@inspectorhub/field-ui 0.3.0 → 0.5.0

package/README.md

@@ -24,7 +24,7 @@ The root entry exports:
 
 | Group | Exports |
 |---|---|
-| The editor | `FieldEditor` (props: `{ data: EditorData }`) |
+| The editor | `FieldEditor` (props: `{ data: EditorData; readOnly?: boolean }`) |
 | Host contract | `FieldDataSourceProvider`, `useFieldDataSource`, `useFieldCommand`, `useFieldEnsureHuman`, `useFieldSlots`, `isIgnored`, `setFieldLocale`, `bindFieldLocaleSource`, and the TypeScript types of the contract (`FieldDataSource`, `FieldHostSlots`, `FieldUrls`, `FieldResources`, `EditorData`, `SessionInfo`, and so on) |
 | Finding keys | `findingKey`, `findingsForUnit`, `isMetaKey` (the same functions the server uses to address a result) |
 | Photo decoding | `DecodeImageError`, `isDecodeImageError` (matches by error name, so it works across two copies of the package), and the types `DecodeImage`, `DecodeImageOptions`, `DecodedImage` (see `media` below) |
@@ -46,6 +46,13 @@ setFieldLocale(session.locale); // and keep it in step with the host's own local
 </FieldDataSourceProvider>
 ```
 
+Pass `readOnly` to show an inspection for reading only. Nothing in a read-only editor can write: the results document is
+never handed to a write helper, every write on the data source (commands, uploads, the media store, the resource writes)
+is refused with "This inspection is read-only.", and the controls that write (rating row, notes input, add-photo tile,
+publish, sign, finish, structure and template editing, settings, units, cost items, batch and Speed mode) are not
+rendered. Navigation, the section and item lists, the rating as an indicator, notes as text, photos and their viewer, the
+preview and updates from other people keep working. Without `readOnly` nothing changes.
+
 What the host has to provide:
 
 - A `FieldDataSource` (next section). `editorData` is what its `load()` returns.
@@ -131,6 +138,10 @@ signatures):
   neutral notice and counts the batch as saved, not failed.
 - `urls`: `FieldUrls`, the address builders for photos, reports, presence and
   in-app paths.
+  `photo()` is synchronous; a host that can only produce an address later (a photo it fetches and caches) provides the
+  optional `subscribe(listener)` and calls the listener whenever any photo address may have changed. The editor then asks
+  `photo()` again and its thumbnails, viewer and previews show the new address. Calls may be batched; `subscribe` returns
+  the unsubscribe function. Absent, nothing changes.
 - `resources`: `FieldResources`, optional capabilities (preferences, canned
   comments, cost items, repair items, media pool, settings sheet, AI assist,
   publish readiness, template search, version history, video). A member the

package/dist/{data-source-IaWUdrIc.d.ts → data-source-B3NrVs6i.d.ts}

@@ -524,6 +524,12 @@ interface TagLibraryEntry {
     name: string;
     color: string;
 }
+/** The tags on each checklist item of one inspection, keyed by the item's id (the editor's chips). */
+type ItemTagMap = Record<string, Array<{
+    id: string;
+    name: string;
+    color?: string;
+}>>;
 /** The loader returns `{ id, name, color }` rows. */
 interface DefectCategory {
     id: string;
@@ -1364,6 +1370,13 @@ interface CollabConnector {
 }
 interface FieldUrls {
     photo(inspectionId: string, key: string): string;
+    /**
+     * Optional. `photo()` is synchronous, so a host that can only produce an address later (a photo it fetches and
+     * caches, a signed address it renews) calls the listener whenever any photo address may have changed; the editor then
+     * asks `photo()` again and its thumbnails, viewer and previews show the new address. Calls may be batched. Returns
+     * the unsubscribe function. Absent: addresses are read when the editor renders, as before.
+     */
+    subscribe?(listener: () => void): () => void;
     reportPreview(tenantSlug: string, inspectionId: string): string | null;
     reportPdf(inspectionId: string): string | null;
     /**
@@ -1431,6 +1444,20 @@ interface FieldResources {
             id?: string;
         }>>;
     };
+    /**
+     * The tags on each checklist item of one inspection (the web host serves it from
+     * `/resources/inspection-item-tags`). `list` never rejects: `null` means the host could not read it, and the
+     * editor then shows what it already has. `add` and `remove` never reject either: a not-ok answer means the host
+     * did not store the change, and the editor takes it back. Both are idempotent (adding a tag that is attached, or
+     * removing one that is not, changes nothing), and the tag must be one of the company's own (`EditorData.tagLibrary`).
+     * Absent means the host cannot keep item tags: the editor holds them in memory for the session only, as it did
+     * before this member existed.
+     */
+    itemTags?: {
+        list(inspectionId: string): Promise<ItemTagMap | null>;
+        add(inspectionId: string, itemId: string, tagId: string): Promise<CommandResult>;
+        remove(inspectionId: string, itemId: string, tagId: string): Promise<CommandResult>;
+    };
     /** The tenant's repair-item catalogue (it is not per inspection). `list` never rejects: a failed read answers none. */
     repairItems?: {
         list(): Promise<RepairItemOption[]>;

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { F as FieldCommand, C as CommandResult, a as CommandData, b as FieldDataSource, E as EditorData, I as InspectionPrefs } from './data-source-IaWUdrIc.js';
-export { A as AiAssistInput, c as AiAssistResult, d as AutoAdvanceMode, e as AutofillReason, B as BulkCreateUnitsBody, f as CollabConnector, g as CommandDataMap, h as CommandKey, i as CommentsLibraryEntry, j as CommentsLibraryQuery, k as CommentsLibraryRow, l as CommercialPresets, m as ComplianceCommand, n as CompliancePanelData, o as CostItemView, p as CostItemWrite, q as CostItemsListing, r as CoverPhotoOption, D as DateFormat, s as DecodeImage, t as DecodeImageError, u as DecodeImageOptions, v as DecodedImage, w as DefectCategory, x as DocumentReviewItemView, y as EditorInspection, z as ExecuteOptions, G as FieldResources, H as FieldUrls, J as GalleryPhoto, K as InspectionUnit, M as METADATA_PRESETS, L as MediaFileResult, N as MediaPoolListing, O as MediaUploader, P as NotifyOptions, Q as NotifyVariant, R as OutboundCoolingWindow, S as PcaNarrative, T as PcaNarrativeData, U as PendingMediaRecord, V as PendingMediaStore, W as PhotoAnnotateMeta, X as PhotoCropMeta, Y as PhotoCropTransform, Z as PhotoUploadMeta, _ as PropertyMetaField, $ as PsqView, a0 as PublishBlockingDefect, a1 as PublishReadiness, a2 as RatingLevel, a3 as RelianceText, a4 as RepairItemOption, a5 as ReportLinkTtl, a6 as ReportProfileOption, a7 as ReportSignoffView, a8 as ResultMap, a9 as ResultsDocHandle, aa as RevisionStatus, ab as SaveStructureTemplateCommand, ac as SchemaItem, ad as SchemaSection, ae as SessionInfo, af as SettingsSheetData, ag as StatutoryCoverage, ah as StatutoryDetails, ai as TagLibraryEntry, aj as TemplateItemBody, ak as TemplateSchema, al as TemplateSearchResult, am as TemplateSnapshot, an as TemplateSummary, ao as TimeFormat, ap as UnitCommand, aq as UnitProgress, ar as VersionSnapshotContent, as as VersionSnapshotEntry, at as VideoFinalizeInput, au as VideoUploadRef, av as VideoUploadTicket, aw as isDecodeImageError, ax as resolvePcaNarrative } from './data-source-IaWUdrIc.js';
+import { F as FieldCommand, C as CommandResult, a as CommandData, b as FieldDataSource, E as EditorData, I as InspectionPrefs } from './data-source-B3NrVs6i.js';
+export { A as AiAssistInput, c as AiAssistResult, d as AutoAdvanceMode, e as AutofillReason, B as BulkCreateUnitsBody, f as CollabConnector, g as CommandDataMap, h as CommandKey, i as CommentsLibraryEntry, j as CommentsLibraryQuery, k as CommentsLibraryRow, l as CommercialPresets, m as ComplianceCommand, n as CompliancePanelData, o as CostItemView, p as CostItemWrite, q as CostItemsListing, r as CoverPhotoOption, D as DateFormat, s as DecodeImage, t as DecodeImageError, u as DecodeImageOptions, v as DecodedImage, w as DefectCategory, x as DocumentReviewItemView, y as EditorInspection, z as ExecuteOptions, G as FieldResources, H as FieldUrls, J as GalleryPhoto, K as InspectionUnit, M as METADATA_PRESETS, L as MediaFileResult, N as MediaPoolListing, O as MediaUploader, P as NotifyOptions, Q as NotifyVariant, R as OutboundCoolingWindow, S as PcaNarrative, T as PcaNarrativeData, U as PendingMediaRecord, V as PendingMediaStore, W as PhotoAnnotateMeta, X as PhotoCropMeta, Y as PhotoCropTransform, Z as PhotoUploadMeta, _ as PropertyMetaField, $ as PsqView, a0 as PublishBlockingDefect, a1 as PublishReadiness, a2 as RatingLevel, a3 as RelianceText, a4 as RepairItemOption, a5 as ReportLinkTtl, a6 as ReportProfileOption, a7 as ReportSignoffView, a8 as ResultMap, a9 as ResultsDocHandle, aa as RevisionStatus, ab as SaveStructureTemplateCommand, ac as SchemaItem, ad as SchemaSection, ae as SessionInfo, af as SettingsSheetData, ag as StatutoryCoverage, ah as StatutoryDetails, ai as TagLibraryEntry, aj as TemplateItemBody, ak as TemplateSchema, al as TemplateSearchResult, am as TemplateSnapshot, an as TemplateSummary, ao as TimeFormat, ap as UnitCommand, aq as UnitProgress, ar as VersionSnapshotContent, as as VersionSnapshotEntry, at as VideoFinalizeInput, au as VideoUploadRef, av as VideoUploadTicket, aw as isDecodeImageError, ax as resolvePcaNarrative } from './data-source-B3NrVs6i.js';
 import * as React from 'react';
 import { ReactNode } from 'react';
 import * as Y from 'yjs';
@@ -126,13 +126,10 @@ interface FieldCommandRunner {
  */
 declare function useFieldCommand(inspectionId: string): FieldCommandRunner;
 
-/**
- * The inspection editor page. It reads everything from its `data` prop, the field data source and the host
- * slots, so any host (web route, native shell) mounts it the same way. `data` must follow the host's
- * revalidation: units, publish state and the rest are read from it on every render.
- */
-declare function FieldEditor({ data }: {
+/** The inspection editor page. `readOnly` shows it for reading only: nothing in it can write, and the write controls are not offered. */
+declare function FieldEditor({ data, readOnly }: {
     data: EditorData;
+    readOnly?: boolean;
 }): React.JSX.Element;
 
 declare function findingKey(unitId: string | null | undefined, sectionId: string, itemId: string): string;