@lssm/bundle.contractspec-workspace 0.0.0-canary-20251217060834 → 0.0.0-canary-20251217072406

package/dist/libs/contracts/dist/integrations/providers/twilio-sms.js

@@ -0,0 +1,61 @@
+import { StabilityEnum } from "../../ownership.js";
+
+//#region ../../libs/contracts/dist/integrations/providers/twilio-sms.js
+const twilioSmsIntegrationSpec = {
+	meta: {
+		key: "sms.twilio",
+		version: 1,
+		category: "sms",
+		displayName: "Twilio SMS",
+		title: "Twilio Messaging",
+		description: "Twilio SMS integration for transactional and notification messaging.",
+		domain: "communications",
+		owners: ["platform.messaging"],
+		tags: ["sms", "messaging"],
+		stability: StabilityEnum.Stable
+	},
+	supportedModes: ["managed", "byok"],
+	capabilities: { provides: [{
+		key: "sms.outbound",
+		version: 1
+	}] },
+	configSchema: {
+		schema: {
+			type: "object",
+			properties: { fromNumber: {
+				type: "string",
+				description: "Default Twilio phone number used as sender."
+			} }
+		},
+		example: { fromNumber: "+15551234567" }
+	},
+	secretSchema: {
+		schema: {
+			type: "object",
+			required: ["accountSid", "authToken"],
+			properties: {
+				accountSid: {
+					type: "string",
+					description: "Twilio Account SID."
+				},
+				authToken: {
+					type: "string",
+					description: "Twilio Auth Token."
+				}
+			}
+		},
+		example: {
+			accountSid: "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
+			authToken: "auth-token"
+		}
+	},
+	healthCheck: {
+		method: "custom",
+		timeoutMs: 3e3
+	},
+	docsUrl: "https://www.twilio.com/docs/sms/api",
+	constraints: { rateLimit: { rpm: 200 } },
+	byokSetup: { setupInstructions: "Provide a Twilio account SID, auth token, and verify the outbound sending numbers used by the integration." }
+};
+
+//#endregion

package/dist/libs/contracts/dist/jsonschema.js

@@ -0,0 +1,24 @@
+import z from "zod";
+
+//#region ../../libs/contracts/dist/jsonschema.js
+function jsonSchemaForSpec(spec) {
+	return {
+		input: spec.io.input ? z.toJSONSchema(spec.io.input.getZod()) : null,
+		output: spec.io.output ? z.toJSONSchema(spec.io.output.getZod()) : null,
+		meta: {
+			name: spec.meta.name,
+			version: spec.meta.version,
+			kind: spec.meta.kind,
+			description: spec.meta.description,
+			tags: spec.meta.tags ?? [],
+			stability: spec.meta.stability ?? "stable"
+		}
+	};
+}
+/** Helper to derive default REST path */
+function defaultRestPath(name, version) {
+	return `/${name.replace(/\./g, "/")}/v${version}`;
+}
+
+//#endregion
+export { defaultRestPath, jsonSchemaForSpec };

package/dist/libs/contracts/dist/knowledge/contracts.js

