@contractspec/lib.contracts-spec 2.0.0

package/dist/onboarding-base.js

@@ -0,0 +1,597 @@
+// @bun
+var __defProp = Object.defineProperty;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __moduleCache = /* @__PURE__ */ new WeakMap;
+var __toCommonJS = (from) => {
+  var entry = __moduleCache.get(from), desc;
+  if (entry)
+    return entry;
+  entry = __defProp({}, "__esModule", { value: true });
+  if (from && typeof from === "object" || typeof from === "function")
+    __getOwnPropNames(from).map((key) => !__hasOwnProp.call(entry, key) && __defProp(entry, key, {
+      get: () => from[key],
+      enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+    }));
+  __moduleCache.set(from, entry);
+  return entry;
+};
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, {
+      get: all[name],
+      enumerable: true,
+      configurable: true,
+      set: (newValue) => all[name] = () => newValue
+    });
+};
+var __esm = (fn, res) => () => (fn && (res = fn(fn = 0)), res);
+var __require = import.meta.require;
+
+// src/registry-utils.ts
+var exports_registry_utils = {};
+__export(exports_registry_utils, {
+  groupByToArray: () => groupByToArray,
+  groupByMultiple: () => groupByMultiple,
+  groupBy: () => groupBy,
+  getUniqueTags: () => getUniqueTags,
+  getUniqueOwners: () => getUniqueOwners,
+  getUniqueDomains: () => getUniqueDomains,
+  filterBy: () => filterBy,
+  GroupingStrategies: () => GroupingStrategies
+});
+function filterBy(items, filter) {
+  return items.filter((item) => {
+    if (filter.tags?.length) {
+      const hasMatchingTag = filter.tags.some((tag) => item.meta.tags?.includes(tag));
+      if (!hasMatchingTag)
+        return false;
+    }
+    if (filter.owners?.length) {
+      const hasMatchingOwner = filter.owners.some((owner) => item.meta.owners?.includes(owner));
+      if (!hasMatchingOwner)
+        return false;
+    }
+    if (filter.stability?.length) {
+      if (!filter.stability.includes(item.meta.stability ?? "stable")) {
+        return false;
+      }
+    }
+    if (filter.domain) {
+      const itemDomain = GroupingStrategies.byDomain(item);
+      if (itemDomain !== filter.domain)
+        return false;
+    }
+    if (filter.keyPattern) {
+      const name = item.meta.key ?? item.meta.key ?? "";
+      const pattern = filter.keyPattern.replace(/\*/g, ".*").replace(/\?/g, ".");
+      const regex = new RegExp(`^${pattern}$`, "i");
+      if (!regex.test(name))
+        return false;
+    }
+    return true;
+  });
+}
+function groupBy(items, keyFn) {
+  const groups = new Map;
+  for (const item of items) {
+    const key = keyFn(item);
+    const existing = groups.get(key);
+    if (existing) {
+      existing.push(item);
+    } else {
+      groups.set(key, [item]);
+    }
+  }
+  return groups;
+}
+function groupByToArray(items, keyFn) {
+  const map = groupBy(items, keyFn);
+  return Array.from(map.entries()).map(([key, items2]) => ({ key, items: items2 }));
+}
+function groupByMultiple(items, keysFn) {
+  const groups = new Map;
+  for (const item of items) {
+    const keys = keysFn(item);
+    for (const key of keys) {
+      const existing = groups.get(key);
+      if (existing) {
+        existing.push(item);
+      } else {
+        groups.set(key, [item]);
+      }
+    }
+  }
+  return groups;
+}
+function getUniqueTags(items) {
+  const tags = new Set;
+  for (const item of items) {
+    for (const tag of item.meta.tags ?? []) {
+      tags.add(tag);
+    }
+  }
+  return Array.from(tags).sort();
+}
+function getUniqueOwners(items) {
+  const owners = new Set;
+  for (const item of items) {
+    for (const owner of item.meta.owners ?? []) {
+      owners.add(owner);
+    }
+  }
+  return Array.from(owners).sort();
+}
+function getUniqueDomains(items) {
+  const domains = new Set;
+  for (const item of items) {
+    domains.add(GroupingStrategies.byDomain(item));
+  }
+  return Array.from(domains).sort();
+}
+var GroupingStrategies;
+var init_registry_utils = __esm(() => {
+  GroupingStrategies = {
+    byTag: (item) => item.meta.tags?.[0] ?? "untagged",
+    byAllTags: (item) => item.meta.tags?.length ? item.meta.tags : ["untagged"],
+    byOwner: (item) => item.meta.owners?.[0] ?? "unowned",
+    byDomain: (item) => {
+      const name = item.meta.key ?? item.meta.key ?? "";
+      return name.split(".")[0] ?? "default";
+    },
+    byStability: (item) => item.meta.stability ?? "stable",
+    byUrlPath: (level) => (item) => {
+      if (!item.path)
+        return "root";
+      const segments = item.path.split("/").filter(Boolean);
+      return segments.slice(0, level).join("/") || "root";
+    }
+  };
+});
+
+// src/ownership.ts
+var StabilityEnum = {
+  Idea: "idea",
+  InCreation: "in_creation",
+  Experimental: "experimental",
+  Beta: "beta",
+  Stable: "stable",
+  Deprecated: "deprecated"
+};
+var OwnersEnum = {
+  PlatformCore: "platform.core",
+  PlatformSigil: "platform.sigil",
+  PlatformMarketplace: "platform.marketplace",
+  PlatformMessaging: "platform.messaging",
+  PlatformContent: "platform.content",
+  PlatformFeatureFlags: "platform.featureflags",
+  PlatformFinance: "platform.finance"
+};
+var Owners = OwnersEnum;
+var TagsEnum = {
+  Spots: "spots",
+  Collectivity: "collectivity",
+  Marketplace: "marketplace",
+  Sellers: "sellers",
+  Auth: "auth",
+  Login: "login",
+  Signup: "signup",
+  Guide: "guide",
+  Docs: "docs",
+  I18n: "i18n",
+  Incident: "incident",
+  Automation: "automation",
+  Hygiene: "hygiene"
+};
+var Tags = TagsEnum;
+
+// src/operations/operation.ts
+var isEmitDeclRef = (e) => ("ref" in e);
+var defineCommand = (spec) => ({
+  ...spec,
+  meta: { ...spec.meta, kind: "command" },
+  policy: {
+    ...spec.policy,
+    idempotent: spec.policy?.["policy"]?.idempotent ?? false
+  }
+});
+var defineQuery = (spec) => ({
+  ...spec,
+  meta: { ...spec.meta, kind: "query" },
+  policy: { ...spec.policy, idempotent: true }
+});
+
+// src/registry.ts
+init_registry_utils();
+import { compareVersions } from "compare-versions";
+var keyOfSpecContract = (spec) => `${spec.meta.key}.v${spec.meta.version}`;
+
+class SpecContractRegistry {
+  contractType;
+  items = new Map;
+  constructor(contractType, items) {
+    this.contractType = contractType;
+    if (items) {
+      items.forEach((p) => this.register(p));
+    }
+  }
+  register(p) {
+    const key = keyOfSpecContract(p);
+    if (this.items.has(key))
+      throw new Error(`Duplicate contract \`${this.contractType}\` ${key}`);
+    this.items.set(key, p);
+    return this;
+  }
+  count() {
+    return this.items.size;
+  }
+  list() {
+    return [...this.items.values()];
+  }
+  get(key, version) {
+    if (version != null)
+      return this.items.get(`${key}.v${version}`);
+    let candidate;
+    for (const [k, p] of this.items.entries()) {
+      if (!k.startsWith(`${key}.v`))
+        continue;
+      if (!candidate || compareVersions(p.meta.version, candidate.meta.version) > 0) {
+        candidate = p;
+      }
+    }
+    return candidate;
+  }
+  has(key, version) {
+    return !!this.get(key, version);
+  }
+  filter(criteria) {
+    return filterBy(this.list(), criteria);
+  }
+  listByTag(tag) {
+    return this.list().filter((p) => p.meta.tags?.includes(tag));
+  }
+  listByOwner(owner) {
+    return this.list().filter((p) => p.meta.owners?.includes(owner));
+  }
+  groupBy(keyFn) {
+    return groupBy(this.list(), keyFn);
+  }
+  getUniqueTags() {
+    return getUniqueTags(this.list());
+  }
+}
+
+// src/events.ts
+function defineEvent(e) {
+  return e;
+}
+var eventKey = (key, version) => `${key}.v${version}`;
+
+class EventRegistry extends SpecContractRegistry {
+  constructor(items) {
+    super("event", items);
+  }
+}
+
+// src/operations/registry.ts
+function opKey(key, version) {
+  return `${key}.v${version}`;
+}
+
+class OperationSpecRegistry extends SpecContractRegistry {
+  handlers = new Map;
+  constructor(items) {
+    super("operation", items);
+  }
+  bind(spec, handler) {
+    const key = opKey(spec.meta.key, spec.meta.version);
+    if (!this.items.has(key))
+      throw new Error(`Cannot bind; spec not found: ${key}`);
+    if (this.handlers.has(key))
+      throw new Error(`Handler already bound for ${key}`);
+    this.handlers.set(key, handler);
+    return this;
+  }
+  getHandler(key, version) {
+    const spec = this.get(key, version);
+    if (!spec)
+      return;
+    return this.handlers.get(opKey(spec.meta.key, spec.meta.version));
+  }
+  listBound() {
+    const out = [];
+    for (const [k, spec] of this.items.entries()) {
+      const h = this.handlers.get(k);
+      if (h)
+        out.push({ spec, handler: h });
+    }
+    return out;
+  }
+  async execute(key, version, rawInput, ctx) {
+    const baseSpec = this.get(key, version);
+    if (!baseSpec)
+      throw new Error(`Spec not found for ${key}${version ? `.v${version}` : ""}`);
+    const spec = await ctx.specVariantResolver?.resolve({
+      name: baseSpec.meta.key,
+      version: baseSpec.meta.version,
+      kind: baseSpec.meta.kind
+    }, ctx) ?? baseSpec;
+    let handlerKey = opKey(spec.meta.key, spec.meta.version);
+    let handler = this.handlers.get(handlerKey);
+    if (!handler) {
+      const fallbackKey = opKey(baseSpec.meta.key, baseSpec.meta.version);
+      handler = this.handlers.get(fallbackKey);
+      handlerKey = fallbackKey;
+    }
+    if (!handler)
+      throw new Error(`No handler bound for ${handlerKey}`);
+    const parsedInput = spec.io.input?.getZod().parse(rawInput);
+    if (ctx.decide) {
+      const [service, command] = spec.meta.key.split(".");
+      if (!service || !command)
+        throw new Error(`Invalid spec name: ${spec.meta.key}`);
+      const decision = await ctx.decide({
+        service,
+        command,
+        version: spec.meta.version,
+        actor: ctx.actor ?? "anonymous",
+        channel: ctx.channel,
+        roles: ctx.roles,
+        organizationId: ctx.organizationId,
+        userId: ctx.userId,
+        flags: []
+      });
+      if (decision.effect === "deny") {
+        throw new Error(`PolicyDenied: ${spec.meta.key}.v${spec.meta.version}`);
+      }
+      if (decision.rateLimit && ctx.rateLimit) {
+        const key2 = decision.rateLimit.key ?? "default";
+        const rpm = decision.rateLimit.rpm ?? 60;
+        await ctx.rateLimit(key2, 1, rpm);
+      }
+    }
+    const allowedEvents = new Map;
+    if (spec.sideEffects?.emits) {
+      for (const e of spec.sideEffects.emits) {
+        if (isEmitDeclRef(e)) {
+          const eventSpec = ctx.eventSpecResolver?.get(e.ref.key, e.ref.version);
+          if (eventSpec) {
+            allowedEvents.set(`${e.ref.key}.v${e.ref.version}`, eventSpec.payload);
+          }
+        } else {
+          allowedEvents.set(`${e.key}.v${e.version}`, e.payload);
+        }
+      }
+    }
+    const emitGuard = async (eventName, eventVersion, payload) => {
+      const key2 = eventKey(eventName, eventVersion);
+      const schema = allowedEvents.get(key2);
+      if (!schema)
+        throw new Error(`UndeclaredEvent: ${key2} not allowed by ${opKey(spec.meta.key, spec.meta.version)}`);
+      const parsed = schema.getZod().parse(payload);
+      await ctx.eventPublisher?.({
+        key: eventName,
+        version: eventVersion,
+        payload: parsed,
+        traceId: ctx.traceId
+      });
+    };
+    if (ctx.appConfig) {
+      if (!ctx.branding) {
+        ctx.branding = ctx.appConfig.branding;
+      }
+      if (!ctx.translation) {
+        ctx.translation = { config: ctx.appConfig.translation };
+      } else if (!ctx.translation.config) {
+        ctx.translation = {
+          ...ctx.translation,
+          config: ctx.appConfig.translation
+        };
+      }
+    }
+    const telemetryContext = ctx.telemetry;
+    const trackTelemetry = async (trigger, details) => {
+      if (!telemetryContext || !trigger?.event)
+        return;
+      try {
+        const props = trigger.properties?.(details) ?? {};
+        await telemetryContext.track(trigger.event.key, trigger.event.version ?? "1.0.0", props, {
+          tenantId: ctx.organizationId ?? undefined,
+          organizationId: ctx.organizationId,
+          userId: ctx.userId,
+          actor: ctx.actor,
+          channel: ctx.channel,
+          metadata: ctx.traceId ? { traceId: ctx.traceId } : undefined
+        });
+      } catch (_error) {}
+    };
+    let result;
+    try {
+      result = await handler(parsedInput, {
+        ...ctx,
+        __emitGuard__: emitGuard
+      });
+    } catch (error) {
+      if (spec.telemetry?.failure) {
+        await trackTelemetry(spec.telemetry.failure, {
+          input: parsedInput ?? rawInput,
+          error
+        });
+      }
+      throw error;
+    }
+    if (spec.telemetry?.success) {
+      await trackTelemetry(spec.telemetry.success, {
+        input: parsedInput ?? rawInput,
+        output: result
+      });
+    }
+    const outputModel = spec.io.output;
+    if (outputModel?.getZod) {
+      const parsedOutput = outputModel.getZod().parse(result);
+      return parsedOutput;
+    }
+    return result;
+  }
+}
+// src/onboarding-base.ts
+import { ScalarTypeEnum } from "@contractspec/lib.schema/ScalarTypeEnum";
+import { SchemaModel } from "@contractspec/lib.schema/SchemaModel";
+var SaveOnboardingDraftInput = new SchemaModel({
+  name: "SaveOnboardingDraftInput",
+  description: "Input for saving onboarding draft",
+  fields: {
+    data: { type: ScalarTypeEnum.JSON(), isOptional: false }
+  }
+});
+var SaveOnboardingDraftOutput = new SchemaModel({
+  name: "SaveOnboardingDraftOutput",
+  description: "Output for saving onboarding draft",
+  fields: {
+    id: { type: ScalarTypeEnum.ID(), isOptional: false },
+    organizationId: { type: ScalarTypeEnum.ID(), isOptional: false }
+  }
+});
+var SaveOnboardingDraftBaseSpec = defineCommand({
+  meta: {
+    key: "base.onboarding.saveDraft",
+    version: "1.0.0",
+    stability: StabilityEnum.Beta,
+    owners: [OwnersEnum.PlatformSigil],
+    tags: ["onboarding", "draft"],
+    description: "Save or update onboarding draft for active organization",
+    goal: "Persist onboarding progress incrementally for resumption and safety",
+    context: "Auto-saves every few seconds during onboarding; enables users to leave and resume"
+  },
+  io: {
+    input: SaveOnboardingDraftInput,
+    output: SaveOnboardingDraftOutput
+  },
+  policy: {
+    auth: "user",
+    escalate: null
+  },
+  transport: {
+    gql: { field: "saveOnboardingDraft" },
+    rest: { method: "POST" }
+  }
+});
+var GetOnboardingDraftOutput = new SchemaModel({
+  name: "GetOnboardingDraftOutput",
+  description: "Onboarding draft payload",
+  fields: {
+    id: { type: ScalarTypeEnum.ID(), isOptional: true },
+    organizationId: { type: ScalarTypeEnum.ID(), isOptional: true },
+    data: { type: ScalarTypeEnum.JSON(), isOptional: true },
+    createdAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+    updatedAt: { type: ScalarTypeEnum.DateTime(), isOptional: true }
+  }
+});
+var GetOnboardingDraftBaseSpec = defineQuery({
+  meta: {
+    key: "base.onboarding.getDraft",
+    version: "1.0.0",
+    stability: StabilityEnum.Beta,
+    owners: [OwnersEnum.PlatformSigil],
+    tags: ["onboarding", "draft"],
+    description: "Get onboarding draft for active organization",
+    goal: "Retrieve saved onboarding progress",
+    context: "Called on mount to restore in-progress onboarding"
+  },
+  io: {
+    input: null,
+    output: GetOnboardingDraftOutput
+  },
+  policy: {
+    auth: "user",
+    escalate: null
+  },
+  transport: {
+    gql: { field: "getOnboardingDraft" },
+    rest: { method: "GET" }
+  }
+});
+var DeleteOnboardingDraftOutput = new SchemaModel({
+  name: "DeleteOnboardingDraftOutput",
+  description: "Result of delete operation",
+  fields: {
+    ok: { type: ScalarTypeEnum.Boolean(), isOptional: false }
+  }
+});
+var DeleteOnboardingDraftBaseSpec = defineCommand({
+  meta: {
+    key: "base.onboarding.deleteDraft",
+    version: "1.0.0",
+    stability: StabilityEnum.Beta,
+    owners: [OwnersEnum.PlatformSigil],
+    tags: ["onboarding", "draft"],
+    description: "Delete onboarding draft for active organization",
+    goal: "Clear draft after completion or if user wants to restart",
+    context: "Called after successful onboarding or explicit user reset"
+  },
+  io: {
+    input: null,
+    output: DeleteOnboardingDraftOutput
+  },
+  policy: {
+    auth: "user",
+    escalate: null
+  },
+  transport: {
+    gql: { field: "deleteOnboardingDraft" },
+    rest: { method: "POST" }
+  }
+});
+var CompleteOnboardingBaseInput = new SchemaModel({
+  name: "CompleteOnboardingBaseInput",
+  description: "Input for completing onboarding",
+  fields: {
+    data: { type: ScalarTypeEnum.JSON(), isOptional: false }
+  }
+});
+var CompleteOnboardingBaseOutput = new SchemaModel({
+  name: "CompleteOnboardingBaseOutput",
+  description: "Result of onboarding completion",
+  fields: {
+    success: { type: ScalarTypeEnum.Boolean(), isOptional: false },
+    userId: { type: ScalarTypeEnum.ID(), isOptional: true },
+    organizationId: { type: ScalarTypeEnum.ID(), isOptional: true }
+  }
+});
+var CompleteOnboardingBaseSpec = defineCommand({
+  meta: {
+    key: "base.onboarding.complete",
+    version: "1.0.0",
+    stability: StabilityEnum.Beta,
+    owners: [OwnersEnum.PlatformSigil],
+    tags: ["onboarding"],
+    description: "Complete onboarding and finalize user/organization setup",
+    goal: "Transition from draft to active profile",
+    context: "Validates all required fields, creates/updates entities, marks onboarding complete"
+  },
+  io: {
+    input: CompleteOnboardingBaseInput,
+    output: CompleteOnboardingBaseOutput
+  },
+  policy: {
+    auth: "user",
+    escalate: null
+  },
+  transport: {
+    gql: { field: "completeOnboarding" },
+    rest: { method: "POST" }
+  }
+});
+export {
+  SaveOnboardingDraftOutput,
+  SaveOnboardingDraftInput,
+  SaveOnboardingDraftBaseSpec,
+  GetOnboardingDraftOutput,
+  GetOnboardingDraftBaseSpec,
+  DeleteOnboardingDraftOutput,
+  DeleteOnboardingDraftBaseSpec,
+  CompleteOnboardingBaseSpec,
+  CompleteOnboardingBaseOutput,
+  CompleteOnboardingBaseInput
+};

package/dist/openapi.d.ts

@@ -0,0 +1,33 @@
+/**
+ * OpenAPI export utilities.
+ *
+ * @deprecated Import from @contractspec/lib.contracts-transformers/openapi instead.
+ * This file is kept for backwards compatibility.
+ */
+import type { OperationSpecRegistry } from './operations/registry';
+export interface OpenApiServer {
+    url: string;
+    description?: string;
+}
+export interface OpenApiExportOptions {
+    title?: string;
+    version?: string;
+    description?: string;
+    servers?: OpenApiServer[];
+}
+type OpenApiSchemaObject = Record<string, unknown>;
+export interface OpenApiDocument {
+    openapi: '3.1.0';
+    info: {
+        title: string;
+        version: string;
+        description?: string;
+    };
+    servers?: OpenApiServer[];
+    paths: Record<string, Record<string, unknown>>;
+    components: {
+        schemas: Record<string, OpenApiSchemaObject>;
+    };
+}
+export declare function openApiForRegistry(registry: OperationSpecRegistry, options?: OpenApiExportOptions): OpenApiDocument;
+export {};