✨ Support API key metadata

package.json

@@ -1,6 +1,6 @@
 {
   "name": "staart-manager",
-  "version": "1.0.76",
+  "version": "1.0.77",
   "main": "index.js",
   "repository": "[email protected]:AnandChowdhary/staart.git",
   "author": "Anand Chowdhary <[email protected]>",

schema.sql

@@ -11,7 +11,7 @@
  Target Server Version : 100221
  File Encoding         : 65001
 
- Date: 18/07/2019 10:08:21
+ Date: 18/07/2019 11:18:22
 */
 
 SET NAMES utf8mb4;
@@ -22,7 +22,9 @@ SET FOREIGN_KEY_CHECKS = 0;
 -- ----------------------------
 DROP TABLE IF EXISTS `staart-api-keys`;
 CREATE TABLE `staart-api-keys` (
-  `id` int(11) NOT NULL,
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `name` varchar(255) COLLATE utf8mb4_bin DEFAULT NULL,
+  `description` text COLLATE utf8mb4_bin DEFAULT NULL,
   `jwtApiKey` text COLLATE utf8mb4_bin NOT NULL,
   `organizationId` int(12) NOT NULL,
   `ipRestrictions` text COLLATE utf8mb4_bin DEFAULT NULL,

setup/internal/staart-version

@@ -1 +1 @@
-1.0.76
+1.0.77

src/controllers/organization.ts

@@ -534,20 +534,24 @@ export class OrganizationController {
   }
 
   @Put(":id/api-keys")
+  @Middleware(
+    validator(
+      {
+        scopes: Joi.string(),
+        ipRestrictions: Joi.string(),
+        referrerRestrictions: Joi.string(),
+        name: Joi.string(),
+        description: Joi.string()
+      },
+      "body"
+    )
+  )
   async putUserApiKeys(req: Request, res: Response) {
     const id = await organizationUsernameToId(req.params.id);
     joiValidate(
       { id: [Joi.string().required(), Joi.number().required()] },
       { id }
     );
-    joiValidate(
-      {
-        scopes: Joi.string().allow(null),
-        ipRestrictions: Joi.string().allow(null),
-        referrerRestrictions: Joi.string().allow(null)
-      },
-      req.body
-    );
     res
       .status(CREATED)
       .json(
@@ -577,6 +581,18 @@ export class OrganizationController {
   }
 
   @Patch(":id/api-keys/:apiKeyId")
+  @Middleware(
+    validator(
+      {
+        scopes: Joi.string().allow(""),
+        ipRestrictions: Joi.string().allow(""),
+        referrerRestrictions: Joi.string().allow(""),
+        name: Joi.string().allow(""),
+        description: Joi.string().allow("")
+      },
+      "body"
+    )
+  )
   async patchUserApiKey(req: Request, res: Response) {
     const id = await organizationUsernameToId(req.params.id);
     const apiKeyId = req.params.apiKeyId;
@@ -587,14 +603,6 @@ export class OrganizationController {
       },
       { id, apiKeyId }
     );
-    joiValidate(
-      {
-        scopes: Joi.string().allow(null),
-        ipRestrictions: Joi.string().allow(null),
-        referrerRestrictions: Joi.string().allow(null)
-      },
-      req.body
-    );
     res.json(
       await updateApiKeyForUser(
         localsToTokenOrKey(res),

src/helpers/jwt.ts

@@ -99,6 +99,8 @@ export const apiKeyToken = (apiKey: ApiKey) => {
   const createApiKey = { ...apiKey };
   delete createApiKey.createdAt;
   delete createApiKey.updatedAt;
+  delete createApiKey.name;
+  delete createApiKey.description;
   delete createApiKey.expiresAt;
   return generateToken(
     createApiKey,

src/interfaces/tables/organization.ts

@@ -12,6 +12,8 @@ export interface Organization {
 
 export interface ApiKey {
   id?: number;
+  name?: string;
+  description?: string;
   jwtApiKey?: string;
   scopes?: string;
   organizationId: number;