@contractspec/example.saas-boilerplate 3.7.5 → 3.7.7

package/src/billing/billing.schema.ts

@@ -1,133 +1,133 @@
 import { defineSchemaModel, ScalarTypeEnum } from '@contractspec/lib.schema';
 import {
-  SubscriptionStatusSchemaEnum,
-  FeatureAccessReasonEnum,
+	FeatureAccessReasonEnum,
+	SubscriptionStatusSchemaEnum,
 } from './billing.enum';
 
 /**
  * Organization subscription details schema.
  */
 export const SubscriptionModel = defineSchemaModel({
-  name: 'Subscription',
-  description: 'Organization subscription details',
-  fields: {
-    id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    organizationId: {
-      type: ScalarTypeEnum.String_unsecure(),
-      isOptional: false,
-    },
-    planId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    planName: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    status: { type: SubscriptionStatusSchemaEnum, isOptional: false },
-    currentPeriodStart: { type: ScalarTypeEnum.DateTime(), isOptional: false },
-    currentPeriodEnd: { type: ScalarTypeEnum.DateTime(), isOptional: false },
-    trialEndsAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },
-    cancelAtPeriodEnd: { type: ScalarTypeEnum.Boolean(), isOptional: false },
-  },
+	name: 'Subscription',
+	description: 'Organization subscription details',
+	fields: {
+		id: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+		organizationId: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false,
+		},
+		planId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+		planName: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+		status: { type: SubscriptionStatusSchemaEnum, isOptional: false },
+		currentPeriodStart: { type: ScalarTypeEnum.DateTime(), isOptional: false },
+		currentPeriodEnd: { type: ScalarTypeEnum.DateTime(), isOptional: false },
+		trialEndsAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },
+		cancelAtPeriodEnd: { type: ScalarTypeEnum.Boolean(), isOptional: false },
+	},
 });
 
 /**
  * Usage summary for a feature schema.
  */
 export const UsageSummaryModel = defineSchemaModel({
-  name: 'UsageSummary',
-  description: 'Usage summary for a feature',
-  fields: {
-    feature: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    used: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
-    limit: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true },
-    unit: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    percentage: { type: ScalarTypeEnum.Float_unsecure(), isOptional: true },
-  },
+	name: 'UsageSummary',
+	description: 'Usage summary for a feature',
+	fields: {
+		feature: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+		used: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+		limit: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true },
+		unit: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+		percentage: { type: ScalarTypeEnum.Float_unsecure(), isOptional: true },
+	},
 });
 
 /**
  * Input for recording feature usage.
  */
 export const RecordUsageInputModel = defineSchemaModel({
-  name: 'RecordUsageInput',
-  description: 'Input for recording feature usage',
-  fields: {
-    feature: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    quantity: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
-    sourceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    sourceType: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-    metadata: { type: ScalarTypeEnum.JSONObject(), isOptional: true },
-  },
+	name: 'RecordUsageInput',
+	description: 'Input for recording feature usage',
+	fields: {
+		feature: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+		quantity: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+		sourceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+		sourceType: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+		metadata: { type: ScalarTypeEnum.JSONObject(), isOptional: true },
+	},
 });
 
 /**
  * Output for recording feature usage.
  */
 export const RecordUsageOutputModel = defineSchemaModel({
-  name: 'RecordUsageOutput',
-  description: 'Output for recording feature usage',
-  fields: {
-    recorded: { type: ScalarTypeEnum.Boolean(), isOptional: false },
-    currentUsage: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
-    limit: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true },
-    limitReached: { type: ScalarTypeEnum.Boolean(), isOptional: false },
-  },
+	name: 'RecordUsageOutput',
+	description: 'Output for recording feature usage',
+	fields: {
+		recorded: { type: ScalarTypeEnum.Boolean(), isOptional: false },
+		currentUsage: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+		limit: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true },
+		limitReached: { type: ScalarTypeEnum.Boolean(), isOptional: false },
+	},
 });
 
 /**
  * Payload for usage.recorded event.
  */
 export const UsageRecordedPayloadModel = defineSchemaModel({
-  name: 'UsageRecordedPayload',
-  description: 'Payload for usage.recorded event',
-  fields: {
-    feature: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-    quantity: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
-  },
+	name: 'UsageRecordedPayload',
+	description: 'Payload for usage.recorded event',
+	fields: {
+		feature: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+		quantity: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
+	},
 });
 
 /**
  * Input for getting usage summary.
  */
 export const GetUsageSummaryInputModel = defineSchemaModel({
-  name: 'GetUsageSummaryInput',
-  description: 'Input for getting usage summary',
-  fields: {
-    billingPeriod: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
-  },
+	name: 'GetUsageSummaryInput',
+	description: 'Input for getting usage summary',
+	fields: {
+		billingPeriod: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
+	},
 });
 
 /**
  * Output for usage summary.
  */
 export const GetUsageSummaryOutputModel = defineSchemaModel({
-  name: 'GetUsageSummaryOutput',
-  description: 'Output for usage summary',
-  fields: {
-    billingPeriod: {
-      type: ScalarTypeEnum.String_unsecure(),
-      isOptional: false,
-    },
-    usage: { type: UsageSummaryModel, isArray: true, isOptional: false },
-  },
+	name: 'GetUsageSummaryOutput',
+	description: 'Output for usage summary',
+	fields: {
+		billingPeriod: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false,
+		},
+		usage: { type: UsageSummaryModel, isArray: true, isOptional: false },
+	},
 });
 
 /**
  * Input for checking feature access.
  */
 export const CheckFeatureAccessInputModel = defineSchemaModel({
-  name: 'CheckFeatureAccessInput',
-  description: 'Input for checking feature access',
-  fields: {
-    feature: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
-  },
+	name: 'CheckFeatureAccessInput',
+	description: 'Input for checking feature access',
+	fields: {
+		feature: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
+	},
 });
 
 /**
  * Output for feature access check.
  */
 export const CheckFeatureAccessOutputModel = defineSchemaModel({
-  name: 'CheckFeatureAccessOutput',
-  description: 'Output for feature access check',
-  fields: {
-    hasAccess: { type: ScalarTypeEnum.Boolean(), isOptional: false },
-    reason: { type: FeatureAccessReasonEnum, isOptional: true },
-    upgradeUrl: { type: ScalarTypeEnum.URL(), isOptional: true },
-  },
+	name: 'CheckFeatureAccessOutput',
+	description: 'Output for feature access check',
+	fields: {
+		hasAccess: { type: ScalarTypeEnum.Boolean(), isOptional: false },
+		reason: { type: FeatureAccessReasonEnum, isOptional: true },
+		upgradeUrl: { type: ScalarTypeEnum.URL(), isOptional: true },
+	},
 });

