nestjs-apikey-module 0.0.1

package/README.md

@@ -0,0 +1 @@
+# nestjs-apikey-module

package/dist/api-key.module.d.ts

@@ -0,0 +1,6 @@
+import { DynamicModule } from "@nestjs/common";
+import { IApiKeyModuleAsyncOptions, IApiKeyModuleOptions } from "./interfaces/api-key.interfaces";
+export declare class ApiKeyModule {
+    static forRoot(options?: IApiKeyModuleOptions): DynamicModule;
+    static forRootAsync(options: IApiKeyModuleAsyncOptions): DynamicModule;
+}

package/dist/api-key.module.js

@@ -0,0 +1,57 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var ApiKeyModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiKeyModule = void 0;
+const common_1 = require("@nestjs/common");
+const typeorm_1 = require("@nestjs/typeorm");
+const schedule_1 = require("@nestjs/schedule");
+const api_key_entity_1 = require("./entities/api-key.entity");
+const api_key_action_entity_1 = require("./entities/api-key-action.entity");
+const api_key_service_1 = require("./services/api-key.service");
+const api_key_expiry_task_1 = require("./tasks/api-key-expiry.task");
+const constants_1 = require("./constants");
+const TYPEORM_FEATURE = typeorm_1.TypeOrmModule.forFeature([
+    api_key_entity_1.ApiKeyEntity,
+    api_key_action_entity_1.ApiKeyActionEntity,
+]);
+let ApiKeyModule = ApiKeyModule_1 = class ApiKeyModule {
+    static forRoot(options = {}) {
+        return {
+            module: ApiKeyModule_1,
+            imports: [TYPEORM_FEATURE, schedule_1.ScheduleModule.forRoot()],
+            providers: [
+                { provide: constants_1.API_KEY_MODULE_OPTIONS, useValue: options },
+                api_key_service_1.ApiKeyService,
+                api_key_expiry_task_1.ApiKeyExpiryTask,
+            ],
+            exports: [api_key_service_1.ApiKeyService],
+        };
+    }
+    static forRootAsync(options) {
+        return {
+            module: ApiKeyModule_1,
+            imports: [...(options.imports ?? []), TYPEORM_FEATURE, schedule_1.ScheduleModule.forRoot()],
+            providers: [
+                {
+                    provide: constants_1.API_KEY_MODULE_OPTIONS,
+                    useFactory: options.useFactory,
+                    inject: options.inject ?? [],
+                },
+                api_key_service_1.ApiKeyService,
+                api_key_expiry_task_1.ApiKeyExpiryTask,
+            ],
+            exports: [api_key_service_1.ApiKeyService],
+        };
+    }
+};
+exports.ApiKeyModule = ApiKeyModule;
+exports.ApiKeyModule = ApiKeyModule = ApiKeyModule_1 = __decorate([
+    (0, common_1.Module)({})
+], ApiKeyModule);
+//# sourceMappingURL=api-key.module.js.map

package/dist/api-key.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-key.module.js","sourceRoot":"","sources":["../libs/nestjs-apikey-module/src/api-key.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAAuD;AACvD,6CAAgD;AAChD,+CAAkD;AAClD,8DAAyD;AACzD,4EAAsE;AACtE,gEAA2D;AAC3D,qEAA+D;AAK/D,2CAAqD;AAErD,MAAM,eAAe,GAAG,uBAAa,CAAC,UAAU,CAAC;IAC/C,6BAAY;IACZ,0CAAkB;CACnB,CAAC,CAAC;AAGI,IAAM,YAAY,oBAAlB,MAAM,YAAY;IAOvB,MAAM,CAAC,OAAO,CAAC,UAAgC,EAAE;QAC/C,OAAO;YACL,MAAM,EAAE,cAAY;YACpB,OAAO,EAAE,CAAC,eAAe,EAAE,yBAAc,CAAC,OAAO,EAAE,CAAC;YACpD,SAAS,EAAE;gBACT,EAAE,OAAO,EAAE,kCAAsB,EAAE,QAAQ,EAAE,OAAO,EAAE;gBACtD,+BAAa;gBACb,sCAAgB;aACjB;YACD,OAAO,EAAE,CAAC,+BAAa,CAAC;SACzB,CAAC;IACJ,CAAC;IAeD,MAAM,CAAC,YAAY,CAAC,OAAkC;QACpD,OAAO;YACL,MAAM,EAAE,cAAY;YACpB,OAAO,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,eAAe,EAAE,yBAAc,CAAC,OAAO,EAAE,CAAC;YAChF,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,kCAAsB;oBAC/B,UAAU,EAAE,OAAO,CAAC,UAAU;oBAC9B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;iBAC7B;gBACD,+BAAa;gBACb,sCAAgB;aACjB;YACD,OAAO,EAAE,CAAC,+BAAa,CAAC;SACzB,CAAC;IACJ,CAAC;CACF,CAAA;AAjDY,oCAAY;uBAAZ,YAAY;IADxB,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,YAAY,CAiDxB"}

