@k-msg/template 0.1.0 → 0.1.2

package/README.md

@@ -21,27 +21,23 @@ bun add @k-msg/template @k-msg/core
 ## Basic Usage
 
 ```typescript
-import { TemplateService, TemplateValidator } from '@k-msg/template';
+import { TemplateService } from '@k-msg/template';
+import { IWINVAdapter } from '@k-msg/provider';
 
-const templateService = new TemplateService();
+const adapter = new IWINVAdapter(config);
+const templateService = new TemplateService(adapter);
 
 // Create a new template
-const template = await templateService.create({
+const result = await templateService.create({
+  code: 'OTP_001',
   name: 'OTP Verification',
-  content: '[MyApp] Your verification code is #{code}. Valid for 10 minutes.',
-  category: 'AUTHENTICATION',
-  variables: ['code']
+  content: '[MyApp] Your verification code is #{code}.',
+  category: 'AUTHENTICATION'
 });
 
-// Validate template
-const validator = new TemplateValidator();
-const validation = validator.validate(template.content);
-
-if (validation.isValid) {
-  console.log('Template is valid');
-  console.log('Variables found:', validation.variables);
-} else {
-  console.log('Validation errors:', validation.errors);
+if (result.isSuccess) {
+  const template = result.value;
+  console.log('Template created:', template.id);
 }
 ```
 

package/dist/builder/template.builder.d.ts

@@ -0,0 +1,139 @@
+/**
+ * Template Builder - Fluent API for creating AlimTalk templates
+ */
+import { type AlimTalkTemplate, type TemplateButton, TemplateCategory, TemplateStatus } from "../types/template.types";
+export declare class TemplateBuilder {
+    private template;
+    /**
+     * Set template name
+     */
+    name(name: string): TemplateBuilder;
+    /**
+     * Set template code (provider specific)
+     */
+    code(code: string): TemplateBuilder;
+    /**
+     * Set template content with variables
+     */
+    content(content: string): TemplateBuilder;
+    /**
+     * Set template category
+     */
+    category(category: TemplateCategory): TemplateBuilder;
+    /**
+     * Set template provider
+     */
+    provider(provider: string): TemplateBuilder;
+    /**
+     * Set template status
+     */
+    status(status: TemplateStatus): TemplateBuilder;
+    /**
+     * Add a variable definition
+     */
+    variable(name: string, type?: "string" | "number" | "date" | "custom", required?: boolean, options?: {
+        maxLength?: number;
+        format?: string;
+        description?: string;
+        example?: string;
+    }): TemplateBuilder;
+    /**
+     * Add multiple variables at once
+     */
+    variables(variables: Array<{
+        name: string;
+        type?: "string" | "number" | "date" | "custom";
+        required?: boolean;
+        maxLength?: number;
+        format?: string;
+        description?: string;
+        example?: string;
+    }>): TemplateBuilder;
+    /**
+     * Add a web link button
+     */
+    webLinkButton(name: string, mobileUrl?: string, pcUrl?: string): TemplateBuilder;
+    /**
+     * Add an app link button
+     */
+    appLinkButton(name: string, options: {
+        iosUrl?: string;
+        androidUrl?: string;
+        iosScheme?: string;
+        androidScheme?: string;
+    }): TemplateBuilder;
+    /**
+     * Add a delivery tracking button
+     */
+    deliveryButton(name: string): TemplateBuilder;
+    /**
+     * Add a bot keyword button
+     */
+    botKeywordButton(name: string): TemplateBuilder;
+    /**
+     * Add a message delivery button
+     */
+    messageDeliveryButton(name: string): TemplateBuilder;
+    /**
+     * Add a custom button
+     */
+    button(button: TemplateButton): TemplateBuilder;
+    /**
+     * Clear all buttons
+     */
+    clearButtons(): TemplateBuilder;
+    /**
+     * Set template metadata
+     */
+    metadata(metadata: Partial<AlimTalkTemplate["metadata"]>): TemplateBuilder;
+    /**
+     * Validate the current template
+     */
+    validate(): {
+        isValid: boolean;
+        errors: string[];
+        warnings: string[];
+    };
+    /**
+     * Preview the template with sample variables
+     */
+    preview(sampleVariables?: Record<string, any>): string;
+    /**
+     * Generate sample variables based on variable definitions
+     */
+    private generateSampleVariables;
+    /**
+     * Clone the current builder
+     */
+    clone(): TemplateBuilder;
+    /**
+     * Reset the builder to start fresh
+     */
+    reset(): TemplateBuilder;
+    /**
+     * Build the final template
+     */
+    build(): AlimTalkTemplate;
+    private generateTemplateId;
+}
+/**
+ * Static factory methods for common template types
+ */
+export declare const TemplateBuilders: {
+    /**
+     * Create an authentication template builder
+     */
+    authentication(name: string, provider: string): TemplateBuilder;
+    /**
+     * Create a notification template builder
+     */
+    notification(name: string, provider: string): TemplateBuilder;
+    /**
+     * Create a promotion template builder
+     */
+    promotion(name: string, provider: string): TemplateBuilder;
+    /**
+     * Create a payment template builder
+     */
+    payment(name: string, provider: string): TemplateBuilder;
+};

