@vol-a/client 0.0.0-stage → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +284 -2
  3. package/dist/access-tokens.d.ts +21 -0
  4. package/dist/access-tokens.d.ts.map +1 -0
  5. package/dist/access-tokens.js +34 -0
  6. package/dist/access-tokens.js.map +1 -0
  7. package/dist/body.d.ts +40 -0
  8. package/dist/body.d.ts.map +1 -0
  9. package/dist/body.js +112 -0
  10. package/dist/body.js.map +1 -0
  11. package/dist/client.d.ts +185 -0
  12. package/dist/client.d.ts.map +1 -0
  13. package/dist/client.js +311 -0
  14. package/dist/client.js.map +1 -0
  15. package/dist/env.d.ts +19 -0
  16. package/dist/env.d.ts.map +1 -0
  17. package/dist/env.js +52 -0
  18. package/dist/env.js.map +1 -0
  19. package/dist/errors.d.ts +43 -0
  20. package/dist/errors.d.ts.map +1 -0
  21. package/dist/errors.js +93 -0
  22. package/dist/errors.js.map +1 -0
  23. package/dist/files.d.ts +144 -0
  24. package/dist/files.d.ts.map +1 -0
  25. package/dist/files.js +239 -0
  26. package/dist/files.js.map +1 -0
  27. package/dist/folders.d.ts +35 -0
  28. package/dist/folders.d.ts.map +1 -0
  29. package/dist/folders.js +62 -0
  30. package/dist/folders.js.map +1 -0
  31. package/dist/index.d.ts +21 -0
  32. package/dist/index.d.ts.map +1 -0
  33. package/dist/index.js +12 -0
  34. package/dist/index.js.map +1 -0
  35. package/dist/keyrings.d.ts +44 -0
  36. package/dist/keyrings.d.ts.map +1 -0
  37. package/dist/keyrings.js +111 -0
  38. package/dist/keyrings.js.map +1 -0
  39. package/dist/management.d.ts +47 -0
  40. package/dist/management.d.ts.map +1 -0
  41. package/dist/management.js +65 -0
  42. package/dist/management.js.map +1 -0
  43. package/dist/shares.d.ts +87 -0
  44. package/dist/shares.d.ts.map +1 -0
  45. package/dist/shares.js +144 -0
  46. package/dist/shares.js.map +1 -0
  47. package/dist/uploads.d.ts +112 -0
  48. package/dist/uploads.d.ts.map +1 -0
  49. package/dist/uploads.js +290 -0
  50. package/dist/uploads.js.map +1 -0
  51. package/package.json +48 -3
