@multiplatform.one/frappe-ui 7.23.2 → 7.24.0

package/types/list/recordLook.d.ts

@@ -0,0 +1,25 @@
+/**
+ * How a doctype's records present beyond their fields: a display title, a
+ * short code beside it, candidate images. Lists, insights and record pages
+ * draw a record the same way from one declaration.
+ */
+export interface FrappeRecordLook<TDoc> {
+    /** The record's display name; defaults to the title field, then the name. */
+    title?: (doc: Partial<TDoc>) => string;
+    /** A short code shown beside the title ("#025"). */
+    code?: (doc: Partial<TDoc>) => string;
+    /** A muted line under the title on cards (a Pokemon's species). */
+    subtitle?: (doc: Partial<TDoc>) => string | undefined;
+    /** Image candidates in order; a failed load moves to the next. */
+    images?: (doc: Partial<TDoc>, baseURL: string | undefined) => string[];
+    /** Further images a record page shows after the first, one slide each. */
+    gallery?: (doc: Partial<TDoc>, baseURL: string | undefined) => FrappeRecordSlide[];
+}
+export interface FrappeRecordSlide {
+    src: string;
+    label: string;
+    /** Nearest-neighbor upscaling, for pixel art. */
+    pixelated?: boolean;
+}
+export declare function recordTitle<TDoc>(doc: Partial<TDoc>, look: FrappeRecordLook<TDoc> | undefined, titleField?: string): string;
+//# sourceMappingURL=recordLook.d.ts.map

package/types/list/recordLook.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recordLook.d.ts","sourceRoot":"","sources":["../../src/list/recordLook.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,gBAAgB,CAAC,IAAI;IACpC,6EAA6E;IAC7E,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC;IACvC,oDAAoD;IACpD,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC;IACtC,mEAAmE;IACnE,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,MAAM,GAAG,SAAS,CAAC;IACtD,kEAAkE;IAClE,MAAM,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,GAAG,SAAS,KAAK,MAAM,EAAE,CAAC;IACvE,0EAA0E;IAC1E,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,GAAG,SAAS,KAAK,iBAAiB,EAAE,CAAC;CACpF;AAED,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,iDAAiD;IACjD,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,wBAAgB,WAAW,CAAC,IAAI,EAC9B,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,EAClB,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,GAAG,SAAS,EACxC,UAAU,CAAC,EAAE,MAAM,GAClB,MAAM,CAOR"}

package/types/list/useListControls.d.ts

@@ -0,0 +1,48 @@
+import type React from "react";
+import type { FrappeConnection } from "../frappeConnections";
+import type { FrappeRouter } from "../frappeNavigation";
+import type { FrappeRowsConnection } from "../useFrappeRows";
+import { type FacetReading } from "./facetReading";
+import { type UseFavorites } from "./favorites";
+import { type FrappeListControls, type FrappeListState } from "./listState";
+export interface ListControlsOptions {
+    doctype: string;
+    controls: FrappeListControls;
+    connections: readonly FrappeConnection[] | undefined;
+    connection: FrappeRowsConnection | undefined;
+    /** The list's row ceiling; the base read (count, range ceilings) shares it. */
+    limit?: number;
+    /** Storage key of the favorites; undefined offers none. */
+    favoritesKey?: string;
+    /** Read and write the state through the router's query params. */
+    router?: FrappeRouter;
+    /** Read every record's name (and range fields) for counts and ceilings. */
+    readBase: boolean;
+}
+export interface ListControlsResult {
+    state: FrappeListState;
+    /** The search box's text, ahead of its debounced commit to `state.search`. */
+    searchText: string;
+    setSearchText: (text: string) => void;
+    update: (patch: Partial<FrappeListState>) => void;
+    /** Drops search, facets, ranges and favorites-only. */
+    clear: () => void;
+    favorites: UseFavorites;
+    facets: Readonly<Record<string, FacetReading>>;
+    /** Records the base read found, capped at the list's limit. */
+    total: number | undefined;
+    /** Highest value per range param in the base read. */
+    highest: Readonly<Record<string, number>>;
+    /** Mount these: the facet and base reads. */
+    readers: React.ReactNode;
+}
+/**
+ * The state behind a list page's controls, the favorites it filters by and
+ * the reads that label them (facet values and counts, the record count, the
+ * range ceilings). With a router that hands over query params the state
+ * seeds from them once and writes back after each commit: the write rides
+ * a post-commit effect, since a host router notifies its subscribers
+ * synchronously and a notify inside a render-phase update is a React error.
+ */
+export declare function useListControls({ doctype, controls, connections, connection, limit, favoritesKey, router, readBase, }: ListControlsOptions): ListControlsResult;
+//# sourceMappingURL=useListControls.d.ts.map