package/dist/index.d.ts

@@ -1,463 +1,14 @@
-import { EventEmitter } from 'events';
-
-declare enum TemplateType {
-    ALIMTALK = "ALIMTALK",
-    SMS = "SMS",
-    LMS = "LMS",
-    MMS = "MMS",
-    RCS = "RCS"
-}
-declare enum TemplateCategory {
-    AUTHENTICATION = "AUTHENTICATION",// 인증
-    NOTIFICATION = "NOTIFICATION",// 알림
-    PROMOTION = "PROMOTION",// 프로모션
-    INFORMATION = "INFORMATION",// 정보성
-    RESERVATION = "RESERVATION",// 예약
-    SHIPPING = "SHIPPING",// 배송
-    PAYMENT = "PAYMENT"
-}
-declare enum TemplateStatus {
-    DRAFT = "DRAFT",// 초안
-    PENDING = "PENDING",// 검수 중
-    APPROVED = "APPROVED",// 승인됨
-    REJECTED = "REJECTED",// 반려됨
-    DISABLED = "DISABLED"
-}
-interface TemplateVariable {
-    name: string;
-    type: 'string' | 'number' | 'date' | 'custom';
-    required: boolean;
-    maxLength?: number;
-    format?: string;
-    description?: string;
-    example?: string;
-}
-interface TemplateButton {
-    type: 'WL' | 'AL' | 'DS' | 'BK' | 'MD';
-    name: string;
-    linkMobile?: string;
-    linkPc?: string;
-    linkIos?: string;
-    linkAndroid?: string;
-    schemeIos?: string;
-    schemeAndroid?: string;
-}
-interface AlimTalkTemplate {
-    id: string;
-    code: string;
-    name: string;
-    content: string;
-    variables: TemplateVariable[];
-    buttons?: TemplateButton[];
-    category: TemplateCategory;
-    status: TemplateStatus;
-    provider: string;
-    metadata: {
-        createdAt: Date;
-        updatedAt: Date;
-        approvedAt?: Date;
-        rejectedAt?: Date;
-        rejectionReason?: string;
-        usage: {
-            sent: number;
-            delivered: number;
-            failed: number;
-        };
-    };
-}
-
-declare class TemplateService {
-    private templates;
-    createTemplate(template: Omit<AlimTalkTemplate, 'id' | 'metadata'>): Promise<AlimTalkTemplate>;
-    getTemplate(templateId: string): Promise<AlimTalkTemplate | null>;
-    updateTemplate(templateId: string, updates: Partial<AlimTalkTemplate>): Promise<AlimTalkTemplate>;
-    deleteTemplate(templateId: string): Promise<void>;
-    renderTemplate(templateId: string, variables: Record<string, any>): Promise<string>;
-    private generateTemplateId;
-}
-
-declare class VariableParser {
-    private static readonly VARIABLE_PATTERN;
-    /**
-     * 템플릿 내용에서 변수를 추출합니다
-     */
-    static extractVariables(content: string): string[];
-    /**
-     * 템플릿 내용의 변수를 실제 값으로 치환합니다
-     */
-    static replaceVariables(content: string, variables: Record<string, string | number | Date>): string;
-    /**
-     * 변수 정의와 실제 제공된 값을 검증합니다
-     */
-    static validateVariables(variableDefinitions: TemplateVariable[], providedVariables: Record<string, any>): {
-        isValid: boolean;
-        errors: string[];
-    };
-    private static validateVariableType;
-    /**
-     * 템플릿에서 사용된 변수와 정의된 변수의 일치성을 검사합니다
-     */
-    static validateTemplateVariables(content: string, variableDefinitions: TemplateVariable[]): {
-        isValid: boolean;
-        errors: string[];
-    };
-}
-
-declare class ButtonParser {
-    /**
-     * 버튼 설정의 유효성을 검증합니다
-     */
-    static validateButtons(buttons: TemplateButton[]): {
-        isValid: boolean;
-        errors: string[];
-    };
-    private static validateButtonByType;
-    private static validateWebLinkButton;
-    private static validateAppLinkButton;
-    private static validateDeliveryButton;
-    private static validateBotKeywordButton;
-    private static validateMessageDeliveryButton;
-    private static isValidUrl;
-    /**
-     * 버튼을 JSON 문자열로 직렬화합니다 (카카오 API 형식)
-     */
-    static serializeButtons(buttons: TemplateButton[]): string;
-    /**
-     * JSON 문자열에서 버튼 배열로 역직렬화합니다
-     */
-    static deserializeButtons(buttonsJson: string): TemplateButton[];
-}
-
-interface ValidationResult {
-    isValid: boolean;
-    errors: string[];
-    warnings: string[];
-}
-declare class TemplateValidator {
-    /**
-     * 알림톡 템플릿의 전체적인 유효성을 검증합니다
-     */
-    static validate(template: AlimTalkTemplate): ValidationResult;
-    private static validateBasicFields;
-    private static validateContent;
-    private static containsProhibitedCharacters;
-    private static validateUrlsInContent;
-    private static validateByCategory;
-    private static validateAuthenticationTemplate;
-    private static validatePromotionTemplate;
-    private static validatePaymentTemplate;
-    /**
-     * 빠른 검증 - 기본적인 필수 필드만 검사
-     */
-    static quickValidate(template: Partial<AlimTalkTemplate>): ValidationResult;
-}
-
 /**
- * Template Builder - Fluent API for creating AlimTalk templates
+ * Template Engine
+ * 템플릿 파싱, 변수 치환, 검증 기능 제공
  */
