@agentuity/core 1.0.41 → 1.0.42
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/dist/services/api-reference.d.ts +68 -0
- package/dist/services/api-reference.d.ts.map +1 -0
- package/dist/services/api-reference.js +91 -0
- package/dist/services/api-reference.js.map +1 -0
- package/dist/services/apikey/api-reference.d.ts +4 -0
- package/dist/services/apikey/api-reference.d.ts.map +1 -0
- package/dist/services/apikey/api-reference.js +96 -0
- package/dist/services/apikey/api-reference.js.map +1 -0
- package/dist/services/db/api-reference.d.ts +4 -0
- package/dist/services/db/api-reference.d.ts.map +1 -0
- package/dist/services/db/api-reference.js +149 -0
- package/dist/services/db/api-reference.js.map +1 -0
- package/dist/services/db/types.d.ts +7 -0
- package/dist/services/db/types.d.ts.map +1 -0
- package/dist/services/db/types.js +9 -0
- package/dist/services/db/types.js.map +1 -0
- package/dist/services/email/api-reference.d.ts +4 -0
- package/dist/services/email/api-reference.d.ts.map +1 -0
- package/dist/services/email/api-reference.js +342 -0
- package/dist/services/email/api-reference.js.map +1 -0
- package/dist/services/email/service.d.ts.map +1 -1
- package/dist/services/email/service.js +1 -2
- package/dist/services/email/service.js.map +1 -1
- package/dist/services/email/types.d.ts +13 -0
- package/dist/services/email/types.d.ts.map +1 -0
- package/dist/services/email/types.js +11 -0
- package/dist/services/email/types.js.map +1 -0
- package/dist/services/eval/api-reference.d.ts +4 -0
- package/dist/services/eval/api-reference.d.ts.map +1 -0
- package/dist/services/eval/api-reference.js +121 -0
- package/dist/services/eval/api-reference.js.map +1 -0
- package/dist/services/index.d.ts +2 -0
- package/dist/services/index.d.ts.map +1 -1
- package/dist/services/index.js +2 -0
- package/dist/services/index.js.map +1 -1
- package/dist/services/keyvalue/api-reference.d.ts +4 -0
- package/dist/services/keyvalue/api-reference.d.ts.map +1 -0
- package/dist/services/keyvalue/api-reference.js +270 -0
- package/dist/services/keyvalue/api-reference.js.map +1 -0
- package/dist/services/keyvalue/types.d.ts +18 -0
- package/dist/services/keyvalue/types.d.ts.map +1 -0
- package/dist/services/keyvalue/types.js +19 -0
- package/dist/services/keyvalue/types.js.map +1 -0
- package/dist/services/machine/api-reference.d.ts +4 -0
- package/dist/services/machine/api-reference.d.ts.map +1 -0
- package/dist/services/machine/api-reference.js +152 -0
- package/dist/services/machine/api-reference.js.map +1 -0
- package/dist/services/machine/types.d.ts +18 -0
- package/dist/services/machine/types.d.ts.map +1 -0
- package/dist/services/machine/types.js +15 -0
- package/dist/services/machine/types.js.map +1 -0
- package/dist/services/monitoring/index.d.ts +3 -0
- package/dist/services/monitoring/index.d.ts.map +1 -0
- package/dist/services/monitoring/index.js +3 -0
- package/dist/services/monitoring/index.js.map +1 -0
- package/dist/services/monitoring/service.d.ts +55 -0
- package/dist/services/monitoring/service.d.ts.map +1 -0
- package/dist/services/monitoring/service.js +503 -0
- package/dist/services/monitoring/service.js.map +1 -0
- package/dist/services/monitoring/types.d.ts +173 -0
- package/dist/services/monitoring/types.d.ts.map +1 -0
- package/dist/services/monitoring/types.js +2 -0
- package/dist/services/monitoring/types.js.map +1 -0
- package/dist/services/oauth/activity.d.ts +5 -0
- package/dist/services/oauth/activity.d.ts.map +1 -0
- package/dist/services/oauth/activity.js +17 -0
- package/dist/services/oauth/activity.js.map +1 -0
- package/dist/services/oauth/api-reference.d.ts +4 -0
- package/dist/services/oauth/api-reference.d.ts.map +1 -0
- package/dist/services/oauth/api-reference.js +344 -0
- package/dist/services/oauth/api-reference.js.map +1 -0
- package/dist/services/oauth/clients.d.ts +18 -0
- package/dist/services/oauth/clients.d.ts.map +1 -0
- package/dist/services/oauth/clients.js +66 -0
- package/dist/services/oauth/clients.js.map +1 -0
- package/dist/services/oauth/consent.d.ts +7 -0
- package/dist/services/oauth/consent.d.ts.map +1 -0
- package/dist/services/oauth/consent.js +17 -0
- package/dist/services/oauth/consent.js.map +1 -0
- package/dist/services/oauth/index.d.ts +9 -0
- package/dist/services/oauth/index.d.ts.map +1 -0
- package/dist/services/oauth/index.js +9 -0
- package/dist/services/oauth/index.js.map +1 -0
- package/dist/services/oauth/keys.d.ts +5 -0
- package/dist/services/oauth/keys.d.ts.map +1 -0
- package/dist/services/oauth/keys.js +10 -0
- package/dist/services/oauth/keys.js.map +1 -0
- package/dist/services/oauth/members.d.ts +4 -0
- package/dist/services/oauth/members.d.ts.map +1 -0
- package/dist/services/oauth/members.js +10 -0
- package/dist/services/oauth/members.js.map +1 -0
- package/dist/services/oauth/scopes.d.ts +4 -0
- package/dist/services/oauth/scopes.d.ts.map +1 -0
- package/dist/services/oauth/scopes.js +10 -0
- package/dist/services/oauth/scopes.js.map +1 -0
- package/dist/services/oauth/types.d.ts +587 -0
- package/dist/services/oauth/types.d.ts.map +1 -0
- package/dist/services/oauth/types.js +160 -0
- package/dist/services/oauth/types.js.map +1 -0
- package/dist/services/oauth/util.d.ts +23 -0
- package/dist/services/oauth/util.d.ts.map +1 -0
- package/dist/services/oauth/util.js +3 -0
- package/dist/services/oauth/util.js.map +1 -0
- package/dist/services/org/api-reference.d.ts +4 -0
- package/dist/services/org/api-reference.d.ts.map +1 -0
- package/dist/services/org/api-reference.js +145 -0
- package/dist/services/org/api-reference.js.map +1 -0
- package/dist/services/org/types.d.ts +8 -0
- package/dist/services/org/types.d.ts.map +1 -0
- package/dist/services/org/types.js +7 -0
- package/dist/services/org/types.js.map +1 -0
- package/dist/services/project/api-reference.d.ts +4 -0
- package/dist/services/project/api-reference.d.ts.map +1 -0
- package/dist/services/project/api-reference.js +618 -0
- package/dist/services/project/api-reference.js.map +1 -0
- package/dist/services/project/types.d.ts +29 -0
- package/dist/services/project/types.d.ts.map +1 -0
- package/dist/services/project/types.js +40 -0
- package/dist/services/project/types.js.map +1 -0
- package/dist/services/queue/api-reference.d.ts +4 -0
- package/dist/services/queue/api-reference.d.ts.map +1 -0
- package/dist/services/queue/api-reference.js +713 -0
- package/dist/services/queue/api-reference.js.map +1 -0
- package/dist/services/queue/types.d.ts +281 -0
- package/dist/services/queue/types.d.ts.map +1 -1
- package/dist/services/queue/types.js +81 -0
- package/dist/services/queue/types.js.map +1 -1
- package/dist/services/region/api-reference.d.ts +4 -0
- package/dist/services/region/api-reference.d.ts.map +1 -0
- package/dist/services/region/api-reference.js +98 -0
- package/dist/services/region/api-reference.js.map +1 -0
- package/dist/services/region/types.d.ts +18 -0
- package/dist/services/region/types.d.ts.map +1 -0
- package/dist/services/region/types.js +18 -0
- package/dist/services/region/types.js.map +1 -0
- package/dist/services/sandbox/api-reference.d.ts +4 -0
- package/dist/services/sandbox/api-reference.d.ts.map +1 -0
- package/dist/services/sandbox/api-reference.js +1006 -0
- package/dist/services/sandbox/api-reference.js.map +1 -0
- package/dist/services/sandbox/run.d.ts +1 -1
- package/dist/services/sandbox/types.d.ts +64 -1
- package/dist/services/sandbox/types.d.ts.map +1 -1
- package/dist/services/sandbox/types.js +87 -0
- package/dist/services/sandbox/types.js.map +1 -1
- package/dist/services/schedule/api-reference.d.ts +4 -0
- package/dist/services/schedule/api-reference.d.ts.map +1 -0
- package/dist/services/schedule/api-reference.js +216 -0
- package/dist/services/schedule/api-reference.js.map +1 -0
- package/dist/services/schedule/types.d.ts +36 -0
- package/dist/services/schedule/types.d.ts.map +1 -0
- package/dist/services/schedule/types.js +20 -0
- package/dist/services/schedule/types.js.map +1 -0
- package/dist/services/session/api-reference.d.ts +4 -0
- package/dist/services/session/api-reference.d.ts.map +1 -0
- package/dist/services/session/api-reference.js +154 -0
- package/dist/services/session/api-reference.js.map +1 -0
- package/dist/services/storage/api-reference.d.ts +4 -0
- package/dist/services/storage/api-reference.d.ts.map +1 -0
- package/dist/services/storage/api-reference.js +196 -0
- package/dist/services/storage/api-reference.js.map +1 -0
- package/dist/services/storage/types.d.ts.map +1 -1
- package/dist/services/storage/types.js +9 -3
- package/dist/services/storage/types.js.map +1 -1
- package/dist/services/stream/api-reference.d.ts +4 -0
- package/dist/services/stream/api-reference.d.ts.map +1 -0
- package/dist/services/stream/api-reference.js +153 -0
- package/dist/services/stream/api-reference.js.map +1 -0
- package/dist/services/stream/types.d.ts +49 -0
- package/dist/services/stream/types.d.ts.map +1 -0
- package/dist/services/stream/types.js +49 -0
- package/dist/services/stream/types.js.map +1 -0
- package/dist/services/task/api-reference.d.ts +4 -0
- package/dist/services/task/api-reference.d.ts.map +1 -0
- package/dist/services/task/api-reference.js +802 -0
- package/dist/services/task/api-reference.js.map +1 -0
- package/dist/services/task/service.d.ts.map +1 -1
- package/dist/services/task/service.js +35 -39
- package/dist/services/task/service.js.map +1 -1
- package/dist/services/task/types.d.ts +48 -0
- package/dist/services/task/types.d.ts.map +1 -0
- package/dist/services/task/types.js +55 -0
- package/dist/services/task/types.js.map +1 -0
- package/dist/services/thread/api-reference.d.ts +4 -0
- package/dist/services/thread/api-reference.d.ts.map +1 -0
- package/dist/services/thread/api-reference.js +89 -0
- package/dist/services/thread/api-reference.js.map +1 -0
- package/dist/services/user/api-reference.d.ts +4 -0
- package/dist/services/user/api-reference.d.ts.map +1 -0
- package/dist/services/user/api-reference.js +27 -0
- package/dist/services/user/api-reference.js.map +1 -0
- package/dist/services/vector/api-reference.d.ts +4 -0
- package/dist/services/vector/api-reference.d.ts.map +1 -0
- package/dist/services/vector/api-reference.js +213 -0
- package/dist/services/vector/api-reference.js.map +1 -0
- package/dist/services/vector/types.d.ts +63 -0
- package/dist/services/vector/types.d.ts.map +1 -0
- package/dist/services/vector/types.js +90 -0
- package/dist/services/vector/types.js.map +1 -0
- package/dist/services/webhook/api-reference.d.ts +4 -0
- package/dist/services/webhook/api-reference.d.ts.map +1 -0
- package/dist/services/webhook/api-reference.js +388 -0
- package/dist/services/webhook/api-reference.js.map +1 -0
- package/package.json +2 -2
- package/src/services/api-reference.ts +198 -0
- package/src/services/apikey/api-reference.ts +99 -0
- package/src/services/db/api-reference.ts +152 -0
- package/src/services/db/types.ts +12 -0
- package/src/services/email/api-reference.ts +349 -0
- package/src/services/email/service.ts +1 -6
- package/src/services/email/types.ts +15 -0
- package/src/services/eval/api-reference.ts +124 -0
- package/src/services/index.ts +2 -0
- package/src/services/keyvalue/api-reference.ts +280 -0
- package/src/services/keyvalue/types.ts +25 -0
- package/src/services/machine/api-reference.ts +158 -0
- package/src/services/machine/types.ts +21 -0
- package/src/services/monitoring/index.ts +2 -0
- package/src/services/monitoring/service.ts +639 -0
- package/src/services/monitoring/types.ts +209 -0
- package/src/services/oauth/activity.ts +41 -0
- package/src/services/oauth/api-reference.ts +380 -0
- package/src/services/oauth/clients.ts +161 -0
- package/src/services/oauth/consent.ts +33 -0
- package/src/services/oauth/index.ts +8 -0
- package/src/services/oauth/keys.ts +13 -0
- package/src/services/oauth/members.ts +13 -0
- package/src/services/oauth/scopes.ts +13 -0
- package/src/services/oauth/types.ts +240 -0
- package/src/services/oauth/util.ts +3 -0
- package/src/services/org/api-reference.ts +148 -0
- package/src/services/org/types.ts +9 -0
- package/src/services/project/api-reference.ts +636 -0
- package/src/services/project/types.ts +47 -0
- package/src/services/queue/api-reference.ts +734 -0
- package/src/services/queue/types.ts +112 -0
- package/src/services/region/api-reference.ts +105 -0
- package/src/services/region/types.ts +27 -0
- package/src/services/sandbox/api-reference.ts +1042 -0
- package/src/services/sandbox/types.ts +100 -0
- package/src/services/schedule/api-reference.ts +228 -0
- package/src/services/schedule/types.ts +26 -0
- package/src/services/session/api-reference.ts +160 -0
- package/src/services/storage/api-reference.ts +207 -0
- package/src/services/storage/types.ts +9 -3
- package/src/services/stream/api-reference.ts +163 -0
- package/src/services/stream/types.ts +64 -0
- package/src/services/task/api-reference.ts +830 -0
- package/src/services/task/service.ts +35 -93
- package/src/services/task/types.ts +73 -0
- package/src/services/thread/api-reference.ts +91 -0
- package/src/services/user/api-reference.ts +31 -0
- package/src/services/vector/api-reference.ts +231 -0
- package/src/services/vector/types.ts +112 -0
- package/src/services/webhook/api-reference.ts +403 -0
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
|
3
|
+
interface NamedField {
|
|
4
|
+
name: string;
|
|
5
|
+
type: string;
|
|
6
|
+
description: string;
|
|
7
|
+
required?: boolean;
|
|
8
|
+
}
|
|
9
|
+
interface FieldSource {
|
|
10
|
+
schema: z.ZodType;
|
|
11
|
+
prefix?: string;
|
|
12
|
+
pick?: string[];
|
|
13
|
+
omit?: string[];
|
|
14
|
+
overrides?: Record<string, Partial<Pick<NamedField, 'type' | 'description'>>>;
|
|
15
|
+
stripRequired?: boolean;
|
|
16
|
+
}
|
|
17
|
+
type FieldDefinition = NamedField[] | FieldSource;
|
|
18
|
+
interface RequestBody {
|
|
19
|
+
description: string;
|
|
20
|
+
fields?: FieldDefinition;
|
|
21
|
+
}
|
|
22
|
+
interface Param {
|
|
23
|
+
name: string;
|
|
24
|
+
type: string;
|
|
25
|
+
description: string;
|
|
26
|
+
required?: boolean;
|
|
27
|
+
}
|
|
28
|
+
interface EndpointStatus {
|
|
29
|
+
code: number;
|
|
30
|
+
description: string;
|
|
31
|
+
}
|
|
32
|
+
interface ResponseHeader {
|
|
33
|
+
name: string;
|
|
34
|
+
description: string;
|
|
35
|
+
}
|
|
36
|
+
interface Endpoint {
|
|
37
|
+
id: string;
|
|
38
|
+
title: string;
|
|
39
|
+
sectionTitle?: string;
|
|
40
|
+
method: HttpMethod;
|
|
41
|
+
path: string;
|
|
42
|
+
description: string;
|
|
43
|
+
pathParams: Param[];
|
|
44
|
+
queryParams: Param[];
|
|
45
|
+
requestBody: RequestBody | null;
|
|
46
|
+
responseDescription: string;
|
|
47
|
+
responseHeaders?: ResponseHeader[];
|
|
48
|
+
responseFields?: FieldDefinition;
|
|
49
|
+
statuses: EndpointStatus[];
|
|
50
|
+
examplePath: string;
|
|
51
|
+
exampleBody?: string | object;
|
|
52
|
+
exampleHeaders?: Record<string, string>;
|
|
53
|
+
ttlNote?: string;
|
|
54
|
+
}
|
|
55
|
+
interface Service {
|
|
56
|
+
name: string;
|
|
57
|
+
slug: string;
|
|
58
|
+
description: string;
|
|
59
|
+
host?: string;
|
|
60
|
+
hasPublicEndpoints?: boolean;
|
|
61
|
+
endpoints: Endpoint[];
|
|
62
|
+
icon?: string;
|
|
63
|
+
}
|
|
64
|
+
declare function fieldsFromSchema(schema: z.ZodType, prefix?: string): NamedField[];
|
|
65
|
+
declare function resolveFields(definition: FieldDefinition | undefined): NamedField[] | undefined;
|
|
66
|
+
export type { HttpMethod, NamedField, FieldSource, FieldDefinition, RequestBody, Param, EndpointStatus, ResponseHeader, Endpoint, Service, };
|
|
67
|
+
export { fieldsFromSchema, resolveFields };
|
|
68
|
+
//# sourceMappingURL=api-reference.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-reference.d.ts","sourceRoot":"","sources":["../../src/services/api-reference.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,KAAK,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAC;AAE9D,UAAU,UAAU;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,UAAU,WAAW;IACpB,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;IAC9E,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,KAAK,eAAe,GAAG,UAAU,EAAE,GAAG,WAAW,CAAC;AAElD,UAAU,WAAW;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,eAAe,CAAC;CACzB;AAED,UAAU,KAAK;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,UAAU,cAAc;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACpB;AAED,UAAU,cAAc;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACpB;AAED,UAAU,QAAQ;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,UAAU,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,KAAK,EAAE,CAAC;IACpB,WAAW,EAAE,KAAK,EAAE,CAAC;IACrB,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;IAChC,mBAAmB,EAAE,MAAM,CAAC;IAC5B,eAAe,CAAC,EAAE,cAAc,EAAE,CAAC;IACnC,cAAc,CAAC,EAAE,eAAe,CAAC;IACjC,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC9B,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACxC,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,OAAO;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,SAAS,EAAE,QAAQ,EAAE,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;CACd;AA6ED,iBAAS,gBAAgB,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,UAAU,EAAE,CAI1E;AAED,iBAAS,aAAa,CAAC,UAAU,EAAE,eAAe,GAAG,SAAS,GAAG,UAAU,EAAE,GAAG,SAAS,CA4BxF;AAED,YAAY,EACX,UAAU,EACV,UAAU,EACV,WAAW,EACX,eAAe,EACf,WAAW,EACX,KAAK,EACL,cAAc,EACd,cAAc,EACd,QAAQ,EACR,OAAO,GACP,CAAC;AACF,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,CAAC"}
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
function jsonSchemaTypeToFieldType(schema) {
|
|
3
|
+
if (!schema || typeof schema !== 'object')
|
|
4
|
+
return 'any';
|
|
5
|
+
if (Array.isArray(schema.anyOf) && schema.anyOf.length > 0) {
|
|
6
|
+
const mapped = schema.anyOf.map((part) => jsonSchemaTypeToFieldType(part));
|
|
7
|
+
return [...new Set(mapped)].join(' | ');
|
|
8
|
+
}
|
|
9
|
+
if (Array.isArray(schema.oneOf) && schema.oneOf.length > 0) {
|
|
10
|
+
const mapped = schema.oneOf.map((part) => jsonSchemaTypeToFieldType(part));
|
|
11
|
+
return [...new Set(mapped)].join(' | ');
|
|
12
|
+
}
|
|
13
|
+
if (Array.isArray(schema.type)) {
|
|
14
|
+
const mapped = schema.type.map((t) => (t === 'integer' ? 'number' : t));
|
|
15
|
+
return [...new Set(mapped)].join(' | ');
|
|
16
|
+
}
|
|
17
|
+
if (schema.type === 'integer')
|
|
18
|
+
return 'number';
|
|
19
|
+
if (schema.type === 'array') {
|
|
20
|
+
if (schema.items) {
|
|
21
|
+
const itemType = jsonSchemaTypeToFieldType(schema.items);
|
|
22
|
+
return itemType === 'any' ? 'array' : `${itemType}[]`;
|
|
23
|
+
}
|
|
24
|
+
return 'array';
|
|
25
|
+
}
|
|
26
|
+
if (typeof schema.type === 'string')
|
|
27
|
+
return schema.type;
|
|
28
|
+
return 'any';
|
|
29
|
+
}
|
|
30
|
+
function fieldName(prefix, key) {
|
|
31
|
+
return prefix ? `${prefix}.${key}` : key;
|
|
32
|
+
}
|
|
33
|
+
function extractFields(jsonSchema, prefix, requiredSet) {
|
|
34
|
+
const properties = jsonSchema?.properties;
|
|
35
|
+
if (!properties || typeof properties !== 'object')
|
|
36
|
+
return [];
|
|
37
|
+
const fields = [];
|
|
38
|
+
for (const [key, value] of Object.entries(properties)) {
|
|
39
|
+
const prop = value;
|
|
40
|
+
const name = fieldName(prefix, key);
|
|
41
|
+
fields.push({
|
|
42
|
+
name,
|
|
43
|
+
type: jsonSchemaTypeToFieldType(prop),
|
|
44
|
+
description: typeof prop?.description === 'string' ? prop.description : '',
|
|
45
|
+
required: requiredSet.has(key),
|
|
46
|
+
});
|
|
47
|
+
// Note: nullable objects (anyOf: [object, null]) are not recursed into.
|
|
48
|
+
// Use a non-nullable sub-schema or manually list sub-fields if expansion is needed.
|
|
49
|
+
if (prop.type === 'object' && prop.properties) {
|
|
50
|
+
const nestedRequired = new Set(Array.isArray(prop.required) ? prop.required : []);
|
|
51
|
+
fields.push(...extractFields(prop, name, nestedRequired));
|
|
52
|
+
}
|
|
53
|
+
if (prop.type === 'array' && prop.items?.type === 'object' && prop.items?.properties) {
|
|
54
|
+
const itemRequired = new Set(Array.isArray(prop.items.required) ? prop.items.required : []);
|
|
55
|
+
fields.push(...extractFields(prop.items, `${name}[]`, itemRequired));
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
return fields;
|
|
59
|
+
}
|
|
60
|
+
function fieldsFromSchema(schema, prefix) {
|
|
61
|
+
const jsonSchema = z.toJSONSchema(schema, { unrepresentable: 'any' });
|
|
62
|
+
const required = new Set(Array.isArray(jsonSchema?.required) ? jsonSchema.required : []);
|
|
63
|
+
return extractFields(jsonSchema, prefix, required);
|
|
64
|
+
}
|
|
65
|
+
function resolveFields(definition) {
|
|
66
|
+
if (!definition)
|
|
67
|
+
return undefined;
|
|
68
|
+
if (Array.isArray(definition))
|
|
69
|
+
return definition;
|
|
70
|
+
let fields = fieldsFromSchema(definition.schema, definition.prefix);
|
|
71
|
+
if (definition.pick) {
|
|
72
|
+
const pickSet = new Set(definition.pick);
|
|
73
|
+
fields = fields.filter((field) => pickSet.has(field.name));
|
|
74
|
+
}
|
|
75
|
+
if (definition.omit) {
|
|
76
|
+
const omitSet = new Set(definition.omit);
|
|
77
|
+
fields = fields.filter((field) => !omitSet.has(field.name));
|
|
78
|
+
}
|
|
79
|
+
if (definition.overrides) {
|
|
80
|
+
fields = fields.map((field) => {
|
|
81
|
+
const override = definition.overrides?.[field.name];
|
|
82
|
+
return override ? { ...field, ...override } : field;
|
|
83
|
+
});
|
|
84
|
+
}
|
|
85
|
+
if (definition.stripRequired) {
|
|
86
|
+
fields = fields.map(({ required, ...rest }) => rest);
|
|
87
|
+
}
|
|
88
|
+
return fields;
|
|
89
|
+
}
|
|
90
|
+
export { fieldsFromSchema, resolveFields };
|
|
91
|
+
//# sourceMappingURL=api-reference.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-reference.js","sourceRoot":"","sources":["../../src/services/api-reference.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AA0ExB,SAAS,yBAAyB,CAAC,MAAW;IAC7C,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAExD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5D,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAS,EAAE,EAAE,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC,CAAC;QAChF,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5D,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAS,EAAE,EAAE,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC,CAAC;QAChF,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;QAChC,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAChF,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS;QAAE,OAAO,QAAQ,CAAC;IAC/C,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC7B,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YAClB,MAAM,QAAQ,GAAG,yBAAyB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACzD,OAAO,QAAQ,KAAK,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,QAAQ,IAAI,CAAC;QACvD,CAAC;QACD,OAAO,OAAO,CAAC;IAChB,CAAC;IAED,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAC,IAAI,CAAC;IAExD,OAAO,KAAK,CAAC;AACd,CAAC;AAED,SAAS,SAAS,CAAC,MAA0B,EAAE,GAAW;IACzD,OAAO,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;AAC1C,CAAC;AAED,SAAS,aAAa,CACrB,UAAe,EACf,MAA0B,EAC1B,WAAwB;IAExB,MAAM,UAAU,GAAG,UAAU,EAAE,UAAU,CAAC;IAC1C,IAAI,CAAC,UAAU,IAAI,OAAO,UAAU,KAAK,QAAQ;QAAE,OAAO,EAAE,CAAC;IAE7D,MAAM,MAAM,GAAiB,EAAE,CAAC;IAEhC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QACvD,MAAM,IAAI,GAAG,KAAY,CAAC;QAC1B,MAAM,IAAI,GAAG,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAEpC,MAAM,CAAC,IAAI,CAAC;YACX,IAAI;YACJ,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC;YACrC,WAAW,EAAE,OAAO,IAAI,EAAE,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE;YAC1E,QAAQ,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC;SAC9B,CAAC,CAAC;QAEH,wEAAwE;QACxE,oFAAoF;QACpF,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YAC/C,MAAM,cAAc,GAAG,IAAI,GAAG,CAAS,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YAC1F,MAAM,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC;QAC3D,CAAC;QAED,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,KAAK,EAAE,UAAU,EAAE,CAAC;YACtF,MAAM,YAAY,GAAG,IAAI,GAAG,CAC3B,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAC7D,CAAC;YACF,MAAM,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC;QACtE,CAAC;IACF,CAAC;IAED,OAAO,MAAM,CAAC;AACf,CAAC;AAED,SAAS,gBAAgB,CAAC,MAAiB,EAAE,MAAe;IAC3D,MAAM,UAAU,GAAG,CAAC,CAAC,YAAY,CAAC,MAAM,EAAE,EAAE,eAAe,EAAE,KAAK,EAAE,CAAQ,CAAC;IAC7E,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAS,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IACjG,OAAO,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;AACpD,CAAC;AAED,SAAS,aAAa,CAAC,UAAuC;IAC7D,IAAI,CAAC,UAAU;QAAE,OAAO,SAAS,CAAC;IAClC,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC;QAAE,OAAO,UAAU,CAAC;IAEjD,IAAI,MAAM,GAAG,gBAAgB,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;IAEpE,IAAI,UAAU,CAAC,IAAI,EAAE,CAAC;QACrB,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IAC5D,CAAC;IAED,IAAI,UAAU,CAAC,IAAI,EAAE,CAAC;QACrB,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED,IAAI,UAAU,CAAC,SAAS,EAAE,CAAC;QAC1B,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YAC7B,MAAM,QAAQ,GAAG,UAAU,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACpD,OAAO,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,GAAG,QAAQ,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QACrD,CAAC,CAAC,CAAC;IACJ,CAAC;IAED,IAAI,UAAU,CAAC,aAAa,EAAE,CAAC;QAC9B,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;IACtD,CAAC;IAED,OAAO,MAAM,CAAC;AACf,CAAC;AAcD,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-reference.d.ts","sourceRoot":"","sources":["../../../src/services/apikey/api-reference.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAInD,QAAA,MAAM,OAAO,EAAE,OA4Fd,CAAC;AAEF,eAAe,OAAO,CAAC"}
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
import { APIKeyCreateRequestSchema, APIKeyCreateResponseSchema } from "./create.js";
|
|
2
|
+
import { APIKeySchema } from "./list.js";
|
|
3
|
+
const service = {
|
|
4
|
+
name: 'API Keys',
|
|
5
|
+
slug: 'api-keys',
|
|
6
|
+
description: 'Create and manage API keys for authentication',
|
|
7
|
+
endpoints: [
|
|
8
|
+
{
|
|
9
|
+
id: 'create-api-key',
|
|
10
|
+
title: 'Create API Key',
|
|
11
|
+
method: 'POST',
|
|
12
|
+
path: '/cli/apikey',
|
|
13
|
+
description: 'Create a new API key. The key value is only returned at creation time.',
|
|
14
|
+
pathParams: [],
|
|
15
|
+
queryParams: [],
|
|
16
|
+
requestBody: {
|
|
17
|
+
description: 'API key creation payload.',
|
|
18
|
+
fields: { schema: APIKeyCreateRequestSchema },
|
|
19
|
+
},
|
|
20
|
+
responseDescription: 'Returns the new key ID and value. The value is only returned at creation time.',
|
|
21
|
+
responseFields: { schema: APIKeyCreateResponseSchema },
|
|
22
|
+
statuses: [
|
|
23
|
+
{ code: 201, description: 'API key created' },
|
|
24
|
+
{ code: 401, description: 'Unauthorized — invalid or missing Bearer token' },
|
|
25
|
+
],
|
|
26
|
+
examplePath: '/cli/apikey',
|
|
27
|
+
exampleBody: { name: 'My API Key', expiresAt: '2026-12-31T23:59:59Z' },
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
id: 'list-api-keys',
|
|
31
|
+
title: 'List API Keys',
|
|
32
|
+
method: 'GET',
|
|
33
|
+
path: '/cli/apikey',
|
|
34
|
+
description: 'List API keys with optional filtering by organization or project.',
|
|
35
|
+
pathParams: [],
|
|
36
|
+
queryParams: [
|
|
37
|
+
{
|
|
38
|
+
name: 'orgId',
|
|
39
|
+
type: 'string',
|
|
40
|
+
description: 'Filter by organization ID',
|
|
41
|
+
required: false,
|
|
42
|
+
},
|
|
43
|
+
{
|
|
44
|
+
name: 'projectId',
|
|
45
|
+
type: 'string',
|
|
46
|
+
description: 'Filter by project ID',
|
|
47
|
+
required: false,
|
|
48
|
+
},
|
|
49
|
+
],
|
|
50
|
+
requestBody: null,
|
|
51
|
+
responseDescription: 'Array of API key objects.',
|
|
52
|
+
responseFields: { schema: APIKeySchema },
|
|
53
|
+
statuses: [
|
|
54
|
+
{ code: 200, description: 'API keys returned' },
|
|
55
|
+
{ code: 401, description: 'Unauthorized — invalid or missing Bearer token' },
|
|
56
|
+
],
|
|
57
|
+
examplePath: '/cli/apikey',
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
id: 'get-api-key',
|
|
61
|
+
title: 'Get API Key',
|
|
62
|
+
method: 'GET',
|
|
63
|
+
path: '/cli/apikey/{id}',
|
|
64
|
+
description: 'Get a specific API key by ID.',
|
|
65
|
+
pathParams: [{ name: 'id', type: 'string', description: 'API key ID', required: true }],
|
|
66
|
+
queryParams: [],
|
|
67
|
+
requestBody: null,
|
|
68
|
+
responseDescription: 'API key object.',
|
|
69
|
+
statuses: [
|
|
70
|
+
{ code: 200, description: 'API key returned' },
|
|
71
|
+
{ code: 401, description: 'Unauthorized — invalid or missing Bearer token' },
|
|
72
|
+
{ code: 404, description: 'API key not found' },
|
|
73
|
+
],
|
|
74
|
+
examplePath: '/cli/apikey/ak_abc123',
|
|
75
|
+
},
|
|
76
|
+
{
|
|
77
|
+
id: 'delete-api-key',
|
|
78
|
+
title: 'Delete API Key',
|
|
79
|
+
method: 'DELETE',
|
|
80
|
+
path: '/cli/apikey/{id}',
|
|
81
|
+
description: 'Delete an API key by ID.',
|
|
82
|
+
pathParams: [{ name: 'id', type: 'string', description: 'API key ID', required: true }],
|
|
83
|
+
queryParams: [],
|
|
84
|
+
requestBody: null,
|
|
85
|
+
responseDescription: 'Empty response on success.',
|
|
86
|
+
statuses: [
|
|
87
|
+
{ code: 204, description: 'API key deleted' },
|
|
88
|
+
{ code: 401, description: 'Unauthorized — invalid or missing Bearer token' },
|
|
89
|
+
{ code: 404, description: 'API key not found' },
|
|
90
|
+
],
|
|
91
|
+
examplePath: '/cli/apikey/ak_abc123',
|
|
92
|
+
},
|
|
93
|
+
],
|
|
94
|
+
};
|
|
95
|
+
export default service;
|
|
96
|
+
//# sourceMappingURL=api-reference.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-reference.js","sourceRoot":"","sources":["../../../src/services/apikey/api-reference.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,yBAAyB,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAC;AACpF,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC,MAAM,OAAO,GAAY;IACxB,IAAI,EAAE,UAAU;IAChB,IAAI,EAAE,UAAU;IAChB,WAAW,EAAE,+CAA+C;IAC5D,SAAS,EAAE;QACV;YACC,EAAE,EAAE,gBAAgB;YACpB,KAAK,EAAE,gBAAgB;YACvB,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,aAAa;YACnB,WAAW,EAAE,wEAAwE;YACrF,UAAU,EAAE,EAAE;YACd,WAAW,EAAE,EAAE;YACf,WAAW,EAAE;gBACZ,WAAW,EAAE,2BAA2B;gBACxC,MAAM,EAAE,EAAE,MAAM,EAAE,yBAAyB,EAAE;aAC7C;YACD,mBAAmB,EAClB,gFAAgF;YACjF,cAAc,EAAE,EAAE,MAAM,EAAE,0BAA0B,EAAE;YACtD,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,iBAAiB,EAAE;gBAC7C,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,gDAAgD,EAAE;aAC5E;YACD,WAAW,EAAE,aAAa;YAC1B,WAAW,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,EAAE,sBAAsB,EAAE;SACtE;QACD;YACC,EAAE,EAAE,eAAe;YACnB,KAAK,EAAE,eAAe;YACtB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,aAAa;YACnB,WAAW,EAAE,mEAAmE;YAChF,UAAU,EAAE,EAAE;YACd,WAAW,EAAE;gBACZ;oBACC,IAAI,EAAE,OAAO;oBACb,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,2BAA2B;oBACxC,QAAQ,EAAE,KAAK;iBACf;gBACD;oBACC,IAAI,EAAE,WAAW;oBACjB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,sBAAsB;oBACnC,QAAQ,EAAE,KAAK;iBACf;aACD;YACD,WAAW,EAAE,IAAI;YACjB,mBAAmB,EAAE,2BAA2B;YAChD,cAAc,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE;YACxC,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,mBAAmB,EAAE;gBAC/C,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,gDAAgD,EAAE;aAC5E;YACD,WAAW,EAAE,aAAa;SAC1B;QACD;YACC,EAAE,EAAE,aAAa;YACjB,KAAK,EAAE,aAAa;YACpB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,kBAAkB;YACxB,WAAW,EAAE,+BAA+B;YAC5C,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;YACvF,WAAW,EAAE,EAAE;YACf,WAAW,EAAE,IAAI;YACjB,mBAAmB,EAAE,iBAAiB;YACtC,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,kBAAkB,EAAE;gBAC9C,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,gDAAgD,EAAE;gBAC5E,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,mBAAmB,EAAE;aAC/C;YACD,WAAW,EAAE,uBAAuB;SACpC;QACD;YACC,EAAE,EAAE,gBAAgB;YACpB,KAAK,EAAE,gBAAgB;YACvB,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,kBAAkB;YACxB,WAAW,EAAE,0BAA0B;YACvC,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;YACvF,WAAW,EAAE,EAAE;YACf,WAAW,EAAE,IAAI;YACjB,mBAAmB,EAAE,4BAA4B;YACjD,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,iBAAiB,EAAE;gBAC7C,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,gDAAgD,EAAE;gBAC5E,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,mBAAmB,EAAE;aAC/C;YACD,WAAW,EAAE,uBAAuB;SACpC;KACD;CACD,CAAC;AAEF,eAAe,OAAO,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-reference.d.ts","sourceRoot":"","sources":["../../../src/services/db/api-reference.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAEnD,QAAA,MAAM,OAAO,EAAE,OAkJd,CAAC;AAEF,eAAe,OAAO,CAAC"}
|
|
@@ -0,0 +1,149 @@
|
|
|
1
|
+
import { DbExecuteQueryRequestSchema } from "./types.js";
|
|
2
|
+
const service = {
|
|
3
|
+
name: 'Databases',
|
|
4
|
+
slug: 'database',
|
|
5
|
+
description: 'Execute queries, inspect tables, and monitor database performance',
|
|
6
|
+
endpoints: [
|
|
7
|
+
{
|
|
8
|
+
id: 'get-query-logs',
|
|
9
|
+
title: 'Get Query Logs',
|
|
10
|
+
method: 'GET',
|
|
11
|
+
path: '/resource/{orgId}/{region}/{database}/logs',
|
|
12
|
+
description: 'Get query logs for a database with optional filtering.',
|
|
13
|
+
pathParams: [
|
|
14
|
+
{ name: 'orgId', type: 'string', description: 'Organization ID', required: true },
|
|
15
|
+
{ name: 'region', type: 'string', description: 'Region identifier', required: true },
|
|
16
|
+
{ name: 'database', type: 'string', description: 'Database name', required: true },
|
|
17
|
+
],
|
|
18
|
+
queryParams: [
|
|
19
|
+
{
|
|
20
|
+
name: 'startDate',
|
|
21
|
+
type: 'string',
|
|
22
|
+
description: 'Start date filter',
|
|
23
|
+
required: false,
|
|
24
|
+
},
|
|
25
|
+
{ name: 'endDate', type: 'string', description: 'End date filter', required: false },
|
|
26
|
+
{
|
|
27
|
+
name: 'username',
|
|
28
|
+
type: 'string',
|
|
29
|
+
description: 'Filter by username',
|
|
30
|
+
required: false,
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
name: 'command',
|
|
34
|
+
type: 'string',
|
|
35
|
+
description: 'Filter by SQL command type',
|
|
36
|
+
required: false,
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
name: 'hasError',
|
|
40
|
+
type: 'boolean',
|
|
41
|
+
description: 'Filter for queries with errors',
|
|
42
|
+
required: false,
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
name: 'sessionId',
|
|
46
|
+
type: 'string',
|
|
47
|
+
description: 'Filter by session ID',
|
|
48
|
+
required: false,
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
name: 'limit',
|
|
52
|
+
type: 'number',
|
|
53
|
+
description: 'Maximum logs to return',
|
|
54
|
+
required: false,
|
|
55
|
+
},
|
|
56
|
+
],
|
|
57
|
+
requestBody: null,
|
|
58
|
+
responseDescription: 'Array of query log entries.',
|
|
59
|
+
statuses: [
|
|
60
|
+
{ code: 200, description: 'Query logs returned' },
|
|
61
|
+
{ code: 401, description: 'Unauthorized — invalid or missing Bearer token' },
|
|
62
|
+
{ code: 404, description: 'Database not found' },
|
|
63
|
+
],
|
|
64
|
+
examplePath: '/resource/org_abc123/usw/mydb/logs',
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
id: 'execute-query',
|
|
68
|
+
title: 'Execute Query',
|
|
69
|
+
method: 'POST',
|
|
70
|
+
path: '/resource/{orgId}/{region}/{database}/query',
|
|
71
|
+
description: 'Execute a SQL query against a database.',
|
|
72
|
+
pathParams: [
|
|
73
|
+
{ name: 'orgId', type: 'string', description: 'Organization ID', required: true },
|
|
74
|
+
{ name: 'region', type: 'string', description: 'Region identifier', required: true },
|
|
75
|
+
{ name: 'database', type: 'string', description: 'Database name', required: true },
|
|
76
|
+
],
|
|
77
|
+
queryParams: [],
|
|
78
|
+
requestBody: {
|
|
79
|
+
description: 'SQL query payload.',
|
|
80
|
+
fields: { schema: DbExecuteQueryRequestSchema },
|
|
81
|
+
},
|
|
82
|
+
responseDescription: 'Returns columns, rows, row count, and whether results were truncated (max 1000 rows).',
|
|
83
|
+
statuses: [
|
|
84
|
+
{ code: 200, description: 'Query executed successfully' },
|
|
85
|
+
{ code: 401, description: 'Unauthorized — invalid or missing Bearer token' },
|
|
86
|
+
{ code: 404, description: 'Database not found' },
|
|
87
|
+
],
|
|
88
|
+
examplePath: '/resource/org_abc123/usw/mydb/query',
|
|
89
|
+
exampleBody: { query: 'SELECT * FROM users LIMIT 10' },
|
|
90
|
+
},
|
|
91
|
+
{
|
|
92
|
+
id: 'get-query-stats',
|
|
93
|
+
title: 'Get Query Stats',
|
|
94
|
+
method: 'GET',
|
|
95
|
+
path: '/resource/{orgId}/{region}/{database}/logs/stats',
|
|
96
|
+
description: 'Get aggregate query statistics for a database over a date range.',
|
|
97
|
+
pathParams: [
|
|
98
|
+
{ name: 'orgId', type: 'string', description: 'Organization ID', required: true },
|
|
99
|
+
{ name: 'region', type: 'string', description: 'Region identifier', required: true },
|
|
100
|
+
{ name: 'database', type: 'string', description: 'Database name', required: true },
|
|
101
|
+
],
|
|
102
|
+
queryParams: [
|
|
103
|
+
{
|
|
104
|
+
name: 'startDate',
|
|
105
|
+
type: 'string',
|
|
106
|
+
description: 'Start date for stats range',
|
|
107
|
+
required: true,
|
|
108
|
+
},
|
|
109
|
+
{
|
|
110
|
+
name: 'endDate',
|
|
111
|
+
type: 'string',
|
|
112
|
+
description: 'End date for stats range',
|
|
113
|
+
required: true,
|
|
114
|
+
},
|
|
115
|
+
],
|
|
116
|
+
requestBody: null,
|
|
117
|
+
responseDescription: 'Aggregate query statistics.',
|
|
118
|
+
statuses: [
|
|
119
|
+
{ code: 200, description: 'Query stats returned' },
|
|
120
|
+
{ code: 401, description: 'Unauthorized — invalid or missing Bearer token' },
|
|
121
|
+
{ code: 404, description: 'Database not found' },
|
|
122
|
+
],
|
|
123
|
+
examplePath: '/resource/org_abc123/usw/mydb/logs/stats',
|
|
124
|
+
},
|
|
125
|
+
{
|
|
126
|
+
id: 'list-tables',
|
|
127
|
+
title: 'List Tables',
|
|
128
|
+
method: 'GET',
|
|
129
|
+
path: '/resource/{orgId}/{region}/{database}/tables',
|
|
130
|
+
description: 'List all tables in a database.',
|
|
131
|
+
pathParams: [
|
|
132
|
+
{ name: 'orgId', type: 'string', description: 'Organization ID', required: true },
|
|
133
|
+
{ name: 'region', type: 'string', description: 'Region identifier', required: true },
|
|
134
|
+
{ name: 'database', type: 'string', description: 'Database name', required: true },
|
|
135
|
+
],
|
|
136
|
+
queryParams: [],
|
|
137
|
+
requestBody: null,
|
|
138
|
+
responseDescription: 'Array of table names and metadata.',
|
|
139
|
+
statuses: [
|
|
140
|
+
{ code: 200, description: 'Tables returned' },
|
|
141
|
+
{ code: 401, description: 'Unauthorized — invalid or missing Bearer token' },
|
|
142
|
+
{ code: 404, description: 'Database not found' },
|
|
143
|
+
],
|
|
144
|
+
examplePath: '/resource/org_abc123/usw/mydb/tables',
|
|
145
|
+
},
|
|
146
|
+
],
|
|
147
|
+
};
|
|
148
|
+
export default service;
|
|
149
|
+
//# sourceMappingURL=api-reference.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-reference.js","sourceRoot":"","sources":["../../../src/services/db/api-reference.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,YAAY,CAAC;AAGzD,MAAM,OAAO,GAAY;IACxB,IAAI,EAAE,WAAW;IACjB,IAAI,EAAE,UAAU;IAChB,WAAW,EAAE,mEAAmE;IAChF,SAAS,EAAE;QACV;YACC,EAAE,EAAE,gBAAgB;YACpB,KAAK,EAAE,gBAAgB;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,4CAA4C;YAClD,WAAW,EAAE,wDAAwD;YACrE,UAAU,EAAE;gBACX,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,iBAAiB,EAAE,QAAQ,EAAE,IAAI,EAAE;gBACjF,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,mBAAmB,EAAE,QAAQ,EAAE,IAAI,EAAE;gBACpF,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,eAAe,EAAE,QAAQ,EAAE,IAAI,EAAE;aAClF;YACD,WAAW,EAAE;gBACZ;oBACC,IAAI,EAAE,WAAW;oBACjB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,mBAAmB;oBAChC,QAAQ,EAAE,KAAK;iBACf;gBACD,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,iBAAiB,EAAE,QAAQ,EAAE,KAAK,EAAE;gBACpF;oBACC,IAAI,EAAE,UAAU;oBAChB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,oBAAoB;oBACjC,QAAQ,EAAE,KAAK;iBACf;gBACD;oBACC,IAAI,EAAE,SAAS;oBACf,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,4BAA4B;oBACzC,QAAQ,EAAE,KAAK;iBACf;gBACD;oBACC,IAAI,EAAE,UAAU;oBAChB,IAAI,EAAE,SAAS;oBACf,WAAW,EAAE,gCAAgC;oBAC7C,QAAQ,EAAE,KAAK;iBACf;gBACD;oBACC,IAAI,EAAE,WAAW;oBACjB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,sBAAsB;oBACnC,QAAQ,EAAE,KAAK;iBACf;gBACD;oBACC,IAAI,EAAE,OAAO;oBACb,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,wBAAwB;oBACrC,QAAQ,EAAE,KAAK;iBACf;aACD;YACD,WAAW,EAAE,IAAI;YACjB,mBAAmB,EAAE,6BAA6B;YAClD,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,qBAAqB,EAAE;gBACjD,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,gDAAgD,EAAE;gBAC5E,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,oBAAoB,EAAE;aAChD;YACD,WAAW,EAAE,oCAAoC;SACjD;QACD;YACC,EAAE,EAAE,eAAe;YACnB,KAAK,EAAE,eAAe;YACtB,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,6CAA6C;YACnD,WAAW,EAAE,yCAAyC;YACtD,UAAU,EAAE;gBACX,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,iBAAiB,EAAE,QAAQ,EAAE,IAAI,EAAE;gBACjF,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,mBAAmB,EAAE,QAAQ,EAAE,IAAI,EAAE;gBACpF,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,eAAe,EAAE,QAAQ,EAAE,IAAI,EAAE;aAClF;YACD,WAAW,EAAE,EAAE;YACf,WAAW,EAAE;gBACZ,WAAW,EAAE,oBAAoB;gBACjC,MAAM,EAAE,EAAE,MAAM,EAAE,2BAA2B,EAAE;aAC/C;YACD,mBAAmB,EAClB,uFAAuF;YACxF,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,6BAA6B,EAAE;gBACzD,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,gDAAgD,EAAE;gBAC5E,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,oBAAoB,EAAE;aAChD;YACD,WAAW,EAAE,qCAAqC;YAClD,WAAW,EAAE,EAAE,KAAK,EAAE,8BAA8B,EAAE;SACtD;QACD;YACC,EAAE,EAAE,iBAAiB;YACrB,KAAK,EAAE,iBAAiB;YACxB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,kDAAkD;YACxD,WAAW,EAAE,kEAAkE;YAC/E,UAAU,EAAE;gBACX,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,iBAAiB,EAAE,QAAQ,EAAE,IAAI,EAAE;gBACjF,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,mBAAmB,EAAE,QAAQ,EAAE,IAAI,EAAE;gBACpF,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,eAAe,EAAE,QAAQ,EAAE,IAAI,EAAE;aAClF;YACD,WAAW,EAAE;gBACZ;oBACC,IAAI,EAAE,WAAW;oBACjB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,4BAA4B;oBACzC,QAAQ,EAAE,IAAI;iBACd;gBACD;oBACC,IAAI,EAAE,SAAS;oBACf,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,0BAA0B;oBACvC,QAAQ,EAAE,IAAI;iBACd;aACD;YACD,WAAW,EAAE,IAAI;YACjB,mBAAmB,EAAE,6BAA6B;YAClD,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,sBAAsB,EAAE;gBAClD,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,gDAAgD,EAAE;gBAC5E,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,oBAAoB,EAAE;aAChD;YACD,WAAW,EAAE,0CAA0C;SACvD;QACD;YACC,EAAE,EAAE,aAAa;YACjB,KAAK,EAAE,aAAa;YACpB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,8CAA8C;YACpD,WAAW,EAAE,gCAAgC;YAC7C,UAAU,EAAE;gBACX,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,iBAAiB,EAAE,QAAQ,EAAE,IAAI,EAAE;gBACjF,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,mBAAmB,EAAE,QAAQ,EAAE,IAAI,EAAE;gBACpF,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,eAAe,EAAE,QAAQ,EAAE,IAAI,EAAE;aAClF;YACD,WAAW,EAAE,EAAE;YACf,WAAW,EAAE,IAAI;YACjB,mBAAmB,EAAE,oCAAoC;YACzD,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,iBAAiB,EAAE;gBAC7C,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,gDAAgD,EAAE;gBAC5E,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,oBAAoB,EAAE;aAChD;YACD,WAAW,EAAE,sCAAsC;SACnD;KACD;CACD,CAAC;AAEF,eAAe,OAAO,CAAC"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
/** Request body for POST /resource/{orgId}/{region}/{database}/query */
|
|
3
|
+
export declare const DbExecuteQueryRequestSchema: z.ZodObject<{
|
|
4
|
+
query: z.ZodString;
|
|
5
|
+
}, z.core.$strip>;
|
|
6
|
+
export type DbExecuteQueryRequest = z.infer<typeof DbExecuteQueryRequestSchema>;
|
|
7
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/services/db/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAMxB,wEAAwE;AACxE,eAAO,MAAM,2BAA2B;;iBAEtC,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
// ---------------------------------------------------------------------------
|
|
3
|
+
// API-level Zod schemas for the Database HTTP API.
|
|
4
|
+
// ---------------------------------------------------------------------------
|
|
5
|
+
/** Request body for POST /resource/{orgId}/{region}/{database}/query */
|
|
6
|
+
export const DbExecuteQueryRequestSchema = z.object({
|
|
7
|
+
query: z.string().describe('SQL query to execute'),
|
|
8
|
+
});
|
|
9
|
+
//# sourceMappingURL=types.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/db/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,8EAA8E;AAC9E,mDAAmD;AACnD,8EAA8E;AAE9E,wEAAwE;AACxE,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,sBAAsB,CAAC;CAClD,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-reference.d.ts","sourceRoot":"","sources":["../../../src/services/email/api-reference.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAEnD,QAAA,MAAM,OAAO,EAAE,OAkVd,CAAC;AAEF,eAAe,OAAO,CAAC"}
|