@byline/core 4.6.1 → 4.7.0

package/dist/storage/store-manifest.js

@@ -0,0 +1,215 @@
+/**
+ * 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
+ *
+ * The dialect-independent column manifest for the EAV store tables.
+ *
+ * Every adapter's UNION ALL over its `store_*` tables projects into the same
+ * unified row shape (see `UnifiedFieldValue`). Instead of each adapter
+ * hand-maintaining its own list of columns, adapters generate their SELECT
+ * lists from this single manifest — adding a column or a new store table is
+ * a one-line change here rather than N hand-synchronized SQL fragments.
+ *
+ * This module is pure data: no SQL, no drizzle-orm, no pg. Each adapter owns
+ * its own SQL generation (e.g. `@byline/db-postgres`'s `storeSelectList()` +
+ * `pgNullCast()`) consuming this manifest.
+ */
+/** Store table names, keyed by StoreType. Shared naming convention across adapters. */
+export const storeTableNames = {
+    text: 'byline_store_text',
+    numeric: 'byline_store_numeric',
+    boolean: 'byline_store_boolean',
+    datetime: 'byline_store_datetime',
+    json: 'byline_store_json',
+    relation: 'byline_store_relation',
+    file: 'byline_store_file',
+};
+/**
+ * Canonical column order for the unified UNION ALL output.
+ *
+ * The first 7 columns are shared across all store tables (base columns).
+ * The remaining columns are type-specific — each one declares which store
+ * table(s) provide it and what source column to read.
+ */
+export const storeColumnManifest = [
+    // -- Base columns (provided by every store table) -------------------------
+    { name: 'id', nullCast: 'uuid' },
+    { name: 'document_version_id', nullCast: 'uuid' },
+    { name: 'collection_id', nullCast: 'uuid' },
+    // field_type is handled specially — see each adapter's SELECT-list builder.
+    { name: 'field_path', nullCast: 'varchar' },
+    { name: 'field_name', nullCast: 'varchar' },
+    { name: 'locale', nullCast: 'varchar' },
+    { name: 'parent_path', nullCast: 'varchar' },
+    // -- Text -----------------------------------------------------------------
+    {
+        name: 'text_value',
+        nullCast: 'text',
+        sources: { text: 'value' },
+    },
+    // -- Boolean --------------------------------------------------------------
+    {
+        name: 'boolean_value',
+        nullCast: 'boolean',
+        sources: { boolean: 'value' },
+    },
+    // -- JSON -----------------------------------------------------------------
+    {
+        name: 'json_value',
+        nullCast: 'jsonb',
+        sources: { json: 'value' },
+    },
+    // -- DateTime -------------------------------------------------------------
+    {
+        name: 'date_type',
+        nullCast: 'varchar',
+        sources: { datetime: 'date_type' },
+    },
+    {
+        name: 'value_date',
+        nullCast: 'date',
+        sources: { datetime: 'value_date' },
+    },
+    {
+        name: 'value_time',
+        nullCast: 'time',
+        sources: { datetime: 'value_time' },
+    },
+    {
+        name: 'value_timestamp_tz',
+        nullCast: 'timestamp',
+        sources: { datetime: 'value_timestamp_tz' },
+    },
+    // -- File -----------------------------------------------------------------
+    {
+        name: 'file_id',
+        nullCast: 'uuid',
+        sources: { file: 'file_id' },
+    },
+    {
+        name: 'filename',
+        nullCast: 'varchar',
+        sources: { file: 'filename' },
+    },
+    {
+        name: 'original_filename',
+        nullCast: 'varchar',
+        sources: { file: 'original_filename' },
+    },
+    {
+        name: 'mime_type',
+        nullCast: 'varchar',
+        sources: { file: 'mime_type' },
+    },
+    {
+        name: 'file_size',
+        nullCast: 'bigint',
+        sources: { file: 'file_size' },
+    },
+    {
+        name: 'storage_provider',
+        nullCast: 'varchar',
+        sources: { file: 'storage_provider' },
+    },
+    {
+        name: 'storage_path',
+        nullCast: 'text',
+        sources: { file: 'storage_path' },
+    },
+    {
+        name: 'storage_url',
+        nullCast: 'text',
+        sources: { file: 'storage_url' },
+    },
+    {
+        name: 'file_hash',
+        nullCast: 'varchar',
+        sources: { file: 'file_hash' },
+    },
+    {
+        name: 'image_width',
+        nullCast: 'integer',
+        sources: { file: 'image_width' },
+    },
+    {
+        name: 'image_height',
+        nullCast: 'integer',
+        sources: { file: 'image_height' },
+    },
+    {
+        name: 'image_format',
+        nullCast: 'varchar',
+        sources: { file: 'image_format' },
+    },
+    {
+        name: 'processing_status',
+        nullCast: 'varchar',
+        sources: { file: 'processing_status' },
+    },
+    {
+        name: 'thumbnail_generated',
+        nullCast: 'boolean',
+        sources: { file: 'thumbnail_generated' },
+    },
+    {
+        name: 'variants',
+        nullCast: 'jsonb',
+        sources: { file: 'variants' },
+    },
+    // -- Relation -------------------------------------------------------------
+    {
+        name: 'target_document_id',
+        nullCast: 'uuid',
+        sources: { relation: 'target_document_id' },
+    },
+    {
+        name: 'target_collection_id',
+        nullCast: 'uuid',
+        sources: { relation: 'target_collection_id' },
+    },
+    {
+        name: 'relationship_type',
+        nullCast: 'varchar',
+        sources: { relation: 'relationship_type' },
+    },
+    {
+        name: 'cascade_delete',
+        nullCast: 'boolean',
+        sources: { relation: 'cascade_delete' },
+    },
+    // -- JSON extras ----------------------------------------------------------
+    {
+        name: 'json_schema',
+        nullCast: 'varchar',
+        sources: { json: 'json_schema' },
+    },
+    {
+        name: 'object_keys',
+        nullCast: 'text[]',
+        sources: { json: 'object_keys' },
+    },
+    // -- Numeric --------------------------------------------------------------
+    {
+        name: 'number_type',
+        nullCast: 'varchar',
+        sources: { numeric: 'number_type' },
+    },
+    {
+        name: 'value_integer',
+        nullCast: 'integer',
+        sources: { numeric: 'value_integer' },
+    },
+    {
+        name: 'value_decimal',
+        nullCast: 'decimal',
+        sources: { numeric: 'value_decimal' },
+    },
+    {
+        name: 'value_float',
+        nullCast: 'real',
+        sources: { numeric: 'value_float' },
+    },
+];

