@proveanything/smartlinks 1.9.23 → 1.10.1

package/docs/records-admin-pattern.md

@@ -30,7 +30,7 @@ Without a shared pattern, every app reinvents:
 - CSV import/export
 - bulk operations
 
-The result is drift: each app feels different and admins have to re-learn the model. This guide locks the model down at the SDK level so the matching UI primitives in `@proveanything/ui-utils` (see the [companion guide](ui-utils.md)) can stay simple.
+The result is drift: each app feels different and admins have to re-learn the model. This guide locks the model down at the SDK level so the matching UI primitives in `@proveanything/smartlinks-utils-ui` (see the [companion guide](ui-utils.md)) can stay simple.
 
 ---
 
@@ -71,20 +71,35 @@ variant:<productId>:<variantId>
 batch:<productId>:<batchId>
 proof:<proofId>
 facet:<facetKey>:<valueKey>
-default
+''                             (universal / collection-wide fallback)
 ```
 
 Notes:
 
 - Variants and batches are **always nested under a product** in the SDK, so their refs include `productId`.
 - `facet:` refs are **collection-wide** — facets cross products by design.
-- `default` is a single record per (app, recordType) used as the global fallback.
+- `''` (empty ref) is the **universal** record — one per `(app, recordType)` with no scope restrictions; the collection-wide fallback.
 - Refs are opaque to the SDK. Apps parse them. A helper module (`@proveanything/smartlinks-utils-ui/records-admin`) exports `parseRef`/`buildRef` so all apps agree on syntax. See Appendix A for the full implementation.
 
 ### Adding scopes later
 
 If a new axis appears (e.g. `region:eu`), pick a new prefix and document it. Never reuse a prefix with different semantics.
 
+### Writing records
+
+When creating or upserting a record, send a structured **`RecordScope`** — the server derives `ref` from it:
+
+```ts
+await app.records.upsert(collectionId, appId, {
+  recordType: 'nutrition',
+  scope: { productId: 'prod_abc', variantId: 'var_500ml' }, // server → ref: 'product:prod_abc/variant:var_500ml'
+  data: { calories: 260 },
+});
+```
+
+- `ref` is for **display, URL routing, and resolution output only** — never construct one to use as an upsert key.
+- `customId` / `sourceSystem` are for external references (filterable via `list()`) but are **not unique** — the same external ID can exist across `recordType` values. Do not upsert on `customId` either.
+
 ---
 
 ## 4. Resolution order (REQUIRED)
@@ -92,7 +107,7 @@ If a new axis appears (e.g. `region:eu`), pick a new prefix and document it. Nev
 When the **public** side of an app needs "the data that applies to this proof / product / context", it walks the chain from most-specific to least-specific and returns the first match:
 
 ```
-proof → batch → variant → product → facet(*) → default
+proof → batch → variant → product → facet(*) → universal
 ```
 
 `facet(*)` means: walk every facet attached to the product in a deterministic order (alphabetical by `facetKey`, then `valueKey`) and use the first matching facet record.
@@ -208,7 +223,7 @@ If you are using `<RecordsAdminShell>`, the bulk actions menu is included and wi
 
 ## 9. CSV import / export
 
-Adopt this column shape across all records-based apps:
+If your app exposes CSV import/export, use this column shape so files round-trip across apps:
 
 ```
 scope,scopeRef,<field1>,<field2>,...
@@ -220,18 +235,22 @@ facet,bread_type/sourdough,240,11.0,...
 
 - `scope` is the kind; `scopeRef` is the human-readable reference (the shell maps it to the canonical `ref`).
 - Validation errors return a downloadable annotated CSV with an `error` column appended.
-- Round-tripping (export → reimport unchanged) MUST be a no-op.
+
+#### If you ship CSV
+
+- Round-tripping (export → reimport unchanged) must be a no-op.
 
 ---
 
 ## 10. Public-side hook contract
 
-To keep widgets consistent across apps, expose one hook per record type (implemented in `@proveanything/ui-utils`):
+To keep widgets consistent across apps, expose one hook per record type (from `@proveanything/smartlinks-utils-ui`):
 
 ```ts
 import { useResolvedRecord } from '@proveanything/smartlinks-utils-ui/records-admin';
 
 const { data, source, isLoading } = useResolvedRecord({
+  SL,
   appId,
   recordType: 'nutrition',
   // any combination of these — the hook walks the chain:
@@ -239,13 +258,13 @@ const { data, source, isLoading } = useResolvedRecord({
 });
 ```
 
