@marianmeres/collection-types 2.0.0 → 2.2.0

package/dist/inbox.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Inbox message type definitions for the `@marianmeres/stack-inbox` notification inbox.
+ *
+ * Usage with Model:
+ * ```typescript
+ * import type { Model, InboxMessageData } from "@marianmeres/collection-types";
+ * type InboxMessageModel = Model<InboxMessageData>;
+ * ```
+ */
+/** Discriminator for how a message's content is rendered. */
+export type InboxContentType = "typed" | "freeform";
+/** Origin of a message. */
+export type InboxSenderKind = "system" | "user";
+/** Relative importance; reserved for future prioritized/pinned rendering. */
+export type InboxPriority = "low" | "normal" | "high";
+/**
+ * One recipient's own copy of a notification (denormalized model). The collection
+ * is owner-scoped: `owner_id` (a collection column, NOT a data field) is the
+ * recipient account id. Broadcasts materialize one row per recipient, all sharing
+ * the same `broadcast_id`.
+ */
+export interface InboxMessageData {
+    /**
+     * "typed" => render from i18n `template` + `template_data`;
+     * "freeform" => show `title`/`body` verbatim.
+     */
+    content_type: InboxContentType;
+    /** i18n key base, e.g. "order_processed" → console renders `inbox.msg.order_processed.{title,body}`. */
+    template?: string;
+    /** Interpolation values for the typed template. */
+    template_data?: Record<string, unknown>;
+    /** Freeform title (as authored). */
+    title?: string;
+    /** Freeform body (as authored). */
+    body?: string;
+    /** Author's language tag (display hint only; freeform is not translated). */
+    lang?: string;
+    /** Sender account id; `null` for system-originated messages. */
+    sender_id?: string | null;
+    /** "system" (automated) or "user" (a person sent it). */
+    sender_kind: InboxSenderKind;
+    /** Groups all per-recipient copies of one logical send (recall/edit seam). */
+    broadcast_id?: string | null;
+    /** Reserved; minimal use in v1. */
+    priority?: InboxPriority;
+    /** Optional auto-expiry (ISO 8601). Expired messages are hidden from the inbox. */
+    expires_at?: string | null;
+    /** ISO timestamp when the recipient marked it read; null/absent = unread. */
+    read_at?: string | null;
+    /** ISO timestamp when the recipient archived it; null/absent = in the inbox. */
+    archived_at?: string | null;
+    /** Index signature for `Model<T>` compatibility. */
+    [key: string]: unknown;
+}

package/dist/inbox.js

@@ -0,0 +1,10 @@
+/**
+ * Inbox message type definitions for the `@marianmeres/stack-inbox` notification inbox.
+ *
+ * Usage with Model:
+ * ```typescript
+ * import type { Model, InboxMessageData } from "@marianmeres/collection-types";
+ * type InboxMessageModel = Model<InboxMessageData>;
+ * ```
+ */
+export {};

package/dist/mod.d.ts

@@ -47,6 +47,7 @@ export * from "./country.js";
 export * from "./template.js";
 export * from "./email.js";
 export * from "./example.js";
+export * from "./inbox.js";
 export * from "./schema-builder.js";
 export * from "./navigation.js";
 export * from "./form-routes.js";

package/dist/mod.js

@@ -63,6 +63,8 @@ export * from "./template.js";
 export * from "./email.js";
 // Example domain types (reference implementation)
 export * from "./example.js";
+// Inbox domain types (notification inbox)
+export * from "./inbox.js";
 // Schema builder utilities (type-safe schema definitions)
 export * from "./schema-builder.js";
 // Navigation types (admin UI)

package/dist/order.d.ts

@@ -12,7 +12,10 @@
 import type { AddressData } from "./customer.js";
 import type { UUID } from "./utils.js";
 /** Order status progression */
-export type OrderStatus = "pending" | "paid" | "processing" | "shipped" | "delivered" | "cancelled";
+export type OrderStatus = "pending" | "paid" | "processing" | "shipped" | "delivered" | "cancelled"
+/** System-set by the abandoned-checkout maintenance sweep (never via the
+ * customer/admin transition API); a terminal, off-sequence state. */
+ | "abandoned";
 /** Checkout stages for tracking progress */
 export type CheckoutStage = "cart" | "addresses" | "delivery" | "confirm" | "payment" | "complete";
 /** Single order line item (snapshot at purchase time) */

