@pi-r/aws-lib 0.7.3 → 0.7.4

package/LICENSE

@@ -1,7 +1,7 @@
-Copyright 2024 An Pham
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
+Copyright 2024 An Pham
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,7 +1,7 @@
-### @pi-r/aws-lib
-
-https://e-mc.readthedocs.io/en/latest/cloud/aws.html
-
-### LICENSE
-
+### @pi-r/aws-lib
+
+https://e-mc.readthedocs.io/en/latest/cloud/aws.html
+
+### LICENSE
+
 MIT

package/package.json

@@ -1,24 +1,24 @@
-{
-  "name": "@pi-r/aws-lib",
-  "version": "0.7.3",
-  "description": "AWS cloud utility functions for E-mc.",
-  "main": "index.js",
-  "types": "types/index.d.ts",
-  "publishConfig": {
-    "access": "public"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/anpham6/pi-r.git",
-    "directory": "src/cloud/aws-lib"
-  },
-  "keywords": [
-    "squared",
-    "e-mc",
-    "squared-functions"
-  ],
-  "author": "An Pham <anpham6@gmail.com>",
-  "license": "MIT",
-  "homepage": "https://github.com/anpham6/pi-r#readme",
-  "dependencies": {}
-}
+{
+  "name": "@pi-r/aws-lib",
+  "version": "0.7.4",
+  "description": "AWS cloud utility functions for E-mc.",
+  "main": "index.js",
+  "types": "types/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/anpham6/pi-r.git",
+    "directory": "src/cloud/aws-lib"
+  },
+  "keywords": [
+    "squared",
+    "e-mc",
+    "squared-functions"
+  ],
+  "author": "An Pham <anpham6@gmail.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/anpham6/pi-r#readme",
+  "dependencies": {}
+}

package/types/index.d.ts

