@ask-ell/back-end 0.0.2 → 0.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ask-ell/back-end",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "private": false,
   "type": "commonjs",
   "main": "./src/index.js",

package/src/add-ons/add-on.interface.d.ts

@@ -0,0 +1,5 @@
+import { INestApplication } from "@nestjs/common";
+export interface IAddOn<T> {
+    apply(application: INestApplication<T>): void;
+}
+//# sourceMappingURL=add-on.interface.d.ts.map

package/src/add-ons/add-on.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-on.interface.d.ts","sourceRoot":"","sources":["../../../../../packages/back-end/src/add-ons/add-on.interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAElD,MAAM,WAAW,MAAM,CAAC,CAAC;IACjB,KAAK,CAAC,WAAW,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;CACrD"}

package/src/add-ons/add-on.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/add-ons/add-on.wrapper.d.ts

@@ -0,0 +1,10 @@
+import { INestApplication } from "@nestjs/common";
+import { IAddOn } from "./add-on.interface";
+import { AddOnWrapperParams } from "./types";
+export declare class AddOnWrapper<T> implements IAddOn<T> {
+    private params;
+    private implementations;
+    constructor(params: AddOnWrapperParams);
+    apply(application: INestApplication<T>): void;
+}
+//# sourceMappingURL=add-on.wrapper.d.ts.map

package/src/add-ons/add-on.wrapper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-on.wrapper.d.ts","sourceRoot":"","sources":["../../../../../packages/back-end/src/add-ons/add-on.wrapper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAElD,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAG5C,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAG7C,qBAAa,YAAY,CAAC,CAAC,CAAE,YAAW,MAAM,CAAC,CAAC,CAAC;IAIzC,OAAO,CAAC,MAAM;IAHlB,OAAO,CAAC,eAAe,CAAc;gBAGzB,MAAM,EAAE,kBAAkB;IAQtC,KAAK,CAAC,WAAW,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,IAAI;CAKhD"}

package/src/add-ons/add-on.wrapper.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AddOnWrapper = void 0;
+const swagger_add_on_1 = require("./implementations/swagger/swagger.add-on");
+const security_add_on_1 = require("./implementations/security/security.add-on");
+class AddOnWrapper {
+    params;
+    implementations;
+    constructor(params) {
+        this.params = params;
+        this.implementations = [
+            new swagger_add_on_1.SwaggerAddon(this.params.swagger),
+            new security_add_on_1.SecurityAddOn()
+        ];
+    }
+    apply(application) {
+        this.implementations.forEach((addOn) => {
+            addOn.apply(application);
+        });
+    }
+}
+exports.AddOnWrapper = AddOnWrapper;

package/src/add-ons/implementations/security/security.add-on.d.ts

@@ -0,0 +1,6 @@
+import { INestApplication } from "@nestjs/common";
+import { IAddOn } from "../../add-on.interface";
+export declare class SecurityAddOn<T> implements IAddOn<T> {
+    apply(application: INestApplication<T>): void;
+}
+//# sourceMappingURL=security.add-on.d.ts.map

package/src/add-ons/implementations/security/security.add-on.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"security.add-on.d.ts","sourceRoot":"","sources":["../../../../../../../packages/back-end/src/add-ons/implementations/security/security.add-on.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAkB,MAAM,gBAAgB,CAAC;AAGlE,OAAO,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAGhD,qBAAa,aAAa,CAAC,CAAC,CAAE,YAAW,MAAM,CAAC,CAAC,CAAC;IAChD,KAAK,CAAC,WAAW,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,IAAI;CAU9C"}

package/src/add-ons/implementations/security/security.add-on.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SecurityAddOn = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@nestjs/common");
+const helmet_1 = tslib_1.__importDefault(require("helmet"));
+class SecurityAddOn {
+    apply(application) {
+        application.enableCors();
+        application.use((0, helmet_1.default)());
+        application.useGlobalPipes(new common_1.ValidationPipe({
+            transform: true,
+            whitelist: false
+        }));
+    }
+}
+exports.SecurityAddOn = SecurityAddOn;

package/src/add-ons/implementations/sentry/sentry.add-on.d.ts

