Files
PaperClipAI/packages/shared/src/validators/skill-policy.ts
T
3abe9e2134 build(deps): bump zod from 3.25.76 to 4.4.3 (#11719)
Bumps [zod](https://github.com/colinhacks/zod) from 3.25.76 to 4.4.3.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/colinhacks/zod/releases">zod's
releases</a>.</em></p>
<blockquote>
<h2>v4.4.3</h2>
<h2>Commits:</h2>
<ul>
<li>4c2fa95ce3f3390fbc522324e406b4e9e89b88f9 docs: use Zernio primary
wordmark for gold sponsor logo</li>
<li>2aeec83eb135e3a83756e973ef44845fc5a455d2 docs: prune lapsed gold
sponsors and rebalance logo sizing</li>
<li>7391be88ac1ee5cd02057f5ccc012a1f5df4efd0 docs: prune lapsed
silver/bronze sponsors and add active ones</li>
<li>2c703322a21b4e2b12f33f49ea8430c451a68b4f docs: normalize bronze
sponsor logos to github avatar pattern</li>
<li>9195250cab0e7950efe39c3926d6c203b4b0a170 docs: remove Mintlify from
bronze sponsors (churned)</li>
<li>b8dffe9e62f17e6571e6249d05cc5102b54d94e4 docs: remove Numeric and
Speakeasy (2+ missed monthly cycles)</li>
<li>1cab69383fcdeae2a366d5e2a2fc4d8fc765d168 fix(v4): restore catch
handling for absent object keys (<a
href="https://redirect.github.com/colinhacks/zod/issues/5937">#5937</a>)
(<a
href="https://redirect.github.com/colinhacks/zod/issues/5939">#5939</a>)</li>
<li>c2be4f819064eed62c7c350a2d399b5faecd15f8 fix(v4): generalize
optin/fallback to transform; restore preprocess on absent keys (<a
href="https://redirect.github.com/colinhacks/zod/issues/5941">#5941</a>)</li>
<li>f3c9ec03ba7a28ae72d25cc295f38674bee0f559 4.4.3</li>
<li>1fb56a5c18c27102dbc92260a4007c7732a0ccca docs: document release
procedure in AGENTS.md</li>
</ul>
<h2>v4.4.2</h2>
<h2>Commits:</h2>
<ul>
<li>0c62df0ea19fd05abdf90473e9eef7eea530fab2 Clean up docs navigation
and stale labels (<a
href="https://redirect.github.com/colinhacks/zod/issues/5901">#5901</a>)</li>
<li>20cc794895cc8604fe0c87d83a5d1c3f89fad0ac chore: add security policy
and refresh tooling deps</li>
<li>6fbe07b0177efdd1bf1c0b05160e70d7a0702337 fix(docs): heading anchor
links now include the hash so it doesnt scoll all the way up, follows
navbar logic (<a
href="https://redirect.github.com/colinhacks/zod/issues/5791">#5791</a>)</li>
<li>4bbed1b1c73eca4ce9e59b1189ed236aa6c8b5bd Tighten discriminated union
option typing</li>
<li>bbac3e567e7fccfaaf7cdc97f1ce30c295e2c908 Update PR guidance for
agents</li>
<li>cf0dc942a32805c292fff59ade20a7ace980735a Merge remote-tracking
branch 'origin/main' into fix-discriminated-union-key-constraint</li>
<li>292c894a5fd2aa42e527900b83d8d7a3009a709c docs: add Zernio gold
sponsor</li>
<li>1fc9f311c28dcf80d0bb5a36b177086cbc3d8eca docs: document codec
inversion</li>
<li>1373c85da9aeff704a9762d27bc58699618aefb7 docs: remove AI disclosure
guidance</li>
<li>e20d02b473c08e3a4e557bc610b1b5fac079b649 chore: ignore triage
notes</li>
<li>e58ea4d91b1dfe8194b73508203213cbc7e9c936 docs: test Zod Mini tab
code heights</li>
<li>905761a5d127e8d5dd2ebb3bc88c75cb0b8149ff docs: document preprocess
input type narrowing</li>
<li>bf64bac850d4dee2b7dde7e64909d5d796d32043 chore: tighten test
guidance in AGENTS.md</li>
<li>8ec4e73f4c4693b6361ad591be40fb41eb8a9f95 chore: update play.ts
scratch</li>
<li>02c2baf7d0d615872fa4528a8020603b71211702 Make z.preprocess defer
optionality to inner schema (<a
href="https://redirect.github.com/colinhacks/zod/issues/5929">#5929</a>)</li>
<li>88015df8e25c44fb5385eb3ef28935119cd5edea fix(docs): drop deprecated
<code>baseUrl</code> from tsconfig</li>
<li>c59d4474e3b4cad1b323462186cf607178ce8267 4.4.2</li>
</ul>
<h2>v4.4.1</h2>
<h2>Commits:</h2>
<ul>
<li>481f7be4238c83ed58183f921b2646f340a91c6a ci: gate release publishing
on full test workflow</li>
<li>95ccab423aec720b2523c3a64cdc7e3204537cc7 test(v3): restore optional
undefined expectations</li>
<li>cede2c63739a5823d6aa5093d291e9a111da943d fix(v4): reject tuple holes
before required defaults (<a
href="https://redirect.github.com/colinhacks/zod/issues/5900">#5900</a>)</li>
<li>edd0bf0f5ada4a8dc581c259407d7bbad0a71ea7 release: 4.4.1</li>
<li>180d83d1dbe6a59260710cc8637a3dea2281ee56 docs: remove Jazz featured
sponsor</li>
</ul>
<h2>v4.4.0</h2>
<h2>4.4.0</h2>
<p>This is a minor release with a wide set of correctness and soundness
fixes. Some fixes intentionally make Zod stricter, so code that depended
on previously accepted invalid or ambiguous inputs may need small
updates.</p>
<h2>Potentially breaking bug fixes</h2>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/colinhacks/zod/commit/1fb56a5c18c27102dbc92260a4007c7732a0ccca"><code>1fb56a5</code></a>
docs: document release procedure in AGENTS.md</li>
<li><a
href="https://github.com/colinhacks/zod/commit/f3c9ec03ba7a28ae72d25cc295f38674bee0f559"><code>f3c9ec0</code></a>
4.4.3</li>
<li><a
href="https://github.com/colinhacks/zod/commit/c2be4f819064eed62c7c350a2d399b5faecd15f8"><code>c2be4f8</code></a>
fix(v4): generalize optin/fallback to transform; restore preprocess on
absent...</li>
<li><a
href="https://github.com/colinhacks/zod/commit/1cab69383fcdeae2a366d5e2a2fc4d8fc765d168"><code>1cab693</code></a>
fix(v4): restore catch handling for absent object keys (<a
href="https://redirect.github.com/colinhacks/zod/issues/5937">#5937</a>)
(<a
href="https://redirect.github.com/colinhacks/zod/issues/5939">#5939</a>)</li>
<li><a
href="https://github.com/colinhacks/zod/commit/b8dffe9e62f17e6571e6249d05cc5102b54d94e4"><code>b8dffe9</code></a>
docs: remove Numeric and Speakeasy (2+ missed monthly cycles)</li>
<li><a
href="https://github.com/colinhacks/zod/commit/9195250cab0e7950efe39c3926d6c203b4b0a170"><code>9195250</code></a>
docs: remove Mintlify from bronze sponsors (churned)</li>
<li><a
href="https://github.com/colinhacks/zod/commit/2c703322a21b4e2b12f33f49ea8430c451a68b4f"><code>2c70332</code></a>
docs: normalize bronze sponsor logos to github avatar pattern</li>
<li><a
href="https://github.com/colinhacks/zod/commit/7391be88ac1ee5cd02057f5ccc012a1f5df4efd0"><code>7391be8</code></a>
docs: prune lapsed silver/bronze sponsors and add active ones</li>
<li><a
href="https://github.com/colinhacks/zod/commit/2aeec83eb135e3a83756e973ef44845fc5a455d2"><code>2aeec83</code></a>
docs: prune lapsed gold sponsors and rebalance logo sizing</li>
<li><a
href="https://github.com/colinhacks/zod/commit/4c2fa95ce3f3390fbc522324e406b4e9e89b88f9"><code>4c2fa95</code></a>
docs: use Zernio primary wordmark for gold sponsor logo</li>
<li>Additional commits viewable in <a
href="https://github.com/colinhacks/zod/compare/v3.25.76...v4.4.3">compare
view</a></li>
</ul>
</details>
<details>
<summary>Maintainer changes</summary>
<p>This version was pushed to npm by <a
href="https://www.npmjs.com/~GitHub%20Actions">GitHub Actions</a>, a new
releaser for zod since your current version.</p>
</details>
<br />

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Priya Raman <priya@paperclip.ing>
Co-authored-by: Paperclip <noreply@paperclip.ing>
2026-08-21 00:04:14 -07:00

157 lines
6.5 KiB
TypeScript

import { z } from "zod";
export const SKILL_POLICY_ACTIONS = [
"skills.create",
"skills.import",
"skills.install",
"skills.edit",
"skills.update",
"skills.test",
"skills.reset",
"skills.remove",
] as const;
export const SKILL_POLICY_SOURCE_TYPES = [
"workspace",
"catalog",
"git",
"external_package",
"generated",
"unknown",
] as const;
export const skillPolicyActionSchema = z.enum(SKILL_POLICY_ACTIONS);
export const skillPolicySourceTypeSchema = z.enum(SKILL_POLICY_SOURCE_TYPES);
export const skillPolicyEffectSchema = z.enum(["allow", "deny"]);
const nonEmptyUniqueStrings = z.array(z.string().trim().min(1).max(512)).min(1).max(500)
.refine((values) => new Set(values).size === values.length, "Values must be unique");
function isSafeSourceLocator(value: string) {
if (/:\/\/[^/@\s]+:[^/@\s]+@/.test(value)) return false;
try {
const url = new URL(value);
if (url.username || url.password) return false;
const credentialParameter = /token|secret|password|api[-_]?key|authorization/i;
if ([...url.searchParams.keys()].some((key) => credentialParameter.test(key))) return false;
const fragment = url.hash.slice(1);
return !/(?:^|[?&;])(?:token|secret|password|api[-_]?key|authorization)=/i.test(fragment);
} catch {
return true;
}
}
// Canonical form matching the server-side remote-import normalization: repo-style
// https URLs get a lowercased host (www.github.com -> github.com), lowercased
// owner/repo, and a stripped .git suffix. Evaluation resources are normalized the
// same way, so rules must be too or deny rules silently never match.
export function normalizeSkillPolicySourceLocator(value: string): string {
const trimmed = value.trim();
let url: URL;
try {
url = new URL(trimmed);
} catch {
return trimmed;
}
if (url.protocol !== "https:" && url.protocol !== "http:") return trimmed;
const hostname = url.hostname.toLowerCase() === "www.github.com" ? "github.com" : url.hostname.toLowerCase();
const segments = url.pathname.split("/").filter(Boolean);
const isRepoStyle = url.protocol === "https:"
&& !hostname.endsWith(".githubusercontent.com")
&& hostname !== "gist.github.com"
&& segments.length >= 2
&& !url.pathname.endsWith(".md")
&& !url.username && !url.password && !url.search && !url.hash;
if (!isRepoStyle) return url.toString();
const owner = segments[0]!.toLowerCase();
const repo = segments[1]!.replace(/\.git$/i, "").toLowerCase();
const suffix = segments.slice(2).join("/");
return `https://${hostname}/${owner}/${repo}${suffix ? `/${suffix}` : ""}`;
}
const skillPolicySourceLocatorSchema = z.string().trim().min(1).max(2_048)
.refine(isSafeSourceLocator, "Source locators must not contain credentials or secret query or fragment parameters")
.transform(normalizeSkillPolicySourceLocator);
export const skillPolicySubjectSchema = z.discriminatedUnion("type", [
z.object({ type: z.literal("all_agents") }).strict(),
z.object({
type: z.literal("agents"),
agentIds: z.array(z.string().guid()).min(1).max(500)
.refine((values) => new Set(values).size === values.length, "Agent IDs must be unique"),
}).strict(),
z.object({ type: z.literal("roles"), roles: nonEmptyUniqueStrings }).strict(),
]);
export const skillPolicyResourceSelectorSchema = z.object({
skillIds: z.array(z.string().guid()).min(1).max(500).optional(),
skillKeys: nonEmptyUniqueStrings.optional(),
sourceTypes: z.array(skillPolicySourceTypeSchema).min(1)
.refine((values) => new Set(values).size === values.length, "Source types must be unique")
.optional(),
sourceLocators: z.array(skillPolicySourceLocatorSchema).min(1).max(500)
.refine((values) => new Set(values).size === values.length, "Source locators must be unique")
.optional(),
}).strict().refine((value) => Object.keys(value).length > 0, "At least one resource selector is required");
export const skillPolicyRuleSchema = z.object({
id: z.string().trim().min(1).max(128).regex(/^[a-zA-Z0-9][a-zA-Z0-9._:-]*$/),
priority: z.number().int().min(-1_000_000).max(1_000_000),
effect: skillPolicyEffectSchema,
subject: skillPolicySubjectSchema,
actions: z.array(skillPolicyActionSchema).min(1)
.refine((values) => new Set(values).size === values.length, "Actions must be unique"),
resources: skillPolicyResourceSelectorSchema.optional(),
}).strict();
export const skillPolicyDocumentSchema = z.object({
schemaVersion: z.literal(1),
defaultEffect: skillPolicyEffectSchema,
rules: z.array(skillPolicyRuleSchema).max(1_000)
.refine((rules) => new Set(rules.map((rule) => rule.id)).size === rules.length, "Rule IDs must be unique"),
}).strict();
export const replaceSkillPolicySchema = skillPolicyDocumentSchema.extend({
expectedRevision: z.number().int().nonnegative(),
}).strict();
export const skillPolicyEvaluationResourceSchema = z.object({
skillId: z.string().guid().optional(),
skillKey: z.string().trim().min(1).max(512).optional(),
sourceType: skillPolicySourceTypeSchema.optional(),
sourceLocator: skillPolicySourceLocatorSchema.optional(),
}).strict();
export const evaluateSkillPolicySchema = z.object({
action: skillPolicyActionSchema,
resource: skillPolicyEvaluationResourceSchema.default({}),
principal: z.object({ agentId: z.string().guid() }).strict().optional(),
}).strict();
export type SkillPolicyAction = z.infer<typeof skillPolicyActionSchema>;
export type SkillPolicySourceType = z.infer<typeof skillPolicySourceTypeSchema>;
export type SkillPolicyEffect = z.infer<typeof skillPolicyEffectSchema>;
export type SkillPolicySubject = z.infer<typeof skillPolicySubjectSchema>;
export type SkillPolicyResourceSelector = z.infer<typeof skillPolicyResourceSelectorSchema>;
export type SkillPolicyRule = z.infer<typeof skillPolicyRuleSchema>;
export type SkillPolicyDocument = z.infer<typeof skillPolicyDocumentSchema>;
export type ReplaceSkillPolicy = z.infer<typeof replaceSkillPolicySchema>;
export type SkillPolicyEvaluationResource = z.infer<typeof skillPolicyEvaluationResourceSchema>;
export type EvaluateSkillPolicy = z.infer<typeof evaluateSkillPolicySchema>;
export type EffectiveSkillPolicy = SkillPolicyDocument & { revision: number; materialized: boolean };
export type SkillPolicyDecisionReason =
| "platform_invariant"
| "no_policy_default"
| "explicit_rule"
| "policy_default"
| "legacy_compatibility";
export type SkillPolicyDecision = {
allowed: boolean;
action: SkillPolicyAction;
reason: SkillPolicyDecisionReason;
policyRevision: number;
matchedRuleId: string | null;
remediation: string | null;
};