@mj-biz-apps/orders-ng 0.0.1 → 5.2.0

package/dist/lib/sections/orders-sections.component.d.ts

@@ -0,0 +1,282 @@
+/**
+ * @fileoverview The four Explorer tabs.
+ *
+ * Each class is registered with `@RegisterClass(BaseResourceComponent, '<DriverClass>')`
+ * under the name the Application's `DefaultNavItems` reference
+ * (`metadata/applications/.orders-application.json`), which is what makes these
+ * plug into MJ Explorer with no host-side wiring: Explorer reads the nav metadata,
+ * asks the class factory for the driver class, and mounts it as a tab.
+ *
+ * Each section is deliberately thin. It owns three things — its rail, which
+ * sub-page is showing, and remembering that across sessions — and delegates the
+ * frame to {@link MJOSectionShellComponent} and the content to the sub-page
+ * components. Anything more here would be logic that belongs to a page.
+ *
+ * SUB-PAGE HOSTING. Pages are created once and CACHED, so switching rails and
+ * coming back does not discard a half-entered order. That is not an optimisation;
+ * an order taker who loses their work to a mis-click stops trusting the tool.
+ *
+ * @module @mj-biz-apps/orders-ng
+ */
+import { OnInit, Type, ViewContainerRef, type ComponentRef } from '@angular/core';
+import { BaseResourceComponent } from '@memberjunction/ng-shared';
+import type { MJLeftNavSection } from '@memberjunction/ng-ui-components';
+import type { ResourceData } from '@memberjunction/core-entities';
+import type { OrderHeaderEntity } from '@mj-biz-apps/orders-entities';
+import { type OrdersNavBadges, type OrdersSubPage } from './section-nav.model.js';
+import * as i0 from "@angular/core";
+/**
+ * Shared behaviour for the four sections: rail construction, active-page state,
+ * per-user persistence of where someone was, and cached sub-page mounting.
+ *
+ * A `@Directive` rather than a plain class so Angular's compiler accepts the
+ * `@ViewChild` declared here and inherited by each concrete section — the
+ * documented way to share member decorators across component subclasses.
+ */
+export declare abstract class MJOSectionBaseComponent extends BaseResourceComponent implements OnInit {
+    /** Where a sub-page is created. Declared once, inherited by all four sections. */
+    protected pageHost?: ViewContainerRef;
+    private readonly cdr;
+    /** The rail, rebuilt whenever a badge count changes. */
+    NavSections: MJLeftNavSection[];
+    /** Which sub-page is showing. */
+    ActivePageId: string | null;
+    IsLoading: boolean;
+    LoadError: string | null;
+    /** Live counts the rail badges. Sections refresh these; zero badges do not render. */
+    protected badges: OrdersNavBadges;
+    protected readonly mounted: Map<string, ComponentRef<unknown>>;
+    /** The section's pages, in rail order. */
+    protected abstract get subPages(): OrdersSubPage[];
+    /** Key under which this section remembers the user's last page. */
+    protected abstract get preferenceKey(): string;
+    /**
+     * Component type for a page id, or `null` while a page is still to be built.
+     * Returning null renders the "not built yet" notice rather than throwing —
+     * a rail item that cannot open is a bug, but a blank tab is a worse one.
+     */
+    protected abstract resolvePage(pageId: string): Type<unknown> | null;
+    ngOnInit(): void;
+    /** Rail click handler. */
+    OnPageSelected(pageId: string): Promise<void>;
+    /** Rebuild the rail after badge counts change. */
+    protected refreshBadges(badges: OrdersNavBadges): void;
+    /**
+     * Mount a page, reusing the instance if it has been shown before.
+     *
+     * Cached views are detached rather than destroyed, which is what preserves a
+     * part-typed order across a trip to another rail item.
+     */
+    protected showPage(pageId: string): Promise<void>;
+    /**
+     * Connect a freshly created page to the section.
+     *
+     * A page created through `ViewContainerRef.createComponent` has NO template
+     * binding its outputs — there is no host markup for Angular to wire. Every
+     * `@Output()` on every page therefore emitted into nothing: the confirm button
+     * fired `ConfirmRequested` at no listener, dashboard tiles fired
+     * `NavigateRequested` at no listener, and list rows fired `OrderOpened` at no
+     * listener. The pages looked complete and were inert.
+     *
+     * Subscribed by NAME and only when present, because the four sections host
+     * different pages and a missing output is normal rather than an error.
+     */
+    private wirePage;
+    /**
+     * Give a page the data its inputs expect.
+     *
+     * Set by NAME and only when the property exists, because the four sections
+     * host different pages and an absent input is normal rather than an error —
+     * the same shape as the output wiring above.
+     *
+     * The catalog is loaded ONCE per section and shared. Every page that needs it
+     * needs the same list, and re-reading it per page would be a round trip to
+     * produce an answer already in memory.
+     */
+    private sharedInputs;
+    private catalogCache;
+    /** The product picker's options, shaped as it expects them. */
+    private catalogOptions;
+    private companyCache;
+    /**
+     * The company a new order belongs to.
+     *
+     * Taken from the catalog rather than asked for: a company with no products
+     * cannot be sold from, so the first product's company is a better default than
+     * an empty picker. A multi-company user changes it on the order.
+     */
+    private defaultCompanyID;
+    private tenderCache;
+    /** Tenders a payment can be taken on. */
+    private tenderOptions;
+    /** Remember which record a destination page should open, then go there. */
+    protected openRecord(pageId: string, row: {
+        ID?: string;
+    } | string): void;
+    /** Open an entity record in Explorer — same path as the generated form host. */
+    protected openEntity(entityName: string, row: {
+        ID?: string;
+    } | string): void;
+    /** Set when a page was opened for a specific record. */
+    PendingRecordID: string | null;
+    /**
+     * The action the primary button performs, or null for a section that has no
+     * single obvious thing to start.
+     *
+     * Deliberately per-section rather than a global "New order". On Receivables
+     * and Catalog there is no one thing a person arrives wanting to create, and a
+     * primary button that guesses is worse than none — it makes the wrong action
+     * the most prominent one on the page.
+     */
+    protected get primaryAction(): {
+        Label: string;
+        Icon: string;
+        PageId?: string;
+        EntityName?: string;
+    } | null;
+    /** When the visible data was last read. Shown so a stale screen can be spotted. */
+    LoadedAt: Date | null;
+    /** The 'as of' chip. Time only — the date is today by construction. */
+    get LoadedAtDisplay(): string;
+    /**
+     * Re-read the active page.
+     *
+     * Destroys the cached instance rather than asking it to reload, because a page
+     * has no reload contract — some load in `ngOnInit`, some on a preset change,
+     * and inventing an interface every page must implement to support one button
+     * is more surface than the button is worth. Recreating runs whatever the page
+     * already does on mount.
+     */
+    RefreshActivePage(): void;
+    /** Start the section's primary action. */
+    StartPrimary(): void;
+    private readonly entry;
+    /** A confirm is in flight — the button says so and cannot be pressed twice. */
+    Confirming: boolean;
+    /** Why the last confirm was refused, rendered verbatim. Null when there is nothing to say. */
+    ConfirmError: string | null;
+    /**
+     * Confirm an order. THE ENGINE IS THE ONLY AUTHORITY, AND IT IS ASKED ONCE.
+     *
+     * This used to open a pre-flight backed by `Orders.PreviewConfirm`, which ran the
+     * REAL confirm inside a rolled-back transaction so it could show the journal
+     * entries the commit would write. Truthful, and far too expensive: every confirm
+     * booked the order twice, and the button was GATED on the throwaway run, so a
+     * transient failure in the half nobody would ever see blocked the half that
+     * mattered. Repeatedly, that presented as "the confirm button does nothing".
+     *
+     * So there is no dry run. `Orders.ConfirmOrder` either books — journal entries,
+     * subscriptions, entitlements, the initial payment, one transaction — or it is
+     * refused with a reason. Every rule that was pre-checked is still enforced, by
+     * `OrderEntityServer.ValidateAsync` and the booking walk; the difference is that
+     * the refusal now reaches the user as itself rather than as a prediction of
+     * itself. `MJOPricingScheduler.Confirm` throws on refusal, and the catch below
+     * puts that sentence on screen.
+     *
+     * A richer pre-flight can come back, but it must be built on a read-only decide
+     * pass (the shape `Orders.PreviewPrice` already has), never on a save.
+     */
+    Confirm(draft: OrderHeaderEntity): Promise<void>;
+    /** Dismiss the refusal banner. */
+    ClearConfirmError(): void;
+    /**
+     * Throw away cached pages so the next visit re-reads.
+     *
+     * The ACTIVE page is kept: it is on screen, the user is looking at it, and destroying it under
+     * them would blank the view mid-interaction. Everything else is a snapshot of the world before
+     * whatever just changed.
+     */
+    private dropStalePages;
+    /** First page in the rail — the fallback when nothing is remembered. */
+    protected get defaultPageId(): string;
+    /**
+     * Restore the last page this user was on.
+     *
+     * Guarded, and falls back to the default rather than throwing: an unknown id
+     * means the rail was renamed since the preference was written, and stranding
+     * someone on a blank tab because of a rename is the wrong trade.
+     */
+    protected restorePageId(): string;
+    protected persistPageId(pageId: string): void;
+    GetResourceDisplayName(_data: ResourceData): Promise<string>;
+    GetResourceIconClass(_data: ResourceData): Promise<string>;
+    protected abstract get sectionTitle(): string;
+    protected abstract get sectionIcon(): string;
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MJOSectionBaseComponent, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<MJOSectionBaseComponent, never, never, {}, {}, never, never, true, never>;
+}
+/**
+ * The Orders tab — take an order, then work the ones you have.
+ *
+ * Default tab of the application, because taking an order is the job most people
+ * open this app to do.
+ */
+export declare class OrdersSectionResource extends MJOSectionBaseComponent {
+    /** Taking an order is what someone arrives at this section to do. */
+    protected get primaryAction(): {
+        Label: string;
+        Icon: string;
+        PageId: string;
+    };
+    StartPrimary(): void;
+    protected get subPages(): OrdersSubPage[];
+    protected get preferenceKey(): string;
+    protected get sectionTitle(): string;
+    protected get sectionIcon(): string;
+    /**
+     * Dashboard, list, fulfillment, and returns. New/existing orders open as
+     * Explorer record tabs via NavigationService, not as rail pages.
+     */
+    protected resolvePage(pageId: string): Type<unknown> | null;
+    static ɵfac: i0.ɵɵFactoryDeclaration<OrdersSectionResource, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<OrdersSectionResource, "mjo-orders-section", never, {}, {}, never, never, true, never>;
+}
+/** The Payments tab — take the cash, and say what it settles. */
+export declare class PaymentsSectionResource extends MJOSectionBaseComponent {
+    protected get primaryAction(): {
+        Label: string;
+        Icon: string;
+        EntityName: "MJ_BizApps_Orders: Payment Headers";
+    };
+    protected get subPages(): OrdersSubPage[];
+    protected get preferenceKey(): string;
+    protected get sectionTitle(): string;
+    protected get sectionIcon(): string;
+    protected resolvePage(pageId: string): Type<unknown> | null;
+    static ɵfac: i0.ɵɵFactoryDeclaration<PaymentsSectionResource, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<PaymentsSectionResource, "mjo-payments-section", never, {}, {}, never, never, true, never>;
+}
+/**
+ * The Receivables tab — A/R, collections and subscriptions.
+ *
+ * Its own section rather than a "Reports" folder: aging and renewals are
+ * operational work with worklists and actions, and filing them under Reports
+ * would tell the accounting team their work is read-only.
+ */
+export declare class ReceivablesSectionResource extends MJOSectionBaseComponent {
+    protected get subPages(): OrdersSubPage[];
+    protected get preferenceKey(): string;
+    protected get sectionTitle(): string;
+    protected get sectionIcon(): string;
+    protected resolvePage(pageId: string): Type<unknown> | null;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ReceivablesSectionResource, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ReceivablesSectionResource, "mjo-receivables-section", never, {}, {}, never, never, true, never>;
+}
+/**
+ * The Catalog tab — where the behaviour every order inherits is configured.
+ *
+ * Product type decides revenue recognition, taxability, fulfillment and
+ * recurrence, so this is the section that makes the order screens correct by
+ * default instead of asking the user to restate it per line.
+ */
+export declare class CatalogSectionResource extends MJOSectionBaseComponent {
+    protected get subPages(): OrdersSubPage[];
+    protected get preferenceKey(): string;
+    protected get sectionTitle(): string;
+    protected get sectionIcon(): string;
+    protected resolvePage(pageId: string): Type<unknown> | null;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CatalogSectionResource, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<CatalogSectionResource, "mjo-catalog-section", never, {}, {}, never, never, true, never>;
+}
+//# sourceMappingURL=orders-sections.component.d.ts.map