package/dist/payment.d.ts

@@ -59,6 +59,10 @@ export interface PaymentIntent {
 export interface PaymentResult {
     /** Provider reference ID */
     provider_reference: string;
+    /** Optional provider verification summary (e.g. PayPal payer email/id,
+     *  capture status, seller-protection eligibility) surfaced for admin review.
+     *  Provider-specific keys; undefined when the provider supplies none. */
+    verification?: Record<string, unknown>;
 }
 /**
  * Result of a refund operation.

package/dist/schema-builder.d.ts

@@ -29,6 +29,13 @@ export type ObjectSchema<T> = {
     _searchable?: boolean;
     /** Virtual form-only fields (not persisted, excluded from DB validation) */
     _extra_form_fields?: Record<string, PropertyDefinition>;
+    /**
+     * Admin list-view hint: append these top-level model timestamp columns to the
+     * DataTable (rendered from the model row, not `data.*`). Operational
+     * collections (orders, invoices, …) typically want "when was this placed /
+     * last touched" in the list.
+     */
+    _data_table_dates?: ("_created_at" | "_updated_at")[];
 };
 /** Extended schema (loose typing for __extends patterns) */
 export type ExtendedSchema = {

package/dist/schema.d.ts

@@ -4,7 +4,7 @@
  */
 import type { MaybeLocalized } from "./utils.js";
 /** HTML field type for UI rendering */
-export type SchemaHtmlType = "text" | "textarea" | "wysiwyg" | "markdown" | "number" | "boolean" | "checkbox" | "parent" | "object" | "select" | "multiselect" | "date" | "datetime" | "time" | "color" | "relation" | "asset" | "json" | "code" | "keyvalues" | "password";
+export type SchemaHtmlType = "text" | "textarea" | "wysiwyg" | "markdown" | "number" | "money" | "boolean" | "checkbox" | "parent" | "object" | "select" | "status" | "multiselect" | "date" | "datetime" | "time" | "color" | "relation" | "asset" | "json" | "code" | "keyvalues" | "password";
 /** Configuration for relation-type fields in schema */
 export interface RelationTypeConfig {
     relation_type: string;
@@ -22,11 +22,13 @@ export interface AssetTypeConfig {
     maxSize?: number;
     variants?: string[];
 }
-/** Configuration for select/multiselect fields */
+/** Configuration for select/multiselect/status fields */
 export interface SelectConfig {
+    /** `intent` (status fields) carries the per-value badge color. */
     options: Array<{
         value: string;
         label: string;
+        intent?: string;
     }>;
     multiple?: boolean;
 }
@@ -37,12 +39,30 @@ export interface KeyValuesConfig {
     addLabel?: string;
     emptyMessage?: string;
 }
+/**
+ * Configuration for `money` fields (`_html.type: "money"`).
+ *
+ * The value is stored as an INTEGER number of minor units (e.g. cents) — the
+ * JSON Schema `type` should be `"integer"`. The UI displays/edits it as a major
+ * unit decimal (e.g. dollars): display = stored / `scale`, input = entered *
+ * `scale` (rounded). Keeping this in the schema makes "this field is money"
+ * authoritative for every surface (list display, form input, import transform)
+ * instead of guessing from the field name.
+ */
+export interface MoneyConfig {
+    /** Minor units per major unit. Default 100 (cents → dollars). */
+    scale?: number;
+    /** Decimal places to display. Default 2. */
+    decimals?: number;
+    /** Optional ISO currency code, for surfaces that render a symbol (e.g. "USD"). */
+    currency?: string;
+}
 /** Configuration for _html schema keyword */
 export interface SchemaHtmlConfig {
     /** Field type for UI rendering */
     type?: SchemaHtmlType;
     /** Type-specific configuration */
-    _type_config?: RelationTypeConfig | AssetTypeConfig | SelectConfig | KeyValuesConfig;
+    _type_config?: RelationTypeConfig | AssetTypeConfig | SelectConfig | KeyValuesConfig | MoneyConfig;
     /** Display label (can be localized) */
     label?: MaybeLocalized<string>;
     /** Display description (can be localized) */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@marianmeres/collection-types",
-	"version": "2.0.0",
+	"version": "2.2.0",
 	"type": "module",
 	"main": "dist/mod.js",
 	"types": "dist/mod.d.ts",