@byline/core 1.11.1 → 1.12.0

package/dist/@types/admin-types.d.ts

@@ -179,23 +179,6 @@ export interface CollectionAdminConfig<T = any> {
     slug: string;
     /** Group name for organising collections in the admin sidebar. */
     group?: string;
-    /**
-     * When true, documents in this collection carry a fractional-index
-     * `order_key` and the list view sorts by it ascending by default, with
-     * drag-to-reorder enabled in the admin UI.
-     *
-     * Storage: `byline_documents.order_key` — admin metadata, never per-version
-     * and never EAV. Reordering writes the single column and does NOT mint a
-     * new document version.
-     *
-     * Backfill: existing rows in newly-`orderable` collections start with
-     * `order_key = NULL`. They sort to the bottom (NULLS LAST) until the
-     * editor drags them into position.
-     *
-     * Orthogonal to `hasMany` array order. Use this for top-level order
-     * inside a collection (bios, team members, FAQ items, sections).
-     */
-    orderable?: boolean;
     /** Column definitions for the collection list view. */
     columns?: ColumnDefinition<T>[];
     /**

package/dist/@types/collection-types.d.ts

@@ -578,8 +578,8 @@ export interface AfterReadContext {
  *   - `collectionPath` — the collection being queried (useful when the
  *     same hook function is reused across collections).
  *
- * See `docs/AUTHN-AUTHZ.md` for the strategic rationale and
- * `docs/ACCESS-CONTROL-RECIPES.md` for worked examples.
+ * See `docs/AUTHN-AUTHZ.md` for the strategic rationale; the Quick
+ * Reference there carries six worked recipes.
  */
 export interface BeforeReadContext {
     collectionPath: string;
@@ -655,8 +655,8 @@ export interface CollectionHooks {
      * that the query layer ANDs onto the caller's `where` to enforce
      * read-side row scoping (multi-tenant, owner-only-drafts, soft-delete
      * hide, etc). Returning `void` applies no scoping. Multiple functions
-     * combine with implicit AND. See
-     * `docs/ACCESS-CONTROL-RECIPES.md`.
+     * combine with implicit AND. See `docs/AUTHN-AUTHZ.md` (Read-side
+     * scoping + Quick Reference recipes).
      */
     beforeRead?: BeforeReadHookSlot;
     /**
@@ -725,6 +725,28 @@ export interface CollectionDefinition {
      * on every landing-page load, so opt in deliberately.
      */
     showStats?: boolean;
+    /**
+     * When `true`, documents in this collection carry a fractional-index
+     * `order_key` and the list view sorts by it ascending by default, with
+     * drag-to-reorder enabled in the admin UI.
+     *
+     * Storage: `byline_documents.order_key` — system metadata, never per-version
+     * and never EAV. Reordering writes the single column and does NOT mint a
+     * new document version.
+     *
+     * Backfill: existing rows in newly-`orderable` collections start with
+     * `order_key = NULL`. They sort to the bottom (NULLS LAST) until the
+     * editor drags them into position.
+     *
+     * Lives on the schema (not admin config) because it has structural
+     * consequences across layers — `document-lifecycle` appends a key on
+     * create, the reorder server fn gates on it, and the `@byline/client`
+     * SDK can default-sort on it without crossing into presentation config.
+     *
+     * Orthogonal to `hasMany` array order. Use this for top-level order
+     * inside a collection (bios, team members, FAQ items, sections).
+     */
+    orderable?: boolean;
     /**
      * Optional explicit version pin. When omitted, the startup bootstrap
      * auto-increments the collection's stored version any time the schema

package/dist/@types/db-types.d.ts

@@ -231,7 +231,7 @@ export interface IDocumentCommands {
          * Only set on the initial create (when `documentId` is undefined) for
          * collections with `orderable: true`. Ignored on subsequent versions of
          * an existing document — order is admin metadata on the logical document,
-         * not per-version content. See docs/ORDERABLE.md.
+         * not per-version content. See docs/COLLECTIONS.md (Orderable collections).
          */
         orderKey?: string;
     }): Promise<{

package/dist/services/document-lifecycle.js

@@ -7,7 +7,7 @@
  */
 import { isArrayField, isBlocksField, isGroupField, normalizeCollectionHook, } from '../@types/index.js';
 import { assertActorCanPerform } from '../auth/assert-actor-can-perform.js';
-import { getCollectionAdminConfig } from '../config/config.js';
+import { getCollectionDefinition } from '../config/config.js';
 import { ERR_CONFLICT, ERR_INVALID_TRANSITION, ERR_NOT_FOUND, ERR_PATCH_FAILED, ERR_PATH_CONFLICT, ERR_VALIDATION, ErrorCodes, } from '../lib/errors.js';
 import { generateKeyBetween } from '../lib/fractional-index.js';
 import { withLogContext } from '../lib/logger.js';
@@ -31,15 +31,15 @@ async function invokeHook(hook, ctx) {
     }
 }
 /**
- * For collections with `orderable: true` in their admin config, compute an
- * append-at-end fractional-index key for a newly-inserted document.
- * Returns `undefined` when the collection hasn't opted in (or has no admin
- * config registered, e.g. in unit-test environments), so the storage row
+ * For collections with `orderable: true` on their schema definition, compute
+ * an append-at-end fractional-index key for a newly-inserted document.
+ * Returns `undefined` when the collection hasn't opted in (or has no
+ * definition registered, e.g. in unit-test environments), so the storage row
  * gets `order_key = NULL` and the existing "no ordering" behavior holds.
  */
 async function maybeAppendOrderKey(ctx, collectionPath) {
-    const adminConfig = getCollectionAdminConfig(collectionPath);
-    if (adminConfig?.orderable !== true)
+    const definition = getCollectionDefinition(collectionPath);
+    if (definition?.orderable !== true)
         return undefined;
     const last = await ctx.db.queries.documents.getLastOrderKey({
         collection_id: ctx.collectionId,

package/package.json

@@ -2,7 +2,7 @@
   "name": "@byline/core",
   "private": false,
   "license": "MPL-2.0",
-  "version": "1.11.1",
+  "version": "1.12.0",
   "engines": {
     "node": ">=20.9.0"
   },
@@ -79,7 +79,7 @@
     "sharp": "^0.34.5",
     "uuid": "^14.0.0",
     "zod": "^4.4.3",
-    "@byline/auth": "1.11.1"
+    "@byline/auth": "1.12.0"
   },
   "devDependencies": {
     "@biomejs/biome": "2.4.15",
@@ -98,7 +98,7 @@
   "scripts": {
     "dev": "chokidar 'src/**/*' -c 'npm-run-all build'",
     "build": "tsc -p tsconfig.json && tsc-alias",
-    "clean": "rimraf node_modules dist build .turbo",
+    "clean": "node scripts/clean.js node_modules dist build .turbo",
     "lint": "biome check --write --unsafe --diagnostic-level=error",
     "skip": "tsx ./scripts/task-watch.js",
     "test": "vitest run --mode=node",