@ackplus/nest-dynamic-templates 1.1.1 → 1.1.5

package/src/test/test-database.config.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.testRedisConfig = exports.testDatabaseConfig = void 0;
+const template_entity_1 = require("../lib/entities/template.entity");
+const template_layout_entity_1 = require("../lib/entities/template-layout.entity");
+exports.testDatabaseConfig = {
+    type: 'sqlite',
+    database: ':memory:',
+    entities: [template_entity_1.NestDynamicTemplate, template_layout_entity_1.NestDynamicTemplateLayout],
+    logging: ['error', 'warn'],
+    synchronize: true, // Disable auto-synchronization
+    dropSchema: true, // Drop schema before tests
+};
+exports.testRedisConfig = {
+    type: 'single',
+    options: {
+        host: 'localhost',
+        port: 6379,
+        retryStrategy: (times) => {
+            return Math.min(times * 50, 2000);
+        },
+    },
+};

package/src/test/test.setup.d.ts

@@ -0,0 +1,4 @@
+import { NestDynamicTemplatesModuleConfig } from '../lib/interfaces/module-config.interface';
+export declare function createTestModule(options?: Partial<NestDynamicTemplatesModuleConfig>): Promise<import("@nestjs/testing").TestingModule>;
+export declare function createTestApp(options?: Partial<NestDynamicTemplatesModuleConfig>): Promise<import("@nestjs/common").INestApplication<any>>;
+//# sourceMappingURL=test.setup.d.ts.map

package/src/test/test.setup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test.setup.d.ts","sourceRoot":"","sources":["../../../../../packages/nest-dynamic-templates/src/test/test.setup.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,gCAAgC,EAAE,MAAM,2CAA2C,CAAC;AAG7F,wBAAsB,gBAAgB,CAAC,OAAO,GAAE,OAAO,CAAC,gCAAgC,CAAM,oDAY7F;AAED,wBAAsB,aAAa,CAAC,OAAO,GAAE,OAAO,CAAC,gCAAgC,CAAM,2DAU1F"}

package/src/test/test.setup.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTestModule = createTestModule;
+exports.createTestApp = createTestApp;
+const testing_1 = require("@nestjs/testing");
+const typeorm_1 = require("@nestjs/typeorm");
+const test_database_config_1 = require("./test-database.config");
+const template_layout_entity_1 = require("../lib/entities/template-layout.entity");
+const template_entity_1 = require("../lib/entities/template.entity");
+const common_1 = require("@nestjs/common");
+const nest_dynamic_templates_module_1 = require("../lib/nest-dynamic-templates.module");
+async function createTestModule(options = {}) {
+    const moduleRef = await testing_1.Test.createTestingModule({
+        imports: [
+            typeorm_1.TypeOrmModule.forRoot(test_database_config_1.testDatabaseConfig),
+            typeorm_1.TypeOrmModule.forFeature([template_entity_1.NestDynamicTemplate, template_layout_entity_1.NestDynamicTemplateLayout]),
+            // RedisModule.forRoot(testRedisConfig),
+            nest_dynamic_templates_module_1.NestDynamicTemplatesModule.forRoot(options),
+        ],
+    }).compile();
+    return moduleRef;
+}
+async function createTestApp(options = {}) {
+    const moduleRef = await createTestModule(options);
+    const app = moduleRef.createNestApplication();
+    // Enable validation
+    app.useGlobalPipes(new common_1.ValidationPipe());
+    await app.init();
+    return app;
+}

package/eslint.config.mjs

@@ -1,22 +0,0 @@
-import baseConfig from '../../eslint.base.config';
-
-export default [
-  ...baseConfig,
-  {
-    files: ['**/*.json'],
-    rules: {
-      '@nx/dependency-checks': [
-        'error',
-        {
-          ignoredFiles: ['{projectRoot}/eslint.config.{js,cjs,mjs,ts,cts,mts}'],
-        },
-      ],
-    },
-    languageOptions: {
-      parser: await import('jsonc-eslint-parser'),
-    },
-  },
-  {
-    ignores: ['**/out-tsc'],
-  },
-];

package/jest.config.ts

@@ -1,10 +0,0 @@
-export default {
-  displayName: 'nest-dynamic-templates',
-  preset: '../../jest.preset.js',
-  testEnvironment: 'node',
-  transform: {
-    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
-  },
-  moduleFileExtensions: ['ts', 'js', 'html'],
-  coverageDirectory: '../../coverage/packages/nest-dynamic-templates',
-};

package/project.json

