@zeniai/client-epic-state 5.3.24-betaAK1 → 5.3.25-betaGS1

package/lib/entity/jeScheduleApprovalRule/jeScheduleApprovalRulePayload.d.ts

@@ -0,0 +1,105 @@
+import { ID } from '../../commonStateTypes/common';
+import { ZeniAPIResponse, ZeniAPIStatus } from '../../responsePayload';
+import { JEScheduleApprovalAPIStatus, JEScheduleApprovalInfo, JEScheduleApprovalRuleFormData, JEScheduleApprovalRuleState, JEScheduleApprovalStepState, JEScheduleApprover, JEScheduleApproverRole } from './jeScheduleApprovalRuleState';
+import { JEApprovalEntriesSource, JEScheduleType, JE_APPROVAL_STEP_ACTION } from './jeScheduleApprovalRuleTypes';
+export interface JEScheduleApprovalUserActorPayload {
+    id: ID;
+    type: 'user';
+}
+export interface JEScheduleApprovalRoleActorPayload {
+    sub_type: string;
+    type: 'role';
+}
+export type JEScheduleApprovalActorPayload = JEScheduleApprovalUserActorPayload | JEScheduleApprovalRoleActorPayload;
+export interface JEScheduleApprovalStepPayload {
+    action: string;
+    actors: JEScheduleApprovalActorPayload[];
+}
+export interface JEScheduleApprovalStepRequestPayload {
+    action: typeof JE_APPROVAL_STEP_ACTION;
+    actors: JEScheduleApprovalActorPayload[];
+}
+export interface JEScheduleApprovalRulePayload {
+    create_time: string;
+    created_by_user_id: ID | null;
+    description: string | null;
+    id: ID;
+    is_separation_of_duty_enabled: boolean;
+    monthly_amount_min: number;
+    name: string;
+    owner: string;
+    priority: number;
+    schedule_types: string[];
+    step: JEScheduleApprovalStepPayload;
+    update_time: string;
+    updated_by_user_id: ID | null;
+}
+export interface JEScheduleApprovalRulesListPayload {
+    can_edit: boolean;
+    rules: JEScheduleApprovalRulePayload[];
+    rules_version: number;
+    viewer_owner: string;
+}
+export interface JEScheduleApprovalRuleSavePayload extends JEScheduleApprovalRulesListPayload {
+    rule: JEScheduleApprovalRulePayload;
+}
+/** Body for POST / PUT `/1.0/je-schedules/approval-rules[/<id>]`; a type alias so it satisfies the `Record<string, unknown>` body param. */
+export type JEScheduleApprovalRuleRequestBody = {
+    description: string | null;
+    is_applicable_on_pending_approval_entity: boolean;
+    is_separation_of_duty_enabled: boolean;
+    monthly_amount_min: number;
+    name: string;
+    schedule_types: JEScheduleType[];
+    step: JEScheduleApprovalStepRequestPayload;
+};
+export interface JEScheduleApproverPayload {
+    email: string;
+    first_name: string;
+    is_zeni: boolean;
+    je_level: number | null;
+    je_level_label: string | null;
+    last_name: string;
+    user_id: ID;
+}
+export interface JEScheduleApproverRolePayload {
+    label: string;
+    level: number | null;
+    sub_type: string;
+}
+export interface JEScheduleApproversPayload {
+    roles: JEScheduleApproverRolePayload[];
+    users: JEScheduleApproverPayload[];
+    viewer_owner: string;
+}
+export interface JEScheduleApprovalInfoPayload {
+    approver_labels: string[];
+    approver_roles: string[];
+    approver_user_ids: ID[];
+    can_approve: boolean;
+    entries_source: JEApprovalEntriesSource;
+    entries_version: number;
+    matched_rule_ids: ID[];
+    matched_rule_name: string | null;
+    matched_rule_owner: string | null;
+    message: string;
+    monthly_amount: number | null;
+    preparer_user_id: ID | null;
+    requires_approval: boolean;
+    rule_min: number | null;
+    separation_of_duties: boolean;
+    unevaluable_reason: string | null;
+}
+export type JEScheduleApprovalRulesListResponse = ZeniAPIResponse<JEScheduleApprovalRulesListPayload>;
+export type JEScheduleApprovalRuleSaveResponse = ZeniAPIResponse<JEScheduleApprovalRuleSavePayload>;
+export type JEScheduleApproversResponse = ZeniAPIResponse<JEScheduleApproversPayload>;
+export declare const toJEScheduleApprovalStepState: (payload: JEScheduleApprovalStepPayload) => JEScheduleApprovalStepState;
+export declare const toJEScheduleTypes: (scheduleTypes: string[]) => JEScheduleType[];
+export declare const toJEScheduleApprovalRuleState: (payload: JEScheduleApprovalRulePayload) => JEScheduleApprovalRuleState;
+/** Reverse mapper for create / update. The contract carries exactly one step. */
+export declare const toJEScheduleApprovalRulePayload: (formData: JEScheduleApprovalRuleFormData) => JEScheduleApprovalRuleRequestBody;
+export declare const toJEScheduleApprover: (payload: JEScheduleApproverPayload) => JEScheduleApprover;
+export declare const toJEScheduleApproverRole: (payload: JEScheduleApproverRolePayload) => JEScheduleApproverRole;
+export declare const toJEScheduleApprovalInfo: (payload: JEScheduleApprovalInfoPayload | null | undefined) => JEScheduleApprovalInfo | undefined;
+/** Wraps an API status with a typed `kind` and a user-facing message for 403 / 404; a 404 on the action endpoint means the schedule, not the rules, is gone. */
+export declare const toJEScheduleApprovalAPIStatus: (status: ZeniAPIStatus, context?: "rules" | "action") => JEScheduleApprovalAPIStatus;

