@byline/db-postgres 2.7.0 → 3.0.0

package/dist/modules/storage/tests/storage-document-available-locales.test.js

@@ -0,0 +1,198 @@
+/**
+ * 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 { afterAll, beforeAll, describe, expect, it } from 'vitest';
+import { setupTestDB, teardownTestDB } from '../../../lib/test-helper.js';
+let commandBuilders;
+let queryBuilders;
+const timestamp = Date.now();
+const AdvertiseCollectionConfig = {
+    path: `advertise-${timestamp}`,
+    labels: { singular: 'AdvertiseTest', plural: 'AdvertiseTests' },
+    fields: [{ name: 'title', type: 'text', localized: true }],
+};
+let testCollection = {};
+function readById(documentId) {
+    return queryBuilders.documents.getDocumentById({
+        collection_id: testCollection.id,
+        document_id: documentId,
+    });
+}
+describe('byline_document_available_locales integration', () => {
+    beforeAll(async () => {
+        const testDB = setupTestDB([AdvertiseCollectionConfig]);
+        commandBuilders = testDB.commandBuilders;
+        queryBuilders = testDB.queryBuilders;
+        const result = await commandBuilders.collections.create(AdvertiseCollectionConfig.path, AdvertiseCollectionConfig);
+        const collection = result[0];
+        if (collection == null) {
+            throw new Error('Failed to create test collection');
+        }
+        testCollection = { id: collection.id, name: collection.path };
+    });
+    afterAll(async () => {
+        try {
+            await commandBuilders.collections.delete(testCollection.id);
+        }
+        catch (error) {
+            console.error('Failed to cleanup test collection:', error);
+        }
+        await teardownTestDB();
+    });
+    it('surfaces the advertised set on a detail read, sorted', async () => {
+        const created = await commandBuilders.documents.createDocumentVersion({
+            collectionId: testCollection.id,
+            collectionVersion: 1,
+            collectionConfig: AdvertiseCollectionConfig,
+            action: 'create',
+            documentData: { title: 'Hello' },
+            availableLocales: ['fr', 'en', 'de'],
+            locale: 'all',
+            status: 'draft',
+        });
+        const doc = await readById(created.document.document_id);
+        expect(doc?.availableLocales, 'sorted advertised locales').toEqual(['de', 'en', 'fr']);
+    });
+    it('defaults to an empty set when no advertised locales were ever written', async () => {
+        const created = await commandBuilders.documents.createDocumentVersion({
+            collectionId: testCollection.id,
+            collectionVersion: 1,
+            collectionConfig: AdvertiseCollectionConfig,
+            action: 'create',
+            documentData: { title: 'None' },
+            locale: 'all',
+            status: 'draft',
+        });
+        const doc = await readById(created.document.document_id);
+        expect(doc?.availableLocales).toEqual([]);
+    });
+    it('replaces the set wholesale on re-save (not merged)', async () => {
+        const first = await commandBuilders.documents.createDocumentVersion({
+            collectionId: testCollection.id,
+            collectionVersion: 1,
+            collectionConfig: AdvertiseCollectionConfig,
+            action: 'create',
+            documentData: { title: 'V1' },
+            availableLocales: ['en', 'fr'],
+            locale: 'all',
+            status: 'draft',
+        });
+        const documentId = first.document.document_id;
+        await commandBuilders.documents.createDocumentVersion({
+            documentId,
+            collectionId: testCollection.id,
+            collectionVersion: 1,
+            collectionConfig: AdvertiseCollectionConfig,
+            action: 'update',
+            documentData: { title: 'V2' },
+            availableLocales: ['de'],
+            locale: 'all',
+            status: 'draft',
+            previousVersionId: first.document.id,
+        });
+        const doc = await readById(documentId);
+        expect(doc?.availableLocales, 'fr/en gone, only de remains').toEqual(['de']);
+    });
+    it('leaves the set untouched when the param is omitted (sticky across versions)', async () => {
+        const first = await commandBuilders.documents.createDocumentVersion({
+            collectionId: testCollection.id,
+            collectionVersion: 1,
+            collectionConfig: AdvertiseCollectionConfig,
+            action: 'create',
+            documentData: { title: 'Sticky V1' },
+            availableLocales: ['en', 'de'],
+            locale: 'all',
+            status: 'draft',
+        });
+        const documentId = first.document.document_id;
+        // New version, no availableLocales param — advertising must carry forward.
+        await commandBuilders.documents.createDocumentVersion({
+            documentId,
+            collectionId: testCollection.id,
+            collectionVersion: 1,
+            collectionConfig: AdvertiseCollectionConfig,
+            action: 'update',
+            documentData: { title: 'Sticky V2' },
+            locale: 'all',
+            status: 'draft',
+            previousVersionId: first.document.id,
+        });
+        const doc = await readById(documentId);
+        expect(doc?.availableLocales, 'editorial intent carried forward').toEqual(['de', 'en']);
+    });
+    it('clears the set when given an empty array', async () => {
+        const first = await commandBuilders.documents.createDocumentVersion({
+            collectionId: testCollection.id,
+            collectionVersion: 1,
+            collectionConfig: AdvertiseCollectionConfig,
+            action: 'create',
+            documentData: { title: 'Clear V1' },
+            availableLocales: ['en', 'fr'],
+            locale: 'all',
+            status: 'draft',
+        });
+        const documentId = first.document.document_id;
+        await commandBuilders.documents.createDocumentVersion({
+            documentId,
+            collectionId: testCollection.id,
+            collectionVersion: 1,
+            collectionConfig: AdvertiseCollectionConfig,
+            action: 'update',
+            documentData: { title: 'Clear V2' },
+            availableLocales: [],
+            locale: 'all',
+            status: 'draft',
+            previousVersionId: first.document.id,
+        });
+        const doc = await readById(documentId);
+        expect(doc?.availableLocales, 'empty array clears advertising').toEqual([]);
+    });
+    it('deduplicates caller-supplied duplicate locales', async () => {
+        const created = await commandBuilders.documents.createDocumentVersion({
+            collectionId: testCollection.id,
+            collectionVersion: 1,
+            collectionConfig: AdvertiseCollectionConfig,
+            action: 'create',
+            documentData: { title: 'Dupes' },
+            availableLocales: ['en', 'en', 'fr', 'fr', 'fr'],
+            locale: 'all',
+            status: 'draft',
+        });
+        const doc = await readById(created.document.document_id);
+        expect(doc?.availableLocales, 'duplicates collapse, no PK violation').toEqual(['en', 'fr']);
+    });
+    it('surfaces the advertised set per row on a list read', async () => {
+        const a = await commandBuilders.documents.createDocumentVersion({
+            collectionId: testCollection.id,
+            collectionVersion: 1,
+            collectionConfig: AdvertiseCollectionConfig,
+            action: 'create',
+            documentData: { title: 'List-A' },
+            availableLocales: ['en', 'fr'],
+            locale: 'all',
+            status: 'draft',
+        });
+        const b = await commandBuilders.documents.createDocumentVersion({
+            collectionId: testCollection.id,
+            collectionVersion: 1,
+            collectionConfig: AdvertiseCollectionConfig,
+            action: 'create',
+            documentData: { title: 'List-B' },
+            availableLocales: ['de'],
+            locale: 'all',
+            status: 'draft',
+        });
+        const { documents } = await queryBuilders.documents.findDocuments({
+            collection_id: testCollection.id,
+            locale: 'all',
+            pageSize: 200,
+        });
+        const byId = new Map(documents.map((d) => [d.document_id, d]));
+        expect(byId.get(a.document.document_id)?.availableLocales).toEqual(['en', 'fr']);
+        expect(byId.get(b.document.document_id)?.availableLocales).toEqual(['de']);
+    });
+});

package/dist/modules/storage/tests/storage-locale-fallback.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 {};