@contractspec/example.saas-boilerplate 3.7.5 → 3.7.7

package/src/settings/settings.entity.ts

@@ -5,85 +5,85 @@ import { SettingsScopeEnum } from './settings.enum';
  * Settings entity - key-value configuration store.
  */
 export const SettingsEntity = defineEntity({
-  name: 'Settings',
-  description: 'Application, organization, or user settings.',
-  schema: 'saas_app',
-  map: 'settings',
-  fields: {
-    id: field.id(),
+	name: 'Settings',
+	description: 'Application, organization, or user settings.',
+	schema: 'saas_app',
+	map: 'settings',
+	fields: {
+		id: field.id(),
 
-    // Key identification
-    key: field.string({
-      description: 'Setting key (e.g., "theme", "notifications.email")',
-    }),
+		// Key identification
+		key: field.string({
+			description: 'Setting key (e.g., "theme", "notifications.email")',
+		}),
 
-    // Scope
-    scope: field.enum('SettingsScope'),
-    scopeId: field.string({
-      isOptional: true,
-      description: 'ID of scoped entity (org, user, project)',
-    }),
+		// Scope
+		scope: field.enum('SettingsScope'),
+		scopeId: field.string({
+			isOptional: true,
+			description: 'ID of scoped entity (org, user, project)',
+		}),
 
-    // Value
-    value: field.json({ description: 'Setting value' }),
-    valueType: field.string({
-      default: '"string"',
-      description: 'Type hint for value',
-    }),
+		// Value
+		value: field.json({ description: 'Setting value' }),
+		valueType: field.string({
+			default: '"string"',
+			description: 'Type hint for value',
+		}),
 
-    // Schema
-    schema: field.json({
-      isOptional: true,
-      description: 'JSON schema for validation',
-    }),
+		// Schema
+		schema: field.json({
+			isOptional: true,
+			description: 'JSON schema for validation',
+		}),
 
-    // Metadata
-    description: field.string({ isOptional: true }),
-    isSecret: field.boolean({
-      default: false,
-      description: 'Whether value should be encrypted',
-    }),
+		// Metadata
+		description: field.string({ isOptional: true }),
+		isSecret: field.boolean({
+			default: false,
+			description: 'Whether value should be encrypted',
+		}),
 
-    // Timestamps
-    createdAt: field.createdAt(),
-    updatedAt: field.updatedAt(),
-  },
-  indexes: [
-    index.unique(['scope', 'scopeId', 'key']),
-    index.on(['scope', 'key']),
-  ],
-  enums: [SettingsScopeEnum],
+		// Timestamps
+		createdAt: field.createdAt(),
+		updatedAt: field.updatedAt(),
+	},
+	indexes: [
+		index.unique(['scope', 'scopeId', 'key']),
+		index.on(['scope', 'key']),
+	],
+	enums: [SettingsScopeEnum],
 });
 
 /**
  * FeatureFlag entity - feature toggles.
  */
 export const FeatureFlagEntity = defineEntity({
-  name: 'FeatureFlag',
-  description: 'Feature flags for progressive rollout.',
-  schema: 'saas_app',
-  map: 'feature_flag',
-  fields: {
-    id: field.id(),
-    key: field.string({ isUnique: true, description: 'Feature flag key' }),
-    name: field.string({ description: 'Human-readable name' }),
-    description: field.string({ isOptional: true }),
+	name: 'FeatureFlag',
+	description: 'Feature flags for progressive rollout.',
+	schema: 'saas_app',
+	map: 'feature_flag',
+	fields: {
+		id: field.id(),
+		key: field.string({ isUnique: true, description: 'Feature flag key' }),
+		name: field.string({ description: 'Human-readable name' }),
+		description: field.string({ isOptional: true }),
 
-    // Status
-    enabled: field.boolean({ default: false }),
+		// Status
+		enabled: field.boolean({ default: false }),
 
-    // Targeting
-    defaultValue: field.boolean({ default: false }),
-    rules: field.json({ isOptional: true, description: 'Targeting rules' }),
+		// Targeting
+		defaultValue: field.boolean({ default: false }),
+		rules: field.json({ isOptional: true, description: 'Targeting rules' }),
 
-    // Rollout
-    rolloutPercentage: field.int({
-      default: 0,
-      description: 'Percentage rollout (0-100)',
-    }),
+		// Rollout
+		rolloutPercentage: field.int({
+			default: 0,
+			description: 'Percentage rollout (0-100)',
+		}),
 
-    // Timestamps
-    createdAt: field.createdAt(),
-    updatedAt: field.updatedAt(),
-  },
+		// Timestamps
+		createdAt: field.createdAt(),
+		updatedAt: field.updatedAt(),
+	},
 });

