@lssm/example.saas-boilerplate 0.0.0-canary-20251217060834 → 0.0.0-canary-20251217072406

package/dist/libs/contracts/dist/integrations/providers/gcs-storage.js

@@ -0,0 +1,75 @@
+import { StabilityEnum } from "../../ownership.js";
+
+//#region ../../libs/contracts/dist/integrations/providers/gcs-storage.js
+const gcsStorageIntegrationSpec = {
+	meta: {
+		key: "storage.gcs",
+		version: 1,
+		category: "storage",
+		displayName: "Google Cloud Storage",
+		title: "Google Cloud Storage Buckets",
+		description: "Google Cloud Storage integration for object storage and retrieval.",
+		domain: "infrastructure",
+		owners: ["platform.infrastructure"],
+		tags: [
+			"storage",
+			"gcs",
+			"google-cloud"
+		],
+		stability: StabilityEnum.Beta
+	},
+	supportedModes: ["managed", "byok"],
+	capabilities: { provides: [{
+		key: "storage.objects",
+		version: 1
+	}] },
+	configSchema: {
+		schema: {
+			type: "object",
+			required: ["bucket"],
+			properties: {
+				bucket: {
+					type: "string",
+					description: "Primary bucket name used for storing objects."
+				},
+				prefix: {
+					type: "string",
+					description: "Optional prefix applied to object keys."
+				}
+			}
+		},
+		example: {
+			bucket: "pfo-tenant-assets",
+			prefix: "documents/"
+		}
+	},
+	secretSchema: {
+		schema: {
+			type: "object",
+			properties: {
+				type: {
+					type: "string",
+					description: "Service account type field from Google credentials JSON (if provided)."
+				},
+				client_email: { type: "string" },
+				private_key: { type: "string" },
+				project_id: { type: "string" }
+			}
+		},
+		example: {
+			type: "service_account",
+			client_email: "svc-account@example.iam.gserviceaccount.com",
+			private_key: "-----BEGIN PRIVATE KEY-----...",
+			project_id: "example-project"
+		}
+	},
+	healthCheck: {
+		method: "ping",
+		timeoutMs: 4e3
+	},
+	docsUrl: "https://cloud.google.com/storage/docs/apis",
+	constraints: { quotas: { storageGb: 5120 } },
+	byokSetup: { setupInstructions: "Create a Google Cloud service account with Storage Object Admin role and upload the JSON credentials to the secret store." }
+};
+
+//#endregion

package/dist/libs/contracts/dist/integrations/providers/gmail.js

@@ -0,0 +1,87 @@
+import { StabilityEnum } from "../../ownership.js";
+
+//#region ../../libs/contracts/dist/integrations/providers/gmail.js
+const gmailIntegrationSpec = {
+	meta: {
+		key: "email.gmail",
+		version: 1,
+		category: "email",
+		displayName: "Gmail API",
+		title: "Google Gmail API",
+		description: "Gmail integration supporting inbound thread ingestion and outbound transactional email.",
+		domain: "communications",
+		owners: ["platform.messaging"],
+		tags: ["email", "gmail"],
+		stability: StabilityEnum.Beta
+	},
+	supportedModes: ["managed", "byok"],
+	capabilities: { provides: [{
+		key: "email.inbound",
+		version: 1
+	}, {
+		key: "email.outbound",
+		version: 1
+	}] },
+	configSchema: {
+		schema: {
+			type: "object",
+			properties: {
+				labelIds: {
+					type: "array",
+					items: { type: "string" },
+					description: "Optional list of label IDs to scope inbound sync."
+				},
+				includeSpamTrash: {
+					type: "boolean",
+					description: "Whether to include spam or trash messages during sync."
+				}
+			}
+		},
+		example: {
+			labelIds: ["INBOX"],
+			includeSpamTrash: false
+		}
+	},
+	secretSchema: {
+		schema: {
+			type: "object",
+			required: [
+				"clientId",
+				"clientSecret",
+				"refreshToken"
+			],
+			properties: {
+				clientId: {
+					type: "string",
+					description: "OAuth client ID for the Google Cloud project."
+				},
+				clientSecret: {
+					type: "string",
+					description: "OAuth client secret for the Google Cloud project."
+				},
+				refreshToken: {
+					type: "string",
+					description: "OAuth refresh token for delegated Gmail access."
+				},
+				redirectUri: {
+					type: "string",
+					description: "Optional redirect URI used when issuing the refresh token."
+				}
+			}
+		},
+		example: {
+			clientId: "xxx.apps.googleusercontent.com",
+			clientSecret: "secret",
+			refreshToken: "refresh-token"
+		}
+	},
+	healthCheck: {
+		method: "custom",
+		timeoutMs: 4e3
+	},
+	docsUrl: "https://developers.google.com/gmail/api",
+	constraints: { rateLimit: { rpm: 600 } },
+	byokSetup: { setupInstructions: "Create an OAuth consent screen and credentials within Google Cloud Console, then authorize the Gmail scopes and store the resulting refresh token." }
+};
+
+//#endregion

