@byline/core 0.9.3

package/dist/patches/patch-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"patch-types.d.ts","sourceRoot":"","sources":["../../src/patches/patch-types.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAA;AAEzE,8DAA8D;AAC9D,MAAM,MAAM,SAAS,GAAG,MAAM,CAAA;AAE9B,MAAM,WAAW,SAAS;IACxB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,aAAc,SAAQ,SAAS;IAC9C,IAAI,EAAE,WAAW,CAAA;IACjB,IAAI,EAAE,SAAS,CAAA;IACf,KAAK,EAAE,OAAO,CAAA;CACf;AAED,MAAM,WAAW,eAAgB,SAAQ,SAAS;IAChD,IAAI,EAAE,aAAa,CAAA;IACnB,IAAI,EAAE,SAAS,CAAA;CAChB;AAED,MAAM,MAAM,UAAU,GAAG,aAAa,GAAG,eAAe,CAAA;AAExD,MAAM,WAAW,gBAAiB,SAAQ,SAAS;IACjD,IAAI,EAAE,cAAc,CAAA;IACpB,IAAI,EAAE,SAAS,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,OAAO,CAAA;CACd;AAED,MAAM,WAAW,cAAe,SAAQ,SAAS;IAC/C,IAAI,EAAE,YAAY,CAAA;IAClB,IAAI,EAAE,SAAS,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,gBAAiB,SAAQ,SAAS;IACjD,IAAI,EAAE,cAAc,CAAA;IACpB,IAAI,EAAE,SAAS,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,oBAAqB,SAAQ,SAAS;IACrD,IAAI,EAAE,kBAAkB,CAAA;IACxB,IAAI,EAAE,SAAS,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,aAAa,EAAE,CAAA;CACzB;AAED,MAAM,MAAM,UAAU,GAAG,gBAAgB,GAAG,cAAc,GAAG,gBAAgB,GAAG,oBAAoB,CAAA;AAEpG,MAAM,WAAW,aAAc,SAAQ,SAAS;IAC9C,IAAI,EAAE,WAAW,CAAA;IACjB,IAAI,EAAE,SAAS,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB;AAED,MAAM,WAAW,cAAe,SAAQ,SAAS;IAC/C,IAAI,EAAE,YAAY,CAAA;IAClB,IAAI,EAAE,SAAS,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,gBAAiB,SAAQ,SAAS;IACjD,IAAI,EAAE,cAAc,CAAA;IACpB,IAAI,EAAE,SAAS,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,qBAAsB,SAAQ,SAAS;IACtD,IAAI,EAAE,mBAAmB,CAAA;IACzB,IAAI,EAAE,SAAS,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,SAAS,CAAA;IACpB,KAAK,EAAE,OAAO,CAAA;CACf;AAED,MAAM,MAAM,UAAU,GAAG,aAAa,GAAG,cAAc,GAAG,gBAAgB,GAAG,qBAAqB,CAAA;AAElG,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,UAAU,GAAG,UAAU,CAAA;AAEhE,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,aAAa,CAAA;CACrB;AAED,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,OAAO,CAAA;IACZ,MAAM,EAAE,UAAU,EAAE,CAAA;IACpB,QAAQ,EAAE,UAAU,EAAE,CAAA;CACvB;AAED,MAAM,WAAW,YAAY;IAC3B,UAAU,EAAE,oBAAoB,CAAA;CACjC"}

package/dist/patches/patch-types.js

@@ -0,0 +1,3 @@
+// Patch model shared between dashboard, core and adapters
+export {};
+//# sourceMappingURL=patch-types.js.map

package/dist/patches/patch-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"patch-types.js","sourceRoot":"","sources":["../../src/patches/patch-types.ts"],"names":[],"mappings":"AAAA,0DAA0D"}

package/dist/patches/patch.test.node.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=patch.test.node.d.ts.map

package/dist/patches/patch.test.node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"patch.test.node.d.ts","sourceRoot":"","sources":["../../src/patches/patch.test.node.ts"],"names":[],"mappings":""}