package/src/billing/index.ts

@@ -2,63 +2,58 @@
  * Billing domain - subscription, usage tracking, and feature access.
  */
 
+// Entities
+export {
+	BillingUsageEntity,
+	SubscriptionEntity,
+	SubscriptionStatusEnum,
+	UsageLimitEntity,
+} from './billing.entity';
 // Enums
 export {
-  SubscriptionStatusSchemaEnum,
-  FeatureAccessReasonEnum,
+	FeatureAccessReasonEnum,
+	SubscriptionStatusSchemaEnum,
 } from './billing.enum';
-
-// Schema models
-export {
-  SubscriptionModel,
-  UsageSummaryModel,
-  RecordUsageInputModel,
-  RecordUsageOutputModel,
-  UsageRecordedPayloadModel,
-  GetUsageSummaryInputModel,
-  GetUsageSummaryOutputModel,
-  CheckFeatureAccessInputModel,
-  CheckFeatureAccessOutputModel,
-} from './billing.schema';
-
-// Contracts
-export {
-  GetSubscriptionContract,
-  RecordUsageContract,
-  GetUsageSummaryContract,
-  CheckFeatureAccessContract,
-} from './billing.operations';
-
 // Events
 export {
-  UsageRecordedEvent,
-  UsageLimitReachedEvent,
-  SubscriptionChangedEvent,
+	SubscriptionChangedEvent,
+	UsageLimitReachedEvent,
+	UsageRecordedEvent,
 } from './billing.event';
-
-// Entities
+// Handlers
 export {
-  SubscriptionStatusEnum,
-  SubscriptionEntity,
-  BillingUsageEntity,
-  UsageLimitEntity,
-} from './billing.entity';
+	type CheckFeatureAccessInput,
+	type CheckFeatureAccessOutput,
+	mockCheckFeatureAccessHandler,
+	mockGetSubscriptionHandler,
+	mockGetUsageSummaryHandler,
+	mockRecordUsageHandler,
+	type RecordUsageInput,
+	type Subscription,
+	type UsageSummary,
+} from './billing.handler';
+// Contracts
+export {
+	CheckFeatureAccessContract,
+	GetSubscriptionContract,
+	GetUsageSummaryContract,
+	RecordUsageContract,
+} from './billing.operations';
 
 // Presentations
 export {
-  SubscriptionPresentation,
-  UsageDashboardPresentation,
+	SubscriptionPresentation,
+	UsageDashboardPresentation,
 } from './billing.presentation';
