theauthapi 1.0.0 → 1.0.1-2.1

package/dist/index.js

@@ -0,0 +1,74 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const assert_1 = __importDefault(require("assert"));
+const remove_trailing_slash_1 = __importDefault(require("remove-trailing-slash"));
+const ApiRequest_1 = __importDefault(require("./services/ApiRequest/ApiRequest"));
+const ApiKeys_1 = __importDefault(require("./endpoints/ApiKeys/ApiKeys"));
+const HttpMethod_1 = require("./services/ApiRequest/HttpMethod");
+const Projects_1 = __importDefault(require("./endpoints/Projects/Projects"));
+const Accounts_1 = __importDefault(require("./endpoints/Accounts/Accounts"));
+// eslint-disable-next-line @typescript-eslint/no-empty-function
+const noop = () => { };
+class TheAuthAPI {
+    /**
+     * @param {String} accessKey
+     * @param {Object} [options] (optional)
+     *   @property {String} host (default: 'https://api.segment.io')
+     *   @property {number} retryCount (default: 3)
+     */
+    constructor(accessKey, options) {
+        var _a;
+        (0, assert_1.default)(accessKey, "You must pass your project's write key.");
+        this.accessKey = accessKey;
+        this.host = (0, remove_trailing_slash_1.default)((options === null || options === void 0 ? void 0 : options.host) || "https://api.theauthapi.com");
+        this.api = new ApiRequest_1.default({
+            accessKey: this.accessKey,
+            host: this.host,
+            retryCount: (_a = options === null || options === void 0 ? void 0 : options.retryCount) !== null && _a !== void 0 ? _a : 3,
+        });
+        this.apiKeys = new ApiKeys_1.default(this.api);
+        this.projects = new Projects_1.default(this.api);
+        this.accounts = new Accounts_1.default(this.api);
+    }
+    /*
+      @deprecated
+     */
+    authenticateAPIKey(key, callback) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const cb = callback || noop;
+            const done = (err) => {
+                cb(err, data);
+            };
+            const data = {
+                credentials: { api_key: key },
+                timestamp: new Date().getTime(),
+                sentAt: new Date().getTime(),
+            };
+            try {
+                const key = yield this.api.request(HttpMethod_1.HttpMethod.POST, "/auth/authenticate", data);
+                done(key);
+                return key;
+            }
+            catch (err) {
+                if (err.response) {
+                    const error = new Error(err.response.statusText);
+                    return done(error);
+                }
+                done(err);
+            }
+        });
+    }
+}
+exports.default = TheAuthAPI;

package/dist/libraryMeta.d.ts

@@ -0,0 +1 @@
+export declare const version = "1.0.11";

package/dist/libraryMeta.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.version = void 0;
+exports.version = "1.0.11";

package/dist/services/ApiRequest/ApiCall.d.ts

@@ -0,0 +1,5 @@
+import { HttpMethod } from "./HttpMethod";
+interface ApiCall {
+    request<T>(method: HttpMethod, endpoint: string, payload?: any): Promise<T>;
+}
+export default ApiCall;

package/dist/services/ApiRequest/ApiCall.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/services/ApiRequest/ApiRequest.d.ts

@@ -0,0 +1,24 @@
+import { HttpMethod } from "./HttpMethod";
+import ApiCall from "./ApiCall";
+type Config = {
+    host: string;
+    accessKey: string;
+    headers?: object;
+    retryCount?: number;
+};
+declare class ApiRequest implements ApiCall {
+    host: string;
+    headers: object;
+    accessKey: string;
+    retryCount: number;
+    constructor(config: Config);
+    _init(): void;
+    request<T>(method: HttpMethod, endpoint: string, payload?: any): Promise<T>;
+    _generateDefaultHeaders(): {
+        "user-agent": string;
+        "x-api-key": string;
+        "api-key": string;
+    };
+    _isErrorRetryable(error: any): boolean;
+}
+export default ApiRequest;

package/dist/services/ApiRequest/ApiRequest.js