@@ -1,38 +0,0 @@
-{
-  "name": "nest-dynamic-templates",
-  "$schema": "../../node_modules/nx/schemas/project-schema.json",
-  "sourceRoot": "packages/nest-dynamic-templates/src",
-  "projectType": "library",
-  "release": {
-    "version": {
-      "manifestRootsToUpdate": [
-        "dist/{projectRoot}"
-      ],
-      "currentVersionResolver": "git-tag",
-      "fallbackCurrentVersionResolver": "disk"
-    }
-  },
-  "tags": [],
-  "targets": {
-    "build": {
-      "executor": "@nx/js:tsc",
-      "outputs": [
-        "{options.outputPath}"
-      ],
-      "options": {
-        "outputPath": "dist/packages/nest-dynamic-templates",
-        "tsConfig": "packages/nest-dynamic-templates/tsconfig.lib.json",
-        "packageJson": "packages/nest-dynamic-templates/package.json",
-        "main": "packages/nest-dynamic-templates/src/index.ts",
-        "assets": [
-          "packages/nest-dynamic-templates/*.md"
-        ]
-      }
-    },
-    "nx-release-publish": {
-      "options": {
-        "packageRoot": "dist/{projectRoot}"
-      }
-    }
-  }
-}

package/src/lib/constant.ts

@@ -1,2 +0,0 @@
-export const NEST_DYNAMIC_TEMPLATES_MODULE_CONFIG = Symbol('NEST_DYNAMIC_TEMPLATES_MODULE_CONFIG');
-export const NEST_DYNAMIC_TEMPLATES_ASYNC_OPTIONS_PROVIDER = 'NEST_DYNAMIC_TEMPLATES_ASYNC_OPTIONS_PROVIDER';

package/src/lib/dto/create-template-layout.dto.ts

@@ -1,65 +0,0 @@
-import { IsString, IsEnum, IsOptional, IsNotEmpty, Matches } from 'class-validator';
-import { TemplateEngineEnum, TemplateLanguageEnum } from '../interfaces/template.types';
-import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
-
-
-export class CreateTemplateLayoutDto {
-
-    @ApiProperty({ type: String })
-    @IsString()
-    @IsNotEmpty()
-    @Matches(/^[a-z0-9\-_]+$/, { message: 'Invalid template name format' })
-    name: string;
-
-    @ApiProperty({ type: String })
-    @IsString()
-    @IsOptional()
-    type?: string;
-
-    @ApiPropertyOptional({ type: String })
-    @IsString()
-    @IsNotEmpty()
-    displayName: string;
-
-    @ApiProperty({ type: String, nullable: true })
-    @IsString()
-    @IsOptional()
-    description?: string;
-
-    @ApiProperty({ enum: TemplateEngineEnum, type: String })
-    @IsEnum(TemplateEngineEnum)
-    @IsOptional()
-    engine: TemplateEngineEnum = TemplateEngineEnum.NUNJUCKS;
-
-    @ApiProperty({ enum: TemplateLanguageEnum, type: String })
-    @IsEnum(TemplateLanguageEnum)
-    @IsNotEmpty()
-    language: TemplateLanguageEnum;
-
-    @ApiProperty({ type: String, nullable: true })
-    @IsString()
-    content: string;
-
-    @ApiPropertyOptional({ type: String, default: 'system' })
-    @IsString()
-    @IsOptional()
-    scope: string = 'system';
-
-    @ApiPropertyOptional({ type: String })
-    @IsString()
-    @IsOptional()
-    scopeId?: string;
-
-    @ApiPropertyOptional({ type: String, nullable: true, default: 'en' })
-    @IsString()
-    @IsOptional()
-    locale?: string = 'en';
-
-    @ApiPropertyOptional({ type: Object, nullable: true })
-    @IsOptional()
-    previewContext?: Record<string, any>;
-
-    @ApiPropertyOptional({ type: Boolean, nullable: true })
-    @IsOptional()
-    isActive?: boolean = true;
-}

package/src/lib/dto/create-template.dto.ts