package/lib/entity/jeScheduleApprovalRule/jeScheduleApprovalRulePayload.js

@@ -0,0 +1,158 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toJEScheduleApprovalAPIStatus = exports.toJEScheduleApprovalInfo = exports.toJEScheduleApproverRole = exports.toJEScheduleApprover = exports.toJEScheduleApprovalRulePayload = exports.toJEScheduleApprovalRuleState = exports.toJEScheduleTypes = exports.toJEScheduleApprovalStepState = void 0;
+const zeniDayJS_1 = require("../../zeniDayJS");
+const jeScheduleApprovalRuleTypes_1 = require("./jeScheduleApprovalRuleTypes");
+const isUserActor = (actor) => actor.type === 'user';
+const toJEScheduleApprovalStepState = (payload) => {
+    const nonUserActors = [];
+    payload.actors.forEach((actor) => {
+        if (isUserActor(actor)) {
+            return;
+        }
+        const subType = (0, jeScheduleApprovalRuleTypes_1.toJEApprovalRoleSubTypeStrict)(actor.sub_type);
+        if (subType == null) {
+            console.warn(`[jeScheduleApprovalRule] dropping unknown role actor "${actor.sub_type}"`);
+            return;
+        }
+        nonUserActors.push({ subType });
+    });
+    return {
+        actorUserIds: payload.actors.filter(isUserActor).map((actor) => actor.id),
+        nonUserActors,
+    };
+};
+exports.toJEScheduleApprovalStepState = toJEScheduleApprovalStepState;
+const toJEScheduleTypes = (scheduleTypes) => {
+    const result = [];
+    scheduleTypes.forEach((scheduleType) => {
+        const known = (0, jeScheduleApprovalRuleTypes_1.toJEScheduleTypeStrict)(scheduleType);
+        if (known == null) {
+            console.warn(`[jeScheduleApprovalRule] dropping unknown schedule type "${scheduleType}"`);
+            return;
+        }
+        result.push(known);
+    });
+    return result;
+};
+exports.toJEScheduleTypes = toJEScheduleTypes;
+const toJEScheduleApprovalRuleState = (payload) => ({
+    approvalRuleId: payload.id,
+    owner: (0, jeScheduleApprovalRuleTypes_1.toJEApprovalOwner)(payload.owner),
+    priority: payload.priority,
+    name: payload.name,
+    description: payload.description ?? undefined,
+    separationOfDuties: payload.is_separation_of_duty_enabled,
+    criteria: {
+        scheduleTypes: (0, exports.toJEScheduleTypes)(payload.schedule_types),
+        monthlyAmountMin: payload.monthly_amount_min,
+    },
+    steps: payload.step.action === jeScheduleApprovalRuleTypes_1.JE_APPROVAL_STEP_ACTION
+        ? [(0, exports.toJEScheduleApprovalStepState)(payload.step)]
+        : [],
+    createdByUserId: payload.created_by_user_id ?? undefined,
+    updatedByUserId: payload.updated_by_user_id ?? undefined,
+    createTime: (0, zeniDayJS_1.date)(payload.create_time),
+    updateTime: (0, zeniDayJS_1.date)(payload.update_time),
+});
+exports.toJEScheduleApprovalRuleState = toJEScheduleApprovalRuleState;
+const toJEScheduleApprovalStepPayload = (step) => ({
+    action: jeScheduleApprovalRuleTypes_1.JE_APPROVAL_STEP_ACTION,
+    actors: [
+        ...step.actorUserIds.map((userId) => ({
+            type: 'user',
+            id: userId,
+        })),
+        ...step.nonUserActors.map((actor) => ({
+            type: 'role',
+            sub_type: actor.subType,
+        })),
+    ],
+});
+/** Reverse mapper for create / update. The contract carries exactly one step. */
+const toJEScheduleApprovalRulePayload = (formData) => ({
+    name: formData.name,
+    description: formData.description ?? null,
+    is_separation_of_duty_enabled: formData.separationOfDuties,
+    schedule_types: formData.criteria.scheduleTypes,
+    monthly_amount_min: formData.criteria.monthlyAmountMin,
+    step: toJEScheduleApprovalStepPayload(formData.steps[0] ?? {
+        actorUserIds: [],
+        nonUserActors: [],
+    }),
+    is_applicable_on_pending_approval_entity: formData.isApplicableOnPendingApprovalEntity,
+});
+exports.toJEScheduleApprovalRulePayload = toJEScheduleApprovalRulePayload;
+const toJEScheduleApprover = (payload) => ({
+    userId: payload.user_id,
+    email: payload.email,
+    firstName: payload.first_name,
+    lastName: payload.last_name,
+    isZeni: payload.is_zeni,
+    jeLevel: payload.je_level ?? undefined,
+    jeLevelLabel: payload.je_level_label ?? undefined,
+});
+exports.toJEScheduleApprover = toJEScheduleApprover;
+const toJEScheduleApproverRole = (payload) => ({
+    subType: (0, jeScheduleApprovalRuleTypes_1.toJEApprovalRoleSubType)(payload.sub_type),
+    level: payload.level ?? undefined,
+    label: payload.label,
+});
+exports.toJEScheduleApproverRole = toJEScheduleApproverRole;
+const toJEScheduleApprovalInfo = (payload) => {
+    if (payload == null) {
+        return undefined;
+    }
+    return {
+        requiresApproval: payload.requires_approval,
+        canApprove: payload.can_approve,
+        entriesSource: payload.entries_source,
+        entriesVersion: payload.entries_version,
+        approverLabels: payload.approver_labels,
+        approverRoles: payload.approver_roles,
+        approverUserIds: payload.approver_user_ids,
+        matchedRuleIds: payload.matched_rule_ids,
+        matchedRuleName: payload.matched_rule_name ?? undefined,
+        matchedRuleOwner: payload.matched_rule_owner != null
+            ? (0, jeScheduleApprovalRuleTypes_1.toJEApprovalOwner)(payload.matched_rule_owner)
+            : undefined,
+        monthlyAmount: payload.monthly_amount ?? undefined,
+        ruleMin: payload.rule_min ?? undefined,
+        separationOfDuties: payload.separation_of_duties,
+        preparerUserId: payload.preparer_user_id ?? undefined,
+        unevaluableReason: payload.unevaluable_reason ?? undefined,
+        message: payload.message,
+    };
+};
+exports.toJEScheduleApprovalInfo = toJEScheduleApprovalInfo;
+const toJEApprovalErrorKind = (code) => {
+    switch (code) {
+        case 403:
+            return 'forbidden';
+        case 409:
+            return 'conflict';
+        case 400:
+            return 'validation';
+        case 404:
+            return 'not_found';
+        default:
+            return 'unknown';
+    }
+};
+const USER_FACING_MESSAGES = {
+    forbidden: 'You are not allowed to perform this action.',
+    conflict: undefined, // already-claimed and stale-draft both arrive with a user-facing message
+    validation: undefined, // backend's status.message is already user-facing
+    not_found: 'JE schedule approval rules are not available for this account.',
+    unknown: undefined,
+};
+const SCHEDULE_NOT_FOUND_MESSAGE = 'This schedule no longer exists.';
+/** Wraps an API status with a typed `kind` and a user-facing message for 403 / 404; a 404 on the action endpoint means the schedule, not the rules, is gone. */
+const toJEScheduleApprovalAPIStatus = (status, context = 'rules') => {
+    const kind = toJEApprovalErrorKind(status.code);
+    const message = kind === 'not_found' && context === 'action'
+        ? status.message || SCHEDULE_NOT_FOUND_MESSAGE
+        : (USER_FACING_MESSAGES[kind] ?? status.message);
+    return { ...status, kind, message };
+};
+exports.toJEScheduleApprovalAPIStatus = toJEScheduleApprovalAPIStatus;