-
-// Handlers
+// Schema models
 export {
-  mockGetSubscriptionHandler,
-  mockGetUsageSummaryHandler,
-  mockRecordUsageHandler,
-  mockCheckFeatureAccessHandler,
-  type Subscription,
-  type UsageSummary,
-  type RecordUsageInput,
-  type CheckFeatureAccessInput,
-  type CheckFeatureAccessOutput,
-} from './billing.handler';
+	CheckFeatureAccessInputModel,
+	CheckFeatureAccessOutputModel,
+	GetUsageSummaryInputModel,
+	GetUsageSummaryOutputModel,
+	RecordUsageInputModel,
+	RecordUsageOutputModel,
+	SubscriptionModel,
+	UsageRecordedPayloadModel,
+	UsageSummaryModel,
+} from './billing.schema';

package/src/dashboard/dashboard.presentation.ts

@@ -1,59 +1,59 @@
 import {
-  definePresentation,
-  StabilityEnum,
+	definePresentation,
+	StabilityEnum,
 } from '@contractspec/lib.contracts-spec';
 
 /**
  * Main dashboard presentation for the SaaS application.
  */
 export const SaasDashboardPresentation = definePresentation({
-  meta: {
-    key: 'saas.dashboard',
-    version: '1.0.0',
-    title: 'SaaS Dashboard',
-    description:
-      'Main SaaS dashboard with project overview, usage stats, and quick actions',
-    domain: 'saas-boilerplate',
-    owners: ['@saas-team'],
-    tags: ['dashboard', 'overview'],
-    stability: StabilityEnum.Beta,
-    goal: 'Overview of SaaS activity and metrics',
-    context: 'Main dashboard',
-  },
-  source: {
-    type: 'component',
-    framework: 'react',
-    componentKey: 'SaasDashboard',
-  },
-  targets: ['react', 'markdown'],
-  policy: {
-    flags: ['saas.enabled'],
-  },
+	meta: {
+		key: 'saas.dashboard',
+		version: '1.0.0',
+		title: 'SaaS Dashboard',
+		description:
+			'Main SaaS dashboard with project overview, usage stats, and quick actions',
+		domain: 'saas-boilerplate',
+		owners: ['@saas-team'],
+		tags: ['dashboard', 'overview'],
+		stability: StabilityEnum.Beta,
+		goal: 'Overview of SaaS activity and metrics',
+		context: 'Main dashboard',
+	},
+	source: {
+		type: 'component',
+		framework: 'react',
+		componentKey: 'SaasDashboard',
+	},
+	targets: ['react', 'markdown'],
+	policy: {
+		flags: ['saas.enabled'],
+	},
 });
 
 /**
  * Settings panel presentation.
  */
 export const SettingsPanelPresentation = definePresentation({
-  meta: {
-    key: 'saas.settings',
-    version: '1.0.0',
-    title: 'Settings Panel',
-    description: 'Organization and user settings panel',
-    domain: 'saas-boilerplate',
-    owners: ['@saas-team'],
-    tags: ['settings', 'config'],
-    stability: StabilityEnum.Beta,
-    goal: 'Configure organization and user settings',
-    context: 'Settings section',
-  },
-  source: {
-    type: 'component',
-    framework: 'react',
-    componentKey: 'SettingsPanel',
-  },
-  targets: ['react'],
-  policy: {
-    flags: ['saas.enabled'],
-  },
+	meta: {
+		key: 'saas.settings',
+		version: '1.0.0',
+		title: 'Settings Panel',
+		description: 'Organization and user settings panel',
+		domain: 'saas-boilerplate',
+		owners: ['@saas-team'],
+		tags: ['settings', 'config'],
+		stability: StabilityEnum.Beta,
+		goal: 'Configure organization and user settings',
+		context: 'Settings section',
+	},
+	source: {
+		type: 'component',
+		framework: 'react',
+		componentKey: 'SettingsPanel',
+	},
+	targets: ['react'],
+	policy: {
+		flags: ['saas.enabled'],
+	},
 });

package/src/dashboard/index.ts

@@ -3,6 +3,6 @@
  */
 
 export {
-  SaasDashboardPresentation,
-  SettingsPanelPresentation,
+	SaasDashboardPresentation,
+	SettingsPanelPresentation,
 } from './dashboard.presentation';

