@byline/search-postgres 3.15.0 → 3.15.1

package/README.md

@@ -42,7 +42,7 @@ defineServerConfig({
 })
 ```
 
-A collection opts into indexing through its role-based `search` config
+A collection opts into indexing through its `search` config
 (`{ body, facets, filters, zones }`); `initBylineCore()` fails fast if a
 collection opts in but no provider is registered.
 

package/dist/migrate.d.ts

@@ -5,6 +5,19 @@
  *
  * Copyright (c) Infonomic Company Limited
  */
+/**
+ * Migration runner — the driver owns its schema. Applies the numbered
+ * migrations that haven't run yet, recording each in its own
+ * `byline_search_migrations` bookkeeping table (separate from the host's
+ * migration stream). Idempotent and transactional per migration.
+ *
+ * The SQL is embedded (`./migrations-data`) so the runner is **bundle-safe** —
+ * a production server bundle (Nitro / rollup) inlines this package and rewrites
+ * `import.meta.url`, which would break reading the `.sql` files from disk at
+ * runtime. The numbered `.sql` files remain the source of truth and still ship
+ * for the by-hand path (`psql -f migrations/0001_init.sql`) in locked-down
+ * environments; `migrate(pool)` / `autoMigrate` are the convenience paths.
+ */
 import type { Pool } from 'pg';
 export interface MigrateOptions {
     /** Optional sink for progress lines (e.g. the host logger). */

package/dist/migrate.js

@@ -5,19 +5,7 @@
  *
  * Copyright (c) Infonomic Company Limited
  */
-/**
- * Migration runner — the driver owns its schema. Applies the numbered SQL
- * files in `../migrations` that haven't run yet, recording each in its own
- * `byline_search_migrations` bookkeeping table (separate from the host's
- * migration stream). Idempotent and transactional per file.
- *
- * The numbered `.sql` files are the source of truth: ops can apply them by
- * hand (`psql -f migrations/0001_init.sql`) in locked-down environments, or
- * call `migrate(pool)` / enable `autoMigrate` for convenience.
- */
-import { readdirSync, readFileSync } from 'node:fs';
-import { fileURLToPath } from 'node:url';
-const MIGRATIONS_DIR = fileURLToPath(new URL('../migrations', import.meta.url));
+import { MIGRATIONS } from './migrations-data.js';
 /**
  * Apply any pending search-index migrations. Safe to call repeatedly (and at
  * boot via `autoMigrate`) — already-applied versions are skipped.
@@ -56,16 +44,7 @@ export async function migrate(pool, options = {}) {
     }
     return { applied };
 }
-/** Read + parse the numbered `.sql` files, sorted by version ascending. */
+/** The embedded migrations, sorted by version ascending. */
 function loadMigrations() {
-    return readdirSync(MIGRATIONS_DIR)
-        .filter((f) => f.endsWith('.sql'))
-        .map((name) => {
-        const version = Number.parseInt(name.split('_')[0] ?? '', 10);
-        if (!Number.isInteger(version)) {
-            throw new Error(`[search-postgres] migration file '${name}' has no leading version number`);
-        }
-        return { version, name, sql: readFileSync(`${MIGRATIONS_DIR}/${name}`, 'utf8') };
-    })
-        .sort((a, b) => a.version - b.version);
+    return [...MIGRATIONS].sort((a, b) => a.version - b.version);
 }

package/dist/migrations-data.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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
+ */
+/**
+ * Embedded migrations — the numbered SQL in `migrations/` inlined as strings.
+ *
+ * Why inline rather than read the `.sql` files at runtime: `migrate()` must be
+ * callable from a production server bundle, where Nitro / rollup inline this
+ * package into a single file and rewrite `import.meta.url`. Any read of
+ * `migrations/*.sql` resolved relative to that URL then points at the bundle
+ * directory instead of the package, and `migrate()` ENOENTs at boot. Embedding
+ * the SQL into the JS makes the runner bundle-safe everywhere.
+ *
+ * The `.sql` files remain the DBA-reviewable source of truth and still ship in
+ * the package for the `psql -f migrations/0001_init.sql` install path —
+ * `migrations-data.test.node.ts` asserts the two never drift.
+ */
+export interface EmbeddedMigration {
+    version: number;
+    name: string;
+    sql: string;
+}
+export declare const MIGRATIONS: EmbeddedMigration[];

package/dist/migrations-data.js