package/lib/entity/jeScheduleApprovalRule/jeScheduleApprovalRuleState.d.ts

@@ -0,0 +1,89 @@
+import { ID } from '../../commonStateTypes/common';
+import { ZeniAPIStatus } from '../../responsePayload';
+import { ZeniDate } from '../../zeniDayJS';
+import { JEApprovalEntriesSource, JEApprovalErrorKind, JEApprovalOwner, JEApprovalRoleSubType, JEScheduleType } from './jeScheduleApprovalRuleTypes';
+/** A user eligible to approve JE schedules, as `/je-schedules/approvers` reports them. */
+export interface JEScheduleApprover {
+    email: string;
+    firstName: string;
+    isZeni: boolean;
+    lastName: string;
+    userId: ID;
+    jeLevel?: number;
+    jeLevelLabel?: string;
+}
+export interface JEScheduleApproverRole {
+    label: string;
+    subType: JEApprovalRoleSubType;
+    level?: number;
+}
+export interface JEScheduleApprovalNonUserActor {
+    subType: JEApprovalRoleSubType;
+}
+export interface JEScheduleApprovalCriteria {
+    monthlyAmountMin: number;
+    scheduleTypes: JEScheduleType[];
+}
+/** Stored shape: actors are user ids; the view selector joins them against the approvers list. */
+export interface JEScheduleApprovalStepState {
+    actorUserIds: ID[];
+    nonUserActors: JEScheduleApprovalNonUserActor[];
+}
+export interface JEScheduleApprovalRuleBase {
+    approvalRuleId: ID;
+    createTime: ZeniDate;
+    criteria: JEScheduleApprovalCriteria;
+    name: string;
+    owner: JEApprovalOwner;
+    priority: number;
+    separationOfDuties: boolean;
+    updateTime: ZeniDate;
+    createdByUserId?: ID;
+    description?: string;
+    updatedByUserId?: ID;
+}
+export interface JEScheduleApprovalRuleState extends JEScheduleApprovalRuleBase {
+    steps: JEScheduleApprovalStepState[];
+}
+/** Selector shape: actors resolved to approver records. */
+export interface JEScheduleApprovalStep {
+    actors: JEScheduleApprover[];
+    nonUserActors: JEScheduleApprovalNonUserActor[];
+}
+export interface JEScheduleApprovalRule extends JEScheduleApprovalRuleBase {
+    steps: JEScheduleApprovalStep[];
+}
+/** Form-side shape for create / update; mapped to the wire by `toJEScheduleApprovalRulePayload`. */
+export interface JEScheduleApprovalRuleFormData {
+    criteria: JEScheduleApprovalCriteria;
+    isApplicableOnPendingApprovalEntity: boolean;
+    name: string;
+    separationOfDuties: boolean;
+    steps: JEScheduleApprovalStepState[];
+    approvalRuleId?: ID;
+    description?: string;
+}
+/** Per-schedule approval evaluation carried on JE schedule rows (`approval_info`). */
+export interface JEScheduleApprovalInfo {
+    approverLabels: string[];
+    approverRoles: string[];
+    approverUserIds: ID[];
+    canApprove: boolean;
+    /** 'parked' when the detail read served the rows saved while held; 'live' otherwise. */
+    entriesSource: JEApprovalEntriesSource;
+    /** Echoed back on approve; the server answers 409 when the draft was re-parked since. */
+    entriesVersion: number;
+    matchedRuleIds: ID[];
+    message: string;
+    requiresApproval: boolean;
+    separationOfDuties: boolean;
+    matchedRuleName?: string;
+    matchedRuleOwner?: JEApprovalOwner;
+    monthlyAmount?: number;
+    preparerUserId?: ID;
+    ruleMin?: number;
+    unevaluableReason?: string;
+}
+export interface JEScheduleApprovalAPIStatus extends ZeniAPIStatus {
+    kind: JEApprovalErrorKind;
+}