-`source` is one of `'proof' | 'batch' | 'variant' | 'product' | 'facet' | 'default' | null`. UI can show a badge ("Showing batch-specific values") when useful.
+`source` is one of `'proof' | 'batch' | 'variant' | 'product' | 'facet' | 'universal' | null`. UI can show a badge ("Showing batch-specific values") when useful.
 
 ---
 
 ## 11. Telemetry
 
-All admin shells emit these events. The `<RecordsAdminShell>` from `@proveanything/ui-utils` wires them automatically using `interactions.appendEvent` from the SDK — apps don't call this themselves.
+All admin shells emit these events. The `<RecordsAdminShell>` from `@proveanything/smartlinks-utils-ui` wires them automatically using `interactions.appendEvent` from the SDK — apps don't call this themselves.
 
 | Event                  | Props                                                |
 |------------------------|------------------------------------------------------|
@@ -278,11 +297,11 @@ All admin shells emit these events. The `<RecordsAdminShell>` from `@proveanythi
 
 ## Appendix A — `ref` parser reference
 
-This is the canonical implementation. Copy it into your app or import from `@proveanything/ui-utils/records`.
+This is the canonical implementation. Copy it into your app or import from `@proveanything/smartlinks-utils-ui/records-admin`.
 
 ```ts
 type ParsedRef =
-  | { kind: 'default' }
+  | { kind: 'universal' }
   | { kind: 'product'; productId: string }
   | { kind: 'variant'; productId: string; variantId: string }
   | { kind: 'batch';   productId: string; batchId: string }
@@ -291,7 +310,7 @@ type ParsedRef =
 
 export const buildRef = (p: ParsedRef): string => {
   switch (p.kind) {
-    case 'default': return 'default';
+    case 'universal': return '';
     case 'product': return `product:${p.productId}`;
     case 'variant': return `variant:${p.productId}:${p.variantId}`;
     case 'batch':   return `batch:${p.productId}:${p.batchId}`;
@@ -301,7 +320,7 @@ export const buildRef = (p: ParsedRef): string => {
 };
 
 export const parseRef = (ref: string): ParsedRef | null => {
-  if (ref === 'default') return { kind: 'default' };
+  if (!ref) return { kind: 'universal' };
   const [head, ...rest] = ref.split(':');
   switch (head) {
     case 'product': return rest.length === 1 ? { kind: 'product', productId: rest[0] } : null;

package/docs/ui-utils.md

@@ -82,7 +82,7 @@ import * as SL from '@proveanything/smartlinks';
   scopes={['facet', 'product', 'variant', 'batch']}
   contextScope={{ productId, variantId, batchId }}   // from iframe URL — optional
   defaultData={() => ({})}
-  csvSchema={{ columns: [/* ... */] }}
+  csvSchema={{ columns: [/* ... */] }}  // optional — omit to disable CSV import/export
   renderEditor={(ctx) => <NutritionForm ctx={ctx} />}
   renderPreview={({ resolved }) => <pre>{JSON.stringify(resolved, null, 2)}</pre>}
 />
@@ -97,7 +97,7 @@ import * as SL from '@proveanything/smartlinks';
 - **Collection-aware tabs**: calls `collection.get` and hides Variants / Batches tabs unless `collection.variants` / `collection.batches` are true — no flicker
 - **Server-side pagination** via `useInfiniteQuery` — handles thousands of products with a "Load more" button
 - **Context-aware**: pass `contextScope` from your iframe URL (`productId` / `variantId` / `batchId`) and the browser is constrained to that subtree with the right tab auto-selected
-- **CSV import / export** with a schema you define; failed rows come back as an annotated CSV
+- **CSV import / export** (optional — provide `csvSchema` to enable); failed rows come back as an annotated CSV
 - **Bulk actions menu** (apply-to-many, copy-from, clear) via `bulkUpsert` / `bulkDelete`
 - **Telemetry hook** (`onTelemetry`) emits typed events for save, delete, scope change, CSV import/export, bulk apply
 - **i18n strings** fully overridable
@@ -136,7 +136,7 @@ const { data, source, isLoading } = useResolvedRecord({
   batchId,     // optional
   proofId,     // optional
 });
-// source: 'proof' | 'batch' | 'variant' | 'product' | 'facet' | 'default' | null
+// source: 'proof' | 'batch' | 'variant' | 'product' | 'facet' | 'universal' | null
 ```
 
 Walks the resolution chain defined in [records-admin-pattern.md §4](records-admin-pattern.md#4-resolution-order-required). Use this on the **public widget side** to read the correct value for a given context.