@contractspec/example.saas-boilerplate 3.7.5 → 3.7.7

package/src/billing/billing.handler.ts

@@ -5,133 +5,133 @@ import { MOCK_SUBSCRIPTION, MOCK_USAGE_SUMMARY } from '../shared/mock-data';
 
 // Types inferred from contract schemas
 export interface Subscription {
-  id: string;
-  organizationId: string;
-  planId: string;
-  planName: string;
-  status: 'ACTIVE' | 'TRIALING' | 'PAST_DUE' | 'CANCELED' | 'UNPAID';
-  currentPeriodStart: Date;
-  currentPeriodEnd: Date;
-  limits: {
-    projects: number;
-    users: number;
-    storage: number;
-    apiCalls: number;
-  };
-  usage: {
-    projects: number;
-    users: number;
-    storage: number;
-    apiCalls: number;
-  };
+	id: string;
+	organizationId: string;
+	planId: string;
+	planName: string;
+	status: 'ACTIVE' | 'TRIALING' | 'PAST_DUE' | 'CANCELED' | 'UNPAID';
+	currentPeriodStart: Date;
+	currentPeriodEnd: Date;
+	limits: {
+		projects: number;
+		users: number;
+		storage: number;
+		apiCalls: number;
+	};
+	usage: {
+		projects: number;
+		users: number;
+		storage: number;
+		apiCalls: number;
+	};
 }
 
 export interface UsageSummary {
-  organizationId: string;
-  period: string;
-  apiCalls: {
-    total: number;
-    limit: number;
-    percentUsed: number;
-  };
-  storage: {
-    totalGb: number;
-    limitGb: number;
-    percentUsed: number;
-  };
-  activeProjects: number;
-  activeUsers: number;
-  breakdown: {
-    date: string;
-    apiCalls: number;
-    storageGb: number;
-  }[];
+	organizationId: string;
+	period: string;
+	apiCalls: {
+		total: number;
+		limit: number;
+		percentUsed: number;
+	};
+	storage: {
+		totalGb: number;
+		limitGb: number;
+		percentUsed: number;
+	};
+	activeProjects: number;
+	activeUsers: number;
+	breakdown: {
+		date: string;
+		apiCalls: number;
+		storageGb: number;
+	}[];
 }
 
 export interface RecordUsageInput {
-  metric: string;
-  quantity: number;
-  timestamp?: Date;
-  metadata?: Record<string, unknown>;
+	metric: string;
+	quantity: number;
+	timestamp?: Date;
+	metadata?: Record<string, unknown>;
 }
 
 export interface CheckFeatureAccessInput {
-  feature: string;
+	feature: string;
 }
 
 export interface CheckFeatureAccessOutput {
-  allowed: boolean;
-  reason?:
-    | 'PLAN_LIMIT'
-    | 'FEATURE_NOT_INCLUDED'
-    | 'QUOTA_EXCEEDED'
-    | 'SUBSCRIPTION_INACTIVE';
-  currentUsage?: number;
-  limit?: number;
+	allowed: boolean;
+	reason?:
+		| 'PLAN_LIMIT'
+		| 'FEATURE_NOT_INCLUDED'
+		| 'QUOTA_EXCEEDED'
+		| 'SUBSCRIPTION_INACTIVE';
+	currentUsage?: number;
+	limit?: number;
 }
 
 /**
  * Mock handler for GetSubscriptionContract.
  */
 export async function mockGetSubscriptionHandler(): Promise<Subscription> {
-  return MOCK_SUBSCRIPTION;
+	return MOCK_SUBSCRIPTION;
 }
 
 /**
  * Mock handler for GetUsageSummaryContract.
  */
 export async function mockGetUsageSummaryHandler(input: {
-  period?: string;
+	period?: string;
 }): Promise<UsageSummary> {
-  return {
-    ...MOCK_USAGE_SUMMARY,
-    period: input.period ?? 'current_month',
-  };
+	return {
+		...MOCK_USAGE_SUMMARY,
+		period: input.period ?? 'current_month',
+	};
 }
 
 /**
  * Mock handler for RecordUsageContract.
  */
 export async function mockRecordUsageHandler(
-  input: RecordUsageInput
+	input: RecordUsageInput
 ): Promise<{ recorded: boolean; newTotal: number }> {
-  const currentUsage = MOCK_USAGE_SUMMARY.apiCalls.total;
-  const newTotal = currentUsage + input.quantity;
+	const currentUsage = MOCK_USAGE_SUMMARY.apiCalls.total;
+	const newTotal = currentUsage + input.quantity;
 
-  return {
-    recorded: true,
-    newTotal,
-  };
+	return {
+		recorded: true,
+		newTotal,
+	};
 }
 
 /**
  * Mock handler for CheckFeatureAccessContract.
  */
 export async function mockCheckFeatureAccessHandler(
-  input: CheckFeatureAccessInput
+	input: CheckFeatureAccessInput
 ): Promise<CheckFeatureAccessOutput> {
-  const { feature } = input;
+	const { feature } = input;
 
-  const featureMap: Record<string, CheckFeatureAccessOutput> = {
-    custom_domains: {
-      allowed: true,
-    },
-    api_access: {
-      allowed: true,
-      currentUsage: MOCK_USAGE_SUMMARY.apiCalls.total,
-      limit: MOCK_USAGE_SUMMARY.apiCalls.limit,
-    },
-    advanced_analytics: {
-      allowed: false,
-      reason: 'FEATURE_NOT_INCLUDED',
-    },
-    unlimited_projects: {
-      allowed: false,
-      reason: 'PLAN_LIMIT',
-      currentUsage: MOCK_SUBSCRIPTION.usage.projects,
-      limit: MOCK_SUBSCRIPTION.limits.projects,
-    },
-  };
+	const featureMap: Record<string, CheckFeatureAccessOutput> = {
+		custom_domains: {
+			allowed: true,
+		},
+		api_access: {
+			allowed: true,
+			currentUsage: MOCK_USAGE_SUMMARY.apiCalls.total,
+			limit: MOCK_USAGE_SUMMARY.apiCalls.limit,
+		},
+		advanced_analytics: {
+			allowed: false,
+			reason: 'FEATURE_NOT_INCLUDED',
+		},
+		unlimited_projects: {
+			allowed: false,
+			reason: 'PLAN_LIMIT',
+			currentUsage: MOCK_SUBSCRIPTION.usage.projects,
+			limit: MOCK_SUBSCRIPTION.limits.projects,
+		},
+	};
 
-  return featureMap[feature] ?? { allowed: true };
+	return featureMap[feature] ?? { allowed: true };
 }