package/dist/patches/patch.test.node.js

@@ -0,0 +1,193 @@
+import { describe, expect, it } from 'vitest';
+import { applyPatches } from './apply-patches.js';
+const DocsDefinition = {
+    path: 'docs',
+    labels: {
+        singular: 'Document',
+        plural: 'Documents',
+    },
+    fields: [
+        { name: 'path', label: 'Path', type: 'text' },
+        { name: 'title', label: 'Title', type: 'text' },
+        { name: 'summary', label: 'Summary', type: 'textArea', optional: true, localized: true },
+        {
+            name: 'publishedOn',
+            label: 'Published On',
+            type: 'datetime',
+            mode: 'datetime',
+        },
+        {
+            name: 'featured',
+            label: 'Featured',
+            type: 'checkbox',
+            optional: true,
+        },
+        {
+            name: 'content',
+            label: 'Content',
+            type: 'blocks',
+            optional: true,
+            blocks: [
+                {
+                    blockType: 'richTextBlock',
+                    label: 'Richtext Block',
+                    fields: [
+                        {
+                            name: 'richText',
+                            label: 'Richtext',
+                            type: 'richText',
+                            optional: true,
+                        },
+                        {
+                            name: 'constrainedWidth',
+                            label: 'Constrained Width',
+                            type: 'checkbox',
+                            optional: true,
+                        },
+                    ],
+                },
+                {
+                    blockType: 'photoBlock',
+                    label: 'Photo Block',
+                    fields: [
+                        { name: 'display', label: 'Display', type: 'text', optional: true },
+                        { name: 'photo', label: 'Photo', type: 'image' },
+                        { name: 'alt', label: 'Alt', type: 'text' },
+                        { name: 'caption', label: 'Caption', type: 'richText', optional: true },
+                    ],
+                },
+            ],
+        },
+        {
+            name: 'reviews',
+            label: 'Reviews',
+            type: 'array',
+            optional: true,
+            fields: [
+                {
+                    name: 'reviewItem',
+                    label: 'Review Item',
+                    type: 'group',
+                    fields: [
+                        { name: 'rating', label: 'Rating', type: 'integer' },
+                        { name: 'comment', label: 'Comments', type: 'richText', optional: true },
+                    ],
+                },
+            ],
+        },
+        {
+            name: 'links',
+            label: 'Links',
+            type: 'array',
+            optional: true,
+            fields: [{ name: 'link', label: 'Link', type: 'text' }],
+        },
+    ],
+};
+const DocsPatchExample = [
+    {
+        kind: 'field.set',
+        path: 'title',
+        value: 'Updated title via patch',
+    },
+];
+describe('applyPatches', () => {
+    it('applies DocsPatchExample to a simple doc object', () => {
+        const original = {
+            title: 'Original title',
+            path: '/docs/original',
+            summary: 'Original summary',
+        };
+        const { doc, errors } = applyPatches(DocsDefinition, original, DocsPatchExample);
+        expect(errors).toHaveLength(0);
+        const patched = doc;
+        expect(patched.title).toBe('Updated title via patch');
+        expect(patched.path).toBe(original.path);
+        expect(patched.summary).toBe(original.summary);
+    });
+    it('leaves the document unchanged when no patches are provided', () => {
+        const original = {
+            title: 'Original title',
+            path: '/docs/original',
+            summary: 'Original summary',
+        };
+        const { doc, errors } = applyPatches(DocsDefinition, original, []);
+        expect(errors).toHaveLength(0);
+        expect(doc).toEqual(original);
+    });
+    it('reports an error for unsupported patch kinds', () => {
+        const original = {
+            title: 'Original title',
+        };
+        const { errors } = applyPatches(DocsDefinition, original, [
+            // @ts-expect-error - intentionally passing an unsupported kind to verify type narrowing behaviour
+            { kind: 'unknown.kind', path: 'links' },
+        ]);
+        expect(errors.length).toBe(1);
+        expect(errors[0]?.message).toContain('Unsupported patch kind');
+    });
+    it('supports array.insert and array.move with stable ids', () => {
+        const original = {
+            reviews: [
+                { _id: 'a', rating: 3 },
+                { _id: 'b', rating: 4 },
+            ],
+        };
+        const { doc: afterInsert, errors: insertErrors } = applyPatches(DocsDefinition, original, [
+            {
+                kind: 'array.insert',
+                path: 'reviews',
+                index: 1,
+                item: { _id: 'c', rating: 5 },
+            },
+        ]);
+        expect(insertErrors).toHaveLength(0);
+        const inserted = afterInsert;
+        expect(inserted.reviews.map((r) => r._id)).toEqual(['a', 'c', 'b']);
+        const { doc: afterMove, errors: moveErrors } = applyPatches(DocsDefinition, inserted, [
+            {
+                kind: 'array.move',
+                path: 'reviews',
+                itemId: 'c',
+                toIndex: 0,
+            },
+        ]);
+        expect(moveErrors).toHaveLength(0);
+        const moved = afterMove;
+        expect(moved.reviews.map((r) => r._id)).toEqual(['c', 'a', 'b']);
+    });
+    it('supports block.add and block.updateField on content blocks', () => {
+        const original = {
+            content: [],
+        };
+        const { doc: afterAdd, errors: addErrors } = applyPatches(DocsDefinition, original, [
+            {
+                kind: 'block.add',
+                path: 'content',
+                blockType: 'richTextBlock',
+                initialValue: {
+                    richText: { ops: [{ insert: 'Hello' }] },
+                },
+            },
+        ]);
+        expect(addErrors).toHaveLength(0);
+        const withBlock = afterAdd;
+        expect(withBlock.content).toHaveLength(1);
+        const block = withBlock.content[0];
+        expect(block?._type).toBe('richTextBlock');
+        expect(block?.richText).toEqual({ ops: [{ insert: 'Hello' }] });
+        const { doc: afterUpdate, errors: updateErrors } = applyPatches(DocsDefinition, withBlock, [
+            {
+                kind: 'block.updateField',
+                path: 'content',
+                blockId: block._id,
+                fieldPath: 'constrainedWidth',
+                value: true,
+            },
+        ]);
+        expect(updateErrors).toHaveLength(0);
+        const updated = afterUpdate;
+        expect(updated.content[0]?.constrainedWidth).toBe(true);
+    });
+});
+//# sourceMappingURL=patch.test.node.js.map

