npm - @strapi/provider-upload-aws-s3 - Versions diffs - 0.0.0-next.dff425769af4d4d006725a10c395f59637403653 → 0.0.0-next.e037a7b2d1f48b7bd8bcd0d9400ca0f9ded8a982 - Mend

@strapi/provider-upload-aws-s3 0.0.0-next.dff425769af4d4d006725a10c395f59637403653 → 0.0.0-next.e037a7b2d1f48b7bd8bcd0d9400ca0f9ded8a982

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 (12) hide show

package/README.md CHANGED Viewed

@@ -70,11 +70,13 @@ module.exports = ({ env }) => ({
 });
 ```
-### Configuration for a private S3 bucket
+### Configuration for a private S3 bucket and signed URLs
-If your bucket is configured to be private, you will need to set the `ACL` option to `private` in the `params` object. This will ensure that the signed URL is generated with the correct permissions.
+If your bucket is configured to be private, you will need to set the `ACL` option to `private` in the `params` object. This will ensure file URLs are signed.
-You can also define the expiration time of the signed URL by setting the `signedUrlExpires` option in the `params` object. The default value is 7 days.
+**Note:** If you are using a CDN, the URLs will not be signed.
+You can also define the expiration time of the signed URL by setting the `signedUrlExpires` option in the `params` object. The default value is 15 minutes.
 `./config/plugins.js`
@@ -90,7 +92,7 @@ module.exports = ({ env }) => ({
         region: env('AWS_REGION'),
         params: {
           ACL: 'private', // <== set ACL to private
-          signedUrlExpires: env('AWS_SIGNED_URL_EXPIRES', 60 * 60 * 24 * 7),
+          signedUrlExpires: env('AWS_SIGNED_URL_EXPIRES', 15 * 60),
           Bucket: env('AWS_BUCKET'),
         },
       },
@@ -150,14 +152,14 @@ module.exports = [
             "'self'",
             'data:',
             'blob:',
-            'dl.airtable.com',
+            'market-assets.strapi.io',
             'yourBucketName.s3.yourRegion.amazonaws.com',
           ],
           'media-src': [
             "'self'",
             'data:',
             'blob:',
-            'dl.airtable.com',
+            'market-assets.strapi.io',
             'yourBucketName.s3.yourRegion.amazonaws.com',
           ],
           upgradeInsecureRequests: null,

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,46 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import type { ReadStream } from 'node:fs';
+import AWS from 'aws-sdk';
+interface File {
+    name: string;
+    alternativeText?: string;
+    caption?: string;
+    width?: number;
+    height?: number;
+    formats?: Record<string, unknown>;
+    hash: string;
+    ext?: string;
+    mime: string;
+    size: number;
+    url: string;
+    previewUrl?: string;
+    path?: string;
+    provider?: string;
+    provider_metadata?: Record<string, unknown>;
+    stream?: ReadStream;
+    buffer?: Buffer;
+}
+interface InitOptions extends Partial<AWS.S3.ClientConfiguration> {
+    baseUrl?: string;
+    rootPath?: string;
+    s3Options: AWS.S3.ClientConfiguration & {
+        params: {
+            Bucket: string;
+            ACL?: string;
+            signedUrlExpires?: string;
+        };
+    };
+}
+declare const _default: {
+    init({ baseUrl, rootPath, s3Options, ...legacyS3Options }: InitOptions): {
+        isPrivate(): boolean;
+        getSignedUrl(file: File): Promise<{
+            url: string;
+        }>;
+        uploadStream(file: File, customParams?: {}): Promise<void>;
+        upload(file: File, customParams?: {}): Promise<void>;
+        delete(file: File, customParams?: {}): Promise<void>;
+    };
+};
+export = _default;

package/dist/index.js ADDED Viewed

@@ -0,0 +1,112 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const fp_1 = require("lodash/fp");
+const aws_sdk_1 = __importDefault(require("aws-sdk"));
+const utils_1 = require("./utils");
+// TODO V5: Migrate to aws-sdk v3
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+require('aws-sdk/lib/maintenance_mode_message').suppress = true;
+function hasUrlProtocol(url) {
+    // Regex to test protocol like "http://", "https://"
+    return /^\w*:\/\//.test(url);
+}
+module.exports = {
+    init({ baseUrl, rootPath, s3Options, ...legacyS3Options }) {
+        if (Object.keys(legacyS3Options).length > 0) {
+            process.emitWarning("S3 configuration options passed at root level of the plugin's providerOptions is deprecated and will be removed in a future release. Please wrap them inside the 's3Options:{}' property.");
+        }
+        const config = { ...s3Options, ...legacyS3Options };
+        const S3 = new aws_sdk_1.default.S3({
+            apiVersion: '2006-03-01',
+            ...config,
+        });
+        const filePrefix = rootPath ? `${rootPath.replace(/\/+$/, '')}/` : '';
+        const getFileKey = (file) => {
+            const path = file.path ? `${file.path}/` : '';
+            return `${filePrefix}${path}${file.hash}${file.ext}`;
+        };
+        const ACL = (0, fp_1.getOr)('public-read', ['params', 'ACL'], config);
+        const upload = (file, customParams = {}) => new Promise((resolve, reject) => {
+            const fileKey = getFileKey(file);
+            if (!file.stream && !file.buffer) {
+                reject(new Error('Missing file stream or buffer'));
+                return;
+            }
+            const params = {
+                Key: fileKey,
+                Bucket: config.params.Bucket,
+                Body: file.stream || file.buffer,
+                ACL,
+                ContentType: file.mime,
+                ...customParams,
+            };
+            const onUploaded = (err, data) => {
+                if (err) {
+                    return reject(err);
+                }
+                // set the bucket file url
+                if (baseUrl) {
+                    // Construct the url with the baseUrl
+                    file.url = `${baseUrl}/${fileKey}`;
+                }
+                else {
+                    // Add the protocol if it is missing
+                    // Some providers like DigitalOcean Spaces return the url without the protocol
+                    file.url = hasUrlProtocol(data.Location) ? data.Location : `https://${data.Location}`;
+                }
+                resolve();
+            };
+            S3.upload(params, onUploaded);
+        });
+        return {
+            isPrivate() {
+                return ACL === 'private';
+            },
+            async getSignedUrl(file) {
+                // Do not sign the url if it does not come from the same bucket.
+                if (!(0, utils_1.isUrlFromBucket)(file.url, config.params.Bucket, baseUrl)) {
+                    return { url: file.url };
+                }
+                const signedUrlExpires = (0, fp_1.getOr)(15 * 60, ['params', 'signedUrlExpires'], config); // 15 minutes
+                return new Promise((resolve, reject) => {
+                    const fileKey = getFileKey(file);
+                    S3.getSignedUrl('getObject', {
+                        Bucket: config.params.Bucket,
+                        Key: fileKey,
+                        Expires: parseInt(signedUrlExpires, 10),
+                    }, (err, url) => {
+                        if (err) {
+                            return reject(err);
+                        }
+                        resolve({ url });
+                    });
+                });
+            },
+            uploadStream(file, customParams = {}) {
+                return upload(file, customParams);
+            },
+            upload(file, customParams = {}) {
+                return upload(file, customParams);
+            },
+            delete(file, customParams = {}) {
+                return new Promise((resolve, reject) => {
+                    // delete file on S3 bucket
+                    const fileKey = getFileKey(file);
+                    S3.deleteObject({
+                        Key: fileKey,
+                        Bucket: config.params.Bucket,
+                        ...customParams,
+                    }, (err) => {
+                        if (err) {
+                            return reject(err);
+                        }
+                        resolve();
+                    });
+                });
+            },
+        };
+    },
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AACA,kCAAkC;AAClC,sDAA0B;AAC1B,mCAA0C;AAsB1C,iCAAiC;AACjC,8DAA8D;AAC9D,OAAO,CAAC,sCAAsC,CAAC,CAAC,QAAQ,GAAG,IAAI,CAAC;AAEhE,SAAS,cAAc,CAAC,GAAW;IACjC,oDAAoD;IACpD,OAAO,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC/B,CAAC;AAcD,iBAAS;IACP,IAAI,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,eAAe,EAAe;QACpE,IAAI,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;YAC3C,OAAO,CAAC,WAAW,CACjB,2LAA2L,CAC5L,CAAC;SACH;QAED,MAAM,MAAM,GAAG,EAAE,GAAG,SAAS,EAAE,GAAG,eAAe,EAAE,CAAC;QAEpD,MAAM,EAAE,GAAG,IAAI,iBAAG,CAAC,EAAE,CAAC;YACpB,UAAU,EAAE,YAAY;YACxB,GAAG,MAAM;SACV,CAAC,CAAC;QAEH,MAAM,UAAU,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAEtE,MAAM,UAAU,GAAG,CAAC,IAAU,EAAE,EAAE;YAChC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YAE9C,OAAO,GAAG,UAAU,GAAG,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvD,CAAC,CAAC;QAEF,MAAM,GAAG,GAAG,IAAA,UAAK,EAAC,aAAa,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;QAE5D,MAAM,MAAM,GAAG,CAAC,IAAU,EAAE,YAAY,GAAG,EAAE,EAAiB,EAAE,CAC9D,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC9B,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;YAEjC,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;gBAChC,MAAM,CAAC,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC,CAAC;gBACnD,OAAO;aACR;YAED,MAAM,MAAM,GAAG;gBACb,GAAG,EAAE,OAAO;gBACZ,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM;gBAC5B,IAAI,EAAE,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM;gBAChC,GAAG;gBACH,WAAW,EAAE,IAAI,CAAC,IAAI;gBACtB,GAAG,YAAY;aAChB,CAAC;YAEF,MAAM,UAAU,GAAG,CAAC,GAAU,EAAE,IAAmC,EAAE,EAAE;gBACrE,IAAI,GAAG,EAAE;oBACP,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;iBACpB;gBAED,0BAA0B;gBAC1B,IAAI,OAAO,EAAE;oBACX,qCAAqC;oBACrC,IAAI,CAAC,GAAG,GAAG,GAAG,OAAO,IAAI,OAAO,EAAE,CAAC;iBACpC;qBAAM;oBACL,oCAAoC;oBACpC,8EAA8E;oBAC9E,IAAI,CAAC,GAAG,GAAG,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,IAAI,CAAC,QAAQ,EAAE,CAAC;iBACvF;gBACD,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC;YAEF,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;QAEL,OAAO;YACL,SAAS;gBACP,OAAO,GAAG,KAAK,SAAS,CAAC;YAC3B,CAAC;YACD,KAAK,CAAC,YAAY,CAAC,IAAU;gBAC3B,gEAAgE;gBAChE,IAAI,CAAC,IAAA,uBAAe,EAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE;oBAC7D,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC;iBAC1B;gBAED,MAAM,gBAAgB,GAAW,IAAA,UAAK,EAAC,EAAE,GAAG,EAAE,EAAE,CAAC,QAAQ,EAAE,kBAAkB,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,aAAa;gBAEtG,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;oBACrC,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;oBAEjC,EAAE,CAAC,YAAY,CACb,WAAW,EACX;wBACE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM;wBAC5B,GAAG,EAAE,OAAO;wBACZ,OAAO,EAAE,QAAQ,CAAC,gBAAgB,EAAE,EAAE,CAAC;qBACxC,EACD,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;wBACX,IAAI,GAAG,EAAE;4BACP,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;yBACpB;wBACD,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;oBACnB,CAAC,CACF,CAAC;gBACJ,CAAC,CAAC,CAAC;YACL,CAAC;YACD,YAAY,CAAC,IAAU,EAAE,YAAY,GAAG,EAAE;gBACxC,OAAO,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;YACpC,CAAC;YACD,MAAM,CAAC,IAAU,EAAE,YAAY,GAAG,EAAE;gBAClC,OAAO,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;YACpC,CAAC;YACD,MAAM,CAAC,IAAU,EAAE,YAAY,GAAG,EAAE;gBAClC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;oBACrC,2BAA2B;oBAC3B,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;oBACjC,EAAE,CAAC,YAAY,CACb;wBACE,GAAG,EAAE,OAAO;wBACZ,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM;wBAC5B,GAAG,YAAY;qBAChB,EACD,CAAC,GAAG,EAAE,EAAE;wBACN,IAAI,GAAG,EAAE;4BACP,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;yBACpB;wBAED,OAAO,EAAE,CAAC;oBACZ,CAAC,CACF,CAAC;gBACJ,CAAC,CAAC,CAAC;YACL,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC"}

