theauthapi 1.0.10 → 1.0.12

package/README.md

@@ -33,7 +33,7 @@ yarn add theauthapi
 
 You'll need to configure the library with your `access key` and `account id`, you can grab these from [TheAuthAPI](https://app.theauthapi.com) dashboard.
 
-For further instructions on creating an account, check out our [how to guides](https://thatapicompany.notion.site/The-Auth-API-Knowledge-Base-21660cee84e640729714fad43d9ce546).
+For further instructions on creating an account, check out our [how to guides](https://support.theauthapi.com/).
 
 ### Imports
 
@@ -59,7 +59,6 @@ You can also provide custom options:
 
 ```javascript
 const theAuthAPI = new TheAuthAPI("YOUR_ACCESS_KEY", {
-  timeout: 3600,
   retryCount: 2,
 });
 ```
@@ -70,8 +69,6 @@ const theAuthAPI = new TheAuthAPI("YOUR_ACCESS_KEY", {
 type Options = {
   // server url
   host?: string;
-  // request timeout in ms
-  timeout?: string | number;
   // number of retries before failing
   retryCount?: number;
 };
@@ -165,10 +162,12 @@ try {
 ```typescript
 type ApiKeyFilter = {
   projectId?: string;
-  customAccountId?: string;
-  customUserId?: string;
+  name?: string;
+  customAccountId?: string | null;
+  customUserId?: string | null;
   isActive?: boolean;
 };
+
 ```
 
 **Example**: filtering api-keys with a specific `projectId` where the keys are not active

package/dist/endpoints/Accounts/Accounts.js

@@ -10,7 +10,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const HttpMethod_1 = require("../../services/ApiRequest/HttpMethod");
-const util_1 = require("../../util");
 class Accounts {
     constructor(apiService) {
         this.api = apiService;
@@ -18,7 +17,6 @@ class Accounts {
     }
     getAccount(accountId) {
         return __awaiter(this, void 0, void 0, function* () {
-            (0, util_1.validateString)("accountId", accountId);
             return yield this.api.request(HttpMethod_1.HttpMethod.GET, `${this.endpoint}/${accountId}`);
         });
     }

package/dist/endpoints/ApiKeys/ApiKeys.d.ts

@@ -12,9 +12,8 @@ declare class ApiKeys implements ApiKeysInterface {
     createKey(apiKey: ApiKeyInput): Promise<ApiKey>;
     updateKey(apiKey: string, updatedKey: UpdateApiKeyInput): Promise<ApiKey>;
     deleteKey(apiKey: string): Promise<boolean>;
-    private validateCreateKeyInput;
-    private validateUpdateKeyInput;
-    private validateFiltersInput;
+    reactivateKey(apiKey: string): Promise<ApiKey>;
+    rotateKey(apiKey: string): Promise<ApiKey>;
     private getKeysFilterEndpoint;
 }
 export default ApiKeys;

package/dist/endpoints/ApiKeys/ApiKeys.js

@@ -13,8 +13,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const HttpMethod_1 = require("../../services/ApiRequest/HttpMethod");
-const lodash_omit_1 = __importDefault(require("lodash.omit"));
-const util_1 = require("../../util");
 const ApiResponseError_1 = __importDefault(require("../../services/ApiRequest/ApiResponseError"));
 class ApiKeys {
     constructor(apiService) {
@@ -23,9 +21,8 @@ class ApiKeys {
     }
     isValidKey(apikey) {
         return __awaiter(this, void 0, void 0, function* () {
-            (0, util_1.validateString)("apikey", apikey);
             try {
-                const key = yield this.api.request(HttpMethod_1.HttpMethod.GET, `/api-keys/auth/${apikey}`);
+                const key = yield this.authenticateKey(apikey);
                 return key.key !== undefined;
             }
             catch (error) {
@@ -38,8 +35,7 @@ class ApiKeys {
     }
     authenticateKey(apikey) {
         return __awaiter(this, void 0, void 0, function* () {
-            (0, util_1.validateString)("apikey", apikey);
-            return yield this.api.request(HttpMethod_1.HttpMethod.GET, `/api-keys/auth/${apikey}`);
+            return yield this.api.request(HttpMethod_1.HttpMethod.POST, `/api-keys/auth/${apikey}`);
         });
     }
     getKeys(filter) {
@@ -50,67 +46,40 @@ class ApiKeys {
     }
     getKey(apikey) {
         return __awaiter(this, void 0, void 0, function* () {
-            (0, util_1.validateString)("apikey", apikey);
             return yield this.api.request(HttpMethod_1.HttpMethod.GET, `/api-keys/${apikey}`);
         });
     }
     createKey(apiKey) {
         return __awaiter(this, void 0, void 0, function* () {
-            this.validateCreateKeyInput(apiKey);
             return yield this.api.request(HttpMethod_1.HttpMethod.POST, "/api-keys", apiKey);
         });
     }
     updateKey(apiKey, updatedKey) {
         return __awaiter(this, void 0, void 0, function* () {
-            this.validateUpdateKeyInput(apiKey, updatedKey);
             return yield this.api.request(HttpMethod_1.HttpMethod.PATCH, `/api-keys/${apiKey}`, updatedKey);
         });
     }
     deleteKey(apiKey) {
         return __awaiter(this, void 0, void 0, function* () {
-            (0, util_1.validateString)("apiKey", apiKey);
             return yield this.api.request(HttpMethod_1.HttpMethod.DELETE, `/api-keys/${apiKey}`);
         });
     }
-    validateCreateKeyInput(apiKey) {
-        if (!apiKey) {
-            throw new TypeError("apiKey must be an object");
-        }
-        if (!apiKey.name) {
-            throw TypeError("apiKey object must contain the property name");
-        }
-        // validate string properties only
-        for (const [key, value] of Object.entries((0, lodash_omit_1.default)(apiKey, ["customMetaData", "rateLimitConfigs"]))) {
-            (0, util_1.validateString)(key, value);
-        }
-    }
-    validateUpdateKeyInput(apiKey, updatedKey) {
-        if (!updatedKey) {
-            throw new TypeError("updatedKey must be an object");
-        }
-        if (!updatedKey.name) {
-            throw TypeError("updatedKey object must contain the property [name]");
-        }
-        (0, util_1.validateString)("apiKey", apiKey);
-        (0, util_1.validateString)("name", updatedKey.name);
+    reactivateKey(apiKey) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.api.request(HttpMethod_1.HttpMethod.PATCH, `/api-keys/${apiKey}/reactivate`);
+        });
     }
-    validateFiltersInput(filter) {
-        if (filter) {
-            if (filter.isActive && typeof filter.isActive !== "boolean") {
-                throw TypeError("isActive must be a boolean");
-            }
-            Object.entries((0, lodash_omit_1.default)(filter, "isActive")).forEach(([key, value]) => {
-                (0, util_1.validateString)(key, value);
-            });
-        }
+    rotateKey(apiKey) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.api.request(HttpMethod_1.HttpMethod.POST, `/api-keys/${apiKey}/rotate`);
+        });
     }
     getKeysFilterEndpoint(filter) {
-        this.validateFiltersInput(filter);
         let filters = [];
-        if (filter) {
+        if (filter !== undefined) {
             filters = Object.entries(filter).map(([key, value]) => `${key}=${value}`);
         }
-        return `${this.endpoint}${filter ? "?" : ""}${filters.join("&")}`;
+        return `${this.endpoint}${filter !== undefined ? "?" : ""}${filters.join("&")}`;
     }
 }
 exports.default = ApiKeys;

package/dist/endpoints/ApiKeys/ApiKeysInterface.d.ts

@@ -7,4 +7,6 @@ export interface ApiKeysInterface {
     createKey(apiKey: ApiKeyInput): Promise<ApiKey>;
     updateKey(apiKey: string, updateTo: UpdateApiKeyInput): Promise<ApiKey>;
     deleteKey(apiKey: string): Promise<boolean>;
+    reactivateKey(apiKey: string): Promise<ApiKey>;
+    rotateKey(apiKey: string): Promise<ApiKey>;
 }

package/dist/endpoints/Projects/Projects.d.ts

@@ -10,7 +10,5 @@ declare class Projects implements ProjectsInterface {
     deleteProject(projectId: string): Promise<boolean>;
     createProject(project: CreateProjectInput): Promise<Project>;
     updateProject(projectId: string, project: UpdateProjectInput): Promise<Project>;
-    private validateCreateProjectInput;
-    private validateUpdateProjectInput;
 }
 export default Projects;

package/dist/endpoints/Projects/Projects.js

@@ -9,9 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const types_1 = require("../../types");
 const HttpMethod_1 = require("../../services/ApiRequest/HttpMethod");
-const util_1 = require("../../util");
 class Projects {
     constructor(apiService) {
         this.api = apiService;
@@ -19,50 +17,28 @@ class Projects {
     }
     getProjects(accountId) {
         return __awaiter(this, void 0, void 0, function* () {
-            (0, util_1.validateString)("accountId", accountId);
             return yield this.api.request(HttpMethod_1.HttpMethod.GET, `${this.endpoint}?accountId=${accountId}`);
         });
     }
     getProject(projectId) {
         return __awaiter(this, void 0, void 0, function* () {
-            (0, util_1.validateString)("projectId", projectId);
             return yield this.api.request(HttpMethod_1.HttpMethod.GET, `${this.endpoint}/${projectId}`);
         });
     }
     deleteProject(projectId) {
         return __awaiter(this, void 0, void 0, function* () {
-            (0, util_1.validateString)("projectId", projectId);
             return yield this.api.request(HttpMethod_1.HttpMethod.DELETE, `${this.endpoint}/${projectId}`);
         });
     }
     createProject(project) {
         return __awaiter(this, void 0, void 0, function* () {
-            this.validateCreateProjectInput(project);
             return yield this.api.request(HttpMethod_1.HttpMethod.POST, this.endpoint, project);
         });
     }
     updateProject(projectId, project) {
         return __awaiter(this, void 0, void 0, function* () {
-            this.validateUpdateProjectInput(projectId, project);
             return this.api.request(HttpMethod_1.HttpMethod.PATCH, `${this.endpoint}/${projectId}`, project);
         });
     }
-    validateCreateProjectInput(project) {
-        if (!project) {
-            throw new TypeError("project must be an object");
-        }
-        (0, util_1.validateString)("name", project.name);
-        (0, util_1.validateString)("accountId", project.accountId);
-        if (!Object.values(types_1.Environment).includes(project.env)) {
-            throw TypeError(`expected env to be one of [${Object.values(types_1.Environment).map((v) => `"${v}"`)}], got: ${project.env}`);
-        }
-    }
-    validateUpdateProjectInput(projectId, project) {
-        if (!project) {
-            throw new TypeError("project must be an object");
-        }
-        (0, util_1.validateString)("projectId", projectId);
-        (0, util_1.validateString)("name", project.name);
-    }
 }
 exports.default = Projects;

package/dist/index.d.ts

@@ -2,33 +2,23 @@ import ApiRequest from "./services/ApiRequest/ApiRequest";
 import ApiKeys from "./endpoints/ApiKeys/ApiKeys";
 import Projects from "./endpoints/Projects/Projects";
 import Accounts from "./endpoints/Accounts/Accounts";
-declare type Options = {
+type Options = {
     host?: string;
-    timeout?: string | number;
-    cacheTTL?: number;
-    enable?: boolean;
     retryCount?: number;
 };
 declare class TheAuthAPI {
-    queue: [];
     accessKey: string;
     host: string;
     timeout: number | string | undefined;
-    cacheTTL: number;
     api: ApiRequest;
     apiKeys: ApiKeys;
     projects: Projects;
     accounts: Accounts;
     /**
-     * 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)
+     *   @property {number} retryCount (default: 3)
      */
     constructor(accessKey: string, options?: Options);
     authenticateAPIKey(key: string, callback?: (err: any, data: any) => any): Promise<unknown>;

package/dist/index.js

@@ -15,7 +15,6 @@ 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"));
@@ -24,44 +23,30 @@ const Accounts_1 = __importDefault(require("./endpoints/Accounts/Accounts"));
 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)
+     *   @property {number} retryCount (default: 3)
      */
     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,
+            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);
-        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);

package/dist/libraryMeta.d.ts

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

package/dist/libraryMeta.js

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

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

@@ -1,17 +1,15 @@
 import { HttpMethod } from "./HttpMethod";
 import ApiCall from "./ApiCall";
-declare type Config = {
+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;

package/dist/services/ApiRequest/ApiRequest.js

@@ -16,15 +16,13 @@ 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;
+        const { host, accessKey, headers, retryCount } = 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 });

package/dist/types/index.d.ts

@@ -1,45 +1,51 @@
-export declare type ApiKey = {
+export type ApiKey = {
     key: string;
     name: string;
-    customMetaData: object;
+    customMetaData: AnyJson;
     customAccountId: string;
     customUserId: string;
     env: Environment;
     createdAt: Date;
     updatedAt: Date;
     isActive: boolean;
+    rateLimitConfigs: RateLimitConfiguration;
+    expiry: Date;
 };
-export declare type RateLimitConfiguration = {
-    rateLimitedEntity?: string;
-    ratelimitedEnitityId?: string;
+export type RateLimitConfiguration = {
     rateLimit: number;
     rateLimitTtl: number;
 };
-export declare type ApiKeyInput = {
+export type ApiKeyInput = {
     name: string;
     projectId?: string;
     key?: string;
-    customMetaData?: object;
+    customMetaData?: AnyJson;
     customAccountId?: string;
     customUserId?: string;
     rateLimitConfigs?: RateLimitConfiguration;
+    expiry?: Date;
 };
-export declare type ApiKeyFilter = {
+export type ApiKeyFilter = {
     projectId?: string;
-    customAccountId?: string;
-    customUserId?: string;
+    name?: string;
+    customAccountId?: string | null;
+    customUserId?: string | null;
     isActive?: boolean;
 };
-export declare type UpdateApiKeyInput = {
+export type UpdateApiKeyInput = {
     name: string;
-    customMetaData?: object;
+    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 declare type AuthBaseEntity = {
+export type AuthBaseEntity = {
     isActive: boolean;
     createdBy: string;
     createdByType?: AuthedEntityType;
@@ -49,7 +55,7 @@ export declare type AuthBaseEntity = {
     updatedAt: Date;
     createdAt: Date;
 };
-export declare type Project = AuthBaseEntity & {
+export type Project = AuthBaseEntity & {
     id: string;
     name: string;
     accountId: string;
@@ -59,15 +65,21 @@ export declare enum Environment {
     LIVE = "live",
     TEST = "test"
 }
-export declare type CreateProjectInput = {
+export type CreateProjectInput = {
     name: string;
     accountId: string;
     env: Environment;
 };
-export declare type UpdateProjectInput = {
+export type UpdateProjectInput = {
     name: string;
 };
-export declare type Account = AuthBaseEntity & {
+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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "theauthapi",
-  "version": "1.0.10",
+  "version": "1.0.12",
   "description": "Client library for TheAuthAPI.com",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -31,14 +31,11 @@
     "assert": "^2.0.0",
     "axios": "^0.21.4",
     "axios-retry": "^3.1.9",
-    "lodash.isstring": "^4.0.1",
-    "lodash.omit": "^4.5.0",
-    "ms": "^2.1.3",
     "remove-trailing-slash": "^0.1.1"
   },
   "devDependencies": {
     "@types/express": "^4.17.13",
-    "@types/jest": "^27.4.1",
+    "@types/jest": "^27.5.2",
     "@types/lodash.isstring": "^4.0.6",
     "@types/lodash.omit": "^4.5.6",
     "@types/ms": "^0.7.31",
@@ -49,8 +46,9 @@
     "eslint": "^7.14.0",
     "eslint-config-prettier": "^8.5.0",
     "express": "^4.15.2",
-    "jest": "^27.5.1",
+    "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

package/dist/util/index.d.ts

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

package/dist/util/index.js

@@ -1,13 +0,0 @@
-"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;