package/dist/config/enum.d.ts

@@ -0,0 +1,5 @@
+export declare enum API_KEY_STATUS {
+    ACTIVE = "ACTIVE",
+    REVOKED = "REVOKED",
+    EXPIRED = "EXPIRED"
+}

package/dist/config/enum.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.API_KEY_STATUS = void 0;
+var API_KEY_STATUS;
+(function (API_KEY_STATUS) {
+    API_KEY_STATUS["ACTIVE"] = "ACTIVE";
+    API_KEY_STATUS["REVOKED"] = "REVOKED";
+    API_KEY_STATUS["EXPIRED"] = "EXPIRED";
+})(API_KEY_STATUS || (exports.API_KEY_STATUS = API_KEY_STATUS = {}));
+//# sourceMappingURL=enum.js.map

package/dist/config/enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enum.js","sourceRoot":"","sources":["../../libs/nestjs-apikey-module/src/config/enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,mCAAiB,CAAA;IACjB,qCAAmB,CAAA;IACnB,qCAAmB,CAAA;AACrB,CAAC,EAJW,cAAc,8BAAd,cAAc,QAIzB"}

package/dist/constants/index.d.ts

@@ -0,0 +1,3 @@
+export declare const API_KEY_MODULE_OPTIONS = "API_KEY_MODULE_OPTIONS";
+export declare const API_KEY_ACTIONS_KEY = "api_key_actions";
+export declare const API_KEY_SESSION_KEY = "apiKeySession";

package/dist/constants/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.API_KEY_SESSION_KEY = exports.API_KEY_ACTIONS_KEY = exports.API_KEY_MODULE_OPTIONS = void 0;
+exports.API_KEY_MODULE_OPTIONS = "API_KEY_MODULE_OPTIONS";
+exports.API_KEY_ACTIONS_KEY = "api_key_actions";
+exports.API_KEY_SESSION_KEY = "apiKeySession";
+//# sourceMappingURL=index.js.map

package/dist/constants/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../libs/nestjs-apikey-module/src/constants/index.ts"],"names":[],"mappings":";;;AAAa,QAAA,sBAAsB,GAAG,wBAAwB,CAAC;AAClD,QAAA,mBAAmB,GAAG,iBAAiB,CAAC;AACxC,QAAA,mBAAmB,GAAG,eAAe,CAAC"}

package/dist/decorators/api-key-actions.decorator.d.ts

@@ -0,0 +1,2 @@
+export type ApiKeyActionRule = string | string[];
+export declare const ApiKeyActions: (...rules: ApiKeyActionRule[]) => import("@nestjs/common").CustomDecorator<string>;

package/dist/decorators/api-key-actions.decorator.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiKeyActions = void 0;
+const common_1 = require("@nestjs/common");
+const constants_1 = require("../constants");
+const ApiKeyActions = (...rules) => (0, common_1.SetMetadata)(constants_1.API_KEY_ACTIONS_KEY, rules);
+exports.ApiKeyActions = ApiKeyActions;
+//# sourceMappingURL=api-key-actions.decorator.js.map

