@vol-a/client 0.0.0-stage → 1.1.1

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.
Files changed (47) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +254 -2
  3. package/dist/body.d.ts +40 -0
  4. package/dist/body.d.ts.map +1 -0
  5. package/dist/body.js +112 -0
  6. package/dist/body.js.map +1 -0
  7. package/dist/client.d.ts +161 -0
  8. package/dist/client.d.ts.map +1 -0
  9. package/dist/client.js +245 -0
  10. package/dist/client.js.map +1 -0
  11. package/dist/env.d.ts +19 -0
  12. package/dist/env.d.ts.map +1 -0
  13. package/dist/env.js +52 -0
  14. package/dist/env.js.map +1 -0
  15. package/dist/errors.d.ts +43 -0
  16. package/dist/errors.d.ts.map +1 -0
  17. package/dist/errors.js +93 -0
  18. package/dist/errors.js.map +1 -0
  19. package/dist/files.d.ts +144 -0
  20. package/dist/files.d.ts.map +1 -0
  21. package/dist/files.js +239 -0
  22. package/dist/files.js.map +1 -0
  23. package/dist/folders.d.ts +35 -0
  24. package/dist/folders.d.ts.map +1 -0
  25. package/dist/folders.js +62 -0
  26. package/dist/folders.js.map +1 -0
  27. package/dist/index.d.ts +20 -0
  28. package/dist/index.d.ts.map +1 -0
  29. package/dist/index.js +11 -0
  30. package/dist/index.js.map +1 -0
  31. package/dist/keyrings.d.ts +44 -0
  32. package/dist/keyrings.d.ts.map +1 -0
  33. package/dist/keyrings.js +111 -0
  34. package/dist/keyrings.js.map +1 -0
  35. package/dist/management.d.ts +47 -0
  36. package/dist/management.d.ts.map +1 -0
  37. package/dist/management.js +65 -0
  38. package/dist/management.js.map +1 -0
  39. package/dist/shares.d.ts +87 -0
  40. package/dist/shares.d.ts.map +1 -0
  41. package/dist/shares.js +144 -0
  42. package/dist/shares.js.map +1 -0
  43. package/dist/uploads.d.ts +112 -0
  44. package/dist/uploads.d.ts.map +1 -0
  45. package/dist/uploads.js +290 -0
  46. package/dist/uploads.js.map +1 -0
  47. package/package.json +48 -3
