@byline/host-tanstack-start 4.16.0 → 4.18.0

package/dist/server-fns/singleton-document-read.js

@@ -0,0 +1,10 @@
+import { getAdminBylineClient } from "@byline/client/server";
+import { getCollectionDefinition } from "@byline/core";
+import { resolveAdminDocumentRead } from "./admin-document-presentation.js";
+import { serialise } from "./serialise.js";
+async function readSingletonDocument(data) {
+    const handle = getAdminBylineClient().singleton(data.singleton);
+    const { options } = resolveAdminDocumentRead(getCollectionDefinition(data.singleton), data);
+    return serialise(await handle.get(options));
+}
+export { readSingletonDocument };

package/dist/server-fns/singletons/cancel-scheduled-publish.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+export declare const cancelSingletonScheduledPublish: import("@tanstack/react-start").RequiredFetcher<undefined, (input: {
+    singleton: string;
+}) => {
+    singleton: string;
+}, Promise<import("@byline/client").DocumentPublishScheduleInfo | null>>;

package/dist/server-fns/singletons/cancel-scheduled-publish.js

@@ -0,0 +1,7 @@
+import { createServerFn } from "@tanstack/react-start";
+import { getAdminBylineClient } from "@byline/client/server";
+import { serialise } from "../serialise.js";
+const cancelSingletonScheduledPublish = createServerFn({
+    method: 'POST'
+}).validator((input)=>input).handler(async ({ data })=>serialise(await getAdminBylineClient().singleton(data.singleton).cancelScheduledPublish()));
+export { cancelSingletonScheduledPublish };

package/dist/server-fns/singletons/change-status.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+export declare const changeSingletonStatus: import("@tanstack/react-start").RequiredFetcher<undefined, (input: {
+    singleton: string;
+    status: string;
+}) => {
+    singleton: string;
+    status: string;
+}, Promise<import("@byline/core").ChangeStatusResult>>;

package/dist/server-fns/singletons/change-status.js

@@ -0,0 +1,7 @@
+import { createServerFn } from "@tanstack/react-start";
+import { getAdminBylineClient } from "@byline/client/server";
+import { serialise } from "../serialise.js";
+const changeSingletonStatus = createServerFn({
+    method: 'POST'
+}).validator((input)=>input).handler(async ({ data })=>serialise(await getAdminBylineClient().singleton(data.singleton).changeStatus(data.status)));
+export { changeSingletonStatus };

package/dist/server-fns/singletons/confirm-scheduled-publish.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+export declare const confirmSingletonScheduledPublish: import("@tanstack/react-start").RequiredFetcher<undefined, (input: {
+    singleton: string;
+    expectedVersionId: string;
+}) => {
+    singleton: string;
+    expectedVersionId: string;
+}, Promise<import("@byline/client").DocumentPublishScheduleInfo>>;

package/dist/server-fns/singletons/confirm-scheduled-publish.js

@@ -0,0 +1,9 @@
+import { createServerFn } from "@tanstack/react-start";
+import { getAdminBylineClient } from "@byline/client/server";
+import { serialise } from "../serialise.js";
+const confirmSingletonScheduledPublish = createServerFn({
+    method: 'POST'
+}).validator((input)=>input).handler(async ({ data })=>serialise(await getAdminBylineClient().singleton(data.singleton).confirmScheduledPublish({
+        expectedVersionId: data.expectedVersionId
+    })));
+export { confirmSingletonScheduledPublish };

package/dist/server-fns/singletons/copy-to-locale.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+export declare const copySingletonToLocale: import("@tanstack/react-start").RequiredFetcher<undefined, (input: {
+    singleton: string;
+    sourceLocale: string;
+    targetLocale: string;
+    overwrite?: boolean;
+}) => {
+    singleton: string;
+    sourceLocale: string;
+    targetLocale: string;
+    overwrite?: boolean;
+}, Promise<import("@byline/core").SingletonSaveResult>>;

package/dist/server-fns/singletons/copy-to-locale.js

