theauthapi 1.0.7 → 1.0.10

package/README.md

@@ -6,10 +6,11 @@
   - [Installation](#installation)
   - [Configuration](#configuration)
   - [Usage](#usage)
-    - [Example: Validating an api-key](#example-validating-an-api-key)
+    - [Example: Validating an API-Key](#example-validating-an-api-key)
+    - [Example: Listing API-Keys](#example-listing-api-keys)
     - [Example: Listing the projects of an account](#example-listing-the-projects-of-an-account)
-    - [Example: Listing projects and associated API Keys](#example-listing-projects-and-associated-api-keys)
-    - [Example: Creating an API Key](#example-creating-an-api-key)
+    - [Example: Listing projects and associated API-Keys](#example-listing-projects-and-associated-api-keys)
+    - [Example: Creating an API-Key](#example-creating-an-api-key)
     - [Handling Errors](#handling-errors)
     - [Typescript](#typescript)
     - [📙 Further Reading](#-further-reading)
@@ -30,7 +31,7 @@ yarn add theauthapi
 
 ## Configuration
 
-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) dashboard.
+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).
 
@@ -99,11 +100,11 @@ All methods return a promise containing the returned JSON as a javascript object
 | HTTP Method | method name | example                                                                   |
 | ----------- | ----------- | ------------------------------------------------------------------------- |
 | POST        | create\*    | `client.apiKeys.createKey({ name: "KEY_NAME", projectId: "PROJECT_ID" })` |
-| GET         | get\*       | `client.apiKeys.getKeys("PROJECT_ID")`                                    |
+| GET         | get\*       | `client.apiKeys.getKeys()`                                                |
 | DELETE      | delete\*    | `client.apiKeys.deleteKey("MY_KEY")`                                      |
 | PATCH       | update\*    | `client.apiKeys.updateKey("MY_KEY", { name: "UPDATED_KEY_NAME" })`        |
 
-#### Example: Validating an api-key
+#### Example: Validating an API-Key
 
 You can easily validate an API key using `apiKeys.isValidKey` which returns `true` if the key is valid, `false` otherwise.
 `isValidKey` throws an `ApiRequestError` if there's a network issue, it's advised to wrap it in a `try/catch` to handle the potential error
@@ -138,6 +139,55 @@ try {
 }
 ```
 
+**Note:** If you want to consume the API key and get the API key entity in return, you can use `apiKeys.authenticateKey` which returns an ApiKey.
+
+#### Example: Listing API-keys
+
+```javascript
+theAuthAPI.apiKeys
+  .getKeys()
+  .then((keys) => console.log(keys))
+  .catch((error) => console.log(error));
+```
+
+**Using async/await**
+
+```javascript
+try {
+  const keys = await theAuthAPI.apiKeys.getKeys();
+} catch (error) {
+  console.log(error);
+}
+```
+
+**Filtering API Keys**: You can filter the listed API keys by passing an object of type filter as an argument to `getKeys` 
+
+```typescript
+type ApiKeyFilter = {
+  projectId?: string;
+  customAccountId?: string;
+  customUserId?: string;
+  isActive?: boolean;
+};
+```
+
+**Example**: filtering api-keys with a specific `projectId` where the keys are not active
+
+```javascript
+try {
+  const keys = await theAuthAPI.apiKeys.getKeys({
+    projectId: "PROJECT_ID",
+    isActive: false,
+  });
+} catch (error) {
+  console.log(error);
+}
+```
+
+**NOTE** that if your access key is at account level, you need to specify `projectId` when listing the API keys: 
+`getKeys({ projectId: "PROJECT_ID" })`, otherwise if your access key is created at project level, you don't have to specify `projectId`, 
+the access key's `projectId` will be used to get the API-keys (i.e. you'll see only the keys of the project your access key is created against)
+
 #### Example: Listing the projects of an account
 
 ```javascript
@@ -157,7 +207,7 @@ try {
 }
 ```
 
-#### Example: Listing projects and associated API Keys
+#### Example: Listing projects and associated API-Keys
 
 ```javascript
 async function getProjectsWithKeys(accountId: string) {
@@ -174,7 +224,7 @@ async function getProjectsWithKeys(accountId: string) {
 }
 ```
 
-#### Example: Creating an API Key
+#### Example: Creating an API-Key
 
 ```javascript
 theAuthAPI.apiKeys
@@ -280,5 +330,6 @@ async function getProjectsIds(accountId: string): Promise<string[]> {
 
 - Create your account [https://theauthapi.com](https://theauthapi.com)
 - View our [Knowledge Base](https://thatapicompany.notion.site/The-Auth-API-Knowledge-Base-21660cee84e640729714fad43d9ce546) help centre
+- Read our [API docs](https://docs.theauthapi.com)
 - Articles on best Auth practice - [https://theauthapi.com/articles](https://theauthapi.com/articles)
 - Meet the team behind The Auth API - [That API Company](https://thatapicompany.com/)

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

@@ -1,16 +1,20 @@
 import ApiRequest from "../../services/ApiRequest/ApiRequest";
-import { ApiKey, ApiKeyInput, UpdateApiKeyInput } from "../../types";
+import { ApiKey, ApiKeyFilter, ApiKeyInput, UpdateApiKeyInput } from "../../types";
 import { ApiKeysInterface } from "./ApiKeysInterface";
 declare class ApiKeys implements ApiKeysInterface {
     api: ApiRequest;
+    private readonly endpoint;
     constructor(apiService: ApiRequest);
     isValidKey(apikey: string): Promise<boolean>;
-    getKeys(projectId: string): Promise<ApiKey[]>;
+    authenticateKey(apikey: string): Promise<ApiKey>;
+    getKeys(filter?: ApiKeyFilter): Promise<ApiKey[]>;
     getKey(apikey: string): Promise<ApiKey>;
     createKey(apiKey: ApiKeyInput): Promise<ApiKey>;
-    updateKey(apiKey: string, updateTo: UpdateApiKeyInput): Promise<ApiKey>;
+    updateKey(apiKey: string, updatedKey: UpdateApiKeyInput): Promise<ApiKey>;
     deleteKey(apiKey: string): Promise<boolean>;
     private validateCreateKeyInput;
     private validateUpdateKeyInput;
+    private validateFiltersInput;
+    private getKeysFilterEndpoint;
 }
 export default ApiKeys;

package/dist/endpoints/ApiKeys/ApiKeys.js

@@ -19,12 +19,13 @@ const ApiResponseError_1 = __importDefault(require("../../services/ApiRequest/Ap
 class ApiKeys {
     constructor(apiService) {
         this.api = apiService;
+        this.endpoint = "/api-keys/";
     }
     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/${apikey}`);
+                const key = yield this.api.request(HttpMethod_1.HttpMethod.GET, `/api-keys/auth/${apikey}`);
                 return key.key !== undefined;
             }
             catch (error) {
@@ -35,10 +36,16 @@ class ApiKeys {
             }
         });
     }
-    getKeys(projectId) {
+    authenticateKey(apikey) {
         return __awaiter(this, void 0, void 0, function* () {
-            (0, util_1.validateString)("projectId", projectId);
-            return yield this.api.request(HttpMethod_1.HttpMethod.GET, `/api-keys/?projectId=${projectId}`);
+            (0, util_1.validateString)("apikey", apikey);
+            return yield this.api.request(HttpMethod_1.HttpMethod.GET, `/api-keys/auth/${apikey}`);
+        });
+    }
+    getKeys(filter) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = this.getKeysFilterEndpoint(filter);
+            return yield this.api.request(HttpMethod_1.HttpMethod.GET, endpoint);
         });
     }
     getKey(apikey) {
@@ -53,10 +60,10 @@ class ApiKeys {
             return yield this.api.request(HttpMethod_1.HttpMethod.POST, "/api-keys", apiKey);
         });
     }
-    updateKey(apiKey, updateTo) {
+    updateKey(apiKey, updatedKey) {
         return __awaiter(this, void 0, void 0, function* () {
-            this.validateUpdateKeyInput(apiKey, updateTo);
-            return yield this.api.request(HttpMethod_1.HttpMethod.PATCH, `/api-keys/${apiKey}`, updateTo);
+            this.validateUpdateKeyInput(apiKey, updatedKey);
+            return yield this.api.request(HttpMethod_1.HttpMethod.PATCH, `/api-keys/${apiKey}`, updatedKey);
         });
     }
     deleteKey(apiKey) {
@@ -69,8 +76,8 @@ class ApiKeys {
         if (!apiKey) {
             throw new TypeError("apiKey must be an object");
         }
-        if (!apiKey.name || !apiKey.projectId) {
-            throw TypeError("apiKey object must contain the properties [name, projectId]");
+        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"]))) {
@@ -87,5 +94,23 @@ class ApiKeys {
         (0, util_1.validateString)("apiKey", apiKey);
         (0, util_1.validateString)("name", updatedKey.name);
     }
+    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);
+            });
+        }
+    }
+    getKeysFilterEndpoint(filter) {
+        this.validateFiltersInput(filter);
+        let filters = [];
+        if (filter) {
+            filters = Object.entries(filter).map(([key, value]) => `${key}=${value}`);
+        }
+        return `${this.endpoint}${filter ? "?" : ""}${filters.join("&")}`;
+    }
 }
 exports.default = ApiKeys;

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

@@ -1,8 +1,9 @@
-import { ApiKey, ApiKeyInput, UpdateApiKeyInput } from "../../types";
+import { ApiKey, ApiKeyFilter, ApiKeyInput, UpdateApiKeyInput } from "../../types";
 export interface ApiKeysInterface {
     isValidKey(apiKey: string): Promise<boolean>;
     getKey(apiKey: string): Promise<ApiKey>;
-    getKeys(projectId: 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>;

package/dist/libraryMeta.d.ts

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

package/dist/libraryMeta.js

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

package/dist/types/index.d.ts

@@ -1,26 +1,34 @@
 export declare type ApiKey = {
     key: string;
     name: string;
-    customMetaData: string;
+    customMetaData: object;
     customAccountId: string;
-    env: string;
+    customUserId: string;
+    env: Environment;
     createdAt: Date;
     updatedAt: Date;
+    isActive: boolean;
 };
 export declare type RateLimitConfiguration = {
     rateLimitedEntity?: string;
-    ratelimitedEnitityId?: any;
+    ratelimitedEnitityId?: string;
     rateLimit: number;
     rateLimitTtl: number;
 };
 export declare type ApiKeyInput = {
     name: string;
-    projectId: string;
+    projectId?: string;
     key?: string;
     customMetaData?: object;
     customAccountId?: string;
+    customUserId?: string;
     rateLimitConfigs?: RateLimitConfiguration;
+};
+export declare type ApiKeyFilter = {
+    projectId?: string;
+    customAccountId?: string;
     customUserId?: string;
+    isActive?: boolean;
 };
 export declare type UpdateApiKeyInput = {
     name: string;
@@ -45,7 +53,7 @@ export declare type Project = AuthBaseEntity & {
     id: string;
     name: string;
     accountId: string;
-    env: string;
+    env: Environment;
 };
 export declare enum Environment {
     LIVE = "live",

package/package.json

@@ -1,17 +1,19 @@
 {
   "name": "theauthapi",
-  "version": "1.0.7",
+  "version": "1.0.10",
   "description": "Client library for TheAuthAPI.com",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
     "dist"
   ],
+  "keywords": [
+    "theauthapi",
+    "authapi"
+  ],
   "scripts": {
     "test": "jest --runInBand",
     "test:coverage": "jest --coverage --runInBand",
-    "np": "np --no-publish",
-    "release": "yarn run np",
     "build": "tsc",
     "prepublish": "npm run build"
   },
@@ -35,8 +37,6 @@
     "remove-trailing-slash": "^0.1.1"
   },
   "devDependencies": {
-    "@size-limit/preset-small-lib": "^7.0.8",
-    "@types/basic-auth": "^1.1.3",
     "@types/express": "^4.17.13",
     "@types/jest": "^27.4.1",
     "@types/lodash.isstring": "^4.0.6",
@@ -51,9 +51,6 @@
     "express": "^4.15.2",
     "jest": "^27.5.1",
     "prettier": "2.6.2",
-    "size-limit": "^4.11.0",
-    "ts-jest": "^27.1.4",
-    "ts-node": "^10.7.0",
     "typescript": "^4.6.3"
   }
 }