@wix/origami-site 0.1.14 → 0.1.16

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/origami-site",
-  "version": "0.1.14",
+  "version": "0.1.16",
   "description": "Runs an exported Wix origami site: file-based routing, Wix dynamic pages, popups and build checks. Use with @wix/origami-site-astro or @wix/origami-site-express.",
   "type": "module",
   "files": [
@@ -91,5 +91,5 @@
       "optional": true
     }
   },
-  "falconPackageHash": "868bb5e4b9ca878b90a0f7ef207610a252e0cfb8eba4e563dc2ea3d5"
+  "falconPackageHash": "98246cb0560035c80b813a0c4d4937ea7d4530365e6eab3d5f7226a4"
 }

package/src/server/index.d.ts

@@ -8,7 +8,7 @@ export type SiteOptions = {
   root: string                       // the site package folder
   mode: 'dev' | 'prod'
   table?: SiteRouteTable                 // prod: the table from the build. dev: omitted, the core scans.
-  wix: { clientId: string; siteId: string }   // from VITE_WIX_CLIENT_ID / VITE_WIX_SITE_ID
+  wix: { clientId: string; siteId: string }   // from VITE_WIX_CLIENT_ID / VITE_WIX_METASITE_ID
   tokens?: TokenProvider             // default: rejects until router support (stage 2)
   access?: AccessSource              // default: noAccessRules (4)
   accessHandlers?: AccessHandler[]   // default: []
@@ -80,3 +80,7 @@ export function getAccessToken(): Promise<string>
 export function serializePageData(data: PageData): string
 /** The core's plain HTML error page: logs the stack, shows the message in dev only, `cache-control: no-store`. */
 export function errorResponse(error: unknown, options: { status?: 500 | 503; mode: 'dev' | 'prod'; logger?: Logger }): Response
+/** `yarn build`: writes `<serverOutDir>/origami-routes.json`, atomically. */
+export function writeBuiltTable(serverOutDir: string, table: SiteRouteTable): Promise<void>
+/** `yarn start`: reads it back; throws on a missing file, an unknown format or another core major. */
+export function readBuiltTable(serverOutDir: string): Promise<SiteRouteTable>

package/src/server/index.js

@@ -1,4 +1,5 @@
 export { readSiteTree } from './site-tree/readSiteTree.js'
+export { writeBuiltTable, readBuiltTable } from './site-tree/builtTable.js'
 export { SiteTreeError } from './requests/errors.js'
 export { createSite, noAccessRules } from './requests/createSite.js'
 export { runInRequestContext, getRequestContext, getAccessToken } from './requests/context.js'

package/src/server/site-tree/builtTable.js

@@ -0,0 +1,36 @@
+import { mkdir, readFile, rename, writeFile } from 'node:fs/promises'
+import { join } from 'node:path'
+
+const FILE = 'origami-routes.json'
+const FORMAT = 1
+const corePackage = JSON.parse(await readFile(new URL('../../../package.json', import.meta.url), 'utf8'))
+const breakingPart = version => {
+    const [first, second] = String(version).split('.')
+    return first === '0' ? `0.${second}` : first
+}
+
+/** Writes the route table `yarn build` used, beside (never inside) the public client folder.
+ * @param {string} serverOutDir @param {import('@wix/origami-types').SiteRouteTable} table */
+export async function writeBuiltTable(serverOutDir, table) {
+    await mkdir(serverOutDir, { recursive: true })
+    const path = join(serverOutDir, FILE)
+    // Temp file plus rename: a crashed build never leaves half a table.
+    const temporary = `${path}.${process.pid}.tmp`
+    await writeFile(temporary, `${JSON.stringify({ format: FORMAT, core: corePackage.version, table }, null, 2)}\n`)
+    await rename(temporary, path)
+}
+
+/** @param {string} serverOutDir @returns {Promise<import('@wix/origami-types').SiteRouteTable>} */
+export async function readBuiltTable(serverOutDir) {
+    const path = join(serverOutDir, FILE)
+    let file
+    try { file = JSON.parse(await readFile(path, 'utf8')) } catch (error) {
+        if (/** @type {NodeJS.ErrnoException} */ (error).code === 'ENOENT') throw new Error(`No route table at ${path}: run yarn build first.`)
+        throw new Error(`The route table at ${path} is not valid JSON: run yarn build again.`, { cause: error })
+    }
+    if (file?.format !== FORMAT || file.table?.version !== 2) throw new Error(`The route table at ${path} has an unknown format: run yarn build again.`)
+    // While 0.x, a minor is breaking, as ^ ranges treat it.
+    if (breakingPart(file.core) !== breakingPart(corePackage.version))
+        throw new Error(`The route table at ${path} was built by @wix/origami-site ${file.core}, this is ${corePackage.version}: rebuild after upgrading.`)
+    return file.table
+}

package/src/types/index.d.ts

@@ -1,4 +1,4 @@
-/** What each adapter package exports as its default `origami` descriptor. */
+/** What each adapter package exports as the default export of its `./adapter` entry. */
 export interface OrigamiAdapter {
   name: string                                   // '@wix/origami-site-astro'
   version: string                                // its package version
@@ -12,11 +12,11 @@ export interface OrigamiAdapter {
 export type ProjectContext = {
   siteName: string
   coreVersion: string                            // the @wix/origami-site range to depend on
-  nodeVersion: string                            // '22'
+  nodeVersion: string                            // '24'
 }
 
 export type ProjectFiles = {
-  files: Record<string /* path relative to the site package */, string /* contents */>   // e.g. astro.config.mjs, Dockerfile
+  files: Record<string /* path relative to the site package */, string /* contents */>   // e.g. astro.config.mjs
   packageJson: {
     scripts: { dev: string; build: string; start: string } & Record<string, string>
     dependencies: Record<string, string>
@@ -35,7 +35,7 @@ export interface ConformanceDriver {
   start(root: string, env: SiteEnv): Promise<RunningSite>
 }
 
-export type SiteEnv = Record<string, string>     // VITE_WIX_CLIENT_ID, VITE_WIX_SITE_ID, ORIGAMI_WIX_API_BASE (tests), PORT
+export type SiteEnv = Record<string, string>     // VITE_WIX_CLIENT_ID, VITE_WIX_METASITE_ID, ORIGAMI_WIX_API_BASE (tests), PORT
 export type RunningSite = { url: URL; logs(): string; restarts(): number; stop(): Promise<void> }
 export type BuildResult = { ok: true; output: string } | { ok: false; output: string }