@neon/tools 2.14.4 → 2.16.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 +195 -5
- package/dist/descriptions.gen.js +2 -2
- package/dist/effect.d.ts +22 -0
- package/dist/effect.d.ts.map +1 -0
- package/dist/effect.js +3 -0
- package/dist/generated/output.gen.d.ts +3418 -0
- package/dist/generated/output.gen.d.ts.map +1 -0
- package/dist/generated/output.gen.js +1498 -0
- package/dist/generated/zod.gen.d.ts +3 -3
- package/dist/index.d.ts +17 -5
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +30 -9
- package/dist/lib/custom/auth-config.d.ts +63 -2
- package/dist/lib/custom/auth-config.d.ts.map +1 -1
- package/dist/lib/custom/auth-config.js +34 -7
- package/dist/lib/custom/docs.d.ts +32 -2
- package/dist/lib/custom/docs.d.ts.map +1 -1
- package/dist/lib/custom/docs.js +18 -1
- package/dist/lib/custom/feedback.d.ts +7 -2
- package/dist/lib/custom/feedback.d.ts.map +1 -1
- package/dist/lib/custom/feedback.js +3 -0
- package/dist/lib/custom/fetch.d.ts +15 -1
- package/dist/lib/custom/fetch.d.ts.map +1 -1
- package/dist/lib/custom/fetch.js +10 -1
- package/dist/lib/custom/organizations.d.ts +23 -1
- package/dist/lib/custom/organizations.d.ts.map +1 -1
- package/dist/lib/custom/organizations.js +3 -0
- package/dist/lib/custom/resources.d.ts +15 -1
- package/dist/lib/custom/resources.d.ts.map +1 -1
- package/dist/lib/custom/resources.js +8 -1
- package/dist/lib/custom/sql/connection.d.ts +6 -7
- package/dist/lib/custom/sql/connection.d.ts.map +1 -1
- package/dist/lib/custom/sql/connection.js +10 -12
- package/dist/lib/custom/sql/describe-branch.d.ts +99 -1
- package/dist/lib/custom/sql/describe-branch.d.ts.map +1 -1
- package/dist/lib/custom/sql/describe-branch.js +11 -2
- package/dist/lib/custom/sql/inspect/inspect.d.ts +27 -1
- package/dist/lib/custom/sql/inspect/inspect.d.ts.map +1 -1
- package/dist/lib/custom/sql/inspect/inspect.js +17 -3
- package/dist/lib/custom/sql/migrations.d.ts +46 -2
- package/dist/lib/custom/sql/migrations.d.ts.map +1 -1
- package/dist/lib/custom/sql/migrations.js +29 -7
- package/dist/lib/custom/sql/query-tuning.d.ts +90 -2
- package/dist/lib/custom/sql/query-tuning.d.ts.map +1 -1
- package/dist/lib/custom/sql/query-tuning.js +31 -8
- package/dist/lib/custom/sql/run.d.ts +30 -3
- package/dist/lib/custom/sql/run.d.ts.map +1 -1
- package/dist/lib/custom/sql/run.js +15 -6
- package/dist/lib/custom/sql/schema.d.ts +76 -2
- package/dist/lib/custom/sql/schema.d.ts.map +1 -1
- package/dist/lib/custom/sql/schema.js +34 -5
- package/dist/lib/custom/sql/slow-queries.d.ts +15 -1
- package/dist/lib/custom/sql/slow-queries.d.ts.map +1 -1
- package/dist/lib/custom/sql/slow-queries.js +11 -3
- package/dist/lib/customize.d.ts +1 -1
- package/dist/lib/customize.d.ts.map +1 -1
- package/dist/lib/customize.js +8 -4
- package/dist/lib/effect/errors.d.ts +51 -0
- package/dist/lib/effect/errors.d.ts.map +1 -0
- package/dist/lib/effect/errors.js +37 -0
- package/dist/lib/effect/tools.d.ts +56 -0
- package/dist/lib/effect/tools.d.ts.map +1 -0
- package/dist/lib/effect/tools.js +67 -0
- package/dist/lib/ergonomic/bind.d.ts +25 -7
- 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 +5335 -180
- package/dist/lib/ergonomic/catalog.d.ts.map +1 -1
- package/dist/lib/ergonomic/catalog.js +286 -23
- package/dist/lib/ergonomic/composed.d.ts +866 -12
- package/dist/lib/ergonomic/composed.d.ts.map +1 -1
- package/dist/lib/ergonomic/composed.js +63 -0
- package/dist/lib/mcp-json-schema.d.ts +20 -0
- package/dist/lib/mcp-json-schema.d.ts.map +1 -1
- package/dist/lib/mcp-json-schema.js +89 -1
- package/dist/lib/mcp-register.d.ts +1 -1
- package/dist/lib/mcp-register.d.ts.map +1 -1
- package/dist/lib/mcp-register.js +2 -1
- package/dist/lib/operation.d.ts +56 -5
- package/dist/lib/operation.d.ts.map +1 -1
- package/dist/lib/operation.js +6 -1
- package/dist/lib/policy.d.ts +24 -0
- package/dist/lib/policy.d.ts.map +1 -0
- package/dist/lib/policy.js +49 -0
- package/dist/lib/redact.d.ts +8 -0
- package/dist/lib/redact.d.ts.map +1 -0
- package/dist/lib/redact.js +40 -0
- package/dist/mastra.d.ts +2 -1
- package/dist/mastra.d.ts.map +1 -1
- package/dist/mcp-v1.d.ts.map +1 -1
- package/dist/mcp-v1.js +3 -1
- package/dist/mcp.d.ts +3 -3
- package/dist/mcp.d.ts.map +1 -1
- package/dist/mcp.js +3 -3
- package/dist/operations.gen.d.ts +194 -194
- package/package.json +21 -2
|
@@ -1320,8 +1320,8 @@ export declare const zBillingSubscriptionType: z.ZodEnum<{
|
|
|
1320
1320
|
*
|
|
1321
1321
|
*/
|
|
1322
1322
|
export declare const zBillingPaymentMethod: z.ZodEnum<{
|
|
1323
|
-
UNKNOWN: "UNKNOWN";
|
|
1324
1323
|
none: "none";
|
|
1324
|
+
UNKNOWN: "UNKNOWN";
|
|
1325
1325
|
stripe: "stripe";
|
|
1326
1326
|
direct_payment: "direct_payment";
|
|
1327
1327
|
aws_mp: "aws_mp";
|
|
@@ -1374,8 +1374,8 @@ export declare const zBillingAccount: z.ZodObject<{
|
|
|
1374
1374
|
vercel_pg_legacy: "vercel_pg_legacy";
|
|
1375
1375
|
}>;
|
|
1376
1376
|
payment_method: z.ZodEnum<{
|
|
1377
|
-
UNKNOWN: "UNKNOWN";
|
|
1378
1377
|
none: "none";
|
|
1378
|
+
UNKNOWN: "UNKNOWN";
|
|
1379
1379
|
stripe: "stripe";
|
|
1380
1380
|
direct_payment: "direct_payment";
|
|
1381
1381
|
aws_mp: "aws_mp";
|
|
@@ -1705,8 +1705,8 @@ export declare const zCurrentUserInfoResponse: z.ZodObject<{
|
|
|
1705
1705
|
vercel_pg_legacy: "vercel_pg_legacy";
|
|
1706
1706
|
}>;
|
|
1707
1707
|
payment_method: z.ZodEnum<{
|
|
1708
|
-
UNKNOWN: "UNKNOWN";
|
|
1709
1708
|
none: "none";
|
|
1709
|
+
UNKNOWN: "UNKNOWN";
|
|
1710
1710
|
stripe: "stripe";
|
|
1711
1711
|
direct_payment: "direct_payment";
|
|
1712
1712
|
aws_mp: "aws_mp";
|
package/dist/index.d.ts
CHANGED
|
@@ -3,11 +3,15 @@ import { inspectChecks } from "./lib/custom/sql/inspect/catalog.js";
|
|
|
3
3
|
import { InspectDiagnosticError } from "./lib/custom/sql/inspect/inspect.js";
|
|
4
4
|
import { type InjectedNeonTool, type NeonToolCustomizeOptions, type NeonToolInjectOptions, type NeonToolNameOverrides } from "./lib/customize.js";
|
|
5
5
|
import { customToolIds, type NeonToolId, type PublishedId, publishedId, type ToolClientOptions, toolFactories, toolIds } from "./lib/ergonomic/index.js";
|
|
6
|
+
import { type NeonToolPolicyOptions, type NeonToolPredicate } from "./lib/policy.js";
|
|
6
7
|
export type { NeonBearerCredential } from "./lib/auth.js";
|
|
7
8
|
export type { InspectCheckInfo } from "./lib/custom/sql/inspect/catalog.js";
|
|
8
9
|
export type { InspectCheck } from "./lib/custom/sql/inspect/queries.js";
|
|
9
10
|
export type { InjectedNeonTool, NeonToolCustomizeOptions, NeonToolDescriptionOverrides, NeonToolDescriptionSource, NeonToolInjectOptions, NeonToolInjectValue, NeonToolNameOverrides, NeonToolNameSource, NeonToolOnExecute, NeonToolOnExecuteEvent, } from "./lib/customize.js";
|
|
10
|
-
export type { JsonSafe, JsonSafeBlob, NeonTool, NeonToolAnnotations, NeonToolCaller, NeonToolExecutionContext, NeonToolMetadata, NeonToolResult, } from "./lib/operation.js";
|
|
11
|
+
export type { JsonSafe, JsonSafeBlob, NeonOperationMetadata, NeonSecretField, NeonSecretKind, NeonSecretsMode, NeonTool, NeonToolAnnotations, NeonToolCaller, NeonToolExecutionContext, NeonToolMetadata, NeonToolResult, } from "./lib/operation.js";
|
|
12
|
+
export type { NeonToolDescriptor, NeonToolPolicyOptions, NeonToolPredicate, } from "./lib/policy.js";
|
|
13
|
+
export { hiddenSecretFields, withheldUnderSecrets } from "./lib/policy.js";
|
|
14
|
+
export { REDACTED_SECRET } from "./lib/redact.js";
|
|
11
15
|
export type { NeonToolId, PublishedId };
|
|
12
16
|
export { customToolIds, InspectDiagnosticError, inspectChecks, NeonError, publishedId, toolIds, };
|
|
13
17
|
type ToolFactories = typeof toolFactories;
|
|
@@ -22,24 +26,32 @@ type WithPublishedId<Tool> = Tool extends {
|
|
|
22
26
|
} ? Omit<Tool, "id"> & {
|
|
23
27
|
id: string;
|
|
24
28
|
} : Tool;
|
|
25
|
-
export interface NeonToolsClientOptions extends ToolClientOptions, Omit<NeonToolCustomizeOptions, "name" | "names"> {
|
|
29
|
+
export interface NeonToolsClientOptions extends ToolClientOptions, NeonToolPolicyOptions, Omit<NeonToolCustomizeOptions, "name" | "names"> {
|
|
26
30
|
}
|
|
27
31
|
type CreateNeonToolsInput = NeonToolsClientOptions & {
|
|
28
|
-
tools: readonly NeonToolId[];
|
|
32
|
+
tools: readonly NeonToolId[] | NeonToolPredicate;
|
|
29
33
|
};
|
|
34
|
+
type AllNeonToolIds = typeof toolIds;
|
|
30
35
|
export type CreateNeonToolsOptions<Tools extends readonly NeonToolId[] = readonly NeonToolId[]> = NeonToolsClientOptions & {
|
|
31
36
|
tools: Tools;
|
|
32
37
|
};
|
|
38
|
+
export type CreateNeonToolsPredicateOptions = NeonToolsClientOptions & {
|
|
39
|
+
tools: NeonToolPredicate;
|
|
40
|
+
};
|
|
33
41
|
type SelectedTools<T> = T extends {
|
|
34
42
|
tools: infer S extends readonly NeonToolId[];
|
|
35
43
|
} ? S : [];
|
|
36
|
-
type NeonToolsFor<T, Inject> = T extends CreateNeonToolsInput ?
|
|
44
|
+
type NeonToolsFor<T, Inject> = T extends CreateNeonToolsInput ? T extends {
|
|
45
|
+
tools: NeonToolPredicate;
|
|
46
|
+
} ? Partial<Inject extends NeonToolInjectOptions ? InjectedNeonTools<AllNeonToolIds, Inject> : NeonTools<AllNeonToolIds>> : Inject extends NeonToolInjectOptions ? InjectedNeonTools<SelectedTools<T>, Inject> : NeonTools<SelectedTools<T>> : never;
|
|
37
47
|
type ToolForId<Id extends NeonToolId> = ReturnType<ToolFactories[Id]>;
|
|
38
48
|
type NamedNeonTools<Tools extends readonly NeonToolId[], Inject> = {
|
|
39
49
|
[Tool in Tools[number]]: WithPublishedId<Inject extends NeonToolInjectOptions ? InjectedNeonTool<ReturnType<ToolFactories[Tool]>, Inject> : ReturnType<ToolFactories[Tool]>>;
|
|
40
50
|
};
|
|
41
51
|
type NamedNeonTool<Id extends NeonToolId, Inject> = WithPublishedId<Inject extends NeonToolInjectOptions ? InjectedNeonTool<ToolForId<Id>, Inject> : ToolForId<Id>>;
|
|
42
|
-
type NamedNeonToolsFor<T, Inject> = T extends CreateNeonToolsInput ?
|
|
52
|
+
type NamedNeonToolsFor<T, Inject> = T extends CreateNeonToolsInput ? T extends {
|
|
53
|
+
tools: NeonToolPredicate;
|
|
54
|
+
} ? Partial<NamedNeonTools<AllNeonToolIds, Inject>> : NamedNeonTools<SelectedTools<T>, Inject> : never;
|
|
43
55
|
export declare function createNeonTools<const T extends CreateNeonToolsInput, const Inject extends NeonToolInjectOptions | undefined = undefined>(options: T & {
|
|
44
56
|
inject?: Inject;
|
|
45
57
|
} & ({
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AACpE,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,EAGN,KAAK,gBAAgB,EACrB,KAAK,wBAAwB,EAC7B,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAE1B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACN,aAAa,EAEb,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,WAAW,EACX,KAAK,iBAAiB,EAEtB,aAAa,EACb,OAAO,EAEP,MAAM,0BAA0B,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AACpE,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,EAGN,KAAK,gBAAgB,EACrB,KAAK,wBAAwB,EAC7B,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAE1B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACN,aAAa,EAEb,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,WAAW,EACX,KAAK,iBAAiB,EAEtB,aAAa,EACb,OAAO,EAEP,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAEN,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EAGtB,MAAM,iBAAiB,CAAC;AAEzB,YAAY,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAC1D,YAAY,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,YAAY,EAAE,YAAY,EAAE,MAAM,qCAAqC,CAAC;AACxE,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,qBAAqB,EACrB,eAAe,EACf,cAAc,EACd,eAAe,EACf,QAAQ,EACR,mBAAmB,EACnB,cAAc,EACd,wBAAwB,EACxB,gBAAgB,EAChB,cAAc,GACd,MAAM,oBAAoB,CAAC;AAC5B,YAAY,EACX,kBAAkB,EAClB,qBAAqB,EACrB,iBAAiB,GACjB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAC3E,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,YAAY,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC;AACxC,OAAO,EACN,aAAa,EACb,sBAAsB,EACtB,aAAa,EACb,SAAS,EACT,WAAW,EACX,OAAO,GACP,CAAC;AAEF,KAAK,aAAa,GAAG,OAAO,aAAa,CAAC;AAE1C,MAAM,MAAM,SAAS,CAAC,KAAK,SAAS,SAAS,UAAU,EAAE,GAAG,EAAE,IAAI;KAChE,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;CACxD,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,KAAK,SAAS,SAAS,UAAU,EAAE,EAAE,MAAM,IAAI;KAC3E,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,gBAAgB,CACxC,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,EAC/B,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,iBAAiB,EACxB,qBAAqB,EACrB,IAAI,CAAC,wBAAwB,EAAE,MAAM,GAAG,OAAO,CAAC;CAAG;AAErD,KAAK,oBAAoB,GAAG,sBAAsB,GAAG;IACpD,KAAK,EAAE,SAAS,UAAU,EAAE,GAAG,iBAAiB,CAAC;CACjD,CAAC;AAEF,KAAK,cAAc,GAAG,OAAO,OAAO,CAAC;AAErC,MAAM,MAAM,sBAAsB,CACjC,KAAK,SAAS,SAAS,UAAU,EAAE,GAAG,SAAS,UAAU,EAAE,IACxD,sBAAsB,GAAG;IAAE,KAAK,EAAE,KAAK,CAAA;CAAE,CAAC;AAE9C,MAAM,MAAM,+BAA+B,GAAG,sBAAsB,GAAG;IACtE,KAAK,EAAE,iBAAiB,CAAC;CACzB,CAAC;AAEF,KAAK,aAAa,CAAC,CAAC,IAAI,CAAC,SAAS;IACjC,KAAK,EAAE,MAAM,CAAC,SAAS,SAAS,UAAU,EAAE,CAAC;CAC7C,GACE,CAAC,GACD,EAAE,CAAC;AAEN,KAAK,YAAY,CAAC,CAAC,EAAE,MAAM,IAAI,CAAC,SAAS,oBAAoB,GAC1D,CAAC,SAAS;IAAE,KAAK,EAAE,iBAAiB,CAAA;CAAE,GACrC,OAAO,CACP,MAAM,SAAS,qBAAqB,GACjC,iBAAiB,CAAC,cAAc,EAAE,MAAM,CAAC,GACzC,SAAS,CAAC,cAAc,CAAC,CAC5B,GACA,MAAM,SAAS,qBAAqB,GACnC,iBAAiB,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,GAC3C,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,GAC7B,KAAK,CAAC;AAET,KAAK,SAAS,CAAC,EAAE,SAAS,UAAU,IAAI,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC;AAiItE,KAAK,cAAc,CAAC,KAAK,SAAS,SAAS,UAAU,EAAE,EAAE,MAAM,IAAI;KACjE,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,eAAe,CACvC,MAAM,SAAS,qBAAqB,GACjC,gBAAgB,CAAC,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,GACzD,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAClC;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,SAAS;IAAE,KAAK,EAAE,iBAAiB,CAAA;CAAE,GACrC,OAAO,CAAC,cAAc,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,GAC/C,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,GACzC,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
CHANGED
|
@@ -4,6 +4,8 @@ import { InspectDiagnosticError } from "./lib/custom/sql/inspect/inspect.js";
|
|
|
4
4
|
import { customToolIds, isNeonToolId, toolIds, unpublishedToolError } from "./lib/ergonomic/ids.js";
|
|
5
5
|
import { applyToolCustomization, assertToolCustomizeOptions, publishedToolId } from "./lib/customize.js";
|
|
6
6
|
import { toolFactories } from "./lib/ergonomic/catalog.js";
|
|
7
|
+
import { REDACTED_SECRET } from "./lib/redact.js";
|
|
8
|
+
import { applyToolPolicy, hiddenSecretFields, toolCallGuard, toolDescriptor, withheldUnderSecrets } from "./lib/policy.js";
|
|
7
9
|
import { NeonError } from "@neon/sdk";
|
|
8
10
|
// src/index.ts
|
|
9
11
|
const assertKnownNameKeys = (names, tools) => {
|
|
@@ -21,16 +23,30 @@ const factoryFor = (id) => {
|
|
|
21
23
|
if (known === void 0) throw unpublishedToolError(id);
|
|
22
24
|
return toolFactories[known];
|
|
23
25
|
};
|
|
24
|
-
const
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
26
|
+
const publishedIdOf = (publishedIds, toolId) => {
|
|
27
|
+
const published = publishedIds.get(toolId);
|
|
28
|
+
if (published === void 0) throw new TypeError(`No published id for ${toolId}`);
|
|
29
|
+
return published;
|
|
30
|
+
};
|
|
31
|
+
const selectedEntries = (options) => {
|
|
32
|
+
const selection = options.tools;
|
|
33
|
+
if (typeof selection === "function") {
|
|
34
|
+
const entries = toolIds.map((toolId) => [toolId, factoryFor(toolId)(options)]).filter(([, tool]) => selection(toolDescriptor(tool)));
|
|
35
|
+
if (entries.length === 0) throw new TypeError("The createNeonTools tools predicate matched no tool");
|
|
36
|
+
return entries;
|
|
37
|
+
}
|
|
38
|
+
if (selection === void 0 || selection.length === 0) throw new TypeError("createNeonTools requires at least one tool");
|
|
28
39
|
const seen = /* @__PURE__ */ new Set();
|
|
29
|
-
|
|
40
|
+
return selection.map((toolId) => {
|
|
30
41
|
if (seen.has(toolId)) throw new Error(`Duplicate Neon tool "${toolId}"`);
|
|
31
42
|
seen.add(toolId);
|
|
32
43
|
return [toolId, factoryFor(toolId)(options)];
|
|
33
44
|
});
|
|
45
|
+
};
|
|
46
|
+
const bindTools = (options) => {
|
|
47
|
+
assertToolCustomizeOptions(options);
|
|
48
|
+
const rawEntries = selectedEntries(options);
|
|
49
|
+
const selected = rawEntries.map(([toolId]) => toolId);
|
|
34
50
|
assertKnownNameKeys(options.names, rawEntries.map(([, tool]) => tool));
|
|
35
51
|
const publishedIds = /* @__PURE__ */ new Map();
|
|
36
52
|
const selectorsById = /* @__PURE__ */ new Map();
|
|
@@ -41,7 +57,10 @@ const bindTools = (options) => {
|
|
|
41
57
|
selectorsById.set(published, id);
|
|
42
58
|
publishedIds.set(id, published);
|
|
43
59
|
}
|
|
44
|
-
const entries = rawEntries.map(([id, tool]) =>
|
|
60
|
+
const entries = rawEntries.map(([id, tool]) => {
|
|
61
|
+
const guard = toolCallGuard(tool, options, publishedIdOf(publishedIds, id));
|
|
62
|
+
return [id, applyToolCustomization(applyToolPolicy(tool, options, guard), options, publishedIds, guard)];
|
|
63
|
+
});
|
|
45
64
|
const tools = Object.fromEntries(entries);
|
|
46
65
|
assertNeonTools(tools, selected);
|
|
47
66
|
return tools;
|
|
@@ -54,7 +73,9 @@ function createNeonTool(id, options) {
|
|
|
54
73
|
assertToolCustomizeOptions(options);
|
|
55
74
|
const tool = factoryFor(id)(options);
|
|
56
75
|
assertKnownNameKeys(options.names, [tool]);
|
|
57
|
-
const
|
|
58
|
-
|
|
76
|
+
const published = publishedToolId(tool, options);
|
|
77
|
+
const publishedIds = /* @__PURE__ */ new Map([[id, published]]);
|
|
78
|
+
const guard = toolCallGuard(tool, options, published);
|
|
79
|
+
return applyToolCustomization(applyToolPolicy(tool, options, guard), options, publishedIds, guard);
|
|
59
80
|
}
|
|
60
|
-
export { InspectDiagnosticError, NeonError, createNeonTool, createNeonTools, customToolIds, inspectChecks, publishedId, toolIds };
|
|
81
|
+
export { InspectDiagnosticError, NeonError, REDACTED_SECRET, createNeonTool, createNeonTools, customToolIds, hiddenSecretFields, inspectChecks, publishedId, toolIds, withheldUnderSecrets };
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import { type NeonAuthWebhookConfig, type NeonClient } from "@neon/sdk";
|
|
2
2
|
import * as z from "zod";
|
|
3
3
|
import { type ToolClientOptions } from "../ergonomic/bind.js";
|
|
4
|
-
export declare const REDACTED_SECRET = "***redacted***";
|
|
5
4
|
export declare const getAuthConfigInputSchema: z.ZodObject<{
|
|
6
5
|
project_id: z.ZodString;
|
|
7
6
|
branch_id: z.ZodOptional<z.ZodString>;
|
|
@@ -164,5 +163,67 @@ export declare const getAuthConfigTool: (options: ToolClientOptions) => import("
|
|
|
164
163
|
logs_export: {
|
|
165
164
|
enabled: boolean;
|
|
166
165
|
} | null;
|
|
167
|
-
}
|
|
166
|
+
}, z.ZodObject<{
|
|
167
|
+
project_id: z.ZodString;
|
|
168
|
+
branch_id: z.ZodString;
|
|
169
|
+
branch_name: z.ZodString;
|
|
170
|
+
base_url: z.ZodNullable<z.ZodString>;
|
|
171
|
+
jwks_url: z.ZodString;
|
|
172
|
+
db_name: z.ZodString;
|
|
173
|
+
integration: z.ZodObject<{
|
|
174
|
+
auth_provider: z.ZodString;
|
|
175
|
+
auth_provider_project_id: z.ZodString;
|
|
176
|
+
branch_id: z.ZodString;
|
|
177
|
+
db_name: z.ZodString;
|
|
178
|
+
created_at: z.ZodString;
|
|
179
|
+
owned_by: z.ZodString;
|
|
180
|
+
transfer_status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
181
|
+
jwks_url: z.ZodString;
|
|
182
|
+
base_url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
183
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
184
|
+
}, z.core.$loose>;
|
|
185
|
+
trusted_origins: z.ZodArray<z.ZodString>;
|
|
186
|
+
allow_localhost: z.ZodBoolean;
|
|
187
|
+
auth_methods: z.ZodObject<{
|
|
188
|
+
email_password: z.ZodObject<{}, z.core.$loose>;
|
|
189
|
+
}, z.core.$loose>;
|
|
190
|
+
oauth_providers: z.ZodArray<z.ZodObject<{}, z.core.$loose>>;
|
|
191
|
+
email_provider: z.ZodUnknown;
|
|
192
|
+
plugins: z.ZodUnknown;
|
|
193
|
+
webhook: z.ZodUnknown;
|
|
194
|
+
logs_export: z.ZodUnknown;
|
|
195
|
+
_errors: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>>;
|
|
196
|
+
}, z.core.$loose>> & {
|
|
197
|
+
outputSchema: z.ZodObject<{
|
|
198
|
+
project_id: z.ZodString;
|
|
199
|
+
branch_id: z.ZodString;
|
|
200
|
+
branch_name: z.ZodString;
|
|
201
|
+
base_url: z.ZodNullable<z.ZodString>;
|
|
202
|
+
jwks_url: z.ZodString;
|
|
203
|
+
db_name: z.ZodString;
|
|
204
|
+
integration: z.ZodObject<{
|
|
205
|
+
auth_provider: z.ZodString;
|
|
206
|
+
auth_provider_project_id: z.ZodString;
|
|
207
|
+
branch_id: z.ZodString;
|
|
208
|
+
db_name: z.ZodString;
|
|
209
|
+
created_at: z.ZodString;
|
|
210
|
+
owned_by: z.ZodString;
|
|
211
|
+
transfer_status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
212
|
+
jwks_url: z.ZodString;
|
|
213
|
+
base_url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
214
|
+
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
215
|
+
}, z.core.$loose>;
|
|
216
|
+
trusted_origins: z.ZodArray<z.ZodString>;
|
|
217
|
+
allow_localhost: z.ZodBoolean;
|
|
218
|
+
auth_methods: z.ZodObject<{
|
|
219
|
+
email_password: z.ZodObject<{}, z.core.$loose>;
|
|
220
|
+
}, z.core.$loose>;
|
|
221
|
+
oauth_providers: z.ZodArray<z.ZodObject<{}, z.core.$loose>>;
|
|
222
|
+
email_provider: z.ZodUnknown;
|
|
223
|
+
plugins: z.ZodUnknown;
|
|
224
|
+
webhook: z.ZodUnknown;
|
|
225
|
+
logs_export: z.ZodUnknown;
|
|
226
|
+
_errors: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>>;
|
|
227
|
+
}, z.core.$loose>;
|
|
228
|
+
};
|
|
168
229
|
//# sourceMappingURL=auth-config.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"auth-config.d.ts","sourceRoot":"","sources":["../../../src/lib/custom/auth-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAON,KAAK,qBAAqB,EAC1B,KAAK,UAAU,EACf,MAAM,WAAW,CAAC;AACnB,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;
|
|
1
|
+
{"version":3,"file":"auth-config.d.ts","sourceRoot":"","sources":["../../../src/lib/custom/auth-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAON,KAAK,qBAAqB,EAC1B,KAAK,UAAU,EACf,MAAM,WAAW,CAAC;AACnB,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAIzB,OAAO,EAGN,KAAK,iBAAiB,EACtB,MAAM,sBAAsB,CAAC;AAE9B,eAAO,MAAM,wBAAwB;;;kBASnC,CAAC;AA0GH,eAAO,MAAM,cAAc,GAC1B,MAAM,UAAU,CAAC,IAAI,CAAC,EACtB,OAAO,CAAC,CAAC,MAAM,CAAC,OAAO,wBAAwB,CAAC,EAChD,SAAS,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAyFpB,CAAC;AAgCF,eAAO,MAAM,iBAAiB,GAAI,SAAS,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmC1D,CAAC"}
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import { pathInputDescriptions } from "../../descriptions.gen.js";
|
|
2
2
|
import { zGetNeonAuthPath } from "../../generated/zod.gen.js";
|
|
3
3
|
import { bindTool, publishedId } from "../ergonomic/bind.js";
|
|
4
|
-
import {
|
|
4
|
+
import { NeonAuthIntegration } from "../../generated/output.gen.js";
|
|
5
5
|
import * as z from "zod";
|
|
6
|
+
import { NeonApiError } from "@neon/sdk";
|
|
6
7
|
// src/lib/custom/auth-config.ts
|
|
7
|
-
const REDACTED_SECRET = "***redacted***";
|
|
8
8
|
const getAuthConfigInputSchema = z.strictObject({
|
|
9
9
|
project_id: zGetNeonAuthPath.shape.project_id.describe(pathInputDescriptions.project_id),
|
|
10
10
|
branch_id: zGetNeonAuthPath.shape.branch_id.describe(`${pathInputDescriptions.branch_id} Omit it for the project's default branch.`).optional()
|
|
@@ -24,7 +24,7 @@ const oauthProviderSettings = (provider) => ({
|
|
|
24
24
|
id: provider.id,
|
|
25
25
|
type: provider.type,
|
|
26
26
|
client_id: provider.client_id ?? null,
|
|
27
|
-
client_secret: provider.client_secret
|
|
27
|
+
client_secret: provider.client_secret ?? null,
|
|
28
28
|
...provider.microsoft_tenant_id && { microsoft_tenant_id: provider.microsoft_tenant_id },
|
|
29
29
|
...provider.apple_team_id && { apple_team_id: provider.apple_team_id },
|
|
30
30
|
...provider.apple_key_id && { apple_key_id: provider.apple_key_id }
|
|
@@ -37,7 +37,7 @@ const emailProviderSettings = (data) => {
|
|
|
37
37
|
host: data.host,
|
|
38
38
|
port: data.port,
|
|
39
39
|
username: data.username,
|
|
40
|
-
password:
|
|
40
|
+
password: data.password ?? null,
|
|
41
41
|
sender_email: data.sender_email,
|
|
42
42
|
sender_name: data.sender_name
|
|
43
43
|
};
|
|
@@ -154,25 +154,52 @@ const readAuthConfig = async (neon, input, signal) => {
|
|
|
154
154
|
...Object.keys(errors).length > 0 && { _errors: errors }
|
|
155
155
|
};
|
|
156
156
|
};
|
|
157
|
+
const authConfigOutputSchema = z.looseObject({
|
|
158
|
+
project_id: z.string(),
|
|
159
|
+
branch_id: z.string(),
|
|
160
|
+
branch_name: z.string(),
|
|
161
|
+
base_url: z.string().nullable().describe("Neon Auth API base URL."),
|
|
162
|
+
jwks_url: z.string().describe("JWKS URL for verifying session tokens."),
|
|
163
|
+
db_name: z.string().describe("Database that holds the auth schema."),
|
|
164
|
+
integration: NeonAuthIntegration.describe("The branch's Neon Auth integration."),
|
|
165
|
+
trusted_origins: z.array(z.string()).describe("Domains allowed as redirect targets."),
|
|
166
|
+
allow_localhost: z.boolean(),
|
|
167
|
+
auth_methods: z.looseObject({ email_password: z.looseObject({}) }).describe("Email and password settings."),
|
|
168
|
+
oauth_providers: z.array(z.looseObject({})).describe("OAuth providers, secrets redacted."),
|
|
169
|
+
email_provider: z.unknown().describe("Email server, secrets redacted."),
|
|
170
|
+
plugins: z.unknown().describe("Plugin settings."),
|
|
171
|
+
webhook: z.unknown().describe("Webhook settings, secrets redacted."),
|
|
172
|
+
logs_export: z.unknown().describe("Logs export settings."),
|
|
173
|
+
_errors: z.record(z.string(), z.string()).nullish().describe("Settings that failed to read, by key.")
|
|
174
|
+
});
|
|
157
175
|
const getAuthConfigTool = (options) => bindTool(options, {
|
|
158
176
|
operationId: "auth.getConfig",
|
|
159
177
|
id: publishedId("auth.getConfig"),
|
|
160
178
|
title: "Get Neon Auth configuration",
|
|
161
|
-
description: "Returns a branch's Neon Auth integration and settings: trusted origins, localhost, email and password, OAuth and email providers, plugins, webhook, and logs export
|
|
179
|
+
description: "Returns a branch's Neon Auth integration and settings: trusted origins, localhost, email and password, OAuth and email providers, plugins, webhook, and logs export. Needs Neon Auth on the branch ({{auth.create}}).",
|
|
162
180
|
inputSchema: getAuthConfigInputSchema,
|
|
181
|
+
outputSchema: authConfigOutputSchema,
|
|
163
182
|
annotations: {
|
|
164
183
|
readOnlyHint: true,
|
|
165
184
|
destructiveHint: false,
|
|
166
185
|
idempotentHint: true,
|
|
167
186
|
openWorldHint: false
|
|
168
187
|
},
|
|
169
|
-
requiresApproval:
|
|
188
|
+
requiresApproval: true,
|
|
170
189
|
metadata: {
|
|
171
190
|
method: "GET",
|
|
191
|
+
readOnlySafe: true,
|
|
192
|
+
secretOutputFields: [{
|
|
193
|
+
path: "$.oauth_providers[*].client_secret",
|
|
194
|
+
kind: "stored"
|
|
195
|
+
}, {
|
|
196
|
+
path: "$.email_provider.password",
|
|
197
|
+
kind: "stored"
|
|
198
|
+
}],
|
|
172
199
|
path: "/projects/{project_id}/branches/{branch_id}/auth",
|
|
173
200
|
stability: "stable",
|
|
174
201
|
deprecated: false,
|
|
175
202
|
tags: ["Auth"]
|
|
176
203
|
}
|
|
177
204
|
}, readAuthConfig);
|
|
178
|
-
export {
|
|
205
|
+
export { getAuthConfigInputSchema, getAuthConfigTool, readAuthConfig };
|
|
@@ -48,11 +48,41 @@ export declare const searchDocsTool: (options: ToolClientOptions) => import("../
|
|
|
48
48
|
heading: string;
|
|
49
49
|
excerpt: string;
|
|
50
50
|
}[];
|
|
51
|
-
}
|
|
51
|
+
}, z.ZodObject<{
|
|
52
|
+
hits: z.ZodArray<z.ZodObject<{
|
|
53
|
+
title: z.ZodString;
|
|
54
|
+
url: z.ZodString;
|
|
55
|
+
slug: z.ZodString;
|
|
56
|
+
category: z.ZodString;
|
|
57
|
+
breadcrumb: z.ZodArray<z.ZodString>;
|
|
58
|
+
heading: z.ZodString;
|
|
59
|
+
excerpt: z.ZodString;
|
|
60
|
+
}, z.core.$loose>>;
|
|
61
|
+
}, z.core.$loose>> & {
|
|
62
|
+
outputSchema: z.ZodObject<{
|
|
63
|
+
hits: z.ZodArray<z.ZodObject<{
|
|
64
|
+
title: z.ZodString;
|
|
65
|
+
url: z.ZodString;
|
|
66
|
+
slug: z.ZodString;
|
|
67
|
+
category: z.ZodString;
|
|
68
|
+
breadcrumb: z.ZodArray<z.ZodString>;
|
|
69
|
+
heading: z.ZodString;
|
|
70
|
+
excerpt: z.ZodString;
|
|
71
|
+
}, z.core.$loose>>;
|
|
72
|
+
}, z.core.$loose>;
|
|
73
|
+
};
|
|
52
74
|
export declare const getDocTool: (options: ToolClientOptions) => import("../operation.js").NeonTool<z.ZodObject<{
|
|
53
75
|
slug: z.ZodString;
|
|
54
76
|
}, z.core.$strict>, "get_docs", {
|
|
55
77
|
url: string;
|
|
56
78
|
markdown: string;
|
|
57
|
-
}
|
|
79
|
+
}, z.ZodObject<{
|
|
80
|
+
url: z.ZodString;
|
|
81
|
+
markdown: z.ZodString;
|
|
82
|
+
}, z.core.$loose>> & {
|
|
83
|
+
outputSchema: z.ZodObject<{
|
|
84
|
+
url: z.ZodString;
|
|
85
|
+
markdown: z.ZodString;
|
|
86
|
+
}, z.core.$loose>;
|
|
87
|
+
};
|
|
58
88
|
//# sourceMappingURL=docs.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"docs.d.ts","sourceRoot":"","sources":["../../../src/lib/custom/docs.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAGN,KAAK,iBAAiB,EACtB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAuB,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAE3E,eAAO,MAAM,uBAAuB,8FACwD,CAAC;AAC7F,eAAO,MAAM,qBAAqB,qBAAqB,CAAC;AAGxD,eAAO,MAAM,mBAAmB,QAAS,CAAC;AAE1C,eAAO,MAAM,cAAc,GAAI,SAAS,WAAW,gBAGlD,CAAC;AAmBF,eAAO,MAAM,qBAAqB;;;;;;;;;;;;kBA2BhC,CAAC;AAEH,eAAO,MAAM,iBAAiB;;kBAM5B,CAAC;AAiCH;;;GAGG;AACH,eAAO,MAAM,iBAAiB,GAC7B,QAAQ,cAAc,GAAG,SAAS,KAChC,MAAM,CAAC,MAAM,EAAE,MAAM,CAkBvB,CAAC;
|
|
1
|
+
{"version":3,"file":"docs.d.ts","sourceRoot":"","sources":["../../../src/lib/custom/docs.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAGN,KAAK,iBAAiB,EACtB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAuB,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAE3E,eAAO,MAAM,uBAAuB,8FACwD,CAAC;AAC7F,eAAO,MAAM,qBAAqB,qBAAqB,CAAC;AAGxD,eAAO,MAAM,mBAAmB,QAAS,CAAC;AAE1C,eAAO,MAAM,cAAc,GAAI,SAAS,WAAW,gBAGlD,CAAC;AAmBF,eAAO,MAAM,qBAAqB;;;;;;;;;;;;kBA2BhC,CAAC;AAEH,eAAO,MAAM,iBAAiB;;kBAM5B,CAAC;AAiCH;;;GAGG;AACH,eAAO,MAAM,iBAAiB,GAC7B,QAAQ,cAAc,GAAG,SAAS,KAChC,MAAM,CAAC,MAAM,EAAE,MAAM,CAkBvB,CAAC;AAoCF,eAAO,MAAM,cAAc,GAAI,SAAS,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4DxD,CAAC;AAOF,eAAO,MAAM,UAAU,GAAI,SAAS,iBAAiB;;;;;;;;;;;;;CA2CpD,CAAC"}
|
package/dist/lib/custom/docs.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { bindPublicTool, publishedId } from "../ergonomic/bind.js";
|
|
2
|
-
import { NeonClientError } from "@neon/sdk";
|
|
3
2
|
import * as z from "zod";
|
|
3
|
+
import { NeonClientError } from "@neon/sdk";
|
|
4
4
|
// src/lib/custom/docs.ts
|
|
5
5
|
const DEFAULT_SITE_SEARCH_URL = "https://br-frosty-cell-a5smzg39-assistant.compute.c-1.us-east-2.aws.neon.tech/site-search";
|
|
6
6
|
const DEFAULT_DOCS_BASE_URL = "https://neon.com";
|
|
@@ -67,6 +67,15 @@ const validateDocSlug = (slug) => {
|
|
|
67
67
|
if (slug.includes("://")) throw new NeonClientError("Invalid doc slug: absolute URLs are not allowed");
|
|
68
68
|
if (slug.startsWith("/")) throw new NeonClientError("Invalid doc slug: slug must not start with \"/\"");
|
|
69
69
|
};
|
|
70
|
+
const searchDocsOutputSchema = z.looseObject({ hits: z.array(z.looseObject({
|
|
71
|
+
title: z.string(),
|
|
72
|
+
url: z.string(),
|
|
73
|
+
slug: z.string(),
|
|
74
|
+
category: z.string(),
|
|
75
|
+
breadcrumb: z.array(z.string()),
|
|
76
|
+
heading: z.string(),
|
|
77
|
+
excerpt: z.string()
|
|
78
|
+
})).describe("Matching doc sections.") });
|
|
70
79
|
const searchDocsTool = (options) => {
|
|
71
80
|
const url = options.siteSearchUrl ?? "https://br-frosty-cell-a5smzg39-assistant.compute.c-1.us-east-2.aws.neon.tech/site-search";
|
|
72
81
|
const fetchImpl = options.fetch ?? fetch;
|
|
@@ -76,10 +85,12 @@ const searchDocsTool = (options) => {
|
|
|
76
85
|
title: "Search Documentation",
|
|
77
86
|
description: "Searches neon.com docs, API reference, PostgreSQL tutorial, guides, FAQs, changelog, and blog for ranked pages with the slug {{docs.get}} reads.",
|
|
78
87
|
inputSchema: searchDocsInputSchema,
|
|
88
|
+
outputSchema: searchDocsOutputSchema,
|
|
79
89
|
annotations: docsAnnotations,
|
|
80
90
|
requiresApproval: false,
|
|
81
91
|
metadata: {
|
|
82
92
|
method: "POST",
|
|
93
|
+
readOnlySafe: true,
|
|
83
94
|
path: "/site-search",
|
|
84
95
|
stability: "stable",
|
|
85
96
|
deprecated: false,
|
|
@@ -109,6 +120,10 @@ const searchDocsTool = (options) => {
|
|
|
109
120
|
return parsed.data;
|
|
110
121
|
});
|
|
111
122
|
};
|
|
123
|
+
const getDocOutputSchema = z.looseObject({
|
|
124
|
+
url: z.string(),
|
|
125
|
+
markdown: z.string().describe("The page as markdown.")
|
|
126
|
+
});
|
|
112
127
|
const getDocTool = (options) => {
|
|
113
128
|
const baseUrl = options.docsBaseUrl ?? "https://neon.com";
|
|
114
129
|
const fetchImpl = options.fetch ?? fetch;
|
|
@@ -118,10 +133,12 @@ const getDocTool = (options) => {
|
|
|
118
133
|
title: "Get Documentation Page",
|
|
119
134
|
description: "Returns one neon.com page as markdown, by the slug of a {{docs.search}} hit.",
|
|
120
135
|
inputSchema: getDocInputSchema,
|
|
136
|
+
outputSchema: getDocOutputSchema,
|
|
121
137
|
annotations: docsAnnotations,
|
|
122
138
|
requiresApproval: false,
|
|
123
139
|
metadata: {
|
|
124
140
|
method: "GET",
|
|
141
|
+
readOnlySafe: true,
|
|
125
142
|
path: "/{slug}.md",
|
|
126
143
|
stability: "stable",
|
|
127
144
|
deprecated: false,
|
|
@@ -6,10 +6,15 @@ export declare const MAX_FEEDBACK_LENGTH = 10000;
|
|
|
6
6
|
export declare const sendFeedbackInputSchema: z.ZodObject<{
|
|
7
7
|
feedback: z.ZodString;
|
|
8
8
|
}, z.core.$strict>;
|
|
9
|
-
/** Sends only the message and `source` to the Neon feedback service: no account, project, or credential. */
|
|
10
9
|
export declare const sendFeedbackTool: (options: ToolClientOptions) => import("../operation.js").NeonTool<z.ZodObject<{
|
|
11
10
|
feedback: z.ZodString;
|
|
12
11
|
}, z.core.$strict>, "send_feedback", {
|
|
13
12
|
message: string;
|
|
14
|
-
}
|
|
13
|
+
}, z.ZodObject<{
|
|
14
|
+
message: z.ZodString;
|
|
15
|
+
}, z.core.$loose>> & {
|
|
16
|
+
outputSchema: z.ZodObject<{
|
|
17
|
+
message: z.ZodString;
|
|
18
|
+
}, z.core.$loose>;
|
|
19
|
+
};
|
|
15
20
|
//# sourceMappingURL=feedback.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"feedback.d.ts","sourceRoot":"","sources":["../../../src/lib/custom/feedback.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAGN,KAAK,iBAAiB,EACtB,MAAM,sBAAsB,CAAC;AAG9B,eAAO,MAAM,oBAAoB,gCAAgC,CAAC;AAClE,eAAO,MAAM,uBAAuB,eAAe,CAAC;AAGpD,eAAO,MAAM,mBAAmB,QAAS,CAAC;AAE1C,eAAO,MAAM,uBAAuB;;kBASlC,CAAC;
|
|
1
|
+
{"version":3,"file":"feedback.d.ts","sourceRoot":"","sources":["../../../src/lib/custom/feedback.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAGN,KAAK,iBAAiB,EACtB,MAAM,sBAAsB,CAAC;AAG9B,eAAO,MAAM,oBAAoB,gCAAgC,CAAC;AAClE,eAAO,MAAM,uBAAuB,eAAe,CAAC;AAGpD,eAAO,MAAM,mBAAmB,QAAS,CAAC;AAE1C,eAAO,MAAM,uBAAuB;;kBASlC,CAAC;AAKH,eAAO,MAAM,gBAAgB,GAAI,SAAS,iBAAiB;;;;;;;;;;CA8D1D,CAAC"}
|
|
@@ -7,6 +7,7 @@ const DEFAULT_FEEDBACK_SOURCE = "neon_tools";
|
|
|
7
7
|
const MAX_FEEDBACK_LENGTH = 1e4;
|
|
8
8
|
const sendFeedbackInputSchema = z.strictObject({ feedback: z.string().trim().min(1).max(MAX_FEEDBACK_LENGTH).describe("The feedback to send to Neon. Do not include passwords, API keys, connection strings, or other secrets.") });
|
|
9
9
|
/** Sends only the message and `source` to the Neon feedback service: no account, project, or credential. */
|
|
10
|
+
const sendFeedbackOutputSchema = z.looseObject({ message: z.string() });
|
|
10
11
|
const sendFeedbackTool = (options) => {
|
|
11
12
|
const url = options.feedbackUrl ?? "https://feedback.neon.tech/";
|
|
12
13
|
const source = options.feedbackSource ?? "neon_tools";
|
|
@@ -17,6 +18,7 @@ const sendFeedbackTool = (options) => {
|
|
|
17
18
|
title: "Send Feedback",
|
|
18
19
|
description: "Sends anonymous feedback text to the Neon team, with no account, project, or connection details. Only call it when the user asks to give feedback.",
|
|
19
20
|
inputSchema: sendFeedbackInputSchema,
|
|
21
|
+
outputSchema: sendFeedbackOutputSchema,
|
|
20
22
|
annotations: {
|
|
21
23
|
readOnlyHint: false,
|
|
22
24
|
destructiveHint: false,
|
|
@@ -26,6 +28,7 @@ const sendFeedbackTool = (options) => {
|
|
|
26
28
|
requiresApproval: true,
|
|
27
29
|
metadata: {
|
|
28
30
|
method: "POST",
|
|
31
|
+
readOnlySafe: true,
|
|
29
32
|
path: "/",
|
|
30
33
|
stability: "stable",
|
|
31
34
|
deprecated: false,
|
|
@@ -398,5 +398,19 @@ export declare const fetchResourceTool: (options: ToolClientOptions) => import("
|
|
|
398
398
|
}[][] | null;
|
|
399
399
|
database_structure_error?: string | null | undefined;
|
|
400
400
|
};
|
|
401
|
-
}
|
|
401
|
+
}, z.ZodObject<{
|
|
402
|
+
id: z.ZodString;
|
|
403
|
+
title: z.ZodString;
|
|
404
|
+
text: z.ZodString;
|
|
405
|
+
url: z.ZodString;
|
|
406
|
+
metadata: z.ZodObject<{}, z.core.$loose>;
|
|
407
|
+
}, z.core.$loose>> & {
|
|
408
|
+
outputSchema: z.ZodObject<{
|
|
409
|
+
id: z.ZodString;
|
|
410
|
+
title: z.ZodString;
|
|
411
|
+
text: z.ZodString;
|
|
412
|
+
url: z.ZodString;
|
|
413
|
+
metadata: z.ZodObject<{}, z.core.$loose>;
|
|
414
|
+
}, z.core.$loose>;
|
|
415
|
+
};
|
|
402
416
|
//# sourceMappingURL=fetch.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../../../src/lib/custom/fetch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAmC,MAAM,WAAW,CAAC;AAC7E,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAGN,KAAK,iBAAiB,EACtB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AAQhE,eAAO,MAAM,wBAAwB;;kBAOnC,CAAC;AAkMH,eAAO,MAAM,aAAa,GACzB,YAAY,UAAU,CAAC,IAAI,CAAC,EAC5B,IAAI,MAAM,EACV,SAAS,wBAAwB,EACjC,YAAY,MAAM,EAClB,SAAS,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+DpB,CAAC;
|
|
1
|
+
{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../../../src/lib/custom/fetch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAmC,MAAM,WAAW,CAAC;AAC7E,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAGN,KAAK,iBAAiB,EACtB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AAQhE,eAAO,MAAM,wBAAwB;;kBAOnC,CAAC;AAkMH,eAAO,MAAM,aAAa,GACzB,YAAY,UAAU,CAAC,IAAI,CAAC,EAC5B,IAAI,MAAM,EACV,SAAS,wBAAwB,EACjC,YAAY,MAAM,EAClB,SAAS,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+DpB,CAAC;AAcF,eAAO,MAAM,iBAAiB,GAAI,SAAS,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+B3D,CAAC"}
|
package/dist/lib/custom/fetch.js
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { bindTool, publishedId } from "../ergonomic/bind.js";
|
|
2
2
|
import { consoleBaseUrl, isAccessRefusal } from "./resources.js";
|
|
3
3
|
import { describeBranch } from "./sql/describe-branch.js";
|
|
4
|
-
import { NeonClientError } from "@neon/sdk";
|
|
5
4
|
import * as z from "zod";
|
|
5
|
+
import { NeonClientError } from "@neon/sdk";
|
|
6
6
|
// src/lib/custom/fetch.ts
|
|
7
7
|
const fetchResourceInputSchema = z.strictObject({ id: z.string().min(1).describe("An id from {{resources.search}}, such as project:<project_id>.") });
|
|
8
8
|
/** The first page only; a list the API refuses is empty. */
|
|
@@ -167,6 +167,13 @@ const fetchResource = async (neonClient, id, context, consoleUrl, signal) => {
|
|
|
167
167
|
}
|
|
168
168
|
throw invalidId(id);
|
|
169
169
|
};
|
|
170
|
+
const fetchResourceOutputSchema = z.looseObject({
|
|
171
|
+
id: z.string(),
|
|
172
|
+
title: z.string(),
|
|
173
|
+
text: z.string().describe("The resource as markdown."),
|
|
174
|
+
url: z.string().describe("Console URL."),
|
|
175
|
+
metadata: z.looseObject({}).describe("API records: organization, members, and projects; project and branches; endpoint; or snapshot.")
|
|
176
|
+
});
|
|
170
177
|
const fetchResourceTool = (options) => {
|
|
171
178
|
const consoleUrl = consoleBaseUrl(options.baseUrl ?? "https://console.neon.tech/api/v2");
|
|
172
179
|
return bindTool(options, {
|
|
@@ -175,6 +182,7 @@ const fetchResourceTool = (options) => {
|
|
|
175
182
|
title: "Fetch",
|
|
176
183
|
description: "Returns an organization, project, branch, compute, or snapshot by an id from {{resources.search}}: markdown text, console URL, and records in metadata.",
|
|
177
184
|
inputSchema: fetchResourceInputSchema,
|
|
185
|
+
outputSchema: fetchResourceOutputSchema,
|
|
178
186
|
annotations: {
|
|
179
187
|
readOnlyHint: true,
|
|
180
188
|
destructiveHint: false,
|
|
@@ -184,6 +192,7 @@ const fetchResourceTool = (options) => {
|
|
|
184
192
|
requiresApproval: false,
|
|
185
193
|
metadata: {
|
|
186
194
|
method: "SQL",
|
|
195
|
+
readOnlySafe: true,
|
|
187
196
|
path: "/projects",
|
|
188
197
|
stability: "stable",
|
|
189
198
|
deprecated: false,
|
|
@@ -19,5 +19,27 @@ export declare const userOrganizationsTool: (options: ToolClientOptions) => impo
|
|
|
19
19
|
updated_at: string;
|
|
20
20
|
allow_hipaa_projects?: boolean | null | undefined;
|
|
21
21
|
require_mfa?: boolean | null | undefined;
|
|
22
|
-
}[]
|
|
22
|
+
}[], z.ZodArray<z.ZodObject<{
|
|
23
|
+
id: z.ZodString;
|
|
24
|
+
name: z.ZodString;
|
|
25
|
+
handle: z.ZodString;
|
|
26
|
+
plan: z.ZodString;
|
|
27
|
+
created_at: z.ZodString;
|
|
28
|
+
managed_by: z.ZodString;
|
|
29
|
+
updated_at: z.ZodString;
|
|
30
|
+
allow_hipaa_projects: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
31
|
+
require_mfa: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
32
|
+
}, z.core.$loose>>> & {
|
|
33
|
+
outputSchema: z.ZodArray<z.ZodObject<{
|
|
34
|
+
id: z.ZodString;
|
|
35
|
+
name: z.ZodString;
|
|
36
|
+
handle: z.ZodString;
|
|
37
|
+
plan: z.ZodString;
|
|
38
|
+
created_at: z.ZodString;
|
|
39
|
+
managed_by: z.ZodString;
|
|
40
|
+
updated_at: z.ZodString;
|
|
41
|
+
allow_hipaa_projects: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
42
|
+
require_mfa: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
43
|
+
}, z.core.$loose>>;
|
|
44
|
+
};
|
|
23
45
|
//# sourceMappingURL=organizations.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"organizations.d.ts","sourceRoot":"","sources":["../../../src/lib/custom/organizations.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;
|
|
1
|
+
{"version":3,"file":"organizations.d.ts","sourceRoot":"","sources":["../../../src/lib/custom/organizations.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,OAAO,EAGN,KAAK,iBAAiB,EACtB,MAAM,sBAAsB,CAAC;AAE9B,eAAO,MAAM,4BAA4B;;kBAKvC,CAAC;AAEH,eAAO,MAAM,eAAe,GAC3B,QAAQ;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,EACpC,OAAO,MAAM,YAOb,CAAC;AAEF,eAAO,MAAM,qBAAqB,GAAI,SAAS,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2B9D,CAAC"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { bindTool, publishedId } from "../ergonomic/bind.js";
|
|
2
|
+
import { Organization } from "../../generated/output.gen.js";
|
|
2
3
|
import * as z from "zod";
|
|
3
4
|
// src/lib/custom/organizations.ts
|
|
4
5
|
const userOrganizationsInputSchema = z.strictObject({ search: z.string().describe("Part of an organization name or id, ignoring case.").optional() });
|
|
@@ -12,6 +13,7 @@ const userOrganizationsTool = (options) => bindTool(options, {
|
|
|
12
13
|
title: "List organizations for the current user",
|
|
13
14
|
description: "Lists the organizations the user belongs to; an organization API key gets its own organization. search filters by name or id.",
|
|
14
15
|
inputSchema: userOrganizationsInputSchema,
|
|
16
|
+
outputSchema: z.array(Organization),
|
|
15
17
|
annotations: {
|
|
16
18
|
readOnlyHint: true,
|
|
17
19
|
openWorldHint: false
|
|
@@ -19,6 +21,7 @@ const userOrganizationsTool = (options) => bindTool(options, {
|
|
|
19
21
|
requiresApproval: false,
|
|
20
22
|
metadata: {
|
|
21
23
|
method: "GET",
|
|
24
|
+
readOnlySafe: true,
|
|
22
25
|
path: "/users/me/organizations",
|
|
23
26
|
stability: "stable",
|
|
24
27
|
deprecated: false,
|