@contractspec/example.saas-boilerplate 3.7.6 → 3.8.2

package/dist/visualizations/selectors.js

@@ -0,0 +1,211 @@
+// @bun
+// src/visualizations/catalog.ts
+import {
+  defineVisualization,
+  VisualizationRegistry
+} from "@contractspec/lib.contracts-spec/visualizations";
+var PROJECT_LIST_REF = {
+  key: "saas.project.list",
+  version: "1.0.0"
+};
+var META = {
+  version: "1.0.0",
+  domain: "saas",
+  stability: "experimental",
+  owners: ["@example.saas-boilerplate"],
+  tags: ["saas", "visualization", "projects"]
+};
+var SaasProjectUsageVisualization = defineVisualization({
+  meta: {
+    ...META,
+    key: "saas-boilerplate.visualization.project-usage",
+    title: "Project Capacity",
+    description: "Current project count against the current plan limit.",
+    goal: "Show usage against the active plan allowance.",
+    context: "SaaS account overview."
+  },
+  source: { primary: PROJECT_LIST_REF, resultPath: "data" },
+  visualization: {
+    kind: "metric",
+    measure: "totalProjects",
+    comparisonMeasure: "projectLimit",
+    measures: [
+      {
+        key: "totalProjects",
+        label: "Projects",
+        dataPath: "totalProjects",
+        format: "number"
+      },
+      {
+        key: "projectLimit",
+        label: "Plan Limit",
+        dataPath: "projectLimit",
+        format: "number"
+      }
+    ],
+    table: { caption: "Current project count and plan limit." }
+  }
+});
+var SaasProjectStatusVisualization = defineVisualization({
+  meta: {
+    ...META,
+    key: "saas-boilerplate.visualization.project-status",
+    title: "Project Status",
+    description: "Distribution of project states.",
+    goal: "Show the mix of active, draft, and archived projects.",
+    context: "Project portfolio overview."
+  },
+  source: { primary: PROJECT_LIST_REF, resultPath: "data" },
+  visualization: {
+    kind: "pie",
+    nameDimension: "status",
+    valueMeasure: "projects",
+    dimensions: [
+      { key: "status", label: "Status", dataPath: "status", type: "category" }
+    ],
+    measures: [
+      {
+        key: "projects",
+        label: "Projects",
+        dataPath: "projects",
+        format: "number"
+      }
+    ],
+    table: { caption: "Project counts by status." }
+  }
+});
+var SaasProjectTierVisualization = defineVisualization({
+  meta: {
+    ...META,
+    key: "saas-boilerplate.visualization.project-tiers",
+    title: "Tier Comparison",
+    description: "Distribution of projects across tiers.",
+    goal: "Compare how the current portfolio is distributed by tier.",
+    context: "Plan and packaging overview."
+  },
+  source: { primary: PROJECT_LIST_REF, resultPath: "data" },
+  visualization: {
+    kind: "cartesian",
+    variant: "bar",
+    xDimension: "tier",
+    yMeasures: ["projects"],
+    dimensions: [
+      { key: "tier", label: "Tier", dataPath: "tier", type: "category" }
+    ],
+    measures: [
+      {
+        key: "projects",
+        label: "Projects",
+        dataPath: "projects",
+        format: "number",
+        color: "#1d4ed8"
+      }
+    ],
+    table: { caption: "Project counts by tier." }
+  }
+});
+var SaasProjectActivityVisualization = defineVisualization({
+  meta: {
+    ...META,
+    key: "saas-boilerplate.visualization.project-activity",
+    title: "Recent Project Activity",
+    description: "Daily project creation activity.",
+    goal: "Show recent project activity over time.",
+    context: "Project portfolio trend view."
+  },
+  source: { primary: PROJECT_LIST_REF, resultPath: "data" },
+  visualization: {
+    kind: "cartesian",
+    variant: "line",
+    xDimension: "day",
+    yMeasures: ["projects"],
+    dimensions: [{ key: "day", label: "Day", dataPath: "day", type: "time" }],
+    measures: [
+      {
+        key: "projects",
+        label: "Projects",
+        dataPath: "projects",
+        format: "number",
+        color: "#0f766e"
+      }
+    ],
+    table: { caption: "Daily project creation counts." }
+  }
+});
+var SaasVisualizationSpecs = [
+  SaasProjectUsageVisualization,
+  SaasProjectStatusVisualization,
+  SaasProjectTierVisualization,
+  SaasProjectActivityVisualization
+];
+var SaasVisualizationRegistry = new VisualizationRegistry([
+  ...SaasVisualizationSpecs
+]);
+var SaasVisualizationRefs = SaasVisualizationSpecs.map((spec) => ({
+  key: spec.meta.key,
+  version: spec.meta.version
+}));
+
+// src/visualizations/selectors.ts
+function toDayKey(value) {
+  const date = value instanceof Date ? value : new Date(value);
+  return date.toISOString().slice(0, 10);
+}
+function createSaasVisualizationItems(projects, projectLimit = 10) {
+  const statusCounts = new Map;
+  const tierCounts = new Map;
+  const activityCounts = new Map;
+  for (const project of projects) {
+    statusCounts.set(project.status, (statusCounts.get(project.status) ?? 0) + 1);
+    tierCounts.set(project.tier, (tierCounts.get(project.tier) ?? 0) + 1);
+    const day = toDayKey(project.createdAt);
+    activityCounts.set(day, (activityCounts.get(day) ?? 0) + 1);
+  }
+  return [
+    {
+      key: "saas-capacity",
+      spec: SaasProjectUsageVisualization,
+      data: { data: [{ totalProjects: projects.length, projectLimit }] },
+      title: "Project Capacity",
+      description: "Current project count compared to the active limit.",
+      height: 220
+    },
+    {
+      key: "saas-status",
+      spec: SaasProjectStatusVisualization,
+      data: {
+        data: Array.from(statusCounts.entries()).map(([status, count]) => ({
+          status,
+          projects: count
+        }))
+      },
+      title: "Project Status",
+      description: "Status mix across the current project portfolio.",
+      height: 260
+    },
+    {
+      key: "saas-tier",
+      spec: SaasProjectTierVisualization,
+      data: {
+        data: Array.from(tierCounts.entries()).map(([tier, count]) => ({
+          tier,
+          projects: count
+        }))
+      },
+      title: "Tier Comparison",
+      description: "How projects are distributed across tiers."
+    },
+    {
+      key: "saas-activity",
+      spec: SaasProjectActivityVisualization,
+      data: {
+        data: Array.from(activityCounts.entries()).sort(([left], [right]) => left.localeCompare(right)).map(([day, count]) => ({ day, projects: count }))
+      },
+      title: "Recent Project Activity",
+      description: "Daily project creation activity."
+    }
+  ];
+}
+export {
+  createSaasVisualizationItems
+};

