@suiteop/storefront 0.5.0 → 0.6.0

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 Hand-written per release. Tag `storefront-sdk@<version>` on `main` publishes it.
 
+## 0.6.0
+
+- `suiteop({ routes })` takes two more sitemap sources: `guides` (one URL per guide the site shows,
+  e.g. `'/things-to-do/[id]': 'guides'`) and `page`, a server-rendered route without a parameter
+  listed as one page (`'/': 'page'`, `'/blog': 'page'`). A `page` route with a parameter is
+  refused at config time. An older platform skips both sources; the rest of the sitemap is
+  unchanged.
+- `listings.list({ checkIn, checkOut })`: only listings whose synced calendar can take that stay
+  (listing-local `YYYY-MM-DD`, checkout exclusive; both or neither, with the stay rules of
+  `availability.get`) — every night available, the check-in day open to arrival and its minimum
+  stay met, the checkout day open to departure. `total`, paging and `facets` count only those
+  listings. Display only, as `buildings.availability`: `quotes.create` re-checks live. An older API
+  ignores both and answers every listing.
+
 ## 0.5.0
 
 - The site config takes optional `layout` (`listings`, the default, `locations`, `areas` or

package/README.md

@@ -232,8 +232,10 @@ set from `colors.primary` — the `--so-*` colours, type scale, radii and button
 
 `suiteop()` writes `/_suiteop/manifest.json` after every build: the prerendered pages (path,
 language, title, last change — pages marked `noindex` are left out) and the on-demand routes that
-expand from catalogue data (`/listing/[id]`, `/building/[id]`). `/_suiteop/*` is reserved for the
-platform; do not add pages under it.
+expand from catalogue data (`/listing/[id]`, `/building/[id]`). Declare the others in
+`suiteop({ routes })`: `'/things-to-do/[id]': 'guides'` for the guides the site shows, and
+`'page'` for a server-rendered page without a parameter (`'/': 'page'`, `'/blog': 'page'`), which
+the sitemap then lists once. `/_suiteop/*` is reserved for the platform; do not add pages under it.
 
 On SuiteOp hosting, `getSiteContext(Astro.locals)` (`@suiteop/storefront/astro`) returns the
 per-request site props the edge passes (publishable key, API bases; null elsewhere). The checkout

package/dist/astro-content-model.cjs

@@ -1,7 +1,7 @@
 'use strict';
 
-var chunkNNWJZUQL_cjs = require('./chunk-NNWJZUQL.cjs');
-require('./chunk-LY73ZYN5.cjs');
+var chunkOXCLLFCY_cjs = require('./chunk-OXCLLFCY.cjs');
+require('./chunk-QBHOJGZI.cjs');
 require('./chunk-J5FZ4WDQ.cjs');
 require('./chunk-EHQFWSP6.cjs');
 var definition = require('virtual:suiteop/content');
@@ -10,7 +10,7 @@ function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
 var definition__default = /*#__PURE__*/_interopDefault(definition);
 
-var prerender=true;function GET(){return new Response(`${JSON.stringify(chunkNNWJZUQL_cjs.parseContentModel(definition__default.default))}
+var prerender=true;function GET(){return new Response(`${JSON.stringify(chunkOXCLLFCY_cjs.parseContentModel(definition__default.default))}
 `,{headers:{"content-type":"application/json"}})}
 
 exports.GET = GET;

package/dist/astro-content-model.js

@@ -1,5 +1,5 @@
-import { parseContentModel } from './chunk-IUNIQSFB.js';
-import './chunk-5TUJX6GY.js';
+import { parseContentModel } from './chunk-3B6ZYRYF.js';
+import './chunk-XOCFEVP4.js';
 import './chunk-W5K7IDYN.js';
 import './chunk-IBCBDAGY.js';
 import definition from 'virtual:suiteop/content';

package/dist/astro.cjs

@@ -2,7 +2,7 @@
 
 var zod = require('zod');
 
-var SOURCES=[[/^\/listing\/\[[^\]/]+\]$/,"listings"],[/^\/building\/\[[^\]/]+\]$/,"buildings"],[/^\/area\/\[[^\]/]+\]$/,"locations"]];var DECLARABLE_SOURCE=/^(listings|buildings|locations|collection:[a-z][a-z0-9_]{0,39})$/;var ERROR_PAGES=new Set(["404","500"]);function normalizePath(pathname){const withSlash=pathname.startsWith("/")?pathname:`/${pathname}`;const trimmed=withSlash.replace(/\/+$/,"").replace(/\/index(\.html)?$/,"");return trimmed===""?"/":trimmed}var ENTITIES={amp:"&",lt:"<",gt:">",quot:'"',apos:"'"};function decodeEntities(text){return text.replace(/&(#x[0-9a-f]+|#\d+|[a-z]+);/gi,(whole,ref)=>{if(ref[0]==="#"){const code=ref[1]==="x"||ref[1]==="X"?parseInt(ref.slice(2),16):Number(ref.slice(1));return Number.isFinite(code)&&code>0&&code<=1114111?String.fromCodePoint(code):whole}return ENTITIES[ref.toLowerCase()]??whole})}function metaContent(html,name){for(const[tag]of html.matchAll(/<meta\b[^>]*>/gi)){const attr=key=>new RegExp(`\\b${key}\\s*=\\s*(?:"([^"]*)"|'([^']*)')`,"i").exec(tag);const tagName=attr("name");if((tagName?.[1]??tagName?.[2])?.toLowerCase()!==name)continue;const content=attr("content");return decodeEntities(content?.[1]??content?.[2]??"")}return null}function localeOf(path,config){const first=path.split("/")[1]??"";return first!==config.defaultLocale&&config.locales.includes(first)?first:config.defaultLocale}function isErrorPage(path,locale,config){const rest=locale===config.defaultLocale?path:path.slice(locale.length+1);return ERROR_PAGES.has(rest.replace(/^\//,""))}async function buildSiteManifest(input){const now=input.now.toISOString();const pages=[];const seen=new Set;for(const pathname of input.pages){const path=normalizePath(pathname);if(seen.has(path))continue;seen.add(path);const locale=localeOf(path,input.config);if(isErrorPage(path,locale,input.config))continue;const html=await input.readHtml(pathname);if(!html)continue;if(/\bnoindex\b/i.test(metaContent(html,"robots")??""))continue;const title=/<title[^>]*>([\s\S]*?)<\/title>/i.exec(html)?.[1];const lastmodRaw=metaContent(html,"suiteop:lastmod");const lastmodMs=lastmodRaw?Date.parse(lastmodRaw):Number.NaN;pages.push({path,locale,title:title?decodeEntities(title.trim()):"",lastmod:Number.isNaN(lastmodMs)?now:new Date(lastmodMs).toISOString()});}pages.sort((a,b)=>a.path<b.path?-1:a.path>b.path?1:0);const dynamicRoutes=[];for(const pattern of input.dynamicRoutes){const source=input.declaredRoutes?.[pattern]??SOURCES.find(([re])=>re.test(pattern))?.[1];if(source&&!dynamicRoutes.some(r=>r.pattern===pattern)){dynamicRoutes.push({pattern,source});}}return {version:1,generatedAt:now,pages,dynamicRoutes}}var sameOriginPath=zod.z.string().regex(/^\/(?![/\\])/);var siteContextSchema=zod.z.object({siteId:zod.z.string().min(1),orgId:zod.z.string().min(1),region:zod.z.enum(["us","eu","apac"]),environment:zod.z.enum(["live","test"]),publishableKey:zod.z.string().regex(/^pk_(live|test)_/),country:zod.z.string().nullable().optional(),apiBasePath:sameOriginPath,apiBaseUrl:zod.z.url({protocol:/^https$/}).nullable().optional(),apiHeaders:zod.z.record(zod.z.string().regex(/^x-suiteop-[a-z0-9-]+$/),zod.z.string()).optional()});function getSiteContext(locals){const props=locals.cfContext?.props;if(typeof props!=="object"||props===null)return null;const parsed=siteContextSchema.safeParse(props);if(!parsed.success)return null;const p=parsed.data;return {...p,country:p.country??null,apiBaseUrl:p.apiBaseUrl??null,apiHeaders:p.apiHeaders??{}}}var SITE_MANIFEST_PATH="_suiteop/manifest.json";var CONTENT_MODEL_PATH="_suiteop/content-model.json";var CONTENT_MODULE_ID="virtual:suiteop/content";var RESOLVED_CONTENT_MODULE_ID=`\0${CONTENT_MODULE_ID}`;function devProxy(env){const apiOrigin=env["SUITEOP_API_ORIGIN"];const edgeOrigin=env["SUITEOP_EDGE_ORIGIN"];const proxy={};if(apiOrigin){proxy["/api/storefront/v1"]={target:apiOrigin,changeOrigin:true,...edgeOrigin?{headers:{origin:edgeOrigin}}:{}};}if(edgeOrigin){proxy["^/checkout/(manifest\\.json|v\\d+(\\.[0-9a-f]+)?\\.js)$"]={target:edgeOrigin,changeOrigin:true};}return proxy}function contentModulePlugin(file){return {name:"@suiteop/storefront:content",resolveId:id=>id===CONTENT_MODULE_ID?RESOLVED_CONTENT_MODULE_ID:void 0,load:id=>id===RESOLVED_CONTENT_MODULE_ID?`export { default } from ${JSON.stringify(file)}`:void 0}}function suiteop(options={}){for(const[pattern,source]of Object.entries(options.routes??{})){if(!DECLARABLE_SOURCE.test(source)){throw new Error(`suiteop(): route ${pattern} has source "${source}"; use listings, buildings, locations or collection:<key>.`)}}let i18n={locales:[],defaultLocale:"en"};let format="directory";let onDemandRoutes=[];return {name:"@suiteop/storefront",hooks:{"astro:config:setup":({command,config,updateConfig,injectRoute})=>{if(options.content){const file=decodeURIComponent(new URL(options.content,config.root).pathname);updateConfig({vite:{plugins:[contentModulePlugin(file)]}});injectRoute({pattern:`/${CONTENT_MODEL_PATH}`,entrypoint:"@suiteop/storefront/astro/content-model",prerender:true});}if(command==="dev"&&process.env["SUITEOP_DEV_PROXY"]==="1"){updateConfig({vite:{server:{proxy:devProxy(process.env),strictPort:true}}});}},"astro:config:done":({config})=>{format=config.build.format;if(config.i18n){i18n={locales:config.i18n.locales.map(l=>typeof l==="string"?l:l.path),defaultLocale:config.i18n.defaultLocale};}},"astro:routes:resolved":({routes})=>{onDemandRoutes=routes.filter(r=>r.type==="page"&&!r.isPrerendered&&r.origin==="project").map(r=>r.pattern);},"astro:build:done":async({dir,pages,logger})=>{const{mkdir,writeFile}=await import('node:fs/promises');const built=await builtHtmlPaths(dir);const all=new Set([...pages.map(p=>`/${p.pathname}`),...built]);const manifest=await buildSiteManifest({pages:[...all],dynamicRoutes:onDemandRoutes,declaredRoutes:options.routes,readHtml:pathname=>readBuiltHtml(dir,pathname,format),now:new Date,config:i18n});const target=new URL(SITE_MANIFEST_PATH,dir);await mkdir(new URL(".",target),{recursive:true});await writeFile(target,`${JSON.stringify(manifest)}
+var SOURCES=[[/^\/listing\/\[[^\]/]+\]$/,"listings"],[/^\/building\/\[[^\]/]+\]$/,"buildings"],[/^\/area\/\[[^\]/]+\]$/,"locations"]];var DECLARABLE_SOURCE=/^(listings|buildings|locations|guides|page|collection:[a-z][a-z0-9_]{0,39})$/;var ERROR_PAGES=new Set(["404","500"]);function normalizePath(pathname){const withSlash=pathname.startsWith("/")?pathname:`/${pathname}`;const trimmed=withSlash.replace(/\/+$/,"").replace(/\/index(\.html)?$/,"");return trimmed===""?"/":trimmed}var ENTITIES={amp:"&",lt:"<",gt:">",quot:'"',apos:"'"};function decodeEntities(text){return text.replace(/&(#x[0-9a-f]+|#\d+|[a-z]+);/gi,(whole,ref)=>{if(ref[0]==="#"){const code=ref[1]==="x"||ref[1]==="X"?parseInt(ref.slice(2),16):Number(ref.slice(1));return Number.isFinite(code)&&code>0&&code<=1114111?String.fromCodePoint(code):whole}return ENTITIES[ref.toLowerCase()]??whole})}function metaContent(html,name){for(const[tag]of html.matchAll(/<meta\b[^>]*>/gi)){const attr=key=>new RegExp(`\\b${key}\\s*=\\s*(?:"([^"]*)"|'([^']*)')`,"i").exec(tag);const tagName=attr("name");if((tagName?.[1]??tagName?.[2])?.toLowerCase()!==name)continue;const content=attr("content");return decodeEntities(content?.[1]??content?.[2]??"")}return null}function localeOf(path,config){const first=path.split("/")[1]??"";return first!==config.defaultLocale&&config.locales.includes(first)?first:config.defaultLocale}function isErrorPage(path,locale,config){const rest=locale===config.defaultLocale?path:path.slice(locale.length+1);return ERROR_PAGES.has(rest.replace(/^\//,""))}async function buildSiteManifest(input){const now=input.now.toISOString();const pages=[];const seen=new Set;for(const pathname of input.pages){const path=normalizePath(pathname);if(seen.has(path))continue;seen.add(path);const locale=localeOf(path,input.config);if(isErrorPage(path,locale,input.config))continue;const html=await input.readHtml(pathname);if(!html)continue;if(/\bnoindex\b/i.test(metaContent(html,"robots")??""))continue;const title=/<title[^>]*>([\s\S]*?)<\/title>/i.exec(html)?.[1];const lastmodRaw=metaContent(html,"suiteop:lastmod");const lastmodMs=lastmodRaw?Date.parse(lastmodRaw):Number.NaN;pages.push({path,locale,title:title?decodeEntities(title.trim()):"",lastmod:Number.isNaN(lastmodMs)?now:new Date(lastmodMs).toISOString()});}pages.sort((a,b)=>a.path<b.path?-1:a.path>b.path?1:0);const dynamicRoutes=[];for(const pattern of input.dynamicRoutes){const source=input.declaredRoutes?.[pattern]??SOURCES.find(([re])=>re.test(pattern))?.[1];if(source&&!dynamicRoutes.some(r=>r.pattern===pattern)){dynamicRoutes.push({pattern,source});}}return {version:1,generatedAt:now,pages,dynamicRoutes}}var sameOriginPath=zod.z.string().regex(/^\/(?![/\\])/);var siteContextSchema=zod.z.object({siteId:zod.z.string().min(1),orgId:zod.z.string().min(1),region:zod.z.enum(["us","eu","apac"]),environment:zod.z.enum(["live","test"]),publishableKey:zod.z.string().regex(/^pk_(live|test)_/),country:zod.z.string().nullable().optional(),apiBasePath:sameOriginPath,apiBaseUrl:zod.z.url({protocol:/^https$/}).nullable().optional(),apiHeaders:zod.z.record(zod.z.string().regex(/^x-suiteop-[a-z0-9-]+$/),zod.z.string()).optional()});function getSiteContext(locals){const props=locals.cfContext?.props;if(typeof props!=="object"||props===null)return null;const parsed=siteContextSchema.safeParse(props);if(!parsed.success)return null;const p=parsed.data;return {...p,country:p.country??null,apiBaseUrl:p.apiBaseUrl??null,apiHeaders:p.apiHeaders??{}}}var SITE_MANIFEST_PATH="_suiteop/manifest.json";var CONTENT_MODEL_PATH="_suiteop/content-model.json";var CONTENT_MODULE_ID="virtual:suiteop/content";var RESOLVED_CONTENT_MODULE_ID=`\0${CONTENT_MODULE_ID}`;function devProxy(env){const apiOrigin=env["SUITEOP_API_ORIGIN"];const edgeOrigin=env["SUITEOP_EDGE_ORIGIN"];const proxy={};if(apiOrigin){proxy["/api/storefront/v1"]={target:apiOrigin,changeOrigin:true,...edgeOrigin?{headers:{origin:edgeOrigin}}:{}};}if(edgeOrigin){proxy["^/checkout/(manifest\\.json|v\\d+(\\.[0-9a-f]+)?\\.js)$"]={target:edgeOrigin,changeOrigin:true};}return proxy}function contentModulePlugin(file){return {name:"@suiteop/storefront:content",resolveId:id=>id===CONTENT_MODULE_ID?RESOLVED_CONTENT_MODULE_ID:void 0,load:id=>id===RESOLVED_CONTENT_MODULE_ID?`export { default } from ${JSON.stringify(file)}`:void 0}}function suiteop(options={}){for(const[pattern,source]of Object.entries(options.routes??{})){if(!DECLARABLE_SOURCE.test(source)){throw new Error(`suiteop(): route ${pattern} has source "${source}"; use listings, buildings, locations, guides, page or collection:<key>.`)}if(source==="page"&&pattern.includes("[")){throw new Error(`suiteop(): route ${pattern} has a parameter, so it is not one page.`)}}let i18n={locales:[],defaultLocale:"en"};let format="directory";let onDemandRoutes=[];return {name:"@suiteop/storefront",hooks:{"astro:config:setup":({command,config,updateConfig,injectRoute})=>{if(options.content){const file=decodeURIComponent(new URL(options.content,config.root).pathname);updateConfig({vite:{plugins:[contentModulePlugin(file)]}});injectRoute({pattern:`/${CONTENT_MODEL_PATH}`,entrypoint:"@suiteop/storefront/astro/content-model",prerender:true});}if(command==="dev"&&process.env["SUITEOP_DEV_PROXY"]==="1"){updateConfig({vite:{server:{proxy:devProxy(process.env),strictPort:true}}});}},"astro:config:done":({config})=>{format=config.build.format;if(config.i18n){i18n={locales:config.i18n.locales.map(l=>typeof l==="string"?l:l.path),defaultLocale:config.i18n.defaultLocale};}},"astro:routes:resolved":({routes})=>{onDemandRoutes=routes.filter(r=>r.type==="page"&&!r.isPrerendered&&r.origin==="project").map(r=>r.pattern);},"astro:build:done":async({dir,pages,logger})=>{const{mkdir,writeFile}=await import('node:fs/promises');const built=await builtHtmlPaths(dir);const all=new Set([...pages.map(p=>`/${p.pathname}`),...built]);const manifest=await buildSiteManifest({pages:[...all],dynamicRoutes:onDemandRoutes,declaredRoutes:options.routes,readHtml:pathname=>readBuiltHtml(dir,pathname,format),now:new Date,config:i18n});const target=new URL(SITE_MANIFEST_PATH,dir);await mkdir(new URL(".",target),{recursive:true});await writeFile(target,`${JSON.stringify(manifest)}
 `);logger.info(`suiteop manifest: ${manifest.pages.length} pages, ${manifest.dynamicRoutes.length} dynamic routes`);}}}}async function builtHtmlPaths(dir){const{readdir}=await import('node:fs/promises');const{fileURLToPath}=await import('node:url');const entries=await readdir(fileURLToPath(dir),{recursive:true,withFileTypes:true});const paths=[];for(const entry of entries){if(!entry.isFile()||!entry.name.endsWith(".html"))continue;const rel=`${entry.parentPath}/${entry.name}`.slice(fileURLToPath(dir).length).replace(/\\/g,"/").replace(/^\/+/,"");if(/^(_astro|_suiteop)\//.test(rel))continue;paths.push(`/${rel.replace(/(^|\/)index\.html$/,"$1").replace(/\.html$/,"")}`);}return paths}async function readBuiltHtml(dir,pathname,format){const{readFile}=await import('node:fs/promises');const base=pathname.replace(/^\/+/,"").replace(/\/+$/,"");const candidates=base===""?["index.html"]:format==="file"?[`${base}.html`,`${base}/index.html`]:[`${base}/index.html`,`${base}.html`];for(const candidate of candidates){try{return await readFile(new URL(candidate,dir),"utf8")}catch(err){if(err.code!=="ENOENT")throw err}}return null}
 
 exports.CONTENT_MODEL_PATH = CONTENT_MODEL_PATH;

package/dist/astro.d.cts

@@ -1,23 +1,45 @@
-type SiteManifestSource = 'listings' | 'buildings' | 'locations' | `collection:${string}`;
+/**
+ * The site manifest a storefront build emits at `/_suiteop/manifest.json`. The platform reads it
+ * after a deploy for the sitemap and search features: which prerendered pages exist (with their
+ * title, language and last change) and which on-demand routes expand from catalogue data.
+ */
+/**
+ * Where a dynamic route's pages come from: the listings, buildings or areas (`locations`) of the
+ * catalogue, the guides the site shows (`guides`), or the published items of one of the site's
+ * collections (`collection:<key>`). `page` is a server-rendered route without a parameter
+ * (`/blog`): the sitemap lists it as one page.
+ */
+type SiteManifestSource = 'listings' | 'buildings' | 'locations' | 'guides' | 'page' | `collection:${string}`;
 interface SiteManifestPage {
+    /** Site-relative, no trailing slash (`/` for the home page). */
     path: string;
     locale: string;
     title: string;
+    /** ISO 8601. */
     lastmod: string;
 }
 interface SiteManifest {
     version: 1;
     generatedAt: string;
     pages: SiteManifestPage[];
+    /** On-demand routes whose pages are one per catalogue record. Checkout, confirmation and search never appear. */
     dynamicRoutes: {
         pattern: string;
         source: SiteManifestSource;
     }[];
 }
 interface BuildSiteManifestInput {
+    /** Pathnames of the prerendered pages, as the build reports them. */
     pages: string[];
+    /** Route patterns of the on-demand (server-rendered) routes, e.g. `/listing/[id]`. */
     dynamicRoutes: string[];
+    /**
+     * Sources the site declares for routes the conventions do not cover
+     * (`suiteop({ routes: { '/blog/[slug]': 'collection:blog' } })`). Only on-demand routes count:
+     * a prerendered page is listed as a page already.
+     */
     declaredRoutes?: Record<string, SiteManifestSource>;
+    /** The built HTML for a page pathname; null when it cannot be read. */
     readHtml(pathname: string): Promise<string | null>;
     now: Date;
     config: {
@@ -27,30 +49,47 @@ interface BuildSiteManifestInput {
 }
 declare function buildSiteManifest(input: BuildSiteManifestInput): Promise<SiteManifest>;
 
+/**
+ * What the SuiteOp edge hands every request of a SuiteOp-hosted site on the Worker's
+ * `ctx.props` (`Astro.locals.cfContext.props` with `@astrojs/cloudflare`).
+ */
 interface SiteContext {
     siteId: string;
     orgId: string;
     region: 'us' | 'eu' | 'apac';
     environment: 'live' | 'test';
+    /** This environment's publishable key. Public by design — safe in HTML. */
     publishableKey: string;
+    /** The visitor's country (ISO 3166-1 alpha-2) when the edge knows it. */
     country: string | null;
+    /** Same-origin Storefront API path for the browser, proxied by the edge. */
     apiBasePath: string;
+    /**
+     * Absolute Storefront API base for server-side calls (the site's regional API). Null when the
+     * edge does not provide one; server calls then fall back to the same-origin path.
+     */
     apiBaseUrl: string | null;
+    /** Headers the edge signs for THIS request (the visitor's IP); send them on server-side API calls. */
     apiHeaders: Record<string, string>;
 }
+/** The edge's props for this request, or null when the site is not served by the SuiteOp edge. */
 declare function getSiteContext(locals: object): SiteContext | null;
 
+/** Where the manifest lands in the client build output, and the path the site serves it on. */
 declare const SITE_MANIFEST_PATH = "_suiteop/manifest.json";
+/** Where the site's content model lands in the client build output (`suiteop({ content })`). */
 declare const CONTENT_MODEL_PATH = "_suiteop/content-model.json";
 interface ProxyTarget {
     target: string;
     changeOrigin: boolean;
+    /** Set on every proxied request, replacing what the caller sent. */
     headers?: Record<string, string>;
     rewrite?: (path: string) => string;
 }
 interface I18nLocale {
     path: string;
 }
+/** The Vite plugin that serves the site's content declaration under {@link CONTENT_MODULE_ID}. */
 interface ContentModulePlugin {
     name: string;
     resolveId(id: string): string | undefined;
@@ -114,12 +153,38 @@ interface SuiteOpIntegration {
         'astro:build:done': (options: BuildDoneOptions) => Promise<void>;
     };
 }
+/**
+ * `astro dev` proxy for `suiteop dev`: the Storefront API and the checkout bundle answer on the
+ * same paths as on a SuiteOp-hosted site, so site code has no dev-only branch. Enabled only when
+ * `SUITEOP_DEV_PROXY=1` (the CLI sets it with the two origins).
+ *
+ * API calls are sent with the site's own origin (`SUITEOP_EDGE_ORIGIN`), which is among its
+ * key's allowed origins: the API refuses a call from `http://localhost:<port>` (the site's
+ * server code) and one with no `Origin` at all (a same-origin GET from the browser).
+ */
 declare function devProxy(env: Record<string, string | undefined>): Record<string, ProxyTarget>;
 interface SuiteOpIntegrationOptions {
+    /**
+     * The site's content model (`defineContent`), e.g. `'./src/suiteop.content.ts'`, relative to the
+     * project root. The build emits it at `/_suiteop/content-model.json` and the deploy registers it,
+     * so the dashboard shows a form for each type.
+     */
     content?: string;
+    /**
+     * The source of on-demand routes the conventions do not cover, for the sitemap:
+     * `{ '/blog/[slug]': 'collection:blog', '/things-to-do/[id]': 'guides', '/blog': 'page' }`.
+     * `page` lists a route without a parameter as one page. `/listing/[…]`, `/building/[…]` and
+     * `/area/[…]` are inferred.
+     */
     routes?: Record<string, SiteManifestSource>;
 }
+/** The Vite plugin re-exporting the site's content declaration at `file`. */
 declare function contentModulePlugin(file: string): ContentModulePlugin;
+/**
+ * The SuiteOp Astro integration: emits the site manifest at `/_suiteop/manifest.json` after a
+ * build, the site's content model at `/_suiteop/content-model.json` when it declares one, and
+ * wires the `suiteop dev` proxy.
+ */
 declare function suiteop(options?: SuiteOpIntegrationOptions): SuiteOpIntegration;
 
 export { type BuildSiteManifestInput, CONTENT_MODEL_PATH, type ContentModulePlugin, SITE_MANIFEST_PATH, type SiteContext, type SiteManifest, type SiteManifestPage, type SiteManifestSource, type SuiteOpIntegration, type SuiteOpIntegrationOptions, buildSiteManifest, contentModulePlugin, devProxy, getSiteContext, suiteop };

package/dist/astro.d.ts

@@ -1,23 +1,45 @@
-type SiteManifestSource = 'listings' | 'buildings' | 'locations' | `collection:${string}`;
+/**
+ * The site manifest a storefront build emits at `/_suiteop/manifest.json`. The platform reads it
+ * after a deploy for the sitemap and search features: which prerendered pages exist (with their
+ * title, language and last change) and which on-demand routes expand from catalogue data.
+ */
+/**
+ * Where a dynamic route's pages come from: the listings, buildings or areas (`locations`) of the
+ * catalogue, the guides the site shows (`guides`), or the published items of one of the site's
+ * collections (`collection:<key>`). `page` is a server-rendered route without a parameter
+ * (`/blog`): the sitemap lists it as one page.
+ */
+type SiteManifestSource = 'listings' | 'buildings' | 'locations' | 'guides' | 'page' | `collection:${string}`;
 interface SiteManifestPage {
+    /** Site-relative, no trailing slash (`/` for the home page). */
     path: string;
     locale: string;
     title: string;
+    /** ISO 8601. */
     lastmod: string;
 }
 interface SiteManifest {
     version: 1;
     generatedAt: string;
     pages: SiteManifestPage[];
+    /** On-demand routes whose pages are one per catalogue record. Checkout, confirmation and search never appear. */
     dynamicRoutes: {
         pattern: string;
         source: SiteManifestSource;
     }[];
 }
 interface BuildSiteManifestInput {
+    /** Pathnames of the prerendered pages, as the build reports them. */
     pages: string[];
+    /** Route patterns of the on-demand (server-rendered) routes, e.g. `/listing/[id]`. */
     dynamicRoutes: string[];
+    /**
+     * Sources the site declares for routes the conventions do not cover
+     * (`suiteop({ routes: { '/blog/[slug]': 'collection:blog' } })`). Only on-demand routes count:
+     * a prerendered page is listed as a page already.
+     */
     declaredRoutes?: Record<string, SiteManifestSource>;
+    /** The built HTML for a page pathname; null when it cannot be read. */
     readHtml(pathname: string): Promise<string | null>;
     now: Date;
     config: {
@@ -27,30 +49,47 @@ interface BuildSiteManifestInput {
 }
 declare function buildSiteManifest(input: BuildSiteManifestInput): Promise<SiteManifest>;
 
+/**
+ * What the SuiteOp edge hands every request of a SuiteOp-hosted site on the Worker's
+ * `ctx.props` (`Astro.locals.cfContext.props` with `@astrojs/cloudflare`).
+ */
 interface SiteContext {
     siteId: string;
     orgId: string;
     region: 'us' | 'eu' | 'apac';
     environment: 'live' | 'test';
+    /** This environment's publishable key. Public by design — safe in HTML. */
     publishableKey: string;
+    /** The visitor's country (ISO 3166-1 alpha-2) when the edge knows it. */
     country: string | null;
+    /** Same-origin Storefront API path for the browser, proxied by the edge. */
     apiBasePath: string;
+    /**
+     * Absolute Storefront API base for server-side calls (the site's regional API). Null when the
+     * edge does not provide one; server calls then fall back to the same-origin path.
+     */
     apiBaseUrl: string | null;
+    /** Headers the edge signs for THIS request (the visitor's IP); send them on server-side API calls. */
     apiHeaders: Record<string, string>;
 }
+/** The edge's props for this request, or null when the site is not served by the SuiteOp edge. */
 declare function getSiteContext(locals: object): SiteContext | null;
 
+/** Where the manifest lands in the client build output, and the path the site serves it on. */
 declare const SITE_MANIFEST_PATH = "_suiteop/manifest.json";
+/** Where the site's content model lands in the client build output (`suiteop({ content })`). */
 declare const CONTENT_MODEL_PATH = "_suiteop/content-model.json";
 interface ProxyTarget {
     target: string;
     changeOrigin: boolean;
+    /** Set on every proxied request, replacing what the caller sent. */
     headers?: Record<string, string>;
     rewrite?: (path: string) => string;
 }
 interface I18nLocale {
     path: string;
 }
+/** The Vite plugin that serves the site's content declaration under {@link CONTENT_MODULE_ID}. */
 interface ContentModulePlugin {
     name: string;
     resolveId(id: string): string | undefined;
@@ -114,12 +153,38 @@ interface SuiteOpIntegration {
         'astro:build:done': (options: BuildDoneOptions) => Promise<void>;
     };
 }
+/**
+ * `astro dev` proxy for `suiteop dev`: the Storefront API and the checkout bundle answer on the
+ * same paths as on a SuiteOp-hosted site, so site code has no dev-only branch. Enabled only when
+ * `SUITEOP_DEV_PROXY=1` (the CLI sets it with the two origins).
+ *
+ * API calls are sent with the site's own origin (`SUITEOP_EDGE_ORIGIN`), which is among its
+ * key's allowed origins: the API refuses a call from `http://localhost:<port>` (the site's
+ * server code) and one with no `Origin` at all (a same-origin GET from the browser).
+ */
 declare function devProxy(env: Record<string, string | undefined>): Record<string, ProxyTarget>;
 interface SuiteOpIntegrationOptions {
+    /**
+     * The site's content model (`defineContent`), e.g. `'./src/suiteop.content.ts'`, relative to the
+     * project root. The build emits it at `/_suiteop/content-model.json` and the deploy registers it,
+     * so the dashboard shows a form for each type.
+     */
     content?: string;
+    /**
+     * The source of on-demand routes the conventions do not cover, for the sitemap:
+     * `{ '/blog/[slug]': 'collection:blog', '/things-to-do/[id]': 'guides', '/blog': 'page' }`.
+     * `page` lists a route without a parameter as one page. `/listing/[…]`, `/building/[…]` and
+     * `/area/[…]` are inferred.
+     */
     routes?: Record<string, SiteManifestSource>;
 }
+/** The Vite plugin re-exporting the site's content declaration at `file`. */
 declare function contentModulePlugin(file: string): ContentModulePlugin;
+/**
+ * The SuiteOp Astro integration: emits the site manifest at `/_suiteop/manifest.json` after a
+ * build, the site's content model at `/_suiteop/content-model.json` when it declares one, and
+ * wires the `suiteop dev` proxy.
+ */
 declare function suiteop(options?: SuiteOpIntegrationOptions): SuiteOpIntegration;
 
 export { type BuildSiteManifestInput, CONTENT_MODEL_PATH, type ContentModulePlugin, SITE_MANIFEST_PATH, type SiteContext, type SiteManifest, type SiteManifestPage, type SiteManifestSource, type SuiteOpIntegration, type SuiteOpIntegrationOptions, buildSiteManifest, contentModulePlugin, devProxy, getSiteContext, suiteop };

package/dist/astro.js

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 
-var SOURCES=[[/^\/listing\/\[[^\]/]+\]$/,"listings"],[/^\/building\/\[[^\]/]+\]$/,"buildings"],[/^\/area\/\[[^\]/]+\]$/,"locations"]];var DECLARABLE_SOURCE=/^(listings|buildings|locations|collection:[a-z][a-z0-9_]{0,39})$/;var ERROR_PAGES=new Set(["404","500"]);function normalizePath(pathname){const withSlash=pathname.startsWith("/")?pathname:`/${pathname}`;const trimmed=withSlash.replace(/\/+$/,"").replace(/\/index(\.html)?$/,"");return trimmed===""?"/":trimmed}var ENTITIES={amp:"&",lt:"<",gt:">",quot:'"',apos:"'"};function decodeEntities(text){return text.replace(/&(#x[0-9a-f]+|#\d+|[a-z]+);/gi,(whole,ref)=>{if(ref[0]==="#"){const code=ref[1]==="x"||ref[1]==="X"?parseInt(ref.slice(2),16):Number(ref.slice(1));return Number.isFinite(code)&&code>0&&code<=1114111?String.fromCodePoint(code):whole}return ENTITIES[ref.toLowerCase()]??whole})}function metaContent(html,name){for(const[tag]of html.matchAll(/<meta\b[^>]*>/gi)){const attr=key=>new RegExp(`\\b${key}\\s*=\\s*(?:"([^"]*)"|'([^']*)')`,"i").exec(tag);const tagName=attr("name");if((tagName?.[1]??tagName?.[2])?.toLowerCase()!==name)continue;const content=attr("content");return decodeEntities(content?.[1]??content?.[2]??"")}return null}function localeOf(path,config){const first=path.split("/")[1]??"";return first!==config.defaultLocale&&config.locales.includes(first)?first:config.defaultLocale}function isErrorPage(path,locale,config){const rest=locale===config.defaultLocale?path:path.slice(locale.length+1);return ERROR_PAGES.has(rest.replace(/^\//,""))}async function buildSiteManifest(input){const now=input.now.toISOString();const pages=[];const seen=new Set;for(const pathname of input.pages){const path=normalizePath(pathname);if(seen.has(path))continue;seen.add(path);const locale=localeOf(path,input.config);if(isErrorPage(path,locale,input.config))continue;const html=await input.readHtml(pathname);if(!html)continue;if(/\bnoindex\b/i.test(metaContent(html,"robots")??""))continue;const title=/<title[^>]*>([\s\S]*?)<\/title>/i.exec(html)?.[1];const lastmodRaw=metaContent(html,"suiteop:lastmod");const lastmodMs=lastmodRaw?Date.parse(lastmodRaw):Number.NaN;pages.push({path,locale,title:title?decodeEntities(title.trim()):"",lastmod:Number.isNaN(lastmodMs)?now:new Date(lastmodMs).toISOString()});}pages.sort((a,b)=>a.path<b.path?-1:a.path>b.path?1:0);const dynamicRoutes=[];for(const pattern of input.dynamicRoutes){const source=input.declaredRoutes?.[pattern]??SOURCES.find(([re])=>re.test(pattern))?.[1];if(source&&!dynamicRoutes.some(r=>r.pattern===pattern)){dynamicRoutes.push({pattern,source});}}return {version:1,generatedAt:now,pages,dynamicRoutes}}var sameOriginPath=z.string().regex(/^\/(?![/\\])/);var siteContextSchema=z.object({siteId:z.string().min(1),orgId:z.string().min(1),region:z.enum(["us","eu","apac"]),environment:z.enum(["live","test"]),publishableKey:z.string().regex(/^pk_(live|test)_/),country:z.string().nullable().optional(),apiBasePath:sameOriginPath,apiBaseUrl:z.url({protocol:/^https$/}).nullable().optional(),apiHeaders:z.record(z.string().regex(/^x-suiteop-[a-z0-9-]+$/),z.string()).optional()});function getSiteContext(locals){const props=locals.cfContext?.props;if(typeof props!=="object"||props===null)return null;const parsed=siteContextSchema.safeParse(props);if(!parsed.success)return null;const p=parsed.data;return {...p,country:p.country??null,apiBaseUrl:p.apiBaseUrl??null,apiHeaders:p.apiHeaders??{}}}var SITE_MANIFEST_PATH="_suiteop/manifest.json";var CONTENT_MODEL_PATH="_suiteop/content-model.json";var CONTENT_MODULE_ID="virtual:suiteop/content";var RESOLVED_CONTENT_MODULE_ID=`\0${CONTENT_MODULE_ID}`;function devProxy(env){const apiOrigin=env["SUITEOP_API_ORIGIN"];const edgeOrigin=env["SUITEOP_EDGE_ORIGIN"];const proxy={};if(apiOrigin){proxy["/api/storefront/v1"]={target:apiOrigin,changeOrigin:true,...edgeOrigin?{headers:{origin:edgeOrigin}}:{}};}if(edgeOrigin){proxy["^/checkout/(manifest\\.json|v\\d+(\\.[0-9a-f]+)?\\.js)$"]={target:edgeOrigin,changeOrigin:true};}return proxy}function contentModulePlugin(file){return {name:"@suiteop/storefront:content",resolveId:id=>id===CONTENT_MODULE_ID?RESOLVED_CONTENT_MODULE_ID:void 0,load:id=>id===RESOLVED_CONTENT_MODULE_ID?`export { default } from ${JSON.stringify(file)}`:void 0}}function suiteop(options={}){for(const[pattern,source]of Object.entries(options.routes??{})){if(!DECLARABLE_SOURCE.test(source)){throw new Error(`suiteop(): route ${pattern} has source "${source}"; use listings, buildings, locations or collection:<key>.`)}}let i18n={locales:[],defaultLocale:"en"};let format="directory";let onDemandRoutes=[];return {name:"@suiteop/storefront",hooks:{"astro:config:setup":({command,config,updateConfig,injectRoute})=>{if(options.content){const file=decodeURIComponent(new URL(options.content,config.root).pathname);updateConfig({vite:{plugins:[contentModulePlugin(file)]}});injectRoute({pattern:`/${CONTENT_MODEL_PATH}`,entrypoint:"@suiteop/storefront/astro/content-model",prerender:true});}if(command==="dev"&&process.env["SUITEOP_DEV_PROXY"]==="1"){updateConfig({vite:{server:{proxy:devProxy(process.env),strictPort:true}}});}},"astro:config:done":({config})=>{format=config.build.format;if(config.i18n){i18n={locales:config.i18n.locales.map(l=>typeof l==="string"?l:l.path),defaultLocale:config.i18n.defaultLocale};}},"astro:routes:resolved":({routes})=>{onDemandRoutes=routes.filter(r=>r.type==="page"&&!r.isPrerendered&&r.origin==="project").map(r=>r.pattern);},"astro:build:done":async({dir,pages,logger})=>{const{mkdir,writeFile}=await import('node:fs/promises');const built=await builtHtmlPaths(dir);const all=new Set([...pages.map(p=>`/${p.pathname}`),...built]);const manifest=await buildSiteManifest({pages:[...all],dynamicRoutes:onDemandRoutes,declaredRoutes:options.routes,readHtml:pathname=>readBuiltHtml(dir,pathname,format),now:new Date,config:i18n});const target=new URL(SITE_MANIFEST_PATH,dir);await mkdir(new URL(".",target),{recursive:true});await writeFile(target,`${JSON.stringify(manifest)}
+var SOURCES=[[/^\/listing\/\[[^\]/]+\]$/,"listings"],[/^\/building\/\[[^\]/]+\]$/,"buildings"],[/^\/area\/\[[^\]/]+\]$/,"locations"]];var DECLARABLE_SOURCE=/^(listings|buildings|locations|guides|page|collection:[a-z][a-z0-9_]{0,39})$/;var ERROR_PAGES=new Set(["404","500"]);function normalizePath(pathname){const withSlash=pathname.startsWith("/")?pathname:`/${pathname}`;const trimmed=withSlash.replace(/\/+$/,"").replace(/\/index(\.html)?$/,"");return trimmed===""?"/":trimmed}var ENTITIES={amp:"&",lt:"<",gt:">",quot:'"',apos:"'"};function decodeEntities(text){return text.replace(/&(#x[0-9a-f]+|#\d+|[a-z]+);/gi,(whole,ref)=>{if(ref[0]==="#"){const code=ref[1]==="x"||ref[1]==="X"?parseInt(ref.slice(2),16):Number(ref.slice(1));return Number.isFinite(code)&&code>0&&code<=1114111?String.fromCodePoint(code):whole}return ENTITIES[ref.toLowerCase()]??whole})}function metaContent(html,name){for(const[tag]of html.matchAll(/<meta\b[^>]*>/gi)){const attr=key=>new RegExp(`\\b${key}\\s*=\\s*(?:"([^"]*)"|'([^']*)')`,"i").exec(tag);const tagName=attr("name");if((tagName?.[1]??tagName?.[2])?.toLowerCase()!==name)continue;const content=attr("content");return decodeEntities(content?.[1]??content?.[2]??"")}return null}function localeOf(path,config){const first=path.split("/")[1]??"";return first!==config.defaultLocale&&config.locales.includes(first)?first:config.defaultLocale}function isErrorPage(path,locale,config){const rest=locale===config.defaultLocale?path:path.slice(locale.length+1);return ERROR_PAGES.has(rest.replace(/^\//,""))}async function buildSiteManifest(input){const now=input.now.toISOString();const pages=[];const seen=new Set;for(const pathname of input.pages){const path=normalizePath(pathname);if(seen.has(path))continue;seen.add(path);const locale=localeOf(path,input.config);if(isErrorPage(path,locale,input.config))continue;const html=await input.readHtml(pathname);if(!html)continue;if(/\bnoindex\b/i.test(metaContent(html,"robots")??""))continue;const title=/<title[^>]*>([\s\S]*?)<\/title>/i.exec(html)?.[1];const lastmodRaw=metaContent(html,"suiteop:lastmod");const lastmodMs=lastmodRaw?Date.parse(lastmodRaw):Number.NaN;pages.push({path,locale,title:title?decodeEntities(title.trim()):"",lastmod:Number.isNaN(lastmodMs)?now:new Date(lastmodMs).toISOString()});}pages.sort((a,b)=>a.path<b.path?-1:a.path>b.path?1:0);const dynamicRoutes=[];for(const pattern of input.dynamicRoutes){const source=input.declaredRoutes?.[pattern]??SOURCES.find(([re])=>re.test(pattern))?.[1];if(source&&!dynamicRoutes.some(r=>r.pattern===pattern)){dynamicRoutes.push({pattern,source});}}return {version:1,generatedAt:now,pages,dynamicRoutes}}var sameOriginPath=z.string().regex(/^\/(?![/\\])/);var siteContextSchema=z.object({siteId:z.string().min(1),orgId:z.string().min(1),region:z.enum(["us","eu","apac"]),environment:z.enum(["live","test"]),publishableKey:z.string().regex(/^pk_(live|test)_/),country:z.string().nullable().optional(),apiBasePath:sameOriginPath,apiBaseUrl:z.url({protocol:/^https$/}).nullable().optional(),apiHeaders:z.record(z.string().regex(/^x-suiteop-[a-z0-9-]+$/),z.string()).optional()});function getSiteContext(locals){const props=locals.cfContext?.props;if(typeof props!=="object"||props===null)return null;const parsed=siteContextSchema.safeParse(props);if(!parsed.success)return null;const p=parsed.data;return {...p,country:p.country??null,apiBaseUrl:p.apiBaseUrl??null,apiHeaders:p.apiHeaders??{}}}var SITE_MANIFEST_PATH="_suiteop/manifest.json";var CONTENT_MODEL_PATH="_suiteop/content-model.json";var CONTENT_MODULE_ID="virtual:suiteop/content";var RESOLVED_CONTENT_MODULE_ID=`\0${CONTENT_MODULE_ID}`;function devProxy(env){const apiOrigin=env["SUITEOP_API_ORIGIN"];const edgeOrigin=env["SUITEOP_EDGE_ORIGIN"];const proxy={};if(apiOrigin){proxy["/api/storefront/v1"]={target:apiOrigin,changeOrigin:true,...edgeOrigin?{headers:{origin:edgeOrigin}}:{}};}if(edgeOrigin){proxy["^/checkout/(manifest\\.json|v\\d+(\\.[0-9a-f]+)?\\.js)$"]={target:edgeOrigin,changeOrigin:true};}return proxy}function contentModulePlugin(file){return {name:"@suiteop/storefront:content",resolveId:id=>id===CONTENT_MODULE_ID?RESOLVED_CONTENT_MODULE_ID:void 0,load:id=>id===RESOLVED_CONTENT_MODULE_ID?`export { default } from ${JSON.stringify(file)}`:void 0}}function suiteop(options={}){for(const[pattern,source]of Object.entries(options.routes??{})){if(!DECLARABLE_SOURCE.test(source)){throw new Error(`suiteop(): route ${pattern} has source "${source}"; use listings, buildings, locations, guides, page or collection:<key>.`)}if(source==="page"&&pattern.includes("[")){throw new Error(`suiteop(): route ${pattern} has a parameter, so it is not one page.`)}}let i18n={locales:[],defaultLocale:"en"};let format="directory";let onDemandRoutes=[];return {name:"@suiteop/storefront",hooks:{"astro:config:setup":({command,config,updateConfig,injectRoute})=>{if(options.content){const file=decodeURIComponent(new URL(options.content,config.root).pathname);updateConfig({vite:{plugins:[contentModulePlugin(file)]}});injectRoute({pattern:`/${CONTENT_MODEL_PATH}`,entrypoint:"@suiteop/storefront/astro/content-model",prerender:true});}if(command==="dev"&&process.env["SUITEOP_DEV_PROXY"]==="1"){updateConfig({vite:{server:{proxy:devProxy(process.env),strictPort:true}}});}},"astro:config:done":({config})=>{format=config.build.format;if(config.i18n){i18n={locales:config.i18n.locales.map(l=>typeof l==="string"?l:l.path),defaultLocale:config.i18n.defaultLocale};}},"astro:routes:resolved":({routes})=>{onDemandRoutes=routes.filter(r=>r.type==="page"&&!r.isPrerendered&&r.origin==="project").map(r=>r.pattern);},"astro:build:done":async({dir,pages,logger})=>{const{mkdir,writeFile}=await import('node:fs/promises');const built=await builtHtmlPaths(dir);const all=new Set([...pages.map(p=>`/${p.pathname}`),...built]);const manifest=await buildSiteManifest({pages:[...all],dynamicRoutes:onDemandRoutes,declaredRoutes:options.routes,readHtml:pathname=>readBuiltHtml(dir,pathname,format),now:new Date,config:i18n});const target=new URL(SITE_MANIFEST_PATH,dir);await mkdir(new URL(".",target),{recursive:true});await writeFile(target,`${JSON.stringify(manifest)}
 `);logger.info(`suiteop manifest: ${manifest.pages.length} pages, ${manifest.dynamicRoutes.length} dynamic routes`);}}}}async function builtHtmlPaths(dir){const{readdir}=await import('node:fs/promises');const{fileURLToPath}=await import('node:url');const entries=await readdir(fileURLToPath(dir),{recursive:true,withFileTypes:true});const paths=[];for(const entry of entries){if(!entry.isFile()||!entry.name.endsWith(".html"))continue;const rel=`${entry.parentPath}/${entry.name}`.slice(fileURLToPath(dir).length).replace(/\\/g,"/").replace(/^\/+/,"");if(/^(_astro|_suiteop)\//.test(rel))continue;paths.push(`/${rel.replace(/(^|\/)index\.html$/,"$1").replace(/\.html$/,"")}`);}return paths}async function readBuiltHtml(dir,pathname,format){const{readFile}=await import('node:fs/promises');const base=pathname.replace(/^\/+/,"").replace(/\/+$/,"");const candidates=base===""?["index.html"]:format==="file"?[`${base}.html`,`${base}/index.html`]:[`${base}/index.html`,`${base}.html`];for(const candidate of candidates){try{return await readFile(new URL(candidate,dir),"utf8")}catch(err){if(err.code!=="ENOENT")throw err}}return null}
 
 export { CONTENT_MODEL_PATH, SITE_MANIFEST_PATH, buildSiteManifest, contentModulePlugin, devProxy, getSiteContext, suiteop };

package/dist/{availability-Dh0yLSkj.d.cts → availability.d-Cla9GuGc.d.cts}

@@ -18,7 +18,7 @@ declare const storefrontCalendarDaySchema: z.ZodObject<{
     minNights: z.ZodNullable<z.ZodNumber>;
     closedToArrival: z.ZodOptional<z.ZodBoolean>;
     closedToDeparture: z.ZodOptional<z.ZodBoolean>;
-    status: z.ZodType<"blocked" | "available" | "booked" | (string & {}), unknown, z.core.$ZodTypeInternals<"blocked" | "available" | "booked" | (string & {}), unknown>>;
+    status: z.ZodType<"available" | "blocked" | "booked" | (string & {}), unknown, z.core.$ZodTypeInternals<"available" | "blocked" | "booked" | (string & {}), unknown>>;
 }, z.core.$strip>;
 type StorefrontCalendarDay = z.infer<typeof storefrontCalendarDaySchema>;
 declare const storefrontCalendarSchema: z.ZodObject<{
@@ -31,17 +31,17 @@ declare const storefrontCalendarSchema: z.ZodObject<{
         minNights: z.ZodNullable<z.ZodNumber>;
         closedToArrival: z.ZodOptional<z.ZodBoolean>;
         closedToDeparture: z.ZodOptional<z.ZodBoolean>;
-        status: z.ZodType<"blocked" | "available" | "booked" | (string & {}), unknown, z.core.$ZodTypeInternals<"blocked" | "available" | "booked" | (string & {}), unknown>>;
+        status: z.ZodType<"available" | "blocked" | "booked" | (string & {}), unknown, z.core.$ZodTypeInternals<"available" | "blocked" | "booked" | (string & {}), unknown>>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
 type StorefrontCalendar = z.infer<typeof storefrontCalendarSchema>;
 declare const storefrontUnavailableReasonSchema: z.ZodEnum<{
-    not_bookable: "not_bookable";
-    dates_unavailable: "dates_unavailable";
-    min_nights: "min_nights";
-    max_guests: "max_guests";
     closed_to_arrival: "closed_to_arrival";
     closed_to_departure: "closed_to_departure";
+    dates_unavailable: "dates_unavailable";
+    max_guests: "max_guests";
+    min_nights: "min_nights";
+    not_bookable: "not_bookable";
 }>;
 type StorefrontUnavailableReason = z.infer<typeof storefrontUnavailableReasonSchema>;
 declare const storefrontAvailabilitySchema: z.ZodObject<{
@@ -51,7 +51,7 @@ declare const storefrontAvailabilitySchema: z.ZodObject<{
     guests: z.ZodNumber;
     bookable: z.ZodBoolean;
     available: z.ZodBoolean;
-    reason: z.ZodNullable<z.ZodType<(string & {}) | "not_bookable" | "dates_unavailable" | "min_nights" | "max_guests" | "closed_to_arrival" | "closed_to_departure", unknown, z.core.$ZodTypeInternals<(string & {}) | "not_bookable" | "dates_unavailable" | "min_nights" | "max_guests" | "closed_to_arrival" | "closed_to_departure", unknown>>>;
+    reason: z.ZodNullable<z.ZodType<"closed_to_arrival" | "closed_to_departure" | "dates_unavailable" | "max_guests" | "min_nights" | "not_bookable" | (string & {}), unknown, z.core.$ZodTypeInternals<"closed_to_arrival" | "closed_to_departure" | "dates_unavailable" | "max_guests" | "min_nights" | "not_bookable" | (string & {}), unknown>>>;
     minNights: z.ZodNullable<z.ZodNumber>;
     maxGuests: z.ZodNullable<z.ZodNumber>;
 }, z.core.$strip>;
@@ -69,7 +69,7 @@ type StorefrontUnitUnavailableReason = (typeof STOREFRONT_UNIT_UNAVAILABLE_REASO
 declare const storefrontUnitAvailabilitySchema: z.ZodObject<{
     listingId: z.ZodUUID;
     available: z.ZodBoolean;
-    reason: z.ZodNullable<z.ZodType<(string & {}) | "not_bookable" | "dates_unavailable" | "min_nights" | "max_guests" | "closed_to_arrival" | "closed_to_departure" | "calendar_unavailable", unknown, z.core.$ZodTypeInternals<(string & {}) | "not_bookable" | "dates_unavailable" | "min_nights" | "max_guests" | "closed_to_arrival" | "closed_to_departure" | "calendar_unavailable", unknown>>>;
+    reason: z.ZodNullable<z.ZodType<"calendar_unavailable" | "closed_to_arrival" | "closed_to_departure" | "dates_unavailable" | "max_guests" | "min_nights" | "not_bookable" | (string & {}), unknown, z.core.$ZodTypeInternals<"calendar_unavailable" | "closed_to_arrival" | "closed_to_departure" | "dates_unavailable" | "max_guests" | "min_nights" | "not_bookable" | (string & {}), unknown>>>;
     totalMinor: z.ZodNullable<z.ZodNumber>;
     currency: z.ZodNullable<z.ZodString>;
     nights: z.ZodNumber;

package/dist/{availability-Dh0yLSkj.d.ts → availability.d-Cla9GuGc.d.ts}

@@ -18,7 +18,7 @@ declare const storefrontCalendarDaySchema: z.ZodObject<{
     minNights: z.ZodNullable<z.ZodNumber>;
     closedToArrival: z.ZodOptional<z.ZodBoolean>;
     closedToDeparture: z.ZodOptional<z.ZodBoolean>;
-    status: z.ZodType<"blocked" | "available" | "booked" | (string & {}), unknown, z.core.$ZodTypeInternals<"blocked" | "available" | "booked" | (string & {}), unknown>>;
+    status: z.ZodType<"available" | "blocked" | "booked" | (string & {}), unknown, z.core.$ZodTypeInternals<"available" | "blocked" | "booked" | (string & {}), unknown>>;
 }, z.core.$strip>;
 type StorefrontCalendarDay = z.infer<typeof storefrontCalendarDaySchema>;
 declare const storefrontCalendarSchema: z.ZodObject<{
@@ -31,17 +31,17 @@ declare const storefrontCalendarSchema: z.ZodObject<{
         minNights: z.ZodNullable<z.ZodNumber>;
         closedToArrival: z.ZodOptional<z.ZodBoolean>;
         closedToDeparture: z.ZodOptional<z.ZodBoolean>;
-        status: z.ZodType<"blocked" | "available" | "booked" | (string & {}), unknown, z.core.$ZodTypeInternals<"blocked" | "available" | "booked" | (string & {}), unknown>>;
+        status: z.ZodType<"available" | "blocked" | "booked" | (string & {}), unknown, z.core.$ZodTypeInternals<"available" | "blocked" | "booked" | (string & {}), unknown>>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
 type StorefrontCalendar = z.infer<typeof storefrontCalendarSchema>;
 declare const storefrontUnavailableReasonSchema: z.ZodEnum<{
-    not_bookable: "not_bookable";
-    dates_unavailable: "dates_unavailable";
-    min_nights: "min_nights";
-    max_guests: "max_guests";
     closed_to_arrival: "closed_to_arrival";
     closed_to_departure: "closed_to_departure";
+    dates_unavailable: "dates_unavailable";
+    max_guests: "max_guests";
+    min_nights: "min_nights";
+    not_bookable: "not_bookable";
 }>;
 type StorefrontUnavailableReason = z.infer<typeof storefrontUnavailableReasonSchema>;
 declare const storefrontAvailabilitySchema: z.ZodObject<{
@@ -51,7 +51,7 @@ declare const storefrontAvailabilitySchema: z.ZodObject<{
     guests: z.ZodNumber;
     bookable: z.ZodBoolean;
     available: z.ZodBoolean;
-    reason: z.ZodNullable<z.ZodType<(string & {}) | "not_bookable" | "dates_unavailable" | "min_nights" | "max_guests" | "closed_to_arrival" | "closed_to_departure", unknown, z.core.$ZodTypeInternals<(string & {}) | "not_bookable" | "dates_unavailable" | "min_nights" | "max_guests" | "closed_to_arrival" | "closed_to_departure", unknown>>>;
+    reason: z.ZodNullable<z.ZodType<"closed_to_arrival" | "closed_to_departure" | "dates_unavailable" | "max_guests" | "min_nights" | "not_bookable" | (string & {}), unknown, z.core.$ZodTypeInternals<"closed_to_arrival" | "closed_to_departure" | "dates_unavailable" | "max_guests" | "min_nights" | "not_bookable" | (string & {}), unknown>>>;
     minNights: z.ZodNullable<z.ZodNumber>;
     maxGuests: z.ZodNullable<z.ZodNumber>;
 }, z.core.$strip>;
@@ -69,7 +69,7 @@ type StorefrontUnitUnavailableReason = (typeof STOREFRONT_UNIT_UNAVAILABLE_REASO
 declare const storefrontUnitAvailabilitySchema: z.ZodObject<{
     listingId: z.ZodUUID;
     available: z.ZodBoolean;
-    reason: z.ZodNullable<z.ZodType<(string & {}) | "not_bookable" | "dates_unavailable" | "min_nights" | "max_guests" | "closed_to_arrival" | "closed_to_departure" | "calendar_unavailable", unknown, z.core.$ZodTypeInternals<(string & {}) | "not_bookable" | "dates_unavailable" | "min_nights" | "max_guests" | "closed_to_arrival" | "closed_to_departure" | "calendar_unavailable", unknown>>>;
+    reason: z.ZodNullable<z.ZodType<"calendar_unavailable" | "closed_to_arrival" | "closed_to_departure" | "dates_unavailable" | "max_guests" | "min_nights" | "not_bookable" | (string & {}), unknown, z.core.$ZodTypeInternals<"calendar_unavailable" | "closed_to_arrival" | "closed_to_departure" | "dates_unavailable" | "max_guests" | "min_nights" | "not_bookable" | (string & {}), unknown>>>;
     totalMinor: z.ZodNullable<z.ZodNumber>;
     currency: z.ZodNullable<z.ZodString>;
     nights: z.ZodNumber;

package/dist/checkout.d.cts

@@ -1,7 +1,18 @@
 interface LoadCheckoutOptions {
+    /** The checkout bundle's major version. */
     major?: 1;
+    /**
+     * The storefront host that serves the bundle. Default: the page's own origin (SuiteOp-hosted
+     * sites). A self-hosted site passes its SuiteOp storefront host, e.g. `https://<site>.suiteop.site`.
+     */
     origin?: string;
 }
+/**
+ * Loads the `<suiteop-checkout>` element: reads the storefront host's manifest, injects the
+ * bundle's content-hashed script with its Subresource Integrity hash, and resolves once the
+ * element is defined. Idempotent per origin + major; a no-op outside a browser. Rejects with a
+ * `StorefrontError` whose code is `checkout_unavailable`.
+ */
 declare function loadCheckout(options?: LoadCheckoutOptions): Promise<void>;
 
 export { type LoadCheckoutOptions, loadCheckout };

package/dist/checkout.d.ts

@@ -1,7 +1,18 @@
 interface LoadCheckoutOptions {
+    /** The checkout bundle's major version. */
     major?: 1;
+    /**
+     * The storefront host that serves the bundle. Default: the page's own origin (SuiteOp-hosted
+     * sites). A self-hosted site passes its SuiteOp storefront host, e.g. `https://<site>.suiteop.site`.
+     */
     origin?: string;
 }
+/**
+ * Loads the `<suiteop-checkout>` element: reads the storefront host's manifest, injects the
+ * bundle's content-hashed script with its Subresource Integrity hash, and resolves once the
+ * element is defined. Idempotent per origin + major; a no-op outside a browser. Rejects with a
+ * `StorefrontError` whose code is `checkout_unavailable`.
+ */
 declare function loadCheckout(options?: LoadCheckoutOptions): Promise<void>;
 
 export { type LoadCheckoutOptions, loadCheckout };

package/dist/{chunk-IUNIQSFB.js → chunk-3B6ZYRYF.js}

@@ -1,4 +1,4 @@
-import { storefrontContentRefSchema, storefrontImageSchema } from './chunk-5TUJX6GY.js';
+import { storefrontContentRefSchema, storefrontImageSchema } from './chunk-XOCFEVP4.js';
 import { StorefrontError } from './chunk-W5K7IDYN.js';
 import { z } from 'zod';