All files / src/domains/mdm/application/services number-series.service.ts

0% Statements 0/103
0% Branches 0/80
0% Functions 0/11
0% Lines 0/97

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   
import {
  Injectable,
  Logger,
  NotFoundException,
  BadRequestException,
} from '@nestjs/common';
import { InjectModel } from '@nestjs/mongoose';
import { Model } from 'mongoose';
import {
  NumberSeriesDefinition,
  NumberSeriesVersion,
  NumberSeriesSequence,
  NumberSeriesReservation,
} from '../../infrastructure/schemas/number-series.schema';
import { NumberSeriesGenerator } from '../../domain/interfaces/master-data-provider.interface';
import { CacheService } from '../../../../platform/cache/cache.service';
 
@Injectable()
export class NumberSeriesService implements NumberSeriesGenerator {
  private readonly logger = new Logger(NumberSeriesService.name);
 
  constructor(
    @InjectModel(NumberSeriesDefinition.name)
    private readonly defModel: Model<NumberSeriesDefinition>,
    @InjectModel(NumberSeriesVersion.name)
    private readonly versionModel: Model<NumberSeriesVersion>,
    @InjectModel(NumberSeriesSequence.name)
    private readonly seqModel: Model<NumberSeriesSequence>,
    @InjectModel(NumberSeriesReservation.name)
    private readonly reservationModel: Model<NumberSeriesReservation>,
    private readonly cache: CacheService,
  ) {}
 
  // ────────────────────────────────────────────────────────────────
  // DEFINITION CRUD
  // ────────────────────────────────────────────────────────────────
 
  async createDefinition(params: {
    seriesCode: string;
    seriesName: string;
    description?: string;
    entityTypeKey: string;
    prefix: string;
    suffix?: string;
    includeDateToken?: boolean;
    dateTokenFormat?: string;
    sequenceDigits?: number;
    separator?: string;
    resetCycle: string;
    branchSpecific?: boolean;
    tenantSpecific?: boolean;
    tenantId?: string;
  }): Promise<any> {
    const def = await this.defModel.create({
      ...params,
      status: 'active',
    });
    return def.toObject();
  }
 
  async listDefinitions(
    entityTypeKey?: string,
    tenantId?: string,
  ): Promise<any[]> {
    const query: any = { status: { $ne: 'deprecated' } };
    if (entityTypeKey) query.entityTypeKey = entityTypeKey;
    if (tenantId) query.$or = [{ tenantId }, { tenantId: null }];
    return this.defModel.find(query).sort({ seriesCode: 1 }).lean().exec();
  }
 
  // ────────────────────────────────────────────────────────────────
  // GENERATE NEXT (atomic — concurrency safe)
  // ────────────────────────────────────────────────────────────────
 
  async generateNext(
    seriesCode: string,
    context: { tenantId?: string; branchId?: string; fiscalYear?: string },
  ): Promise<string> {
    // 1. Load definition
    const def = await this.getDefinition(seriesCode, context.tenantId);
    if (!def)
      throw new NotFoundException(`Number series not found: ${seriesCode}`);
 
    // 2. Compute cycle key
    const cycleKey = this.computeCycleKey(def);
    const scopeKey = this.computeScopeKey(def, context);
 
    // 3. Atomic increment
    const seq = await this.seqModel.findOneAndUpdate(
      { seriesCode, cycleKey, scopeKey },
      {
        $inc: { lastNumber: 1, nextNumber: 1 },
        $set: { lastGeneratedAt: new Date() },
        $setOnInsert: { seriesCode, cycleKey, scopeKey },
      },
      { upsert: true, new: true, returnDocument: 'after' },
    );
 
    // 4. Format the generated value
    const formatted = this.formatNumber(
      def,
      seq.lastNumber,
      cycleKey,
      scopeKey,
    );
 
    // 5. Update lastGeneratedValue for quick reference
    await this.seqModel.updateOne(
      { _id: seq._id },
      { $set: { lastGeneratedValue: formatted } },
    );
 
    this.logger.debug(`Generated: ${seriesCode} → ${formatted}`);
    return formatted;
  }
 
  // ────────────────────────────────────────────────────────────────
  // RESERVE BLOCK (for bulk imports)
  // ────────────────────────────────────────────────────────────────
 