package/lib/entity/jeScheduleApprovalRule/jeScheduleApprovalRuleState.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/entity/jeScheduleApprovalRule/jeScheduleApprovalRuleTypes.d.ts

@@ -0,0 +1,33 @@
+export declare const JE_SCHEDULE_TYPES: readonly ["prepaid_expenses", "fixed_assets", "accrued_expenses"];
+export declare const toJEScheduleType: (v: string) => "prepaid_expenses" | "fixed_assets" | "accrued_expenses";
+export declare const toJEScheduleTypeStrict: (v: string) => "prepaid_expenses" | "fixed_assets" | "accrued_expenses" | undefined;
+export type JEScheduleType = ReturnType<typeof toJEScheduleType>;
+export declare const JE_APPROVAL_OWNERS: readonly ["zeni", "customer"];
+export declare const toJEApprovalOwner: (v: string) => "customer" | "zeni";
+export declare const toJEApprovalOwnerStrict: (v: string) => "customer" | "zeni" | undefined;
+export type JEApprovalOwner = ReturnType<typeof toJEApprovalOwner>;
+/** The only step action the backend accepts; older notify steps are dropped on read. */
+export declare const JE_APPROVAL_STEP_ACTION = "require_approval";
+export declare const JE_APPROVAL_ZENI_ROLE_SUB_TYPES: readonly ["reviewer", "controller"];
+/** Role actors valid only on customer-owned rules. */
+export declare const JE_APPROVAL_CUSTOMER_ROLE_SUB_TYPES: readonly ["customer_super_admin", "customer_finance_admin"];
+export declare const JE_APPROVAL_ROLE_SUB_TYPES: readonly ["reviewer", "controller", "customer_super_admin", "customer_finance_admin"];
+export declare const toJEApprovalRoleSubType: (v: string) => "reviewer" | "controller" | "customer_super_admin" | "customer_finance_admin";
+export declare const toJEApprovalRoleSubTypeStrict: (v: string) => "reviewer" | "controller" | "customer_super_admin" | "customer_finance_admin" | undefined;
+export type JEApprovalRoleSubType = ReturnType<typeof toJEApprovalRoleSubType>;
+export declare const JE_APPROVAL_ACTIONS: readonly ["approve", "reject", "save_draft"];
+export type JEApprovalAction = (typeof JE_APPROVAL_ACTIONS)[number];
+export declare const JE_LEVEL_PREPARER = 1;
+export declare const JE_LEVEL_REVIEWER = 2;
+export declare const JE_LEVEL_CONTROLLER = 3;
+export declare const JE_LEVEL_LABELS: Record<number, string>;
+export declare const JE_SCHEDULE_TYPE_LABELS: Record<JEScheduleType, string>;
+/**
+ * Typed failure kinds for the approval-rule / approval-action endpoints.
+ * 403 = viewer may not edit (or touched the other owner's rule / is not an
+ * eligible approver / SoD); 409 = someone else already approved.
+ */
+export declare const JE_APPROVAL_ENTRIES_SOURCES: readonly ["parked", "live"];
+export type JEApprovalEntriesSource = (typeof JE_APPROVAL_ENTRIES_SOURCES)[number];
+export declare const JE_APPROVAL_ERROR_KINDS: readonly ["forbidden", "conflict", "validation", "not_found", "unknown"];
+export type JEApprovalErrorKind = (typeof JE_APPROVAL_ERROR_KINDS)[number];

