@agentuity/core 1.0.40 → 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,121 @@
|
|
|
1
|
+
import { EvaluationSchema } from "./list.js";
|
|
2
|
+
import { EvalRunSchema } from "./run-list.js";
|
|
3
|
+
const service = {
|
|
4
|
+
name: 'Evaluations',
|
|
5
|
+
slug: 'evaluations',
|
|
6
|
+
description: 'List and retrieve evaluations and their run history',
|
|
7
|
+
endpoints: [
|
|
8
|
+
{
|
|
9
|
+
id: 'list-evaluations',
|
|
10
|
+
title: 'List Evaluations',
|
|
11
|
+
method: 'GET',
|
|
12
|
+
path: '/cli/eval',
|
|
13
|
+
description: 'List evaluations with optional filtering by organization, project, or agent.',
|
|
14
|
+
pathParams: [],
|
|
15
|
+
queryParams: [
|
|
16
|
+
{
|
|
17
|
+
name: 'orgId',
|
|
18
|
+
type: 'string',
|
|
19
|
+
description: 'Filter by organization ID',
|
|
20
|
+
required: false,
|
|
21
|
+
},
|
|
22
|
+
{
|
|
23
|
+
name: 'projectId',
|
|
24
|
+
type: 'string',
|
|
25
|
+
description: 'Filter by project ID',
|
|
26
|
+
required: false,
|
|
27
|
+
},
|
|
28
|
+
{ name: 'agentId', type: 'string', description: 'Filter by agent ID', required: false },
|
|
29
|
+
],
|
|
30
|
+
requestBody: null,
|
|
31
|
+
responseDescription: 'Array of evaluation objects.',
|
|
32
|
+
responseFields: { schema: EvaluationSchema },
|
|
33
|
+
statuses: [
|
|
34
|
+
{ code: 200, description: 'Evaluations returned' },
|
|
35
|
+
{ code: 401, description: 'Unauthorized — invalid or missing Bearer token' },
|
|
36
|
+
],
|
|
37
|
+
examplePath: '/cli/eval',
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
id: 'get-evaluation',
|
|
41
|
+
title: 'Get Evaluation',
|
|
42
|
+
method: 'GET',
|
|
43
|
+
path: '/cli/eval/{id}',
|
|
44
|
+
description: 'Get a specific evaluation by ID.',
|
|
45
|
+
pathParams: [{ name: 'id', type: 'string', description: 'Evaluation ID', required: true }],
|
|
46
|
+
queryParams: [],
|
|
47
|
+
requestBody: null,
|
|
48
|
+
responseDescription: 'Evaluation object.',
|
|
49
|
+
statuses: [
|
|
50
|
+
{ code: 200, description: 'Evaluation returned' },
|
|
51
|
+
{ code: 401, description: 'Unauthorized — invalid or missing Bearer token' },
|
|
52
|
+
{ code: 404, description: 'Evaluation not found' },
|
|
53
|
+
],
|
|
54
|
+
examplePath: '/cli/eval/eval_abc123',
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
id: 'list-eval-runs',
|
|
58
|
+
title: 'List Eval Runs',
|
|
59
|
+
sectionTitle: 'Eval Runs',
|
|
60
|
+
method: 'GET',
|
|
61
|
+
path: '/cli/eval-run',
|
|
62
|
+
description: 'List evaluation runs with optional filtering.',
|
|
63
|
+
pathParams: [],
|
|
64
|
+
queryParams: [
|
|
65
|
+
{
|
|
66
|
+
name: 'orgId',
|
|
67
|
+
type: 'string',
|
|
68
|
+
description: 'Filter by organization ID',
|
|
69
|
+
required: false,
|
|
70
|
+
},
|
|
71
|
+
{
|
|
72
|
+
name: 'projectId',
|
|
73
|
+
type: 'string',
|
|
74
|
+
description: 'Filter by project ID',
|
|
75
|
+
required: false,
|
|
76
|
+
},
|
|
77
|
+
{ name: 'agentId', type: 'string', description: 'Filter by agent ID', required: false },
|
|
78
|
+
{
|
|
79
|
+
name: 'evalId',
|
|
80
|
+
type: 'string',
|
|
81
|
+
description: 'Filter by evaluation ID',
|
|
82
|
+
required: false,
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
name: 'sessionId',
|
|
86
|
+
type: 'string',
|
|
87
|
+
description: 'Filter by session ID',
|
|
88
|
+
required: false,
|
|
89
|
+
},
|
|
90
|
+
],
|
|
91
|
+
requestBody: null,
|
|
92
|
+
responseDescription: 'Array of evaluation run objects.',
|
|
93
|
+
responseFields: { schema: EvalRunSchema },
|
|
94
|
+
statuses: [
|
|
95
|
+
{ code: 200, description: 'Eval runs returned' },
|
|
96
|
+
{ code: 401, description: 'Unauthorized — invalid or missing Bearer token' },
|
|
97
|
+
],
|
|
98
|
+
examplePath: '/cli/eval-run',
|
|
99
|
+
},
|
|
100
|
+
{
|
|
101
|
+
id: 'get-eval-run',
|
|
102
|
+
title: 'Get Eval Run',
|
|
103
|
+
sectionTitle: 'Eval Runs',
|
|
104
|
+
method: 'GET',
|
|
105
|
+
path: '/cli/eval-run/{id}',
|
|
106
|
+
description: 'Get a specific evaluation run by ID.',
|
|
107
|
+
pathParams: [{ name: 'id', type: 'string', description: 'Eval run ID', required: true }],
|
|
108
|
+
queryParams: [],
|
|
109
|
+
requestBody: null,
|
|
110
|
+
responseDescription: 'Evaluation run object.',
|
|
111
|
+
statuses: [
|
|
112
|
+
{ code: 200, description: 'Eval run returned' },
|
|
113
|
+
{ code: 401, description: 'Unauthorized — invalid or missing Bearer token' },
|
|
114
|
+
{ code: 404, description: 'Eval run not found' },
|
|
115
|
+
],
|
|
116
|
+
examplePath: '/cli/eval-run/er_abc123',
|
|
117
|
+
},
|
|
118
|
+
],
|
|
119
|
+
};
|
|
120
|
+
export default service;
|
|
121
|
+
//# sourceMappingURL=api-reference.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-reference.js","sourceRoot":"","sources":["../../../src/services/eval/api-reference.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAE9C,MAAM,OAAO,GAAY;IACxB,IAAI,EAAE,aAAa;IACnB,IAAI,EAAE,aAAa;IACnB,WAAW,EAAE,qDAAqD;IAClE,SAAS,EAAE;QACV;YACC,EAAE,EAAE,kBAAkB;YACtB,KAAK,EAAE,kBAAkB;YACzB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,WAAW;YACjB,WAAW,EACV,8EAA8E;YAC/E,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;gBACD,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,oBAAoB,EAAE,QAAQ,EAAE,KAAK,EAAE;aACvF;YACD,WAAW,EAAE,IAAI;YACjB,mBAAmB,EAAE,8BAA8B;YACnD,cAAc,EAAE,EAAE,MAAM,EAAE,gBAAgB,EAAE;YAC5C,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,sBAAsB,EAAE;gBAClD,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,gDAAgD,EAAE;aAC5E;YACD,WAAW,EAAE,WAAW;SACxB;QACD;YACC,EAAE,EAAE,gBAAgB;YACpB,KAAK,EAAE,gBAAgB;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,gBAAgB;YACtB,WAAW,EAAE,kCAAkC;YAC/C,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,eAAe,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;YAC1F,WAAW,EAAE,EAAE;YACf,WAAW,EAAE,IAAI;YACjB,mBAAmB,EAAE,oBAAoB;YACzC,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,sBAAsB,EAAE;aAClD;YACD,WAAW,EAAE,uBAAuB;SACpC;QACD;YACC,EAAE,EAAE,gBAAgB;YACpB,KAAK,EAAE,gBAAgB;YACvB,YAAY,EAAE,WAAW;YACzB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,eAAe;YACrB,WAAW,EAAE,+CAA+C;YAC5D,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;gBACD,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,oBAAoB,EAAE,QAAQ,EAAE,KAAK,EAAE;gBACvF;oBACC,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,yBAAyB;oBACtC,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,kCAAkC;YACvD,cAAc,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE;YACzC,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,oBAAoB,EAAE;gBAChD,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,gDAAgD,EAAE;aAC5E;YACD,WAAW,EAAE,eAAe;SAC5B;QACD;YACC,EAAE,EAAE,cAAc;YAClB,KAAK,EAAE,cAAc;YACrB,YAAY,EAAE,WAAW;YACzB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,oBAAoB;YAC1B,WAAW,EAAE,sCAAsC;YACnD,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,aAAa,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;YACxF,WAAW,EAAE,EAAE;YACf,WAAW,EAAE,IAAI;YACjB,mBAAmB,EAAE,wBAAwB;YAC7C,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,mBAAmB,EAAE;gBAC/C,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,gDAAgD,EAAE;gBAC5E,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,oBAAoB,EAAE;aAChD;YACD,WAAW,EAAE,yBAAyB;SACtC;KACD;CACD,CAAC;AAEF,eAAe,OAAO,CAAC"}
|
package/dist/services/index.d.ts
CHANGED
|
@@ -14,6 +14,8 @@ export * from './apikey/index.ts';
|
|
|
14
14
|
export * from './db/index.ts';
|
|
15
15
|
export * from './eval/index.ts';
|
|
16
16
|
export * from './machine/index.ts';
|
|
17
|
+
export * from './monitoring/index.ts';
|
|
18
|
+
export * from './oauth/index.ts';
|
|
17
19
|
export * from './org/index.ts';
|
|
18
20
|
export * from './project/index.ts';
|
|
19
21
|
export * from './queue/index.ts';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/services/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAElC,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AAEzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,YAAY,CAAC;AAC3B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AAEnC,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/services/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAElC,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AAEzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,YAAY,CAAC;AAC3B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AAEnC,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC"}
|
package/dist/services/index.js
CHANGED
|
@@ -14,6 +14,8 @@ export * from "./apikey/index.js";
|
|
|
14
14
|
export * from "./db/index.js";
|
|
15
15
|
export * from "./eval/index.js";
|
|
16
16
|
export * from "./machine/index.js";
|
|
17
|
+
export * from "./monitoring/index.js";
|
|
18
|
+
export * from "./oauth/index.js";
|
|
17
19
|
export * from "./org/index.js";
|
|
18
20
|
export * from "./project/index.js";
|
|
19
21
|
export * from "./queue/index.js";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/services/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAElC,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AAEzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,YAAY,CAAC;AAC3B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AAEnC,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/services/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAElC,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AAEzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,YAAY,CAAC;AAC3B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AAEnC,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-reference.d.ts","sourceRoot":"","sources":["../../../src/services/keyvalue/api-reference.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAEnD,QAAA,MAAM,OAAO,EAAE,OAiRd,CAAC;AAEF,eAAe,OAAO,CAAC"}
|
|
@@ -0,0 +1,270 @@
|
|
|
1
|
+
import { KeyValueStatsPaginatedSchema, KeyValueStatsSchema } from "./service.js";
|
|
2
|
+
import { CreateNamespaceApiRequestSchema, KeyValueItemMetadataSchema } from "./types.js";
|
|
3
|
+
const service = {
|
|
4
|
+
name: 'Key-Value Storage',
|
|
5
|
+
slug: 'key-value',
|
|
6
|
+
description: 'Store and retrieve arbitrary data by key within namespaces',
|
|
7
|
+
endpoints: [
|
|
8
|
+
{
|
|
9
|
+
id: 'get-value',
|
|
10
|
+
title: 'Get Value',
|
|
11
|
+
method: 'GET',
|
|
12
|
+
path: '/kv/{namespace}/{key}',
|
|
13
|
+
description: 'Retrieve a stored value by its namespace and key. Returns the raw value with the original content type.',
|
|
14
|
+
pathParams: [
|
|
15
|
+
{ name: 'namespace', type: 'string', description: 'The namespace name' },
|
|
16
|
+
{ name: 'key', type: 'string', description: 'The key to retrieve' },
|
|
17
|
+
],
|
|
18
|
+
queryParams: [],
|
|
19
|
+
requestBody: null,
|
|
20
|
+
responseDescription: 'Returns the raw stored value with the original content type. The response body is the value itself (not wrapped in JSON).',
|
|
21
|
+
responseHeaders: [
|
|
22
|
+
{
|
|
23
|
+
name: 'Content-Type',
|
|
24
|
+
description: 'MIME type of the stored value (e.g., `application/json`, `text/plain`, `application/octet-stream`)',
|
|
25
|
+
},
|
|
26
|
+
{
|
|
27
|
+
name: 'x-expires-at',
|
|
28
|
+
description: 'ISO 8601 expiration timestamp. Omitted if the key does not expire.',
|
|
29
|
+
},
|
|
30
|
+
],
|
|
31
|
+
statuses: [
|
|
32
|
+
{ code: 200, description: 'Value found and returned' },
|
|
33
|
+
{ code: 401, description: 'Unauthorized — invalid or missing API key' },
|
|
34
|
+
{ code: 404, description: 'Key does not exist in the namespace' },
|
|
35
|
+
],
|
|
36
|
+
examplePath: '/kv/my-namespace/user-123',
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
id: 'set-value',
|
|
40
|
+
title: 'Store Value',
|
|
41
|
+
method: 'PUT',
|
|
42
|
+
path: '/kv/{namespace}/{key}[/{ttl}]',
|
|
43
|
+
description: "Store a value in key-value storage. The namespace is auto-created if it doesn't exist. Set the Content-Type header to match your data format.",
|
|
44
|
+
pathParams: [
|
|
45
|
+
{
|
|
46
|
+
name: 'namespace',
|
|
47
|
+
type: 'string',
|
|
48
|
+
description: 'The namespace name (auto-created if not exists)',
|
|
49
|
+
},
|
|
50
|
+
{ name: 'key', type: 'string', description: 'The key to store the value under' },
|
|
51
|
+
{
|
|
52
|
+
name: 'ttl',
|
|
53
|
+
type: 'number',
|
|
54
|
+
description: 'Optional TTL in seconds (60–31,536,000). Omit for namespace default. Use `0` for no expiration.',
|
|
55
|
+
required: false,
|
|
56
|
+
},
|
|
57
|
+
],
|
|
58
|
+
queryParams: [],
|
|
59
|
+
requestBody: {
|
|
60
|
+
description: 'The raw value to store. Can be any content type — JSON, text, or binary.',
|
|
61
|
+
},
|
|
62
|
+
responseDescription: 'Empty response on success.',
|
|
63
|
+
responseHeaders: [],
|
|
64
|
+
statuses: [
|
|
65
|
+
{ code: 200, description: 'Value stored successfully' },
|
|
66
|
+
{ code: 401, description: 'Unauthorized — invalid or missing API key' },
|
|
67
|
+
{ code: 402, description: 'Payment required — upgrade to a paid plan' },
|
|
68
|
+
],
|
|
69
|
+
examplePath: '/kv/my-namespace/user-123',
|
|
70
|
+
exampleBody: { name: 'Alice', email: 'alice@example.com' },
|
|
71
|
+
ttlNote: 'TTL behavior:\n- **Omitted**: Key inherits namespace default TTL (7 days if not configured)\n- **`0`**: Key never expires\n- **60–31,536,000**: Expires after specified seconds (values outside range are clamped)',
|
|
72
|
+
},
|
|
73
|
+
{
|
|
74
|
+
id: 'delete-value',
|
|
75
|
+
title: 'Delete Value',
|
|
76
|
+
method: 'DELETE',
|
|
77
|
+
path: '/kv/{namespace}/{key}',
|
|
78
|
+
description: 'Delete a specific key from a namespace.',
|
|
79
|
+
pathParams: [
|
|
80
|
+
{ name: 'namespace', type: 'string', description: 'The namespace name' },
|
|
81
|
+
{ name: 'key', type: 'string', description: 'The key to delete' },
|
|
82
|
+
],
|
|
83
|
+
queryParams: [],
|
|
84
|
+
requestBody: null,
|
|
85
|
+
responseDescription: 'Empty response on success.',
|
|
86
|
+
responseHeaders: [],
|
|
87
|
+
statuses: [
|
|
88
|
+
{ code: 200, description: 'Key deleted successfully' },
|
|
89
|
+
{ code: 401, description: 'Unauthorized' },
|
|
90
|
+
],
|
|
91
|
+
examplePath: '/kv/my-namespace/user-123',
|
|
92
|
+
},
|
|
93
|
+
{
|
|
94
|
+
id: 'search-keys',
|
|
95
|
+
title: 'Search Keys',
|
|
96
|
+
method: 'GET',
|
|
97
|
+
path: '/kv/search/{namespace}/{keyword}',
|
|
98
|
+
description: 'Search for keys matching a keyword within a namespace. Returns matching keys with their values and metadata.',
|
|
99
|
+
pathParams: [
|
|
100
|
+
{ name: 'namespace', type: 'string', description: 'The namespace to search in' },
|
|
101
|
+
{
|
|
102
|
+
name: 'keyword',
|
|
103
|
+
type: 'string',
|
|
104
|
+
description: 'The keyword to search for in key names',
|
|
105
|
+
},
|
|
106
|
+
],
|
|
107
|
+
queryParams: [],
|
|
108
|
+
requestBody: null,
|
|
109
|
+
responseDescription: 'JSON object mapping key names to their values and metadata.',
|
|
110
|
+
responseFields: {
|
|
111
|
+
schema: KeyValueItemMetadataSchema,
|
|
112
|
+
prefix: '{key}',
|
|
113
|
+
stripRequired: true,
|
|
114
|
+
},
|
|
115
|
+
statuses: [
|
|
116
|
+
{ code: 200, description: 'Search results returned' },
|
|
117
|
+
{ code: 401, description: 'Unauthorized' },
|
|
118
|
+
],
|
|
119
|
+
examplePath: '/kv/search/my-namespace/user',
|
|
120
|
+
},
|
|
121
|
+
{
|
|
122
|
+
id: 'get-keys',
|
|
123
|
+
title: 'List Keys',
|
|
124
|
+
method: 'GET',
|
|
125
|
+
path: '/kv/keys/{namespace}',
|
|
126
|
+
description: 'Get all key names in a namespace.',
|
|
127
|
+
pathParams: [
|
|
128
|
+
{ name: 'namespace', type: 'string', description: 'The namespace to list keys from' },
|
|
129
|
+
],
|
|
130
|
+
queryParams: [],
|
|
131
|
+
requestBody: null,
|
|
132
|
+
responseDescription: 'JSON array of key name strings.',
|
|
133
|
+
responseHeaders: [],
|
|
134
|
+
statuses: [
|
|
135
|
+
{ code: 200, description: 'Key list returned' },
|
|
136
|
+
{ code: 401, description: 'Unauthorized' },
|
|
137
|
+
],
|
|
138
|
+
examplePath: '/kv/keys/my-namespace',
|
|
139
|
+
},
|
|
140
|
+
{
|
|
141
|
+
id: 'get-namespace-stats',
|
|
142
|
+
title: 'Get Namespace Stats',
|
|
143
|
+
method: 'GET',
|
|
144
|
+
path: '/kv/stats/{namespace}',
|
|
145
|
+
description: 'Get statistics for a specific namespace including record count and size.',
|
|
146
|
+
pathParams: [
|
|
147
|
+
{ name: 'namespace', type: 'string', description: 'The namespace to get stats for' },
|
|
148
|
+
],
|
|
149
|
+
queryParams: [],
|
|
150
|
+
requestBody: null,
|
|
151
|
+
responseDescription: 'JSON object with namespace statistics.',
|
|
152
|
+
responseFields: { schema: KeyValueStatsSchema, omit: ['internal'] },
|
|
153
|
+
statuses: [
|
|
154
|
+
{ code: 200, description: 'Stats returned' },
|
|
155
|
+
{ code: 401, description: 'Unauthorized' },
|
|
156
|
+
],
|
|
157
|
+
examplePath: '/kv/stats/my-namespace',
|
|
158
|
+
},
|
|
159
|
+
{
|
|
160
|
+
id: 'get-all-stats',
|
|
161
|
+
title: 'List All Namespace Stats',
|
|
162
|
+
method: 'GET',
|
|
163
|
+
path: '/kv/stats',
|
|
164
|
+
description: 'Get statistics for all namespaces with optional pagination and filtering.',
|
|
165
|
+
pathParams: [],
|
|
166
|
+
queryParams: [
|
|
167
|
+
{
|
|
168
|
+
name: 'limit',
|
|
169
|
+
type: 'number',
|
|
170
|
+
description: 'Maximum namespaces to return (default: 100, max: 1000)',
|
|
171
|
+
required: false,
|
|
172
|
+
},
|
|
173
|
+
{
|
|
174
|
+
name: 'offset',
|
|
175
|
+
type: 'number',
|
|
176
|
+
description: 'Number of namespaces to skip (default: 0)',
|
|
177
|
+
required: false,
|
|
178
|
+
},
|
|
179
|
+
{
|
|
180
|
+
name: 'sort',
|
|
181
|
+
type: 'string',
|
|
182
|
+
description: 'Sort field: `name`, `size`, `records`, `created`, or `lastUsed`',
|
|
183
|
+
required: false,
|
|
184
|
+
},
|
|
185
|
+
{
|
|
186
|
+
name: 'direction',
|
|
187
|
+
type: 'string',
|
|
188
|
+
description: 'Sort direction: `asc` or `desc` (default: `desc`)',
|
|
189
|
+
required: false,
|
|
190
|
+
},
|
|
191
|
+
{
|
|
192
|
+
name: 'name',
|
|
193
|
+
type: 'string',
|
|
194
|
+
description: 'Filter namespaces by name substring',
|
|
195
|
+
required: false,
|
|
196
|
+
},
|
|
197
|
+
],
|
|
198
|
+
requestBody: null,
|
|
199
|
+
responseDescription: 'Paginated response with namespace statistics.',
|
|
200
|
+
responseFields: { schema: KeyValueStatsPaginatedSchema, stripRequired: true },
|
|
201
|
+
statuses: [
|
|
202
|
+
{ code: 200, description: 'Stats returned' },
|
|
203
|
+
{ code: 401, description: 'Unauthorized' },
|
|
204
|
+
],
|
|
205
|
+
examplePath: '/kv/stats?limit=10&sort=size&direction=desc',
|
|
206
|
+
},
|
|
207
|
+
{
|
|
208
|
+
id: 'list-namespaces',
|
|
209
|
+
title: 'List Namespaces',
|
|
210
|
+
method: 'GET',
|
|
211
|
+
path: '/kv/namespaces',
|
|
212
|
+
description: 'Get all namespace names (up to 1000, ordered by creation date, most recent first).',
|
|
213
|
+
pathParams: [],
|
|
214
|
+
queryParams: [],
|
|
215
|
+
requestBody: null,
|
|
216
|
+
responseDescription: 'JSON array of namespace name strings.',
|
|
217
|
+
responseHeaders: [],
|
|
218
|
+
statuses: [
|
|
219
|
+
{ code: 200, description: 'Namespace list returned' },
|
|
220
|
+
{ code: 401, description: 'Unauthorized' },
|
|
221
|
+
],
|
|
222
|
+
examplePath: '/kv/namespaces',
|
|
223
|
+
},
|
|
224
|
+
{
|
|
225
|
+
id: 'create-namespace',
|
|
226
|
+
title: 'Create Namespace',
|
|
227
|
+
method: 'POST',
|
|
228
|
+
path: '/kv/{namespace}',
|
|
229
|
+
description: 'Create a new namespace with optional default TTL configuration.',
|
|
230
|
+
pathParams: [
|
|
231
|
+
{ name: 'namespace', type: 'string', description: 'The namespace name to create' },
|
|
232
|
+
],
|
|
233
|
+
queryParams: [],
|
|
234
|
+
requestBody: {
|
|
235
|
+
description: 'Optional JSON body with namespace configuration.',
|
|
236
|
+
fields: { schema: CreateNamespaceApiRequestSchema },
|
|
237
|
+
},
|
|
238
|
+
responseDescription: 'Empty response on success.',
|
|
239
|
+
responseHeaders: [],
|
|
240
|
+
statuses: [
|
|
241
|
+
{ code: 200, description: 'Namespace created successfully' },
|
|
242
|
+
{ code: 401, description: 'Unauthorized' },
|
|
243
|
+
{ code: 402, description: 'Payment required' },
|
|
244
|
+
],
|
|
245
|
+
examplePath: '/kv/my-namespace',
|
|
246
|
+
exampleBody: { default_ttl_seconds: 86400 },
|
|
247
|
+
},
|
|
248
|
+
{
|
|
249
|
+
id: 'delete-namespace',
|
|
250
|
+
title: 'Delete Namespace',
|
|
251
|
+
method: 'DELETE',
|
|
252
|
+
path: '/kv/{namespace}',
|
|
253
|
+
description: 'Delete an entire namespace and all its keys.',
|
|
254
|
+
pathParams: [
|
|
255
|
+
{ name: 'namespace', type: 'string', description: 'The namespace to delete' },
|
|
256
|
+
],
|
|
257
|
+
queryParams: [],
|
|
258
|
+
requestBody: null,
|
|
259
|
+
responseDescription: 'Empty response on success.',
|
|
260
|
+
responseHeaders: [],
|
|
261
|
+
statuses: [
|
|
262
|
+
{ code: 200, description: 'Namespace deleted successfully' },
|
|
263
|
+
{ code: 401, description: 'Unauthorized' },
|
|
264
|
+
],
|
|
265
|
+
examplePath: '/kv/my-namespace',
|
|
266
|
+
},
|
|
267
|
+
],
|
|
268
|
+
};
|
|
269
|
+
export default service;
|
|
270
|
+
//# sourceMappingURL=api-reference.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-reference.js","sourceRoot":"","sources":["../../../src/services/keyvalue/api-reference.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACjF,OAAO,EAAE,+BAA+B,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAC;AAGzF,MAAM,OAAO,GAAY;IACxB,IAAI,EAAE,mBAAmB;IACzB,IAAI,EAAE,WAAW;IACjB,WAAW,EAAE,4DAA4D;IACzE,SAAS,EAAE;QACV;YACC,EAAE,EAAE,WAAW;YACf,KAAK,EAAE,WAAW;YAClB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,uBAAuB;YAC7B,WAAW,EACV,yGAAyG;YAC1G,UAAU,EAAE;gBACX,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,oBAAoB,EAAE;gBACxE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,qBAAqB,EAAE;aACnE;YACD,WAAW,EAAE,EAAE;YACf,WAAW,EAAE,IAAI;YACjB,mBAAmB,EAClB,2HAA2H;YAC5H,eAAe,EAAE;gBAChB;oBACC,IAAI,EAAE,cAAc;oBACpB,WAAW,EACV,oGAAoG;iBACrG;gBACD;oBACC,IAAI,EAAE,cAAc;oBACpB,WAAW,EAAE,oEAAoE;iBACjF;aACD;YACD,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,0BAA0B,EAAE;gBACtD,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,2CAA2C,EAAE;gBACvE,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,qCAAqC,EAAE;aACjE;YACD,WAAW,EAAE,2BAA2B;SACxC;QACD;YACC,EAAE,EAAE,WAAW;YACf,KAAK,EAAE,aAAa;YACpB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,+BAA+B;YACrC,WAAW,EACV,+IAA+I;YAChJ,UAAU,EAAE;gBACX;oBACC,IAAI,EAAE,WAAW;oBACjB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,iDAAiD;iBAC9D;gBACD,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,kCAAkC,EAAE;gBAChF;oBACC,IAAI,EAAE,KAAK;oBACX,IAAI,EAAE,QAAQ;oBACd,WAAW,EACV,iGAAiG;oBAClG,QAAQ,EAAE,KAAK;iBACf;aACD;YACD,WAAW,EAAE,EAAE;YACf,WAAW,EAAE;gBACZ,WAAW,EAAE,0EAA0E;aACvF;YACD,mBAAmB,EAAE,4BAA4B;YACjD,eAAe,EAAE,EAAE;YACnB,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,2BAA2B,EAAE;gBACvD,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,2CAA2C,EAAE;gBACvE,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,2CAA2C,EAAE;aACvE;YACD,WAAW,EAAE,2BAA2B;YACxC,WAAW,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,mBAAmB,EAAE;YAC1D,OAAO,EACN,oNAAoN;SACrN;QACD;YACC,EAAE,EAAE,cAAc;YAClB,KAAK,EAAE,cAAc;YACrB,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,uBAAuB;YAC7B,WAAW,EAAE,yCAAyC;YACtD,UAAU,EAAE;gBACX,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,oBAAoB,EAAE;gBACxE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,mBAAmB,EAAE;aACjE;YACD,WAAW,EAAE,EAAE;YACf,WAAW,EAAE,IAAI;YACjB,mBAAmB,EAAE,4BAA4B;YACjD,eAAe,EAAE,EAAE;YACnB,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,0BAA0B,EAAE;gBACtD,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,cAAc,EAAE;aAC1C;YACD,WAAW,EAAE,2BAA2B;SACxC;QACD;YACC,EAAE,EAAE,aAAa;YACjB,KAAK,EAAE,aAAa;YACpB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,kCAAkC;YACxC,WAAW,EACV,8GAA8G;YAC/G,UAAU,EAAE;gBACX,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,4BAA4B,EAAE;gBAChF;oBACC,IAAI,EAAE,SAAS;oBACf,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,wCAAwC;iBACrD;aACD;YACD,WAAW,EAAE,EAAE;YACf,WAAW,EAAE,IAAI;YACjB,mBAAmB,EAAE,6DAA6D;YAClF,cAAc,EAAE;gBACf,MAAM,EAAE,0BAA0B;gBAClC,MAAM,EAAE,OAAO;gBACf,aAAa,EAAE,IAAI;aACnB;YACD,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,yBAAyB,EAAE;gBACrD,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,cAAc,EAAE;aAC1C;YACD,WAAW,EAAE,8BAA8B;SAC3C;QACD;YACC,EAAE,EAAE,UAAU;YACd,KAAK,EAAE,WAAW;YAClB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,sBAAsB;YAC5B,WAAW,EAAE,mCAAmC;YAChD,UAAU,EAAE;gBACX,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,iCAAiC,EAAE;aACrF;YACD,WAAW,EAAE,EAAE;YACf,WAAW,EAAE,IAAI;YACjB,mBAAmB,EAAE,iCAAiC;YACtD,eAAe,EAAE,EAAE;YACnB,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,mBAAmB,EAAE;gBAC/C,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,cAAc,EAAE;aAC1C;YACD,WAAW,EAAE,uBAAuB;SACpC;QACD;YACC,EAAE,EAAE,qBAAqB;YACzB,KAAK,EAAE,qBAAqB;YAC5B,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,uBAAuB;YAC7B,WAAW,EAAE,0EAA0E;YACvF,UAAU,EAAE;gBACX,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,gCAAgC,EAAE;aACpF;YACD,WAAW,EAAE,EAAE;YACf,WAAW,EAAE,IAAI;YACjB,mBAAmB,EAAE,wCAAwC;YAC7D,cAAc,EAAE,EAAE,MAAM,EAAE,mBAAmB,EAAE,IAAI,EAAE,CAAC,UAAU,CAAC,EAAE;YACnE,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,gBAAgB,EAAE;gBAC5C,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,cAAc,EAAE;aAC1C;YACD,WAAW,EAAE,wBAAwB;SACrC;QACD;YACC,EAAE,EAAE,eAAe;YACnB,KAAK,EAAE,0BAA0B;YACjC,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,WAAW;YACjB,WAAW,EAAE,2EAA2E;YACxF,UAAU,EAAE,EAAE;YACd,WAAW,EAAE;gBACZ;oBACC,IAAI,EAAE,OAAO;oBACb,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,wDAAwD;oBACrE,QAAQ,EAAE,KAAK;iBACf;gBACD;oBACC,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,2CAA2C;oBACxD,QAAQ,EAAE,KAAK;iBACf;gBACD;oBACC,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,iEAAiE;oBAC9E,QAAQ,EAAE,KAAK;iBACf;gBACD;oBACC,IAAI,EAAE,WAAW;oBACjB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,mDAAmD;oBAChE,QAAQ,EAAE,KAAK;iBACf;gBACD;oBACC,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,qCAAqC;oBAClD,QAAQ,EAAE,KAAK;iBACf;aACD;YACD,WAAW,EAAE,IAAI;YACjB,mBAAmB,EAAE,+CAA+C;YACpE,cAAc,EAAE,EAAE,MAAM,EAAE,4BAA4B,EAAE,aAAa,EAAE,IAAI,EAAE;YAC7E,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,gBAAgB,EAAE;gBAC5C,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,cAAc,EAAE;aAC1C;YACD,WAAW,EAAE,6CAA6C;SAC1D;QACD;YACC,EAAE,EAAE,iBAAiB;YACrB,KAAK,EAAE,iBAAiB;YACxB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,gBAAgB;YACtB,WAAW,EACV,oFAAoF;YACrF,UAAU,EAAE,EAAE;YACd,WAAW,EAAE,EAAE;YACf,WAAW,EAAE,IAAI;YACjB,mBAAmB,EAAE,uCAAuC;YAC5D,eAAe,EAAE,EAAE;YACnB,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,yBAAyB,EAAE;gBACrD,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,cAAc,EAAE;aAC1C;YACD,WAAW,EAAE,gBAAgB;SAC7B;QACD;YACC,EAAE,EAAE,kBAAkB;YACtB,KAAK,EAAE,kBAAkB;YACzB,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,iBAAiB;YACvB,WAAW,EAAE,iEAAiE;YAC9E,UAAU,EAAE;gBACX,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,8BAA8B,EAAE;aAClF;YACD,WAAW,EAAE,EAAE;YACf,WAAW,EAAE;gBACZ,WAAW,EAAE,kDAAkD;gBAC/D,MAAM,EAAE,EAAE,MAAM,EAAE,+BAA+B,EAAE;aACnD;YACD,mBAAmB,EAAE,4BAA4B;YACjD,eAAe,EAAE,EAAE;YACnB,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,gCAAgC,EAAE;gBAC5D,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,cAAc,EAAE;gBAC1C,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,kBAAkB,EAAE;aAC9C;YACD,WAAW,EAAE,kBAAkB;YAC/B,WAAW,EAAE,EAAE,mBAAmB,EAAE,KAAK,EAAE;SAC3C;QACD;YACC,EAAE,EAAE,kBAAkB;YACtB,KAAK,EAAE,kBAAkB;YACzB,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,iBAAiB;YACvB,WAAW,EAAE,8CAA8C;YAC3D,UAAU,EAAE;gBACX,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,yBAAyB,EAAE;aAC7E;YACD,WAAW,EAAE,EAAE;YACf,WAAW,EAAE,IAAI;YACjB,mBAAmB,EAAE,4BAA4B;YACjD,eAAe,EAAE,EAAE;YACnB,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,gCAAgC,EAAE;gBAC5D,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,cAAc,EAAE;aAC1C;YACD,WAAW,EAAE,kBAAkB;SAC/B;KACD;CACD,CAAC;AAEF,eAAe,OAAO,CAAC"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
/** API-level request for creating a namespace (uses snake_case field names) */
|
|
3
|
+
export declare const CreateNamespaceApiRequestSchema: z.ZodObject<{
|
|
4
|
+
default_ttl_seconds: z.ZodOptional<z.ZodNumber>;
|
|
5
|
+
}, z.core.$strip>;
|
|
6
|
+
/** Metadata for a key-value item in search results */
|
|
7
|
+
export declare const KeyValueItemMetadataSchema: z.ZodObject<{
|
|
8
|
+
value: z.ZodUnknown;
|
|
9
|
+
contentType: z.ZodString;
|
|
10
|
+
size: z.ZodNumber;
|
|
11
|
+
expiresAt: z.ZodNullable<z.ZodString>;
|
|
12
|
+
firstUsed: z.ZodNullable<z.ZodNumber>;
|
|
13
|
+
lastUsed: z.ZodNullable<z.ZodNumber>;
|
|
14
|
+
count: z.ZodNullable<z.ZodNumber>;
|
|
15
|
+
}, z.core.$strip>;
|
|
16
|
+
export type CreateNamespaceApiRequest = z.infer<typeof CreateNamespaceApiRequestSchema>;
|
|
17
|
+
export type KeyValueItemMetadata = z.infer<typeof KeyValueItemMetadataSchema>;
|
|
18
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/services/keyvalue/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,+EAA+E;AAC/E,eAAO,MAAM,+BAA+B;;iBAO1C,CAAC;AAEH,sDAAsD;AACtD,eAAO,MAAM,0BAA0B;;;;;;;;iBAQrC,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC;AACxF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
/** API-level request for creating a namespace (uses snake_case field names) */
|
|
3
|
+
export const CreateNamespaceApiRequestSchema = z.object({
|
|
4
|
+
default_ttl_seconds: z
|
|
5
|
+
.number()
|
|
6
|
+
.optional()
|
|
7
|
+
.describe('Default TTL for keys in this namespace (in seconds). If omitted, defaults to 7 days (604,800). Use 0 for keys that never expire.'),
|
|
8
|
+
});
|
|
9
|
+
/** Metadata for a key-value item in search results */
|
|
10
|
+
export const KeyValueItemMetadataSchema = z.object({
|
|
11
|
+
value: z.unknown().describe('The stored value (base64-encoded for binary)'),
|
|
12
|
+
contentType: z.string().describe('MIME type of the stored value'),
|
|
13
|
+
size: z.number().describe('Size in bytes'),
|
|
14
|
+
expiresAt: z.string().nullable().describe('ISO 8601 expiration timestamp'),
|
|
15
|
+
firstUsed: z.number().nullable().describe('Unix timestamp (ms) of first access'),
|
|
16
|
+
lastUsed: z.number().nullable().describe('Unix timestamp (ms) of last access'),
|
|
17
|
+
count: z.number().nullable().describe('Number of times accessed'),
|
|
18
|
+
});
|
|
19
|
+
//# sourceMappingURL=types.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/keyvalue/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,+EAA+E;AAC/E,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,CAAC,MAAM,CAAC;IACvD,mBAAmB,EAAE,CAAC;SACpB,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CACR,kIAAkI,CAClI;CACF,CAAC,CAAC;AAEH,sDAAsD;AACtD,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,8CAA8C,CAAC;IAC3E,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,+BAA+B,CAAC;IACjE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC;IAC1C,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,+BAA+B,CAAC;IAC1E,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,qCAAqC,CAAC;IAChF,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,oCAAoC,CAAC;IAC9E,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,0BAA0B,CAAC;CACjE,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-reference.d.ts","sourceRoot":"","sources":["../../../src/services/machine/api-reference.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAEnD,QAAA,MAAM,OAAO,EAAE,OAmJd,CAAC;AAEF,eAAe,OAAO,CAAC"}
|