package/dist/libs/contracts/dist/integrations/providers/google-calendar.js

@@ -0,0 +1,66 @@
+import { StabilityEnum } from "../../ownership.js";
+
+//#region ../../libs/contracts/dist/integrations/providers/google-calendar.js
+const googleCalendarIntegrationSpec = {
+	meta: {
+		key: "calendar.google",
+		version: 1,
+		category: "calendar",
+		displayName: "Google Calendar",
+		title: "Google Calendar API",
+		description: "Google Calendar integration for event creation, updates, and scheduling automations.",
+		domain: "productivity",
+		owners: ["platform.messaging"],
+		tags: ["calendar", "google"],
+		stability: StabilityEnum.Beta
+	},
+	supportedModes: ["managed", "byok"],
+	capabilities: { provides: [{
+		key: "calendar.events",
+		version: 1
+	}] },
+	configSchema: {
+		schema: {
+			type: "object",
+			properties: { calendarId: {
+				type: "string",
+				description: "Default calendar identifier (defaults to primary)."
+			} }
+		},
+		example: { calendarId: "primary" }
+	},
+	secretSchema: {
+		schema: {
+			type: "object",
+			required: ["clientEmail", "privateKey"],
+			properties: {
+				clientEmail: {
+					type: "string",
+					description: "Service account client email."
+				},
+				privateKey: {
+					type: "string",
+					description: "Service account private key."
+				},
+				projectId: {
+					type: "string",
+					description: "Google Cloud project ID."
+				}
+			}
+		},
+		example: {
+			clientEmail: "svc-calendar@example.iam.gserviceaccount.com",
+			privateKey: "-----BEGIN PRIVATE KEY-----...",
+			projectId: "calendar-project"
+		}
+	},
+	healthCheck: {
+		method: "custom",
+		timeoutMs: 4e3
+	},
+	docsUrl: "https://developers.google.com/calendar/api",
+	constraints: {},
+	byokSetup: { setupInstructions: "Create a Google service account with Calendar access and share the target calendars with the service account email." }
+};
+
+//#endregion

package/dist/libs/contracts/dist/integrations/providers/index.js

@@ -0,0 +1,11 @@
+import "./stripe.js";
+import "./postmark.js";
+import "./qdrant.js";
+import "./mistral.js";
+import "./elevenlabs.js";
+import "./gmail.js";
+import "./google-calendar.js";
+import "./twilio-sms.js";
+import "./gcs-storage.js";
+import "./powens.js";
+import "./registry.js";

package/dist/libs/contracts/dist/integrations/providers/mistral.js

