@dimah-s3/core 1.0.1 → 1.1.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 (59) hide show
  1. package/README.md +1 -1
  2. package/dist/create-s3-client.d.ts.map +1 -1
  3. package/dist/error-codes.d.ts +11 -11
  4. package/dist/error-codes.d.ts.map +1 -1
  5. package/dist/helpers/build-content-disposition.d.ts +3 -2
  6. package/dist/helpers/build-content-disposition.d.ts.map +1 -1
  7. package/dist/helpers/checksum.d.ts +5 -0
  8. package/dist/helpers/checksum.d.ts.map +1 -0
  9. package/dist/helpers/format-file-size.d.ts.map +1 -1
  10. package/dist/helpers/index.d.ts +7 -4
  11. package/dist/helpers/index.d.ts.map +1 -1
  12. package/dist/helpers/magic-bytes.d.ts +11 -0
  13. package/dist/helpers/magic-bytes.d.ts.map +1 -0
  14. package/dist/helpers/normalize-object-key.d.ts +8 -0
  15. package/dist/helpers/normalize-object-key.d.ts.map +1 -0
  16. package/dist/helpers/parse-file-name.d.ts +7 -0
  17. package/dist/helpers/parse-file-name.d.ts.map +1 -1
  18. package/dist/helpers/public-object-url.d.ts +10 -0
  19. package/dist/helpers/public-object-url.d.ts.map +1 -0
  20. package/dist/helpers/sanitize-file-name.d.ts +1 -1
  21. package/dist/helpers/sanitize-file-name.d.ts.map +1 -1
  22. package/dist/helpers/validate-file.d.ts +5 -0
  23. package/dist/helpers/validate-file.d.ts.map +1 -1
  24. package/dist/index.js +231 -86
  25. package/dist/index.js.map +1 -1
  26. package/dist/plugin/plugin-path.d.ts.map +1 -1
  27. package/dist/plugin/types.d.ts +1 -1
  28. package/dist/plugin/types.d.ts.map +1 -1
  29. package/dist/routes.d.ts +3 -0
  30. package/dist/routes.d.ts.map +1 -1
  31. package/dist/schema/catalog.d.ts +105 -0
  32. package/dist/schema/catalog.d.ts.map +1 -0
  33. package/dist/schema/delete.d.ts +8 -3
  34. package/dist/schema/delete.d.ts.map +1 -1
  35. package/dist/schema/download.d.ts +9 -6
  36. package/dist/schema/download.d.ts.map +1 -1
  37. package/dist/schema/file.d.ts +12 -0
  38. package/dist/schema/file.d.ts.map +1 -0
  39. package/dist/schema/index.d.ts +6 -3
  40. package/dist/schema/index.d.ts.map +1 -1
  41. package/dist/schema/multipart.d.ts +23 -26
  42. package/dist/schema/multipart.d.ts.map +1 -1
  43. package/dist/schema/shared.d.ts +14 -7
  44. package/dist/schema/shared.d.ts.map +1 -1
  45. package/dist/schema/upload.d.ts +9 -14
  46. package/dist/schema/upload.d.ts.map +1 -1
  47. package/dist/types/index.d.ts +5 -2
  48. package/dist/types/index.d.ts.map +1 -1
  49. package/dist/types/requests.d.ts +23 -17
  50. package/dist/types/requests.d.ts.map +1 -1
  51. package/dist/types/responses.d.ts +62 -48
  52. package/dist/types/responses.d.ts.map +1 -1
  53. package/dist/types/routes.d.ts +23 -0
  54. package/dist/types/routes.d.ts.map +1 -0
  55. package/package.json +6 -6
  56. package/dist/helpers/default-object-key.d.ts +0 -6
  57. package/dist/helpers/default-object-key.d.ts.map +0 -1
  58. package/dist/helpers/get-file-extension.d.ts +0 -2
  59. package/dist/helpers/get-file-extension.d.ts.map +0 -1
@@ -1,19 +1,14 @@
1
1
  import { z } from "zod";
2
2
  export declare const uploadBodySchema: z.ZodObject<{
3
- key: z.ZodString;
4
- contentType: z.ZodOptional<z.ZodString>;
5
- fileSize: z.ZodOptional<z.ZodNumber>;
3
+ route: z.ZodString;
4
+ fileName: z.ZodString;
5
+ fileSize: z.ZodNumber;
6
+ contentType: z.ZodPreprocess<z.ZodOptional<z.ZodString>, unknown>;
6
7
  metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
7
- bucket: z.ZodOptional<z.ZodString>;
8
- expiresIn: z.ZodOptional<z.ZodNumber>;
9
- acl: z.ZodOptional<z.ZodEnum<{
10
- private: "private";
11
- "public-read": "public-read";
12
- }>>;
13
- fileName: z.ZodOptional<z.ZodString>;
14
- }, z.core.$strip>;
8
+ checksum: z.ZodPreprocess<z.ZodOptional<z.ZodString>, unknown>;
9
+ }, z.core.$strict>;
15
10
  export declare const confirmBodySchema: z.ZodObject<{
16
- key: z.ZodString;
17
- bucket: z.ZodOptional<z.ZodString>;
18
- }, z.core.$strip>;
11
+ route: z.ZodString;
12
+ key: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
13
+ }, z.core.$strict>;
19
14
  //# sourceMappingURL=upload.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"upload.d.ts","sourceRoot":"","sources":["../../src/schema/upload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AASxB,eAAO,MAAM,gBAAgB;;;;;;;;;;;;iBAS3B,CAAC;AAEH,eAAO,MAAM,iBAAiB;;;iBAG5B,CAAC"}