@@ -0,0 +1,56 @@
+/**
+ * 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 const MIGRATIONS = [
+    {
+        version: 1,
+        name: '0001_init.sql',
+        sql: `-- @byline/search-postgres — 0001_init
+--
+-- The full-text search index, owned entirely by this driver. One row per
+-- (collection_path, document_id, locale). The \`search_vector\` is a weighted
+-- tsvector assembled from the type-enriched SearchDocument at upsert time
+-- (title => A, body fields => A–D by boost, facet terms => C). Facet ids and
+-- filterable scalars are kept as jsonb for aggregation / filtering.
+--
+-- Idempotent (IF NOT EXISTS throughout) so re-applying is safe. The driver's
+-- migration runner records applied versions in byline_search_migrations.
+
+CREATE TABLE IF NOT EXISTS byline_search_documents (
+  collection_path text        NOT NULL,
+  document_id     text        NOT NULL,
+  locale          text        NOT NULL,
+  status          text        NOT NULL,
+  zones           text[]      NOT NULL DEFAULT '{}',
+  title           text        NOT NULL DEFAULT '',
+  path            text,
+  body            text        NOT NULL DEFAULT '',
+  search_vector   tsvector,
+  facets          jsonb       NOT NULL DEFAULT '{}'::jsonb,
+  filters         jsonb       NOT NULL DEFAULT '{}'::jsonb,
+  updated_at      timestamptz NOT NULL DEFAULT now(),
+  PRIMARY KEY (collection_path, document_id, locale)
+);
+
+-- Ranked full-text search.
+CREATE INDEX IF NOT EXISTS byline_search_documents_vector_idx
+  ON byline_search_documents USING gin (search_vector);
+
+-- Zone scoping (\`zones @> ARRAY[$zone]\`).
+CREATE INDEX IF NOT EXISTS byline_search_documents_zones_idx
+  ON byline_search_documents USING gin (zones);
+
+-- Facet aggregation / filtering over the jsonb projection.
+CREATE INDEX IF NOT EXISTS byline_search_documents_facets_idx
+  ON byline_search_documents USING gin (facets jsonb_path_ops);
+
+-- Single-collection scoping + status filtering.
+CREATE INDEX IF NOT EXISTS byline_search_documents_collection_idx
+  ON byline_search_documents (collection_path, status);
+`,
+    },
+];

package/dist/migrations-data.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/migrations-data.test.node.js

@@ -0,0 +1,36 @@
+/**
+ * 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 { readdirSync, readFileSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { describe, expect, it } from 'vitest';
+import { MIGRATIONS } from './migrations-data.js';
+// Drift guard: the embedded SQL (`migrations-data.ts`, the bundle-safe source
+// the runner executes) must stay byte-identical to the numbered `.sql` files
+// (the DBA-reviewable source of truth that ships for the `psql -f` path). When
+// adding a migration, update both — this test fails until they match.
+const migrationsDir = join(dirname(fileURLToPath(import.meta.url)), '../migrations');
+describe('embedded migrations vs the .sql files', () => {
+    const sqlFiles = readdirSync(migrationsDir)
+        .filter((f) => f.endsWith('.sql'))
+        .sort();
+    it('embeds exactly the .sql files that ship in the package', () => {
+        expect(MIGRATIONS.map((m) => m.name).sort()).toEqual(sqlFiles);
+    });
+    it.each(sqlFiles)('embedded SQL for %s matches the file on disk', (name) => {
+        const onDisk = readFileSync(join(migrationsDir, name), 'utf8');
+        const embedded = MIGRATIONS.find((m) => m.name === name);
+        expect(embedded, `no embedded migration named ${name}`).toBeDefined();
+        expect(embedded?.sql.trim()).toBe(onDisk.trim());
+    });
+    it('numbers each migration from its filename prefix', () => {
+        for (const m of MIGRATIONS) {
+            expect(m.version).toBe(Number.parseInt(m.name.split('_')[0] ?? '', 10));
+        }
+    });
+});

package/package.json

@@ -2,7 +2,7 @@
   "name": "@byline/search-postgres",
   "private": false,
   "license": "MPL-2.0",
-  "version": "3.15.0",
+  "version": "3.15.1",
   "engines": {
     "node": ">=20.9.0"
   },
@@ -42,7 +42,7 @@
   ],
   "dependencies": {
     "npm-run-all": "^4.1.5",
-    "@byline/core": "3.15.0"
+    "@byline/core": "3.15.1"
   },
   "peerDependencies": {
     "pg": "^8.21.0"