@documenso/sdk-typescript 0.1.2 → 0.2.0

package/src/mcp-server/scopes.ts

@@ -0,0 +1,7 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export const mcpScopes = [] as const;
+
+export type MCPScope = (typeof mcpScopes)[number];

package/src/mcp-server/server.ts

@@ -0,0 +1,145 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { DocumensoCore } from "../core.js";
+import { SDKOptions } from "../lib/config.js";
+import type { ConsoleLogger } from "./console-logger.js";
+import { createRegisterPrompt } from "./prompts.js";
+import {
+  createRegisterResource,
+  createRegisterResourceTemplate,
+} from "./resources.js";
+import { MCPScope } from "./scopes.js";
+import { createRegisterTool } from "./tools.js";
+import { tool$documentsCreateV0 } from "./tools/documentsCreateV0.js";
+import { tool$documentsDelete } from "./tools/documentsDelete.js";
+import { tool$documentsDistribute } from "./tools/documentsDistribute.js";
+import { tool$documentsDuplicate } from "./tools/documentsDuplicate.js";
+import { tool$documentsFieldsCreate } from "./tools/documentsFieldsCreate.js";
+import { tool$documentsFieldsCreateMany } from "./tools/documentsFieldsCreateMany.js";
+import { tool$documentsFieldsDelete } from "./tools/documentsFieldsDelete.js";
+import { tool$documentsFieldsGet } from "./tools/documentsFieldsGet.js";
+import { tool$documentsFieldsUpdate } from "./tools/documentsFieldsUpdate.js";
+import { tool$documentsFieldsUpdateMany } from "./tools/documentsFieldsUpdateMany.js";
+import { tool$documentsFind } from "./tools/documentsFind.js";
+import { tool$documentsGet } from "./tools/documentsGet.js";
+import { tool$documentsMoveToTeam } from "./tools/documentsMoveToTeam.js";
+import { tool$documentsRecipientsCreate } from "./tools/documentsRecipientsCreate.js";
+import { tool$documentsRecipientsCreateMany } from "./tools/documentsRecipientsCreateMany.js";
+import { tool$documentsRecipientsDelete } from "./tools/documentsRecipientsDelete.js";
+import { tool$documentsRecipientsGet } from "./tools/documentsRecipientsGet.js";
+import { tool$documentsRecipientsUpdate } from "./tools/documentsRecipientsUpdate.js";
+import { tool$documentsRecipientsUpdateMany } from "./tools/documentsRecipientsUpdateMany.js";
+import { tool$documentsRedistribute } from "./tools/documentsRedistribute.js";
+import { tool$documentsUpdate } from "./tools/documentsUpdate.js";
+import { tool$templatesDelete } from "./tools/templatesDelete.js";
+import { tool$templatesDirectLinkCreate } from "./tools/templatesDirectLinkCreate.js";
+import { tool$templatesDirectLinkDelete } from "./tools/templatesDirectLinkDelete.js";
+import { tool$templatesDirectLinkToggle } from "./tools/templatesDirectLinkToggle.js";
+import { tool$templatesDuplicate } from "./tools/templatesDuplicate.js";
+import { tool$templatesFieldsCreate } from "./tools/templatesFieldsCreate.js";
+import { tool$templatesFieldsCreateMany } from "./tools/templatesFieldsCreateMany.js";
+import { tool$templatesFieldsDelete } from "./tools/templatesFieldsDelete.js";
+import { tool$templatesFieldsGet } from "./tools/templatesFieldsGet.js";
+import { tool$templatesFieldsUpdate } from "./tools/templatesFieldsUpdate.js";
+import { tool$templatesFieldsUpdateMany } from "./tools/templatesFieldsUpdateMany.js";
+import { tool$templatesFind } from "./tools/templatesFind.js";
+import { tool$templatesGet } from "./tools/templatesGet.js";
+import { tool$templatesMoveToTeam } from "./tools/templatesMoveToTeam.js";
+import { tool$templatesRecipientsCreate } from "./tools/templatesRecipientsCreate.js";
+import { tool$templatesRecipientsCreateMany } from "./tools/templatesRecipientsCreateMany.js";
+import { tool$templatesRecipientsDelete } from "./tools/templatesRecipientsDelete.js";
+import { tool$templatesRecipientsGet } from "./tools/templatesRecipientsGet.js";
+import { tool$templatesRecipientsUpdate } from "./tools/templatesRecipientsUpdate.js";
+import { tool$templatesRecipientsUpdateMany } from "./tools/templatesRecipientsUpdateMany.js";
+import { tool$templatesUpdate } from "./tools/templatesUpdate.js";
+import { tool$templatesUse } from "./tools/templatesUse.js";
+
+export function createMCPServer(deps: {
+  logger: ConsoleLogger;
+  allowedTools?: string[] | undefined;
+  scopes?: MCPScope[] | undefined;
+  serverURL?: string | undefined;
+  apiKey?: SDKOptions["apiKey"] | undefined;
+  serverIdx?: SDKOptions["serverIdx"] | undefined;
+}) {
+  const server = new McpServer({
+    name: "Documenso",
+    version: "0.2.0",
+  });
+
+  const client = new DocumensoCore({
+    apiKey: deps.apiKey,
+    serverURL: deps.serverURL,
+    serverIdx: deps.serverIdx,
+  });
+
+  const scopes = new Set(deps.scopes);
+
+  const allowedTools = deps.allowedTools && new Set(deps.allowedTools);
+  const tool = createRegisterTool(
+    deps.logger,
+    server,
+    client,
+    scopes,
+    allowedTools,
+  );
+  const resource = createRegisterResource(deps.logger, server, client, scopes);
+  const resourceTemplate = createRegisterResourceTemplate(
+    deps.logger,
+    server,
+    client,
+    scopes,
+  );
+  const prompt = createRegisterPrompt(deps.logger, server, client, scopes);
+  const register = { tool, resource, resourceTemplate, prompt };
+  void register; // suppress unused warnings
+
+  tool(tool$documentsFind);
+  tool(tool$documentsGet);
+  tool(tool$documentsCreateV0);
+  tool(tool$documentsUpdate);
+  tool(tool$documentsDelete);
+  tool(tool$documentsMoveToTeam);
+  tool(tool$documentsDistribute);
+  tool(tool$documentsRedistribute);
+  tool(tool$documentsDuplicate);
+  tool(tool$templatesFind);
+  tool(tool$templatesGet);
+  tool(tool$templatesUpdate);
+  tool(tool$templatesDuplicate);
+  tool(tool$templatesDelete);
+  tool(tool$templatesUse);
+  tool(tool$templatesMoveToTeam);
+  tool(tool$documentsFieldsGet);
+  tool(tool$documentsFieldsCreate);
+  tool(tool$documentsFieldsCreateMany);
+  tool(tool$documentsFieldsUpdate);
+  tool(tool$documentsFieldsUpdateMany);
+  tool(tool$documentsFieldsDelete);
+  tool(tool$documentsRecipientsGet);
+  tool(tool$documentsRecipientsCreate);
+  tool(tool$documentsRecipientsCreateMany);
+  tool(tool$documentsRecipientsUpdate);
+  tool(tool$documentsRecipientsUpdateMany);
+  tool(tool$documentsRecipientsDelete);
+  tool(tool$templatesFieldsCreate);
+  tool(tool$templatesFieldsGet);
+  tool(tool$templatesFieldsCreateMany);
+  tool(tool$templatesFieldsUpdate);
+  tool(tool$templatesFieldsUpdateMany);
+  tool(tool$templatesFieldsDelete);
+  tool(tool$templatesRecipientsGet);
+  tool(tool$templatesRecipientsCreate);
+  tool(tool$templatesRecipientsCreateMany);
+  tool(tool$templatesRecipientsUpdate);
+  tool(tool$templatesRecipientsUpdateMany);
+  tool(tool$templatesRecipientsDelete);
+  tool(tool$templatesDirectLinkCreate);
+  tool(tool$templatesDirectLinkDelete);
+  tool(tool$templatesDirectLinkToggle);
+
+  return server;
+}