@@ -0,0 +1,306 @@
+import { SchemaModel } from "../schema/dist/SchemaModel.js";
+import { ScalarTypeEnum } from "../schema/dist/ScalarTypeEnum.js";
+import "../schema/dist/index.js";
+import { defineCommand, defineQuery } from "../spec.js";
+
+//#region ../../libs/contracts/dist/knowledge/contracts.js
+const KnowledgeSyncSchedule = new SchemaModel({
+	name: "KnowledgeSyncSchedule",
+	fields: {
+		enabled: {
+			type: ScalarTypeEnum.Boolean(),
+			isOptional: false
+		},
+		cron: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		intervalMs: {
+			type: ScalarTypeEnum.Int_unsecure(),
+			isOptional: true
+		}
+	}
+});
+const KnowledgeSourceRecord = new SchemaModel({
+	name: "KnowledgeSourceRecord",
+	fields: {
+		id: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		tenantId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		spaceKey: {
+			type: ScalarTypeEnum.NonEmptyString(),
+			isOptional: false
+		},
+		spaceVersion: {
+			type: ScalarTypeEnum.Int_unsecure(),
+			isOptional: false
+		},
+		label: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false
+		},
+		sourceType: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false
+		},
+		syncSchedule: {
+			type: KnowledgeSyncSchedule,
+			isOptional: true
+		},
+		lastSyncStatus: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		lastSyncAt: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: true
+		},
+		itemsProcessed: {
+			type: ScalarTypeEnum.Int_unsecure(),
+			isOptional: true
+		},
+		createdAt: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: true
+		},
+		updatedAt: {
+			type: ScalarTypeEnum.DateTime(),
+			isOptional: true
+		}
+	}
+});
+const CreateKnowledgeSourceInput = new SchemaModel({
+	name: "CreateKnowledgeSourceInput",
+	fields: {
+		tenantId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		spaceKey: {
+			type: ScalarTypeEnum.NonEmptyString(),
+			isOptional: false
+		},
+		spaceVersion: {
+			type: ScalarTypeEnum.Int_unsecure(),
+			isOptional: false
+		},
+		label: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: false
+		},
+		sourceType: {
+			type: ScalarTypeEnum.NonEmptyString(),
+			isOptional: false
+		},
+		config: {
+			type: ScalarTypeEnum.JSONObject(),
+			isOptional: false
+		},
+		syncSchedule: {
+			type: KnowledgeSyncSchedule,
+			isOptional: true
+		}
+	}
+});
+const UpdateKnowledgeSourceInput = new SchemaModel({
+	name: "UpdateKnowledgeSourceInput",
+	fields: {
+		sourceId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		label: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		},
+		config: {
+			type: ScalarTypeEnum.JSONObject(),
+			isOptional: true
+		},
+		syncSchedule: {
+			type: KnowledgeSyncSchedule,
+			isOptional: true
+		}
+	}
+});
+const DeleteKnowledgeSourceInput = new SchemaModel({
+	name: "DeleteKnowledgeSourceInput",
+	fields: { sourceId: {
+		type: ScalarTypeEnum.ID(),
+		isOptional: false
+	} }
+});
+const DeleteKnowledgeSourceOutput = new SchemaModel({
+	name: "DeleteKnowledgeSourceOutput",
+	fields: { success: {
+		type: ScalarTypeEnum.Boolean(),
+		isOptional: false
+	} }
+});
+const ListKnowledgeSourcesInput = new SchemaModel({
+	name: "ListKnowledgeSourcesInput",
+	fields: {
+		tenantId: {
+			type: ScalarTypeEnum.ID(),
+			isOptional: false
+		},
+		spaceKey: {
+			type: ScalarTypeEnum.NonEmptyString(),
+			isOptional: true
+		}
+	}
+});
+const ListKnowledgeSourcesOutput = new SchemaModel({
+	name: "ListKnowledgeSourcesOutput",
+	fields: { sources: {
+		type: KnowledgeSourceRecord,
+		isOptional: false,
+		isArray: true
+	} }
+});
+const TriggerKnowledgeSyncInput = new SchemaModel({
+	name: "TriggerKnowledgeSyncInput",
+	fields: { sourceId: {
+		type: ScalarTypeEnum.ID(),
+		isOptional: false
+	} }
+});
+const TriggerKnowledgeSyncOutput = new SchemaModel({
+	name: "TriggerKnowledgeSyncOutput",
+	fields: {
+		success: {
+			type: ScalarTypeEnum.Boolean(),
+			isOptional: false
+		},
+		itemsProcessed: {
+			type: ScalarTypeEnum.Int_unsecure(),
+			isOptional: true
+		},
+		error: {
+			type: ScalarTypeEnum.String_unsecure(),
+			isOptional: true
+		}
+	}
+});
+const CreateKnowledgeSource = defineCommand({
+	meta: {
+		name: "knowledge.source.create",
+		version: 1,
+		description: "Create a knowledge source binding for a tenant.",
+		goal: "Onboard a new knowledge ingestion source such as Notion or uploads.",
+		context: "Used by Ops and App Studio to configure knowledge ingestion per tenant and space.",
+		owners: ["platform.knowledge"],
+		tags: ["knowledge", "sources"],
+		stability: "experimental"
+	},
+	io: {
+		input: CreateKnowledgeSourceInput,
+		output: KnowledgeSourceRecord
+	},
+	policy: {
+		auth: "admin",
+		policies: [{
+			name: "platform.knowledge.manage",
+			version: 1
+		}]
+	}
+});
+const UpdateKnowledgeSource = defineCommand({
+	meta: {
+		name: "knowledge.source.update",
+		version: 1,
+		description: "Update metadata or configuration for a knowledge source.",
+		goal: "Allow rotation of credentials, sync schedules, and labels.",
+		context: "Supports editing how a tenant ingests knowledge (e.g., toggling sync cadence).",
+		owners: ["platform.knowledge"],
+		tags: ["knowledge", "sources"],
+		stability: "experimental"
+	},
+	io: {
+		input: UpdateKnowledgeSourceInput,
+		output: KnowledgeSourceRecord
+	},
+	policy: {
+		auth: "admin",
+		policies: [{
+			name: "platform.knowledge.manage",
+			version: 1
+		}]
+	}
+});
+const DeleteKnowledgeSource = defineCommand({
+	meta: {
+		name: "knowledge.source.delete",
+		version: 1,
+		description: "Delete a knowledge source binding for a tenant.",
+		goal: "Remove obsolete or compromised knowledge ingestion paths.",
+		context: "Ensures ephemeral or external sources can be removed cleanly without leaving residual bindings.",
+		owners: ["platform.knowledge"],
+		tags: ["knowledge", "sources"],
+		stability: "experimental"
+	},
+	io: {
+		input: DeleteKnowledgeSourceInput,
+		output: DeleteKnowledgeSourceOutput
+	},
+	policy: {
+		auth: "admin",
+		policies: [{
+			name: "platform.knowledge.manage",
+			version: 1
+		}]
+	}
+});
+const ListKnowledgeSources = defineQuery({
+	meta: {
+		name: "knowledge.source.list",
+		version: 1,
+		description: "List knowledge sources configured for a tenant.",
+		goal: "Provide visibility into knowledge ingest configuration and schedules.",
+		context: "Used by App Studio and Ops flows to surface knowledge sources and their health.",
+		owners: ["platform.knowledge"],
+		tags: ["knowledge", "sources"],
+		stability: "experimental"
+	},
+	io: {
+		input: ListKnowledgeSourcesInput,
+		output: ListKnowledgeSourcesOutput
+	},
+	policy: {
+		auth: "admin",
+		policies: [{
+			name: "platform.knowledge.read",
+			version: 1
+		}]
+	}
+});
+const TriggerKnowledgeSourceSync = defineCommand({
+	meta: {
+		name: "knowledge.source.triggerSync",
+		version: 1,
+		description: "Trigger an immediate sync for a knowledge source.",
+		goal: "Support manual or automated sync retries for knowledge ingestion.",
+		context: "Invoked by Ops tooling or monitors when knowledge content must be refreshed or reprocessed.",
+		owners: ["platform.knowledge"],
+		tags: ["knowledge", "sources"],
+		stability: "experimental"
+	},
+	io: {
+		input: TriggerKnowledgeSyncInput,
+		output: TriggerKnowledgeSyncOutput
+	},
+	policy: {
+		auth: "admin",
+		policies: [{
+			name: "platform.knowledge.manage",
+			version: 1
+		}]
+	}
+});
+
+//#endregion

