@nangohq/runner-sdk 0.69.45 → 0.69.47

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/scripts.d.ts CHANGED
@@ -28,6 +28,7 @@ export interface CreateSyncProps<TModels extends Record<string, ZodModel>, TMeta
28
28
  * You can call this endpoint to fetch records synced by the sync.
29
29
  * You need one endpoint per model.
30
30
  *
31
+ * @deprecated Endpoints are no longer required. This field will be removed in a future version.
31
32
  * @example
32
33
  * ```ts
33
34
  * endpoints: [{ method: 'GET', path: '/github/issues' }],
@@ -36,7 +37,7 @@ export interface CreateSyncProps<TModels extends Record<string, ZodModel>, TMeta
36
37
  * const res = await fetch('https://api.nango.dev/github/issues');
37
38
  * ```
38
39
  */
39
- endpoints: NangoSyncEndpointV2[];
40
+ endpoints?: NangoSyncEndpointV2[];
40
41
  /**
41
42
  * The frequency of the sync.
42
43
  *
@@ -188,6 +189,7 @@ export interface CreateActionProps<TInput extends z.ZodTypeAny, TOutput extends
188
189
  * The endpoint of the action.
189
190
  * You can call this endpoint to trigger the action.
190
191
  *
192
+ * @deprecated Endpoints are no longer required. This field will be removed in a future version.
191
193
  * @example
192
194
  * ```ts
193
195
  * endpoint: { method: 'POST', path: '/github/issues' },
@@ -201,7 +203,7 @@ export interface CreateActionProps<TInput extends z.ZodTypeAny, TOutput extends
201
203
  * });
202
204
  * ```
203
205
  */
