@bagelink/blox 1.15.587 → 1.15.591

package/README.md

@@ -28,39 +28,61 @@ Do not import `@bagelink/vue/dist/style.css` or
 existing projects. Import the same entries in local development and CI so a
 source alias cannot hide a package-export problem.
 
-## Quick Start
+## Production Website Setup
 
 ```typescript
 // main.ts
-import { createApp } from 'vue'
-import { createRouter, createWebHistory } from 'vue-router'
-import { createBlox, ButtonConfig, TextConfig, TitleConfig } from '@bagelink/blox'
+import { createBloxApp } from '@bagelink/blox'
+import { BagelVue } from '@bagelink/vue'
 import '@bagelink/vue/styles/core.css'
 import '@bagelink/blox/style.css'
 
 import App from './App.vue'
-
-const app = createApp(App)
-const router = createRouter({
-	history: createWebHistory(),
-	routes: [
-		// Your app routes
-	],
+import router from './router'
+
+const blocks = import.meta.glob('./components/blocks/*.vue', { eager: true })
+
+createBloxApp({
+	rootComponent: App,
+	router,
+	modules: blocks,
+	websiteName: 'my-site',
+	store: 'my-site',
+	locale: 'en',
+	supportedLocales: ['en'],
+	plugins: [BagelVue],
+	navigation: 'document',
 })
+```
 
-// Create and configure Blox
-const blox = createBlox()
-blox.registerComponents([ButtonConfig, TextConfig, TitleConfig]).registerRoutes(router)
-
-app.use(blox)
-app.use(router)
-app.mount('#app')
+```typescript
+// main.server.ts
+import { createBloxSSREntry } from '@bagelink/blox/ssg'
+import { BagelVue } from '@bagelink/vue'
+import App from './App.vue'
+import { createRouter } from './router'
+
+const blocks = import.meta.glob('./components/blocks/*.vue', { eager: true })
+
+export const { render, prefetchResolve } = createBloxSSREntry({
+	rootComponent: App,
+	createRouter,
+	modules: blocks,
+	websiteName: 'my-site',
+	store: 'my-site',
+	locale: 'en',
+	supportedLocales: ['en'],
+	plugins: [BagelVue],
+})
 ```
 
-That's it! Preview routes are now available at:
+The client hydrates prerendered HTML directly. Components can use normal Vue
+primitives including `Suspense`, `Teleport`, Pinia, and `onServerPrefetch`.
+Use `useData(key, loader)` for data that must be present in static HTML and in
+the hydration payload. Do not install fetch or Axios cache interceptors.
 
-- `/blox/preview/:pageId?` - External preview with editor communication
-- `/blox/render/:pageId?` - Static page rendering
+Blox owns the preview route and one named CMS fallback route. Consumer routers
+should declare app-owned routes and redirects only.
 
 ### With Custom Components
 
@@ -104,7 +126,11 @@ For more examples, see [SETUP_EXAMPLE.md](./SETUP_EXAMPLE.md).
 
 ---
 
-## Alternative Setup (Legacy)
+## Low-level Setup
+
+`createBlox()` remains available for the editor and specialized embedded
+renderers. New production websites should use `createBloxApp()` and
+`createBloxSSREntry()` so client and server assembly cannot drift.
 
 ### 1. Register Base Components
 

package/dist/CmsPageView.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CmsPageView.vue.d.ts","sourceRoot":"","sources":["../src/CmsPageView.vue"],"names":[],"mappings":";AAmkBA,wBAMG"}
+{"version":3,"file":"CmsPageView.vue.d.ts","sourceRoot":"","sources":["../src/CmsPageView.vue"],"names":[],"mappings":";AAqkBA,wBAMG"}

package/dist/{PreviewApp-D208UMZs.js → PreviewApp-BagepqPk.js}

@@ -1,4 +1,4 @@
-import { _ as _sfc_main } from "./PreviewApp.vue_vue_type_style_index_0_lang-l6QisbG-.js";
+import { _ as _sfc_main } from "./PreviewApp.vue_vue_type_style_index_0_lang-Dl3bKQTA.js";
 export {
   _sfc_main as default
 };

package/dist/{PreviewApp-DNMYw1AS.cjs → PreviewApp-HVipxMQ3.cjs}

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const PreviewApp_vue_vue_type_style_index_0_lang = require("./PreviewApp.vue_vue_type_style_index_0_lang-Dm0SmjEr.cjs");
+const PreviewApp_vue_vue_type_style_index_0_lang = require("./PreviewApp.vue_vue_type_style_index_0_lang-C6e-tDzD.cjs");
 exports.default = PreviewApp_vue_vue_type_style_index_0_lang._sfc_main;

package/dist/{PreviewApp.vue_vue_type_style_index_0_lang-Dm0SmjEr.cjs → PreviewApp.vue_vue_type_style_index_0_lang-C6e-tDzD.cjs}

@@ -1,6 +1,6 @@
 "use strict";
 const vue = require("vue");