package/dist/libs/contracts/dist/knowledge/index.js

@@ -0,0 +1,7 @@
+import "./spaces/product-canon.js";
+import "./spaces/support-faq.js";
+import "./spaces/email-threads.js";
+import "./spaces/uploaded-docs.js";
+import "./spaces/financial-docs.js";
+import "./spaces/financial-overview.js";
+import "./spaces/index.js";

package/dist/libs/contracts/dist/knowledge/spaces/email-threads.js

@@ -0,0 +1,34 @@
+import { StabilityEnum } from "../../ownership.js";
+
+//#region ../../libs/contracts/dist/knowledge/spaces/email-threads.js
+const emailThreadsKnowledgeSpace = {
+	meta: {
+		key: "knowledge.email-threads",
+		version: 1,
+		category: "operational",
+		displayName: "Email Threads",
+		title: "Operational Email Threads",
+		description: "Indexed copies of operational email threads used for support, onboarding, and workflows.",
+		domain: "operations",
+		owners: ["platform.operations"],
+		tags: ["email", "operations"],
+		stability: StabilityEnum.Beta
+	},
+	retention: { ttlDays: 365 },
+	access: {
+		policy: {
+			name: "knowledge.access.email-threads",
+			version: 1
+		},
+		trustLevel: "medium",
+		automationWritable: true
+	},
+	indexing: {
+		embeddingModel: "mistral-embed",
+		chunkSize: 600,
+		vectorDbIntegration: "vectordb.qdrant"
+	},
+	description: "Operational email threads synchronized from Gmail to support automations and contextual assistance."
+};
+
+//#endregion

