theauthapi 1.0.15 → 1.0.16

package/dist/endpoints/Accounts/Accounts.d.ts

@@ -1,6 +1,6 @@
-import { AccountsInterface } from "./AccountsInterface";
-import ApiRequest from "../../services/ApiRequest/ApiRequest";
-import { Account } from "../../types";
+import { AccountsInterface } from './AccountsInterface';
+import ApiRequest from '../../services/ApiRequest/ApiRequest';
+import { Account } from '../../types';
 declare class Accounts implements AccountsInterface {
     api: ApiRequest;
     endpoint: string;

package/dist/endpoints/Accounts/Accounts.js

@@ -7,11 +7,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { HttpMethod } from "../../services/ApiRequest/HttpMethod";
+import { HttpMethod } from '../../services/ApiRequest/HttpMethod';
 class Accounts {
     constructor(apiService) {
         this.api = apiService;
-        this.endpoint = "/accounts";
+        this.endpoint = '/accounts';
     }
     getAccount(accountId) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/endpoints/Accounts/AccountsInterface.d.ts

@@ -1,4 +1,4 @@
-import { Account } from "../../types";
+import { Account } from '../../types';
 export interface AccountsInterface {
     getAccount(accountId: string): Promise<Account>;
 }

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

@@ -1,6 +1,6 @@
-import ApiRequest from "../../services/ApiRequest/ApiRequest";
-import { ApiKey, ApiKeyFilter, ApiKeyInput, UpdateApiKeyInput } from "../../types";
-import { ApiKeysInterface } from "./ApiKeysInterface";
+import ApiRequest from '../../services/ApiRequest/ApiRequest';
+import { ApiKey, ApiKeyFilter, ApiKeyInput, UpdateApiKeyInput } from '../../types';
+import { ApiKeysInterface } from './ApiKeysInterface';
 declare class ApiKeys implements ApiKeysInterface {
     api: ApiRequest;
     private readonly endpoint;

package/dist/endpoints/ApiKeys/ApiKeys.js

@@ -7,12 +7,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { HttpMethod } from "../../services/ApiRequest/HttpMethod";
-import ApiResponseError from "../../services/ApiRequest/ApiResponseError";
+import { HttpMethod } from '../../services/ApiRequest/HttpMethod';
+import ApiResponseError from '../../services/ApiRequest/ApiResponseError';
 class ApiKeys {
     constructor(apiService) {
         this.api = apiService;
-        this.endpoint = "/api-keys/";
+        this.endpoint = '/api-keys/';
     }
     isValidKey(apikey) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -46,7 +46,7 @@ class ApiKeys {
     }
     createKey(apiKey) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.api.request(HttpMethod.POST, "/api-keys", apiKey);
+            return yield this.api.request(HttpMethod.POST, '/api-keys', apiKey);
         });
     }
     updateKey(apiKey, updatedKey) {
@@ -74,7 +74,7 @@ class ApiKeys {
         if (filter !== undefined) {
             filters = Object.entries(filter).map(([key, value]) => `${key}=${value}`);
         }
-        return `${this.endpoint}${filter !== undefined ? "?" : ""}${filters.join("&")}`;
+        return `${this.endpoint}${filter !== undefined ? '?' : ''}${filters.join('&')}`;
     }
 }
 export default ApiKeys;

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

@@ -1,4 +1,4 @@
-import { ApiKey, ApiKeyFilter, ApiKeyInput, UpdateApiKeyInput } from "../../types";
+import { ApiKey, ApiKeyFilter, ApiKeyInput, UpdateApiKeyInput } from '../../types';
 export interface ApiKeysInterface {
     isValidKey(apiKey: string): Promise<boolean>;
     getKey(apiKey: string): Promise<ApiKey>;

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

@@ -1,6 +1,6 @@
-import ApiRequest from "../../services/ApiRequest/ApiRequest";
-import { CreateProjectInput, Project, UpdateProjectInput } from "../../types";
-import { ProjectsInterface } from "./ProjectsInterface";
+import ApiRequest from '../../services/ApiRequest/ApiRequest';
+import { CreateProjectInput, Project, UpdateProjectInput } from '../../types';
+import { ProjectsInterface } from './ProjectsInterface';
 declare class Projects implements ProjectsInterface {
     api: ApiRequest;
     endpoint: string;

package/dist/endpoints/Projects/Projects.js

@@ -7,11 +7,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { HttpMethod } from "../../services/ApiRequest/HttpMethod";
+import { HttpMethod } from '../../services/ApiRequest/HttpMethod';
 class Projects {
     constructor(apiService) {
         this.api = apiService;
-        this.endpoint = "/projects";
+        this.endpoint = '/projects';
     }
     getProjects(accountId) {
         return __awaiter(this, void 0, void 0, function* () {

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

@@ -1,4 +1,4 @@
-import { CreateProjectInput, Project, UpdateProjectInput } from "../../types";
+import { CreateProjectInput, Project, UpdateProjectInput } from '../../types';
 export interface ProjectsInterface {
     getProjects(accountId: string): Promise<Project[]>;
     getProject(projectId: string): Promise<Project>;

package/dist/index.cjs

@@ -32,7 +32,7 @@ function __awaiter(thisArg, _arguments, P, generator) {
     });
 }
 
-const version = "1.0.11";
+const version = '1.0.11';
 
 /**
  *
@@ -58,7 +58,7 @@ class ApiResponseError extends Error {
     constructor(statusCode, message) {
         super(`(${statusCode}): ${message}`);
         this.statusCode = statusCode;
-        this.name = "ApiResponseError";
+        this.name = 'ApiResponseError';
     }
 }
 
@@ -78,10 +78,10 @@ class ApiRequest {
         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);
+            return value && typeof value === 'string' && isoDateFormat.test(value);
         }
         function handleDates(body) {
-            if (body === null || body === undefined || typeof body !== "object") {
+            if (body === null || body === undefined || typeof body !== 'object') {
                 return body;
             }
             for (const key of Object.keys(body)) {
@@ -89,7 +89,7 @@ class ApiRequest {
                 if (isIsoDateString(value)) {
                     body[key] = new Date(value);
                 }
-                else if (typeof value === "object") {
+                else if (typeof value === 'object') {
                     handleDates(value);
                 }
             }
@@ -132,9 +132,9 @@ class ApiRequest {
     }
     _generateDefaultHeaders() {
         return {
-            "user-agent": `theauthapi-client-node/${version}`,
-            "x-api-key": this.accessKey,
-            "api-key": this.accessKey,
+            'user-agent': `theauthapi-client-node/${version}`,
+            'x-api-key': this.accessKey,
+            'api-key': this.accessKey,
         };
     }
     _isErrorRetryable(error) {
@@ -170,7 +170,7 @@ var HttpMethod;
 class ApiKeys {
     constructor(apiService) {
         this.api = apiService;
-        this.endpoint = "/api-keys/";
+        this.endpoint = '/api-keys/';
     }
     isValidKey(apikey) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -204,7 +204,7 @@ class ApiKeys {
     }
     createKey(apiKey) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.api.request(HttpMethod.POST, "/api-keys", apiKey);
+            return yield this.api.request(HttpMethod.POST, '/api-keys', apiKey);
         });
     }
     updateKey(apiKey, updatedKey) {
@@ -232,14 +232,14 @@ class ApiKeys {
         if (filter !== undefined) {
             filters = Object.entries(filter).map(([key, value]) => `${key}=${value}`);
         }
-        return `${this.endpoint}${filter !== undefined ? "?" : ""}${filters.join("&")}`;
+        return `${this.endpoint}${filter !== undefined ? '?' : ''}${filters.join('&')}`;
     }
 }
 
 class Projects {
     constructor(apiService) {
         this.api = apiService;
-        this.endpoint = "/projects";
+        this.endpoint = '/projects';
     }
     getProjects(accountId) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -271,7 +271,7 @@ class Projects {
 class Accounts {
     constructor(apiService) {
         this.api = apiService;
-        this.endpoint = "/accounts";
+        this.endpoint = '/accounts';
     }
     getAccount(accountId) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -293,7 +293,7 @@ class TheAuthAPI {
         var _a;
         assert(accessKey, "You must pass your project's write key.");
         this.accessKey = accessKey;
-        this.host = removeSlash((options === null || options === void 0 ? void 0 : options.host) || "https://api.theauthapi.com");
+        this.host = removeSlash((options === null || options === void 0 ? void 0 : options.host) || 'https://api.theauthapi.com');
         this.api = new ApiRequest({
             accessKey: this.accessKey,
             host: this.host,
@@ -318,7 +318,7 @@ class TheAuthAPI {
                 sentAt: new Date().getTime(),
             };
             try {
-                const key = yield this.api.request(HttpMethod.POST, "/auth/authenticate", data);
+                const key = yield this.api.request(HttpMethod.POST, '/auth/authenticate', data);
                 done(key);
                 return key;
             }

package/dist/index.d.cts

@@ -0,0 +1,200 @@
+declare enum HttpMethod {
+    GET = "GET",
+    POST = "POST",
+    DELETE = "DELETE",
+    PATCH = "PATCH",
+    PUT = "PUT"
+}
+
+interface ApiCall {
+    request<T>(method: HttpMethod, endpoint: string, payload?: any): Promise<T>;
+}
+
+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;
+}
+
+type ApiKey = {
+    key: string;
+    name: string;
+    customMetaData: AnyJson;
+    customAccountId: string;
+    customUserId: string;
+    env: Environment;
+    createdAt: Date;
+    updatedAt: Date;
+    isActive: boolean;
+    rateLimitConfigs: RateLimitConfiguration;
+    expiry: Date;
+};
+type RateLimitConfiguration = {
+    rateLimit: number;
+    rateLimitTtl: number;
+};
+type ApiKeyInput = {
+    name: string;
+    projectId?: string;
+    key?: string;
+    customMetaData?: AnyJson;
+    customAccountId?: string;
+    customUserId?: string;
+    rateLimitConfigs?: RateLimitConfiguration;
+    expiry?: Date;
+};
+type ApiKeyFilter = {
+    projectId?: string;
+    name?: string;
+    customAccountId?: string | null;
+    customUserId?: string | null;
+    isActive?: boolean;
+};
+type UpdateApiKeyInput = {
+    name: string;
+    key?: string;
+    customMetaData?: AnyJson;
+    customAccountId?: string;
+    customUserId?: string;
+    expiry?: Date | null;
+    rateLimitConfigs?: RateLimitConfiguration | null;
+};
+declare enum AuthedEntityType {
+    USER = "USER",
+    ACCESS_KEY = "ACCESS_KEY"
+}
+type AuthBaseEntity = {
+    isActive: boolean;
+    createdBy: string;
+    createdByType?: AuthedEntityType;
+    createdIn: string;
+    lastChangedBy: string;
+    lastChangedByType?: AuthedEntityType;
+    updatedAt: Date;
+    createdAt: Date;
+};
+type Project = AuthBaseEntity & {
+    id: string;
+    name: string;
+    accountId: string;
+    env: Environment;
+};
+declare enum Environment {
+    LIVE = "live",
+    TEST = "test"
+}
+type CreateProjectInput = {
+    name: string;
+    accountId: string;
+    env: Environment;
+};
+type UpdateProjectInput = {
+    name: string;
+};
+type Account = AuthBaseEntity & {
+    id: string;
+    name: string;
+};
+type AnyJson = boolean | number | string | null | JsonArray | JsonMap;
+type JsonMap = {
+    [key: string]: AnyJson;
+};
+type JsonArray = Array<AnyJson>;
+
+interface ApiKeysInterface {
+    isValidKey(apiKey: string): Promise<boolean>;
+    getKey(apiKey: string): Promise<ApiKey>;
+    authenticateKey(apiKey: string): Promise<ApiKey>;
+    getKeys(filter?: ApiKeyFilter): Promise<ApiKey[]>;
+    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>;
+}
+
+declare class ApiKeys implements ApiKeysInterface {
+    api: ApiRequest;
+    private readonly endpoint;
+    constructor(apiService: ApiRequest);
+    isValidKey(apikey: string): Promise<boolean>;
+    authenticateKey(apikey: string): Promise<ApiKey>;
+    getKeys(filter?: ApiKeyFilter): Promise<ApiKey[]>;
+    getKey(apikey: string): Promise<ApiKey>;
+    createKey(apiKey: ApiKeyInput): Promise<ApiKey>;
+    updateKey(apiKey: string, updatedKey: UpdateApiKeyInput): Promise<ApiKey>;
+    deleteKey(apiKey: string): Promise<boolean>;
+    reactivateKey(apiKey: string): Promise<ApiKey>;
+    rotateKey(apiKey: string): Promise<ApiKey>;
+    private getKeysFilterEndpoint;
+}
+
+interface ProjectsInterface {
+    getProjects(accountId: string): Promise<Project[]>;
+    getProject(projectId: string): Promise<Project>;
+    deleteProject(projectId: string): Promise<boolean>;
+    createProject(project: CreateProjectInput): Promise<Project>;
+    updateProject(name: string, updateTo: UpdateProjectInput): Promise<Project>;
+}
+
+declare class Projects implements ProjectsInterface {
+    api: ApiRequest;
+    endpoint: string;
+    constructor(apiService: ApiRequest);
+    getProjects(accountId: string): Promise<Project[]>;
+    getProject(projectId: string): Promise<Project>;
+    deleteProject(projectId: string): Promise<boolean>;
+    createProject(project: CreateProjectInput): Promise<Project>;
+    updateProject(projectId: string, project: UpdateProjectInput): Promise<Project>;
+}
+
+interface AccountsInterface {
+    getAccount(accountId: string): Promise<Account>;
+}
+
+declare class Accounts implements AccountsInterface {
+    api: ApiRequest;
+    endpoint: string;
+    constructor(apiService: ApiRequest);
+    getAccount(accountId: string): Promise<Account>;
+}
+
+type Options = {
+    host?: string;
+    retryCount?: number;
+};
+declare class TheAuthAPI {
+    accessKey: string;
+    host: string;
+    timeout: number | string | undefined;
+    api: ApiRequest;
+    apiKeys: ApiKeys;
+    projects: Projects;
+    accounts: Accounts;
+    /**
+     * @param {String} accessKey
+     * @param {Object} [options] (optional)
+     *   @property {String} host (default: 'https://api.segment.io')
+     *   @property {number} retryCount (default: 3)
+     */
+    constructor(accessKey: string, options?: Options);
+    authenticateAPIKey(key: string, callback?: (err: any, data: any) => any): Promise<unknown>;
+}
+
+exports = TheAuthAPI;

package/dist/index.d.mts

@@ -0,0 +1,200 @@
+declare enum HttpMethod {
+    GET = "GET",
+    POST = "POST",
+    DELETE = "DELETE",
+    PATCH = "PATCH",
+    PUT = "PUT"
+}
+
+interface ApiCall {
+    request<T>(method: HttpMethod, endpoint: string, payload?: any): Promise<T>;
+}
+
+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;
+}
+
+type ApiKey = {
+    key: string;
+    name: string;
+    customMetaData: AnyJson;
+    customAccountId: string;
+    customUserId: string;
+    env: Environment;
+    createdAt: Date;
+    updatedAt: Date;
+    isActive: boolean;
+    rateLimitConfigs: RateLimitConfiguration;
+    expiry: Date;
+};
+type RateLimitConfiguration = {
+    rateLimit: number;
+    rateLimitTtl: number;
+};
+type ApiKeyInput = {
+    name: string;
+    projectId?: string;
+    key?: string;
+    customMetaData?: AnyJson;
+    customAccountId?: string;
+    customUserId?: string;
+    rateLimitConfigs?: RateLimitConfiguration;
+    expiry?: Date;
+};
+type ApiKeyFilter = {
+    projectId?: string;
+    name?: string;
+    customAccountId?: string | null;
+    customUserId?: string | null;
+    isActive?: boolean;
+};
+type UpdateApiKeyInput = {
+    name: string;
+    key?: string;
+    customMetaData?: AnyJson;
+    customAccountId?: string;
+    customUserId?: string;
+    expiry?: Date | null;
+    rateLimitConfigs?: RateLimitConfiguration | null;
+};
+declare enum AuthedEntityType {
+    USER = "USER",
+    ACCESS_KEY = "ACCESS_KEY"
+}
+type AuthBaseEntity = {
+    isActive: boolean;
+    createdBy: string;
+    createdByType?: AuthedEntityType;
+    createdIn: string;
+    lastChangedBy: string;
+    lastChangedByType?: AuthedEntityType;
+    updatedAt: Date;
+    createdAt: Date;
+};
+type Project = AuthBaseEntity & {
+    id: string;
+    name: string;
+    accountId: string;
+    env: Environment;
+};
+declare enum Environment {
+    LIVE = "live",
+    TEST = "test"
+}
+type CreateProjectInput = {
+    name: string;
+    accountId: string;
+    env: Environment;
+};
+type UpdateProjectInput = {
+    name: string;
+};
+type Account = AuthBaseEntity & {
+    id: string;
+    name: string;
+};
+type AnyJson = boolean | number | string | null | JsonArray | JsonMap;
+type JsonMap = {
+    [key: string]: AnyJson;
+};
+type JsonArray = Array<AnyJson>;
+
+interface ApiKeysInterface {
+    isValidKey(apiKey: string): Promise<boolean>;
+    getKey(apiKey: string): Promise<ApiKey>;
+    authenticateKey(apiKey: string): Promise<ApiKey>;
+    getKeys(filter?: ApiKeyFilter): Promise<ApiKey[]>;
+    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>;
+}
+
+declare class ApiKeys implements ApiKeysInterface {
+    api: ApiRequest;
+    private readonly endpoint;
+    constructor(apiService: ApiRequest);
+    isValidKey(apikey: string): Promise<boolean>;
+    authenticateKey(apikey: string): Promise<ApiKey>;
+    getKeys(filter?: ApiKeyFilter): Promise<ApiKey[]>;
+    getKey(apikey: string): Promise<ApiKey>;
+    createKey(apiKey: ApiKeyInput): Promise<ApiKey>;
+    updateKey(apiKey: string, updatedKey: UpdateApiKeyInput): Promise<ApiKey>;
+    deleteKey(apiKey: string): Promise<boolean>;
+    reactivateKey(apiKey: string): Promise<ApiKey>;
+    rotateKey(apiKey: string): Promise<ApiKey>;
+    private getKeysFilterEndpoint;
+}
+
+interface ProjectsInterface {
+    getProjects(accountId: string): Promise<Project[]>;
+    getProject(projectId: string): Promise<Project>;
+    deleteProject(projectId: string): Promise<boolean>;
+    createProject(project: CreateProjectInput): Promise<Project>;
+    updateProject(name: string, updateTo: UpdateProjectInput): Promise<Project>;
+}
+
+declare class Projects implements ProjectsInterface {
+    api: ApiRequest;
+    endpoint: string;
+    constructor(apiService: ApiRequest);
+    getProjects(accountId: string): Promise<Project[]>;
+    getProject(projectId: string): Promise<Project>;
+    deleteProject(projectId: string): Promise<boolean>;
+    createProject(project: CreateProjectInput): Promise<Project>;
+    updateProject(projectId: string, project: UpdateProjectInput): Promise<Project>;
+}
+
+interface AccountsInterface {
+    getAccount(accountId: string): Promise<Account>;
+}
+
+declare class Accounts implements AccountsInterface {
+    api: ApiRequest;
+    endpoint: string;
+    constructor(apiService: ApiRequest);
+    getAccount(accountId: string): Promise<Account>;
+}
+
+type Options = {
+    host?: string;
+    retryCount?: number;
+};
+declare class TheAuthAPI {
+    accessKey: string;
+    host: string;
+    timeout: number | string | undefined;
+    api: ApiRequest;
+    apiKeys: ApiKeys;
+    projects: Projects;
+    accounts: Accounts;
+    /**
+     * @param {String} accessKey
+     * @param {Object} [options] (optional)
+     *   @property {String} host (default: 'https://api.segment.io')
+     *   @property {number} retryCount (default: 3)
+     */
+    constructor(accessKey: string, options?: Options);
+    authenticateAPIKey(key: string, callback?: (err: any, data: any) => any): Promise<unknown>;
+}
+
+export { TheAuthAPI as default };