-const routes = require("./routes-DOcek9fP.cjs");
+const appRuntime = require("./appRuntime-D1Z3fX-G.cjs");
 function sendToEditor(msg) {
   window.parent.postMessage(cloneForPostMessage(msg), "*");
 }
@@ -45,7 +45,7 @@ const PreviewRenderer = vue.defineComponent({
     }
   },
   setup(props) {
-    const registry = vue.inject(routes.BLOX_REGISTRY_KEY, {});
+    const registry = vue.inject(appRuntime.BLOX_REGISTRY_KEY, {});
     const contexts = vue.inject("contexts", { value: {} });
     const localHovered = vue.ref(null);
     function onBlockClick(index) {
@@ -139,7 +139,7 @@ const PreviewRenderer = vue.defineComponent({
               "onMouseleave": onBlockLeave
             },
             [
-              vue.h(definition.component, routes.resolveBlockProps(block, definition.schema.defaults, contexts.value)),
+              vue.h(definition.component, appRuntime.resolveBlockProps(block, definition.schema.defaults, contexts.value)),
               vue.h("div", { style: overlayStyle }),
               (isSelected || isHovered) && vue.h("div", { style: labelStyle }, label)
             ]
@@ -153,8 +153,8 @@ const _hoisted_1 = { class: "blox-preview-root" };
 const _sfc_main = /* @__PURE__ */ vue.defineComponent({
   __name: "PreviewApp",
   setup(__props) {
-    const registry = vue.inject(routes.BLOX_REGISTRY_KEY, {});
-    const { setLocale } = routes.useLocale();
+    const registry = vue.inject(appRuntime.BLOX_REGISTRY_KEY, {});
+    const { setLocale } = appRuntime.useLocale();
     const blocks = vue.ref([]);
     const contexts = vue.ref({});
     const selectedIndex = vue.ref(null);
@@ -162,7 +162,7 @@ const _sfc_main = /* @__PURE__ */ vue.defineComponent({
     const globalBlockTypes = vue.ref([]);
     const runtimeLoading = vue.ref(true);
     vue.provide("contexts", contexts);
-    vue.provide(routes.BLOX_RUNTIME_KEY, {
+    vue.provide(appRuntime.BLOX_RUNTIME_KEY, {
       isPreview: vue.ref(true),
       loading: runtimeLoading
     });

package/dist/{PreviewApp.vue_vue_type_style_index_0_lang-l6QisbG-.js → PreviewApp.vue_vue_type_style_index_0_lang-Dl3bKQTA.js}

@@ -1,5 +1,5 @@
 import { defineComponent, inject, ref, h, provide, onMounted, onUnmounted, openBlock, createElementBlock, createVNode, unref, nextTick } from "vue";
-import { h as BLOX_REGISTRY_KEY, r as resolveBlockProps, u as useLocale, j as BLOX_RUNTIME_KEY } from "./routes-DDiQDksF.js";
+import { f as BLOX_REGISTRY_KEY, r as resolveBlockProps, u as useLocale, g as BLOX_RUNTIME_KEY } from "./appRuntime-B6yWkH3M.js";
 function sendToEditor(msg) {
   window.parent.postMessage(cloneForPostMessage(msg), "*");
 }

package/dist/api/index.d.ts

@@ -1,5 +1,23 @@
 import { CollectionItemsPage, PageResolveRead } from './types';
+import { App, InjectionKey } from 'vue';
 type CollectionResolver = (collection: string, options: ListItemsOptions) => Promise<Array<Record<string, unknown>>>;
+export interface BloxApiOptions {
+    websiteName: string;
+    store: string;
+    origin?: string;
+    collectionResolver?: CollectionResolver | null;
+}
+export interface BloxApiClient {
+    getWebsiteIdSync: () => string | null;
+    getWebsiteId: () => Promise<string>;
+    resolvePath: (path: string, locale: string) => Promise<PageResolveRead>;
+    listItems: <T = Record<string, unknown>>(collection: string, options?: ListItemsOptions) => Promise<CollectionItemsPage & {
+        items: T[];
+    }>;
+    getItemBySlug: <T = Record<string, unknown>>(collection: string, slug: string, locale?: string) => Promise<T | null>;
+    getItemById: <T = Record<string, unknown>>(collection: string, id: string, locale?: string) => Promise<T | null>;
+}
+export declare const BLOX_API_KEY: InjectionKey<BloxApiClient>;
 export declare function configureApi(websiteName: string, store: string): void;
 /**
  * Point blox's datastore client at an absolute API base (SSG/Node, where
@@ -9,6 +27,9 @@ export declare function configureApi(websiteName: string, store: string): void;
 export declare function setApiOrigin(base: string): void;
 /** Use an immutable build-time collection source instead of HTTP during SSR. */
 export declare function setCollectionResolver(resolver: CollectionResolver | null): void;
+export declare function createBloxApi(options: BloxApiOptions): BloxApiClient;
+export declare function provideBloxApi(app: App, options: BloxApiOptions): BloxApiClient;
+export declare function useBloxApi(): BloxApiClient | null;
 /** Synchronously read the resolved website id if already known (SSG-embedded or cached). */
 export declare function getWebsiteIdSync(): string | null;
 export declare function getWebsiteId(): Promise<string>;
@@ -38,5 +59,8 @@ export declare function getItemBySlug<T = Record<string, unknown>>(collection: s
  * Returns null if the item isn't available in that locale (datastore 406/404).
  */
 export declare function getItemById<T = Record<string, unknown>>(collection: string, id: string, locale?: string): Promise<T | null>;
+export declare function listItemsFromActiveApi<T = Record<string, unknown>>(collection: string, options?: ListItemsOptions): Promise<CollectionItemsPage & {
+    items: T[];
+}>;
 export {};
 //# sourceMappingURL=index.d.ts.map

package/dist/api/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,eAAe,EAAoB,MAAM,SAAS,CAAA;AAYrF,KAAK,kBAAkB,GAAG,CACzB,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,gBAAgB,KACrB,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;AAG5C,wBAAgB,YAAY,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAIrE;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAU/C;AAED,gFAAgF;AAChF,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,kBAAkB,GAAG,IAAI,GAAG,IAAI,CAE/E;AAuBD,4FAA4F;AAC5F,wBAAgB,gBAAgB,IAAI,MAAM,GAAG,IAAI,CAOhD;AAED,wBAAsB,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,CAwBpD;AAED,wBAAsB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAMxF;AAED,MAAM,WAAW,gBAAgB;IAChC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;CACd;AAED,wBAAsB,SAAS,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC1D,UAAU,EAAE,MAAM,EAClB,EAAE,MAAM,EAAE,CAAC,EAAE,MAAU,EAAE,KAAW,EAAE,GAAE,gBAAqB,GAC3D,OAAO,CAAC,mBAAmB,GAAG;IAAE,KAAK,EAAE,CAAC,EAAE,CAAA;CAAE,CAAC,CAQ/C;AAED;;;;;;;GAOG;AACH,wBAAsB,aAAa,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9D,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAMnB;AAED;;;;;GAKG;AACH,wBAAsB,WAAW,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC5D,UAAU,EAAE,MAAM,EAClB,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAOnB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,eAAe,EAAoB,MAAM,SAAS,CAAA;AACrF,OAAO,KAAK,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM,KAAK,CAAA;AAa5C,KAAK,kBAAkB,GAAG,CACzB,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,gBAAgB,KACrB,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;AAG5C,MAAM,WAAW,cAAc;IAC9B,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,kBAAkB,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAA;CAC9C;AAED,MAAM,WAAW,aAAa;IAC7B,gBAAgB,EAAE,MAAM,MAAM,GAAG,IAAI,CAAA;IACrC,YAAY,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAA;IACnC,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,eAAe,CAAC,CAAA;IACvE,SAAS,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACtC,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,gBAAgB,KACtB,OAAO,CAAC,mBAAmB,GAAG;QAAE,KAAK,EAAE,CAAC,EAAE,CAAA;KAAE,CAAC,CAAA;IAClD,aAAa,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC1C,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,MAAM,KACX,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAA;IACtB,WAAW,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACxC,UAAU,EAAE,MAAM,EAClB,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,MAAM,KACX,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAA;CACtB;AAED,eAAO,MAAM,YAAY,EAAE,YAAY,CAAC,aAAa,CAAsB,CAAA;AAE3E,wBAAgB,YAAY,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAIrE;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAU/C;AAED,gFAAgF;AAChF,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,kBAAkB,GAAG,IAAI,GAAG,IAAI,CAE/E;AAoBD,wBAAgB,aAAa,CAAC,OAAO,EAAE,cAAc,GAAG,aAAa,CA+FpE;AAED,wBAAgB,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,cAAc,GAAG,aAAa,CAI/E;AAED,wBAAgB,UAAU,IAAI,aAAa,GAAG,IAAI,CAEjD;AAkBD,4FAA4F;AAC5F,wBAAgB,gBAAgB,IAAI,MAAM,GAAG,IAAI,CAOhD;AAED,wBAAsB,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,CAwBpD;AAED,wBAAsB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAMxF;AAED,MAAM,WAAW,gBAAgB;IAChC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;CACd;AAED,wBAAsB,SAAS,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC1D,UAAU,EAAE,MAAM,EAClB,EAAE,MAAM,EAAE,CAAC,EAAE,MAAU,EAAE,KAAW,EAAE,GAAE,gBAAqB,GAC3D,OAAO,CAAC,mBAAmB,GAAG;IAAE,KAAK,EAAE,CAAC,EAAE,CAAA;CAAE,CAAC,CAQ/C;AAED;;;;;;;GAOG;AACH,wBAAsB,aAAa,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9D,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAMnB;AAED;;;;;GAKG;AACH,wBAAsB,WAAW,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC5D,UAAU,EAAE,MAAM,EAClB,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAOnB;AAED,wBAAgB,sBAAsB,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACjE,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,gBAAqB,GAC5B,OAAO,CAAC,mBAAmB,GAAG;IAAE,KAAK,EAAE,CAAC,EAAE,CAAA;CAAE,CAAC,CAE/C"}