package/lib/entity/jeScheduleApprovalRule/jeScheduleApprovalRuleTypes.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JE_APPROVAL_ERROR_KINDS = exports.JE_APPROVAL_ENTRIES_SOURCES = exports.JE_SCHEDULE_TYPE_LABELS = exports.JE_LEVEL_LABELS = exports.JE_LEVEL_CONTROLLER = exports.JE_LEVEL_REVIEWER = exports.JE_LEVEL_PREPARER = exports.JE_APPROVAL_ACTIONS = exports.toJEApprovalRoleSubTypeStrict = exports.toJEApprovalRoleSubType = exports.JE_APPROVAL_ROLE_SUB_TYPES = exports.JE_APPROVAL_CUSTOMER_ROLE_SUB_TYPES = exports.JE_APPROVAL_ZENI_ROLE_SUB_TYPES = exports.JE_APPROVAL_STEP_ACTION = exports.toJEApprovalOwnerStrict = exports.toJEApprovalOwner = exports.JE_APPROVAL_OWNERS = exports.toJEScheduleTypeStrict = exports.toJEScheduleType = exports.JE_SCHEDULE_TYPES = void 0;
+const stringToUnion_1 = require("../../commonStateTypes/stringToUnion");
+exports.JE_SCHEDULE_TYPES = [
+    'prepaid_expenses',
+    'fixed_assets',
+    'accrued_expenses',
+];
+const toJEScheduleType = (v) => (0, stringToUnion_1.stringToUnion)(v, exports.JE_SCHEDULE_TYPES);
+exports.toJEScheduleType = toJEScheduleType;
+const toJEScheduleTypeStrict = (v) => (0, stringToUnion_1.stringToUnionStrict)(v, exports.JE_SCHEDULE_TYPES);
+exports.toJEScheduleTypeStrict = toJEScheduleTypeStrict;
+exports.JE_APPROVAL_OWNERS = ['zeni', 'customer'];
+const toJEApprovalOwner = (v) => (0, stringToUnion_1.stringToUnion)(v, exports.JE_APPROVAL_OWNERS);
+exports.toJEApprovalOwner = toJEApprovalOwner;
+const toJEApprovalOwnerStrict = (v) => (0, stringToUnion_1.stringToUnionStrict)(v, exports.JE_APPROVAL_OWNERS);
+exports.toJEApprovalOwnerStrict = toJEApprovalOwnerStrict;
+/** The only step action the backend accepts; older notify steps are dropped on read. */
+exports.JE_APPROVAL_STEP_ACTION = 'require_approval';
+exports.JE_APPROVAL_ZENI_ROLE_SUB_TYPES = [
+    'reviewer',
+    'controller',
+];
+/** Role actors valid only on customer-owned rules. */
+exports.JE_APPROVAL_CUSTOMER_ROLE_SUB_TYPES = [
+    'customer_super_admin',
+    'customer_finance_admin',
+];
+exports.JE_APPROVAL_ROLE_SUB_TYPES = [
+    ...exports.JE_APPROVAL_ZENI_ROLE_SUB_TYPES,
+    ...exports.JE_APPROVAL_CUSTOMER_ROLE_SUB_TYPES,
+];
+const toJEApprovalRoleSubType = (v) => (0, stringToUnion_1.stringToUnion)(v, exports.JE_APPROVAL_ROLE_SUB_TYPES);
+exports.toJEApprovalRoleSubType = toJEApprovalRoleSubType;
+const toJEApprovalRoleSubTypeStrict = (v) => (0, stringToUnion_1.stringToUnionStrict)(v, exports.JE_APPROVAL_ROLE_SUB_TYPES);
+exports.toJEApprovalRoleSubTypeStrict = toJEApprovalRoleSubTypeStrict;
+exports.JE_APPROVAL_ACTIONS = ['approve', 'reject', 'save_draft'];
+exports.JE_LEVEL_PREPARER = 1;
+exports.JE_LEVEL_REVIEWER = 2;
+exports.JE_LEVEL_CONTROLLER = 3;
+exports.JE_LEVEL_LABELS = {
+    [exports.JE_LEVEL_PREPARER]: 'Preparer',
+    [exports.JE_LEVEL_REVIEWER]: 'Reviewer',
+    [exports.JE_LEVEL_CONTROLLER]: 'Controller',
+};
+exports.JE_SCHEDULE_TYPE_LABELS = {
+    prepaid_expenses: 'Prepaid Expenses',
+    fixed_assets: 'Fixed Assets',
+    accrued_expenses: 'Accrued Expenses',
+};
+/**
+ * Typed failure kinds for the approval-rule / approval-action endpoints.
+ * 403 = viewer may not edit (or touched the other owner's rule / is not an
+ * eligible approver / SoD); 409 = someone else already approved.
+ */
+exports.JE_APPROVAL_ENTRIES_SOURCES = ['parked', 'live'];
+exports.JE_APPROVAL_ERROR_KINDS = [
+    'forbidden',
+    'conflict',
+    'validation',
+    'not_found',
+    'unknown',
+];

