@payloadcms/storage-azure 4.0.0-internal.cea8867 → 4.0.0-internal.d21c039
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -10
- package/dist/adapter.d.ts +1 -1
- package/dist/adapter.d.ts.map +1 -1
- package/dist/adapter.js +24 -14
- package/dist/adapter.js.map +1 -1
- package/dist/client/AzureClientUploadHandler.d.ts +3 -4
- package/dist/client/AzureClientUploadHandler.d.ts.map +1 -1
- package/dist/client/AzureClientUploadHandler.js +2 -11
- package/dist/client/AzureClientUploadHandler.js.map +1 -1
- package/dist/client/handleAzureUpload.d.ts +2 -9
- package/dist/client/handleAzureUpload.d.ts.map +1 -1
- package/dist/client/handleAzureUpload.js +2 -27
- package/dist/client/handleAzureUpload.js.map +1 -1
- package/dist/deleteFile.d.ts +2 -5
- package/dist/deleteFile.d.ts.map +1 -1
- package/dist/deleteFile.js +2 -9
- package/dist/deleteFile.js.map +1 -1
- package/dist/generateURL.js +3 -3
- package/dist/generateURL.js.map +1 -1
- package/dist/generateUploadInstructions.d.ts +12 -0
- package/dist/generateUploadInstructions.d.ts.map +1 -0
- package/dist/generateUploadInstructions.js +57 -0
- package/dist/generateUploadInstructions.js.map +1 -0
- package/dist/getFile.d.ts +4 -4
- package/dist/getFile.d.ts.map +1 -1
- package/dist/getFile.js +13 -11
- package/dist/getFile.js.map +1 -1
- package/dist/index.d.ts +23 -17
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +25 -22
- package/dist/index.js.map +1 -1
- package/dist/isClientUploadAllowed.d.ts +6 -0
- package/dist/isClientUploadAllowed.d.ts.map +1 -0
- package/dist/isClientUploadAllowed.js +3 -0
- package/dist/isClientUploadAllowed.js.map +1 -0
- package/dist/uploadFile.d.ts +2 -5
- package/dist/uploadFile.d.ts.map +1 -1
- package/dist/uploadFile.js +2 -9
- package/dist/uploadFile.js.map +1 -1
- package/package.json +5 -5
- package/dist/client/handleAzureUpload.spec.d.ts +0 -2
- package/dist/client/handleAzureUpload.spec.d.ts.map +0 -1
- package/dist/client/handleAzureUpload.spec.js +0 -185
- package/dist/client/handleAzureUpload.spec.js.map +0 -1
- package/dist/generateSignedURL.d.ts +0 -14
- package/dist/generateSignedURL.d.ts.map +0 -1
- package/dist/generateSignedURL.js +0 -47
- package/dist/generateSignedURL.js.map +0 -1
package/README.md
CHANGED
|
@@ -14,7 +14,7 @@ pnpm add @payloadcms/storage-azure
|
|
|
14
14
|
|
|
15
15
|
- Configure the `collections` object to specify which collections should use the Azure Blob Storage adapter. The slug _must_ match one of your existing collection slugs.
|
|
16
16
|
- When enabled, this package will automatically set `disableLocalStorage` to `true` for each collection.
|
|
17
|
-
- When deploying to Vercel, server uploads are limited
|
|
17
|
+
- When deploying to Vercel, server uploads are limited to 4.5MB. Set `clientUploads` to `true` to use upload instructions and send files directly to Azure.
|
|
18
18
|
|
|
19
19
|
### Client uploads and CORS
|
|
20
20
|
|
|
@@ -58,12 +58,15 @@ export default buildConfig({
|
|
|
58
58
|
|
|
59
59
|
### Configuration Options
|
|
60
60
|
|
|
61
|
-
| Option | Description
|
|
62
|
-
| ---------------------- |
|
|
63
|
-
| `enabled` | Whether or not to enable the plugin
|
|
64
|
-
| `collections` | Collections to apply the Azure Blob adapter to
|
|
65
|
-
| `allowContainerCreate` | Whether or not to allow the container to be created if it does not exist
|
|
66
|
-
| `
|
|
67
|
-
| `
|
|
68
|
-
| `
|
|
69
|
-
| `
|
|
61
|
+
| Option | Description | Default |
|
|
62
|
+
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
|
|
63
|
+
| `enabled` | Whether or not to enable the plugin | `true` |
|
|
64
|
+
| `collections` | Collections to apply the Azure Blob adapter to | |
|
|
65
|
+
| `allowContainerCreate` | Whether or not to allow the container to be created if it does not exist | `false` |
|
|
66
|
+
| `containerAccess` | Public access level for a container the plugin creates. `'private'` (default) serves blobs only through Payload's access-controlled route; `'blob'` / `'container'` expose them to anonymous clients directly from Azure. Has no effect on containers that already exist. | `'private'` |
|
|
67
|
+
| `baseURL` | Base URL for the Azure Blob storage account | |
|
|
68
|
+
| `connectionString` | Azure Blob storage connection string | |
|
|
69
|
+
| `containerName` | Azure Blob storage container name | |
|
|
70
|
+
| `clientUploads` | Upload directly to Azure instead of through Payload. | |
|
|
71
|
+
|
|
72
|
+
> **Breaking change (private by default):** When `allowContainerCreate: true`, the plugin now creates containers with **private** access. Previously it created them with public `blob` access. If you relied on files being served directly from the anonymous Azure blob URL (typically alongside `disablePayloadAccessControl: true`), set `containerAccess: 'blob'` to restore the old behaviour. This only affects **newly created** containers — existing containers keep their current access level, so you must flip their ACL manually if needed.
|
package/dist/adapter.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ interface CreateAzureAdapterArgs {
|
|
|
5
5
|
baseURL: string;
|
|
6
6
|
clientUploads?: ClientUploadsConfig;
|
|
7
7
|
containerName: string;
|
|
8
|
-
createContainerIfNotExists: () => void;
|
|
8
|
+
createContainerIfNotExists: () => Promise<void> | void;
|
|
9
9
|
getStorageClient: () => ContainerClient;
|
|
10
10
|
useCompositePrefixes?: boolean;
|
|
11
11
|
}
|
package/dist/adapter.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAC1D,OAAO,KAAK,EACV,OAAO,EACP,mBAAmB,EAEpB,MAAM,wCAAwC,CAAA;
|
|
1
|
+
{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAC1D,OAAO,KAAK,EACV,OAAO,EACP,mBAAmB,EAEpB,MAAM,wCAAwC,CAAA;AAS/C,UAAU,sBAAsB;IAC9B,oBAAoB,EAAE,OAAO,CAAA;IAC7B,OAAO,EAAE,MAAM,CAAA;IACf,aAAa,CAAC,EAAE,mBAAmB,CAAA;IACnC,aAAa,EAAE,MAAM,CAAA;IACrB,0BAA0B,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IACtD,gBAAgB,EAAE,MAAM,eAAe,CAAA;IACvC,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,wBAAgB,kBAAkB,CAAC,EACjC,oBAAoB,EACpB,OAAO,EACP,aAAa,EACb,aAAa,EACb,0BAA0B,EAC1B,gBAAgB,EAChB,oBAA4B,GAC7B,EAAE,sBAAsB,GAAG,OAAO,CA+DlC"}
|
package/dist/adapter.js
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
import { deleteFile } from './deleteFile.js';
|
|
2
|
+
import { generateUploadInstructions } from './generateUploadInstructions.js';
|
|
2
3
|
import { generateURL } from './generateURL.js';
|
|
3
4
|
import { getFile } from './getFile.js';
|
|
5
|
+
import { isClientUploadAllowed } from './isClientUploadAllowed.js';
|
|
4
6
|
import { uploadFile } from './uploadFile.js';
|
|
5
7
|
export function createAzureAdapter({ allowContainerCreate, baseURL, clientUploads, containerName, createContainerIfNotExists, getStorageClient, useCompositePrefixes = false }) {
|
|
6
8
|
return ({ collection, prefix = '' })=>({
|
|
7
9
|
name: 'azure',
|
|
8
|
-
clientUploads,
|
|
9
10
|
generateURL: ({ filename, prefix: urlPrefix = '' })=>generateURL({
|
|
10
11
|
baseURL,
|
|
11
12
|
collectionPrefix: prefix,
|
|
@@ -14,35 +15,44 @@ export function createAzureAdapter({ allowContainerCreate, baseURL, clientUpload
|
|
|
14
15
|
prefix: urlPrefix,
|
|
15
16
|
useCompositePrefixes
|
|
16
17
|
}),
|
|
17
|
-
|
|
18
|
-
|
|
18
|
+
uploadInstructions: {
|
|
19
|
+
adminHandler: {
|
|
20
|
+
path: '@payloadcms/storage-azure/client#AzureClientUploadHandler'
|
|
21
|
+
},
|
|
22
|
+
enabled: Boolean(clientUploads) && isClientUploadAllowed(collection),
|
|
23
|
+
generate: generateUploadInstructions({
|
|
24
|
+
access: typeof clientUploads === 'object' ? clientUploads.access : undefined,
|
|
19
25
|
collectionPrefix: prefix,
|
|
20
|
-
|
|
21
|
-
|
|
26
|
+
containerName,
|
|
27
|
+
getStorageClient,
|
|
22
28
|
useCompositePrefixes
|
|
23
29
|
}),
|
|
24
|
-
|
|
30
|
+
requiresUploadReceipt: true,
|
|
31
|
+
useInAdmin: true
|
|
32
|
+
},
|
|
33
|
+
handleDelete: ({ storageFilePath })=>deleteFile({
|
|
34
|
+
client: getStorageClient(),
|
|
35
|
+
storageFilePath
|
|
36
|
+
}),
|
|
37
|
+
handleUpload: async ({ data, file, storageFilePath })=>{
|
|
25
38
|
await uploadFile({
|
|
26
39
|
buffer: file.buffer,
|
|
27
40
|
client: getStorageClient(),
|
|
28
|
-
collectionPrefix: prefix,
|
|
29
|
-
docPrefix: data.prefix,
|
|
30
|
-
filename: file.filename,
|
|
31
41
|
mimeType: file.mimeType,
|
|
32
|
-
|
|
33
|
-
|
|
42
|
+
storageFilePath,
|
|
43
|
+
tempFilePath: file.tempFilePath
|
|
34
44
|
});
|
|
35
45
|
return data;
|
|
36
46
|
},
|
|
37
|
-
staticHandler: (req, { headers, params: {
|
|
47
|
+
staticHandler: (req, { doc, headers, params: { filename, uploadReference } })=>getFile({
|
|
38
48
|
client: getStorageClient(),
|
|
39
|
-
clientUploadContext,
|
|
40
49
|
collection,
|
|
41
50
|
collectionPrefix: prefix,
|
|
51
|
+
doc,
|
|
42
52
|
filename,
|
|
43
53
|
incomingHeaders: headers,
|
|
44
|
-
prefixQueryParam,
|
|
45
54
|
req,
|
|
55
|
+
uploadReference,
|
|
46
56
|
useCompositePrefixes
|
|
47
57
|
}),
|
|
48
58
|
...allowContainerCreate && {
|
package/dist/adapter.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/adapter.ts"],"sourcesContent":["import type { ContainerClient } from '@azure/storage-blob'\nimport type {\n Adapter,\n ClientUploadsConfig,\n GeneratedAdapter,\n} from '@payloadcms/plugin-cloud-storage/types'\n\nimport { deleteFile } from './deleteFile.js'\nimport { generateURL } from './generateURL.js'\nimport { getFile } from './getFile.js'\nimport { uploadFile } from './uploadFile.js'\n\ninterface CreateAzureAdapterArgs {\n allowContainerCreate: boolean\n baseURL: string\n clientUploads?: ClientUploadsConfig\n containerName: string\n createContainerIfNotExists: () => void\n getStorageClient: () => ContainerClient\n useCompositePrefixes?: boolean\n}\n\nexport function createAzureAdapter({\n allowContainerCreate,\n baseURL,\n clientUploads,\n containerName,\n createContainerIfNotExists,\n getStorageClient,\n useCompositePrefixes = false,\n}: CreateAzureAdapterArgs): Adapter {\n return ({ collection, prefix = '' }): GeneratedAdapter => ({\n name: 'azure',\n
|
|
1
|
+
{"version":3,"sources":["../src/adapter.ts"],"sourcesContent":["import type { ContainerClient } from '@azure/storage-blob'\nimport type {\n Adapter,\n ClientUploadsConfig,\n GeneratedAdapter,\n} from '@payloadcms/plugin-cloud-storage/types'\n\nimport { deleteFile } from './deleteFile.js'\nimport { generateUploadInstructions } from './generateUploadInstructions.js'\nimport { generateURL } from './generateURL.js'\nimport { getFile } from './getFile.js'\nimport { isClientUploadAllowed } from './isClientUploadAllowed.js'\nimport { uploadFile } from './uploadFile.js'\n\ninterface CreateAzureAdapterArgs {\n allowContainerCreate: boolean\n baseURL: string\n clientUploads?: ClientUploadsConfig\n containerName: string\n createContainerIfNotExists: () => Promise<void> | void\n getStorageClient: () => ContainerClient\n useCompositePrefixes?: boolean\n}\n\nexport function createAzureAdapter({\n allowContainerCreate,\n baseURL,\n clientUploads,\n containerName,\n createContainerIfNotExists,\n getStorageClient,\n useCompositePrefixes = false,\n}: CreateAzureAdapterArgs): Adapter {\n return ({ collection, prefix = '' }): GeneratedAdapter => ({\n name: 'azure',\n\n generateURL: ({ filename, prefix: urlPrefix = '' }) =>\n generateURL({\n baseURL,\n collectionPrefix: prefix,\n containerName,\n filename,\n prefix: urlPrefix,\n useCompositePrefixes,\n }),\n\n uploadInstructions: {\n adminHandler: {\n path: '@payloadcms/storage-azure/client#AzureClientUploadHandler',\n },\n enabled: Boolean(clientUploads) && isClientUploadAllowed(collection),\n generate: generateUploadInstructions({\n access: typeof clientUploads === 'object' ? clientUploads.access : undefined,\n collectionPrefix: prefix,\n containerName,\n getStorageClient,\n useCompositePrefixes,\n }),\n requiresUploadReceipt: true,\n useInAdmin: true,\n },\n\n handleDelete: ({ storageFilePath }) =>\n deleteFile({\n client: getStorageClient(),\n storageFilePath,\n }),\n\n handleUpload: async ({ data, file, storageFilePath }) => {\n await uploadFile({\n buffer: file.buffer,\n client: getStorageClient(),\n mimeType: file.mimeType,\n storageFilePath,\n tempFilePath: file.tempFilePath,\n })\n\n return data\n },\n\n staticHandler: (req, { doc, headers, params: { filename, uploadReference } }) =>\n getFile({\n client: getStorageClient(),\n collection,\n collectionPrefix: prefix,\n doc,\n filename,\n incomingHeaders: headers,\n req,\n uploadReference,\n useCompositePrefixes,\n }),\n\n ...(allowContainerCreate && { onInit: createContainerIfNotExists }),\n })\n}\n"],"names":["deleteFile","generateUploadInstructions","generateURL","getFile","isClientUploadAllowed","uploadFile","createAzureAdapter","allowContainerCreate","baseURL","clientUploads","containerName","createContainerIfNotExists","getStorageClient","useCompositePrefixes","collection","prefix","name","filename","urlPrefix","collectionPrefix","uploadInstructions","adminHandler","path","enabled","Boolean","generate","access","undefined","requiresUploadReceipt","useInAdmin","handleDelete","storageFilePath","client","handleUpload","data","file","buffer","mimeType","tempFilePath","staticHandler","req","doc","headers","params","uploadReference","incomingHeaders","onInit"],"mappings":"AAOA,SAASA,UAAU,QAAQ,kBAAiB;AAC5C,SAASC,0BAA0B,QAAQ,kCAAiC;AAC5E,SAASC,WAAW,QAAQ,mBAAkB;AAC9C,SAASC,OAAO,QAAQ,eAAc;AACtC,SAASC,qBAAqB,QAAQ,6BAA4B;AAClE,SAASC,UAAU,QAAQ,kBAAiB;AAY5C,OAAO,SAASC,mBAAmB,EACjCC,oBAAoB,EACpBC,OAAO,EACPC,aAAa,EACbC,aAAa,EACbC,0BAA0B,EAC1BC,gBAAgB,EAChBC,uBAAuB,KAAK,EACL;IACvB,OAAO,CAAC,EAAEC,UAAU,EAAEC,SAAS,EAAE,EAAE,GAAwB,CAAA;YACzDC,MAAM;YAENd,aAAa,CAAC,EAAEe,QAAQ,EAAEF,QAAQG,YAAY,EAAE,EAAE,GAChDhB,YAAY;oBACVM;oBACAW,kBAAkBJ;oBAClBL;oBACAO;oBACAF,QAAQG;oBACRL;gBACF;YAEFO,oBAAoB;gBAClBC,cAAc;oBACZC,MAAM;gBACR;gBACAC,SAASC,QAAQf,kBAAkBL,sBAAsBU;gBACzDW,UAAUxB,2BAA2B;oBACnCyB,QAAQ,OAAOjB,kBAAkB,WAAWA,cAAciB,MAAM,GAAGC;oBACnER,kBAAkBJ;oBAClBL;oBACAE;oBACAC;gBACF;gBACAe,uBAAuB;gBACvBC,YAAY;YACd;YAEAC,cAAc,CAAC,EAAEC,eAAe,EAAE,GAChC/B,WAAW;oBACTgC,QAAQpB;oBACRmB;gBACF;YAEFE,cAAc,OAAO,EAAEC,IAAI,EAAEC,IAAI,EAAEJ,eAAe,EAAE;gBAClD,MAAM1B,WAAW;oBACf+B,QAAQD,KAAKC,MAAM;oBACnBJ,QAAQpB;oBACRyB,UAAUF,KAAKE,QAAQ;oBACvBN;oBACAO,cAAcH,KAAKG,YAAY;gBACjC;gBAEA,OAAOJ;YACT;YAEAK,eAAe,CAACC,KAAK,EAAEC,GAAG,EAAEC,OAAO,EAAEC,QAAQ,EAAE1B,QAAQ,EAAE2B,eAAe,EAAE,EAAE,GAC1EzC,QAAQ;oBACN6B,QAAQpB;oBACRE;oBACAK,kBAAkBJ;oBAClB0B;oBACAxB;oBACA4B,iBAAiBH;oBACjBF;oBACAI;oBACA/B;gBACF;YAEF,GAAIN,wBAAwB;gBAAEuC,QAAQnC;YAA2B,CAAC;QACpE,CAAA;AACF"}
|
|
@@ -1,9 +1,8 @@
|
|
|
1
|
-
export declare const AzureClientUploadHandler: ({ children, collectionSlug,
|
|
1
|
+
export declare const AzureClientUploadHandler: ({ children, collectionSlug, endpointPath, prefix, props, }: {
|
|
2
2
|
children: import("react").ReactNode;
|
|
3
3
|
collectionSlug: import("payload").UploadCollectionSlug;
|
|
4
|
-
|
|
5
|
-
extra: Record<string, unknown>;
|
|
4
|
+
endpointPath?: `/${string}`;
|
|
6
5
|
prefix?: string;
|
|
7
|
-
|
|
6
|
+
props: Record<string, unknown>;
|
|
8
7
|
}) => import("react").JSX.Element;
|
|
9
8
|
//# sourceMappingURL=AzureClientUploadHandler.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AzureClientUploadHandler.d.ts","sourceRoot":"","sources":["../../src/client/AzureClientUploadHandler.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,wBAAwB
|
|
1
|
+
{"version":3,"file":"AzureClientUploadHandler.d.ts","sourceRoot":"","sources":["../../src/client/AzureClientUploadHandler.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,wBAAwB;;;;;;iCAGnC,CAAA"}
|
|
@@ -2,17 +2,8 @@
|
|
|
2
2
|
import { createClientUploadHandler } from '@payloadcms/plugin-cloud-storage/client';
|
|
3
3
|
import { handleAzureUpload } from './handleAzureUpload.js';
|
|
4
4
|
export const AzureClientUploadHandler = createClientUploadHandler({
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
apiRoute,
|
|
8
|
-
collectionSlug,
|
|
9
|
-
docPrefix,
|
|
10
|
-
file,
|
|
11
|
-
serverHandlerPath,
|
|
12
|
-
serverURL,
|
|
13
|
-
updateFilename
|
|
14
|
-
});
|
|
15
|
-
}
|
|
5
|
+
name: 'uploadToAzure',
|
|
6
|
+
handler: handleAzureUpload
|
|
16
7
|
});
|
|
17
8
|
|
|
18
9
|
//# sourceMappingURL=AzureClientUploadHandler.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/client/AzureClientUploadHandler.ts"],"sourcesContent":["'use client'\nimport { createClientUploadHandler } from '@payloadcms/plugin-cloud-storage/client'\n\nimport { handleAzureUpload } from './handleAzureUpload.js'\n\nexport const AzureClientUploadHandler = createClientUploadHandler({\n
|
|
1
|
+
{"version":3,"sources":["../../src/client/AzureClientUploadHandler.ts"],"sourcesContent":["'use client'\nimport { createClientUploadHandler } from '@payloadcms/plugin-cloud-storage/client'\n\nimport { handleAzureUpload } from './handleAzureUpload.js'\n\nexport const AzureClientUploadHandler = createClientUploadHandler({\n name: 'uploadToAzure',\n handler: handleAzureUpload,\n})\n"],"names":["createClientUploadHandler","handleAzureUpload","AzureClientUploadHandler","name","handler"],"mappings":"AAAA;AACA,SAASA,yBAAyB,QAAQ,0CAAyC;AAEnF,SAASC,iBAAiB,QAAQ,yBAAwB;AAE1D,OAAO,MAAMC,2BAA2BF,0BAA0B;IAChEG,MAAM;IACNC,SAASH;AACX,GAAE"}
|
|
@@ -1,14 +1,7 @@
|
|
|
1
1
|
type HandleAzureUploadArgs = {
|
|
2
|
-
|
|
3
|
-
collectionSlug: string;
|
|
4
|
-
docPrefix?: string;
|
|
2
|
+
data?: unknown;
|
|
5
3
|
file: File;
|
|
6
|
-
serverHandlerPath: `/${string}`;
|
|
7
|
-
serverURL: string;
|
|
8
|
-
updateFilename: (value: string) => void;
|
|
9
4
|
};
|
|
10
|
-
export declare const handleAzureUpload: ({
|
|
11
|
-
prefix: string;
|
|
12
|
-
}>;
|
|
5
|
+
export declare const handleAzureUpload: ({ data, file }: HandleAzureUploadArgs) => Promise<void>;
|
|
13
6
|
export {};
|
|
14
7
|
//# sourceMappingURL=handleAzureUpload.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"handleAzureUpload.d.ts","sourceRoot":"","sources":["../../src/client/handleAzureUpload.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"handleAzureUpload.d.ts","sourceRoot":"","sources":["../../src/client/handleAzureUpload.ts"],"names":[],"mappings":"AASA,KAAK,qBAAqB,GAAG;IAC3B,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,IAAI,EAAE,IAAI,CAAA;CACX,CAAA;AAED,eAAO,MAAM,iBAAiB,mBAA0B,qBAAqB,KAAG,OAAO,CAAC,IAAI,CAc3F,CAAA"}
|
|
@@ -1,34 +1,12 @@
|
|
|
1
1
|
'use client';
|
|
2
|
-
import { formatAdminURL } from 'payload/shared';
|
|
3
2
|
// Balances upload parallelism against browser memory: `blockSize * concurrency`
|
|
4
3
|
// bytes are buffered in flight. The SDK uses a single Put Blob for small files
|
|
5
4
|
// and switches to Put Block + Put Block List above its single-shot threshold,
|
|
6
5
|
// lifting the ~5 GB single-request ceiling to Azure's block-blob maximum.
|
|
7
6
|
const BLOCK_SIZE = 64 * 1024 * 1024;
|
|
8
7
|
const CONCURRENCY = 4;
|
|
9
|
-
export const handleAzureUpload = async ({
|
|
10
|
-
const
|
|
11
|
-
apiRoute,
|
|
12
|
-
path: serverHandlerPath,
|
|
13
|
-
serverURL
|
|
14
|
-
});
|
|
15
|
-
const response = await fetch(endpointRoute, {
|
|
16
|
-
body: JSON.stringify({
|
|
17
|
-
collectionSlug,
|
|
18
|
-
docPrefix,
|
|
19
|
-
filename: file.name,
|
|
20
|
-
mimeType: file.type
|
|
21
|
-
}),
|
|
22
|
-
credentials: 'include',
|
|
23
|
-
method: 'POST'
|
|
24
|
-
});
|
|
25
|
-
if (!response.ok) {
|
|
26
|
-
throw new Error('Failed to retrieve signed URL for Azure client upload');
|
|
27
|
-
}
|
|
28
|
-
const { docPrefix: sanitizedDocPrefix, filename: sanitizedFilename, url } = await response.json();
|
|
29
|
-
if (sanitizedFilename && sanitizedFilename !== file.name) {
|
|
30
|
-
updateFilename(sanitizedFilename);
|
|
31
|
-
}
|
|
8
|
+
export const handleAzureUpload = async ({ data, file })=>{
|
|
9
|
+
const { url } = data;
|
|
32
10
|
// Loaded on demand so @azure/storage-blob is only pulled into the client bundle
|
|
33
11
|
// when a client upload actually runs, rather than for every Azure adapter user.
|
|
34
12
|
const { BlockBlobClient } = await import('@azure/storage-blob');
|
|
@@ -40,9 +18,6 @@ export const handleAzureUpload = async ({ apiRoute, collectionSlug, docPrefix, f
|
|
|
40
18
|
blockSize: BLOCK_SIZE,
|
|
41
19
|
concurrency: CONCURRENCY
|
|
42
20
|
});
|
|
43
|
-
return {
|
|
44
|
-
prefix: sanitizedDocPrefix
|
|
45
|
-
};
|
|
46
21
|
};
|
|
47
22
|
|
|
48
23
|
//# sourceMappingURL=handleAzureUpload.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/client/handleAzureUpload.ts"],"sourcesContent":["'use client'\
|
|
1
|
+
{"version":3,"sources":["../../src/client/handleAzureUpload.ts"],"sourcesContent":["'use client'\n\n// Balances upload parallelism against browser memory: `blockSize * concurrency`\n// bytes are buffered in flight. The SDK uses a single Put Blob for small files\n// and switches to Put Block + Put Block List above its single-shot threshold,\n// lifting the ~5 GB single-request ceiling to Azure's block-blob maximum.\nconst BLOCK_SIZE = 64 * 1024 * 1024\nconst CONCURRENCY = 4\n\ntype HandleAzureUploadArgs = {\n data?: unknown\n file: File\n}\n\nexport const handleAzureUpload = async ({ data, file }: HandleAzureUploadArgs): Promise<void> => {\n const { url } = data as { url: string }\n\n // Loaded on demand so @azure/storage-blob is only pulled into the client bundle\n // when a client upload actually runs, rather than for every Azure adapter user.\n const { BlockBlobClient } = await import('@azure/storage-blob')\n\n const blockBlobClient = new BlockBlobClient(url)\n\n await blockBlobClient.uploadData(file, {\n blobHTTPHeaders: { blobContentType: file.type },\n blockSize: BLOCK_SIZE,\n concurrency: CONCURRENCY,\n })\n}\n"],"names":["BLOCK_SIZE","CONCURRENCY","handleAzureUpload","data","file","url","BlockBlobClient","blockBlobClient","uploadData","blobHTTPHeaders","blobContentType","type","blockSize","concurrency"],"mappings":"AAAA;AAEA,gFAAgF;AAChF,+EAA+E;AAC/E,8EAA8E;AAC9E,0EAA0E;AAC1E,MAAMA,aAAa,KAAK,OAAO;AAC/B,MAAMC,cAAc;AAOpB,OAAO,MAAMC,oBAAoB,OAAO,EAAEC,IAAI,EAAEC,IAAI,EAAyB;IAC3E,MAAM,EAAEC,GAAG,EAAE,GAAGF;IAEhB,gFAAgF;IAChF,gFAAgF;IAChF,MAAM,EAAEG,eAAe,EAAE,GAAG,MAAM,MAAM,CAAC;IAEzC,MAAMC,kBAAkB,IAAID,gBAAgBD;IAE5C,MAAME,gBAAgBC,UAAU,CAACJ,MAAM;QACrCK,iBAAiB;YAAEC,iBAAiBN,KAAKO,IAAI;QAAC;QAC9CC,WAAWZ;QACXa,aAAaZ;IACf;AACF,EAAC"}
|
package/dist/deleteFile.d.ts
CHANGED
|
@@ -1,11 +1,8 @@
|
|
|
1
1
|
import type { ContainerClient } from '@azure/storage-blob';
|
|
2
2
|
interface DeleteArgs {
|
|
3
3
|
client: ContainerClient;
|
|
4
|
-
|
|
5
|
-
docPrefix: string;
|
|
6
|
-
filename: string;
|
|
7
|
-
useCompositePrefixes?: boolean;
|
|
4
|
+
storageFilePath: string;
|
|
8
5
|
}
|
|
9
|
-
export declare function deleteFile({ client,
|
|
6
|
+
export declare function deleteFile({ client, storageFilePath }: DeleteArgs): Promise<void>;
|
|
10
7
|
export {};
|
|
11
8
|
//# sourceMappingURL=deleteFile.d.ts.map
|
package/dist/deleteFile.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"deleteFile.d.ts","sourceRoot":"","sources":["../src/deleteFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;
|
|
1
|
+
{"version":3,"file":"deleteFile.d.ts","sourceRoot":"","sources":["../src/deleteFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAE1D,UAAU,UAAU;IAClB,MAAM,EAAE,eAAe,CAAA;IACvB,eAAe,EAAE,MAAM,CAAA;CACxB;AAED,wBAAsB,UAAU,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAIvF"}
|
package/dist/deleteFile.js
CHANGED
|
@@ -1,12 +1,5 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
const { fileKey } = getFileKey({
|
|
4
|
-
collectionPrefix,
|
|
5
|
-
docPrefix,
|
|
6
|
-
filename,
|
|
7
|
-
useCompositePrefixes
|
|
8
|
-
});
|
|
9
|
-
const blockBlobClient = client.getBlockBlobClient(fileKey);
|
|
1
|
+
export async function deleteFile({ client, storageFilePath }) {
|
|
2
|
+
const blockBlobClient = client.getBlockBlobClient(storageFilePath);
|
|
10
3
|
await blockBlobClient.deleteIfExists();
|
|
11
4
|
}
|
|
12
5
|
|
package/dist/deleteFile.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/deleteFile.ts"],"sourcesContent":["import type { ContainerClient } from '@azure/storage-blob'\n\
|
|
1
|
+
{"version":3,"sources":["../src/deleteFile.ts"],"sourcesContent":["import type { ContainerClient } from '@azure/storage-blob'\n\ninterface DeleteArgs {\n client: ContainerClient\n storageFilePath: string\n}\n\nexport async function deleteFile({ client, storageFilePath }: DeleteArgs): Promise<void> {\n const blockBlobClient = client.getBlockBlobClient(storageFilePath)\n\n await blockBlobClient.deleteIfExists()\n}\n"],"names":["deleteFile","client","storageFilePath","blockBlobClient","getBlockBlobClient","deleteIfExists"],"mappings":"AAOA,OAAO,eAAeA,WAAW,EAAEC,MAAM,EAAEC,eAAe,EAAc;IACtE,MAAMC,kBAAkBF,OAAOG,kBAAkB,CAACF;IAElD,MAAMC,gBAAgBE,cAAc;AACtC"}
|
package/dist/generateURL.js
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { buildStoragePathData } from '@payloadcms/plugin-cloud-storage/utilities';
|
|
2
2
|
export function generateURL({ baseURL, collectionPrefix = '', containerName, filename, prefix, useCompositePrefixes = false }) {
|
|
3
|
-
const {
|
|
3
|
+
const { storageFilePath } = buildStoragePathData({
|
|
4
4
|
collectionPrefix,
|
|
5
5
|
docPrefix: prefix,
|
|
6
6
|
filename,
|
|
7
7
|
useCompositePrefixes
|
|
8
8
|
});
|
|
9
|
-
return `${baseURL}/${containerName}/${
|
|
9
|
+
return `${baseURL}/${containerName}/${storageFilePath}`;
|
|
10
10
|
}
|
|
11
11
|
|
|
12
12
|
//# sourceMappingURL=generateURL.js.map
|
package/dist/generateURL.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/generateURL.ts"],"sourcesContent":["import {
|
|
1
|
+
{"version":3,"sources":["../src/generateURL.ts"],"sourcesContent":["import { buildStoragePathData } from '@payloadcms/plugin-cloud-storage/utilities'\n\ninterface GenerateURLArgs {\n baseURL: string\n collectionPrefix?: string\n containerName: string\n filename: string\n prefix: string\n useCompositePrefixes?: boolean\n}\n\nexport function generateURL({\n baseURL,\n collectionPrefix = '',\n containerName,\n filename,\n prefix,\n useCompositePrefixes = false,\n}: GenerateURLArgs): string {\n const { storageFilePath } = buildStoragePathData({\n collectionPrefix,\n docPrefix: prefix,\n filename,\n useCompositePrefixes,\n })\n\n return `${baseURL}/${containerName}/${storageFilePath}`\n}\n"],"names":["buildStoragePathData","generateURL","baseURL","collectionPrefix","containerName","filename","prefix","useCompositePrefixes","storageFilePath","docPrefix"],"mappings":"AAAA,SAASA,oBAAoB,QAAQ,6CAA4C;AAWjF,OAAO,SAASC,YAAY,EAC1BC,OAAO,EACPC,mBAAmB,EAAE,EACrBC,aAAa,EACbC,QAAQ,EACRC,MAAM,EACNC,uBAAuB,KAAK,EACZ;IAChB,MAAM,EAAEC,eAAe,EAAE,GAAGR,qBAAqB;QAC/CG;QACAM,WAAWH;QACXD;QACAE;IACF;IAEA,OAAO,GAAGL,QAAQ,CAAC,EAAEE,cAAc,CAAC,EAAEI,iBAAiB;AACzD"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { ContainerClient } from '@azure/storage-blob';
|
|
2
|
+
import type { GenerateUploadInstructions, UploadInstructionsAccess } from 'payload';
|
|
3
|
+
interface Args {
|
|
4
|
+
access?: UploadInstructionsAccess;
|
|
5
|
+
collectionPrefix: string;
|
|
6
|
+
containerName: string;
|
|
7
|
+
getStorageClient: () => ContainerClient;
|
|
8
|
+
useCompositePrefixes?: boolean;
|
|
9
|
+
}
|
|
10
|
+
export declare const generateUploadInstructions: ({ access, collectionPrefix, containerName, getStorageClient, useCompositePrefixes, }: Args) => GenerateUploadInstructions;
|
|
11
|
+
export {};
|
|
12
|
+
//# sourceMappingURL=generateUploadInstructions.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"generateUploadInstructions.d.ts","sourceRoot":"","sources":["../src/generateUploadInstructions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAA8B,MAAM,qBAAqB,CAAA;AACtF,OAAO,KAAK,EAAE,0BAA0B,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;AASnF,UAAU,IAAI;IACZ,MAAM,CAAC,EAAE,wBAAwB,CAAA;IACjC,gBAAgB,EAAE,MAAM,CAAA;IACxB,aAAa,EAAE,MAAM,CAAA;IACrB,gBAAgB,EAAE,MAAM,eAAe,CAAA;IACvC,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,eAAO,MAAM,0BAA0B,yFAMpC,IAAI,KAAG,0BA8DT,CAAA"}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
import { BlobSASPermissions, generateBlobSASQueryParameters } from '@azure/storage-blob';
|
|
2
|
+
import { resolveSignedURLKey } from '@payloadcms/plugin-cloud-storage/utilities';
|
|
3
|
+
import { APIError, Forbidden } from 'payload';
|
|
4
|
+
import { assertClientUploadAllowed } from 'payload/internal';
|
|
5
|
+
import { isClientUploadAllowed } from './isClientUploadAllowed.js';
|
|
6
|
+
export const generateUploadInstructions = ({ access, collectionPrefix, containerName, getStorageClient, useCompositePrefixes = false })=>{
|
|
7
|
+
return async ({ collectionSlug, docPrefix, filename, filesize, mimeType, overrideAccess, req })=>{
|
|
8
|
+
if (!overrideAccess && (access ? !await access({
|
|
9
|
+
collectionSlug,
|
|
10
|
+
req
|
|
11
|
+
}) : !req.user)) {
|
|
12
|
+
throw new Forbidden(req.t);
|
|
13
|
+
}
|
|
14
|
+
const collection = req.payload.collections[collectionSlug]?.config;
|
|
15
|
+
if (!isClientUploadAllowed(collection)) {
|
|
16
|
+
throw new APIError('Azure client uploads require allowRestrictedFileTypes to be enabled.', 400);
|
|
17
|
+
}
|
|
18
|
+
assertClientUploadAllowed({
|
|
19
|
+
collection,
|
|
20
|
+
filename,
|
|
21
|
+
mimeType
|
|
22
|
+
});
|
|
23
|
+
const { sanitizedFilename, storageFilePath, uploadReference } = await resolveSignedURLKey({
|
|
24
|
+
collectionPrefix,
|
|
25
|
+
collectionSlug,
|
|
26
|
+
docPrefix,
|
|
27
|
+
filename,
|
|
28
|
+
req,
|
|
29
|
+
useCompositePrefixes
|
|
30
|
+
});
|
|
31
|
+
const blobClient = getStorageClient().getBlobClient(storageFilePath);
|
|
32
|
+
const sasToken = generateBlobSASQueryParameters({
|
|
33
|
+
blobName: storageFilePath,
|
|
34
|
+
containerName,
|
|
35
|
+
contentType: mimeType,
|
|
36
|
+
expiresOn: new Date(Date.now() + 3 * 60 * 60 * 1000),
|
|
37
|
+
permissions: BlobSASPermissions.parse('c'),
|
|
38
|
+
startsOn: new Date(),
|
|
39
|
+
version: '2026-04-06'
|
|
40
|
+
}, getStorageClient().credential);
|
|
41
|
+
return {
|
|
42
|
+
name: 'uploadToAzure',
|
|
43
|
+
type: 'dispatch',
|
|
44
|
+
data: {
|
|
45
|
+
url: `${blobClient.url}?${sasToken.toString()}`
|
|
46
|
+
},
|
|
47
|
+
file: {
|
|
48
|
+
filename: sanitizedFilename,
|
|
49
|
+
mimeType,
|
|
50
|
+
size: filesize,
|
|
51
|
+
uploadReference
|
|
52
|
+
}
|
|
53
|
+
};
|
|
54
|
+
};
|
|
55
|
+
};
|
|
56
|
+
|
|
57
|
+
//# sourceMappingURL=generateUploadInstructions.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/generateUploadInstructions.ts"],"sourcesContent":["import type { ContainerClient, StorageSharedKeyCredential } from '@azure/storage-blob'\nimport type { GenerateUploadInstructions, UploadInstructionsAccess } from 'payload'\n\nimport { BlobSASPermissions, generateBlobSASQueryParameters } from '@azure/storage-blob'\nimport { resolveSignedURLKey } from '@payloadcms/plugin-cloud-storage/utilities'\nimport { APIError, Forbidden } from 'payload'\nimport { assertClientUploadAllowed } from 'payload/internal'\n\nimport { isClientUploadAllowed } from './isClientUploadAllowed.js'\n\ninterface Args {\n access?: UploadInstructionsAccess\n collectionPrefix: string\n containerName: string\n getStorageClient: () => ContainerClient\n useCompositePrefixes?: boolean\n}\n\nexport const generateUploadInstructions = ({\n access,\n collectionPrefix,\n containerName,\n getStorageClient,\n useCompositePrefixes = false,\n}: Args): GenerateUploadInstructions => {\n return async ({\n collectionSlug,\n docPrefix,\n filename,\n filesize,\n mimeType,\n overrideAccess,\n req,\n }) => {\n if (!overrideAccess && (access ? !(await access({ collectionSlug, req })) : !req.user)) {\n throw new Forbidden(req.t)\n }\n\n const collection = req.payload.collections[collectionSlug]?.config\n if (!isClientUploadAllowed(collection)) {\n throw new APIError(\n 'Azure client uploads require allowRestrictedFileTypes to be enabled.',\n 400,\n )\n }\n\n assertClientUploadAllowed({ collection, filename, mimeType })\n\n const { sanitizedFilename, storageFilePath, uploadReference } = await resolveSignedURLKey({\n collectionPrefix,\n collectionSlug,\n docPrefix,\n filename,\n req,\n useCompositePrefixes,\n })\n\n const blobClient = getStorageClient().getBlobClient(storageFilePath)\n\n const sasToken = generateBlobSASQueryParameters(\n {\n blobName: storageFilePath,\n containerName,\n contentType: mimeType,\n expiresOn: new Date(Date.now() + 3 * 60 * 60 * 1000),\n permissions: BlobSASPermissions.parse('c'),\n startsOn: new Date(),\n version: '2026-04-06',\n },\n getStorageClient().credential as StorageSharedKeyCredential,\n )\n\n return {\n name: 'uploadToAzure',\n type: 'dispatch',\n data: {\n url: `${blobClient.url}?${sasToken.toString()}`,\n },\n file: {\n filename: sanitizedFilename,\n mimeType,\n size: filesize,\n uploadReference,\n },\n }\n }\n}\n"],"names":["BlobSASPermissions","generateBlobSASQueryParameters","resolveSignedURLKey","APIError","Forbidden","assertClientUploadAllowed","isClientUploadAllowed","generateUploadInstructions","access","collectionPrefix","containerName","getStorageClient","useCompositePrefixes","collectionSlug","docPrefix","filename","filesize","mimeType","overrideAccess","req","user","t","collection","payload","collections","config","sanitizedFilename","storageFilePath","uploadReference","blobClient","getBlobClient","sasToken","blobName","contentType","expiresOn","Date","now","permissions","parse","startsOn","version","credential","name","type","data","url","toString","file","size"],"mappings":"AAGA,SAASA,kBAAkB,EAAEC,8BAA8B,QAAQ,sBAAqB;AACxF,SAASC,mBAAmB,QAAQ,6CAA4C;AAChF,SAASC,QAAQ,EAAEC,SAAS,QAAQ,UAAS;AAC7C,SAASC,yBAAyB,QAAQ,mBAAkB;AAE5D,SAASC,qBAAqB,QAAQ,6BAA4B;AAUlE,OAAO,MAAMC,6BAA6B,CAAC,EACzCC,MAAM,EACNC,gBAAgB,EAChBC,aAAa,EACbC,gBAAgB,EAChBC,uBAAuB,KAAK,EACvB;IACL,OAAO,OAAO,EACZC,cAAc,EACdC,SAAS,EACTC,QAAQ,EACRC,QAAQ,EACRC,QAAQ,EACRC,cAAc,EACdC,GAAG,EACJ;QACC,IAAI,CAACD,kBAAmBV,CAAAA,SAAS,CAAE,MAAMA,OAAO;YAAEK;YAAgBM;QAAI,KAAM,CAACA,IAAIC,IAAI,AAAD,GAAI;YACtF,MAAM,IAAIhB,UAAUe,IAAIE,CAAC;QAC3B;QAEA,MAAMC,aAAaH,IAAII,OAAO,CAACC,WAAW,CAACX,eAAe,EAAEY;QAC5D,IAAI,CAACnB,sBAAsBgB,aAAa;YACtC,MAAM,IAAInB,SACR,wEACA;QAEJ;QAEAE,0BAA0B;YAAEiB;YAAYP;YAAUE;QAAS;QAE3D,MAAM,EAAES,iBAAiB,EAAEC,eAAe,EAAEC,eAAe,EAAE,GAAG,MAAM1B,oBAAoB;YACxFO;YACAI;YACAC;YACAC;YACAI;YACAP;QACF;QAEA,MAAMiB,aAAalB,mBAAmBmB,aAAa,CAACH;QAEpD,MAAMI,WAAW9B,+BACf;YACE+B,UAAUL;YACVjB;YACAuB,aAAahB;YACbiB,WAAW,IAAIC,KAAKA,KAAKC,GAAG,KAAK,IAAI,KAAK,KAAK;YAC/CC,aAAarC,mBAAmBsC,KAAK,CAAC;YACtCC,UAAU,IAAIJ;YACdK,SAAS;QACX,GACA7B,mBAAmB8B,UAAU;QAG/B,OAAO;YACLC,MAAM;YACNC,MAAM;YACNC,MAAM;gBACJC,KAAK,GAAGhB,WAAWgB,GAAG,CAAC,CAAC,EAAEd,SAASe,QAAQ,IAAI;YACjD;YACAC,MAAM;gBACJhC,UAAUW;gBACVT;gBACA+B,MAAMhC;gBACNY;YACF;QACF;IACF;AACF,EAAC"}
|
package/dist/getFile.d.ts
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
import type { ContainerClient } from '@azure/storage-blob';
|
|
2
|
-
import type { CollectionConfig, PayloadRequest } from 'payload';
|
|
2
|
+
import type { CollectionConfig, PayloadRequest, TypeWithID } from 'payload';
|
|
3
3
|
interface GetFileArgs {
|
|
4
4
|
client: ContainerClient;
|
|
5
|
-
clientUploadContext?: unknown;
|
|
6
5
|
collection: CollectionConfig;
|
|
7
6
|
collectionPrefix?: string;
|
|
7
|
+
doc?: TypeWithID;
|
|
8
8
|
filename: string;
|
|
9
9
|
incomingHeaders?: Headers;
|
|
10
|
-
prefixQueryParam?: string;
|
|
11
10
|
req: PayloadRequest;
|
|
11
|
+
uploadReference?: unknown;
|
|
12
12
|
useCompositePrefixes?: boolean;
|
|
13
13
|
}
|
|
14
|
-
export declare function getFile({ client,
|
|
14
|
+
export declare function getFile({ client, collection, collectionPrefix, doc, filename, incomingHeaders, req, uploadReference, useCompositePrefixes, }: GetFileArgs): Promise<Response>;
|
|
15
15
|
export {};
|
|
16
16
|
//# sourceMappingURL=getFile.d.ts.map
|
package/dist/getFile.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"getFile.d.ts","sourceRoot":"","sources":["../src/getFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAA8B,eAAe,EAAE,MAAM,qBAAqB,CAAA;AACtF,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;
|
|
1
|
+
{"version":3,"file":"getFile.d.ts","sourceRoot":"","sources":["../src/getFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAA8B,eAAe,EAAE,MAAM,qBAAqB,CAAA;AACtF,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAU3E,UAAU,WAAW;IACnB,MAAM,EAAE,eAAe,CAAA;IACvB,UAAU,EAAE,gBAAgB,CAAA;IAC5B,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,GAAG,CAAC,EAAE,UAAU,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,GAAG,EAAE,cAAc,CAAA;IACnB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAgCD,wBAAsB,OAAO,CAAC,EAC5B,MAAM,EACN,UAAU,EACV,gBAAqB,EACrB,GAAG,EACH,QAAQ,EACR,eAAe,EACf,GAAG,EACH,eAAe,EACf,oBAA4B,GAC7B,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAyHjC"}
|
package/dist/getFile.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { RestError } from '@azure/storage-blob';
|
|
2
|
-
import { getFilePrefix as getDocPrefix
|
|
3
|
-
import { getRangeRequestInfo } from 'payload/internal';
|
|
2
|
+
import { buildStoragePathData, getFilePrefix as getDocPrefix } from '@payloadcms/plugin-cloud-storage/utilities';
|
|
3
|
+
import { getRangeRequestInfo, isXmlMimeType, uploadContentSecurityPolicy } from 'payload/internal';
|
|
4
4
|
const isNodeReadableStream = (body)=>{
|
|
5
5
|
return typeof body === 'object' && body !== null && 'pipe' in body && typeof body.pipe === 'function' && 'destroy' in body && typeof body.destroy === 'function';
|
|
6
6
|
};
|
|
@@ -13,7 +13,7 @@ const abortRequestAndDestroyStream = ({ abortController, blob })=>{
|
|
|
13
13
|
blob.readableStreamBody.destroy();
|
|
14
14
|
}
|
|
15
15
|
};
|
|
16
|
-
export async function getFile({ client,
|
|
16
|
+
export async function getFile({ client, collection, collectionPrefix = '', doc, filename, incomingHeaders, req, uploadReference, useCompositePrefixes = false }) {
|
|
17
17
|
let blob = undefined;
|
|
18
18
|
let streamed = false;
|
|
19
19
|
const abortController = new AbortController();
|
|
@@ -27,19 +27,21 @@ export async function getFile({ client, clientUploadContext, collection, collect
|
|
|
27
27
|
}
|
|
28
28
|
try {
|
|
29
29
|
const docPrefix = await getDocPrefix({
|
|
30
|
-
clientUploadContext,
|
|
31
30
|
collection,
|
|
31
|
+
collectionPrefix,
|
|
32
|
+
doc,
|
|
32
33
|
filename,
|
|
33
|
-
|
|
34
|
-
|
|
34
|
+
req,
|
|
35
|
+
uploadReference,
|
|
36
|
+
useCompositePrefixes
|
|
35
37
|
});
|
|
36
|
-
const {
|
|
38
|
+
const { storageFilePath } = buildStoragePathData({
|
|
37
39
|
collectionPrefix,
|
|
38
40
|
docPrefix,
|
|
39
41
|
filename,
|
|
40
42
|
useCompositePrefixes
|
|
41
43
|
});
|
|
42
|
-
const blockBlobClient = client.getBlockBlobClient(
|
|
44
|
+
const blockBlobClient = client.getBlockBlobClient(storageFilePath);
|
|
43
45
|
// Get file size for range validation
|
|
44
46
|
const properties = await blockBlobClient.getProperties();
|
|
45
47
|
const fileSize = properties.contentLength;
|
|
@@ -76,9 +78,9 @@ export async function getFile({ client, clientUploadContext, collection, collect
|
|
|
76
78
|
if (properties.etag) {
|
|
77
79
|
headers.append('ETag', String(properties.etag));
|
|
78
80
|
}
|
|
79
|
-
//
|
|
80
|
-
if (properties.contentType
|
|
81
|
-
headers.append('Content-Security-Policy',
|
|
81
|
+
// Apply a restrictive policy to XML-family responses served through Payload.
|
|
82
|
+
if (isXmlMimeType(properties.contentType)) {
|
|
83
|
+
headers.append('Content-Security-Policy', uploadContentSecurityPolicy);
|
|
82
84
|
}
|
|
83
85
|
const etagFromHeaders = req.headers.get('etag') || req.headers.get('if-none-match');
|
|
84
86
|
if (collection.upload && typeof collection.upload === 'object' && typeof collection.upload.modifyResponseHeaders === 'function') {
|
package/dist/getFile.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/getFile.ts"],"sourcesContent":["import type { BlobDownloadResponseParsed, ContainerClient } from '@azure/storage-blob'\nimport type { CollectionConfig, PayloadRequest } from 'payload'\nimport type { Readable } from 'stream'\n\nimport { RestError } from '@azure/storage-blob'\nimport {\n getFilePrefix as getDocPrefix,\n
|
|
1
|
+
{"version":3,"sources":["../src/getFile.ts"],"sourcesContent":["import type { BlobDownloadResponseParsed, ContainerClient } from '@azure/storage-blob'\nimport type { CollectionConfig, PayloadRequest, TypeWithID } from 'payload'\nimport type { Readable } from 'stream'\n\nimport { RestError } from '@azure/storage-blob'\nimport {\n buildStoragePathData,\n getFilePrefix as getDocPrefix,\n} from '@payloadcms/plugin-cloud-storage/utilities'\nimport { getRangeRequestInfo, isXmlMimeType, uploadContentSecurityPolicy } from 'payload/internal'\n\ninterface GetFileArgs {\n client: ContainerClient\n collection: CollectionConfig\n collectionPrefix?: string\n doc?: TypeWithID\n filename: string\n incomingHeaders?: Headers\n req: PayloadRequest\n uploadReference?: unknown\n useCompositePrefixes?: boolean\n}\n\nconst isNodeReadableStream = (\n body: BlobDownloadResponseParsed['readableStreamBody'],\n): body is Readable => {\n return (\n typeof body === 'object' &&\n body !== null &&\n 'pipe' in body &&\n typeof body.pipe === 'function' &&\n 'destroy' in body &&\n typeof body.destroy === 'function'\n )\n}\n\nconst abortRequestAndDestroyStream = ({\n abortController,\n blob,\n}: {\n abortController: AbortController\n blob?: BlobDownloadResponseParsed\n}) => {\n try {\n abortController.abort()\n } catch {\n /* noop */\n }\n if (blob?.readableStreamBody && isNodeReadableStream(blob.readableStreamBody)) {\n blob.readableStreamBody.destroy()\n }\n}\n\nexport async function getFile({\n client,\n collection,\n collectionPrefix = '',\n doc,\n filename,\n incomingHeaders,\n req,\n uploadReference,\n useCompositePrefixes = false,\n}: GetFileArgs): Promise<Response> {\n let blob: BlobDownloadResponseParsed | undefined = undefined\n let streamed = false\n\n const abortController = new AbortController()\n if (req.signal) {\n req.signal.addEventListener('abort', () => {\n abortRequestAndDestroyStream({ abortController, blob })\n })\n }\n\n try {\n const docPrefix = await getDocPrefix({\n collection,\n collectionPrefix,\n doc,\n filename,\n req,\n uploadReference,\n useCompositePrefixes,\n })\n\n const { storageFilePath } = buildStoragePathData({\n collectionPrefix,\n docPrefix,\n filename,\n useCompositePrefixes,\n })\n\n const blockBlobClient = client.getBlockBlobClient(storageFilePath)\n\n // Get file size for range validation\n const properties = await blockBlobClient.getProperties()\n const fileSize = properties.contentLength\n\n if (!fileSize) {\n return new Response('Internal Server Error', { status: 500 })\n }\n\n // Handle range request\n const rangeHeader = req.headers.get('range')\n const rangeResult = getRangeRequestInfo({ fileSize, rangeHeader })\n\n if (rangeResult.type === 'invalid') {\n return new Response(null, {\n headers: new Headers(rangeResult.headers),\n status: rangeResult.status,\n })\n }\n\n // Download with range if partial\n blob =\n rangeResult.type === 'partial'\n ? await blockBlobClient.download(\n rangeResult.rangeStart,\n rangeResult.rangeEnd - rangeResult.rangeStart + 1,\n { abortSignal: abortController.signal },\n )\n : await blockBlobClient.download(0, undefined, { abortSignal: abortController.signal })\n\n let headers = new Headers(incomingHeaders)\n\n // Add range-related headers from the result\n for (const [key, value] of Object.entries(rangeResult.headers)) {\n headers.append(key, value)\n }\n\n // Add Azure-specific headers\n headers.append('Content-Type', String(properties.contentType))\n if (properties.etag) {\n headers.append('ETag', String(properties.etag))\n }\n\n // Apply a restrictive policy to XML-family responses served through Payload.\n if (isXmlMimeType(properties.contentType)) {\n headers.append('Content-Security-Policy', uploadContentSecurityPolicy)\n }\n\n const etagFromHeaders = req.headers.get('etag') || req.headers.get('if-none-match')\n\n if (\n collection.upload &&\n typeof collection.upload === 'object' &&\n typeof collection.upload.modifyResponseHeaders === 'function'\n ) {\n headers = collection.upload.modifyResponseHeaders({ headers }) || headers\n }\n\n if (etagFromHeaders && etagFromHeaders === properties.etag) {\n return new Response(null, {\n headers,\n status: 304,\n })\n }\n\n if (!blob.readableStreamBody || !isNodeReadableStream(blob.readableStreamBody)) {\n return new Response('Internal Server Error', { status: 500 })\n }\n\n const stream = blob.readableStreamBody\n stream.on('error', (err: Error) => {\n req.payload.logger.error({\n err,\n msg: 'Error while streaming Azure blob (aborting)',\n })\n abortRequestAndDestroyStream({ abortController, blob })\n })\n\n streamed = true\n return new Response(stream, { headers, status: rangeResult.status })\n } catch (err: unknown) {\n if (err instanceof RestError && err.statusCode === 404) {\n return new Response(null, { status: 404, statusText: 'Not Found' })\n }\n req.payload.logger.error(err)\n return new Response('Internal Server Error', { status: 500 })\n } finally {\n if (!streamed) {\n abortRequestAndDestroyStream({ abortController, blob })\n }\n }\n}\n"],"names":["RestError","buildStoragePathData","getFilePrefix","getDocPrefix","getRangeRequestInfo","isXmlMimeType","uploadContentSecurityPolicy","isNodeReadableStream","body","pipe","destroy","abortRequestAndDestroyStream","abortController","blob","abort","readableStreamBody","getFile","client","collection","collectionPrefix","doc","filename","incomingHeaders","req","uploadReference","useCompositePrefixes","undefined","streamed","AbortController","signal","addEventListener","docPrefix","storageFilePath","blockBlobClient","getBlockBlobClient","properties","getProperties","fileSize","contentLength","Response","status","rangeHeader","headers","get","rangeResult","type","Headers","download","rangeStart","rangeEnd","abortSignal","key","value","Object","entries","append","String","contentType","etag","etagFromHeaders","upload","modifyResponseHeaders","stream","on","err","payload","logger","error","msg","statusCode","statusText"],"mappings":"AAIA,SAASA,SAAS,QAAQ,sBAAqB;AAC/C,SACEC,oBAAoB,EACpBC,iBAAiBC,YAAY,QACxB,6CAA4C;AACnD,SAASC,mBAAmB,EAAEC,aAAa,EAAEC,2BAA2B,QAAQ,mBAAkB;AAclG,MAAMC,uBAAuB,CAC3BC;IAEA,OACE,OAAOA,SAAS,YAChBA,SAAS,QACT,UAAUA,QACV,OAAOA,KAAKC,IAAI,KAAK,cACrB,aAAaD,QACb,OAAOA,KAAKE,OAAO,KAAK;AAE5B;AAEA,MAAMC,+BAA+B,CAAC,EACpCC,eAAe,EACfC,IAAI,EAIL;IACC,IAAI;QACFD,gBAAgBE,KAAK;IACvB,EAAE,OAAM;IACN,QAAQ,GACV;IACA,IAAID,MAAME,sBAAsBR,qBAAqBM,KAAKE,kBAAkB,GAAG;QAC7EF,KAAKE,kBAAkB,CAACL,OAAO;IACjC;AACF;AAEA,OAAO,eAAeM,QAAQ,EAC5BC,MAAM,EACNC,UAAU,EACVC,mBAAmB,EAAE,EACrBC,GAAG,EACHC,QAAQ,EACRC,eAAe,EACfC,GAAG,EACHC,eAAe,EACfC,uBAAuB,KAAK,EAChB;IACZ,IAAIZ,OAA+Ca;IACnD,IAAIC,WAAW;IAEf,MAAMf,kBAAkB,IAAIgB;IAC5B,IAAIL,IAAIM,MAAM,EAAE;QACdN,IAAIM,MAAM,CAACC,gBAAgB,CAAC,SAAS;YACnCnB,6BAA6B;gBAAEC;gBAAiBC;YAAK;QACvD;IACF;IAEA,IAAI;QACF,MAAMkB,YAAY,MAAM5B,aAAa;YACnCe;YACAC;YACAC;YACAC;YACAE;YACAC;YACAC;QACF;QAEA,MAAM,EAAEO,eAAe,EAAE,GAAG/B,qBAAqB;YAC/CkB;YACAY;YACAV;YACAI;QACF;QAEA,MAAMQ,kBAAkBhB,OAAOiB,kBAAkB,CAACF;QAElD,qCAAqC;QACrC,MAAMG,aAAa,MAAMF,gBAAgBG,aAAa;QACtD,MAAMC,WAAWF,WAAWG,aAAa;QAEzC,IAAI,CAACD,UAAU;YACb,OAAO,IAAIE,SAAS,yBAAyB;gBAAEC,QAAQ;YAAI;QAC7D;QAEA,uBAAuB;QACvB,MAAMC,cAAclB,IAAImB,OAAO,CAACC,GAAG,CAAC;QACpC,MAAMC,cAAcxC,oBAAoB;YAAEiC;YAAUI;QAAY;QAEhE,IAAIG,YAAYC,IAAI,KAAK,WAAW;YAClC,OAAO,IAAIN,SAAS,MAAM;gBACxBG,SAAS,IAAII,QAAQF,YAAYF,OAAO;gBACxCF,QAAQI,YAAYJ,MAAM;YAC5B;QACF;QAEA,iCAAiC;QACjC3B,OACE+B,YAAYC,IAAI,KAAK,YACjB,MAAMZ,gBAAgBc,QAAQ,CAC5BH,YAAYI,UAAU,EACtBJ,YAAYK,QAAQ,GAAGL,YAAYI,UAAU,GAAG,GAChD;YAAEE,aAAatC,gBAAgBiB,MAAM;QAAC,KAExC,MAAMI,gBAAgBc,QAAQ,CAAC,GAAGrB,WAAW;YAAEwB,aAAatC,gBAAgBiB,MAAM;QAAC;QAEzF,IAAIa,UAAU,IAAII,QAAQxB;QAE1B,4CAA4C;QAC5C,KAAK,MAAM,CAAC6B,KAAKC,MAAM,IAAIC,OAAOC,OAAO,CAACV,YAAYF,OAAO,EAAG;YAC9DA,QAAQa,MAAM,CAACJ,KAAKC;QACtB;QAEA,6BAA6B;QAC7BV,QAAQa,MAAM,CAAC,gBAAgBC,OAAOrB,WAAWsB,WAAW;QAC5D,IAAItB,WAAWuB,IAAI,EAAE;YACnBhB,QAAQa,MAAM,CAAC,QAAQC,OAAOrB,WAAWuB,IAAI;QAC/C;QAEA,6EAA6E;QAC7E,IAAIrD,cAAc8B,WAAWsB,WAAW,GAAG;YACzCf,QAAQa,MAAM,CAAC,2BAA2BjD;QAC5C;QAEA,MAAMqD,kBAAkBpC,IAAImB,OAAO,CAACC,GAAG,CAAC,WAAWpB,IAAImB,OAAO,CAACC,GAAG,CAAC;QAEnE,IACEzB,WAAW0C,MAAM,IACjB,OAAO1C,WAAW0C,MAAM,KAAK,YAC7B,OAAO1C,WAAW0C,MAAM,CAACC,qBAAqB,KAAK,YACnD;YACAnB,UAAUxB,WAAW0C,MAAM,CAACC,qBAAqB,CAAC;gBAAEnB;YAAQ,MAAMA;QACpE;QAEA,IAAIiB,mBAAmBA,oBAAoBxB,WAAWuB,IAAI,EAAE;YAC1D,OAAO,IAAInB,SAAS,MAAM;gBACxBG;gBACAF,QAAQ;YACV;QACF;QAEA,IAAI,CAAC3B,KAAKE,kBAAkB,IAAI,CAACR,qBAAqBM,KAAKE,kBAAkB,GAAG;YAC9E,OAAO,IAAIwB,SAAS,yBAAyB;gBAAEC,QAAQ;YAAI;QAC7D;QAEA,MAAMsB,SAASjD,KAAKE,kBAAkB;QACtC+C,OAAOC,EAAE,CAAC,SAAS,CAACC;YAClBzC,IAAI0C,OAAO,CAACC,MAAM,CAACC,KAAK,CAAC;gBACvBH;gBACAI,KAAK;YACP;YACAzD,6BAA6B;gBAAEC;gBAAiBC;YAAK;QACvD;QAEAc,WAAW;QACX,OAAO,IAAIY,SAASuB,QAAQ;YAAEpB;YAASF,QAAQI,YAAYJ,MAAM;QAAC;IACpE,EAAE,OAAOwB,KAAc;QACrB,IAAIA,eAAehE,aAAagE,IAAIK,UAAU,KAAK,KAAK;YACtD,OAAO,IAAI9B,SAAS,MAAM;gBAAEC,QAAQ;gBAAK8B,YAAY;YAAY;QACnE;QACA/C,IAAI0C,OAAO,CAACC,MAAM,CAACC,KAAK,CAACH;QACzB,OAAO,IAAIzB,SAAS,yBAAyB;YAAEC,QAAQ;QAAI;IAC7D,SAAU;QACR,IAAI,CAACb,UAAU;YACbhB,6BAA6B;gBAAEC;gBAAiBC;YAAK;QACvD;IACF;AACF"}
|