@@ -1,105 +1,105 @@
-declare namespace AWS {
-    type BucketCannedACL = "authenticated-read" | "private" | "public-read" | "public-read-write";
-    type ObjectCannedACL = BucketCannedACL | "bucket-owner-full-control" | "bucket-owner-read";
-
-    interface EndpointConfig {
-        /**
-         * The region to send service requests to.
-         */
-        region?: string | Provider<string>;
-        /**
-         * The endpoint URI to send requests to. The default endpoint is built from the configured region.
-         * The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.
-         */
-        endpoint?: string | Endpoint;
-    }
-
-    interface AccessConfig {
-        /**
-         * AWS access key ID.
-         *
-         * @deprecated
-         */
-        accessKeyId?: string;
-        /**
-         * AWS secret access key.
-         *
-         * @deprecated
-         */
-        secretAccessKey?: string;
-        /**
-         * AWS session token.
-         *
-         * @deprecated
-         */
-        sessionToken?: string;
-    }
-
-    class Endpoint {
-        /**
-         * Constructs a new endpoint given an endpoint URL.
-         */
-        constructor(url: string);
-
-        /**
-         * The host portion of the endpoint including the port, e.g., example.com:80.
-         */
-        host: string;
-        /**
-         * The host portion of the endpoint, e.g., example.com.
-         */
-        hostname: string;
-        /**
-         * The full URL of the endpoint.
-         */
-        href: string;
-        /**
-         * The port of the endpoint.
-         */
-        port: number;
-        /**
-         * The protocol (http or https) of the endpoint URL.
-         */
-        protocol: string;
-    }
-
-    interface DefaultRetention {
-        /**
-         * @public
-         * <p>The default Object Lock retention mode you want to apply to new objects placed in the
-         *          specified bucket. Must be used with either <code>Days</code> or <code>Years</code>.</p>
-         */
-        Mode?: ObjectLockRetentionMode;
-        /**
-         * @public
-         * <p>The number of days that you want to specify for the default retention period. Must be
-         *          used with <code>Mode</code>.</p>
-         */
-        Days?: number;
-        /**
-         * @public
-         * <p>The number of years that you want to specify for the default retention period. Must be
-         *          used with <code>Mode</code>.</p>
-         */
-        Years?: number;
-    }
-
-    type Provider<T> = () => Promise<T>;
-    type ObjectLockRetentionMode = "GOVERNANCE" | "COMPLIANCE" | string; // eslint-disable-line @typescript-eslint/no-redundant-type-constituents
-
-    function isAccessDefined(credential: AccessConfig): boolean;
-    function isEnvDefined(): boolean;
-    function isSharedCredentialsDefined(): boolean;
-    function isProviderChainDefined(): boolean;
-    function isDatabaseDefined(credential: unknown, data: unknown): boolean;
-    function getPublicReadPolicy(bucket: string, authenticated?: boolean, write?: boolean): string;
-    function getBucketPublicReadPolicy(bucket: string): string;
-    function getPrivatePolicy(bucket: string): string;
-    function setDatabaseEndpoint(config: EndpointConfig, fallbackRegion?: string): void;
-    function setEndpoint(config: EndpointConfig, instance: string, fallbackRegion?: string): void;
-    function checkBucketCannedACL(value: unknown): BucketCannedACL | undefined;
-    function formatDefaultRetention(retention: DefaultRetention): string;
-    function getBucketKey(credential: unknown, bucket: string, acl: string | undefined, service: string, sdk: string): string;
-}
-
+declare namespace AWS {
+    type BucketCannedACL = "authenticated-read" | "private" | "public-read" | "public-read-write";
+    type ObjectCannedACL = BucketCannedACL | "bucket-owner-full-control" | "bucket-owner-read";
+
+    interface EndpointConfig {
+        /**
+         * The region to send service requests to.
+         */
+        region?: string | Provider<string>;
+        /**
+         * The endpoint URI to send requests to. The default endpoint is built from the configured region.
+         * The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.
+         */
+        endpoint?: string | Endpoint;
+    }
+
+    interface AccessConfig {
+        /**
+         * AWS access key ID.
+         *
+         * @deprecated
+         */
+        accessKeyId?: string;
+        /**
+         * AWS secret access key.
+         *
+         * @deprecated
+         */
+        secretAccessKey?: string;
+        /**
+         * AWS session token.
+         *
+         * @deprecated
+         */
+        sessionToken?: string;
+    }
+
+    class Endpoint {
+        /**
+         * Constructs a new endpoint given an endpoint URL.
+         */
+        constructor(url: string);
+
+        /**
+         * The host portion of the endpoint including the port, e.g., example.com:80.
+         */
+        host: string;
+        /**
+         * The host portion of the endpoint, e.g., example.com.
+         */
+        hostname: string;
+        /**
+         * The full URL of the endpoint.
+         */
+        href: string;
+        /**
+         * The port of the endpoint.
+         */
+        port: number;
+        /**
+         * The protocol (http or https) of the endpoint URL.
+         */
+        protocol: string;
+    }
+
+    interface DefaultRetention {
+        /**
+         * @public
+         * <p>The default Object Lock retention mode you want to apply to new objects placed in the
+         *          specified bucket. Must be used with either <code>Days</code> or <code>Years</code>.</p>
+         */
+        Mode?: ObjectLockRetentionMode;
+        /**
+         * @public
+         * <p>The number of days that you want to specify for the default retention period. Must be
+         *          used with <code>Mode</code>.</p>
+         */
+        Days?: number;
+        /**
+         * @public
+         * <p>The number of years that you want to specify for the default retention period. Must be
+         *          used with <code>Mode</code>.</p>
+         */
+        Years?: number;
+    }
+
+    type Provider<T> = () => Promise<T>;
+    type ObjectLockRetentionMode = "GOVERNANCE" | "COMPLIANCE" | string; // eslint-disable-line @typescript-eslint/no-redundant-type-constituents
+
+    function isAccessDefined(credential: AccessConfig): boolean;
+    function isEnvDefined(): boolean;
+    function isSharedCredentialsDefined(): boolean;
+    function isProviderChainDefined(): boolean;
+    function isDatabaseDefined(credential: unknown, data: unknown): boolean;
+    function getPublicReadPolicy(bucket: string, authenticated?: boolean, write?: boolean): string;
+    function getBucketPublicReadPolicy(bucket: string): string;
+    function getPrivatePolicy(bucket: string): string;
+    function setDatabaseEndpoint(config: EndpointConfig, fallbackRegion?: string): void;
+    function setEndpoint(config: EndpointConfig, instance: string, fallbackRegion?: string): void;
+    function checkBucketCannedACL(value: unknown): BucketCannedACL | undefined;
+    function formatDefaultRetention(retention: DefaultRetention): string;
+    function getBucketKey(credential: unknown, bucket: string, acl: string | undefined, service: string, sdk: string): string;
+}
+
 export = AWS;