@antelopejs/interface-dms-saas 0.4.1 → 0.5.0

package/README.md

@@ -17,7 +17,7 @@ The AntelopeJS interface to extend the DMS SaaS module: billing, plans, registra
 - Builds plan projections and catalogues, and normalizes prices.
 - Extends registration and the provisioning of a new workspace.
 - Adds workspace settings categories and blocks to the tenant billing page.
-- Listens to workspace lifecycle events and operator actions, and exposes the canonical SaaS tables and models (`/db`).
+- Listens to tenant lifecycle events and operator actions, and exposes the canonical SaaS tables and models (`/db`).
 
 A module that extends [`@antelopejs/dms-saas`](https://www.npmjs.com/package/@antelopejs/dms-saas) depends on this package, never on the runtime.
 
@@ -29,13 +29,13 @@ pnpm add @antelopejs/interface-dms-saas
 
 ## Quick start
 
-The root entry holds every extension point except `db`, with `invoiceLineItems` and `workspaceLifecycle` as namespaces:
+The root entry holds every extension point except `db`, with `invoiceLineItems` and `tenantLifecycle` as namespaces:
 
 ```ts docs-check
-import { invoiceLineItems, workspaceLifecycle } from "@antelopejs/interface-dms-saas";
+import { invoiceLineItems, tenantLifecycle } from "@antelopejs/interface-dms-saas";
 
 export const usageKey = invoiceLineItems.buildInvoiceLineKey("example.compute", "minutes");
-export const isProvisioningCommitted = workspaceLifecycle.IsWorkspaceProvisioningCommitted;
+export const isProvisioningCommitted = tenantLifecycle.IsTenantProvisioningCommitted;
 ```
 
 Use the [entry-point reference](./docs/1.index.md#entry-points) for supported

package/dist/index.d.ts

@@ -5,4 +5,4 @@ export * from "./plans";
 export * from "./provisioning";
 export * from "./registration";
 export * as invoiceLineItems from "./invoice-line-items";
-export * as workspaceLifecycle from "./workspace-lifecycle";
+export * as tenantLifecycle from "./tenant-lifecycle";

package/dist/index.js

@@ -36,7 +36,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.workspaceLifecycle = exports.invoiceLineItems = void 0;
+exports.tenantLifecycle = exports.invoiceLineItems = void 0;
 __exportStar(require("./billing"), exports);
 __exportStar(require("./data-api"), exports);
 __exportStar(require("./pages"), exports);
@@ -44,5 +44,5 @@ __exportStar(require("./plans"), exports);
 __exportStar(require("./provisioning"), exports);
 __exportStar(require("./registration"), exports);
 exports.invoiceLineItems = __importStar(require("./invoice-line-items"));
-exports.workspaceLifecycle = __importStar(require("./workspace-lifecycle"));
+exports.tenantLifecycle = __importStar(require("./tenant-lifecycle"));
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAWA,4CAA0B;AAC1B,6CAA2B;AAC3B,0CAAwB;AACxB,0CAAwB;AACxB,iDAA+B;AAC/B,iDAA+B;AAC/B,yEAAyD;AACzD,4EAA4D"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAWA,4CAA0B;AAC1B,6CAA2B;AAC3B,0CAAwB;AACxB,0CAAwB;AACxB,iDAA+B;AAC/B,iDAA+B;AAC/B,yEAAyD;AACzD,sEAAsD"}

package/dist/tenant-lifecycle.d.ts

@@ -0,0 +1,27 @@
+import { RegisteringProxy } from "@antelopejs/interface-core";
+export declare const TENANT_LIFECYCLE_TRANSITIONS: readonly ["created", "suspended", "reactivation_requested"];
+export type TenantLifecycleTransition = (typeof TENANT_LIFECYCLE_TRANSITIONS)[number];
+export interface TenantLifecycleMessage {
+    tenantId: string;
+    operationId: string;
+    transition: TenantLifecycleTransition;
+    requestedAt: Date;
+}
+export interface TenantLifecycleReceipt {
+    receiptId: string;
+    effectiveAt?: Date;
+}
+export interface TenantLifecycleConsumer {
+    name: string;
+    transitions: readonly TenantLifecycleTransition[];
+    consume(message: TenantLifecycleMessage): Promise<TenantLifecycleReceipt>;
+}
+export interface TenantLifecycleConsumerRegistration {
+    unregister(): void;
+}
+export declare const IsTenantProvisioningCommitted: (tenantId: string) => Promise<boolean>;
+export declare namespace internal {
+    const RegisterTenantLifecycleConsumer: RegisteringProxy<(name: string, consumer: TenantLifecycleConsumer) => void>;
+}
+export declare function UnregisterTenantLifecycleConsumer(name: string): void;
+export declare function RegisterTenantLifecycleConsumer(consumer: TenantLifecycleConsumer): TenantLifecycleConsumerRegistration;

package/dist/tenant-lifecycle.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.internal = exports.IsTenantProvisioningCommitted = exports.TENANT_LIFECYCLE_TRANSITIONS = void 0;
+exports.UnregisterTenantLifecycleConsumer = UnregisterTenantLifecycleConsumer;
+exports.RegisterTenantLifecycleConsumer = RegisterTenantLifecycleConsumer;
+const interface_core_1 = require("@antelopejs/interface-core");
+const CONSUMER_NAME_PATTERN = /^[a-z][a-z0-9._-]{2,63}$/;
+exports.TENANT_LIFECYCLE_TRANSITIONS = [
+    "created",
+    "suspended",
+    "reactivation_requested",
+];
+exports.IsTenantProvisioningCommitted = (0, interface_core_1.InterfaceFunction)();
+var internal;
+(function (internal) {
+    internal.RegisterTenantLifecycleConsumer = new interface_core_1.RegisteringProxy();
+})(internal || (exports.internal = internal = {}));
+function UnregisterTenantLifecycleConsumer(name) {
+    internal.RegisterTenantLifecycleConsumer.unregister(name);
+}
+function RegisterTenantLifecycleConsumer(consumer) {
+    if (!CONSUMER_NAME_PATTERN.test(consumer.name)) {
+        throw new Error("Invalid workspace lifecycle consumer name");
+    }
+    internal.RegisterTenantLifecycleConsumer.register(consumer.name, consumer);
+    return {
+        unregister: () => UnregisterTenantLifecycleConsumer(consumer.name),
+    };
+}
+//# sourceMappingURL=tenant-lifecycle.js.map

package/dist/tenant-lifecycle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tenant-lifecycle.js","sourceRoot":"","sources":["../src/tenant-lifecycle.ts"],"names":[],"mappings":";;;AA+DA,8EAEC;AAWD,0EAUC;AAtFD,+DAGoC;AAEpC,MAAM,qBAAqB,GAAG,0BAA0B,CAAC;AAG5C,QAAA,4BAA4B,GAAG;IAC1C,SAAS;IACT,WAAW;IACX,wBAAwB;CAChB,CAAC;AAwCE,QAAA,6BAA6B,GACxC,IAAA,kCAAiB,GAA0C,CAAC;AAG9D,IAAiB,QAAQ,CAIxB;AAJD,WAAiB,QAAQ;IACV,wCAA+B,GAAG,IAAI,iCAAgB,EAEhE,CAAC;AACN,CAAC,EAJgB,QAAQ,wBAAR,QAAQ,QAIxB;AAGD,SAAgB,iCAAiC,CAAC,IAAY;IAC5D,QAAQ,CAAC,+BAA+B,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;AAC5D,CAAC;AAWD,SAAgB,+BAA+B,CAC7C,QAAiC;IAEjC,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/C,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;IAC/D,CAAC;IACD,QAAQ,CAAC,+BAA+B,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC3E,OAAO;QACL,UAAU,EAAE,GAAG,EAAE,CAAC,iCAAiC,CAAC,QAAQ,CAAC,IAAI,CAAC;KACnE,CAAC;AACJ,CAAC"}

package/docs/1.index.md

@@ -11,26 +11,26 @@ Consumers depend on `@antelopejs/interface-dms-saas`, not the runtime's private
 
 | Import after `@antelopejs/interface-dms-saas` | Contract |
 | --- | --- |
-| Root | Billing, data API, pages, plans, provisioning and registration exports; `invoiceLineItems` and `workspaceLifecycle` namespaces |
+| Root | Billing, data API, pages, plans, provisioning and registration exports; `invoiceLineItems` and `tenantLifecycle` namespaces |
 | `/billing` | [Balances, previews and billing-state recomputation](./2.billing.md) |
 | `/invoice-line-items` | [Usage providers, line types and key helpers](./3.lifecycle-and-usage.md#invoice-line-items) |
-| `/workspace-lifecycle` | [Durable lifecycle consumers and provisioning gate](./3.lifecycle-and-usage.md#workspace-lifecycle) |
+| `/tenant-lifecycle` | [Durable lifecycle consumers and provisioning gate](./3.lifecycle-and-usage.md#tenant-lifecycle) |
 | `/provisioning`, `/registration` | [Provisioning payload and registration limits](./3.lifecycle-and-usage.md#registration-and-provisioning) |
 | `/pages`, `/page-definitions` | [Page descriptors and extension registration](./4.pages-plans-data.md#page-extensions) |
 | `/plans` | [Plan projections, localization and pricing helpers](./4.pages-plans-data.md#plan-helpers) |
 | `/data-api`, `/hidden-filter` | [HiddenStringFilter](./4.pages-plans-data.md#hiddenstringfilter) |
 | `/db`, `/db/models`, `/db/tables` | Canonical SaaS models and table classes; see the data boundary below |
 
-`invoiceLineItems` and `workspaceLifecycle` are namespaces at the root, not flat exports. Use their direct subpaths for individual functions. Their `internal` proxy namespaces are implementation plumbing, not consumer APIs.
+`invoiceLineItems` and `tenantLifecycle` are namespaces at the root, not flat exports. Use their direct subpaths for individual functions. Their `internal` proxy namespaces are implementation plumbing, not consumer APIs.
 
 ```ts docs-check
-import { invoiceLineItems, workspaceLifecycle } from "@antelopejs/interface-dms-saas";
+import { invoiceLineItems, tenantLifecycle } from "@antelopejs/interface-dms-saas";
 
 export const usageKey = invoiceLineItems.buildInvoiceLineKey("example.compute", "minutes");
 
 export async function mayProvision(tenantId: string): Promise<boolean> {
   // Errors propagate: unavailable storage must not grant eligibility.
-  return workspaceLifecycle.IsWorkspaceProvisioningCommitted(tenantId);
+  return tenantLifecycle.IsTenantProvisioningCommitted(tenantId);
 }
 ```
 

package/docs/3.lifecycle-and-usage.md

@@ -1,11 +1,11 @@
 ---
 title: Lifecycle and usage
-description: Registration extras, durable workspace lifecycle consumers and idempotent invoice usage providers.
+description: Registration extras, durable tenant lifecycle consumers and idempotent invoice usage providers.
 ---
 
 # Lifecycle and usage
 
-Use the direct subpaths below or the root's `invoiceLineItems` and `workspaceLifecycle` namespaces. Register consumers/providers from the owning module's lifecycle, not a request handler. Registrations replay when SaaS attaches or reloads and are released when their owner unloads.
+Use the direct subpaths below or the root's `invoiceLineItems` and `tenantLifecycle` namespaces. Register consumers/providers from the owning module's lifecycle, not a request handler. Registrations replay when SaaS attaches or reloads and are released when their owner unloads.
 
 ## Invoice line items
 
@@ -49,42 +49,44 @@ Preview calls set `isPreview: true`, use a synthetic `upcoming_<subscription id>
 
 `selectInvoiceLineItemsToCreate(providerId: string, items: readonly InvoiceLineItem[], alreadyInjectedKeys: ReadonlySet<string>): InvoiceLineItemSelection` is synchronous and has no Stripe side effects. It returns `accepted: PreparedInvoiceLineItem[]` (`{ lineKey, item }`, with trimmed item keys) and `skipped: SkippedInvoiceLineItem[]` (`{ lineKey, reason }`). `SkippedLineItemReason` is `already_invoiced`, `duplicate_key`, `zero_amount`, or `invalid`. The set must contain full provider-prefixed keys. This selection helper does not itself provide transactional idempotency.
 
-## Workspace lifecycle
+## Tenant lifecycle
 
-Import from `/workspace-lifecycle`. `WORKSPACE_LIFECYCLE_TRANSITIONS` contains `created`, `suspended` and `reactivation_requested`; `WorkspaceLifecycleTransition` is their union.
+Import from `/tenant-lifecycle`. `TENANT_LIFECYCLE_TRANSITIONS` contains `created`, `suspended` and `reactivation_requested`; `TenantLifecycleTransition` is their union.
+
+**Breaking migration:** Update `@antelopejs/interface-dms-saas` and `@antelopejs/dms-saas` together. The old `RegisterWorkspaceLifecycleConsumer`, `UnregisterWorkspaceLifecycleConsumer`, `WorkspaceLifecycle*` types, `WORKSPACE_LIFECYCLE_TRANSITIONS`, `IsWorkspaceProvisioningCommitted`, `/workspace-lifecycle` subpath and root `workspaceLifecycle` namespace are removed, without compatibility aliases. Use the tenant-named API below and root `tenantLifecycle` namespace instead. Persisted consumer IDs, transition values and operation IDs remain unchanged; keep existing consumer names and deduplication keys.
 
 ```ts [Contract]
-import type { WorkspaceLifecycleTransition } from "@antelopejs/interface-dms-saas/workspace-lifecycle";
+import type { TenantLifecycleTransition } from "@antelopejs/interface-dms-saas/tenant-lifecycle";
 
-interface WorkspaceLifecycleMessage {
+interface TenantLifecycleMessage {
   tenantId: string;
   operationId: string;
-  transition: WorkspaceLifecycleTransition;
+  transition: TenantLifecycleTransition;
   requestedAt: Date;
 }
-interface WorkspaceLifecycleReceipt {
+interface TenantLifecycleReceipt {
   receiptId: string;
   effectiveAt?: Date;
 }
-interface WorkspaceLifecycleConsumer {
+interface TenantLifecycleConsumer {
   name: string;
-  transitions: readonly WorkspaceLifecycleTransition[];
-  consume(message: WorkspaceLifecycleMessage): Promise<WorkspaceLifecycleReceipt>;
+  transitions: readonly TenantLifecycleTransition[];
+  consume(message: TenantLifecycleMessage): Promise<TenantLifecycleReceipt>;
 }
-interface WorkspaceLifecycleConsumerRegistration { unregister(): void; }
+interface TenantLifecycleConsumerRegistration { unregister(): void; }
 
-declare function RegisterWorkspaceLifecycleConsumer(
-  consumer: WorkspaceLifecycleConsumer,
-): WorkspaceLifecycleConsumerRegistration;
-declare function UnregisterWorkspaceLifecycleConsumer(name: string): void;
-declare function IsWorkspaceProvisioningCommitted(tenantId: string): Promise<boolean>;
+declare function RegisterTenantLifecycleConsumer(
+  consumer: TenantLifecycleConsumer,
+): TenantLifecycleConsumerRegistration;
+declare function UnregisterTenantLifecycleConsumer(name: string): void;
+declare function IsTenantProvisioningCommitted(tenantId: string): Promise<boolean>;
 ```
 
 Names must match `/^[a-z][a-z0-9._-]{2,63}$/`; invalid names throw synchronously. Pick a stable unique name and explicitly select transitions. Unregister via the returned handle or by name when the module stops.
 
 Delivery is **at least once**. Deduplicate by `operationId`, durably link provisioned resources, then return a durable receipt. A rejection is not an acknowledgement. Suspension closes SaaS access before delivery; reactivation keeps access closed until every registered required consumer returns a receipt. `created` arrives after ownership, billing and pre-provisioning hooks succeed and the first invoice is paid, or no payment is required.
 
-`IsWorkspaceProvisioningCommitted` returns false for preparing, unpaid or cancelled self-service workspaces; true for committed creations and legacy/bootstrap tenants without a marker. It is not an existence, membership or access check. Storage and missing-implementation errors propagate; fail closed instead of treating an unavailable check as eligibility.
+`IsTenantProvisioningCommitted` returns false for preparing, unpaid or cancelled self-service workspaces; true for committed creations and legacy/bootstrap tenants without a marker. It is not an existence, membership or access check. Storage and missing-implementation errors propagate; fail closed instead of treating an unavailable check as eligibility.
 
 ## Registration and provisioning
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antelopejs/interface-dms-saas",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "description": "AntelopeJS interface for the DMS SaaS module: billing, plans, registration, workspace pages and lifecycle extension points.",
   "keywords": [
     "antelopejs",

package/dist/workspace-lifecycle.d.ts

@@ -1,27 +0,0 @@
-import { RegisteringProxy } from "@antelopejs/interface-core";
-export declare const WORKSPACE_LIFECYCLE_TRANSITIONS: readonly ["created", "suspended", "reactivation_requested"];
-export type WorkspaceLifecycleTransition = (typeof WORKSPACE_LIFECYCLE_TRANSITIONS)[number];
-export interface WorkspaceLifecycleMessage {
-    tenantId: string;
-    operationId: string;
-    transition: WorkspaceLifecycleTransition;
-    requestedAt: Date;
-}
-export interface WorkspaceLifecycleReceipt {
-    receiptId: string;
-    effectiveAt?: Date;
-}
-export interface WorkspaceLifecycleConsumer {
-    name: string;
-    transitions: readonly WorkspaceLifecycleTransition[];
-    consume(message: WorkspaceLifecycleMessage): Promise<WorkspaceLifecycleReceipt>;
-}
-export interface WorkspaceLifecycleConsumerRegistration {
-    unregister(): void;
-}
-export declare const IsWorkspaceProvisioningCommitted: (tenantId: string) => Promise<boolean>;
-export declare namespace internal {
-    const RegisterWorkspaceLifecycleConsumer: RegisteringProxy<(name: string, consumer: WorkspaceLifecycleConsumer) => void>;
-}
-export declare function UnregisterWorkspaceLifecycleConsumer(name: string): void;
-export declare function RegisterWorkspaceLifecycleConsumer(consumer: WorkspaceLifecycleConsumer): WorkspaceLifecycleConsumerRegistration;

package/dist/workspace-lifecycle.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.internal = exports.IsWorkspaceProvisioningCommitted = exports.WORKSPACE_LIFECYCLE_TRANSITIONS = void 0;
-exports.UnregisterWorkspaceLifecycleConsumer = UnregisterWorkspaceLifecycleConsumer;
-exports.RegisterWorkspaceLifecycleConsumer = RegisterWorkspaceLifecycleConsumer;
-const interface_core_1 = require("@antelopejs/interface-core");
-const CONSUMER_NAME_PATTERN = /^[a-z][a-z0-9._-]{2,63}$/;
-exports.WORKSPACE_LIFECYCLE_TRANSITIONS = [
-    "created",
-    "suspended",
-    "reactivation_requested",
-];
-exports.IsWorkspaceProvisioningCommitted = (0, interface_core_1.InterfaceFunction)();
-var internal;
-(function (internal) {
-    internal.RegisterWorkspaceLifecycleConsumer = new interface_core_1.RegisteringProxy();
-})(internal || (exports.internal = internal = {}));
-function UnregisterWorkspaceLifecycleConsumer(name) {
-    internal.RegisterWorkspaceLifecycleConsumer.unregister(name);
-}
-function RegisterWorkspaceLifecycleConsumer(consumer) {
-    if (!CONSUMER_NAME_PATTERN.test(consumer.name)) {
-        throw new Error("Invalid workspace lifecycle consumer name");
-    }
-    internal.RegisterWorkspaceLifecycleConsumer.register(consumer.name, consumer);
-    return {
-        unregister: () => UnregisterWorkspaceLifecycleConsumer(consumer.name),
-    };
-}
-//# sourceMappingURL=workspace-lifecycle.js.map

package/dist/workspace-lifecycle.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"workspace-lifecycle.js","sourceRoot":"","sources":["../src/workspace-lifecycle.ts"],"names":[],"mappings":";;;AAiEA,oFAEC;AAWD,gFAUC;AAxFD,+DAGoC;AAEpC,MAAM,qBAAqB,GAAG,0BAA0B,CAAC;AAG5C,QAAA,+BAA+B,GAAG;IAC7C,SAAS;IACT,WAAW;IACX,wBAAwB;CAChB,CAAC;AA0CE,QAAA,gCAAgC,GAC3C,IAAA,kCAAiB,GAA0C,CAAC;AAG9D,IAAiB,QAAQ,CAIxB;AAJD,WAAiB,QAAQ;IACV,2CAAkC,GAAG,IAAI,iCAAgB,EAEnE,CAAC;AACN,CAAC,EAJgB,QAAQ,wBAAR,QAAQ,QAIxB;AAGD,SAAgB,oCAAoC,CAAC,IAAY;IAC/D,QAAQ,CAAC,kCAAkC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;AAC/D,CAAC;AAWD,SAAgB,kCAAkC,CAChD,QAAoC;IAEpC,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/C,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;IAC/D,CAAC;IACD,QAAQ,CAAC,kCAAkC,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC9E,OAAO;QACL,UAAU,EAAE,GAAG,EAAE,CAAC,oCAAoC,CAAC,QAAQ,CAAC,IAAI,CAAC;KACtE,CAAC;AACJ,CAAC"}