@@ -0,0 +1,8 @@
+import { Entity, type IResult } from "@ask-ell/core";
+import { ISentryAddOnState } from "./sentry.add-on.state.interface";
+import { ISentryAddOn } from "./sentry.add-on.interface";
+export declare class SentryAddon<T> extends Entity<ISentryAddOnState> implements ISentryAddOn<T> {
+    checkStateValidity(_newState: ISentryAddOnState): IResult<void>;
+    apply(): void;
+}
+//# sourceMappingURL=sentry.add-on.d.ts.map

package/src/add-ons/implementations/sentry/sentry.add-on.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sentry.add-on.d.ts","sourceRoot":"","sources":["../../../../../../../packages/back-end/src/add-ons/implementations/sentry/sentry.add-on.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,OAAO,EAAM,MAAM,eAAe,CAAC;AAGzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAGzD,qBAAa,WAAW,CAAC,CAAC,CACxB,SAAQ,MAAM,CAAC,iBAAiB,CAChC,YAAW,YAAY,CAAC,CAAC,CAAC;IAE1B,kBAAkB,CAAC,SAAS,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/D,KAAK,IAAI,IAAI;CASd"}

package/src/add-ons/implementations/sentry/sentry.add-on.interface.d.ts

@@ -0,0 +1,6 @@
+import { IEntity } from "@ask-ell/core";
+import { ISentryAddOnState } from "./sentry.add-on.state.interface";
+import { IAddOn } from "../../add-on.interface";
+export interface ISentryAddOn<T> extends IEntity<ISentryAddOnState>, IAddOn<T> {
+}
+//# sourceMappingURL=sentry.add-on.interface.d.ts.map

package/src/add-ons/implementations/sentry/sentry.add-on.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sentry.add-on.interface.d.ts","sourceRoot":"","sources":["../../../../../../../packages/back-end/src/add-ons/implementations/sentry/sentry.add-on.interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAGhD,MAAM,WAAW,YAAY,CAAC,CAAC,CAC7B,SAAQ,OAAO,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;CAAI"}

package/src/add-ons/implementations/sentry/sentry.add-on.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/add-ons/implementations/sentry/sentry.add-on.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SentryAddon = void 0;
+const core_1 = require("@ask-ell/core");
+const nest_1 = require("@ask-ell/nest");
+class SentryAddon extends core_1.Entity {
+    checkStateValidity(_newState) {
+        return (0, core_1.ok)();
+    }
+    apply() {
+        const { host, projectId, publicKey } = this.getSnapshot();
+        new nest_1.NestSentryConfiguration({
+            publicKey,
+            host,
+            projectId
+        }).init();
+    }
+}
+exports.SentryAddon = SentryAddon;

package/src/add-ons/implementations/sentry/sentry.add-on.state.interface.d.ts

@@ -0,0 +1,6 @@
+export interface ISentryAddOnState {
+    publicKey: string;
+    host: string;
+    projectId: string;
+}
+//# sourceMappingURL=sentry.add-on.state.interface.d.ts.map

package/src/add-ons/implementations/sentry/sentry.add-on.state.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sentry.add-on.state.interface.d.ts","sourceRoot":"","sources":["../../../../../../../packages/back-end/src/add-ons/implementations/sentry/sentry.add-on.state.interface.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;CACnB"}

package/src/add-ons/implementations/sentry/sentry.add-on.state.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/add-ons/implementations/swagger/swagger.add-on.d.ts

@@ -0,0 +1,9 @@
+import { Entity, type IResult } from "@ask-ell/core";
+import { type INestApplication } from "@nestjs/common";
+import { ISwaggerAddOnState } from "./swagger.add-on.state.interface";
+import { ISwaggerAddOn } from "./swagger.add-on.interface";
+export declare class SwaggerAddon<T> extends Entity<ISwaggerAddOnState> implements ISwaggerAddOn<T> {
+    checkStateValidity(_newState: ISwaggerAddOnState): IResult<void>;
+    apply(application: INestApplication<T>): void;
+}
+//# sourceMappingURL=swagger.add-on.d.ts.map

package/src/add-ons/implementations/swagger/swagger.add-on.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"swagger.add-on.d.ts","sourceRoot":"","sources":["../../../../../../../packages/back-end/src/add-ons/implementations/swagger/swagger.add-on.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,OAAO,EAAM,MAAM,eAAe,CAAC;AACzD,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAOvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAI3D,qBAAa,YAAY,CAAC,CAAC,CACzB,SAAQ,MAAM,CAAC,kBAAkB,CACjC,YAAW,aAAa,CAAC,CAAC,CAAC;IAE3B,kBAAkB,CAAC,SAAS,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhE,KAAK,CAAC,WAAW,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,IAAI;CAqB9C"}

