@neon/tools 0.2.0 → 0.4.0

package/README.md

@@ -1,6 +1,6 @@
 # `@neon/tools`
 
-Generated agent tools for every operation in the Neon Management API. Select only the operations an agent needs, then use the canonical descriptors directly or adapt them for MCP, Eve, or Mastra.
+Agent tools for the Neon Management API and for the `@neon/sdk` workflows that attach compute and return a connection string. Select only the operations and workflows an agent needs, then use the canonical descriptors directly or adapt them for MCP, Eve, and Mastra.
 
 ```bash
 npm install @neon/tools
@@ -24,7 +24,7 @@ const tools = createNeonTools({
 });
 
 const result = await tools.listProjects.execute({
-	query: { limit: 10 },
+	limit: 10,
 });
 ```
 
@@ -43,14 +43,58 @@ Or supply the token per call:
 const tools = createNeonTools({ operations });
 
 await tools.listProjects.execute(
-	{ query: { limit: 10 } },
+	{ limit: 10 },
 	{ apiKey: oauthAccessToken },
 );
 ```
 
-The returned record is keyed by OpenAPI operation ID. Each tool includes its generated Zod 4 `inputSchema`, snake-case `id`, title, description, safety annotations, stability metadata, and an `execute()` function. Inputs group API parameters under `path`, `query`, `headers`, and `body`.
+The returned record is keyed by OpenAPI operation ID or workflow id. Each tool includes its Zod 4 `inputSchema`, snake-case `id`, title, description, safety annotations, stability metadata, and an `execute()` function. Inputs are flat: path, query, header, and body fields sit on one object. A body that is a single object wrapper is lifted, so `create_project` takes `{ name, region_id, org_id, ... }` rather than `{ project: { name } }`. A body with several properties keeps those properties, so `create_project_branch` takes `{ project_id, branch, endpoints, annotation_value }` and `branch` is still an object. Two email-provider updates keep a `body` field because the API request is a discriminated union.
 
-`operationIds` exports every valid selector. `execute()` strictly validates the input, rejects unknown fields instead of dropping them, and returns typed, JSON-safe `{ data }`. Neon SDK errors remain typed and are thrown to the caller.
+`operationIds` exports every valid operation selector. `execute()` strictly validates the input, rejects unknown fields instead of dropping them, and returns typed, JSON-safe `{ data }`. Neon SDK errors remain typed and are thrown to the caller.
+
+## Workflows
+
+`workflows` selects methods from the `@neon/sdk` ergonomic client. These are not OpenAPI operations: they attach a default compute, wait until the resource is ready, and return a connection string. `operations` is the generated Management API. At least one of the two arrays is required.
+
+Both workflow tools poll until the resource is ready. The default deadline is five minutes (`wait.timeoutMs`). Pass `wait: { timeoutMs: 30_000 }` on `createNeonTools` or `createNeonTool` to bound that. Set it below the host's own tool-call timeout, otherwise the host gives up first. An abort `signal` on `execute` or a wait timeout stops the poll, not the create: the branch or project may already exist, and the error does not include its id. List before retrying. `metadata.method` and `metadata.path` name the first request; extra readiness GETs are not listed there. `inject.projectId` still works on `createBranchWithCompute` because its path is `/projects/{project_id}/branches`.
+
+```ts
+const tools = createNeonTools({
+	apiKey,
+	operations: ["listProjects"],
+	workflows: ["createBranchWithCompute", "createProjectAndConnect"],
+});
+
+const { data } = await tools.createBranchWithCompute.execute({
+	project_id: "project-id",
+	name: "feature-x",
+});
+
+await tools.createProjectAndConnect.execute({
+	name: "agent-project",
+	region_id: "aws-us-east-1",
+});
+```
+
+`createNeonTool` accepts the same workflow ids:
+
+```ts
+const createBranch = createNeonTool("createBranchWithCompute", { apiKey });
+```
+
+`workflowIds` lists the selectors. Record keys name the entity (`createBranchWithCompute`, `createProjectAndConnect`) and call `neon.branches.createWithCompute` and `neon.projects.createAndConnect`. Published ids are `create_branch_with_compute` and `create_project_and_connect`. Input fields are snake_case, same as generated tools. `names` can rename a workflow the same way it renames an operation:
+
+```ts
+const tools = createNeonTools({
+	apiKey,
+	workflows: ["createBranchWithCompute"],
+	names: { createBranchWithCompute: "create_branch" },
+});
+
+tools.createBranchWithCompute.id; // "create_branch"
+```
+
+`create_project_branch` still creates a branch with no compute when `endpoints` is omitted. It can attach compute if you pass `endpoints`; it does not wait or return a connection string. Use `createBranchWithCompute` when the next step needs to connect.
 
 ## Optional host add-ons
 
@@ -96,9 +140,27 @@ const tools = createNeonTools({
 
 This package does not send analytics. Mutating `event.input` does not change a grant-locked project or branch id.
 
+### Names
+
+`name` rewrites every published tool `id`. `names` overrides one tool first, keyed by OpenAPI operation ID or the generated snake-case `id`:
+
+```ts
+const tools = createNeonTools({
+	apiKey,
+	operations: ["createProjectBranch", "listProjects"] as const,
+	names: { createProjectBranch: "create_branch" },
+	name: (id) => `neon_${id}`,
+});
+
+tools.createProjectBranch.id; // "neon_create_branch"
+tools.listProjects.id; // "neon_list_projects"
+```
+
+The record is still keyed by operation ID (`tools.createProjectBranch`). MCP and Mastra publish `tool.id`. Eve uses the filename as the model-facing name, so name the file after the published `id`. Duplicate or non-snake-case ids throw, and a `names` key that matches no selected tool throws.
+
 ### Project and branch injection
 
-Generated tools take OpenAPI path parameters (`path.project_id`, `path.branch_id`). A host that already knows those values can inject them. Without `omitFromSchema`, the published field becomes optional and a caller-supplied value wins. With `omitFromSchema: true`, the field is removed from the published schema and the injector is the only source:
+Tools take path parameters as `project_id` and `branch_id`. A host that already knows those values can inject them, including on `createBranchWithCompute`. Without `omitFromSchema`, the published field becomes optional and a caller-supplied value wins. With `omitFromSchema: true`, the field is removed from the published schema and the injector is the only source:
 
 ```ts
 const tools = createNeonTools({
@@ -111,7 +173,7 @@ const tools = createNeonTools({
 });
 
 await tools.getProject.execute({});
-await tools.deleteProjectBranch.execute({ path: { branch_id: "br-id" } });
+await tools.deleteProjectBranch.execute({ branch_id: "br-id" });
 ```
 
 Use a getter when the value is request-scoped. The getter can read the host's own `AsyncLocalStorage` (this package does not export one):
@@ -134,7 +196,9 @@ await grant.run({ projectId: "project-id" }, () => tools.getProject.execute({}))
 
 Injectors only apply to tools that have that path key. `listProjects` is unchanged. Empty inject values fail closed. Invalid ids still fail the original path schema before fetch.
 
-These add-ons do not flatten `{ path, query, body }` into camelCase `projectId`, do not rename tools (`get_project` is not `describe_project`), and do not add host-only behavior such as returning a connection string from `createProject`. Grant filtering, read-only filtering, and access-control notices stay in the host. `branchId` injection fills `path.branch_id` only — query/body branch selectors such as `getConnectionURI`'s `query.branch_id` are unchanged.
+`onExecute` and `inject` apply to workflow tools the same way they apply to generated tools. Grant filtering, read-only filtering, and access-control notices stay in the host.
+
+Injection reads the URL template, so it fills path `project_id` and `branch_id` only. Query and body fields with those names stay caller-supplied, including `getConnectionURI.branch_id`, `createOrgApiKey.project_id`, `createNeonAuthIntegration.project_id` / `branch_id`, `createNeonAuthNewUser.project_id`, `createNeonAuthProviderSDKKeys.project_id`, `transferNeonAuthProviderProject.project_id`, `addProjectJWKS.branch_id`, `createProjectEndpoint.branch_id`, `updateProjectEndpoint.branch_id`, and `getProjectAdvisorSecurityIssues.branch_id`. `omitFromSchema: true` does not hide those fields.
 
 ## Request schemas
 
@@ -152,6 +216,8 @@ const body = zCreateProjectBody.parse({
 });
 ```
 
+These are the raw OpenAPI request shapes, not the flat tool input. `zCreateProjectBody` still wraps fields in `project`. The tool `create_project` does not.
+
 These schemas are strict. If a newly added API field is not recognized, upgrade `@neon/tools`; use `@neon/sdk` directly until a matching tools release is available.
 
 ## MCP
@@ -262,12 +328,10 @@ const deployFunction = createNeonTool(
 );
 
 await deployFunction.execute({
-	path: {
-		project_id: "project-id",
-		branch_id: "branch-id",
-		slug: "hello",
-	},
-	body: { zip: "UEsDBA==" },
+	project_id: "project-id",
+	branch_id: "branch-id",
+	slug: "hello",
+	zip: "UEsDBA==",
 });
 ```
 

package/dist/index.d.ts

@@ -1,29 +1,89 @@
 import { type NeonConfig, NeonError } from "@neon/sdk";
 import { type NeonBearerCredential } from "./lib/auth.js";
-import { type InjectedNeonTool, type NeonToolCustomizeOptions, type NeonToolInjectOptions } from "./lib/customize.js";
+import { type InjectedNeonTool, type NeonToolCustomizeOptions, type NeonToolInjectOptions, type NeonToolNameOverrides } from "./lib/customize.js";
+import { type NeonWorkflowId, type WorkflowFactories, workflowIds } from "./lib/workflows.js";
 import { type NeonOperationId, operationFactories, operationIds } from "./operations.gen.js";
 export type { NeonBearerCredential } from "./lib/auth.js";
-export type { InjectedNeonTool, NeonToolCustomizeOptions, NeonToolDescriptionOverrides, NeonToolDescriptionSource, NeonToolInjectOptions, NeonToolInjectValue, NeonToolOnExecute, NeonToolOnExecuteEvent, } from "./lib/customize.js";
+export type { InjectedNeonTool, NeonToolCustomizeOptions, NeonToolDescriptionOverrides, NeonToolDescriptionSource, NeonToolInjectOptions, NeonToolInjectValue, NeonToolNameOverrides, NeonToolNameSource, NeonToolOnExecute, NeonToolOnExecuteEvent, } from "./lib/customize.js";
 export type { JsonSafe, JsonSafeBlob, NeonTool, NeonToolAnnotations, NeonToolExecutionContext, NeonToolMetadata, NeonToolResult, } from "./lib/operation.js";
-export type { NeonOperationId };
-export { NeonError, operationIds };
+export type { NeonOperationId, NeonWorkflowId };
+export { NeonError, operationIds, workflowIds };
 type OperationFactories = typeof operationFactories;
-export type NeonTools<Operations extends readonly NeonOperationId[]> = {
+export type NeonTools<Operations extends readonly NeonOperationId[] = [], Workflows extends readonly NeonWorkflowId[] = []> = {
     [Operation in Operations[number]]: ReturnType<OperationFactories[Operation]>;
+} & {
+    [Workflow in Workflows[number]]: ReturnType<WorkflowFactories[Workflow]>;
 };
-export type InjectedNeonTools<Operations extends readonly NeonOperationId[], Inject> = {
+export type InjectedNeonTools<Operations extends readonly NeonOperationId[], Inject, Workflows extends readonly NeonWorkflowId[] = []> = {
     [Operation in Operations[number]]: InjectedNeonTool<ReturnType<OperationFactories[Operation]>, Inject>;
+} & {
+    [Workflow in Workflows[number]]: InjectedNeonTool<ReturnType<WorkflowFactories[Workflow]>, Inject>;
 };
-export interface NeonToolsClientOptions extends Pick<NeonConfig, "baseUrl" | "fetch">, NeonToolCustomizeOptions {
+type WithPublishedId<Tool> = Tool extends {
+    id: string;
+} ? Omit<Tool, "id"> & {
+    id: string;
+} : Tool;
+export interface NeonToolsClientOptions extends Pick<NeonConfig, "baseUrl" | "fetch" | "wait">, Omit<NeonToolCustomizeOptions, "name" | "names"> {
     apiKey?: NeonBearerCredential;
 }
-export interface CreateNeonToolsOptions<Operations extends readonly NeonOperationId[]> extends NeonToolsClientOptions {
-    operations: Operations;
+interface OperationSelection {
+    operations: readonly NeonOperationId[];
+    workflows?: readonly NeonWorkflowId[];
+}
+interface WorkflowSelection {
+    workflows: readonly NeonWorkflowId[];
+    operations?: readonly NeonOperationId[];
 }
-export declare const createNeonTools: <const Operations extends readonly NeonOperationId[], const Inject extends NeonToolInjectOptions | undefined = undefined>(options: CreateNeonToolsOptions<Operations> & {
+type CreateNeonToolsInput = NeonToolsClientOptions & (OperationSelection | WorkflowSelection);
+export type CreateNeonToolsOptions<Operations extends readonly NeonOperationId[] = readonly NeonOperationId[], Workflows extends readonly NeonWorkflowId[] = readonly []> = NeonToolsClientOptions & (Workflows extends readonly [] ? {
+    operations: Operations;
+    workflows?: Workflows;
+} : Operations extends readonly [] ? {
+    workflows: Workflows;
+    operations?: Operations;
+} : {
+    operations: Operations;
+    workflows: Workflows;
+});
+type SelectedOperations<T> = T extends {
+    operations: infer O extends readonly NeonOperationId[];
+} ? O : [];
+type SelectedWorkflows<T> = T extends {
+    workflows: infer W extends readonly NeonWorkflowId[];
+} ? W : [];
+type NeonToolsFor<T, Inject> = T extends CreateNeonToolsInput ? Inject extends NeonToolInjectOptions ? InjectedNeonTools<SelectedOperations<T>, Inject, SelectedWorkflows<T>> : NeonTools<SelectedOperations<T>, SelectedWorkflows<T>> : never;
+type NeonToolId = NeonOperationId | NeonWorkflowId;
+type ToolForId<Id extends NeonToolId> = Id extends NeonWorkflowId ? ReturnType<WorkflowFactories[Id]> : Id extends NeonOperationId ? ReturnType<OperationFactories[Id]> : never;
+type NamedNeonTools<Operations extends readonly NeonOperationId[], Workflows extends readonly NeonWorkflowId[], Inject> = {
+    [Operation in Operations[number]]: WithPublishedId<Inject extends NeonToolInjectOptions ? InjectedNeonTool<ReturnType<OperationFactories[Operation]>, Inject> : ReturnType<OperationFactories[Operation]>>;
+} & {
+    [Workflow in Workflows[number]]: WithPublishedId<Inject extends NeonToolInjectOptions ? InjectedNeonTool<ReturnType<WorkflowFactories[Workflow]>, Inject> : ReturnType<WorkflowFactories[Workflow]>>;
+};
+type NamedNeonTool<Id extends NeonToolId, Inject> = WithPublishedId<Inject extends NeonToolInjectOptions ? InjectedNeonTool<ToolForId<Id>, Inject> : ToolForId<Id>>;
+type NamedNeonToolsFor<T, Inject> = T extends CreateNeonToolsInput ? NamedNeonTools<SelectedOperations<T>, SelectedWorkflows<T>, Inject> : never;
+export declare function createNeonTools<const T extends CreateNeonToolsInput, const Inject extends NeonToolInjectOptions | undefined = undefined>(options: T & {
+    inject?: Inject;
+} & ({
+    name: (id: string) => string;
+    names?: NeonToolNameOverrides;
+} | {
+    names: NeonToolNameOverrides;
+    name?: (id: string) => string;
+})): NamedNeonToolsFor<T, Inject>;
+export declare function createNeonTools<const T extends CreateNeonToolsInput, const Inject extends NeonToolInjectOptions | undefined = undefined>(options: T & {
+    inject?: Inject;
+}): NeonToolsFor<T, Inject>;
+export declare function createNeonTool<const Id extends NeonToolId, const Inject extends NeonToolInjectOptions | undefined = undefined>(id: Id, options: NeonToolsClientOptions & {
     inject?: Inject;
-}) => Inject extends NeonToolInjectOptions ? InjectedNeonTools<Operations, Inject> : NeonTools<Operations>;
-export declare function createNeonTool<const Operation extends NeonOperationId, const Inject extends NeonToolInjectOptions | undefined = undefined>(operationId: Operation, options: NeonToolsClientOptions & {
+} & ({
+    name: (id: string) => string;
+    names?: NeonToolNameOverrides;
+} | {
+    names: NeonToolNameOverrides;
+    name?: (id: string) => string;
+})): NamedNeonTool<Id, Inject>;
+export declare function createNeonTool<const Id extends NeonToolId, const Inject extends NeonToolInjectOptions | undefined = undefined>(id: Id, options: NeonToolsClientOptions & {
     inject?: Inject;
-}): Inject extends NeonToolInjectOptions ? InjectedNeonTool<ReturnType<OperationFactories[Operation]>, Inject> : ReturnType<OperationFactories[Operation]>;
+}): Inject extends NeonToolInjectOptions ? InjectedNeonTool<ToolForId<Id>, Inject> : ToolForId<Id>;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,KAAK,UAAU,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACzE,OAAO,EAEN,KAAK,oBAAoB,EAEzB,MAAM,eAAe,CAAC;AACvB,OAAO,EAIN,KAAK,gBAAgB,EACrB,KAAK,wBAAwB,EAC7B,KAAK,qBAAqB,EAC1B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACN,KAAK,eAAe,EACpB,kBAAkB,EAClB,YAAY,EACZ,MAAM,qBAAqB,CAAC;AAE7B,YAAY,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAC1D,YAAY,EACX,gBAAgB,EAChB,wBAAwB,EACxB,4BAA4B,EAC5B,yBAAyB,EACzB,qBAAqB,EACrB,mBAAmB,EACnB,iBAAiB,EACjB,sBAAsB,GACtB,MAAM,oBAAoB,CAAC;AAC5B,YAAY,EACX,QAAQ,EACR,YAAY,EACZ,QAAQ,EACR,mBAAmB,EACnB,wBAAwB,EACxB,gBAAgB,EAChB,cAAc,GACd,MAAM,oBAAoB,CAAC;AAC5B,YAAY,EAAE,eAAe,EAAE,CAAC;AAChC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC;AAEnC,KAAK,kBAAkB,GAAG,OAAO,kBAAkB,CAAC;AAEpD,MAAM,MAAM,SAAS,CAAC,UAAU,SAAS,SAAS,eAAe,EAAE,IAAI;KACrE,SAAS,IAAI,UAAU,CAAC,MAAM,CAAC,GAAG,UAAU,CAC5C,kBAAkB,CAAC,SAAS,CAAC,CAC7B;CACD,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAC5B,UAAU,SAAS,SAAS,eAAe,EAAE,EAC7C,MAAM,IACH;KACF,SAAS,IAAI,UAAU,CAAC,MAAM,CAAC,GAAG,gBAAgB,CAClD,UAAU,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,EACzC,MAAM,CACN;CACD,CAAC;AAEF,MAAM,WAAW,sBAChB,SAAQ,IAAI,CAAC,UAAU,EAAE,SAAS,GAAG,OAAO,CAAC,EAC5C,wBAAwB;IACzB,MAAM,CAAC,EAAE,oBAAoB,CAAC;CAC9B;AAED,MAAM,WAAW,sBAAsB,CACtC,UAAU,SAAS,SAAS,eAAe,EAAE,CAC5C,SAAQ,sBAAsB;IAC/B,UAAU,EAAE,UAAU,CAAC;CACvB;AAiED,eAAO,MAAM,eAAe,GAC3B,KAAK,CAAC,UAAU,SAAS,SAAS,eAAe,EAAE,EACnD,KAAK,CAAC,MAAM,SAAS,qBAAqB,GAAG,SAAS,GAAG,SAAS,EAElE,SAAS,sBAAsB,CAAC,UAAU,CAAC,GAAG;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,KAC/D,MAAM,SAAS,qBAAqB,GACpC,iBAAiB,CAAC,UAAU,EAAE,MAAM,CAAC,GACrC,SAAS,CAAC,UAAU,CAGE,CAAC;AAE1B,wBAAgB,cAAc,CAC7B,KAAK,CAAC,SAAS,SAAS,eAAe,EACvC,KAAK,CAAC,MAAM,SAAS,qBAAqB,GAAG,SAAS,GAAG,SAAS,EAElE,WAAW,EAAE,SAAS,EACtB,OAAO,EAAE,sBAAsB,GAAG;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GACnD,MAAM,SAAS,qBAAqB,GACpC,gBAAgB,CAAC,UAAU,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,GACnE,UAAU,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAS3C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,KAAK,UAAU,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACzE,OAAO,EAEN,KAAK,oBAAoB,EAEzB,MAAM,eAAe,CAAC;AACvB,OAAO,EAIN,KAAK,gBAAgB,EACrB,KAAK,wBAAwB,EAC7B,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAEN,KAAK,cAAc,EACnB,KAAK,iBAAiB,EAEtB,WAAW,EACX,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACN,KAAK,eAAe,EACpB,kBAAkB,EAClB,YAAY,EACZ,MAAM,qBAAqB,CAAC;AAE7B,YAAY,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAC1D,YAAY,EACX,gBAAgB,EAChB,wBAAwB,EACxB,4BAA4B,EAC5B,yBAAyB,EACzB,qBAAqB,EACrB,mBAAmB,EACnB,qBAAqB,EACrB,kBAAkB,EAClB,iBAAiB,EACjB,sBAAsB,GACtB,MAAM,oBAAoB,CAAC;AAC5B,YAAY,EACX,QAAQ,EACR,YAAY,EACZ,QAAQ,EACR,mBAAmB,EACnB,wBAAwB,EACxB,gBAAgB,EAChB,cAAc,GACd,MAAM,oBAAoB,CAAC;AAC5B,YAAY,EAAE,eAAe,EAAE,cAAc,EAAE,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC;AAEhD,KAAK,kBAAkB,GAAG,OAAO,kBAAkB,CAAC;AAEpD,MAAM,MAAM,SAAS,CACpB,UAAU,SAAS,SAAS,eAAe,EAAE,GAAG,EAAE,EAClD,SAAS,SAAS,SAAS,cAAc,EAAE,GAAG,EAAE,IAC7C;KACF,SAAS,IAAI,UAAU,CAAC,MAAM,CAAC,GAAG,UAAU,CAC5C,kBAAkB,CAAC,SAAS,CAAC,CAC7B;CACD,GAAG;KACF,QAAQ,IAAI,SAAS,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;CACxE,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAC5B,UAAU,SAAS,SAAS,eAAe,EAAE,EAC7C,MAAM,EACN,SAAS,SAAS,SAAS,cAAc,EAAE,GAAG,EAAE,IAC7C;KACF,SAAS,IAAI,UAAU,CAAC,MAAM,CAAC,GAAG,gBAAgB,CAClD,UAAU,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,EACzC,MAAM,CACN;CACD,GAAG;KACF,QAAQ,IAAI,SAAS,CAAC,MAAM,CAAC,GAAG,gBAAgB,CAChD,UAAU,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,EACvC,MAAM,CACN;CACD,CAAC;AAEF,KAAK,eAAe,CAAC,IAAI,IAAI,IAAI,SAAS;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,GACrD,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,GACjC,IAAI,CAAC;AAER,MAAM,WAAW,sBAChB,SAAQ,IAAI,CAAC,UAAU,EAAE,SAAS,GAAG,OAAO,GAAG,MAAM,CAAC,EACrD,IAAI,CAAC,wBAAwB,EAAE,MAAM,GAAG,OAAO,CAAC;IACjD,MAAM,CAAC,EAAE,oBAAoB,CAAC;CAC9B;AAED,UAAU,kBAAkB;IAC3B,UAAU,EAAE,SAAS,eAAe,EAAE,CAAC;IACvC,SAAS,CAAC,EAAE,SAAS,cAAc,EAAE,CAAC;CACtC;AAED,UAAU,iBAAiB;IAC1B,SAAS,EAAE,SAAS,cAAc,EAAE,CAAC;IACrC,UAAU,CAAC,EAAE,SAAS,eAAe,EAAE,CAAC;CACxC;AAED,KAAK,oBAAoB,GAAG,sBAAsB,GACjD,CAAC,kBAAkB,GAAG,iBAAiB,CAAC,CAAC;AAE1C,MAAM,MAAM,sBAAsB,CACjC,UAAU,SAAS,SAAS,eAAe,EAAE,GAAG,SAAS,eAAe,EAAE,EAC1E,SAAS,SAAS,SAAS,cAAc,EAAE,GAAG,SAAS,EAAE,IACtD,sBAAsB,GACzB,CAAC,SAAS,SAAS,SAAS,EAAE,GAC3B;IAAE,UAAU,EAAE,UAAU,CAAC;IAAC,SAAS,CAAC,EAAE,SAAS,CAAA;CAAE,GACjD,UAAU,SAAS,SAAS,EAAE,GAC7B;IAAE,SAAS,EAAE,SAAS,CAAC;IAAC,UAAU,CAAC,EAAE,UAAU,CAAA;CAAE,GACjD;IAAE,UAAU,EAAE,UAAU,CAAC;IAAC,SAAS,EAAE,SAAS,CAAA;CAAE,CAAC,CAAC;AAEvD,KAAK,kBAAkB,CAAC,CAAC,IAAI,CAAC,SAAS;IACtC,UAAU,EAAE,MAAM,CAAC,SAAS,SAAS,eAAe,EAAE,CAAC;CACvD,GACE,CAAC,GACD,EAAE,CAAC;AAEN,KAAK,iBAAiB,CAAC,CAAC,IAAI,CAAC,SAAS;IACrC,SAAS,EAAE,MAAM,CAAC,SAAS,SAAS,cAAc,EAAE,CAAC;CACrD,GACE,CAAC,GACD,EAAE,CAAC;AAEN,KAAK,YAAY,CAAC,CAAC,EAAE,MAAM,IAAI,CAAC,SAAS,oBAAoB,GAC1D,MAAM,SAAS,qBAAqB,GACnC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC,GACtE,SAAS,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC,GACvD,KAAK,CAAC;AAET,KAAK,UAAU,GAAG,eAAe,GAAG,cAAc,CAAC;AAEnD,KAAK,SAAS,CAAC,EAAE,SAAS,UAAU,IAAI,EAAE,SAAS,cAAc,GAC9D,UAAU,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,GACjC,EAAE,SAAS,eAAe,GACzB,UAAU,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC,GAClC,KAAK,CAAC;AAkIV,KAAK,cAAc,CAClB,UAAU,SAAS,SAAS,eAAe,EAAE,EAC7C,SAAS,SAAS,SAAS,cAAc,EAAE,EAC3C,MAAM,IACH;KACF,SAAS,IAAI,UAAU,CAAC,MAAM,CAAC,GAAG,eAAe,CACjD,MAAM,SAAS,qBAAqB,GACjC,gBAAgB,CAChB,UAAU,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,EACzC,MAAM,CACN,GACA,UAAU,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAC5C;CACD,GAAG;KACF,QAAQ,IAAI,SAAS,CAAC,MAAM,CAAC,GAAG,eAAe,CAC/C,MAAM,SAAS,qBAAqB,GACjC,gBAAgB,CAAC,UAAU,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC,GACjE,UAAU,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,CAC1C;CACD,CAAC;AAEF,KAAK,aAAa,CAAC,EAAE,SAAS,UAAU,EAAE,MAAM,IAAI,eAAe,CAClE,MAAM,SAAS,qBAAqB,GACjC,gBAAgB,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,GACvC,SAAS,CAAC,EAAE,CAAC,CAChB,CAAC;AAEF,KAAK,iBAAiB,CAAC,CAAC,EAAE,MAAM,IAAI,CAAC,SAAS,oBAAoB,GAC/D,cAAc,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,GACnE,KAAK,CAAC;AAET,wBAAgB,eAAe,CAC9B,KAAK,CAAC,CAAC,SAAS,oBAAoB,EACpC,KAAK,CAAC,MAAM,SAAS,qBAAqB,GAAG,SAAS,GAAG,SAAS,EAElE,OAAO,EAAE,CAAC,GAAG;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,CAC/B;IAAE,IAAI,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,qBAAqB,CAAA;CAAE,GAC/D;IAAE,KAAK,EAAE,qBAAqB,CAAC;IAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,MAAM,CAAA;CAAE,CACjE,GACA,iBAAiB,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AAChC,wBAAgB,eAAe,CAC9B,KAAK,CAAC,CAAC,SAAS,oBAAoB,EACpC,KAAK,CAAC,MAAM,SAAS,qBAAqB,GAAG,SAAS,GAAG,SAAS,EACjE,OAAO,EAAE,CAAC,GAAG;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,YAAY,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AAY7D,wBAAgB,cAAc,CAC7B,KAAK,CAAC,EAAE,SAAS,UAAU,EAC3B,KAAK,CAAC,MAAM,SAAS,qBAAqB,GAAG,SAAS,GAAG,SAAS,EAElE,EAAE,EAAE,EAAE,EACN,OAAO,EAAE,sBAAsB,GAAG;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB,GAAG,CACA;IAAE,IAAI,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,qBAAqB,CAAA;CAAE,GAC/D;IAAE,KAAK,EAAE,qBAAqB,CAAC;IAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,MAAM,CAAA;CAAE,CACjE,GACA,aAAa,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;AAC7B,wBAAgB,cAAc,CAC7B,KAAK,CAAC,EAAE,SAAS,UAAU,EAC3B,KAAK,CAAC,MAAM,SAAS,qBAAqB,GAAG,SAAS,GAAG,SAAS,EAElE,EAAE,EAAE,EAAE,EACN,OAAO,EAAE,sBAAsB,GAAG;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GACnD,MAAM,SAAS,qBAAqB,GACpC,gBAAgB,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,GACvC,SAAS,CAAC,EAAE,CAAC,CAAC"}

package/dist/index.js

@@ -1,44 +1,77 @@
 import { missingBearerCredential, requireBearerCredential } from "./lib/auth.js";
 import { applyToolCustomization, assertToolCustomizeOptions, hasToolCustomization } from "./lib/customize.js";
+import { isNeonWorkflowId, workflowFactoryFor, workflowIds } from "./lib/workflows.js";
 import { operationFactories, operationIds } from "./operations.gen.js";
 import { NeonError, createNeonClient } from "@neon/sdk";
 //#region src/index.ts
 const createRawClient = (options) => createNeonClient({
 	apiKey: options.apiKey === void 0 ? missingBearerCredential : requireBearerCredential(options.apiKey),
 	...options.baseUrl === void 0 ? {} : { baseUrl: options.baseUrl },
-	...options.fetch === void 0 ? {} : { fetch: options.fetch }
+	...options.fetch === void 0 ? {} : { fetch: options.fetch },
+	...options.wait === void 0 ? {} : { wait: options.wait }
 }).client;
 const operationFactoryFor = (operationId) => {
 	const knownOperationId = operationIds.find((candidate) => candidate === operationId);
 	if (knownOperationId === void 0) throw new TypeError(`Unknown Neon operation "${operationId}".`);
 	return operationFactories[knownOperationId];
 };
-function assertNeonTools(value, operations) {
+const assertKnownNameKeys = (names, tools) => {
+	if (names === void 0 || typeof names === "function") return;
+	const known = new Set(tools.flatMap((tool) => [tool.operationId, tool.id]));
+	const unknown = Object.keys(names).filter((key) => !known.has(key));
+	if (unknown.length > 0) throw new TypeError(`Unknown Neon tool name override: ${unknown.join(", ")}`);
+};
+function assertNeonTools(value, operations, workflows) {
 	if (typeof value !== "object" || value === null) throw new TypeError("Expected generated Neon tools to be an object.");
 	for (const operationId of operations) if (!(operationId in value)) throw new TypeError(`Missing generated Neon tool "${operationId}".`);
+	for (const workflowId of workflows) if (!(workflowId in value)) throw new TypeError(`Missing Neon workflow tool "${workflowId}".`);
 }
 const bindTools = (options) => {
 	assertToolCustomizeOptions(options);
-	const selected = /* @__PURE__ */ new Set();
-	const selectedFactories = options.operations.map((operationId) => {
-		if (selected.has(operationId)) throw new Error(`Duplicate Neon operation "${operationId}"`);
-		selected.add(operationId);
-		return [operationId, operationFactoryFor(operationId)];
+	const operations = options.operations ?? [];
+	const workflows = options.workflows ?? [];
+	if (operations.length === 0 && workflows.length === 0) throw new TypeError("createNeonTools requires at least one operation or workflow");
+	const selectedOperations = /* @__PURE__ */ new Set();
+	const operationEntries = operations.map((operationId) => {
+		if (selectedOperations.has(operationId)) throw new Error(`Duplicate Neon operation "${operationId}"`);
+		selectedOperations.add(operationId);
+		return [operationId, operationFactoryFor(operationId)(createRawClient(options))];
+	});
+	const selectedWorkflows = /* @__PURE__ */ new Set();
+	const workflowEntries = workflows.map((workflowId) => {
+		if (selectedWorkflows.has(workflowId)) throw new Error(`Duplicate Neon workflow "${workflowId}"`);
+		selectedWorkflows.add(workflowId);
+		return [workflowId, workflowFactoryFor(workflowId)(options)];
 	});
-	const client = createRawClient(options);
-	const entries = selectedFactories.map(([operationId, factory]) => {
-		const tool = factory(client);
-		return [operationId, hasToolCustomization(options) ? applyToolCustomization(tool, options) : tool];
+	const rawEntries = [...operationEntries, ...workflowEntries];
+	assertKnownNameKeys(options.names, rawEntries.map(([, tool]) => tool));
+	const entries = rawEntries.map(([id, tool]) => {
+		return [id, hasToolCustomization(options) ? applyToolCustomization(tool, options) : tool];
 	});
+	const publishedIds = /* @__PURE__ */ new Map();
+	for (const [id, tool] of entries) {
+		const previous = publishedIds.get(tool.id);
+		if (previous !== void 0) throw new Error(`Duplicate Neon tool id "${tool.id}" for ${previous}, ${id}`);
+		publishedIds.set(tool.id, id);
+	}
 	const tools = Object.fromEntries(entries);
-	assertNeonTools(tools, options.operations);
+	assertNeonTools(tools, operations, workflows);
 	return tools;
 };
-const createNeonTools = (options) => bindTools(options);
-function createNeonTool(operationId, options) {
+function createNeonTools(options) {
+	return bindTools(options);
+}
+function createNeonTool(id, options) {
 	assertToolCustomizeOptions(options);
-	const tool = operationFactoryFor(operationId)(createRawClient(options));
+	let tool;
+	if (isNeonWorkflowId(id)) tool = workflowFactoryFor(id)(options);
+	else {
+		const knownOperationId = operationIds.find((candidate) => candidate === id);
+		if (knownOperationId === void 0) throw new TypeError(`Unknown Neon operation or workflow "${id}".`);
+		tool = operationFactories[knownOperationId](createRawClient(options));
+	}
+	assertKnownNameKeys(options.names, [tool]);
 	return hasToolCustomization(options) ? applyToolCustomization(tool, options) : tool;
 }
 //#endregion
-export { NeonError, createNeonTool, createNeonTools, operationIds };
+export { NeonError, createNeonTool, createNeonTools, operationIds, workflowIds };

package/dist/lib/customize.d.ts

@@ -13,6 +13,8 @@ export interface NeonToolDescriptionSource {
     description: string;
 }
 export type NeonToolDescriptionOverrides = Readonly<Record<string, string>> | ((tool: NeonToolDescriptionSource) => string);
+export type NeonToolNameSource = Pick<NeonToolDescriptionSource, "operationId" | "id">;
+export type NeonToolNameOverrides = Readonly<Record<string, string>> | ((tool: NeonToolNameSource) => string);
 export interface NeonToolOnExecuteEvent<Output = unknown> {
     operationId: string;
     id: string;
@@ -22,31 +24,29 @@ export interface NeonToolOnExecuteEvent<Output = unknown> {
 export type NeonToolOnExecute = <Output>(event: NeonToolOnExecuteEvent<Output>) => Promise<NeonToolResult<Output>>;
 export interface NeonToolCustomizeOptions {
     descriptions?: NeonToolDescriptionOverrides;
+    names?: NeonToolNameOverrides;
+    name?: (id: string) => string;
     onExecute?: NeonToolOnExecute;
     inject?: NeonToolInjectOptions;
 }
 type InjectedPathKey<Inject> = ("projectId" extends keyof Inject ? Inject["projectId"] extends undefined ? never : "project_id" : never) | ("branchId" extends keyof Inject ? Inject["branchId"] extends undefined ? never : "branch_id" : never);
-type OptionalInjectedPath<Path, Keys extends string> = [
-    keyof Omit<Path, Keys>
-] extends [never] ? {
-    path?: Omit<Path, Keys> & Partial<Pick<Path, Extract<Keys, keyof Path>>>;
-} : {
-    path: Omit<Path, Keys> & Partial<Pick<Path, Extract<Keys, keyof Path>>>;
-};
-type ApplyInjectToInput<Input, Inject> = [InjectedPathKey<Inject>] extends [
-    never
-] ? Input : Input extends {
-    path: infer Path;
-} ? Inject extends {
+type RequiredKeys<Input> = {
+    [Key in keyof Input]-?: object extends Pick<Input, Key> ? never : Key;
+}[keyof Input];
+type InjectedRequiredKey<Input, Inject> = Extract<InjectedPathKey<Inject>, RequiredKeys<Input>>;
+type ApplyInjectToInput<Input, Inject> = [
+    InjectedRequiredKey<Input, Inject>
+] extends [never] ? Input : Inject extends {
     omitFromSchema: true;
-} ? [keyof Omit<Path, InjectedPathKey<Inject>>] extends [never] ? Omit<Input, "path"> : Omit<Input, "path"> & {
-    path: Omit<Path, InjectedPathKey<Inject>>;
-} : Omit<Input, "path"> & OptionalInjectedPath<Path, InjectedPathKey<Inject>> : Input;
+} ? Omit<Input, InjectedRequiredKey<Input, Inject>> : Omit<Input, InjectedRequiredKey<Input, Inject>> & Partial<Pick<Input, Extract<InjectedRequiredKey<Input, Inject>, keyof Input>>>;
 export type InjectedNeonTool<Tool, Inject> = Tool extends NeonTool<infer Schema, string, infer Output> ? Omit<Tool, "execute"> & {
     execute(input: ApplyInjectToInput<z.input<Schema>, Inject>, context?: NeonToolExecutionContext): Promise<NeonToolResult<Output>>;
 } : Tool;
+export declare const pathTemplateParams: (path: string) => Set<string>;
 export declare const assertToolCustomizeOptions: (options: NeonToolCustomizeOptions) => void;
 export declare const hasToolCustomization: (options: NeonToolCustomizeOptions) => boolean;
-export declare const applyToolCustomization: <Tool extends NeonTool>(tool: Tool, options: NeonToolCustomizeOptions) => Tool;
+export declare const applyToolCustomization: <Tool extends NeonTool>(tool: Tool, options: NeonToolCustomizeOptions) => Omit<Tool, "id"> & {
+    id: string;
+};
 export {};
 //# sourceMappingURL=customize.d.ts.map

package/dist/lib/customize.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"customize.d.ts","sourceRoot":"","sources":["../../src/lib/customize.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,KAAK,EACX,QAAQ,EACR,wBAAwB,EACxB,cAAc,EACd,MAAM,gBAAgB,CAAC;AAExB,MAAM,MAAM,mBAAmB,GAC5B,MAAM,GACN,CAAC,MAAM,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;AAE5D,MAAM,WAAW,qBAAqB;IACrC,SAAS,CAAC,EAAE,mBAAmB,CAAC;IAChC,QAAQ,CAAC,EAAE,mBAAmB,CAAC;IAC/B,cAAc,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,yBAAyB;IACzC,WAAW,EAAE,MAAM,CAAC;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,4BAA4B,GACrC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAChC,CAAC,CAAC,IAAI,EAAE,yBAAyB,KAAK,MAAM,CAAC,CAAC;AAEjD,MAAM,WAAW,sBAAsB,CAAC,MAAM,GAAG,OAAO;IACvD,WAAW,EAAE,MAAM,CAAC;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,MAAM,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;CAC/C;AAED,MAAM,MAAM,iBAAiB,GAAG,CAAC,MAAM,EACtC,KAAK,EAAE,sBAAsB,CAAC,MAAM,CAAC,KACjC,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;AAErC,MAAM,WAAW,wBAAwB;IACxC,YAAY,CAAC,EAAE,4BAA4B,CAAC;IAC5C,SAAS,CAAC,EAAE,iBAAiB,CAAC;IAC9B,MAAM,CAAC,EAAE,qBAAqB,CAAC;CAC/B;AAED,KAAK,eAAe,CAAC,MAAM,IACxB,CAAC,WAAW,SAAS,MAAM,MAAM,GAC/B,MAAM,CAAC,WAAW,CAAC,SAAS,SAAS,GACpC,KAAK,GACL,YAAY,GACb,KAAK,CAAC,GACR,CAAC,UAAU,SAAS,MAAM,MAAM,GAC9B,MAAM,CAAC,UAAU,CAAC,SAAS,SAAS,GACnC,KAAK,GACL,WAAW,GACZ,KAAK,CAAC,CAAC;AAEZ,KAAK,oBAAoB,CAAC,IAAI,EAAE,IAAI,SAAS,MAAM,IAAI;IACtD,MAAM,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC;CACtB,SAAS,CAAC,KAAK,CAAC,GACd;IACA,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GACtB,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC;CAChD,GACA;IACA,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GACrB,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC;CAChD,CAAC;AAEJ,KAAK,kBAAkB,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,SAAS;IAC1E,KAAK;CACL,GACE,KAAK,GACL,KAAK,SAAS;IAAE,IAAI,EAAE,MAAM,IAAI,CAAA;CAAE,GACjC,MAAM,SAAS;IAAE,cAAc,EAAE,IAAI,CAAA;CAAE,GACtC,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAC1D,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,GACnB,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG;IACtB,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC;CAC1C,GACD,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,GACnB,oBAAoB,CAAC,IAAI,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC,GACpD,KAAK,CAAC;AAEV,MAAM,MAAM,gBAAgB,CAAC,IAAI,EAAE,MAAM,IACxC,IAAI,SAAS,QAAQ,CAAC,MAAM,MAAM,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC,GACtD,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,GAAG;IACxB,OAAO,CACN,KAAK,EAAE,kBAAkB,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,EAClD,OAAO,CAAC,EAAE,wBAAwB,GAChC,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;CACnC,GACA,IAAI,CAAC;AAeT,eAAO,MAAM,0BAA0B,GACtC,SAAS,wBAAwB,KAC/B,IAEF,CAAC;AAEF,eAAO,MAAM,oBAAoB,GAChC,SAAS,wBAAwB,KAC/B,OAGkC,CAAC;AAEtC,eAAO,MAAM,sBAAsB,GAAI,IAAI,SAAS,QAAQ,EAC3D,MAAM,IAAI,EACV,SAAS,wBAAwB,KAC/B,IAsBF,CAAC"}
+{"version":3,"file":"customize.d.ts","sourceRoot":"","sources":["../../src/lib/customize.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,KAAK,EACX,QAAQ,EACR,wBAAwB,EACxB,cAAc,EACd,MAAM,gBAAgB,CAAC;AAExB,MAAM,MAAM,mBAAmB,GAC5B,MAAM,GACN,CAAC,MAAM,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;AAE5D,MAAM,WAAW,qBAAqB;IACrC,SAAS,CAAC,EAAE,mBAAmB,CAAC;IAChC,QAAQ,CAAC,EAAE,mBAAmB,CAAC;IAC/B,cAAc,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,yBAAyB;IACzC,WAAW,EAAE,MAAM,CAAC;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,4BAA4B,GACrC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAChC,CAAC,CAAC,IAAI,EAAE,yBAAyB,KAAK,MAAM,CAAC,CAAC;AAEjD,MAAM,MAAM,kBAAkB,GAAG,IAAI,CACpC,yBAAyB,EACzB,aAAa,GAAG,IAAI,CACpB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAC9B,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAChC,CAAC,CAAC,IAAI,EAAE,kBAAkB,KAAK,MAAM,CAAC,CAAC;AAE1C,MAAM,WAAW,sBAAsB,CAAC,MAAM,GAAG,OAAO;IACvD,WAAW,EAAE,MAAM,CAAC;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,MAAM,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;CAC/C;AAED,MAAM,MAAM,iBAAiB,GAAG,CAAC,MAAM,EACtC,KAAK,EAAE,sBAAsB,CAAC,MAAM,CAAC,KACjC,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;AAErC,MAAM,WAAW,wBAAwB;IACxC,YAAY,CAAC,EAAE,4BAA4B,CAAC;IAC5C,KAAK,CAAC,EAAE,qBAAqB,CAAC;IAC9B,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,MAAM,CAAC;IAC9B,SAAS,CAAC,EAAE,iBAAiB,CAAC;IAC9B,MAAM,CAAC,EAAE,qBAAqB,CAAC;CAC/B;AAED,KAAK,eAAe,CAAC,MAAM,IACxB,CAAC,WAAW,SAAS,MAAM,MAAM,GAC/B,MAAM,CAAC,WAAW,CAAC,SAAS,SAAS,GACpC,KAAK,GACL,YAAY,GACb,KAAK,CAAC,GACR,CAAC,UAAU,SAAS,MAAM,MAAM,GAC9B,MAAM,CAAC,UAAU,CAAC,SAAS,SAAS,GACnC,KAAK,GACL,WAAW,GACZ,KAAK,CAAC,CAAC;AAEZ,KAAK,YAAY,CAAC,KAAK,IAAI;KACzB,GAAG,IAAI,MAAM,KAAK,CAAC,CAAC,GAAG,MAAM,SAAS,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,KAAK,GAAG,GAAG;CACrE,CAAC,MAAM,KAAK,CAAC,CAAC;AAEf,KAAK,mBAAmB,CAAC,KAAK,EAAE,MAAM,IAAI,OAAO,CAChD,eAAe,CAAC,MAAM,CAAC,EACvB,YAAY,CAAC,KAAK,CAAC,CACnB,CAAC;AAEF,KAAK,kBAAkB,CAAC,KAAK,EAAE,MAAM,IAAI;IACxC,mBAAmB,CAAC,KAAK,EAAE,MAAM,CAAC;CAClC,SAAS,CAAC,KAAK,CAAC,GACd,KAAK,GACL,MAAM,SAAS;IAAE,cAAc,EAAE,IAAI,CAAA;CAAE,GACtC,IAAI,CAAC,KAAK,EAAE,mBAAmB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,GAC/C,IAAI,CAAC,KAAK,EAAE,mBAAmB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,GAC/C,OAAO,CACN,IAAI,CACH,KAAK,EACL,OAAO,CAAC,mBAAmB,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,CAAC,CACxD,CACD,CAAC;AAEN,MAAM,MAAM,gBAAgB,CAAC,IAAI,EAAE,MAAM,IACxC,IAAI,SAAS,QAAQ,CAAC,MAAM,MAAM,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC,GACtD,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,GAAG;IACxB,OAAO,CACN,KAAK,EAAE,kBAAkB,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,EAClD,OAAO,CAAC,EAAE,wBAAwB,GAChC,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;CACnC,GACA,IAAI,CAAC;AAsBT,eAAO,MAAM,kBAAkB,GAAI,MAAM,MAAM,KAAG,GAAG,CAAC,MAAM,CACU,CAAC;AAEvE,eAAO,MAAM,0BAA0B,GACtC,SAAS,wBAAwB,KAC/B,IAgBF,CAAC;AAEF,eAAO,MAAM,oBAAoB,GAChC,SAAS,wBAAwB,KAC/B,OAKkC,CAAC;AAEtC,eAAO,MAAM,sBAAsB,GAAI,IAAI,SAAS,QAAQ,EAC3D,MAAM,IAAI,EACV,SAAS,wBAAwB,KAC/B,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAoBjC,CAAC"}

package/dist/lib/customize.js

@@ -1,24 +1,51 @@
 import * as z from "zod";
 //#region src/lib/customize.ts
+const PATH_INJECT = [["projectId", "project_id"], ["branchId", "branch_id"]];
+const PUBLISHED_ID = /^[a-z][a-z0-9_]*$/;
 const missingInjectMessage = (name) => `A ${name} inject value is required`;
 const isPlainObject = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+const pathTemplateParams = (path) => new Set([...path.matchAll(/\{([^{}]+)\}/g)].map((match) => match[1]));
 const assertToolCustomizeOptions = (options) => {
 	resolveInject(options.inject);
+	if (options.name !== void 0 && typeof options.name !== "function") throw new TypeError("Neon tool name transforms must be functions");
+	if (options.names !== void 0 && typeof options.names !== "function" && (typeof options.names !== "object" || options.names === null || Array.isArray(options.names))) throw new TypeError("Neon tool name overrides must be a map or a function");
 };
-const hasToolCustomization = (options) => options.descriptions !== void 0 || options.onExecute !== void 0 || resolveInject(options.inject).hasAny;
+const hasToolCustomization = (options) => options.descriptions !== void 0 || options.names !== void 0 || options.name !== void 0 || options.onExecute !== void 0 || resolveInject(options.inject).hasAny;
 const applyToolCustomization = (tool, options) => {
 	const inject = resolveInject(options.inject);
+	const id = publishedId(tool, options);
 	const description = applyDescription(tool, options.descriptions);
-	const inputSchema = publishInputSchema(tool.inputSchema, inject);
+	const inputSchema = publishInputSchema(tool.inputSchema, inject, pathTemplateParams(tool.metadata.path));
 	const wrapExecute = options.onExecute !== void 0 || inject.hasAny;
-	if (description === tool.description && inputSchema === tool.inputSchema && !wrapExecute) return tool;
 	return {
 		...tool,
+		id,
 		description,
 		inputSchema,
-		execute: wrapExecute ? wrapToolExecute(tool, options.onExecute, inject) : tool.execute
+		execute: wrapExecute ? wrapToolExecute({
+			...tool,
+			id
+		}, options.onExecute, inject) : tool.execute
 	};
 };
+function publishedId(tool, options) {
+	let id = tool.id;
+	if (options.names !== void 0) {
+		if (typeof options.names === "function") {
+			id = options.names({
+				operationId: tool.operationId,
+				id: tool.id
+			});
+			if (typeof id !== "string") throw new TypeError(`Neon tool name overrides must return a string for ${tool.operationId}`);
+		} else {
+			const override = options.names[tool.operationId] ?? options.names[tool.id];
+			if (override !== void 0) id = override;
+		}
+	}
+	if (options.name !== void 0) id = options.name(id);
+	if (typeof id !== "string" || !PUBLISHED_ID.test(id)) throw new TypeError(`Neon tool id must match ${PUBLISHED_ID} for ${tool.operationId}: received ${JSON.stringify(id)}`);
+	return id;
+}
 function resolveInject(inject) {
 	if (inject === void 0) return {
 		omitFromSchema: false,
@@ -64,10 +91,10 @@ function applyDescription(tool, descriptions) {
 }
 function wrapToolExecute(tool, onExecute, inject) {
 	const originalExecute = tool.execute.bind(tool);
-	const availableKeys = pathKeys(tool.inputSchema);
+	const availableKeys = pathTemplateParams(tool.metadata.path);
 	const mode = inject.omitFromSchema ? "override" : "fill";
 	return async (input, context) => {
-		const run = async () => originalExecute(mergePathPatch(input, await resolveInjectedPath(input, inject, availableKeys, mode), mode), context);
+		const run = async () => originalExecute(mergeFields(input, await resolveInjectedFields(input, inject, availableKeys, mode), mode), context);
 		if (onExecute === void 0) return run();
 		return onExecute({
 			operationId: tool.operationId,
@@ -77,10 +104,10 @@ function wrapToolExecute(tool, onExecute, inject) {
 		});
 	};
 }
-async function resolveInjectedPath(input, inject, availableKeys, mode) {
-	const present = isPlainObject(input) && isPlainObject(input.path) ? input.path : void 0;
+async function resolveInjectedFields(input, inject, availableKeys, mode) {
+	const present = isPlainObject(input) ? input : void 0;
 	const patch = {};
-	for (const [name, pathKey] of [["projectId", "project_id"], ["branchId", "branch_id"]]) {
+	for (const [name, pathKey] of PATH_INJECT) {
 		if (!availableKeys.has(pathKey)) continue;
 		const injector = inject[name];
 		if (injector === void 0) continue;
@@ -95,78 +122,37 @@ async function resolveInjectedPath(input, inject, availableKeys, mode) {
 	}
 	return patch;
 }
-function mergePathPatch(input, patch, mode) {
+function mergeFields(input, patch, mode) {
 	if (Object.keys(patch).length === 0) return input === void 0 ? {} : input;
-	if (input === void 0) return { path: patch };
+	if (input === void 0) return patch;
 	if (!isPlainObject(input)) return input;
-	const path = input.path;
-	if (path === void 0) return {
-		...input,
-		path: patch
-	};
-	if (!isPlainObject(path)) return input;
-	const nextPath = { ...path };
-	for (const [key, value] of Object.entries(patch)) if (mode === "override" || nextPath[key] === void 0) nextPath[key] = value;
-	return {
-		...input,
-		path: nextPath
-	};
+	const next = { ...input };
+	for (const [key, value] of Object.entries(patch)) if (mode === "override" || next[key] === void 0) next[key] = value;
+	return next;
 }
 function cloneInput(input) {
 	if (!isPlainObject(input)) return input;
-	if (!isPlainObject(input.path)) return { ...input };
-	return {
-		...input,
-		path: { ...input.path }
-	};
+	return { ...input };
 }
 function objectShape(schema) {
 	if (schema instanceof z.ZodOptional) return objectShape(schema.unwrap());
 	if (schema instanceof z.ZodObject) return schema.shape;
 }
-function pathKeys(schema) {
-	const shape = objectShape(schema);
-	if (shape?.path === void 0) return /* @__PURE__ */ new Set();
-	const pathShape = objectShape(shape.path);
-	if (pathShape === void 0) return /* @__PURE__ */ new Set();
-	return new Set(Object.keys(pathShape));
-}
-function publishInputSchema(schema, inject) {
+function publishInputSchema(schema, inject, pathKeys) {
 	if (!inject.hasAny) return schema;
-	const available = pathKeys(schema);
-	const modes = {};
-	if (inject.projectId !== void 0 && available.has("project_id")) modes.project_id = inject.omitFromSchema ? "omit" : "optional";
-	if (inject.branchId !== void 0 && available.has("branch_id")) modes.branch_id = inject.omitFromSchema ? "omit" : "optional";
-	if (modes.project_id === void 0 && modes.branch_id === void 0) return schema;
-	return rewritePathSchema(schema, modes);
-}
-function rewritePathSchema(schema, modes) {
-	if (!(schema instanceof z.ZodObject)) return schema;
-	const shape = schema.shape;
-	if (shape.path === void 0) return schema;
-	let pathSchema = shape.path;
-	if (shape.path instanceof z.ZodOptional) pathSchema = shape.path.unwrap();
-	const pathWasOptional = shape.path instanceof z.ZodOptional;
-	if (!(pathSchema instanceof z.ZodObject)) return schema;
-	const pathShape = { ...pathSchema.shape };
+	const shape = objectShape(schema);
+	if (shape === void 0) return schema;
+	const nextShape = { ...shape };
 	let changed = false;
-	for (const key of ["project_id", "branch_id"]) {
-		const mode = modes[key];
-		if (mode === void 0 || pathShape[key] === void 0) continue;
+	for (const [name, pathKey] of PATH_INJECT) {
+		if (inject[name] === void 0 || !pathKeys.has(pathKey)) continue;
+		if (nextShape[pathKey] === void 0) continue;
 		changed = true;
-		if (mode === "omit") delete pathShape[key];
-		else pathShape[key] = pathShape[key].optional();
+		if (inject.omitFromSchema) delete nextShape[pathKey];
+		else nextShape[pathKey] = nextShape[pathKey].optional();
 	}
 	if (!changed) return schema;
-	const restShape = { ...shape };
-	const remaining = Object.keys(pathShape);
-	if (remaining.length === 0) {
-		delete restShape.path;
-		return Object.keys(restShape).length === 0 ? z.strictObject({}) : z.strictObject(restShape);
-	}
-	const nextPath = z.strictObject(pathShape);
-	restShape.path = pathWasOptional || remaining.every((key) => pathShape[key] instanceof z.ZodOptional) ? nextPath.optional() : nextPath;
-	return z.strictObject(restShape);
+	return Object.keys(nextShape).length === 0 ? z.strictObject({}) : z.strictObject(nextShape);
 }
 //#endregion
-export { applyToolCustomization, assertToolCustomizeOptions, hasToolCustomization };
+export { applyToolCustomization, assertToolCustomizeOptions, hasToolCustomization, pathTemplateParams };