@ossy/app 1.34.0 → 1.35.0

package/cli/build.task.js

@@ -18,10 +18,12 @@ import getPlatformFiles, {
   AGGREGATE_FILE_PATTERN,
   INTEGRATION_FILE_PATTERN,
   STARTUP_FILE_PATTERN,
+  EMAIL_FILE_PATTERN,
+  ACTION_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, INTEGRATION_FILE_PATTERN, STARTUP_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, EMAIL_FILE_PATTERN, ACTION_FILE_PATTERN }
 
 // Generated entry stubs live under `build/.ossy/entries/`. Putting them
 // inside `build/` means they're cleaned automatically with every build,
@@ -71,7 +73,7 @@ function entryNameFromSource (sourcePath, srcDir, packageName) {
 }
 
 function stubFileNameFor (kind, sourcePath, srcDir, packageName) {
-  const ext = (kind === 'page' || kind === 'component') ? '.entry.jsx' : '.entry.js'
+  const ext = (kind === 'page' || kind === 'component' || kind === 'email') ? '.entry.jsx' : '.entry.js'
   return entryNameFromSource(sourcePath, srcDir, packageName) + ext
 }
 
@@ -182,6 +184,29 @@ function generateStartupStub ({ stubAbs, sourceAbs }) {
   ].join('\n')
 }
 