package/src/billing/billing.operations.ts

@@ -1,13 +1,13 @@
 import { defineCommand, defineQuery } from '@contractspec/lib.contracts-spec';
 import {
-  CheckFeatureAccessInputModel,
-  CheckFeatureAccessOutputModel,
-  GetUsageSummaryInputModel,
-  GetUsageSummaryOutputModel,
-  RecordUsageInputModel,
-  RecordUsageOutputModel,
-  SubscriptionModel,
-  UsageRecordedPayloadModel,
+	CheckFeatureAccessInputModel,
+	CheckFeatureAccessOutputModel,
+	GetUsageSummaryInputModel,
+	GetUsageSummaryOutputModel,
+	RecordUsageInputModel,
+	RecordUsageOutputModel,
+	SubscriptionModel,
+	UsageRecordedPayloadModel,
 } from './billing.schema';
 
 const OWNERS = ['@example.saas-boilerplate'] as const;
@@ -16,172 +16,172 @@ const OWNERS = ['@example.saas-boilerplate'] as const;
  * Get subscription status.
  */
 export const GetSubscriptionContract = defineQuery({
-  meta: {
-    key: 'saas.billing.subscription.get',
-    version: '1.0.0',
-    stability: 'stable',
-    owners: [...OWNERS],
-    tags: ['saas', 'billing', 'subscription'],
-    description: 'Get organization subscription status.',
-    goal: 'Show current plan and billing status.',
-    context: 'Billing page, plan upgrade prompts.',
-  },
-  io: {
-    input: null,
-    output: SubscriptionModel,
-  },
-  policy: {
-    auth: 'user',
-  },
-  acceptance: {
-    scenarios: [
-      {
-        key: 'get-subscription-happy-path',
-        given: ['Organization has active subscription'],
-        when: ['User requests subscription status'],
-        then: ['Subscription details are returned'],
-      },
-    ],
-    examples: [
-      {
-        key: 'get-basic',
-        input: null,
-        output: {
-          plan: 'pro',
-          status: 'active',
-          currentPeriodEnd: '2025-02-01T00:00:00Z',
-        },
-      },
-    ],
-  },
+	meta: {
+		key: 'saas.billing.subscription.get',
+		version: '1.0.0',
+		stability: 'stable',
+		owners: [...OWNERS],
+		tags: ['saas', 'billing', 'subscription'],
+		description: 'Get organization subscription status.',
+		goal: 'Show current plan and billing status.',
+		context: 'Billing page, plan upgrade prompts.',
+	},
+	io: {
+		input: null,
+		output: SubscriptionModel,
+	},
+	policy: {
+		auth: 'user',
+	},
+	acceptance: {
+		scenarios: [
+			{
+				key: 'get-subscription-happy-path',
+				given: ['Organization has active subscription'],
+				when: ['User requests subscription status'],
+				then: ['Subscription details are returned'],
+			},
+		],
+		examples: [
+			{
+				key: 'get-basic',
+				input: null,
+				output: {
+					plan: 'pro',
+					status: 'active',
+					currentPeriodEnd: '2025-02-01T00:00:00Z',
+				},
+			},
+		],
+	},
 });
 
 /**
  * Record feature usage.
  */
 export const RecordUsageContract = defineCommand({
-  meta: {
-    key: 'saas.billing.usage.record',
-    version: '1.0.0',
-    stability: 'stable',
-    owners: [...OWNERS],
-    tags: ['saas', 'billing', 'usage'],
-    description: 'Record usage of a metered feature.',
-    goal: 'Track feature usage for billing.',
-    context: 'Called by services when metered features are used.',
-  },
-  io: {
-    input: RecordUsageInputModel,
-    output: RecordUsageOutputModel,
-  },
-  policy: {
-    auth: 'user',
-  },
-  sideEffects: {
-    emits: [
-      {
-        key: 'billing.usage.recorded',
-        version: '1.0.0',
-        when: 'Usage is recorded',
-        payload: UsageRecordedPayloadModel,
-      },
-    ],
-  },
-  acceptance: {
-    scenarios: [
-      {
-        key: 'record-usage-happy-path',
-        given: ['Organization exists'],
-        when: ['System records feature usage'],
-        then: ['Usage is recorded'],
-      },
-    ],
-    examples: [
-      {
-        key: 'record-api-call',
-        input: { feature: 'api_calls', quantity: 1, idempotencyKey: 'abc-123' },
-        output: { recorded: true, currentUsage: 100 },
-      },
-    ],
-  },
+	meta: {
+		key: 'saas.billing.usage.record',
+		version: '1.0.0',
+		stability: 'stable',
+		owners: [...OWNERS],
+		tags: ['saas', 'billing', 'usage'],
+		description: 'Record usage of a metered feature.',
+		goal: 'Track feature usage for billing.',
+		context: 'Called by services when metered features are used.',
+	},
+	io: {
+		input: RecordUsageInputModel,
+		output: RecordUsageOutputModel,
+	},
+	policy: {
+		auth: 'user',
+	},
+	sideEffects: {
+		emits: [
+			{
+				key: 'billing.usage.recorded',
+				version: '1.0.0',
+				when: 'Usage is recorded',
+				payload: UsageRecordedPayloadModel,
+			},
+		],
+	},
+	acceptance: {
+		scenarios: [
+			{
+				key: 'record-usage-happy-path',
+				given: ['Organization exists'],
+				when: ['System records feature usage'],
+				then: ['Usage is recorded'],
+			},
+		],
+		examples: [
+			{
+				key: 'record-api-call',
+				input: { feature: 'api_calls', quantity: 1, idempotencyKey: 'abc-123' },
+				output: { recorded: true, currentUsage: 100 },
+			},
+		],
+	},
 });
 
 /**
  * Get usage summary.
  */
 export const GetUsageSummaryContract = defineQuery({
-  meta: {
-    key: 'saas.billing.usage.summary',
-    version: '1.0.0',
-    stability: 'stable',
-    owners: [...OWNERS],
-    tags: ['saas', 'billing', 'usage'],
-    description: 'Get usage summary for the current billing period.',
-    goal: 'Show usage vs limits.',
-    context: 'Billing page, usage dashboards.',
-  },
-  io: {
-    input: GetUsageSummaryInputModel,
-    output: GetUsageSummaryOutputModel,
-  },
-  policy: {
-    auth: 'user',
-  },
-  acceptance: {
-    scenarios: [
-      {
-        key: 'get-usage-happy-path',
-        given: ['Organization has usage history'],
-        when: ['User requests usage summary'],
-        then: ['Usage metrics are returned'],
-      },
-    ],
-    examples: [
-      {
-        key: 'get-current-usage',
-        input: { period: 'current' },
-        output: { features: [{ name: 'api_calls', used: 100, limit: 1000 }] },
-      },
-    ],
-  },
+	meta: {
+		key: 'saas.billing.usage.summary',
+		version: '1.0.0',
+		stability: 'stable',
+		owners: [...OWNERS],
+		tags: ['saas', 'billing', 'usage'],
+		description: 'Get usage summary for the current billing period.',
+		goal: 'Show usage vs limits.',
+		context: 'Billing page, usage dashboards.',
+	},
+	io: {
+		input: GetUsageSummaryInputModel,
+		output: GetUsageSummaryOutputModel,
+	},
+	policy: {
+		auth: 'user',
+	},
+	acceptance: {
+		scenarios: [
+			{
+				key: 'get-usage-happy-path',
+				given: ['Organization has usage history'],
+				when: ['User requests usage summary'],
+				then: ['Usage metrics are returned'],
+			},
+		],
+		examples: [
+			{
+				key: 'get-current-usage',
+				input: { period: 'current' },
+				output: { features: [{ name: 'api_calls', used: 100, limit: 1000 }] },
+			},
+		],
+	},
 });
 
 /**
  * Check feature access.
  */
 export const CheckFeatureAccessContract = defineQuery({
-  meta: {
-    key: 'saas.billing.feature.check',
-    version: '1.0.0',
-    stability: 'stable',
-    owners: [...OWNERS],
-    tags: ['saas', 'billing', 'feature'],
-    description: 'Check if organization has access to a feature.',
-    goal: 'Gate features based on plan/usage.',
-    context: 'Feature access checks, upgrade prompts.',
-  },
-  io: {
-    input: CheckFeatureAccessInputModel,
-    output: CheckFeatureAccessOutputModel,
-  },
-  policy: {
-    auth: 'user',
-  },
-  acceptance: {
-    scenarios: [
-      {
-        key: 'check-access-granted',
-        given: ['Organization is on Pro plan'],
-        when: ['User checks access to Pro feature'],
-        then: ['Access is granted'],
-      },
-    ],
-    examples: [
-      {
-        key: 'check-advanced-reports',
-        input: { feature: 'advanced_reports' },
-        output: { hasAccess: true, reason: 'Included in Pro plan' },
-      },
-    ],
-  },
+	meta: {
+		key: 'saas.billing.feature.check',
+		version: '1.0.0',
+		stability: 'stable',
+		owners: [...OWNERS],
+		tags: ['saas', 'billing', 'feature'],
+		description: 'Check if organization has access to a feature.',
+		goal: 'Gate features based on plan/usage.',
+		context: 'Feature access checks, upgrade prompts.',
+	},
+	io: {
+		input: CheckFeatureAccessInputModel,
+		output: CheckFeatureAccessOutputModel,
+	},
+	policy: {
+		auth: 'user',
+	},
+	acceptance: {
+		scenarios: [
+			{
+				key: 'check-access-granted',
+				given: ['Organization is on Pro plan'],
+				when: ['User checks access to Pro feature'],
+				then: ['Access is granted'],
+			},
+		],
+		examples: [
+			{
+				key: 'check-advanced-reports',
+				input: { feature: 'advanced_reports' },
+				output: { hasAccess: true, reason: 'Included in Pro plan' },
+			},
+		],
+	},
 });

