theauthapi 1.0.9 → 1.0.10

package/README.md

@@ -31,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).
 
@@ -139,6 +139,8 @@ 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
@@ -328,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

@@ -6,6 +6,7 @@ declare class ApiKeys implements ApiKeysInterface {
     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>;

package/dist/endpoints/ApiKeys/ApiKeys.js

@@ -25,7 +25,7 @@ class ApiKeys {
         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) {
@@ -36,6 +36,12 @@ 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}`);
+        });
+    }
     getKeys(filter) {
         return __awaiter(this, void 0, void 0, function* () {
             const endpoint = this.getKeysFilterEndpoint(filter);

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

@@ -2,6 +2,7 @@ import { ApiKey, ApiKeyFilter, ApiKeyInput, UpdateApiKeyInput } from "../../type
 export 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>;

package/dist/libraryMeta.d.ts

@@ -1 +1 @@
-export declare const version = "1.0.9";
+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.9";
+exports.version = "1.0.10";

package/package.json

@@ -1,17 +1,19 @@
 {
   "name": "theauthapi",
-  "version": "1.0.9",
+  "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"
   }
 }