package/src/mcp-server/shared.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { bytesToBase64 } from "../lib/base64.js";
+
+type BinaryData =
+  | Uint8Array
+  | ArrayBuffer
+  | Blob
+  | ReadableStream
+  | Response
+  | string;
+
+export async function consumeStream(
+  stream: ReadableStream<Uint8Array>,
+): Promise<Uint8Array> {
+  const reader = stream.getReader();
+  const chunks: Uint8Array[] = [];
+
+  try {
+    while (true) {
+      const { done, value } = await reader.read();
+      if (value != null) chunks.push(value);
+      if (done) break;
+    }
+  } finally {
+    reader.releaseLock();
+  }
+
+  return new Uint8Array(await new Blob(chunks).arrayBuffer());
+}
+
+export function isAsyncIterable(
+  value: unknown,
+): value is AsyncIterable<string> {
+  return (
+    typeof value === "object" && value != null && Symbol.asyncIterator in value
+  );
+}
+
+export function isBinaryData(value: unknown): value is BinaryData {
+  return (
+    value instanceof Uint8Array
+    || value instanceof ArrayBuffer
+    || value instanceof Blob
+    || value instanceof ReadableStream
+    || value instanceof Response
+    || typeof value === "string"
+  );
+}
+
+const base64Schema = z.string().base64();
+
+export async function valueToBase64(
+  value: BinaryData | null | undefined,
+): Promise<string | null> {
+  if (value == null) {
+    return null;
+  } else if (value instanceof Uint8Array) {
+    return bytesToBase64(value);
+  } else if (value instanceof ArrayBuffer) {
+    return bytesToBase64(new Uint8Array(value));
+  } else if (value instanceof Response || value instanceof Blob) {
+    return bytesToBase64(new Uint8Array(await value.arrayBuffer()));
+  } else if (value instanceof ReadableStream) {
+    return bytesToBase64(await consumeStream(value));
+  } else if (typeof value === "string") {
+    return base64Schema.parse(value);
+  } else {
+    value satisfies never;
+    throw new Error(`Unsupported image value type: ${typeof value}`);
+  }
+}