@@ -0,0 +1,115 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = __importDefault(require("axios"));
+const libraryMeta_1 = require("../../libraryMeta");
+const ApiRequestError_1 = __importDefault(require("./ApiRequestError"));
+const axios_retry_1 = __importDefault(require("axios-retry"));
+const ApiResponseError_1 = __importDefault(require("./ApiResponseError"));
+class ApiRequest {
+    constructor(config) {
+        const { host, accessKey, headers, retryCount } = config;
+        this.host = host;
+        this.accessKey = accessKey;
+        this.headers = this._generateDefaultHeaders();
+        this.retryCount = retryCount !== null && retryCount !== void 0 ? retryCount : 3;
+        if (headers) {
+            this.headers = Object.assign(Object.assign({}, this.headers), { headers });
+        }
+        this._init();
+    }
+    _init() {
+        var _a;
+        const isoDateFormat = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d*)?(?:[-+]\d{2}:?\d{2}|Z)?$/;
+        function isIsoDateString(value) {
+            return value && typeof value === "string" && isoDateFormat.test(value);
+        }
+        function handleDates(body) {
+            if (body === null || body === undefined || typeof body !== "object") {
+                return body;
+            }
+            for (const key of Object.keys(body)) {
+                const value = body[key];
+                if (isIsoDateString(value)) {
+                    body[key] = new Date(value);
+                }
+                else if (typeof value === "object") {
+                    handleDates(value);
+                }
+            }
+        }
+        axios_1.default.interceptors.response.use((response) => {
+            handleDates(response.data);
+            return response;
+        });
+        (0, axios_retry_1.default)(axios_1.default, {
+            retries: (_a = this.retryCount) !== null && _a !== void 0 ? _a : 3,
+            retryCondition: this._isErrorRetryable,
+            retryDelay: axios_retry_1.default.exponentialDelay,
+        });
+    }
+    request(method, endpoint, payload) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const response = yield axios_1.default.request({
+                    baseURL: this.host,
+                    method: method,
+                    url: endpoint,
+                    data: payload,
+                    headers: this.headers,
+                });
+                return response.data;
+            }
+            catch (error) {
+                if (axios_1.default.isAxiosError(error)) {
+                    if (error.response) {
+                        throw new ApiResponseError_1.default(error.response.status, (_a = error.response.data.message) !== null && _a !== void 0 ? _a : error.response.statusText);
+                    }
+                    else if (error.request) {
+                        throw new ApiRequestError_1.default(error.message);
+                    }
+                }
+                throw error;
+            }
+        });
+    }
+    _generateDefaultHeaders() {
+        return {
+            "user-agent": `theauthapi-client-node/${libraryMeta_1.version}`,
+            "x-api-key": this.accessKey,
+            "api-key": this.accessKey,
+        };
+    }
+    _isErrorRetryable(error) {
+        // Retry Network Errors.
+        if (axios_retry_1.default.isNetworkError(error)) {
+            return true;
+        }
+        if (!error.response) {
+            // Cannot determine if the request can be retried
+            return false;
+        }
+        // Retry Server Errors (5xx).
+        if (error.response.status >= 500 && error.response.status <= 599) {
+            return true;
+        }
+        // Retry if rate limited.
+        if (error.response.status === 429) {
+            return true;
+        }
+        return false;
+    }
+}
+exports.default = ApiRequest;

package/dist/services/ApiRequest/ApiRequestError.d.ts

@@ -0,0 +1,10 @@
+/**
+ *
+ *  Throws when no response was received from the server
+ *  @param message - error message
+ *
+ * */
+declare class ApiRequestError extends Error {
+    constructor(message: string);
+}
+export default ApiRequestError;

package/dist/services/ApiRequest/ApiRequestError.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ *
+ *  Throws when no response was received from the server
+ *  @param message - error message
+ *
+ * */
+class ApiRequestError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'ApiRequestError';
+    }
+}
+exports.default = ApiRequestError;

