@aws/amazon-location-utilities-auth-helper 1.0.0

package/dist/cjs/apikey/index.js

@@ -0,0 +1,26 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withAPIKey = void 0;
+/**
+ * Creates an auth helper instance using APIKey. Its `getLocationClientConfig` function creates a signer to set the
+ * APIKey in all the commands of a client.
+ *
+ * @param apiKey APIKey
+ */
+async function withAPIKey(apiKey) {
+    return {
+        getLocationClientConfig: () => ({
+            signer: {
+                sign: async (requestToSign) => {
+                    var _a;
+                    // APIKey in the command can override the APIKey set by auth helper.
+                    requestToSign.query = Object.assign({ key: apiKey }, ((_a = requestToSign.query) !== null && _a !== void 0 ? _a : {}));
+                    return requestToSign;
+                },
+            },
+        }),
+    };
+}
+exports.withAPIKey = withAPIKey;

package/dist/cjs/cognito/index.js

@@ -0,0 +1,54 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withIdentityPoolId = void 0;
+const credential_providers_1 = require("@aws-sdk/credential-providers");
+const core_1 = require("@aws-amplify/core");
+/**
+ * Creates an auth helper instance using credentials from Cognito.
+ *
+ * @param identityPoolId Cognito Identity Pool Id
+ */
+async function withIdentityPoolId(identityPoolId) {
+    const region = identityPoolId.split(":")[0];
+    const credentialsProvider = (0, credential_providers_1.fromCognitoIdentityPool)({
+        identityPoolId,
+        clientConfig: {
+            region,
+        },
+    });
+    let credentials;
+    async function refreshCredentials() {
+        credentials = await credentialsProvider();
+        let timeToRefresh = 3600000; // default to 1 hour if credentials does not have expiration field
+        if (credentials.expiration) {
+            timeToRefresh = credentials.expiration.getTime() - new Date().getTime();
+        }
+        // timeToRefresh minus 1 minute to give some time for the actual refresh to happen.
+        setTimeout(refreshCredentials, timeToRefresh - 60000);
+    }
+    await refreshCredentials();
+    return {
+        getMapAuthenticationOptions: () => ({
+            transformRequest: (url) => {
+                // Only sign aws URLs
+                if (url.includes("amazonaws.com")) {
+                    return {
+                        url: core_1.Signer.signUrl(url, {
+                            access_key: credentials.accessKeyId,
+                            secret_key: credentials.secretAccessKey,
+                            session_token: credentials.sessionToken,
+                        }),
+                    };
+                }
+                return { url };
+            },
+        }),
+        getLocationClientConfig: () => ({
+            credentials: credentialsProvider,
+        }),
+        getCredentials: () => credentials,
+    };
+}
+exports.withIdentityPoolId = withIdentityPoolId;

package/dist/cjs/common/types.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/index.js

@@ -0,0 +1,21 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./common/types"), exports);
+__exportStar(require("./cognito"), exports);
+__exportStar(require("./apikey"), exports);

package/dist/esm/apikey/index.js

@@ -0,0 +1,22 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * Creates an auth helper instance using APIKey. Its `getLocationClientConfig` function creates a signer to set the
+ * APIKey in all the commands of a client.
+ *
+ * @param apiKey APIKey
+ */
+export async function withAPIKey(apiKey) {
+    return {
+        getLocationClientConfig: () => ({
+            signer: {
+                sign: async (requestToSign) => {
+                    var _a;
+                    // APIKey in the command can override the APIKey set by auth helper.
+                    requestToSign.query = Object.assign({ key: apiKey }, ((_a = requestToSign.query) !== null && _a !== void 0 ? _a : {}));
+                    return requestToSign;
+                },
+            },
+        }),
+    };
+}

package/dist/esm/cognito/index.js

@@ -0,0 +1,50 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { fromCognitoIdentityPool } from "@aws-sdk/credential-providers";
+import { Signer } from "@aws-amplify/core";
+/**
+ * Creates an auth helper instance using credentials from Cognito.
+ *
+ * @param identityPoolId Cognito Identity Pool Id
+ */
+export async function withIdentityPoolId(identityPoolId) {
+    const region = identityPoolId.split(":")[0];
+    const credentialsProvider = fromCognitoIdentityPool({
+        identityPoolId,
+        clientConfig: {
+            region,
+        },
+    });
+    let credentials;
+    async function refreshCredentials() {
+        credentials = await credentialsProvider();
+        let timeToRefresh = 3600000; // default to 1 hour if credentials does not have expiration field
+        if (credentials.expiration) {
+            timeToRefresh = credentials.expiration.getTime() - new Date().getTime();
+        }
+        // timeToRefresh minus 1 minute to give some time for the actual refresh to happen.
+        setTimeout(refreshCredentials, timeToRefresh - 60000);
+    }
+    await refreshCredentials();
+    return {
+        getMapAuthenticationOptions: () => ({
+            transformRequest: (url) => {
+                // Only sign aws URLs
+                if (url.includes("amazonaws.com")) {
+                    return {
+                        url: Signer.signUrl(url, {
+                            access_key: credentials.accessKeyId,
+                            secret_key: credentials.secretAccessKey,
+                            session_token: credentials.sessionToken,
+                        }),
+                    };
+                }
+                return { url };
+            },
+        }),
+        getLocationClientConfig: () => ({
+            credentials: credentialsProvider,
+        }),
+        getCredentials: () => credentials,
+    };
+}

package/dist/esm/common/types.js

@@ -0,0 +1,3 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export {};

package/dist/esm/index.js