package/dist/files.js ADDED
@@ -0,0 +1,239 @@
1
+ import { ENCRYPTION_HEADER, FileDetailSchema, FileInfoSchema, FileListSchema, FileVersionsSchema, FORCE_DOWNLOAD_QUERY, OCR_QUERY, OCR_QUERY_FULL, PurgeResultSchema, THUMBNAIL_CROP_QUERY, THUMBNAIL_STATUS_HEADER, UPLOAD_FILE_FIELD, UPLOAD_FOLDER_ID_FIELD, UPLOAD_FOLDER_PATH_FIELD, UPLOAD_METADATA_FIELD, UPLOAD_PARENT_ID_FIELD, } from "@vol-a/core";
2
+ import { multipartBody, nameOf, typeOf } from "./body.js";
3
+ import { ok2xx } from "./client.js";
4
+ import { encodePath } from "./env.js";
5
+ import { VolaError } from "./errors.js";
6
+ export function rangeHeader(range) {
7
+ if (typeof range === "string")
8
+ return range;
9
+ if ("suffix" in range)
10
+ return `bytes=-${range.suffix}`;
11
+ return `bytes=${range.start}-${range.end ?? ""}`;
12
+ }
13
+ /** `/files/:type/:id`. */
14
+ export function instancePath(type, id) {
15
+ return `/files/${encodeURIComponent(type)}/${encodeURIComponent(id)}`;
16
+ }
17
+ /** `/files/:type/:id/:fileId`. */
18
+ export function filePath(type, id, fileId) {
19
+ return `${instancePath(type, id)}/${encodeURIComponent(fileId)}`;
20
+ }
21
+ /** The files of an instance: upload, download, metadata, versions, visibility, delete. */
22
+ export class FilesApi {
23
+ client;
24
+ constructor(client) {
25
+ this.client = client;
26
+ }
27
+ /**
28
+ * `POST /files/:type/:id` (multipart) — or `PUT …/slug/:slug` with `slug`. The source is a
29
+ * `File`/`Blob`, a `Uint8Array`/`Buffer`, an `ArrayBuffer`, a web `ReadableStream` or any
30
+ * async iterable of bytes (a Node `Readable`): streams are sent without being buffered.
31
+ * Resolves with the stored file (`201`).
32
+ */
33
+ async upload(type, id, source, options = {}) {
34
+ const filename = options.filename ?? nameOf(source);
35
+ if (!filename) {
36
+ throw new VolaError({
37
+ status: 0,
38
+ code: "bad_request",
39
+ message: "upload: filename is required when the source is not a File",
40
+ });
41
+ }
42
+ if (options.folderPath !== undefined && options.folderId !== undefined) {
43
+ throw new VolaError({
44
+ status: 0,
45
+ code: "bad_request",
46
+ message: "upload: folderPath and folderId exclude each other",
47
+ });
48
+ }
49
+ const fields = [];
50
+ if (options.folderPath !== undefined)
51
+ fields.push([UPLOAD_FOLDER_PATH_FIELD, options.folderPath]);
52
+ if (options.folderId !== undefined)
53
+ fields.push([UPLOAD_FOLDER_ID_FIELD, options.folderId ?? ""]);
54
+ if (options.parentId !== undefined)
55
+ fields.push([UPLOAD_PARENT_ID_FIELD, options.parentId]);
56
+ if (options.metadata !== undefined) {
57
+ fields.push([UPLOAD_METADATA_FIELD, JSON.stringify(options.metadata)]);
58
+ }
59
+ const { body, contentType, streaming } = multipartBody(fields, {
60
+ field: UPLOAD_FILE_FIELD,
61
+ filename,
62
+ contentType: options.contentType ?? typeOf(source) ?? "application/octet-stream",
63
+ source,
64
+ });
65
+ const path = options.slug
66
+ ? `${instancePath(type, id)}/slug/${encodeURIComponent(options.slug)}`
67
+ : instancePath(type, id);
68
+ return this.client.json(path, FileInfoSchema, {
69
+ method: options.slug ? "PUT" : "POST",
70
+ body,
71
+ streaming,
72
+ headers: {
73
+ "content-type": contentType,
74
+ [ENCRYPTION_HEADER]: options.encryption,
75
+ },
76
+ signal: options.signal,
77
+ unlock: options.unlock,
78
+ contentKey: options.contentKey,
79
+ });
80
+ }
81
+ /** `PUT /files/:type/:id/slug/:slug`: `upload()` as an upsert under `slug`. */
82
+ putSlug(type, id, slug, source, options = {}) {
83
+ return this.upload(type, id, source, { ...options, slug });
84
+ }
85
+ async fetchFile(path, method, options) {
86
+ return this.client.request(path, {
87
+ method,
88
+ query: { [FORCE_DOWNLOAD_QUERY]: options.download },
89
+ headers: {
90
+ range: options.range === undefined ? undefined : rangeHeader(options.range),
91
+ "if-none-match": options.ifNoneMatch,
92
+ },
93
+ ok: (status) => ok2xx(status) || status === 304,
94
+ signal: options.signal,
95
+ unlock: options.unlock,
96
+ contentKey: options.contentKey,
97
+ });
98
+ }
99
+ /**
100
+ * `GET /files/:type/:id/:fileId`: the bytes as a streaming `Response` (`200`, or `206` for a
101
+ * `range`, `304` for a matching `ifNoneMatch`) — read `response.body`, `.blob()`,
102
+ * `.arrayBuffer()` as needed. Headers: `ETag`, `Content-Disposition`, `Content-Range`,
103
+ * `X-Vola-Encryption` for an encrypted file.
104
+ */
105
+ download(type, id, fileId, options = {}) {
106
+ return this.fetchFile(filePath(type, id, fileId), "GET", options);
107
+ }
108
+ /** `HEAD /files/:type/:id/:fileId`: the headers of a download without the body. */
109
+ head(type, id, fileId, options = {}) {
110
+ return this.fetchFile(filePath(type, id, fileId), "HEAD", options);
111
+ }
112
+ /** `GET /files/:type/:id/path/*`: the newest live file of that name in that folder (`docs/q4/report.pdf`). */
113
+ byPath(type, id, path, options = {}) {
114
+ return this.fetchFile(`${instancePath(type, id)}/path/${encodePath(path)}`, "GET", options);
115
+ }
116
+ /** `GET /files/:type/:id/slug/:slug`: the live file under `slug`. */
117
+ bySlug(type, id, slug, options = {}) {
118
+ return this.fetchFile(`${instancePath(type, id)}/slug/${encodeURIComponent(slug)}`, "GET", options);
119
+ }
120
+ /** `GET /public/:fileId`: an `is_global_public` file, no key needed. */
121
+ public(fileId, options = {}) {
122
+ return this.client.request(`/public/${encodeURIComponent(fileId)}`, {
123
+ anonymous: true,
124
+ query: { [FORCE_DOWNLOAD_QUERY]: options.download },
125
+ headers: {
126
+ range: options.range === undefined ? undefined : rangeHeader(options.range),
127
+ "if-none-match": options.ifNoneMatch,
128
+ },
129
+ ok: (status) => ok2xx(status) || status === 304,
130
+ signal: options.signal,
131
+ });
132
+ }
133
+ /** The URL of a download — WITHOUT credentials: for a `<a href>` behind a proxy or cookie auth, or for `fetch` with `client.headers()`. */
134
+ downloadUrl(type, id, fileId, options = {}) {
135
+ return this.client.url(filePath(type, id, fileId), {
136
+ [FORCE_DOWNLOAD_QUERY]: options.download,
137
+ });
138
+ }
139
+ /** The URL of `GET /public/:fileId` (anonymous: usable as an `<img src>` for an `is_global_public` file). */
140
+ publicUrl(fileId) {
141
+ return this.client.url(`/public/${encodeURIComponent(fileId)}`);
142
+ }
143
+ /** `GET …/:fileId/info`: the metadata (never the bytes) with the aggregate processing status and the `ocr` block. */
144
+ info(type, id, fileId, options = {}) {
145
+ return this.client.json(`${filePath(type, id, fileId)}/info`, FileDetailSchema, {
146
+ query: {
147
+ include_deleted: options.includeDeleted,
148
+ [OCR_QUERY]: options.ocr === "full" ? OCR_QUERY_FULL : undefined,
149
+ },
150
+ signal: options.signal,
151
+ unlock: options.unlock,
152
+ contentKey: options.contentKey,
153
+ });
154
+ }
155
+ /** `GET /files/:type/:id`: the instance's files, newest first, one page (`next_cursor` feeds `cursor`). */
156
+ list(type, id, options = {}) {
157
+ return this.client.json(instancePath(type, id), FileListSchema, {
158
+ query: {
159
+ cursor: options.cursor,
160
+ limit: options.limit,
161
+ include_deleted: options.includeDeleted,
162
+ },
163
+ signal: options.signal,
164
+ unlock: options.unlock,
165
+ });
166
+ }
167
+ /** Every file of the instance, page after page. */
168
+ async *iterate(type, id, options = {}) {
169
+ let cursor = options.cursor ?? null;
170
+ do {
171
+ const page = await this.list(type, id, { ...options, cursor });
172
+ for (const file of page.files)
173
+ yield file;
174
+ cursor = page.next_cursor;
175
+ } while (cursor);
176
+ }
177
+ /** `GET …/:fileId/versions`: the whole version chain, newest first. */
178
+ versions(type, id, fileId, options = {}) {
179
+ return this.client.json(`${filePath(type, id, fileId)}/versions`, FileVersionsSchema, {
180
+ query: { include_deleted: options.includeDeleted },
181
+ signal: options.signal,
182
+ unlock: options.unlock,
183
+ });
184
+ }
185
+ /** `PATCH …/:fileId`: move (`folder_path`), rename (`filename`), visibility (`is_public`, `is_global_public`). */
186
+ patch(type, id, fileId, patch, options = {}) {
187
+ return this.client.json(filePath(type, id, fileId), FileInfoSchema, {
188
+ method: "PATCH",
189
+ json: patch,
190
+ ...options,
191
+ });
192
+ }
193
+ /** `DELETE …/:fileId`: soft delete (the bytes stay; `purge` removes them). Idempotent. */
194
+ delete(type, id, fileId, options = {}) {
195
+ return this.client.json(filePath(type, id, fileId), FileInfoSchema, {
196
+ method: "DELETE",
197
+ ...options,
198
+ });
199
+ }
200
+ /** `DELETE …/:fileId/purge`: the row, its version chain, and every blob nothing references any more. */
201
+ purge(type, id, fileId, options = {}) {
202
+ return this.client.json(`${filePath(type, id, fileId)}/purge`, PurgeResultSchema, {
203
+ method: "DELETE",
204
+ ...options,
205
+ });
206
+ }
207
+ /** `…/:fileId/thumb/:size[?crop=]` as a URL — WITHOUT credentials (see `downloadUrl`). */
208
+ thumbUrl(type, id, fileId, size, options = {}) {
209
+ return this.client.url(`${filePath(type, id, fileId)}/thumb/${size}`, {
210
+ [THUMBNAIL_CROP_QUERY]: options.crop,
211
+ });
212
+ }
213
+ /**
214
+ * `GET …/:fileId/thumb/:size?crop=`: `{status: "ready", blob}` for the WebP, `{status:
215
+ * "generating"}` while the worker renders it (a `202` — retry later, never cache),
216
+ * `{status: "failed"}` when the file could not be rendered. `404 no_thumbnail` throws: the
217
+ * file has none by its nature.
218
+ */
219
+ async thumb(type, id, fileId, size, options = {}) {
220
+ const response = await this.client.request(`${filePath(type, id, fileId)}/thumb/${size}`, {
221
+ query: { [THUMBNAIL_CROP_QUERY]: options.crop },
222
+ headers: { "if-none-match": options.ifNoneMatch },
223
+ ok: (status) => ok2xx(status) || status === 304,
224
+ signal: options.signal,
225
+ unlock: options.unlock,
226
+ contentKey: options.contentKey,
227
+ });
228
+ const etag = response.headers.get("etag");
229
+ if (response.status === 304)
230
+ return { status: "not_modified", etag, response };
231
+ const state = response.headers.get(THUMBNAIL_STATUS_HEADER);
232
+ if (response.status === 202 || state === "generating")
233
+ return { status: "generating", response };
234
+ if (state === "failed")
235
+ return { status: "failed", response };
236
+ return { status: "ready", blob: await response.blob(), etag, response };
237
+ }
238
+ }
239
+ //# sourceMappingURL=files.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"files.js","sourceRoot":"","sources":["../src/files.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EAEjB,gBAAgB,EAGhB,cAAc,EAEd,cAAc,EAId,kBAAkB,EAClB,oBAAoB,EACpB,SAAS,EACT,cAAc,EAEd,iBAAiB,EACjB,oBAAoB,EACpB,uBAAuB,EAGvB,iBAAiB,EACjB,sBAAsB,EACtB,wBAAwB,EACxB,qBAAqB,EACrB,sBAAsB,GACvB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,EAAqB,MAAM,WAAW,CAAC;AAE7E,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAKxC,MAAM,UAAU,WAAW,CAAC,KAAgB;IAC1C,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC5C,IAAI,QAAQ,IAAI,KAAK;QAAE,OAAO,UAAU,KAAK,CAAC,MAAM,EAAE,CAAC;IACvD,OAAO,SAAS,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC;AACnD,CAAC;AAkED,0BAA0B;AAC1B,MAAM,UAAU,YAAY,CAAC,IAAY,EAAE,EAAU;IACnD,OAAO,UAAU,kBAAkB,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,EAAE,CAAC,EAAE,CAAC;AACxE,CAAC;AAED,kCAAkC;AAClC,MAAM,UAAU,QAAQ,CAAC,IAAY,EAAE,EAAU,EAAE,MAAc;IAC/D,OAAO,GAAG,YAAY,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC;AACnE,CAAC;AAED,0FAA0F;AAC1F,MAAM,OAAO,QAAQ;IACU;IAA7B,YAA6B,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;IAAG,CAAC;IAEnD;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,IAAY,EACZ,EAAU,EACV,MAAoB,EACpB,UAAyB,EAAE;QAE3B,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC;QACpD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,SAAS,CAAC;gBAClB,MAAM,EAAE,CAAC;gBACT,IAAI,EAAE,aAAa;gBACnB,OAAO,EAAE,4DAA4D;aACtE,CAAC,CAAC;QACL,CAAC;QACD,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACvE,MAAM,IAAI,SAAS,CAAC;gBAClB,MAAM,EAAE,CAAC;gBACT,IAAI,EAAE,aAAa;gBACnB,OAAO,EAAE,oDAAoD;aAC9D,CAAC,CAAC;QACL,CAAC;QACD,MAAM,MAAM,GAAuB,EAAE,CAAC;QACtC,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS;YAClC,MAAM,CAAC,IAAI,CAAC,CAAC,wBAAwB,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;QAC9D,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS;YAChC,MAAM,CAAC,IAAI,CAAC,CAAC,sBAAsB,EAAE,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,CAAC;QAChE,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS;YAAE,MAAM,CAAC,IAAI,CAAC,CAAC,sBAAsB,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC5F,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACnC,MAAM,CAAC,IAAI,CAAC,CAAC,qBAAqB,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QACzE,CAAC;QACD,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,GAAG,aAAa,CAAC,MAAM,EAAE;YAC7D,KAAK,EAAE,iBAAiB;YACxB,QAAQ;YACR,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,0BAA0B;YAChF,MAAM;SACP,CAAC,CAAC;QACH,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI;YACvB,CAAC,CAAC,GAAG,YAAY,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,kBAAkB,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACtE,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,EAAE;YAC5C,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM;YACrC,IAAI;YACJ,SAAS;YACT,OAAO,EAAE;gBACP,cAAc,EAAE,WAAW;gBAC3B,CAAC,iBAAiB,CAAC,EAAE,OAAO,CAAC,UAAU;aACxC;YACD,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,UAAU,EAAE,OAAO,CAAC,UAAU;SAC/B,CAAC,CAAC;IACL,CAAC;IAED,+EAA+E;IAC/E,OAAO,CACL,IAAY,EACZ,EAAU,EACV,IAAY,EACZ,MAAoB,EACpB,UAAuC,EAAE;QAEzC,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7D,CAAC;IAEO,KAAK,CAAC,SAAS,CACrB,IAAY,EACZ,MAAsB,EACtB,OAAwB;QAExB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE;YAC/B,MAAM;YACN,KAAK,EAAE,EAAE,CAAC,oBAAoB,CAAC,EAAE,OAAO,CAAC,QAAQ,EAAE;YACnD,OAAO,EAAE;gBACP,KAAK,EAAE,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC;gBAC3E,eAAe,EAAE,OAAO,CAAC,WAAW;aACrC;YACD,EAAE,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,MAAM,KAAK,GAAG;YAC/C,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,UAAU,EAAE,OAAO,CAAC,UAAU;SAC/B,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CACN,IAAY,EACZ,EAAU,EACV,MAAc,EACd,UAA2B,EAAE;QAE7B,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED,mFAAmF;IACnF,IAAI,CAAC,IAAY,EAAE,EAAU,EAAE,MAAc,EAAE,UAA2B,EAAE;QAC1E,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED,8GAA8G;IAC9G,MAAM,CAAC,IAAY,EAAE,EAAU,EAAE,IAAY,EAAE,UAA2B,EAAE;QAC1E,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,YAAY,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAC9F,CAAC;IAED,qEAAqE;IACrE,MAAM,CAAC,IAAY,EAAE,EAAU,EAAE,IAAY,EAAE,UAA2B,EAAE;QAC1E,OAAO,IAAI,CAAC,SAAS,CACnB,GAAG,YAAY,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,kBAAkB,CAAC,IAAI,CAAC,EAAE,EAC5D,KAAK,EACL,OAAO,CACR,CAAC;IACJ,CAAC;IAED,wEAAwE;IACxE,MAAM,CACJ,MAAc,EACd,UAA0D,EAAE;QAE5D,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,kBAAkB,CAAC,MAAM,CAAC,EAAE,EAAE;YAClE,SAAS,EAAE,IAAI;YACf,KAAK,EAAE,EAAE,CAAC,oBAAoB,CAAC,EAAE,OAAO,CAAC,QAAQ,EAAE;YACnD,OAAO,EAAE;gBACP,KAAK,EAAE,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC;gBAC3E,eAAe,EAAE,OAAO,CAAC,WAAW;aACrC;YACD,EAAE,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,MAAM,KAAK,GAAG;YAC/C,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC,CAAC;IACL,CAAC;IAED,2IAA2I;IAC3I,WAAW,CACT,IAAY,EACZ,EAAU,EACV,MAAc,EACd,UAA8C,EAAE;QAEhD,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE;YACjD,CAAC,oBAAoB,CAAC,EAAE,OAAO,CAAC,QAAQ;SACzC,CAAC,CAAC;IACL,CAAC;IAED,6GAA6G;IAC7G,SAAS,CAAC,MAAc;QACtB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,qHAAqH;IACrH,IAAI,CAAC,IAAY,EAAE,EAAU,EAAE,MAAc,EAAE,UAAuB,EAAE;QACtE,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,OAAO,EAAE,gBAAgB,EAAE;YAC9E,KAAK,EAAE;gBACL,eAAe,EAAE,OAAO,CAAC,cAAc;gBACvC,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,GAAG,KAAK,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS;aACjE;YACD,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,UAAU,EAAE,OAAO,CAAC,UAAU;SAC/B,CAAC,CAAC;IACL,CAAC;IAED,2GAA2G;IAC3G,IAAI,CAAC,IAAY,EAAE,EAAU,EAAE,UAAuB,EAAE;QACtD,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,cAAc,EAAE;YAC9D,KAAK,EAAE;gBACL,MAAM,EAAE,OAAO,CAAC,MAAM;gBACtB,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,eAAe,EAAE,OAAO,CAAC,cAAc;aACxC;YACD,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC,CAAC;IACL,CAAC;IAED,mDAAmD;IACnD,KAAK,CAAC,CAAC,OAAO,CAAC,IAAY,EAAE,EAAU,EAAE,UAAuB,EAAE;QAChE,IAAI,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC;QACpC,GAAG,CAAC;YACF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;YAC/D,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK;gBAAE,MAAM,IAAI,CAAC;YAC1C,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC;QAC5B,CAAC,QAAQ,MAAM,EAAE;IACnB,CAAC;IAED,uEAAuE;IACvE,QAAQ,CACN,IAAY,EACZ,EAAU,EACV,MAAc,EACd,UAA2B,EAAE;QAE7B,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,WAAW,EAAE,kBAAkB,EAAE;YACpF,KAAK,EAAE,EAAE,eAAe,EAAE,OAAO,CAAC,cAAc,EAAE;YAClD,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC,CAAC;IACL,CAAC;IAED,kHAAkH;IAClH,KAAK,CACH,IAAY,EACZ,EAAU,EACV,MAAc,EACd,KAAgB,EAChB,UAAuB,EAAE;QAEzB,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,cAAc,EAAE;YAClE,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,KAAK;YACX,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED,0FAA0F;IAC1F,MAAM,CAAC,IAAY,EAAE,EAAU,EAAE,MAAc,EAAE,UAAuB,EAAE;QACxE,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,cAAc,EAAE;YAClE,MAAM,EAAE,QAAQ;YAChB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED,wGAAwG;IACxG,KAAK,CAAC,IAAY,EAAE,EAAU,EAAE,MAAc,EAAE,UAAuB,EAAE;QACvE,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE;YAChF,MAAM,EAAE,QAAQ;YAChB,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED,0FAA0F;IAC1F,QAAQ,CACN,IAAY,EACZ,EAAU,EACV,MAAc,EACd,IAAmB,EACnB,UAAgD,EAAE;QAElD,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,UAAU,IAAI,EAAE,EAAE;YACpE,CAAC,oBAAoB,CAAC,EAAE,OAAO,CAAC,IAAI;SACrC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CACT,IAAY,EACZ,EAAU,EACV,MAAc,EACd,IAAmB,EACnB,UAA4B,EAAE;QAE9B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,UAAU,IAAI,EAAE,EAAE;YACxF,KAAK,EAAE,EAAE,CAAC,oBAAoB,CAAC,EAAE,OAAO,CAAC,IAAI,EAAE;YAC/C,OAAO,EAAE,EAAE,eAAe,EAAE,OAAO,CAAC,WAAW,EAAE;YACjD,EAAE,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,MAAM,KAAK,GAAG;YAC/C,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,UAAU,EAAE,OAAO,CAAC,UAAU;SAC/B,CAAC,CAAC;QACH,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG;YAAE,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;QAC/E,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;QAC5D,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,KAAK,KAAK,YAAY;YACnD,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC;QAC5C,IAAI,KAAK,KAAK,QAAQ;YAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;QAC9D,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;IAC1E,CAAC;CACF"}
@@ -0,0 +1,35 @@
1
+ import { type FolderDeleteResult, type FolderInfo, type FolderListing, type FolderPatch } from "@vol-a/core";
2
+ import type { CallOptions, VolaClient } from "./client.js";
3
+ import { instancePath } from "./files.js";
4
+ export interface FolderDeleteOptions extends CallOptions {
5
+ /** Delete a non-empty folder with everything in it (`409 folder_not_empty` otherwise). */
6
+ recursive?: boolean | undefined;
7
+ }
8
+ /** `/folders/:type/:id[/a/b/c]`. */
9
+ export declare function folderPath(type: string, id: string, path: string): string;
10
+ /** The virtual folders of an instance. Paths are `a/b/c` (`""` is the root). */
11
+ export declare class FoldersApi {
12
+ private readonly client;
13
+ constructor(client: VolaClient);
14
+ /** `POST /folders/:type/:id/*path`: the folder and every missing parent (`201` new, `200` existing). */
15
+ create(type: string, id: string, path: string, options?: CallOptions): Promise<FolderInfo>;
16
+ /** `GET /folders/:type/:id/*path`: one level — the folder (`null` for the root), its subfolders, its live files. */
17
+ list(type: string, id: string, path?: string, options?: CallOptions): Promise<FolderListing>;
18
+ /** `PATCH /folders/:type/:id/*path` with any combination of `name`, `parent_path`, `default_keyring`. */
19
+ patch(type: string, id: string, path: string, patch: FolderPatch, options?: CallOptions): Promise<FolderInfo>;
20
+ /** Renames the folder (its descendants follow). */
21
+ rename(type: string, id: string, path: string, name: string, options?: CallOptions): Promise<FolderInfo>;
22
+ /** Moves the folder under `parentPath` (`""`: the root, created when missing). */
23
+ move(type: string, id: string, path: string, parentPath: string, options?: CallOptions): Promise<FolderInfo>;
24
+ /**
25
+ * The folder's encryption policy: `"me"` — every new upload into it (or below) is encrypted
26
+ * under the keyring of the instance's `userId` (an unlock token is then required to upload);
27
+ * `null` — no policy of its own.
28
+ */
29
+ setDefaultKeyring(type: string, id: string, path: string, keyring: "me" | null, options?: CallOptions): Promise<FolderInfo>;
30
+ /** `DELETE /folders/:type/:id/*path[?recursive=1]`: soft delete. */
31
+ delete(type: string, id: string, path: string, options?: FolderDeleteOptions): Promise<FolderDeleteResult>;
32
+ }
33
+ /** Re-exported for symmetry with `filePath`. */
34
+ export { instancePath };
35
+ //# sourceMappingURL=folders.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"folders.d.ts","sourceRoot":"","sources":["../src/folders.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,kBAAkB,EAEvB,KAAK,UAAU,EAEf,KAAK,aAAa,EAElB,KAAK,WAAW,EAEjB,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE3D,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACtD,0FAA0F;IAC1F,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACjC;AAED,oCAAoC;AACpC,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAGzE;AAED,gFAAgF;AAChF,qBAAa,UAAU;IACT,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAN,MAAM,EAAE,UAAU;IAE/C,wGAAwG;IACxG,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,UAAU,CAAC;IAO9F,oHAAoH;IACpH,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,SAAK,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,aAAa,CAAC;IAI5F,yGAAyG;IACzG,KAAK,CACH,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,WAAW,EAClB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,UAAU,CAAC;IAQtB,mDAAmD;IACnD,MAAM,CACJ,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,UAAU,CAAC;IAItB,kFAAkF;IAClF,IAAI,CACF,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,EAClB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,UAAU,CAAC;IAItB;;;;OAIG;IACH,iBAAiB,CACf,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,IAAI,GAAG,IAAI,EACpB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,UAAU,CAAC;IAItB,oEAAoE;IACpE,MAAM,CACJ,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,mBAAwB,GAChC,OAAO,CAAC,kBAAkB,CAAC;CAQ/B;AAED,gDAAgD;AAChD,OAAO,EAAE,YAAY,EAAE,CAAC"}
@@ -0,0 +1,62 @@
1
+ import { FolderDeleteResultSchema, FolderInfoSchema, FolderListingSchema, RECURSIVE_QUERY, } from "@vol-a/core";
2
+ import { encodePath } from "./env.js";
3
+ import { instancePath } from "./files.js";
4
+ /** `/folders/:type/:id[/a/b/c]`. */
5
+ export function folderPath(type, id, path) {
6
+ const encoded = encodePath(path);
7
+ return `/folders/${encodeURIComponent(type)}/${encodeURIComponent(id)}${encoded ? `/${encoded}` : ""}`;
8
+ }
9
+ /** The virtual folders of an instance. Paths are `a/b/c` (`""` is the root). */
10
+ export class FoldersApi {
11
+ client;
12
+ constructor(client) {
13
+ this.client = client;
14
+ }
15
+ /** `POST /folders/:type/:id/*path`: the folder and every missing parent (`201` new, `200` existing). */
16
+ create(type, id, path, options = {}) {
17
+ return this.client.json(folderPath(type, id, path), FolderInfoSchema, {
18
+ method: "POST",
19
+ ...options,
20
+ });
21
+ }
22
+ /** `GET /folders/:type/:id/*path`: one level — the folder (`null` for the root), its subfolders, its live files. */
23
+ list(type, id, path = "", options = {}) {
24
+ return this.client.json(folderPath(type, id, path), FolderListingSchema, options);
25
+ }
26
+ /** `PATCH /folders/:type/:id/*path` with any combination of `name`, `parent_path`, `default_keyring`. */
27
+ patch(type, id, path, patch, options = {}) {
28
+ return this.client.json(folderPath(type, id, path), FolderInfoSchema, {
29
+ method: "PATCH",
30
+ json: patch,
31
+ ...options,
32
+ });
33
+ }
34
+ /** Renames the folder (its descendants follow). */
35
+ rename(type, id, path, name, options = {}) {
36
+ return this.patch(type, id, path, { name }, options);
37
+ }
38
+ /** Moves the folder under `parentPath` (`""`: the root, created when missing). */
39
+ move(type, id, path, parentPath, options = {}) {
40
+ return this.patch(type, id, path, { parent_path: parentPath }, options);
41
+ }
42
+ /**
43
+ * The folder's encryption policy: `"me"` — every new upload into it (or below) is encrypted
44
+ * under the keyring of the instance's `userId` (an unlock token is then required to upload);
45
+ * `null` — no policy of its own.
46
+ */
47
+ setDefaultKeyring(type, id, path, keyring, options = {}) {
48
+ return this.patch(type, id, path, { default_keyring: keyring }, options);
49
+ }
50
+ /** `DELETE /folders/:type/:id/*path[?recursive=1]`: soft delete. */
51
+ delete(type, id, path, options = {}) {
52
+ return this.client.json(folderPath(type, id, path), FolderDeleteResultSchema, {
53
+ method: "DELETE",
54
+ query: { [RECURSIVE_QUERY]: options.recursive },
55
+ signal: options.signal,
56
+ unlock: options.unlock,
57
+ });
58
+ }
59
+ }
60
+ /** Re-exported for symmetry with `filePath`. */
61
+ export { instancePath };
62
+ //# sourceMappingURL=folders.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"folders.js","sourceRoot":"","sources":["../src/folders.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,wBAAwB,EAExB,gBAAgB,EAEhB,mBAAmB,EAEnB,eAAe,GAChB,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAO1C,oCAAoC;AACpC,MAAM,UAAU,UAAU,CAAC,IAAY,EAAE,EAAU,EAAE,IAAY;IAC/D,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;IACjC,OAAO,YAAY,kBAAkB,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;AACzG,CAAC;AAED,gFAAgF;AAChF,MAAM,OAAO,UAAU;IACQ;IAA7B,YAA6B,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;IAAG,CAAC;IAEnD,wGAAwG;IACxG,MAAM,CAAC,IAAY,EAAE,EAAU,EAAE,IAAY,EAAE,UAAuB,EAAE;QACtE,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,gBAAgB,EAAE;YACpE,MAAM,EAAE,MAAM;YACd,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED,oHAAoH;IACpH,IAAI,CAAC,IAAY,EAAE,EAAU,EAAE,IAAI,GAAG,EAAE,EAAE,UAAuB,EAAE;QACjE,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;IAED,yGAAyG;IACzG,KAAK,CACH,IAAY,EACZ,EAAU,EACV,IAAY,EACZ,KAAkB,EAClB,UAAuB,EAAE;QAEzB,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,gBAAgB,EAAE;YACpE,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,KAAK;YACX,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED,mDAAmD;IACnD,MAAM,CACJ,IAAY,EACZ,EAAU,EACV,IAAY,EACZ,IAAY,EACZ,UAAuB,EAAE;QAEzB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED,kFAAkF;IAClF,IAAI,CACF,IAAY,EACZ,EAAU,EACV,IAAY,EACZ,UAAkB,EAClB,UAAuB,EAAE;QAEzB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CACf,IAAY,EACZ,EAAU,EACV,IAAY,EACZ,OAAoB,EACpB,UAAuB,EAAE;QAEzB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,eAAe,EAAE,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;IAED,oEAAoE;IACpE,MAAM,CACJ,IAAY,EACZ,EAAU,EACV,IAAY,EACZ,UAA+B,EAAE;QAEjC,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,wBAAwB,EAAE;YAC5E,MAAM,EAAE,QAAQ;YAChB,KAAK,EAAE,EAAE,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC,SAAS,EAAE;YAC/C,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC,CAAC;IACL,CAAC;CACF;AAED,gDAAgD;AAChD,OAAO,EAAE,YAAY,EAAE,CAAC"}
@@ -0,0 +1,20 @@
1
+ export type { ByteSource, MultipartBody, MultipartFile, StreamSource, UploadSource, } from "./body.js";
2
+ export { multipartBody } from "./body.js";
3
+ export type { CallOptions, ContentKey, LockOnUnloadOptions, QueryValue, RequestOptions, ResponseSchema, VolaClientOptions, } from "./client.js";
4
+ export { ok2xx, VolaClient } from "./client.js";
5
+ export { base64ToBytes, bytesToBase64, bytesToBase64Url, isBrowser, randomBytes } from "./env.js";
6
+ export type { VolaErrorInit } from "./errors.js";
7
+ export { errorFromResponse, VolaApiError, VolaError, VolaIntegrityError, VolaLockedError, } from "./errors.js";
8
+ export type { ByteRange, DownloadOptions, InfoOptions, ListOptions, ThumbnailOptions, ThumbnailResult, UploadOptions, UploadPlacement, VersionsOptions, } from "./files.js";
9
+ export { FilesApi, filePath, instancePath, rangeHeader } from "./files.js";
10
+ export type { FolderDeleteOptions } from "./folders.js";
11
+ export { FoldersApi, folderPath } from "./folders.js";
12
+ export type { UnlockOptions } from "./keyrings.js";
13
+ export { KeyringsApi } from "./keyrings.js";
14
+ export type { StatsOptions, TransferInput } from "./management.js";
15
+ export { AdminApi, KeysApi, StatsApi } from "./management.js";
16
+ export type { CallerGrant, OpenShareOptions, ShareCreateInput, ShareListOptions, } from "./shares.js";
17
+ export { callerGrant, openShareUrl, parseShareUrl, SharesApi } from "./shares.js";
18
+ export type { FingerprintStore, ResumableCreate, ResumableOptions, ResumableResult, UploadProgress, UploadProtocol, UploadState, } from "./uploads.js";
19
+ export { DEFAULT_CHUNK_SIZE, defaultFingerprintStore, MemoryFingerprintStore, storageFingerprintStore, UploadsApi, } from "./uploads.js";
20
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,UAAU,EACV,aAAa,EACb,aAAa,EACb,YAAY,EACZ,YAAY,GACb,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,YAAY,EACV,WAAW,EACX,UAAU,EACV,mBAAmB,EACnB,UAAU,EACV,cAAc,EACd,cAAc,EACd,iBAAiB,GAClB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,gBAAgB,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAClG,YAAY,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EACL,iBAAiB,EACjB,YAAY,EACZ,SAAS,EACT,kBAAkB,EAClB,eAAe,GAChB,MAAM,aAAa,CAAC;AACrB,YAAY,EACV,SAAS,EACT,eAAe,EACf,WAAW,EACX,WAAW,EACX,gBAAgB,EAChB,eAAe,EACf,aAAa,EACb,eAAe,EACf,eAAe,GAChB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAC3E,YAAY,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AACtD,YAAY,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC9D,YAAY,EACV,WAAW,EACX,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,GACjB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAClF,YAAY,EACV,gBAAgB,EAChB,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,cAAc,EACd,cAAc,EACd,WAAW,GACZ,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,kBAAkB,EAClB,uBAAuB,EACvB,sBAAsB,EACtB,uBAAuB,EACvB,UAAU,GACX,MAAM,cAAc,CAAC"}
package/dist/index.js ADDED
@@ -0,0 +1,11 @@
1
+ export { multipartBody } from "./body.js";
2
+ export { ok2xx, VolaClient } from "./client.js";
3
+ export { base64ToBytes, bytesToBase64, bytesToBase64Url, isBrowser, randomBytes } from "./env.js";
4
+ export { errorFromResponse, VolaApiError, VolaError, VolaIntegrityError, VolaLockedError, } from "./errors.js";
5
+ export { FilesApi, filePath, instancePath, rangeHeader } from "./files.js";
6
+ export { FoldersApi, folderPath } from "./folders.js";
7
+ export { KeyringsApi } from "./keyrings.js";
8
+ export { AdminApi, KeysApi, StatsApi } from "./management.js";
9
+ export { callerGrant, openShareUrl, parseShareUrl, SharesApi } from "./shares.js";
10
+ export { DEFAULT_CHUNK_SIZE, defaultFingerprintStore, MemoryFingerprintStore, storageFingerprintStore, UploadsApi, } from "./uploads.js";
11
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAU1C,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,gBAAgB,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAElG,OAAO,EACL,iBAAiB,EACjB,YAAY,EACZ,SAAS,EACT,kBAAkB,EAClB,eAAe,GAChB,MAAM,aAAa,CAAC;AAYrB,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE3E,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAEtD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAO9D,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAUlF,OAAO,EACL,kBAAkB,EAClB,uBAAuB,EACvB,sBAAsB,EACtB,uBAAuB,EACvB,UAAU,GACX,MAAM,cAAc,CAAC"}
@@ -0,0 +1,44 @@
1
+ import { type KeyringCreated, type KeyringDeletePreview, type KeyringResetResult, type KeyringStatus, type Recovered, type Unlocked } from "@vol-a/core";
2
+ import type { CallOptions, VolaClient } from "./client.js";
3
+ export interface UnlockOptions extends CallOptions {
4
+ /** Keep the token in the instance (every later call sends it). Default `true`. */
5
+ remember?: boolean | undefined;
6
+ }
7
+ /**
8
+ * The keyring of the instance's `userId` (`/keyrings/me`, scope `keyrings:write`): a PIN
9
+ * that locks the keys of that principal's `keyring`-encrypted files. An unlock is a token
10
+ * the instance keeps in memory and sends as `X-Vola-Unlock` until `lock()`, `changePin()`,
11
+ * `recover()` or `reset()` — or the server's sliding TTL — ends it. The PIN, the recovery
12
+ * key and the token go in request bodies and headers, never in a URL.
13
+ */
14
+ export declare class KeyringsApi {
15
+ private readonly client;
16
+ constructor(client: VolaClient);
17
+ /** `GET /keyrings/me/status`: has a PIN, locked, the token's remaining seconds, a lock-out. Does not extend the token. */
18
+ status(options?: CallOptions): Promise<KeyringStatus>;
19
+ /** `POST /keyrings/me {pin}` → `201 {keyring_id, recovery_key}`: the recovery key is shown this once — store it with the user. */
20
+ setup(pin: string, options?: CallOptions): Promise<KeyringCreated>;
21
+ /** `PUT /keyrings/me/pin {current_pin, new_pin}`: every token of the principal dies, this instance's too. */
22
+ changePin(currentPin: string, newPin: string, options?: CallOptions): Promise<void>;
23
+ /** `POST /keyrings/me/recover {recovery_key, new_pin}` → a NEW recovery key (the old one is retired). */
24
+ recover(recoveryKey: string, newPin: string, options?: CallOptions): Promise<Recovered>;
25
+ /**
26
+ * `POST /keyrings/me/unlock {pin}` → `{token, expires_in}`; the instance keeps the token
27
+ * (`remember: false` leaves that to the caller). `403 pin_wrong` (with `attempts` in
28
+ * `details`), `429 too_many_attempts` with `retryAfter` while locked out — even for the right PIN.
29
+ */
30
+ unlock(pin: string, options?: UnlockOptions): Promise<Unlocked>;
31
+ /** `DELETE /keyrings/me/unlock`: ends the token the instance holds (or `options.unlock`) and forgets it. Idempotent; nothing held → nothing sent. */
32
+ lock(options?: CallOptions): Promise<void>;
33
+ /** `POST /keyrings/me/unlock/close {token}`: the beacon alias — ends `token` without an API key (what `lockOnUnload` sends). */
34
+ close(token: string, options?: Pick<CallOptions, "signal">): Promise<void>;
35
+ /** `POST /keyrings/me/reset {confirm: "RESET"}`: the crypto-shred of every file under the keyring and of the keyring. Re-authenticate the person first. */
36
+ reset(options?: CallOptions): Promise<KeyringResetResult>;
37
+ /** `GET /keyrings/me/delete-preview`: what a reset would remove. */
38
+ deletePreview(options?: CallOptions): Promise<KeyringDeletePreview>;
39
+ /** Admin: `GET /keyrings/by-principal/:principal/status`. */
40
+ statusOf(principal: string, options?: CallOptions): Promise<KeyringStatus>;
41
+ /** Admin: `POST /keyrings/by-principal/:principal/reset`. */
42
+ resetOf(principal: string, options?: CallOptions): Promise<KeyringResetResult>;
43
+ }
44
+ //# sourceMappingURL=keyrings.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"keyrings.d.ts","sourceRoot":"","sources":["../src/keyrings.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,cAAc,EAEnB,KAAK,oBAAoB,EAEzB,KAAK,kBAAkB,EAEvB,KAAK,aAAa,EAGlB,KAAK,SAAS,EAEd,KAAK,QAAQ,EAEd,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE3D,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD,kFAAkF;IAClF,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAChC;AAED;;;;;;GAMG;AACH,qBAAa,WAAW;IACV,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAN,MAAM,EAAE,UAAU;IAE/C,0HAA0H;IAC1H,MAAM,CAAC,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,aAAa,CAAC;IAIzD,kIAAkI;IAClI,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,cAAc,CAAC;IAQtE,6GAA6G;IACvG,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAU7F,yGAAyG;IACnG,OAAO,CACX,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,SAAS,CAAC;IAUrB;;;;OAIG;IACG,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAWzE,qJAAqJ;IAC/I,IAAI,CAAC,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAapD,gIAAgI;IAC1H,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAUpF,2JAA2J;IACrJ,KAAK,CAAC,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAUnE,oEAAoE;IACpE,aAAa,CAAC,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAIvE,6DAA6D;IAC7D,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,aAAa,CAAC;IAQ9E,6DAA6D;IAC7D,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAOnF"}
@@ -0,0 +1,111 @@
1
+ import { KeyringCreatedSchema, KeyringDeletePreviewSchema, KeyringResetResultSchema, KeyringStatusSchema, RESET_CONFIRMATION, RecoveredSchema, UnlockedSchema, } from "@vol-a/core";
2
+ /**
3
+ * The keyring of the instance's `userId` (`/keyrings/me`, scope `keyrings:write`): a PIN
4
+ * that locks the keys of that principal's `keyring`-encrypted files. An unlock is a token
5
+ * the instance keeps in memory and sends as `X-Vola-Unlock` until `lock()`, `changePin()`,
6
+ * `recover()` or `reset()` — or the server's sliding TTL — ends it. The PIN, the recovery
7
+ * key and the token go in request bodies and headers, never in a URL.
8
+ */
9
+ export class KeyringsApi {
10
+ client;
11
+ constructor(client) {
12
+ this.client = client;
13
+ }
14
+ /** `GET /keyrings/me/status`: has a PIN, locked, the token's remaining seconds, a lock-out. Does not extend the token. */
15
+ status(options = {}) {
16
+ return this.client.json("/keyrings/me/status", KeyringStatusSchema, options);
17
+ }
18
+ /** `POST /keyrings/me {pin}` → `201 {keyring_id, recovery_key}`: the recovery key is shown this once — store it with the user. */
19
+ setup(pin, options = {}) {
20
+ return this.client.json("/keyrings/me", KeyringCreatedSchema, {
21
+ method: "POST",
22
+ json: { pin },
23
+ ...options,
24
+ });
25
+ }
26
+ /** `PUT /keyrings/me/pin {current_pin, new_pin}`: every token of the principal dies, this instance's too. */
27
+ async changePin(currentPin, newPin, options = {}) {
28
+ const response = await this.client.request("/keyrings/me/pin", {
29
+ method: "PUT",
30
+ json: { current_pin: currentPin, new_pin: newPin },
31
+ ...options,
32
+ });
33
+ await response.body?.cancel().catch(() => undefined);
34
+ this.client.setUnlock(null);
35
+ }
36
+ /** `POST /keyrings/me/recover {recovery_key, new_pin}` → a NEW recovery key (the old one is retired). */
37
+ async recover(recoveryKey, newPin, options = {}) {
38
+ const recovered = await this.client.json("/keyrings/me/recover", RecoveredSchema, {
39
+ method: "POST",
40
+ json: { recovery_key: recoveryKey, new_pin: newPin },
41
+ ...options,
42
+ });
43
+ this.client.setUnlock(null);
44
+ return recovered;
45
+ }
46
+ /**
47
+ * `POST /keyrings/me/unlock {pin}` → `{token, expires_in}`; the instance keeps the token
48
+ * (`remember: false` leaves that to the caller). `403 pin_wrong` (with `attempts` in
49
+ * `details`), `429 too_many_attempts` with `retryAfter` while locked out — even for the right PIN.
50
+ */
51
+ async unlock(pin, options = {}) {
52
+ const { remember, ...call } = options;
53
+ const unlocked = await this.client.json("/keyrings/me/unlock", UnlockedSchema, {
54
+ method: "POST",
55
+ json: { pin },
56
+ ...call,
57
+ });
58
+ if (remember ?? true)
59
+ this.client.setUnlock(unlocked.token);
60
+ return unlocked;
61
+ }
62
+ /** `DELETE /keyrings/me/unlock`: ends the token the instance holds (or `options.unlock`) and forgets it. Idempotent; nothing held → nothing sent. */
63
+ async lock(options = {}) {
64
+ if (!options.unlock && !this.client.unlocked)
65
+ return;
66
+ try {
67
+ const response = await this.client.request("/keyrings/me/unlock", {
68
+ method: "DELETE",
69
+ ...options,
70
+ });
71
+ await response.body?.cancel().catch(() => undefined);
72
+ }
73
+ finally {
74
+ if (!options.unlock)
75
+ this.client.setUnlock(null);
76
+ }
77
+ }
78
+ /** `POST /keyrings/me/unlock/close {token}`: the beacon alias — ends `token` without an API key (what `lockOnUnload` sends). */
79
+ async close(token, options = {}) {
80
+ const response = await this.client.request("/keyrings/me/unlock/close", {
81
+ method: "POST",
82
+ anonymous: true,
83
+ json: { token },
84
+ signal: options.signal,
85
+ });
86
+ await response.body?.cancel().catch(() => undefined);
87
+ }
88
+ /** `POST /keyrings/me/reset {confirm: "RESET"}`: the crypto-shred of every file under the keyring and of the keyring. Re-authenticate the person first. */
89
+ async reset(options = {}) {
90
+ const result = await this.client.json("/keyrings/me/reset", KeyringResetResultSchema, {
91
+ method: "POST",
92
+ json: { confirm: RESET_CONFIRMATION },
93
+ ...options,
94
+ });
95
+ this.client.setUnlock(null);
96
+ return result;
97
+ }
98
+ /** `GET /keyrings/me/delete-preview`: what a reset would remove. */
99
+ deletePreview(options = {}) {
100
+ return this.client.json("/keyrings/me/delete-preview", KeyringDeletePreviewSchema, options);
101
+ }
102
+ /** Admin: `GET /keyrings/by-principal/:principal/status`. */
103
+ statusOf(principal, options = {}) {
104
+ return this.client.json(`/keyrings/by-principal/${encodeURIComponent(principal)}/status`, KeyringStatusSchema, options);
105
+ }
106
+ /** Admin: `POST /keyrings/by-principal/:principal/reset`. */
107
+ resetOf(principal, options = {}) {
108
+ return this.client.json(`/keyrings/by-principal/${encodeURIComponent(principal)}/reset`, KeyringResetResultSchema, { method: "POST", json: { confirm: RESET_CONFIRMATION }, ...options });
109
+ }
110
+ }
111
+ //# sourceMappingURL=keyrings.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"keyrings.js","sourceRoot":"","sources":["../src/keyrings.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,oBAAoB,EAEpB,0BAA0B,EAE1B,wBAAwB,EAExB,mBAAmB,EACnB,kBAAkB,EAElB,eAAe,EAEf,cAAc,GACf,MAAM,aAAa,CAAC;AAQrB;;;;;;GAMG;AACH,MAAM,OAAO,WAAW;IACO;IAA7B,YAA6B,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;IAAG,CAAC;IAEnD,0HAA0H;IAC1H,MAAM,CAAC,UAAuB,EAAE;QAC9B,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,qBAAqB,EAAE,mBAAmB,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED,kIAAkI;IAClI,KAAK,CAAC,GAAW,EAAE,UAAuB,EAAE;QAC1C,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,oBAAoB,EAAE;YAC5D,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,EAAE,GAAG,EAAE;YACb,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED,6GAA6G;IAC7G,KAAK,CAAC,SAAS,CAAC,UAAkB,EAAE,MAAc,EAAE,UAAuB,EAAE;QAC3E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,kBAAkB,EAAE;YAC7D,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE;YAClD,GAAG,OAAO;SACX,CAAC,CAAC;QACH,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED,yGAAyG;IACzG,KAAK,CAAC,OAAO,CACX,WAAmB,EACnB,MAAc,EACd,UAAuB,EAAE;QAEzB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,sBAAsB,EAAE,eAAe,EAAE;YAChF,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,EAAE,YAAY,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,EAAE;YACpD,GAAG,OAAO;SACX,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC5B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,GAAW,EAAE,UAAyB,EAAE;QACnD,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;QACtC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,qBAAqB,EAAE,cAAc,EAAE;YAC7E,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,EAAE,GAAG,EAAE;YACb,GAAG,IAAI;SACR,CAAC,CAAC;QACH,IAAI,QAAQ,IAAI,IAAI;YAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC5D,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,qJAAqJ;IACrJ,KAAK,CAAC,IAAI,CAAC,UAAuB,EAAE;QAClC,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ;YAAE,OAAO;QACrD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,qBAAqB,EAAE;gBAChE,MAAM,EAAE,QAAQ;gBAChB,GAAG,OAAO;aACX,CAAC,CAAC;YACH,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QACvD,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,OAAO,CAAC,MAAM;gBAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAED,gIAAgI;IAChI,KAAK,CAAC,KAAK,CAAC,KAAa,EAAE,UAAuC,EAAE;QAClE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,2BAA2B,EAAE;YACtE,MAAM,EAAE,MAAM;YACd,SAAS,EAAE,IAAI;YACf,IAAI,EAAE,EAAE,KAAK,EAAE;YACf,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC,CAAC;QACH,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IACvD,CAAC;IAED,2JAA2J;IAC3J,KAAK,CAAC,KAAK,CAAC,UAAuB,EAAE;QACnC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,oBAAoB,EAAE,wBAAwB,EAAE;YACpF,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE;YACrC,GAAG,OAAO;SACX,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC5B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,oEAAoE;IACpE,aAAa,CAAC,UAAuB,EAAE;QACrC,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,6BAA6B,EAAE,0BAA0B,EAAE,OAAO,CAAC,CAAC;IAC9F,CAAC;IAED,6DAA6D;IAC7D,QAAQ,CAAC,SAAiB,EAAE,UAAuB,EAAE;QACnD,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CACrB,0BAA0B,kBAAkB,CAAC,SAAS,CAAC,SAAS,EAChE,mBAAmB,EACnB,OAAO,CACR,CAAC;IACJ,CAAC;IAED,6DAA6D;IAC7D,OAAO,CAAC,SAAiB,EAAE,UAAuB,EAAE;QAClD,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CACrB,0BAA0B,kBAAkB,CAAC,SAAS,CAAC,QAAQ,EAC/D,wBAAwB,EACxB,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE,EAAE,GAAG,OAAO,EAAE,CACtE,CAAC;IACJ,CAAC;CACF"}
@@ -0,0 +1,47 @@
1
+ import { type ApiKey, type ApiKeyCreate, type ApiKeyCreated, type ApiKeyList, type StorageStats, type TenantStats, type TransferResult } from "@vol-a/core";
2
+ import type { CallOptions, VolaClient } from "./client.js";
3
+ export interface StatsOptions extends CallOptions {
4
+ /** Recompute the snapshot now instead of reading the cached one. */
5
+ recompute?: boolean | undefined;
6
+ }
7
+ /** `POST /admin/transfer` as a caller writes it (`user_map` and `dry_run` optional). */
8
+ export interface TransferInput {
9
+ from_tenant: string;
10
+ to_tenant: string;
11
+ instances: {
12
+ instance_type: string;
13
+ instance_id: string;
14
+ }[];
15
+ user_map?: Record<string, string> | undefined;
16
+ dry_run?: boolean | undefined;
17
+ }
18
+ /** Statistics (scope `files:read`). */
19
+ export declare class StatsApi {
20
+ private readonly client;
21
+ constructor(client: VolaClient);
22
+ /** `GET /stats/tenant[?recompute=1]`: the tenant's live files — count, bytes, per kind, oldest, newest. */
23
+ tenant(options?: StatsOptions): Promise<TenantStats>;
24
+ /** `GET /stats/instance/:type/:id[?recompute=1]`: the same for one instance. */
25
+ instance(type: string, id: string, options?: StatsOptions): Promise<TenantStats>;
26
+ /** `GET /stats/storage`: logical bytes and distinct blobs; an admin key also gets `physical` (and, without a tenant, the whole deployment). */
27
+ storage(options?: CallOptions): Promise<StorageStats>;
28
+ }
29
+ /** API keys of the tenant (scope `keys:write`). */
30
+ export declare class KeysApi {
31
+ private readonly client;
32
+ constructor(client: VolaClient);
33
+ /** `POST /keys {name, scopes, env, expires_at?}` → `201`: the key with its plaintext, this once. */
34
+ create(body: ApiKeyCreate, options?: CallOptions): Promise<ApiKeyCreated>;
35
+ /** `GET /keys`: the tenant's keys, newest first, never the hash. */
36
+ list(options?: CallOptions): Promise<ApiKeyList>;
37
+ /** `DELETE /keys/:id`: revoke (idempotent). */
38
+ revoke(id: string, options?: CallOptions): Promise<ApiKey>;
39
+ }
40
+ /** Cross-tenant administration (an admin key, scope `admin`). */
41
+ export declare class AdminApi {
42
+ private readonly client;
43
+ constructor(client: VolaClient);
44
+ /** `POST /admin/transfer`: move the files of instances from one tenant to another (`dry_run` counts only). */
45
+ transfer(body: TransferInput, options?: CallOptions): Promise<TransferResult>;
46
+ }
47
+ //# sourceMappingURL=management.d.ts.map