package/dist/visualizations/selectors.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contractspec/example.saas-boilerplate",
-  "version": "3.7.6",
+  "version": "3.8.2",
   "description": "SaaS Boilerplate - Users, Orgs, Projects, Billing, Settings",
   "type": "module",
   "types": "./dist/index.d.ts",
@@ -327,6 +327,13 @@
       "node": "./dist/node/ui/SaasDashboard.js",
       "default": "./dist/ui/SaasDashboard.js"
     },
+    "./ui/SaasDashboard.visualizations": {
+      "types": "./dist/ui/SaasDashboard.visualizations.d.ts",
+      "browser": "./dist/browser/ui/SaasDashboard.visualizations.js",
+      "bun": "./dist/ui/SaasDashboard.visualizations.js",
+      "node": "./dist/node/ui/SaasDashboard.visualizations.js",
+      "default": "./dist/ui/SaasDashboard.visualizations.js"
+    },
     "./ui/SaasProjectList": {
       "types": "./dist/ui/SaasProjectList.d.ts",
       "browser": "./dist/browser/ui/SaasProjectList.js",
@@ -340,6 +347,27 @@
       "bun": "./dist/ui/SaasSettingsPanel.js",
       "node": "./dist/node/ui/SaasSettingsPanel.js",
       "default": "./dist/ui/SaasSettingsPanel.js"
+    },
+    "./visualizations": {
+      "types": "./dist/visualizations/index.d.ts",
+      "browser": "./dist/browser/visualizations/index.js",
+      "bun": "./dist/visualizations/index.js",
+      "node": "./dist/node/visualizations/index.js",
+      "default": "./dist/visualizations/index.js"
+    },
+    "./visualizations/catalog": {
+      "types": "./dist/visualizations/catalog.d.ts",
+      "browser": "./dist/browser/visualizations/catalog.js",
+      "bun": "./dist/visualizations/catalog.js",
+      "node": "./dist/node/visualizations/catalog.js",
+      "default": "./dist/visualizations/catalog.js"
+    },
+    "./visualizations/selectors": {
+      "types": "./dist/visualizations/selectors.d.ts",
+      "browser": "./dist/browser/visualizations/selectors.js",
+      "bun": "./dist/visualizations/selectors.js",
+      "node": "./dist/node/visualizations/selectors.js",
+      "default": "./dist/visualizations/selectors.js"
     }
   },
   "scripts": {
@@ -351,31 +379,31 @@
     "dev": "contractspec-bun-build dev",
     "clean": "rimraf dist .turbo",
     "lint": "bun lint:fix",
-    "lint:fix": "eslint src --fix",
-    "lint:check": "eslint src",
+    "lint:fix": "biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .",
+    "lint:check": "biome check .",
     "test": "bun test --pass-with-no-tests",
     "prebuild": "contractspec-bun-build prebuild",
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@contractspec/lib.identity-rbac": "3.7.6",
-    "@contractspec/lib.jobs": "3.7.6",
-    "@contractspec/module.audit-trail": "3.7.6",
-    "@contractspec/module.notifications": "3.7.6",
-    "@contractspec/lib.contracts-spec": "3.7.6",
-    "@contractspec/lib.schema": "3.7.6",
-    "@contractspec/lib.example-shared-ui": "6.0.6",
-    "@contractspec/lib.design-system": "3.7.6",
-    "@contractspec/lib.runtime-sandbox": "2.7.6",
+    "@contractspec/lib.identity-rbac": "3.7.10",
+    "@contractspec/lib.jobs": "3.7.10",
+    "@contractspec/module.audit-trail": "3.7.10",
+    "@contractspec/module.notifications": "3.7.10",
+    "@contractspec/lib.contracts-spec": "4.1.2",
+    "@contractspec/lib.schema": "3.7.8",
+    "@contractspec/lib.example-shared-ui": "6.0.10",
+    "@contractspec/lib.design-system": "3.8.3",
+    "@contractspec/lib.runtime-sandbox": "2.7.9",
     "react": "19.2.0",
     "react-dom": "19.2.0"
   },
   "devDependencies": {
-    "@contractspec/tool.typescript": "3.7.6",
+    "@contractspec/tool.typescript": "3.7.8",
     "typescript": "^5.9.3",
     "@types/react": "^19.2.14",
     "@types/react-dom": "^19.2.2",
-    "@contractspec/tool.bun": "3.7.6"
+    "@contractspec/tool.bun": "3.7.8"
   },
   "publishConfig": {
     "exports": {
@@ -701,6 +729,13 @@
         "node": "./dist/node/ui/SaasDashboard.js",
         "default": "./dist/ui/SaasDashboard.js"
       },
+      "./ui/SaasDashboard.visualizations": {
+        "types": "./dist/ui/SaasDashboard.visualizations.d.ts",
+        "browser": "./dist/browser/ui/SaasDashboard.visualizations.js",
+        "bun": "./dist/ui/SaasDashboard.visualizations.js",
+        "node": "./dist/node/ui/SaasDashboard.visualizations.js",
+        "default": "./dist/ui/SaasDashboard.visualizations.js"
+      },
       "./ui/SaasProjectList": {
         "types": "./dist/ui/SaasProjectList.d.ts",
         "browser": "./dist/browser/ui/SaasProjectList.js",
@@ -714,6 +749,27 @@
         "bun": "./dist/ui/SaasSettingsPanel.js",
         "node": "./dist/node/ui/SaasSettingsPanel.js",
         "default": "./dist/ui/SaasSettingsPanel.js"
+      },
+      "./visualizations": {
+        "types": "./dist/visualizations/index.d.ts",
+        "browser": "./dist/browser/visualizations/index.js",
+        "bun": "./dist/visualizations/index.js",
+        "node": "./dist/node/visualizations/index.js",
+        "default": "./dist/visualizations/index.js"
+      },
+      "./visualizations/catalog": {
+        "types": "./dist/visualizations/catalog.d.ts",
+        "browser": "./dist/browser/visualizations/catalog.js",
+        "bun": "./dist/visualizations/catalog.js",
+        "node": "./dist/node/visualizations/catalog.js",
+        "default": "./dist/visualizations/catalog.js"
+      },
+      "./visualizations/selectors": {
+        "types": "./dist/visualizations/selectors.d.ts",
+        "browser": "./dist/browser/visualizations/selectors.js",
+        "bun": "./dist/visualizations/selectors.js",
+        "node": "./dist/node/visualizations/selectors.js",
+        "default": "./dist/visualizations/selectors.js"
       }
     },
     "registry": "https://registry.npmjs.org/",