package/dist/decorators/api-key-actions.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-key-actions.decorator.js","sourceRoot":"","sources":["../../libs/nestjs-apikey-module/src/decorators/api-key-actions.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAC7C,4CAAmD;AAe5C,MAAM,aAAa,GAAG,CAAC,GAAG,KAAyB,EAAE,EAAE,CAC5D,IAAA,oBAAW,EAAC,+BAAmB,EAAE,KAAK,CAAC,CAAC;AAD7B,QAAA,aAAa,iBACgB"}

package/dist/decorators/api-key-session.decorator.d.ts

@@ -0,0 +1 @@
+export declare const ApiKeySession: (...dataOrPipes: unknown[]) => ParameterDecorator;

package/dist/decorators/api-key-session.decorator.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiKeySession = void 0;
+const common_1 = require("@nestjs/common");
+const constants_1 = require("../constants");
+exports.ApiKeySession = (0, common_1.createParamDecorator)((_data, ctx) => {
+    return ctx.switchToHttp().getRequest()[constants_1.API_KEY_SESSION_KEY] ?? null;
+});
+//# sourceMappingURL=api-key-session.decorator.js.map

package/dist/decorators/api-key-session.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-key-session.decorator.js","sourceRoot":"","sources":["../../libs/nestjs-apikey-module/src/decorators/api-key-session.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAwE;AACxE,4CAAmD;AAStC,QAAA,aAAa,GAAG,IAAA,6BAAoB,EAC/C,CAAC,KAAc,EAAE,GAAqB,EAAE,EAAE;IACxC,OAAO,GAAG,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC,+BAAmB,CAAC,IAAI,IAAI,CAAC;AACtE,CAAC,CACF,CAAC"}

package/dist/entities/api-key-action.entity.d.ts

@@ -0,0 +1,7 @@
+import { ApiKeyEntity } from "./api-key.entity";
+export declare class ApiKeyActionEntity {
+    id: number;
+    actionCode: string;
+    createdAt: Date;
+    apiKey: ApiKeyEntity;
+}

package/dist/entities/api-key-action.entity.js

@@ -0,0 +1,41 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiKeyActionEntity = void 0;
+const typeorm_1 = require("typeorm");
+const api_key_entity_1 = require("./api-key.entity");
+let ApiKeyActionEntity = class ApiKeyActionEntity {
+};
+exports.ApiKeyActionEntity = ApiKeyActionEntity;
+__decorate([
+    (0, typeorm_1.PrimaryGeneratedColumn)(),
+    __metadata("design:type", Number)
+], ApiKeyActionEntity.prototype, "id", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ name: "action_code", length: 100 }),
+    __metadata("design:type", String)
+], ApiKeyActionEntity.prototype, "actionCode", void 0);
+__decorate([
+    (0, typeorm_1.CreateDateColumn)({ name: "created_at" }),
+    __metadata("design:type", Date)
+], ApiKeyActionEntity.prototype, "createdAt", void 0);
+__decorate([
+    (0, typeorm_1.ManyToOne)(() => api_key_entity_1.ApiKeyEntity, (apiKey) => apiKey.actions, {
+        nullable: false,
+        onDelete: "CASCADE",
+    }),
+    (0, typeorm_1.JoinColumn)({ name: "api_key_id" }),
+    __metadata("design:type", api_key_entity_1.ApiKeyEntity)
+], ApiKeyActionEntity.prototype, "apiKey", void 0);
+exports.ApiKeyActionEntity = ApiKeyActionEntity = __decorate([
+    (0, typeorm_1.Entity)("api_key_actions")
+], ApiKeyActionEntity);
+//# sourceMappingURL=api-key-action.entity.js.map