@@ -1,80 +0,0 @@
-import { IsString, IsEnum, IsOptional, IsNotEmpty, Matches, IsBoolean } from 'class-validator';
-import { TemplateEngineEnum, TemplateLanguageEnum, TemplateTypeEnum } from '../interfaces/template.types';
-import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
-import { Transform } from 'class-transformer';
-
-export class CreateTemplateDto {
-
-    @ApiProperty({ type: String })
-    @IsString()
-    @IsNotEmpty()
-    @Matches(/^[a-z0-9\-_]+$/, { message: 'Invalid template name format' })
-    name: string;
-
-    @ApiPropertyOptional({ type: String, nullable: true })
-    @IsString()
-    @IsOptional()
-    templateLayoutName?: string;
-
-    @ApiProperty({ type: String })
-    @IsString()
-    @IsOptional()
-    type?: string;
-
-    @ApiPropertyOptional({ type: String })
-    @IsString()
-    @IsNotEmpty()
-    displayName: string;
-
-    @ApiProperty({ type: String, nullable: true })
-    @IsString()
-    @IsOptional()
-    description?: string;
-
-    @ApiProperty({ enum: TemplateEngineEnum, type: String })
-    @IsEnum(TemplateEngineEnum)
-    @IsOptional()
-    engine: TemplateEngineEnum = TemplateEngineEnum.NUNJUCKS;
-
-    @ApiProperty({ enum: TemplateLanguageEnum, type: String })
-    @IsEnum(TemplateLanguageEnum)
-    language: TemplateLanguageEnum;
-
-    @ApiProperty({ type: String, nullable: true })
-    @IsString()
-    @IsOptional()
-    content: string;
-
-    @ApiPropertyOptional({ type: String, nullable: true })
-    @IsString()
-    @IsOptional()
-    subject?: string;
-
-    @ApiPropertyOptional({ type: String, default: 'system' })
-    @IsString()
-    @IsOptional()
-    @Transform(({ value }) => value || 'system')
-    scope: string = 'system';
-
-    @ApiPropertyOptional({ type: String })
-    @IsString()
-    @IsOptional()
-    scopeId?: string;
-
-    @ApiPropertyOptional({ type: String, nullable: true, default: 'en' })
-    @IsString()
-    @IsOptional()
-    @IsNotEmpty()
-    @Transform(({ value }) => value || 'en')
-    locale?: string = 'en';
-
-    @ApiPropertyOptional({ type: Object, nullable: true })
-    @IsOptional()
-    previewContext?: Record<string, any>;
-
-    @ApiPropertyOptional({ type: Boolean, nullable: true })
-    @IsBoolean()
-    @IsOptional()
-    isActive?: boolean = true;
-
-}

package/src/lib/dto/render-content-template-layout.dto.ts

@@ -1,32 +0,0 @@
-import { IsString, IsEnum, IsObject, IsOptional, IsNotEmpty } from 'class-validator';
-import { TemplateEngineEnum, TemplateLanguageEnum } from '../interfaces/template.types';
-import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
-import { Transform } from 'class-transformer';
-
-
-export class RenderContentTemplateLayoutDto {
-    @ApiProperty({ type: String })
-    @IsString()
-    @IsNotEmpty()
-    content?: string;
-
-    @ApiProperty({ enum: TemplateLanguageEnum, type: String })
-    @IsEnum(TemplateLanguageEnum)
-    @IsNotEmpty()
-    @Transform(({ value }) => value || TemplateLanguageEnum.HTML)
-    language?: TemplateLanguageEnum;
-
-    @ApiProperty({ enum: TemplateEngineEnum, type: String })
-    @IsEnum(TemplateEngineEnum)
-    @Transform(({ value }) => value || TemplateEngineEnum.NUNJUCKS)
-    engine?: TemplateEngineEnum;
-
-    @ApiPropertyOptional({
-        type: String,
-        nullable: true,
-        description: 'The context of the template'
-    })
-    @IsObject()
-    @IsOptional()
-    context?: Record<string, any>;
-}

package/src/lib/dto/render-content-template.dto.ts

@@ -1,37 +0,0 @@
-import { IsString, IsEnum, IsObject, IsOptional, IsNotEmpty } from 'class-validator';
-import { TemplateEngineEnum, TemplateLanguageEnum } from '../interfaces/template.types';
-import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
-import { Transform } from 'class-transformer';
-
-
-export class RenderContentTemplateDto {
-    @ApiProperty({ type: String })
-    @IsString()
-    @IsNotEmpty()
-    content?: string;
-
-    @ApiProperty({ enum: TemplateLanguageEnum, type: String })
-    @IsEnum(TemplateLanguageEnum)
-    @IsNotEmpty()
-    @Transform(({ value }) => value || TemplateLanguageEnum.HTML)
-    language?: TemplateLanguageEnum;
-
-    @ApiProperty({ enum: TemplateEngineEnum, type: String })
-    @IsEnum(TemplateEngineEnum)
-    @Transform(({ value }) => value || TemplateEngineEnum.NUNJUCKS)
-    engine?: TemplateEngineEnum;
-
-    @ApiPropertyOptional({
-        type: String,
-        nullable: true,
-        description: 'The context of the template'
-    })
-    @IsObject()
-    @IsOptional()
-    context?: Record<string, any>;
-
-    @ApiPropertyOptional({ type: String })
-    @IsString()
-    @IsOptional()
-    templateLayoutId?: string;
-}