package/src/mcp-server/tools/documentsCreateV0.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { documentsCreateV0 } from "../../funcs/documentsCreateV0.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.DocumentCreateDocumentTemporaryRequest$inboundSchema,
+};
+
+export const tool$documentsCreateV0: ToolDefinition<typeof args> = {
+  name: "documents-create-v0",
+  description: `Create document
+
+You will need to upload the PDF to the provided URL returned. Note: Once V2 API is released, this will be removed since we will allow direct uploads, instead of using an upload URL.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await documentsCreateV0(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/documentsDelete.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { documentsDelete } from "../../funcs/documentsDelete.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.DocumentDeleteDocumentRequest$inboundSchema,
+};
+
+export const tool$documentsDelete: ToolDefinition<typeof args> = {
+  name: "documents-delete",
+  description: `Delete document`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await documentsDelete(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/documentsDistribute.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { documentsDistribute } from "../../funcs/documentsDistribute.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.DocumentSendDocumentRequest$inboundSchema,
+};
+
+export const tool$documentsDistribute: ToolDefinition<typeof args> = {
+  name: "documents-distribute",
+  description: `Distribute document
+
+Send the document out to recipients based on your distribution method`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await documentsDistribute(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/documentsDuplicate.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { documentsDuplicate } from "../../funcs/documentsDuplicate.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.DocumentDuplicateDocumentRequest$inboundSchema,
+};
+
+export const tool$documentsDuplicate: ToolDefinition<typeof args> = {
+  name: "documents-duplicate",
+  description: `Duplicate document`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await documentsDuplicate(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/documentsFieldsCreate.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { documentsFieldsCreate } from "../../funcs/documentsFieldsCreate.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.FieldCreateDocumentFieldRequest$inboundSchema,
+};
+
+export const tool$documentsFieldsCreate: ToolDefinition<typeof args> = {
+  name: "documents-fields-create",
+  description: `Create document field
+
+Create a single field for a document.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await documentsFieldsCreate(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/documentsFieldsCreateMany.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { documentsFieldsCreateMany } from "../../funcs/documentsFieldsCreateMany.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.FieldCreateDocumentFieldsRequest$inboundSchema,
+};
+
+export const tool$documentsFieldsCreateMany: ToolDefinition<typeof args> = {
+  name: "documents-fields-create-many",
+  description: `Create document fields
+
+Create multiple fields for a document.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await documentsFieldsCreateMany(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/documentsFieldsDelete.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { documentsFieldsDelete } from "../../funcs/documentsFieldsDelete.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.FieldDeleteDocumentFieldRequest$inboundSchema,
+};
+
+export const tool$documentsFieldsDelete: ToolDefinition<typeof args> = {
+  name: "documents-fields-delete",
+  description: `Delete document field`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await documentsFieldsDelete(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/documentsFieldsGet.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { documentsFieldsGet } from "../../funcs/documentsFieldsGet.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.FieldGetDocumentFieldRequest$inboundSchema,
+};
+
+export const tool$documentsFieldsGet: ToolDefinition<typeof args> = {
+  name: "documents-fields-get",
+  description: `Get document field
+
+Returns a single field. If you want to retrieve all the fields for a document, use the "Get Document" endpoint.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await documentsFieldsGet(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/documentsFieldsUpdate.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { documentsFieldsUpdate } from "../../funcs/documentsFieldsUpdate.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.FieldUpdateDocumentFieldRequest$inboundSchema,
+};
+
+export const tool$documentsFieldsUpdate: ToolDefinition<typeof args> = {
+  name: "documents-fields-update",
+  description: `Update document field
+
+Update a single field for a document.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await documentsFieldsUpdate(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/documentsFieldsUpdateMany.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { documentsFieldsUpdateMany } from "../../funcs/documentsFieldsUpdateMany.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.FieldUpdateDocumentFieldsRequest$inboundSchema,
+};
+
+export const tool$documentsFieldsUpdateMany: ToolDefinition<typeof args> = {
+  name: "documents-fields-update-many",
+  description: `Update document fields
+
+Update multiple fields for a document.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await documentsFieldsUpdateMany(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/documentsFind.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { documentsFind } from "../../funcs/documentsFind.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.DocumentFindDocumentsRequest$inboundSchema,
+};
+
+export const tool$documentsFind: ToolDefinition<typeof args> = {
+  name: "documents-find",
+  description: `Find documents
+
+Find documents based on a search criteria`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await documentsFind(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/documentsGet.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { documentsGet } from "../../funcs/documentsGet.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.DocumentGetDocumentWithDetailsByIdRequest$inboundSchema,
+};
+
+export const tool$documentsGet: ToolDefinition<typeof args> = {
+  name: "documents-get",
+  description: `Get document
+
+Returns a document given an ID`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await documentsGet(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};