@@ -0,0 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export * from "./common/types";
+export * from "./cognito";
+export * from "./apikey";

package/dist/types/apikey/index.d.ts

@@ -0,0 +1,8 @@
+import { SDKAuthHelper } from "../common/types";
+/**
+ * Creates an auth helper instance using APIKey. Its `getLocationClientConfig` function creates a signer to set the
+ * APIKey in all the commands of a client.
+ *
+ * @param apiKey APIKey
+ */
+export declare function withAPIKey(apiKey: string): Promise<SDKAuthHelper>;

package/dist/types/cognito/index.d.ts

@@ -0,0 +1,7 @@
+import { MapAuthHelper, SDKAuthHelper } from "../common/types";
+/**
+ * Creates an auth helper instance using credentials from Cognito.
+ *
+ * @param identityPoolId Cognito Identity Pool Id
+ */
+export declare function withIdentityPoolId(identityPoolId: string): Promise<MapAuthHelper & SDKAuthHelper>;

package/dist/types/common/types.d.ts

@@ -0,0 +1,20 @@
+import { AwsCredentialIdentity, Provider, RequestSigner } from "@aws-sdk/types";
+export interface MapAuthenticationOptions {
+    transformRequest: (url: string, resourceType?: string) => {
+        url: string;
+    };
+}
+export interface LocationClientConfig {
+    signer?: RequestSigner;
+    credentials?: Provider<AwsCredentialIdentity>;
+}
+export type getMapAuthenticationOptionsFunc = () => MapAuthenticationOptions;
+export type getLocationClientConfigFunc = () => LocationClientConfig;
+export type getCredentialsFunc = () => AwsCredentialIdentity;
+export interface MapAuthHelper {
+    getMapAuthenticationOptions: getMapAuthenticationOptionsFunc;
+    getCredentials: getCredentialsFunc;
+}
+export interface SDKAuthHelper {
+    getLocationClientConfig: getLocationClientConfigFunc;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./common/types";
+export * from "./cognito";
+export * from "./apikey";

package/package.json

@@ -0,0 +1,94 @@
+{
+  "name": "@aws/amazon-location-utilities-auth-helper",
+  "description": "Amazon Location Utilities - Authentication Helper for JavaScript",
+  "license": "Apache-2.0",
+  "version": "1.0.0",
+  "keywords": [],
+  "author": {
+    "name": "Amazon Web Services",
+    "email": "",
+    "url": "https://aws.amazon.com/"
+  },
+  "homepage": "https://github.com/aws-geospatial/amazon-location-utilities-auth-helper-js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/aws-geospatial/amazon-location-utilities-auth-helper-js"
+  },
+  "bugs": {
+    "url": "https://github.com/aws-geospatial/amazon-location-utilities-auth-helper-js/issues",
+    "mail": ""
+  },
+  "contributors": [
+    "Eason Huang <yuxuanh@amazon.com>"
+  ],
+  "engines": {
+    "node": ">= 16.0.0"
+  },
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "files": [
+    "./LICENSE.txt",
+    "./LICENSE-THIRD-PARTY.txt",
+    "./CODE_OF_CONDUCT.md",
+    "./CONTRIBUTING.md",
+    "./Notice.txt",
+    "./README.md",
+    "./package.json",
+    "./dist"
+  ],
+  "scripts": {
+    "clean": "rm -r dist",
+    "prettier": "prettier -w .",
+    "prettier:check": "prettier -c .",
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix .",
+    "typedoc": "typedoc",
+    "test": "jest --coverage",
+    "build": "npm-run-all build:*",
+    "build:ts": "npm-run-all build-ts:*",
+    "build:bundle": "rollup -c",
+    "build-ts:types": "tsc --declaration --emitDeclarationOnly --outDir dist/types",
+    "build-ts:cjs": "tsc --module commonjs --outDir dist/cjs",
+    "build-ts:esm": "tsc --esModuleInterop --module esnext --outDir dist/esm",
+    "prepare": "husky install",
+    "prepublishOnly": "npm-run-all clean lint prettier:check test build"
+  },
+  "lint-staged": {
+    "*.{js,ts}": [
+      "eslint --fix",
+      "prettier --write"
+    ],
+    "!(*.{js,ts})": "prettier --write --ignore-unknown"
+  },
+  "dependencies": {
+    "@aws-amplify/core": "^5.5.0",
+    "@aws-sdk/client-location": "^3.359.0",
+    "@aws-sdk/credential-providers": "^3.359.0",
+    "@aws-sdk/types": "^3.347.0"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.21.8",
+    "@babel/preset-env": "^7.21.5",
+    "@babel/preset-typescript": "^7.21.5",
+    "@rollup/plugin-babel": "^6.0.3",
+    "@rollup/plugin-commonjs": "^25.0.2",
+    "@rollup/plugin-json": "^6.0.0",
+    "@rollup/plugin-node-resolve": "^15.1.0",
+    "@types/jest": "^29.5.0",
+    "@typescript-eslint/eslint-plugin": "^5.57.0",
+    "@typescript-eslint/parser": "^5.57.0",
+    "eslint": "^8.37.0",
+    "husky": "^8.0.3",
+    "jest": "^29.5.0",
+    "lint-staged": "^13.2.2",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^2.8.7",
+    "prettier-plugin-jsdoc": "^0.4.2",
+    "rollup": "^3.22.0",
+    "ts-jest": "^29.1.0",
+    "ts-node": "^10.9.1",
+    "typedoc": "^0.24.1",
+    "typescript": "^5.0.2"
+  }
+}