@mj-biz-apps/orders-core-entities-server 5.35.0 → 5.36.0

package/dist/OrderReview.d.ts

@@ -0,0 +1,72 @@
+import '@mj-biz-apps/tasks-entities';
+import { type OrderReviewChangeFacts, type OrderReviewConfig, type ReviewStanding, type ReviewTaskFacts } from '@mj-biz-apps/orders-entities';
+import { type ApprovalTaskContext } from './ConcessionApprovalTask.js';
+import { type ConcessionLineFacts } from './ConcessionGate.js';
+/** A line as the review reads it: the concession gate's facts plus its service period. */
+export interface ReviewLineInput extends ConcessionLineFacts {
+    ServicePeriodStart: string | null;
+    ServicePeriodEnd: string | null;
+    /** A renewal line whose carried-forward price this save edits. */
+    RenewalPriceEdited: boolean;
+}
+/** The order, as the save hands it to the review. */
+export interface ReviewOrderInput {
+    /** Null for an order not yet saved. */
+    OrderHeaderID: string | null;
+    OrderNumber: string | null;
+    Origin: string | null;
+    ReversesOrderHeaderID: string | null;
+    Lines: readonly ReviewLineInput[];
+}
+/** The order's most recent review task, with what the gate reads from it. */
+interface LatestReview {
+    Task: {
+        ID: string;
+        Name: string;
+        Status: string;
+    };
+    Facts: ReviewTaskFacts;
+    Standing: ReviewStanding;
+}
+/** What a raised review was sent to. */
+export interface RaisedReview {
+    TaskID: string;
+    TaskName: string;
+    Role: string;
+    Escalated: boolean;
+    AssigneeCount: number;
+}
+/**
+ * Called by a save of a saved, unconfirmed order. Raises a review when the save changes a reviewed field
+ * on a deal-created order, changes one after an approved review, or edits a renewal's carried-forward
+ * price; notes the change on an open review instead of raising a second. Returns a refusal or null.
+ */
+export declare function CheckOrderReviewOnChange(order: ReviewOrderInput, change: OrderReviewChangeFacts, ctx: ApprovalTaskContext): Promise<string | null>;
+/**
+ * Called by the save that confirms an order. Null lets the confirm through; a string refuses it and says
+ * why, and when the order needed a review it did not have, that a review was raised and who it went to.
+ */
+export declare function CheckOrderReviewAtConfirm(order: ReviewOrderInput, ctx: ApprovalTaskContext): Promise<string | null>;
+/**
+ * The order's review and where it stands, or null when it has none (or the tasks app, or the review
+ * task type, is not installed, in which case no review can exist).
+ *
+ * WHICH TASK. Every review task linked to the order is read. An open one that is assigned to someone
+ * wins, newest first, so a newer closed task (which anyone who can write task links can point at the
+ * order) never outranks an open review. With none open, the newest task decides. An open task assigned
+ * to nobody is passed over and reads as not approved, so it is replaced rather than holding the order
+ * forever.
+ */
+export declare function LatestReviewTask(orderHeaderID: string, config: OrderReviewConfig, ctx: ApprovalTaskContext): Promise<LatestReview | null>;
+/**
+ * Raise a review task for the order: decide the role, assign its active holders other than the order's
+ * creator by Person, and link the order. Throws, saying what to fix, when nobody could receive it.
+ */
+export declare function RaiseOrderReview(order: ReviewOrderInput, reasons: readonly string[], config: OrderReviewConfig, ctx: ApprovalTaskContext): Promise<RaisedReview>;
+/**
+ * The user who created the order, from its `MJ: Record Changes` Create row. With no such row (a host
+ * that does not track the entity's changes, or an order older than the tracking), the user saving.
+ */
+export declare function OrderCreatorUserID(orderHeaderID: string, ctx: ApprovalTaskContext): Promise<string>;
+export {};
+//# sourceMappingURL=OrderReview.d.ts.map

package/dist/OrderReview.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OrderReview.d.ts","sourceRoot":"","sources":["../src/OrderReview.ts"],"names":[],"mappings":"AA8CA,OAAO,6BAA6B,CAAC;AAErC,OAAO,EAkBH,KAAK,sBAAsB,EAC3B,KAAK,iBAAiB,EAMtB,KAAK,cAAc,EACnB,KAAK,eAAe,EACvB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAaH,KAAK,mBAAmB,EAC3B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAiB,KAAK,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAW9E,0FAA0F;AAC1F,MAAM,WAAW,eAAgB,SAAQ,mBAAmB;IACxD,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,kEAAkE;IAClE,kBAAkB,EAAE,OAAO,CAAC;CAC/B;AAED,qDAAqD;AACrD,MAAM,WAAW,gBAAgB;IAC7B,uCAAuC;IACvC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,KAAK,EAAE,SAAS,eAAe,EAAE,CAAC;CACrC;AAED,6EAA6E;AAC7E,UAAU,YAAY;IAClB,IAAI,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IACnD,KAAK,EAAE,eAAe,CAAC;IACvB,QAAQ,EAAE,cAAc,CAAC;CAC5B;AAED,wCAAwC;AACxC,MAAM,WAAW,YAAY;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,OAAO,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;CACzB;AAID;;;;GAIG;AACH,wBAAsB,wBAAwB,CAC1C,KAAK,EAAE,gBAAgB,EACvB,MAAM,EAAE,sBAAsB,EAC9B,GAAG,EAAE,mBAAmB,GACzB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CA6CxB;AAED;;;GAGG;AACH,wBAAsB,yBAAyB,CAAC,KAAK,EAAE,gBAAgB,EAAE,GAAG,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAiDzH;AAwED;;;;;;;;;GASG;AACH,wBAAsB,gBAAgB,CAClC,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,iBAAiB,EACzB,GAAG,EAAE,mBAAmB,GACzB,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CAiC9B;AAyND;;;GAGG;AACH,wBAAsB,gBAAgB,CAClC,KAAK,EAAE,gBAAgB,EACvB,OAAO,EAAE,SAAS,MAAM,EAAE,EAC1B,MAAM,EAAE,iBAAiB,EACzB,GAAG,EAAE,mBAAmB,GACzB,OAAO,CAAC,YAAY,CAAC,CA4DvB;AAWD;;;GAGG;AACH,wBAAsB,kBAAkB,CAAC,aAAa,EAAE,MAAM,EAAE,GAAG,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC,CAezG"}