@pi-r/aws-lib 0.9.0 → 0.9.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pi-r/aws-lib",
-  "version": "0.9.0",
+  "version": "0.9.2",
   "description": "AWS cloud utility functions for E-mc.",
   "main": "index.js",
   "types": "types/index.d.ts",

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;