package/src/billing/billing.entity.ts

@@ -1,158 +1,158 @@
 import {
-  defineEntity,
-  defineEntityEnum,
-  field,
-  index,
+	defineEntity,
+	defineEntityEnum,
+	field,
+	index,
 } from '@contractspec/lib.schema';
 
 /**
  * Subscription status enum for entities.
  */
 export const SubscriptionStatusEnum = defineEntityEnum({
-  name: 'SubscriptionStatus',
-  values: ['TRIALING', 'ACTIVE', 'PAST_DUE', 'CANCELED', 'PAUSED'] as const,
-  schema: 'saas_app',
-  description: 'Status of a subscription.',
+	name: 'SubscriptionStatus',
+	values: ['TRIALING', 'ACTIVE', 'PAST_DUE', 'CANCELED', 'PAUSED'] as const,
+	schema: 'saas_app',
+	description: 'Status of a subscription.',
 });
 
 /**
  * Subscription entity - organization subscription info.
  */
 export const SubscriptionEntity = defineEntity({
-  name: 'Subscription',
-  description: 'Organization subscription/plan information.',
-  schema: 'saas_app',
-  map: 'subscription',
-  fields: {
-    id: field.id(),
-    organizationId: field.foreignKey({ isUnique: true }),
-
-    // Plan info
-    planId: field.string({ description: 'Plan identifier' }),
-    planName: field.string({ description: 'Plan display name' }),
-
-    // Status
-    status: field.enum('SubscriptionStatus'),
-
-    // Billing cycle
-    currentPeriodStart: field.dateTime(),
-    currentPeriodEnd: field.dateTime(),
-
-    // Trial
-    trialEndsAt: field.dateTime({ isOptional: true }),
-
-    // Cancellation
-    cancelAtPeriodEnd: field.boolean({ default: false }),
-    canceledAt: field.dateTime({ isOptional: true }),
-
-    // External reference
-    stripeSubscriptionId: field.string({ isOptional: true }),
-    stripeCustomerId: field.string({ isOptional: true }),
-
-    // Metadata
-    metadata: field.json({ isOptional: true }),
-
-    // Timestamps
-    createdAt: field.createdAt(),
-    updatedAt: field.updatedAt(),
-  },
-  enums: [SubscriptionStatusEnum],
+	name: 'Subscription',
+	description: 'Organization subscription/plan information.',
+	schema: 'saas_app',
+	map: 'subscription',
+	fields: {
+		id: field.id(),
+		organizationId: field.foreignKey({ isUnique: true }),
+
+		// Plan info
+		planId: field.string({ description: 'Plan identifier' }),
+		planName: field.string({ description: 'Plan display name' }),
+
+		// Status
+		status: field.enum('SubscriptionStatus'),
+
+		// Billing cycle
+		currentPeriodStart: field.dateTime(),
+		currentPeriodEnd: field.dateTime(),
+
+		// Trial
+		trialEndsAt: field.dateTime({ isOptional: true }),
+
+		// Cancellation
+		cancelAtPeriodEnd: field.boolean({ default: false }),
+		canceledAt: field.dateTime({ isOptional: true }),
+
+		// External reference
+		stripeSubscriptionId: field.string({ isOptional: true }),
+		stripeCustomerId: field.string({ isOptional: true }),
+
+		// Metadata
+		metadata: field.json({ isOptional: true }),
+
+		// Timestamps
+		createdAt: field.createdAt(),
+		updatedAt: field.updatedAt(),
+	},
+	enums: [SubscriptionStatusEnum],
 });
 
 /**
  * BillingUsage entity - track feature usage.
  */
 export const BillingUsageEntity = defineEntity({
-  name: 'BillingUsage',
-  description: 'Track usage of metered features.',
-  schema: 'saas_app',
-  map: 'billing_usage',
-  fields: {
-    id: field.id(),
-    organizationId: field.foreignKey(),
-
-    // Feature
-    feature: field.string({
-      description: 'Feature being tracked (e.g., "api_calls", "storage_gb")',
-    }),
-
-    // Usage
-    quantity: field.int({ description: 'Usage quantity' }),
-    unit: field.string({
-      isOptional: true,
-      description: 'Unit of measurement',
-    }),
-
-    // Period
-    billingPeriod: field.string({
-      description: 'Billing period (e.g., "2024-01")',
-    }),
-
-    // Aggregation
-    recordedAt: field.dateTime({ description: 'When usage was recorded' }),
-
-    // Source
-    sourceId: field.string({
-      isOptional: true,
-      description: 'Source of usage (e.g., request ID)',
-    }),
-    sourceType: field.string({ isOptional: true }),
-
-    // Metadata
-    metadata: field.json({ isOptional: true }),
-  },
-  indexes: [
-    index.on(['organizationId', 'feature', 'billingPeriod']),
-    index.on(['organizationId', 'recordedAt']),
-  ],
+	name: 'BillingUsage',
+	description: 'Track usage of metered features.',
+	schema: 'saas_app',
+	map: 'billing_usage',
+	fields: {
+		id: field.id(),
+		organizationId: field.foreignKey(),
+
+		// Feature
+		feature: field.string({
+			description: 'Feature being tracked (e.g., "api_calls", "storage_gb")',
+		}),
+
+		// Usage
+		quantity: field.int({ description: 'Usage quantity' }),
+		unit: field.string({
+			isOptional: true,
+			description: 'Unit of measurement',
+		}),
+
+		// Period
+		billingPeriod: field.string({
+			description: 'Billing period (e.g., "2024-01")',
+		}),
+
+		// Aggregation
+		recordedAt: field.dateTime({ description: 'When usage was recorded' }),
+
+		// Source
+		sourceId: field.string({
+			isOptional: true,
+			description: 'Source of usage (e.g., request ID)',
+		}),
+		sourceType: field.string({ isOptional: true }),
+
+		// Metadata
+		metadata: field.json({ isOptional: true }),
+	},
+	indexes: [
+		index.on(['organizationId', 'feature', 'billingPeriod']),
+		index.on(['organizationId', 'recordedAt']),
+	],
 });
 
 /**
  * UsageLimit entity - feature usage limits per plan.
  */
 export const UsageLimitEntity = defineEntity({
-  name: 'UsageLimit',
-  description: 'Usage limits per plan/organization.',
-  schema: 'saas_app',
-  map: 'usage_limit',
-  fields: {
-    id: field.id(),
-
-    // Scope
-    planId: field.string({
-      isOptional: true,
-      description: 'Plan this limit applies to',
-    }),
-    organizationId: field.string({
-      isOptional: true,
-      description: 'Org-specific override',
-    }),
-
-    // Limit
-    feature: field.string({ description: 'Feature being limited' }),
-    limit: field.int({ description: 'Maximum allowed usage' }),
-    resetPeriod: field.string({
-      default: '"monthly"',
-      description: 'When limit resets',
-    }),
-
-    // Soft/hard limit
-    isSoftLimit: field.boolean({
-      default: false,
-      description: 'Whether to warn vs block',
-    }),
-    overage: field.boolean({
-      default: false,
-      description: 'Whether overage is allowed',
-    }),
-    overageRate: field.float({
-      isOptional: true,
-      description: 'Cost per unit over limit',
-    }),
-
-    // Timestamps
-    createdAt: field.createdAt(),
-    updatedAt: field.updatedAt(),
-  },
-  indexes: [index.unique(['planId', 'feature'])],
+	name: 'UsageLimit',
+	description: 'Usage limits per plan/organization.',
+	schema: 'saas_app',
+	map: 'usage_limit',
+	fields: {
+		id: field.id(),
+
+		// Scope
+		planId: field.string({
+			isOptional: true,
+			description: 'Plan this limit applies to',
+		}),
+		organizationId: field.string({
+			isOptional: true,
+			description: 'Org-specific override',
+		}),
+
+		// Limit
+		feature: field.string({ description: 'Feature being limited' }),
+		limit: field.int({ description: 'Maximum allowed usage' }),
+		resetPeriod: field.string({
+			default: '"monthly"',
+			description: 'When limit resets',
+		}),
+
+		// Soft/hard limit
+		isSoftLimit: field.boolean({
+			default: false,
+			description: 'Whether to warn vs block',
+		}),
+		overage: field.boolean({
+			default: false,
+			description: 'Whether overage is allowed',
+		}),
+		overageRate: field.float({
+			isOptional: true,
+			description: 'Cost per unit over limit',
+		}),
+
+		// Timestamps
+		createdAt: field.createdAt(),
+		updatedAt: field.updatedAt(),
+	},
+	indexes: [index.unique(['planId', 'feature'])],
 });

package/src/billing/billing.enum.ts

@@ -5,19 +5,19 @@ import { defineEnum } from '@contractspec/lib.schema';
  * Note: Entity enum is defined separately in billing.entity.ts
  */
 export const SubscriptionStatusSchemaEnum = defineEnum('SubscriptionStatus', [
-  'TRIALING',
-  'ACTIVE',
-  'PAST_DUE',
-  'CANCELED',
-  'PAUSED',
+	'TRIALING',
+	'ACTIVE',
+	'PAST_DUE',
+	'CANCELED',
+	'PAUSED',
 ]);
 
 /**
  * Feature access reason enum.
  */
 export const FeatureAccessReasonEnum = defineEnum('FeatureAccessReason', [
-  'included',
-  'limit_available',
-  'limit_reached',
-  'not_in_plan',
+	'included',
+	'limit_available',
+	'limit_reached',
+	'not_in_plan',
 ]);