@zapier/policy-schema 0.13.0 → 0.17.0

package/dist/index.mjs

@@ -1,9 +1,15 @@
 import { z } from 'zod';
 
 // src/schema.ts
-var VALID_VERSIONS = [1, 2];
+var RUBBERDUCK_POLICY_VERSION = "rc-rubberduck";
+var VALID_VERSIONS = [1, 2, 3, RUBBERDUCK_POLICY_VERSION];
+var ID_BASED_VERSIONS = /* @__PURE__ */ new Set([
+  3,
+  RUBBERDUCK_POLICY_VERSION
+]);
 var VALID_EFFECTS = ["allow", "ask", "deny"];
 var VALID_OPERATOR_LIST = [
+  "all",
   "equals",
   "exists",
   "in",
@@ -12,16 +18,20 @@ var VALID_OPERATOR_LIST = [
   "matches_host",
   "matches_path",
   "matches_url",
+  "none",
   "range",
   "size",
+  "some",
   "values_in"
 ];
 var ScalarSchema = z.union([z.string(), z.number(), z.boolean()]);
 var PathSchema = z.array(z.union([z.string(), z.number()])).min(1);
+var RelativePathSchema = z.array(z.union([z.string(), z.number()]));
+var ConditionValueSchema = z.json();
 var EqualsConditionSchema = z.object({
   path: PathSchema,
   operator: z.literal("equals"),
-  value: z.json()
+  value: ConditionValueSchema
 }).strict();
 var InConditionSchema = z.object({
   path: PathSchema,
@@ -82,6 +92,24 @@ var SizeConditionSchema = z.object({
   operator: z.literal("size"),
   value: SizeValueSchema
 }).strict();
+var RelativeConditionSchema = z.union([
+  EqualsConditionSchema.extend({ path: RelativePathSchema }),
+  InConditionSchema.extend({ path: RelativePathSchema }),
+  MatchesConditionSchema.extend({ path: RelativePathSchema }),
+  MatchesHostConditionSchema.extend({ path: RelativePathSchema }),
+  MatchesPathConditionSchema.extend({ path: RelativePathSchema }),
+  RangeConditionSchema.extend({ path: RelativePathSchema }),
+  MatchesUrlConditionSchema.extend({ path: RelativePathSchema }),
+  ValuesInConditionSchema.extend({ path: RelativePathSchema }),
+  ExistsConditionSchema.extend({ path: RelativePathSchema }),
+  KeysInConditionSchema.extend({ path: RelativePathSchema }),
+  SizeConditionSchema.extend({ path: RelativePathSchema })
+]);
+var QuantifierConditionSchema = z.object({
+  path: PathSchema,
+  operator: z.enum(["some", "all", "none"]),
+  where: z.array(RelativeConditionSchema).min(1)
+}).strict();
 var ConditionSchema = z.union([
   // Scalar operators
   EqualsConditionSchema,
@@ -97,7 +125,8 @@ var ConditionSchema = z.union([
   // Other operators
   ExistsConditionSchema,
   KeysInConditionSchema,
-  SizeConditionSchema
+  SizeConditionSchema,
+  QuantifierConditionSchema
 ]);
 var ScalarOperatorSchema = z.enum([
   "equals",
@@ -107,7 +136,7 @@ var ScalarOperatorSchema = z.enum([
   "matches_path",
   "range"
 ]);
-var ArrayOperatorSchema = z.enum(["values_in"]);
+var ArrayOperatorSchema = z.enum(["values_in", "some", "all", "none"]);
 var UrlOperatorSchema = z.enum(["matches_url"]);
 var OtherOperatorSchema = z.enum(["exists", "keys_in", "size"]);
 var OperatorSchema = z.enum([
@@ -122,12 +151,14 @@ var OperatorSchema = z.enum([
   "matches_url",
   // Array
   "values_in",
+  "some",
+  "all",
+  "none",
   // Other
   "exists",
   "keys_in",
   "size"
 ]);
-var ConditionValueSchema = z.json();
 var V1StatementSchema = z.object({
   id: z.string().optional(),
   effect: z.enum(["allow", "deny"]),
@@ -143,92 +174,182 @@ var V2StatementSchema = z.object({
   conditions: z.array(ConditionSchema).optional()
 }).strict();
 var StatementSchema = V2StatementSchema;
+var StatementIdSchema = z.string().regex(/^s_\S+$/, { error: "Statement id must match ^s_\\S+$" }).max(512);
+var PolicyIdSchema = z.string().regex(/^p_\S+$/, { error: "Policy id must match ^p_\\S+$" }).max(512);
 var V1PolicySchema = z.object({
   version: z.literal(1),
   statements: z.array(V1StatementSchema)
 }).strict();
+var DefaultEffectSchema = z.enum(["deny", "ask"]);
 var V2PolicySchema = z.object({
   version: z.literal(2),
   statements: z.array(V2StatementSchema)
 }).strict();
-var PolicySchema = z.union([V1PolicySchema, V2PolicySchema]);
+var RcRubberduckStatementSchema = z.object({
+  id: StatementIdSchema,
+  effect: z.enum(["allow", "ask", "deny"]),
+  permissions: z.array(z.string()).min(1),
+  resources: z.array(z.string()).min(1),
+  conditions: z.array(ConditionSchema).optional()
+}).strict();
+var RcRubberduckPolicySchema = z.object({
+  version: z.literal(RUBBERDUCK_POLICY_VERSION),
+  id: PolicyIdSchema,
+  defaultEffect: DefaultEffectSchema,
+  statements: z.array(RcRubberduckStatementSchema)
+}).strict();
+var V3_MAX_TIERS = 3;
+var V3StatementSchema = z.object({
+  id: StatementIdSchema,
+  effect: z.enum(["allow", "ask", "deny"]),
+  permissions: z.array(z.string()).min(1),
+  resources: z.array(z.string()).min(1),
+  conditions: z.array(ConditionSchema).optional()
+}).strict();
+var V3PolicySchema = z.object({
+  version: z.literal(3),
+  // Ordered tiers, in priority order. 1..V3_MAX_TIERS tiers; a tier may be
+  // empty (e.g. `[[]]` denies everything).
+  statements: z.array(z.array(V3StatementSchema)).min(1).max(V3_MAX_TIERS)
+}).strict();
+var PolicySchema = z.union([
+  V1PolicySchema,
+  V2PolicySchema,
+  V3PolicySchema,
+  RcRubberduckPolicySchema
+]);
 var CanonicalHashSchema = z.custom(
   (value) => typeof value === "string" && /^[0-9a-f]{64}$/.test(value),
   { error: "Expected a 64-character lowercase hex SHA-256 digest" }
 );
-var OverrideBaseShape = {
+var OverrideHashBaseShape = {
   id: z.string().optional(),
+  /**
+   * The canonical hash of the targeted statement.
+   * Used for v1/v2 policies. Must be a valid SHA-256 hex digest (non-null).
+   */
   statementHash: CanonicalHashSchema,
   effect: z.literal("allow")
 };
+var OverrideIdBaseShape = {
+  id: z.string().optional(),
+  /**
+   * The statement id of the targeted statement. Used for rc-rubberduck policies.
+   * Must be a valid statement id (non-null). To target the policy's default
+   * effect, use policyId instead.
+   */
+  statementId: StatementIdSchema,
+  effect: z.literal("allow")
+};
+var OverridePolicyIdBaseShape = {
+  id: z.string().optional(),
+  /**
+   * Targets the policy's default effect. Only applies when this policyId
+   * matches the evaluated policy's id. Used for rc-rubberduck policies.
+   */
+  policyId: PolicyIdSchema,
+  effect: z.literal("allow")
+};
 var OverrideSchema = z.union([
-  z.object({ ...OverrideBaseShape, match: z.literal("any") }).strict(),
-  z.object({ ...OverrideBaseShape, contextHash: CanonicalHashSchema }).strict(),
-  // Empty conditionals is intentional (the "blank check"): the override
-  // applies whenever the targeted ask statement fires, with no extra
-  // conditions. Do not add .min(1) here.
+  // statementHash × match
+  z.object({ ...OverrideHashBaseShape, match: z.literal("any") }).strict(),
+  // statementHash × contextHash
+  z.object({ ...OverrideHashBaseShape, contextHash: CanonicalHashSchema }).strict(),
+  // statementHash × conditionals
+  z.object({
+    ...OverrideHashBaseShape,
+    conditionals: z.array(ConditionSchema)
+  }).strict(),
+  // statementId × match
+  z.object({ ...OverrideIdBaseShape, match: z.literal("any") }).strict(),
+  // statementId × contextHash
+  z.object({ ...OverrideIdBaseShape, contextHash: CanonicalHashSchema }).strict(),
+  // statementId × conditionals
+  z.object({
+    ...OverrideIdBaseShape,
+    conditionals: z.array(ConditionSchema)
+  }).strict(),
+  // policyId × match
+  z.object({ ...OverridePolicyIdBaseShape, match: z.literal("any") }).strict(),
+  // policyId × contextHash
+  z.object({ ...OverridePolicyIdBaseShape, contextHash: CanonicalHashSchema }).strict(),
+  // policyId × conditionals
   z.object({
-    ...OverrideBaseShape,
+    ...OverridePolicyIdBaseShape,
     conditionals: z.array(ConditionSchema)
   }).strict()
 ]);
 function getOpenApiSchema() {
-  return {
+  const statementItems = {
     type: "object",
-    required: ["version", "statements"],
+    required: ["effect", "permissions", "resources"],
     properties: {
-      version: {
-        type: "integer",
-        enum: [...VALID_VERSIONS],
-        description: `Policy schema version. Must be one of ${JSON.stringify([...VALID_VERSIONS])}.`
+      id: {
+        type: "string",
+        description: "Statement identifier. Required for v3 and rc-rubberduck policies; must use the s_ prefix with no whitespace. Optional on v1/v2 for debugging and provenance."
       },
-      statements: {
+      effect: {
+        type: "string",
+        enum: [...VALID_EFFECTS].sort(),
+        description: "Whether to allow, ask, or deny the specified permissions. The 'ask' effect is valid in version 2, version 3, and rc-rubberduck policies."
+      },
+      permissions: {
+        type: "array",
+        minItems: 1,
+        items: { type: "string" },
+        description: "List of permission identifiers."
+      },
+      resources: {
         type: "array",
-        description: "List of policy statements defining permissions.",
+        minItems: 1,
+        items: { type: "string" },
+        description: "List of resource identifiers the statement applies to."
+      },
+      conditions: {
+        type: "array",
+        description: "Optional conditions that must be met for the statement to apply.",
         items: {
           type: "object",
-          required: ["effect", "permissions", "resources"],
+          required: ["path", "operator"],
           properties: {
-            id: {
-              type: "string",
-              description: "Optional identifier for debugging and provenance. Included in canonical hash."
+            path: {
+              type: "array",
+              minItems: 1,
+              description: "Path to the value to evaluate in the request context.",
+              items: {
+                anyOf: [{ type: "string" }, { type: "integer" }]
+              }
             },
-            effect: {
+            operator: {
               type: "string",
-              enum: [...VALID_EFFECTS].sort(),
-              description: "Whether to allow, ask, or deny the specified permissions. The 'ask' effect is only valid in version 2 policies."
+              enum: [...VALID_OPERATOR_LIST],
+              description: "Comparison operator used to evaluate the condition."
             },
-            permissions: {
-              type: "array",
-              minItems: 1,
-              items: { type: "string" },
-              description: "List of permission identifiers."
+            value: {
+              description: "Value to compare against using the operator."
             },
-            resources: {
+            where: {
               type: "array",
               minItems: 1,
-              items: { type: "string" },
-              description: "List of resource identifiers the statement applies to."
-            },
-            conditions: {
-              type: "array",
-              description: "Optional conditions that must be met for the statement to apply.",
+              description: "Conditions evaluated relative to each collection element for some, all, and none.",
               items: {
                 type: "object",
                 required: ["path", "operator"],
                 properties: {
                   path: {
                     type: "array",
-                    minItems: 1,
-                    description: "Path to the value to evaluate in the request context.",
+                    minItems: 0,
+                    description: "Path relative to the collection element; an empty path selects the element itself.",
                     items: {
                       anyOf: [{ type: "string" }, { type: "integer" }]
                     }
                   },
                   operator: {
                     type: "string",
-                    enum: [...VALID_OPERATOR_LIST],
-                    description: "Comparison operator used to evaluate the condition."
+                    enum: [...VALID_OPERATOR_LIST].filter(
+                      (operator) => operator !== "some" && operator !== "all" && operator !== "none"
+                    ),
+                    description: "Non-quantifier operator evaluated against the collection element."
                   },
                   value: {
                     description: "Value to compare against using the operator."
@@ -241,6 +362,42 @@ function getOpenApiSchema() {
       }
     }
   };
+  return {
+    type: "object",
+    required: ["version", "statements"],
+    properties: {
+      version: {
+        anyOf: [
+          { type: "integer", enum: [1, 2, 3] },
+          { type: "string", enum: [RUBBERDUCK_POLICY_VERSION] }
+        ],
+        description: "Policy schema version. Stable versions are 1, 2, and 3; supported release candidates are rc-rubberduck."
+      },
+      id: {
+        type: "string",
+        description: "Policy id (required for rc-rubberduck policies; not permitted on any other version). Must use the p_ prefix and contain no whitespace."
+      },
+      defaultEffect: {
+        type: "string",
+        enum: [...DefaultEffectSchema.options],
+        description: "Effect applied when no statement matches. Required on rc-rubberduck policies (deny equals implicit deny); not permitted on any other version."
+      },
+      statements: {
+        type: "array",
+        description: "Policy statements. For v1/v2/rc-rubberduck each entry is a statement. For v3 each entry is a tier (a list of statements); tiers are in priority order and evaluated first-to-last (the first tier with a match decides), so `statements` is a list of lists.",
+        items: {
+          anyOf: [
+            statementItems,
+            {
+              type: "array",
+              description: "A v3 tier: statements evaluated together with deny > ask > allow precedence.",
+              items: statementItems
+            }
+          ]
+        }
+      }
+    }
+  };
 }
 
-export { ArrayOperatorSchema, CanonicalHashSchema, ConditionSchema, ConditionValueSchema, OperatorSchema, OtherOperatorSchema, OverrideSchema, PolicySchema, RangeValueSchema, ScalarOperatorSchema, SizeValueSchema, StatementSchema, UrlOperatorSchema, VALID_EFFECTS, VALID_OPERATOR_LIST, VALID_VERSIONS, getOpenApiSchema };
+export { ArrayOperatorSchema, CanonicalHashSchema, ConditionSchema, ConditionValueSchema, DefaultEffectSchema, ID_BASED_VERSIONS, OperatorSchema, OtherOperatorSchema, OverrideSchema, PolicyIdSchema, PolicySchema, RUBBERDUCK_POLICY_VERSION, RangeValueSchema, ScalarOperatorSchema, SizeValueSchema, StatementIdSchema, StatementSchema, UrlOperatorSchema, V3_MAX_TIERS, VALID_EFFECTS, VALID_OPERATOR_LIST, VALID_VERSIONS, getOpenApiSchema };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zapier/policy-schema",
-  "version": "0.13.0",
+  "version": "0.17.0",
   "description": "Zod schemas and TypeScript types for the Zapier policy engine",
   "type": "module",
   "main": "dist/index.cjs",