@nangohq/nango-yaml 0.40.1

package/dist/parser.v2.unit.test.js

@@ -0,0 +1,151 @@
+import { expect, describe, it } from 'vitest';
+import { NangoYamlParserV2 } from './parser.v2.js';
+import { ParserErrorMissingId, ParserErrorModelIsLiteral, ParserErrorModelNotFound } from './errors.js';
+describe('parse', () => {
+    it('should parse', () => {
+        const v2 = {
+            models: { GithubIssue: { id: 'string' } },
+            integrations: {
+                provider: {
+                    syncs: { top: { runs: 'every day', input: 'GithubIssue', output: 'GithubIssue', endpoint: 'GET /provider/top' } },
+                    actions: { createIssue: { endpoint: '/test', input: 'string', output: 'GithubIssue' } }
+                }
+            }
+        };
+        const parser = new NangoYamlParserV2({ raw: v2 });
+        parser.parse();
+        expect(parser.errors).toStrictEqual([]);
+        expect(parser.parsed).toStrictEqual({
+            integrations: [
+                {
+                    providerConfigKey: 'provider',
+                    syncs: [
+                        {
+                            auto_start: true,
+                            description: '',
+                            endpoints: [{ GET: '/provider/top' }],
+                            input: 'GithubIssue',
+                            name: 'top',
+                            output: ['GithubIssue'],
+                            runs: 'every day',
+                            scopes: [],
+                            sync_type: 'full',
+                            track_deletes: false,
+                            type: 'sync',
+                            usedModels: ['GithubIssue'],
+                            webhookSubscriptions: []
+                        }
+                    ],
+                    postConnectionScripts: [],
+                    actions: [
+                        {
+                            description: '',
+                            input: 'Anonymous_provider_action_createIssue_input',
+                            endpoint: { POST: '/test' },
+                            name: 'createIssue',
+                            output: ['GithubIssue'],
+                            scopes: [],
+                            type: 'action',
+                            usedModels: ['GithubIssue', 'Anonymous_provider_action_createIssue_input']
+                        }
+                    ]
+                }
+            ],
+            models: new Map([
+                ['GithubIssue', { name: 'GithubIssue', fields: [{ name: 'id', value: 'string', tsType: true, array: false, optional: false }] }],
+                [
+                    'Anonymous_provider_action_createIssue_input',
+                    {
+                        fields: [{ array: false, name: 'input', optional: false, tsType: true, value: 'string' }],
+                        isAnon: true,
+                        name: 'Anonymous_provider_action_createIssue_input'
+                    }
+                ]
+            ]),
+            yamlVersion: 'v2'
+        });
+    });
+    it('should handle input / output as literal', () => {
+        const v2 = {
+            models: {},
+            integrations: { provider: { syncs: { top: { runs: 'every day', input: 'boolean', output: 'foobar', endpoint: 'GET /provider/top' } } } }
+        };
+        const parser = new NangoYamlParserV2({ raw: v2 });
+        parser.parse();
+        expect(parser.errors).toStrictEqual([
+            new ParserErrorMissingId({ model: 'Anonymous_provider_sync_top_output', path: ['provider', 'syncs', 'top', '[output]'] })
+        ]);
+        expect(parser.warnings).toStrictEqual([new ParserErrorModelIsLiteral({ model: 'boolean', path: ['provider', 'syncs', 'top', '[input]'] })]);
+        expect(parser.parsed).toStrictEqual({
+            integrations: [
+                {
+                    providerConfigKey: 'provider',
+                    syncs: [
+                        {
+                            auto_start: true,
+                            description: '',
+                            endpoints: [{ GET: '/provider/top' }],
+                            input: 'Anonymous_provider_sync_top_input',
+                            name: 'top',
+                            output: ['Anonymous_provider_sync_top_output'],
+                            runs: 'every day',
+                            scopes: [],
+                            sync_type: 'full',
+                            track_deletes: false,
+                            type: 'sync',
+                            usedModels: ['Anonymous_provider_sync_top_output', 'Anonymous_provider_sync_top_input'],
+                            webhookSubscriptions: []
+                        }
+                    ],
+                    postConnectionScripts: [],
+                    actions: []
+                }
+            ],
+            models: new Map([
+                [
+                    'Anonymous_provider_sync_top_output',
+                    { name: 'Anonymous_provider_sync_top_output', fields: [{ name: 'output', value: 'foobar', array: false, optional: false }], isAnon: true }
+                ],
+                [
+                    'Anonymous_provider_sync_top_input',
+                    {
+                        name: 'Anonymous_provider_sync_top_input',
+                        fields: [{ name: 'input', value: 'boolean', tsType: true, array: false, optional: false }],
+                        isAnon: true
+                    }
+                ]
+            ]),
+            yamlVersion: 'v2'
+        });
+    });
+    it('should handle endpoint with model inside (found)', () => {
+        const v2 = {
+            models: { Found: { id: 'string' } },
+            integrations: {
+                provider: { actions: { getGithubIssue: { endpoint: 'GET /ticketing/tickets/{Found:id}' } } }
+            }
+        };
+        const parser = new NangoYamlParserV2({ raw: v2 });
+        parser.parse();
+        expect(parser.errors).toStrictEqual([]);
+        expect(parser.warnings).toStrictEqual([]);
+        expect(parser.parsed?.integrations[0]?.actions).toMatchObject([
+            {
+                endpoint: { GET: '/ticketing/tickets/{Found:id}' }
+            }
+        ]);
+    });
+    it('should handle endpoint with model inside (missing)', () => {
+        const v2 = {
+            models: {},
+            integrations: {
+                provider: { actions: { getGithubIssue: { endpoint: 'GET /ticketing/tickets/{Missing:id}' } } }
+            }
+        };
+        const parser = new NangoYamlParserV2({ raw: v2 });
+        parser.parse();
+        expect(parser.errors).toStrictEqual([new ParserErrorModelNotFound({ model: 'Missing', path: ['provider', 'syncs', 'getGithubIssue', '[endpoint]'] })]);
+        expect(parser.warnings).toStrictEqual([]);
+    });
+});
+//# sourceMappingURL=parser.v2.unit.test.js.map

