@zapier/policy-schema 0.17.0 → 0.19.0

package/dist/index.mjs

@@ -2,9 +2,10 @@ import { z } from 'zod';
 
 // src/schema.ts
 var RUBBERDUCK_POLICY_VERSION = "rc-rubberduck";
-var VALID_VERSIONS = [1, 2, 3, RUBBERDUCK_POLICY_VERSION];
+var VALID_VERSIONS = [1, 2, 3, 4, RUBBERDUCK_POLICY_VERSION];
 var ID_BASED_VERSIONS = /* @__PURE__ */ new Set([
   3,
+  4,
   RUBBERDUCK_POLICY_VERSION
 ]);
 var VALID_EFFECTS = ["allow", "ask", "deny"];
@@ -25,33 +26,40 @@ var VALID_OPERATOR_LIST = [
   "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 PathSegmentSchema = z.union([z.string(), z.number().int()]);
+var PathSchema = z.array(PathSegmentSchema).min(1);
+var RelativePathSchema = z.array(PathSegmentSchema);
+var NegateField = { negate: z.boolean().optional() };
 var ConditionValueSchema = z.json();
 var EqualsConditionSchema = z.object({
   path: PathSchema,
   operator: z.literal("equals"),
-  value: ConditionValueSchema
+  value: ConditionValueSchema,
+  ...NegateField
 }).strict();
 var InConditionSchema = z.object({
   path: PathSchema,
   operator: z.literal("in"),
-  value: z.array(ScalarSchema).min(1)
+  value: z.array(ScalarSchema).min(1),
+  ...NegateField
 }).strict();
 var MatchesConditionSchema = z.object({
   path: PathSchema,
   operator: z.literal("matches"),
-  value: z.string()
+  value: z.string(),
+  ...NegateField
 }).strict();
 var MatchesHostConditionSchema = z.object({
   path: PathSchema,
   operator: z.literal("matches_host"),
-  value: z.string()
+  value: z.string(),
+  ...NegateField
 }).strict();
 var MatchesPathConditionSchema = z.object({
   path: PathSchema,
   operator: z.literal("matches_path"),
-  value: z.string()
+  value: z.string(),
+  ...NegateField
 }).strict();
 var RangeValueSchema = z.object({
   min: z.number().finite().optional(),
@@ -62,26 +70,31 @@ var RangeValueSchema = z.object({
 var RangeConditionSchema = z.object({
   path: PathSchema,
   operator: z.literal("range"),
-  value: RangeValueSchema
+  value: RangeValueSchema,
+  ...NegateField
 }).strict();
 var MatchesUrlConditionSchema = z.object({
   path: PathSchema,
   operator: z.literal("matches_url"),
-  value: z.string()
+  value: z.string(),
+  ...NegateField
 }).strict();
 var ValuesInConditionSchema = z.object({
   path: PathSchema,
   operator: z.literal("values_in"),
-  value: z.array(ScalarSchema).min(1)
+  value: z.array(ScalarSchema).min(1),
+  ...NegateField
 }).strict();
 var ExistsConditionSchema = z.object({
   path: PathSchema,
-  operator: z.literal("exists")
+  operator: z.literal("exists"),
+  ...NegateField
 }).strict();
 var KeysInConditionSchema = z.object({
   path: PathSchema,
   operator: z.literal("keys_in"),
-  value: z.array(z.string())
+  value: z.array(z.string()),
+  ...NegateField
 }).strict();
 var SizeValueSchema = z.union([
   z.number().int().nonnegative(),
@@ -90,7 +103,8 @@ var SizeValueSchema = z.union([
 var SizeConditionSchema = z.object({
   path: PathSchema,
   operator: z.literal("size"),
-  value: SizeValueSchema
+  value: SizeValueSchema,
+  ...NegateField
 }).strict();
 var RelativeConditionSchema = z.union([
   EqualsConditionSchema.extend({ path: RelativePathSchema }),
@@ -176,6 +190,7 @@ var V2StatementSchema = z.object({
 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 RuleIdSchema = z.string().regex(/^r_\S+$/, { error: "Rule id must match ^r_\\S+$" }).max(512);
 var V1PolicySchema = z.object({
   version: z.literal(1),
   statements: z.array(V1StatementSchema)
@@ -212,10 +227,25 @@ var V3PolicySchema = z.object({
   // empty (e.g. `[[]]` denies everything).
   statements: z.array(z.array(V3StatementSchema)).min(1).max(V3_MAX_TIERS)
 }).strict();
+var V4_MAX_TIERS = 3;
+var V4RuleSchema = z.object({
+  id: RuleIdSchema,
+  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 V4PolicySchema = z.object({
+  version: z.literal(4),
+  // Ordered tiers, in priority order. 1..V4_MAX_TIERS tiers; a tier may be
+  // empty (e.g. `[[]]` denies everything). Renamed from v3's `statements`.
+  rules: z.array(z.array(V4RuleSchema)).min(1).max(V4_MAX_TIERS)
+}).strict();
 var PolicySchema = z.union([
   V1PolicySchema,
   V2PolicySchema,
   V3PolicySchema,
+  V4PolicySchema,
   RcRubberduckPolicySchema
 ]);
 var CanonicalHashSchema = z.custom(
@@ -250,6 +280,12 @@ var OverridePolicyIdBaseShape = {
   policyId: PolicyIdSchema,
   effect: z.literal("allow")
 };
+var OverrideRuleIdBaseShape = {
+  id: z.string().optional(),
+  /** Targets a v4 rule by id (r_ prefix, non-null). */
+  ruleId: RuleIdSchema,
+  effect: z.literal("allow")
+};
 var OverrideSchema = z.union([
   // statementHash × match
   z.object({ ...OverrideHashBaseShape, match: z.literal("any") }).strict(),
@@ -277,6 +313,15 @@ var OverrideSchema = z.union([
   z.object({
     ...OverridePolicyIdBaseShape,
     conditionals: z.array(ConditionSchema)
+  }).strict(),
+  // ruleId × match
+  z.object({ ...OverrideRuleIdBaseShape, match: z.literal("any") }).strict(),
+  // ruleId × contextHash
+  z.object({ ...OverrideRuleIdBaseShape, contextHash: CanonicalHashSchema }).strict(),
+  // ruleId × conditionals
+  z.object({
+    ...OverrideRuleIdBaseShape,
+    conditionals: z.array(ConditionSchema)
   }).strict()
 ]);
 function getOpenApiSchema() {
@@ -291,7 +336,7 @@ function getOpenApiSchema() {
       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."
+        description: "Whether to allow, ask, or deny the specified permissions. The 'ask' effect is valid in version 2, version 3, version 4, and rc-rubberduck policies."
       },
       permissions: {
         type: "array",
@@ -328,6 +373,10 @@ function getOpenApiSchema() {
             value: {
               description: "Value to compare against using the operator."
             },
+            negate: {
+              type: "boolean",
+              description: "When true, the condition passes only if the operator would have failed. Not permitted on the some, all, and none quantifiers."
+            },
             where: {
               type: "array",
               minItems: 1,
@@ -353,6 +402,10 @@ function getOpenApiSchema() {
                   },
                   value: {
                     description: "Value to compare against using the operator."
+                  },
+                  negate: {
+                    type: "boolean",
+                    description: "When true, the relative condition passes only if the operator would have failed."
                   }
                 }
               }
@@ -362,42 +415,123 @@ function getOpenApiSchema() {
       }
     }
   };
-  return {
-    type: "object",
-    required: ["version", "statements"],
+  const ruleItems = {
+    ...statementItems,
     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."
-      },
+      ...statementItems.properties,
       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."
+        description: "Rule identifier. Required for v4 policies; must use the r_ prefix with 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."
+      resources: {
+        ...statementItems.properties.resources,
+        description: "List of resource identifiers the rule applies to."
       },
-      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
-            }
-          ]
-        }
+      conditions: {
+        ...statementItems.properties.conditions,
+        description: "Optional conditions that must be met for the rule to apply."
       }
     }
   };
+  const versionDescription = "Policy schema version. Stable versions are 1, 2, 3, and 4; supported release candidates are rc-rubberduck.";
+  const flatStatements = {
+    type: "array",
+    description: "Policy statements; each entry is a statement.",
+    items: statementItems
+  };
+  const statementTiers = {
+    type: "array",
+    description: "v3 tiers in priority order; each entry is a tier (a list of statements) evaluated first-to-last (the first tier with a match decides), so `statements` is a list of lists.",
+    items: {
+      type: "array",
+      description: "A v3 tier: statements evaluated together with deny > ask > allow precedence.",
+      items: statementItems
+    }
+  };
+  const ruleTiers = {
+    type: "array",
+    description: "v4 rules in priority order; each entry is a tier (a list of rules) evaluated first-to-last (the first tier with a match decides), so `rules` is a list of lists.",
+    items: {
+      type: "array",
+      description: "A v4 tier: rules evaluated together with deny > ask > allow precedence.",
+      items: ruleItems
+    }
+  };
+  const idProperty = {
+    type: "string",
+    description: "Policy id (rc-rubberduck only). Must use the p_ prefix and contain no whitespace."
+  };
+  const defaultEffectProperty = {
+    type: "string",
+    enum: [...DefaultEffectSchema.options],
+    description: "Effect applied when no statement matches (rc-rubberduck only; deny equals implicit deny)."
+  };
+  return {
+    oneOf: [
+      {
+        type: "object",
+        required: ["version", "statements"],
+        properties: {
+          version: {
+            type: "integer",
+            const: 1,
+            description: versionDescription
+          },
+          statements: flatStatements
+        }
+      },
+      {
+        type: "object",
+        required: ["version", "statements"],
+        properties: {
+          version: {
+            type: "integer",
+            const: 2,
+            description: versionDescription
+          },
+          statements: flatStatements
+        }
+      },
+      {
+        type: "object",
+        required: ["version", "statements"],
+        properties: {
+          version: {
+            type: "integer",
+            const: 3,
+            description: versionDescription
+          },
+          statements: statementTiers
+        }
+      },
+      {
+        type: "object",
+        required: ["version", "rules"],
+        properties: {
+          version: {
+            type: "integer",
+            const: 4,
+            description: versionDescription
+          },
+          rules: ruleTiers
+        }
+      },
+      {
+        type: "object",
+        required: ["version", "id", "defaultEffect", "statements"],
+        properties: {
+          version: {
+            type: "string",
+            const: RUBBERDUCK_POLICY_VERSION,
+            description: versionDescription
+          },
+          id: idProperty,
+          defaultEffect: defaultEffectProperty,
+          statements: flatStatements
+        }
+      }
+    ]
+  };
 }
 
-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 };
+export { ArrayOperatorSchema, CanonicalHashSchema, ConditionSchema, ConditionValueSchema, DefaultEffectSchema, ID_BASED_VERSIONS, OperatorSchema, OtherOperatorSchema, OverrideSchema, PolicyIdSchema, PolicySchema, RUBBERDUCK_POLICY_VERSION, RangeValueSchema, RuleIdSchema, ScalarOperatorSchema, SizeValueSchema, StatementIdSchema, StatementSchema, UrlOperatorSchema, V3_MAX_TIERS, V4_MAX_TIERS, VALID_EFFECTS, VALID_OPERATOR_LIST, VALID_VERSIONS, getOpenApiSchema };

package/package.json

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