@sequenceholdings/orm 2.2.0 → 2.4.0

package/dist/predicate-v2.d.cts

@@ -11,7 +11,7 @@ type PolicyOperand =
     kind: 'path';
     segments: readonly string[];
 }
-/** `claim('sub')` / `claim('org')` — the only claim() keys in CLAIMS_CONTRACT. */
+/** `claim('sub')` / `claim('org')` / `claim('ext_subject')` / `claim('ext_email')` — the scalar keys in CLAIMS_CONTRACT. */
  | {
     kind: 'claim';
     key: ClaimKey;
@@ -50,6 +50,16 @@ type PolicyNode = {
     kind: 'exists';
     path: readonly string[];
     where: PolicyNode;
+}
+/**
+ * `visible(<link-path>)` — a related row exists AND the caller may read it:
+ * the final target's own read policy is compiled in as the inner predicate.
+ * Lets a write policy say "only on a parent you can see" without restating
+ * the parent's rule (and without drifting from it).
+ */
+ | {
+    kind: 'visible';
+    path: readonly string[];
 };
 interface ParsedPolicy {
     readonly source: string;
@@ -63,7 +73,7 @@ declare class PolicyParseError extends Error {
     readonly name = "PolicyParseError";
     constructor(message: string, position: number);
 }
-type PolicyCompileErrorCode = 'unknown-table' | 'unknown-column' | 'unknown-link' | 'not-to-one' | 'link-depth-exceeded' | 'unsupported-comparison' | 'invalid-null-comparison' | 'when-not-claims-only';
+type PolicyCompileErrorCode = 'unknown-table' | 'unknown-column' | 'unknown-link' | 'not-to-one' | 'link-depth-exceeded' | 'unsupported-comparison' | 'invalid-null-comparison' | 'when-not-claims-only' | 'claim-type-mismatch' | 'visible-unresolvable' | 'visible-cycle';
 /**
  * Compile-time failure — the parsed policy references something the table
  * doesn't declare, or uses a shape the v2.0 IR cannot represent. Carries
@@ -90,15 +100,28 @@ declare function parsePolicy(source: string): ParsedPolicy;
  *  - a comparison must reference exactly ONE column side (column↔column and
  *    claims↔literal comparisons have no PredIr shape in v2.0);
  *  - `col = null` / `col != null` normalize to the isNull operator;
+ *  - verified-borrower claims (`claim('ext_subject')`, `claim('ext_email')`)
+ *    are text: they compare to a text column with `=` only, never under
+ *    not(), so no negation, ordering or pattern can widen a borrower's rows;
  *  - variant `when` guards are claims-only: capability()/role() under
  *    and/or/not. (claim() comparisons in `when` are not representable in the
  *    v2.0 IR — a targeted error says so.)
+ *  - `visible(<link-path>)` lowers to `exists(<link-path>, <target read policy>)`,
+ *    compiled from the target's own read policy expression at the combined
+ *    depth. A read policy that reaches itself again through visible() is a
+ *    cycle and refused; a target with no read policy is readable to everyone
+ *    who may use the namespace, so visibility reduces to existence.
  */
 
 declare const POLICY_MAX_LINK_DEPTH = 3;
 interface PolicyColumnInfo {
     readonly name: string;
     readonly columnName: string;
+    /**
+     * The column's IR type when the resolver knows it (TableMetaIr always does).
+     * Required for a verified-borrower claim comparison: unknown is refused.
+     */
+    readonly type?: unknown;
 }
 interface PolicyLinkInfo {
     readonly name: string;
@@ -112,6 +135,19 @@ interface PolicyTableInfo {
 /** `{ tables }` keyed by table name — TableMetaIr's record is assignable. */
 interface PolicyResolver {
     readonly tables: Record<string, PolicyTableInfo>;
+    /**
+     * A table's read policy expression, for `visible()`. Return `undefined` when
+     * the table has none (readable to every namespace user). A resolver without
+     * this callback cannot compile `visible()`: it is refused, never guessed.
+     */
+    readonly readPolicy?: (table: string) => PolicyExpression | undefined;
+    /**
+     * The namespace that owns a table's policies, in a composed namespace. A
+     * visible() expansion of an imported table's read policy evaluates its
+     * capability() and role() checks in that namespace, not the importer's.
+     * Omitted (or undefined for a table) leaves them unscoped.
+     */
+    readonly policyNamespace?: (table: string) => string | undefined;
 }
 interface CompilePredicateInput {
     /** DSL source text, or an already-parsed policy. */
@@ -123,11 +159,20 @@ interface CompilePredicateInput {
 declare function compilePredicateV2({ expression, table, resolver, maxLinkDepth }: CompilePredicateInput): PredIr;
 /** Variant `when` guards may only test claims: capability()/role() under and/or/not. */
 declare function assertClaimsOnlyWhen(parsed: ParsedPolicy): void;
+/** Which of a table's policies is being compiled. */
+type PolicyAccess = 'read' | 'write' | 'insert' | 'update';
 interface CompilePolicyInput {
     expression: PolicyExpression;
     table: string;
     resolver: PolicyResolver;
     maxLinkDepth?: number;
+    /**
+     * Default 'read'. A read policy that reaches its own table through visible()
+     * is a cycle; a write policy that follows a self-link (a subtask written
+     * under a parent the caller can read) only expands the read policy, so it
+     * does not start the cycle check at its own table.
+     */
+    access?: PolicyAccess;
 }
 /**
  * Policy expression (string or `{default, variants}`) → one PredIr under §4c
@@ -138,6 +183,6 @@ interface CompilePolicyInput {
  * Granting a role/capability only ever widens access; `allow: true`
  * short-circuits its branch to the guard alone.
  */
-declare function compilePolicy({ expression, table, resolver, maxLinkDepth }: CompilePolicyInput): PredIr;
+declare function compilePolicy({ expression, table, resolver, maxLinkDepth, access }: CompilePolicyInput): PredIr;
 
-export { type CompilePolicyInput, type CompilePredicateInput, POLICY_COMPARE_OPS, POLICY_MAX_LINK_DEPTH, type ParsedPolicy, type PolicyColumnInfo, type PolicyCompareOp, PolicyCompileError, type PolicyCompileErrorCode, type PolicyLinkInfo, type PolicyNode, type PolicyOperand, PolicyParseError, type PolicyResolver, type PolicyTableInfo, assertClaimsOnlyWhen, compilePolicy, compilePredicateV2, parsePolicy, walkPolicy };
+export { type CompilePolicyInput, type CompilePredicateInput, POLICY_COMPARE_OPS, POLICY_MAX_LINK_DEPTH, type ParsedPolicy, type PolicyAccess, type PolicyColumnInfo, type PolicyCompareOp, PolicyCompileError, type PolicyCompileErrorCode, type PolicyLinkInfo, type PolicyNode, type PolicyOperand, PolicyParseError, type PolicyResolver, type PolicyTableInfo, assertClaimsOnlyWhen, compilePolicy, compilePredicateV2, parsePolicy, walkPolicy };

package/dist/predicate-v2.d.ts

@@ -11,7 +11,7 @@ type PolicyOperand =
     kind: 'path';
     segments: readonly string[];
 }
-/** `claim('sub')` / `claim('org')` — the only claim() keys in CLAIMS_CONTRACT. */
+/** `claim('sub')` / `claim('org')` / `claim('ext_subject')` / `claim('ext_email')` — the scalar keys in CLAIMS_CONTRACT. */
  | {
     kind: 'claim';
     key: ClaimKey;
@@ -50,6 +50,16 @@ type PolicyNode = {
     kind: 'exists';
     path: readonly string[];
     where: PolicyNode;
+}
+/**
+ * `visible(<link-path>)` — a related row exists AND the caller may read it:
+ * the final target's own read policy is compiled in as the inner predicate.
+ * Lets a write policy say "only on a parent you can see" without restating
+ * the parent's rule (and without drifting from it).
+ */
+ | {
+    kind: 'visible';
+    path: readonly string[];
 };
 interface ParsedPolicy {
     readonly source: string;
@@ -63,7 +73,7 @@ declare class PolicyParseError extends Error {
     readonly name = "PolicyParseError";
     constructor(message: string, position: number);
 }
-type PolicyCompileErrorCode = 'unknown-table' | 'unknown-column' | 'unknown-link' | 'not-to-one' | 'link-depth-exceeded' | 'unsupported-comparison' | 'invalid-null-comparison' | 'when-not-claims-only';
+type PolicyCompileErrorCode = 'unknown-table' | 'unknown-column' | 'unknown-link' | 'not-to-one' | 'link-depth-exceeded' | 'unsupported-comparison' | 'invalid-null-comparison' | 'when-not-claims-only' | 'claim-type-mismatch' | 'visible-unresolvable' | 'visible-cycle';
 /**
  * Compile-time failure — the parsed policy references something the table
  * doesn't declare, or uses a shape the v2.0 IR cannot represent. Carries
@@ -90,15 +100,28 @@ declare function parsePolicy(source: string): ParsedPolicy;
  *  - a comparison must reference exactly ONE column side (column↔column and
  *    claims↔literal comparisons have no PredIr shape in v2.0);
  *  - `col = null` / `col != null` normalize to the isNull operator;
+ *  - verified-borrower claims (`claim('ext_subject')`, `claim('ext_email')`)
+ *    are text: they compare to a text column with `=` only, never under
+ *    not(), so no negation, ordering or pattern can widen a borrower's rows;
  *  - variant `when` guards are claims-only: capability()/role() under
  *    and/or/not. (claim() comparisons in `when` are not representable in the
  *    v2.0 IR — a targeted error says so.)
+ *  - `visible(<link-path>)` lowers to `exists(<link-path>, <target read policy>)`,
+ *    compiled from the target's own read policy expression at the combined
+ *    depth. A read policy that reaches itself again through visible() is a
+ *    cycle and refused; a target with no read policy is readable to everyone
+ *    who may use the namespace, so visibility reduces to existence.
  */
 
 declare const POLICY_MAX_LINK_DEPTH = 3;
 interface PolicyColumnInfo {
     readonly name: string;
     readonly columnName: string;
+    /**
+     * The column's IR type when the resolver knows it (TableMetaIr always does).
+     * Required for a verified-borrower claim comparison: unknown is refused.
+     */
+    readonly type?: unknown;
 }
 interface PolicyLinkInfo {
     readonly name: string;
@@ -112,6 +135,19 @@ interface PolicyTableInfo {
 /** `{ tables }` keyed by table name — TableMetaIr's record is assignable. */
 interface PolicyResolver {
     readonly tables: Record<string, PolicyTableInfo>;
+    /**
+     * A table's read policy expression, for `visible()`. Return `undefined` when
+     * the table has none (readable to every namespace user). A resolver without
+     * this callback cannot compile `visible()`: it is refused, never guessed.
+     */
+    readonly readPolicy?: (table: string) => PolicyExpression | undefined;
+    /**
+     * The namespace that owns a table's policies, in a composed namespace. A
+     * visible() expansion of an imported table's read policy evaluates its
+     * capability() and role() checks in that namespace, not the importer's.
+     * Omitted (or undefined for a table) leaves them unscoped.
+     */
+    readonly policyNamespace?: (table: string) => string | undefined;
 }
 interface CompilePredicateInput {
     /** DSL source text, or an already-parsed policy. */
@@ -123,11 +159,20 @@ interface CompilePredicateInput {
 declare function compilePredicateV2({ expression, table, resolver, maxLinkDepth }: CompilePredicateInput): PredIr;
 /** Variant `when` guards may only test claims: capability()/role() under and/or/not. */
 declare function assertClaimsOnlyWhen(parsed: ParsedPolicy): void;
+/** Which of a table's policies is being compiled. */
+type PolicyAccess = 'read' | 'write' | 'insert' | 'update';
 interface CompilePolicyInput {
     expression: PolicyExpression;
     table: string;
     resolver: PolicyResolver;
     maxLinkDepth?: number;
+    /**
+     * Default 'read'. A read policy that reaches its own table through visible()
+     * is a cycle; a write policy that follows a self-link (a subtask written
+     * under a parent the caller can read) only expands the read policy, so it
+     * does not start the cycle check at its own table.
+     */
+    access?: PolicyAccess;
 }
 /**
  * Policy expression (string or `{default, variants}`) → one PredIr under §4c
@@ -138,6 +183,6 @@ interface CompilePolicyInput {
  * Granting a role/capability only ever widens access; `allow: true`
  * short-circuits its branch to the guard alone.
  */
-declare function compilePolicy({ expression, table, resolver, maxLinkDepth }: CompilePolicyInput): PredIr;
+declare function compilePolicy({ expression, table, resolver, maxLinkDepth, access }: CompilePolicyInput): PredIr;
 
-export { type CompilePolicyInput, type CompilePredicateInput, POLICY_COMPARE_OPS, POLICY_MAX_LINK_DEPTH, type ParsedPolicy, type PolicyColumnInfo, type PolicyCompareOp, PolicyCompileError, type PolicyCompileErrorCode, type PolicyLinkInfo, type PolicyNode, type PolicyOperand, PolicyParseError, type PolicyResolver, type PolicyTableInfo, assertClaimsOnlyWhen, compilePolicy, compilePredicateV2, parsePolicy, walkPolicy };
+export { type CompilePolicyInput, type CompilePredicateInput, POLICY_COMPARE_OPS, POLICY_MAX_LINK_DEPTH, type ParsedPolicy, type PolicyAccess, type PolicyColumnInfo, type PolicyCompareOp, PolicyCompileError, type PolicyCompileErrorCode, type PolicyLinkInfo, type PolicyNode, type PolicyOperand, PolicyParseError, type PolicyResolver, type PolicyTableInfo, assertClaimsOnlyWhen, compilePolicy, compilePredicateV2, parsePolicy, walkPolicy };

package/dist/predicate-v2.js

@@ -1056,14 +1056,20 @@ z.object({ irVersion: irVersionSchema });
 var CLAIMS_CONTRACT = {
   sub: "string",
   org: "string?",
+  ext_subject: "string?",
+  ext_email: "string?",
   roles: "string[]",
   capabilities: "string[]"
 };
+var EXTERNAL_POLICY_CLAIM_KEYS = ["ext_subject", "ext_email"];
+function isExternalPolicyClaimKey(key) {
+  return EXTERNAL_POLICY_CLAIM_KEYS.includes(key);
+}
 var scalarLiteral = z.union([z.string(), z.number(), z.boolean(), z.null()]);
 var valueIrSchema = z.discriminatedUnion("kind", [
   z.object({ kind: z.literal("literal"), value: z.union([scalarLiteral, z.array(scalarLiteral)]) }),
   z.object({ kind: z.literal("variable"), name: z.string() }),
-  z.object({ kind: z.literal("claim"), key: z.enum(["sub", "org"]) })
+  z.object({ kind: z.literal("claim"), key: z.enum(["sub", "org", ...EXTERNAL_POLICY_CLAIM_KEYS]) })
 ]);
 var CMP_OPS = [
   "eq",
@@ -1634,6 +1640,7 @@ var Parser2 = class {
       return node;
     }
     if (this.peekKeyword("exists")) return this.parseExists();
+    if (this.peekKeyword("visible") && this.tokens[this.index + 1]?.kind === "lparen") return this.parseVisible();
     return this.parseComparison();
   }
   parseBooleanCall(fn) {
@@ -1653,6 +1660,13 @@ var Parser2 = class {
     this.expect("rparen", "')' closing exists(...)");
     return { kind: "exists", path, where };
   }
+  parseVisible() {
+    this.advance();
+    this.expect("lparen", "'(' after visible");
+    const path = this.parsePath("a link path in visible(...)");
+    this.expect("rparen", "')' closing visible(...)");
+    return { kind: "visible", path };
+  }
   parseComparison() {
     const left = this.parseOperand();
     const operator = this.expect("operator", "a comparison operator");
@@ -1768,6 +1782,24 @@ function parsePolicy(source) {
 
 // src/predicate-v2/compile.ts
 var POLICY_MAX_LINK_DEPTH = 3;
+function scopeToNamespace(pred, namespace) {
+  switch (pred.kind) {
+    case "capability":
+    case "role":
+      return pred.namespace ? pred : { ...pred, namespace };
+    case "and":
+    case "or":
+      return { ...pred, operands: pred.operands.map((operand) => scopeToNamespace(operand, namespace)) };
+    case "not":
+      return { ...pred, operand: scopeToNamespace(pred.operand, namespace) };
+    case "exists":
+      return { ...pred, where: scopeToNamespace(pred.where, namespace) };
+    case "aggPredicate":
+      return pred.where ? { ...pred, where: scopeToNamespace(pred.where, namespace) } : pred;
+    default:
+      return pred;
+  }
+}
 var CMP_BY_OP = {
   "=": "eq",
   "!=": "neq",
@@ -1801,7 +1833,7 @@ function resolveLink(info, ref) {
 function columnCandidates(info) {
   return [...info.columns.map((c) => c.name), ...info.links.map((l) => l.name)];
 }
-var PolicyCompiler = class {
+var PolicyCompiler = class _PolicyCompiler {
   constructor(ctx) {
     this.ctx = ctx;
   }
@@ -1813,13 +1845,16 @@ var PolicyCompiler = class {
       case "or":
         return { kind: node.kind, operands: node.operands.map((operand) => this.compile(operand, table, depth)) };
       case "not":
-        return { kind: "not", operand: this.compile(node.operand, table, depth) };
+        assertNoNegatedExternalClaim(node.operand);
+        return { kind: "not", operand: new _PolicyCompiler({ ...this.ctx, negated: true }).compile(node.operand, table, depth) };
       case "capability":
         return { kind: "capability", key: node.key };
       case "role":
         return { kind: "role", key: node.key };
       case "exists":
         return this.compileExists(node.path, node.where, table, depth);
+      case "visible":
+        return this.compileVisible(node.path, table, depth);
       case "compare":
         return this.compileCompare(node, table, depth);
     }
@@ -1833,6 +1868,36 @@ var PolicyCompiler = class {
     }
     return pred;
   }
+  /** `visible(path)` → `exists(path, <final target's read policy>)`. */
+  compileVisible(path, table, depth) {
+    const { links, finalTable } = this.resolveLinkPath(path, table, depth, { toOneOnly: false });
+    const readPolicy = this.ctx.resolver.readPolicy;
+    if (!readPolicy) {
+      throw new PolicyCompileError(
+        `visible(${path.join(".")}) needs the target's read policy, which this compile context does not provide`,
+        "visible-unresolvable"
+      );
+    }
+    if (this.ctx.visiting.includes(finalTable)) {
+      throw new PolicyCompileError(
+        `visible(${path.join(".")}) on '${table}' reaches '${finalTable}' whose read policy is already being expanded (${[...this.ctx.visiting, finalTable].join(" \u2192 ")})`,
+        "visible-cycle"
+      );
+    }
+    const expression = readPolicy(finalTable);
+    let pred = expression === void 0 ? { kind: "const", value: true } : compilePolicyAt({
+      expression,
+      table: finalTable,
+      ctx: { ...this.ctx, visiting: [...this.ctx.visiting, finalTable] },
+      depth: depth + links.length
+    });
+    const owner = this.ctx.resolver.policyNamespace?.(finalTable);
+    if (owner) pred = scopeToNamespace(pred, owner);
+    for (let i = links.length - 1; i >= 0; i -= 1) {
+      pred = { kind: "exists", link: links[i].name, where: pred };
+    }
+    return pred;
+  }
   resolveLinkPath(path, table, depth, { toOneOnly }) {
     const links = [];
     let current = table;
@@ -1892,6 +1957,10 @@ var PolicyCompiler = class {
         columnCandidates(info)
       );
     }
+    if (valueSide.kind === "claim" && isExternalPolicyClaimKey(valueSide.key)) {
+      if (this.ctx.negated) throw negatedExternalClaim(valueSide.key);
+      assertExternalClaimComparison({ op, key: valueSide.key, column: info.columns.find((c) => c.name === column) });
+    }
     let cmp = this.buildCmp(op, column, valueSide);
     for (let i = links.length - 1; i >= 0; i -= 1) {
       cmp = { kind: "exists", link: links[i].name, where: cmp };
@@ -1912,10 +1981,45 @@ var PolicyCompiler = class {
     return { kind: "cmp", op: CMP_BY_OP[op], column, value };
   }
 };
+function assertExternalClaimComparison({ op, key, column }) {
+  if (op !== "=") {
+    throw new PolicyCompileError(
+      `claim('${key}') supports = comparisons only, got '${op}'`,
+      "unsupported-comparison"
+    );
+  }
+  if (column?.type !== "text") {
+    const actual = column?.type === void 0 ? "of unknown type" : typeof column.type === "string" ? column.type : "an enum";
+    throw new PolicyCompileError(
+      `claim('${key}') is text and compares to a text column only \u2014 '${column?.name ?? "?"}' is ${actual}`,
+      "claim-type-mismatch"
+    );
+  }
+}
+function negatedExternalClaim(key) {
+  return new PolicyCompileError(
+    `claim('${key}') cannot appear under not(): a negated borrower comparison admits other borrowers' rows`,
+    "unsupported-comparison"
+  );
+}
+function assertNoNegatedExternalClaim(operand) {
+  walkPolicy(operand, (node) => {
+    if (node.kind !== "compare") return;
+    const claim = [node.left, node.right].find((side) => side.kind === "claim" && isExternalPolicyClaimKey(side.key));
+    if (claim?.kind === "claim") throw negatedExternalClaim(claim.key);
+  });
+}
 function compilePredicateV2({ expression, table, resolver, maxLinkDepth }) {
+  return compilePredicateAt({
+    expression,
+    table,
+    depth: 0,
+    ctx: { resolver, maxLinkDepth: maxLinkDepth ?? POLICY_MAX_LINK_DEPTH, visiting: [table] }
+  });
+}
+function compilePredicateAt({ expression, table, ctx, depth }) {
   const parsed = typeof expression === "string" ? parsePolicy(expression) : expression;
-  const compiler = new PolicyCompiler({ resolver, maxLinkDepth: maxLinkDepth ?? POLICY_MAX_LINK_DEPTH });
-  return compiler.compile(parsed.ast, table, 0);
+  return new PolicyCompiler(ctx).compile(parsed.ast, table, depth);
 }
 function assertClaimsOnlyWhen(parsed) {
   walkPolicy(parsed.ast, (node) => {
@@ -1932,25 +2036,34 @@ function assertClaimsOnlyWhen(parsed) {
         "when-not-claims-only"
       );
     }
-    if (node.kind === "exists") {
+    if (node.kind === "exists" || node.kind === "visible") {
       throw new PolicyCompileError(
-        "variant 'when' guards are claims-only \u2014 exists() is not allowed",
+        `variant 'when' guards are claims-only \u2014 ${node.kind}() is not allowed`,
         "when-not-claims-only"
       );
     }
   });
 }
-function compilePolicy({ expression, table, resolver, maxLinkDepth }) {
-  if (typeof expression === "string") {
-    return compilePredicateV2({ expression, table, resolver, maxLinkDepth });
-  }
-  const defaultPred = compilePredicateV2({ expression: expression.default, table, resolver, maxLinkDepth });
+function initialVisiting({ table, access }) {
+  return (access ?? "read") === "read" ? [table] : [];
+}
+function compilePolicy({ expression, table, resolver, maxLinkDepth, access }) {
+  return compilePolicyAt({
+    expression,
+    table,
+    depth: 0,
+    ctx: { resolver, maxLinkDepth: maxLinkDepth ?? POLICY_MAX_LINK_DEPTH, visiting: initialVisiting({ table, access }) }
+  });
+}
+function compilePolicyAt({ expression, table, ctx, depth }) {
+  if (typeof expression === "string") return compilePredicateAt({ expression, table, ctx, depth });
+  const defaultPred = compilePredicateAt({ expression: expression.default, table, ctx, depth });
   if (expression.variants.length === 0) return defaultPred;
   const branches = expression.variants.map((variant) => {
     const parsedWhen = parsePolicy(variant.when);
     assertClaimsOnlyWhen(parsedWhen);
-    const when = compilePredicateV2({ expression: parsedWhen, table, resolver, maxLinkDepth });
-    const grant = variant.allow === true ? { kind: "const", value: true } : compilePredicateV2({ expression: variant.policy, table, resolver, maxLinkDepth });
+    const when = compilePredicateAt({ expression: parsedWhen, table, ctx, depth });
+    const grant = variant.allow === true ? { kind: "const", value: true } : compilePredicateAt({ expression: variant.policy, table, ctx, depth });
     return { kind: "and", operands: [when, grant] };
   });
   return { kind: "or", operands: [defaultPred, ...branches] };