package/src/docs/saas-boilerplate.docblock.ts

@@ -2,16 +2,16 @@ import type { DocBlock } from '@contractspec/lib.contracts-spec/docs';
 import { registerDocBlocks } from '@contractspec/lib.contracts-spec/docs';
 
 const saasBoilerplateDocBlocks: DocBlock[] = [
-  {
-    id: 'docs.examples.saas-boilerplate.goal',
-    title: 'SaaS Boilerplate — Goal',
-    summary:
-      'Multi-tenant SaaS foundation with orgs, members, projects, settings, and usage.',
-    kind: 'goal',
-    visibility: 'public',
-    route: '/docs/examples/saas-boilerplate/goal',
-    tags: ['saas', 'goal'],
-    body: `## Why it matters
+	{
+		id: 'docs.examples.saas-boilerplate.goal',
+		title: 'SaaS Boilerplate — Goal',
+		summary:
+			'Multi-tenant SaaS foundation with orgs, members, projects, settings, and usage.',
+		kind: 'goal',
+		visibility: 'public',
+		route: '/docs/examples/saas-boilerplate/goal',
+		tags: ['saas', 'goal'],
+		body: `## Why it matters
 - Provides a regenerable SaaS base: orgs, members, projects, settings, usage/billing.
 - Avoids drift across identity, settings, and usage capture.
 
@@ -22,16 +22,16 @@ const saasBoilerplateDocBlocks: DocBlock[] = [
 ## Success criteria
 - Spec changes to org/project/settings/usage regenerate UI/API/events cleanly.
 - Tenant isolation and RBAC stay enforced; usage data is captured with PII scopes.`,
-  },
-  {
-    id: 'docs.examples.saas-boilerplate.usage',
-    title: 'SaaS Boilerplate — Usage',
-    summary: 'How to seed, extend, and regenerate the SaaS base.',
-    kind: 'usage',
-    visibility: 'public',
-    route: '/docs/examples/saas-boilerplate/usage',
-    tags: ['saas', 'usage'],
-    body: `## Setup
+	},
+	{
+		id: 'docs.examples.saas-boilerplate.usage',
+		title: 'SaaS Boilerplate — Usage',
+		summary: 'How to seed, extend, and regenerate the SaaS base.',
+		kind: 'usage',
+		visibility: 'public',
+		route: '/docs/examples/saas-boilerplate/usage',
+		tags: ['saas', 'usage'],
+		body: `## Setup
 1) Seed (if available) or create orgs, members, and projects via UI.
 2) Configure Notifications for invites and project events; set policy.pii for sensitive fields.
 
@@ -44,17 +44,17 @@ const saasBoilerplateDocBlocks: DocBlock[] = [
 - Keep tenant/role context explicit in contracts and presentations.
 - Emit events for invites, project changes, and usage records; log in Audit Trail.
 - Redact sensitive user/org data in markdown/JSON outputs.`,
-  },
-  {
-    id: 'docs.examples.saas-boilerplate.reference',
-    title: 'SaaS Boilerplate — Reference',
-    summary:
-      'Entities, contracts, events, and presentations for the SaaS starter.',
-    kind: 'reference',
-    visibility: 'public',
-    route: '/docs/examples/saas-boilerplate',
-    tags: ['saas', 'reference'],
-    body: `## Entities
+	},
+	{
+		id: 'docs.examples.saas-boilerplate.reference',
+		title: 'SaaS Boilerplate — Reference',
+		summary:
+			'Entities, contracts, events, and presentations for the SaaS starter.',
+		kind: 'reference',
+		visibility: 'public',
+		route: '/docs/examples/saas-boilerplate',
+		tags: ['saas', 'reference'],
+		body: `## Entities
 - Organization, Member, Role, Project, AppSettings, UserSettings, BillingUsage.
 
 ## Contracts
@@ -69,17 +69,17 @@ const saasBoilerplateDocBlocks: DocBlock[] = [
 ## Notes
 - Tenant isolation is mandatory; enforce via RBAC/policies.
 - Usage/Metering drives billing/limits; keep units explicit.`,
-  },
-  {
-    id: 'docs.examples.saas-boilerplate.constraints',
-    title: 'SaaS Boilerplate — Constraints & Safety',
-    summary:
-      'Internal guardrails for tenancy, RBAC, usage metering, and regeneration.',
-    kind: 'reference',
-    visibility: 'internal',
-    route: '/docs/examples/saas-boilerplate/constraints',
-    tags: ['saas', 'constraints', 'internal'],
-    body: `## Constraints
+	},
+	{
+		id: 'docs.examples.saas-boilerplate.constraints',
+		title: 'SaaS Boilerplate — Constraints & Safety',
+		summary:
+			'Internal guardrails for tenancy, RBAC, usage metering, and regeneration.',
+		kind: 'reference',
+		visibility: 'internal',
+		route: '/docs/examples/saas-boilerplate/constraints',
+		tags: ['saas', 'constraints', 'internal'],
+		body: `## Constraints
 - Tenant isolation and RBAC must remain explicit in spec; no implicit defaults in code.
 - Events to emit: org.created, member.invited/accepted, project.created/updated, usage.recorded.
 - Regeneration must not change billing/usage semantics without spec diffs.
@@ -92,7 +92,7 @@ const saasBoilerplateDocBlocks: DocBlock[] = [
 - Add fixtures for usage recording and role changes.
 - Ensure Audit/Notifications remain wired for invites/project updates.
 - Use Feature Flags for new settings/billing fields; default safe/off.`,
-  },
+	},
 ];
 
 registerDocBlocks(saasBoilerplateDocBlocks);

package/src/example.ts

@@ -1,38 +1,38 @@
 import { defineExample } from '@contractspec/lib.contracts-spec';
 
 const example = defineExample({
-  meta: {
-    key: 'saas-boilerplate',
-    version: '1.0.0',
-    title: 'SaaS Boilerplate',
-    description:
-      'Multi-tenant SaaS foundation with orgs, projects, settings, billing usage, and RBAC.',
-    kind: 'template',
-    visibility: 'public',
-    stability: 'experimental',
-    owners: ['@platform.core'],
-    tags: ['saas', 'multi-tenant', 'billing', 'rbac'],
-  },
-  docs: {
-    rootDocId: 'docs.examples.saas-boilerplate',
-  },
-  entrypoints: {
-    packageName: '@contractspec/example.saas-boilerplate',
-    feature: './feature',
-    contracts: './contracts',
-    presentations: './presentations',
-    handlers: './handlers',
-    docs: './docs',
-  },
-  surfaces: {
-    templates: true,
-    sandbox: {
-      enabled: true,
-      modes: ['playground', 'specs', 'builder', 'markdown', 'evolution'],
-    },
-    studio: { enabled: true, installable: true },
-    mcp: { enabled: true },
-  },
+	meta: {
+		key: 'saas-boilerplate',
+		version: '1.0.0',
+		title: 'SaaS Boilerplate',
+		description:
+			'Multi-tenant SaaS foundation with orgs, projects, settings, billing usage, and RBAC.',
+		kind: 'template',
+		visibility: 'public',
+		stability: 'experimental',
+		owners: ['@platform.core'],
+		tags: ['saas', 'multi-tenant', 'billing', 'rbac'],
+	},
+	docs: {
+		rootDocId: 'docs.examples.saas-boilerplate',
+	},
+	entrypoints: {
+		packageName: '@contractspec/example.saas-boilerplate',
+		feature: './feature',
+		contracts: './contracts',
+		presentations: './presentations',
+		handlers: './handlers',
+		docs: './docs',
+	},
+	surfaces: {
+		templates: true,
+		sandbox: {
+			enabled: true,
+			modes: ['playground', 'specs', 'builder', 'markdown', 'evolution'],
+		},
+		studio: { enabled: true, installable: true },
+		mcp: { enabled: true },
+	},
 });
 
 export default example;

package/src/handlers/index.ts

@@ -4,19 +4,19 @@
 
 // Billing handlers
 export {
-  mockGetSubscriptionHandler,
-  mockRecordUsageHandler,
-  mockGetUsageSummaryHandler,
-  mockCheckFeatureAccessHandler,
+	mockCheckFeatureAccessHandler,
+	mockGetSubscriptionHandler,
+	mockGetUsageSummaryHandler,
+	mockRecordUsageHandler,
 } from '../billing/billing.handler';
 
 // Project handlers
 export {
-  mockCreateProjectHandler,
-  mockGetProjectHandler,
-  mockListProjectsHandler,
-  mockUpdateProjectHandler,
-  mockDeleteProjectHandler,
+	mockCreateProjectHandler,
+	mockDeleteProjectHandler,
+	mockGetProjectHandler,
+	mockListProjectsHandler,
+	mockUpdateProjectHandler,
 } from '../project/project.handler';
 
 // Runtime handlers (PGLite)