@mastra/client-js 1.21.2-alpha.2 → 1.22.0-alpha.4
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 +139 -0
- package/dist/docs/SKILL.md +2 -2
- package/dist/docs/assets/SOURCE_MAP.json +1 -1
- package/dist/docs/references/docs-agents-signals.md +132 -71
- package/dist/index.cjs +144 -8
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +144 -8
- package/dist/index.js.map +1 -1
- package/dist/resources/run.d.ts +25 -0
- package/dist/resources/run.d.ts.map +1 -1
- package/dist/resources/tool-provider.d.ts +57 -10
- package/dist/resources/tool-provider.d.ts.map +1 -1
- package/dist/route-types.generated.d.ts +1490 -76
- package/dist/route-types.generated.d.ts.map +1 -1
- package/dist/types.d.ts +74 -0
- package/dist/types.d.ts.map +1 -1
- package/package.json +5 -5
package/dist/resources/run.d.ts
CHANGED
|
@@ -177,6 +177,31 @@ export declare class Run extends BaseResource {
|
|
|
177
177
|
perStep?: boolean;
|
|
178
178
|
forEachIndex?: number;
|
|
179
179
|
}): Promise<WorkflowRunResult>;
|
|
180
|
+
/**
|
|
181
|
+
* Resumes a suspended workflow step without waiting for the workflow to complete (fire-and-forget)
|
|
182
|
+
* and returns immediately with the runId. The workflow continues executing in the background.
|
|
183
|
+
*
|
|
184
|
+
* Use this when you want to dispatch a resume and return immediately (e.g. an HTTP handler that
|
|
185
|
+
* never needs the resolved result inline). For Inngest-backed workflows this also avoids the
|
|
186
|
+
* `getRunOutput()` polling race that `resumeAsync()` can hit.
|
|
187
|
+
*
|
|
188
|
+
* TODO(v2): in Mastra v2 this fire-and-forget behavior should become the behavior of
|
|
189
|
+
* `resumeAsync()` (to mirror `start`/`resume` fire-and-forget semantics), and this method
|
|
190
|
+
* should be removed. Kept as a separate method in v1 to avoid a breaking contract change.
|
|
191
|
+
*
|
|
192
|
+
* @param params - Object containing the step, resumeData and requestContext
|
|
193
|
+
* @returns Promise containing the runId of the resumed workflow run
|
|
194
|
+
*/
|
|
195
|
+
resumeNoWait(params: {
|
|
196
|
+
step?: string | string[];
|
|
197
|
+
resumeData?: Record<string, any>;
|
|
198
|
+
requestContext?: RequestContext | Record<string, any>;
|
|
199
|
+
tracingOptions?: TracingOptions;
|
|
200
|
+
perStep?: boolean;
|
|
201
|
+
forEachIndex?: number;
|
|
202
|
+
}): Promise<{
|
|
203
|
+
runId: string;
|
|
204
|
+
}>;
|
|
180
205
|
/**
|
|
181
206
|
* Resumes a suspended workflow step that uses stream asynchronously and returns a promise that resolves when the workflow is complete
|
|
182
207
|
* @param params - Object containing the step, resumeData and requestContext
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../src/resources/run.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAGzG,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAkBtC,qBAAa,GAAI,SAAQ,YAAY;IAGjC,OAAO,CAAC,UAAU;aACF,KAAK,EAAE,MAAM;gBAF7B,OAAO,EAAE,aAAa,EACd,UAAU,EAAE,MAAM,EACV,KAAK,EAAE,MAAM;IAK/B;;OAEG;IACH,OAAO,CAAC,0BAA0B;IAkClC;;;;OAIG;IACH,SAAS,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAMzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4DG;IACH,MAAM,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAMtC;;;;OAIG;IACH,KAAK,CAAC,MAAM,EAAE;QACZ,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC/B,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACnC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtD,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAchC;;;;OAIG;IACH,MAAM,CAAC,EACL,IAAI,EACJ,UAAU,EACV,cAAc,EACd,OAAO,EACP,YAAY,EACZ,GAAG,IAAI,EACR,EAAE;QACD,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QACzB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACjC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtD,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAehC;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE;QACjB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC/B,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACnC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtD,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAoB9B;;;;OAIG;IACG,MAAM,CAAC,MAAM,EAAE;QACnB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC/B,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACnC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtD,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,cAAc,CAAC,EAAE,OAAO,CAAC;KAC1B,GAAG,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC;IAgC5D;;;;;;;;;;;;;;;;OAgBG;IACG,OAAO,CAAC,MAAM,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC;IAwBrG;;;;OAIG;IACG,aAAa;IAInB;;;;OAIG;IACH,WAAW,CAAC,MAAM,EAAE;QAClB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QACzB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACjC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtD,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAe9B;;;;OAIG;IACG,YAAY,CAAC,MAAM,EAAE;QACzB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QACzB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACjC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtD,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,GAAG,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC;IAgC5D;;;;OAIG;IACH,OAAO,CAAC,MAAM,EAAE;QACd,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtD,cAAc,CAAC,EAAE,cAAc,CAAC;KACjC,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAWhC;;;;OAIG;IACH,YAAY,CAAC,MAAM,CAAC,EAAE;QACpB,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtD,cAAc,CAAC,EAAE,cAAc,CAAC;KACjC,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAW9B;;;;OAIG;IACH,UAAU,CAAC,EAAE,cAAc,EAAE,oBAAoB,EAAE,GAAG,MAAM,EAAE,EAAE,gBAAgB,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAW/G;;;;OAIG;IACH,eAAe,CAAC,EAAE,cAAc,EAAE,oBAAoB,EAAE,GAAG,MAAM,EAAE,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAWlH;;;;OAIG;IACG,gBAAgB,CAAC,EACrB,cAAc,EAAE,oBAAoB,EACpC,GAAG,MAAM,EACV,EAAE,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC;CAyB/E"}
|
|
1
|
+
{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../src/resources/run.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAGzG,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAkBtC,qBAAa,GAAI,SAAQ,YAAY;IAGjC,OAAO,CAAC,UAAU;aACF,KAAK,EAAE,MAAM;gBAF7B,OAAO,EAAE,aAAa,EACd,UAAU,EAAE,MAAM,EACV,KAAK,EAAE,MAAM;IAK/B;;OAEG;IACH,OAAO,CAAC,0BAA0B;IAkClC;;;;OAIG;IACH,SAAS,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAMzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4DG;IACH,MAAM,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAMtC;;;;OAIG;IACH,KAAK,CAAC,MAAM,EAAE;QACZ,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC/B,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACnC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtD,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAchC;;;;OAIG;IACH,MAAM,CAAC,EACL,IAAI,EACJ,UAAU,EACV,cAAc,EACd,OAAO,EACP,YAAY,EACZ,GAAG,IAAI,EACR,EAAE;QACD,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QACzB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACjC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtD,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAehC;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE;QACjB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC/B,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACnC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtD,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAoB9B;;;;OAIG;IACG,MAAM,CAAC,MAAM,EAAE;QACnB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC/B,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACnC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtD,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,cAAc,CAAC,EAAE,OAAO,CAAC;KAC1B,GAAG,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC;IAgC5D;;;;;;;;;;;;;;;;OAgBG;IACG,OAAO,CAAC,MAAM,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC;IAwBrG;;;;OAIG;IACG,aAAa;IAInB;;;;OAIG;IACH,WAAW,CAAC,MAAM,EAAE;QAClB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QACzB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACjC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtD,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAe9B;;;;;;;;;;;;;;OAcG;IACH,YAAY,CAAC,MAAM,EAAE;QACnB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QACzB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACjC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtD,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAe9B;;;;OAIG;IACG,YAAY,CAAC,MAAM,EAAE;QACzB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QACzB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACjC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtD,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,GAAG,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC;IAgC5D;;;;OAIG;IACH,OAAO,CAAC,MAAM,EAAE;QACd,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtD,cAAc,CAAC,EAAE,cAAc,CAAC;KACjC,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAWhC;;;;OAIG;IACH,YAAY,CAAC,MAAM,CAAC,EAAE;QACpB,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtD,cAAc,CAAC,EAAE,cAAc,CAAC;KACjC,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAW9B;;;;OAIG;IACH,UAAU,CAAC,EAAE,cAAc,EAAE,oBAAoB,EAAE,GAAG,MAAM,EAAE,EAAE,gBAAgB,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAW/G;;;;OAIG;IACH,eAAe,CAAC,EAAE,cAAc,EAAE,oBAAoB,EAAE,GAAG,MAAM,EAAE,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAWlH;;;;OAIG;IACG,gBAAgB,CAAC,EACrB,cAAc,EAAE,oBAAoB,EACpC,GAAG,MAAM,EACV,EAAE,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC;CAyB/E"}
|
|
@@ -1,27 +1,74 @@
|
|
|
1
|
-
import type { ClientOptions, ListToolProviderToolkitsResponse, ListToolProviderToolsParams, ListToolProviderToolsResponse,
|
|
1
|
+
import type { AuthorizeToolProviderParams, AuthorizeToolProviderResponse, ClientOptions, DisconnectToolProviderConnectionParams, DisconnectToolProviderConnectionResponse, GetToolProviderConnectionUsageParams, GetToolProviderConnectionUsageResponse, GetToolProviderToolSchemaResponse, ListToolProviderConnectionFieldsParams, ListToolProviderConnectionFieldsResponse, ListToolProviderConnectionsParams, ListToolProviderConnectionsResponse, ListToolProviderToolkitsResponse, ListToolProviderToolsParams, ListToolProviderToolsResponse, ToolProviderAuthStatusResponse, ToolProviderConnectionStatusParams, ToolProviderConnectionStatusResponse, ToolProviderHealthResponse } from '../types.js';
|
|
2
2
|
import { BaseResource } from './base.js';
|
|
3
3
|
/**
|
|
4
|
-
* Resource for interacting with a specific tool provider
|
|
4
|
+
* Resource for interacting with a specific tool provider.
|
|
5
|
+
*
|
|
6
|
+
* Exposes the catalog (toolkits + tools), the OAuth surface (authorize +
|
|
7
|
+
* auth-status + connection-status), the lifecycle surface (connections list /
|
|
8
|
+
* disconnect / usage / fields), and a provider-level health check.
|
|
5
9
|
*/
|
|
6
10
|
export declare class ToolProvider extends BaseResource {
|
|
7
11
|
private providerId;
|
|
8
12
|
constructor(options: ClientOptions, providerId: string);
|
|
9
13
|
/**
|
|
10
|
-
* Lists available toolkits from this provider
|
|
11
|
-
* @returns Promise containing list of toolkits
|
|
14
|
+
* Lists available toolkits from this provider.
|
|
12
15
|
*/
|
|
13
16
|
listToolkits(): Promise<ListToolProviderToolkitsResponse>;
|
|
14
17
|
/**
|
|
15
|
-
* Lists available tools from this provider, with optional filtering
|
|
16
|
-
* @param params - Optional filtering and pagination parameters
|
|
17
|
-
* @returns Promise containing list of tools
|
|
18
|
+
* Lists available tools from this provider, with optional filtering.
|
|
18
19
|
*/
|
|
19
20
|
listTools(params?: ListToolProviderToolsParams): Promise<ListToolProviderToolsResponse>;
|
|
20
21
|
/**
|
|
21
|
-
* Gets the input schema for a specific tool
|
|
22
|
-
* @param toolSlug - The slug of the tool
|
|
23
|
-
* @returns Promise containing the tool's JSON schema
|
|
22
|
+
* Gets the input schema for a specific tool.
|
|
24
23
|
*/
|
|
25
24
|
getToolSchema(toolSlug: string): Promise<GetToolProviderToolSchemaResponse>;
|
|
25
|
+
/**
|
|
26
|
+
* Starts an OAuth flow for a (toolkit, connectionId) pair. Returns a
|
|
27
|
+
* redirect URL and an opaque auth handle to poll with `getAuthStatus`.
|
|
28
|
+
*/
|
|
29
|
+
authorize(params: AuthorizeToolProviderParams): Promise<AuthorizeToolProviderResponse>;
|
|
30
|
+
/**
|
|
31
|
+
* Polls the OAuth flow status for an outstanding authorize call.
|
|
32
|
+
*/
|
|
33
|
+
getAuthStatus(authId: string): Promise<ToolProviderAuthStatusResponse>;
|
|
34
|
+
/**
|
|
35
|
+
* Batch-checks whether a set of (connectionId, toolkit) tuples are
|
|
36
|
+
* currently connected.
|
|
37
|
+
*/
|
|
38
|
+
getConnectionStatus(params: ToolProviderConnectionStatusParams): Promise<ToolProviderConnectionStatusResponse>;
|
|
39
|
+
/**
|
|
40
|
+
* Lists existing provider connections, scoped to a toolkit.
|
|
41
|
+
*
|
|
42
|
+
* Default: the connection owner is resolved server-side from the request's
|
|
43
|
+
* auth context. Admin callers (with `tool-providers:admin` permission) may
|
|
44
|
+
* pass `authorId` to target a specific author, or omit it to receive
|
|
45
|
+
* connections across all authors known to `tool_provider_connections` for
|
|
46
|
+
* this provider/toolkit. Pagination is page-based via `page` (1-indexed)
|
|
47
|
+
* and `perPage` (default 50, max 200).
|
|
48
|
+
*/
|
|
49
|
+
listConnections(params: ListToolProviderConnectionsParams): Promise<ListToolProviderConnectionsResponse>;
|
|
50
|
+
/**
|
|
51
|
+
* Lists provider-specific fields the picker should collect before
|
|
52
|
+
* initiating a new connection (e.g. Confluence subdomain). Most toolkits
|
|
53
|
+
* return an empty array.
|
|
54
|
+
*/
|
|
55
|
+
listConnectionFields(params: ListToolProviderConnectionFieldsParams): Promise<ListToolProviderConnectionFieldsResponse>;
|
|
56
|
+
/**
|
|
57
|
+
* Disconnects (revokes + deletes) a persisted connection.
|
|
58
|
+
*
|
|
59
|
+
* Without `force: true` the server refuses if any agent still pins the
|
|
60
|
+
* connection. With `force: true` the provider-side revoke is best-effort
|
|
61
|
+
* (errors are tolerated) and the local row is always removed.
|
|
62
|
+
*/
|
|
63
|
+
disconnectConnection(connectionId: string, params?: DisconnectToolProviderConnectionParams): Promise<DisconnectToolProviderConnectionResponse>;
|
|
64
|
+
/**
|
|
65
|
+
* Lists the agents that currently pin a given connection. Used by the
|
|
66
|
+
* picker to warn the user before disconnecting a shared account.
|
|
67
|
+
*/
|
|
68
|
+
getConnectionUsage(connectionId: string, params?: GetToolProviderConnectionUsageParams): Promise<GetToolProviderConnectionUsageResponse>;
|
|
69
|
+
/**
|
|
70
|
+
* Returns provider-level health (config, reachability, etc.).
|
|
71
|
+
*/
|
|
72
|
+
getHealth(): Promise<ToolProviderHealthResponse>;
|
|
26
73
|
}
|
|
27
74
|
//# sourceMappingURL=tool-provider.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tool-provider.d.ts","sourceRoot":"","sources":["../../src/resources/tool-provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,gCAAgC,EAChC,2BAA2B,EAC3B,6BAA6B,EAC7B,
|
|
1
|
+
{"version":3,"file":"tool-provider.d.ts","sourceRoot":"","sources":["../../src/resources/tool-provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,2BAA2B,EAC3B,6BAA6B,EAC7B,aAAa,EACb,sCAAsC,EACtC,wCAAwC,EACxC,oCAAoC,EACpC,sCAAsC,EACtC,iCAAiC,EACjC,sCAAsC,EACtC,wCAAwC,EACxC,iCAAiC,EACjC,mCAAmC,EACnC,gCAAgC,EAChC,2BAA2B,EAC3B,6BAA6B,EAC7B,8BAA8B,EAC9B,kCAAkC,EAClC,oCAAoC,EACpC,0BAA0B,EAC3B,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAEtC;;;;;;GAMG;AACH,qBAAa,YAAa,SAAQ,YAAY;IAG1C,OAAO,CAAC,UAAU;gBADlB,OAAO,EAAE,aAAa,EACd,UAAU,EAAE,MAAM;IAK5B;;OAEG;IACH,YAAY,IAAI,OAAO,CAAC,gCAAgC,CAAC;IAIzD;;OAEG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC,6BAA6B,CAAC;IAsBvF;;OAEG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,iCAAiC,CAAC;IAM3E;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,2BAA2B,GAAG,OAAO,CAAC,6BAA6B,CAAC;IAOtF;;OAEG;IACH,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,8BAA8B,CAAC;IAMtE;;;OAGG;IACH,mBAAmB,CAAC,MAAM,EAAE,kCAAkC,GAAG,OAAO,CAAC,oCAAoC,CAAC;IAO9G;;;;;;;;;OASG;IACH,eAAe,CAAC,MAAM,EAAE,iCAAiC,GAAG,OAAO,CAAC,mCAAmC,CAAC;IAoBxG;;;;OAIG;IACH,oBAAoB,CAClB,MAAM,EAAE,sCAAsC,GAC7C,OAAO,CAAC,wCAAwC,CAAC;IAQpD;;;;;;OAMG;IACH,oBAAoB,CAClB,YAAY,EAAE,MAAM,EACpB,MAAM,CAAC,EAAE,sCAAsC,GAC9C,OAAO,CAAC,wCAAwC,CAAC;IAmBpD;;;OAGG;IACH,kBAAkB,CAChB,YAAY,EAAE,MAAM,EACpB,MAAM,CAAC,EAAE,oCAAoC,GAC5C,OAAO,CAAC,sCAAsC,CAAC;IAalD;;OAEG;IACH,SAAS,IAAI,OAAO,CAAC,0BAA0B,CAAC;CAGjD"}
|