package/dist/services/ApiRequest/ApiResponseError.d.ts

@@ -0,0 +1,12 @@
+/**
+ *
+ *  Throws when the server responds with a status code that falls out of the range 2xx
+ *  @param statusCode - HTTP status code the server responded with
+ *  @param message - error message
+ *
+ * */
+declare class ApiResponseError extends Error {
+    statusCode: number;
+    constructor(statusCode: number, message: string);
+}
+export default ApiResponseError;

package/dist/services/ApiRequest/ApiResponseError.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ *
+ *  Throws when the server responds with a status code that falls out of the range 2xx
+ *  @param statusCode - HTTP status code the server responded with
+ *  @param message - error message
+ *
+ * */
+class ApiResponseError extends Error {
+    constructor(statusCode, message) {
+        super(`(${statusCode}): ${message}`);
+        this.statusCode = statusCode;
+        this.name = "ApiResponseError";
+    }
+}
+exports.default = ApiResponseError;

package/dist/services/ApiRequest/HttpMethod.d.ts

@@ -0,0 +1,7 @@
+export declare enum HttpMethod {
+    GET = "GET",
+    POST = "POST",
+    DELETE = "DELETE",
+    PATCH = "PATCH",
+    PUT = "PUT"
+}

package/dist/services/ApiRequest/HttpMethod.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpMethod = void 0;
+var HttpMethod;
+(function (HttpMethod) {
+    HttpMethod["GET"] = "GET";
+    HttpMethod["POST"] = "POST";
+    HttpMethod["DELETE"] = "DELETE";
+    HttpMethod["PATCH"] = "PATCH";
+    HttpMethod["PUT"] = "PUT";
+})(HttpMethod = exports.HttpMethod || (exports.HttpMethod = {}));

package/dist/types/index.d.ts

@@ -0,0 +1,85 @@
+export type ApiKey = {
+    key: string;
+    name: string;
+    customMetaData: AnyJson;
+    customAccountId: string;
+    customUserId: string;
+    env: Environment;
+    createdAt: Date;
+    updatedAt: Date;
+    isActive: boolean;
+    rateLimitConfigs: RateLimitConfiguration;
+    expiry: Date;
+};
+export type RateLimitConfiguration = {
+    rateLimit: number;
+    rateLimitTtl: number;
+};
+export type ApiKeyInput = {
+    name: string;
+    projectId?: string;
+    key?: string;
+    customMetaData?: AnyJson;
+    customAccountId?: string;
+    customUserId?: string;
+    rateLimitConfigs?: RateLimitConfiguration;
+    expiry?: Date;
+};
+export type ApiKeyFilter = {
+    projectId?: string;
+    name?: string;
+    customAccountId?: string | null;
+    customUserId?: string | null;
+    isActive?: boolean;
+};
+export type UpdateApiKeyInput = {
+    name: string;
+    key?: string;
+    customMetaData?: AnyJson;
+    customAccountId?: string;
+    customUserId?: string;
+    expiry?: Date | null;
+    rateLimitConfigs?: RateLimitConfiguration | null;
+};
+export declare enum AuthedEntityType {
+    USER = "USER",
+    ACCESS_KEY = "ACCESS_KEY"
+}
+export type AuthBaseEntity = {
+    isActive: boolean;
+    createdBy: string;
+    createdByType?: AuthedEntityType;
+    createdIn: string;
+    lastChangedBy: string;
+    lastChangedByType?: AuthedEntityType;
+    updatedAt: Date;
+    createdAt: Date;
+};
+export type Project = AuthBaseEntity & {
+    id: string;
+    name: string;
+    accountId: string;
+    env: Environment;
+};
+export declare enum Environment {
+    LIVE = "live",
+    TEST = "test"
+}
+export type CreateProjectInput = {
+    name: string;
+    accountId: string;
+    env: Environment;
+};
+export type UpdateProjectInput = {
+    name: string;
+};
+export type Account = AuthBaseEntity & {
+    id: string;
+    name: string;
+};
+type AnyJson = boolean | number | string | null | JsonArray | JsonMap;
+type JsonMap = {
+    [key: string]: AnyJson;
+};
+type JsonArray = Array<AnyJson>;
+export {};