package/src/settings/settings.enum.ts

@@ -4,8 +4,8 @@ import { defineEntityEnum } from '@contractspec/lib.schema';
  * Settings scope enum.
  */
 export const SettingsScopeEnum = defineEntityEnum({
-  name: 'SettingsScope',
-  values: ['APP', 'ORG', 'USER', 'PROJECT'] as const,
-  schema: 'saas_app',
-  description: 'Scope of a setting.',
+	name: 'SettingsScope',
+	values: ['APP', 'ORG', 'USER', 'PROJECT'] as const,
+	schema: 'saas_app',
+	description: 'Scope of a setting.',
 });

package/src/shared/mock-data.ts

@@ -5,106 +5,106 @@
 // ============ Project Mock Data ============
 
 export const MOCK_PROJECTS = [
-  {
-    id: 'proj-1',
-    name: 'Marketing Website',
-    description: 'Main company website redesign project',
-    slug: 'marketing-website',
-    organizationId: 'demo-org',
-    createdBy: 'user-1',
-    status: 'ACTIVE' as const,
-    isPublic: false,
-    tags: ['marketing', 'website', 'redesign'],
-    createdAt: new Date('2024-01-15T10:00:00Z'),
-    updatedAt: new Date('2024-03-20T14:30:00Z'),
-  },
-  {
-    id: 'proj-2',
-    name: 'Mobile App v2',
-    description: 'Next generation mobile application',
-    slug: 'mobile-app-v2',
-    organizationId: 'demo-org',
-    createdBy: 'user-2',
-    status: 'ACTIVE' as const,
-    isPublic: false,
-    tags: ['mobile', 'app', 'v2'],
-    createdAt: new Date('2024-02-01T09:00:00Z'),
-    updatedAt: new Date('2024-04-05T11:15:00Z'),
-  },
-  {
-    id: 'proj-3',
-    name: 'API Integration',
-    description: 'Third-party API integration project',
-    slug: 'api-integration',
-    organizationId: 'demo-org',
-    createdBy: 'user-1',
-    status: 'DRAFT' as const,
-    isPublic: false,
-    tags: ['api', 'integration'],
-    createdAt: new Date('2024-03-10T08:00:00Z'),
-    updatedAt: new Date('2024-03-10T08:00:00Z'),
-  },
-  {
-    id: 'proj-4',
-    name: 'Analytics Dashboard',
-    description: 'Internal analytics and reporting dashboard',
-    slug: 'analytics-dashboard',
-    organizationId: 'demo-org',
-    createdBy: 'user-3',
-    status: 'ARCHIVED' as const,
-    isPublic: true,
-    tags: ['analytics', 'dashboard', 'reporting'],
-    createdAt: new Date('2023-10-01T12:00:00Z'),
-    updatedAt: new Date('2024-02-28T16:45:00Z'),
-  },
+	{
+		id: 'proj-1',
+		name: 'Marketing Website',
+		description: 'Main company website redesign project',
+		slug: 'marketing-website',
+		organizationId: 'demo-org',
+		createdBy: 'user-1',
+		status: 'ACTIVE' as const,
+		isPublic: false,
+		tags: ['marketing', 'website', 'redesign'],
+		createdAt: new Date('2024-01-15T10:00:00Z'),
+		updatedAt: new Date('2024-03-20T14:30:00Z'),
+	},
+	{
+		id: 'proj-2',
+		name: 'Mobile App v2',
+		description: 'Next generation mobile application',
+		slug: 'mobile-app-v2',
+		organizationId: 'demo-org',
+		createdBy: 'user-2',
+		status: 'ACTIVE' as const,
+		isPublic: false,
+		tags: ['mobile', 'app', 'v2'],
+		createdAt: new Date('2024-02-01T09:00:00Z'),
+		updatedAt: new Date('2024-04-05T11:15:00Z'),
+	},
+	{
+		id: 'proj-3',
+		name: 'API Integration',
+		description: 'Third-party API integration project',
+		slug: 'api-integration',
+		organizationId: 'demo-org',
+		createdBy: 'user-1',
+		status: 'DRAFT' as const,
+		isPublic: false,
+		tags: ['api', 'integration'],
+		createdAt: new Date('2024-03-10T08:00:00Z'),
+		updatedAt: new Date('2024-03-10T08:00:00Z'),
+	},
+	{
+		id: 'proj-4',
+		name: 'Analytics Dashboard',
+		description: 'Internal analytics and reporting dashboard',
+		slug: 'analytics-dashboard',
+		organizationId: 'demo-org',
+		createdBy: 'user-3',
+		status: 'ARCHIVED' as const,
+		isPublic: true,
+		tags: ['analytics', 'dashboard', 'reporting'],
+		createdAt: new Date('2023-10-01T12:00:00Z'),
+		updatedAt: new Date('2024-02-28T16:45:00Z'),
+	},
 ];
 
 // ============ Subscription Mock Data ============
 
 export const MOCK_SUBSCRIPTION = {
-  id: 'sub-1',
-  organizationId: 'demo-org',
-  planId: 'pro',
-  planName: 'Professional',
-  status: 'ACTIVE' as const,
-  currentPeriodStart: new Date('2024-04-01T00:00:00Z'),
-  currentPeriodEnd: new Date('2024-05-01T00:00:00Z'),
-  limits: {
-    projects: 25,
-    users: 10,
-    storage: 50, // GB
-    apiCalls: 100000,
-  },
-  usage: {
-    projects: 4,
-    users: 5,
-    storage: 12.5,
-    apiCalls: 45230,
-  },
+	id: 'sub-1',
+	organizationId: 'demo-org',
+	planId: 'pro',
+	planName: 'Professional',
+	status: 'ACTIVE' as const,
+	currentPeriodStart: new Date('2024-04-01T00:00:00Z'),
+	currentPeriodEnd: new Date('2024-05-01T00:00:00Z'),
+	limits: {
+		projects: 25,
+		users: 10,
+		storage: 50, // GB
+		apiCalls: 100000,
+	},
+	usage: {
+		projects: 4,
+		users: 5,
+		storage: 12.5,
+		apiCalls: 45230,
+	},
 };
 
 // ============ Usage Summary Mock Data ============
 
 export const MOCK_USAGE_SUMMARY = {
-  organizationId: 'demo-org',
-  period: 'current_month',
-  apiCalls: {
-    total: 45230,
-    limit: 100000,
-    percentUsed: 45.23,
-  },
-  storage: {
-    totalGb: 12.5,
-    limitGb: 50,
-    percentUsed: 25,
-  },
-  activeProjects: 4,
-  activeUsers: 5,
-  breakdown: [
-    { date: '2024-04-01', apiCalls: 3200, storageGb: 12.1 },
-    { date: '2024-04-02', apiCalls: 2800, storageGb: 12.2 },
-    { date: '2024-04-03', apiCalls: 4100, storageGb: 12.3 },
-    { date: '2024-04-04', apiCalls: 3600, storageGb: 12.4 },
-    { date: '2024-04-05', apiCalls: 3800, storageGb: 12.5 },
-  ],
+	organizationId: 'demo-org',
+	period: 'current_month',
+	apiCalls: {
+		total: 45230,
+		limit: 100000,
+		percentUsed: 45.23,
+	},
+	storage: {
+		totalGb: 12.5,
+		limitGb: 50,
+		percentUsed: 25,
+	},
+	activeProjects: 4,
+	activeUsers: 5,
+	breakdown: [
+		{ date: '2024-04-01', apiCalls: 3200, storageGb: 12.1 },
+		{ date: '2024-04-02', apiCalls: 2800, storageGb: 12.2 },
+		{ date: '2024-04-03', apiCalls: 4100, storageGb: 12.3 },
+		{ date: '2024-04-04', apiCalls: 3600, storageGb: 12.4 },
+		{ date: '2024-04-05', apiCalls: 3800, storageGb: 12.5 },
+	],
 };

