@payloadcms/plugin-import-export 3.86.0-internal.ac46214 → 4.0.0-canary.2

package/dist/utilities/legacyHookDispatch.spec.js

@@ -1,227 +0,0 @@
-import { flattenObject } from './flattenObject.js';
-import { getExportFieldFunctions } from './getExportFieldFunctions.js';
-import { getImportFieldFunctions } from './getImportFieldFunctions.js';
-import { unflattenObject } from './unflattenObject.js';
-import { describe, expect, it, vi } from 'vitest';
-const mockReq = {
-    payload: {
-        logger: {
-            error: vi.fn()
-        }
-    }
-};
-describe('legacy toCSV / fromCSV argument shape', ()=>{
-    describe('toCSV receives { columnName, data, doc, row, siblingDoc, value }', ()=>{
-        it('should pass row as flat row accumulator, doc as top-level doc, and siblingDoc as source doc', ()=>{
-            const received = [];
-            const fields = [
-                {
-                    name: 'legacy',
-                    type: 'text',
-                    custom: {
-                        'plugin-import-export': {
-                            toCSV: (args)=>{
-                                received.push(args);
-                                args.row[`${args.columnName}_extra`] = 'added';
-                                return String(args.value) + '_transformed';
-                            }
-                        }
-                    }
-                }
-            ];
-            const exportFieldHooks = getExportFieldFunctions({
-                fields
-            });
-            const doc = {
-                legacy: 'hello',
-                title: 'Top'
-            };
-            const result = flattenObject({
-                data: doc,
-                exportFieldHooks,
-                format: 'csv',
-                req: mockReq
-            });
-            expect(received).toHaveLength(1);
-            const args = received[0];
-            expect(args.columnName).toBe('legacy');
-            expect(args.value).toBe('hello');
-            // doc should be the top-level document
-            expect(args.doc).toBe(doc);
-            // siblingDoc should be the source doc at the current nesting level (top-level == doc)
-            expect(args.siblingDoc).toBe(doc);
-            // row should be the flat row accumulator (a different object from doc)
-            expect(args.row).not.toBe(doc);
-            // data is kept as alias for row to avoid breaking legacy usage
-            expect(args.data).toBe(args.row);
-            expect(result.legacy).toBe('hello_transformed');
-            expect(result.legacy_extra).toBe('added');
-        });
-        it('should not pass legacy args to hooks.beforeExport', ()=>{
-            const received = [];
-            const fields = [
-                {
-                    name: 'modern',
-                    type: 'text',
-                    custom: {
-                        'plugin-import-export': {
-                            hooks: {
-                                beforeExport: (args)=>{
-                                    received.push(args);
-                                    return String(args.value) + '_modern';
-                                }
-                            }
-                        }
-                    }
-                }
-            ];
-            const exportFieldHooks = getExportFieldFunctions({
-                fields
-            });
-            const doc = {
-                modern: 'v',
-                title: 'Top'
-            };
-            flattenObject({
-                data: doc,
-                exportFieldHooks,
-                format: 'csv',
-                req: mockReq
-            });
-            expect(received).toHaveLength(1);
-            const args = received[0];
-            // Modern signature: data === top-level doc
-            expect(args.data).toBe(doc);
-            // Modern signature: siblingData === flat row accumulator (not source doc)
-            expect(args.siblingData).not.toBe(doc);
-            expect(args.format).toBe('csv');
-            // Legacy-only args should not be present
-            expect(args.doc).toBeUndefined();
-            expect(args.row).toBeUndefined();
-            // `siblingDoc` is part of the modern signature too (read-only source view)
-            expect(args.siblingDoc).toBeDefined();
-        });
-        it('should prefer hooks.beforeExport when both are defined on a field', ()=>{
-            const legacyCalls = [];
-            const modernCalls = [];
-            const fields = [
-                {
-                    name: 'both',
-                    type: 'text',
-                    custom: {
-                        'plugin-import-export': {
-                            hooks: {
-                                beforeExport: ({ value })=>{
-                                    modernCalls.push(String(value));
-                                    return `${value}_modern`;
-                                }
-                            },
-                            toCSV: ({ value })=>{
-                                legacyCalls.push(String(value));
-                                return `${value}_legacy`;
-                            }
-                        }
-                    }
-                }
-            ];
-            const exportFieldHooks = getExportFieldFunctions({
-                fields
-            });
-            const result = flattenObject({
-                data: {
-                    both: 'x'
-                },
-                exportFieldHooks,
-                format: 'csv',
-                req: mockReq
-            });
-            expect(modernCalls).toEqual([
-                'x'
-            ]);
-            expect(legacyCalls).toEqual([]);
-            expect(result.both).toBe('x_modern');
-        });
-    });
-    describe('fromCSV receives { columnName, data, value } with data as full flat row', ()=>{
-        it('should pass the full flat row as data', ()=>{
-            const received = [];
-            const fields = [
-                {
-                    name: 'legacy',
-                    type: 'text',
-                    custom: {
-                        'plugin-import-export': {
-                            fromCSV: (args)=>{
-                                received.push(args);
-                                return String(args.value) + '_imported';
-                            }
-                        }
-                    }
-                }
-            ];
-            const importFieldHooks = getImportFieldFunctions({
-                fields
-            });
-            const flatRow = {
-                legacy: 'incoming',
-                title: 'Top'
-            };
-            const result = unflattenObject({
-                data: flatRow,
-                fields,
-                format: 'csv',
-                importFieldHooks,
-                req: mockReq
-            });
-            expect(received).toHaveLength(1);
-            expect(received[0].columnName).toBe('legacy');
-            expect(received[0].value).toBe('incoming');
-            // data should be the full flat row
-            expect(received[0].data).toBe(flatRow);
-            expect(result.legacy).toBe('incoming_imported');
-        });
-        it('should prefer hooks.beforeImport when both are defined on a field', ()=>{
-            const legacyCalls = [];
-            const modernCalls = [];
-            const fields = [
-                {
-                    name: 'both',
-                    type: 'text',
-                    custom: {
-                        'plugin-import-export': {
-                            fromCSV: ({ value })=>{
-                                legacyCalls.push(String(value));
-                                return `${value}_legacy`;
-                            },
-                            hooks: {
-                                beforeImport: ({ value })=>{
-                                    modernCalls.push(String(value));
-                                    return `${value}_modern`;
-                                }
-                            }
-                        }
-                    }
-                }
-            ];
-            const importFieldHooks = getImportFieldFunctions({
-                fields
-            });
-            const result = unflattenObject({
-                data: {
-                    both: 'x'
-                },
-                fields,
-                format: 'csv',
-                importFieldHooks,
-                req: mockReq
-            });
-            expect(modernCalls).toEqual([
-                'x'
-            ]);
-            expect(legacyCalls).toEqual([]);
-            expect(result.both).toBe('x_modern');
-        });
-    });
-});
-
-//# sourceMappingURL=legacyHookDispatch.spec.js.map