package/dist/lib/sections/orders-sections.component.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"orders-sections.component.d.ts","sourceRoot":"","sources":["../../../src/lib/sections/orders-sections.component.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAIH,MAAM,EACN,IAAI,EAEJ,gBAAgB,EAEhB,KAAK,YAAY,EAEpB,MAAM,eAAe,CAAC;AAGvB,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACzE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAKlE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AA+BtE,OAAO,EAMH,KAAK,eAAe,EACpB,KAAK,aAAa,EACrB,MAAM,qBAAqB,CAAC;;AAE7B;;;;;;;GAOG;AACH,8BACsB,uBAAwB,SAAQ,qBAAsB,YAAW,MAAM;IACzF,kFAAkF;IAElF,SAAS,CAAC,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAEtC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAA6B;IAEjD,wDAAwD;IACjD,WAAW,EAAE,gBAAgB,EAAE,CAAM;IAE5C,iCAAiC;IAC1B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAQ;IAEnC,SAAS,UAAS;IAClB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAQ;IAEvC,sFAAsF;IACtF,SAAS,CAAC,MAAM,EAAE,eAAe,CAAM;IAEvC,SAAS,CAAC,QAAQ,CAAC,OAAO,qCAA4C;IAEtE,0CAA0C;IAC1C,SAAS,CAAC,QAAQ,KAAK,QAAQ,IAAI,aAAa,EAAE,CAAC;IAEnD,mEAAmE;IACnE,SAAS,CAAC,QAAQ,KAAK,aAAa,IAAI,MAAM,CAAC;IAE/C;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI;IAEpD,QAAQ,IAAI,IAAI;IA6BhC,0BAA0B;IACb,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAO1D,kDAAkD;IAClD,SAAS,CAAC,aAAa,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI;IAKtD;;;;;OAKG;cACa,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAgFvD;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,QAAQ;IA6ChB;;;;;;;;;;OAUG;YACW,YAAY;IAU1B,OAAO,CAAC,YAAY,CAAmC;IAEvD,+DAA+D;YACjD,cAAc;IAO5B,OAAO,CAAC,YAAY,CAAuB;IAE3C;;;;;;OAMG;YACW,gBAAgB;IAO9B,OAAO,CAAC,WAAW,CAA+C;IAElE,yCAAyC;YAC3B,aAAa;IAc3B,2EAA2E;IAC3E,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE;QAAE,EAAE,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM,GAAG,IAAI;IAKzE,gFAAgF;IAChF,SAAS,CAAC,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE;QAAE,EAAE,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM,GAAG,IAAI;IAM7E,wDAAwD;IACjD,eAAe,EAAE,MAAM,GAAG,IAAI,CAAQ;IAI7C;;;;;;;;OAQG;IACH,SAAS,KAAK,aAAa,IAAI;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAE1G;IAED,mFAAmF;IAC5E,QAAQ,EAAE,IAAI,GAAG,IAAI,CAAQ;IAEpC,uEAAuE;IACvE,IAAW,eAAe,IAAI,MAAM,CAGnC;IAED;;;;;;;;OAQG;IACI,iBAAiB,IAAI,IAAI;IAYhC,0CAA0C;IACnC,YAAY,IAAI,IAAI;IAwB3B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA+B;IAErD,+EAA+E;IACxE,UAAU,UAAS;IAC1B,8FAA8F;IACvF,YAAY,EAAE,MAAM,GAAG,IAAI,CAAQ;IAE1C;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,OAAO,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAwD7D,kCAAkC;IAC3B,iBAAiB,IAAI,IAAI;IAIhC;;;;;;OAMG;IACH,OAAO,CAAC,cAAc;IAQtB,wEAAwE;IACxE,SAAS,KAAK,aAAa,IAAI,MAAM,CAEpC;IAED;;;;;;OAMG;IACH,SAAS,CAAC,aAAa,IAAI,MAAM;IAUjC,SAAS,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAQvB,sBAAsB,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IAI5D,oBAAoB,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IAIhF,SAAS,CAAC,QAAQ,KAAK,YAAY,IAAI,MAAM,CAAC;IAC9C,SAAS,CAAC,QAAQ,KAAK,WAAW,IAAI,MAAM,CAAC;IAE7B,WAAW,IAAI,IAAI;yCApgBjB,uBAAuB;2CAAvB,uBAAuB;CA2gB5C;AAMD;;;;;GAKG;AACH,qBAkEa,qBAAsB,SAAQ,uBAAuB;IAC9D,qEAAqE;IACrE,cAAuB,aAAa;;;;MAEnC;IAEe,YAAY,IAAI,IAAI;IAIpC,SAAS,KAAK,QAAQ,IAAI,aAAa,EAAE,CAExC;IACD,SAAS,KAAK,aAAa,IAAI,MAAM,CAEpC;IACD,SAAS,KAAK,YAAY,IAAI,MAAM,CAEnC;IACD,SAAS,KAAK,WAAW,IAAI,MAAM,CAElC;IAED;;;OAGG;IACH,SAAS,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI;yCA3BlD,qBAAqB;2CAArB,qBAAqB;CAyCjC;AAMD,iEAAiE;AACjE,qBA0Ca,uBAAwB,SAAQ,uBAAuB;IAChE,cAAuB,aAAa;;;;MAEnC;IAED,SAAS,KAAK,QAAQ,IAAI,aAAa,EAAE,CAExC;IACD,SAAS,KAAK,aAAa,IAAI,MAAM,CAEpC;IACD,SAAS,KAAK,YAAY,IAAI,MAAM,CAEnC;IACD,SAAS,KAAK,WAAW,IAAI,MAAM,CAElC;IACD,SAAS,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI;yCAjBlD,uBAAuB;2CAAvB,uBAAuB;CA+BnC;AAMD;;;;;;GAMG;AACH,qBA0Ca,0BAA2B,SAAQ,uBAAuB;IACnE,SAAS,KAAK,QAAQ,IAAI,aAAa,EAAE,CAExC;IACD,SAAS,KAAK,aAAa,IAAI,MAAM,CAEpC;IACD,SAAS,KAAK,YAAY,IAAI,MAAM,CAEnC;IACD,SAAS,KAAK,WAAW,IAAI,MAAM,CAElC;IACD,SAAS,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI;yCAblD,0BAA0B;2CAA1B,0BAA0B;CAyBtC;AAMD;;;;;;GAMG;AACH,qBA0Ca,sBAAuB,SAAQ,uBAAuB;IAC/D,SAAS,KAAK,QAAQ,IAAI,aAAa,EAAE,CAExC;IACD,SAAS,KAAK,aAAa,IAAI,MAAM,CAEpC;IACD,SAAS,KAAK,YAAY,IAAI,MAAM,CAEnC;IACD,SAAS,KAAK,WAAW,IAAI,MAAM,CAElC;IACD,SAAS,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI;yCAblD,sBAAsB;2CAAtB,sBAAsB;CA2BlC"}