@@ -0,0 +1,68 @@
+import { StabilityEnum } from "../../ownership.js";
+
+//#region ../../libs/contracts/dist/integrations/providers/mistral.js
+const mistralIntegrationSpec = {
+	meta: {
+		key: "ai-llm.mistral",
+		version: 1,
+		category: "ai-llm",
+		displayName: "Mistral AI",
+		title: "Mistral Large Language Model",
+		description: "Mistral integration providing chat completions and embedding generation.",
+		domain: "ai",
+		owners: ["platform.ai"],
+		tags: [
+			"ai",
+			"llm",
+			"embeddings"
+		],
+		stability: StabilityEnum.Experimental
+	},
+	supportedModes: ["managed", "byok"],
+	capabilities: { provides: [{
+		key: "ai.chat",
+		version: 1
+	}, {
+		key: "ai.embeddings",
+		version: 1
+	}] },
+	configSchema: {
+		schema: {
+			type: "object",
+			properties: {
+				model: {
+					type: "string",
+					description: "Default chat completion model (e.g., mistral-large-latest)."
+				},
+				embeddingModel: {
+					type: "string",
+					description: "Embedding model identifier."
+				}
+			}
+		},
+		example: {
+			model: "mistral-large-latest",
+			embeddingModel: "mistral-embed"
+		}
+	},
+	secretSchema: {
+		schema: {
+			type: "object",
+			required: ["apiKey"],
+			properties: { apiKey: {
+				type: "string",
+				description: "Mistral API key with access to chat and embeddings endpoints."
+			} }
+		},
+		example: { apiKey: "mistral-***" }
+	},
+	healthCheck: {
+		method: "custom",
+		timeoutMs: 5e3
+	},
+	docsUrl: "https://docs.mistral.ai/platform/endpoints",
+	constraints: { rateLimit: { rpm: 600 } },
+	byokSetup: { setupInstructions: "Generate an API key within the Mistral console and ensure the selected models are enabled for the account." }
+};
+
+//#endregion

package/dist/libs/contracts/dist/integrations/providers/postmark.js

@@ -0,0 +1,68 @@
+import { StabilityEnum } from "../../ownership.js";
+
+//#region ../../libs/contracts/dist/integrations/providers/postmark.js
+const postmarkIntegrationSpec = {
+	meta: {
+		key: "email.postmark",
+		version: 1,
+		category: "email",
+		displayName: "Postmark",
+		title: "Postmark Transactional Email",
+		description: "Postmark integration for transactional email delivery.",
+		domain: "communications",
+		owners: ["platform.messaging"],
+		tags: ["email", "transactional"],
+		stability: StabilityEnum.Stable
+	},
+	supportedModes: ["managed", "byok"],
+	capabilities: {
+		provides: [{
+			key: "email.transactional",
+			version: 1
+		}],
+		requires: [{
+			key: "platform.webhooks",
+			optional: true,
+			reason: "Optional for inbound bounce handling"
+		}]
+	},
+	configSchema: {
+		schema: {
+			type: "object",
+			properties: {
+				messageStream: {
+					type: "string",
+					description: "Optional message stream identifier (e.g., transactional)."
+				},
+				fromEmail: {
+					type: "string",
+					description: "Default From address used for outbound messages."
+				}
+			}
+		},
+		example: {
+			messageStream: "outbound",
+			fromEmail: "notifications@example.com"
+		}
+	},
+	secretSchema: {
+		schema: {
+			type: "object",
+			required: ["serverToken"],
+			properties: { serverToken: {
+				type: "string",
+				description: "Server token for the Postmark account."
+			} }
+		},
+		example: { serverToken: "server-***" }
+	},
+	healthCheck: {
+		method: "ping",
+		timeoutMs: 3e3
+	},
+	docsUrl: "https://postmarkapp.com/developer",
+	constraints: { rateLimit: { rpm: 500 } },
+	byokSetup: { setupInstructions: "Create a Postmark server token with outbound send permissions and configure allowed from addresses." }
+};
+
+//#endregion

package/dist/libs/contracts/dist/integrations/providers/powens.js

