@cullet/erp-core 1.0.1 → 1.0.3

package/src/core/policies/asof/asof.ts

@@ -6,63 +6,63 @@ import { isValidDate } from "../../shared/temporal-guards";
 const DEFAULT_MAX_AS_OF_FUTURE_YEARS = 10;
 
 export interface DeriveAsOfOptions {
-  readonly maxFutureYears?: number;
+    readonly maxFutureYears?: number;
 }
 
 export class PolicyAsOfResolver {
-  private static resolveMaxFutureYears(
-    options: DeriveAsOfOptions,
-  ): Result<number, string> {
-    const maxFutureYears =
-      options.maxFutureYears ?? DEFAULT_MAX_AS_OF_FUTURE_YEARS;
+    private static resolveMaxFutureYears(
+        options: DeriveAsOfOptions,
+    ): Result<number, string> {
+        const maxFutureYears =
+            options.maxFutureYears ?? DEFAULT_MAX_AS_OF_FUTURE_YEARS;
 
-    if (!Number.isInteger(maxFutureYears) || maxFutureYears < 0) {
-      return Result.err(
-        `deriveAsOf maxFutureYears must be a non-negative integer. Received: ${maxFutureYears}`,
-      );
-    }
-
-    return Result.ok(maxFutureYears);
-  }
+        if (!Number.isInteger(maxFutureYears) || maxFutureYears < 0) {
+            return Result.err(
+                `deriveAsOf maxFutureYears must be a non-negative integer. Received: ${maxFutureYears}`,
+            );
+        }
 
-  static derive(
-    source: AsOfSource,
-    seed: ContextSeed,
-    now: Date,
-    options: DeriveAsOfOptions = {},
-  ): Result<Date, string> {
-    const maxFutureYearsResult =
-      PolicyAsOfResolver.resolveMaxFutureYears(options);
-    if (maxFutureYearsResult.isErr()) {
-      return Result.err(maxFutureYearsResult.errorOrNull()!);
+        return Result.ok(maxFutureYears);
     }
-    const maxFutureYears = maxFutureYearsResult.getOrNull()!;
-
-    switch (source) {
-      case "NOW":
-        return Result.ok(now);
 
-      case "CALLER_PROVIDED": {
-        const asOf = seed.fields["asOf"];
-        if (!isValidDate(asOf)) {
-          return Result.err(
-            'asOfSource "CALLER_PROVIDED" requires seed.fields.asOf to be a Date',
-          );
+    static derive(
+        source: AsOfSource,
+        seed: ContextSeed,
+        now: Date,
+        options: DeriveAsOfOptions = {},
+    ): Result<Date, string> {
+        const maxFutureYearsResult =
+            PolicyAsOfResolver.resolveMaxFutureYears(options);
+        if (maxFutureYearsResult.isErr()) {
+            return Result.err(maxFutureYearsResult.errorOrNull()!);
         }
+        const maxFutureYears = maxFutureYearsResult.getOrNull()!;
 
-        const maxFuture = new Date(now);
-        maxFuture.setFullYear(maxFuture.getFullYear() + maxFutureYears);
-        if (asOf > maxFuture) {
-          return Result.err(
-            `asOf date is more than ${maxFutureYears} years in the future (received ${asOf.toISOString()})`,
-          );
-        }
+        switch (source) {
+            case "NOW":
+                return Result.ok(now);
+
+            case "CALLER_PROVIDED": {
+                const asOf = seed.fields["asOf"];
+                if (!isValidDate(asOf)) {
+                    return Result.err(
+                        'asOfSource "CALLER_PROVIDED" requires seed.fields.asOf to be a Date',
+                    );
+                }
 
-        return Result.ok(asOf);
-      }
+                const maxFuture = new Date(now);
+                maxFuture.setFullYear(maxFuture.getFullYear() + maxFutureYears);
+                if (asOf > maxFuture) {
+                    return Result.err(
+                        `asOf date is more than ${maxFutureYears} years in the future (received ${asOf.toISOString()})`,
+                    );
+                }
 
-      default:
-        return Result.err(`Unknown asOfSource: "${source}"`);
+                return Result.ok(asOf);
+            }
+
+            default:
+                return Result.err(`Unknown asOfSource: "${source}"`);
+        }
     }
-  }
 }

package/src/core/policies/catalog/catalog.instance.ts

@@ -11,11 +11,13 @@ import { PolicyCatalogEntry } from "./policy-catalog-entry";
  * are responsible for passing all relevant packages at composition time.
  */
 export class PolicyCatalogFactory {
-  static build(packages: readonly PolicyPackage[]): PolicyCatalog {
-    const entries = packages.flatMap((policyPackage) =>
-      Array.from(policyPackage.catalogEntries).map(PolicyCatalogEntry.from),
-    );
+    static build(packages: readonly PolicyPackage[]): PolicyCatalog {
+        const entries = packages.flatMap((policyPackage) =>
+            Array.from(policyPackage.catalogEntries).map(
+                PolicyCatalogEntry.from,
+            ),
+        );
 
-    return new PolicyCatalog(entries);
-  }
+        return new PolicyCatalog(entries);
+    }
 }

package/src/core/policies/catalog/index.ts

@@ -1,8 +1,8 @@
 export type {
-  AsOfSource,
-  PolicyKind,
-  PolicyOwner,
-  PolicyScopeLevel,
+    AsOfSource,
+    PolicyKind,
+    PolicyOwner,
+    PolicyScopeLevel,
 } from "./catalog-types";
 export type { PolicyCatalogEntryProps } from "./policy-catalog-entry";
 export { PolicyCatalogEntry } from "./policy-catalog-entry";

package/src/core/policies/catalog/policy-catalog-entry.ts

@@ -1,10 +1,10 @@
 import { UnexpectedError } from "../../errors";
 
 import type {
-  AsOfSource,
-  PolicyKind,
-  PolicyOwner,
-  PolicyScopeLevel,
+    AsOfSource,
+    PolicyKind,
+    PolicyOwner,
+    PolicyScopeLevel,
 } from "./catalog-types";
 import type { PolicyKey } from "./policy-key";
 
@@ -12,18 +12,18 @@ import type { PolicyKey } from "./policy-key";
  * Properties for creating a PolicyCatalogEntry.
  */
 export interface PolicyCatalogEntryProps {
-  readonly key: PolicyKey;
-  readonly kind: PolicyKind;
-  readonly gateEngineVersion?: number;
-  readonly computeEngineVersion?: number;
-  readonly payloadSchemaVersion?: number;
-  readonly owner: PolicyOwner;
-  readonly allowedScopes: readonly PolicyScopeLevel[];
-  readonly asOfSource: AsOfSource;
-  /** Paths the context must contain for this policy to be evaluable. */
-  readonly contextRequirements: readonly string[];
-  readonly tags?: readonly string[];
-  readonly description: string;
+    readonly key: PolicyKey;
+    readonly kind: PolicyKind;
+    readonly gateEngineVersion?: number;
+    readonly computeEngineVersion?: number;
+    readonly payloadSchemaVersion?: number;
+    readonly owner: PolicyOwner;
+    readonly allowedScopes: readonly PolicyScopeLevel[];
+    readonly asOfSource: AsOfSource;
+    /** Paths the context must contain for this policy to be evaluable. */
+    readonly contextRequirements: readonly string[];
+    readonly tags?: readonly string[];
+    readonly description: string;
 }
 
 /**
@@ -31,190 +31,192 @@ export interface PolicyCatalogEntryProps {
  * Encapsulates metadata and validation logic for a policy.
  */
 export class PolicyCatalogEntry {
-  public readonly key: PolicyKey;
-  public readonly kind: PolicyKind;
-
-  public readonly gateEngineVersion?: number;
-  public readonly computeEngineVersion?: number;
-  public readonly payloadSchemaVersion?: number;
-
-  public readonly owner: PolicyOwner;
-  public readonly allowedScopes: readonly PolicyScopeLevel[];
-  public readonly asOfSource: AsOfSource;
-  public readonly contextRequirements: readonly string[];
-  public readonly tags: readonly string[];
-  public readonly description: string;
-
-  constructor(props: PolicyCatalogEntryProps) {
-    this.key = props.key;
-    this.kind = props.kind;
-    this.gateEngineVersion = props.gateEngineVersion;
-    this.computeEngineVersion = props.computeEngineVersion;
-    this.payloadSchemaVersion = props.payloadSchemaVersion;
-    this.owner = props.owner;
-    this.allowedScopes = [...props.allowedScopes];
-    this.asOfSource = props.asOfSource;
-    this.contextRequirements = [...props.contextRequirements];
-    this.tags = [...(props.tags ?? [])];
-    this.description = props.description;
-  }
-
-  static assertFamilyConsistency(entries: readonly PolicyCatalogEntry[]): void {
-    if (entries.length === 0) {
-      throw new UnexpectedError(
-        "Cannot validate an empty PolicyCatalogEntry family",
-      );
-    }
-
-    const [first, ...rest] = entries;
-    for (const entry of rest) {
-      if (!first.key.equals(entry.key)) {
-        throw new UnexpectedError(
-          "Cannot merge PolicyCatalog entries with different keys",
-        );
-      }
+    public readonly key: PolicyKey;
+    public readonly kind: PolicyKind;
+
+    public readonly gateEngineVersion?: number;
+    public readonly computeEngineVersion?: number;
+    public readonly payloadSchemaVersion?: number;
+
+    public readonly owner: PolicyOwner;
+    public readonly allowedScopes: readonly PolicyScopeLevel[];
+    public readonly asOfSource: AsOfSource;
+    public readonly contextRequirements: readonly string[];
+    public readonly tags: readonly string[];
+    public readonly description: string;
+
+    constructor(props: PolicyCatalogEntryProps) {
+        this.key = props.key;
+        this.kind = props.kind;
+        this.gateEngineVersion = props.gateEngineVersion;
+        this.computeEngineVersion = props.computeEngineVersion;
+        this.payloadSchemaVersion = props.payloadSchemaVersion;
+        this.owner = props.owner;
+        this.allowedScopes = [...props.allowedScopes];
+        this.asOfSource = props.asOfSource;
+        this.contextRequirements = [...props.contextRequirements];
+        this.tags = [...(props.tags ?? [])];
+        this.description = props.description;
+    }
 
-      if (first.kind !== entry.kind) {
-        throw new UnexpectedError(
-          `PolicyCatalog entries for key "${first.key.toString()}" must share the same kind`,
-        );
-      }
+    static assertFamilyConsistency(
+        entries: readonly PolicyCatalogEntry[],
+    ): void {
+        if (entries.length === 0) {
+            throw new UnexpectedError(
+                "Cannot validate an empty PolicyCatalogEntry family",
+            );
+        }
+
+        const [first, ...rest] = entries;
+        for (const entry of rest) {
+            if (!first.key.equals(entry.key)) {
+                throw new UnexpectedError(
+                    "Cannot merge PolicyCatalog entries with different keys",
+                );
+            }
+
+            if (first.kind !== entry.kind) {
+                throw new UnexpectedError(
+                    `PolicyCatalog entries for key "${first.key.toString()}" must share the same kind`,
+                );
+            }
+
+            if (first.owner !== entry.owner) {
+                throw new UnexpectedError(
+                    `PolicyCatalog entries for key "${first.key.toString()}" must share the same owner`,
+                );
+            }
+
+            if (first.asOfSource !== entry.asOfSource) {
+                throw new UnexpectedError(
+                    `PolicyCatalog entries for key "${first.key.toString()}" must share the same asOfSource`,
+                );
+            }
+
+            if (first.description !== entry.description) {
+                throw new UnexpectedError(
+                    `PolicyCatalog entries for key "${first.key.toString()}" must share the same description`,
+                );
+            }
+        }
+    }
 
-      if (first.owner !== entry.owner) {
-        throw new UnexpectedError(
-          `PolicyCatalog entries for key "${first.key.toString()}" must share the same owner`,
-        );
-      }
+    static from(
+        entry: PolicyCatalogEntry | PolicyCatalogEntryProps,
+    ): PolicyCatalogEntry {
+        return entry instanceof PolicyCatalogEntry
+            ? entry
+            : new PolicyCatalogEntry(entry);
+    }
 
-      if (first.asOfSource !== entry.asOfSource) {
-        throw new UnexpectedError(
-          `PolicyCatalog entries for key "${first.key.toString()}" must share the same asOfSource`,
-        );
-      }
+    isGate(): boolean {
+        return this.kind === "GATE";
+    }
+
+    isCompute(): boolean {
+        return this.kind === "COMPUTE";
+    }
+
+    allowsScope(scope: PolicyScopeLevel): boolean {
+        return this.allowedScopes.includes(scope);
+    }
 
-      if (first.description !== entry.description) {
-        throw new UnexpectedError(
-          `PolicyCatalog entries for key "${first.key.toString()}" must share the same description`,
+    hasExplicitVersionSelector(): boolean {
+        return (
+            this.gateEngineVersion !== undefined ||
+            this.computeEngineVersion !== undefined ||
+            this.payloadSchemaVersion !== undefined
         );
-      }
-    }
-  }
-
-  static from(
-    entry: PolicyCatalogEntry | PolicyCatalogEntryProps,
-  ): PolicyCatalogEntry {
-    return entry instanceof PolicyCatalogEntry
-      ? entry
-      : new PolicyCatalogEntry(entry);
-  }
-
-  isGate(): boolean {
-    return this.kind === "GATE";
-  }
-
-  isCompute(): boolean {
-    return this.kind === "COMPUTE";
-  }
-
-  allowsScope(scope: PolicyScopeLevel): boolean {
-    return this.allowedScopes.includes(scope);
-  }
-
-  hasExplicitVersionSelector(): boolean {
-    return (
-      this.gateEngineVersion !== undefined ||
-      this.computeEngineVersion !== undefined ||
-      this.payloadSchemaVersion !== undefined
-    );
-  }
-
-  matchesVersion(params: {
-    readonly kind: PolicyKind;
-    readonly gateEngineVersion?: number;
-    readonly computeEngineVersion?: number;
-    readonly payloadSchemaVersion?: number;
-  }): boolean {
-    if (this.kind !== params.kind) {
-      return false;
-    }
-
-    if (
-      this.gateEngineVersion !== undefined &&
-      this.gateEngineVersion !== params.gateEngineVersion
-    ) {
-      return false;
-    }
-
-    if (
-      this.computeEngineVersion !== undefined &&
-      this.computeEngineVersion !== params.computeEngineVersion
-    ) {
-      return false;
-    }
-
-    if (
-      this.payloadSchemaVersion !== undefined &&
-      this.payloadSchemaVersion !== params.payloadSchemaVersion
-    ) {
-      return false;
-    }
-
-    return true;
-  }
-
-  toVariantKey(): string {
-    return [
-      this.key.toString(),
-      this.kind,
-      this.gateEngineVersion ?? "gate:any",
-      this.computeEngineVersion ?? "compute:any",
-      this.payloadSchemaVersion ?? "schema:any",
-    ].join("::");
-  }
-
-  usesNowAsOf(): boolean {
-    return this.asOfSource === "NOW";
-  }
-
-  usesCallerProvidedAsOf(): boolean {
-    return this.asOfSource === "CALLER_PROVIDED";
-  }
-
-  requiresContext(path: string): boolean {
-    return this.contextRequirements.includes(path);
-  }
-
-  requiresAllContexts(paths: readonly string[]): boolean {
-    return paths.every((path) => this.requiresContext(path));
-  }
-
-  hasTag(tag: string): boolean {
-    return this.tags.includes(tag);
-  }
-
-  equals(other: PolicyCatalogEntry): boolean {
-    return this.key.equals(other.key);
-  }
-
-  toJSON(): PolicyCatalogEntryProps {
-    return {
-      key: this.key,
-      kind: this.kind,
-      ...(this.gateEngineVersion !== undefined
-        ? { gateEngineVersion: this.gateEngineVersion }
-        : {}),
-      ...(this.computeEngineVersion !== undefined
-        ? { computeEngineVersion: this.computeEngineVersion }
-        : {}),
-      ...(this.payloadSchemaVersion !== undefined
-        ? { payloadSchemaVersion: this.payloadSchemaVersion }
-        : {}),
-      owner: this.owner,
-      allowedScopes: [...this.allowedScopes],
-      asOfSource: this.asOfSource,
-      contextRequirements: [...this.contextRequirements],
-      tags: this.tags.length > 0 ? [...this.tags] : undefined,
-      description: this.description,
-    };
-  }
+    }
+
+    matchesVersion(params: {
+        readonly kind: PolicyKind;
+        readonly gateEngineVersion?: number;
+        readonly computeEngineVersion?: number;
+        readonly payloadSchemaVersion?: number;
+    }): boolean {
+        if (this.kind !== params.kind) {
+            return false;
+        }
+
+        if (
+            this.gateEngineVersion !== undefined &&
+            this.gateEngineVersion !== params.gateEngineVersion
+        ) {
+            return false;
+        }
+
+        if (
+            this.computeEngineVersion !== undefined &&
+            this.computeEngineVersion !== params.computeEngineVersion
+        ) {
+            return false;
+        }
+
+        if (
+            this.payloadSchemaVersion !== undefined &&
+            this.payloadSchemaVersion !== params.payloadSchemaVersion
+        ) {
+            return false;
+        }
+
+        return true;
+    }
+
+    toVariantKey(): string {
+        return [
+            this.key.toString(),
+            this.kind,
+            this.gateEngineVersion ?? "gate:any",
+            this.computeEngineVersion ?? "compute:any",
+            this.payloadSchemaVersion ?? "schema:any",
+        ].join("::");
+    }
+
+    usesNowAsOf(): boolean {
+        return this.asOfSource === "NOW";
+    }
+
+    usesCallerProvidedAsOf(): boolean {
+        return this.asOfSource === "CALLER_PROVIDED";
+    }
+
+    requiresContext(path: string): boolean {
+        return this.contextRequirements.includes(path);
+    }
+
+    requiresAllContexts(paths: readonly string[]): boolean {
+        return paths.every((path) => this.requiresContext(path));
+    }
+
+    hasTag(tag: string): boolean {
+        return this.tags.includes(tag);
+    }
+
+    equals(other: PolicyCatalogEntry): boolean {
+        return this.key.equals(other.key);
+    }
+
+    toJSON(): PolicyCatalogEntryProps {
+        return {
+            key: this.key,
+            kind: this.kind,
+            ...(this.gateEngineVersion !== undefined
+                ? { gateEngineVersion: this.gateEngineVersion }
+                : {}),
+            ...(this.computeEngineVersion !== undefined
+                ? { computeEngineVersion: this.computeEngineVersion }
+                : {}),
+            ...(this.payloadSchemaVersion !== undefined
+                ? { payloadSchemaVersion: this.payloadSchemaVersion }
+                : {}),
+            owner: this.owner,
+            allowedScopes: [...this.allowedScopes],
+            asOfSource: this.asOfSource,
+            contextRequirements: [...this.contextRequirements],
+            tags: this.tags.length > 0 ? [...this.tags] : undefined,
+            description: this.description,
+        };
+    }
 }