204
- endpoint: NangoSyncEndpointV2;
206
+ endpoint?: NangoSyncEndpointV2;
205
207
  /**
206
208
  * The input required by the action when triggering it.
207
209
  *
@@ -1 +1 @@
1
- {"version":3,"file":"scripts.js","sourceRoot":"","sources":["../lib/scripts.ts"],"names":[],"mappings":"AAiLA;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,UAAU,CACtB,MAAwD;IAExD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;AACvC,CAAC;AA+HD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,YAAY,CAK1B,MAAkE;IAChE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,MAAM,EAAE,CAAC;AACzC,CAAC;AAoED;;GAEG;AACH,MAAM,UAAU,aAAa,CACzB,MAAkD;IAElD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,MAAM,EAAE,CAAC;AAC1C,CAAC"}
1
+ {"version":3,"file":"scripts.js","sourceRoot":"","sources":["../lib/scripts.ts"],"names":[],"mappings":"AAkLA;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,UAAU,CACtB,MAAwD;IAExD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;AACvC,CAAC;AAgID;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,YAAY,CAK1B,MAAkE;IAChE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,MAAM,EAAE,CAAC;AACzC,CAAC;AAoED;;GAEG;AACH,MAAM,UAAU,aAAa,CACzB,MAAkD;IAElD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,MAAM,EAAE,CAAC;AAC1C,CAAC"}
@@ -55,6 +55,26 @@ describe('scripts', () => {
55
55
  onWebhook: expect.any(Function)
56
56
  });
57
57
  });
58
+ it('should create a sync without endpoints', () => {
59
+ const sync = createSync({
60
+ description: 'Fetch issues from GitHub',
61
+ frequency: 'every hour',
62
+ models: {
63
+ issue: z.object({ id: z.string() })
64
+ },
65
+ exec: async (nango) => {
66
+ await nango.log('Hello, world!');
67
+ }
68
+ });
69
+ expect(sync).toStrictEqual({
70
+ description: 'Fetch issues from GitHub',
71
+ frequency: 'every hour',
72
+ type: 'sync',
73
+ models: expect.any(Object),
74
+ exec: expect.any(Function)
75
+ });
76
+ expect(sync.endpoints).toBeUndefined();
77
+ });
58
78
  it('should correctly infer the type of the nango object when no models are provided', () => {
59
79
  createSync({
60
80
  description: 'Fetch issues from GitHub',
@@ -76,6 +96,25 @@ describe('scripts', () => {
76
96
  });
77
97
  });
78
98
  describe('createAction', () => {
99
+ it('should create an action without endpoint', () => {
100
+ const action = createAction({
101
+ description: 'Create a new issue in GitHub',
102
+ input: z.object({ title: z.string() }),
103
+ output: z.object({ issueId: z.string() }),
104
+ exec: async (nango, input) => {
105
+ await nango.log('Hello, world!', input);
106
+ return { issueId: '123' };
107
+ }
108
+ });
109
+ expect(action).toStrictEqual({
110
+ description: 'Create a new issue in GitHub',
111
+ input: expect.any(Object),
112
+ output: expect.any(Object),
113
+ type: 'action',
114
+ exec: expect.any(Function)
115
+ });
116
+ expect(action.endpoint).toBeUndefined();
117
+ });
79
118
  it('should create an action', () => {
80
119
  const action = createAction({
81
120
  description: 'Create a new issue in GitHub',
@@ -1 +1 @@
1
- {"version":3,"file":"scripts.unit.test.js","sourceRoot":"","sources":["../lib/scripts.unit.test.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC5D,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAEvE,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACrB,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QACxB,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;YAC5B,MAAM,IAAI,GAAG,UAAU,CAAC;gBACpB,WAAW,EAAE,0BAA0B;gBACvC,SAAS,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;gBACtD,SAAS,EAAE,YAAY;gBACvB,MAAM,EAAE;oBACJ,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC;wBACZ,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;wBACd,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;wBACjB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;qBACnB,CAAC;iBACL;gBACD,QAAQ,EAAE,MAAM;gBAChB,YAAY,EAAE,KAAK;gBACnB,SAAS,EAAE,IAAI;gBACf,MAAM,EAAE,CAAC,WAAW,EAAE,YAAY,CAAC;gBACnC,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;gBACxC,oBAAoB,EAAE,EAAE;gBACxB,OAAO,EAAE,OAAO;gBAChB,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;oBAClB,MAAM,KAAK,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;oBAEjC,YAAY,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,EAAW,CAAC;oBACxE,YAAY,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,aAAa,EAAW,CAAC;oBAEpE,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,EAAW,CAAC;oBAC1E,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,aAAa,EAAW,CAAC;oBAEtE,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,EAAW,CAAC;oBAC1E,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,aAAa,EAAW,CAAC;oBAEtE,YAAY,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,aAAa,EAA6B,CAAC;oBAC7E,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,aAAa,EAAoB,CAAC;gBACnF,CAAC;gBACD,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;oBACvB,MAAM,KAAK,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;gBACrC,CAAC;aACJ,CAAC,CAAC;YAEH,MAAM,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC;gBACvB,WAAW,EAAE,0BAA0B;gBACvC,SAAS,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;gBACtD,SAAS,EAAE,YAAY;gBACvB,QAAQ,EAAE,MAAM;gBAChB,YAAY,EAAE,KAAK;gBACnB,SAAS,EAAE,IAAI;gBACf,MAAM,EAAE,CAAC,WAAW,EAAE,YAAY,CAAC;gBACnC,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;gBAC5B,oBAAoB,EAAE,EAAE;gBACxB,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE,OAAO;gBAChB,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;gBAC1B,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;gBAC1B,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;aAClC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iFAAiF,EAAE,GAAG,EAAE;YACvF,UAAU,CAAC;gBACP,WAAW,EAAE,0BAA0B;gBACvC,SAAS,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;gBACtD,SAAS,EAAE,YAAY;gBACvB,QAAQ,EAAE,MAAM;gBAChB,MAAM,EAAE,EAAE;gBACV,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE;oBACZ,YAAY,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;oBACvD,YAAY,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;oBAEvD,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;oBACzD,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;oBAEzD,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;oBACzD,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;oBAEzD,YAAY,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,aAAa,EAAkB,CAAC;oBAClE,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,aAAa,EAAS,CAAC;gBACxE,CAAC;aACJ,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC1B,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;YAC/B,MAAM,MAAM,GAAG,YAAY,CAAC;gBACxB,WAAW,EAAE,8BAA8B;gBAC3C,QAAQ,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE;gBACpD,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC;oBACZ,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;iBACpB,CAAC;gBACF,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC;oBACb,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;iBACtB,CAAC;gBACF,QAAQ,EAAE,CAAC,CAAC,IAAI,EAAE;gBAClB,MAAM,EAAE,CAAC,WAAW,EAAE,YAAY,CAAC;gBACnC,OAAO,EAAE,OAAO;gBAChB,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;oBACzB,MAAM,KAAK,CAAC,GAAG,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;oBACxC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;gBAC9B,CAAC;aACJ,CAAC,CAAC;YAEH,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;gBACzB,WAAW,EAAE,8BAA8B;gBAC3C,QAAQ,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE;gBACpD,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;gBACzB,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;gBAC1B,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;gBAC5B,MAAM,EAAE,CAAC,WAAW,EAAE,YAAY,CAAC;gBACnC,OAAO,EAAE,OAAO;gBAChB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;aAC7B,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC3B,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;YAChC,MAAM,OAAO,GAAG,aAAa,CAAC;gBAC1B,WAAW,EAAE,8BAA8B;gBAC3C,KAAK,EAAE,0BAA0B;gBACjC,QAAQ,EAAE,CAAC,CAAC,IAAI,EAAE;gBAClB,OAAO,EAAE,OAAO;gBAChB,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;oBAClB,MAAM,KAAK,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;gBACrC,CAAC;aACJ,CAAC,CAAC;YAEH,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;gBAC1B,WAAW,EAAE,8BAA8B;gBAC3C,KAAK,EAAE,0BAA0B;gBACjC,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;gBAC5B,OAAO,EAAE,OAAO;gBAChB,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;aAC7B,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
1
+ {"version":3,"file":"scripts.unit.test.js","sourceRoot":"","sources":["../lib/scripts.unit.test.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC5D,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAEvE,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACrB,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QACxB,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;YAC5B,MAAM,IAAI,GAAG,UAAU,CAAC;gBACpB,WAAW,EAAE,0BAA0B;gBACvC,SAAS,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;gBACtD,SAAS,EAAE,YAAY;gBACvB,MAAM,EAAE;oBACJ,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC;wBACZ,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;wBACd,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;wBACjB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;qBACnB,CAAC;iBACL;gBACD,QAAQ,EAAE,MAAM;gBAChB,YAAY,EAAE,KAAK;gBACnB,SAAS,EAAE,IAAI;gBACf,MAAM,EAAE,CAAC,WAAW,EAAE,YAAY,CAAC;gBACnC,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;gBACxC,oBAAoB,EAAE,EAAE;gBACxB,OAAO,EAAE,OAAO;gBAChB,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;oBAClB,MAAM,KAAK,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;oBAEjC,YAAY,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,EAAW,CAAC;oBACxE,YAAY,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,aAAa,EAAW,CAAC;oBAEpE,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,EAAW,CAAC;oBAC1E,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,aAAa,EAAW,CAAC;oBAEtE,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,EAAW,CAAC;oBAC1E,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,aAAa,EAAW,CAAC;oBAEtE,YAAY,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,aAAa,EAA6B,CAAC;oBAC7E,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,aAAa,EAAoB,CAAC;gBACnF,CAAC;gBACD,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;oBACvB,MAAM,KAAK,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;gBACrC,CAAC;aACJ,CAAC,CAAC;YAEH,MAAM,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC;gBACvB,WAAW,EAAE,0BAA0B;gBACvC,SAAS,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;gBACtD,SAAS,EAAE,YAAY;gBACvB,QAAQ,EAAE,MAAM;gBAChB,YAAY,EAAE,KAAK;gBACnB,SAAS,EAAE,IAAI;gBACf,MAAM,EAAE,CAAC,WAAW,EAAE,YAAY,CAAC;gBACnC,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;gBAC5B,oBAAoB,EAAE,EAAE;gBACxB,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE,OAAO;gBAChB,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;gBAC1B,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;gBAC1B,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;aAClC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;YAC9C,MAAM,IAAI,GAAG,UAAU,CAAC;gBACpB,WAAW,EAAE,0BAA0B;gBACvC,SAAS,EAAE,YAAY;gBACvB,MAAM,EAAE;oBACJ,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;iBACtC;gBACD,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;oBAClB,MAAM,KAAK,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;gBACrC,CAAC;aACJ,CAAC,CAAC;YAEH,MAAM,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC;gBACvB,WAAW,EAAE,0BAA0B;gBACvC,SAAS,EAAE,YAAY;gBACvB,IAAI,EAAE,MAAM;gBACZ,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;gBAC1B,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;aAC7B,CAAC,CAAC;YACH,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,aAAa,EAAE,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iFAAiF,EAAE,GAAG,EAAE;YACvF,UAAU,CAAC;gBACP,WAAW,EAAE,0BAA0B;gBACvC,SAAS,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;gBACtD,SAAS,EAAE,YAAY;gBACvB,QAAQ,EAAE,MAAM;gBAChB,MAAM,EAAE,EAAE;gBACV,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE;oBACZ,YAAY,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;oBACvD,YAAY,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;oBAEvD,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;oBACzD,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;oBAEzD,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;oBACzD,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;oBAEzD,YAAY,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,aAAa,EAAkB,CAAC;oBAClE,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,aAAa,EAAS,CAAC;gBACxE,CAAC;aACJ,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC1B,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;YAChD,MAAM,MAAM,GAAG,YAAY,CAAC;gBACxB,WAAW,EAAE,8BAA8B;gBAC3C,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;gBACtC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;gBACzC,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;oBACzB,MAAM,KAAK,CAAC,GAAG,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;oBACxC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;gBAC9B,CAAC;aACJ,CAAC,CAAC;YAEH,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;gBACzB,WAAW,EAAE,8BAA8B;gBAC3C,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;gBACzB,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;gBAC1B,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;aAC7B,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,aAAa,EAAE,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;YAC/B,MAAM,MAAM,GAAG,YAAY,CAAC;gBACxB,WAAW,EAAE,8BAA8B;gBAC3C,QAAQ,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE;gBACpD,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC;oBACZ,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;iBACpB,CAAC;gBACF,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC;oBACb,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;iBACtB,CAAC;gBACF,QAAQ,EAAE,CAAC,CAAC,IAAI,EAAE;gBAClB,MAAM,EAAE,CAAC,WAAW,EAAE,YAAY,CAAC;gBACnC,OAAO,EAAE,OAAO;gBAChB,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;oBACzB,MAAM,KAAK,CAAC,GAAG,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;oBACxC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;gBAC9B,CAAC;aACJ,CAAC,CAAC;YAEH,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;gBACzB,WAAW,EAAE,8BAA8B;gBAC3C,QAAQ,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE;gBACpD,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;gBACzB,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;gBAC1B,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;gBAC5B,MAAM,EAAE,CAAC,WAAW,EAAE,YAAY,CAAC;gBACnC,OAAO,EAAE,OAAO;gBAChB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;aAC7B,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC3B,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;YAChC,MAAM,OAAO,GAAG,aAAa,CAAC;gBAC1B,WAAW,EAAE,8BAA8B;gBAC3C,KAAK,EAAE,0BAA0B;gBACjC,QAAQ,EAAE,CAAC,CAAC,IAAI,EAAE;gBAClB,OAAO,EAAE,OAAO;gBAChB,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;oBAClB,MAAM,KAAK,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;gBACrC,CAAC;aACJ,CAAC,CAAC;YAEH,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC;gBAC1B,WAAW,EAAE,8BAA8B;gBAC3C,KAAK,EAAE,0BAA0B;gBACjC,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC;gBAC5B,OAAO,EAAE,OAAO;gBAChB,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;aAC7B,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
package/dist/sync.d.ts CHANGED
@@ -18,6 +18,9 @@ export declare abstract class NangoSyncBase<TModels extends Record<string, ZodMo
18
18
  abstract batchDelete<TModel extends RawModel = z.infer<TModels[TModelName]>>(results: (Pick<TModel, 'id'> & Partial<TModel>)[], model: TModelName): MaybePromise<boolean>;
19
19
  abstract batchUpdate<TModel extends RawModel = z.infer<TModels[TModelName]>>(results: (Pick<TModel, 'id'> & Partial<TModel>)[], model: TModelName): MaybePromise<boolean>;
20
20
  abstract getRecordsByIds<TKey = string | number, TModel extends RawModel = z.infer<TModels[TModelName]>>(ids: TKey[], model: TModelName): MaybePromise<Map<TKey, TModel>>;
21
+ abstract listRecords<TModel extends RawModel = z.infer<TModels[TModelName]>>(model: TModelName, options?: {
22
+ cursor?: string;
23
+ }): AsyncGenerator<TModel>;
21
24
  /**
22
25
  * @deprecated please use trackDeletesStart and trackDeletesEnd
23
26
  */