package/src/add-ons/implementations/swagger/swagger.add-on.interface.d.ts

@@ -0,0 +1,6 @@
+import { IEntity } from "@ask-ell/core";
+import { ISwaggerAddOnState } from "./swagger.add-on.state.interface";
+import { IAddOn } from "../../add-on.interface";
+export interface ISwaggerAddOn<T> extends IEntity<ISwaggerAddOnState>, IAddOn<T> {
+}
+//# sourceMappingURL=swagger.add-on.interface.d.ts.map

package/src/add-ons/implementations/swagger/swagger.add-on.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"swagger.add-on.interface.d.ts","sourceRoot":"","sources":["../../../../../../../packages/back-end/src/add-ons/implementations/swagger/swagger.add-on.interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAEhD,MAAM,WAAW,aAAa,CAAC,CAAC,CAC9B,SAAQ,OAAO,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;CAAI"}

package/src/add-ons/implementations/swagger/swagger.add-on.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/add-ons/implementations/swagger/swagger.add-on.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SwaggerAddon = void 0;
+const core_1 = require("@ask-ell/core");
+const swagger_1 = require("@nestjs/swagger");
+class SwaggerAddon extends core_1.Entity {
+    checkStateValidity(_newState) {
+        return (0, core_1.ok)();
+    }
+    apply(application) {
+        const { title, auths } = this.getSnapshot();
+        const documentBuilder = new swagger_1.DocumentBuilder().setTitle(title);
+        auths?.forEach((auth) => {
+            if (auth === 'bearer') {
+                documentBuilder.addBearerAuth();
+            }
+        });
+        const documentBuild = documentBuilder.build();
+        const documentFactory = () => swagger_1.SwaggerModule.createDocument(application, documentBuild);
+        swagger_1.SwaggerModule.setup("/swagger", application, documentFactory, {
+            customSiteTitle: title,
+            jsonDocumentUrl: "/swagger/json",
+        });
+    }
+}
+exports.SwaggerAddon = SwaggerAddon;

package/src/add-ons/implementations/swagger/swagger.add-on.state.interface.d.ts

@@ -0,0 +1,6 @@
+import { AuthMethod } from "./types";
+export interface ISwaggerAddOnState {
+    title: string;
+    auths?: AuthMethod[];
+}
+//# sourceMappingURL=swagger.add-on.state.interface.d.ts.map

package/src/add-ons/implementations/swagger/swagger.add-on.state.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"swagger.add-on.state.interface.d.ts","sourceRoot":"","sources":["../../../../../../../packages/back-end/src/add-ons/implementations/swagger/swagger.add-on.state.interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAErC,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,UAAU,EAAE,CAAC;CACtB"}

package/src/add-ons/implementations/swagger/swagger.add-on.state.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/add-ons/implementations/swagger/types.d.ts

@@ -0,0 +1,2 @@
+export type AuthMethod = 'bearer' | 'cookie';
+//# sourceMappingURL=types.d.ts.map

package/src/add-ons/implementations/swagger/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../../../packages/back-end/src/add-ons/implementations/swagger/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,QAAQ,CAAC"}

package/src/add-ons/implementations/swagger/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/add-ons/index.d.ts

@@ -0,0 +1,2 @@
+export * from './add-on.wrapper';
+//# sourceMappingURL=index.d.ts.map

package/src/add-ons/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../packages/back-end/src/add-ons/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAA"}

package/src/add-ons/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./add-on.wrapper"), exports);

package/src/add-ons/types.d.ts

@@ -0,0 +1,5 @@
+import { ISwaggerAddOnState } from "./implementations/swagger/swagger.add-on.state.interface";
+export type AddOnWrapperParams = {
+    swagger: ISwaggerAddOnState;
+};
+//# sourceMappingURL=types.d.ts.map

package/src/add-ons/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../packages/back-end/src/add-ons/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,0DAA0D,CAAA;AAE7F,MAAM,MAAM,kBAAkB,GAAG;IAC7B,OAAO,EAAE,kBAAkB,CAAC;CAC/B,CAAA"}

