@multiplatform.one/backoffice 6.3.0 → 6.4.1

package/types/workspace/types.d.ts

@@ -0,0 +1,112 @@
+/**
+ * Frappe Workspace doc shapes — verified against a real bench
+ * (`GET /api/resource/Workspace/<name>`; see WorkspaceScreen for the
+ * rendering contract). `content` is an editorjs-style JSON string of
+ * blocks; the child tables hold the referenced widget definitions.
+ */
+/** One row of the `shortcuts` child table (doctype "Workspace Shortcut"). */
+export interface WorkspaceShortcutRow {
+    name: string;
+    /** "DocType" | "Report" | "Page" | "Dashboard" | "URL" */
+    type: string;
+    link_to?: string;
+    /** URL shortcuts put the target here. */
+    url?: string;
+    label: string;
+    /** Optional list-view variant, e.g. "List" | "Tree" | "Report Builder". */
+    doc_view?: string;
+    /** Frappe color name for the count pill, e.g. "Grey", "Blue". */
+    color?: string;
+    /** JSON filters for the live count, e.g. `{"status":"Open"}`. */
+    stats_filter?: string;
+    /** Count display template, `{}` is the count, e.g. `"{} Open"`. */
+    format?: string;
+}
+/** One row of the `links` child table (doctype "Workspace Link"). */
+export interface WorkspaceLinkRow {
+    name: string;
+    /** "Card Break" starts a link group; "Link" is a member of the group. */
+    type: "Card Break" | "Link" | string;
+    label: string;
+    /** "DocType" | "Report" | "Page" — only on type "Link". */
+    link_type?: string;
+    link_to?: string;
+    hidden?: number;
+    onboard?: number;
+    is_query_report?: number;
+    /** On Card Break rows: number of links desk shows before "+ N more". */
+    link_count?: number;
+    dependencies?: string;
+}
+/** One row of the `charts` child table (doctype "Workspace Chart"). */
+export interface WorkspaceChartRow {
+    name: string;
+    /** Dashboard Chart doc name. */
+    chart_name: string;
+    label?: string;
+}
+/** One row of the `number_cards` child table (doctype "Workspace Number Card"). */
+export interface WorkspaceNumberCardRow {
+    name: string;
+    /** Number Card doc name. */
+    number_card_name: string;
+    label?: string;
+}
+/** One row of the `quick_lists` child table (doctype "Workspace Quick List"). */
+export interface WorkspaceQuickListRow {
+    name: string;
+    document_type: string;
+    label?: string;
+    /** JSON filters, e.g. `{"status":["=","Open"]}`. */
+    quick_list_filter?: string;
+}
+/** The Workspace document (fields the workspace page renders). */
+export interface WorkspaceDoc {
+    name: string;
+    doctype: string;
+    title?: string;
+    label?: string;
+    icon?: string;
+    module?: string;
+    public?: number;
+    is_hidden?: number;
+    /** JSON string of editorjs-style blocks. */
+    content?: string;
+    shortcuts?: WorkspaceShortcutRow[];
+    links?: WorkspaceLinkRow[];
+    charts?: WorkspaceChartRow[];
+    number_cards?: WorkspaceNumberCardRow[];
+    quick_lists?: WorkspaceQuickListRow[];
+    [key: string]: unknown;
+}
+export type WorkspaceBlockType = "header" | "paragraph" | "shortcut" | "card" | "chart" | "number_card" | "quick_list" | "spacer" | "onboarding" | (string & {});
+export interface WorkspaceBlock {
+    id: string;
+    type: WorkspaceBlockType;
+    data: {
+        /** header / paragraph: HTML-ish rich text. */
+        text?: string;
+        /** shortcut: matches `shortcuts[].label`. */
+        shortcut_name?: string;
+        /** card: matches a Card Break `links[].label`. */
+        card_name?: string;
+        /** chart: matches `charts[].chart_name`. */
+        chart_name?: string;
+        /** number_card: matches `number_cards[].number_card_name`. */
+        number_card_name?: string;
+        /** quick_list: matches `quick_lists[].document_type`. */
+        quick_list_name?: string;
+        /** 12-column grid span (3 = shortcut pill, 4 = card, 12 = full row). */
+        col?: number;
+        [key: string]: unknown;
+    };
+}
+/** A Card Break row grouped together with its following Link rows. */
+export interface WorkspaceLinkGroup {
+    label: string;
+    breakRow: WorkspaceLinkRow;
+    links: WorkspaceLinkRow[];
+}
+/** Frappe filter triple, ready for the frappe client (`[field, op, value]`). */
+export type FrappeFilterTuple = [string, string, unknown];
+//# sourceMappingURL=types.d.ts.map