@@ -0,0 +1 @@
1
+ {"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,aAAa;IAC5B,gGAAgG;IAChG,MAAM,EAAE,MAAM,CAAC;IACf,6GAA6G;IAC7G,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,kHAAkH;IAClH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,+FAA+F;IAC/F,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IAC9C,0DAA0D;IAC1D,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACvC;AAED;;;;GAIG;AACH,qBAAa,SAAU,SAAQ,KAAK;IAClC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC1C,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEtB,IAAI,EAAE,aAAa;CAShC;AAED,gJAAgJ;AAChJ,qBAAa,eAAgB,SAAQ,SAAS;gBAChC,IAAI,EAAE,aAAa;CAIhC;AAED,gIAAgI;AAChI,qBAAa,kBAAmB,SAAQ,SAAS;gBACnC,IAAI,EAAE,aAAa;CAIhC;AAED,6FAA6F;AAC7F,eAAO,MAAM,YAAY,kBAAY,CAAC;AAYtC;;;;GAIG;AACH,wBAAsB,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAuC9E"}
package/dist/errors.js ADDED
@@ -0,0 +1,93 @@
1
+ import { ErrorResponseSchema, INTEGRITY_ERROR_CODE, REQUEST_ID_HEADER } from "@vol-a/core";
2
+ /**
3
+ * A non-2xx answer of the server, carrying its `{ error: { code, message, … } }` envelope —
4
+ * or an error the SDK raised itself (`status: 0`). Never a secret: no key, token, PIN or
5
+ * share secret is ever part of the message or the details.
6
+ */
7
+ export class VolaError extends Error {
8
+ status;
9
+ code;
10
+ retryAfter;
11
+ details;
12
+ requestId;
13
+ constructor(init) {
14
+ super(init.message);
15
+ this.name = "VolaError";
16
+ this.status = init.status;
17
+ this.code = init.code;
18
+ this.retryAfter = init.retryAfter;
19
+ this.details = init.details ?? {};
20
+ this.requestId = init.requestId ?? null;
21
+ }
22
+ }
23
+ /** `423 vola_locked`: the request needs an unlock token (keyring) or a content key (caller) it did not carry, or the one it carried is dead. */
24
+ export class VolaLockedError extends VolaError {
25
+ constructor(init) {
26
+ super(init);
27
+ this.name = "VolaLockedError";
28
+ }
29
+ }
30
+ /** `409 vola_integrity`: the file (or a share grant) could not be decrypted — a wrong key, a wrong secret, or damaged bytes. */
31
+ export class VolaIntegrityError extends VolaError {
32
+ constructor(init) {
33
+ super(init);
34
+ this.name = "VolaIntegrityError";
35
+ }
36
+ }
37
+ /** @deprecated The name of the health-only client's error; `VolaError` is the same class. */
38
+ export const VolaApiError = VolaError;
39
+ const INTEGER_RE = /^\d{1,9}$/;
40
+ /** `Retry-After` in seconds (the delta form only; an HTTP date is ignored). */
41
+ function retryAfterOf(response, details) {
42
+ const header = response.headers.get("retry-after")?.trim();
43
+ if (header && INTEGER_RE.test(header))
44
+ return Number(header);
45
+ const body = details.retry_after;
46
+ return typeof body === "number" && Number.isFinite(body) ? body : undefined;
47
+ }
48
+ /**
49
+ * The `VolaError` of a non-2xx `response`: the envelope when the body is one, `unknown_error`
50
+ * with `HTTP <status>` otherwise. `423` is a `VolaLockedError`, `409 vola_integrity` a
51
+ * `VolaIntegrityError`. Consumes the body.
52
+ */
53
+ export async function errorFromResponse(response) {
54
+ const text = await response.text().catch(() => "");
55
+ let body;
56
+ try {
57
+ body = text === "" ? undefined : JSON.parse(text);
58
+ }
59
+ catch {
60
+ body = undefined;
61
+ }
62
+ const parsed = ErrorResponseSchema.safeParse(body);
63
+ const raw = typeof body === "object" && body !== null && "error" in body
64
+ ? body.error
65
+ : undefined;
66
+ const details = typeof raw === "object" && raw !== null ? { ...raw } : {};
67
+ delete details.code;
68
+ delete details.message;
69
+ const init = parsed.success
70
+ ? {
71
+ status: response.status,
72
+ code: parsed.data.error.code,
73
+ message: parsed.data.error.message,
74
+ details,
75
+ retryAfter: retryAfterOf(response, details),
76
+ requestId: response.headers.get(REQUEST_ID_HEADER),
77
+ }
78
+ : {
79
+ status: response.status,
80
+ code: "unknown_error",
81
+ message: `HTTP ${response.status}`,
82
+ details,
83
+ retryAfter: retryAfterOf(response, details),
84
+ requestId: response.headers.get(REQUEST_ID_HEADER),
85
+ };
86
+ if (response.status === 423)
87
+ return new VolaLockedError(init);
88
+ if (response.status === 409 && init.code === INTEGRITY_ERROR_CODE) {
89
+ return new VolaIntegrityError(init);
90
+ }
91
+ return new VolaError(init);
92
+ }
93
+ //# sourceMappingURL=errors.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAgB3F;;;;GAIG;AACH,MAAM,OAAO,SAAU,SAAQ,KAAK;IACzB,MAAM,CAAS;IACf,IAAI,CAAS;IACb,UAAU,CAAqB;IAC/B,OAAO,CAA0B;IACjC,SAAS,CAAgB;IAElC,YAAY,IAAmB;QAC7B,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACpB,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAClC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;QAClC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC;IAC1C,CAAC;CACF;AAED,gJAAgJ;AAChJ,MAAM,OAAO,eAAgB,SAAQ,SAAS;IAC5C,YAAY,IAAmB;QAC7B,KAAK,CAAC,IAAI,CAAC,CAAC;QACZ,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;IAChC,CAAC;CACF;AAED,gIAAgI;AAChI,MAAM,OAAO,kBAAmB,SAAQ,SAAS;IAC/C,YAAY,IAAmB;QAC7B,KAAK,CAAC,IAAI,CAAC,CAAC;QACZ,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;IACnC,CAAC;CACF;AAED,6FAA6F;AAC7F,MAAM,CAAC,MAAM,YAAY,GAAG,SAAS,CAAC;AAEtC,MAAM,UAAU,GAAG,WAAW,CAAC;AAE/B,+EAA+E;AAC/E,SAAS,YAAY,CAAC,QAAkB,EAAE,OAAgC;IACxE,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,CAAC;IAC3D,IAAI,MAAM,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC;QAAE,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC;IAC7D,MAAM,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC;IACjC,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;AAC9E,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,QAAkB;IACxD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;IACnD,IAAI,IAAa,CAAC;IAClB,IAAI,CAAC;QACH,IAAI,GAAG,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAAC,MAAM,CAAC;QACP,IAAI,GAAG,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,MAAM,GAAG,mBAAmB,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACnD,MAAM,GAAG,GACP,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,IAAI;QAC1D,CAAC,CAAE,IAA2B,CAAC,KAAK;QACpC,CAAC,CAAC,SAAS,CAAC;IAChB,MAAM,OAAO,GACX,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,GAAI,GAA+B,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACzF,OAAO,OAAO,CAAC,IAAI,CAAC;IACpB,OAAO,OAAO,CAAC,OAAO,CAAC;IACvB,MAAM,IAAI,GAAkB,MAAM,CAAC,OAAO;QACxC,CAAC,CAAC;YACE,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI;YAC5B,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO;YAClC,OAAO;YACP,UAAU,EAAE,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC;YAC3C,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;SACnD;QACH,CAAC,CAAC;YACE,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,IAAI,EAAE,eAAe;YACrB,OAAO,EAAE,QAAQ,QAAQ,CAAC,MAAM,EAAE;YAClC,OAAO;YACP,UAAU,EAAE,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC;YAC3C,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;SACnD,CAAC;IACN,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG;QAAE,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;IAC9D,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,IAAI,KAAK,oBAAoB,EAAE,CAAC;QAClE,OAAO,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IACD,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC;AAC7B,CAAC"}
@@ -0,0 +1,144 @@
1
+ import { type FileDetail, type FileEncryption, type FileInfo, type FileList, type FileMetadata, type FilePatch, type FileVersions, type PurgeResult, type ThumbnailCrop, type ThumbnailSize } from "@vol-a/core";
2
+ import { type UploadSource } from "./body.js";
3
+ import type { CallOptions, VolaClient } from "./client.js";
4
+ /** A `Range`: `{start, end?}` (inclusive, as HTTP), `{suffix}` (the last N bytes), or the header value itself. */
5
+ export type ByteRange = {
6
+ start: number;
7
+ end?: number | undefined;
8
+ } | {
9
+ suffix: number;
10
+ } | string;
11
+ export declare function rangeHeader(range: ByteRange): string;
12
+ /** Where an upload lands and what it is. */
13
+ export interface UploadPlacement {
14
+ /** Required unless the source is a `File` (its `name` is used). */
15
+ filename?: string | undefined;
16
+ /** The MIME type of the bytes; default: the `Blob`'s type, else `application/octet-stream` (the server sniffs anyway). */
17
+ contentType?: string | undefined;
18
+ /** The folder (`a/b/c`, created when missing; `""` the root). Excludes `folderId`. */
19
+ folderPath?: string | undefined;
20
+ /** An existing folder by id (`null`: the root). */
21
+ folderId?: string | null | undefined;
22
+ /** The previous version this upload supersedes. */
23
+ parentId?: string | undefined;
24
+ /** Free JSON attached to the file. */
25
+ metadata?: FileMetadata | undefined;
26
+ /** `none` | `tenant` | `keyring` (needs an unlock token) | `caller` (needs `contentKey`, Node only). Default: the folder's policy, else the tenant's default. */
27
+ encryption?: FileEncryption | undefined;
28
+ }
29
+ export interface UploadOptions extends UploadPlacement, CallOptions {
30
+ /** Upsert the file under this slug (`PUT …/slug/:slug`): at most one live file per slug. */
31
+ slug?: string | undefined;
32
+ }
33
+ export interface DownloadOptions extends CallOptions {
34
+ range?: ByteRange | undefined;
35
+ /** `?download=1`: `Content-Disposition: attachment` whatever the type. */
36
+ download?: boolean | undefined;
37
+ /** `If-None-Match`: a `304` resolves (with an empty body). */
38
+ ifNoneMatch?: string | undefined;
39
+ }
40
+ export interface InfoOptions extends CallOptions {
41
+ /** See a soft-deleted file too. */
42
+ includeDeleted?: boolean | undefined;
43
+ /** `"full"`: the whole OCR text under `ocr.text` (the 500-character preview is always there). */
44
+ ocr?: "full" | undefined;
45
+ }
46
+ export interface ListOptions extends CallOptions {
47
+ cursor?: string | null | undefined;
48
+ /** Page size, at most 200. */
49
+ limit?: number | undefined;
50
+ includeDeleted?: boolean | undefined;
51
+ }
52
+ export interface VersionsOptions extends CallOptions {
53
+ includeDeleted?: boolean | undefined;
54
+ }
55
+ export interface ThumbnailOptions extends CallOptions {
56
+ crop?: ThumbnailCrop | undefined;
57
+ ifNoneMatch?: string | undefined;
58
+ }
59
+ /**
60
+ * What `thumb()` resolves with. A `202` of the server is NOT the image: it is a grey placeholder
61
+ * while the worker renders — `generating` tells the caller to retry (and never to cache).
62
+ */
63
+ export type ThumbnailResult = {
64
+ status: "ready";
65
+ blob: Blob;
66
+ etag: string | null;
67
+ response: Response;
68
+ } | {
69
+ status: "not_modified";
70
+ etag: string | null;
71
+ response: Response;
72
+ } | {
73
+ status: "generating";
74
+ response: Response;
75
+ } | {
76
+ status: "failed";
77
+ response: Response;
78
+ };
79
+ /** `/files/:type/:id`. */
80
+ export declare function instancePath(type: string, id: string): string;
81
+ /** `/files/:type/:id/:fileId`. */
82
+ export declare function filePath(type: string, id: string, fileId: string): string;
83
+ /** The files of an instance: upload, download, metadata, versions, visibility, delete. */
84
+ export declare class FilesApi {
85
+ private readonly client;
86
+ constructor(client: VolaClient);
87
+ /**
88
+ * `POST /files/:type/:id` (multipart) — or `PUT …/slug/:slug` with `slug`. The source is a
89
+ * `File`/`Blob`, a `Uint8Array`/`Buffer`, an `ArrayBuffer`, a web `ReadableStream` or any
90
+ * async iterable of bytes (a Node `Readable`): streams are sent without being buffered.
91
+ * Resolves with the stored file (`201`).
92
+ */
93
+ upload(type: string, id: string, source: UploadSource, options?: UploadOptions): Promise<FileInfo>;
94
+ /** `PUT /files/:type/:id/slug/:slug`: `upload()` as an upsert under `slug`. */
95
+ putSlug(type: string, id: string, slug: string, source: UploadSource, options?: Omit<UploadOptions, "slug">): Promise<FileInfo>;
96
+ private fetchFile;
97
+ /**
98
+ * `GET /files/:type/:id/:fileId`: the bytes as a streaming `Response` (`200`, or `206` for a
99
+ * `range`, `304` for a matching `ifNoneMatch`) — read `response.body`, `.blob()`,
100
+ * `.arrayBuffer()` as needed. Headers: `ETag`, `Content-Disposition`, `Content-Range`,
101
+ * `X-Vola-Encryption` for an encrypted file.
102
+ */
103
+ download(type: string, id: string, fileId: string, options?: DownloadOptions): Promise<Response>;
104
+ /** `HEAD /files/:type/:id/:fileId`: the headers of a download without the body. */
105
+ head(type: string, id: string, fileId: string, options?: DownloadOptions): Promise<Response>;
106
+ /** `GET /files/:type/:id/path/*`: the newest live file of that name in that folder (`docs/q4/report.pdf`). */
107
+ byPath(type: string, id: string, path: string, options?: DownloadOptions): Promise<Response>;
108
+ /** `GET /files/:type/:id/slug/:slug`: the live file under `slug`. */
109
+ bySlug(type: string, id: string, slug: string, options?: DownloadOptions): Promise<Response>;
110
+ /** `GET /public/:fileId`: an `is_global_public` file, no key needed. */
111
+ public(fileId: string, options?: Omit<DownloadOptions, "unlock" | "contentKey">): Promise<Response>;
112
+ /** The URL of a download — WITHOUT credentials: for a `<a href>` behind a proxy or cookie auth, or for `fetch` with `client.headers()`. */
113
+ downloadUrl(type: string, id: string, fileId: string, options?: {
114
+ download?: boolean | undefined;
115
+ }): string;
116
+ /** The URL of `GET /public/:fileId` (anonymous: usable as an `<img src>` for an `is_global_public` file). */
117
+ publicUrl(fileId: string): string;
118
+ /** `GET …/:fileId/info`: the metadata (never the bytes) with the aggregate processing status and the `ocr` block. */
119
+ info(type: string, id: string, fileId: string, options?: InfoOptions): Promise<FileDetail>;
120
+ /** `GET /files/:type/:id`: the instance's files, newest first, one page (`next_cursor` feeds `cursor`). */
121
+ list(type: string, id: string, options?: ListOptions): Promise<FileList>;
122
+ /** Every file of the instance, page after page. */
123
+ iterate(type: string, id: string, options?: ListOptions): AsyncGenerator<FileInfo>;
124
+ /** `GET …/:fileId/versions`: the whole version chain, newest first. */
125
+ versions(type: string, id: string, fileId: string, options?: VersionsOptions): Promise<FileVersions>;
126
+ /** `PATCH …/:fileId`: move (`folder_path`), rename (`filename`), visibility (`is_public`, `is_global_public`). */
127
+ patch(type: string, id: string, fileId: string, patch: FilePatch, options?: CallOptions): Promise<FileInfo>;
128
+ /** `DELETE …/:fileId`: soft delete (the bytes stay; `purge` removes them). Idempotent. */
129
+ delete(type: string, id: string, fileId: string, options?: CallOptions): Promise<FileInfo>;
130
+ /** `DELETE …/:fileId/purge`: the row, its version chain, and every blob nothing references any more. */
131
+ purge(type: string, id: string, fileId: string, options?: CallOptions): Promise<PurgeResult>;
132
+ /** `…/:fileId/thumb/:size[?crop=]` as a URL — WITHOUT credentials (see `downloadUrl`). */
133
+ thumbUrl(type: string, id: string, fileId: string, size: ThumbnailSize, options?: {
134
+ crop?: ThumbnailCrop | undefined;
135
+ }): string;
136
+ /**
137
+ * `GET …/:fileId/thumb/:size?crop=`: `{status: "ready", blob}` for the WebP, `{status:
138
+ * "generating"}` while the worker renders it (a `202` — retry later, never cache),
139
+ * `{status: "failed"}` when the file could not be rendered. `404 no_thumbnail` throws: the
140
+ * file has none by its nature.
141
+ */
142
+ thumb(type: string, id: string, fileId: string, size: ThumbnailSize, options?: ThumbnailOptions): Promise<ThumbnailResult>;
143
+ }
144
+ //# sourceMappingURL=files.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../src/files.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,UAAU,EAEf,KAAK,cAAc,EACnB,KAAK,QAAQ,EAEb,KAAK,QAAQ,EAEb,KAAK,YAAY,EACjB,KAAK,SAAS,EACd,KAAK,YAAY,EAKjB,KAAK,WAAW,EAIhB,KAAK,aAAa,EAClB,KAAK,aAAa,EAMnB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAiC,KAAK,YAAY,EAAE,MAAM,WAAW,CAAC;AAC7E,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAK3D,kHAAkH;AAClH,MAAM,MAAM,SAAS,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAAC;AAElG,wBAAgB,WAAW,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM,CAIpD;AAED,4CAA4C;AAC5C,MAAM,WAAW,eAAe;IAC9B,mEAAmE;IACnE,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,0HAA0H;IAC1H,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,sFAAsF;IACtF,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,mDAAmD;IACnD,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACrC,mDAAmD;IACnD,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,sCAAsC;IACtC,QAAQ,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IACpC,iKAAiK;IACjK,UAAU,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;CACzC;AAED,MAAM,WAAW,aAAc,SAAQ,eAAe,EAAE,WAAW;IACjE,4FAA4F;IAC5F,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B;AAED,MAAM,WAAW,eAAgB,SAAQ,WAAW;IAClD,KAAK,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAC9B,0EAA0E;IAC1E,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B,8DAA8D;IAC9D,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC;AAED,MAAM,WAAW,WAAY,SAAQ,WAAW;IAC9C,mCAAmC;IACnC,cAAc,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACrC,iGAAiG;IACjG,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC1B;AAED,MAAM,WAAW,WAAY,SAAQ,WAAW;IAC9C,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACnC,8BAA8B;IAC9B,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,cAAc,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACtC;AAED,MAAM,WAAW,eAAgB,SAAQ,WAAW;IAClD,cAAc,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACtC;AAED,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD,IAAI,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IACjC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,MAAM,eAAe,GACvB;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,QAAQ,EAAE,QAAQ,CAAA;CAAE,GACxE;IAAE,MAAM,EAAE,cAAc,CAAC;IAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,QAAQ,EAAE,QAAQ,CAAA;CAAE,GACnE;IAAE,MAAM,EAAE,YAAY,CAAC;IAAC,QAAQ,EAAE,QAAQ,CAAA;CAAE,GAC5C;IAAE,MAAM,EAAE,QAAQ,CAAC;IAAC,QAAQ,EAAE,QAAQ,CAAA;CAAE,CAAC;AAE7C,0BAA0B;AAC1B,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,CAE7D;AAED,kCAAkC;AAClC,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAEzE;AAED,0FAA0F;AAC1F,qBAAa,QAAQ;IACP,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAN,MAAM,EAAE,UAAU;IAE/C;;;;;OAKG;IACG,MAAM,CACV,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,YAAY,EACpB,OAAO,GAAE,aAAkB,GAC1B,OAAO,CAAC,QAAQ,CAAC;IAgDpB,+EAA+E;IAC/E,OAAO,CACL,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,YAAY,EACpB,OAAO,GAAE,IAAI,CAAC,aAAa,EAAE,MAAM,CAAM,GACxC,OAAO,CAAC,QAAQ,CAAC;YAIN,SAAS;IAmBvB;;;;;OAKG;IACH,QAAQ,CACN,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,QAAQ,CAAC;IAIpB,mFAAmF;IACnF,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,eAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIhG,8GAA8G;IAC9G,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,eAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIhG,qEAAqE;IACrE,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,eAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAQhG,wEAAwE;IACxE,MAAM,CACJ,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,IAAI,CAAC,eAAe,EAAE,QAAQ,GAAG,YAAY,CAAM,GAC3D,OAAO,CAAC,QAAQ,CAAC;IAapB,2IAA2I;IAC3I,WAAW,CACT,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,OAAO,GAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;KAAO,GAC/C,MAAM;IAMT,6GAA6G;IAC7G,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAIjC,qHAAqH;IACrH,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,UAAU,CAAC;IAY9F,2GAA2G;IAC3G,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAY5E,mDAAmD;IAC5C,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,cAAc,CAAC,QAAQ,CAAC;IAS7F,uEAAuE;IACvE,QAAQ,CACN,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,YAAY,CAAC;IAQxB,kHAAkH;IAClH,KAAK,CACH,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,SAAS,EAChB,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,QAAQ,CAAC;IAQpB,0FAA0F;IAC1F,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAO9F,wGAAwG;IACxG,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,WAAW,CAAC;IAOhG,0FAA0F;IAC1F,QAAQ,CACN,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,aAAa,EACnB,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,aAAa,GAAG,SAAS,CAAA;KAAO,GACjD,MAAM;IAMT;;;;;OAKG;IACG,KAAK,CACT,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,aAAa,EACnB,OAAO,GAAE,gBAAqB,GAC7B,OAAO,CAAC,eAAe,CAAC;CAiB5B"}
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"}