@zapier/zapier-sdk 0.44.0 → 0.45.0
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/CHANGELOG.md +6 -0
- package/dist/index.cjs +94 -107
- package/dist/index.d.mts +2483 -2464
- package/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.mjs +94 -107
- package/dist/plugins/apps/index.d.ts +1 -1
- package/dist/plugins/apps/index.d.ts.map +1 -1
- package/dist/plugins/apps/index.js +4 -0
- package/dist/plugins/registry/index.d.ts +11 -16
- package/dist/plugins/registry/index.d.ts.map +1 -1
- package/dist/plugins/registry/index.js +9 -130
- package/dist/registry.d.ts +9 -0
- package/dist/registry.d.ts.map +1 -0
- package/dist/registry.js +77 -0
- package/dist/sdk.d.ts +20 -2
- package/dist/sdk.d.ts.map +1 -1
- package/dist/sdk.js +25 -9
- package/dist/types/plugin.d.ts +7 -1
- package/dist/types/plugin.d.ts.map +1 -1
- package/dist/types/registry.d.ts +49 -0
- package/dist/types/registry.d.ts.map +1 -0
- package/dist/types/registry.js +1 -0
- package/dist/types/sdk.d.ts +1 -78
- package/dist/types/sdk.d.ts.map +1 -1
- package/dist/utils/schema-utils.d.ts +1 -1
- package/dist/utils/schema-utils.d.ts.map +1 -1
- package/package.json +1 -1
package/dist/sdk.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../src/sdk.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,
|
|
1
|
+
{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../src/sdk.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,KAAK,EACV,aAAa,EACb,MAAM,EACN,cAAc,EACd,UAAU,EACX,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAiB,KAAK,cAAc,EAAE,MAAM,YAAY,CAAC;AA8ChE,MAAM,WAAW,gBAAiB,SAAQ,cAAc;CAAG;AAE3D,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,gBAAgB;;;;EAE5D;AAED,wBAAgB,SAAS;;cACW,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC;;;cAA1B,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC;;;kBAqBxB,MAAM;oBAAK,cAAc;cAcjD,SAAS,SAAS,cAAc;;kBAnCV,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC;;;;kBAA1B,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC;;;EAC7D;AA4ED;;;;GAIG;AACH,wBAAgB,8BAA8B,CAAC,OAAO,GAAE,gBAAqB;;cAlFzC,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC;;;;;;uwDAuF7D;AAED,wBAAgB,eAAe,CAAC,OAAO,GAAE,gBAAqB;;cAzF1B,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC;;;;;;uwDAiK7D;AAED,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC,OAAO,eAAe,CAAC,CAAC"}
|
package/dist/sdk.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
|
|
1
|
+
import { buildRegistry } from "./registry";
|
|
2
|
+
import { logDeprecation } from "./utils/logging";
|
|
2
3
|
import { appsPlugin } from "./plugins/apps/index";
|
|
3
4
|
import { fetchPlugin } from "./plugins/fetch/index";
|
|
4
|
-
import { registryPlugin } from "./plugins/registry/index";
|
|
5
5
|
import { apiPlugin } from "./plugins/api/index";
|
|
6
6
|
import { getProfilePlugin } from "./plugins/getProfile";
|
|
7
7
|
import { listAppsPlugin } from "./plugins/listApps";
|
|
@@ -13,7 +13,6 @@ import { listConnectionsPlugin } from "./plugins/listConnections";
|
|
|
13
13
|
import { getConnectionPlugin } from "./plugins/getConnection";
|
|
14
14
|
import { findFirstConnectionPlugin } from "./plugins/findFirstConnection";
|
|
15
15
|
import { findUniqueConnectionPlugin } from "./plugins/findUniqueConnection";
|
|
16
|
-
// Deprecated authentication plugins (thin wrappers for backward compatibility)
|
|
17
16
|
import { listAuthenticationsPlugin, getAuthenticationPlugin, findFirstAuthenticationPlugin, findUniqueAuthenticationPlugin, } from "./plugins/deprecated/authentications";
|
|
18
17
|
import { listClientCredentialsPlugin } from "./plugins/listClientCredentials";
|
|
19
18
|
import { createClientCredentialsPlugin } from "./plugins/createClientCredentials";
|
|
@@ -48,12 +47,24 @@ export function createSdk() {
|
|
|
48
47
|
// and its meta sub-property is deep-merged across plugins
|
|
49
48
|
function buildSdk(properties, context) {
|
|
50
49
|
const frozenContext = Object.freeze(context);
|
|
51
|
-
|
|
50
|
+
const registryCache = new Map();
|
|
51
|
+
const sdk = {
|
|
52
52
|
...properties,
|
|
53
53
|
get context() {
|
|
54
54
|
return frozenContext;
|
|
55
55
|
},
|
|
56
56
|
getContext: () => frozenContext, // runtime compat shim, not in types
|
|
57
|
+
getRegistry(options) {
|
|
58
|
+
const cacheKey = options?.package ?? "__all__";
|
|
59
|
+
if (!registryCache.has(cacheKey)) {
|
|
60
|
+
registryCache.set(cacheKey, buildRegistry({
|
|
61
|
+
sdk: sdk,
|
|
62
|
+
meta: frozenContext.meta,
|
|
63
|
+
packageFilter: options?.package,
|
|
64
|
+
}));
|
|
65
|
+
}
|
|
66
|
+
return registryCache.get(cacheKey);
|
|
67
|
+
},
|
|
57
68
|
addPlugin(plugin) {
|
|
58
69
|
const pluginResult = plugin({
|
|
59
70
|
...properties,
|
|
@@ -81,8 +92,18 @@ function buildSdk(properties, context) {
|
|
|
81
92
|
return buildSdk(mergedProperties, mergedContext);
|
|
82
93
|
},
|
|
83
94
|
};
|
|
95
|
+
return sdk;
|
|
84
96
|
}
|
|
97
|
+
/**
|
|
98
|
+
* @deprecated `getRegistry` is now built into every sdk, so the "without
|
|
99
|
+
* registry" form has no behavioral difference from {@link createZapierSdk}.
|
|
100
|
+
* Use {@link createZapierSdk} instead.
|
|
101
|
+
*/
|
|
85
102
|
export function createZapierSdkWithoutRegistry(options = {}) {
|
|
103
|
+
logDeprecation("createZapierSdkWithoutRegistry is deprecated; use createZapierSdk instead. getRegistry is now available on every sdk.");
|
|
104
|
+
return createZapierSdk(options);
|
|
105
|
+
}
|
|
106
|
+
export function createZapierSdk(options = {}) {
|
|
86
107
|
return (createSdk()
|
|
87
108
|
.addPlugin(createOptionsPlugin(options))
|
|
88
109
|
// Event emission (must be first to be available to other plugins)
|
|
@@ -140,8 +161,3 @@ export function createZapierSdkWithoutRegistry(options = {}) {
|
|
|
140
161
|
// Profile
|
|
141
162
|
.addPlugin(getProfilePlugin));
|
|
142
163
|
}
|
|
143
|
-
export function createZapierSdk(options = {}) {
|
|
144
|
-
return (createZapierSdkWithoutRegistry(options)
|
|
145
|
-
// Register plugins for CLI/MCP metadata
|
|
146
|
-
.addPlugin(registryPlugin));
|
|
147
|
-
}
|
package/dist/types/plugin.d.ts
CHANGED
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
* merges the plugin's result into the SDK, producing a new SDK.
|
|
12
12
|
*/
|
|
13
13
|
import type { z } from "zod";
|
|
14
|
+
import type { RegistryResult } from "./registry";
|
|
14
15
|
export interface PluginProvides extends Record<string, any> {
|
|
15
16
|
context?: {
|
|
16
17
|
meta?: Record<string, PluginMeta>;
|
|
@@ -51,8 +52,10 @@ export interface Plugin<TSdk = {}, TProvides extends PluginProvides = PluginProv
|
|
|
51
52
|
}): TProvides;
|
|
52
53
|
}
|
|
53
54
|
/**
|
|
54
|
-
* Takes an SDK shape and adds
|
|
55
|
+
* Takes an SDK shape and adds addPlugin and getRegistry methods to it.
|
|
55
56
|
* addPlugin merges a plugin's result into the shape, producing a new SDK.
|
|
57
|
+
* getRegistry is a lazy view over context.meta, available on every sdk
|
|
58
|
+
* produced by buildSdk regardless of plugin order.
|
|
56
59
|
*/
|
|
57
60
|
export type WithAddPlugin<T = {
|
|
58
61
|
context: {
|
|
@@ -60,5 +63,8 @@ export type WithAddPlugin<T = {
|
|
|
60
63
|
};
|
|
61
64
|
}> = T & {
|
|
62
65
|
addPlugin<TProvides extends PluginProvides>(plugin: Plugin<T, TProvides>): WithAddPlugin<T & TProvides>;
|
|
66
|
+
getRegistry(options?: {
|
|
67
|
+
package?: string;
|
|
68
|
+
}): RegistryResult;
|
|
63
69
|
};
|
|
64
70
|
//# sourceMappingURL=plugin.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../src/types/plugin.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;
|
|
1
|
+
{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../src/types/plugin.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAC7B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAGjD,MAAM,WAAW,cAAe,SAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IACzD,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QAClC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;CACH;AAED,MAAM,WAAW,UAAU;IACzB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAC7C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC;IAC1B,YAAY,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAChC,+DAA+D;IAC/D,OAAO,CAAC,EAAE,eAAe,GAAG,QAAQ,CAAC;IACrC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,MAAM,CACrB,IAAI,GAAG,EAAE,EACT,SAAS,SAAS,cAAc,GAAG,cAAc;IAEjD,CACE,GAAG,EAAE,IAAI,GAAG;QACV,OAAO,EAAE;YACP,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;SAClC,CAAC;KACH,GACA,SAAS,CAAC;CACd;AAED;;;;;GAKG;AACH,MAAM,MAAM,aAAa,CACvB,CAAC,GAAG;IAAE,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;KAAE,CAAA;CAAE,IACnD,CAAC,GAAG;IACN,SAAS,CAAC,SAAS,SAAS,cAAc,EACxC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,SAAS,CAAC,GAC3B,aAAa,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;IAChC,WAAW,CAAC,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,cAAc,CAAC;CAC7D,CAAC"}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import type { z } from "zod";
|
|
2
|
+
import type { OutputFormatter } from "../utils/schema-utils";
|
|
3
|
+
export interface FunctionRegistryEntry {
|
|
4
|
+
name: string;
|
|
5
|
+
/**
|
|
6
|
+
* Human-readable description of the function. Surfaced as CLI help text,
|
|
7
|
+
* MCP tool description, and README documentation. Prefer providing this
|
|
8
|
+
* directly rather than relying solely on inputSchema.describe().
|
|
9
|
+
*/
|
|
10
|
+
description?: string;
|
|
11
|
+
type?: "list" | "item" | "create" | "delete";
|
|
12
|
+
itemType?: string;
|
|
13
|
+
returnType?: string;
|
|
14
|
+
inputSchema?: z.ZodSchema;
|
|
15
|
+
inputParameters?: Array<{
|
|
16
|
+
name: string;
|
|
17
|
+
schema: z.ZodSchema;
|
|
18
|
+
}>;
|
|
19
|
+
outputSchema?: z.ZodSchema;
|
|
20
|
+
categories: string[];
|
|
21
|
+
resolvers?: Record<string, any>;
|
|
22
|
+
packages?: string[];
|
|
23
|
+
/** Confirmation prompt type - prompts user before executing */
|
|
24
|
+
confirm?: "create-secret" | "delete";
|
|
25
|
+
/**
|
|
26
|
+
* Optional deprecation metadata for commands.
|
|
27
|
+
*/
|
|
28
|
+
deprecation?: FunctionDeprecation;
|
|
29
|
+
/** Short flag aliases for CLI options (e.g., { request: "X", header: "H" }) */
|
|
30
|
+
aliases?: Record<string, string>;
|
|
31
|
+
/** Output formatter with optional page-level enrichment (mirrors resolvers for output) */
|
|
32
|
+
formatter?: OutputFormatter;
|
|
33
|
+
/** Defaults to true. Set to false to suppress --json (e.g. login/logout/init). */
|
|
34
|
+
supportsJsonOutput: boolean;
|
|
35
|
+
}
|
|
36
|
+
export interface FunctionDeprecation {
|
|
37
|
+
/** User-facing deprecation message for why/how to migrate */
|
|
38
|
+
message: string;
|
|
39
|
+
}
|
|
40
|
+
export interface RegistryResult {
|
|
41
|
+
functions: FunctionRegistryEntry[];
|
|
42
|
+
categories: {
|
|
43
|
+
key: string;
|
|
44
|
+
title: string;
|
|
45
|
+
titlePlural: string;
|
|
46
|
+
functions: string[];
|
|
47
|
+
}[];
|
|
48
|
+
}
|
|
49
|
+
//# sourceMappingURL=registry.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../src/types/registry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAC7B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAE7D,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAC7C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC;IAC1B,eAAe,CAAC,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,CAAC,CAAC,SAAS,CAAA;KAAE,CAAC,CAAC;IAC/D,YAAY,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC;IAC3B,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAChC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,+DAA+D;IAC/D,OAAO,CAAC,EAAE,eAAe,GAAG,QAAQ,CAAC;IACrC;;OAEG;IACH,WAAW,CAAC,EAAE,mBAAmB,CAAC;IAClC,+EAA+E;IAC/E,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,0FAA0F;IAC1F,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,kFAAkF;IAClF,kBAAkB,EAAE,OAAO,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAClC,6DAA6D;IAC7D,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,qBAAqB,EAAE,CAAC;IACnC,UAAU,EAAE;QACV,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,WAAW,EAAE,MAAM,CAAC;QACpB,SAAS,EAAE,MAAM,EAAE,CAAC;KACrB,EAAE,CAAC;CACL"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
package/dist/types/sdk.d.ts
CHANGED
|
@@ -5,7 +5,6 @@ import { z } from "zod";
|
|
|
5
5
|
import type { EventCallback } from "./events";
|
|
6
6
|
import type { EventEmissionConfig } from "../plugins/eventEmission";
|
|
7
7
|
import type { Manifest } from "../plugins/manifest";
|
|
8
|
-
import type { OutputFormatter } from "../utils/schema-utils";
|
|
9
8
|
export declare const BaseSdkOptionsSchema: z.ZodObject<{
|
|
10
9
|
credentials: z.ZodOptional<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodUnion<readonly [z.ZodObject<{
|
|
11
10
|
type: z.ZodOptional<z.ZodEnum<{
|
|
@@ -81,83 +80,7 @@ import type { GetConnectionSdkFunction } from "../plugins/getConnection/schemas"
|
|
|
81
80
|
import type { FindFirstConnectionSdkFunction } from "../plugins/findFirstConnection/schemas";
|
|
82
81
|
import type { FindUniqueConnectionSdkFunction } from "../plugins/findUniqueConnection/schemas";
|
|
83
82
|
import type { RelayRequestSdkFunction } from "../plugins/request/schemas";
|
|
84
|
-
|
|
85
|
-
import type { GetProfilePluginProvides } from "../plugins/getProfile";
|
|
86
|
-
import type { EventEmissionProvides } from "../plugins/eventEmission";
|
|
87
|
-
import type { ApiPluginProvides } from "../plugins/api";
|
|
88
|
-
import type { AppsPluginProvides, ZapierSdkApps } from "../plugins/apps";
|
|
89
|
-
import type { ActionProxy } from "../plugins/apps/schemas";
|
|
90
|
-
import type { FetchPluginProvides } from "../plugins/fetch";
|
|
91
|
-
import type { ListAppsPluginProvides } from "../plugins/listApps";
|
|
92
|
-
import type { GetAppPluginProvides } from "../plugins/getApp";
|
|
93
|
-
import type { ListActionsPluginProvides } from "../plugins/listActions";
|
|
94
|
-
import type { GetActionPluginProvides } from "../plugins/getAction";
|
|
95
|
-
import type { RunActionPluginProvides } from "../plugins/runAction";
|
|
96
|
-
import type { ListConnectionsPluginProvides } from "../plugins/listConnections";
|
|
97
|
-
import type { GetConnectionPluginProvides } from "../plugins/getConnection";
|
|
98
|
-
import type { FindFirstConnectionPluginProvides } from "../plugins/findFirstConnection";
|
|
99
|
-
import type { FindUniqueConnectionPluginProvides } from "../plugins/findUniqueConnection";
|
|
100
|
-
import type { ListAuthenticationsPluginProvides, GetAuthenticationPluginProvides, FindFirstAuthenticationPluginProvides, FindUniqueAuthenticationPluginProvides } from "../plugins/deprecated/authentications";
|
|
101
|
-
import type { ListClientCredentialsPluginProvides } from "../plugins/listClientCredentials";
|
|
102
|
-
import type { CreateClientCredentialsPluginProvides } from "../plugins/createClientCredentials";
|
|
103
|
-
import type { DeleteClientCredentialsPluginProvides } from "../plugins/deleteClientCredentials";
|
|
104
|
-
import type { ListInputFieldsPluginProvides } from "../plugins/listInputFields";
|
|
105
|
-
import type { GetInputFieldsSchemaPluginProvides } from "../plugins/getInputFieldsSchema";
|
|
106
|
-
import type { ListInputFieldChoicesPluginProvides } from "../plugins/listInputFieldChoices";
|
|
107
|
-
import type { RequestPluginProvides } from "../plugins/request";
|
|
108
|
-
import type { ManifestPluginProvides } from "../plugins/manifest";
|
|
109
|
-
import type { ListTablesPluginProvides } from "../plugins/tables/listTables";
|
|
110
|
-
import type { GetTablePluginProvides } from "../plugins/tables/getTable";
|
|
111
|
-
import type { DeleteTablePluginProvides } from "../plugins/tables/deleteTable";
|
|
112
|
-
import type { CreateTablePluginProvides } from "../plugins/tables/createTable";
|
|
113
|
-
import type { ListTableFieldsPluginProvides } from "../plugins/tables/listTableFields";
|
|
114
|
-
import type { CreateTableFieldsPluginProvides } from "../plugins/tables/createTableFields";
|
|
115
|
-
import type { DeleteTableFieldsPluginProvides } from "../plugins/tables/deleteTableFields";
|
|
116
|
-
import type { GetTableRecordPluginProvides } from "../plugins/tables/getTableRecord";
|
|
117
|
-
import type { ListTableRecordsPluginProvides } from "../plugins/tables/listTableRecords";
|
|
118
|
-
import type { CreateTableRecordsPluginProvides } from "../plugins/tables/createTableRecords";
|
|
119
|
-
import type { DeleteTableRecordsPluginProvides } from "../plugins/tables/deleteTableRecords";
|
|
120
|
-
import type { UpdateTableRecordsPluginProvides } from "../plugins/tables/updateTableRecords";
|
|
121
|
-
export interface FunctionRegistryEntry {
|
|
122
|
-
name: string;
|
|
123
|
-
/**
|
|
124
|
-
* Human-readable description of the function. Surfaced as CLI help text,
|
|
125
|
-
* MCP tool description, and README documentation. Prefer providing this
|
|
126
|
-
* directly rather than relying solely on inputSchema.describe().
|
|
127
|
-
*/
|
|
128
|
-
description?: string;
|
|
129
|
-
type?: "list" | "item" | "create" | "delete";
|
|
130
|
-
itemType?: string;
|
|
131
|
-
returnType?: string;
|
|
132
|
-
inputSchema?: z.ZodSchema;
|
|
133
|
-
inputParameters?: Array<{
|
|
134
|
-
name: string;
|
|
135
|
-
schema: z.ZodSchema;
|
|
136
|
-
}>;
|
|
137
|
-
outputSchema?: z.ZodSchema;
|
|
138
|
-
categories: string[];
|
|
139
|
-
resolvers?: Record<string, any>;
|
|
140
|
-
packages?: string[];
|
|
141
|
-
/** Confirmation prompt type - prompts user before executing */
|
|
142
|
-
confirm?: "create-secret" | "delete";
|
|
143
|
-
/**
|
|
144
|
-
* Optional deprecation metadata for commands.
|
|
145
|
-
*/
|
|
146
|
-
deprecation?: FunctionDeprecation;
|
|
147
|
-
/** Short flag aliases for CLI options (e.g., { request: "X", header: "H" }) */
|
|
148
|
-
aliases?: Record<string, string>;
|
|
149
|
-
/** Output formatter with optional page-level enrichment (mirrors resolvers for output) */
|
|
150
|
-
formatter?: OutputFormatter;
|
|
151
|
-
/** Defaults to true. Set to false to suppress --json (e.g. login/logout/init). */
|
|
152
|
-
supportsJsonOutput: boolean;
|
|
153
|
-
}
|
|
154
|
-
export interface FunctionDeprecation {
|
|
155
|
-
/** User-facing deprecation message for why/how to migrate */
|
|
156
|
-
message: string;
|
|
157
|
-
}
|
|
83
|
+
export type { FunctionRegistryEntry, FunctionDeprecation } from "./registry";
|
|
158
84
|
export interface ZapierSdkFunctions extends ListInputFieldsSdkFunction, GetConnectionSdkFunction, FindFirstConnectionSdkFunction, FindUniqueConnectionSdkFunction, RelayRequestSdkFunction {
|
|
159
85
|
}
|
|
160
|
-
export type ZapierSdk = RegistryPluginProvides & FetchPluginProvides & AppsPluginProvides & ListAppsPluginProvides & ManifestPluginProvides & GetAppPluginProvides & ListActionsPluginProvides & GetActionPluginProvides & RunActionPluginProvides & ListConnectionsPluginProvides & GetConnectionPluginProvides & FindFirstConnectionPluginProvides & FindUniqueConnectionPluginProvides & ListAuthenticationsPluginProvides & GetAuthenticationPluginProvides & FindFirstAuthenticationPluginProvides & FindUniqueAuthenticationPluginProvides & ListClientCredentialsPluginProvides & CreateClientCredentialsPluginProvides & DeleteClientCredentialsPluginProvides & ListInputFieldsPluginProvides & GetInputFieldsSchemaPluginProvides & ListInputFieldChoicesPluginProvides & RequestPluginProvides & GetProfilePluginProvides & EventEmissionProvides & ApiPluginProvides & ListTablesPluginProvides & GetTablePluginProvides & DeleteTablePluginProvides & CreateTablePluginProvides & ListTableFieldsPluginProvides & CreateTableFieldsPluginProvides & DeleteTableFieldsPluginProvides & GetTableRecordPluginProvides & ListTableRecordsPluginProvides & CreateTableRecordsPluginProvides & DeleteTableRecordsPluginProvides & UpdateTableRecordsPluginProvides & {
|
|
161
|
-
apps: ActionProxy & ZapierSdkApps;
|
|
162
|
-
};
|
|
163
86
|
//# sourceMappingURL=sdk.d.ts.map
|
package/dist/types/sdk.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../../src/types/sdk.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;
|
|
1
|
+
{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../../src/types/sdk.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAIpD,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA4F/B,CAAC;AAEH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAGlE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,oCAAoC,CAAC;AACrF,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,kCAAkC,CAAC;AACjF,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,wCAAwC,CAAC;AAC7F,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,yCAAyC,CAAC;AAC/F,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AAE1E,YAAY,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAG7E,MAAM,WAAW,kBACf,SAAQ,0BAA0B,EAChC,wBAAwB,EACxB,8BAA8B,EAC9B,+BAA+B,EAC/B,uBAAuB;CAAG"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"schema-utils.d.ts","sourceRoot":"","sources":["../../src/utils/schema-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"schema-utils.d.ts","sourceRoot":"","sources":["../../src/utils/schema-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAMxC,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,KAAK,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,QAAQ,GAAG,KAAK,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAC;KAC5D,CAAC,CAAC;CACJ;AAED,MAAM,WAAW,cAAc,CAAC,KAAK,GAAG,OAAO;IAC7C,MAAM,EAAE,CAAC,IAAI,EAAE,KAAK,KAAK,aAAa,CAAC;CACxC;AAED,MAAM,WAAW,eAAe,CAC9B,KAAK,GAAG,OAAO,EACf,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACjC,QAAQ,GAAG,OAAO;IAElB,KAAK,CAAC,EAAE,CACN,GAAG,EAAE,SAAS,EACd,MAAM,EAAE,OAAO,EACf,IAAI,EAAE,KAAK,EACX,OAAO,EAAE,QAAQ,GAAG,SAAS,KAC1B,OAAO,CAAC,QAAQ,CAAC,CAAC;IACvB,MAAM,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,QAAQ,KAAK,aAAa,CAAC;CAC5D;AAGD,wBAAgB,aAAa,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAC/C,MAAM,EAAE,CAAC,EACT,UAAU,EAAE,cAAc,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GACrC,CAAC,CAQH;AAGD,wBAAgB,eAAe,CAAC,WAAW,EAAE,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,OAAO,GAAG,SAAS,CAE7E;AAGD,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAClD,WAAW,EAAE,CAAC,EACd,YAAY,EAAE,CAAC,CAAC,OAAO,GACtB,CAAC,GAAG;IACL,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG;QAAE,YAAY,EAAE,CAAC,CAAC,OAAO,CAAA;KAAE,CAAC;CAC/C,CAQA;AAMD,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,KAAK,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,OAAO,CAAC;KAChB,CAAC,CAAC;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC;IACrC,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,GAAG,MAAM,CAAC;CACjD;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;CACxC;AAED,MAAM,WAAW,cAAe,SAAQ,QAAQ;IAC9C,IAAI,EAAE,QAAQ,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,CAAC;IAC1C,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,eAAe,CAC9B,KAAK,GAAG,OAAO,EACf,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CACjC,SAAQ,QAAQ;IAChB,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE,CACL,GAAG,EAAE,SAAS,EACd,cAAc,EAAE,OAAO,KACpB,WAAW,CACZ,KAAK,EAAE,GACP;QAAE,IAAI,EAAE,KAAK,EAAE,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,GACtC,aAAa,CAAC;QAAE,IAAI,EAAE,KAAK,EAAE,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CACxD,CAAC;IACF,MAAM,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,OAAO,KAAK,YAAY,CAAC;IAC1D,yGAAyG;IACzG,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC/B;;;;;;OAMG;IACH,uBAAuB,CAAC,EAAE,CACxB,GAAG,EAAE,SAAS,EACd,MAAM,EAAE,OAAO,KACZ,OAAO,CAAC;QAAE,aAAa,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC,CAAC;CACjD;AAGD,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAClD,MAAM,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAE7B,QAAQ,CAAC,EAAE,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;CACvC;AAED,MAAM,WAAW,cAAc,CAC7B,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACjC,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CACjC,SAAQ,QAAQ;IAChB,IAAI,EAAE,QAAQ,CAAC;IACf,KAAK,EAAE,CACL,GAAG,EAAE,SAAS,EACd,cAAc,EAAE,OAAO,KACpB,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAClC,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC;CACzD;AAED,MAAM,WAAW,aAAa,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAC9D,SAAQ,QAAQ;IAChB,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,CACL,GAAG,EAAE,SAAS,EACd,cAAc,EAAE,OAAO,KACpB,OAAO,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IACjD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,gBAAgB,CAC1B,KAAK,GAAG,OAAO,EACf,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAE/B,cAAc,GACd,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,GAC/B,cAAc,CAAC,OAAO,CAAC,GACvB,aAAa,CAAC,OAAO,CAAC,CAAC;AAG3B,MAAM,WAAW,cAAc,CAC7B,KAAK,GAAG,OAAO,EACf,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAEjC,QAAQ,EAAE,gBAAgB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;CAI5C;AAGD,wBAAgB,YAAY,CAC1B,CAAC,SAAS,CAAC,CAAC,OAAO,EACnB,KAAK,GAAG,OAAO,EACf,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACjC,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,CAMtD;AAMD,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,CAAC,CAAC,SAAS,GAAG,MAAM,GAAG,SAAS,CAE5E;AAED,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,GACjC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAWxB;AAMD,MAAM,WAAW,kBAAkB;IACjC,cAAc,EAAE;QACd,UAAU,EAAE,IAAI,CAAC;KAClB,CAAC;CACH;AAGD,wBAAgB,cAAc,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAChD,MAAM,EAAE,CAAC,GACR,CAAC,GAAG;IACL,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,kBAAkB,CAAC;CACtC,CAQA;AAWD,wBAAgB,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,GAAG,OAAO,CAqBvD"}
|