package/dist/utils.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export declare function isUrlFromBucket(fileUrl: string, bucketName: string, baseUrl?: string): boolean;

package/dist/utils.js ADDED Viewed

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isUrlFromBucket = void 0;
+const ENDPOINT_PATTERN = /^(.+\.)?s3[.-]([a-z0-9-]+)\./;
+function isUrlFromBucket(fileUrl, bucketName, baseUrl = '') {
+    const url = new URL(fileUrl);
+    // Check if the file URL is using a base URL (e.g. a CDN).
+    // In this case do not sign the URL.
+    if (baseUrl) {
+        return false;
+    }
+    const { bucket } = getBucketFromAwsUrl(fileUrl);
+    if (bucket) {
+        return bucket === bucketName;
+    }
+    // File URL might be of an S3-compatible provider. (or an invalid URL)
+    // In this case, check if the bucket name appears in the URL host or path.
+    // e.g. https://minio.example.com/bucket-name/object-key
+    // e.g. https://bucket.nyc3.digitaloceanspaces.com/folder/img.png
+    return url.host.startsWith(`${bucketName}.`) || url.pathname.includes(`/${bucketName}/`);
+}
+exports.isUrlFromBucket = isUrlFromBucket;
+/**
+ * Parse the bucket name from a URL.
+ * See all URL formats in https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-bucket-intro.html
+ *
+ * @param {string} fileUrl - the URL to parse
+ * @returns {object} result
+ * @returns {string} result.bucket - the bucket name
+ * @returns {string} result.err - if any
+ */
+function getBucketFromAwsUrl(fileUrl) {
+    const url = new URL(fileUrl);
+    // S3://<bucket-name>/<key>
+    if (url.protocol === 's3:') {
+        const bucket = url.host;
+        if (!bucket) {
+            return { err: `Invalid S3 url: no bucket: ${url}` };
+        }
+        return { bucket };
+    }
+    if (!url.host) {
+        return { err: `Invalid S3 url: no hostname: ${url}` };
+    }
+    const matches = url.host.match(ENDPOINT_PATTERN);
+    if (!matches) {
+        return { err: `Invalid S3 url: hostname does not appear to be a valid S3 endpoint: ${url}` };
+    }
+    const prefix = matches[1];
+    // https://s3.amazonaws.com/<bucket-name>
+    if (!prefix) {
+        if (url.pathname === '/') {
+            return { bucket: null };
+        }
+        const index = url.pathname.indexOf('/', 1);
+        // https://s3.amazonaws.com/<bucket-name>
+        if (index === -1) {
+            return { bucket: url.pathname.substring(1) };
+        }
+        // https://s3.amazonaws.com/<bucket-name>/
+        if (index === url.pathname.length - 1) {
+            return { bucket: url.pathname.substring(1, index) };
+        }
+        // https://s3.amazonaws.com/<bucket-name>/key
+        return { bucket: url.pathname.substring(1, index) };
+    }
+    // https://<bucket-name>.s3.amazonaws.com/
+    return { bucket: prefix.substring(0, prefix.length - 1) };
+}
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAAA,MAAM,gBAAgB,GAAG,8BAA8B,CAAC;AAOxD,SAAgB,eAAe,CAAC,OAAe,EAAE,UAAkB,EAAE,OAAO,GAAG,EAAE;IAC/E,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;IAE7B,0DAA0D;IAC1D,oCAAoC;IACpC,IAAI,OAAO,EAAE;QACX,OAAO,KAAK,CAAC;KACd;IAED,MAAM,EAAE,MAAM,EAAE,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAEhD,IAAI,MAAM,EAAE;QACV,OAAO,MAAM,KAAK,UAAU,CAAC;KAC9B;IAED,sEAAsE;IACtE,0EAA0E;IAC1E,wDAAwD;IACxD,iEAAiE;IACjE,OAAO,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,UAAU,GAAG,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,UAAU,GAAG,CAAC,CAAC;AAC3F,CAAC;AApBD,0CAoBC;AAED;;;;;;;;GAQG;AACH,SAAS,mBAAmB,CAAC,OAAe;IAC1C,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;IAE7B,2BAA2B;IAC3B,IAAI,GAAG,CAAC,QAAQ,KAAK,KAAK,EAAE;QAC1B,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC;QAExB,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,EAAE,GAAG,EAAE,8BAA8B,GAAG,EAAE,EAAE,CAAC;SACrD;QACD,OAAO,EAAE,MAAM,EAAE,CAAC;KACnB;IAED,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE;QACb,OAAO,EAAE,GAAG,EAAE,gCAAgC,GAAG,EAAE,EAAE,CAAC;KACvD;IAED,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACjD,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO,EAAE,GAAG,EAAE,uEAAuE,GAAG,EAAE,EAAE,CAAC;KAC9F;IAED,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAC1B,yCAAyC;IACzC,IAAI,CAAC,MAAM,EAAE;QACX,IAAI,GAAG,CAAC,QAAQ,KAAK,GAAG,EAAE;YACxB,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;SACzB;QAED,MAAM,KAAK,GAAG,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QAE3C,yCAAyC;QACzC,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;YAChB,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;SAC9C;QAED,0CAA0C;QAC1C,IAAI,KAAK,KAAK,GAAG,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YACrC,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;SACrD;QAED,6CAA6C;QAC7C,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;KACrD;IAED,0CAA0C;IAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC;AAC5D,CAAC"}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/provider-upload-aws-s3",
-  "version": "0.0.0-next.dff425769af4d4d006725a10c395f59637403653",
+  "version": "0.0.0-next.e037a7b2d1f48b7bd8bcd0d9400ca0f9ded8a982",
   "description": "AWS S3 provider for strapi upload",
   "keywords": [
     "upload",
@@ -29,22 +29,33 @@
       "url": "https://strapi.io"
     }
   ],
