lunisolar/src/class/stemBranch.ts

专业农历库，支持公历阴历互转，支持各类黄历数据查询，如八字四柱、阴历、神煞宜忌、时辰吉凶、建除十二神、胎神占方、五行纳音等。支持自定义插件。

import { HIDDEN_STEMS } from '../constants/calendarData'
import { Element5 } from './element5'
import { _GlobalConfig } from '../config'
import {
  getTrigramValueByStem,
  computeSBValue,
  parseCommonCreateClassValue,
  computeTriadE5Value,
  computeGroup6E5Value,
  computeMeetingE5Value
} from '../utils'
import { Trigram8 } from './trigram8'
import { cache } from '../utils/decorators'
import { CacheClass } from './CacheClass'

/**
 * 地支
 */
export class Branch extends CacheClass {
  readonly value: number = -1
  readonly _config: Required<ClassCommonConfig> = {
    lang: _GlobalConfig.lang
  }

  static getNames(lang?: string): string[] {
    lang = lang || _GlobalConfig.lang
    return [..._GlobalConfig.locales[lang].branchs]
  }
  static instances = new Map<string, Branch>()
  static create(value: number | string | Branch, config?: ClassCommonConfig): Branch {
    if (value instanceof Branch) return value
    const lang = config?.lang || _GlobalConfig.lang
    value = parseCommonCreateClassValue(value, 'branch', lang, _GlobalConfig)
    const instMapKey = `${value}:${lang}`
    if (Branch.instances.has(instMapKey)) return Branch.instances.get(instMapKey) as Branch
    const inst = new Branch(value, config)
    Branch.instances.set(instMapKey, inst)
    return inst
  }

  constructor(value: number | string | Branch, config?: ClassCommonConfig) {
    super()
    if (value instanceof Branch) return value
    if (config) {
      this._config = Object.assign({}, this._config, config)
    }
    this.value = parseCommonCreateClassValue(value, 'branch', this._config.lang, _GlobalConfig)
  }

  get name(): string {
    return _GlobalConfig.locales[this._config.lang].branchs[this.value]
  }

  @cache('branch:hiddenStems')
  get hiddenStems(): Stem[] {
    const hiddenStemsValue = HIDDEN_STEMS[this.value]
    return hiddenStemsValue.map(v => new Stem(v))
  }

  @cache('branch:e5')
  get e5(): Element5 {
    const i = Math.floor((this.value + 10) / 3) % 4
    if ((this.value + 10) % 3 === 2) {
      return Element5.create(2, this._config)
    } else {
      return Element5.create(i < 2 ? i : i + 1, this._config)
    }
  }

  /**
   * 三会
   */
  @cache('branch:meeting')
  get meeting(): [Branch, Branch] {
    const meetings = [
      [2, 3, 4],
      [5, 6, 7],
      [8, 9, 10],
      [11, 0, 1]
    ]
    const meeting = meetings.find(item => item.includes(this.value))!
    const result = meeting?.filter(item => item !== this.value)
    return [Branch.create(result[0], this._config), Branch.create(result[1], this._config)]
  }

  /**
   * 三会五行
   */
  get meetingE5(): Element5 {
    return Element5.create(computeMeetingE5Value(this.value), this._config)
  }

  /**
   * 三合
   */
  get triad(): [Branch, Branch] {
    return [
      Branch.create((this.value + 4) % 12, this._config),
      Branch.create((this.value + 8) % 12, this._config)
    ]
  }

  /**
   * 三合五行
   */
  get triadE5(): Element5 {
    return Element5.create(computeTriadE5Value(this.value), this._config)
  }

  /**
   * 六合
   */
  get group6(): Branch {
    return Branch.create((13 - this.value) % 12, this._config)
  }

  get group6E5(): Element5 {
    return Element5.create(computeGroup6E5Value(this.value), this._config)
  }

  // 相刑
  @cache('branch:punishing')
  get punishing(): Branch {
    const b = [3, 10, 5, 0, 4, 8, 6, 1, 2, 9, 7, 11]
    return Branch.create(b[this.value], this._config)
  }

  // 被刑
  @cache('branch:punishBy')
  get punishBy(): Branch {
    const b = [3, 7, 8, 0, 4, 2, 6, 10, 5, 9, 1, 11]
    return Branch.create(b[this.value], this._config)
  }

  // 相冲
  @cache('branch:conflict')
  get conflict(): Branch {
    return Branch.create((this.value + 6) % 12, this._config)
  }

  // 相破
  @cache('branch:destroying')
  get destroying(): Branch {
    const b = [9, 4, 11, 6, 1, 8, 3, 10, 5, 0, 7, 2]
    return Branch.create(b[this.value], this._config)
  }