package/dist/storage/store-manifest.test.node.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/dist/storage/store-manifest.test.node.js

@@ -0,0 +1,128 @@
+/**
+ * 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 { describe, expect, it } from 'vitest';
+import { ALL_STORE_TYPES } from './field-store-map.js';
+import { storeColumnManifest, storeTableNames } from './store-manifest.js';
+/**
+ * Data-level pins for the shared store-column manifest. SQL-generation
+ * behaviour (buildSelectList, NULL casts, field_type literal placement) is
+ * exercised by the Postgres adapter's own test — this file only pins the
+ * dialect-independent manifest data every adapter consumes.
+ */
+describe('store-manifest', () => {
+    it('pins the manifest column count', () => {
+        expect(storeColumnManifest.length).toBe(39);
+    });
+    it('pins the manifest column order', () => {
+        expect(storeColumnManifest.map((col) => col.name)).toEqual([
+            'id',
+            'document_version_id',
+            'collection_id',
+            'field_path',
+            'field_name',
+            'locale',
+            'parent_path',
+            'text_value',
+            'boolean_value',
+            'json_value',
+            'date_type',
+            'value_date',
+            'value_time',
+            'value_timestamp_tz',
+            'file_id',
+            'filename',
+            'original_filename',
+            'mime_type',
+            'file_size',
+            'storage_provider',
+            'storage_path',
+            'storage_url',
+            'file_hash',
+            'image_width',
+            'image_height',
+            'image_format',
+            'processing_status',
+            'thumbnail_generated',
+            'variants',
+            'target_document_id',
+            'target_collection_id',
+            'relationship_type',
+            'cascade_delete',
+            'json_schema',
+            'object_keys',
+            'number_type',
+            'value_integer',
+            'value_decimal',
+            'value_float',
+        ]);
+    });
+    it('has a table name for every StoreType', () => {
+        for (const storeType of ALL_STORE_TYPES) {
+            expect(storeTableNames[storeType], `Missing table name for ${storeType}`).toBeTruthy();
+        }
+    });
+    it('every StoreType has at least one sources entry for its value columns', () => {
+        for (const storeType of ALL_STORE_TYPES) {
+            const owned = storeColumnManifest.filter((col) => col.sources?.[storeType] != null);
+            expect(owned.length, `Expected ${storeType} to own at least one manifest column`).toBeGreaterThan(0);
+        }
+    });
+    it('pins the exact set of columns each StoreType owns', () => {
+        const ownedNames = (storeType) => storeColumnManifest.filter((col) => col.sources?.[storeType] != null).map((col) => col.name);
+        expect(ownedNames('text')).toEqual(['text_value']);
+        expect(ownedNames('boolean')).toEqual(['boolean_value']);
+        expect(ownedNames('json')).toEqual(['json_value', 'json_schema', 'object_keys']);
+        expect(ownedNames('datetime')).toEqual([
+            'date_type',
+            'value_date',
+            'value_time',
+            'value_timestamp_tz',
+        ]);
+        expect(ownedNames('relation')).toEqual([
+            'target_document_id',
+            'target_collection_id',
+            'relationship_type',
+            'cascade_delete',
+        ]);
+        expect(ownedNames('numeric')).toEqual([
+            'number_type',
+            'value_integer',
+            'value_decimal',
+            'value_float',
+        ]);
+        expect(ownedNames('file')).toEqual([
+            'file_id',
+            'filename',
+            'original_filename',
+            'mime_type',
+            'file_size',
+            'storage_provider',
+            'storage_path',
+            'storage_url',
+            'file_hash',
+            'image_width',
+            'image_height',
+            'image_format',
+            'processing_status',
+            'thumbnail_generated',
+            'variants',
+        ]);
+    });
+    it('base columns (no sources) are id, document_version_id, collection_id, field_path, field_name, locale, parent_path', () => {
+        const baseNames = storeColumnManifest.filter((col) => !col.sources).map((col) => col.name);
+        expect(baseNames).toEqual([
+            'id',
+            'document_version_id',
+            'collection_id',
+            'field_path',
+            'field_name',
+            'locale',
+            'parent_path',
+        ]);
+    });
+});

package/package.json

@@ -2,7 +2,7 @@
   "name": "@byline/core",
   "private": false,
   "license": "MPL-2.0",
-  "version": "4.6.1",
+  "version": "4.7.0",
   "engines": {
     "node": ">=20.9.0"
   },
@@ -80,8 +80,9 @@
     "dotenv": "^17.4.2",
     "pino": "^10.3.1",
     "sharp": "^0.35.3",
+    "uuid": "^14.0.1",
     "zod": "^4.4.3",
-    "@byline/auth": "4.6.1"
+    "@byline/auth": "4.7.0"
   },
   "devDependencies": {
     "@biomejs/biome": "2.5.4",