+// Emails are React components. The stub re-exports `id`, `subject`, and the
+// default component export so the manifest plugin can validate them.
+function generateEmailStub ({ stubAbs, sourceAbs }) {
+  const importPath = relImport(stubAbs, sourceAbs)
+  return [
+    '// Generated by @ossy/app — do not edit',
+    `export { id, subject, default } from '${importPath}'`,
+    '',
+  ].join('\n')
+}
+
+// Actions are named command handlers. The stub re-exports `id`, `access`, and
+// `run` so the manifest plugin can validate them and the platform server can
+// invoke them at runtime.
+function generateActionStub ({ stubAbs, sourceAbs }) {
+  const importPath = relImport(stubAbs, sourceAbs)
+  return [
+    '// Generated by @ossy/app — do not edit',
+    `export { id, access, run } from '${importPath}'`,
+    '',
+  ].join('\n')
+}
+
 function stubFor (kind, args) {
   if (kind === 'page') return generatePageStub(args)
   if (kind === 'api') return generateApiStub(args)
@@ -190,6 +215,8 @@ function stubFor (kind, args) {
   if (kind === 'aggregate') return generateAggregateStub(args)
   if (kind === 'integration') return generateIntegrationStub(args)
   if (kind === 'startup') return generateStartupStub(args)
+  if (kind === 'email') return generateEmailStub(args)
+  if (kind === 'action') return generateActionStub(args)
   return generateTaskStub(args)
 }
 
@@ -234,6 +261,8 @@ export async function build (cliArgs = []) {
     ...platformFiles.aggregates,
     ...platformFiles.integrations,
     ...platformFiles.startups,
+    ...platformFiles.emails,
+    ...platformFiles.actions,
   ]
 
   const entriesByStub = new Map()

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

@@ -9,9 +9,11 @@ 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)$/
+export const EMAIL_FILE_PATTERN = /\.email\.(jsx?|tsx?)$/
+export const ACTION_FILE_PATTERN = /\.action\.(mjs|cjs|js)$/
 
 /**
- * @typedef {'page' | 'api' | 'task' | 'resource' | 'component' | 'aggregate' | 'integration' | 'startup'} EntryKind
+ * @typedef {'page' | 'api' | 'task' | 'resource' | 'component' | 'aggregate' | 'integration' | 'startup' | 'email' | 'action'} EntryKind
  *
  * @typedef {object} PlatformEntry
  * @property {EntryKind} kind          Which bucket this entry lives in.
@@ -28,6 +30,8 @@ export const STARTUP_FILE_PATTERN = /\.startup\.(mjs|cjs|js)$/
  * @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.
+ * @property {PlatformEntry[]} emails        Discovered `*.email.{jsx,tsx,...}` entries.
+ * @property {PlatformEntry[]} actions       Discovered `*.action.{js,mjs,cjs}` entries.
  */
 export function discoverFilesByPattern (srcDir, filePattern) {
   const dir = path.resolve(srcDir)
@@ -54,6 +58,8 @@ function classifyFile (absPath) {
   if (AGGREGATE_FILE_PATTERN.test(base)) return 'aggregate'
   if (INTEGRATION_FILE_PATTERN.test(base)) return 'integration'
   if (STARTUP_FILE_PATTERN.test(base)) return 'startup'
+  if (EMAIL_FILE_PATTERN.test(base)) return 'email'
+  if (ACTION_FILE_PATTERN.test(base)) return 'action'
   return null
 }
 
@@ -126,6 +132,8 @@ export function discoverInstalledPackageEntries (projectRoot) {
       ...discoverFilesByPattern(packageSrcDir, AGGREGATE_FILE_PATTERN),
       ...discoverFilesByPattern(packageSrcDir, INTEGRATION_FILE_PATTERN),
       ...discoverFilesByPattern(packageSrcDir, STARTUP_FILE_PATTERN),
+      ...discoverFilesByPattern(packageSrcDir, EMAIL_FILE_PATTERN),
+      ...discoverFilesByPattern(packageSrcDir, ACTION_FILE_PATTERN),
     ]
     for (const sourcePath of files) {
       const stat = fs.statSync(sourcePath)
@@ -169,8 +177,8 @@ export function discoverInstalledPackageEntries (projectRoot) {
  * @returns {Promise<PlatformFiles>}
  */
 export default async function getPlatformFiles (srcDir) {
-  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' }
+  const out = { pages: [], apis: [], tasks: [], resources: [], components: [], aggregates: [], integrations: [], startups: [], emails: [], actions: [] }
+  const bucketByKind = { page: 'pages', api: 'apis', task: 'tasks', resource: 'resources', component: 'components', aggregate: 'aggregates', integration: 'integrations', startup: 'startups', email: 'emails', action: 'actions' }
 
   // Aggregates are only discovered from installed packages — never from the
   // local `src/` — to avoid pulling in per-project duplicates of the same
@@ -183,6 +191,8 @@ export default async function getPlatformFiles (srcDir) {
     ...discoverFilesByPattern(srcDir, COMPONENT_FILE_PATTERN),
     ...discoverFilesByPattern(srcDir, INTEGRATION_FILE_PATTERN),
     ...discoverFilesByPattern(srcDir, STARTUP_FILE_PATTERN),
+    ...discoverFilesByPattern(srcDir, EMAIL_FILE_PATTERN),
+    ...discoverFilesByPattern(srcDir, ACTION_FILE_PATTERN),
   ]
   for (const sourcePath of localFiles) {
     const stat = fs.statSync(sourcePath)

package/cli/manifest-plugin.js

@@ -55,6 +55,15 @@ import { metadataIdFromFile, defaultPageRoute } from './get-platform-files.task.
  * @property {string} id     Unique startup slug (e.g. `'create-bot-user'`).
  * @property {string} entry  URL the platform serves the startup bundle from.
  *
+ * @typedef {object} EmailManifestEntry
+ * @property {string} id     Unique email id (e.g. `'authentication/verify-sign-in'`).
+ * @property {string} entry  URL the platform serves the email bundle from.
+ *
+ * @typedef {object} ActionManifestEntry
+ * @property {string} id      Unique action slug (e.g. `'authentication/request-sign-in'`).
+ * @property {string} entry   URL the platform serves the action bundle from.
+ * @property {string} access  Access level: `'public'` | `'authenticated'` | `'workspace'`.
+ *
  * @typedef {object} Manifest
  * @property {ManifestEntry[]} entries              Flat, ordered list of every routable thing.
  * @property {ComponentManifestEntry[]} components  Discovered `*.component.*` entries, keyed by id.
@@ -62,6 +71,8 @@ import { metadataIdFromFile, defaultPageRoute } from './get-platform-files.task.
  * @property {AggregateManifestEntry[]} aggregates  Discovered `*.aggregate.js` entries from installed packages.
  * @property {IntegrationManifestEntry[]} integrations  Discovered `*.integration.js` entries.
  * @property {StartupManifestEntry[]} startups      Discovered `*.startup.js` entries.
+ * @property {EmailManifestEntry[]} emails          Discovered `*.email.{jsx,tsx}` entries.
+ * @property {ActionManifestEntry[]} actions        Discovered `*.action.js` entries.
  * @property {object} config                        Inlined `src/config.js` default export.
  */
 
@@ -115,11 +126,17 @@ export function manifestPlugin ({ entriesByStub, srcDir, staticOutDir, configVal
       const integrations = []
       /** @type {StartupManifestEntry[]} */
       const startups = []
+      /** @type {EmailManifestEntry[]} */
+      const emails = []
+      /** @type {ActionManifestEntry[]} */
+      const actions = []
       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()
+      const seenEmailIds = new Set()
+      const seenActionIds = new Set()
 
       for (const fileName of Object.keys(bundle)) {
         const chunk = bundle[fileName]
@@ -197,6 +214,54 @@ export function manifestPlugin ({ entriesByStub, srcDir, staticOutDir, configVal
           continue
         }
 
+        // Emails are React components that render to HTML/text via EmailRenderer.
+        // The bundle exports `id` (a namespaced slug) and a default export
+        // (the component). They don't produce routable entries.
+        if (entryInfo.kind === 'email') {
+          const emailId = mod && mod.id
+          const component = mod && mod.default
+          if (typeof emailId !== 'string' || emailId.trim() === '') {
+            this.error(
+              `[@ossy/app][build] email entry ${entryInfo.sourcePath} must export a non-empty string "id"`,
+            )
+          }
+          if (typeof component !== 'function') {
+            this.error(
+              `[@ossy/app][build] email entry ${entryInfo.sourcePath} must default-export a component function`,
+            )
+          }
+          if (seenEmailIds.has(emailId)) {
+            this.error(`[@ossy/app][build] Duplicate email id "${emailId}"`)
+          }
+          seenEmailIds.add(emailId)
+          emails.push({ id: emailId, entry: url })
+          continue
+        }
+
+        // Actions are named, discoverable command handlers. The bundle exports
+        // `id` (a unique slug), `run` (the handler function), and optionally
+        // `access` ('public' | 'authenticated' | 'workspace', default 'authenticated').
+        if (entryInfo.kind === 'action') {
+          const actionId = mod && mod.id
+          if (typeof actionId !== 'string' || actionId.trim() === '') {
+            this.error(
+              `[@ossy/app][build] action entry ${entryInfo.sourcePath} must export a non-empty string "id"`,
+            )
+          }
+          if (typeof mod.run !== 'function') {
+            this.error(
+              `[@ossy/app][build] action entry ${entryInfo.sourcePath} must export a "run" function`,
+            )
+          }
+          if (seenActionIds.has(actionId)) {
+            this.error(`[@ossy/app][build] Duplicate action id "${actionId}"`)
+          }
+          const access = mod.access ?? 'authenticated'
+          seenActionIds.add(actionId)
+          actions.push({ id: actionId, entry: url, access })
+          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.
@@ -282,7 +347,7 @@ export function manifestPlugin ({ entriesByStub, srcDir, staticOutDir, configVal
       }
 
       /** @type {Manifest} */
-      const manifest = { entries, components, resourceTemplates, aggregates, integrations, startups, config: configValue || {} }
+      const manifest = { entries, components, resourceTemplates, aggregates, integrations, startups, emails, actions, 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.34.0",
+  "version": "1.35.0",
   "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.34.0",
+    "@ossy/design-system": "^1.35.0",
     "@ossy/pages": "^1.23.0",
-    "@ossy/platform": "^1.33.0",
-    "@ossy/router": "^1.34.0",
-    "@ossy/router-react": "^1.34.0",
-    "@ossy/sdk": "^1.34.0",
-    "@ossy/sdk-react": "^1.34.0",
-    "@ossy/themes": "^1.34.0",
+    "@ossy/platform": "^1.34.0",
+    "@ossy/router": "^1.35.0",
+    "@ossy/router-react": "^1.35.0",
+    "@ossy/sdk": "^1.35.0",
+    "@ossy/sdk-react": "^1.35.0",
+    "@ossy/themes": "^1.35.0",
     "@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": "46cdd391ec01ea9210543ee7b14661f77079a7e7"
+  "gitHead": "c6697078268867d88553ca0bac08faad5cea1546"
 }