proto: 一日未満の勤怠記録のデータ設計を改善 以前のままでは半日公休+半日出勤&時間単位年休といった記録が つけられなかった。オフラインで議論を重ねてこの形なら汎用性 とシンプル性が保てるという結論に達したものをコードにした。

Changes

12 changed files (+238/-8)

• packages/proto/yamori/work_record/v1/halved_record.proto (new)
  • @@ -0,0 +1,16 @@
    + // SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com> + // SPDX-License-Identifier: AGPL-3.0-only + + edition = "2023"; + + package yamori.work_record.v1; + + import "yamori/work_record/v1/record_kind.proto"; + + message HalvedRecord { + // 前半 (午前) の記録。 + RecordKind am = 1; + + // 後半 (午後) の記録。 + RecordKind pm = 2; + }
• packages/proto/yamori/work_record/v1/halved_record_write_input.proto (new)
  • @@ -0,0 +1,16 @@
    + // SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com> + // SPDX-License-Identifier: AGPL-3.0-only + + edition = "2023"; + + package yamori.work_record.v1; + + import "yamori/work_record/v1/record_kind_write_input.proto"; + + message HalvedRecordWriteInput { + // 前半 (午前) の記録。 + RecordKindWriteInput am = 1; + + // 後半 (午後) の記録。 + RecordKindWriteInput pm = 2; + }
• packages/proto/yamori/work_record/v1/hourly_workspace_defined_leave.proto (new)
  • @@ -0,0 +1,17 @@
    + // SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com> + // SPDX-License-Identifier: AGPL-3.0-only + + edition = "2023"; + + package yamori.work_record.v1; + + import "yamori/work_record/v1/leave.proto"; + + // 一日未満、もしくは半日未満の時間単位で法定・特別休暇を取得した。 + message HourlyWorkspaceDefinedLeave { + // 対象となる法定・特別休暇。 + Leave leave = 1; + + // 利用した時間。 (1~24) + uint32 hours = 2; + }
• packages/proto/yamori/work_record/v1/hourly_workspace_defined_leave_write_input.proto (new)
  • @@ -0,0 +1,16 @@
    + // SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com> + // SPDX-License-Identifier: AGPL-3.0-only + + edition = "2023"; + + package yamori.work_record.v1; + + import "yamori/work_record/v1/leave_id.proto"; + + message HourlyWorkspaceDefinedLeaveWriteInput { + // 対象となる法定・特別休暇の ID 。 + LeaveID leave_id = 1; + + // 利用した時間。 (1~24) + uint32 hours = 2; + }
• packages/proto/yamori/work_record/v1/record_kind.proto (new)
  • @@ -0,0 +1,33 @@
    + // SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com> + // SPDX-License-Identifier: AGPL-3.0-only + + edition = "2023"; + + package yamori.work_record.v1; + + import "yamori/work_record/v1/day_off.proto"; + import "yamori/work_record/v1/leave.proto"; + import "yamori/work_record/v1/paid_leave.proto"; + import "yamori/work_record/v1/skipped.proto"; + import "yamori/work_record/v1/worked.proto"; + + // 勤怠の記録。 + message RecordKind { + oneof kind { + // 出勤した。 + Worked worked = 1; + + // 欠勤した。 + Skipped skipped = 2; + + // 休日 (公休) 。 + DayOff day_off = 3; + + // 年次有給休暇を利用した。 + PaidLeave paid_leave = 4; + + // 法定休暇・休業や特別休暇といったワークスペースで定義されている + // 休暇・休業を利用した。 + Leave workspace_defined_leave = 5; + } + }
• packages/proto/yamori/work_record/v1/record_kind_write_input.proto (new)
  • @@ -0,0 +1,32 @@
    + // SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com> + // SPDX-License-Identifier: AGPL-3.0-only + + edition = "2023"; + + package yamori.work_record.v1; + + import "yamori/work_record/v1/day_off_write_input.proto"; + import "yamori/work_record/v1/leave_id.proto"; + import "yamori/work_record/v1/paid_leave_write_input.proto"; + import "yamori/work_record/v1/skipped_write_input.proto"; + import "yamori/work_record/v1/worked_write_input.proto"; + + message RecordKindWriteInput { + oneof kind { + // 出勤した。 + WorkedWriteInput worked = 1; + + // 欠勤した。 + SkippedWriteInput skipped = 2; + + // 休日 (公休) 。 + DayOffWriteInput day_off = 3; + + // 年次有給休暇を利用した。 + PaidLeaveWriteInput paid_leave = 4; + + // 法定休暇・休業や特別休暇といったワークスペースで定義されている + // 休暇・休業を利用した際の ID 。 + LeaveID workspace_defined_leave_id = 5; + } + }
• packages/proto/yamori/work_record/v1/skipped.proto (new)
  • @@ -0,0 +1,22 @@
    + // SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com> + // SPDX-License-Identifier: AGPL-3.0-only + + edition = "2023"; + + package yamori.work_record.v1; + + import "yamori/work_record/v1/hourly_paid_leave.proto"; + import "yamori/work_record/v1/hourly_workspace_defined_leave.proto"; + + // 欠勤したことを表すレコード。 + message Skipped { + // 利用した時間単位年次有給休暇。 + // 年次有給休暇付与の出勤率算定時に欠勤扱いを避けるために利用する + // 可能性が排除できないため想定している。 + HourlyPaidLeave hourly_paid_leave = 1; + + // 利用した一日・半日未満の法定・特別休暇の一覧。 + // 年次有給休暇付与の出勤率算定時に欠勤扱いを避けるために利用する + // 可能性が排除できないため想定している。 + repeated HourlyWorkspaceDefinedLeave hourly_workspace_defined_leaves = 2; + }
