@hantera/portal-app 20250526.0.0-develop.2 → 20250707.0.0-develop.1

package/dist/index.d.ts

@@ -2,9 +2,12 @@ import { Component } from 'vue';
 import { ComponentOptionsMixin } from 'vue';
 import { ComponentProvideOptions } from 'vue';
 import { ComputedRef } from 'vue';
-import { ContextMenuItem } from '@hantera/design-system';
-import { ContextMenuSection } from '@hantera/design-system';
-import { ContextMenuSections } from '@hantera/design-system';
+import { DataColumn } from '@hantera/design-system';
+import { DataColumnFilter } from '@hantera/design-system';
+import { DataColumnValuesEnumSet } from '@hantera/design-system';
+import { DataColumnValuesEnumValue } from '@hantera/design-system';
+import { DataProvider } from '@hantera/design-system';
+import { DataRow } from '@hantera/design-system';
 import Decimal from 'decimal.js';
 import { default as default_2 } from 'decimal.js';
 import { DefineComponent } from 'vue';
@@ -191,13 +194,24 @@ declare interface AddTagCommand_4 {
     key: string;
 }
 
+export declare interface AppContext {
+    appId: string;
+    getAppViewPath(relativePath: string, appId?: string): string;
+}
+
+/**
+ * Provides information about the current app
+ */
+export declare const appContextKey: InjectionKey<Readonly<AppContext>>;
+
 export declare namespace apps {
     export {
         defineSlot,
         defineService,
         componentContext,
-        _default as orderViewSlots,
-        _default_2 as legacySlots,
+        _default as workspaceSlots,
+        _default_2 as orderViewSlots,
+        _default_3 as legacySlots,
         AppSlot,
         AppService,
         standardServices
@@ -295,6 +309,18 @@ export declare interface BackendFetchResponse extends Response {
     graph(): Promise<any>;
 }
 
+declare interface BackOrder {
+    backOrderId: string;
+    inventoryDate: Date;
+    quantity: default_2;
+}
+
+declare interface BackOrder_2 {
+    backOrderId: string
+    inventoryDate: Date
+    quantity: Decimal
+}
+
 declare interface CalculatedDiscount {
     calculatedDiscountId: string;
     discountId: string;
@@ -417,18 +443,12 @@ declare interface ComputedDiscount_2 {
 /**
  * Provides contextual information about the current session
  */
-export declare const contextKey: InjectionKey<PortalContext>;
+export declare const contextKey: InjectionKey<Readonly<PortalContext>>;
 
 export declare const contextKeys: {
     orderView: InjectionKey<OrderViewContext>;
 };
 
-export { ContextMenuItem }
-
-export { ContextMenuSection }
-
-export { ContextMenuSections }
-
 declare function country(countryCode: string): string;
 
 /**
@@ -687,6 +707,10 @@ declare function dateTime(date: Date | string): string;
 
 declare const _default: {
     sidebar: AppSlot<unknown>;
+};
+
+declare const _default_2: {
+    sidebar: AppSlot<unknown>;
     sidebarCustomer: AppSlot<unknown>;
     toolbars: {
         deliveries: AppSlot<unknown>;
@@ -722,7 +746,7 @@ declare const _default: {
     };
 };
 
-declare const _default_2: {
+declare const _default_3: {
     legacyOrder: {
         details: {
             beforeSummary: AppSlot<unknown>;
@@ -765,7 +789,9 @@ declare const _default_2: {
             rows: AppSlot<unknown>;
             contextMenu: AppSlot<unknown>;
             row: AppSlot<unknown>;
-            rowDetails: AppSlot<unknown>;
+            rowDetails: AppSlot<    {
+            rmaRow: LegacyRmaRow;
+            }>;
         };
         invoices: {
             first: AppSlot<unknown>;
@@ -1015,6 +1041,87 @@ export declare namespace Graph_2 {
     }
 }
 
+declare class GraphDataProvider implements DataProvider {
+    private graph;
+    private graphMeta;
+    private enums;
+    private query;
+    private state;
+    private options;
+    private _rows;
+    rows: ComputedRef<DataRow[]>;
+    private _isLoading;
+    isLoading: ComputedRef<boolean>;
+    private _allLoaded;
+    allLoaded: ComputedRef<boolean>;
+    private _totalCount;
+    totalCount: ComputedRef<{
+        count: number;
+        cap: number;
+    }>;
+    private _errors;
+    errors: ComputedRef<BackendError[] | undefined>;
+    columns: ComputedRef<DataColumn[]>;
+    private abortController;
+    private lastCursor;
+    private currentQuery;
+    private currentQueryJson;
+    private rootEdges;
+    private tableHeaders;
+    constructor(graph: BackendApiGraph, graphMeta: Record<string, GraphNodeMeta_2>, enums: ReturnType<typeof useEnums>, query: Ref<GraphDataProviderQuery>, state: Ref<GraphDataProviderState>, options: Options);
+    refresh(): Promise<void>;
+    private refreshInternal;
+    protected rowHue(r: any[]): void;
+    loadMore(): Promise<void>;
+    private buildQuery;
+    private toRecord;
+    private getNodeMeta;
+}
+
+declare interface GraphDataProviderColumnState {
+    queryPath: string[];
+    field: string;
+    filters: DataColumnFilter[];
+    size?: number;
+}
+
+declare interface GraphDataProviderQuery {
+    edge: string;
+    /**
+     * These fields are always queried but not necessarily displayed. Can be used for coloring rows or
+     * providing context options.
+     */
+    dataFields?: string[];
+    /**
+     * Fields available to the user
+     */
+    availableFields: {
+        field: string;
+        label?: string;
+    }[];
+    /**
+     * Base filter that will always apply
+     */
+    filter?: string;
+    navigations?: GraphDataProviderQuery[];
+}
+
+export declare interface GraphDataProviderQueryRoot extends GraphDataProviderQuery {
+    /**
+     * Default ordering if not overridden by user.
+     */
+    orderBy?: string;
+}
+
+export declare interface GraphDataProviderState {
+    columns: GraphDataProviderColumnState[];
+    orderBy?: {
+        queryPath: string[];
+        field: string;
+        direction: 'asc' | 'desc';
+    };
+}
+
 declare type GraphEdgeCardinality = 'single' | 'many';
 
 declare type GraphEdgeCardinality_2 = 'single' | 'many';
@@ -1047,9 +1154,17 @@ declare interface GraphFieldMeta_2 {
     dimensionKey?: string;
 }
 
-declare type GraphFilterMeta = GraphFilterMetaDateTimeRange | GraphFilterMetaValues | GraphFilterMetaEnums | GraphFilterMetaNone | GraphFilterMetaNumeric;
+declare type GraphFilterMeta = GraphFilterMetaDateTimeRange | GraphFilterMetaValues | GraphFilterMetaEnums | GraphFilterMetaNone | GraphFilterMetaNumeric | GraphFilterMetaBoolean
 
-declare type GraphFilterMeta_2 = GraphFilterMetaDateTimeRange_2 | GraphFilterMetaValues_2 | GraphFilterMetaEnums_2 | GraphFilterMetaNone_2 | GraphFilterMetaNumeric_2;
+declare type GraphFilterMeta_2 = GraphFilterMetaDateTimeRange_2 | GraphFilterMetaValues_2 | GraphFilterMetaEnums_2 | GraphFilterMetaNone_2 | GraphFilterMetaNumeric_2 | GraphFilterMetaBoolean_2;
+
+declare interface GraphFilterMetaBoolean {
+    type: 'boolean'
+}
+
+declare interface GraphFilterMetaBoolean_2 {
+    type: 'boolean';
+}
 
 declare interface GraphFilterMetaDateTimeRange {
     type: 'dateTimeRange'
@@ -1108,6 +1223,8 @@ export declare namespace GraphMeta {
         GraphValueTypeMeta,
         GraphValueTypeScalar,
         GraphValueTypeEnum,
+        GraphValueTypeEnumValueSet,
+        GraphValueTypeEnumValue,
         GraphValueTypeArray,
         GraphValueTypeDynamic,
         GraphFilterMeta,
@@ -1115,6 +1232,7 @@ export declare namespace GraphMeta {
         GraphFilterMetaValues,
         GraphFilterMetaEnums,
         GraphFilterMetaNone,
+        GraphFilterMetaBoolean,
         GraphFilterMetaNumeric
     }
 }
@@ -1128,6 +1246,8 @@ export declare namespace GraphMeta_2 {
         GraphValueTypeMeta_2 as GraphValueTypeMeta,
         GraphValueTypeScalar_2 as GraphValueTypeScalar,
         GraphValueTypeEnum_2 as GraphValueTypeEnum,
+        GraphValueTypeEnumValueSet_2 as GraphValueTypeEnumValueSet,
+        GraphValueTypeEnumValue_2 as GraphValueTypeEnumValue,
         GraphValueTypeArray_2 as GraphValueTypeArray,
         GraphValueTypeDynamic_2 as GraphValueTypeDynamic,
         GraphFilterMeta_2 as GraphFilterMeta,
@@ -1135,12 +1255,14 @@ export declare namespace GraphMeta_2 {
         GraphFilterMetaValues_2 as GraphFilterMetaValues,
         GraphFilterMetaEnums_2 as GraphFilterMetaEnums,
         GraphFilterMetaNone_2 as GraphFilterMetaNone,
+        GraphFilterMetaBoolean_2 as GraphFilterMetaBoolean,
         GraphFilterMetaNumeric_2 as GraphFilterMetaNumeric
     }
 }
 
 declare interface GraphNodeMeta {
     rootEdgeName: string
+    name: string
     idField: string
     fields: Record<string, GraphFieldMeta>
     edges: Record<string, GraphEdgeMeta>
@@ -1148,6 +1270,7 @@ declare interface GraphNodeMeta {
 
 declare interface GraphNodeMeta_2 {
     rootEdgeName: string;
+    name: string;
     idField: string;
     fields: Record<string, GraphFieldMeta_2>;
     edges: Record<string, GraphEdgeMeta_2>;
@@ -1161,9 +1284,9 @@ export declare interface GraphQueryNavigation {
     orderBy?: string;
     filter?: string;
     phrase?: string;
-    phraseFields?: string;
+    after?: string;
     node: {
-        fields: string[];
+        fields?: string[];
         navigate?: GraphQueryNavigation[];
     };
 }
@@ -1190,12 +1313,32 @@ declare interface GraphValueTypeDynamic_2 {
 
 declare interface GraphValueTypeEnum {
     type: 'enum'
-    values: string[]
+    valueSets: Record<string, GraphValueTypeEnumValueSet>
 }
 
 declare interface GraphValueTypeEnum_2 {
     type: 'enum';
-    values: string[];
+    valueSets: Record<string, GraphValueTypeEnumValueSet_2>;
+}
+
+declare interface GraphValueTypeEnumValue {
+    label: Record<string, string>
+    hue?: Decimal
+}
+
+declare interface GraphValueTypeEnumValue_2 {
+    label: Record<string, string>;
+    hue?: Decimal;
+}
+
+declare interface GraphValueTypeEnumValueSet {
+    label: Record<string, string>
+    values: Record<string, GraphValueTypeEnumValue>
+}
+
+declare interface GraphValueTypeEnumValueSet_2 {
+    label: Record<string, string>;
+    values: Record<string, GraphValueTypeEnumValue_2>;
 }
 
 declare type GraphValueTypeMeta = GraphValueTypeScalar | GraphValueTypeEnum | GraphValueTypeArray | GraphValueTypeDynamic
@@ -1229,9 +1372,6 @@ export declare const hostKey: InjectionKey<Host>;
  * Messages sent from client to host
  */
 declare type HostMessage = {
-    type: 'navigated';
-    path: string;
-} | {
     type: 'expiredSession';
 } | {
     type: 'signOut';
@@ -1364,7 +1504,7 @@ export declare interface JsonTableResponse {
         first?: string;
         last?: string;
     };
-    totalCount?: number;
+    totalCount?: default_2;
     headers: string[];
     rows: Array<Array<unknown>>;
 }
@@ -1401,7 +1541,7 @@ export declare interface LegacyAdjustment {
     adjustmentTotal: default_2;
     adjustmentVat: default_2;
     fields: LegacyField[];
-    orderRule: LegacyRule;
+    orderRule?: LegacyRule;
     actionId: string;
 }
 
@@ -1646,6 +1786,9 @@ export declare const legacyOrderCommands: {
     setDeliveryAsReleased: TypedCommand<{
         deliveryId: string;
     }>;
+    cancelDelivery: TypedCommand<{
+        deliveryId: string;
+    }>;
     setRmaRowReference: TypedCommand<{
         rmaId: string;
         rmaRowId: string;
@@ -1910,6 +2053,10 @@ declare namespace Models_2 {
 
 declare function number(value: default_2 | number): string;
 
+declare interface Options {
+    rowHue?: (row: Record<string, any>) => number | string | undefined;
+}
+
 declare interface Order {
     orderId: string
     orderNumber: string
@@ -2040,6 +2187,7 @@ declare interface OrderLine {
     image?: string;
     quantity: default_2;
     returnedQuantity: default_2;
+    reservedQuantity: default_2;
     salesQuantity: default_2;
     unitPrice: default_2;
     taxFactor: default_2;
@@ -2048,6 +2196,8 @@ declare interface OrderLine {
     dynamic: Record<string, any>;
     calculatedDiscounts: Array<CalculatedDiscount>;
     orderLineDiscounts: Array<Discount>;
+    backOrders: Array<BackOrder>;
+    skus: Array<OrderLineSku>;
 }
 
 declare interface OrderLine_2 {
@@ -2058,6 +2208,7 @@ declare interface OrderLine_2 {
     image?: string
     quantity: Decimal
     returnedQuantity: Decimal
+    reservedQuantity: Decimal
     salesQuantity: Decimal
     unitPrice: Decimal
     taxFactor: Decimal
@@ -2067,6 +2218,27 @@ declare interface OrderLine_2 {
 
     calculatedDiscounts: Array<CalculatedDiscount_2>
     orderLineDiscounts: Array<Discount_2>
+    backOrders: Array<BackOrder_2>
+    skus: Array<OrderLineSku_2>
+}
+
+declare interface OrderLineSku {
+    skuNumber: string;
+    totalQuantity: default_2;
+    reservedQuantity: default_2;
+    unitQuantity: default_2;
+    stockReservations: Array<StockReservation>;
+    backOrders: Array<BackOrder>;
+}
+
+declare interface OrderLineSku_2 {
+    skuNumber: string
+    totalQuantity: Decimal
+    reservedQuantity: Decimal
+    unitQuantity: Decimal
+
+    stockReservations: Array<StockReservation_2>
+    backOrders: Array<BackOrder_2>
 }
 
 declare interface OrderViewContext {
@@ -2255,6 +2427,31 @@ export declare interface PortalContext {
     user(): User;
     authorize(pattern: string): boolean;
     authorizeAll(patterns?: string[]): boolean;
+    mode: 'workspace' | 'stack';
+    /**
+     * If set upon initial load, instructs the view manager to open this view
+     */
+    defaultViewUri?: string;
+    /**
+     * Opens the view specified by the path.
+     * @param uri The view URI to the view to open. May contain a querystring.
+     * @param options
+     */
+    openView(uri: string, options: ViewOptions): Readonly<ViewContext>;
+    /**
+     * Gets a view by its ID
+     * @param viewId
+     */
+    getView(viewId: string | undefined): Readonly<ViewContext> | undefined;
+    /**
+     * Gets all the views opened as child of the specified view
+     * @param parentViewId View ID of the parent to fetch child views of
+     */
+    getChildrenViews(parentViewId: string | undefined): Readonly<ViewContext>[];
+    /**
+     * Provides access to current view. Will be undefined outside any view.
+     */
+    currentView: ComputedRef<Readonly<ViewContext> | undefined>;
 }
 
 export declare interface Processes {
@@ -2781,6 +2978,21 @@ declare interface StaticDiscount_2 {
     createdAt: Date
 }
 
+declare interface StockReservation {
+    stockReservationId: string;
+    inventoryDate: Date;
+    quantity: default_2;
+}
+
+declare interface StockReservation_2 {
+    stockReservationId: string
+    inventoryDate: Date
+    quantity: Decimal
+
+    // Add incoming stock and allocation
+    // Add stock position
+}
+
 declare function string(template: string, values?: {
     [key: string]: string | number | undefined | null;
 }): string;
@@ -2841,6 +3053,11 @@ declare interface UnsetDeliveryInventoryCommand {
     deliveryId: string;
 }
 
+export declare function useAppContext(): {
+    appId: string;
+    getAppViewPath(relativePath: string, appId?: string): string;
+};
+
 export declare function useBackendApi(): {
     fetch: BackendFetch;
     legacyOrders: BackendApiOrders;
@@ -2855,6 +3072,12 @@ export declare function useContext(): {
     user(): User;
     authorize(pattern: string): boolean;
     authorizeAll(patterns?: string[]): boolean;
+    mode: "workspace" | "stack";
+    defaultViewUri?: string;
+    openView(uri: string, options: ViewOptions): Readonly<ViewContext>;
+    getView(viewId: string | undefined): Readonly<ViewContext> | undefined;
+    getChildrenViews(parentViewId: string | undefined): Readonly<ViewContext>[];
+    currentView: ComputedRef<Readonly<ViewContext> | undefined>;
 };
 
 export declare function useDialogs(): {
@@ -2903,18 +3126,18 @@ export declare function useDialogs(): {
     alert(message: string, title?: string, confirmLabel?: string): Promise<void>;
 };
 
-export declare function useEnumFields(): {
-    valueLabel(nodeName: string, fieldName: string, value: string): ComputedRef<string>;
-    valueColor(nodeName: string, fieldName: string, value: string): ComputedRef<string>;
-    values(nodeName: string, fieldName: string): ComputedRef<{
-        categoryId?: string;
-        sortOrder: number;
-        name: string;
-        values: string[];
-    }[]>;
+export declare function useEnums(): {
+    valueSets(nodeName: string, fieldName: string): ComputedRef<DataColumnValuesEnumSet[]>;
+    value(nodeName: string, fieldName: string, valueKey: string): ComputedRef<DataColumnValuesEnumValue | undefined>;
     openEditor(nodeName: string, fieldName: string, value?: string): void;
 };
 
+/**
+ * Creates a GraphDataProvider that can be used to easily create DataTables or ListDetailLayouts
+ * that work with the Hantera Graph.
+ */
+export declare function useGraphDataProvider(query: Ref<GraphDataProviderQueryRoot>, state: Ref<GraphDataProviderState>, options?: Options): GraphDataProvider;
+
 export declare function useGraphMeta(): Record<string, GraphNodeMeta_2>;
 
 export declare function useHost(): {
@@ -2957,6 +3180,45 @@ declare interface User {
  */
 export declare function useRegistry(): Record<string, any>;
 
+export declare interface ViewContext {
+    /**
+     * A unique ID identifying this view instance
+     */
+    viewId: string;
+    /**
+     * The current path of the view
+     */
+    path: Readonly<string>;
+    query: Readonly<Record<string, string | undefined>>;
+    uri: Readonly<string>;
+    /**
+     * The state can be used to store arbitrary data in the view between
+     * reloads (if supported by view manager).
+     */
+    state: Record<string, any>;
+    name: Ref<string | undefined>;
+    hasPendingChanges: Ref<boolean>;
+    parentView?: Readonly<string>;
+    /**
+     * Closes the view
+     */
+    close(): void;
+    /**
+     * Replaces the view with another view specified by the path
+     * @param uri The path to the view to open. May contain a querystring
+     * @param options
+     */
+    navigate(uri: string, options?: ViewNavigateOptions): void;
+    /**
+     * Whether this view is currently visible to the user
+     */
+    visible: Readonly<boolean>;
+    /**
+     * Whether this is the active view user is currently interacting with.
+     */
+    active: Readonly<boolean>;
+}
+
 export declare namespace ViewContexts {
     export {
         OrderViewContext,
@@ -2964,6 +3226,26 @@ export declare namespace ViewContexts {
     }
 }
 
+export declare interface ViewNavigateOptions {
+    /**
+     * Optional structured "querystring" to pass to the view. As an alternative to path-embedded querystring
+     */
+    query?: Record<string, string | undefined>;
+    state?: Record<string, any>;
+}
+
+export declare interface ViewOptions {
+    /**
+     * Optional structured "querystring" to pass to the view. As an alternative to path-embedded querystring
+     */
+    query?: Record<string, string | undefined>;
+    state?: Record<string, any>;
+    /**
+     * If set, allows views to be queried using PortalContext.getChildrenViews
+     */
+    parentViewId?: string;
+}
+
 export declare interface WorkspaceMenuItem {
     folderPath: string;
     label: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hantera/portal-app",
-  "version": "20250526.0.0-develop.2",
+  "version": "20250707.0.0-develop.1",
   "types": "./dist/index.d.ts",
   "scripts": {
     "build": "cpx ../../portal/portal-app/dist/**/*.d.ts ./dist -C"