-  "main": "./lib",
-  "directories": {
-    "lib": "./lib"
-  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "./dist"
+  ],
   "scripts": {
+    "build": "run -T tsc",
+    "build:ts": "run -T tsc",
+    "watch": "run -T tsc -w --preserveWatchOutput",
+    "clean": "run -T rimraf ./dist",
+    "prepublishOnly": "yarn clean && yarn build",
     "test:unit": "run -T jest",
     "test:unit:watch": "run -T jest --watch",
     "lint": "run -T eslint ."
   },
   "dependencies": {
-    "aws-sdk": "2.1351.0",
+    "aws-sdk": "2.1437.0",
     "lodash": "4.17.21"
   },
+  "devDependencies": {
+    "@types/jest": "29.5.2",
+    "eslint-config-custom": "0.0.0-next.e037a7b2d1f48b7bd8bcd0d9400ca0f9ded8a982",
+    "tsconfig": "0.0.0-next.e037a7b2d1f48b7bd8bcd0d9400ca0f9ded8a982"
+  },
   "engines": {
-    "node": ">=14.19.1 <=18.x.x",
+    "node": ">=16.0.0 <=20.x.x",
     "npm": ">=6.0.0"
   },
-  "gitHead": "dff425769af4d4d006725a10c395f59637403653"
+  "gitHead": "e037a7b2d1f48b7bd8bcd0d9400ca0f9ded8a982"
 }