@@ -0,0 +1,116 @@
+import { StabilityEnum } from "../../ownership.js";
+
+//#region ../../libs/contracts/dist/integrations/providers/powens.js
+const powensIntegrationSpec = {
+	meta: {
+		key: "openbanking.powens",
+		version: 1,
+		category: "open-banking",
+		displayName: "Powens Open Banking",
+		title: "Powens Open Banking (Read)",
+		description: "Read-only Open Banking integration powered by Powens, exposing accounts, transactions, and balances.",
+		domain: "finance",
+		owners: ["platform.finance"],
+		tags: [
+			"open-banking",
+			"powens",
+			"finance"
+		],
+		stability: StabilityEnum.Experimental
+	},
+	supportedModes: ["byok"],
+	capabilities: { provides: [
+		{
+			key: "openbanking.accounts.read",
+			version: 1
+		},
+		{
+			key: "openbanking.transactions.read",
+			version: 1
+		},
+		{
+			key: "openbanking.balances.read",
+			version: 1
+		}
+	] },
+	configSchema: {
+		schema: {
+			type: "object",
+			required: ["environment"],
+			properties: {
+				environment: {
+					type: "string",
+					enum: ["sandbox", "production"],
+					description: "Powens environment to target. Sandbox uses Powens test API base URL, production uses live endpoints."
+				},
+				baseUrl: {
+					type: "string",
+					description: "Optional override for the Powens API base URL. Defaults to Powens environment defaults."
+				},
+				region: {
+					type: "string",
+					description: "Optional Powens region identifier when targeting a specific data residency cluster."
+				},
+				pollingIntervalMs: {
+					type: "number",
+					description: "Optional custom polling interval in milliseconds for background sync jobs (defaults to platform standard)."
+				}
+			}
+		},
+		example: {
+			environment: "sandbox",
+			baseUrl: "https://api-sandbox.powens.com/v2",
+			region: "eu-west-1",
+			pollingIntervalMs: 3e5
+		}
+	},
+	secretSchema: {
+		schema: {
+			type: "object",
+			required: ["clientId", "clientSecret"],
+			properties: {
+				clientId: {
+					type: "string",
+					description: "Powens OAuth client identifier obtained from the Powens Console (BYOK project)."
+				},
+				clientSecret: {
+					type: "string",
+					description: "Powens OAuth client secret used to exchange for access tokens."
+				},
+				apiKey: {
+					type: "string",
+					description: "Optional Powens API key (if the tenant project exposes a dedicated API token)."
+				},
+				webhookSecret: {
+					type: "string",
+					description: "Optional webhook signing secret used to verify Powens webhook payloads."
+				}
+			}
+		},
+		example: {
+			clientId: "powens-client-id",
+			clientSecret: "powens-client-secret",
+			apiKey: "powens-api-key",
+			webhookSecret: "powens-webhook-secret"
+		}
+	},
+	healthCheck: {
+		method: "ping",
+		timeoutMs: 8e3
+	},
+	docsUrl: "https://docs.powens.com/",
+	constraints: { rateLimit: {
+		rph: 1e4,
+		rpm: 600
+	} },
+	byokSetup: {
+		setupInstructions: "Create a Powens BYOK project, generate OAuth credentials, and optionally configure webhook delivery for account/transaction updates.",
+		requiredScopes: [
+			"accounts:read",
+			"transactions:read",
+			"balances:read"
+		]
+	}
+};
+
+//#endregion

package/dist/libs/contracts/dist/integrations/providers/qdrant.js