package/dist/entities/api-key-action.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-key-action.entity.js","sourceRoot":"","sources":["../../libs/nestjs-apikey-module/src/entities/api-key-action.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAOiB;AACjB,qDAAgD;AAGzC,IAAM,kBAAkB,GAAxB,MAAM,kBAAkB;CAgB9B,CAAA;AAhBY,gDAAkB;AAE7B;IADC,IAAA,gCAAsB,GAAE;;8CACd;AAGX;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;;sDAC1B;AAGnB;IADC,IAAA,0BAAgB,EAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;8BAC9B,IAAI;qDAAC;AAOhB;IALC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,6BAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,EAAE;QACzD,QAAQ,EAAE,KAAK;QACf,QAAQ,EAAE,SAAS;KACpB,CAAC;IACD,IAAA,oBAAU,EAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;8BAC3B,6BAAY;kDAAC;6BAfV,kBAAkB;IAD9B,IAAA,gBAAM,EAAC,iBAAiB,CAAC;GACb,kBAAkB,CAgB9B"}

package/dist/entities/api-key.entity.d.ts

@@ -0,0 +1,17 @@
+import { API_KEY_STATUS } from "../config/enum";
+import { ApiKeyActionEntity } from "./api-key-action.entity";
+export declare class ApiKeyEntity {
+    id: string;
+    name: string;
+    keyPrefix: string;
+    secretHash: string;
+    secretLast4: string;
+    status: API_KEY_STATUS;
+    expiresAt: Date | null;
+    lastUsedAt: Date | null;
+    lastUsedIp: string | null;
+    createdAt: Date;
+    revokedAt: Date | null;
+    revokeReason: string | null;
+    actions: ApiKeyActionEntity[];
+}

package/dist/entities/api-key.entity.js

@@ -0,0 +1,82 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiKeyEntity = void 0;
+const typeorm_1 = require("typeorm");
+const enum_1 = require("../config/enum");
+const api_key_action_entity_1 = require("./api-key-action.entity");
+let ApiKeyEntity = class ApiKeyEntity {
+};
+exports.ApiKeyEntity = ApiKeyEntity;
+__decorate([
+    (0, typeorm_1.PrimaryGeneratedColumn)("uuid"),
+    __metadata("design:type", String)
+], ApiKeyEntity.prototype, "id", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ name: "name", length: 100 }),
+    __metadata("design:type", String)
+], ApiKeyEntity.prototype, "name", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ name: "key_prefix", length: 30, unique: true }),
+    __metadata("design:type", String)
+], ApiKeyEntity.prototype, "keyPrefix", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ name: "secret_hash", length: 255 }),
+    __metadata("design:type", String)
+], ApiKeyEntity.prototype, "secretHash", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ name: "secret_last4", length: 4 }),
+    __metadata("design:type", String)
+], ApiKeyEntity.prototype, "secretLast4", void 0);
+__decorate([
+    (0, typeorm_1.Column)({
+        name: "status",
+        type: "enum",
+        enum: enum_1.API_KEY_STATUS,
+        default: enum_1.API_KEY_STATUS.ACTIVE,
+    }),
+    __metadata("design:type", String)
+], ApiKeyEntity.prototype, "status", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ name: "expires_at", type: "datetime", nullable: true }),
+    __metadata("design:type", Date)
+], ApiKeyEntity.prototype, "expiresAt", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ name: "last_used_at", type: "datetime", nullable: true }),
+    __metadata("design:type", Date)
+], ApiKeyEntity.prototype, "lastUsedAt", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ name: "last_used_ip", length: 45, nullable: true }),
+    __metadata("design:type", String)
+], ApiKeyEntity.prototype, "lastUsedIp", void 0);
+__decorate([
+    (0, typeorm_1.CreateDateColumn)({ name: "created_at" }),
+    __metadata("design:type", Date)
+], ApiKeyEntity.prototype, "createdAt", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ name: "revoked_at", type: "datetime", nullable: true }),
+    __metadata("design:type", Date)
+], ApiKeyEntity.prototype, "revokedAt", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ name: "revoke_reason", length: 255, nullable: true }),
+    __metadata("design:type", String)
+], ApiKeyEntity.prototype, "revokeReason", void 0);
+__decorate([
+    (0, typeorm_1.OneToMany)(() => api_key_action_entity_1.ApiKeyActionEntity, (action) => action.apiKey, {
+        cascade: true,
+        eager: false,
+    }),
+    __metadata("design:type", Array)
+], ApiKeyEntity.prototype, "actions", void 0);
+exports.ApiKeyEntity = ApiKeyEntity = __decorate([
+    (0, typeorm_1.Entity)("api_keys")
+], ApiKeyEntity);
+//# sourceMappingURL=api-key.entity.js.map