package/dist/types/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Environment = exports.AuthedEntityType = void 0;
+var AuthedEntityType;
+(function (AuthedEntityType) {
+    AuthedEntityType["USER"] = "USER";
+    AuthedEntityType["ACCESS_KEY"] = "ACCESS_KEY";
+})(AuthedEntityType = exports.AuthedEntityType || (exports.AuthedEntityType = {}));
+var Environment;
+(function (Environment) {
+    Environment["LIVE"] = "live";
+    Environment["TEST"] = "test";
+})(Environment = exports.Environment || (exports.Environment = {}));

package/package.json

@@ -1,25 +1,28 @@
 {
   "name": "theauthapi",
-  "version": "1.0.0",
+  "version": "1.0.1-2.1",
   "description": "Client library for TheAuthAPI.com",
-  "main": "index.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "theauthapi",
+    "authapi"
+  ],
   "scripts": {
-    "dependencies": "yarn",
-    "size": "size-limit",
-    "test": "standard && nyc ava",
-    "report-coverage": "nyc report --reporter=lcov > coverage.lcov && codecov",
-    "np": "np --no-publish",
-    "release": "yarn run np",
-    "babel-node": "babel-node --presets='@babel/preset-env'",
-    "dev": "nodemon --exec npm run babel-node -- src/app.js",
-    "test-mocha": "ava mocha"
+    "test": "jest --runInBand",
+    "test:coverage": "jest --coverage --runInBand",
+    "build": "tsc",
+    "prepublish": "npm run build"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/thatapicompany/theauthapi.git"
   },
   "author": "Aden Forshaw",
-  "license": "ISC",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/thatapicompany/theauthapi/issues"
   },
@@ -28,31 +31,24 @@
     "assert": "^2.0.0",
     "axios": "^0.21.4",
     "axios-retry": "^3.1.9",
-    "core-js": "^3.17.3",
-    "lodash.isstring": "^4.0.1",
-    "ms": "^2.1.3",
-    "node-cache": "^5.1.2",
-    "regenerator-runtime": "^0.13.9",
     "remove-trailing-slash": "^0.1.1"
   },
   "devDependencies": {
-    "ava": "^3.15.0",
-    "basic-auth": "^2.0.1",
-    "body-parser": "^1.17.1",
-    "chai": "^4.3.4",
-    "codecov": "^3.0.0",
-    "commander": "^5.1.0",
-    "delay": "^4.2.0",
+    "@types/express": "^4.17.13",
+    "@types/jest": "^27.5.2",
+    "@types/lodash.isstring": "^4.0.6",
+    "@types/lodash.omit": "^4.5.6",
+    "@types/ms": "^0.7.31",
+    "@types/node": "^17.0.23",
+    "@typescript-eslint/eslint-plugin": "^5.17.0",
+    "@typescript-eslint/parser": "^5.17.0",
+    "body-parser": "^1.20.0",
+    "eslint": "^7.14.0",
+    "eslint-config-prettier": "^8.5.0",
     "express": "^4.15.2",
-    "husky": "^3.0.4",
-    "mocha": "^9.1.1",
-    "nyc": "^14.1.1",
-    "pify": "^4.0.1",
-    "sinon": "^7.3.2",
-    "sinon-chai": "^3.7.0",
-    "size-limit": "^4.11.0",
-    "snyk": "^1.328.0",
-    "standard": "^12.0.1",
-    "supertest": "^6.1.6"
+    "jest": "^29.7.0",
+    "prettier": "2.6.2",
+    "ts-jest": "^29.1.1",
+    "typescript": "^4.6.3"
   }
 }

package/History.md

@@ -1,5 +0,0 @@
-
-v1.0.0 / 2021-09-11
-==========================
-
-  * Released to NPM for Alpha testing