theauthapi 1.0.4 → 1.0.7

package/src/index.ts

@@ -1,103 +0,0 @@
-import assert from "assert";
-import removeSlash from "remove-trailing-slash";
-
-import ApiRequest from "./services/ApiRequest/ApiRequest";
-import { validateString } from "./util";
-import ApiKeys from "./endpoints/ApiKeys/ApiKeys";
-import { HttpMethod } from "./services/ApiRequest/HttpMethod";
-import Projects from "./endpoints/Projects/Projects";
-
-// eslint-disable-next-line @typescript-eslint/no-empty-function
-const noop = () => {};
-
-type Options = {
-  host?: string;
-  timeout?: string | number;
-  cacheTTL?: number;
-  enable?: boolean;
-  retryCount?: number;
-};
-
-class TheAuthAPI {
-  queue: [];
-  accessKey: string;
-  host: string;
-  timeout: number | string | undefined;
-  cacheTTL: number;
-  api: ApiRequest;
-  apiKeys: ApiKeys;
-  projects: Projects;
-
-  /**
-   * 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: string, options?: Options) {
-    assert(accessKey, "You must pass your project's write key.");
-    this.queue = [];
-    this.accessKey = accessKey;
-    this.host = removeSlash(options?.host || "https://api.theauthapi.com");
-    this.timeout = options?.timeout;
-    this.cacheTTL = options?.cacheTTL ?? 60;
-    this.api = new ApiRequest({
-      accessKey: this.accessKey,
-      host: this.host,
-    });
-    this.apiKeys = new ApiKeys(this.api);
-    this.projects = new Projects(this.api);
-
-    Object.defineProperty(this, "enable", {
-      configurable: false,
-      writable: false,
-      enumerable: true,
-      value: typeof options?.enable === "boolean" ? options.enable : true,
-    });
-  }
-
-  /*
-    @deprecated
-   */
-  async authenticateAPIKey(
-    key: string,
-    callback?: (err: any, data: any) => any
-  ) {
-    validateString("key", key);
-
-    const cb = callback || noop;
-    const done = (err: any) => {
-      cb(err, data);
-    };
-
-    const data = {
-      credentials: { api_key: key },
-      timestamp: new Date().getTime(),
-      sentAt: new Date().getTime(),
-    };
-
-    try {
-      const key = await this.api.request(
-        HttpMethod.POST,
-        "/auth/authenticate",
-        data
-      );
-      done(key);
-      return key;
-    } catch (err: any) {
-      if (err.response) {
-        const error = new Error(err.response.statusText);
-        return done(error);
-      }
-      done(err);
-    }
-  }
-}
-
-export default TheAuthAPI;

package/src/libraryMeta.ts

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

package/src/services/ApiRequest/ApiCall.ts

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

package/src/services/ApiRequest/ApiRequest.ts

