@ossy/app 1.16.5 → 1.16.7

package/cli/build.task.js

@@ -13,10 +13,11 @@ import getPlatformFiles, {
   PAGE_FILE_PATTERN,
   API_FILE_PATTERN,
   TASK_FILE_PATTERN,
+  RESOURCE_FILE_PATTERN,
 } from './get-platform-files.task.js'
 import { manifestPlugin } from './manifest-plugin.js'
 
-export { PAGE_FILE_PATTERN, API_FILE_PATTERN, TASK_FILE_PATTERN }
+export { PAGE_FILE_PATTERN, API_FILE_PATTERN, TASK_FILE_PATTERN, RESOURCE_FILE_PATTERN }
 
 // Generated entry stubs live under `build/.ossy/entries/`. Putting them
 // inside `build/` means they're cleaned automatically with every build,
@@ -113,9 +114,22 @@ function generateTaskStub ({ stubAbs, sourceAbs }) {
   ].join('\n')
 }
 
+// Resources are pure data (POJOs default-exported from `*.resource.js`).
+// The stub only pass-through re-exports the default so the manifest plugin
+// can read it via the same `await import(chunkUrl)` path as the other kinds.
+function generateResourceStub ({ stubAbs, sourceAbs }) {
+  const importPath = relImport(stubAbs, sourceAbs)
+  return [
+    '// Generated by @ossy/app — do not edit',
+    `export { default } 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)
   return generateTaskStub(args)
 }
 
@@ -151,7 +165,12 @@ export async function build (cliArgs = []) {
   ensureDir(stubDir)
 
   const platformFiles = await getPlatformFiles(srcDir)
-  const allEntries = [...platformFiles.pages, ...platformFiles.apis, ...platformFiles.tasks]
+  const allEntries = [
+    ...platformFiles.pages,
+    ...platformFiles.apis,
+    ...platformFiles.tasks,
+    ...platformFiles.resources,
+  ]
 
   const entriesByStub = new Map()
   const stubInputMap = {}

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

@@ -4,21 +4,22 @@ import path from 'node:path'
 export const PAGE_FILE_PATTERN = /\.page\.(jsx?|tsx?)$/
 export const API_FILE_PATTERN = /\.api\.(mjs|cjs|js)$/
 export const TASK_FILE_PATTERN = /\.task\.(mjs|cjs|js)$/
+export const RESOURCE_FILE_PATTERN = /\.resource\.(mjs|cjs|js)$/
 
 /**
- * @typedef {'page' | 'api' | 'task'} EntryKind
+ * @typedef {'page' | 'api' | 'task' | 'resource'} EntryKind
  *
  * @typedef {object} PlatformEntry
  * @property {EntryKind} kind     Which bucket this entry lives in.
  * @property {string} sourcePath  Absolute path to the user-authored source file.
  *
  * @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[]} 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.
  */
-
-function discoverFilesByPattern (srcDir, filePattern) {
+export function discoverFilesByPattern (srcDir, filePattern) {
   const dir = path.resolve(srcDir)
   if (!fs.existsSync(dir) || !fs.statSync(dir).isDirectory()) return []
   const files = []
@@ -38,6 +39,7 @@ function classifyFile (absPath) {
   if (PAGE_FILE_PATTERN.test(base)) return 'page'
   if (API_FILE_PATTERN.test(base)) return 'api'
   if (TASK_FILE_PATTERN.test(base)) return 'task'
+  if (RESOURCE_FILE_PATTERN.test(base)) return 'resource'
   return null
 }
 
@@ -66,6 +68,14 @@ export function defaultPageRoute (id) {
   return id === 'home' ? '/' : '/' + id
 }
 
+/**
+ * @returns {{ id: string, path: string }}
+ */
+export function filePathToRoute (absPath, srcDir) {
+  const id = metadataIdFromFile(absPath, srcDir)
+  return { id, path: defaultPageRoute(id) }
+}
+
 /**
  * Walks `srcDir` and returns the user-authored entries the platform cares
  * about, bucketed by kind. Empty (zero-byte) source files are skipped — we
@@ -79,21 +89,20 @@ export function defaultPageRoute (id) {
  * @returns {Promise<PlatformFiles>}
  */
 export default async function getPlatformFiles (srcDir) {
-  const out = { pages: [], apis: [], tasks: [] }
+  const out = { pages: [], apis: [], tasks: [], resources: [] }
   const all = [
     ...discoverFilesByPattern(srcDir, PAGE_FILE_PATTERN),
     ...discoverFilesByPattern(srcDir, API_FILE_PATTERN),
     ...discoverFilesByPattern(srcDir, TASK_FILE_PATTERN),
+    ...discoverFilesByPattern(srcDir, RESOURCE_FILE_PATTERN),
   ]
+  const bucketByKind = { page: 'pages', api: 'apis', task: 'tasks', resource: 'resources' }
   for (const sourcePath of all) {
     const stat = fs.statSync(sourcePath)
     if (!stat.isFile() || stat.size === 0) continue
     const kind = classifyFile(sourcePath)
     if (!kind) continue
-    out[kind === 'page' ? 'pages' : kind === 'api' ? 'apis' : 'tasks'].push({
-      kind,
-      sourcePath,
-    })
+    out[bucketByKind[kind]].push({ kind, sourcePath })
   }
   return out
 }

package/cli/manifest-plugin.js

@@ -39,8 +39,9 @@ import { metadataIdFromFile, defaultPageRoute } from './get-platform-files.task.
  *                                        (e.g. `/static/home.page-7f2a.js`).
  *
  * @typedef {object} Manifest
- * @property {ManifestEntry[]} entries    Flat, ordered list of every routable thing.
- * @property {object} config              Inlined `src/config.js` default export.
+ * @property {ManifestEntry[]} entries          Flat, ordered list of every routable thing.
+ * @property {object[]} resourceTemplates       Each `*.resource.js` file's default-exported template object.
+ * @property {object} config                    Inlined `src/config.js` default export.
  */
 
 /**
@@ -83,7 +84,10 @@ export function manifestPlugin ({ entriesByStub, srcDir, staticOutDir, configVal
     async writeBundle (_, bundle) {
       /** @type {ManifestEntry[]} */
       const entries = []
+      /** @type {object[]} */
+      const resourceTemplates = []
       const seenIds = { page: new Set(), api: new Set(), task: new Set() }
+      const seenResourceIds = new Set()
 
       for (const fileName of Object.keys(bundle)) {
         const chunk = bundle[fileName]
@@ -109,6 +113,30 @@ export function manifestPlugin ({ entriesByStub, srcDir, staticOutDir, configVal
           )
         }
 
+        // Resources are pure data — the default export *is* the template.
+        // They don't use `metadata`, don't need a derived id, and don't
+        // produce a routable manifest entry; they accumulate into a separate
+        // `resourceTemplates` array on the manifest.
+        if (entryInfo.kind === 'resource') {
+          const template = mod && mod.default
+          if (!template || typeof template !== 'object' || Array.isArray(template)) {
+            this.error(
+              `[@ossy/app][build] resource entry ${entryInfo.sourcePath} must default-export an object`,
+            )
+          }
+          if (typeof template.id !== 'string' || template.id.trim() === '') {
+            this.error(
+              `[@ossy/app][build] resource entry ${entryInfo.sourcePath} default export is missing a non-empty string "id"`,
+            )
+          }
+          if (seenResourceIds.has(template.id)) {
+            this.error(`[@ossy/app][build] Duplicate resource template id "${template.id}"`)
+          }
+          seenResourceIds.add(template.id)
+          resourceTemplates.push(template)
+          continue
+        }
+
         const rawMeta = (mod && mod.metadata) || {}
         const id = rawMeta.id || metadataIdFromFile(entryInfo.sourcePath, srcDir)
         if (!id) {
@@ -141,7 +169,7 @@ export function manifestPlugin ({ entriesByStub, srcDir, staticOutDir, configVal
       }
 
       /** @type {Manifest} */
-      const manifest = { entries, config: configValue || {} }
+      const manifest = { entries, resourceTemplates, 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.16.5",
+  "version": "1.16.7",
   "description": "",
   "source": "./src/index.js",
   "main": "./src/index.js",
@@ -16,7 +16,7 @@
   },
   "scripts": {
     "build": "echo Building not required",
-    "test": "node --experimental-vm-modules ../node_modules/jest/bin/jest.js --verbose",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
     "typecheck": "tsc --noEmit"
   },
   "keywords": [],
@@ -33,15 +33,15 @@
     "@babel/eslint-parser": "^7.15.8",
     "@babel/preset-react": "^7.26.3",
     "@babel/register": "^7.25.9",
-    "@ossy/connected-components": "^1.16.5",
-    "@ossy/design-system": "^1.16.5",
-    "@ossy/pages": "^1.16.5",
-    "@ossy/platform": "^1.15.5",
-    "@ossy/router": "^1.16.5",
-    "@ossy/router-react": "^1.16.5",
-    "@ossy/sdk": "^1.16.5",
-    "@ossy/sdk-react": "^1.16.5",
-    "@ossy/themes": "^1.16.5",
+    "@ossy/connected-components": "^1.16.7",
+    "@ossy/design-system": "^1.16.7",
+    "@ossy/pages": "^1.16.7",
+    "@ossy/platform": "^1.15.7",
+    "@ossy/router": "^1.16.7",
+    "@ossy/router-react": "^1.16.7",
+    "@ossy/sdk": "^1.16.7",
+    "@ossy/sdk-react": "^1.16.7",
+    "@ossy/themes": "^1.16.7",
     "@rollup/plugin-alias": "^6.0.0",
     "@rollup/plugin-babel": "6.1.0",
     "@rollup/plugin-commonjs": "^29.0.0",
@@ -75,5 +75,5 @@
     "README.md",
     "tsconfig.json"
   ],
-  "gitHead": "da7427b2b46b9069ff9a1a05751e275eb11ddc50"
+  "gitHead": "ca79da159a5d017ea80dfddbb7218b1a51aab396"
 }

package/src/index.js

@@ -3,4 +3,5 @@ export {
   PAGE_FILE_PATTERN,
   API_FILE_PATTERN,
   TASK_FILE_PATTERN,
+  RESOURCE_FILE_PATTERN,
 } from '../cli/build.task.js'