  async reserveBlock(
    seriesCode: string,
    blockSize: number,
    context: {
      tenantId?: string;
      branchId?: string;
      fiscalYear?: string;
      purpose?: string;
    },
  ): Promise<{ from: number; to: number; prefix: string }> {
    if (blockSize < 1 || blockSize > 10000) {
      throw new BadRequestException('Block size must be between 1 and 10000');
    }
 
    const def = await this.getDefinition(seriesCode, context.tenantId);
    if (!def)
      throw new NotFoundException(`Number series not found: ${seriesCode}`);
 
    const cycleKey = this.computeCycleKey(def);
    const scopeKey = this.computeScopeKey(def, context);
 
    // Atomic reserve
    const seq = await this.seqModel.findOneAndUpdate(
      { seriesCode, cycleKey, scopeKey },
      {
        $inc: { lastNumber: blockSize, nextNumber: blockSize },
        $set: { lastGeneratedAt: new Date() },
        $setOnInsert: { seriesCode, cycleKey, scopeKey },
      },
      { upsert: true, new: true, returnDocument: 'after' },
    );
 
    const fromNumber = seq.lastNumber - blockSize + 1;
    const toNumber = seq.lastNumber;
 
    // Record reservation
    await this.reservationModel.create({
      seriesCode,
      cycleKey,
      scopeKey,
      fromNumber,
      toNumber,
      blockSize,
      status: 'reserved',
      purpose: context.purpose || 'bulk_operation',
      expiresAt: new Date(Date.now() + 24 * 60 * 60 * 1000), // 24h expiry
    });
 
    const prefix = this.compilePrefix(def, cycleKey);
    this.logger.log(
      `Reserved block: ${seriesCode} [${fromNumber}-${toNumber}]`,
    );
    return { from: fromNumber, to: toNumber, prefix };
  }
 
  // ────────────────────────────────────────────────────────────────
  // PEEK (non-destructive)
  // ────────────────────────────────────────────────────────────────
 
  async peekNext(
    seriesCode: string,
    context: { tenantId?: string; branchId?: string },
  ): Promise<string> {
    const def = await this.getDefinition(seriesCode, context.tenantId);
    if (!def)
      throw new NotFoundException(`Number series not found: ${seriesCode}`);
 
    const cycleKey = this.computeCycleKey(def);
    const scopeKey = this.computeScopeKey(def, context);
 
    const seq = await this.seqModel
      .findOne({ seriesCode, cycleKey, scopeKey })
      .lean()
      .exec();
    const nextNumber = seq ? seq.lastNumber + 1 : 1;
 
    return this.formatNumber(def, nextNumber, cycleKey, scopeKey);
  }
 
  // ────────────────────────────────────────────────────────────────
  // PRIVATE HELPERS
  // ────────────────────────────────────────────────────────────────
 
  private async getDefinition(
    seriesCode: string,
    tenantId?: string,
  ): Promise<any> {
    // Tenant-specific first, then global
    if (tenantId) {
      const tenantDef = await this.defModel
        .findOne({ seriesCode, tenantId, status: 'active' })
        .lean()
        .exec();
      if (tenantDef) return tenantDef;
    }
    return this.defModel
      .findOne({ seriesCode, tenantId: null, status: 'active' })
      .lean()
      .exec();
  }
 
  private computeCycleKey(def: any): string {
    const now = new Date();
    switch (def.resetCycle) {
      case 'annual':
        return now.getFullYear().toString();
      case 'monthly':
        return `${now.getFullYear()}-${String(now.getMonth() + 1).padStart(2, '0')}`;
      case 'fiscal_year': {
        // Indian FY: Apr to Mar
        const month = now.getMonth();
        const year = now.getFullYear();
        const fyStart = month >= 3 ? year : year - 1;
        return `FY${fyStart}-${(fyStart + 1).toString().slice(-2)}`;
      }
      case 'global':
        return 'GLOBAL';
      default:
        return 'GLOBAL';
    }
  }
 
  private computeScopeKey(
    def: any,
    context: { tenantId?: string; branchId?: string },
  ): string {
    const parts: string[] = [];
    if (def.tenantSpecific && context.tenantId)
      parts.push(`T:${context.tenantId}`);
    if (def.branchSpecific && context.branchId)
      parts.push(`B:${context.branchId}`);
    return parts.length ? parts.join('|') : 'GLOBAL';
  }
 
  private compilePrefix(def: any, cycleKey: string): string {
    let prefix = def.prefix || '';
 
    if (def.includeDateToken && def.dateTokenFormat) {
      const now = new Date();
      let token = '';
      switch (def.dateTokenFormat) {
        case 'YYYY':
          token = now.getFullYear().toString();
          break;
        case 'YY':
          token = now.getFullYear().toString().slice(-2);
          break;
        case 'YYYY-MM':
          token = `${now.getFullYear()}-${String(now.getMonth() + 1).padStart(2, '0')}`;
          break;
        case 'MM':
          token = String(now.getMonth() + 1).padStart(2, '0');
          break;
        case 'FY':
          token = cycleKey;
          break;
        case 'FY-SHORT':
          token = cycleKey.replace('FY', '');
          break;
        default:
          token = cycleKey;
      }
      prefix = `${prefix}${def.separator || '-'}${token}`;
    }
 
    return prefix;
  }
 
  private formatNumber(
    def: any,
    number: number,
    cycleKey: string,
    scopeKey: string,
  ): string {
    const prefix = this.compilePrefix(def, cycleKey);
    const digits = def.sequenceDigits || 4;
    const paddedNumber = String(number).padStart(digits, '0');
    const separator = def.separator || '-';
 
    let result = `${prefix}${separator}${paddedNumber}`;
    if (def.suffix) result += `${separator}${def.suffix}`;
 
    return result;
  }
}