theauthapi 1.0.4 → 1.0.7

package/dist/index.js

@@ -0,0 +1,89 @@
+"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 util_1 = require("./util");
+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 {
+    /**
+     * Initialize a new `Analytics` with your Segment project's `writeKey` and an
+     * optional dictionary of `options`.
+     *
+     * @param {String} accessKey
+     * @param {Object} [options] (optional)
+     *   @property {Number} flushAt (default: 20)
+     *   @property {Number} flushInterval (default: 10000)
+     *   @property {String} host (default: 'https://api.segment.io')
+     *   @property {Boolean} enable (default: true)
+     */
+    constructor(accessKey, options) {
+        var _a;
+        (0, assert_1.default)(accessKey, "You must pass your project's write key.");
+        this.queue = [];
+        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.timeout = options === null || options === void 0 ? void 0 : options.timeout;
+        this.cacheTTL = (_a = options === null || options === void 0 ? void 0 : options.cacheTTL) !== null && _a !== void 0 ? _a : 60;
+        this.api = new ApiRequest_1.default({
+            accessKey: this.accessKey,
+            host: this.host,
+        });
+        this.apiKeys = new ApiKeys_1.default(this.api);
+        this.projects = new Projects_1.default(this.api);
+        this.accounts = new Accounts_1.default(this.api);
+        Object.defineProperty(this, "enable", {
+            configurable: false,
+            writable: false,
+            enumerable: true,
+            value: typeof (options === null || options === void 0 ? void 0 : options.enable) === "boolean" ? options.enable : true,
+        });
+    }
+    /*
+      @deprecated
+     */
+    authenticateAPIKey(key, callback) {
+        return __awaiter(this, void 0, void 0, function* () {
+            (0, util_1.validateString)("key", key);
+            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.6";

package/dist/libraryMeta.js

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

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,26 @@
+import { HttpMethod } from "./HttpMethod";
+import ApiCall from "./ApiCall";
+declare type Config = {
+    host: string;
+    accessKey: string;
+    headers?: object;
+    retryCount?: number;
+    timeout?: number | string;
+};
+declare class ApiRequest implements ApiCall {
+    host: string;
+    headers: object;
+    accessKey: string;
+    timeout: number;
+    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,117 @@
+"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 ms_1 = __importDefault(require("ms"));
+const ApiResponseError_1 = __importDefault(require("./ApiResponseError"));
+class ApiRequest {
+    constructor(config) {
+        const { host, accessKey, headers, retryCount, timeout } = config;
+        this.host = host;
+        this.accessKey = accessKey;
+        this.headers = this._generateDefaultHeaders();
+        this.timeout = timeout ? (typeof timeout === "string" ? (0, ms_1.default)(timeout) : timeout) : 0;
+        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,65 @@
+export declare type ApiKey = {
+    key: string;
+    name: string;
+    customMetaData: string;
+    customAccountId: string;
+    env: string;
+    createdAt: Date;
+    updatedAt: Date;
+};
+export declare type RateLimitConfiguration = {
+    rateLimitedEntity?: string;
+    ratelimitedEnitityId?: any;
+    rateLimit: number;
+    rateLimitTtl: number;
+};
+export declare type ApiKeyInput = {
+    name: string;
+    projectId: string;
+    key?: string;
+    customMetaData?: object;
+    customAccountId?: string;
+    rateLimitConfigs?: RateLimitConfiguration;
+    customUserId?: string;
+};
+export declare type UpdateApiKeyInput = {
+    name: string;
+    customMetaData?: object;
+    customAccountId?: string;
+};
+export declare enum AuthedEntityType {
+    USER = "USER",
+    ACCESS_KEY = "ACCESS_KEY"
+}
+export declare type AuthBaseEntity = {
+    isActive: boolean;
+    createdBy: string;
+    createdByType?: AuthedEntityType;
+    createdIn: string;
+    lastChangedBy: string;
+    lastChangedByType?: AuthedEntityType;
+    updatedAt: Date;
+    createdAt: Date;
+};
+export declare type Project = AuthBaseEntity & {
+    id: string;
+    name: string;
+    accountId: string;
+    env: string;
+};
+export declare enum Environment {
+    LIVE = "live",
+    TEST = "test"
+}
+export declare type CreateProjectInput = {
+    name: string;
+    accountId: string;
+    env: Environment;
+};
+export declare type UpdateProjectInput = {
+    name: string;
+};
+export declare type Account = AuthBaseEntity & {
+    id: string;
+    name: string;
+};

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/dist/util/index.d.ts

@@ -0,0 +1 @@
+export declare function validateString(variableName: string, value: string): void;

package/dist/util/index.js

@@ -0,0 +1,13 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateString = void 0;
+const lodash_isstring_1 = __importDefault(require("lodash.isstring"));
+function validateString(variableName, value) {
+    if (!value || !(0, lodash_isstring_1.default)(value)) {
+        throw new TypeError(`${variableName} must be a string, got: ${value}`);
+    }
+}
+exports.validateString = validateString;

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "theauthapi",
-  "version": "1.0.4",
+  "version": "1.0.7",
   "description": "Client library for TheAuthAPI.com",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "test": "jest --runInBand",
     "test:coverage": "jest --coverage --runInBand",
@@ -52,13 +55,5 @@
     "ts-jest": "^27.1.4",
     "ts-node": "^10.7.0",
     "typescript": "^4.6.3"
-  },
-  "ava": {
-    "extensions": [
-      "ts"
-    ],
-    "require": [
-      "ts-node/register"
-    ]
   }
 }

package/.eslintrc.js

@@ -1,15 +0,0 @@
-module.exports = {
-  root: true,
-  parser: '@typescript-eslint/parser',
-  plugins: [
-    '@typescript-eslint',
-  ],
-  extends: [
-    'eslint:recommended',
-    'plugin:@typescript-eslint/recommended',
-    'prettier'
-  ],
-  env: {
-    node: true
-  }
-};

package/.prettierrc.json

@@ -1 +0,0 @@
-{}

package/jest.config.js

@@ -1,5 +0,0 @@
-module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  setupFilesAfterEnv: ['./jest.setup.ts'],
-};

package/src/endpoints/ApiKeys/ApiKeys.ts

@@ -1,68 +0,0 @@
-import { HttpMethod } from "../../services/ApiRequest/HttpMethod";
-import omit from "lodash.omit";
-import ApiRequest from "../../services/ApiRequest/ApiRequest";
-import {ApiKey, ApiKeyInput, UpdateApiKeyInput} from "../../types";
-import { validateString } from "../../util";
-import ApiKeysInterface from "./ApiKeysInterface";
-
-class ApiKeys implements ApiKeysInterface {
-  api: ApiRequest;
-
-  constructor(apiService: ApiRequest) {
-    this.api = apiService;
-  }
-
-  async authenticateKey(apikey: string) {
-    validateString("apikey", apikey);
-    return await this.api.request<ApiKey>(
-      HttpMethod.GET,
-      `/api-keys/${apikey}`
-    );
-  }
-
-  async getKeys(projectId: string) {
-    validateString("projectId", projectId);
-    return await this.api.request<ApiKey[]>(
-      HttpMethod.GET,
-      `/api-keys/?projectId=${projectId}`
-    );
-  }
-
-  async createKey(apiKey: ApiKeyInput) {
-    // validate string properties only
-    for (const [key, value] of Object.entries(
-      omit(apiKey, ["customMetaData", "rateLimitConfigs"])
-    )) {
-      validateString(key, value);
-    }
-    return await this.api.request<ApiKey>(
-      HttpMethod.POST,
-      "/api-keys",
-      apiKey
-    );
-  }
-
-  async updateKey(apiKey: string, updateTo: UpdateApiKeyInput) {
-    validateString("apiKey", apiKey);
-    for (const [key, value] of Object.entries(
-      omit(updateTo, "customMetaData")
-    )) {
-      validateString(key, value);
-    }
-    return await this.api.request<ApiKey>(
-      HttpMethod.PATCH,
-      `/api-keys/${apiKey}`,
-      updateTo
-    );
-  }
-
-  async deleteKey(apiKey: string) {
-    validateString("apiKey", apiKey);
-    return await this.api.request<boolean>(
-      HttpMethod.DELETE,
-      `/api-keys/${apiKey}`
-    );
-  }
-}
-
-export = ApiKeys;

package/src/endpoints/ApiKeys/ApiKeysInterface.ts

@@ -1,11 +0,0 @@
-import { ApiKey, ApiKeyInput, UpdateApiKeyInput } from "../../types";
-
-interface ApiKeysInterface {
-  authenticateKey(apiKey: string): Promise<ApiKey>;
-  getKeys(projectId: string): Promise<ApiKey[]>;
-  createKey(apiKey: ApiKeyInput): Promise<ApiKey>;
-  updateKey(apiKey: string, updateTo: UpdateApiKeyInput): Promise<ApiKey>;
-  deleteKey(apiKey: string): Promise<boolean>;
-}
-
-export = ApiKeysInterface;

package/src/endpoints/Projects/Projects.ts

@@ -1,62 +0,0 @@
-import ApiRequest from "../../services/ApiRequest/ApiRequest";
-import { Project, UpdateProjectInput } from "../../types";
-import { HttpMethod } from "../../services/ApiRequest/HttpMethod";
-import { validateString } from "../../util";
-import { ProjectsInterface } from "./ProjectsInterface";
-
-class Projects implements ProjectsInterface {
-  api: ApiRequest;
-  endpoint: string;
-
-  constructor(apiService: ApiRequest) {
-    this.api = apiService;
-    this.endpoint = "/projects";
-  }
-
-  async getProjects(accountId: string): Promise<Project[]> {
-    validateString("accountId", accountId);
-    return await this.api.request<Project[]>(
-      HttpMethod.GET,
-      `${this.endpoint}?accountId=${accountId}`
-    );
-  }
-
-  async getProject(projectId: string): Promise<Project> {
-    validateString("projectId", projectId);
-    return await this.api.request<Project>(
-      HttpMethod.GET,
-      `${this.endpoint}/${projectId}`
-    );
-  }
-
-  async deleteProject(projectId: string): Promise<boolean> {
-    validateString("projectId", projectId);
-    return await this.api.request<boolean>(
-      HttpMethod.DELETE,
-      `${this.endpoint}/${projectId}`
-    );
-  }
-
-  async createProject(name: string, accountId: string): Promise<Project> {
-    validateString("name", name);
-    validateString("accountId", accountId);
-    return await this.api.request<Project>(HttpMethod.POST, this.endpoint, {
-      name,
-      accountId,
-    });
-  }
-
-  async updateProject(
-    projectId: string,
-    updateTo: UpdateProjectInput
-  ): Promise<Project> {
-    validateString("projectId", projectId);
-    return this.api.request<Project>(
-      HttpMethod.PATCH,
-      `${this.endpoint}/${projectId}`,
-      updateTo
-    );
-  }
-}
-
-export default Projects;

package/src/endpoints/Projects/ProjectsInterface.ts

@@ -1,9 +0,0 @@
-import {Project, UpdateProjectInput} from "../../types";
-
-export interface ProjectsInterface {
-  getProjects(accountId: string): Promise<Project[]>;
-  getProject(projectId: string): Promise<Project>;
-  deleteProject(projectId: string): Promise<boolean>;
-  createProject(name: string, accountId: string): Promise<Project>;
-  updateProject(name: string, updateTo: UpdateProjectInput): Promise<Project>;
-}