package/lib/entity/jeSchedules/jeSchedulesPayload.d.ts

@@ -2,12 +2,13 @@ import { StatusCodeWithLabelPayload } from '../../commonPayloadTypes/statusPaylo
 import { ID } from '../../commonStateTypes/common';
 import { AccountPayload } from '../account/accountPayload';
 import { ClassBasePayload } from '../class/classPayload';
+import { JEScheduleApprovalInfoPayload } from '../jeScheduleApprovalRule/jeScheduleApprovalRulePayload';
 import { ScheduleTransactionPayload } from '../transaction/payloadTypes/scheduleTransactionPayload';
 import { TransactionIDPayload } from '../transaction/payloadTypes/transactionIDPayload';
 import { TransactionCategory } from '../transaction/stateTypes/transactionType';
 import { UserPayload } from '../user/userPayload';
 import { VendorPayload } from '../vendor/vendorPayload';
-import { JEAccruedScheduledTransactionState, JEOneTimeAccrualState, JEScheduledTransactionState, ScheduledJournalEntryState } from './jeSchedulesState';
+import { JEAccruedScheduledTransactionState, JEOneTimeAccrualState, JEScheduleContributor, JEScheduledTransactionState, ScheduledJournalEntryState } from './jeSchedulesState';
 import { JEScheduleKey, JEScheduleTransactionKey } from './jeSchedulesTypes';
 export interface JEScheduleOtherAttributesPayload {
     asset_id?: string | null;
@@ -83,7 +84,9 @@ export interface JEScheduledTransactionPayload {
     updated_by: UserPayload;
     vendor: VendorPayload;
     ai_summaries?: JEScheduleAISummariesPayload;
+    approval_info?: JEScheduleApprovalInfoPayload | null;
     confidence_score?: number | null;
+    contributors?: JEScheduleContributorPayload[] | null;
     create_time?: string | null;
     created_by?: UserPayload;
     end_date?: string | null;
@@ -92,6 +95,14 @@ export interface JEScheduledTransactionPayload {
     recurring_amount?: number | null;
     updated_at?: string | null;
 }
+export interface JEScheduleContributorPayload {
+    kind: string;
+    last_action: string;
+    name: string;
+    user_id: ID;
+    first_action_at?: string | null;
+    last_action_at?: string | null;
+}
 export interface JEAccruedScheduledTransactionPayload extends Omit<JEScheduledTransactionPayload, 'base_transaction' | 'je_schedule_id' | 'je_schedule_type'> {
     create_time: string;
     je_schedule_id: ID;
@@ -166,6 +177,7 @@ export interface JEOneTimeAccrualPayload {
     actual_post_date?: string | null;
     actual_reversal_post_date?: string | null;
     ai_suggestion?: JEOneTimeAccrualAiSuggestionPayload | null;
+    approval_info?: JEScheduleApprovalInfoPayload | null;
     automation_tier?: string | null;
     cleared?: JEOneTimeAccrualClearedPayload | null;
     created_by_user?: UserPayload | null;
@@ -221,6 +233,8 @@ export declare function toJEAccruedAccountPayload(payload: JEScheduledTransactio
 export declare function toJEClassPayload(payload: JEScheduledTransactionPayload | JEAccruedScheduledTransactionPayload, type: TransactionCategory): ClassBasePayload | undefined;
 export declare function getJEScheduleTransactionDetailKeyPayload(payload: ScheduleTransactionPayload): JEScheduleTransactionKey;
 export declare function getJEScheduleKey(payload: JEAccruedScheduledTransactionPayload): JEScheduleKey;
+/** Drops entries whose kind or action this client does not know, so an unknown actor is never shown as an editor. */
+export declare function toJEScheduleContributors(payload: JEScheduleContributorPayload[] | null | undefined): JEScheduleContributor[];
 export declare function toJEScheduledTransaction(payload: JEScheduledTransactionPayload): JEScheduledTransactionState;
 export declare function toJEAccruedScheduledTransaction(payload: JEAccruedScheduledTransactionPayload): JEAccruedScheduledTransactionState;
 export declare function toJEOneTimeAccrual(payload: JEOneTimeAccrualPayload): JEOneTimeAccrualState;

package/lib/entity/jeSchedules/jeSchedulesPayload.js

@@ -6,6 +6,7 @@ exports.toJEAccruedAccountPayload = toJEAccruedAccountPayload;
 exports.toJEClassPayload = toJEClassPayload;
 exports.getJEScheduleTransactionDetailKeyPayload = getJEScheduleTransactionDetailKeyPayload;
 exports.getJEScheduleKey = getJEScheduleKey;
+exports.toJEScheduleContributors = toJEScheduleContributors;
 exports.toJEScheduledTransaction = toJEScheduledTransaction;
 exports.toJEAccruedScheduledTransaction = toJEAccruedScheduledTransaction;
 exports.toJEOneTimeAccrual = toJEOneTimeAccrual;
@@ -13,6 +14,7 @@ const amount_1 = require("../../commonStateTypes/amount");
 const timePeriod_1 = require("../../commonStateTypes/timePeriod");
 const zeniDayJS_1 = require("../../zeniDayJS");
 const zeniUrl_1 = require("../../zeniUrl");
+const jeScheduleApprovalRulePayload_1 = require("../jeScheduleApprovalRule/jeScheduleApprovalRulePayload");
 const transactionIDPayload_1 = require("../transaction/payloadTypes/transactionIDPayload");
 const jeScheduleHelper_1 = require("./jeScheduleHelper");
 const jeSchedulesTypes_1 = require("./jeSchedulesTypes");
@@ -254,6 +256,30 @@ function toJEScheduleAISummaries(payload) {
     }
     return Object.keys(result).length > 0 ? result : undefined;
 }
+/** Drops entries whose kind or action this client does not know, so an unknown actor is never shown as an editor. */
+function toJEScheduleContributors(payload) {
+    const contributors = [];
+    (payload ?? []).forEach((contributor) => {
+        const kind = (0, jeSchedulesTypes_1.toJEScheduleContributorKind)(contributor.kind);
+        const lastAction = (0, jeSchedulesTypes_1.toJEScheduleContributorAction)(contributor.last_action);
+        if (kind == null || lastAction == null) {
+            return;
+        }
+        contributors.push({
+            userId: contributor.user_id,
+            kind,
+            name: contributor.name,
+            lastAction,
+            firstActionAt: contributor.first_action_at != null
+                ? (0, zeniDayJS_1.date)(contributor.first_action_at)
+                : undefined,
+            lastActionAt: contributor.last_action_at != null
+                ? (0, zeniDayJS_1.date)(contributor.last_action_at)
+                : undefined,
+        });
+    });
+    return contributors;
+}
 function toJEScheduleRecommendations(payload) {
     if (payload == null) {
         return undefined;
@@ -334,9 +360,11 @@ function toJEScheduledTransaction(payload) {
             : {},
         scheduledJournalEntry: [],
         aiSummaries: toJEScheduleAISummaries(payload.ai_summaries),
+        approvalInfo: (0, jeScheduleApprovalRulePayload_1.toJEScheduleApprovalInfo)(payload.approval_info),
         confidenceScore: payload.confidence_score ?? undefined,
         createdByUserID: payload.created_by?.user_id ?? undefined,
         recommendations: toJEScheduleRecommendations(payload.recommendations),
+        contributors: toJEScheduleContributors(payload.contributors),
     };
 }
 function toJEAccruedScheduledTransaction(payload) {
@@ -384,6 +412,7 @@ function toJEAccruedScheduledTransaction(payload) {
         },
         currencyCode: payload.currency_code,
         currencySymbol: payload.currency_symbol,
+        approvalInfo: (0, jeScheduleApprovalRulePayload_1.toJEScheduleApprovalInfo)(payload.approval_info),
         dayOfPostingDate: payload.posting_date != null &&
             payload.posting_date >= timePeriod_1.MIN_SCHEDULE_DAY_OF_MONTH &&
             payload.posting_date <= timePeriod_1.MAX_SCHEDULE_DAY_OF_MONTH
@@ -396,6 +425,7 @@ function toJEAccruedScheduledTransaction(payload) {
         scheduledJournalEntry: [],
         createTime: (0, zeniDayJS_1.date)(payload.create_time),
         jeScheduleType: (0, jeSchedulesTypes_1.toScheduleTypesTypeStrict)(payload.je_schedule_type),
+        contributors: toJEScheduleContributors(payload.contributors),
     };
 }
 /**
@@ -514,6 +544,7 @@ function toJEOneTimeAccrual(payload) {
         automationTier: payload.automation_tier != null
             ? (0, jeSchedulesTypes_1.toOneTimeAccrualAutomationTierType)(payload.automation_tier)
             : undefined,
+        approvalInfo: (0, jeScheduleApprovalRulePayload_1.toJEScheduleApprovalInfo)(payload.approval_info),
         estimatedAmount: toOneTimeAccrualAmount(payload.estimated_amount, payload.currency),
         memo: payload.memo ?? '',
         profileSnapshot: toJEOneTimeAccrualProfileSnapshot(payload.profile_snapshot, payload.currency),

package/lib/entity/jeSchedules/jeSchedulesReducer.js

@@ -183,6 +183,10 @@ function doUpdateJEScheduledTransaction(draft, id, payload, updateType) {
     const jeTransaction = (0, jeSchedulesPayload_1.toJEScheduledTransaction)(payload);
     const existingTransaction = draft[id];
     if (existingTransaction != null && updateType === 'merge') {
+        // A payload without a contributors ledger maps to [], which would otherwise wipe the stored one.
+        if (payload.contributors == null) {
+            jeTransaction.contributors = existingTransaction.contributors;
+        }
         // scheduledJournalEntry is held back from the merge. The list payload never carries journal
         // entries -- toJEScheduledTransaction always sets [] -- and [] is not nullish, so the
         // customizer below would treat it as a value and wipe whatever updateJESchedulesDetails had
@@ -199,6 +203,10 @@ function doUpdateJEAccruedScheduledTransaction(draft, id, payload, updateType) {
     const jeTransaction = (0, jeSchedulesPayload_1.toJEAccruedScheduledTransaction)(payload);
     const existingTransaction = draft[id];
     if (existingTransaction != null && updateType === 'merge') {
+        // A payload without a contributors ledger maps to [], which would otherwise wipe the stored one.
+        if (payload.contributors == null) {
+            jeTransaction.contributors = existingTransaction.contributors;
+        }
         (0, assignWith_1.default)(draft[id], jeTransaction, (objValue, srcValue) => srcValue ?? objValue); // IMPORTANT: replace the value only when source has valid value. Otherwise keep the existing value!
     }
     else {
@@ -244,6 +252,10 @@ function doUpdateAccruedScheduledDetailTransaction(draft, id, jeSchedulePayload,
     }
     const existingTransaction = draft[id];
     if (existingTransaction != null && updateType === 'merge') {
+        // A payload without a contributors ledger maps to [], which would otherwise wipe the stored one.
+        if (jeSchedulePayload.contributors == null) {
+            jeTransaction.contributors = existingTransaction.contributors;
+        }
         // An empty array here means "this payload carried no entries for this schedule", not "this
         // schedule has none" -- and [] is not nullish, so the customizer below would treat it as a
         // value and clear entries another call already wrote. Only overwrite when there is something
@@ -274,6 +286,10 @@ function doUpdateScheduledDetailTransaction(draft, id, jeSchedulePayload, schedu
     }
     const existingTransaction = draft[id];
     if (existingTransaction != null && updateType === 'merge') {
+        // A payload without a contributors ledger maps to [], which would otherwise wipe the stored one.
+        if (jeSchedulePayload.contributors == null) {
+            jeTransaction.contributors = existingTransaction.contributors;
+        }
         // An empty array here means "this payload carried no entries for this schedule", not "this
         // schedule has none" -- and [] is not nullish, so the customizer below would treat it as a
         // value and clear entries another call already wrote. Only overwrite when there is something

package/lib/entity/jeSchedules/jeSchedulesSelector.d.ts

@@ -5,6 +5,7 @@ import { RootState } from '../../rootStateTypes';
 import { ZeniDate } from '../../zeniDayJS';
 import { AccountBase } from '../account/accountState';
 import { Class } from '../class/classState';
+import { JEScheduleApprovalInfo } from '../jeScheduleApprovalRule/jeScheduleApprovalRuleState';
 import { ScheduleTransaction } from '../transaction/stateTypes/scheduleTransaction';
 import { TransactionID } from '../transaction/stateTypes/transactionID';
 import { User } from '../user/userState';
@@ -84,3 +85,10 @@ export interface JEOneTimeAccrual extends JEOneTimeAccrualState {
 export declare const getJEOneTimeAccrualByKey: (jeOneTimeAccrualKey: JEOneTimeAccrualKey, jeSchedulesState: JESchedulesState) => JEOneTimeAccrual | undefined;
 export declare const getJEAccruedScheduleByJEScheduleKey: (JEScheduleKey: JEScheduleKey, state: RootState) => JEAccruedSchedule | undefined;
 export declare const getJEScheduledTransactionByJEScheduleTransactionKey: (jeScheduleTransactionKey: JEScheduleTransactionKey, state: RootState) => JEScheduledTransaction;
+/** Schedules are keyed by transaction / accrued key, not schedule id, so this re-indexes both maps by schedule id. */
+export declare const getApprovalInfoByScheduleId: (jeSchedulesState: JESchedulesState) => Record<ID, JEScheduleApprovalInfo>;
+export declare const getScheduleApprovalInfo: (jeSchedulesState: JESchedulesState, jeScheduleId: ID) => JEScheduleApprovalInfo | undefined;
+/** One-time accruals are keyed by accrual id, so this is a direct lookup, unlike the schedule scan. */
+export declare const getOneTimeAccrualApprovalInfo: (jeSchedulesState: JESchedulesState, accrualId: ID) => JEScheduleApprovalInfo | undefined;
+/** Human contributors other than the creator, earliest first; schedules nobody else touched are omitted. */
+export declare const getEditedByNamesByScheduleId: (jeSchedulesState: JESchedulesState) => Record<ID, string[]>;