採番機能について任意の月を開始月とする年度でローテーションできる機能が欲しい

[koichimurakami]

現状 sequence パッケージにおいて rotate_by に指定出来る値として fiscal_yearly があるが4月開始となっている。
現状日本の法人では事業年度の開始日は任意であるため、採番機能としても任意の日付から事業年度を計算してほしい。

[koichimurakami]

事業年度を〇〇期で返却したいケースもあるので、2024年度=2024年4月〜2025年3月だけではなく、第20期=2024年4月〜2025年3月といった計算をしたい。第1期は会社設立初年度等を想定しているので、企業毎に日付から任意の数値を返却できるように関数を設定出来るのが良いと思う。

[quangquandev]

@koichimurakami
以下のインターフェースを使用して、シーケンスサービスを実装する予定です。

export interface ISequenceService {
  /**
   * Get the current sequence by a specific key.
   * @param key - The key to identify the sequence details.
   * @returns A promise that resolves to the current sequence's data entity.
   */
  getCurrentSequence(key: DetailKey): Promise<DataEntity>

  /**
   * Generate a new sequence based on the provided parameters.
   * @param dto - The data transfer object containing generation parameters.
   * @param opts - Additional options including invocation context.
   * @returns A promise that resolves to the newly generated sequence's data entity.
   */
  genNewSequence(
    dto: GenSequenceDto,
    opts: {
      invokeContext: IInvoke
    },
  ): Promise<DataEntity>

  /**
   * Generate a new sequence with a specified format.
   * @param dto - The data transfer object containing parameters for formatted sequence generation.
   * @param opts - Additional options including invocation context.
   * @returns A promise that resolves to the newly generated formatted sequence's data entity.
   */
  generateFormattedSequence(
    dto: GenerateFormattedSequenceDto,
    opts: {
      invokeContext: IInvoke
    },
  ): Promise<DataEntity>
}

最初の2つのメソッドは以前のバージョンで既に実装されており、generateFormattedSequenceは新しい関数になります。

[quangquandev]

@koichimurakami
こちらの返却データの定義です。

 const mockResponse = {
        code: "TODO#TASK1#S#2024",
        updatedBy: "92ca4f68-9ac6-4080-9ae2-2f02a86206a4",
        createdIp: "127.0.0.1",
        tenantCode: tenantCode,
        type: "TODO",
        createdAt: "2024-11-08T13:50:26+07:00",
        updatedIp: "127.0.0.1",
        createdBy: "92ca4f68-9ac6-4080-9ae2-2f02a86206a4",
        requestId: "81bf1821-34b0-4dc5-a2ce-685d37d22f8c",
        name: "fiscal_yearly",
        sk: "TODO#TASK1#S＃2024",
        attributes: {
          fiscal_year: 71,
          issued_at: "2024-11-08T13:50:26+07:00",
          formatted_no: "00TASK1-71-S-001",
          no:1
        },
        pk: "SEQ#MBC",
        seq: 1,
        updatedAt: "2024-11-08T13:50:26+07:00"
      }

[quangquandev]

@quangquandev

本件ですが、 マスタ関連をパッケージ化したいと考えています。 マスタパッケージを注入したらそこからデータを取得し、そうでなければ関数から取得する事って出来ますか？ 関数を上書きすれば動作も変更出来れば良いのかなと考えていますが、いかがでしょうか？

それなら、シーケンスで使用できるように、マスターパッケージをmbc-framwork内に作成する必要があります。
#52

[koichimurakami]

@quangquandev
返却データですが、DynamoDBのデータをそのまま返却するのは止めましょう。 seq が採番された数値だと勘違いする可能性があります。

下記の様な返却データはいかがですか？

{
  "id": "採番のID DynamoDBのID(文字列型)",
  "no": "採番された番号(数値型)",
  "formattedNo": "フォーマットされた番号(文字列型)",
  "issuedAt": "採番した日時または、基準日時"
}

[koichimurakami]

@quangquandev

それなら、シーケンスで使用できるように、マスターパッケージをmbc-framwork内に作成する必要があります。

いえ、これはどうしてもパッケージにしたいです。パッケージをインストールしている場合としていない場合の両方をシーケンス側の実装をする必要があるかもしれないです。
どちらの場合も同じメソッドで同じインターフェースを使うように設計してほしいです。
インターフェースのみCoreにあっても良いかもしれません。

[quangquandev]

@koichimurakami
お疲れ様です
typeCodeとcode1〜5の合計6個指定出来るように修正しました。
このプルを確認お願い致します
#78

[koichimurakami]

Document: https://mbc-cqrs-serverless.mbc-net.com/docs/sequence/
Document in Japanese: https://mbc-cqrs-serverless.mbc-net.com/ja/docs/sequence/