package/.eslintignore DELETED Viewed

	@@ -1,2 +0,0 @@
1	- node_modules/
2	- .eslintrc.js

package/.eslintrc.js DELETED Viewed

@@ -1,4 +0,0 @@
-module.exports = {
-  root: true,
-  extends: ['custom/back'],
-};

package/lib/index.js DELETED Viewed

@@ -1,139 +0,0 @@
-'use strict';
-/**
- * Module dependencies
- */
-/* eslint-disable no-unused-vars */
-// Public node modules.
-const { getOr } = require('lodash/fp');
-// TODO V5: Migrate to aws-sdk v3
-require('aws-sdk/lib/maintenance_mode_message').suppress = true;
-const AWS = require('aws-sdk');
-const { getBucketFromUrl } = require('./utils');
-function assertUrlProtocol(url) {
-  // Regex to test protocol like "http://", "https://"
-  return /^\w*:\/\//.test(url);
-}
-module.exports = {
-  init({ baseUrl = null, rootPath = null, s3Options, ...legacyS3Options }) {
-    if (legacyS3Options) {
-      process.emitWarning(
-        "S3 configuration options passed at root level of the plugin's providerOptions is deprecated and will be removed in a future release. Please wrap them inside the 's3Options:{}' property."
-      );
-    }
-    const config = { ...s3Options, ...legacyS3Options };
-    const S3 = new AWS.S3({
-      apiVersion: '2006-03-01',
-      ...config,
-    });
-    const filePrefix = rootPath ? `${rootPath.replace(/\/+$/, '')}/` : '';
-    const getFileKey = (file) => {
-      const path = file.path ? `${file.path}/` : '';
-      return `${filePrefix}${path}${file.hash}${file.ext}`;
-    };
-    const ACL = getOr('public-read', ['params', 'ACL'], config);
-    const upload = (file, customParams = {}) =>
-      new Promise((resolve, reject) => {
-        // upload file on S3 bucket
-        const fileKey = getFileKey(file);
-        S3.upload(
-          {
-            Key: fileKey,
-            Body: file.stream || Buffer.from(file.buffer, 'binary'),
-            ACL,
-            ContentType: file.mime,
-            ...customParams,
-          },
-          (err, data) => {
-            if (err) {
-              return reject(err);
-            }
-            // set the bucket file url
-            if (assertUrlProtocol(data.Location)) {
-              file.url = baseUrl ? `${baseUrl}/${fileKey}` : data.Location;
-            } else {
-              // Default protocol to https protocol
-              file.url = `https://${data.Location}`;
-            }
-            resolve();
-          }
-        );
-      });
-    return {
-      isPrivate() {
-        return ACL === 'private';
-      },
-      /**
-       * @param {Object} file
-       * @param {string} file.path
-       * @param {string} file.hash
-       * @param {string} file.ext
-       * @param {Object} customParams
-       * @returns {Promise<{url: string}>}
-       */
-      getSignedUrl(file, customParams = {}) {
-        // Do not sign the url if it does not come from the same bucket.
-        const { bucket } = getBucketFromUrl(file.url);
-        if (bucket !== config.params.Bucket) {
-          return { url: file.url };
-        }
-        return new Promise((resolve, reject) => {
-          const fileKey = getFileKey(file);
-          S3.getSignedUrl(
-            'getObject',
-            {
-              Bucket: config.params.Bucket,
-              Key: fileKey,
-              Expires: getOr(15 * 60, ['params', 'signedUrlExpires'], config), // 15 minutes
-            },
-            (err, url) => {
-              if (err) {
-                return reject(err);
-              }
-              resolve({ url });
-            }
-          );
-        });
-      },
-      uploadStream(file, customParams = {}) {
-        return upload(file, customParams);
-      },
-      upload(file, customParams = {}) {
-        return upload(file, customParams);
-      },
-      delete(file, customParams = {}) {
-        return new Promise((resolve, reject) => {
-          // delete file on S3 bucket
-          const fileKey = getFileKey(file);
-          S3.deleteObject(
-            {
-              Key: fileKey,
-              ...customParams,
-            },
-            (err) => {
-              if (err) {
-                return reject(err);
-              }
-              resolve();
-            }
-          );
-        });
-      },
-    };
-  },
-};

