@ossy/app 1.32.2 → 1.32.3

package/cli/build.task.js

@@ -16,10 +16,12 @@ import getPlatformFiles, {
   RESOURCE_FILE_PATTERN,
   COMPONENT_FILE_PATTERN,
   AGGREGATE_FILE_PATTERN,
+  INTEGRATION_FILE_PATTERN,
+  STARTUP_FILE_PATTERN,
 } from './get-platform-files.task.js'
 import { manifestPlugin } from './manifest-plugin.js'
 
-export { PAGE_FILE_PATTERN, API_FILE_PATTERN, TASK_FILE_PATTERN, RESOURCE_FILE_PATTERN, COMPONENT_FILE_PATTERN, AGGREGATE_FILE_PATTERN }
+export { PAGE_FILE_PATTERN, API_FILE_PATTERN, TASK_FILE_PATTERN, RESOURCE_FILE_PATTERN, COMPONENT_FILE_PATTERN, AGGREGATE_FILE_PATTERN, INTEGRATION_FILE_PATTERN, STARTUP_FILE_PATTERN }
 
 // Generated entry stubs live under `build/.ossy/entries/`. Putting them
 // inside `build/` means they're cleaned automatically with every build,
@@ -156,12 +158,38 @@ function generateAggregateStub ({ stubAbs, sourceAbs }) {
   ].join('\n')
 }
 
+// Integrations are server-side only. The stub re-exports `id`, `credentials`,
+// and `connect` so the manifest plugin can validate them and the platform
+// server can call `connect({ env })` at startup.
+function generateIntegrationStub ({ stubAbs, sourceAbs }) {
+  const importPath = relImport(stubAbs, sourceAbs)
+  return [
+    '// Generated by @ossy/app — do not edit',
+    `export * from '${importPath}'`,
+    '',
+  ].join('\n')
+}
+
+// Startups are server-side one-shot hooks. The stub re-exports `id` and `run`
+// so the manifest plugin can validate them and the platform server can call
+// `run({ env })` at boot time.
+function generateStartupStub ({ stubAbs, sourceAbs }) {
+  const importPath = relImport(stubAbs, sourceAbs)
+  return [
+    '// Generated by @ossy/app — do not edit',
+    `export * from '${importPath}'`,
+    '',
+  ].join('\n')
+}
+
 function stubFor (kind, args) {
   if (kind === 'page') return generatePageStub(args)
   if (kind === 'api') return generateApiStub(args)
   if (kind === 'resource') return generateResourceStub(args)
   if (kind === 'component') return generateComponentStub(args)
   if (kind === 'aggregate') return generateAggregateStub(args)
+  if (kind === 'integration') return generateIntegrationStub(args)
+  if (kind === 'startup') return generateStartupStub(args)
   return generateTaskStub(args)
 }
 
@@ -204,6 +232,8 @@ export async function build (cliArgs = []) {
     ...platformFiles.resources,
     ...platformFiles.components,
     ...platformFiles.aggregates,
+    ...platformFiles.integrations,
+    ...platformFiles.startups,
   ]
 
   const entriesByStub = new Map()

package/cli/get-platform-files.task.js

@@ -7,9 +7,11 @@ export const TASK_FILE_PATTERN = /\.task\.(mjs|cjs|js)$/
 export const RESOURCE_FILE_PATTERN = /\.resource\.(mjs|cjs|js)$/
 export const COMPONENT_FILE_PATTERN = /\.component\.(jsx?|tsx?)$/
 export const AGGREGATE_FILE_PATTERN = /\.aggregate\.(mjs|cjs|js)$/