package/src/shared/overlay-types.ts

@@ -1,39 +1,39 @@
 export interface OverlayDefinition {
-  overlayId: string;
-  version: string;
-  description: string;
-  appliesTo: Record<string, string>;
-  modifications: OverlayModification[];
+	overlayId: string;
+	version: string;
+	description: string;
+	appliesTo: Record<string, string>;
+	modifications: OverlayModification[];
 }
 
 export type OverlayModification =
-  | HideFieldModification
-  | RenameLabelModification
-  | AddBadgeModification
-  | SetLimitModification;
+	| HideFieldModification
+	| RenameLabelModification
+	| AddBadgeModification
+	| SetLimitModification;
 
 export interface HideFieldModification {
-  type: 'hideField';
-  field: string;
-  reason?: string;
+	type: 'hideField';
+	field: string;
+	reason?: string;
 }
 
 export interface RenameLabelModification {
-  type: 'renameLabel';
-  field: string;
-  newLabel: string;
+	type: 'renameLabel';
+	field: string;
+	newLabel: string;
 }
 
 export interface AddBadgeModification {
-  type: 'addBadge';
-  position: 'header' | 'footer';
-  label: string;
-  variant: 'warning' | 'info' | 'error' | 'success' | 'default';
+	type: 'addBadge';
+	position: 'header' | 'footer';
+	label: string;
+	variant: 'warning' | 'info' | 'error' | 'success' | 'default';
 }
 
 export interface SetLimitModification {
-  type: 'setLimit';
-  field: string;
-  max: number;
-  message: string;
+	type: 'setLimit';
+	field: string;
+	max: number;
+	message: string;
 }

