@substrat-run/contracts 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,54 @@
+# @substrat-run/contracts
+
+Contract schemas for the [Substrat](https://github.com/substrat-run/substrat) kernel —
+the hard parts of vertical B2B SaaS (tenancy, permissions, audit, GDPR), hosted and
+enforced at runtime.
+
+This package is the **source of truth** for every data shape that crosses a Substrat
+boundary. The schemas are written in [Zod](https://zod.dev), so the reviewed artifact
+*is* the runtime validator: OpenAPI and JSON Schema documents are emitted from this
+package, never hand-maintained beside it.
+
+## What's inside
+
+- **IDs** — branded ULID types (`TenantId`, `ScopeId`, `PrincipalId`, `EventId`, …):
+  opaque, sortable, and unmixable at compile time.
+- **Tenancy** — `Tenant` and `Scope`: two-level today, tree-ready by design
+  (`parentScopeId`), with per-scope `storageShape` and immutable `jurisdiction`.
+- **Permissions** — roles @ nodes plus capability grants, and a `Decision` type where
+  an allow *always* carries the grant and inheritance path that produced it.
+- **Events** — the domain-event envelope. `piiClass` is required at the type level and
+  a PII-classed event without a `subjectId` fails validation: crypto-shredding must
+  always be able to key the erasure.
+- **Module manifest** — what makes an engine self-describing: permissions, emitted and
+  consumed events, migrations and skew window, attachment targets, entitlement key.
+
+## Usage
+
+```ts
+import { scope, domainEventInput, tenantId } from '@substrat-run/contracts';
+
+const s = scope.parse(row);            // validated, branded Scope
+const t: TenantId = tenantId.parse(x); // a ScopeId will not typecheck here
+
+domainEventInput.parse({
+  type: 'workorder.completed',
+  schemaVersion: 1,
+  entity: { entityType: 'workorder', entityId: wo.id },
+  piiClass: 'none',
+  payload: { ... },
+});
+```
+
+## Related packages
+
+- [`@substrat-run/kernel`](https://npmjs.com/package/@substrat-run/kernel) — the behavioral
+  interfaces (`ScopeHost`, `OperationContext`) built on these shapes
+- [`@substrat-run/adapter-sqlite`](https://npmjs.com/package/@substrat-run/adapter-sqlite) — the
+  pure-SQLite reference implementation
+- [`@substrat-run/contract-tests`](https://npmjs.com/package/@substrat-run/contract-tests) — the
+  conformance suite every adapter must pass
+
+## Status
+
+Pre-release (0.x): shapes change without notice until the first vertical ships.

package/dist/attachments.d.ts

@@ -0,0 +1,4 @@
+import { z } from 'zod';
+export declare const visibility: z.ZodEnum<["internal", "customer"]>;
+export type Visibility = z.infer<typeof visibility>;
+//# sourceMappingURL=attachments.d.ts.map

package/dist/attachments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"attachments.d.ts","sourceRoot":"","sources":["../src/attachments.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAQxB,eAAO,MAAM,UAAU,qCAAmC,CAAC;AAC3D,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC"}

package/dist/attachments.js

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+// Visibility classification for attachment items — documents, comments,
+// custom-field values (K-13). Mandatory wherever data can reach the customer
+// portal: like piiClass on events, a classification is only total if it was
+// never optional. Engine-owned tables handle their own flags; this is the
+// kernel-surface convention.
+export const visibility = z.enum(['internal', 'customer']);
+//# sourceMappingURL=attachments.js.map

package/dist/attachments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"attachments.js","sourceRoot":"","sources":["../src/attachments.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,wEAAwE;AACxE,6EAA6E;AAC7E,4EAA4E;AAC5E,0EAA0E;AAC1E,6BAA6B;AAE7B,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC"}

package/dist/events.d.ts

@@ -0,0 +1,186 @@
+import { z } from 'zod';
+export declare const entityRef: z.ZodObject<{
+    entityType: z.ZodString;
+    entityId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    entityType: string;
+    entityId: string;
+}, {
+    entityType: string;
+    entityId: string;
+}>;
+export type EntityRef = z.infer<typeof entityRef>;
+export declare const piiClass: z.ZodEnum<["none", "pseudonymous", "direct"]>;
+export type PiiClass = z.infer<typeof piiClass>;
+export declare const eventType: z.ZodString;
+export declare const systemActor: z.ZodObject<{
+    system: z.ZodBranded<z.ZodString, "ModuleId">;
+}, "strip", z.ZodTypeAny, {
+    system: string & z.BRAND<"ModuleId">;
+}, {
+    system: string;
+}>;
+export declare const actor: z.ZodUnion<[z.ZodBranded<z.ZodString, "PrincipalId">, z.ZodObject<{
+    system: z.ZodBranded<z.ZodString, "ModuleId">;
+}, "strip", z.ZodTypeAny, {
+    system: string & z.BRAND<"ModuleId">;
+}, {
+    system: string;
+}>]>;
+export type Actor = z.infer<typeof actor>;
+export declare const domainEventInput: z.ZodEffects<z.ZodObject<{
+    type: z.ZodString;
+    schemaVersion: z.ZodNumber;
+    entity: z.ZodObject<{
+        entityType: z.ZodString;
+        entityId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        entityType: string;
+        entityId: string;
+    }, {
+        entityType: string;
+        entityId: string;
+    }>;
+    piiClass: z.ZodEnum<["none", "pseudonymous", "direct"]>;
+    subjectId: z.ZodOptional<z.ZodBranded<z.ZodString, "DataSubjectId">>;
+    payload: z.ZodUnknown;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    schemaVersion: number;
+    entity: {
+        entityType: string;
+        entityId: string;
+    };
+    piiClass: "none" | "pseudonymous" | "direct";
+    subjectId?: (string & z.BRAND<"DataSubjectId">) | undefined;
+    payload?: unknown;
+}, {
+    type: string;
+    schemaVersion: number;
+    entity: {
+        entityType: string;
+        entityId: string;
+    };
+    piiClass: "none" | "pseudonymous" | "direct";
+    subjectId?: string | undefined;
+    payload?: unknown;
+}>, {
+    type: string;
+    schemaVersion: number;
+    entity: {
+        entityType: string;
+        entityId: string;
+    };
+    piiClass: "none" | "pseudonymous" | "direct";
+    subjectId?: (string & z.BRAND<"DataSubjectId">) | undefined;
+    payload?: unknown;
+}, {
+    type: string;
+    schemaVersion: number;
+    entity: {
+        entityType: string;
+        entityId: string;
+    };
+    piiClass: "none" | "pseudonymous" | "direct";
+    subjectId?: string | undefined;
+    payload?: unknown;
+}>;
+export type DomainEventInput = z.infer<typeof domainEventInput>;
+export declare const domainEvent: z.ZodEffects<z.ZodObject<{
+    id: z.ZodBranded<z.ZodString, "EventId">;
+    type: z.ZodString;
+    schemaVersion: z.ZodNumber;
+    occurredAt: z.ZodBranded<z.ZodString, "Instant">;
+    tenantId: z.ZodBranded<z.ZodString, "TenantId">;
+    scopeId: z.ZodBranded<z.ZodString, "ScopeId">;
+    actor: z.ZodUnion<[z.ZodBranded<z.ZodString, "PrincipalId">, z.ZodObject<{
+        system: z.ZodBranded<z.ZodString, "ModuleId">;
+    }, "strip", z.ZodTypeAny, {
+        system: string & z.BRAND<"ModuleId">;
+    }, {
+        system: string;
+    }>]>;
+    entity: z.ZodObject<{
+        entityType: z.ZodString;
+        entityId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        entityType: string;
+        entityId: string;
+    }, {
+        entityType: string;
+        entityId: string;
+    }>;
+    piiClass: z.ZodEnum<["none", "pseudonymous", "direct"]>;
+    subjectId: z.ZodOptional<z.ZodBranded<z.ZodString, "DataSubjectId">>;
+    payload: z.ZodUnknown;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    schemaVersion: number;
+    entity: {
+        entityType: string;
+        entityId: string;
+    };
+    piiClass: "none" | "pseudonymous" | "direct";
+    id: string & z.BRAND<"EventId">;
+    occurredAt: string & z.BRAND<"Instant">;
+    tenantId: string & z.BRAND<"TenantId">;
+    scopeId: string & z.BRAND<"ScopeId">;
+    actor: (string & z.BRAND<"PrincipalId">) | {
+        system: string & z.BRAND<"ModuleId">;
+    };
+    subjectId?: (string & z.BRAND<"DataSubjectId">) | undefined;
+    payload?: unknown;
+}, {
+    type: string;
+    schemaVersion: number;
+    entity: {
+        entityType: string;
+        entityId: string;
+    };
+    piiClass: "none" | "pseudonymous" | "direct";
+    id: string;
+    occurredAt: string;
+    tenantId: string;
+    scopeId: string;
+    actor: string | {
+        system: string;
+    };
+    subjectId?: string | undefined;
+    payload?: unknown;
+}>, {
+    type: string;
+    schemaVersion: number;
+    entity: {
+        entityType: string;
+        entityId: string;
+    };
+    piiClass: "none" | "pseudonymous" | "direct";
+    id: string & z.BRAND<"EventId">;
+    occurredAt: string & z.BRAND<"Instant">;
+    tenantId: string & z.BRAND<"TenantId">;
+    scopeId: string & z.BRAND<"ScopeId">;
+    actor: (string & z.BRAND<"PrincipalId">) | {
+        system: string & z.BRAND<"ModuleId">;
+    };
+    subjectId?: (string & z.BRAND<"DataSubjectId">) | undefined;
+    payload?: unknown;
+}, {
+    type: string;
+    schemaVersion: number;
+    entity: {
+        entityType: string;
+        entityId: string;
+    };
+    piiClass: "none" | "pseudonymous" | "direct";
+    id: string;
+    occurredAt: string;
+    tenantId: string;
+    scopeId: string;
+    actor: string | {
+        system: string;
+    };
+    subjectId?: string | undefined;
+    payload?: unknown;
+}>;
+export type DomainEvent = z.infer<typeof domainEvent>;
+//# sourceMappingURL=events.d.ts.map

package/dist/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAYxB,eAAO,MAAM,SAAS;;;;;;;;;EAGpB,CAAC;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAC;AAIlD,eAAO,MAAM,QAAQ,+CAA6C,CAAC;AACnE,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC;AAGhD,eAAO,MAAM,SAAS,aAA+C,CAAC;AAEtE,eAAO,MAAM,WAAW;;;;;;EAAiC,CAAC;AAC1D,eAAO,MAAM,KAAK;;;;;;IAAsC,CAAC;AACzD,MAAM,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,KAAK,CAAC,CAAC;AAiB1C,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EASD,CAAC;AAC7B,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAGhE,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAcI,CAAC;AAC7B,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC"}

package/dist/events.js

@@ -0,0 +1,52 @@
+import { z } from 'zod';
+import { dataSubjectId, eventId, instant, moduleId, principalId, scopeId, tenantId, } from './ids.js';
+// Opaque ref — the kernel owns no entities (D-1); attachment contracts bind here.
+export const entityRef = z.object({
+    entityType: z.string().min(1),
+    entityId: z.string().min(1),
+});
+// Drives crypto-shredding (§5.3 of the plan). Required at the type level:
+// an event that COULD carry PII cannot be declared without classification.
+export const piiClass = z.enum(['none', 'pseudonymous', 'direct']);
+// 'workorder.completed' — module-namespaced
+export const eventType = z.string().regex(/^[a-z0-9-]+\.[a-z0-9-]+$/);
+export const systemActor = z.object({ system: moduleId });
+export const actor = z.union([principalId, systemActor]);
+const piiInvariant = (val, ctx) => {
+    if (val.piiClass !== 'none' && val.subjectId === undefined) {
+        ctx.addIssue({
+            code: z.ZodIssueCode.custom,
+            path: ['subjectId'],
+            message: `subjectId is required when piiClass is '${val.piiClass}' — crypto-shredding must be able to key the erasure`,
+        });
+    }
+};
+// What module code passes to emit(). Everything identifying the origin is
+// deliberately absent — the kernel stamps it (§6.1 of the design doc).
+export const domainEventInput = z
+    .object({
+    type: eventType,
+    schemaVersion: z.number().int().positive(),
+    entity: entityRef,
+    piiClass,
+    subjectId: dataSubjectId.optional(),
+    payload: z.unknown(),
+})
+    .superRefine(piiInvariant);
+// The full envelope as it enters the spine.
+export const domainEvent = z
+    .object({
+    id: eventId, // ULID; idempotency key downstream (consumers are required-idempotent)
+    type: eventType,
+    schemaVersion: z.number().int().positive(),
+    occurredAt: instant, // stamped by kernel
+    tenantId, // stamped by kernel — a vertical cannot mislabel an event's origin
+    scopeId, // stamped by kernel
+    actor, // stamped by kernel from the stub's ambient context
+    entity: entityRef,
+    piiClass,
+    subjectId: dataSubjectId.optional(),
+    payload: z.unknown(),
+})
+    .superRefine(piiInvariant);
+//# sourceMappingURL=events.js.map

package/dist/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,aAAa,EACb,OAAO,EACP,OAAO,EACP,QAAQ,EACR,WAAW,EACX,OAAO,EACP,QAAQ,GACT,MAAM,UAAU,CAAC;AAElB,kFAAkF;AAClF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC;IAChC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CAC5B,CAAC,CAAC;AAGH,0EAA0E;AAC1E,2EAA2E;AAC3E,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,cAAc,EAAE,QAAQ,CAAC,CAAC,CAAC;AAGnE,4CAA4C;AAC5C,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC;AAEtE,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;AAC1D,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;AAGzD,MAAM,YAAY,GAAG,CACnB,GAAgD,EAChD,GAAoB,EACd,EAAE;IACR,IAAI,GAAG,CAAC,QAAQ,KAAK,MAAM,IAAI,GAAG,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QAC3D,GAAG,CAAC,QAAQ,CAAC;YACX,IAAI,EAAE,CAAC,CAAC,YAAY,CAAC,MAAM;YAC3B,IAAI,EAAE,CAAC,WAAW,CAAC;YACnB,OAAO,EAAE,2CAA2C,GAAG,CAAC,QAAQ,sDAAsD;SACvH,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CAAC;AAEF,0EAA0E;AAC1E,uEAAuE;AACvE,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC;KAC9B,MAAM,CAAC;IACN,IAAI,EAAE,SAAS;IACf,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAC1C,MAAM,EAAE,SAAS;IACjB,QAAQ;IACR,SAAS,EAAE,aAAa,CAAC,QAAQ,EAAE;IACnC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;CACrB,CAAC;KACD,WAAW,CAAC,YAAY,CAAC,CAAC;AAG7B,4CAA4C;AAC5C,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC;KACzB,MAAM,CAAC;IACN,EAAE,EAAE,OAAO,EAAE,uEAAuE;IACpF,IAAI,EAAE,SAAS;IACf,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAC1C,UAAU,EAAE,OAAO,EAAE,oBAAoB;IACzC,QAAQ,EAAE,mEAAmE;IAC7E,OAAO,EAAE,oBAAoB;IAC7B,KAAK,EAAE,oDAAoD;IAC3D,MAAM,EAAE,SAAS;IACjB,QAAQ;IACR,SAAS,EAAE,aAAa,CAAC,QAAQ,EAAE;IACnC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;CACrB,CAAC;KACD,WAAW,CAAC,YAAY,CAAC,CAAC"}

package/dist/ids.d.ts

@@ -0,0 +1,19 @@
+import { z } from 'zod';
+export declare const tenantId: z.ZodBranded<z.ZodString, "TenantId">;
+export type TenantId = z.infer<typeof tenantId>;
+export declare const scopeId: z.ZodBranded<z.ZodString, "ScopeId">;
+export type ScopeId = z.infer<typeof scopeId>;
+export declare const principalId: z.ZodBranded<z.ZodString, "PrincipalId">;
+export type PrincipalId = z.infer<typeof principalId>;
+export declare const eventId: z.ZodBranded<z.ZodString, "EventId">;
+export type EventId = z.infer<typeof eventId>;
+export declare const dataSubjectId: z.ZodBranded<z.ZodString, "DataSubjectId">;
+export type DataSubjectId = z.infer<typeof dataSubjectId>;
+export declare const moduleId: z.ZodBranded<z.ZodString, "ModuleId">;
+export type ModuleId = z.infer<typeof moduleId>;
+export declare const instant: z.ZodBranded<z.ZodString, "Instant">;
+export type Instant = z.infer<typeof instant>;
+export declare const permissionKey: z.ZodBranded<z.ZodString, "PermissionKey">;
+export type PermissionKey = z.infer<typeof permissionKey>;
+export declare const slug: z.ZodString;
+//# sourceMappingURL=ids.d.ts.map

package/dist/ids.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ids.d.ts","sourceRoot":"","sources":["../src/ids.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAQxB,eAAO,MAAM,QAAQ,uCAA6C,CAAC;AACnE,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC;AAEhD,eAAO,MAAM,OAAO,sCAA4C,CAAC;AACjE,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,CAAC;AAE9C,eAAO,MAAM,WAAW,0CAAgD,CAAC;AACzE,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AAEtD,eAAO,MAAM,OAAO,sCAA4C,CAAC;AACjE,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,CAAC;AAE9C,eAAO,MAAM,aAAa,4CAAkD,CAAC;AAC7E,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAG1D,eAAO,MAAM,QAAQ,uCAGC,CAAC;AACvB,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC;AAGhD,eAAO,MAAM,OAAO,sCAA2D,CAAC;AAChF,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,CAAC;AAG9C,eAAO,MAAM,aAAa,4CAGC,CAAC;AAC5B,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAE1D,eAAO,MAAM,IAAI,aAAwD,CAAC"}

package/dist/ids.js

@@ -0,0 +1,24 @@
+import { z } from 'zod';
+// Branded ID types: invalid states unrepresentable at the SDK boundary (§5.6/§5.8).
+// ULIDs everywhere — sortable, opaque, no PII. IDs are logged outside jurisdictions
+// by Cloudflare (billing/debug), so they must never encode meaning.
+const ULID = /^[0-9A-HJKMNP-TV-Z]{26}$/;
+export const tenantId = z.string().regex(ULID).brand();
+export const scopeId = z.string().regex(ULID).brand();
+export const principalId = z.string().regex(ULID).brand();
+export const eventId = z.string().regex(ULID).brand();
+export const dataSubjectId = z.string().regex(ULID).brand();
+// npm-package-shaped, e.g. '@substrat-run/engine-workorder'
+export const moduleId = z
+    .string()
+    .regex(/^(@[a-z0-9-~][a-z0-9-._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/)
+    .brand();
+// ISO 8601 with timezone (Z or offset). Stamped kernel-side, never caller-side.
+export const instant = z.string().datetime({ offset: true }).brand();
+// Module-namespaced permission key, e.g. 'workorder:create'
+export const permissionKey = z
+    .string()
+    .regex(/^[a-z0-9-]+:[a-z0-9-]+$/)
+    .brand();
+export const slug = z.string().regex(/^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$/);
+//# sourceMappingURL=ids.js.map

package/dist/ids.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ids.js","sourceRoot":"","sources":["../src/ids.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,oFAAoF;AACpF,oFAAoF;AACpF,oEAAoE;AAEpE,MAAM,IAAI,GAAG,0BAA0B,CAAC;AAExC,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,EAAc,CAAC;AAGnE,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,EAAa,CAAC;AAGjE,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,EAAiB,CAAC;AAGzE,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,EAAa,CAAC;AAGjE,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,EAAmB,CAAC;AAG7E,4DAA4D;AAC5D,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC;KACtB,MAAM,EAAE;KACR,KAAK,CAAC,wDAAwD,CAAC;KAC/D,KAAK,EAAc,CAAC;AAGvB,gFAAgF;AAChF,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,EAAa,CAAC;AAGhF,4DAA4D;AAC5D,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC;KAC3B,MAAM,EAAE;KACR,KAAK,CAAC,yBAAyB,CAAC;KAChC,KAAK,EAAmB,CAAC;AAG5B,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export * from './ids.js';
+export * from './tenancy.js';
+export * from './permission.js';
+export * from './events.js';
+export * from './manifest.js';
+export * from './money.js';
+export * from './attachments.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC"}

package/dist/index.js

@@ -0,0 +1,8 @@
+export * from './ids.js';
+export * from './tenancy.js';
+export * from './permission.js';
+export * from './events.js';
+export * from './manifest.js';
+export * from './money.js';
+export * from './attachments.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC"}