package/dist/libs/contracts/dist/knowledge/spaces/financial-docs.js

@@ -0,0 +1,34 @@
+import { StabilityEnum } from "../../ownership.js";
+
+//#region ../../libs/contracts/dist/knowledge/spaces/financial-docs.js
+const financialDocsKnowledgeSpace = {
+	meta: {
+		key: "knowledge.financial-docs",
+		version: 1,
+		category: "canonical",
+		displayName: "Financial Documents",
+		title: "Household Financial Documents",
+		description: "Invoices, bills, and contracts powering Pocket Family Office financial automation.",
+		domain: "finance",
+		owners: ["platform.finance"],
+		tags: ["finance", "documents"],
+		stability: StabilityEnum.Beta
+	},
+	retention: { ttlDays: null },
+	access: {
+		policy: {
+			name: "knowledge.access.financial-docs",
+			version: 1
+		},
+		trustLevel: "high",
+		automationWritable: true
+	},
+	indexing: {
+		embeddingModel: "mistral-embed",
+		chunkSize: 700,
+		vectorDbIntegration: "vectordb.qdrant"
+	},
+	description: "Normalized financial documents enabling bill pay automation, reminders, and summaries."
+};
+
+//#endregion

package/dist/libs/contracts/dist/knowledge/spaces/financial-overview.js

@@ -0,0 +1,38 @@
+import { StabilityEnum } from "../../ownership.js";
+
+//#region ../../libs/contracts/dist/knowledge/spaces/financial-overview.js
+const financialOverviewKnowledgeSpace = {
+	meta: {
+		key: "knowledge.financial-overview",
+		version: 1,
+		category: "operational",
+		displayName: "Financial Overview Summaries",
+		title: "Derived Financial Summaries",
+		description: "Aggregated cashflow summaries, category breakdowns, and balance trends derived from open banking data.",
+		domain: "finance",
+		owners: ["platform.finance"],
+		tags: [
+			"open-banking",
+			"summaries",
+			"cashflow"
+		],
+		stability: StabilityEnum.Experimental
+	},
+	retention: { ttlDays: 180 },
+	access: {
+		policy: {
+			name: "knowledge.access.financial-overview",
+			version: 1
+		},
+		trustLevel: "medium",
+		automationWritable: true
+	},
+	indexing: {
+		embeddingModel: "mistral-embed",
+		chunkSize: 600,
+		vectorDbIntegration: "vectordb.qdrant"
+	},
+	description: "Derived knowledge space containing weekly/monthly cashflow rollups and account health summaries. Raw transactions are excluded to respect privacy guardrails."
+};
+
+//#endregion

package/dist/libs/contracts/dist/knowledge/spaces/index.js