package/src/tests/operations.test-spec.ts

@@ -1,109 +1,109 @@
 import { defineTestSpec } from '@contractspec/lib.contracts-spec/tests';
 
 export const ProjectListTest = defineTestSpec({
-  meta: {
-    key: 'saas.project.list.test',
-    version: '1.0.0',
-    stability: 'experimental',
-    owners: ['@example.saas-boilerplate'],
-    description: 'Test for listing projects',
-    tags: ['test'],
-  },
-  target: {
-    type: 'operation',
-    operation: { key: 'saas.project.list', version: '1.0.0' },
-  },
-  scenarios: [
-    {
-      key: 'success',
-      when: { operation: { key: 'saas.project.list' } },
-      then: [{ type: 'expectOutput', match: {} }],
-    },
-    {
-      key: 'error',
-      when: { operation: { key: 'saas.project.list' } },
-      then: [{ type: 'expectError' }],
-    },
-  ],
+	meta: {
+		key: 'saas.project.list.test',
+		version: '1.0.0',
+		stability: 'experimental',
+		owners: ['@example.saas-boilerplate'],
+		description: 'Test for listing projects',
+		tags: ['test'],
+	},
+	target: {
+		type: 'operation',
+		operation: { key: 'saas.project.list', version: '1.0.0' },
+	},
+	scenarios: [
+		{
+			key: 'success',
+			when: { operation: { key: 'saas.project.list' } },
+			then: [{ type: 'expectOutput', match: {} }],
+		},
+		{
+			key: 'error',
+			when: { operation: { key: 'saas.project.list' } },
+			then: [{ type: 'expectError' }],
+		},
+	],
 });
 
 export const ProjectGetTest = defineTestSpec({
-  meta: {
-    key: 'saas.project.get.test',
-    version: '1.0.0',
-    stability: 'experimental',
-    owners: ['@example.saas-boilerplate'],
-    description: 'Test for getting project',
-    tags: ['test'],
-  },
-  target: {
-    type: 'operation',
-    operation: { key: 'saas.project.get', version: '1.0.0' },
-  },
-  scenarios: [
-    {
-      key: 'success',
-      when: { operation: { key: 'saas.project.get' } },
-      then: [{ type: 'expectOutput', match: {} }],
-    },
-    {
-      key: 'error',
-      when: { operation: { key: 'saas.project.get' } },
-      then: [{ type: 'expectError' }],
-    },
-  ],
+	meta: {
+		key: 'saas.project.get.test',
+		version: '1.0.0',
+		stability: 'experimental',
+		owners: ['@example.saas-boilerplate'],
+		description: 'Test for getting project',
+		tags: ['test'],
+	},
+	target: {
+		type: 'operation',
+		operation: { key: 'saas.project.get', version: '1.0.0' },
+	},
+	scenarios: [
+		{
+			key: 'success',
+			when: { operation: { key: 'saas.project.get' } },
+			then: [{ type: 'expectOutput', match: {} }],
+		},
+		{
+			key: 'error',
+			when: { operation: { key: 'saas.project.get' } },
+			then: [{ type: 'expectError' }],
+		},
+	],
 });
 
 export const BillingSubscriptionGetTest = defineTestSpec({
-  meta: {
-    key: 'saas.billing.subscription.get.test',
-    version: '1.0.0',
-    stability: 'experimental',
-    owners: ['@example.saas-boilerplate'],
-    description: 'Test for getting subscription',
-    tags: ['test'],
-  },
-  target: {
-    type: 'operation',
-    operation: { key: 'saas.billing.subscription.get', version: '1.0.0' },
-  },
-  scenarios: [
-    {
-      key: 'success',
-      when: { operation: { key: 'saas.billing.subscription.get' } },
-      then: [{ type: 'expectOutput', match: {} }],
-    },
-    {
-      key: 'error',
-      when: { operation: { key: 'saas.billing.subscription.get' } },
-      then: [{ type: 'expectError' }],
-    },
-  ],
+	meta: {
+		key: 'saas.billing.subscription.get.test',
+		version: '1.0.0',
+		stability: 'experimental',
+		owners: ['@example.saas-boilerplate'],
+		description: 'Test for getting subscription',
+		tags: ['test'],
+	},
+	target: {
+		type: 'operation',
+		operation: { key: 'saas.billing.subscription.get', version: '1.0.0' },
+	},
+	scenarios: [
+		{
+			key: 'success',
+			when: { operation: { key: 'saas.billing.subscription.get' } },
+			then: [{ type: 'expectOutput', match: {} }],
+		},
+		{
+			key: 'error',
+			when: { operation: { key: 'saas.billing.subscription.get' } },
+			then: [{ type: 'expectError' }],
+		},
+	],
 });
 
 export const BillingUsageSummaryTest = defineTestSpec({
-  meta: {
-    key: 'saas.billing.usage.summary.test',
-    version: '1.0.0',
-    stability: 'experimental',
-    owners: ['@example.saas-boilerplate'],
-    description: 'Test for getting usage summary',
-    tags: ['test'],
-  },
-  target: {
-    type: 'operation',
-    operation: { key: 'saas.billing.usage.summary', version: '1.0.0' },
-  },
-  scenarios: [
-    {
-      key: 'success',
-      when: { operation: { key: 'saas.billing.usage.summary' } },
-      then: [{ type: 'expectOutput', match: {} }],
-    },
-    {
-      key: 'error',
-      when: { operation: { key: 'saas.billing.usage.summary' } },
-      then: [{ type: 'expectError' }],
-    },
-  ],
+	meta: {
+		key: 'saas.billing.usage.summary.test',
+		version: '1.0.0',
+		stability: 'experimental',
+		owners: ['@example.saas-boilerplate'],
+		description: 'Test for getting usage summary',
+		tags: ['test'],
+	},
+	target: {
+		type: 'operation',
+		operation: { key: 'saas.billing.usage.summary', version: '1.0.0' },
+	},
+	scenarios: [
+		{
+			key: 'success',
+			when: { operation: { key: 'saas.billing.usage.summary' } },
+			then: [{ type: 'expectOutput', match: {} }],
+		},
+		{
+			key: 'error',
+			when: { operation: { key: 'saas.billing.usage.summary' } },
+			then: [{ type: 'expectError' }],
+		},
+	],
 });