@@ -0,0 +1,11 @@
+import { createServerFn } from "@tanstack/react-start";
+import { getAdminBylineClient } from "@byline/client/server";
+import { serialise } from "../serialise.js";
+const copySingletonToLocale = createServerFn({
+    method: 'POST'
+}).validator((input)=>input).handler(async ({ data })=>serialise(await getAdminBylineClient().singleton(data.singleton).copyToLocale({
+        sourceLocale: data.sourceLocale,
+        targetLocale: data.targetLocale,
+        overwrite: data.overwrite
+    })));
+export { copySingletonToLocale };

package/dist/server-fns/singletons/find-by-version.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+export declare const findSingletonByVersion: import("@tanstack/react-start").RequiredFetcher<undefined, (input: {
+    singleton: string;
+    versionId: string;
+    locale?: string;
+}) => {
+    singleton: string;
+    versionId: string;
+    locale?: string;
+}, Promise<import("@byline/client").ClientDocument<Record<string, any>> | null>>;

package/dist/server-fns/singletons/find-by-version.js

@@ -0,0 +1,9 @@
+import { createServerFn } from "@tanstack/react-start";
+import { getAdminBylineClient } from "@byline/client/server";
+import { serialise } from "../serialise.js";
+const findSingletonByVersion = createServerFn({
+    method: 'GET'
+}).validator((input)=>input).handler(async ({ data })=>serialise(await getAdminBylineClient().singleton(data.singleton).findByVersion(data.versionId, {
+        locale: data.locale ?? 'all'
+    })));
+export { findSingletonByVersion };

package/dist/server-fns/singletons/get-scheduled-publish.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+export declare const getSingletonScheduledPublish: import("@tanstack/react-start").RequiredFetcher<undefined, (input: {
+    singleton: string;
+}) => {
+    singleton: string;
+}, Promise<import("@byline/client").DocumentPublishScheduleInfo | null>>;

package/dist/server-fns/singletons/get-scheduled-publish.js

@@ -0,0 +1,7 @@
+import { createServerFn } from "@tanstack/react-start";
+import { getAdminBylineClient } from "@byline/client/server";
+import { serialise } from "../serialise.js";
+const getSingletonScheduledPublish = createServerFn({
+    method: 'GET'
+}).validator((input)=>input).handler(async ({ data })=>serialise(await getAdminBylineClient().singleton(data.singleton).getScheduledPublish()));
+export { getSingletonScheduledPublish };

package/dist/server-fns/singletons/get.d.ts

@@ -0,0 +1,24 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+export interface GetSingletonInput {
+    singleton: string;
+    locale?: string;
+    depth?: number;
+    populateRelations?: boolean;
+}
+/**
+ * Task 4 singleton-loader contract:
+ *
+ * - this shared host layer owns lenient reads, raw missing-locale values,
+ *   relation-summary population, transport serialization, and preservation of
+ *   restore warnings and locale metadata;
+ * - the route loader composes published-version metadata plus scheduled-
+ *   publication enablement, capability, and schedule aliases because those
+ *   require host-only database and actor context beyond the singleton handle.
+ */
+export declare const getSingleton: import("@tanstack/react-start").RequiredFetcher<undefined, (input: GetSingletonInput) => GetSingletonInput, Promise<import("@byline/client").SingletonDocument<Record<string, any>> | null>>;

package/dist/server-fns/singletons/get.js

@@ -0,0 +1,6 @@
+import { createServerFn } from "@tanstack/react-start";
+import { readSingletonDocument } from "../singleton-document-read.js";
+const getSingleton = createServerFn({
+    method: 'GET'
+}).validator((input)=>input).handler(async ({ data })=>readSingletonDocument(data));
+export { getSingleton };

package/dist/server-fns/singletons/history.d.ts

@@ -0,0 +1,31 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+import { type ActorLabelMap } from '../actors.js';
+export interface SingletonHistorySearchParams {
+    page?: number;
+    page_size?: number;
+    order?: string;
+    desc?: boolean;
+    locale?: string;
+}
+export declare const getSingletonHistory: import("@tanstack/react-start").RequiredFetcher<undefined, (input: {
+    singleton: string;
+    params?: SingletonHistorySearchParams;
+}) => {
+    singleton: string;
+    params?: SingletonHistorySearchParams;
+}, Promise<{
+    docs: import("@byline/client").ClientDocument<Record<string, any>>[];
+    meta: {
+        total: number;
+        page: number;
+        pageSize: number;
+        totalPages: number;
+    };
+    actors: ActorLabelMap;
+}>>;