package/dist/sync.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"sync.js","sourceRoot":"","sources":["../lib/sync.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAOnD,MAAM,CAAC,MAAM,YAAY,GAAG,MAAM,CAAC;AAEnC,MAAM,OAAgB,aAKpB,SAAQ,eAAuC;IACtC,OAAO,GAAG,YAAY,CAAC;IAE9B,YAAY,CAAQ;IACpB,aAAa,GAAG,KAAK,CAAC;IAEtB,YAAY,MAAkB;QAC1B,KAAK,CAAC,MAAM,CAAC,CAAC;QAEd,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;YACtB,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QAC5C,CAAC;QAED,IAAI,MAAM,CAAC,aAAa,EAAE,CAAC;YACvB,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;QAC9C,CAAC;QAED,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;YACrB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,WAAW,CAAC;QACtC,CAAC;IACL,CAAC;IAEM,aAAa,CAAC,KAAa;QAC9B,IAAI,IAAI,CAAC,OAAO,KAAK,YAAY,EAAE,CAAC;YAChC,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,OAAO,GAAG,KAAK,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;IACvC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,SAAS,CAAyD,OAAiB,EAAE,KAAiB;QAC/G,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC1C,CAAC;IAsCS,eAAe,CAAC,KAAa,EAAE,OAAkB;QACvD,mBAAmB;QACnB,MAAM,SAAS,GAAqD,EAAE,CAAC;QACvE,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC3B,MAAM,UAAU,GAAG,YAAY,CAAC;gBAC5B,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,OAAO,IAAI,GAAG;gBACxC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gBACzC,UAAU,EAAE,IAAI,CAAC,UAAW,CAAC,kBAAkB;gBAC/C,SAAS,EAAE,KAAK;aACnB,CAAC,CAAC;YACH,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;gBACtB,SAAS;YACb,CAAC;YAED,SAAS,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;YAE7C,IAAI,IAAI,CAAC,WAAW,EAAE,mBAAmB,EAAE,CAAC;gBACxC,MAAM;YACV,CAAC;QACL,CAAC;QAED,OAAO,SAAS,CAAC;IACrB,CAAC;IAES,cAAc,CAAmB,OAAY;QACnD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1B,OAAO,OAAO,CAAC;QACnB,CAAC;QACD,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YAC1B,IAAI,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,iBAAiB,IAAI,MAAM,EAAE,CAAC;gBACtE,OAAO,MAAM,CAAC,eAAe,CAAC;YAClC,CAAC;YAED,OAAO,MAAM,CAAC;QAClB,CAAC,CAAC,CAAC;IACP,CAAC;CACJ"}
1
+ {"version":3,"file":"sync.js","sourceRoot":"","sources":["../lib/sync.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAOnD,MAAM,CAAC,MAAM,YAAY,GAAG,MAAM,CAAC;AAEnC,MAAM,OAAgB,aAKpB,SAAQ,eAAuC;IACtC,OAAO,GAAG,YAAY,CAAC;IAE9B,YAAY,CAAQ;IACpB,aAAa,GAAG,KAAK,CAAC;IAEtB,YAAY,MAAkB;QAC1B,KAAK,CAAC,MAAM,CAAC,CAAC;QAEd,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;YACtB,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QAC5C,CAAC;QAED,IAAI,MAAM,CAAC,aAAa,EAAE,CAAC;YACvB,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;QAC9C,CAAC;QAED,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;YACrB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,WAAW,CAAC;QACtC,CAAC;IACL,CAAC;IAEM,aAAa,CAAC,KAAa;QAC9B,IAAI,IAAI,CAAC,OAAO,KAAK,YAAY,EAAE,CAAC;YAChC,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,OAAO,GAAG,KAAK,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;IACvC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,SAAS,CAAyD,OAAiB,EAAE,KAAiB;QAC/G,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC1C,CAAC;IA6CS,eAAe,CAAC,KAAa,EAAE,OAAkB;QACvD,mBAAmB;QACnB,MAAM,SAAS,GAAqD,EAAE,CAAC;QACvE,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC3B,MAAM,UAAU,GAAG,YAAY,CAAC;gBAC5B,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,OAAO,IAAI,GAAG;gBACxC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gBACzC,UAAU,EAAE,IAAI,CAAC,UAAW,CAAC,kBAAkB;gBAC/C,SAAS,EAAE,KAAK;aACnB,CAAC,CAAC;YACH,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;gBACtB,SAAS;YACb,CAAC;YAED,SAAS,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;YAE7C,IAAI,IAAI,CAAC,WAAW,EAAE,mBAAmB,EAAE,CAAC;gBACxC,MAAM;YACV,CAAC;QACL,CAAC;QAED,OAAO,SAAS,CAAC;IACrB,CAAC;IAES,cAAc,CAAmB,OAAY;QACnD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1B,OAAO,OAAO,CAAC;QACnB,CAAC;QACD,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YAC1B,IAAI,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,iBAAiB,IAAI,MAAM,EAAE,CAAC;gBACtE,OAAO,MAAM,CAAC,eAAe,CAAC;YAClC,CAAC;YAED,OAAO,MAAM,CAAC;QAClB,CAAC,CAAC,CAAC;IACP,CAAC;CACJ"}
package/models.d.ts CHANGED
@@ -9,6 +9,7 @@ import type {
9
9
  HTTP_METHOD,
10
10
  RunnerFlags,
11
11
  PostPublicTrigger,
12
+ NangoRecord,
12
13
  Checkpoint
13
14
  } from '@nangohq/types';
14
15
  import type { ZodSchema, SafeParseSuccess } from 'zod';
@@ -438,6 +439,12 @@ export declare class NangoSync<TCheckpoint = Checkpoint> extends NangoAction {
438
439
  trackDeletesStart(model: string): Promise<void>;
439
440
  trackDeletesEnd(model: string): Promise<{ deletedKeys: string[] }>;
440
441
  getRecordsByIds<K = string | number, T = any>(ids: K[], model: string): Promise<Map<K, T>>;
442
+ listRecords<T extends Record<string, any> = Record<string, any>>(
443
+ model: string,
444
+ options?: {
445
+ cursor?: string;
446
+ }
447
+ ): AsyncGenerator<NangoRecord<T>>;
441
448
  getCheckpoint(): Promise<TCheckpoint | null>;
442
449
  saveCheckpoint(checkpoint: TCheckpoint): Promise<void>;
443
450
  clearCheckpoint(): Promise<void>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nangohq/runner-sdk",
3
- "version": "0.69.45",
3
+ "version": "0.69.47",
4
4
  "description": "Nango's Runner SDK",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -10,15 +10,15 @@
10
10
  "directory": "packages/runner-sdk"
11
11
  },
12
12
  "dependencies": {
13
- "@nangohq/node": "0.69.45",
14
- "@nangohq/providers": "0.69.45",
13
+ "@nangohq/node": "0.69.47",
14
+ "@nangohq/providers": "0.69.47",
15
15
  "ajv": "8.18.0",
16
16
  "ajv-formats": "3.0.1",
17
17
  "lodash-es": "4.17.23",
18
18
  "parse-link-header": "2.0.0"
19
19
  },
20
20
  "devDependencies": {
21
- "@nangohq/types": "0.69.45",
21
+ "@nangohq/types": "0.69.47",
22
22
  "@types/json-schema": "7.0.15",
23
23
  "axios": "1.13.5",
24
24
  "json-schema": "0.4.0",