package/src/lib/dto/render-template-layout.dto.ts

@@ -1,55 +0,0 @@
-import { IsString, IsEnum, IsObject, IsOptional, IsNotEmpty } from 'class-validator';
-import { TemplateTypeEnum } from '../interfaces/template.types';
-import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
-
-
-export class RenderTemplateLayoutDto {
-
-    @ApiPropertyOptional({
-        type: String,
-        default: 'en',
-        description: 'The locale code, i.e en, fr, es, etc.'
-    })
-    @IsString()
-    @IsOptional()
-    locale?: string = 'en';
-
-    @ApiProperty({ type: String })
-    @IsString()
-    @IsNotEmpty()
-    name: string;
-
-    @ApiProperty({
-        type: String,
-        default: 'system',
-        description: 'The scope of the template, i.e user, organization, etc.'
-    })
-    @IsString()
-    scope: string;
-
-    @ApiPropertyOptional({
-        type: String,
-        default: null,
-        description: 'The scope id of the template, i.e user id, organization id, etc.'
-    })
-    @IsString()
-    @IsOptional()
-    scopeId?: string;
-
-    @ApiPropertyOptional({
-        type: String,
-        nullable: true,
-        description: 'The context of the template'
-    })
-    @IsObject()
-    @IsOptional()
-    context?: Record<string, any>;
-}
-
-
-export class RenderTemplateLayoutOutput {
-    @ApiProperty({ type: String })
-    @IsString()
-    @IsNotEmpty()
-    content: string;
-}

package/src/lib/dto/render-template.dto.ts

@@ -1,74 +0,0 @@
-import { IsString, IsEnum, IsObject, IsOptional, IsNotEmpty, Matches, ValidateIf } from 'class-validator';
-import { TemplateLanguageEnum, TemplateTypeEnum } from '../interfaces/template.types';
-import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
-
-
-export class RenderTemplateDto {
-
-    @ApiPropertyOptional({
-        type: String,
-        default: 'en',
-        description: 'The locale code, i.e en, fr, es, etc.'
-    })
-    @IsString()
-    @IsOptional()
-    locale?: string = 'en';
-
-    @ApiProperty({ type: String })
-    @IsString()
-    @IsNotEmpty()
-    @ValidateIf((object, value) => !object?.content)
-    name?: string;
-
-    @ApiProperty({ type: String })
-    @IsString()
-    @IsNotEmpty()
-    @ValidateIf((object, value) => !object?.name)
-    content?: string;
-
-    @ApiProperty({ enum: TemplateLanguageEnum, type: String })
-    @IsEnum(TemplateLanguageEnum)
-    @IsNotEmpty()
-    @ValidateIf((object, value) => !object?.name)
-    language?: TemplateLanguageEnum;
-
-    @ApiPropertyOptional({
-        type: String,
-        default: 'system',
-        description: 'The scope of the template, i.e user, organization, etc.'
-    })
-    @IsString()
-    @IsOptional()
-    scope?: string = 'system';
-
-    @ApiPropertyOptional({
-        type: String,
-        default: null,
-        description: 'The scope id of the template, i.e user id, organization id, etc.'
-    })
-    @IsString()
-    @IsOptional()
-    scopeId?: string;
-
-    @ApiPropertyOptional({
-        type: String,
-        nullable: true,
-        description: 'The context of the template'
-    })
-    @IsObject()
-    @IsOptional()
-    context?: Record<string, any>;
-}
-
-
-export class RenderTemplateOutputDTO {
-    @ApiProperty({ type: String })
-    @IsString()
-    @IsNotEmpty()
-    content: string;
-
-    @ApiProperty({ type: String })
-    @IsString()
-    @IsNotEmpty()
-    subject: string;
-}

package/src/lib/dto/template-filter.dto.ts

@@ -1,52 +0,0 @@
-import { IsEnum, IsOptional, IsString, IsArray } from 'class-validator';
-import { ApiProperty } from '@nestjs/swagger';
-import { TemplateTypeEnum } from '../interfaces/template.types';
-
-export class TemplateFilterDto {
-    @ApiProperty({
-        type: String,
-        required: false,
-        description: 'Filter by scope (e.g., system, tenant, organization)'
-    })
-    @IsString()
-    @IsOptional()
-    scope?: string;
-
-    @ApiProperty({
-        type: String,
-        required: false,
-        description: 'Filter by scope ID (e.g., tenant ID, organization ID)'
-    })
-    @IsString()
-    @IsOptional()
-    scopeId?: string;
-
-    @ApiProperty({
-        enum: TemplateTypeEnum,
-        required: false,
-        description: 'Filter by template type'
-    })
-    @IsEnum(TemplateTypeEnum)
-    @IsOptional()
-    type?: TemplateTypeEnum;
-
-    @ApiProperty({
-        type: String,
-        required: false,
-        description: 'Filter by locale (e.g., en, fr, es)'
-    })
-    @IsString()
-    @IsOptional()
-    locale?: string;
-
-    @ApiProperty({
-        type: [String],
-        required: false,
-        description: 'Exclude templates with these names'
-    })
-    @IsArray()
-    @IsString({ each: true })
-    @IsOptional()
-    excludeNames?: string[];
-
-}

