@happyvertical/smrt-planner 0.0.1 → 0.1.0

package/dist/data/display.d.ts

@@ -1,8 +1,3 @@
-/**
- * Which field labels a record in pickers. `model.display` comes from the
- * manifest's `displayLabelField` (happyvertical/smrt#3611); a model that
- * declares none falls back to the first of `name`, `title`, `label`, `code`.
- */
 import type { CatalogField, CatalogModel } from '../catalog/types.ts';
 export declare const DEFAULT_LABEL_FIELDS: readonly ["name", "title", "label", "code"];
 /** The fields that may label a record of the model, best first. */
@@ -11,13 +6,31 @@ export declare function labelFields(model: CatalogModel): string[];
 export declare function displayLabel(model: CatalogModel, record: Readonly<Record<string, unknown>>): string | undefined;
 /** Finds the label of the record a relation field points at. */
 export type RelatedLabel = (field: CatalogField, id: string) => string | undefined;
+/**
+ * The field that identifies a document to a person (`invoiceNumber`, an
+ * order's `reference`): the first field the framework's field roles
+ * (`deriveFieldRoles`, smrt#3718) give the `identifier` role. `undefined`
+ * for a model with a name of its own: a product's `code` is a detail, its
+ * `name` is what it is called.
+ */
+export declare function identifierField(model: CatalogModel): CatalogField | undefined;
+/** A document's identifier value, e.g. `WIL-1133`; `undefined` when empty. */
+export declare function identifierOf(model: CatalogModel, record: Readonly<Record<string, unknown>>): string | undefined;
 /** A record's own number, e.g. `invoiceNumber` or `number`. */
 export declare function numberOf(model: CatalogModel, record: Readonly<Record<string, unknown>>): string | undefined;
 /** The relation field that best says what a record is about, if it has one. */
 export declare function partyField(fields: readonly CatalogField[], record: Readonly<Record<string, unknown>>): CatalogField | undefined;
 /**
- * The text that names a record: its label field, else its number (plus the
- * party it is for), else the party, with the amount and date for a money record
- * such as a payment. `undefined` when nothing names it.
+ * The text that names a record: its label field, else its identifier (a
+ * document is its number: `GRA-3159`, never `Ridgeline Construction ·
+ * GRA-3159`), else, for a money record such as a payment allocation, the party
+ * it is for with its amount and date, else the party and a description.
+ * `undefined` when nothing names it.
  */
 export declare function recordName(model: CatalogModel, record: Readonly<Record<string, unknown>>, related: RelatedLabel, fields?: readonly CatalogField[]): string | undefined;
+/**
+ * A record page's heading: a document is its kind and identifier
+ * (`Order GRA-3159`), anything else its name. `kind` is the model's name
+ * as a person reads it ("Order", "Purchase order").
+ */
+export declare function recordHeading(model: CatalogModel, record: Readonly<Record<string, unknown>>, name: string, kind: string): string;

package/dist/data/display.js

@@ -1,3 +1,9 @@
+/**
+ * Which field labels a record in pickers. `model.display` comes from the
+ * manifest's `displayLabelField` (happyvertical/smrt#3611); a model that
+ * declares none falls back to the first of `name`, `title`, `label`, `code`.
+ */
+import { deriveFieldRoles, fieldWithRole, } from '@happyvertical/smrt-svelte/screens';
 import { formatMoney } from "./format.js";
 export const DEFAULT_LABEL_FIELDS = ['name', 'title', 'label', 'code'];
 /** The fields that may label a record of the model, best first. */
@@ -27,11 +33,55 @@ const PARTY_ORDER = [
     /^payment/i,
     /^contract/i,
 ];