package/src/billing/billing.presentation.ts

@@ -1,59 +1,59 @@
 import {
-  definePresentation,
-  StabilityEnum,
+	definePresentation,
+	StabilityEnum,
 } from '@contractspec/lib.contracts-spec';
 
 /**
  * Presentation for subscription overview.
  */
 export const SubscriptionPresentation = definePresentation({
-  meta: {
-    key: 'saas.billing.subscription',
-    version: '1.0.0',
-    title: 'Subscription Status',
-    description:
-      'Subscription status with plan info, limits, and current usage',
-    domain: 'saas-boilerplate',
-    owners: ['@saas-team'],
-    tags: ['billing', 'subscription'],
-    stability: StabilityEnum.Beta,
-    goal: 'View subscription plan and status',
-    context: 'Billing section',
-  },
-  source: {
-    type: 'component',
-    framework: 'react',
-    componentKey: 'SubscriptionView',
-  },
-  targets: ['react', 'markdown'],
-  policy: {
-    flags: ['saas.billing.enabled'],
-  },
+	meta: {
+		key: 'saas.billing.subscription',
+		version: '1.0.0',
+		title: 'Subscription Status',
+		description:
+			'Subscription status with plan info, limits, and current usage',
+		domain: 'saas-boilerplate',
+		owners: ['@saas-team'],
+		tags: ['billing', 'subscription'],
+		stability: StabilityEnum.Beta,
+		goal: 'View subscription plan and status',
+		context: 'Billing section',
+	},
+	source: {
+		type: 'component',
+		framework: 'react',
+		componentKey: 'SubscriptionView',
+	},
+	targets: ['react', 'markdown'],
+	policy: {
+		flags: ['saas.billing.enabled'],
+	},
 });
 
 /**
  * Presentation for usage dashboard.
  */
 export const UsageDashboardPresentation = definePresentation({
-  meta: {
-    key: 'saas.billing.usage',
-    version: '1.0.0',
-    title: 'Usage Dashboard',
-    description: 'Usage metrics and breakdown by resource type',
-    domain: 'saas-boilerplate',
-    owners: ['@saas-team'],
-    tags: ['billing', 'usage', 'metrics'],
-    stability: StabilityEnum.Beta,
-    goal: 'Monitor feature usage and limits',
-    context: 'Billing section',
-  },
-  source: {
-    type: 'component',
-    framework: 'react',
-    componentKey: 'UsageDashboardView',
-  },
-  targets: ['react', 'markdown'],
-  policy: {
-    flags: ['saas.billing.enabled'],
-  },
+	meta: {
+		key: 'saas.billing.usage',
+		version: '1.0.0',
+		title: 'Usage Dashboard',
+		description: 'Usage metrics and breakdown by resource type',
+		domain: 'saas-boilerplate',
+		owners: ['@saas-team'],
+		tags: ['billing', 'usage', 'metrics'],
+		stability: StabilityEnum.Beta,
+		goal: 'Monitor feature usage and limits',
+		context: 'Billing section',
+	},
+	source: {
+		type: 'component',
+		framework: 'react',
+		componentKey: 'UsageDashboardView',
+	},
+	targets: ['react', 'markdown'],
+	policy: {
+		flags: ['saas.billing.enabled'],
+	},
 });