package/dist/patches/patch.test.node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"patch.test.node.js","sourceRoot":"","sources":["../../src/patches/patch.test.node.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAA;AAE7C,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAIjD,MAAM,cAAc,GAAyB;IAC3C,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE;QACN,QAAQ,EAAE,UAAU;QACpB,MAAM,EAAE,WAAW;KACpB;IACD,MAAM,EAAE;QACN,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE;QAC7C,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE;QAC/C,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;QACxF;YACE,IAAI,EAAE,aAAa;YACnB,KAAK,EAAE,cAAc;YACrB,IAAI,EAAE,UAAU;YAChB,IAAI,EAAE,UAAU;SACjB;QACD;YACE,IAAI,EAAE,UAAU;YAChB,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,UAAU;YAChB,QAAQ,EAAE,IAAI;SACf;QACD;YACE,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,SAAS;YAChB,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE;gBACN;oBACE,SAAS,EAAE,eAAe;oBAC1B,KAAK,EAAE,gBAAgB;oBACvB,MAAM,EAAE;wBACN;4BACE,IAAI,EAAE,UAAU;4BAChB,KAAK,EAAE,UAAU;4BACjB,IAAI,EAAE,UAAU;4BAChB,QAAQ,EAAE,IAAI;yBACf;wBACD;4BACE,IAAI,EAAE,kBAAkB;4BACxB,KAAK,EAAE,mBAAmB;4BAC1B,IAAI,EAAE,UAAU;4BAChB,QAAQ,EAAE,IAAI;yBACf;qBACF;iBACF;gBACD;oBACE,SAAS,EAAE,YAAY;oBACvB,KAAK,EAAE,aAAa;oBACpB,MAAM,EAAE;wBACN,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE;wBACnE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE;wBAChD,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE;wBAC3C,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE;qBACxE;iBACF;aACF;SACF;QACD;YACE,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,SAAS;YAChB,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE;gBACN;oBACE,IAAI,EAAE,YAAY;oBAClB,KAAK,EAAE,aAAa;oBACpB,IAAI,EAAE,OAAO;oBACb,MAAM,EAAE;wBACN,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE;wBACpD,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE;qBACzE;iBACF;aACF;SACF;QACD;YACE,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,OAAO;YACb,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;SACxD;KACF;CACF,CAAA;AAED,MAAM,gBAAgB,GAAoB;IACxC;QACE,IAAI,EAAE,WAAW;QACjB,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,yBAAyB;KACjC;CACF,CAAA;AAQD,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACzD,MAAM,QAAQ,GAAa;YACzB,KAAK,EAAE,gBAAgB;YACvB,IAAI,EAAE,gBAAgB;YACtB,OAAO,EAAE,kBAAkB;SAC5B,CAAA;QAED,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,YAAY,CAAC,cAAc,EAAE,QAAQ,EAAE,gBAAgB,CAAC,CAAA;QAEhF,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;QAC9B,MAAM,OAAO,GAAG,GAAe,CAAA;QAE/B,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAA;QACrD,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QACxC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;IAChD,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACpE,MAAM,QAAQ,GAAa;YACzB,KAAK,EAAE,gBAAgB;YACvB,IAAI,EAAE,gBAAgB;YACtB,OAAO,EAAE,kBAAkB;SAC5B,CAAA;QAED,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,YAAY,CAAC,cAAc,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAA;QAElE,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;QAC9B,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;IAC/B,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,QAAQ,GAAa;YACzB,KAAK,EAAE,gBAAgB;SACxB,CAAA;QAED,MAAM,EAAE,MAAM,EAAE,GAAG,YAAY,CAAC,cAAc,EAAE,QAAQ,EAAE;YACxD,kGAAkG;YAClG,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,OAAO,EAAE;SACxC,CAAC,CAAA;QAEF,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAC7B,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,wBAAwB,CAAC,CAAA;IAChE,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,MAAM,QAAQ,GAAG;YACf,OAAO,EAAE;gBACP,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE;gBACvB,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE;aACxB;SACF,CAAA;QAED,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,YAAY,CAAC,cAAc,EAAE,QAAQ,EAAE;YACxF;gBACE,IAAI,EAAE,cAAc;gBACpB,IAAI,EAAE,SAAS;gBACf,KAAK,EAAE,CAAC;gBACR,IAAI,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE;aAC9B;SACF,CAAC,CAAA;QAEF,MAAM,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;QAEpC,MAAM,QAAQ,GAAG,WAA6D,CAAA;QAC9E,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAA;QAEnE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,YAAY,CAAC,cAAc,EAAE,QAAQ,EAAE;YACpF;gBACE,IAAI,EAAE,YAAY;gBAClB,IAAI,EAAE,SAAS;gBACf,MAAM,EAAE,GAAG;gBACX,OAAO,EAAE,CAAC;aACX;SACF,CAAC,CAAA;QAEF,MAAM,CAAC,UAAU,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;QAClC,MAAM,KAAK,GAAG,SAA2D,CAAA;QACzE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAA;IAClE,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACpE,MAAM,QAAQ,GAAG;YACf,OAAO,EAAE,EAAE;SACZ,CAAA;QAED,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,YAAY,CAAC,cAAc,EAAE,QAAQ,EAAE;YAClF;gBACE,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,SAAS;gBACf,SAAS,EAAE,eAAe;gBAC1B,YAAY,EAAE;oBACZ,QAAQ,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE;iBACzC;aACF;SACF,CAAC,CAAA;QAEF,MAAM,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;QAEjC,MAAM,SAAS,GAAG,QAEjB,CAAA;QAED,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;QACzC,MAAM,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;QAClC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;QAC1C,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAA;QAE/D,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,YAAY,CAAC,cAAc,EAAE,SAAS,EAAE;YACzF;gBACE,IAAI,EAAE,mBAAmB;gBACzB,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,KAAK,CAAC,GAAG;gBAClB,SAAS,EAAE,kBAAkB;gBAC7B,KAAK,EAAE,IAAI;aACZ;SACF,CAAC,CAAA;QAEF,MAAM,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;QACpC,MAAM,OAAO,GAAG,WAEf,CAAA;QAED,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACzD,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/query/parse-where.d.ts

@@ -0,0 +1,100 @@
+/**
+ * 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 { DocumentFilter, FieldFilterOperator } from '../@types/db-types.js';
+import type { CollectionDefinition } from '../@types/index.js';
+import type { QueryPredicate, SortSpec } from '../@types/query-predicate.js';
+import type { BylineLogger } from '../lib/logger.js';
+type WhereClause = QueryPredicate;
+/** Where clause keys that map to document-level columns, not EAV stores. */
+declare const DOCUMENT_LEVEL_KEYS: Set<string>;
+/**
+ * Optional context used to resolve cross-collection relation filters.
+ *
+ * When the `where` clause traverses a relation field with a nested
+ * sub-clause (e.g. `{ category: { path: 'news' } }`), the parser needs
+ * (a) the target collection's definition to resolve nested field types
+ * and (b) the target collection's DB row id to emit the adapter-facing
+ * `RelationFilter.targetCollectionId`.
+ *
+ * When `ctx` is omitted, nested relation sub-clauses are silently
+ * skipped — bare-value or operator-object values on relation fields
+ * still produce ordinary `$eq`-style filters against
+ * `store_relation.target_document_id`.
+ */
+export interface ParseContext {
+    /** All registered collection definitions. */
+    collections: CollectionDefinition[];
+    /** Resolve a collection path → DB row id. */
+    resolveCollectionId: (path: string) => Promise<string>;
+    /**
+     * Optional logger. When provided, dropped nested relation sub-clauses
+     * (unknown target collection, misconfigured relation field) emit a
+     * `debug` line so a regression is observable. Safe to omit.
+     */
+    logger?: BylineLogger;
+}
+export interface ParsedWhere {
+    /** Filter on document_versions.status (exact match). */
+    status?: string;
+    /** Text search query (for collection-configured search fields). */
+    query?: string;
+    /** Filter on document_versions.path with an operator. */
+    pathFilter?: {
+        operator: FieldFilterOperator;
+        value: string;
+    };
+    /**
+     * Adapter-facing filter list: ordinary field filters and cross-collection
+     * relation filters, intermixed. Consumed by
+     * `IDocumentQueries.findDocuments({ filters })`.
+     */
+    filters: DocumentFilter[];
+}
+export interface ParsedSort {
+    /** Field-level sort descriptor (when sorting by a collection field). */
+    fieldSort?: {
+        fieldName: string;
+        storeType: string;
+        valueColumn: string;
+        direction: 'asc' | 'desc';
+    };
+    /** Document-level sort column (when sorting by created_at, updated_at, path). */
+    orderBy?: string;
+    orderDirection?: 'asc' | 'desc';
+}
+declare const DOCUMENT_SORT_COLUMNS: Record<string, string>;
+/**
+ * Parse a client API `where` clause into document-level conditions and
+ * adapter-facing DocumentFilter descriptors. When `ctx` is provided,
+ * nested relation sub-clauses (e.g. `{ category: { path: 'news' } }`)
+ * are resolved into `RelationFilter` entries; otherwise only
+ * direct/operator predicates against the relation's own
+ * `target_document_id` are emitted.
+ */
+export declare function parseWhere(where: WhereClause | undefined, definition: CollectionDefinition, ctx?: ParseContext): Promise<ParsedWhere>;
+/**
+ * Combine a `beforeRead` hook predicate with a caller-supplied where
+ * clause using implicit AND. Returns whichever side is non-empty, or
+ * wraps both in `$and` when both are present.
+ *
+ * Defined at the predicate level (rather than merging two `ParsedWhere`
+ * outputs) so the result still flows through `parseWhere` once — there
+ * is one normalisation pass and one place where reserved keys, relation
+ * lookups, and combinator flattening happen. `null` is treated the same
+ * as `undefined` (the cache value `null` records "hook ran and applied
+ * no scoping").
+ */
+export declare function mergePredicates(hookPredicate: QueryPredicate | null | undefined, userWhere: WhereClause | undefined): WhereClause | undefined;
+/**
+ * Parse a client API `sort` spec into either a field-level sort descriptor
+ * or a document-level order column.
+ */
+export declare function parseSort(sort: SortSpec | undefined, definition: CollectionDefinition): ParsedSort;
+/** Exported for testing. */
+export { DOCUMENT_LEVEL_KEYS, DOCUMENT_SORT_COLUMNS };
+//# sourceMappingURL=parse-where.d.ts.map

package/dist/query/parse-where.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse-where.d.ts","sourceRoot":"","sources":["../../src/query/parse-where.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,KAAK,EAGV,cAAc,EAEd,mBAAmB,EAEpB,MAAM,uBAAuB,CAAA;AAC9B,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAA;AAC9D,OAAO,KAAK,EAGV,cAAc,EACd,QAAQ,EACT,MAAM,8BAA8B,CAAA;AACrC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAA;AAMpD,KAAK,WAAW,GAAG,cAAc,CAAA;AAOjC,4EAA4E;AAC5E,QAAA,MAAM,mBAAmB,aAAuC,CAAA;AAMhE;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,YAAY;IAC3B,6CAA6C;IAC7C,WAAW,EAAE,oBAAoB,EAAE,CAAA;IACnC,6CAA6C;IAC7C,mBAAmB,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAA;IACtD;;;;OAIG;IACH,MAAM,CAAC,EAAE,YAAY,CAAA;CACtB;AAMD,MAAM,WAAW,WAAW;IAC1B,wDAAwD;IACxD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,mEAAmE;IACnE,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,yDAAyD;IACzD,UAAU,CAAC,EAAE;QAAE,QAAQ,EAAE,mBAAmB,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IAC7D;;;;OAIG;IACH,OAAO,EAAE,cAAc,EAAE,CAAA;CAC1B;AAED,MAAM,WAAW,UAAU;IACzB,wEAAwE;IACxE,SAAS,CAAC,EAAE;QACV,SAAS,EAAE,MAAM,CAAA;QACjB,SAAS,EAAE,MAAM,CAAA;QACjB,WAAW,EAAE,MAAM,CAAA;QACnB,SAAS,EAAE,KAAK,GAAG,MAAM,CAAA;KAC1B,CAAA;IACD,iFAAiF;IACjF,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,cAAc,CAAC,EAAE,KAAK,GAAG,MAAM,CAAA;CAChC;AAMD,QAAA,MAAM,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAMjD,CAAA;AAMD;;;;;;;GAOG;AACH,wBAAsB,UAAU,CAC9B,KAAK,EAAE,WAAW,GAAG,SAAS,EAC9B,UAAU,EAAE,oBAAoB,EAChC,GAAG,CAAC,EAAE,YAAY,GACjB,OAAO,CAAC,WAAW,CAAC,CAEtB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAC7B,aAAa,EAAE,cAAc,GAAG,IAAI,GAAG,SAAS,EAChD,SAAS,EAAE,WAAW,GAAG,SAAS,GACjC,WAAW,GAAG,SAAS,CAKzB;AAqOD;;;GAGG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,QAAQ,GAAG,SAAS,EAC1B,UAAU,EAAE,oBAAoB,GAC/B,UAAU,CAqCZ;AAoED,4BAA4B;AAC5B,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,CAAA"}