@pi-r/aws-lib 0.6.0

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2023 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

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

package/index.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBucketKey = exports.checkBucketCannedACL = exports.setDatabaseEndpoint = exports.setEndpoint = exports.getPrivatePolicy = exports.getBucketPublicReadPolicy = exports.getPublicReadPolicy = exports.isDatabaseDefined = exports.isProviderChainDefined = exports.isSharedCredentialsDefined = exports.isEnvDefined = exports.isAccessDefined = void 0;
+const types_1 = require("@e-mc/types");
+function isAccessDefined(credential) {
+    return !!(credential.accessKeyId && credential.secretAccessKey);
+}
+exports.isAccessDefined = isAccessDefined;
+function isEnvDefined() {
+    return !!(process.env.AWS_ACCESS_KEY_ID && process.env.AWS_SECRET_ACCESS_KEY);
+}
+exports.isEnvDefined = isEnvDefined;
+function isSharedCredentialsDefined() {
+    return !!process.env.AWS_SDK_LOAD_CONFIG;
+}
+exports.isSharedCredentialsDefined = isSharedCredentialsDefined;
+function isProviderChainDefined() {
+    return isSharedCredentialsDefined() || !!(process.env.AWS_WEB_IDENTITY_TOKEN_FILE || process.env.AWS_CONTAINER_CREDENTIALS_RELATIVE_URI || process.env.AWS_CONTAINER_CREDENTIALS_FULL_URI);
+}
+exports.isProviderChainDefined = isProviderChainDefined;
+function isDatabaseDefined(credential, data) {
+    return !!(data.table && (credential.region || credential.endpoint || process.env.AWS_REGION));
+}
+exports.isDatabaseDefined = isDatabaseDefined;
+function getPublicReadPolicy(bucket, authenticated, write) {
+    const Action = ["s3:GetObject", "s3:GetObjectVersion"];
+    if (write) {
+        Action.push("s3:PutObject", "s3:DeleteObjectVersion");
+    }
+    return JSON.stringify({
+        "Version": "2012-10-17",
+        "Statement": [{
+                "Sid": (authenticated ? "AuthenticatedRead" : "PublicRead") + (write ? "Write" : ""),
+                "Effect": "Allow",
+                "Principal": authenticated ? { "AWS": "*" } : "*",
+                "Action": Action,
+                "Resource": [`arn:aws:s3:::${bucket}/*`]
+            }]
+    });
+}
+exports.getPublicReadPolicy = getPublicReadPolicy;
+function getBucketPublicReadPolicy(bucket) {
+    return JSON.stringify({
+        "Version": "2012-10-17",
+        "Statement": [{
+                "Sid": "BucketPublicRead",
+                "Effect": "Allow",
+                "Principal": "*",
+                "Action": ["s3:ListBucket", "s3:ListBucketVersions", "s3:ListBucketMultipartUploads"],
+                "Resource": [`arn:aws:s3:::${bucket}`]
+            }]
+    });
+}
+exports.getBucketPublicReadPolicy = getBucketPublicReadPolicy;
+function getPrivatePolicy(bucket) {
+    return JSON.stringify({
+        "Version": "2012-10-17",
+        "Statement": [{
+                "Sid": "Private",
+                "Effect": "Deny",
+                "Principal": "*",
+                "Action": "*",
+                "Resource": [`arn:aws:s3:::${bucket}`, `arn:aws:s3:::${bucket}/*`]
+            }]
+    });
+}
+exports.getPrivatePolicy = getPrivatePolicy;
+function setEndpoint(config, instance, fallbackRegion) {
+    let { region, endpoint } = config;
+    if (!endpoint) {
+        const location = (0, types_1.isString)(region) ? region : process.env.AWS_REGION || fallbackRegion;
+        if (location) {
+            endpoint = `https://${instance}.${location}.amazonaws.com`;
+            config.endpoint = endpoint;
+        }
+    }
+    if (!region) {
+        region = ((0, types_1.isString)(endpoint) && new RegExp(`\\b${instance}\\.([^.]+)\\.`, 'i').exec(endpoint)?.[1] || process.env.AWS_REGION || fallbackRegion)?.toLowerCase();
+        if (region && region !== "us-east-1" /* STRINGS.REGION */) {
+            config.region = region;
+        }
+    }
+}
+exports.setEndpoint = setEndpoint;
+function setDatabaseEndpoint(config, fallbackRegion = "us-east-1" /* STRINGS.REGION */) {
+    setEndpoint(config, 'dynamodb', fallbackRegion);
+}
+exports.setDatabaseEndpoint = setDatabaseEndpoint;
+function checkBucketCannedACL(value) {
+    switch (value) {
+        case "private" /* PERMISSIONS.PRIVATE */:
+        case "public-read" /* PERMISSIONS.PUBLIC_READ */:
+        case "public-read-write" /* PERMISSIONS.PUBLIC_READ_WRITE */:
+        case "authenticated-read" /* PERMISSIONS.AUTHENTICATED_READ */:
+            return value;
+    }
+}
+exports.checkBucketCannedACL = checkBucketCannedACL;
+const getBucketKey = (credential, bucket, acl, service, sdk) => JSON.stringify(credential) + bucket + '_' + (acl || '') + service + sdk;
+exports.getBucketKey = getBucketKey;

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@pi-r/aws-lib",
+  "version": "0.6.0",
+  "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": {
+    "@e-mc/types": "^0.8.3"
+  }
+}

package/types/index.d.ts

@@ -0,0 +1,83 @@
+import type { CloudDatabase } from '@e-mc/types/lib/cloud';
+
+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;
+    }
+
+    type Provider<T> = () => Promise<T>;
+
+    function isAccessDefined(credential: AccessConfig): boolean;
+    function isEnvDefined(): boolean;
+    function isSharedCredentialsDefined(): boolean;
+    function isProviderChainDefined(): boolean;
+    function isDatabaseDefined(credential: unknown, data: CloudDatabase): 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 getBucketKey(credential: unknown, bucket: string, acl: string | undefined, service: string, sdk: string): string;
+}
+
+export = AWS;