package/types/list/useListControls.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useListControls.d.ts","sourceRoot":"","sources":["../../src/list/useListControls.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAwB,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACzE,OAAO,EAAgB,KAAK,YAAY,EAAE,MAAM,aAAa,CAAC;AAC9D,OAAO,EAGL,KAAK,kBAAkB,EAEvB,KAAK,eAAe,EACrB,MAAM,aAAa,CAAC;AAKrB,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,WAAW,EAAE,SAAS,gBAAgB,EAAE,GAAG,SAAS,CAAC;IACrD,UAAU,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAC7C,+EAA+E;IAC/E,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2DAA2D;IAC3D,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kEAAkE;IAClE,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,2EAA2E;IAC3E,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,eAAe,CAAC;IACvB,8EAA8E;IAC9E,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACtC,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,eAAe,CAAC,KAAK,IAAI,CAAC;IAClD,uDAAuD;IACvD,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,SAAS,EAAE,YAAY,CAAC;IACxB,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC;IAC/C,+DAA+D;IAC/D,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,sDAAsD;IACtD,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1C,6CAA6C;IAC7C,OAAO,EAAE,KAAK,CAAC,SAAS,CAAC;CAC1B;AAWD;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,EAC9B,OAAO,EACP,QAAQ,EACR,WAAW,EACX,UAAU,EACV,KAAK,EACL,YAAY,EACZ,MAAM,EACN,QAAQ,GACT,EAAE,mBAAmB,GAAG,kBAAkB,CAgJ1C"}

package/types/record/RecordBars.d.ts

@@ -0,0 +1,11 @@
+import type { FrappeRecordBarsSection } from "./recordSections";
+/**
+ * A child table's numbers as bars on one shared scale: the sum above, the
+ * chart, then each exact value in a chip (the axis only approximates).
+ */
+export declare function RecordBars({ rows, section, testID, }: {
+    rows: readonly Record<string, unknown>[];
+    section: FrappeRecordBarsSection;
+    testID?: string;
+}): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=RecordBars.d.ts.map

package/types/record/RecordBars.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RecordBars.d.ts","sourceRoot":"","sources":["../../src/record/RecordBars.tsx"],"names":[],"mappings":"AAqBA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAyEhE;;;GAGG;AACH,wBAAgB,UAAU,CAAC,EACzB,IAAI,EACJ,OAAO,EACP,MAAM,GACP,EAAE;IACD,IAAI,EAAE,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;IACzC,OAAO,EAAE,uBAAuB,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,2CAgFA"}

package/types/record/RecordGallery.d.ts

@@ -0,0 +1,17 @@
+import type { FrappeRecordSlide } from "../list/recordLook";
+export interface RecordGalleryProps {
+    /** The record's image candidates: the first slide walks them on error. */
+    images: readonly string[];
+    /** Further slides after the first. */
+    slides?: readonly FrappeRecordSlide[];
+    alt: string;
+    tints?: readonly (string | undefined)[];
+}
+/**
+ * The hero's images. A swipeable carousel once its width is measured; before
+ * that (and on the server) the first image alone, so the hero never paints
+ * empty. Wells take the measured width and slides sit flush, so each lands
+ * exactly one width over.
+ */
+export declare function RecordGallery({ images, slides, alt, tints }: RecordGalleryProps): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=RecordGallery.d.ts.map

package/types/record/RecordGallery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RecordGallery.d.ts","sourceRoot":"","sources":["../../src/record/RecordGallery.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAE5D,MAAM,WAAW,kBAAkB;IACjC,0EAA0E;IAC1E,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1B,sCAAsC;IACtC,MAAM,CAAC,EAAE,SAAS,iBAAiB,EAAE,CAAC;IACtC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,SAAS,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,CAAC;CACzC;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,EAAE,MAAM,EAAE,MAAW,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,kBAAkB,2CA0BpF"}

package/types/record/RecordHero.d.ts