package/dist/parser.v2.unit.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser.v2.unit.test.js","sourceRoot":"","sources":["../lib/parser.v2.unit.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAEnD,OAAO,EAAE,oBAAoB,EAAE,yBAAyB,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAExG,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;IACnB,EAAE,CAAC,cAAc,EAAE,GAAG,EAAE;QACpB,MAAM,EAAE,GAAgB;YACpB,MAAM,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE;YACzC,YAAY,EAAE;gBACV,QAAQ,EAAE;oBACN,KAAK,EAAE,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,mBAAmB,EAAE,EAAE;oBACjH,OAAO,EAAE,EAAE,WAAW,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,EAAE;iBAC1F;aACJ;SACJ,CAAC;QACF,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC;QAClD,MAAM,CAAC,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;QACxC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAkB;YACjD,YAAY,EAAE;gBACV;oBACI,iBAAiB,EAAE,UAAU;oBAC7B,KAAK,EAAE;wBACH;4BACI,UAAU,EAAE,IAAI;4BAChB,WAAW,EAAE,EAAE;4BACf,SAAS,EAAE,CAAC,EAAE,GAAG,EAAE,eAAe,EAAE,CAAC;4BACrC,KAAK,EAAE,aAAa;4BACpB,IAAI,EAAE,KAAK;4BACX,MAAM,EAAE,CAAC,aAAa,CAAC;4BACvB,IAAI,EAAE,WAAW;4BACjB,MAAM,EAAE,EAAE;4BACV,SAAS,EAAE,MAAM;4BACjB,aAAa,EAAE,KAAK;4BACpB,IAAI,EAAE,MAAM;4BACZ,UAAU,EAAE,CAAC,aAAa,CAAC;4BAC3B,oBAAoB,EAAE,EAAE;yBAC3B;qBACJ;oBACD,qBAAqB,EAAE,EAAE;oBACzB,OAAO,EAAE;wBACL;4BACI,WAAW,EAAE,EAAE;4BACf,KAAK,EAAE,6CAA6C;4BACpD,QAAQ,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;4BAC3B,IAAI,EAAE,aAAa;4BACnB,MAAM,EAAE,CAAC,aAAa,CAAC;4BACvB,MAAM,EAAE,EAAE;4BACV,IAAI,EAAE,QAAQ;4BACd,UAAU,EAAE,CAAC,aAAa,EAAE,6CAA6C,CAAC;yBAC7E;qBACJ;iBACJ;aACJ;YACD,MAAM,EAAE,IAAI,GAAG,CAAC;gBACZ,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;gBAChI;oBACI,6CAA6C;oBAC7C;wBACI,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;wBACzF,MAAM,EAAE,IAAI;wBACZ,IAAI,EAAE,6CAA6C;qBACtD;iBACJ;aACJ,CAAC;YACF,WAAW,EAAE,IAAI;SACpB,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QAC/C,MAAM,EAAE,GAAgB;YACpB,MAAM,EAAE,EAAE;YACV,YAAY,EAAE,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,mBAAmB,EAAE,EAAE,EAAE,EAAE;SAC3I,CAAC;QACF,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC;QAClD,MAAM,CAAC,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;YAChC,IAAI,oBAAoB,CAAC,EAAE,KAAK,EAAE,oCAAoC,EAAE,IAAI,EAAE,CAAC,UAAU,EAAE,OAAO,EAAE,KAAK,EAAE,UAAU,CAAC,EAAE,CAAC;SAC5H,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,aAAa,CAAC,CAAC,IAAI,yBAAyB,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,UAAU,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAC5I,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAkB;YACjD,YAAY,EAAE;gBACV;oBACI,iBAAiB,EAAE,UAAU;oBAC7B,KAAK,EAAE;wBACH;4BACI,UAAU,EAAE,IAAI;4BAChB,WAAW,EAAE,EAAE;4BACf,SAAS,EAAE,CAAC,EAAE,GAAG,EAAE,eAAe,EAAE,CAAC;4BACrC,KAAK,EAAE,mCAAmC;4BAC1C,IAAI,EAAE,KAAK;4BACX,MAAM,EAAE,CAAC,oCAAoC,CAAC;4BAC9C,IAAI,EAAE,WAAW;4BACjB,MAAM,EAAE,EAAE;4BACV,SAAS,EAAE,MAAM;4BACjB,aAAa,EAAE,KAAK;4BACpB,IAAI,EAAE,MAAM;4BACZ,UAAU,EAAE,CAAC,oCAAoC,EAAE,mCAAmC,CAAC;4BACvF,oBAAoB,EAAE,EAAE;yBAC3B;qBACJ;oBACD,qBAAqB,EAAE,EAAE;oBACzB,OAAO,EAAE,EAAE;iBACd;aACJ;YACD,MAAM,EAAE,IAAI,GAAG,CAAC;gBACZ;oBACI,oCAAoC;oBACpC,EAAE,IAAI,EAAE,oCAAoC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE;iBAC7I;gBACD;oBACI,mCAAmC;oBACnC;wBACI,IAAI,EAAE,mCAAmC;wBACzC,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;wBAC1F,MAAM,EAAE,IAAI;qBACf;iBACJ;aACJ,CAAC;YACF,WAAW,EAAE,IAAI;SACpB,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;QACxD,MAAM,EAAE,GAAgB;YACpB,MAAM,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE;YACnC,YAAY,EAAE;gBACV,QAAQ,EAAE,EAAE,OAAO,EAAE,EAAE,cAAc,EAAE,EAAE,QAAQ,EAAE,mCAAmC,EAAE,EAAE,EAAE;aAC/F;SACJ,CAAC;QACF,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC;QAClD,MAAM,CAAC,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;QACxC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;QAC1C,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,aAAa,CAAC;YAC1D;gBACI,QAAQ,EAAE,EAAE,GAAG,EAAE,+BAA+B,EAAE;aACrD;SACJ,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC1D,MAAM,EAAE,GAAgB;YACpB,MAAM,EAAE,EAAE;YACV,YAAY,EAAE;gBACV,QAAQ,EAAE,EAAE,OAAO,EAAE,EAAE,cAAc,EAAE,EAAE,QAAQ,EAAE,qCAAqC,EAAE,EAAE,EAAE;aACjG;SACJ,CAAC;QACF,MAAM,MAAM,GAAG,IAAI,iBAAiB,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC;QAClD,MAAM,CAAC,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,CAAC,IAAI,wBAAwB,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,UAAU,EAAE,OAAO,EAAE,gBAAgB,EAAE,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACvJ,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,26 @@
+{
+    "name": "@nangohq/nango-yaml",
+    "version": "0.40.1",
+    "type": "module",
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "scripts": {
+        "build": "rimraf ./dist && tsc"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/NangoHQ/nango.git",
+        "directory": "packages/nango-yaml"
+    },
+    "dependencies": {
+        "ms": "3.0.0-canary.1",
+        "js-yaml": "^4.1.0"
+    },
+    "devDependencies": {
+        "@nangohq/types": "^0.40.1",
+        "vitest": "0.33.0"
+    },
+    "files": [
+        "dist/**/*"
+    ]
+}