@neon/tools 2.12.0 → 2.13.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/README.md +150 -7
- package/dist/descriptions.gen.d.ts +10 -0
- package/dist/descriptions.gen.d.ts.map +1 -0
- package/dist/descriptions.gen.js +150 -0
- package/dist/generated/zod.gen.d.ts +3 -3
- package/dist/index.d.ts +4 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +14 -11
- package/dist/lib/custom/auth-config.d.ts +164 -0
- package/dist/lib/custom/auth-config.d.ts.map +1 -0
- package/dist/lib/custom/auth-config.js +177 -0
- package/dist/lib/custom/docs.d.ts +58 -0
- package/dist/lib/custom/docs.d.ts.map +1 -0
- package/dist/lib/custom/docs.js +143 -0
- package/dist/lib/custom/feedback.d.ts +15 -0
- package/dist/lib/custom/feedback.d.ts.map +1 -0
- package/dist/lib/custom/feedback.js +55 -0
- package/dist/lib/custom/fetch.d.ts +402 -0
- package/dist/lib/custom/fetch.d.ts.map +1 -0
- package/dist/lib/custom/fetch.js +198 -0
- package/dist/lib/custom/organizations.d.ts +23 -0
- package/dist/lib/custom/organizations.d.ts.map +1 -0
- package/dist/lib/custom/organizations.js +32 -0
- package/dist/lib/custom/resources.d.ts +22 -0
- package/dist/lib/custom/resources.d.ts.map +1 -0
- package/dist/lib/custom/resources.js +113 -0
- package/dist/lib/custom/sql/connection.d.ts +46 -0
- package/dist/lib/custom/sql/connection.d.ts.map +1 -0
- package/dist/lib/custom/sql/connection.js +78 -0
- package/dist/lib/custom/sql/describe-branch.d.ts +84 -0
- package/dist/lib/custom/sql/describe-branch.d.ts.map +1 -0
- package/dist/lib/custom/sql/describe-branch.js +155 -0
- package/dist/lib/custom/sql/inspect/inspect.d.ts +75 -0
- package/dist/lib/custom/sql/inspect/inspect.d.ts.map +1 -0
- package/dist/lib/custom/sql/inspect/inspect.js +135 -0
- package/dist/lib/custom/sql/inspect/queries.d.ts +63 -0
- package/dist/lib/custom/sql/inspect/queries.d.ts.map +1 -0
- package/dist/lib/custom/sql/inspect/queries.js +528 -0
- package/dist/lib/custom/sql/inspect/report.d.ts +31 -0
- package/dist/lib/custom/sql/inspect/report.d.ts.map +1 -0
- package/dist/lib/custom/sql/inspect/report.js +43 -0
- package/dist/lib/custom/sql/inspect/targets.d.ts +27 -0
- package/dist/lib/custom/sql/inspect/targets.d.ts.map +1 -0
- package/dist/lib/custom/sql/inspect/targets.js +33 -0
- package/dist/lib/custom/sql/migrations.d.ts +69 -0
- package/dist/lib/custom/sql/migrations.d.ts.map +1 -0
- package/dist/lib/custom/sql/migrations.js +144 -0
- package/dist/lib/custom/sql/plan.d.ts +27 -0
- package/dist/lib/custom/sql/plan.d.ts.map +1 -0
- package/dist/lib/custom/sql/plan.js +53 -0
- package/dist/lib/custom/sql/query-tuning.d.ts +107 -0
- package/dist/lib/custom/sql/query-tuning.d.ts.map +1 -0
- package/dist/lib/custom/sql/query-tuning.js +129 -0
- package/dist/lib/custom/sql/rows.d.ts +11 -0
- package/dist/lib/custom/sql/rows.d.ts.map +1 -0
- package/dist/lib/custom/sql/rows.js +19 -0
- package/dist/lib/custom/sql/run.d.ts +81 -0
- package/dist/lib/custom/sql/run.d.ts.map +1 -0
- package/dist/lib/custom/sql/run.js +90 -0
- package/dist/lib/custom/sql/schema.d.ts +84 -0
- package/dist/lib/custom/sql/schema.d.ts.map +1 -0
- package/dist/lib/custom/sql/schema.js +201 -0
- package/dist/lib/custom/sql/slow-queries.d.ts +43 -0
- package/dist/lib/custom/sql/slow-queries.d.ts.map +1 -0
- package/dist/lib/custom/sql/slow-queries.js +87 -0
- package/dist/lib/customize.d.ts +9 -2
- package/dist/lib/customize.d.ts.map +1 -1
- package/dist/lib/customize.js +21 -7
- package/dist/lib/ergonomic/bind.d.ts +11 -1
- package/dist/lib/ergonomic/bind.d.ts.map +1 -1
- package/dist/lib/ergonomic/bind.js +13 -3
- package/dist/lib/ergonomic/catalog.d.ts +854 -39
- package/dist/lib/ergonomic/catalog.d.ts.map +1 -1
- package/dist/lib/ergonomic/catalog.js +35 -8
- package/dist/lib/ergonomic/composed.d.ts +4 -4
- package/dist/lib/ergonomic/composed.d.ts.map +1 -1
- package/dist/lib/ergonomic/composed.js +47 -45
- package/dist/lib/ergonomic/ids.d.ts +3 -1
- package/dist/lib/ergonomic/ids.d.ts.map +1 -1
- package/dist/lib/ergonomic/ids.js +41 -2
- package/dist/lib/ergonomic/index.d.ts +1 -1
- package/dist/lib/ergonomic/index.d.ts.map +1 -1
- package/dist/lib/ergonomic/index.js +2 -2
- package/dist/lib/operation.d.ts +11 -0
- package/dist/lib/operation.d.ts.map +1 -1
- package/dist/lib/references.d.ts +10 -0
- package/dist/lib/references.d.ts.map +1 -0
- package/dist/lib/references.js +28 -0
- package/dist/operations.gen.d.ts +2 -2
- package/dist/operations.gen.js +301 -301
- package/package.json +8 -5
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"catalog.d.ts","sourceRoot":"","sources":["../../../src/lib/ergonomic/catalog.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;
|
|
1
|
+
{"version":3,"file":"catalog.d.ts","sourceRoot":"","sources":["../../../src/lib/ergonomic/catalog.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAyBzB,OAAO,KAAK,EAAE,QAAQ,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AAE1E,OAAO,EAMN,KAAK,iBAAiB,EACtB,MAAM,WAAW,CAAC;AAenB,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAwE3C,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,UAAU,CAAC,CAAC;AAE7D,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gCAvCU,iBAAiB;;;;;;;;;;;;;;;;;;;;uBAsB9B,OAAO,YAAY,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4iEK,CAAC"}
|
|
@@ -1,6 +1,19 @@
|
|
|
1
1
|
import { decodeBase64 } from "../binary.js";
|
|
2
2
|
import { toToolResult } from "../result.js";
|
|
3
3
|
import { bindTool, collectObjectList, collectPages, fromGenerated, publishedId } from "./bind.js";
|
|
4
|
+
import { describeTableTool, listTablesTool } from "../custom/sql/schema.js";
|
|
5
|
+
import { inspectDatabaseTool } from "../custom/sql/inspect/inspect.js";
|
|
6
|
+
import { getAuthConfigTool } from "../custom/auth-config.js";
|
|
7
|
+
import { getDocTool, searchDocsTool } from "../custom/docs.js";
|
|
8
|
+
import { sendFeedbackTool } from "../custom/feedback.js";
|
|
9
|
+
import { userOrganizationsTool } from "../custom/organizations.js";
|
|
10
|
+
import { searchResourcesTool } from "../custom/resources.js";
|
|
11
|
+
import { describeBranchTool } from "../custom/sql/describe-branch.js";
|
|
12
|
+
import { fetchResourceTool } from "../custom/fetch.js";
|
|
13
|
+
import { explainSqlTool, runSqlTool, runSqlTransactionTool } from "../custom/sql/run.js";
|
|
14
|
+
import { completeMigrationTool, prepareMigrationTool } from "../custom/sql/migrations.js";
|
|
15
|
+
import { completeQueryTuningTool, prepareQueryTuningTool } from "../custom/sql/query-tuning.js";
|
|
16
|
+
import { listSlowQueriesTool } from "../custom/sql/slow-queries.js";
|
|
4
17
|
import { compareSchemaTool, connectionStringTool, createBranchAndConnectTool, createBranchTool, createProjectAndConnectTool, createProjectTool, createRoleTool, getDefaultTool, lokiQueryRangeTool, resetFromParentTool, restoreSnapshotTool, setScheduleTool } from "./composed.js";
|
|
5
18
|
import { NEON_STATUS_API_URL, listNeonIncidents } from "@neon/sdk";
|
|
6
19
|
import * as z from "zod";
|
|
@@ -28,7 +41,7 @@ const listIncidentsTool = (options) => ({
|
|
|
28
41
|
operationId: "incidents.list",
|
|
29
42
|
id: publishedId("incidents.list"),
|
|
30
43
|
title: "List Neon incidents",
|
|
31
|
-
description: "
|
|
44
|
+
description: "Lists open Neon incidents and maintenance from neonstatus.com and the affected components and regions. Needs no credentials. Call it when Neon requests fail unexpectedly or the user asks whether Neon is down.",
|
|
32
45
|
inputSchema: listIncidentsInputSchema,
|
|
33
46
|
annotations: {
|
|
34
47
|
readOnlyHint: true,
|
|
@@ -1406,7 +1419,7 @@ const toolFactories = {
|
|
|
1406
1419
|
operationId: "regions.list",
|
|
1407
1420
|
id: publishedId("regions.list"),
|
|
1408
1421
|
title: "List regions",
|
|
1409
|
-
description: "Lists
|
|
1422
|
+
description: "Lists the regions you can create projects in. An organization API key gets 404.",
|
|
1410
1423
|
inputSchema: z.strictObject({}),
|
|
1411
1424
|
annotations: {
|
|
1412
1425
|
readOnlyHint: true,
|
|
@@ -1426,11 +1439,25 @@ const toolFactories = {
|
|
|
1426
1439
|
generated: "getCurrentUserInfo",
|
|
1427
1440
|
run: (neon, _input, signal) => neon.user.me({ signal })
|
|
1428
1441
|
}),
|
|
1429
|
-
"
|
|
1430
|
-
|
|
1431
|
-
|
|
1432
|
-
|
|
1433
|
-
|
|
1434
|
-
"
|
|
1442
|
+
"incidents.list": listIncidentsTool,
|
|
1443
|
+
"user.organizations": userOrganizationsTool,
|
|
1444
|
+
"auth.getConfig": getAuthConfigTool,
|
|
1445
|
+
"resources.search": searchResourcesTool,
|
|
1446
|
+
"sql.run": runSqlTool,
|
|
1447
|
+
"sql.runTransaction": runSqlTransactionTool,
|
|
1448
|
+
"sql.explain": explainSqlTool,
|
|
1449
|
+
"schema.listTables": listTablesTool,
|
|
1450
|
+
"schema.describeTable": describeTableTool,
|
|
1451
|
+
"branches.describe": describeBranchTool,
|
|
1452
|
+
"queries.listSlow": listSlowQueriesTool,
|
|
1453
|
+
"database.inspect": inspectDatabaseTool,
|
|
1454
|
+
"migrations.prepare": prepareMigrationTool,
|
|
1455
|
+
"migrations.complete": completeMigrationTool,
|
|
1456
|
+
"queryTuning.prepare": prepareQueryTuningTool,
|
|
1457
|
+
"queryTuning.complete": completeQueryTuningTool,
|
|
1458
|
+
"resources.fetch": fetchResourceTool,
|
|
1459
|
+
"docs.search": searchDocsTool,
|
|
1460
|
+
"docs.get": getDocTool,
|
|
1461
|
+
"feedback.send": sendFeedbackTool
|
|
1435
1462
|
};
|
|
1436
1463
|
export { toolFactories };
|
|
@@ -199,8 +199,8 @@ export declare const connectionStringInputSchema: z.ZodObject<{
|
|
|
199
199
|
project_id: z.ZodString;
|
|
200
200
|
branch_id: z.ZodOptional<z.ZodString>;
|
|
201
201
|
endpoint_id: z.ZodOptional<z.ZodString>;
|
|
202
|
-
database_name: z.ZodString
|
|
203
|
-
role_name: z.ZodString
|
|
202
|
+
database_name: z.ZodOptional<z.ZodString>;
|
|
203
|
+
role_name: z.ZodOptional<z.ZodString>;
|
|
204
204
|
pooled: z.ZodOptional<z.ZodBoolean>;
|
|
205
205
|
}, z.core.$strict>;
|
|
206
206
|
export declare const createRoleInputSchema: z.ZodObject<{
|
|
@@ -766,8 +766,8 @@ export declare const connectionStringTool: (options: ToolClientOptions) => impor
|
|
|
766
766
|
project_id: z.ZodString;
|
|
767
767
|
branch_id: z.ZodOptional<z.ZodString>;
|
|
768
768
|
endpoint_id: z.ZodOptional<z.ZodString>;
|
|
769
|
-
database_name: z.ZodString
|
|
770
|
-
role_name: z.ZodString
|
|
769
|
+
database_name: z.ZodOptional<z.ZodString>;
|
|
770
|
+
role_name: z.ZodOptional<z.ZodString>;
|
|
771
771
|
pooled: z.ZodOptional<z.ZodBoolean>;
|
|
772
772
|
}, z.core.$strict>, "connection_string_postgres", string>;
|
|
773
773
|
export declare const createRoleTool: (options: ToolClientOptions) => import("../operation.js").NeonTool<z.ZodObject<{
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"composed.d.ts","sourceRoot":"","sources":["../../../src/lib/ergonomic/composed.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;
|
|
1
|
+
{"version":3,"file":"composed.d.ts","sourceRoot":"","sources":["../../../src/lib/ergonomic/composed.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AASzB,OAAO,EAAyB,KAAK,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAwD1E,eAAO,MAAM,uBAAuB;;;;;;;;;;kBAuBjC,CAAC;AAEJ,eAAO,MAAM,iCAAiC;;;;;;;;;;kBAQ5C,CAAC;AAEH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAEnC,CAAC;AAEH,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAG7C,CAAC;AAEH,eAAO,MAAM,qBAAqB;;kBAIhC,CAAC;AAEH,eAAO,MAAM,0BAA0B;;;;kBAWrC,CAAC;AAIH,eAAO,MAAM,wBAAwB;;;;;;;;;kBAiBnC,CAAC;AAEH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;kBAuCpC,CAAC;AAEH,eAAO,MAAM,kBAAkB,GAAI,SAAS,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;EAuC3D,CAAC;AAEH,eAAO,MAAM,2BAA2B;;;;;;;kBAatC,CAAC;AAOH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;kBAgD/B,CAAC;AAEJ,eAAO,MAAM,0BAA0B;;;;;;kBAarC,CAAC;AAIH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;kBAejC,CAAC;AAEH,eAAO,MAAM,gBAAgB,GAAI,SAAS,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA0CzD,CAAC;AAEH,eAAO,MAAM,0BAA0B,GAAI,SAAS,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiCnE,CAAC;AAEH,eAAO,MAAM,iBAAiB,GAAI,SAAS,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAqB1D,CAAC;AAEH,eAAO,MAAM,2BAA2B,GAAI,SAAS,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAsBpE,CAAC;AAEH,eAAO,MAAM,cAAc,GAAI,SAAS,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAyBvD,CAAC;AAEH,eAAO,MAAM,mBAAmB,GAAI,SAAS,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+B5D,CAAC;AAEH,eAAO,MAAM,iBAAiB,GAAI,SAAS,iBAAiB;;;;;;;;;;;EA0C1D,CAAC;AAEH,eAAO,MAAM,oBAAoB,GAAI,SAAS,iBAAiB;;;;;;;yDAgC7D,CAAC;AAEH,eAAO,MAAM,cAAc,GAAI,SAAS,iBAAiB;;;;;;;;;;;;;;;;;;;;EA8CvD,CAAC;AAEH,eAAO,MAAM,mBAAmB,GAAI,SAAS,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+B5D,CAAC;AAEH,eAAO,MAAM,eAAe,GAAI,SAAS,iBAAiB;;;;;;;;;;;;;;mDA4BxD,CAAC"}
|
|
@@ -1,5 +1,7 @@
|
|
|
1
|
+
import { pathInputDescriptions } from "../../descriptions.gen.js";
|
|
1
2
|
import { zBackupScheduleItem, zBranchCreateRequest, zBranchRestoreRequest, zComputeUnit, zCreateProjectBody, zCreateProjectBranchPath, zCreateProjectBranchRoleBody, zCreateProjectBranchRolePath, zGetConnectionUriPath, zGetConnectionUriQuery, zGetProjectBranchSchemaComparisonPath, zGetProjectBranchSchemaComparisonQuery, zListProjectBranchesPath, zQueryProjectBranchLogsPath, zRestoreProjectBranchPath, zRestoreSnapshotBody, zRestoreSnapshotPath, zSetSnapshotSchedulePath, zSuspendTimeoutSeconds } from "../../generated/zod.gen.js";
|
|
2
3
|
import { bindTool, publishedId } from "./bind.js";
|
|
4
|
+
import { COMPUTE_ID_DESCRIPTION, databaseNameField, resolveConnection, roleNameField } from "../custom/sql/connection.js";
|
|
3
5
|
import * as z from "zod";
|
|
4
6
|
// src/lib/ergonomic/composed.ts
|
|
5
7
|
const writeAnnotations = {
|
|
@@ -11,8 +13,9 @@ const readAnnotations = {
|
|
|
11
13
|
readOnlyHint: true,
|
|
12
14
|
openWorldHint: false
|
|
13
15
|
};
|
|
14
|
-
const pooledField = z.boolean().describe("
|
|
16
|
+
const pooledField = z.boolean().describe("Pooled connection string; default true, false for a direct one.").optional();
|
|
15
17
|
const branchCreateFields = zBranchCreateRequest.shape.branch.unwrap().shape;
|
|
18
|
+
const parentIdField = branchCreateFields.parent_id.describe("Parent branch id (br-...). Omit for the project's default branch.");
|
|
16
19
|
const projectCreateFields = zCreateProjectBody.shape.project.shape;
|
|
17
20
|
const computeSettingsSchema = z.strictObject({
|
|
18
21
|
min_cu: zComputeUnit.optional(),
|
|
@@ -26,9 +29,9 @@ const mapCompute = (compute) => compute === void 0 ? void 0 : {
|
|
|
26
29
|
};
|
|
27
30
|
const NO_COMPUTE_WITH_COMPUTE = "Pass compute settings or no_compute, not both.";
|
|
28
31
|
const createBranchInputSchema = z.strictObject({
|
|
29
|
-
project_id: zCreateProjectBranchPath.shape.project_id,
|
|
32
|
+
project_id: zCreateProjectBranchPath.shape.project_id.describe(pathInputDescriptions.project_id),
|
|
30
33
|
name: branchCreateFields.name,
|
|
31
|
-
parent_id:
|
|
34
|
+
parent_id: parentIdField,
|
|
32
35
|
compute: computeSettingsSchema,
|
|
33
36
|
no_compute: z.boolean().describe("Skip the read-write endpoint. Default false. Cannot be combined with compute.").optional()
|
|
34
37
|
}).superRefine((value, ctx) => {
|
|
@@ -39,9 +42,9 @@ const createBranchInputSchema = z.strictObject({
|
|
|
39
42
|
});
|
|
40
43
|
});
|
|
41
44
|
const createBranchAndConnectInputSchema = z.strictObject({
|
|
42
|
-
project_id: zCreateProjectBranchPath.shape.project_id,
|
|
45
|
+
project_id: zCreateProjectBranchPath.shape.project_id.describe(pathInputDescriptions.project_id),
|
|
43
46
|
name: branchCreateFields.name,
|
|
44
|
-
parent_id:
|
|
47
|
+
parent_id: parentIdField,
|
|
45
48
|
compute: computeSettingsSchema,
|
|
46
49
|
pooled: pooledField
|
|
47
50
|
});
|
|
@@ -50,26 +53,26 @@ const createProjectAndConnectInputSchema = z.strictObject({
|
|
|
50
53
|
...projectCreateFields,
|
|
51
54
|
pooled: pooledField
|
|
52
55
|
});
|
|
53
|
-
const getDefaultInputSchema = z.strictObject({ project_id: zListProjectBranchesPath.shape.project_id });
|
|
56
|
+
const getDefaultInputSchema = z.strictObject({ project_id: zListProjectBranchesPath.shape.project_id.describe(pathInputDescriptions.project_id) });
|
|
54
57
|
const resetFromParentInputSchema = z.strictObject({
|
|
55
|
-
project_id: zRestoreProjectBranchPath.shape.project_id,
|
|
56
|
-
branch_id: zRestoreProjectBranchPath.shape.branch_id,
|
|
58
|
+
project_id: zRestoreProjectBranchPath.shape.project_id.describe(pathInputDescriptions.project_id),
|
|
59
|
+
branch_id: zRestoreProjectBranchPath.shape.branch_id.describe(pathInputDescriptions.branch_id),
|
|
57
60
|
preserve_under_name: zBranchRestoreRequest.shape.preserve_under_name.describe("Name under which to save the current branch before the reset. Required when the branch has children; those children move to the new branch.")
|
|
58
61
|
});
|
|
59
62
|
const compareQuery = zGetProjectBranchSchemaComparisonQuery.shape;
|
|
60
63
|
const compareSchemaInputSchema = z.strictObject({
|
|
61
|
-
project_id: zGetProjectBranchSchemaComparisonPath.shape.project_id,
|
|
62
|
-
branch_id: zGetProjectBranchSchemaComparisonPath.shape.branch_id,
|
|
64
|
+
project_id: zGetProjectBranchSchemaComparisonPath.shape.project_id.describe(pathInputDescriptions.project_id),
|
|
65
|
+
branch_id: zGetProjectBranchSchemaComparisonPath.shape.branch_id.describe(pathInputDescriptions.branch_id),
|
|
63
66
|
database_name: compareQuery.db_name,
|
|
64
|
-
base_branch_id: compareQuery.base_branch_id,
|
|
67
|
+
base_branch_id: compareQuery.base_branch_id.describe("Branch id (br-...) to compare against, not its name. Omit for the parent branch."),
|
|
65
68
|
lsn: compareQuery.lsn,
|
|
66
69
|
timestamp: compareQuery.timestamp,
|
|
67
70
|
base_lsn: compareQuery.base_lsn,
|
|
68
71
|
base_timestamp: compareQuery.base_timestamp
|
|
69
72
|
});
|
|
70
73
|
const lokiQueryRangeInputSchema = z.strictObject({
|
|
71
|
-
project_id: zQueryProjectBranchLogsPath.shape.project_id,
|
|
72
|
-
branch_id: zQueryProjectBranchLogsPath.shape.branch_id,
|
|
74
|
+
project_id: zQueryProjectBranchLogsPath.shape.project_id.describe(pathInputDescriptions.project_id),
|
|
75
|
+
branch_id: zQueryProjectBranchLogsPath.shape.branch_id.describe(pathInputDescriptions.branch_id),
|
|
73
76
|
query: z.string().min(1).describe("LogQL stream selector with optional line filters, e.g. {entity_type=\"function\"} |= \"error\". The source label is entity_type. No parsers, formatting stages, or metric queries."),
|
|
74
77
|
since: z.string().describe("Lookback as a Go duration such as 30m or 24h, ending at end or now. Defaults to 1h. start takes precedence.").optional(),
|
|
75
78
|
start: z.string().describe("Window start as RFC 3339 or Unix nanoseconds.").optional(),
|
|
@@ -81,7 +84,7 @@ const lokiQueryRangeTool = (options) => bindTool(options, {
|
|
|
81
84
|
operationId: "logs.loki.queryRange",
|
|
82
85
|
id: publishedId("logs.loki.queryRange"),
|
|
83
86
|
title: "Query branch logs (Loki)",
|
|
84
|
-
description: "
|
|
87
|
+
description: "Runs a LogQL range query on a branch's logs and returns Loki's response: data.result groups lines by stream label as [nanosecond timestamp, line]. {{logs.query}} has structured filters; {{logs.fields}} and {{logs.fieldValues}} list labels. No cursor: limit lines, or the silent 10,000 cap, may mean more exist; narrow the window.",
|
|
85
88
|
inputSchema: lokiQueryRangeInputSchema,
|
|
86
89
|
annotations: {
|
|
87
90
|
readOnlyHint: true,
|
|
@@ -108,25 +111,25 @@ const lokiQueryRangeTool = (options) => bindTool(options, {
|
|
|
108
111
|
direction: input.direction
|
|
109
112
|
}, { signal }));
|
|
110
113
|
const connectionStringInputSchema = z.strictObject({
|
|
111
|
-
project_id: zGetConnectionUriPath.shape.project_id,
|
|
112
|
-
branch_id: zGetConnectionUriQuery.shape.branch_id,
|
|
113
|
-
endpoint_id: zGetConnectionUriQuery.shape.endpoint_id,
|
|
114
|
-
database_name:
|
|
115
|
-
role_name:
|
|
114
|
+
project_id: zGetConnectionUriPath.shape.project_id.describe(pathInputDescriptions.project_id),
|
|
115
|
+
branch_id: zGetConnectionUriQuery.shape.branch_id.describe(`${pathInputDescriptions.branch_id} Omit it for the default branch.`),
|
|
116
|
+
endpoint_id: zGetConnectionUriQuery.shape.endpoint_id.describe(COMPUTE_ID_DESCRIPTION),
|
|
117
|
+
database_name: databaseNameField,
|
|
118
|
+
role_name: roleNameField,
|
|
116
119
|
pooled: pooledField
|
|
117
120
|
});
|
|
118
121
|
const roleCreateFields = zCreateProjectBranchRoleBody.shape.role.shape;
|
|
119
122
|
const ACCESS_FIELDS_NEED_SCOPED_ACCESS = "database_name and schemas apply only to access read_only or read_write.";
|
|
120
123
|
const createRoleInputSchema = z.strictObject({
|
|
121
|
-
project_id: zCreateProjectBranchRolePath.shape.project_id,
|
|
122
|
-
branch_id: zCreateProjectBranchRolePath.shape.branch_id,
|
|
124
|
+
project_id: zCreateProjectBranchRolePath.shape.project_id.describe(pathInputDescriptions.project_id),
|
|
125
|
+
branch_id: zCreateProjectBranchRolePath.shape.branch_id.describe(pathInputDescriptions.branch_id),
|
|
123
126
|
name: roleCreateFields.name,
|
|
124
127
|
no_login: roleCreateFields.no_login,
|
|
125
128
|
access: z.enum([
|
|
126
129
|
"admin",
|
|
127
130
|
"read_only",
|
|
128
131
|
"read_write"
|
|
129
|
-
]).describe("
|
|
132
|
+
]).describe("read_only grants SELECT; read_write adds INSERT, UPDATE, DELETE, and sequences, on top of what PUBLIC has. Default admin joins neon_superuser.").optional(),
|
|
130
133
|
database_name: z.string().min(1).describe("Database a read_only or read_write role is scoped to. Optional when the branch has exactly one database.").optional(),
|
|
131
134
|
schemas: z.array(z.string().min(1)).min(1).describe("Schemas a read_only or read_write role can use. Default [\"public\"].").optional()
|
|
132
135
|
}).superRefine((value, ctx) => {
|
|
@@ -137,11 +140,11 @@ const createRoleInputSchema = z.strictObject({
|
|
|
137
140
|
});
|
|
138
141
|
});
|
|
139
142
|
const restoreSnapshotInputSchema = z.strictObject({
|
|
140
|
-
project_id: zRestoreSnapshotPath.shape.project_id,
|
|
143
|
+
project_id: zRestoreSnapshotPath.shape.project_id.describe(pathInputDescriptions.project_id),
|
|
141
144
|
snapshot_id: zRestoreSnapshotPath.shape.snapshot_id,
|
|
142
145
|
name: zRestoreSnapshotBody.shape.name,
|
|
143
146
|
target_branch_id: zRestoreSnapshotBody.shape.target_branch_id,
|
|
144
|
-
finalize: z.boolean().describe("
|
|
147
|
+
finalize: z.boolean().describe("Move computes onto the restored branch now. Default true for a new branch, false onto an existing one.").optional()
|
|
145
148
|
});
|
|
146
149
|
const snapshotFrequency = z.enum([
|
|
147
150
|
"daily",
|
|
@@ -149,8 +152,8 @@ const snapshotFrequency = z.enum([
|
|
|
149
152
|
"monthly"
|
|
150
153
|
]);
|
|
151
154
|
const setScheduleInputSchema = z.strictObject({
|
|
152
|
-
project_id: zSetSnapshotSchedulePath.shape.project_id,
|
|
153
|
-
branch_id: zSetSnapshotSchedulePath.shape.branch_id,
|
|
155
|
+
project_id: zSetSnapshotSchedulePath.shape.project_id.describe(pathInputDescriptions.project_id),
|
|
156
|
+
branch_id: zSetSnapshotSchedulePath.shape.branch_id.describe(pathInputDescriptions.branch_id),
|
|
154
157
|
schedule: z.array(z.strictObject({
|
|
155
158
|
...zBackupScheduleItem.shape,
|
|
156
159
|
frequency: snapshotFrequency
|
|
@@ -160,7 +163,7 @@ const createBranchTool = (options) => bindTool(options, {
|
|
|
160
163
|
operationId: "branches.create",
|
|
161
164
|
id: publishedId("branches.create"),
|
|
162
165
|
title: "Create branch",
|
|
163
|
-
description: "
|
|
166
|
+
description: "Creates a branch from its parent's current data, with a read-write compute unless no_compute, and waits until it is ready. Returns no connection string; use {{postgres.connectionString}}.",
|
|
164
167
|
inputSchema: createBranchInputSchema,
|
|
165
168
|
annotations: writeAnnotations,
|
|
166
169
|
requiresApproval: true,
|
|
@@ -189,7 +192,7 @@ const createBranchAndConnectTool = (options) => bindTool(options, {
|
|
|
189
192
|
operationId: "branches.createAndConnect",
|
|
190
193
|
id: publishedId("branches.createAndConnect"),
|
|
191
194
|
title: "Create branch and connect",
|
|
192
|
-
description: "
|
|
195
|
+
description: "Creates a branch with a read-write compute, waits until it is ready, and returns its connection string.",
|
|
193
196
|
inputSchema: createBranchAndConnectInputSchema,
|
|
194
197
|
annotations: writeAnnotations,
|
|
195
198
|
requiresApproval: true,
|
|
@@ -211,7 +214,7 @@ const createProjectTool = (options) => bindTool(options, {
|
|
|
211
214
|
operationId: "projects.create",
|
|
212
215
|
id: publishedId("projects.create"),
|
|
213
216
|
title: "Create project",
|
|
214
|
-
description: "
|
|
217
|
+
description: "Creates a project with a default branch and read-write compute and waits until it is ready. Returns no connection string; use {{postgres.connectionString}}.",
|
|
215
218
|
inputSchema: createProjectInputSchema,
|
|
216
219
|
annotations: writeAnnotations,
|
|
217
220
|
requiresApproval: true,
|
|
@@ -227,7 +230,7 @@ const createProjectAndConnectTool = (options) => bindTool(options, {
|
|
|
227
230
|
operationId: "projects.createAndConnect",
|
|
228
231
|
id: publishedId("projects.createAndConnect"),
|
|
229
232
|
title: "Create project and connect",
|
|
230
|
-
description: "
|
|
233
|
+
description: "Creates a project, waits until its default branch is ready, and returns a connection string to it.",
|
|
231
234
|
inputSchema: createProjectAndConnectInputSchema,
|
|
232
235
|
annotations: writeAnnotations,
|
|
233
236
|
requiresApproval: true,
|
|
@@ -243,7 +246,7 @@ const getDefaultTool = (options) => bindTool(options, {
|
|
|
243
246
|
operationId: "branches.getDefault",
|
|
244
247
|
id: publishedId("branches.getDefault"),
|
|
245
248
|
title: "Get default branch",
|
|
246
|
-
description: "
|
|
249
|
+
description: "Gets the project's default branch by its default flag, not its name.",
|
|
247
250
|
inputSchema: getDefaultInputSchema,
|
|
248
251
|
annotations: readAnnotations,
|
|
249
252
|
requiresApproval: false,
|
|
@@ -259,7 +262,7 @@ const resetFromParentTool = (options) => bindTool(options, {
|
|
|
259
262
|
operationId: "branches.resetFromParent",
|
|
260
263
|
id: publishedId("branches.resetFromParent"),
|
|
261
264
|
title: "Reset branch from parent",
|
|
262
|
-
description: "
|
|
265
|
+
description: "Resets a branch to its parent's current state, discarding the branch's own changes. NEVER run autonomously; always ask the user first. preserve_under_name first saves the current state as a new branch. To restore a snapshot, use {{snapshots.restore}}.",
|
|
263
266
|
inputSchema: resetFromParentInputSchema,
|
|
264
267
|
annotations: writeAnnotations,
|
|
265
268
|
requiresApproval: true,
|
|
@@ -279,7 +282,7 @@ const compareSchemaTool = (options) => bindTool(options, {
|
|
|
279
282
|
operationId: "branches.compareSchema",
|
|
280
283
|
id: publishedId("branches.compareSchema"),
|
|
281
284
|
title: "Compare database schema",
|
|
282
|
-
description: "
|
|
285
|
+
description: "Diffs one database's SQL schema on a branch against another branch, by default its parent. lsn, timestamp, base_lsn, and base_timestamp are only for point-in-time comparisons.",
|
|
283
286
|
inputSchema: compareSchemaInputSchema,
|
|
284
287
|
annotations: readAnnotations,
|
|
285
288
|
requiresApproval: false,
|
|
@@ -304,7 +307,7 @@ const connectionStringTool = (options) => bindTool(options, {
|
|
|
304
307
|
operationId: "postgres.connectionString",
|
|
305
308
|
id: publishedId("postgres.connectionString"),
|
|
306
309
|
title: "Get connection string",
|
|
307
|
-
description: "
|
|
310
|
+
description: "Returns a Postgres connection string with a role password. Omitted inputs resolve like the SQL tools: default branch, neondb or the first database, and its owner. Call it after {{projects.create}} or {{branches.create}}, which return none.",
|
|
308
311
|
inputSchema: connectionStringInputSchema,
|
|
309
312
|
annotations: readAnnotations,
|
|
310
313
|
requiresApproval: true,
|
|
@@ -315,19 +318,18 @@ const connectionStringTool = (options) => bindTool(options, {
|
|
|
315
318
|
deprecated: false,
|
|
316
319
|
tags: ["Project"]
|
|
317
320
|
}
|
|
318
|
-
}, (neon, input, signal) =>
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
}, { signal }));
|
|
321
|
+
}, async (neon, input, signal, context) => {
|
|
322
|
+
const { endpoint_id, ...target } = input;
|
|
323
|
+
return (await resolveConnection(neon, endpoint_id === void 0 ? target : {
|
|
324
|
+
...target,
|
|
325
|
+
compute_id: endpoint_id
|
|
326
|
+
}, context, signal)).uri;
|
|
327
|
+
});
|
|
326
328
|
const createRoleTool = (options) => bindTool(options, {
|
|
327
329
|
operationId: "postgres.roles.create",
|
|
328
330
|
id: publishedId("postgres.roles.create"),
|
|
329
331
|
title: "Create role",
|
|
330
|
-
description: "
|
|
332
|
+
description: "Creates a Postgres role on a branch and returns its password. The default access, admin, joins neon_superuser: every database, creating databases and roles, bypassing row-level security, and it cannot be narrowed later. For least privilege pass read_only or read_write with database_name and schemas, covering the tables the database owner owns, now and later.",
|
|
331
333
|
inputSchema: createRoleInputSchema,
|
|
332
334
|
annotations: writeAnnotations,
|
|
333
335
|
requiresApproval: true,
|
|
@@ -357,7 +359,7 @@ const restoreSnapshotTool = (options) => bindTool(options, {
|
|
|
357
359
|
operationId: "snapshots.restore",
|
|
358
360
|
id: publishedId("snapshots.restore"),
|
|
359
361
|
title: "Restore snapshot",
|
|
360
|
-
description: "
|
|
362
|
+
description: "Restores a snapshot onto a new branch or onto target_branch_id and waits until it is ready. With finalize false, swap it in later with {{branches.finalizeRestore}}.",
|
|
361
363
|
inputSchema: restoreSnapshotInputSchema,
|
|
362
364
|
annotations: writeAnnotations,
|
|
363
365
|
requiresApproval: true,
|
|
@@ -379,7 +381,7 @@ const setScheduleTool = (options) => bindTool(options, {
|
|
|
379
381
|
operationId: "snapshots.setSchedule",
|
|
380
382
|
id: publishedId("snapshots.setSchedule"),
|
|
381
383
|
title: "Set snapshot schedule",
|
|
382
|
-
description: "
|
|
384
|
+
description: "Replaces a branch's automatic snapshot schedule.",
|
|
383
385
|
inputSchema: setScheduleInputSchema,
|
|
384
386
|
annotations: writeAnnotations,
|
|
385
387
|
requiresApproval: true,
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
export declare const hiddenToolIds: readonly ["operations.waitFor", "postgres.roles.password", "storage.objects.get", "credentials.reveal", "logs.loki.labels", "logs.loki.labelValues"];
|
|
2
2
|
export type HiddenToolId = (typeof hiddenToolIds)[number];
|
|
3
|
-
export declare const toolIds: readonly ["projects.list", "projects.count", "projects.get", "projects.create", "projects.createAndConnect", "projects.update", "projects.delete", "projects.recover", "projects.transfer", "projects.transferFromUser", "projects.permissions.list", "projects.permissions.grant", "projects.permissions.revoke", "projects.members.list", "projects.members.setRole", "projects.members.removeRole", "branches.list", "branches.get", "branches.create", "branches.createAndConnect", "branches.update", "branches.delete", "branches.getDefault", "branches.setDefault", "branches.resetFromParent", "branches.compareSchema", "branches.finalizeRestore", "postgres.connectionString", "postgres.endpoints.list", "postgres.endpoints.listByBranch", "postgres.endpoints.get", "postgres.endpoints.create", "postgres.endpoints.update", "postgres.endpoints.delete", "postgres.endpoints.start", "postgres.endpoints.suspend", "postgres.endpoints.restart", "postgres.roles.list", "postgres.roles.get", "postgres.roles.create", "postgres.roles.delete", "postgres.roles.resetPassword", "postgres.databases.list", "postgres.databases.get", "postgres.databases.create", "postgres.databases.update", "postgres.databases.delete", "postgres.dataApi.get", "postgres.dataApi.create", "postgres.dataApi.update", "postgres.dataApi.delete", "storage.get", "storage.buckets.list", "storage.buckets.create", "storage.buckets.delete", "storage.objects.list", "storage.objects.delete", "storage.objects.deleteByPrefix", "storage.objects.presign", "functions.list", "functions.get", "functions.update", "functions.delete", "functions.deploy", "functions.customDomains.list", "functions.customDomains.register", "functions.customDomains.delete", "triggers.list", "triggers.get", "triggers.create", "triggers.update", "triggers.delete", "credentials.list", "credentials.create", "credentials.revoke", "credentials.rotate", "aiGateway.get", "realtime.get", "realtime.enable", "realtime.disable", "realtime.secret", "realtime.rotateSecret", "logs.query", "logs.fields", "logs.fieldValues", "logs.loki.queryRange", "snapshots.list", "snapshots.create", "snapshots.update", "snapshots.delete", "snapshots.restore", "snapshots.getSchedule", "snapshots.setSchedule", "operations.list", "operations.get", "auth.get", "auth.create", "auth.disable", "auth.updateConfig", "auth.oauthProviders.list", "auth.oauthProviders.add", "auth.oauthProviders.update", "auth.oauthProviders.delete", "auth.oauthServer.get", "auth.oauthServer.update", "auth.oauthClients.list", "auth.oauthClients.get", "auth.oauthClients.create", "auth.oauthClients.update", "auth.oauthClients.delete", "auth.oauthClients.rotateSecret", "auth.trustedDomains.list", "auth.trustedDomains.add", "auth.trustedDomains.delete", "auth.users.create", "auth.users.delete", "auth.users.updateRole", "auth.allowLocalhost.get", "auth.allowLocalhost.update", "auth.emailAndPassword.get", "auth.emailAndPassword.update", "auth.emailProvider.get", "auth.emailProvider.update", "auth.emailProvider.sendTest", "auth.plugins.get", "auth.plugins.magicLink.update", "auth.plugins.organization.update", "auth.plugins.phoneNumber.get", "auth.plugins.phoneNumber.update", "auth.webhooks.get", "auth.webhooks.update", "auth.logsExport.update", "consumption.perProject", "consumption.perProjectV2", "consumption.perBranchV2", "apiKeys.list", "apiKeys.create", "apiKeys.revoke", "organizations.get", "organizations.members.list", "organizations.members.get", "organizations.members.update", "organizations.members.remove", "organizations.invitations.list", "organizations.invitations.create", "organizations.spendingLimit.get", "organizations.spendingLimit.set", "organizations.spendingLimit.delete", "organizations.apiKeys.list", "organizations.apiKeys.create", "organizations.apiKeys.revoke", "regions.list", "user.me", "user.organizations", "incidents.list"];
|
|
3
|
+
export declare const toolIds: readonly ["projects.list", "projects.count", "projects.get", "projects.create", "projects.createAndConnect", "projects.update", "projects.delete", "projects.recover", "projects.transfer", "projects.transferFromUser", "projects.permissions.list", "projects.permissions.grant", "projects.permissions.revoke", "projects.members.list", "projects.members.setRole", "projects.members.removeRole", "branches.list", "branches.get", "branches.create", "branches.createAndConnect", "branches.update", "branches.delete", "branches.getDefault", "branches.setDefault", "branches.resetFromParent", "branches.compareSchema", "branches.finalizeRestore", "postgres.connectionString", "postgres.endpoints.list", "postgres.endpoints.listByBranch", "postgres.endpoints.get", "postgres.endpoints.create", "postgres.endpoints.update", "postgres.endpoints.delete", "postgres.endpoints.start", "postgres.endpoints.suspend", "postgres.endpoints.restart", "postgres.roles.list", "postgres.roles.get", "postgres.roles.create", "postgres.roles.delete", "postgres.roles.resetPassword", "postgres.databases.list", "postgres.databases.get", "postgres.databases.create", "postgres.databases.update", "postgres.databases.delete", "postgres.dataApi.get", "postgres.dataApi.create", "postgres.dataApi.update", "postgres.dataApi.delete", "storage.get", "storage.buckets.list", "storage.buckets.create", "storage.buckets.delete", "storage.objects.list", "storage.objects.delete", "storage.objects.deleteByPrefix", "storage.objects.presign", "functions.list", "functions.get", "functions.update", "functions.delete", "functions.deploy", "functions.customDomains.list", "functions.customDomains.register", "functions.customDomains.delete", "triggers.list", "triggers.get", "triggers.create", "triggers.update", "triggers.delete", "credentials.list", "credentials.create", "credentials.revoke", "credentials.rotate", "aiGateway.get", "realtime.get", "realtime.enable", "realtime.disable", "realtime.secret", "realtime.rotateSecret", "logs.query", "logs.fields", "logs.fieldValues", "logs.loki.queryRange", "snapshots.list", "snapshots.create", "snapshots.update", "snapshots.delete", "snapshots.restore", "snapshots.getSchedule", "snapshots.setSchedule", "operations.list", "operations.get", "auth.get", "auth.create", "auth.disable", "auth.updateConfig", "auth.oauthProviders.list", "auth.oauthProviders.add", "auth.oauthProviders.update", "auth.oauthProviders.delete", "auth.oauthServer.get", "auth.oauthServer.update", "auth.oauthClients.list", "auth.oauthClients.get", "auth.oauthClients.create", "auth.oauthClients.update", "auth.oauthClients.delete", "auth.oauthClients.rotateSecret", "auth.trustedDomains.list", "auth.trustedDomains.add", "auth.trustedDomains.delete", "auth.users.create", "auth.users.delete", "auth.users.updateRole", "auth.allowLocalhost.get", "auth.allowLocalhost.update", "auth.emailAndPassword.get", "auth.emailAndPassword.update", "auth.emailProvider.get", "auth.emailProvider.update", "auth.emailProvider.sendTest", "auth.plugins.get", "auth.plugins.magicLink.update", "auth.plugins.organization.update", "auth.plugins.phoneNumber.get", "auth.plugins.phoneNumber.update", "auth.webhooks.get", "auth.webhooks.update", "auth.logsExport.update", "consumption.perProject", "consumption.perProjectV2", "consumption.perBranchV2", "apiKeys.list", "apiKeys.create", "apiKeys.revoke", "organizations.get", "organizations.members.list", "organizations.members.get", "organizations.members.update", "organizations.members.remove", "organizations.invitations.list", "organizations.invitations.create", "organizations.spendingLimit.get", "organizations.spendingLimit.set", "organizations.spendingLimit.delete", "organizations.apiKeys.list", "organizations.apiKeys.create", "organizations.apiKeys.revoke", "regions.list", "user.me", "user.organizations", "incidents.list", "auth.getConfig", "resources.search", "sql.run", "sql.runTransaction", "sql.explain", "schema.listTables", "schema.describeTable", "branches.describe", "queries.listSlow", "database.inspect", "migrations.prepare", "migrations.complete", "queryTuning.prepare", "queryTuning.complete", "resources.fetch", "docs.search", "docs.get", "feedback.send"];
|
|
4
|
+
/** Tools that compose several requests and are not a single `NeonClient` method. */
|
|
5
|
+
export declare const customToolIds: readonly ["auth.getConfig", "resources.search", "sql.run", "sql.runTransaction", "sql.explain", "schema.listTables", "schema.describeTable", "branches.describe", "queries.listSlow", "database.inspect", "migrations.prepare", "migrations.complete", "queryTuning.prepare", "queryTuning.complete", "resources.fetch", "docs.search", "docs.get", "feedback.send"];
|
|
4
6
|
export type NeonToolId = (typeof toolIds)[number];
|
|
5
7
|
export declare const isNeonToolId: (id: string) => id is NeonToolId;
|
|
6
8
|
export declare const unpublishedToolError: (id: string) => TypeError;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ids.d.ts","sourceRoot":"","sources":["../../../src/lib/ergonomic/ids.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,aAAa,sJAOhB,CAAC;AAEX,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1D,eAAO,MAAM,OAAO,
|
|
1
|
+
{"version":3,"file":"ids.d.ts","sourceRoot":"","sources":["../../../src/lib/ergonomic/ids.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,aAAa,sJAOhB,CAAC;AAEX,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1D,eAAO,MAAM,OAAO,smIA8KV,CAAC;AAEX,oFAAoF;AACpF,eAAO,MAAM,aAAa,sWAmB8B,CAAC;AAEzD,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAElD,eAAO,MAAM,YAAY,GAAI,IAAI,MAAM,KAAG,EAAE,IAAI,UACJ,CAAC;AAc7C,eAAO,MAAM,oBAAoB,GAAI,IAAI,MAAM,KAAG,SAOjD,CAAC"}
|
|
@@ -162,7 +162,46 @@ const toolIds = [
|
|
|
162
162
|
"regions.list",
|
|
163
163
|
"user.me",
|
|
164
164
|
"user.organizations",
|
|
165
|
-
"incidents.list"
|
|
165
|
+
"incidents.list",
|
|
166
|
+
"auth.getConfig",
|
|
167
|
+
"resources.search",
|
|
168
|
+
"sql.run",
|
|
169
|
+
"sql.runTransaction",
|
|
170
|
+
"sql.explain",
|
|
171
|
+
"schema.listTables",
|
|
172
|
+
"schema.describeTable",
|
|
173
|
+
"branches.describe",
|
|
174
|
+
"queries.listSlow",
|
|
175
|
+
"database.inspect",
|
|
176
|
+
"migrations.prepare",
|
|
177
|
+
"migrations.complete",
|
|
178
|
+
"queryTuning.prepare",
|
|
179
|
+
"queryTuning.complete",
|
|
180
|
+
"resources.fetch",
|
|
181
|
+
"docs.search",
|
|
182
|
+
"docs.get",
|
|
183
|
+
"feedback.send"
|
|
184
|
+
];
|
|
185
|
+
/** Tools that compose several requests and are not a single `NeonClient` method. */
|
|
186
|
+
const customToolIds = [
|
|
187
|
+
"auth.getConfig",
|
|
188
|
+
"resources.search",
|
|
189
|
+
"sql.run",
|
|
190
|
+
"sql.runTransaction",
|
|
191
|
+
"sql.explain",
|
|
192
|
+
"schema.listTables",
|
|
193
|
+
"schema.describeTable",
|
|
194
|
+
"branches.describe",
|
|
195
|
+
"queries.listSlow",
|
|
196
|
+
"database.inspect",
|
|
197
|
+
"migrations.prepare",
|
|
198
|
+
"migrations.complete",
|
|
199
|
+
"queryTuning.prepare",
|
|
200
|
+
"queryTuning.complete",
|
|
201
|
+
"resources.fetch",
|
|
202
|
+
"docs.search",
|
|
203
|
+
"docs.get",
|
|
204
|
+
"feedback.send"
|
|
166
205
|
];
|
|
167
206
|
const isNeonToolId = (id) => toolIds.includes(id);
|
|
168
207
|
const hiddenToolHint = {
|
|
@@ -177,4 +216,4 @@ const unpublishedToolError = (id) => {
|
|
|
177
216
|
if (hiddenToolIds.includes(id)) return /* @__PURE__ */ new TypeError(`Neon tool "${id}" is not published. ${hiddenToolHint[id]}`);
|
|
178
217
|
return /* @__PURE__ */ new TypeError(`Unknown Neon tool "${id}".`);
|
|
179
218
|
};
|
|
180
|
-
export { hiddenToolIds, isNeonToolId, toolIds, unpublishedToolError };
|
|
219
|
+
export { customToolIds, hiddenToolIds, isNeonToolId, toolIds, unpublishedToolError };
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
export { type PublishedId, publishedId, type ToolClientOptions, } from "./bind.js";
|
|
2
2
|
export { type ToolFactory, toolFactories } from "./catalog.js";
|
|
3
|
-
export { type HiddenToolId, hiddenToolIds, isNeonToolId, type NeonToolId, toolIds, unpublishedToolError, } from "./ids.js";
|
|
3
|
+
export { customToolIds, type HiddenToolId, hiddenToolIds, isNeonToolId, type NeonToolId, toolIds, unpublishedToolError, } from "./ids.js";
|
|
4
4
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/ergonomic/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,KAAK,WAAW,EAChB,WAAW,EACX,KAAK,iBAAiB,GACtB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,KAAK,WAAW,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,EACN,KAAK,YAAY,EACjB,aAAa,EACb,YAAY,EACZ,KAAK,UAAU,EACf,OAAO,EACP,oBAAoB,GACpB,MAAM,UAAU,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/ergonomic/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,KAAK,WAAW,EAChB,WAAW,EACX,KAAK,iBAAiB,GACtB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,KAAK,WAAW,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,EACN,aAAa,EACb,KAAK,YAAY,EACjB,aAAa,EACb,YAAY,EACZ,KAAK,UAAU,EACf,OAAO,EACP,oBAAoB,GACpB,MAAM,UAAU,CAAC"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
import { publishedId } from "./bind.js";
|
|
2
|
+
import { customToolIds, hiddenToolIds, isNeonToolId, toolIds, unpublishedToolError } from "./ids.js";
|
|
2
3
|
import { toolFactories } from "./catalog.js";
|
|
3
|
-
|
|
4
|
-
export { hiddenToolIds, isNeonToolId, publishedId, toolFactories, toolIds, unpublishedToolError };
|
|
4
|
+
export { customToolIds, hiddenToolIds, isNeonToolId, publishedId, toolFactories, toolIds, unpublishedToolError };
|
package/dist/lib/operation.d.ts
CHANGED
|
@@ -7,9 +7,20 @@ export interface NeonToolAnnotations {
|
|
|
7
7
|
idempotentHint?: boolean;
|
|
8
8
|
openWorldHint: boolean;
|
|
9
9
|
}
|
|
10
|
+
export interface NeonToolCaller {
|
|
11
|
+
source: string;
|
|
12
|
+
userAgent?: string;
|
|
13
|
+
client?: string;
|
|
14
|
+
}
|
|
10
15
|
export interface NeonToolExecutionContext {
|
|
11
16
|
signal?: AbortSignal;
|
|
12
17
|
apiKey?: NeonBearerCredential;
|
|
18
|
+
/** SQL tools run caller SQL in a `READ ONLY` transaction or refuse to run. */
|
|
19
|
+
readOnly?: boolean;
|
|
20
|
+
/** Every SQL connection logs in as this Postgres role. */
|
|
21
|
+
postgresRole?: string;
|
|
22
|
+
/** Attribution sent with `docs.search` requests. */
|
|
23
|
+
caller?: NeonToolCaller;
|
|
13
24
|
}
|
|
14
25
|
export interface NeonToolMetadata {
|
|
15
26
|
method: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"operation.d.ts","sourceRoot":"","sources":["../../src/lib/operation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,eAAe,CAAC;AAC1D,OAAO,KAAK,KAAK,CAAC,MAAM,KAAK,CAAC;AAC9B,OAAO,EAAE,KAAK,oBAAoB,EAA2B,MAAM,WAAW,CAAC;AAG/E,MAAM,WAAW,mBAAmB;IACnC,YAAY,EAAE,OAAO,CAAC;IACtB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,aAAa,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,wBAAwB;IACxC,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,MAAM,CAAC,EAAE,oBAAoB,CAAC;
|
|
1
|
+
{"version":3,"file":"operation.d.ts","sourceRoot":"","sources":["../../src/lib/operation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,eAAe,CAAC;AAC1D,OAAO,KAAK,KAAK,CAAC,MAAM,KAAK,CAAC;AAC9B,OAAO,EAAE,KAAK,oBAAoB,EAA2B,MAAM,WAAW,CAAC;AAG/E,MAAM,WAAW,mBAAmB;IACnC,YAAY,EAAE,OAAO,CAAC;IACtB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,aAAa,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,cAAc;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,wBAAwB;IACxC,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,0DAA0D;IAC1D,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,oDAAoD;IACpD,MAAM,CAAC,EAAE,cAAc,CAAC;CACxB;AAED,MAAM,WAAW,gBAAgB;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,OAAO,CAAC;IACpB,IAAI,EAAE,SAAS,MAAM,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,YAAY;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;CACb;AAED,MAAM,MAAM,QAAQ,CAAC,KAAK,IAAI,OAAO,SAAS,KAAK,GAChD,OAAO,GACP,KAAK,SAAS,IAAI,GACjB,IAAI,GACJ,KAAK,SAAS,IAAI,GACjB,IAAI,GACJ,KAAK,SAAS,MAAM,GAAG,IAAI,GAC1B,MAAM,GACN,KAAK,SAAS,IAAI,GACjB,YAAY,GACZ,KAAK,SAAS,MAAM,GAAG,MAAM,GAAG,OAAO,GACtC,KAAK,GACL,KAAK,SAAS,SAAS,CAAC,MAAM,IAAI,CAAC,EAAE,GACpC,QAAQ,CAAC,IAAI,CAAC,EAAE,GAChB,KAAK,SAAS,MAAM,GACnB;KAAG,GAAG,IAAI,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;CAAE,GAC9C,OAAO,CAAC;AAElB,MAAM,WAAW,cAAc,CAAC,IAAI,GAAG,OAAO;IAC7C,IAAI,EAAE,IAAI,CAAC;CACX;AAED,MAAM,WAAW,QAAQ,CACxB,WAAW,SAAS,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,OAAO,EACzC,EAAE,SAAS,MAAM,GAAG,MAAM,EAC1B,MAAM,GAAG,OAAO;IAEhB,WAAW,EAAE,MAAM,CAAC;IACpB,EAAE,EAAE,EAAE,CAAC;IACP,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,WAAW,CAAC;IACzB,WAAW,EAAE,mBAAmB,CAAC;IACjC,gBAAgB,EAAE,OAAO,CAAC;IAC1B,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,OAAO,CACN,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,EAC3B,OAAO,CAAC,EAAE,wBAAwB,GAChC,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,aAAa,CAC7B,WAAW,SAAS,CAAC,CAAC,OAAO,EAC7B,EAAE,SAAS,MAAM,GAAG,MAAM,EAC1B,MAAM,GAAG,OAAO;IAEhB,WAAW,EAAE,MAAM,CAAC;IACpB,EAAE,EAAE,EAAE,CAAC;IACP,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,WAAW,CAAC;IACzB,WAAW,EAAE,mBAAmB,CAAC;IACjC,gBAAgB,EAAE,OAAO,CAAC;IAC1B,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,MAAM,CACL,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,EAC5B,MAAM,CAAC,EAAE,WAAW,GAClB,OAAO,CAAC,MAAM,CAAC,CAAC;CACnB;AAED,eAAO,MAAM,eAAe,GAC3B,KAAK,CAAC,WAAW,SAAS,CAAC,CAAC,OAAO,EACnC,KAAK,CAAC,EAAE,SAAS,MAAM,EACvB,MAAM,EAEN,WAAW,aAAa,CAAC,WAAW,EAAE,EAAE,EAAE,MAAM,CAAC,2CACpC,CAAC;AAEf,eAAO,MAAM,aAAa,GACzB,KAAK,CAAC,WAAW,SAAS,CAAC,CAAC,OAAO,EACnC,KAAK,CAAC,EAAE,SAAS,MAAM,EACvB,MAAM,EAEN,WAAW,aAAa,CAAC,WAAW,EAAE,EAAE,EAAE,MAAM,CAAC,EACjD,QAAQ,MAAM,KACZ,QAAQ,CAAC,WAAW,EAAE,EAAE,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAsBpD,CAAC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import * as z from "zod";
|
|
2
|
+
import { type NeonToolId } from "./ergonomic/ids.js";
|
|
3
|
+
export type ToolNameOf = (selector: NeonToolId) => string;
|
|
4
|
+
/** The selectors a description names as `{{selector}}`. */
|
|
5
|
+
export declare const toolReferences: (text: string) => string[];
|
|
6
|
+
/** Replaces each `{{selector}}` with the name that tool publishes under. */
|
|
7
|
+
export declare const resolveToolReferences: (text: string, nameOf: ToolNameOf, where: string) => string;
|
|
8
|
+
/** Resolves references in the descriptions of an object schema's top-level fields. */
|
|
9
|
+
export declare const resolveInputReferences: (schema: z.ZodType, nameOf: ToolNameOf, where: string) => z.ZodType;
|
|
10
|
+
//# sourceMappingURL=references.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"references.d.ts","sourceRoot":"","sources":["../../src/lib/references.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAgB,KAAK,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAInE,MAAM,MAAM,UAAU,GAAG,CAAC,QAAQ,EAAE,UAAU,KAAK,MAAM,CAAC;AAE1D,2DAA2D;AAC3D,eAAO,MAAM,cAAc,GAAI,MAAM,MAAM,KAAG,MAAM,EACG,CAAC;AAExD,4EAA4E;AAC5E,eAAO,MAAM,qBAAqB,GACjC,MAAM,MAAM,EACZ,QAAQ,UAAU,EAClB,OAAO,MAAM,KACX,MAQA,CAAC;AAeJ,sFAAsF;AACtF,eAAO,MAAM,sBAAsB,GAClC,QAAQ,CAAC,CAAC,OAAO,EACjB,QAAQ,UAAU,EAClB,OAAO,MAAM,KACX,CAAC,CAAC,OAaJ,CAAC"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { isNeonToolId } from "./ergonomic/ids.js";
|
|
2
|
+
import * as z from "zod";
|
|
3
|
+
// src/lib/references.ts
|
|
4
|
+
const REFERENCE = /\{\{([^{}]*)\}\}/g;
|
|
5
|
+
/** The selectors a description names as `{{selector}}`. */
|
|
6
|
+
const toolReferences = (text) => [...text.matchAll(REFERENCE)].map((match) => match[1]);
|
|
7
|
+
/** Replaces each `{{selector}}` with the name that tool publishes under. */
|
|
8
|
+
const resolveToolReferences = (text, nameOf, where) => text.replace(REFERENCE, (_token, selector) => {
|
|
9
|
+
if (!isNeonToolId(selector)) throw new TypeError(`Unknown Neon tool reference "{{${selector}}}" in ${where}`);
|
|
10
|
+
return nameOf(selector);
|
|
11
|
+
});
|
|
12
|
+
const fieldDescription = (field) => {
|
|
13
|
+
const description = z.globalRegistry.get(field)?.description;
|
|
14
|
+
if (description !== void 0) return description;
|
|
15
|
+
if (field instanceof z.ZodOptional || field instanceof z.ZodNullable || field instanceof z.ZodDefault) return fieldDescription(field.unwrap());
|
|
16
|
+
};
|
|
17
|
+
/** Resolves references in the descriptions of an object schema's top-level fields. */
|
|
18
|
+
const resolveInputReferences = (schema, nameOf, where) => {
|
|
19
|
+
if (!(schema instanceof z.ZodObject)) return schema;
|
|
20
|
+
const resolved = {};
|
|
21
|
+
for (const [name, field] of Object.entries(schema.shape)) {
|
|
22
|
+
const description = fieldDescription(field);
|
|
23
|
+
if (description === void 0 || !description.includes("{{")) continue;
|
|
24
|
+
resolved[name] = field.describe(resolveToolReferences(description, nameOf, `${where}.${name}`));
|
|
25
|
+
}
|
|
26
|
+
return Object.keys(resolved).length === 0 ? schema : schema.safeExtend(resolved);
|
|
27
|
+
};
|
|
28
|
+
export { resolveInputReferences, resolveToolReferences, toolReferences };
|
package/dist/operations.gen.d.ts
CHANGED
|
@@ -907,8 +907,8 @@ export declare const operationFactories: {
|
|
|
907
907
|
branch_id: z.ZodString;
|
|
908
908
|
database_name: z.ZodString;
|
|
909
909
|
auth_provider: z.ZodOptional<z.ZodOptional<z.ZodEnum<{
|
|
910
|
-
external: "external";
|
|
911
910
|
neon_auth: "neon_auth";
|
|
911
|
+
external: "external";
|
|
912
912
|
}>>>;
|
|
913
913
|
jwks_url: z.ZodOptional<z.ZodOptional<z.ZodURL>>;
|
|
914
914
|
provider_name: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
@@ -2354,7 +2354,7 @@ export declare const operationFactories: {
|
|
|
2354
2354
|
} | null | undefined;
|
|
2355
2355
|
available_schemas?: string[] | null | undefined;
|
|
2356
2356
|
observed_at?: string | null | undefined;
|
|
2357
|
-
auth_provider?: "
|
|
2357
|
+
auth_provider?: "neon_auth" | "external" | null | undefined;
|
|
2358
2358
|
jwks_url?: string | null | undefined;
|
|
2359
2359
|
provider_name?: string | null | undefined;
|
|
2360
2360
|
jwt_audience?: string | null | undefined;
|