@dimah-s3/react 1.7.1 → 2.0.0-beta.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 (148) hide show
  1. package/README.md +53 -13
  2. package/dist/api.d.ts +24 -15
  3. package/dist/api.d.ts.map +1 -1
  4. package/dist/chunk-SPUUNLXI.js +824 -0
  5. package/dist/chunk-SPUUNLXI.js.map +1 -0
  6. package/dist/create-s3-client.d.ts +1 -1
  7. package/dist/create-s3-client.d.ts.map +1 -1
  8. package/dist/engine.d.ts +15 -1
  9. package/dist/engine.d.ts.map +1 -1
  10. package/dist/engine.js +204 -512
  11. package/dist/engine.js.map +1 -1
  12. package/dist/helpers/format-accept-labels.d.ts +15 -2
  13. package/dist/helpers/format-accept-labels.d.ts.map +1 -1
  14. package/dist/helpers/format-date.d.ts +7 -0
  15. package/dist/helpers/format-date.d.ts.map +1 -0
  16. package/dist/helpers/format-dimah-error.d.ts +12 -2
  17. package/dist/helpers/format-dimah-error.d.ts.map +1 -1
  18. package/dist/helpers/format-file-size.d.ts +20 -0
  19. package/dist/helpers/format-file-size.d.ts.map +1 -0
  20. package/dist/helpers/format-speed.d.ts +1 -1
  21. package/dist/helpers/format-speed.d.ts.map +1 -1
  22. package/dist/helpers/format-upload-progress.d.ts +1 -1
  23. package/dist/helpers/format-upload-progress.d.ts.map +1 -1
  24. package/dist/helpers/index.d.ts +5 -8
  25. package/dist/helpers/index.d.ts.map +1 -1
  26. package/dist/helpers/load-route-catalog.d.ts +32 -8
  27. package/dist/helpers/load-route-catalog.d.ts.map +1 -1
  28. package/dist/helpers/throttled-speed.d.ts +2 -2
  29. package/dist/helpers/throttled-speed.d.ts.map +1 -1
  30. package/dist/helpers/to-timestamp.d.ts +5 -0
  31. package/dist/helpers/to-timestamp.d.ts.map +1 -0
  32. package/dist/helpers/truncate-file-name.d.ts +8 -0
  33. package/dist/helpers/truncate-file-name.d.ts.map +1 -0
  34. package/dist/helpers/use-format-accept-labels.d.ts +12 -0
  35. package/dist/helpers/use-format-accept-labels.d.ts.map +1 -0
  36. package/dist/helpers/use-format-eta.d.ts +14 -0
  37. package/dist/helpers/use-format-eta.d.ts.map +1 -0
  38. package/dist/helpers/use-format-speed.d.ts +12 -0
  39. package/dist/helpers/use-format-speed.d.ts.map +1 -0
  40. package/dist/hooks/use-delete.d.ts +6 -44
  41. package/dist/hooks/use-delete.d.ts.map +1 -1
  42. package/dist/hooks/use-download.d.ts +7 -117
  43. package/dist/hooks/use-download.d.ts.map +1 -1
  44. package/dist/hooks/use-fetch-download.d.ts +8 -0
  45. package/dist/hooks/use-fetch-download.d.ts.map +1 -0
  46. package/dist/hooks/use-file-intake.d.ts +43 -29
  47. package/dist/hooks/use-file-intake.d.ts.map +1 -1
  48. package/dist/hooks/use-file-upload.d.ts +38 -34
  49. package/dist/hooks/use-file-upload.d.ts.map +1 -1
  50. package/dist/hooks/use-object-list-selection.d.ts +78 -0
  51. package/dist/hooks/use-object-list-selection.d.ts.map +1 -0
  52. package/dist/hooks/use-object-list.d.ts +66 -16
  53. package/dist/hooks/use-object-list.d.ts.map +1 -1
  54. package/dist/hooks/use-object-url.d.ts +27 -10
  55. package/dist/hooks/use-object-url.d.ts.map +1 -1
  56. package/dist/hooks/use-route-upload-policy.d.ts +22 -14
  57. package/dist/hooks/use-route-upload-policy.d.ts.map +1 -1
  58. package/dist/hooks/use-upload.d.ts +72 -65
  59. package/dist/hooks/use-upload.d.ts.map +1 -1
  60. package/dist/index.d.ts +15 -19
  61. package/dist/index.d.ts.map +1 -1
  62. package/dist/index.js +2420 -2164
  63. package/dist/index.js.map +1 -1
  64. package/dist/internal/abortable.d.ts +9 -0
  65. package/dist/internal/abortable.d.ts.map +1 -0
  66. package/dist/internal/browser-download.d.ts +15 -0
  67. package/dist/internal/browser-download.d.ts.map +1 -0
  68. package/dist/internal/callbacks.d.ts +54 -0
  69. package/dist/internal/callbacks.d.ts.map +1 -0
  70. package/dist/internal/client-error.d.ts +15 -0
  71. package/dist/internal/client-error.d.ts.map +1 -0
  72. package/dist/internal/hooks.d.ts +27 -0
  73. package/dist/internal/hooks.d.ts.map +1 -0
  74. package/dist/internal/lru.d.ts +13 -0
  75. package/dist/internal/lru.d.ts.map +1 -0
  76. package/dist/internal/operations.d.ts +74 -0
  77. package/dist/internal/operations.d.ts.map +1 -0
  78. package/dist/internal/pool.d.ts +8 -0
  79. package/dist/internal/pool.d.ts.map +1 -0
  80. package/dist/list/entries.d.ts +14 -0
  81. package/dist/list/entries.d.ts.map +1 -0
  82. package/dist/list/memory-object-source.d.ts +60 -0
  83. package/dist/list/memory-object-source.d.ts.map +1 -0
  84. package/dist/list/types.d.ts +123 -11
  85. package/dist/list/types.d.ts.map +1 -1
  86. package/dist/s3-provider.d.ts +3 -2
  87. package/dist/s3-provider.d.ts.map +1 -1
  88. package/dist/store/local-storage-store.d.ts +5 -4
  89. package/dist/store/local-storage-store.d.ts.map +1 -1
  90. package/dist/store/memory-store.d.ts +3 -4
  91. package/dist/store/memory-store.d.ts.map +1 -1
  92. package/dist/translations/types.d.ts +105 -23
  93. package/dist/translations/types.d.ts.map +1 -1
  94. package/dist/types/delete.d.ts +98 -9
  95. package/dist/types/delete.d.ts.map +1 -1
  96. package/dist/types/download.d.ts +152 -23
  97. package/dist/types/download.d.ts.map +1 -1
  98. package/dist/types/index.d.ts +1 -1
  99. package/dist/types/index.d.ts.map +1 -1
  100. package/dist/types/operation.d.ts +38 -0
  101. package/dist/types/operation.d.ts.map +1 -0
  102. package/dist/types/upload-store.d.ts +30 -40
  103. package/dist/types/upload-store.d.ts.map +1 -1
  104. package/dist/types/upload.d.ts +177 -130
  105. package/dist/types/upload.d.ts.map +1 -1
  106. package/dist/upload/abort.d.ts +10 -0
  107. package/dist/upload/abort.d.ts.map +1 -0
  108. package/dist/upload/constants.d.ts +8 -3
  109. package/dist/upload/constants.d.ts.map +1 -1
  110. package/dist/upload/index.d.ts +3 -2
  111. package/dist/upload/index.d.ts.map +1 -1
  112. package/dist/upload/multipart.d.ts +14 -4
  113. package/dist/upload/multipart.d.ts.map +1 -1
  114. package/dist/upload/part-pool.d.ts +16 -0
  115. package/dist/upload/part-pool.d.ts.map +1 -0
  116. package/dist/upload/presigned-http.d.ts +5 -14
  117. package/dist/upload/presigned-http.d.ts.map +1 -1
  118. package/dist/upload/progress.d.ts +7 -0
  119. package/dist/upload/progress.d.ts.map +1 -0
  120. package/dist/upload/request.d.ts +9 -0
  121. package/dist/upload/request.d.ts.map +1 -0
  122. package/dist/upload/resume-key.d.ts +7 -3
  123. package/dist/upload/resume-key.d.ts.map +1 -1
  124. package/dist/upload/retry.d.ts +27 -2
  125. package/dist/upload/retry.d.ts.map +1 -1
  126. package/dist/upload/stored-upload.d.ts +7 -0
  127. package/dist/upload/stored-upload.d.ts.map +1 -0
  128. package/dist/upload/upload-file.d.ts +10 -11
  129. package/dist/upload/upload-file.d.ts.map +1 -1
  130. package/dist/upload/upload-part.d.ts +6 -3
  131. package/dist/upload/upload-part.d.ts.map +1 -1
  132. package/dist/upload/xhr-upload.d.ts +10 -2
  133. package/dist/upload/xhr-upload.d.ts.map +1 -1
  134. package/package.json +7 -8
  135. package/dist/helpers/format-eta.d.ts +0 -13
  136. package/dist/helpers/format-eta.d.ts.map +0 -1
  137. package/dist/helpers/format-validate-file-error.d.ts +0 -9
  138. package/dist/helpers/format-validate-file-error.d.ts.map +0 -1
  139. package/dist/hooks/index.d.ts +0 -7
  140. package/dist/hooks/index.d.ts.map +0 -1
  141. package/dist/internal-helpers.d.ts +0 -10
  142. package/dist/internal-helpers.d.ts.map +0 -1
  143. package/dist/store/use-immer-state.d.ts +0 -8
  144. package/dist/store/use-immer-state.d.ts.map +0 -1
  145. package/dist/types/error.d.ts +0 -27
  146. package/dist/types/error.d.ts.map +0 -1
  147. package/dist/upload/upload-files.d.ts +0 -26
  148. package/dist/upload/upload-files.d.ts.map +0 -1