package/dist/entities/api-key.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-key.entity.js","sourceRoot":"","sources":["../../libs/nestjs-apikey-module/src/entities/api-key.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qCAMiB;AACjB,yCAAgD;AAChD,mEAA6D;AAGtD,IAAM,YAAY,GAAlB,MAAM,YAAY;CA+CxB,CAAA;AA/CY,oCAAY;AAEvB;IADC,IAAA,gCAAsB,EAAC,MAAM,CAAC;;wCACpB;AAGX;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;;0CACzB;AAGb;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;;+CACvC;AAGlB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;;gDAC1B;AAGnB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;;iDACxB;AAQpB;IANC,IAAA,gBAAM,EAAC;QACN,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,qBAAc;QACpB,OAAO,EAAE,qBAAc,CAAC,MAAM;KAC/B,CAAC;;4CACqB;AAGvB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;8BACtD,IAAI;+CAAQ;AAGvB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;8BACvD,IAAI;gDAAQ;AAGxB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;gDACnC;AAG1B;IADC,IAAA,0BAAgB,EAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;8BAC9B,IAAI;+CAAC;AAGhB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;8BACtD,IAAI;+CAAQ;AAGvB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;kDACnC;AAM5B;IAJC,IAAA,mBAAS,EAAC,GAAG,EAAE,CAAC,0CAAkB,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE;QAC9D,OAAO,EAAE,IAAI;QACb,KAAK,EAAE,KAAK;KACb,CAAC;;6CAC4B;uBA9CnB,YAAY;IADxB,IAAA,gBAAM,EAAC,UAAU,CAAC;GACN,YAAY,CA+CxB"}

package/dist/guards/api-key-strategy.guard.d.ts

@@ -0,0 +1,10 @@
+import { ExecutionContext } from "@nestjs/common";
+import { Reflector } from "@nestjs/core";
+import { ApiKeyGuard } from "./api-key.guard";
+import { ApiKeyService } from "../services/api-key.service";
+import { ApiKeyEntity } from "../entities/api-key.entity";
+export declare abstract class ApiKeyStrategyGuard extends ApiKeyGuard {
+    constructor(apiKeyService: ApiKeyService, reflector: Reflector);
+    canActivate(context: ExecutionContext): Promise<boolean>;
+    abstract resolve(apiKey: ApiKeyEntity, request: any): Promise<unknown>;
+}

package/dist/guards/api-key-strategy.guard.js

@@ -0,0 +1,35 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiKeyStrategyGuard = void 0;
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nestjs/core");
+const api_key_guard_1 = require("./api-key.guard");
+const api_key_service_1 = require("../services/api-key.service");
+const constants_1 = require("../constants");
+let ApiKeyStrategyGuard = class ApiKeyStrategyGuard extends api_key_guard_1.ApiKeyGuard {
+    constructor(apiKeyService, reflector) {
+        super(apiKeyService, reflector);
+    }
+    async canActivate(context) {
+        await super.canActivate(context);
+        const request = context.switchToHttp().getRequest();
+        const apiKey = request[constants_1.API_KEY_SESSION_KEY];
+        request[constants_1.API_KEY_SESSION_KEY] = await this.resolve(apiKey, request);
+        return true;
+    }
+};
+exports.ApiKeyStrategyGuard = ApiKeyStrategyGuard;
+exports.ApiKeyStrategyGuard = ApiKeyStrategyGuard = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [api_key_service_1.ApiKeyService, core_1.Reflector])
+], ApiKeyStrategyGuard);
+//# sourceMappingURL=api-key-strategy.guard.js.map