@@ -0,0 +1,6 @@
+import "./product-canon.js";
+import "./support-faq.js";
+import "./email-threads.js";
+import "./uploaded-docs.js";
+import "./financial-docs.js";
+import "./financial-overview.js";

package/dist/libs/contracts/dist/knowledge/spaces/product-canon.js

@@ -0,0 +1,34 @@
+import { StabilityEnum } from "../../ownership.js";
+
+//#region ../../libs/contracts/dist/knowledge/spaces/product-canon.js
+const productCanonKnowledgeSpace = {
+	meta: {
+		key: "knowledge.product-canon",
+		version: 1,
+		category: "canonical",
+		displayName: "Product Canon",
+		title: "Product Canon Knowledge Space",
+		description: "Authoritative product knowledge covering strategy, roadmap, and delivery canon.",
+		domain: "product",
+		owners: ["platform.product"],
+		tags: ["knowledge", "product"],
+		stability: StabilityEnum.Stable
+	},
+	retention: { ttlDays: null },
+	access: {
+		policy: {
+			name: "knowledge.access.product-canon",
+			version: 1
+		},
+		trustLevel: "high",
+		automationWritable: false
+	},
+	indexing: {
+		embeddingModel: "text-embedding-3-large",
+		chunkSize: 800,
+		vectorDbIntegration: "vectordb.qdrant"
+	},
+	description: "Single source of truth for product canon, principles, and strategic narratives."
+};
+
+//#endregion

package/dist/libs/contracts/dist/knowledge/spaces/support-faq.js

@@ -0,0 +1,37 @@
+import { StabilityEnum } from "../../ownership.js";
+
+//#region ../../libs/contracts/dist/knowledge/spaces/support-faq.js
+const supportFaqKnowledgeSpace = {
+	meta: {
+		key: "knowledge.support-faq",
+		version: 1,
+		category: "operational",
+		displayName: "Support FAQ",
+		title: "Support & Success FAQ",
+		description: "Operational knowledge base for customer support and success.",
+		domain: "support",
+		owners: ["platform.support"],
+		tags: ["knowledge", "support"],
+		stability: StabilityEnum.Beta
+	},
+	retention: {
+		ttlDays: 365,
+		archiveAfterDays: 180
+	},
+	access: {
+		policy: {
+			name: "knowledge.access.support",
+			version: 1
+		},
+		trustLevel: "medium",
+		automationWritable: true
+	},
+	indexing: {
+		embeddingModel: "text-embedding-3-small",
+		chunkSize: 700,
+		vectorDbIntegration: "vectordb.qdrant"
+	},
+	description: "Operational FAQs, runbooks, and customer success playbooks augmented with automation updates."
+};
+
+//#endregion

package/dist/libs/contracts/dist/knowledge/spaces/uploaded-docs.js

@@ -0,0 +1,34 @@
+import { StabilityEnum } from "../../ownership.js";
+
+//#region ../../libs/contracts/dist/knowledge/spaces/uploaded-docs.js
+const uploadedDocsKnowledgeSpace = {
+	meta: {
+		key: "knowledge.uploaded-docs",
+		version: 1,
+		category: "external",
+		displayName: "Uploaded Documents",
+		title: "Uploaded Knowledge Assets",
+		description: "Documents uploaded by households, including invoices, contracts, and reference files.",
+		domain: "operations",
+		owners: ["platform.operations"],
+		tags: ["documents", "storage"],
+		stability: StabilityEnum.Beta
+	},
+	retention: { ttlDays: null },
+	access: {
+		policy: {
+			name: "knowledge.access.uploaded-docs",
+			version: 1
+		},
+		trustLevel: "medium",
+		automationWritable: true
+	},
+	indexing: {
+		embeddingModel: "mistral-embed",
+		chunkSize: 900,
+		vectorDbIntegration: "vectordb.qdrant"
+	},
+	description: "User-provided documents normalized and embedded for retrieval augmented workflows."
+};
+
+//#endregion