package/src/lib/dto/template-layout-filter.dto.ts

@@ -1,51 +0,0 @@
-import { IsOptional, IsString, IsArray } from 'class-validator';
-import { ApiProperty } from '@nestjs/swagger';
-
-export class TemplateLayoutFilterDto {
-    @ApiProperty({
-        type: String,
-        required: false,
-        description: 'Filter by scope (e.g., system, tenant, organization)'
-    })
-    @IsString()
-    @IsOptional()
-    scope?: string;
-
-    @ApiProperty({
-        type: String,
-        required: false,
-        description: 'Filter by scope ID (e.g., tenant ID, organization ID)'
-    })
-    @IsString()
-    @IsOptional()
-    scopeId?: string;
-
-    @ApiProperty({
-        type: String,
-        required: false,
-        description: 'Filter by template type'
-    })
-    @IsString()
-    @IsOptional()
-    type?: string;
-
-    @ApiProperty({
-        type: String,
-        required: false,
-        description: 'Filter by locale (e.g., en, fr, es)'
-    })
-    @IsString()
-    @IsOptional()
-    locale?: string;
-
-    @ApiProperty({
-        type: [String],
-        required: false,
-        description: 'Exclude templates with these names'
-    })
-    @IsArray()
-    @IsString({ each: true })
-    @IsOptional()
-    excludeNames?: string[];
-
-}

package/src/lib/engines/language/html.engine.ts

@@ -1,49 +0,0 @@
-import { TemplateLanguageEnum } from '../../interfaces/template.types';
-import { LanguageEngine } from '../language-engine';
-
-export class HtmlEngine extends LanguageEngine {
-    static override engineName = TemplateLanguageEnum.HTML;
-
-    private options: any; // Using any for now since htmlparser2 types are causing issues
-
-    constructor(options?: any) {
-        super();
-        this.options = options;
-    }
-
-    async render(content: string): Promise<string> {
-        try {
-            // For HTML, we just return the content as is
-            // But we validate it first to ensure it's valid HTML
-            const isValid = await this.validate(content);
-            if (!isValid) {
-                throw new Error('Invalid HTML content');
-            }
-            return content;
-        } catch (error: any) {
-            throw new Error(`Failed to render HTML: ${error?.message || 'Unknown error'}`);
-        }
-    }
-
-    async validate(content: string): Promise<boolean> {
-        try {
-            const { Parser } = await import('htmlparser2');
-
-            return new Promise((resolve) => {
-                const parser = new Parser({
-                    onerror: () => {
-                        resolve(false);
-                    },
-                    onend: () => {
-                        resolve(true);
-                    }
-                }, this.options);
-
-                parser.write(content);
-                parser.end();
-            });
-        } catch (error) {
-            return false;
-        }
-    }
-}

package/src/lib/engines/language/markdown.engine.ts

@@ -1,37 +0,0 @@
-import { Injectable } from '@nestjs/common';
-import { TemplateLanguageEnum } from '../../interfaces/template.types';
-import { LanguageEngine } from '../language-engine';
-
-@Injectable()
-export class MarkdownEngine extends LanguageEngine {
-    static override engineName = TemplateLanguageEnum.MARKDOWN;
-
-    private options: any; // Using any for now since marked types are causing issues
-
-    constructor(options?: any) {
-        super();
-        this.options = options;
-    }
-
-    async render(content: string): Promise<string> {
-        // try {
-        //     const { marked } = await import('marked');
-        //     return marked(content, this.options);
-        // } catch (error: any) {
-        //     throw new Error(`Failed to render Markdown: ${error?.message || 'Unknown error'}`);
-        // }
-        return content;
-    }
-
-    async validate(content: string): Promise<boolean> {
-        // try {
-        //     const { marked } = await import('marked');
-        //     // Basic Markdown validation - check for common syntax errors
-        //     marked(content, this.options);
-        //     return true;
-        // } catch (error) {
-        //     return false;
-        // }
-        return true;
-    }
-}