package/lib/utils.js DELETED Viewed

@@ -1,63 +0,0 @@
-'use strict';
-const ENDPOINT_PATTERN = /^(.+\.)?s3[.-]([a-z0-9-]+)\./;
-/**
- * Parse the bucket name from a URL.
- * See all URL formats in https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-bucket-intro.html
- *
- * @param {string} fileUrl - the URL to parse
- * @returns {object} result
- * @returns {string} result.bucket - the bucket name
- * @returns {string} result.error - if any
- */
-function getBucketFromUrl(fileUrl) {
-  const uri = new URL(fileUrl);
-  // S3://<bucket-name>/<key>
-  if (uri.protocol === 's3:') {
-    const bucket = uri.host;
-    if (!bucket) {
-      return { err: `Invalid S3 URI: no bucket: ${uri}` };
-    }
-    return { bucket };
-  }
-  if (!uri.host) {
-    return { err: `Invalid S3 URI: no hostname: ${uri}` };
-  }
-  const matches = uri.host.match(ENDPOINT_PATTERN);
-  if (!matches) {
-    return { err: `Invalid S3 URI: hostname does not appear to be a valid S3 endpoint: ${uri}` };
-  }
-  const prefix = matches[1];
-  // https://s3.amazonaws.com/<bucket-name>
-  if (!prefix) {
-    if (uri.pathname === '/') {
-      return { bucket: null };
-    }
-    const index = uri.pathname.indexOf('/', 1);
-    // https://s3.amazonaws.com/<bucket-name>
-    if (index === -1) {
-      return { bucket: uri.pathname.substring(1) };
-    }
-    // https://s3.amazonaws.com/<bucket-name>/
-    if (index === uri.pathname.length - 1) {
-      return { bucket: uri.pathname.substring(1, index) };
-    }
-    // https://s3.amazonaws.com/<bucket-name>/key
-    return { bucket: uri.pathname.substring(1, index) };
-  }
-  // https://<bucket-name>.s3.amazonaws.com/
-  return { bucket: prefix.substring(0, prefix.length - 1) };
-}
-module.exports = { getBucketFromUrl };