-
-declare class TemplateBuilder {
-    private template;
-    /**
-     * Set template name
-     */
-    name(name: string): TemplateBuilder;
-    /**
-     * Set template code (provider specific)
-     */
-    code(code: string): TemplateBuilder;
-    /**
-     * Set template content with variables
-     */
-    content(content: string): TemplateBuilder;
-    /**
-     * Set template category
-     */
-    category(category: TemplateCategory): TemplateBuilder;
-    /**
-     * Set template provider
-     */
-    provider(provider: string): TemplateBuilder;
-    /**
-     * Set template status
-     */
-    status(status: TemplateStatus): TemplateBuilder;
-    /**
-     * Add a variable definition
-     */
-    variable(name: string, type?: 'string' | 'number' | 'date' | 'custom', required?: boolean, options?: {
-        maxLength?: number;
-        format?: string;
-        description?: string;
-        example?: string;
-    }): TemplateBuilder;
-    /**
-     * Add multiple variables at once
-     */
-    variables(variables: Array<{
-        name: string;
-        type?: 'string' | 'number' | 'date' | 'custom';
-        required?: boolean;
-        maxLength?: number;
-        format?: string;
-        description?: string;
-        example?: string;
-    }>): TemplateBuilder;
-    /**
-     * Add a web link button
-     */
-    webLinkButton(name: string, mobileUrl?: string, pcUrl?: string): TemplateBuilder;
-    /**
-     * Add an app link button
-     */
-    appLinkButton(name: string, options: {
-        iosUrl?: string;
-        androidUrl?: string;
-        iosScheme?: string;
-        androidScheme?: string;
-    }): TemplateBuilder;
-    /**
-     * Add a delivery tracking button
-     */
-    deliveryButton(name: string): TemplateBuilder;
-    /**
-     * Add a bot keyword button
-     */
-    botKeywordButton(name: string): TemplateBuilder;
-    /**
-     * Add a message delivery button
-     */
-    messageDeliveryButton(name: string): TemplateBuilder;
-    /**
-     * Add a custom button
-     */
-    button(button: TemplateButton): TemplateBuilder;
-    /**
-     * Clear all buttons
-     */
-    clearButtons(): TemplateBuilder;
-    /**
-     * Set template metadata
-     */
-    metadata(metadata: Partial<AlimTalkTemplate['metadata']>): TemplateBuilder;
-    /**
-     * Validate the current template
-     */
-    validate(): {
-        isValid: boolean;
-        errors: string[];
-        warnings: string[];
-    };
-    /**
-     * Preview the template with sample variables
-     */
-    preview(sampleVariables?: Record<string, any>): string;
-    /**
-     * Generate sample variables based on variable definitions
-     */
-    private generateSampleVariables;
-    /**
-     * Clone the current builder
-     */
-    clone(): TemplateBuilder;
-    /**
-     * Reset the builder to start fresh
-     */
-    reset(): TemplateBuilder;
-    /**
-     * Build the final template
-     */
-    build(): AlimTalkTemplate;
-    private generateTemplateId;
-}
-/**
- * Static factory methods for common template types
- */
-declare const TemplateBuilders: {
-    /**
-     * Create an authentication template builder
-     */
-    authentication(name: string, provider: string): TemplateBuilder;
-    /**
-     * Create a notification template builder
-     */
-    notification(name: string, provider: string): TemplateBuilder;
-    /**
-     * Create a promotion template builder
-     */
-    promotion(name: string, provider: string): TemplateBuilder;
-    /**
-     * Create a payment template builder
-     */
-    payment(name: string, provider: string): TemplateBuilder;
-};
-
-/**
- * Template Registry - Manages templates across providers and categories
- */
-
-interface TemplateSearchFilters {
-    provider?: string;
-    category?: TemplateCategory;
-    status?: TemplateStatus;
-    nameContains?: string;
-    codeContains?: string;
-    createdAfter?: Date;
-    createdBefore?: Date;
-    usageMin?: number;
-    usageMax?: number;
-}
-interface TemplateSearchOptions {
-    page?: number;
-    limit?: number;
-    sortBy?: 'name' | 'code' | 'createdAt' | 'updatedAt' | 'usage';
-    sortOrder?: 'asc' | 'desc';
-}
-interface TemplateSearchResult {
-    templates: AlimTalkTemplate[];
-    total: number;
-    page: number;
-    limit: number;
-    hasMore: boolean;
-}
-interface TemplateVersion {
-    version: number;
-    template: AlimTalkTemplate;
-    changes: string[];
-    createdAt: Date;
-    createdBy?: string;
-}
-interface TemplateHistory {
-    templateId: string;
-    versions: TemplateVersion[];
-    currentVersion: number;
-}
-interface TemplateUsageStats {
-    templateId: string;
-    totalSent: number;
-    totalDelivered: number;
-    totalFailed: number;
-    deliveryRate: number;
-    failureRate: number;
-    lastUsed?: Date;
-    usageByDay: Array<{
-        date: string;
-        sent: number;
-        delivered: number;
-        failed: number;
-    }>;
-}
-interface TemplateRegistryOptions {
-    enableVersioning: boolean;
-    maxVersionsPerTemplate: number;
-    enableUsageTracking: boolean;
-    enableAutoBackup: boolean;
-    backupInterval: number;
-    enableValidationOnRegister: boolean;
-}
-declare class TemplateRegistry extends EventEmitter {
-    private options;
-    private templates;
-    private templatesByCode;
-    private templatesByProvider;
-    private templatesByCategory;
-    private templateHistories;
-    private usageStats;
-    private backupTimer?;
-    private defaultOptions;
-    constructor(options?: Partial<TemplateRegistryOptions>);
-    /**
-     * Register a new template
-     */
-    register(template: AlimTalkTemplate): Promise<void>;
-    /**
-     * Update an existing template
-     */
-    update(templateId: string, updates: Partial<AlimTalkTemplate>): Promise<AlimTalkTemplate>;
-    /**
-     * Get template by ID
-     */
-    get(templateId: string): AlimTalkTemplate | null;
-    /**
-     * Get template by code and provider
-     */
-    getByCode(code: string, provider: string): AlimTalkTemplate | null;
-    /**
-     * Search templates with filters and pagination
-     */
-    search(filters?: TemplateSearchFilters, options?: TemplateSearchOptions): TemplateSearchResult;
-    /**
-     * Get templates by provider
-     */
-    getByProvider(provider: string): AlimTalkTemplate[];
-    /**
-     * Get templates by category
-     */
-    getByCategory(category: TemplateCategory): AlimTalkTemplate[];
-    /**
-     * Delete template
-     */
-    delete(templateId: string): Promise<boolean>;
-    /**
-     * Get template version history
-     */
-    getHistory(templateId: string): TemplateHistory | null;
-    /**
-     * Get specific template version
-     */
-    getVersion(templateId: string, version: number): AlimTalkTemplate | null;
-    /**
-     * Restore template to a specific version
-     */
-    restoreVersion(templateId: string, version: number): Promise<AlimTalkTemplate>;
-    /**
-     * Get template usage statistics
-     */
-    getUsageStats(templateId: string): TemplateUsageStats | null;
-    /**
-     * Update template usage statistics
-     */
-    updateUsageStats(templateId: string, stats: {
-        sent?: number;
-        delivered?: number;
-        failed?: number;
-    }): void;
-    /**
-     * Get registry statistics
-     */
-    getStats(): {
-        totalTemplates: number;
-        byProvider: Record<string, number>;
-        byCategory: Record<string, number>;
-        byStatus: Record<string, number>;
-    };
-    /**
-     * Export templates to JSON
-     */
-    export(filters?: TemplateSearchFilters): string;
-    /**
-     * Import templates from JSON
-     */
-    import(jsonData: string, options?: {
-        overwrite?: boolean;
-    }): Promise<{
-        imported: number;
-        skipped: number;
-        errors: string[];
-    }>;
-    /**
-     * Clear all templates (use with caution!)
-     */
-    clear(): void;
-    /**
-     * Stop the registry and cleanup
-     */
-    destroy(): void;
-    private updateIndexes;
-    private initializeVersionHistory;
-    private addVersionToHistory;
-    private initializeUsageStats;
-    private startAutoBackup;
-}
-
-export { type AlimTalkTemplate, ButtonParser, TemplateBuilder, TemplateBuilders, type TemplateButton, TemplateCategory, type TemplateHistory, TemplateRegistry, type TemplateRegistryOptions, type TemplateSearchFilters, type TemplateSearchOptions, type TemplateSearchResult, TemplateService, TemplateStatus, TemplateType, type TemplateUsageStats, TemplateValidator, type TemplateVariable, type TemplateVersion, type ValidationResult, VariableParser };
+export { TemplateBuilder, TemplateBuilders } from "./builder/template.builder";
+export { interpolate } from "./interpolator";
+export { ButtonParser } from "./parser/button.parser";
+export { TemplateValidator, type ValidationResult } from "./parser/validator";
+export { VariableParser } from "./parser/variable.parser";
+export { type TemplateHistory, TemplateRegistry, type TemplateRegistryOptions, type TemplateSearchFilters, type TemplateSearchOptions, type TemplateSearchResult, type TemplateUsageStats, type TemplateVersion, } from "./registry/template.registry";
+export { TemplateService } from "./service";
+export { TemplateService as MockTemplateService } from "./services/template.service";
+export type { AlimTalkTemplate, TemplateButton, TemplateVariable, } from "./types/template.types";
+export { TemplateCategory, TemplateStatus, TemplateType, } from "./types/template.types";