package/dist/guards/api-key-strategy.guard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-key-strategy.guard.js","sourceRoot":"","sources":["../../libs/nestjs-apikey-module/src/guards/api-key-strategy.guard.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAA8D;AAC9D,uCAAyC;AACzC,mDAA8C;AAC9C,iEAA4D;AAE5D,4CAAmD;AA0B5C,IAAe,mBAAmB,GAAlC,MAAe,mBAAoB,SAAQ,2BAAW;IAC3D,YAAY,aAA4B,EAAE,SAAoB;QAC5D,KAAK,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IAClC,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,OAAyB;QAEzC,MAAM,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAEjC,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC;QACpD,MAAM,MAAM,GAAiB,OAAO,CAAC,+BAAmB,CAAC,CAAC;QAG1D,OAAO,CAAC,+BAAmB,CAAC,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEnE,OAAO,IAAI,CAAC;IACd,CAAC;CAUF,CAAA;AA1BqB,kDAAmB;8BAAnB,mBAAmB;IADxC,IAAA,mBAAU,GAAE;qCAEgB,+BAAa,EAAa,gBAAS;GAD1C,mBAAmB,CA0BxC"}

package/dist/guards/api-key.guard.d.ts

@@ -0,0 +1,9 @@
+import { CanActivate, ExecutionContext } from "@nestjs/common";
+import { Reflector } from "@nestjs/core";
+import { ApiKeyService } from "../services/api-key.service";
+export declare class ApiKeyGuard implements CanActivate {
+    protected readonly apiKeyService: ApiKeyService;
+    protected readonly reflector: Reflector;
+    constructor(apiKeyService: ApiKeyService, reflector: Reflector);
+    canActivate(context: ExecutionContext): Promise<boolean>;
+}

package/dist/guards/api-key.guard.js

@@ -0,0 +1,48 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiKeyGuard = void 0;
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nestjs/core");
+const api_key_service_1 = require("../services/api-key.service");
+const api_key_actions_helper_1 = require("../helpers/api-key-actions.helper");
+const constants_1 = require("../constants");
+let ApiKeyGuard = class ApiKeyGuard {
+    constructor(apiKeyService, reflector) {
+        this.apiKeyService = apiKeyService;
+        this.reflector = reflector;
+    }
+    async canActivate(context) {
+        const request = context.switchToHttp().getRequest();
+        const rawKey = request.headers["x-api-key"];
+        if (!rawKey) {
+            throw new common_1.UnauthorizedException("Missing x-api-key header.");
+        }
+        let apiKey = await this.apiKeyService.validate({
+            value: rawKey,
+            ip: request.ip,
+        });
+        const rules = this.reflector.get(constants_1.API_KEY_ACTIONS_KEY, context.getHandler());
+        const grantedCodes = (apiKey.actions ?? []).map((a) => a.actionCode);
+        if (!(0, api_key_actions_helper_1.evaluateApiKeyActions)(rules, grantedCodes)) {
+            throw new common_1.UnauthorizedException("API key does not have the required action permissions.");
+        }
+        request[constants_1.API_KEY_SESSION_KEY] = apiKey;
+        return true;
+    }
+};
+exports.ApiKeyGuard = ApiKeyGuard;
+exports.ApiKeyGuard = ApiKeyGuard = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [api_key_service_1.ApiKeyService,
+        core_1.Reflector])
+], ApiKeyGuard);
+//# sourceMappingURL=api-key.guard.js.map