package/src/add-ons/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/application.base.d.ts

@@ -0,0 +1,5 @@
+import { DynamicModule, Provider } from "@nestjs/common";
+export declare class ApplicationBase {
+    static withProviders(providers: Provider[]): DynamicModule;
+}
+//# sourceMappingURL=application.base.d.ts.map

package/src/application.base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"application.base.d.ts","sourceRoot":"","sources":["../../../../packages/back-end/src/application.base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAIzD,qBAAa,eAAe;IACxB,MAAM,CAAC,aAAa,CAAC,SAAS,EAAE,QAAQ,EAAE,GAAG,aAAa;CAS7D"}

package/src/application.base.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApplicationBase = void 0;
+const requirement_module_1 = require("./requirement.module");
+class ApplicationBase {
+    static withProviders(providers) {
+        const providersAndExports = [...providers];
+        return {
+            module: this,
+            imports: [requirement_module_1.RequirementModule],
+            providers: providersAndExports,
+            exports: [...providersAndExports]
+        };
+    }
+}
+exports.ApplicationBase = ApplicationBase;

package/src/index.d.ts

@@ -1,2 +1,4 @@
+export * from './add-ons';
 export * from './keyv.store.adapter.factory';
+export * from "./application.base";
 //# sourceMappingURL=index.d.ts.map

package/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../packages/back-end/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../packages/back-end/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,8BAA8B,CAAC;AAC7C,cAAc,oBAAoB,CAAA"}

package/src/index.js

@@ -1,4 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./add-ons"), exports);
 tslib_1.__exportStar(require("./keyv.store.adapter.factory"), exports);
+tslib_1.__exportStar(require("./application.base"), exports);

package/src/requirement.module.d.ts

@@ -0,0 +1,3 @@
+export declare class RequirementModule {
+}
+//# sourceMappingURL=requirement.module.d.ts.map

package/src/requirement.module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"requirement.module.d.ts","sourceRoot":"","sources":["../../../../packages/back-end/src/requirement.module.ts"],"names":[],"mappings":"AAaA,qBAmCa,iBAAiB;CAAI"}

package/src/requirement.module.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequirementModule = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@nestjs/common");
+const config_1 = require("@nestjs/config");
+const core_1 = require("@nestjs/core");
+const throttler_1 = require("@nestjs/throttler");
+const ask_1 = require("@ask-ell/ask");
+const nest_1 = require("@ask-ell/nest");
+const keyv_store_adapter_factory_1 = require("./keyv.store.adapter.factory");
+const configurationLogger = new nest_1.NestLogger("Configuration");
+let RequirementModule = (() => {
+    let _classDecorators = [(0, common_1.Global)(), (0, common_1.Module)({
+            imports: [
+                nest_1.HealthModule,
+                throttler_1.ThrottlerModule.forRoot([{
+                        ttl: 60000,
+                        limit: 30,
+                    }]),
+                config_1.ConfigModule.forRoot({
+                    isGlobal: true,
+                    load: [
+                        (0, ask_1.askDockerSecretsFactory)(configurationLogger),
+                        (0, ask_1.askLocalSecretsFactory)(configurationLogger)
+                    ]
+                })
+            ],
+            providers: [
+                keyv_store_adapter_factory_1.KeyvStoreAdapterFactory,
+                {
+                    provide: core_1.APP_GUARD,
+                    useClass: throttler_1.ThrottlerGuard
+                },
+                {
+                    provide: core_1.APP_INTERCEPTOR,
+                    useClass: nest_1.ResponseFormatInterceptor
+                },
+                {
+                    provide: core_1.APP_FILTER,
+                    useClass: nest_1.HttpExceptionFilter
+                }
+            ],
+            exports: [
+                config_1.ConfigModule
+            ]
+        })];
+    let _classDescriptor;
+    let _classExtraInitializers = [];
+    let _classThis;
+    var RequirementModule = class {
+        static { _classThis = this; }
+        static {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(null) : void 0;
+            tslib_1.__esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
+            RequirementModule = _classThis = _classDescriptor.value;
+            if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+            tslib_1.__runInitializers(_classThis, _classExtraInitializers);
+        }
+    };
+    return RequirementModule = _classThis;
+})();
+exports.RequirementModule = RequirementModule;