package/dist/utilities/legacyHookDispatch.spec.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/utilities/legacyHookDispatch.spec.ts"],"sourcesContent":["import { FlattenedField, PayloadRequest } from 'payload'\n\nimport type { FromCSVFunction, ToCSVFunction } from '../types.js'\n\nimport { flattenObject } from './flattenObject.js'\nimport { getExportFieldFunctions } from './getExportFieldFunctions.js'\nimport { getImportFieldFunctions } from './getImportFieldFunctions.js'\nimport { unflattenObject } from './unflattenObject.js'\n\nimport { describe, expect, it, vi } from 'vitest'\n\nconst mockReq = {\n  payload: {\n    logger: {\n      error: vi.fn(),\n    },\n  },\n} as unknown as PayloadRequest\n\ndescribe('legacy toCSV / fromCSV argument shape', () => {\n  describe('toCSV receives { columnName, data, doc, row, siblingDoc, value }', () => {\n    it('should pass row as flat row accumulator, doc as top-level doc, and siblingDoc as source doc', () => {\n      const received: Parameters<ToCSVFunction>[0][] = []\n\n      const fields: FlattenedField[] = [\n        {\n          name: 'legacy',\n          type: 'text',\n          custom: {\n            'plugin-import-export': {\n              toCSV: ((args) => {\n                received.push(args)\n                args.row[`${args.columnName}_extra`] = 'added'\n                return String(args.value) + '_transformed'\n              }) satisfies ToCSVFunction,\n            },\n          },\n        } as FlattenedField,\n      ]\n\n      const exportFieldHooks = getExportFieldFunctions({ fields })\n\n      const doc = { legacy: 'hello', title: 'Top' }\n      const result = flattenObject({\n        data: doc,\n        exportFieldHooks,\n        format: 'csv',\n        req: mockReq,\n      })\n\n      expect(received).toHaveLength(1)\n      const args = received[0]!\n      expect(args.columnName).toBe('legacy')\n      expect(args.value).toBe('hello')\n      // doc should be the top-level document\n      expect(args.doc).toBe(doc)\n      // siblingDoc should be the source doc at the current nesting level (top-level == doc)\n      expect(args.siblingDoc).toBe(doc)\n      // row should be the flat row accumulator (a different object from doc)\n      expect(args.row).not.toBe(doc)\n      // data is kept as alias for row to avoid breaking legacy usage\n      expect(args.data).toBe(args.row)\n\n      expect(result.legacy).toBe('hello_transformed')\n      expect(result.legacy_extra).toBe('added')\n    })\n\n    it('should not pass legacy args to hooks.beforeExport', () => {\n      const received: Array<Record<string, unknown>> = []\n\n      const fields: FlattenedField[] = [\n        {\n          name: 'modern',\n          type: 'text',\n          custom: {\n            'plugin-import-export': {\n              hooks: {\n                beforeExport: (args) => {\n                  received.push(args as unknown as Record<string, unknown>)\n                  return String(args.value) + '_modern'\n                },\n              },\n            },\n          },\n        } as FlattenedField,\n      ]\n\n      const exportFieldHooks = getExportFieldFunctions({ fields })\n\n      const doc = { modern: 'v', title: 'Top' }\n      flattenObject({ data: doc, exportFieldHooks, format: 'csv', req: mockReq })\n\n      expect(received).toHaveLength(1)\n      const args = received[0]!\n      // Modern signature: data === top-level doc\n      expect(args.data).toBe(doc)\n      // Modern signature: siblingData === flat row accumulator (not source doc)\n      expect(args.siblingData).not.toBe(doc)\n      expect(args.format).toBe('csv')\n      // Legacy-only args should not be present\n      expect(args.doc).toBeUndefined()\n      expect(args.row).toBeUndefined()\n      // `siblingDoc` is part of the modern signature too (read-only source view)\n      expect(args.siblingDoc).toBeDefined()\n    })\n\n    it('should prefer hooks.beforeExport when both are defined on a field', () => {\n      const legacyCalls: string[] = []\n      const modernCalls: string[] = []\n\n      const fields: FlattenedField[] = [\n        {\n          name: 'both',\n          type: 'text',\n          custom: {\n            'plugin-import-export': {\n              hooks: {\n                beforeExport: ({ value }) => {\n                  modernCalls.push(String(value))\n                  return `${value}_modern`\n                },\n              },\n              toCSV: ({ value }: { value: unknown }) => {\n                legacyCalls.push(String(value))\n                return `${value}_legacy`\n              },\n            },\n          },\n        } as FlattenedField,\n      ]\n\n      const exportFieldHooks = getExportFieldFunctions({ fields })\n      const result = flattenObject({\n        data: { both: 'x' },\n        exportFieldHooks,\n        format: 'csv',\n        req: mockReq,\n      })\n\n      expect(modernCalls).toEqual(['x'])\n      expect(legacyCalls).toEqual([])\n      expect(result.both).toBe('x_modern')\n    })\n  })\n\n  describe('fromCSV receives { columnName, data, value } with data as full flat row', () => {\n    it('should pass the full flat row as data', () => {\n      const received: Parameters<FromCSVFunction>[0][] = []\n\n      const fields: FlattenedField[] = [\n        {\n          name: 'legacy',\n          type: 'text',\n          custom: {\n            'plugin-import-export': {\n              fromCSV: ((args) => {\n                received.push(args)\n                return String(args.value) + '_imported'\n              }) satisfies FromCSVFunction,\n            },\n          },\n        } as FlattenedField,\n      ]\n\n      const importFieldHooks = getImportFieldFunctions({ fields })\n\n      const flatRow = { legacy: 'incoming', title: 'Top' }\n      const result = unflattenObject({\n        data: flatRow,\n        fields,\n        format: 'csv',\n        importFieldHooks,\n        req: mockReq,\n      })\n\n      expect(received).toHaveLength(1)\n      expect(received[0]!.columnName).toBe('legacy')\n      expect(received[0]!.value).toBe('incoming')\n      // data should be the full flat row\n      expect(received[0]!.data).toBe(flatRow)\n\n      expect(result.legacy).toBe('incoming_imported')\n    })\n\n    it('should prefer hooks.beforeImport when both are defined on a field', () => {\n      const legacyCalls: string[] = []\n      const modernCalls: string[] = []\n\n      const fields: FlattenedField[] = [\n        {\n          name: 'both',\n          type: 'text',\n          custom: {\n            'plugin-import-export': {\n              fromCSV: ({ value }: { value: unknown }) => {\n                legacyCalls.push(String(value))\n                return `${value}_legacy`\n              },\n              hooks: {\n                beforeImport: ({ value }) => {\n                  modernCalls.push(String(value))\n                  return `${value}_modern`\n                },\n              },\n            },\n          },\n        } as FlattenedField,\n      ]\n\n      const importFieldHooks = getImportFieldFunctions({ fields })\n      const result = unflattenObject({\n        data: { both: 'x' },\n        fields,\n        format: 'csv',\n        importFieldHooks,\n        req: mockReq,\n      })\n\n      expect(modernCalls).toEqual(['x'])\n      expect(legacyCalls).toEqual([])\n      expect(result.both).toBe('x_modern')\n    })\n  })\n})\n"],"names":["flattenObject","getExportFieldFunctions","getImportFieldFunctions","unflattenObject","describe","expect","it","vi","mockReq","payload","logger","error","fn","received","fields","name","type","custom","toCSV","args","push","row","columnName","String","value","exportFieldHooks","doc","legacy","title","result","data","format","req","toHaveLength","toBe","siblingDoc","not","legacy_extra","hooks","beforeExport","modern","siblingData","toBeUndefined","toBeDefined","legacyCalls","modernCalls","both","toEqual","fromCSV","importFieldHooks","flatRow","beforeImport"],"mappings":"AAIA,SAASA,aAAa,QAAQ,qBAAoB;AAClD,SAASC,uBAAuB,QAAQ,+BAA8B;AACtE,SAASC,uBAAuB,QAAQ,+BAA8B;AACtE,SAASC,eAAe,QAAQ,uBAAsB;AAEtD,SAASC,QAAQ,EAAEC,MAAM,EAAEC,EAAE,EAAEC,EAAE,QAAQ,SAAQ;AAEjD,MAAMC,UAAU;IACdC,SAAS;QACPC,QAAQ;YACNC,OAAOJ,GAAGK,EAAE;QACd;IACF;AACF;AAEAR,SAAS,yCAAyC;IAChDA,SAAS,oEAAoE;QAC3EE,GAAG,+FAA+F;YAChG,MAAMO,WAA2C,EAAE;YAEnD,MAAMC,SAA2B;gBAC/B;oBACEC,MAAM;oBACNC,MAAM;oBACNC,QAAQ;wBACN,wBAAwB;4BACtBC,OAAQ,CAACC;gCACPN,SAASO,IAAI,CAACD;gCACdA,KAAKE,GAAG,CAAC,GAAGF,KAAKG,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG;gCACvC,OAAOC,OAAOJ,KAAKK,KAAK,IAAI;4BAC9B;wBACF;oBACF;gBACF;aACD;YAED,MAAMC,mBAAmBxB,wBAAwB;gBAAEa;YAAO;YAE1D,MAAMY,MAAM;gBAAEC,QAAQ;gBAASC,OAAO;YAAM;YAC5C,MAAMC,SAAS7B,cAAc;gBAC3B8B,MAAMJ;gBACND;gBACAM,QAAQ;gBACRC,KAAKxB;YACP;YAEAH,OAAOQ,UAAUoB,YAAY,CAAC;YAC9B,MAAMd,OAAON,QAAQ,CAAC,EAAE;YACxBR,OAAOc,KAAKG,UAAU,EAAEY,IAAI,CAAC;YAC7B7B,OAAOc,KAAKK,KAAK,EAAEU,IAAI,CAAC;YACxB,uCAAuC;YACvC7B,OAAOc,KAAKO,GAAG,EAAEQ,IAAI,CAACR;YACtB,sFAAsF;YACtFrB,OAAOc,KAAKgB,UAAU,EAAED,IAAI,CAACR;YAC7B,uEAAuE;YACvErB,OAAOc,KAAKE,GAAG,EAAEe,GAAG,CAACF,IAAI,CAACR;YAC1B,+DAA+D;YAC/DrB,OAAOc,KAAKW,IAAI,EAAEI,IAAI,CAACf,KAAKE,GAAG;YAE/BhB,OAAOwB,OAAOF,MAAM,EAAEO,IAAI,CAAC;YAC3B7B,OAAOwB,OAAOQ,YAAY,EAAEH,IAAI,CAAC;QACnC;QAEA5B,GAAG,qDAAqD;YACtD,MAAMO,WAA2C,EAAE;YAEnD,MAAMC,SAA2B;gBAC/B;oBACEC,MAAM;oBACNC,MAAM;oBACNC,QAAQ;wBACN,wBAAwB;4BACtBqB,OAAO;gCACLC,cAAc,CAACpB;oCACbN,SAASO,IAAI,CAACD;oCACd,OAAOI,OAAOJ,KAAKK,KAAK,IAAI;gCAC9B;4BACF;wBACF;oBACF;gBACF;aACD;YAED,MAAMC,mBAAmBxB,wBAAwB;gBAAEa;YAAO;YAE1D,MAAMY,MAAM;gBAAEc,QAAQ;gBAAKZ,OAAO;YAAM;YACxC5B,cAAc;gBAAE8B,MAAMJ;gBAAKD;gBAAkBM,QAAQ;gBAAOC,KAAKxB;YAAQ;YAEzEH,OAAOQ,UAAUoB,YAAY,CAAC;YAC9B,MAAMd,OAAON,QAAQ,CAAC,EAAE;YACxB,2CAA2C;YAC3CR,OAAOc,KAAKW,IAAI,EAAEI,IAAI,CAACR;YACvB,0EAA0E;YAC1ErB,OAAOc,KAAKsB,WAAW,EAAEL,GAAG,CAACF,IAAI,CAACR;YAClCrB,OAAOc,KAAKY,MAAM,EAAEG,IAAI,CAAC;YACzB,yCAAyC;YACzC7B,OAAOc,KAAKO,GAAG,EAAEgB,aAAa;YAC9BrC,OAAOc,KAAKE,GAAG,EAAEqB,aAAa;YAC9B,2EAA2E;YAC3ErC,OAAOc,KAAKgB,UAAU,EAAEQ,WAAW;QACrC;QAEArC,GAAG,qEAAqE;YACtE,MAAMsC,cAAwB,EAAE;YAChC,MAAMC,cAAwB,EAAE;YAEhC,MAAM/B,SAA2B;gBAC/B;oBACEC,MAAM;oBACNC,MAAM;oBACNC,QAAQ;wBACN,wBAAwB;4BACtBqB,OAAO;gCACLC,cAAc,CAAC,EAAEf,KAAK,EAAE;oCACtBqB,YAAYzB,IAAI,CAACG,OAAOC;oCACxB,OAAO,GAAGA,MAAM,OAAO,CAAC;gCAC1B;4BACF;4BACAN,OAAO,CAAC,EAAEM,KAAK,EAAsB;gCACnCoB,YAAYxB,IAAI,CAACG,OAAOC;gCACxB,OAAO,GAAGA,MAAM,OAAO,CAAC;4BAC1B;wBACF;oBACF;gBACF;aACD;YAED,MAAMC,mBAAmBxB,wBAAwB;gBAAEa;YAAO;YAC1D,MAAMe,SAAS7B,cAAc;gBAC3B8B,MAAM;oBAAEgB,MAAM;gBAAI;gBAClBrB;gBACAM,QAAQ;gBACRC,KAAKxB;YACP;YAEAH,OAAOwC,aAAaE,OAAO,CAAC;gBAAC;aAAI;YACjC1C,OAAOuC,aAAaG,OAAO,CAAC,EAAE;YAC9B1C,OAAOwB,OAAOiB,IAAI,EAAEZ,IAAI,CAAC;QAC3B;IACF;IAEA9B,SAAS,2EAA2E;QAClFE,GAAG,yCAAyC;YAC1C,MAAMO,WAA6C,EAAE;YAErD,MAAMC,SAA2B;gBAC/B;oBACEC,MAAM;oBACNC,MAAM;oBACNC,QAAQ;wBACN,wBAAwB;4BACtB+B,SAAU,CAAC7B;gCACTN,SAASO,IAAI,CAACD;gCACd,OAAOI,OAAOJ,KAAKK,KAAK,IAAI;4BAC9B;wBACF;oBACF;gBACF;aACD;YAED,MAAMyB,mBAAmB/C,wBAAwB;gBAAEY;YAAO;YAE1D,MAAMoC,UAAU;gBAAEvB,QAAQ;gBAAYC,OAAO;YAAM;YACnD,MAAMC,SAAS1B,gBAAgB;gBAC7B2B,MAAMoB;gBACNpC;gBACAiB,QAAQ;gBACRkB;gBACAjB,KAAKxB;YACP;YAEAH,OAAOQ,UAAUoB,YAAY,CAAC;YAC9B5B,OAAOQ,QAAQ,CAAC,EAAE,CAAES,UAAU,EAAEY,IAAI,CAAC;YACrC7B,OAAOQ,QAAQ,CAAC,EAAE,CAAEW,KAAK,EAAEU,IAAI,CAAC;YAChC,mCAAmC;YACnC7B,OAAOQ,QAAQ,CAAC,EAAE,CAAEiB,IAAI,EAAEI,IAAI,CAACgB;YAE/B7C,OAAOwB,OAAOF,MAAM,EAAEO,IAAI,CAAC;QAC7B;QAEA5B,GAAG,qEAAqE;YACtE,MAAMsC,cAAwB,EAAE;YAChC,MAAMC,cAAwB,EAAE;YAEhC,MAAM/B,SAA2B;gBAC/B;oBACEC,MAAM;oBACNC,MAAM;oBACNC,QAAQ;wBACN,wBAAwB;4BACtB+B,SAAS,CAAC,EAAExB,KAAK,EAAsB;gCACrCoB,YAAYxB,IAAI,CAACG,OAAOC;gCACxB,OAAO,GAAGA,MAAM,OAAO,CAAC;4BAC1B;4BACAc,OAAO;gCACLa,cAAc,CAAC,EAAE3B,KAAK,EAAE;oCACtBqB,YAAYzB,IAAI,CAACG,OAAOC;oCACxB,OAAO,GAAGA,MAAM,OAAO,CAAC;gCAC1B;4BACF;wBACF;oBACF;gBACF;aACD;YAED,MAAMyB,mBAAmB/C,wBAAwB;gBAAEY;YAAO;YAC1D,MAAMe,SAAS1B,gBAAgB;gBAC7B2B,MAAM;oBAAEgB,MAAM;gBAAI;gBAClBhC;gBACAiB,QAAQ;gBACRkB;gBACAjB,KAAKxB;YACP;YAEAH,OAAOwC,aAAaE,OAAO,CAAC;gBAAC;aAAI;YACjC1C,OAAOuC,aAAaG,OAAO,CAAC,EAAE;YAC9B1C,OAAOwB,OAAOiB,IAAI,EAAEZ,IAAI,CAAC;QAC3B;IACF;AACF"}