package/types/workspace/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/workspace/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,6EAA6E;AAC7E,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,0DAA0D;IAC1D,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yCAAyC;IACzC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iEAAiE;IACjE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iEAAiE;IACjE,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mEAAmE;IACnE,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,qEAAqE;AACrE,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,yEAAyE;IACzE,IAAI,EAAE,YAAY,GAAG,MAAM,GAAG,MAAM,CAAC;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,2DAA2D;IAC3D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,wEAAwE;IACxE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,uEAAuE;AACvE,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,gCAAgC;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,mFAAmF;AACnF,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,4BAA4B;IAC5B,gBAAgB,EAAE,MAAM,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,iFAAiF;AACjF,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,oDAAoD;IACpD,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,kEAAkE;AAClE,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4CAA4C;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACnC,KAAK,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC3B,MAAM,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC7B,YAAY,CAAC,EAAE,sBAAsB,EAAE,CAAC;IACxC,WAAW,CAAC,EAAE,qBAAqB,EAAE,CAAC;IACtC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAMD,MAAM,MAAM,kBAAkB,GAC1B,QAAQ,GACR,WAAW,GACX,UAAU,GACV,MAAM,GACN,OAAO,GACP,aAAa,GACb,YAAY,GACZ,QAAQ,GACR,YAAY,GACZ,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAElB,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,kBAAkB,CAAC;IACzB,IAAI,EAAE;QACJ,8CAA8C;QAC9C,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,6CAA6C;QAC7C,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,kDAAkD;QAClD,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,4CAA4C;QAC5C,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,8DAA8D;QAC9D,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,yDAAyD;QACzD,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,wEAAwE;QACxE,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;CACH;AAED,sEAAsE;AACtE,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,KAAK,EAAE,gBAAgB,EAAE,CAAC;CAC3B;AAED,gFAAgF;AAChF,MAAM,MAAM,iBAAiB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC"}

package/types/workspace/useDashboardChart.d.ts

@@ -0,0 +1,29 @@
+export interface DashboardChartSeries {
+    labels: string[];
+    datasets: Array<{
+        name?: string;
+        values: number[];
+    }>;
+}
+export interface DashboardChartDoc {
+    name: string;
+    doctype: string;
+    chart_name?: string;
+    /** Render style: "Line" | "Bar" | "Percentage" | "Pie" | "Donut" | "Heatmap" */
+    type?: string;
+    /** Data source kind: "Count" | "Sum" | "Average" | "Group By" | "Report" | "Custom" */
+    chart_type?: string;
+    document_type?: string;
+    [key: string]: unknown;
+}
+export interface UseDashboardChartDataResult {
+    series: DashboardChartSeries | undefined;
+    isLoading: boolean;
+    error: Error | undefined;
+    /** Fixture mode (stories/tests) — no RPC available for chart data. */
+    unsupported: boolean;
+    refresh: () => void;
+}
+/** Fetch a Dashboard Chart's series via the desk RPC (live mode only). */
+export declare function useDashboardChartData(chartName: string | undefined): UseDashboardChartDataResult;
+//# sourceMappingURL=useDashboardChart.d.ts.map

package/types/workspace/useDashboardChart.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDashboardChart.d.ts","sourceRoot":"","sources":["../../src/workspace/useDashboardChart.ts"],"names":[],"mappings":"AAiBA,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,QAAQ,EAAE,KAAK,CAAC;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC,CAAC;CACtD;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gFAAgF;IAChF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uFAAuF;IACvF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,oBAAoB,GAAG,SAAS,CAAC;IACzC,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,KAAK,GAAG,SAAS,CAAC;IACzB,sEAAsE;IACtE,WAAW,EAAE,OAAO,CAAC;IACrB,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB;AAuBD,0EAA0E;AAC1E,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,2BAA2B,CAiDhG"}

package/types/workspace/useWorkspaceDoc.d.ts

@@ -0,0 +1,18 @@
+import type { WorkspaceDoc } from "./types";
+export interface UseFrappeDocResult<TDoc> {
+    doc: TDoc | undefined;
+    /** First load in flight — render a skeleton. */
+    isLoading: boolean;
+    error: Error | undefined;
+    /** True when the server rejected the read (HTTP 403). */
+    isPermissionError: boolean;
+    refresh: () => void;
+}
+/** Fetch one document via REST (or the provider's fixtures when present). */
+export declare function useFrappeDoc<TDoc extends {
+    name: string;
+    doctype: string;
+}>(doctype: string, name: string | undefined): UseFrappeDocResult<TDoc>;
+/** Fetch a Workspace doc by proper-cased name (e.g. "Home", "Users"). */
+export declare function useWorkspaceDoc(workspace: string): UseFrappeDocResult<WorkspaceDoc>;
+//# sourceMappingURL=useWorkspaceDoc.d.ts.map

package/types/workspace/useWorkspaceDoc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useWorkspaceDoc.d.ts","sourceRoot":"","sources":["../../src/workspace/useWorkspaceDoc.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAsB5C,MAAM,WAAW,kBAAkB,CAAC,IAAI;IACtC,GAAG,EAAE,IAAI,GAAG,SAAS,CAAC;IACtB,gDAAgD;IAChD,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,KAAK,GAAG,SAAS,CAAC;IACzB,yDAAyD;IACzD,iBAAiB,EAAE,OAAO,CAAC;IAC3B,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB;AAED,6EAA6E;AAC7E,wBAAgB,YAAY,CAAC,IAAI,SAAS;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,EACzE,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,GAAG,SAAS,GACvB,kBAAkB,CAAC,IAAI,CAAC,CA0D1B;AAED,yEAAyE;AACzE,wBAAgB,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,kBAAkB,CAAC,YAAY,CAAC,CAEnF"}