@@ -1 +1 @@
1
- {"version":3,"file":"presigned-http.d.ts","sourceRoot":"","sources":["../../src/upload/presigned-http.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAa9C;;;;;;GAMG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,IAAI,EACV,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC9B,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,EAC/C,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,IAAI,CAAC,CAgBf;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,IAAI,EACV,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC/B,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,EAC/C,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,IAAI,CAAC,CAWf"}
1
+ {"version":3,"file":"presigned-http.d.ts","sourceRoot":"","sources":["../../src/upload/presigned-http.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAItD;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,EAAE,eA+BjC,CAAC"}
@@ -0,0 +1,7 @@
1
+ import type { TransferProgress } from "../types/operation.js";
2
+ /**
3
+ * Progress for `loaded` of `total` bytes, with a whole-number percent capped
4
+ * at 100. A `total` of `0` is unknown, and its percent is `0`.
5
+ */
6
+ export declare function transferProgress(loaded: number, total: number): TransferProgress;
7
+ //# sourceMappingURL=progress.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"progress.d.ts","sourceRoot":"","sources":["../../src/upload/progress.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAE1D;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,GACZ,gBAAgB,CAMlB"}
@@ -0,0 +1,9 @@
1
+ import type { UploadRequestInput, UploadRequestOptions } from "../types/upload.js";
2
+ /**
3
+ * `override` over `base`, the way `useUpload` puts a call's `uploadOptions`
4
+ * over the hook's: `override` fields win, and `metadata` merges key by key.
5
+ */
6
+ export declare function mergeUploadRequest(base: UploadRequestOptions | undefined, override: UploadRequestOptions | undefined): UploadRequestOptions;
7
+ /** The request options `input` gives for `file`. */
8
+ export declare function resolveUploadRequest(input: UploadRequestInput | undefined, file: File): UploadRequestOptions | undefined;
9
+ //# sourceMappingURL=request.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../src/upload/request.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAE/E;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,oBAAoB,GAAG,SAAS,EACtC,QAAQ,EAAE,oBAAoB,GAAG,SAAS,GACzC,oBAAoB,CAOtB;AAED,oDAAoD;AACpD,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,kBAAkB,GAAG,SAAS,EACrC,IAAI,EAAE,IAAI,GACT,oBAAoB,GAAG,SAAS,CAElC"}
@@ -1,6 +1,10 @@
1
+ import type { UploadRequestOptions } from "../types/upload.js";
1
2
  /**
2
- * Stable client-side identity for multipart resume.
3
- * The S3 object key is server-generated and unknown until init.
3
+ * Stable client-side identity for multipart resume: the route, the file, and
4
+ * the `request` options passed to `uploadFile`. A stored upload resumes only
5
+ * for the same file sent with the same name, type and metadata, so it never
6
+ * completes into another folder. The S3 object key is server-generated and
7
+ * unknown until init.
4
8
  */
5
- export declare function multipartResumeKey(route: string, file: File): string;
9
+ export declare function multipartResumeKey(route: string, file: File, request?: UploadRequestOptions): string;
6
10
  //# sourceMappingURL=resume-key.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"resume-key.d.ts","sourceRoot":"","sources":["../../src/upload/resume-key.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,GAAG,MAAM,CAEpE"}
1
+ {"version":3,"file":"resume-key.d.ts","sourceRoot":"","sources":["../../src/upload/resume-key.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAE3D;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,IAAI,EACV,OAAO,GAAE,oBAAyB,GACjC,MAAM,CASR"}
@@ -1,3 +1,28 @@
1
- import type { RetryConfig } from "../types/index.js";
2
- export declare function withRetry<T>(fn: () => Promise<T>, retryConfig: RetryConfig | undefined, signal?: AbortSignal): Promise<T>;
1
+ import type { RetryConfig } from "../types/upload.js";
2
+ export type RetryOptions = {
3
+ retry?: RetryConfig;
4
+ signal?: AbortSignal;
5
+ };
6
+ /**
7
+ * Whether a failed request may succeed if sent again: `NETWORK_ERROR`,
8
+ * `S3_NETWORK_ERROR`, and `UPLOAD_FAILED` with a 5xx or 429 status.
9
+ */
10
+ export declare function isRetryableError(error: unknown): boolean;
11
+ /**
12
+ * Runs `task`, and retries a failure that `canRetry` accepts (by default
13
+ * {@link isRetryableError}) with exponential backoff. Rejects with
14
+ * `signal.reason` once the signal aborts.
15
+ */
16
+ export declare function withRetry<T>(task: () => Promise<T>, options: RetryOptions & {
17
+ canRetry?: (error: unknown) => boolean;
18
+ }): Promise<T>;
19
+ /**
20
+ * Signs a presigned request with `sign` and sends it with `send`, with
21
+ * retries. A dead URL is never reused: the request is signed again before a
22
+ * retry once its URL has expired, and a 403 from an expired URL is retried
23
+ * with a new one. Resolves with the signing response that was sent.
24
+ */
25
+ export declare function withPresignedRetry<TSigned extends {
26
+ expiresIn: number;
27
+ }>(sign: () => Promise<TSigned>, send: (signed: TSigned) => Promise<void>, options: RetryOptions): Promise<TSigned>;
3
28
  //# sourceMappingURL=retry.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"retry.d.ts","sourceRoot":"","sources":["../../src/upload/retry.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AA2C3C,wBAAsB,SAAS,CAAC,CAAC,EAC/B,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EACpB,WAAW,EAAE,WAAW,GAAG,SAAS,EACpC,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,CAAC,CAAC,CAkBZ"}
1
+ {"version":3,"file":"retry.d.ts","sourceRoot":"","sources":["../../src/upload/retry.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAOlD,MAAM,MAAM,YAAY,GAAG;IAAE,KAAK,CAAC,EAAE,WAAW,CAAC;IAAC,MAAM,CAAC,EAAE,WAAW,CAAA;CAAE,CAAC;AAEzE;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAUxD;AAWD;;;;GAIG;AACH,wBAAsB,SAAS,CAAC,CAAC,EAC/B,IAAI,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EACtB,OAAO,EAAE,YAAY,GAAG;IAAE,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAAA;CAAE,GACjE,OAAO,CAAC,CAAC,CAAC,CAeZ;AAED;;;;;GAKG;AACH,wBAAsB,kBAAkB,CAAC,OAAO,SAAS;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,EAC5E,IAAI,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,EAC5B,IAAI,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,EACxC,OAAO,EAAE,YAAY,GACpB,OAAO,CAAC,OAAO,CAAC,CA0BlB"}
@@ -0,0 +1,7 @@
1
+ import type { StoredUpload } from "../types/upload-store.js";
2
+ /**
3
+ * Whether `value` has the {@link StoredUpload} shape. Records from 1.x (no
4
+ * ticket or part layout) fail this check.
5
+ */
6
+ export declare function isStoredUpload(value: unknown): value is StoredUpload;
7
+ //# sourceMappingURL=stored-upload.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"stored-upload.d.ts","sourceRoot":"","sources":["../../src/upload/stored-upload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAEzD;;;GAGG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,YAAY,CAapE"}
@@ -1,13 +1,12 @@
1
- import type { FileUploadConfig, UploadProgress, UploadResult, UploadRequestOptions } from "../types/index.js";
2
1
  import { type S3Api } from "@dimah-s3/core";
3
- export type UploadEngineCallbacks = {
4
- onProgress?: (progress: UploadProgress) => void;
5
- /** Called when the upload transitions between internal phases. */
6
- onPhaseChange?: (phase: "presigning" | "uploading" | "finalizing") => void;
7
- /** Called after each individual multipart part is successfully uploaded. */
8
- onPartUpload?: (partNumber: number, totalParts: number) => void;
9
- /** Called once after `CreateMultipartUpload` succeeds with the S3-assigned `uploadId` and final object `key`. */
10
- onMultipartInit?: (uploadId: string, key: string) => void;
11
- };
12
- export declare function uploadFile(api: S3Api, file: File, config: FileUploadConfig, callbacks?: UploadEngineCallbacks, signal?: AbortSignal, requestOptions?: UploadRequestOptions): Promise<UploadResult>;
2
+ import type { UploadFileOptions, UploadResult } from "../types/upload.js";
3
+ /**
4
+ * Uploads one file and returns the verified object. Files of at least
5
+ * `DEFAULT_MULTIPART_THRESHOLD` bytes use multipart when `policy.multipart`
6
+ * is true; other files are presigned, sent and confirmed in one shot.
7
+ *
8
+ * Rejects with an `APIError`, or with `signal.reason` once `signal` aborts.
9
+ * Phases run `preparing`, `presigning`, `uploading`, then `finalizing`.
10
+ */
11
+ export declare function uploadFile(api: S3Api, file: File, options: UploadFileOptions): Promise<UploadResult>;
13
12
  //# sourceMappingURL=upload-file.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"upload-file.d.ts","sourceRoot":"","sources":["../../src/upload/upload-file.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,cAAc,EACd,YAAY,EACZ,oBAAoB,EAGrB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAc,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAgBxD,MAAM,MAAM,qBAAqB,GAAG;IAClC,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAC;IAChD,kEAAkE;IAClE,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,GAAG,WAAW,GAAG,YAAY,KAAK,IAAI,CAAC;IAC3E,4EAA4E;IAC5E,YAAY,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,KAAK,IAAI,CAAC;IAChE,iHAAiH;IACjH,eAAe,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;CAC3D,CAAC;AAEF,wBAAsB,UAAU,CAC9B,GAAG,EAAE,KAAK,EACV,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,gBAAgB,EACxB,SAAS,GAAE,qBAA0B,EACrC,MAAM,CAAC,EAAE,WAAW,EACpB,cAAc,CAAC,EAAE,oBAAoB,GACpC,OAAO,CAAC,YAAY,CAAC,CAoGvB"}
1
+ {"version":3,"file":"upload-file.d.ts","sourceRoot":"","sources":["../../src/upload/upload-file.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,KAAK,EACX,MAAM,gBAAgB,CAAC;AAExB,OAAO,KAAK,EAGV,iBAAiB,EACjB,YAAY,EAEb,MAAM,gBAAgB,CAAC;AAOxB;;;;;;;GAOG;AACH,wBAAsB,UAAU,CAC9B,GAAG,EAAE,KAAK,EACV,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,YAAY,CAAC,CAcvB"}
@@ -1,4 +1,7 @@
1
- export declare function uploadPart(blob: Blob, url: string, partLoaded: {
2
- bytes: number;
3
- }, reportProgress: () => void, signal?: AbortSignal): Promise<void>;
1
+ import type { MultipartPartResponse } from "@dimah-s3/core";
2
+ /** PUTs one multipart part to its presigned URL with exactly the signed headers. */
3
+ export declare function uploadPart(part: Blob, signed: MultipartPartResponse, options: {
4
+ signal?: AbortSignal;
5
+ onProgress?: (loaded: number) => void;
6
+ }): Promise<void>;
4
7
  //# sourceMappingURL=upload-part.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"upload-part.d.ts","sourceRoot":"","sources":["../../src/upload/upload-part.ts"],"names":[],"mappings":"AAEA,wBAAgB,UAAU,CACxB,IAAI,EAAE,IAAI,EACV,GAAG,EAAE,MAAM,EACX,UAAU,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,EAC7B,cAAc,EAAE,MAAM,IAAI,EAC1B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,IAAI,CAAC,CAef"}
1
+ {"version":3,"file":"upload-part.d.ts","sourceRoot":"","sources":["../../src/upload/upload-part.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AAG5D,oFAAoF;AACpF,wBAAgB,UAAU,CACxB,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,qBAAqB,EAC7B,OAAO,EAAE;IAAE,MAAM,CAAC,EAAE,WAAW,CAAC;IAAC,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAA;CAAE,GACvE,OAAO,CAAC,IAAI,CAAC,CAUf"}
@@ -2,10 +2,18 @@ export type SendXhrUploadOptions = {
2
2
  method: "POST" | "PUT";
3
3
  url: string;
4
4
  body: FormData | Blob;
5
+ /** Sent exactly as given. */
5
6
  headers?: Record<string, string>;
6
7
  signal?: AbortSignal;
7
- errorLabel?: string;
8
- onProgress?: (loaded: number, total: number) => void;
8
+ /** The share of the request body sent so far, from 0 to 1. */
9
+ onProgress?: (fraction: number) => void;
9
10
  };
11
+ /**
12
+ * Sends `body` with `XMLHttpRequest`, which reports upload progress.
13
+ * Rejects with `CHECKSUM_MISMATCH` when S3 answers 400 because the bytes do
14
+ * not match their signed checksum, `UPLOAD_FAILED` carrying S3's status on
15
+ * any other non-2xx response, `NETWORK_ERROR` when the request fails, and
16
+ * `signal.reason` on abort.
17
+ */
10
18
  export declare function sendXhrUpload(options: SendXhrUploadOptions): Promise<void>;
11
19
  //# sourceMappingURL=xhr-upload.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"xhr-upload.d.ts","sourceRoot":"","sources":["../../src/upload/xhr-upload.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;CACtD,CAAC;AAEF,wBAAgB,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAwE1E"}
1
+ {"version":3,"file":"xhr-upload.d.ts","sourceRoot":"","sources":["../../src/upload/xhr-upload.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAC;IACtB,6BAA6B;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,8DAA8D;IAC9D,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;CACzC,CAAC;AAQF;;;;;;GAMG;AACH,wBAAsB,aAAa,CACjC,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,IAAI,CAAC,CAuCf"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dimah-s3/react",
3
- "version": "1.7.1",
3
+ "version": "2.0.0-beta.0",
4
4
  "description": "Headless React hooks for presigned S3 file uploads, downloads, and deletes",
5
5
  "keywords": [
6
6
  "s3",
@@ -23,7 +23,7 @@
23
23
  "headless",
24
24
  "typescript"
25
25
  ],
26
- "homepage": "https://s3.dimah.dev/docs/react",
26
+ "homepage": "https://v2.s3.dimah.dev/docs/react",
27
27
  "bugs": {
28
28
  "url": "https://github.com/dimah-kz/dimah-s3/issues"
29
29
  },
@@ -50,31 +50,30 @@
50
50
  "dist"
51
51
  ],
52
52
  "dependencies": {
53
- "@dimah-s3/core": "1.7.1",
54
- "@fuma-translate/react": "^1.0.2",
55
- "immer": "^11.2.9",
53
+ "@dimah-s3/core": "2.0.0-beta.0",
56
54
  "react-dropzone": "^20.1.4"
57
55
  },
58
56
  "devDependencies": {
57
+ "@fuma-translate/react": "^1.0.2",
59
58
  "@types/react": "^19.3.0",
60
59
  "@types/react-dom": "^19.3.0",
61
60
  "@workspace/eslint-config": "0.0.1",
62
61
  "@workspace/tsup-config": "0.0.0",
63
62
  "@workspace/typescript-config": "0.0.1",
64
63
  "@workspace/vitest-config": "0.0.7",
65
- "eslint": "^10.13.0",
64
+ "eslint": "^10.14.0",
66
65
  "fuma-translate": "^1.0.2",
67
66
  "jsdom": "^30.1.3",
68
67
  "react": "^19.3.1",
69
68
  "react-dom": "^19.3.1",
70
- "tsc-alias": "^1.9.9",
69
+ "tsc-alias": "^1.9.10",
71
70
  "tsup": "^9.0.0",
72
71
  "typescript": "7.0.2",
73
72
  "vitest": "^5.0.5"
74
73
  },
75
74
  "peerDependencies": {
76
75
  "@fuma-translate/react": "^1.0.2",
77
- "react": ">=18"
76
+ "react": ">=19.2"
78
77
  },
79
78
  "publishConfig": {
80
79
  "access": "public"
@@ -1,13 +0,0 @@
1
- /**
2
- * Formats an estimated remaining time given the remaining bytes and current speed.
3
- *
4
- * Returns `null` when speed is 0 or nothing remains (not yet calculable).
5
- *
6
- * @example
7
- * formatEta(4_400_000, 450_000) // → "9s"
8
- * formatEta(4_400_000, 75_000) // → "58s"
9
- * formatEta(90_000_000, 1_500_000) // → "1m"
10
- * formatEta(5_400_000_000, 500_000) // → "3h"
11
- */
12
- export declare function formatEta(remainingBytes: number, bytesPerSecond: number): string | null;
13
- //# sourceMappingURL=format-eta.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"format-eta.d.ts","sourceRoot":"","sources":["../../src/helpers/format-eta.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,wBAAgB,SAAS,CACvB,cAAc,EAAE,MAAM,EACtB,cAAc,EAAE,MAAM,GACrB,MAAM,GAAG,IAAI,CAYf"}
@@ -1,9 +0,0 @@
1
- import type { ValidateFileError } from "@dimah-s3/core";
2
- /**
3
- * Localized {@link ValidateFileError} → string.
4
- *
5
- * `t("…")` call sites are nested under `useTranslations()` so fuma-translate
6
- * can extract keys.
7
- */
8
- export declare function useFormatValidateFileError(): (error: ValidateFileError) => string;
9
- //# sourceMappingURL=format-validate-file-error.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"format-validate-file-error.d.ts","sourceRoot":"","sources":["../../src/helpers/format-validate-file-error.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAGxD;;;;;GAKG;AACH,wBAAgB,0BAA0B,IAAI,CAC5C,KAAK,EAAE,iBAAiB,KACrB,MAAM,CAwBV"}
@@ -1,7 +0,0 @@
1
- export { useUpload, type UseUploadOptions, type UseUploadReturn, type UploadPolicy, type FileRejection, type DropzoneRootProps, type DropzoneInputProps, } from "./use-upload";
2
- export { useDownload, isFetchDownload, type DownloadPhase, type DownloadHooks, type FetchDownloadPhase, type FetchDownloadProgress, type FetchDownloadHooks, type UseDownloadOptions, type UseDownloadReturn, type UseNavigateDownloadOptions, type UseNavigateDownloadReturn, type UseFetchDownloadOptions, type UseFetchDownloadState, type UseFetchDownloadReturn, } from "./use-download";
3
- export { useDelete, type UseDeleteOptions, type UseDeleteState, type UseDeleteReturn, } from "./use-delete";
4
- export { useObjectUrl, type UseObjectUrlOptions, type UseObjectUrlReturn, } from "./use-object-url";
5
- export { useObjectList, type UseObjectListOptions, type UseObjectListReturn, type ObjectListFolder, type ObjectListPage, type ObjectListQuery, type ObjectListQueryInput, } from "./use-object-list";
6
- export { useRouteUploadPolicy, type CatalogLoadStatus, type UseRouteUploadPolicyOptions, type UseRouteUploadPolicyReturn, } from "./use-route-upload-policy";
7
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,GACxB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,WAAW,EACX,eAAe,EACf,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,0BAA0B,EAC/B,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,GAC5B,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,SAAS,EACT,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,KAAK,eAAe,GACrB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,YAAY,EACZ,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,GACxB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,aAAa,EACb,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,KAAK,oBAAoB,GAC1B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,oBAAoB,EACpB,KAAK,iBAAiB,EACtB,KAAK,2BAA2B,EAChC,KAAK,0BAA0B,GAChC,MAAM,2BAA2B,CAAC"}
@@ -1,10 +0,0 @@
1
- /**
2
- * Keeps a ref in sync with the latest value after each render.
3
- *
4
- * Use inside `useCallback(fn, [ref])` to read the latest prop / option value
5
- * without making the callback depend on it (stale-closure-free stable refs).
6
- *
7
- * @internal — not part of the public API.
8
- */
9
- export declare function useLiveRef<T>(value: T): import("react").RefObject<T>;
10
- //# sourceMappingURL=internal-helpers.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"internal-helpers.d.ts","sourceRoot":"","sources":["../src/internal-helpers.ts"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,gCAMrC"}
@@ -1,8 +0,0 @@
1
- import { type Draft } from "immer";
2
- /**
3
- * Per-hook local state with Immer patches.
4
- *
5
- * @internal
6
- */
7
- export declare function useImmerState<T extends object>(initialState: T): readonly [T, (recipe: (draft: Draft<T>) => void) => void, (next: T) => void];
8
- //# sourceMappingURL=use-immer-state.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"use-immer-state.d.ts","sourceRoot":"","sources":["../../src/store/use-immer-state.ts"],"names":[],"mappings":"AAGA,OAAO,EAAW,KAAK,KAAK,EAAE,MAAM,OAAO,CAAC;AAE5C;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,YAAY,EAAE,CAAC,yBAG1B,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,kBAIzB,CAAC,WAKrC"}
@@ -1,27 +0,0 @@
1
- import { APIError } from "@dimah-s3/core";
2
- import type { UploadPhase } from "./upload";
3
- /**
4
- * Client-side upload failure (XHR to S3 / unexpected throw).
5
- *
6
- * Protocol errors from `S3Api` stay {@link APIError} — do not wrap them
7
- * or the stable `code` is lost for i18n.
8
- */
9
- export declare class S3UploadError extends Error {
10
- readonly name = "S3UploadError";
11
- readonly code: string;
12
- readonly status: number;
13
- readonly phase: UploadPhase | undefined;
14
- constructor(message: string, code: string, status?: number, phase?: UploadPhase, options?: ErrorOptions);
15
- get statusCode(): number;
16
- }
17
- /**
18
- * Normalize unknown throws for the upload engine.
19
- * Preserves AbortError and {@link APIError}; wraps everything else.
20
- */
21
- export declare function toUploadError(err: unknown, phase?: UploadPhase): APIError | S3UploadError;
22
- /** Normalize unknown throws for hook `error` state. */
23
- export declare function toHookError(err: unknown, fallback?: string): APIError;
24
- export declare function isAbortError(err: unknown): boolean;
25
- /** Client-side block from a `before*` hook (`false` return). */
26
- export declare function hookBlockedError(message: string): APIError;
27
- //# sourceMappingURL=error.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../src/types/error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAc,MAAM,gBAAgB,CAAC;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAE5C;;;;;GAKG;AACH,qBAAa,aAAc,SAAQ,KAAK;IACtC,SAAkB,IAAI,mBAAmB;IACzC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,SAAS,CAAC;IAExC,YACE,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,MAAM,SAAM,EACZ,KAAK,CAAC,EAAE,WAAW,EACnB,OAAO,CAAC,EAAE,YAAY,EAMvB;IAED,IAAI,UAAU,IAAI,MAAM,CAEvB;CACF;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAC3B,GAAG,EAAE,OAAO,EACZ,KAAK,CAAC,EAAE,WAAW,GAClB,QAAQ,GAAG,aAAa,CAoB1B;AAED,uDAAuD;AACvD,wBAAgB,WAAW,CACzB,GAAG,EAAE,OAAO,EACZ,QAAQ,SAAmB,GAC1B,QAAQ,CAIV;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAOlD;AAED,gEAAgE;AAChE,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,QAAQ,CAE1D"}
@@ -1,26 +0,0 @@
1
- import type { FileUploadConfig, UploadPhase, UploadProgress, UploadResult, UploadRequestOptions } from "../types/index.js";
2
- import type { APIError, S3Api } from "@dimah-s3/core";
3
- export type FileItemStatus = "pending" | "uploading" | "success" | "error";
4
- export type FileItem = {
5
- id: string;
6
- file: File;
7
- status: FileItemStatus;
8
- progress: UploadProgress;
9
- result: UploadResult | null;
10
- error: APIError | null;
11
- };
12
- export type MultiUploadCallbacks = {
13
- onFileProgress?: (id: string, progress: UploadProgress) => void;
14
- onFileSuccess?: (id: string, result: UploadResult) => void;
15
- onFileError?: (id: string, error: APIError) => void;
16
- onTotalProgress?: (progress: UploadProgress) => void;
17
- /** Called once after multipart init for a file (id → uploadId, server key). */
18
- onMultipartInit?: (id: string, uploadId: string, key: string) => void;
19
- onFilePhaseChange?: (id: string, phase: Extract<UploadPhase, "presigning" | "uploading" | "finalizing">) => void;
20
- onPartUpload?: (id: string, partNumber: number, totalParts: number) => void;
21
- };
22
- export declare function uploadFiles(api: S3Api, items: Array<{
23
- id: string;
24
- file: File;
25
- }>, config: FileUploadConfig, callbacks?: MultiUploadCallbacks, signal?: AbortSignal, getRequestOptions?: (file: File) => UploadRequestOptions): Promise<FileItem[]>;
26
- //# sourceMappingURL=upload-files.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"upload-files.d.ts","sourceRoot":"","sources":["../../src/upload/upload-files.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,WAAW,EACX,cAAc,EACd,YAAY,EACZ,oBAAoB,EACrB,MAAM,SAAS,CAAC;AACjB,OAAO,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAKtD,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,WAAW,GAAG,SAAS,GAAG,OAAO,CAAC;AAE3E,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,IAAI,CAAC;IACX,MAAM,EAAE,cAAc,CAAC;IACvB,QAAQ,EAAE,cAAc,CAAC;IACzB,MAAM,EAAE,YAAY,GAAG,IAAI,CAAC;IAC5B,KAAK,EAAE,QAAQ,GAAG,IAAI,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,cAAc,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAC;IAChE,aAAa,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,KAAK,IAAI,CAAC;IAC3D,WAAW,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,KAAK,IAAI,CAAC;IACpD,eAAe,CAAC,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAC;IACrD,+EAA+E;IAC/E,eAAe,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IACtE,iBAAiB,CAAC,EAAE,CAClB,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,OAAO,CAAC,WAAW,EAAE,YAAY,GAAG,WAAW,GAAG,YAAY,CAAC,KACnE,IAAI,CAAC;IACV,YAAY,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,KAAK,IAAI,CAAC;CAC7E,CAAC;AAEF,wBAAsB,WAAW,CAC/B,GAAG,EAAE,KAAK,EACV,KAAK,EAAE,KAAK,CAAC;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,IAAI,CAAA;CAAE,CAAC,EACxC,MAAM,EAAE,gBAAgB,EACxB,SAAS,GAAE,oBAAyB,EACpC,MAAM,CAAC,EAAE,WAAW,EACpB,iBAAiB,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,oBAAoB,GACvD,OAAO,CAAC,QAAQ,EAAE,CAAC,CAiFrB"}