@@ -0,0 +1,73 @@
+import { StabilityEnum } from "../../ownership.js";
+
+//#region ../../libs/contracts/dist/integrations/providers/qdrant.js
+const qdrantIntegrationSpec = {
+	meta: {
+		key: "vectordb.qdrant",
+		version: 1,
+		category: "vector-db",
+		displayName: "Qdrant",
+		title: "Qdrant Vector Database",
+		description: "Qdrant integration for vector search and embeddings storage.",
+		domain: "ai",
+		owners: ["platform.ai"],
+		tags: ["vector-db", "search"],
+		stability: StabilityEnum.Experimental
+	},
+	supportedModes: ["managed", "byok"],
+	capabilities: {
+		provides: [{
+			key: "vector-db.search",
+			version: 1
+		}, {
+			key: "vector-db.storage",
+			version: 1
+		}],
+		requires: [{
+			key: "ai.embeddings",
+			optional: true,
+			reason: "Required if vectors are generated via hosted embedding services"
+		}]
+	},
+	configSchema: {
+		schema: {
+			type: "object",
+			properties: {
+				apiUrl: {
+					type: "string",
+					description: "Base URL for the Qdrant instance (e.g., https://qdrant.example.com)."
+				},
+				collectionPrefix: {
+					type: "string",
+					description: "Prefix applied to all collection names for this tenant."
+				}
+			}
+		},
+		example: {
+			apiUrl: "https://qdrant.example.com",
+			collectionPrefix: "tenant_"
+		}
+	},
+	secretSchema: {
+		schema: {
+			type: "object",
+			properties: { apiKey: {
+				type: "string",
+				description: "API key or token when authentication is enabled."
+			} }
+		},
+		example: { apiKey: "qdrant-api-key" }
+	},
+	healthCheck: {
+		method: "ping",
+		timeoutMs: 4e3
+	},
+	docsUrl: "https://qdrant.tech/documentation/quick-start/",
+	constraints: { quotas: {
+		collections: 100,
+		pointsPerCollection: 1e6
+	} },
+	byokSetup: { setupInstructions: "Provide the HTTPS endpoint of your Qdrant cluster and generate an API key with read/write access to the collections that will be managed." }
+};
+
+//#endregion

package/dist/libs/contracts/dist/integrations/providers/registry.js

@@ -0,0 +1,10 @@
+import "./stripe.js";
+import "./postmark.js";
+import "./qdrant.js";
+import "./mistral.js";
+import "./elevenlabs.js";
+import "./gmail.js";
+import "./google-calendar.js";
+import "./twilio-sms.js";
+import "./gcs-storage.js";
+import "./powens.js";

package/dist/libs/contracts/dist/integrations/providers/stripe.js

@@ -0,0 +1,83 @@
+import { StabilityEnum } from "../../ownership.js";
+
+//#region ../../libs/contracts/dist/integrations/providers/stripe.js
+const stripeIntegrationSpec = {
+	meta: {
+		key: "payments.stripe",
+		version: 1,
+		category: "payments",
+		displayName: "Stripe",
+		title: "Stripe Payments",
+		description: "Stripe integration for payment processing, charges, and payouts.",
+		domain: "payments",
+		owners: ["platform.payments"],
+		tags: ["payments", "psp"],
+		stability: StabilityEnum.Stable
+	},
+	supportedModes: ["managed", "byok"],
+	capabilities: {
+		provides: [{
+			key: "payments.psp",
+			version: 1
+		}],
+		requires: [{
+			key: "platform.webhooks",
+			optional: true,
+			reason: "Recommended for reliable event ingestion"
+		}]
+	},
+	configSchema: {
+		schema: {
+			type: "object",
+			properties: {
+				accountId: {
+					type: "string",
+					description: "Connected account ID when using Stripe Connect (BYOK)."
+				},
+				region: {
+					type: "string",
+					description: "Optional Stripe region or data residency hint."
+				}
+			}
+		},
+		example: {
+			accountId: "acct_123",
+			region: "us-east-1"
+		}
+	},
+	secretSchema: {
+		schema: {
+			type: "object",
+			required: ["apiKey", "webhookSecret"],
+			properties: {
+				apiKey: {
+					type: "string",
+					description: "Stripe secret API key (sk_live_... or sk_test_...)."
+				},
+				webhookSecret: {
+					type: "string",
+					description: "Signing secret for webhook verification."
+				}
+			}
+		},
+		example: {
+			apiKey: "sk_live_***",
+			webhookSecret: "whsec_***"
+		}
+	},
+	healthCheck: {
+		method: "ping",
+		timeoutMs: 5e3
+	},
+	docsUrl: "https://stripe.com/docs/api",
+	constraints: { rateLimit: {
+		rpm: 1e3,
+		rph: 2e4
+	} },
+	byokSetup: {
+		setupInstructions: "Create a restricted Stripe API key with write access to Charges and provide a webhook signing secret.",
+		requiredScopes: ["charges:write", "customers:read"]
+	}
+};
+
+//#endregion