  // 相害
  @cache('branch:harming')
  get harming(): Branch {
    const value = this.value > 7 ? 19 - this.value : 7 - this.value
    return Branch.create(value, this._config)
  }

  toString(): string {
    return this.name
  }

  valueOf(): number {
    return this.value
  }
}

/**
 * 天干
 */
export class Stem extends CacheClass {
  readonly value: number = -1
  readonly _config: Required<ClassCommonConfig> = {
    lang: _GlobalConfig.lang
  }

  static getNames(lang?: string): string[] {
    lang = lang || _GlobalConfig.lang
    return [..._GlobalConfig.locales[lang].stems]
  }

  static instances = new Map<string, Stem>()
  static create(value: number | string | Stem, config?: ClassCommonConfig): Stem {
    if (value instanceof Stem) return value
    const lang = config?.lang || _GlobalConfig.lang
    value = parseCommonCreateClassValue(value, 'stem', lang, _GlobalConfig)
    const instMapKey = `${value}:${lang}`
    if (Stem.instances.has(instMapKey)) return Stem.instances.get(instMapKey) as Stem
    const inst = new Stem(value, config)
    Stem.instances.set(instMapKey, inst)
    return inst
  }

  constructor(value: number | string | Stem, config?: ClassCommonConfig) {
    super()
    if (value instanceof Stem) return value
    if (config) {
      this._config = Object.assign({}, this._config, config)
    }
    this.value = parseCommonCreateClassValue(value, 'stem', this._config.lang, _GlobalConfig)
  }

  get name(): string {
    return _GlobalConfig.locales[this._config.lang].stems[this.value]
  }

  @cache('stem:branchs')
  get branchs(): Branch[] {
    const branchs = _GlobalConfig.locales[this._config.lang].branchs.filter(
      (_: string, index: number) => index % 2 === this.value % 2
    )
    return branchs.map((branch: string) => Branch.create(branch, this._config))
  }

  @cache('stem:e5')
  get e5(): Element5 {
    return Element5.create(Math.floor(this.value / 2), this._config)
  }

  get trigram8(): Trigram8 {
    return Trigram8.create(getTrigramValueByStem(this.value), this._config)
  }

  toString(): string {
    return this.name
  }

  valueOf(): number {
    return this.value
  }
}

/**
 * 天干地支组合
 */
export class SB {
  readonly stem: Stem
  readonly branch: Branch
  readonly value: number = -1
  readonly _config: Required<ClassCommonConfig> = {
    lang: _GlobalConfig.lang
  }

  static getNames(lang?: string): string[] {
    lang = lang || _GlobalConfig.lang
    const locale = _GlobalConfig.locales[lang]
    const res: string[] = new Array(60).fill('')
    return res.map((item, index) => {
      const stemValue = index % 10
      const branchValue = index % 12
      return (
        locale.stems[stemValue] + (locale?.stemBranchSeparator ?? '') + locale.branchs[branchValue]
      )
    })
  }

  static instances = new Map<string, SB>()
  static create(value: number | SB, config?: ClassCommonConfig): SB {
    if (value instanceof SB) return value
    const lang = config?.lang || _GlobalConfig.lang
    const instMapKey = `${value}:${lang}`
    if (SB.instances.has(instMapKey)) return SB.instances.get(instMapKey) as SB
    const inst = new SB(value, undefined, config)
    SB.instances.set(instMapKey, inst)
    return inst
  }

  constructor(
    stemOrValue: number | string | Stem,
    branch?: number | string | Branch,
    config?: ClassCommonConfig
  ) {
    if (config) {
      this._config = Object.assign({}, this._config, config)
    }
    if (typeof branch === 'number' || typeof branch === 'string' || branch instanceof Branch) {
      this.stem = Stem.create(stemOrValue, this._config)
      this.branch = Branch.create(branch, this._config)
      const stemValue = this.stem.valueOf(),
        branchValue = this.branch.valueOf()
      // 如果一个为奇数一个为偶数，则不能组合
      this.value = computeSBValue(stemValue, branchValue)
    } else if (typeof stemOrValue === 'number') {
      this.value = stemOrValue % 60
      const stemValue = this.value % 10
      const branchValue = this.value % 12
      this.stem = Stem.create(stemValue, this._config)
      this.branch = Branch.create(branchValue, this._config)
    } else {
      throw new Error('Invalid SB value')
    }
  }

  get missing(): [Branch, Branch] {
    const bV = (5 - Math.floor(this.value / 10)) * 2
    return [Branch.create(bV, this._config), Branch.create(bV + 1, this._config)]
  }

  get name(): string {
    const locale = _GlobalConfig.locales[this._config.lang]
    return `${this.stem}${locale?.stemBranchSeparator ?? ''}${this.branch}`
  }

  toString(): string {
    return this.name
  }

  valueOf(): number {
    return this.value
  }
}