package/dist/guards/api-key.guard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-key.guard.js","sourceRoot":"","sources":["../../libs/nestjs-apikey-module/src/guards/api-key.guard.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAKwB;AACxB,uCAAyC;AACzC,iEAA4D;AAG5D,8EAA0E;AAC1E,4CAAwE;AAGjE,IAAM,WAAW,GAAjB,MAAM,WAAW;IACtB,YACqB,aAA4B,EAC5B,SAAoB;QADpB,kBAAa,GAAb,aAAa,CAAe;QAC5B,cAAS,GAAT,SAAS,CAAW;IACtC,CAAC;IAEJ,KAAK,CAAC,WAAW,CAAC,OAAyB;QACzC,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC;QAGpD,MAAM,MAAM,GAAW,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACpD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,8BAAqB,CAAC,2BAA2B,CAAC,CAAC;QAC/D,CAAC;QAGD,IAAI,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC;YAC7C,KAAK,EAAE,MAAM;YACb,EAAE,EAAE,OAAO,CAAC,EAAE;SACf,CAAC,CAAC;QAGH,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAC9B,+BAAmB,EACnB,OAAO,CAAC,UAAU,EAAE,CACrB,CAAC;QAEF,MAAM,YAAY,GAAG,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;QAErE,IAAI,CAAC,IAAA,8CAAqB,EAAC,KAAK,EAAE,YAAY,CAAC,EAAE,CAAC;YAChD,MAAM,IAAI,8BAAqB,CAC7B,wDAAwD,CACzD,CAAC;QACJ,CAAC;QAGD,OAAO,CAAC,+BAAmB,CAAC,GAAG,MAAM,CAAC;QAEtC,OAAO,IAAI,CAAC;IACd,CAAC;CACF,CAAA;AAxCY,kCAAW;sBAAX,WAAW;IADvB,IAAA,mBAAU,GAAE;qCAGyB,+BAAa;QACjB,gBAAS;GAH9B,WAAW,CAwCvB"}

package/dist/helpers/api-key-actions.helper.d.ts

@@ -0,0 +1,2 @@
+import { ApiKeyActionRule } from "../decorators/api-key-actions.decorator";
+export declare function evaluateApiKeyActions(rules: ApiKeyActionRule[], grantedActions: string[]): boolean;

package/dist/helpers/api-key-actions.helper.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.evaluateApiKeyActions = evaluateApiKeyActions;
+function evaluateApiKeyActions(rules, grantedActions) {
+    if (!rules || rules.length === 0)
+        return true;
+    const granted = new Set(grantedActions);
+    return rules.some((rule) => {
+        if (Array.isArray(rule)) {
+            return rule.every((action) => granted.has(action));
+        }
+        return granted.has(rule);
+    });
+}
+//# sourceMappingURL=api-key-actions.helper.js.map

package/dist/helpers/api-key-actions.helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-key-actions.helper.js","sourceRoot":"","sources":["../../libs/nestjs-apikey-module/src/helpers/api-key-actions.helper.ts"],"names":[],"mappings":";;AAcA,sDAcC;AAdD,SAAgB,qBAAqB,CACnC,KAAyB,EACzB,cAAwB;IAExB,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAE9C,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,CAAC;IAExC,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;QACzB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;QACrD,CAAC;QACD,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+export * from "./api-key.module";
+export * from "./constants";
+export * from "./config/enum";
+export * from "./decorators/api-key-actions.decorator";
+export * from "./decorators/api-key-session.decorator";
+export * from "./guards/api-key.guard";
+export * from "./guards/api-key-strategy.guard";
+export * from "./helpers/api-key-actions.helper";
+export * from "./interfaces/api-key.interfaces";
+export * from "./entities/api-key.entity";
+export * from "./entities/api-key-action.entity";
+export * from "./interfaces/api-key-context.interface";
+export * from "./services/api-key.service";
+export * from "./tasks/api-key-expiry.task";

package/dist/index.js