package/dist/server-fns/singletons/history.js

@@ -0,0 +1,22 @@
+import { createServerFn } from "@tanstack/react-start";
+import { getAdminBylineClient } from "@byline/client/server";
+import { resolveActorLabels } from "../actors.js";
+import { serialise } from "../serialise.js";
+const getSingletonHistory = createServerFn({
+    method: 'GET'
+}).validator((input)=>input).handler(async ({ data })=>{
+    const params = data.params ?? {};
+    const result = await getAdminBylineClient().singleton(data.singleton).history({
+        locale: params.locale ?? 'en',
+        page: params.page,
+        pageSize: params.page_size,
+        order: params.order,
+        desc: params.desc
+    });
+    const actors = await resolveActorLabels(result.docs.map((item)=>item.createdBy));
+    return {
+        ...serialise(result),
+        actors
+    };
+});
+export { getSingletonHistory };

package/dist/server-fns/singletons/index.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+export * from './cancel-scheduled-publish.js';
+export * from './change-status.js';
+export * from './confirm-scheduled-publish.js';
+export * from './copy-to-locale.js';
+export * from './find-by-version.js';
+export * from './get.js';
+export * from './get-scheduled-publish.js';
+export * from './history.js';
+export * from './restore-version.js';
+export * from './schedule-publish.js';
+export * from './unpublish.js';
+export * from './update.js';

package/dist/server-fns/singletons/index.js

@@ -0,0 +1,12 @@
+export * from "./cancel-scheduled-publish.js";
+export * from "./change-status.js";
+export * from "./confirm-scheduled-publish.js";
+export * from "./copy-to-locale.js";
+export * from "./find-by-version.js";
+export * from "./get.js";
+export * from "./get-scheduled-publish.js";
+export * from "./history.js";
+export * from "./restore-version.js";
+export * from "./schedule-publish.js";
+export * from "./unpublish.js";
+export * from "./update.js";

package/dist/server-fns/singletons/restore-version.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+export declare const restoreSingletonVersion: import("@tanstack/react-start").RequiredFetcher<undefined, (input: {
+    singleton: string;
+    versionId: string;
+}) => {
+    singleton: string;
+    versionId: string;
+}, Promise<import("@byline/core").SingletonSaveResult>>;

package/dist/server-fns/singletons/restore-version.js

@@ -0,0 +1,7 @@
+import { createServerFn } from "@tanstack/react-start";
+import { getAdminBylineClient } from "@byline/client/server";
+import { serialise } from "../serialise.js";
+const restoreSingletonVersion = createServerFn({
+    method: 'POST'
+}).validator((input)=>input).handler(async ({ data })=>serialise(await getAdminBylineClient().singleton(data.singleton).restoreVersion(data.versionId)));
+export { restoreSingletonVersion };

package/dist/server-fns/singletons/schedule-publish.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+export declare const scheduleSingletonPublish: import("@tanstack/react-start").RequiredFetcher<undefined, (input: {
+    singleton: string;
+    publishAt: string;
+    expectedVersionId: string;
+}) => {
+    singleton: string;
+    publishAt: string;
+    expectedVersionId: string;
+}, Promise<import("@byline/client").DocumentPublishScheduleInfo>>;

package/dist/server-fns/singletons/schedule-publish.js

@@ -0,0 +1,10 @@
+import { createServerFn } from "@tanstack/react-start";
+import { getAdminBylineClient } from "@byline/client/server";
+import { serialise } from "../serialise.js";
+const scheduleSingletonPublish = createServerFn({
+    method: 'POST'
+}).validator((input)=>input).handler(async ({ data })=>serialise(await getAdminBylineClient().singleton(data.singleton).schedulePublish({
+        publishAt: data.publishAt,
+        expectedVersionId: data.expectedVersionId
+    })));
+export { scheduleSingletonPublish };