+export const INTEGRATION_FILE_PATTERN = /\.integration\.(mjs|cjs|js)$/
+export const STARTUP_FILE_PATTERN = /\.startup\.(mjs|cjs|js)$/
 
 /**
- * @typedef {'page' | 'api' | 'task' | 'resource' | 'component' | 'aggregate'} EntryKind
+ * @typedef {'page' | 'api' | 'task' | 'resource' | 'component' | 'aggregate' | 'integration' | 'startup'} EntryKind
  *
  * @typedef {object} PlatformEntry
  * @property {EntryKind} kind          Which bucket this entry lives in.
@@ -18,12 +20,14 @@ export const AGGREGATE_FILE_PATTERN = /\.aggregate\.(mjs|cjs|js)$/
  * @property {string} [packageSrcDir]  Absolute path to the package's `src/` dir, set only for installed-package entries.
  *
  * @typedef {object} PlatformFiles
- * @property {PlatformEntry[]} pages       Discovered `*.page.{jsx,tsx,...}` entries.
- * @property {PlatformEntry[]} apis        Discovered `*.api.{js,mjs,cjs}` entries.
- * @property {PlatformEntry[]} tasks       Discovered `*.task.{js,mjs,cjs}` entries.
- * @property {PlatformEntry[]} resources   Discovered `*.resource.{js,mjs,cjs}` entries.
- * @property {PlatformEntry[]} components  Discovered `*.component.{jsx,tsx,...}` entries.
- * @property {PlatformEntry[]} aggregates  Discovered `*.aggregate.{js,mjs,cjs}` entries (installed packages only).
+ * @property {PlatformEntry[]} pages         Discovered `*.page.{jsx,tsx,...}` entries.
+ * @property {PlatformEntry[]} apis          Discovered `*.api.{js,mjs,cjs}` entries.
+ * @property {PlatformEntry[]} tasks         Discovered `*.task.{js,mjs,cjs}` entries.
+ * @property {PlatformEntry[]} resources     Discovered `*.resource.{js,mjs,cjs}` entries.
+ * @property {PlatformEntry[]} components    Discovered `*.component.{jsx,tsx,...}` entries.
+ * @property {PlatformEntry[]} aggregates    Discovered `*.aggregate.{js,mjs,cjs}` entries (installed packages only).
+ * @property {PlatformEntry[]} integrations  Discovered `*.integration.{js,mjs,cjs}` entries.
+ * @property {PlatformEntry[]} startups      Discovered `*.startup.{js,mjs,cjs}` entries.
  */
 export function discoverFilesByPattern (srcDir, filePattern) {
   const dir = path.resolve(srcDir)
@@ -48,6 +52,8 @@ function classifyFile (absPath) {
   if (RESOURCE_FILE_PATTERN.test(base)) return 'resource'
   if (COMPONENT_FILE_PATTERN.test(base)) return 'component'
   if (AGGREGATE_FILE_PATTERN.test(base)) return 'aggregate'
+  if (INTEGRATION_FILE_PATTERN.test(base)) return 'integration'
+  if (STARTUP_FILE_PATTERN.test(base)) return 'startup'
   return null
 }
 
@@ -118,6 +124,8 @@ export function discoverInstalledPackageEntries (projectRoot) {
       ...discoverFilesByPattern(packageSrcDir, RESOURCE_FILE_PATTERN),
       ...discoverFilesByPattern(packageSrcDir, COMPONENT_FILE_PATTERN),
       ...discoverFilesByPattern(packageSrcDir, AGGREGATE_FILE_PATTERN),
+      ...discoverFilesByPattern(packageSrcDir, INTEGRATION_FILE_PATTERN),
+      ...discoverFilesByPattern(packageSrcDir, STARTUP_FILE_PATTERN),
     ]
     for (const sourcePath of files) {
       const stat = fs.statSync(sourcePath)
@@ -161,8 +169,8 @@ export function discoverInstalledPackageEntries (projectRoot) {
  * @returns {Promise<PlatformFiles>}
  */
 export default async function getPlatformFiles (srcDir) {
-  const out = { pages: [], apis: [], tasks: [], resources: [], components: [], aggregates: [] }
-  const bucketByKind = { page: 'pages', api: 'apis', task: 'tasks', resource: 'resources', component: 'components', aggregate: 'aggregates' }
+  const out = { pages: [], apis: [], tasks: [], resources: [], components: [], aggregates: [], integrations: [], startups: [] }
+  const bucketByKind = { page: 'pages', api: 'apis', task: 'tasks', resource: 'resources', component: 'components', aggregate: 'aggregates', integration: 'integrations', startup: 'startups' }
 
   // Aggregates are only discovered from installed packages — never from the
   // local `src/` — to avoid pulling in per-project duplicates of the same
@@ -173,6 +181,8 @@ export default async function getPlatformFiles (srcDir) {
     ...discoverFilesByPattern(srcDir, TASK_FILE_PATTERN),
     ...discoverFilesByPattern(srcDir, RESOURCE_FILE_PATTERN),
     ...discoverFilesByPattern(srcDir, COMPONENT_FILE_PATTERN),
+    ...discoverFilesByPattern(srcDir, INTEGRATION_FILE_PATTERN),
+    ...discoverFilesByPattern(srcDir, STARTUP_FILE_PATTERN),
   ]
   for (const sourcePath of localFiles) {
     const stat = fs.statSync(sourcePath)

package/cli/manifest-plugin.js

@@ -46,12 +46,23 @@ import { metadataIdFromFile, defaultPageRoute } from './get-platform-files.task.
  * @property {string} id     AggregateType string (e.g. `'User'`).
  * @property {string} entry  URL the platform serves the aggregate bundle from.
  *
+ * @typedef {object} IntegrationManifestEntry
+ * @property {string} id              Unique integration slug (e.g. `'email'`).
+ * @property {string} entry           URL the platform serves the integration bundle from.
+ * @property {string[]} credentials   Env var names required by the integration.
+ *
+ * @typedef {object} StartupManifestEntry
+ * @property {string} id     Unique startup slug (e.g. `'create-bot-user'`).
+ * @property {string} entry  URL the platform serves the startup bundle from.
+ *
  * @typedef {object} Manifest
- * @property {ManifestEntry[]} entries          Flat, ordered list of every routable thing.
+ * @property {ManifestEntry[]} entries              Flat, ordered list of every routable thing.
  * @property {ComponentManifestEntry[]} components  Discovered `*.component.*` entries, keyed by id.
- * @property {object[]} resourceTemplates       Each `*.resource.js` file's default-exported template object.
+ * @property {object[]} resourceTemplates           Each `*.resource.js` file's default-exported template object.
  * @property {AggregateManifestEntry[]} aggregates  Discovered `*.aggregate.js` entries from installed packages.
- * @property {object} config                    Inlined `src/config.js` default export.
+ * @property {IntegrationManifestEntry[]} integrations  Discovered `*.integration.js` entries.
+ * @property {StartupManifestEntry[]} startups      Discovered `*.startup.js` entries.
+ * @property {object} config                        Inlined `src/config.js` default export.
  */
 
 /**
@@ -100,9 +111,15 @@ export function manifestPlugin ({ entriesByStub, srcDir, staticOutDir, configVal
       const components = []
       /** @type {AggregateManifestEntry[]} */
       const aggregates = []
+      /** @type {IntegrationManifestEntry[]} */
+      const integrations = []
+      /** @type {StartupManifestEntry[]} */
+      const startups = []
       const seenIds = { page: new Set(), api: new Set(), task: new Set(), component: new Set() }
       const seenResourceIds = new Set()
       const seenAggregateIds = new Set()
+      const seenIntegrationIds = new Set()
+      const seenStartupIds = new Set()
 
       for (const fileName of Object.keys(bundle)) {
         const chunk = bundle[fileName]
@@ -128,6 +145,58 @@ export function manifestPlugin ({ entriesByStub, srcDir, staticOutDir, configVal
           )
         }
 
+        // Integrations provide third-party clients. The bundle exports `id`,
+        // `credentials` (env var names), and `connect({ env })`. They don't
+        // produce routable entries; they accumulate into a separate array.
+        if (entryInfo.kind === 'integration') {
+          const integrationId = mod && mod.id
+          const credentials = mod && mod.credentials
+          if (typeof integrationId !== 'string' || integrationId.trim() === '') {
+            this.error(
+              `[@ossy/app][build] integration entry ${entryInfo.sourcePath} must export a non-empty string "id"`,
+            )
+          }
+          if (!Array.isArray(credentials)) {
+            this.error(
+              `[@ossy/app][build] integration entry ${entryInfo.sourcePath} must export a "credentials" array`,
+            )
+          }
+          if (typeof mod.connect !== 'function') {
+            this.error(
+              `[@ossy/app][build] integration entry ${entryInfo.sourcePath} must export a "connect" function`,
+            )
+          }
+          if (seenIntegrationIds.has(integrationId)) {
+            this.error(`[@ossy/app][build] Duplicate integration id "${integrationId}"`)
+          }
+          seenIntegrationIds.add(integrationId)
+          integrations.push({ id: integrationId, entry: url, credentials })
+          continue
+        }
+
+        // Startups are server-side one-shot hooks. The bundle exports `id`
+        // (a unique slug) and `run({ env })`. They don't produce routable
+        // entries; they accumulate into a separate `startups` array.
+        if (entryInfo.kind === 'startup') {
+          const startupId = mod && mod.id
+          if (typeof startupId !== 'string' || startupId.trim() === '') {
+            this.error(
+              `[@ossy/app][build] startup entry ${entryInfo.sourcePath} must export a non-empty string "id"`,
+            )
+          }
+          if (typeof mod.run !== 'function') {
+            this.error(
+              `[@ossy/app][build] startup entry ${entryInfo.sourcePath} must export a "run" function`,
+            )
+          }
+          if (seenStartupIds.has(startupId)) {
+            this.error(`[@ossy/app][build] Duplicate startup id "${startupId}"`)
+          }
+          seenStartupIds.add(startupId)
+          startups.push({ id: startupId, entry: url })
+          continue
+        }
+
         // Aggregates are server-side classes — the bundle exports `Aggregate`
         // (the class) and `id` (the AggregateType string). They don't produce
         // routable entries; they accumulate into a separate `aggregates` array.
@@ -213,7 +282,7 @@ export function manifestPlugin ({ entriesByStub, srcDir, staticOutDir, configVal
       }
 
       /** @type {Manifest} */
-      const manifest = { entries, components, resourceTemplates, aggregates, config: configValue || {} }
+      const manifest = { entries, components, resourceTemplates, aggregates, integrations, startups, config: configValue || {} }
       fs.mkdirSync(path.dirname(manifestPath), { recursive: true })
       fs.writeFileSync(manifestPath, JSON.stringify(manifest, null, 2), 'utf8')
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ossy/app",
-  "version": "1.32.2",
+  "version": "1.32.3",
   "description": "",
   "source": "./src/index.js",
   "main": "./src/index.js",
@@ -38,14 +38,14 @@
     "@babel/eslint-parser": "^7.15.8",
     "@babel/preset-react": "^7.26.3",
     "@babel/register": "^7.25.9",
-    "@ossy/design-system": "^1.32.2",
+    "@ossy/design-system": "^1.32.3",
     "@ossy/pages": "^1.23.0",
-    "@ossy/platform": "^1.31.2",
-    "@ossy/router": "^1.32.2",
-    "@ossy/router-react": "^1.32.2",
-    "@ossy/sdk": "^1.32.2",
-    "@ossy/sdk-react": "^1.32.2",
-    "@ossy/themes": "^1.32.2",
+    "@ossy/platform": "^1.31.3",
+    "@ossy/router": "^1.32.3",
+    "@ossy/router-react": "^1.32.3",
+    "@ossy/sdk": "^1.32.3",
+    "@ossy/sdk-react": "^1.32.3",
+    "@ossy/themes": "^1.32.3",
     "@rollup/plugin-alias": "^6.0.0",
     "@rollup/plugin-babel": "^7.0.0",
     "@rollup/plugin-commonjs": "^29.0.0",
@@ -79,5 +79,5 @@
     "README.md",
     "tsconfig.json"
   ],
-  "gitHead": "5c17e379298f7027f1dbdcf064a4aff69d1497d5"
+  "gitHead": "b8cbdc545a659e96af8948aa08a89316a2c2d193"
 }