• packages/proto/yamori/work_record/v1/skipped_write_input.proto (new)
  • @@ -0,0 +1,21 @@
    + // SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com> + // SPDX-License-Identifier: AGPL-3.0-only + + edition = "2023"; + + package yamori.work_record.v1; + + import "yamori/work_record/v1/hourly_paid_leave_write_input.proto"; + import "yamori/work_record/v1/hourly_workspace_defined_leave_write_input.proto"; + + message SkippedWriteInput { + // 利用した時間単位年次有給休暇。 + // 年次有給休暇付与の出勤率算定時に欠勤扱いを避けるために利用する + // 可能性が排除できないため想定している。 + HourlyPaidLeaveWriteInput hourly_paid_leave = 1; + + // 利用した一日・半日未満の法定・特別休暇の一覧。 + // 年次有給休暇付与の出勤率算定時に欠勤扱いを避けるために利用する + // 可能性が排除できないため想定している。 + repeated HourlyWorkspaceDefinedLeaveWriteInput hourly_workspace_defined_leave = 2; + }
• packages/proto/yamori/work_record/v1/work_record.proto
  • @@ -7,8 +7,10 @@ package yamori.work_record.v1;
    import "yamori/type/v1/date.proto"; import "yamori/work_record/v1/day_off.proto"; + import "yamori/work_record/v1/halved_record.proto"; import "yamori/work_record/v1/leave.proto"; import "yamori/work_record/v1/paid_leave.proto"; + import "yamori/work_record/v1/record_kind.proto"; import "yamori/work_record/v1/working_day.proto"; message WorkRecord {
  • @@ -17,19 +19,29 @@
    yamori.type.v1.Date date = 1; // その日の労働状況。 + // [DEPRECATED] kind を利用すること。 oneof record { // 労働が行われた、もしくは予定されていた。 - WorkingDay working_day = 2; + WorkingDay working_day = 2 [deprecated = true]; // 休日。 - DayOff day_off = 3; + DayOff day_off = 3 [deprecated = true]; // 年次有給休暇を利用した。 - PaidLeave paid_leave = 4; + PaidLeave paid_leave = 4 [deprecated = true]; // 法定休暇・休業や特別休暇といったワークスペースで定義されている // 休暇・休業を利用した。 - Leave workspace_defined_leave = 7; + Leave workspace_defined_leave = 7 [deprecated = true]; + } + + oneof kind { + // 一日全体の記録。 + RecordKind day_whole = 8; + + // 勤務を前半 (午前) と後半 (午後) に分けて記録している。 + // e.g. 半有、半出勤 + HalvedRecord day_halved = 9; } // ユーザが残したメモ、記載事項。
• packages/proto/yamori/work_record/v1/work_record_batch_write_input.proto
  • @@ -7,8 +7,10 @@ package yamori.work_record.v1;
    import "yamori/type/v1/date.proto"; import "yamori/work_record/v1/day_off_write_input.proto"; + import "yamori/work_record/v1/halved_record_write_input.proto"; import "yamori/work_record/v1/leave_id.proto"; import "yamori/work_record/v1/paid_leave_write_input.proto"; + import "yamori/work_record/v1/record_kind_write_input.proto"; import "yamori/work_record/v1/working_day_write_input.proto"; message WorkRecordBatchWriteInput {
  • @@ -18,13 +20,21 @@ // 更新対象の日付。複数ある場合は対象の日付全てに同じ更新を行う。
    repeated yamori.type.v1.Date dates = 1; oneof record { - WorkingDayWriteInput working_day = 2; + WorkingDayWriteInput working_day = 2 [deprecated = true]; - DayOffWriteInput day_off = 3; + DayOffWriteInput day_off = 3 [deprecated = true]; - PaidLeaveWriteInput paid_leave = 4; + PaidLeaveWriteInput paid_leave = 4 [deprecated = true]; - LeaveID workspace_defined_leave_id = 7; + LeaveID workspace_defined_leave_id = 7 [deprecated = true]; + } + + oneof kind { + // 一日全体の記録。 + RecordKindWriteInput day_whole = 8; + + // 勤務を前半 (午前) と後半 (午後) に分けて記録している。 + HalvedRecordWriteInput day_halved = 9; } // ユーザが残したメモ、記載事項。
• packages/proto/yamori/work_record/v1/worked.proto (new)
  • @@ -0,0 +1,18 @@
    + // SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com> + // SPDX-License-Identifier: AGPL-3.0-only + + edition = "2023"; + + package yamori.work_record.v1; + + import "yamori/work_record/v1/hourly_paid_leave.proto"; + import "yamori/work_record/v1/hourly_workspace_defined_leave.proto"; + + // 出勤したことを表すレコード。 + message Worked { + // 利用した時間単位年次有給休暇。 + HourlyPaidLeave hourly_paid_leave = 1; + + // 利用した一日・半日未満の法定・特別休暇の一覧。 + repeated HourlyWorkspaceDefinedLeave hourly_workspace_defined_leaves = 2; + }
• packages/proto/yamori/work_record/v1/worked_write_input.proto (new)
  • @@ -0,0 +1,17 @@
    + // SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com> + // SPDX-License-Identifier: AGPL-3.0-only + + edition = "2023"; + + package yamori.work_record.v1; + + import "yamori/work_record/v1/hourly_paid_leave_write_input.proto"; + import "yamori/work_record/v1/hourly_workspace_defined_leave_write_input.proto"; + + message WorkedWriteInput { + // 利用した時間単位年次有給休暇。 + HourlyPaidLeaveWriteInput hourly_paid_leave = 1; + + // 利用した一日・半日未満の法定・特別休暇の一覧。 + repeated HourlyWorkspaceDefinedLeaveWriteInput hourly_workspace_defined_leave = 2; + }