@@ -1,132 +0,0 @@
-import axios from "axios";
-import { version } from "../../libraryMeta";
-import { HttpMethod } from "./HttpMethod";
-import ApiCall from "./ApiCall";
-import ApiRequestError from "./ApiRequestError";
-import axiosRetry from "axios-retry";
-import ms from "ms";
-
-type Config = {
-  host: string;
-  accessKey: string;
-  headers?: object;
-  retryCount?: number;
-  timeout?: number | string;
-};
-
-class ApiRequest implements ApiCall {
-  host: string;
-  headers: object;
-  accessKey: string;
-  timeout: number;
-  retryCount: number;
-
-  constructor(config: Config) {
-    const { host, accessKey, headers, retryCount, timeout } = config;
-    this.host = host;
-    this.accessKey = accessKey;
-    this.headers = this._generateDefaultHeaders();
-    this.timeout = timeout ? (typeof timeout === "string" ? ms(timeout) : timeout) : 0;
-    this.retryCount = retryCount ?? 3;
-
-    if (headers) {
-      this.headers = { ...this.headers, headers };
-    }
-
-    this._init();
-  }
-
-  _init() {
-    const isoDateFormat = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d*)?(?:[-+]\d{2}:?\d{2}|Z)?$/
-    function isIsoDateString(value: any): boolean {
-      return value && typeof value === "string" && isoDateFormat.test(value);
-    }
-    function handleDates(body: any) {
-      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.interceptors.response.use((response) => {
-      handleDates(response.data);
-      return response;
-    });
-
-    axiosRetry(axios, {
-      retries: this.retryCount ?? 3,
-      retryCondition: this._isErrorRetryable,
-      retryDelay: axiosRetry.exponentialDelay,
-    });
-  }
-
-  async request<T>(
-    method: HttpMethod,
-    endpoint: string,
-    payload?: any
-  ): Promise<T> {
-    try {
-      const response = await axios.request<T>({
-        baseURL: this.host,
-        method: method,
-        url: endpoint,
-        data: payload,
-        headers: this.headers,
-      });
-      return response.data;
-    } catch (error) {
-      if (axios.isAxiosError(error)) {
-        if (error.response) {
-          throw new ApiRequestError(
-            error.response.status,
-            error.response.data.message ?? error.response.statusText
-          );
-        } else if (error.request) {
-          throw new Error(error.request);
-        }
-      }
-      throw error;
-    }
-  }
-
-  _generateDefaultHeaders() {
-    return {
-      "user-agent": `theauthapi-client-node/${version}`,
-      "x-api-key": this.accessKey,
-      "api-key": this.accessKey,
-    };
-  }
-
-  _isErrorRetryable(error: any) {
-    // Retry Network Errors.
-    if (axiosRetry.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;
-  }
-}
-
-export default ApiRequest;

package/src/services/ApiRequest/ApiRequestError.ts

@@ -1,7 +0,0 @@
-class ApiRequestError extends Error {
-  constructor(statusCode: number, message: string) {
-    super(`(${statusCode}): ${message}`);
-  }
-}
-
-export = ApiRequestError;

package/src/services/ApiRequest/HttpMethod.ts

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

package/src/tests/endpoints/apiKeys.spec.ts

@@ -1,102 +0,0 @@
-import TheAuthAPI from "../../index";
-import testServer from "../testServer/server";
-import { Server } from "http";
-
-const port = 4063;
-
-const createClient = (options?: any) => {
-  options = Object.assign(
-    {
-      host: `http://localhost:${port}`,
-    },
-    options
-  );
-  return new TheAuthAPI("access_key", options);
-};
-
-describe("ApiKeys", () => {
-  let server: Server;
-  beforeAll(() => {
-    server = testServer.listen(port);
-  });
-
-  afterAll(() => {
-    server.close();
-  });
-
-  it("should authenticate a valid api-key", async () => {
-    const client = createClient();
-    const data = await client.apiKeys.authenticateKey(
-      "live_access_zBA6cvuEbJEUhhDIWwuErXHLnwvWqtcqe2ajfV3RVVZvD6lc6xDUaSsSZL1fk53a"
-    );
-    console.log('day', data.createdAt.getDate(), 'month', data.createdAt.getMonth())
-    expect(data.name).toEqual("My customers first Api Key");
-    expect(data.key).toEqual(
-      "KGTSsxbDndjRRcpJGuQQp2or9UmQkqRrVQpCWgQruIXnvnNatmfdmOTcsgYnNwnH"
-    );
-    expect(data.createdAt).toEqual(new Date("2022-03-16T10:34:23.353Z"));
-    expect(data.updatedAt).toEqual(new Date("2022-03-16T10:34:23.353Z"));
-    expect(data.env).toEqual("live");
-    expect(data.customAccountId).toEqual("acc-id");
-  });
-
-  it("should list api keys", async () => {
-    const client = createClient();
-    const keys = await client.apiKeys.getKeys("project_1");
-    expect(keys).toEqual(
-      expect.arrayContaining([
-        expect.objectContaining({
-          key: "live_h3uDZInxQexGLkwoxMDmuqz6PsyXGjkbrmSTpEwFb8l97mdAlQKtt14kt9Rv91PL",
-          name: "my-first-api-key",
-          customMetaData: {},
-          customAccountId: null,
-          env: "live",
-        }),
-        expect.objectContaining({
-          key: "live_1OvRrfHbPdiCUrFAD4VwxiqEgg8L5uiVDlIgE4075juY7TnimZQG1Ll770irHyfM",
-          name: "my-second-api-key",
-          customMetaData: {},
-          customAccountId: null,
-          env: "live",
-        }),
-      ])
-    );
-  });
-
-  it("should create a key", async () => {
-    const client = createClient();
-    const key = await client.apiKeys.createKey({
-      name: "my-new-api-key1",
-      projectId: "b52262b5-eaa6-4edd-825c-ebcdf76a10e5",
-    });
-    expect(key).toEqual(
-      expect.objectContaining({
-        key: "live_1OvRrfHbPdiCUrFAD4VwxiqEgg8L5uiVDlIgE4075juY7TnimZQG1Ll770irHyfM",
-        name: "my-new-api-key1",
-        env: "live",
-      })
-    );
-  });
-
-  it("should update a key", async () => {
-    const client = createClient();
-    const key = await client.apiKeys.updateKey(
-      "live_TVHW0PVtktylIVObMd8J0sBHb7Ym3ZraObpeT3qxu7YRHig2KxrEIwggn50sBpSZ",
-      {
-        name: "my-first-update-key",
-      }
-    );
-    expect(key.name).toEqual("my-first-updated-key");
-    expect(key.key).toEqual(
-      "live_TVHW0PVtktylIVObMd8J0sBHb7Ym3ZraObpeT3qxu7YRHig2KxrEIwggn50sBpSZ"
-    );
-  });
-
-  it("should delete a key", async () => {
-    const client = createClient();
-    const response = await client.apiKeys.deleteKey(
-      "live_TVHW0PVtktylIVObMd8J0sBHb7Ym3ZraObpeT3qxu7YRHig2KxrEIwggn50sBpSZ"
-    );
-    expect(response).toBeTruthy();
-  });
-});

package/src/tests/endpoints/projects.spec.ts

@@ -1,105 +0,0 @@
-import TheAuthAPI from "../../index";
-import testServer from "../testServer/server";
-import { Server } from "http";
-
-const port = 4063;
-
-const createClient = (options?: any) => {
-  options = Object.assign(
-    {
-      host: `http://localhost:${port}`,
-    },
-    options
-  );
-  return new TheAuthAPI("access_key", options);
-};
-
-describe("Projects", () => {
-  let server: Server;
-  beforeAll(() => {
-    server = testServer.listen(port);
-  });
-
-  afterAll(() => {
-    server.close();
-  });
-
-  it("should list all projects", async () => {
-    const client = createClient();
-    const projects = await client.projects.getProjects("project-id-1");
-    expect(projects).toEqual(
-      expect.arrayContaining([
-        expect.objectContaining({
-          isActive: true,
-          createdBy: "user-id-1",
-          createdByType: "ACCESS_KEY",
-          updatedAt: new Date("2022-04-05T21:42:58.054Z"),
-          createdAt: new Date("2022-04-05T21:42:58.054Z"),
-          id: "project-id-1",
-          name: "My Auth Project",
-          accountId: "my-account-id",
-          env: "live",
-        }),
-      ])
-    );
-  });
-
-  it("should get a project using a projectId", async () => {
-    const client = createClient();
-    const project = await client.projects.getProject("project-id-2");
-    expect(project).toEqual(
-      expect.objectContaining({
-        isActive: true,
-        updatedAt: new Date("2022-04-02T21:02:14.808Z"),
-        createdAt: new Date("2022-04-02T21:02:14.808Z"),
-        id: "project-id-2",
-        name: "Hulu",
-        accountId: "my-account-id-2",
-        env: "live",
-      })
-    );
-  });
-
-  it("should delete a project", async () => {
-    const client = createClient();
-    const project = await client.projects.deleteProject("my-project-id");
-    expect(project).toBeTruthy();
-  });
-
-  it("should create a project", async () => {
-    const client = createClient();
-    const project = await client.projects.createProject(
-      "project-id-1",
-      "my-account-id"
-    );
-    expect(project).toEqual(
-      expect.objectContaining({
-        isActive: true,
-        updatedAt: new Date("2022-04-05T21:42:58.054Z"),
-        createdAt: new Date("2022-04-05T21:42:58.054Z"),
-        id: "project-id-1",
-        name: "My Auth Project",
-        accountId: "my-account-id",
-        env: "live",
-      })
-    );
-  });
-
-  it("should update a project", async () => {
-    const client = createClient();
-    const project = await client.projects.updateProject("project-id-1", {
-      name: "my-updated-project-1",
-    });
-    expect(project).toEqual(
-      expect.objectContaining({
-        isActive: true,
-        updatedAt: new Date("2022-04-05T21:42:58.054Z"),
-        createdAt: new Date("2022-04-05T21:42:58.054Z"),
-        id: "project-id-1",
-        name: "my-updated-project-1",
-        accountId: "my-account-id",
-        env: "live",
-      })
-    );
-  });
-});

package/src/tests/index.spec.ts

@@ -1,35 +0,0 @@
-import TheAuthAPI from "../index";
-import { Server } from "http";
-import testServer from "./testServer/server";
-
-const port = 4063;
-
-const createClient = (options?: any) => {
-  options = Object.assign(
-    {
-      host: `http://localhost:${port}`,
-    },
-    options
-  );
-  return new TheAuthAPI("access_key", options);
-};
-
-describe("index", () => {
-  let server: Server;
-  beforeAll(() => {
-    server = testServer.listen(port);
-  });
-
-  afterAll(() => {
-    server.close();
-  });
-  it("should authenticate a valid key [legacy]", async () => {
-    const client = createClient();
-    const data: any = await client.authenticateAPIKey(
-      "aaa13d30-135e-11ec-8e0f-f1de8e89"
-    );
-    expect(data.customUserId).toEqual("my-user-id");
-    expect(data.customAccountId).toEqual("acc-id");
-    expect(data.authenticated).toBeTruthy();
-  }, 30000);
-});

package/src/tests/testServer/middleware/middleware.ts

@@ -1,17 +0,0 @@
-import {Request, Response, NextFunction} from "express"
-import {version} from "../../../libraryMeta";
-
-export function headersMiddleware(request: Request, response: Response, next: NextFunction) {
-  const accessKey = request.header("x-api-key");
-  if (!accessKey) {
-    return response.status(400).json({
-      message: "missing access key",
-    });
-  }
-  if (request.header("user-agent") !== `theauthapi-client-node/${version}`) {
-    return response.status(400).json({
-      message: "invalid user-agent",
-    });
-  }
-  next();
-}

package/src/tests/testServer/routes/apiKeys.ts

@@ -1,89 +0,0 @@
-import { Router } from "express";
-
-const router = Router();
-
-export const apiKeyRoutes = router
-  .get("/:key", (request, response) => {
-    const key = request.params.key;
-    if (!key) {
-      return response.status(400).json({
-        message: "missing api-key",
-      });
-    }
-    return response.json({
-      key: "KGTSsxbDndjRRcpJGuQQp2or9UmQkqRrVQpCWgQruIXnvnNatmfdmOTcsgYnNwnH",
-      name: "My customers first Api Key",
-      customMetaData: {},
-      customAccountId: "acc-id",
-      env: "live",
-      createdAt: "2022-03-16T10:34:23.353Z",
-      updatedAt: "2022-03-16T10:34:23.353Z",
-    });
-  })
-  .get("/", (request, response) => {
-    const { projectId } = request.query;
-    if (!projectId) {
-      return response.status(400).json({
-        message: "missing project-id",
-      });
-    }
-    return response.json([
-      {
-        key: "live_h3uDZInxQexGLkwoxMDmuqz6PsyXGjkbrmSTpEwFb8l97mdAlQKtt14kt9Rv91PL",
-        name: "my-first-api-key",
-        customMetaData: {},
-        customAccountId: null,
-        env: "live",
-        createdAt: "2022-04-03T01:59:32.051Z",
-        updatedAt: "2022-04-03T01:59:32.051Z",
-      },
-      {
-        key: "live_1OvRrfHbPdiCUrFAD4VwxiqEgg8L5uiVDlIgE4075juY7TnimZQG1Ll770irHyfM",
-        name: "my-second-api-key",
-        customMetaData: {},
-        customAccountId: null,
-        env: "live",
-        createdAt: "2022-04-03T02:02:09.730Z",
-        updatedAt: "2022-04-03T02:02:09.730Z",
-      },
-    ]);
-  })
-  .post("/", (request, response) => {
-    const { name, projectId } = request.body;
-    if (!name || !projectId) {
-      response.json({
-        message: "malformed apikey: missing name or projectId",
-      });
-    }
-    return response.json({
-      key: "live_1OvRrfHbPdiCUrFAD4VwxiqEgg8L5uiVDlIgE4075juY7TnimZQG1Ll770irHyfM",
-      name: "my-new-api-key1",
-      env: "live",
-      createdAt: "2022-04-02T21:10:39.648Z",
-      updatedAt: "2022-04-02T21:10:39.648Z",
-    });
-  })
-  .patch("/:key", (request, response) => {
-    const { key } = request.params;
-    if (!key) {
-      return response.status(400).json({
-        message: "missing api-key",
-      });
-    }
-    return response.json({
-      key: "live_TVHW0PVtktylIVObMd8J0sBHb7Ym3ZraObpeT3qxu7YRHig2KxrEIwggn50sBpSZ",
-      name: "my-first-updated-key",
-      env: "live",
-      createdAt: "2022-04-02T21:10:39.648Z",
-      updatedAt: "2022-04-02T21:10:39.648Z",
-    });
-  })
-  .delete("/:key", (request, response) => {
-    const { key } = request.params;
-    if (!key) {
-      return response.status(400).json({
-        message: "missing api-key",
-      });
-    }
-    return response.json(true);
-  });

package/src/tests/testServer/routes/auth.ts

@@ -1,24 +0,0 @@
-import { Router } from "express";
-
-const router = Router();
-
-export const authRoutes = router.post("/authenticate", (request, response) => {
-  const { credentials } = request.body;
-  if (!credentials || !credentials.api_key) {
-    return response.json({
-      message: "missing api_key",
-    });
-  }
-  if (credentials.api_key.length !== 32) {
-    return response.json({
-      message: "api_key must have a length of 32",
-    });
-  }
-
-  return response.json({
-    customMetaData: {},
-    customAccountId: "acc-id",
-    customUserId: "my-user-id",
-    authenticated: true,
-  });
-});