@tomei/sso 0.39.6 → 0.40.0

package/migrations/20240528063108-create-api-key-table.js

@@ -49,11 +49,11 @@ module.exports = {
           onDelete: 'CASCADE',
           onUpdate: 'CASCADE',
         },
-        InvokedAt: {
+        RevokedAt: {
           allowNull: true,
           type: Sequelize.DATE,
         },
-        InvokedById: {
+        RevokedById: {
           type: Sequelize.INTEGER,
           allowNull: true,
           references: {
@@ -63,13 +63,10 @@ module.exports = {
           onDelete: 'CASCADE',
           onUpdate: 'CASCADE',
         },
-      },
-      {
-        uniqueKeys: {
-          IDX_ApiKey: {
-            customIndex: true,
-            fields: ['APIKey'],
-          },
+        RevokedReason: {
+          type: Sequelize.TEXT,
+          defaultValue: 'Active',
+          allowNull: true,
         },
       },
     );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomei/sso",
-  "version": "0.39.6",
+  "version": "0.40.0",
   "description": "Tomei SSO Package",
   "main": "dist/index.js",
   "scripts": {

package/src/components/api-key/api-key.ts

@@ -4,8 +4,9 @@ import { APIKeyRepository } from './api-key.repository';
 import { IAPIKeyAttr } from '../../interfaces/api-key-attr.interface';
 import { LoginUser } from '../login-user/login-user';
 import { ApplicationConfig } from '@tomei/config';
-import { randomUUID, randomBytes } from 'crypto';
+import { randomBytes } from 'crypto';
 import { ActionEnum, Activity } from '@tomei/activity-history';
+import { Op } from 'sequelize';
 
 export class APIKey extends ObjectBase {
   ObjectId: string;
@@ -18,8 +19,9 @@ export class APIKey extends ObjectBase {
   Description: string;
   Status: APIKeyStatusEnum;
   ExpirationDate: Date;
-  _InvokedById: number;
-  _InvokedAt: Date;
+  RevokedReason: string;
+  _RevokedById: number;
+  _RevokedAt: Date;
   _CreatedAt: Date;
   _CreatedById: number;
 
@@ -31,12 +33,12 @@ export class APIKey extends ObjectBase {
     this.ObjectId = value.toString();
   }
 
-  get InvokedById(): number {
-    return this._InvokedById;
+  get RevokedById(): number {
+    return this._RevokedById;
   }
 
-  get InvokedAt(): Date {
-    return this._InvokedAt;
+  get RevokedAt(): Date {
+    return this._RevokedAt;
   }
 
   get CreatedAt(): Date {
@@ -58,8 +60,8 @@ export class APIKey extends ObjectBase {
       this.Description = apiKeyAttr.Description;
       this.Status = apiKeyAttr.Status;
       this.ExpirationDate = apiKeyAttr.ExpirationDate;
-      this._InvokedById = apiKeyAttr.InvokedById;
-      this._InvokedAt = apiKeyAttr.InvokedAt;
+      this._RevokedById = apiKeyAttr.RevokedById;
+      this._RevokedAt = apiKeyAttr.RevokedAt;
       this._CreatedAt = apiKeyAttr.CreatedAt;
       this._CreatedById = apiKeyAttr.CreatedById;
     }
@@ -135,8 +137,9 @@ export class APIKey extends ObjectBase {
         ExpirationDate: this.ExpirationDate,
         CreatedAt: this.CreatedAt,
         CreatedById: this.CreatedById,
-        InvokedAt: this.InvokedAt,
-        InvokedById: this.InvokedById,
+        RevokedAt: this.RevokedAt,
+        RevokedById: this.RevokedById,
+        RevokedReason: this.RevokedReason,
       };
 
       const data = await APIKey._Repo.create(EntityValueAfter, {
@@ -186,8 +189,136 @@ export class APIKey extends ObjectBase {
         ExpirationDate: this.ExpirationDate,
         CreatedAt: this.CreatedAt,
         CreatedById: this.CreatedById,
-        InvokedAt: this.InvokedAt,
-        InvokedById: this.InvokedById,
+        RevokedAt: this.RevokedAt,
+        RevokedById: this.RevokedById,
+        RevokedReason: this.RevokedReason,
+      };
+    } catch (error) {
+      throw error;
+    }
+  }
+
+  async findAll(
+    pagination: { page: number; limit: number },
+    loginUser: LoginUser,
+    dbTransaction: any,
+    whereOptions: {
+      Status?: APIKeyStatusEnum;
+      ExpirationDate?: {
+        FromDate: Date;
+        ToDate: Date;
+      };
+      CreatedById?: number;
+    },
+    sortOptions?: {
+      SortBy: string;
+      SortOrder: 'ASC' | 'DESC';
+    },
+  ) {
+    try {
+      // Part 1: Privilege Checking
+      // Call the loginUser.checkPrivileges() method by passing:
+      // SystemCode: Retrieved from the application configuration.
+      // PrivilegeCode: 'API_KEY_VIEW'.
+      // Ensure the user has the necessary privileges to view API keys.
+      const systemCode =
+        ApplicationConfig.getComponentConfigValue('system-code');
+      const isPrivileged = await loginUser.checkPrivileges(
+        systemCode,
+        'API_KEY_VIEW',
+      );
+
+      if (!isPrivileged) {
+        throw new ClassError(
+          'APIKey',
+          'APIKeyErrMsgO2',
+          'User does not have privilege to generate API key.',
+          'generate',
+        );
+      }
+
+      // Part 2: Prepare Filters
+      // Ensure that whereOptions includes the necessary filters such as:
+      // Status: Filter for specific API key statuses (e.g., "Active", "Revoked").
+      // ExpirationDate: Filter for expiration date ranges (e.g., { [Op.between]: [fromDate, toDate] }).
+      // CreatedById: Filter by the user who created the API key.
+      const where = {};
+      if (whereOptions) {
+        if (whereOptions.Status) {
+          where['Status'] = whereOptions.Status;
+        }
+        if (whereOptions.ExpirationDate) {
+          where['ExpirationDate'] = {
+            [Op.between]: [
+              whereOptions.ExpirationDate.FromDate,
+              whereOptions.ExpirationDate.ToDate,
+            ],
+          };
+        }
+        if (whereOptions.CreatedById) {
+          where['CreatedById'] = whereOptions.CreatedById;
+        }
+      }
+
+      const order = [];
+      if (sortOptions) {
+        // Sort the results based on the provided SortBy and SortOrder.
+        // Ensure that the SortBy field is valid and that the SortOrder is either "ASC" or "DESC".
+        if (sortOptions.SortBy) {
+          order.push([sortOptions.SortBy, sortOptions.SortOrder]);
+        }
+      } else {
+        order.push(['CreatedAt', 'DESC']);
+      }
+
+      let offset = 0;
+      if (pagination) {
+        offset = (pagination.page - 1) * pagination.limit;
+      }
+
+      // Ensure that the pagination object includes the page and limit values.
+      // Use Sequelize's findAll() method with the provided whereOptions, sortOptions, and pagination to retrieve matching API keys.
+      const data = await APIKey._Repo.findAllWithPagination({
+        where,
+        order,
+        offset,
+        limit: pagination.limit,
+      });
+
+      // Return the list of API keys including:
+      // ApiKeyId
+      // ApiKey
+      // Name
+      // Status
+      // ExpirationDate
+      // CreatedAt
+      // CreatedById
+      // RevokedAt
+      // RevokedById
+      // RevokedReason
+      // Include pagination information such as:
+      // total: Total number of records,
+      // page: Current page,
+      // limit: Number of records per page.
+
+      return {
+        total: data.count,
+        ApiKeys: data.rows.map((row) => {
+          return {
+            ApiKeyId: row.APIKeyId,
+            ApiKey: row.ApiKey,
+            Name: row.Name,
+            Status: row.Status,
+            ExpirationDate: row.ExpirationDate,
+            CreatedAt: row.CreatedAt,
+            CreatedById: row.CreatedById,
+            RevokedAt: row.RevokedAt,
+            RevokedById: row.RevokedById,
+            RevokedReason: row.RevokedReason,
+          };
+        }),
+        page: pagination.page,
+        limit: pagination.limit,
       };
     } catch (error) {
       throw error;

package/src/enum/api-key.enum.ts

@@ -1,5 +1,5 @@
 export enum APIKeyStatusEnum {
   ACTIVE = 'Active',
-  INACTIVE = 'Inactive',
+  REVOKED = 'Revoked',
   EXPIRED = 'Expired',
 }

package/src/interfaces/api-key-attr.interface.ts

@@ -8,7 +8,8 @@ export interface IAPIKeyAttr {
   Status: APIKeyStatusEnum;
   ExpirationDate: Date;
   CreatedById: number;
-  InvokedById: number;
+  RevokedById: number;
   CreatedAt: Date;
-  InvokedAt: Date;
+  RevokedAt: Date;
+  RevokedReason: string;
 }

package/src/models/api-key-entity.ts

@@ -29,7 +29,6 @@ export default class APIKeyModel extends Model {
   @Column({
     type: DataType.STRING(128),
   })
-  @Index('IDX_ApiKey')
   ApiKey: string;
 
   @Column({
@@ -60,15 +59,13 @@ export default class APIKeyModel extends Model {
   @Column({
     type: DataType.INTEGER,
   })
-  @Index('IDX_CreatedById')
   CreatedById: number;
 
   @ForeignKey(() => User)
   @Column({
     type: DataType.INTEGER,
   })
-  @Index('IDX_InvokedById')
-  InvokedById: number;
+  RevokedById: number;
 
   @CreatedAt
   CreatedAt: Date;
@@ -77,7 +74,13 @@ export default class APIKeyModel extends Model {
     type: DataType.DATE,
     allowNull: true,
   })
-  InvokedAt: Date;
+  RevokedAt: Date;
+
+  @Column({
+    type: DataType.TEXT,
+    allowNull: true,
+  })
+  RevokedReason: string;
 
   @BelongsTo(() => User, 'CreatedById')
   CreatedByUser: User;