+/** A document's own number, e.g. `invoiceNumber` or `number`. */
+const NUMBER_NAME = /(^|[a-z])Number$|^number$/;
+/**
+ * The field that identifies a document to a person (`invoiceNumber`, an
+ * order's `reference`): the first field the framework's field roles
+ * (`deriveFieldRoles`, smrt#3718) give the `identifier` role. `undefined`
+ * for a model with a name of its own: a product's `code` is a detail, its
+ * `name` is what it is called.
+ */
+export function identifierField(model) {
+    if (labelFields(model).some((name) => name !== 'code'))
+        return undefined;
+    const own = model.fields.filter((f) => !f.system);
+    const roles = deriveFieldRoles({
+        objectRef: model.id,
+        className: model.name,
+        fields: Object.fromEntries(own.map((f) => [
+            f.name,
+            {
+                type: SCREEN_TYPES.has(f.type) ? f.type : 'text',
+                ...(f.enum?.length ? { enum: f.enum } : {}),
+                ...(f.ui ? { ui: { ...f.ui } } : {}),
+            },
+        ])),
+    });
+    const name = fieldWithRole(roles, 'identifier');
+    return name ? own.find((f) => f.name === name) : undefined;
+}
+const SCREEN_TYPES = new Set([
+    'text',
+    'integer',
+    'decimal',
+    'boolean',
+    'datetime',
+    'json',
+    'foreignKey',
+    'crossPackageRef',
+]);
+/** A document's identifier value, e.g. `WIL-1133`; `undefined` when empty. */
+export function identifierOf(model, record) {
+    const field = identifierField(model);
+    const value = field ? record[field.name] : undefined;
+    return typeof value === 'string' && value.trim() !== '' ? value : undefined;
+}
 /** A record's own number, e.g. `invoiceNumber` or `number`. */
 export function numberOf(model, record) {
     const field = model.fields.find((f) => !f.system &&
         f.type === 'text' &&
-        /(^|[a-z])Number$|^number$/.test(f.name) &&
+        NUMBER_NAME.test(f.name) &&
         typeof record[f.name] === 'string' &&
         String(record[f.name]).trim() !== '');
     return field ? String(record[field.name]) : undefined;
@@ -48,21 +98,23 @@ export function partyField(fields, record) {
 }
 const DATE_NAME = /(paid|allocated|issue|^date$|createdat)/i;
 /**
- * The text that names a record: its label field, else its number (plus the
- * party it is for), else the party, with the amount and date for a money record
- * such as a payment. `undefined` when nothing names it.
+ * The text that names a record: its label field, else its identifier (a
+ * document is its number: `GRA-3159`, never `Ridgeline Construction ·
+ * GRA-3159`), else, for a money record such as a payment allocation, the party
+ * it is for with its amount and date, else the party and a description.
+ * `undefined` when nothing names it.
  */
 export function recordName(model, record, related, fields = model.fields) {
     const own = displayLabel(model, record);
     if (own)
         return own;
+    const identifier = identifierOf(model, record);
+    if (identifier)
+        return identifier;
     const partyOf = partyField(fields, record);
     const party = partyOf?.related
         ? related(partyOf, String(record[partyOf.name]))
         : undefined;
-    const number = numberOf(model, record);
-    if (number)
-        return unique([number, party]);
     const moneyField = model.fields.find((f) => f.name === 'amount' && f.type === 'integer');
     if (moneyField && typeof record.amount === 'number') {
         const dateField = model.fields.find((f) => f.type === 'datetime' && DATE_NAME.test(f.name) && record[f.name]);
@@ -72,10 +124,21 @@ export function recordName(model, record, related, fields = model.fields) {
             dateField ? String(record[dateField.name]).slice(0, 10) : undefined,
         ]);
     }
-    const reference = ['reference', 'description']
-        .map((name) => record[name])
-        .find((v) => typeof v === 'string' && v.trim() !== '');
-    return unique([party, reference]);
+    const description = typeof record.description === 'string' && record.description.trim() !== ''
+        ? record.description
+        : undefined;
+    return unique([party, description]);
+}
+/**
+ * A record page's heading: a document is its kind and identifier
+ * (`Order GRA-3159`), anything else its name. `kind` is the model's name
+ * as a person reads it ("Order", "Purchase order").
+ */
+export function recordHeading(model, record, name, kind) {
+    if (displayLabel(model, record))
+        return name;
+    const identifier = identifierOf(model, record);
+    return identifier && identifier === name ? `${kind} ${identifier}` : name;
 }
 function unique(parts) {
     const kept = parts.filter((p) => Boolean(p));

package/dist/data/fakes.d.ts

@@ -10,8 +10,10 @@ export declare function createRandom(seed: number): () => number;
 /** FNV-1a hash of a string, for seeding. */
 export declare function hashString(value: string): number;
 /**
- * Money is stored as integer minor units (cents). A field is money when it is
- * an integer whose name says so; everything else numeric is a plain number.
+ * Money is stored as integer minor units (cents). An integer field is money
+ * when the manifest says so (`ui.format === 'money'`); a field that declares
+ * any other format is not, and neither is a framework-managed one. With no
+ * declared format the field's name decides.
  */
 export declare function isMoneyField(field: CatalogField): boolean;
 /**
@@ -25,18 +27,53 @@ export declare const PRODUCT_CATALOG: readonly {
 }[];
 /** Fixed clock so seeded timestamps never change between runs. */
 export declare const EPOCH: number;
+/** Sample rows per model unless a pack or {@link SAMPLE_ROW_COUNTS} says otherwise. */
+export declare const DEFAULT_SAMPLE_ROWS = 8;
 /** A UUID-shaped id derived from a seed string. */
 export declare function fakeId(seed: string): string;
 /** Fractions a tax rate takes: 0%, 5%, 8.25%, 13% and 20%. */
 export declare const TAX_RATES: readonly [0, 0.05, 0.0825, 0.13, 0.2];
+/**
+ * The sample tax rate when neither the app's setting nor the pack names one:
+ * every line of every document is taxed at it, so a document's tax is one
+ * rate of its subtotal, as on a real invoice.
+ */
+export declare const DEFAULT_SAMPLE_TAX_RATE = 0.05;
 export declare const SAMPLE_ROW_COUNTS: Readonly<Record<string, number>>;
-/** Sample rows for a model: the pack's count, else the shared one, else `fallback`. */
+/**
+ * How many rows of each customer-linked model (orders, quotes, invoices,
+ * payments: any model with a FK to a Customer) point at each sample customer:
+ * 3 to 6, uneven, seeded by the customer's index so it never changes. The
+ * slots interleave (every customer once, then again...), so a list's first
+ * rows still show different customers and row `n < customers` points at
+ * customer `n`.
+ */
+export declare function customerSlots(customers: number): readonly number[];
+/**
+ * Sample rows for a model: the pack's count, else the shared one, else, for a
+ * customer-linked model, one per {@link customerSlots} slot, else `fallback`.
+ */
 export declare function sampleRowCount(modelId: string, fallback: number): number;
-/** One fake value for a field. Money is an integer number of minor units. */
-export declare function fakeValue(field: CatalogField, random: () => number, context: {
+/**
+ * Which row of the target a sample relation points at. Rows are seeded with
+ * ids from `(model, index)`, so pointing at index `n` points at a real row;
+ * spread over every row of the target, so each sample record has related
+ * records (a customer several orders, quotes and invoices), not just the
+ * first few.
+ */
+export declare function relatedIndex(field: CatalogField, context: FakeContext): number;
+/**
+ * Where a fake value is made: the model, the row's index and the data
+ * source's rows per model (default {@link DEFAULT_SAMPLE_ROWS}), so a
+ * reference points at a row the source actually made.
+ */
+export interface FakeContext {
     modelId: string;
     index: number;
-}): unknown;
+    rows?: number;
+}
+/** One fake value for a field. Money is an integer number of minor units. */
+export declare function fakeValue(field: CatalogField, random: () => number, context: FakeContext): unknown;
 /** Fields a person edits: everything the framework does not manage. */
 export declare function editableFields(model: CatalogModel): CatalogField[];
 export declare const DAY: number;
@@ -47,6 +84,8 @@ export declare const DAY: number;
  */
 export declare function packLine(index: number): PackLine | undefined;
 /** A single seeded record for a model. */
-export declare function fakeRecord(model: CatalogModel, index: number, seed: number): ModelRecord;
-/** `count` seeded records for a model. */
-export declare function fakeRecords(model: CatalogModel, count: number, seed?: number): ModelRecord[];
+export declare function fakeRecord(model: CatalogModel, index: number, seed: number, rows?: number): ModelRecord;
+/** Every `EXEMPT_EVERY`th sample customer does not pay sales tax. */
+export declare const EXEMPT_EVERY = 8;
+/** `count` seeded records for a model; `rows` is the source's rows per model. */
+export declare function fakeRecords(model: CatalogModel, count: number, seed?: number, rows?: number): ModelRecord[];

package/dist/data/fakes.js

@@ -1,5 +1,6 @@
+import { getModelByQualifiedName } from "../catalog/index.js";
 import { isLineModel } from "./derived.js";
-import { GENERIC_PACK, getSamplePack, getSampleTaxRate, } from "./packs.js";
+import { GENERIC_PACK, getSamplePack, getSamplePricing, getSampleTaxRate, } from "./packs.js";
 /** Deterministic PRNG (mulberry32): the same seed always yields the same run. */
 export function createRandom(seed) {
     let state = seed >>> 0;
@@ -20,16 +21,26 @@ export function hashString(value) {
     }
     return hash >>> 0;
 }
-const MONEY_NAME = /(price|amount|cost|total|balance|fee|tax|revenue|budget|salary|wage|subtotal|discount|spend|payout|commission|credit|debit|charge|refund|fare|rent)/i;
-const NOT_MONEY_NAME = /(count|quantity|qty|percent|ratio|level)/i;
+// `...Minor` is smrt's name for an amount in minor units (`DocumentTax`'s
+// `taxableMinor`, `TaxSummaryReport`'s `ledgerMovementMinor`).
+const MONEY_NAME = /(price|amount|cost|total|balance|fee|tax|revenue|budget|salary|wage|subtotal|discount|spend|payout|commission|credit|debit|charge|refund|fare|rent|[a-z]Minor$)/i;
+// A count is not money; a dis-count is (`discountTotal`).
+const NOT_MONEY_NAME = /((?<!dis)count|quantity|qty|percent|ratio|level)/i;
 /**
- * Money is stored as integer minor units (cents). A field is money when it is
- * an integer whose name says so; everything else numeric is a plain number.
+ * Money is stored as integer minor units (cents). An integer field is money
+ * when the manifest says so (`ui.format === 'money'`); a field that declares
+ * any other format is not, and neither is a framework-managed one. With no
+ * declared format the field's name decides.
  */
 export function isMoneyField(field) {
-    return (field.type === 'integer' &&
-        MONEY_NAME.test(field.name) &&
-        !NOT_MONEY_NAME.test(field.name));
+    if (field.type !== 'integer')
+        return false;
+    const format = field.ui?.format;
+    if (format !== undefined)
+        return format === 'money';
+    if (field.system)
+        return false;
+    return MONEY_NAME.test(field.name) && !NOT_MONEY_NAME.test(field.name);
 }
 const WORDS = [
     'Harbor',
@@ -76,6 +87,8 @@ const SENTENCES = [
 ];
 /** Fixed clock so seeded timestamps never change between runs. */
 export const EPOCH = Date.UTC(2026, 0, 1);
+/** Sample rows per model unless a pack or {@link SAMPLE_ROW_COUNTS} says otherwise. */
+export const DEFAULT_SAMPLE_ROWS = 8;
 const YEAR = 365 * 24 * 60 * 60 * 1000;
 function pick(random, list) {
     return list[Math.floor(random() * list.length)];
@@ -110,6 +123,12 @@ const CHANNELS = ['web', 'retail', 'phone', 'marketplace', 'wholesale'];
 const PERIODS = ['monthly', 'quarterly', 'annual'];
 /** Fractions a tax rate takes: 0%, 5%, 8.25%, 13% and 20%. */
 export const TAX_RATES = [0, 0.05, 0.0825, 0.13, 0.2];
+/**
+ * The sample tax rate when neither the app's setting nor the pack names one:
+ * every line of every document is taxed at it, so a document's tax is one
+ * rate of its subtotal, as on a real invoice.
+ */
+export const DEFAULT_SAMPLE_TAX_RATE = 0.05;
 function fakeText(field, random, modelName = '') {
     const name = field.name.toLowerCase();
     if (/terms/.test(name))
@@ -158,7 +177,7 @@ function fakeText(field, random, modelName = '') {
         return pick(random, ['active', 'pending', 'archived', 'draft']);
     }
     if (/(currency)/.test(name))
-        return 'USD';
+        return getSamplePricing().currency;
     if (/(person|owner|author|contact|assignee|worker)/.test(name)) {
         return `${pick(random, FIRST)} ${pick(random, LAST)}`;
     }
@@ -175,7 +194,41 @@ export const SAMPLE_ROW_COUNTS = {
     '@happyvertical/smrt-profiles:Profile': 13,
     '@happyvertical/smrt-commerce:Vendor': 5,
 };
-/** Sample rows for a model: the pack's count, else the shared one, else `fallback`. */
+const CUSTOMER_MODEL = '@happyvertical/smrt-commerce:Customer';
+/**
+ * How many rows of each customer-linked model (orders, quotes, invoices,
+ * payments: any model with a FK to a Customer) point at each sample customer:
+ * 3 to 6, uneven, seeded by the customer's index so it never changes. The
+ * slots interleave (every customer once, then again...), so a list's first
+ * rows still show different customers and row `n < customers` points at
+ * customer `n`.
+ */
+export function customerSlots(customers) {
+    const cached = slotCache.get(customers);
+    if (cached)
+        return cached;
+    const counts = Array.from({ length: customers }, (_, k) => 3 + (hashString(`customer-rows:${k}`) % 4));
+    const slots = [];
+    for (let round = 0; round < 6; round++) {
+        counts.forEach((count, k) => {
+            if (count > round)
+                slots.push(k);
+        });
+    }
+    slotCache.set(customers, slots);
+    return slots;
+}
+const slotCache = new Map();
+/** Does the model's rows belong to a customer (a FK to Customer, not its Profile)? */
+function isCustomerLinked(modelId) {
+    const model = getModelByQualifiedName(modelId)?.model;
+    return (model?.fields.some((f) => (f.type === 'foreignKey' || f.type === 'crossPackageRef') &&
+        f.related === CUSTOMER_MODEL) ?? false);
+}
+/**
+ * Sample rows for a model: the pack's count, else the shared one, else, for a
+ * customer-linked model, one per {@link customerSlots} slot, else `fallback`.
+ */
 export function sampleRowCount(modelId, fallback) {
     // Profiles: customers, then vendors, then the pack's instructors.
     if (modelId === PROFILE_MODEL) {
@@ -185,13 +238,19 @@ export function sampleRowCount(modelId, fallback) {
     }
     return (getSamplePack().rowCounts?.[modelId] ??
         SAMPLE_ROW_COUNTS[modelId] ??
-        fallback);
+        (isCustomerLinked(modelId)
+            ? customerSlots(sampleRowCount(CUSTOMER_MODEL, fallback)).length
+            : fallback));
 }
 /**
  * Which row of the target a sample relation points at. Rows are seeded with
- * ids from `(model, index)`, so pointing at index `n` points at a real row.
+ * ids from `(model, index)`, so pointing at index `n` points at a real row;
+ * spread over every row of the target, so each sample record has related
+ * records (a customer several orders, quotes and invoices), not just the
+ * first few.
  */
-function relatedIndex(field, context) {
+export function relatedIndex(field, context) {
+    const rows = context.rows ?? DEFAULT_SAMPLE_ROWS;
     const instructors = getSamplePack().instructors;
     if (field.name === 'organizerId' && instructors?.length) {
         // Organizers lead classes and jobs; they are staff, never customers.
@@ -206,7 +265,13 @@ function relatedIndex(field, context) {
             ? context.index
             : context.index % 8;
     }
-    return context.index % 5;
+    const target = field.related ?? '';
+    if (target === CUSTOMER_MODEL) {
+        // Several rows per customer, 3 to 6 each (see `customerSlots`).
+        const slots = customerSlots(sampleRowCount(CUSTOMER_MODEL, rows));
+        return slots[context.index % slots.length] ?? 0;
+    }
+    return (context.index % (target.includes(':') ? sampleRowCount(target, rows) : rows));
 }
 /** One fake value for a field. Money is an integer number of minor units. */
 export function fakeValue(field, random, context) {
@@ -233,12 +298,12 @@ export function fakeValue(field, random, context) {
         }
         case 'decimal':
             if (/taxrate|vatrate/i.test(field.name)) {
-                // A cookbook's default rate (0: untaxed) beats a random one.
-                const rate = getSampleTaxRate();
-                return rate ?? pick(random, TAX_RATES);
+                // The app's setting, else the pack's (0: untaxed), else 5%.
+                return getSampleTaxRate() ?? DEFAULT_SAMPLE_TAX_RATE;
             }
+            // Exact percent text, as smrt's money model reads it ("10" is 10%).
             if (/discountrate/i.test(field.name))
-                return pick(random, [0, 0.05, 0.1]);
+                return pick(random, ['5', '10']);
             if (/(quantity|qty)/i.test(field.name))
                 return 1 + Math.floor(random() * 5);
             return Math.round(random() * 10000) / 100;
@@ -422,7 +487,7 @@ export function packLine(index) {
     return lines?.length ? lines[index % lines.length] : undefined;
 }
 /** A single seeded record for a model. */
-export function fakeRecord(model, index, seed) {
+export function fakeRecord(model, index, seed, rows) {
     const random = createRandom(hashString(`${seed}:${model.id}:${index}`));
     const record = { id: fakeId(`${model.id}:${index}`) };
     for (const field of model.fields) {
@@ -431,13 +496,72 @@ export function fakeRecord(model, index, seed) {
         record[field.name] = fakeValue(field, random, {
             modelId: model.id,
             index,
+            rows,
         });
     }
     orderDates(model, record, createRandom(hashString(`${seed}:${model.id}:${index}:dates`)));
     nameThings(model, record, index, random);
+    sampleMoneyFields(model, record, index);
     return record;
 }
-/** `count` seeded records for a model. */
-export function fakeRecords(model, count, seed = 1) {
-    return Array.from({ length: count }, (_, i) => fakeRecord(model, i, seed));
+const COMMERCE = '@happyvertical/smrt-commerce:';
+/** Every `EXEMPT_EVERY`th sample customer does not pay sales tax. */
+export const EXEMPT_EVERY = 8;
+/**
+ * The money-model fields of a sample record, set on purpose rather than
+ * drawn: a document is priced the app's way (`lineAmountType`,
+ * `taxRoundingScope`) and is an invoice or a payment, never a credit note or
+ * a refund (those answer an issued document), with no reversal journal or
+ * party tax snapshot; its totals and a line's money
+ * are its document's to settle; tax codes come from the app default, so no
+ * party or product names one of its own; and one customer in eight is tax
+ * exempt.
+ */
+function sampleMoneyFields(model, record, index) {
+    const set = (name, value) => {
+        if (has(model, name))
+            record[name] = value;
+    };
+    for (const name of [
+        'defaultTaxCodeId',
+        'defaultSalesTaxCodeId',
+        'defaultPurchaseTaxCodeId',
+    ]) {
+        set(name, null);
+    }
+    if (!model.id.startsWith(COMMERCE))
+        return;
+    const pricing = getSamplePricing();
+    set('lineAmountType', pricing.pricesIncludeTax ? 'inclusive' : 'exclusive');
+    set('taxRoundingScope', pricing.taxRounding);
+    set('discountTotal', 0);
+    if (model.name === 'Invoice')
+        set('kind', 'invoice');
+    if (model.name === 'Payment')
+        set('kind', 'payment');
+    set('creditedInvoiceId', null);
+    set('creditedLineId', null);
+    set('creditedAmount', 0);
+    // Only a cancelled posted invoice has a reversal journal, and the party's
+    // tax id is snapshotted from the customer when a document is issued.
+    set('arReversalJournalId', null);
+    set('partyTaxId', null);
+    if (isLineModel(model))
+        set('taxAmount', 0);
+    set('taxMode', 'inherit');
+    set('taxCodeId', null);
+    set('taxCodeCode', null);
+    set('taxCodeName', null);
+    if (has(model, 'discountType')) {
+        set('discountType', 'none');
+        set('discountRate', null);
+        set('discount', 0);
+    }
+    if (model.name === 'Customer') {
+        set('taxExempt', index % EXEMPT_EVERY === EXEMPT_EVERY - 1);
+    }
+}
+/** `count` seeded records for a model; `rows` is the source's rows per model. */
+export function fakeRecords(model, count, seed = 1, rows) {
+    return Array.from({ length: count }, (_, i) => fakeRecord(model, i, seed, rows));
 }

package/dist/data/labels.d.ts

@@ -19,8 +19,13 @@ export declare const VENDOR = "@happyvertical/smrt-commerce:Vendor";
 export declare function shortId(id: unknown): string;
 /** Does the model get its name from a Profile (`profileId` referencing one)? */
 export declare function isProfileLabelled(model: CatalogModel): boolean;
-/** The text that names one record. Never an empty string. */
-export declare function recordLabel(source: DataSource, model: CatalogModel, record: ModelRecord, depth?: number): Promise<string>;
+/**
+ * The text that names one record. Never an empty string. `omitParty` names
+ * a party field (`customerId`) whose label to leave out when the record has
+ * a name of its own without it: a customer's page lists its orders as
+ * `TIM-8288`, not `Ridgeline Construction · TIM-8288`.
+ */
+export declare function recordLabel(source: DataSource, model: CatalogModel, record: ModelRecord, depth?: number, omitParty?: string): Promise<string>;
 /**
  * The labels of every record the `fields` of `rows` point at, keyed by
  * {@link labelKey}. A pointer to a record that is gone has no entry, so a view

package/dist/data/labels.js

@@ -36,8 +36,13 @@ async function profileOf(source, record) {
 }
 /** How many relations deep a label may reach (allocation > invoice > customer). */
 const LABEL_DEPTH = 3;
-/** The text that names one record. Never an empty string. */
-export async function recordLabel(source, model, record, depth = 0) {
+/**
+ * The text that names one record. Never an empty string. `omitParty` names
+ * a party field (`customerId`) whose label to leave out when the record has
+ * a name of its own without it: a customer's page lists its orders as
+ * `TIM-8288`, not `Ridgeline Construction · TIM-8288`.
+ */
+export async function recordLabel(source, model, record, depth = 0, omitParty) {
     if (isProfileLabelled(model)) {
         const profile = await profileOf(source, record);
         const name = profile && displayLabel(modelNamed(PROFILE), profile);
@@ -45,6 +50,11 @@ export async function recordLabel(source, model, record, depth = 0) {
             return name;
     }
     const party = partyField(model.fields, record);
+    if (party && party.name === omitParty) {
+        const own = recordName(model, record, () => undefined);
+        if (own)
+            return own;
+    }
     const target = party?.related
         ? getModelByQualifiedName(party.related)?.model
         : undefined;

package/dist/data/list-sort.d.ts

@@ -0,0 +1,8 @@
+/** Sort state belongs to a rendered list, never to its data source. */
+export interface ListSort {
+    key: string;
+    direction: 'ascending' | 'descending';
+}
+export declare function nextListSort(current: ListSort | null, key: string): ListSort;
+/** Stable, non-mutating sort. Empty values remain last in both directions. */
+export declare function sortListRows<T>(rows: readonly T[], sort: ListSort | null, readValue: (row: T, key: string) => unknown): T[];

package/dist/data/list-sort.js

@@ -0,0 +1,45 @@
+export function nextListSort(current, key) {
+    return {
+        key,
+        direction: current?.key === key && current.direction === 'ascending'
+            ? 'descending'
+            : 'ascending',
+    };
+}
+const collator = new Intl.Collator(undefined, {
+    numeric: true,
+    sensitivity: 'base',
+});
+function missing(value) {
+    return (value === null ||
+        value === undefined ||
+        value === '' ||
+        (typeof value === 'number' && !Number.isFinite(value)));
+}
+function compare(a, b) {
+    if (typeof a === 'number' && typeof b === 'number')
+        return a - b;
+    if (typeof a === 'boolean' && typeof b === 'boolean')
+        return Number(a) - Number(b);
+    const left = a instanceof Date ? a.getTime() : a;
+    const right = b instanceof Date ? b.getTime() : b;
+    if (typeof left === 'number' && typeof right === 'number')
+        return left - right;
+    return collator.compare(String(left), String(right));
+}
+/** Stable, non-mutating sort. Empty values remain last in both directions. */
+export function sortListRows(rows, sort, readValue) {
+    if (!sort)
+        return [...rows];
+    return rows
+        .map((row, index) => ({ row, index, value: readValue(row, sort.key) }))
+        .sort((a, b) => {
+        const aMissing = missing(a.value);
+        const bMissing = missing(b.value);
+        if (aMissing !== bMissing)
+            return aMissing ? 1 : -1;
+        const order = aMissing ? 0 : compare(a.value, b.value);
+        return ((sort.direction === 'ascending' ? order : -order) || a.index - b.index);
+    })
+        .map(({ row }) => row);
+}