@zapier/policy-schema 0.12.0 → 0.15.0

package/dist/index.cjs

@@ -3,7 +3,8 @@
 var zod = require('zod');
 
 // src/schema.ts
-var VALID_VERSIONS = [1, 2];
+var RUBBERDUCK_POLICY_VERSION = "rc-rubberduck";
+var VALID_VERSIONS = [1, 2, RUBBERDUCK_POLICY_VERSION];
 var VALID_EFFECTS = ["allow", "ask", "deny"];
 var VALID_OPERATOR_LIST = [
   "equals",
@@ -20,10 +21,11 @@ var VALID_OPERATOR_LIST = [
 ];
 var ScalarSchema = zod.z.union([zod.z.string(), zod.z.number(), zod.z.boolean()]);
 var PathSchema = zod.z.array(zod.z.union([zod.z.string(), zod.z.number()])).min(1);
+var ConditionValueSchema = zod.z.json();
 var EqualsConditionSchema = zod.z.object({
   path: PathSchema,
   operator: zod.z.literal("equals"),
-  value: zod.z.json()
+  value: ConditionValueSchema
 }).strict();
 var InConditionSchema = zod.z.object({
   path: PathSchema,
@@ -129,7 +131,6 @@ var OperatorSchema = zod.z.enum([
   "keys_in",
   "size"
 ]);
-var ConditionValueSchema = zod.z.json();
 var V1StatementSchema = zod.z.object({
   id: zod.z.string().optional(),
   effect: zod.z.enum(["allow", "deny"]),
@@ -145,24 +146,116 @@ var V2StatementSchema = zod.z.object({
   conditions: zod.z.array(ConditionSchema).optional()
 }).strict();
 var StatementSchema = V2StatementSchema;
+var StatementIdSchema = zod.z.string().regex(/^s_\S+$/, { error: "Statement id must match ^s_\\S+$" }).max(512);
+var PolicyIdSchema = zod.z.string().regex(/^p_\S+$/, { error: "Policy id must match ^p_\\S+$" }).max(512);
 var V1PolicySchema = zod.z.object({
   version: zod.z.literal(1),
   statements: zod.z.array(V1StatementSchema)
 }).strict();
+var DefaultEffectSchema = zod.z.enum(["deny", "ask"]);
 var V2PolicySchema = zod.z.object({
   version: zod.z.literal(2),
   statements: zod.z.array(V2StatementSchema)
 }).strict();
-var PolicySchema = zod.z.union([V1PolicySchema, V2PolicySchema]);
+var RcRubberduckStatementSchema = zod.z.object({
+  id: StatementIdSchema,
+  effect: zod.z.enum(["allow", "ask", "deny"]),
+  permissions: zod.z.array(zod.z.string()).min(1),
+  resources: zod.z.array(zod.z.string()).min(1),
+  conditions: zod.z.array(ConditionSchema).optional()
+}).strict();
+var RcRubberduckPolicySchema = zod.z.object({
+  version: zod.z.literal(RUBBERDUCK_POLICY_VERSION),
+  id: PolicyIdSchema,
+  defaultEffect: DefaultEffectSchema,
+  statements: zod.z.array(RcRubberduckStatementSchema)
+}).strict();
+var PolicySchema = zod.z.union([
+  V1PolicySchema,
+  V2PolicySchema,
+  RcRubberduckPolicySchema
+]);
+var CanonicalHashSchema = zod.z.custom(
+  (value) => typeof value === "string" && /^[0-9a-f]{64}$/.test(value),
+  { error: "Expected a 64-character lowercase hex SHA-256 digest" }
+);
+var OverrideHashBaseShape = {
+  id: zod.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: zod.z.literal("allow")
+};
+var OverrideIdBaseShape = {
+  id: zod.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: zod.z.literal("allow")
+};
+var OverridePolicyIdBaseShape = {
+  id: zod.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: zod.z.literal("allow")
+};
+var OverrideSchema = zod.z.union([
+  // statementHash × match
+  zod.z.object({ ...OverrideHashBaseShape, match: zod.z.literal("any") }).strict(),
+  // statementHash × contextHash
+  zod.z.object({ ...OverrideHashBaseShape, contextHash: CanonicalHashSchema }).strict(),
+  // statementHash × conditionals
+  zod.z.object({
+    ...OverrideHashBaseShape,
+    conditionals: zod.z.array(ConditionSchema)
+  }).strict(),
+  // statementId × match
+  zod.z.object({ ...OverrideIdBaseShape, match: zod.z.literal("any") }).strict(),
+  // statementId × contextHash
+  zod.z.object({ ...OverrideIdBaseShape, contextHash: CanonicalHashSchema }).strict(),
+  // statementId × conditionals
+  zod.z.object({
+    ...OverrideIdBaseShape,
+    conditionals: zod.z.array(ConditionSchema)
+  }).strict(),
+  // policyId × match
+  zod.z.object({ ...OverridePolicyIdBaseShape, match: zod.z.literal("any") }).strict(),
+  // policyId × contextHash
+  zod.z.object({ ...OverridePolicyIdBaseShape, contextHash: CanonicalHashSchema }).strict(),
+  // policyId × conditionals
+  zod.z.object({
+    ...OverridePolicyIdBaseShape,
+    conditionals: zod.z.array(ConditionSchema)
+  }).strict()
+]);
 function getOpenApiSchema() {
   return {
     type: "object",
     required: ["version", "statements"],
     properties: {
       version: {
-        type: "integer",
-        enum: [...VALID_VERSIONS],
-        description: `Policy schema version. Must be one of ${JSON.stringify([...VALID_VERSIONS])}.`
+        anyOf: [
+          { type: "integer", enum: [1, 2] },
+          { type: "string", enum: [RUBBERDUCK_POLICY_VERSION] }
+        ],
+        description: "Policy schema version. Stable versions are 1 and 2; supported release candidates are rc-rubberduck."
+      },
+      id: {
+        type: "string",
+        description: "Policy id (required for rc-rubberduck policies). 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."
       },
       statements: {
         type: "array",
@@ -173,12 +266,12 @@ function getOpenApiSchema() {
           properties: {
             id: {
               type: "string",
-              description: "Optional identifier for debugging and provenance. Included in canonical hash."
+              description: "Statement identifier. Required for rc-rubberduck policies; must use the s_ prefix with no whitespace. Optional on v1/v2 for debugging and provenance."
             },
             effect: {
               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."
+              description: "Whether to allow, ask, or deny the specified permissions. The 'ask' effect is valid in version 2 and rc-rubberduck policies."
             },
             permissions: {
               type: "array",
@@ -226,14 +319,20 @@ function getOpenApiSchema() {
 }
 
 exports.ArrayOperatorSchema = ArrayOperatorSchema;
+exports.CanonicalHashSchema = CanonicalHashSchema;
 exports.ConditionSchema = ConditionSchema;
 exports.ConditionValueSchema = ConditionValueSchema;
+exports.DefaultEffectSchema = DefaultEffectSchema;
 exports.OperatorSchema = OperatorSchema;
 exports.OtherOperatorSchema = OtherOperatorSchema;
+exports.OverrideSchema = OverrideSchema;
+exports.PolicyIdSchema = PolicyIdSchema;
 exports.PolicySchema = PolicySchema;
+exports.RUBBERDUCK_POLICY_VERSION = RUBBERDUCK_POLICY_VERSION;
 exports.RangeValueSchema = RangeValueSchema;
 exports.ScalarOperatorSchema = ScalarOperatorSchema;
 exports.SizeValueSchema = SizeValueSchema;
+exports.StatementIdSchema = StatementIdSchema;
 exports.StatementSchema = StatementSchema;
 exports.UrlOperatorSchema = UrlOperatorSchema;
 exports.VALID_EFFECTS = VALID_EFFECTS;