@@ -0,0 +1,42 @@
+import { type YStackProps } from "@multiplatform.one/components";
+import type { ReactNode } from "react";
+/**
+ * The record hero's geometry, shared by the loaded hero and its skeleton so
+ * the row does not jump when the record lands (LC-20).
+ */
+export declare const recordHeroArtBasis = 380;
+export declare const recordHeroArtMax = 480;
+export declare const recordHeroIdentityBasis = 320;
+export interface RecordHeroFrameProps extends YStackProps {
+    /** A theme hue painting the stage from its ramp. */
+    tint?: string;
+    children: ReactNode;
+}
+export declare function RecordHeroFrame({ tint, children, ...rest }: RecordHeroFrameProps): import("react/jsx-runtime").JSX.Element;
+export declare function RecordHeroRow({ children }: {
+    children: ReactNode;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function RecordHeroArtColumn({ children, ...rest }: YStackProps & {
+    children: ReactNode;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function RecordHeroIdentityColumn({ children, ...rest }: YStackProps & {
+    children: ReactNode;
+}): import("react/jsx-runtime").JSX.Element;
+export interface RecordVitalTile {
+    id: string;
+    label: string;
+    value: string;
+    /** Fill of a bar under the value, 0 to 100. */
+    percent?: number;
+}
+/** Nested fact tiles under the title: compact density so they recede. */
+export declare function RecordVitals({ tiles }: {
+    tiles: readonly RecordVitalTile[];
+}): import("react/jsx-runtime").JSX.Element | null;
+/** The breadcrumb line's loading twin. */
+export declare function RecordBreadcrumbBone(): import("react/jsx-runtime").JSX.Element;
+/** The hero and tab strip's loading twin, on the same geometry. */
+export declare function RecordSkeleton({ testID }: {
+    testID?: string;
+}): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=RecordHero.d.ts.map

package/types/record/RecordHero.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RecordHero.d.ts","sourceRoot":"","sources":["../../src/record/RecordHero.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAkC,KAAK,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAGjG,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAGvC;;;GAGG;AACH,eAAO,MAAM,kBAAkB,MAAM,CAAC;AACtC,eAAO,MAAM,gBAAgB,MAAM,CAAC;AACpC,eAAO,MAAM,uBAAuB,MAAM,CAAC;AAE3C,MAAM,WAAW,oBAAqB,SAAQ,WAAW;IACvD,oDAAoD;IACpD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED,wBAAgB,eAAe,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,EAAE,oBAAoB,2CAahF;AAED,wBAAgB,aAAa,CAAC,EAAE,QAAQ,EAAE,EAAE;IAAE,QAAQ,EAAE,SAAS,CAAA;CAAE,2CAOlE;AAED,wBAAgB,mBAAmB,CAAC,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,EAAE,WAAW,GAAG;IAAE,QAAQ,EAAE,SAAS,CAAA;CAAE,2CAc/F;AAED,wBAAgB,wBAAwB,CAAC,EACvC,QAAQ,EACR,GAAG,IAAI,EACR,EAAE,WAAW,GAAG;IAAE,QAAQ,EAAE,SAAS,CAAA;CAAE,2CAavC;AAED,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,+CAA+C;IAC/C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,yEAAyE;AACzE,wBAAgB,YAAY,CAAC,EAAE,KAAK,EAAE,EAAE;IAAE,KAAK,EAAE,SAAS,eAAe,EAAE,CAAA;CAAE,kDAmC5E;AAKD,0CAA0C;AAC1C,wBAAgB,oBAAoB,4CAMnC;AAED,mEAAmE;AACnE,wBAAgB,cAAc,CAAC,EAAE,MAAM,EAAE,EAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,2CAgD7D"}

package/types/record/RecordPage.d.ts

@@ -0,0 +1,54 @@
+import type { ComponentType } from "react";
+import { type FrappeInsightsMetric } from "../insights/insightsRecord";
+import type { FrappeListFacet } from "../list/listState";
+import { type FrappeRecordLook } from "../list/recordLook";
+import type { FrappeRecordTab } from "./recordSections";
+/** A hop from the record to another page of it (the backoffice form). */
+export interface FrappeRecordAction<TDoc> {
+    label: string;
+    icon: ComponentType<{
+        size?: number;
+    }>;
+    href: (doc: Partial<TDoc>) => string;
+    testID?: string;
+}
+type Row = Record<string, unknown>;
+export interface RecordPageProps<TDoc extends {
+    name: string;
+    doctype: string;
+}> {
+    doc: Partial<TDoc>;
+    linked: Record<string, Row[]>;
+    doctype: string;
+    route: string;
+    listName: string;
+    listRows: Partial<TDoc>[];
+    look?: FrappeRecordLook<TDoc>;
+    titleField?: string;
+    facet?: FrappeListFacet;
+    metrics: readonly FrappeInsightsMetric[];
+    summary?: (doc: Partial<TDoc>) => {
+        text: string;
+        cite?: string;
+    } | undefined;
+    tabs: readonly FrappeRecordTab[];
+    favorites?: boolean | string;
+    actions: readonly FrappeRecordAction<TDoc>[];
+    history: boolean;
+    slug: string;
+    baseURL?: string;
+    navigate: (href: string) => void;
+    /** The session may write this record: Edit shows. */
+    canEdit: boolean;
+}
+/**
+ * A record page drawn from a record already read: the header with Back,
+ * the heart, hops and Edit; the hero; the tabs; the neighbors. The data
+ * wrapper (FrappeRecordView) reads the record, its rows and the rights.
+ */
+export declare function RecordPage<TDoc extends {
+    name: string;
+    doctype: string;
+}>({ doc, linked, doctype, route, listName, listRows, look, titleField, facet, metrics, summary, tabs, favorites, actions, history, slug, baseURL, navigate, canEdit, }: RecordPageProps<TDoc>): import("react/jsx-runtime").JSX.Element;
+export {};
+//# sourceMappingURL=RecordPage.d.ts.map

package/types/record/RecordPage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RecordPage.d.ts","sourceRoot":"","sources":["../../src/record/RecordPage.tsx"],"names":[],"mappings":"AAoBA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAG3C,OAAO,EAAe,KAAK,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAGpF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAe,KAAK,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAaxE,OAAO,KAAK,EAAuB,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAE7E,yEAAyE;AACzE,MAAM,WAAW,kBAAkB,CAAC,IAAI;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,aAAa,CAAC;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACvC,IAAI,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC;IACrC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,KAAK,GAAG,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEnC,MAAM,WAAW,eAAe,CAAC,IAAI,SAAS;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE;IAC7E,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;IAC1B,IAAI,CAAC,EAAE,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,OAAO,EAAE,SAAS,oBAAoB,EAAE,CAAC;IACzC,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAC;IAC9E,IAAI,EAAE,SAAS,eAAe,EAAE,CAAC;IACjC,SAAS,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAC7B,OAAO,EAAE,SAAS,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;IAC7C,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACjC,qDAAqD;IACrD,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,IAAI,SAAS;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,EAAE,EACzE,GAAG,EACH,MAAM,EACN,OAAO,EACP,KAAK,EACL,QAAQ,EACR,QAAQ,EACR,IAAI,EACJ,UAAU,EACV,KAAK,EACL,OAAO,EACP,OAAO,EACP,IAAI,EACJ,SAAS,EACT,OAAO,EACP,OAAO,EACP,IAAI,EACJ,OAAO,EACP,QAAQ,EACR,OAAO,GACR,EAAE,eAAe,CAAC,IAAI,CAAC,2CAiQvB"}

package/types/record/RecordPager.d.ts

@@ -0,0 +1,13 @@
+export interface RecordPagerEntry {
+    title: string;
+    code?: string;
+    image?: string;
+    onPress: () => void;
+}
+/** The records either side of this one in the list's order, by face and name. */
+export declare function RecordPager({ prev, next, testID, }: {
+    prev: RecordPagerEntry | null;
+    next: RecordPagerEntry | null;
+    testID?: string;
+}): import("react/jsx-runtime").JSX.Element | null;
+//# sourceMappingURL=RecordPager.d.ts.map

package/types/record/RecordPager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RecordPager.d.ts","sourceRoot":"","sources":["../../src/record/RecordPager.tsx"],"names":[],"mappings":"AAMA,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB;AA2DD,iFAAiF;AACjF,wBAAgB,WAAW,CAAC,EAC1B,IAAI,EACJ,IAAI,EACJ,MAAM,GACP,EAAE;IACD,IAAI,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAC9B,IAAI,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,kDAiBA"}

package/types/record/RecordRows.d.ts

@@ -0,0 +1,13 @@
+import { type FrappeRecordRowsSection } from "./recordSections";
+type Row = Record<string, unknown>;
+/**
+ * A record's linked rows as flat tiles that wrap, in the declared order,
+ * flagged and detailed per row; grouped, each group is an accordion section
+ * with its count, the first open.
+ */
+export declare function RecordRows({ rows, section, }: {
+    rows: readonly Row[];
+    section: FrappeRecordRowsSection;
+}): import("react/jsx-runtime").JSX.Element;
+export {};
+//# sourceMappingURL=RecordRows.d.ts.map

package/types/record/RecordRows.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RecordRows.d.ts","sourceRoot":"","sources":["../../src/record/RecordRows.tsx"],"names":[],"mappings":"AAIA,OAAO,EAAa,KAAK,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAE3E,KAAK,GAAG,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAuCnC;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,EACzB,IAAI,EACJ,OAAO,GACR,EAAE;IACD,IAAI,EAAE,SAAS,GAAG,EAAE,CAAC;IACrB,OAAO,EAAE,uBAAuB,CAAC;CAClC,2CAiCA"}

package/types/record/recordData.d.ts

@@ -0,0 +1,46 @@
+/**
+ * What a record page draws from one record, its linked rows and the list it
+ * sits in: pure, no React, no IO.
+ */
+import type { FrappeListFacet } from "../list/listState";
+type Row = Record<string, unknown>;
+/** Rows ordered ascending by each key in turn. */
+export declare function sortRows<TRow extends Row>(rows: readonly TRow[], keys: readonly string[]): TRow[];
+export interface RowGroup<TRow> {
+    value: string;
+    rows: TRow[];
+}
+/** Rows grouped by a field, groups in the order their values first appear. */
+export declare function groupRows<TRow extends Row>(rows: readonly TRow[], field: string): RowGroup<TRow>[];
+/** A facet's values on one record: its linked rows in order, or its own field. */
+export declare function recordFacetValues(facet: Pick<FrappeListFacet, "doctype" | "field" | "orderBy">, doc: Row, connections: Record<string, readonly Row[]>): string[];
+export interface AdjacentRecords<TRow> {
+    prev: TRow | null;
+    next: TRow | null;
+}
+/** The records either side of `name` in the list's order, without wrapping. */
+export declare function adjacentRecords<TRow extends {
+    name?: string;
+}>(rows: readonly TRow[], name: string): AdjacentRecords<TRow>;
+export interface RecordHistoryEntry {
+    kind: "modified" | "created";
+    author: string;
+    timestamp: string;
+}
+/** The record's own audit trail, newest first; an edit only when one happened. */
+export declare function recordHistory(doc: Row): RecordHistoryEntry[];
+export interface ChildBar {
+    key: string;
+    value: number;
+}
+/** A child table's rows as bars, in the declared order first, and their sum. */
+export declare function childBars(rows: readonly Row[], { label, value, order }: {
+    label: string;
+    value: string;
+    order?: readonly string[];
+}): {
+    bars: ChildBar[];
+    total: number;
+};
+export {};
+//# sourceMappingURL=recordData.d.ts.map

package/types/record/recordData.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recordData.d.ts","sourceRoot":"","sources":["../../src/record/recordData.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,KAAK,GAAG,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAOnC,kDAAkD;AAClD,wBAAgB,QAAQ,CAAC,IAAI,SAAS,GAAG,EAAE,IAAI,EAAE,SAAS,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,EAAE,CASjG;AAED,MAAM,WAAW,QAAQ,CAAC,IAAI;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,IAAI,EAAE,CAAC;CACd;AAED,8EAA8E;AAC9E,wBAAgB,SAAS,CAAC,IAAI,SAAS,GAAG,EACxC,IAAI,EAAE,SAAS,IAAI,EAAE,EACrB,KAAK,EAAE,MAAM,GACZ,QAAQ,CAAC,IAAI,CAAC,EAAE,CASlB;AAED,kFAAkF;AAClF,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,IAAI,CAAC,eAAe,EAAE,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC,EAC7D,GAAG,EAAE,GAAG,EACR,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,EAAE,CAAC,GAC1C,MAAM,EAAE,CAUV;AAED,MAAM,WAAW,eAAe,CAAC,IAAI;IACnC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IAClB,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;CACnB;AAED,+EAA+E;AAC/E,wBAAgB,eAAe,CAAC,IAAI,SAAS;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,EAC5D,IAAI,EAAE,SAAS,IAAI,EAAE,EACrB,IAAI,EAAE,MAAM,GACX,eAAe,CAAC,IAAI,CAAC,CAOvB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,UAAU,GAAG,SAAS,CAAC;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,kFAAkF;AAClF,wBAAgB,aAAa,CAAC,GAAG,EAAE,GAAG,GAAG,kBAAkB,EAAE,CAY5D;AAED,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,gFAAgF;AAChF,wBAAgB,SAAS,CACvB,IAAI,EAAE,SAAS,GAAG,EAAE,EACpB,EAAE,KAAK,EAAE,KAAK,EAAE,KAAU,EAAE,EAAE;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;CAAE,GACxF;IAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAarC"}

package/types/record/recordSections.d.ts

@@ -0,0 +1,67 @@
+import type { ComponentType } from "react";
+/** A record's rows on one connection doctype, as tiles. */
+export interface FrappeRecordRowsSection {
+    kind: "rows";
+    /** A declared connection doctype. */
+    doctype: string;
+    /** The field each tile shows. */
+    field: string;
+    title?: string;
+    description?: string;
+    /** Tile order, ascending by each field in turn. */
+    orderBy?: readonly string[];
+    /** A truthy field marks the tile with a chip. */
+    flag?: {
+        field: string;
+        label: string;
+    };
+    /** A positive number on the row, as a chip. */
+    detail?: {
+        field: string;
+        label: (value: number) => string;
+    };
+    /** One collapsible group per value of a field, the first open. */
+    groupBy?: {
+        field: string;
+        label: (value: string) => string;
+    };
+    /** Shown when the record links no rows. */
+    empty?: string;
+}
+/** A child table's numeric rows as bars on one fixed scale. */
+export interface FrappeRecordBarsSection {
+    kind: "bars";
+    /** Names the chart (`<slug>-<id>-chart`). */
+    id: string;
+    /** The child table field on the record. */
+    table: string;
+    /** The row field naming a bar. */
+    label: string;
+    /** The row field holding its number. */
+    value: string;
+    /** The shared ceiling, so bars compare across records. */
+    max: number;
+    /** Bar order by label value; the rest follow as they came. */
+    order?: readonly string[];
+    barLabel?: (key: string) => string;
+    title: string;
+    /** Names the sum shown above the chart. */
+    totalLabel?: string;
+    description?: string;
+    empty?: string;
+}
+export type FrappeRecordSection = FrappeRecordRowsSection | FrappeRecordBarsSection;
+/** One tab under a record's hero. */
+export interface FrappeRecordTab {
+    value: string;
+    label: string;
+    icon?: ComponentType<{
+        size?: number;
+    }>;
+    /** A connection doctype whose row count badges the tab. */
+    count?: string;
+    sections: readonly FrappeRecordSection[];
+}
+/** "vine-whip" -> "vine whip": slug values read as words. */
+export declare function slugWords(value: string): string;
+//# sourceMappingURL=recordSections.d.ts.map

package/types/record/recordSections.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recordSections.d.ts","sourceRoot":"","sources":["../../src/record/recordSections.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAE3C,2DAA2D;AAC3D,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,iCAAiC;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mDAAmD;IACnD,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,iDAAiD;IACjD,IAAI,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IACxC,+CAA+C;IAC/C,MAAM,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAA;KAAE,CAAC;IAC7D,kEAAkE;IAClE,OAAO,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAA;KAAE,CAAC;IAC9D,2CAA2C;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,+DAA+D;AAC/D,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,6CAA6C;IAC7C,EAAE,EAAE,MAAM,CAAC;IACX,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;IACd,kCAAkC;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,wCAAwC;IACxC,KAAK,EAAE,MAAM,CAAC;IACd,0DAA0D;IAC1D,GAAG,EAAE,MAAM,CAAC;IACZ,8DAA8D;IAC9D,KAAK,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1B,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,2CAA2C;IAC3C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,mBAAmB,GAAG,uBAAuB,GAAG,uBAAuB,CAAC;AAEpF,qCAAqC;AACrC,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,aAAa,CAAC;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACxC,2DAA2D;IAC3D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,SAAS,mBAAmB,EAAE,CAAC;CAC1C;AAED,6DAA6D;AAC7D,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE/C"}