package/dist/server-fns/singletons/unpublish.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+export declare const unpublishSingleton: import("@tanstack/react-start").RequiredFetcher<undefined, (input: {
+    singleton: string;
+}) => {
+    singleton: string;
+}, Promise<import("@byline/core").UnpublishResult>>;

package/dist/server-fns/singletons/unpublish.js

@@ -0,0 +1,7 @@
+import { createServerFn } from "@tanstack/react-start";
+import { getAdminBylineClient } from "@byline/client/server";
+import { serialise } from "../serialise.js";
+const unpublishSingleton = createServerFn({
+    method: 'POST'
+}).validator((input)=>input).handler(async ({ data })=>serialise(await getAdminBylineClient().singleton(data.singleton).unpublish()));
+export { unpublishSingleton };

package/dist/server-fns/singletons/update.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+export interface UpdateSingletonInput {
+    singleton: string;
+    data: Record<string, any>;
+    locale?: string;
+    expectedVersionId?: string;
+}
+export declare const updateSingleton: import("@tanstack/react-start").RequiredFetcher<undefined, (input: UpdateSingletonInput) => UpdateSingletonInput, Promise<import("@byline/core").SingletonSaveResult>>;

package/dist/server-fns/singletons/update.js

@@ -0,0 +1,14 @@
+import { createServerFn } from "@tanstack/react-start";
+import { getAdminBylineClient } from "@byline/client/server";
+import { serialise } from "../serialise.js";
+const updateSingleton = createServerFn({
+    method: 'POST'
+}).validator((input)=>input).handler(async ({ data })=>{
+    const { singleton, data: fields, locale, expectedVersionId } = data;
+    const result = await getAdminBylineClient().singleton(singleton).update(fields, {
+        locale,
+        expectedVersionId
+    });
+    return serialise(result);
+});
+export { updateSingleton };

package/dist/vitest-jsdom.test.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+export {};

package/package.json

@@ -3,7 +3,7 @@
   "private": false,
   "type": "module",
   "license": "MPL-2.0",
-  "version": "4.16.0",
+  "version": "4.18.0",
   "engines": {
     "node": ">=20.9.0"
   },
@@ -77,6 +77,10 @@
       "types": "./dist/server-fns/collections/index.d.ts",
       "import": "./dist/server-fns/collections/index.js"
     },
+    "./server-fns/singletons": {
+      "types": "./dist/server-fns/singletons/index.d.ts",
+      "import": "./dist/server-fns/singletons/index.js"
+    },
     "./i18n": {
       "types": "./dist/i18n/index.d.ts",
       "import": "./dist/i18n/index.js"
@@ -121,15 +125,15 @@
     "react-json-view-lite": "^2.5.0",
     "react-swipeable": "^7.0.2",
     "zod": "^4.4.3",
-    "@byline/admin": "4.16.0",
-    "@byline/analytics-agent": "4.16.0",
-    "@byline/ai": "4.16.0",
-    "@byline/analytics": "4.16.0",
-    "@byline/client": "4.16.0",
-    "@byline/core": "4.16.0",
-    "@byline/auth": "4.16.0",
-    "@byline/i18n": "4.16.0",
-    "@byline/ui": "4.16.0"
+    "@byline/admin": "4.18.0",
+    "@byline/ai": "4.18.0",
+    "@byline/analytics-agent": "4.18.0",
+    "@byline/client": "4.18.0",
+    "@byline/auth": "4.18.0",
+    "@byline/analytics": "4.18.0",
+    "@byline/i18n": "4.18.0",
+    "@byline/core": "4.18.0",
+    "@byline/ui": "4.18.0"
   },
   "peerDependencies": {
     "@tanstack/react-router": "^1.167.0",
@@ -139,19 +143,19 @@
     "vite": "^8.0.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "2.5.9",
+    "@biomejs/biome": "2.5.10",
     "@rsbuild/plugin-react": "^2.1.0",
     "@rslib/core": "^0.23.2",
-    "@tanstack/react-router": "^1.170.31",
-    "@tanstack/react-start": "^1.168.48",
-    "@types/node": "^26.2.0",
+    "@tanstack/react-router": "^1.170.32",
+    "@tanstack/react-start": "^1.168.49",
+    "@types/node": "^26.4.0",
     "@types/react": "19.2.18",
-    "@types/react-dom": "19.2.4",
-    "lightningcss": "^1.33.0",
+    "@types/react-dom": "19.2.5",
+    "@vitejs/plugin-react": "^6.1.0",
+    "jsdom": "^30.0.1",
     "npm-run-all": "^4.1.5",
     "react": "^19.2.8",
     "react-dom": "^19.2.8",
-    "rimraf": "^6.1.3",
     "typescript": "^7.0.2",
     "typescript-plugin-css-modules": "^5.2.0",
     "vite": "^8.2.2",
@@ -173,6 +177,8 @@
     "typecheck": "tsc --noEmit",
     "clean": "node scripts/clean.js node_modules dist build types .turbo",
     "lint": "biome check --write --unsafe --diagnostic-level=error",
-    "test": "vitest run --mode=node"
+    "test": "vitest run --mode=jsdom && vitest run --mode=node",
+    "test:jsdom": "vitest run --mode=jsdom",
+    "test:node": "vitest run --mode=node"
   }
 }