@@ -0,0 +1,31 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./api-key.module"), exports);
+__exportStar(require("./constants"), exports);
+__exportStar(require("./config/enum"), exports);
+__exportStar(require("./decorators/api-key-actions.decorator"), exports);
+__exportStar(require("./decorators/api-key-session.decorator"), exports);
+__exportStar(require("./guards/api-key.guard"), exports);
+__exportStar(require("./guards/api-key-strategy.guard"), exports);
+__exportStar(require("./helpers/api-key-actions.helper"), exports);
+__exportStar(require("./interfaces/api-key.interfaces"), exports);
+__exportStar(require("./entities/api-key.entity"), exports);
+__exportStar(require("./entities/api-key-action.entity"), exports);
+__exportStar(require("./interfaces/api-key-context.interface"), exports);
+__exportStar(require("./services/api-key.service"), exports);
+__exportStar(require("./tasks/api-key-expiry.task"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../libs/nestjs-apikey-module/src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,8CAA4B;AAC5B,gDAA8B;AAC9B,yEAAuD;AACvD,yEAAuD;AACvD,yDAAuC;AACvC,kEAAgD;AAChD,mEAAiD;AACjD,kEAAgD;AAChD,4DAA0C;AAC1C,mEAAiD;AACjD,yEAAuD;AACvD,6DAA2C;AAC3C,8DAA4C"}

package/dist/interfaces/api-key-context.interface.d.ts

@@ -0,0 +1,5 @@
+import { ApiKeyEntity } from "../entities/api-key.entity";
+export interface IApiKeyContext {
+    apiKey: ApiKeyEntity;
+    [key: string]: unknown;
+}

package/dist/interfaces/api-key-context.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=api-key-context.interface.js.map

package/dist/interfaces/api-key-context.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-key-context.interface.js","sourceRoot":"","sources":["../../libs/nestjs-apikey-module/src/interfaces/api-key-context.interface.ts"],"names":[],"mappings":""}

package/dist/interfaces/api-key.interfaces.d.ts

@@ -0,0 +1,30 @@
+import { ModuleMetadata } from "@nestjs/common";
+import { ApiKeyEntity } from "../entities/api-key.entity";
+export interface IApiKeyModuleOptions {
+    keyPrefix?: string;
+    bcryptSaltRounds?: number;
+    expiryCron?: string | false;
+}
+export interface IApiKeyModuleAsyncOptions extends Pick<ModuleMetadata, "imports"> {
+    useFactory: (...args: any[]) => Promise<IApiKeyModuleOptions> | IApiKeyModuleOptions;
+    inject?: any[];
+}
+export interface ICreateApiKeyOptions {
+    name: string;
+    actions: string[];
+    expiresInDays?: number;
+}
+export interface ICreateApiKeyResult {
+    entity: ApiKeyEntity;
+    apikey: string;
+}
+export interface IRevokeApiKeyOptions {
+    id: string;
+    reason?: string;
+}
+export interface IRotateApiKeyResult extends ICreateApiKeyResult {
+}
+export interface IApiKeyValidationOptions {
+    value: string;
+    ip?: string;
+}

package/dist/interfaces/api-key.interfaces.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=api-key.interfaces.js.map

package/dist/interfaces/api-key.interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-key.interfaces.js","sourceRoot":"","sources":["../../libs/nestjs-apikey-module/src/interfaces/api-key.interfaces.ts"],"names":[],"mappings":""}

package/dist/services/api-key.service.d.ts

@@ -0,0 +1,21 @@
+import { Repository } from "typeorm";
+import { ApiKeyEntity } from "../entities/api-key.entity";
+import { ApiKeyActionEntity } from "../entities/api-key-action.entity";
+import { IApiKeyModuleOptions, IApiKeyValidationOptions, ICreateApiKeyOptions, ICreateApiKeyResult, IRevokeApiKeyOptions, IRotateApiKeyResult } from "../interfaces/api-key.interfaces";
+export declare class ApiKeyService {
+    private readonly apiKeyRepo;
+    private readonly apiKeyActionRepo;
+    private readonly options;
+    constructor(apiKeyRepo: Repository<ApiKeyEntity>, apiKeyActionRepo: Repository<ApiKeyActionEntity>, options: IApiKeyModuleOptions);
+    create(data: ICreateApiKeyOptions): Promise<ICreateApiKeyResult>;
+    getById(id: string): Promise<ApiKeyEntity>;
+    getActiveById(id: string): Promise<ApiKeyEntity>;
+    getActiveByKeyPrefix(keyPrefix: string): Promise<ApiKeyEntity>;
+    revoke(options: IRevokeApiKeyOptions): Promise<void>;
+    rotate(id: string): Promise<IRotateApiKeyResult>;
+    validate(options: IApiKeyValidationOptions): Promise<ApiKeyEntity>;
+    remove(id: string): Promise<void>;
+    removeByKeyPrefix(keyPrefix: string): Promise<void>;
+    expireKeys(): Promise<void>;
+    expireByKeyPrefix(keyPrefix: string): Promise<void>;
+}