1
+ {"version":3,"file":"upload.d.ts","sourceRoot":"","sources":["../../src/schema/upload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AASxB,eAAO,MAAM,gBAAgB;;;;;;;kBAQ3B,CAAC;AAEH,eAAO,MAAM,iBAAiB;;;kBAG5B,CAAC"}
@@ -1,4 +1,7 @@
1
1
  export type { UploadPresignMethod } from "./upload-presign-method";
2
- export type { S3ObjectAcl, S3ApiHeaders, UploadPayload, ConfirmPayload, DownloadOptions, DeleteOptions, MultipartInitPayload, MultipartSignPartPayload, MultipartListPartsPayload, MultipartCompletedPartRef, MultipartCompletePayload, MultipartAbortPayload, } from "./requests";
3
- export type { DeleteResponse, MultipartCompleteResponse, MultipartAbortResponse, PresignResponse, UploadPresignResponse, MultipartInitResponse, MultipartPartResponse, MultipartPartInfo, MultipartListPartsResponse, UploadConfirmResponse, S3Api, } from "./responses";
2
+ export type { S3ObjectAcl, S3ApiHeaders, UploadPayload, ConfirmPayload, DownloadPayload, DeletePayload, DeleteBatchPayload, FilePayload, MultipartInitPayload, MultipartSignPartPayload, MultipartListPartsPayload, MultipartCompletedPartRef, MultipartCompletePayload, MultipartAbortPayload, } from "./requests";
3
+ export type { DeleteResponse, DeleteBatchItemResult, DeleteBatchResponse, MultipartCompleteResponse, MultipartAbortResponse, DownloadPresignResponse, UploadPresignResponse, MultipartInitResponse, MultipartPartResponse, MultipartPartInfo, MultipartListPartsResponse, UploadConfirmResponse, ConfirmedObjectResponse, S3Api, } from "./responses";
4
+ export type { RouteCatalogEntry, RouteCatalogResponse } from "../schema/catalog";
5
+ export type { ContentDispositionType } from "../helpers/build-content-disposition";
6
+ export type { DimahS3Routes, InferS3Routes, S3RouteName } from "./routes";
4
7
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AACnE,YAAY,EACV,WAAW,EACX,YAAY,EACZ,aAAa,EACb,cAAc,EACd,eAAe,EACf,aAAa,EACb,oBAAoB,EACpB,wBAAwB,EACxB,yBAAyB,EACzB,yBAAyB,EACzB,wBAAwB,EACxB,qBAAqB,GACtB,MAAM,YAAY,CAAC;AACpB,YAAY,EACV,cAAc,EACd,yBAAyB,EACzB,sBAAsB,EACtB,eAAe,EACf,qBAAqB,EACrB,qBAAqB,EACrB,qBAAqB,EACrB,iBAAiB,EACjB,0BAA0B,EAC1B,qBAAqB,EACrB,KAAK,GACN,MAAM,aAAa,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AACnE,YAAY,EACV,WAAW,EACX,YAAY,EACZ,aAAa,EACb,cAAc,EACd,eAAe,EACf,aAAa,EACb,kBAAkB,EAClB,WAAW,EACX,oBAAoB,EACpB,wBAAwB,EACxB,yBAAyB,EACzB,yBAAyB,EACzB,wBAAwB,EACxB,qBAAqB,GACtB,MAAM,YAAY,CAAC;AACpB,YAAY,EACV,cAAc,EACd,qBAAqB,EACrB,mBAAmB,EACnB,yBAAyB,EACzB,sBAAsB,EACtB,uBAAuB,EACvB,qBAAqB,EACrB,qBAAqB,EACrB,qBAAqB,EACrB,iBAAiB,EACjB,0BAA0B,EAC1B,qBAAqB,EACrB,uBAAuB,EACvB,KAAK,GACN,MAAM,aAAa,CAAC;AACrB,YAAY,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAChF,YAAY,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAClF,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC"}
@@ -1,8 +1,10 @@
1
1
  import type { z } from "zod";
2
2
  import type { confirmBodySchema, uploadBodySchema } from "../schema/upload";
3
3
  import type { downloadQuerySchema } from "../schema/download";
4
- import type { deleteQuerySchema } from "../schema/delete";
5
- import type { multipartAbortBodySchema, multipartCompleteBodySchema, multipartInitBodySchema, multipartListPartsQuerySchema, multipartSignPartBodySchema } from "../schema/multipart";
4
+ import type { deleteBatchBodySchema, deleteQuerySchema } from "../schema/delete";
5
+ import type { fileQuerySchema } from "../schema/file";
6
+ import type { S3RouteName } from "./routes";
7
+ import type { multipartAbortBodySchema, multipartCompleteBodySchema, multipartCompletedPartSchema, multipartInitBodySchema, multipartListPartsQuerySchema, multipartSignPartBodySchema } from "../schema/multipart";
6
8
  import type { s3ObjectAclSchema } from "../schema/shared";
7
9
  export type { UploadPresignMethod } from "./upload-presign-method";
8
10
  /** S3 object ACL. */
@@ -15,27 +17,31 @@ export type S3ApiHeaders = {
15
17
  /** Forwarded into a synthetic `Request` for server-side `api` calls. */
16
18
  headers?: HeadersInit;
17
19
  };
20
+ type WithNamedRoute<T> = Omit<T, "route"> & {
21
+ route: S3RouteName;
22
+ } & S3ApiHeaders;
18
23
  /** Payload for {@link S3Api.upload}. */
19
- export type UploadPayload = z.infer<typeof uploadBodySchema> & S3ApiHeaders;
24
+ export type UploadPayload = WithNamedRoute<z.infer<typeof uploadBodySchema>>;
20
25
  /** Payload for {@link S3Api.confirm}. */
21
- export type ConfirmPayload = z.infer<typeof confirmBodySchema> & S3ApiHeaders;
22
- /** Options for {@link S3Api.download}. */
23
- export type DownloadOptions = Omit<z.infer<typeof downloadQuerySchema>, "key"> & S3ApiHeaders;
24
- /** Options for {@link S3Api.delete}. */
25
- export type DeleteOptions = Omit<z.infer<typeof deleteQuerySchema>, "key"> & S3ApiHeaders;
26
+ export type ConfirmPayload = WithNamedRoute<z.infer<typeof confirmBodySchema>>;
27
+ /** Payload for {@link S3Api.download}. */
28
+ export type DownloadPayload = WithNamedRoute<z.infer<typeof downloadQuerySchema>>;
29
+ /** Payload for {@link S3Api.delete}. */
30
+ export type DeletePayload = WithNamedRoute<z.infer<typeof deleteQuerySchema>>;
31
+ /** Payload for {@link S3Api.deleteMany}. */
32
+ export type DeleteBatchPayload = WithNamedRoute<z.infer<typeof deleteBatchBodySchema>>;
33
+ /** Payload for {@link S3Api.file} (proxy download query). */
34
+ export type FilePayload = WithNamedRoute<z.infer<typeof fileQuerySchema>>;
26
35
  /** Payload for {@link S3Api.multipart.init}. */
27
- export type MultipartInitPayload = z.infer<typeof multipartInitBodySchema> & S3ApiHeaders;
36
+ export type MultipartInitPayload = WithNamedRoute<z.infer<typeof multipartInitBodySchema>>;
28
37
  /** Payload for {@link S3Api.multipart.signPart}. */
29
- export type MultipartSignPartPayload = z.infer<typeof multipartSignPartBodySchema> & S3ApiHeaders;
38
+ export type MultipartSignPartPayload = WithNamedRoute<z.infer<typeof multipartSignPartBodySchema>>;
30
39
  /** Payload for {@link S3Api.multipart.listParts}. */
31
- export type MultipartListPartsPayload = z.infer<typeof multipartListPartsQuerySchema> & S3ApiHeaders;
40
+ export type MultipartListPartsPayload = WithNamedRoute<z.infer<typeof multipartListPartsQuerySchema>>;
32
41
  /** A completed multipart part reference for {@link S3Api.multipart.complete}. */
33
- export type MultipartCompletedPartRef = {
34
- /** 1-based part number. */
35
- partNumber: number;
36
- };
42
+ export type MultipartCompletedPartRef = z.infer<typeof multipartCompletedPartSchema>;
37
43
  /** Payload for {@link S3Api.multipart.complete}. */
38
- export type MultipartCompletePayload = z.infer<typeof multipartCompleteBodySchema> & S3ApiHeaders;
44
+ export type MultipartCompletePayload = WithNamedRoute<z.infer<typeof multipartCompleteBodySchema>>;
39
45
  /** Payload for {@link S3Api.multipart.abort}. */
40
- export type MultipartAbortPayload = z.infer<typeof multipartAbortBodySchema> & S3ApiHeaders;
46
+ export type MultipartAbortPayload = WithNamedRoute<z.infer<typeof multipartAbortBodySchema>>;
41
47
  //# sourceMappingURL=requests.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../src/types/requests.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAC7B,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAC3E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAC7D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACzD,OAAO,KAAK,EACV,wBAAwB,EACxB,2BAA2B,EAC3B,uBAAuB,EACvB,6BAA6B,EAC7B,2BAA2B,EAC5B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEzD,YAAY,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAEnE,qBAAqB;AACrB,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,wEAAwE;IACxE,OAAO,CAAC,EAAE,WAAW,CAAC;CACvB,CAAC;AAEF,wCAAwC;AACxC,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,GAAG,YAAY,CAAC;AAE5E,yCAAyC;AACzC,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,GAAG,YAAY,CAAC;AAE9E,0CAA0C;AAC1C,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,EAAE,KAAK,CAAC,GAC5E,YAAY,CAAC;AAEf,wCAAwC;AACxC,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,EAAE,KAAK,CAAC,GACxE,YAAY,CAAC;AAEf,gDAAgD;AAChD,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,GACxE,YAAY,CAAC;AAEf,oDAAoD;AACpD,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAC5C,OAAO,2BAA2B,CACnC,GACC,YAAY,CAAC;AAEf,qDAAqD;AACrD,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC7C,OAAO,6BAA6B,CACrC,GACC,YAAY,CAAC;AAEf,iFAAiF;AACjF,MAAM,MAAM,yBAAyB,GAAG;IACtC,2BAA2B;IAC3B,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,oDAAoD;AACpD,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAC5C,OAAO,2BAA2B,CACnC,GACC,YAAY,CAAC;AAEf,iDAAiD;AACjD,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,GAC1E,YAAY,CAAC"}
1
+ {"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../src/types/requests.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAC7B,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAC3E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAC7D,OAAO,KAAK,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAChF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,KAAK,EACV,wBAAwB,EACxB,2BAA2B,EAC3B,4BAA4B,EAC5B,uBAAuB,EACvB,6BAA6B,EAC7B,2BAA2B,EAC5B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEzD,YAAY,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAEnE,qBAAqB;AACrB,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,wEAAwE;IACxE,OAAO,CAAC,EAAE,WAAW,CAAC;CACvB,CAAC;AAEF,KAAK,cAAc,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG;IAC1C,KAAK,EAAE,WAAW,CAAC;CACpB,GAAG,YAAY,CAAC;AAEjB,wCAAwC;AACxC,MAAM,MAAM,aAAa,GAAG,cAAc,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC,CAAC;AAE7E,yCAAyC;AACzC,MAAM,MAAM,cAAc,GAAG,cAAc,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC,CAAC;AAE/E,0CAA0C;AAC1C,MAAM,MAAM,eAAe,GAAG,cAAc,CAC1C,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CACpC,CAAC;AAEF,wCAAwC;AACxC,MAAM,MAAM,aAAa,GAAG,cAAc,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC,CAAC;AAE9E,4CAA4C;AAC5C,MAAM,MAAM,kBAAkB,GAAG,cAAc,CAC7C,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CACtC,CAAC;AAEF,6DAA6D;AAC7D,MAAM,MAAM,WAAW,GAAG,cAAc,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC,CAAC;AAE1E,gDAAgD;AAChD,MAAM,MAAM,oBAAoB,GAAG,cAAc,CAC/C,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CACxC,CAAC;AAEF,oDAAoD;AACpD,MAAM,MAAM,wBAAwB,GAAG,cAAc,CACnD,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAC5C,CAAC;AAEF,qDAAqD;AACrD,MAAM,MAAM,yBAAyB,GAAG,cAAc,CACpD,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAC9C,CAAC;AAEF,iFAAiF;AACjF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC7C,OAAO,4BAA4B,CACpC,CAAC;AAEF,oDAAoD;AACpD,MAAM,MAAM,wBAAwB,GAAG,cAAc,CACnD,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAC5C,CAAC;AAEF,iDAAiD;AACjD,MAAM,MAAM,qBAAqB,GAAG,cAAc,CAChD,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CACzC,CAAC"}
@@ -1,26 +1,53 @@
1
- import type { ConfirmPayload, DeleteOptions, DownloadOptions, MultipartAbortPayload, MultipartCompletePayload, MultipartInitPayload, MultipartListPartsPayload, MultipartSignPartPayload, S3ObjectAcl, UploadPayload, UploadPresignMethod } from "./requests";
1
+ import type { ConfirmPayload, DeleteBatchPayload, DeletePayload, DownloadPayload, MultipartAbortPayload, MultipartCompletePayload, MultipartInitPayload, MultipartListPartsPayload, MultipartSignPartPayload, S3ObjectAcl, UploadPayload, UploadPresignMethod } from "./requests";
2
+ import type { RouteCatalogResponse } from "../schema/catalog";
3
+ import type { ContentDispositionType } from "../helpers/build-content-disposition";
2
4
  /** Response from {@link S3Api.delete}. */
3
5
  export type DeleteResponse = {
4
- success: boolean;
6
+ success: true;
5
7
  bucket: string;
6
8
  key: string;
7
9
  };
8
- /** Response from {@link S3Api.multipart.complete}. */
9
- export type MultipartCompleteResponse = {
10
+ /** Per-key result from {@link S3Api.deleteMany}. */
11
+ export type DeleteBatchItemResult = {
12
+ key: string;
13
+ success: boolean;
14
+ error?: {
15
+ code: string;
16
+ message: string;
17
+ };
18
+ };
19
+ /** Response from {@link S3Api.deleteMany}. */
20
+ export type DeleteBatchResponse = {
21
+ results: DeleteBatchItemResult[];
22
+ };
23
+ /** Verified object metadata after confirm or multipart complete. */
24
+ export type ConfirmedObjectResponse = {
25
+ /** S3 object key. */
10
26
  key: string;
27
+ /** Target bucket. */
11
28
  bucket: string;
12
- uploadId: string;
29
+ /** MIME type from HeadObject. */
30
+ contentType?: string;
13
31
  /** Verified size in bytes. */
14
32
  contentLength: number;
15
- contentType?: string;
33
+ /** ETag from HeadObject. */
16
34
  eTag?: string;
35
+ /** Object metadata. */
17
36
  metadata: Record<string, string>;
18
- versionId?: string;
19
- lastModified?: string;
20
- /** Resolved ACL. Omitted when ACL lookup is disabled or unsupported. */
37
+ /** ACL from the upload policy (`upload.acl` / `object`). */
21
38
  acl?: S3ObjectAcl;
22
39
  /** Stored filename. */
23
40
  fileName?: string;
41
+ /** S3 version ID. */
42
+ versionId?: string;
43
+ /** Last modified timestamp. */
44
+ lastModified?: string;
45
+ };
46
+ /** Response from {@link S3Api.confirm}. */
47
+ export type UploadConfirmResponse = ConfirmedObjectResponse;
48
+ /** Response from {@link S3Api.multipart.complete}. */
49
+ export type MultipartCompleteResponse = ConfirmedObjectResponse & {
50
+ uploadId: string;
24
51
  };
25
52
  /** Response from {@link S3Api.multipart.abort}. */
26
53
  export type MultipartAbortResponse = {
@@ -29,19 +56,22 @@ export type MultipartAbortResponse = {
29
56
  key: string;
30
57
  uploadId: string;
31
58
  };
32
- /** Presigned GET URL for download. */
33
- export type PresignResponse = {
59
+ /** Presigned GET URL for download, or a same-origin proxy URL. */
60
+ export type DownloadPresignResponse = {
34
61
  /** S3 object key. */
35
62
  key: string;
36
63
  /** Target bucket. */
37
64
  bucket: string;
38
- /** Presigned URL. */
65
+ /** Presigned URL, or the same-origin `/file` URL when `mode` is `"proxy"`. */
39
66
  url: string;
40
- /** Validity in seconds. */
67
+ /** Validity in seconds. `0` when `mode` is `"proxy"` (session-bound). */
41
68
  expiresIn: number;
69
+ /** How the browser should fetch the object. @default "presign" */
70
+ mode?: "presign" | "proxy";
71
+ /** Content-Disposition used on the signed / proxied GET. */
72
+ disposition?: ContentDispositionType;
42
73
  };
43
- /** Presigned upload URL and method-specific fields. */
44
- export type UploadPresignResponse = {
74
+ type UploadPresignBase = {
45
75
  /** S3 object key. */
46
76
  key: string;
47
77
  /** Target bucket. */
@@ -50,13 +80,17 @@ export type UploadPresignResponse = {
50
80
  url: string;
51
81
  /** Validity in seconds. */
52
82
  expiresIn: number;
53
- /** HTTP method for the upload request. */
54
- method: UploadPresignMethod;
55
- /** Present when `method` is `"POST"`. Must be appended to FormData before the file. */
56
- fields?: Record<string, string>;
57
- /** Present when `method` is `"PUT"`. Must be set as request headers on the PUT request. */
58
- headers?: Record<string, string>;
59
83
  };
84
+ /** Presigned upload URL and method-specific fields. */
85
+ export type UploadPresignResponse = UploadPresignBase & ({
86
+ method: Extract<UploadPresignMethod, "POST">;
87
+ /** Form fields — append to FormData before the file. */
88
+ fields: Record<string, string>;
89
+ } | {
90
+ method: Extract<UploadPresignMethod, "PUT">;
91
+ /** Request headers for the PUT. */
92
+ headers: Record<string, string>;
93
+ });
60
94
  /** Response from multipart upload initialization. */
61
95
  export type MultipartInitResponse = {
62
96
  /** S3 object key. */
@@ -69,7 +103,7 @@ export type MultipartInitResponse = {
69
103
  /** Presigned URL for a single multipart part. */
70
104
  export type MultipartPartResponse = {
71
105
  /** Presigned PUT URL for this part. */
72
- presignedUrl: string;
106
+ url: string;
73
107
  /** 1-based part number. */
74
108
  partNumber: number;
75
109
  /** Multipart upload ID. */
@@ -79,7 +113,7 @@ export type MultipartPartResponse = {
79
113
  /** Validity in seconds. */
80
114
  expiresIn: number;
81
115
  /** Exact byte size locked into this part's presigned URL signature. */
82
- partSize?: number;
116
+ partSize: number;
83
117
  };
84
118
  /** A part already uploaded in a multipart session. */
85
119
  export type MultipartPartInfo = {
@@ -94,29 +128,6 @@ export type MultipartPartInfo = {
94
128
  export type MultipartListPartsResponse = {
95
129
  parts: MultipartPartInfo[];
96
130
  };
97
- /** Verified object metadata after upload confirmation. */
98
- export type UploadConfirmResponse = {
99
- /** S3 object key. */
100
- key: string;
101
- /** Target bucket. */
102
- bucket: string;
103
- /** MIME type from HeadObject. */
104
- contentType?: string;
105
- /** Verified size in bytes. */
106
- contentLength: number;
107
- /** ETag from HeadObject. */
108
- eTag?: string;
109
- /** Object metadata. */
110
- metadata: Record<string, string>;
111
- /** Object ACL. */
112
- acl?: S3ObjectAcl;
113
- /** Stored filename. */
114
- fileName?: string;
115
- /** S3 version ID. */
116
- versionId?: string;
117
- /** Last modified timestamp. */
118
- lastModified?: string;
119
- };
120
131
  /**
121
132
  * Presign API protocol shared by `@dimah-s3/react` hooks and `@dimah-s3/server`.
122
133
  *
@@ -126,8 +137,10 @@ export type UploadConfirmResponse = {
126
137
  export type S3Api = {
127
138
  upload: (payload: UploadPayload) => Promise<UploadPresignResponse>;
128
139
  confirm: (payload: ConfirmPayload) => Promise<UploadConfirmResponse>;
129
- download: (key: string, options?: DownloadOptions) => Promise<PresignResponse>;
130
- delete: (key: string, options?: DeleteOptions) => Promise<DeleteResponse>;
140
+ download: (payload: DownloadPayload) => Promise<DownloadPresignResponse>;
141
+ catalog: () => Promise<RouteCatalogResponse>;
142
+ delete: (payload: DeletePayload) => Promise<DeleteResponse>;
143
+ deleteMany: (payload: DeleteBatchPayload) => Promise<DeleteBatchResponse>;
131
144
  multipart: {
132
145
  init: (payload: MultipartInitPayload) => Promise<MultipartInitResponse>;
133
146
  signPart: (payload: MultipartSignPartPayload) => Promise<MultipartPartResponse>;
@@ -136,4 +149,5 @@ export type S3Api = {
136
149
  abort: (payload: MultipartAbortPayload) => Promise<MultipartAbortResponse>;
137
150
  };
138
151
  };
152
+ export {};
139
153
  //# sourceMappingURL=responses.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../src/types/responses.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,aAAa,EACb,eAAe,EACf,qBAAqB,EACrB,wBAAwB,EACxB,oBAAoB,EACpB,yBAAyB,EACzB,wBAAwB,EACxB,WAAW,EACX,aAAa,EACb,mBAAmB,EACpB,MAAM,YAAY,CAAC;AAEpB,0CAA0C;AAC1C,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,sDAAsD;AACtD,MAAM,MAAM,yBAAyB,GAAG;IACtC,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,8BAA8B;IAC9B,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,wEAAwE;IACxE,GAAG,CAAC,EAAE,WAAW,CAAC;IAClB,uBAAuB;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,mDAAmD;AACnD,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,sCAAsC;AACtC,MAAM,MAAM,eAAe,GAAG;IAC5B,qBAAqB;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,qBAAqB;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,2BAA2B;IAC3B,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,uDAAuD;AACvD,MAAM,MAAM,qBAAqB,GAAG;IAClC,qBAAqB;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,4BAA4B;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,2BAA2B;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,0CAA0C;IAC1C,MAAM,EAAE,mBAAmB,CAAC;IAC5B,uFAAuF;IACvF,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,2FAA2F;IAC3F,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC,CAAC;AAEF,qDAAqD;AACrD,MAAM,MAAM,qBAAqB,GAAG;IAClC,qBAAqB;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,8BAA8B;IAC9B,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,iDAAiD;AACjD,MAAM,MAAM,qBAAqB,GAAG;IAClC,uCAAuC;IACvC,YAAY,EAAE,MAAM,CAAC;IACrB,2BAA2B;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,2BAA2B;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,2BAA2B;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,uEAAuE;IACvE,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,sDAAsD;AACtD,MAAM,MAAM,iBAAiB,GAAG;IAC9B,2BAA2B;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,sDAAsD;AACtD,MAAM,MAAM,0BAA0B,GAAG;IACvC,KAAK,EAAE,iBAAiB,EAAE,CAAC;CAC5B,CAAC;AAEF,0DAA0D;AAC1D,MAAM,MAAM,qBAAqB,GAAG;IAClC,qBAAqB;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,iCAAiC;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,8BAA8B;IAC9B,aAAa,EAAE,MAAM,CAAC;IACtB,4BAA4B;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uBAAuB;IACvB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,kBAAkB;IAClB,GAAG,CAAC,EAAE,WAAW,CAAC;IAClB,uBAAuB;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qBAAqB;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,+BAA+B;IAC/B,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,KAAK,GAAG;IAClB,MAAM,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACnE,OAAO,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACrE,QAAQ,EAAE,CACR,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,eAAe,KACtB,OAAO,CAAC,eAAe,CAAC,CAAC;IAC9B,MAAM,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAC1E,SAAS,EAAE;QACT,IAAI,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,OAAO,CAAC,qBAAqB,CAAC,CAAC;QACxE,QAAQ,EAAE,CACR,OAAO,EAAE,wBAAwB,KAC9B,OAAO,CAAC,qBAAqB,CAAC,CAAC;QACpC,SAAS,EAAE,CACT,OAAO,EAAE,yBAAyB,KAC/B,OAAO,CAAC,0BAA0B,CAAC,CAAC;QACzC,QAAQ,EAAE,CACR,OAAO,EAAE,wBAAwB,KAC9B,OAAO,CAAC,yBAAyB,CAAC,CAAC;QACxC,KAAK,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,OAAO,CAAC,sBAAsB,CAAC,CAAC;KAC5E,CAAC;CACH,CAAC"}
1
+ {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../src/types/responses.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,kBAAkB,EAClB,aAAa,EACb,eAAe,EACf,qBAAqB,EACrB,wBAAwB,EACxB,oBAAoB,EACpB,yBAAyB,EACzB,wBAAwB,EACxB,WAAW,EACX,aAAa,EACb,mBAAmB,EACpB,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAElF,0CAA0C;AAC1C,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,IAAI,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,oDAAoD;AACpD,MAAM,MAAM,qBAAqB,GAAG;IAClC,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;CAC3C,CAAC;AAEF,8CAA8C;AAC9C,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,EAAE,qBAAqB,EAAE,CAAC;CAClC,CAAC;AAEF,oEAAoE;AACpE,MAAM,MAAM,uBAAuB,GAAG;IACpC,qBAAqB;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,iCAAiC;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,8BAA8B;IAC9B,aAAa,EAAE,MAAM,CAAC;IACtB,4BAA4B;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uBAAuB;IACvB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,4DAA4D;IAC5D,GAAG,CAAC,EAAE,WAAW,CAAC;IAClB,uBAAuB;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qBAAqB;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,+BAA+B;IAC/B,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,2CAA2C;AAC3C,MAAM,MAAM,qBAAqB,GAAG,uBAAuB,CAAC;AAE5D,sDAAsD;AACtD,MAAM,MAAM,yBAAyB,GAAG,uBAAuB,GAAG;IAChE,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,mDAAmD;AACnD,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,kEAAkE;AAClE,MAAM,MAAM,uBAAuB,GAAG;IACpC,qBAAqB;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,8EAA8E;IAC9E,GAAG,EAAE,MAAM,CAAC;IACZ,yEAAyE;IACzE,SAAS,EAAE,MAAM,CAAC;IAClB,kEAAkE;IAClE,IAAI,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC;IAC3B,4DAA4D;IAC5D,WAAW,CAAC,EAAE,sBAAsB,CAAC;CACtC,CAAC;AAEF,KAAK,iBAAiB,GAAG;IACvB,qBAAqB;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,4BAA4B;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,2BAA2B;IAC3B,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,uDAAuD;AACvD,MAAM,MAAM,qBAAqB,GAAG,iBAAiB,GACnD,CACI;IACE,MAAM,EAAE,OAAO,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;IAC7C,wDAAwD;IACxD,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAChC,GACD;IACE,MAAM,EAAE,OAAO,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;IAC5C,mCAAmC;IACnC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC,CACJ,CAAC;AAEJ,qDAAqD;AACrD,MAAM,MAAM,qBAAqB,GAAG;IAClC,qBAAqB;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,8BAA8B;IAC9B,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,iDAAiD;AACjD,MAAM,MAAM,qBAAqB,GAAG;IAClC,uCAAuC;IACvC,GAAG,EAAE,MAAM,CAAC;IACZ,2BAA2B;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,2BAA2B;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,2BAA2B;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,uEAAuE;IACvE,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,sDAAsD;AACtD,MAAM,MAAM,iBAAiB,GAAG;IAC9B,2BAA2B;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,sDAAsD;AACtD,MAAM,MAAM,0BAA0B,GAAG;IACvC,KAAK,EAAE,iBAAiB,EAAE,CAAC;CAC5B,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,KAAK,GAAG;IAClB,MAAM,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACnE,OAAO,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACrE,QAAQ,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,OAAO,CAAC,uBAAuB,CAAC,CAAC;IACzE,OAAO,EAAE,MAAM,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAC7C,MAAM,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAC5D,UAAU,EAAE,CAAC,OAAO,EAAE,kBAAkB,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC1E,SAAS,EAAE;QACT,IAAI,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,OAAO,CAAC,qBAAqB,CAAC,CAAC;QACxE,QAAQ,EAAE,CACR,OAAO,EAAE,wBAAwB,KAC9B,OAAO,CAAC,qBAAqB,CAAC,CAAC;QACpC,SAAS,EAAE,CACT,OAAO,EAAE,yBAAyB,KAC/B,OAAO,CAAC,0BAA0B,CAAC,CAAC;QACzC,QAAQ,EAAE,CACR,OAAO,EAAE,wBAAwB,KAC9B,OAAO,CAAC,yBAAyB,CAAC,CAAC;QACxC,KAAK,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,OAAO,CAAC,sBAAsB,CAAC,CAAC;KAC5E,CAAC;CACH,CAAC"}
@@ -0,0 +1,23 @@
1
+ /**
2
+ * Augment to lock client `route` props to your `dimahS3({ routes })` names.
3
+ *
4
+ * ```ts
5
+ * import type { InferS3Routes } from "@dimah-s3/core";
6
+ * import type { s3 } from "@/lib/s3";
7
+ *
8
+ * declare module "@dimah-s3/core" {
9
+ * interface DimahS3Routes extends Record<InferS3Routes<typeof s3>, true> {}
10
+ * }
11
+ * ```
12
+ */
13
+ export interface DimahS3Routes {
14
+ }
15
+ /** Named route. `string` until {@link DimahS3Routes} is augmented. */
16
+ export type S3RouteName = [keyof DimahS3Routes] extends [never] ? string : Extract<keyof DimahS3Routes, string>;
17
+ /** Route names inferred from a `dimahS3()` instance. */
18
+ export type InferS3Routes<T> = T extends {
19
+ $Infer: {
20
+ routes: infer R;
21
+ };
22
+ } ? Extract<R, string> : string;
23
+ //# sourceMappingURL=routes.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"routes.d.ts","sourceRoot":"","sources":["../../src/types/routes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,aAAa;CAAG;AAEjC,sEAAsE;AACtE,MAAM,MAAM,WAAW,GAAG,CAAC,MAAM,aAAa,CAAC,SAAS,CAAC,KAAK,CAAC,GAC3D,MAAM,GACN,OAAO,CAAC,MAAM,aAAa,EAAE,MAAM,CAAC,CAAC;AAEzC,wDAAwD;AACxD,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,MAAM,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GACpE,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,GAClB,MAAM,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dimah-s3/core",
3
- "version": "1.0.1",
3
+ "version": "1.1.0",
4
4
  "description": "Typed S3 presign protocol and fetch client shared by @dimah-s3/server and @dimah-s3/react",
5
5
  "keywords": [
6
6
  "s3",
@@ -38,16 +38,16 @@
38
38
  "dependencies": {
39
39
  "@better-fetch/fetch": "1.3.1",
40
40
  "better-call": "1.4.0",
41
- "zod": "^4.4.3"
41
+ "zod": "^4.5.4"
42
42
  },
43
43
  "devDependencies": {
44
- "eslint": "^10.9.0",
44
+ "@workspace/eslint-config": "0.0.1",
45
+ "@workspace/typescript-config": "0.0.1",
46
+ "eslint": "^10.9.1",
45
47
  "tsc-alias": "^1.9.2",
46
48
  "tsup": "^8.5.1",
47
49
  "typescript": "7.0.2",
48
- "vitest": "^4.1.11",
49
- "@workspace/eslint-config": "0.0.1",
50
- "@workspace/typescript-config": "0.0.1"
50
+ "vitest": "^4.1.11"
51
51
  },
52
52
  "publishConfig": {
53
53
  "access": "public"
@@ -1,6 +0,0 @@
1
- /**
2
- * Default object key for client uploads: a UUID prefix plus the sanitized
3
- * file name so two selections never overwrite the same key.
4
- */
5
- export declare function defaultObjectKey(file: File): string;
6
- //# sourceMappingURL=default-object-key.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"default-object-key.d.ts","sourceRoot":"","sources":["../../src/helpers/default-object-key.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAEnD"}
@@ -1,2 +0,0 @@
1
- export declare function getFileExtension(fileName: string): string;
2
- //# sourceMappingURL=get-file-extension.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"get-file-extension.d.ts","sourceRoot":"","sources":["../../src/helpers/get-file-extension.ts"],"names":[],"mappings":"AAAA,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAIzD"}