package/src/admin-shell/chrome/admin-menu-drawer.tsx

@@ -14,13 +14,13 @@ import { ADMIN_PERMISSIONS_ABILITIES } from '@byline/admin/admin-permissions'
 import { ADMIN_ROLES_ABILITIES } from '@byline/admin/admin-roles'
 import { ADMIN_USERS_ABILITIES } from '@byline/admin/admin-users'
 import { ANALYTICS_ABILITIES } from '@byline/admin/analytics'
-import { collectionAbilityKey, getAdminConfig } from '@byline/core'
+import { documentAbilityKey, getAdminConfig } from '@byline/core'
 import { useTranslation } from '@byline/i18n/react'
 import {
   ActivityIcon,
   AnalyticsIcon,
   CalendarIcon,
-  HomeIcon,
+  DashboardIcon,
   RolesIcon,
   SettingsSlidersIcon,
   Tooltip,
@@ -105,8 +105,8 @@ export function AdminMenuDrawer({
     scheduledPublicationEnabled &&
     getAdminConfig().collections.some(
       (collection) =>
-        has(collectionAbilityKey(collection.path, 'changeStatus')) &&
-        has(collectionAbilityKey(collection.path, 'publish'))
+        has(documentAbilityKey(collection, 'changeStatus')) &&
+        has(documentAbilityKey(collection, 'publish'))
     )
   const showAdminSection = canReadUsers || canReadRoles || canReadPermissions || canReadActivity
 
@@ -144,24 +144,24 @@ export function AdminMenuDrawer({
           <MenuItem
             to={getAdminRoutePath()}
             label={t('chrome.menu.dashboard')}
-            icon={<HomeIcon width="20px" height="20px" />}
+            icon={<DashboardIcon width="20px" height="20px" />}
             pathname={pathname}
             compact={compact}
           />
-          {canSeeScheduledPublications && (
+          {canReadAnalytics && (
             <MenuItem
-              to={getAdminRoutePath('scheduled-publications')}
-              label={t('chrome.menu.scheduledPublications')}
-              icon={<CalendarIcon width="18px" height="18px" />}
+              to={getAdminRoutePath('analytics')}
+              label={t('chrome.menu.analytics')}
+              icon={<AnalyticsIcon width="20px" height="20px" />}
               pathname={pathname}
               compact={compact}
             />
           )}
-          {canReadAnalytics && (
+          {canSeeScheduledPublications && (
             <MenuItem
-              to={getAdminRoutePath('analytics')}
-              label={t('chrome.menu.analytics')}
-              icon={<AnalyticsIcon width="20px" height="20px" />}
+              to={getAdminRoutePath('scheduled-publications')}
+              label={t('chrome.menu.scheduledPublications')}
+              icon={<CalendarIcon width="18px" height="18px" />}
               pathname={pathname}
               compact={compact}
             />