@ai-matrx/records 0.20.0 → 0.21.0

package/dist/react/index.d.cts

@@ -4775,6 +4775,185 @@ interface WorkAssignment {
     message: string;
 }
 
+/** What a step asks for before it counts as done. Every one of these is CHECKED. */
+type ChecklistRequirementKind = 
+/** A person says it is done. */
+"none"
+/** A sentence of evidence, under `note`. */
+ | "note"
+/** A named value filled in on the step itself. */
+ | "answer"
+/** A named Field on the record the run is about must hold a value. */
+ | "record_field"
+/** The step IS a form (SCR-19): finishing it needs a response record. */
+ | "form"
+/** The step IS a document from a doc template (REC-68): finishing it needs a render. */
+ | "document";
+interface ChecklistRequirement {
+    kind: ChecklistRequirementKind;
+    /** For `answer` and `record_field`: which value. */
+    key?: string;
+    /** What a person is asked for, in their words. */
+    label?: string;
+    /** For `form`: the published form this step is. */
+    form_id?: Uuid;
+    /** For `document`: the doc template this step renders. */
+    template_id?: Uuid;
+}
+/** One step of a checklist, as it is WRITTEN — not as it is run. */
+interface ChecklistStepSpec {
+    /** The name the checklist refers to this step by; lower-case, unique. */
+    ref: string;
+    /** What a person reads in their work. */
+    title: string;
+    /** Which role owns it. A role the checklist never declares is refused at save. */
+    role?: string;
+    /** How many days after the run starts it is due. */
+    due_days?: number;
+    /** Steps it waits for. A step waits only for steps listed above it. */
+    depends_on?: string[];
+    requires?: ChecklistRequirement;
+}
+/** A role, and the person who stands in it by default. */
+interface ChecklistRoleSpec {
+    role: string;
+    label?: string;
+    user_id?: Uuid | null;
+}
+/** What starts a run. */
+type ChecklistTriggerKind = "manual" | "record_created" | "status_reached";
+interface ChecklistTrigger {
+    kind: ChecklistTriggerKind;
+    /** The Table being watched, for the two kinds that watch one. */
+    table_id?: Uuid;
+    /** The state, for `status_reached`. */
+    status?: string;
+}
+/** THE COMPLETE DECLARATIVE CHECKLIST — one object, one call, a whole process. */
+interface ChecklistSpec {
+    name: string;
+    /** The Table a run is ABOUT: People, Hires, Jobs, Matters. */
+    about_table_id: Uuid;
+    roles?: ChecklistRoleSpec[];
+    trigger?: ChecklistTrigger;
+    steps: ChecklistStepSpec[];
+}
+/** What `custom.checklist_declare` answers. */
+interface ChecklistDeclared {
+    template_id: Uuid;
+    name: string;
+    about_table_id: Uuid;
+    steps_table_id: Uuid;
+    steps: number;
+    roles: number;
+    trigger: ChecklistTrigger;
+    created: boolean;
+    message: string;
+    ms: number;
+}
+/** One row of `custom.checklist_templates`. */
+interface ChecklistTemplateSummary {
+    template_id: Uuid;
+    name: string;
+    about_table_id: Uuid | null;
+    about_table: string | null;
+    steps: number;
+    roles: number;
+    trigger_kind: ChecklistTriggerKind;
+    trigger_status: string | null;
+    open_runs: number;
+    total_runs: number;
+    updated_at: Timestamp;
+}
+/** `custom.checklist_template_shape` — the spec, plus what the editor needs. */
+type ChecklistTemplateShape = ChecklistSpec & {
+    template_id: Uuid;
+    steps_table_id: Uuid | null;
+    may_change: boolean;
+};
+/** What `custom.checklist_start` answers. */
+interface ChecklistRunStarted {
+    run_id: Uuid;
+    template_id: Uuid;
+    template: string;
+    about_record_id: Uuid | null;
+    about: string | null;
+    steps_table_id: Uuid;
+    steps_created: number;
+    assigned: number;
+    unassigned: number;
+    origin: string;
+    steps: Array<{
+        ref: string;
+        step_id: Uuid;
+        title: string;
+        role: string | null;
+    }>;
+    /** Roles nobody is named for, so the screen can say so rather than show blanks. */
+    waiting_on_a_name: string[];
+    message: string;
+    ms: number;
+}
+/** One step of a RUN, as `custom.checklist_run` answers it. */
+interface ChecklistRunStep {
+    step_id: Uuid;
+    step_order: number;
+    ref: string;
+    title: string;
+    role: string | null;
+    assignee_name: string | null;
+    assignee_user_id: Uuid | null;
+    due_on: Timestamp | null;
+    due_state: WorkDueState;
+    status: string | null;
+    finished: boolean;
+    requires: ChecklistRequirementKind;
+    /**
+     * The key the answer is filed under, as the checklist named it. A screen files
+     * evidence under THIS, never under a name it invented — the store looks for
+     * exactly this key and nothing else.
+     */
+    requires_key: string | null;
+    requires_label: string | null;
+    /** The form or the document template this step is, when it is one. */
+    requires_id: Uuid | null;
+    evidence: Record<string, unknown>;
+    /** The titles of the steps it is still waiting for. */
+    blocked_by: string[];
+    may_complete: boolean;
+    /** Why it cannot be finished right now, in the words a person would use. */
+    refusal: string | null;
+}
+/** One row of `custom.checklist_runs`. */
+interface ChecklistRunSummary {
+    run_id: Uuid;
+    name: string;
+    template_id: Uuid | null;
+    template: string | null;
+    about_record_id: Uuid | null;
+    about: string | null;
+    about_table_id: Uuid | null;
+    started_at: Timestamp | null;
+    started_by: Uuid | null;
+    origin: string;
+    step_count: number;
+    done: number;
+    overdue: number;
+    next_step: string | null;
+    next_due: Timestamp | null;
+    closed_at: Timestamp | null;
+}
+/** What `custom.checklist_step_complete` answers. */
+interface ChecklistStepCompleted {
+    step_id: Uuid;
+    run_id?: Uuid;
+    completed: boolean;
+    evidence?: Record<string, unknown>;
+    steps_left?: number;
+    run_closed?: boolean;
+    message: string;
+}
+
 /**
  * VIS-31. A signed-in OUTSIDER, with the reason in plain English.
  *
@@ -5920,6 +6099,67 @@ interface RecordsClient {
         form_id: Uuid;
         published?: boolean;
     }): Promise<RecordsResult<Timestamp | null>>;
+    /**
+     * What is wrong with a checklist somebody is writing, in the words they would
+     * use. `null` means it is fine. Pure — it reads no row and writes nothing —
+     * so an editor may ask it on every keystroke and the refusal arrives BEFORE
+     * the save rather than after it.
+     */
+    checklistRefusal(args: {
+        spec: ChecklistSpec;
+    }): Promise<RecordsResult<string | null>>;
+    /**
+     * Store a checklist, whole: ordered steps, who each belongs to by role, how
+     * many days in each is due, what each waits for, what each asks for, and what
+     * starts a run. Pass `template_id` to change the checklist that already
+     * exists rather than making a second one.
+     */
+    checklistDeclare(args: {
+        spec: ChecklistSpec;
+        template_id?: Uuid | null;
+    }): Promise<RecordsResult<ChecklistDeclared>>;
+    checklistTemplates(args?: {
+        about_table_id?: Uuid | null;
+        limit?: number;
+    }): Promise<RecordsResult<ChecklistTemplateSummary[]>>;
+    checklistTemplateShape(args: {
+        template_id: Uuid;
+    }): Promise<RecordsResult<ChecklistTemplateShape>>;
+    /**
+     * Run a checklist for one record: one work item per step in the ONE work
+     * layer, assigned by role to real people, dated from the offsets,
+     * dependencies carried across. `roles` names who stands in each role for THIS
+     * run, over whatever the checklist says by default.
+     */
+    checklistStart(args: {
+        template_id: Uuid;
+        about_record_id?: Uuid | null;
+        roles?: Record<string, Uuid>;
+        startingAt?: Timestamp | null;
+    }): Promise<RecordsResult<ChecklistRunStarted>>;
+    checklistRun(args: {
+        run_id: Uuid;
+    }): Promise<RecordsResult<ChecklistRunStep[]>>;
+    checklistRuns(args?: {
+        about_table_id?: Uuid | null;
+        about_record_id?: Uuid | null;
+        includeClosed?: boolean;
+        limit?: number;
+    }): Promise<RecordsResult<ChecklistRunSummary[]>>;
+    /**
+     * Tick a step off with whatever it asked for. Refused by name while a step it
+     * waits for is open, or while what it asks for is missing — and the same
+     * refusal meets `workSetState`, because the rule lives in the store and not
+     * in this door.
+     */
+    checklistStepComplete(args: {
+        step_id: Uuid;
+        evidence?: Record<string, unknown>;
+    }): Promise<RecordsResult<ChecklistStepCompleted>>;
+    /** Why this step cannot be finished right now. `null` means it can. */
+    checklistStepRefusal(args: {
+        step_id: Uuid;
+    }): Promise<RecordsResult<string | null>>;
     /** The five states and what each one may become. Asked, never hardcoded in a picker. */
     workStates(): Promise<RecordsResult<WorkState[]>>;
     /** Why this graph would be refused — asked BEFORE it is written. `null` means it is fine. */
@@ -6344,4 +6584,4 @@ declare function useFieldMutation(): UseFieldMutation;
  */
 declare function useMergeField(key: string | null, state?: Record<string, unknown>): MergeFieldResolution | null;
 
-export { ABSENCE_REASONS, ACTOR_VOCABULARY, type AbsenceReason, type Actor, type AggregateBucket, type AggregateFilter, type AggregateMeasure, type AggregateOperation, type AggregateRow, type AggregateWindow, type AnonTokenBinding, COMPUTE_ON, CONTEXT_POLICIES, type ChoiceOption, type CommentThreadRead, type CommentWritten, type ComputeOn, type ContextPolicy, type ConversationScope, type ConversationScopeContext, type CustomFieldTableType, DELIVERIES, type DashboardBlock, type DashboardBlockKind, type DashboardBlockResult, type DashboardRunResult, type DashboardSummary, type Delivery, type DocRenderRow, type DocSignatureCheck, type DocSignatureRow, type DocTemplateRow, type DocToken, type DocUnresolvedToken, ENTITY_TOKENS, type EntityFieldRights, type EntityFieldValue, type EntityRecordMatch, type EntityRecordRead, type EntityRecordsFound, type EntityTableFacts, type EntityToken, type ExternalPrincipalCard, FIELD_SENSITIVITIES, FIELD_SOURCES, FRESHNESS, type Field, type FieldBehavior, type FieldHistoryEntry, type FieldPatch, type FieldProposal, type FieldRule, type FieldSensitivity, type FieldSource, type FieldTypeWord, type ForbiddenEnvelopeWord, type FormSummary, type Freshness, type HiddenFieldNotice, type HistoryActor, type HistoryActorKind, type HistoryChange, type Home, type ImportBatchResult, type ImportColumnPlan, type ImportFinished, type ImportOpened, type ImportOutcome, type ImportPlan, type ImportPolicy, type ImportProposal, type ImportReport, type ImportRun, type InboundAddress, type InboundDeclared, KERNEL_TABLES, type KernelTableName, MERGE_FIELD_MODIFIERS, MERGE_FIELD_SEMANTIC_TYPES, MERGE_FIELD_SOURCES, type MergeField, type MergeFieldModifier, type MergeFieldProvenance, type MergeFieldResolution, type MergeFieldSemanticType, type MergeFieldSource, type MergeFieldTransform, type MissingBehavior, type MyLevel, type MySubscription, type NewEntityFieldDeclaration, type NewFieldDeclaration, ON_DELETE, OVERRIDE_POLICIES, type OnDelete, type OverridePolicy, PARITY_FIELD_TYPES, PERMISSION_LEVELS, PER_VALUE_ACCESS_WORDS, type ParityFieldType, type ParityFieldTypeDescriptor, type PerValueAccessWord, type PermissionLevel, type PgError, type PortalCard, type PortalInvitation, type PortalPreviewRow, type PortalPrincipal, type PortalRevocation, type PortalSummary, type PortalTableExposure, type PredictedRefusal, type ProvenancePointer, type PublishBinding, RELATION_BINDINGS, RELATION_CARDINALITIES, RELATION_FLAVORS, RETIRED_ACTOR_WORDS, RULE_NODE_KINDS, RULE_USES, type ReadRow, type ReadValue, type RecordComment, type RecordDocument, type RecordHistoryEntry, type RecordRead, type RecordRevision, type RecordScopeComment, type RecordScopeContext, type RecordScopeField, type RecordScopeHistoryEntry, type RecordScopeRelation, type RecordScopeWithheld, type RecordsActor, type RecordsConfig, type RecordsDataSource, type RecordsError, type RecordsErrorCode, type RecordsErrorSink, type RecordsFilter, RecordsProvider, type RecordsProviderProps, type RecordsRealtimePort, type RecordsResolverPort, type RecordsResponse, type RecordsResult, type RecordsTableQuery, type RegisteredTable, type Relation, type RelationBinding, type RelationCardinality, type RelationCarries, type RelationCoordinate, type RelationFlavor, type RelationProperties, type RelationTarget, type ResolutionTriple, type ResolvedPublishBinding, type RestorePreview, type RestoreResult, type RetiredActorWord, type Rule, type RuleAnswer, type RuleExpression, type RuleNodeKind, type RuleUse, STORAGE_MODES, STORE_DOORS, STORE_KNOBS, STORE_REFUSAL_CODES, type StaleWriteDetail, type StorageMode, type StoreDoorName, type StoreRefusalCode, type StoredRecord, type StuckRow, type Subscription, type SubscriptionBlock, type SubscriptionCadence, TABLE_DISPLAYS, TABLE_ORIGINS, TABLE_TYPES, type Table, type TableCapacity, type TableDisplay, type TableOrigin, type TableProposal, type TableType, type Timestamp, type UseEntityFieldMutation, type UseFieldMutation, type UseRecordMutation, type UseRecordsOptions, type UseRecordsState, type Uuid, VALUE_ALTERNATE_KEYS, VALUE_ENVELOPE_KEYS, type ValueAlternate, type ValueAlternateKey, type ValueEnvelope, type ValueEnvelopeKey, type ValueSource, type WorkApprovalDecision, type WorkApprovalFiled, type WorkApprover, type WorkAssignment, type WorkAssignmentField, type WorkChange, type WorkDueState, type WorkGraph, type WorkInboxItem, type WorkInboxKind, type WorkInstantiation, type WorkListFlavour, type WorkListItem, type WorkOrigin, type WorkRecordState, type WorkSlotHold, type WorkState, type WorkTemplateNode, type WorkTemplateRelation, type WorkTurn, type WriteConflict, asPermissionLevel, atLeast, choiceSlug, choiceValuesOf, choicesOf, err, highestLevel, holdsARetiredChoice, isRecordsErr, isTheChosen, looksLikeAnId, measureKey, ok, optionKey, optionLabel, portalPath, publicFormPath, scopeChip, useEntityFieldMutation, useEntityFieldRights, useEntityFields, useEntityRecord, useEntityTable, useFieldMutation, useFields, useMergeField, useMyLevel, useMyLevels, useOptionalRecordsClient, useRecord, useRecordMutation, useRecords, useRecordsActor, useRecordsClient, useTable, useTables };
+export { ABSENCE_REASONS, ACTOR_VOCABULARY, type AbsenceReason, type Actor, type AggregateBucket, type AggregateFilter, type AggregateMeasure, type AggregateOperation, type AggregateRow, type AggregateWindow, type AnonTokenBinding, COMPUTE_ON, CONTEXT_POLICIES, type ChecklistDeclared, type ChecklistRequirement, type ChecklistRequirementKind, type ChecklistRoleSpec, type ChecklistRunStarted, type ChecklistRunStep, type ChecklistRunSummary, type ChecklistSpec, type ChecklistStepCompleted, type ChecklistStepSpec, type ChecklistTemplateShape, type ChecklistTemplateSummary, type ChecklistTrigger, type ChecklistTriggerKind, type ChoiceOption, type CommentThreadRead, type CommentWritten, type ComputeOn, type ContextPolicy, type ConversationScope, type ConversationScopeContext, type CustomFieldTableType, DELIVERIES, type DashboardBlock, type DashboardBlockKind, type DashboardBlockResult, type DashboardRunResult, type DashboardSummary, type Delivery, type DocRenderRow, type DocSignatureCheck, type DocSignatureRow, type DocTemplateRow, type DocToken, type DocUnresolvedToken, ENTITY_TOKENS, type EntityFieldRights, type EntityFieldValue, type EntityRecordMatch, type EntityRecordRead, type EntityRecordsFound, type EntityTableFacts, type EntityToken, type ExternalPrincipalCard, FIELD_SENSITIVITIES, FIELD_SOURCES, FRESHNESS, type Field, type FieldBehavior, type FieldHistoryEntry, type FieldPatch, type FieldProposal, type FieldRule, type FieldSensitivity, type FieldSource, type FieldTypeWord, type ForbiddenEnvelopeWord, type FormSummary, type Freshness, type HiddenFieldNotice, type HistoryActor, type HistoryActorKind, type HistoryChange, type Home, type ImportBatchResult, type ImportColumnPlan, type ImportFinished, type ImportOpened, type ImportOutcome, type ImportPlan, type ImportPolicy, type ImportProposal, type ImportReport, type ImportRun, type InboundAddress, type InboundDeclared, KERNEL_TABLES, type KernelTableName, MERGE_FIELD_MODIFIERS, MERGE_FIELD_SEMANTIC_TYPES, MERGE_FIELD_SOURCES, type MergeField, type MergeFieldModifier, type MergeFieldProvenance, type MergeFieldResolution, type MergeFieldSemanticType, type MergeFieldSource, type MergeFieldTransform, type MissingBehavior, type MyLevel, type MySubscription, type NewEntityFieldDeclaration, type NewFieldDeclaration, ON_DELETE, OVERRIDE_POLICIES, type OnDelete, type OverridePolicy, PARITY_FIELD_TYPES, PERMISSION_LEVELS, PER_VALUE_ACCESS_WORDS, type ParityFieldType, type ParityFieldTypeDescriptor, type PerValueAccessWord, type PermissionLevel, type PgError, type PortalCard, type PortalInvitation, type PortalPreviewRow, type PortalPrincipal, type PortalRevocation, type PortalSummary, type PortalTableExposure, type PredictedRefusal, type ProvenancePointer, type PublishBinding, RELATION_BINDINGS, RELATION_CARDINALITIES, RELATION_FLAVORS, RETIRED_ACTOR_WORDS, RULE_NODE_KINDS, RULE_USES, type ReadRow, type ReadValue, type RecordComment, type RecordDocument, type RecordHistoryEntry, type RecordRead, type RecordRevision, type RecordScopeComment, type RecordScopeContext, type RecordScopeField, type RecordScopeHistoryEntry, type RecordScopeRelation, type RecordScopeWithheld, type RecordsActor, type RecordsConfig, type RecordsDataSource, type RecordsError, type RecordsErrorCode, type RecordsErrorSink, type RecordsFilter, RecordsProvider, type RecordsProviderProps, type RecordsRealtimePort, type RecordsResolverPort, type RecordsResponse, type RecordsResult, type RecordsTableQuery, type RegisteredTable, type Relation, type RelationBinding, type RelationCardinality, type RelationCarries, type RelationCoordinate, type RelationFlavor, type RelationProperties, type RelationTarget, type ResolutionTriple, type ResolvedPublishBinding, type RestorePreview, type RestoreResult, type RetiredActorWord, type Rule, type RuleAnswer, type RuleExpression, type RuleNodeKind, type RuleUse, STORAGE_MODES, STORE_DOORS, STORE_KNOBS, STORE_REFUSAL_CODES, type StaleWriteDetail, type StorageMode, type StoreDoorName, type StoreRefusalCode, type StoredRecord, type StuckRow, type Subscription, type SubscriptionBlock, type SubscriptionCadence, TABLE_DISPLAYS, TABLE_ORIGINS, TABLE_TYPES, type Table, type TableCapacity, type TableDisplay, type TableOrigin, type TableProposal, type TableType, type Timestamp, type UseEntityFieldMutation, type UseFieldMutation, type UseRecordMutation, type UseRecordsOptions, type UseRecordsState, type Uuid, VALUE_ALTERNATE_KEYS, VALUE_ENVELOPE_KEYS, type ValueAlternate, type ValueAlternateKey, type ValueEnvelope, type ValueEnvelopeKey, type ValueSource, type WorkApprovalDecision, type WorkApprovalFiled, type WorkApprover, type WorkAssignment, type WorkAssignmentField, type WorkChange, type WorkDueState, type WorkGraph, type WorkInboxItem, type WorkInboxKind, type WorkInstantiation, type WorkListFlavour, type WorkListItem, type WorkOrigin, type WorkRecordState, type WorkSlotHold, type WorkState, type WorkTemplateNode, type WorkTemplateRelation, type WorkTurn, type WriteConflict, asPermissionLevel, atLeast, choiceSlug, choiceValuesOf, choicesOf, err, highestLevel, holdsARetiredChoice, isRecordsErr, isTheChosen, looksLikeAnId, measureKey, ok, optionKey, optionLabel, portalPath, publicFormPath, scopeChip, useEntityFieldMutation, useEntityFieldRights, useEntityFields, useEntityRecord, useEntityTable, useFieldMutation, useFields, useMergeField, useMyLevel, useMyLevels, useOptionalRecordsClient, useRecord, useRecordMutation, useRecords, useRecordsActor, useRecordsClient, useTable, useTables };

package/dist/react/index.d.ts

@@ -4775,6 +4775,185 @@ interface WorkAssignment {
     message: string;
 }
 
+/** What a step asks for before it counts as done. Every one of these is CHECKED. */
+type ChecklistRequirementKind = 
+/** A person says it is done. */
+"none"
+/** A sentence of evidence, under `note`. */
+ | "note"
+/** A named value filled in on the step itself. */
+ | "answer"
+/** A named Field on the record the run is about must hold a value. */
+ | "record_field"
+/** The step IS a form (SCR-19): finishing it needs a response record. */
+ | "form"
+/** The step IS a document from a doc template (REC-68): finishing it needs a render. */
+ | "document";
+interface ChecklistRequirement {
+    kind: ChecklistRequirementKind;
+    /** For `answer` and `record_field`: which value. */
+    key?: string;
+    /** What a person is asked for, in their words. */
+    label?: string;
+    /** For `form`: the published form this step is. */
+    form_id?: Uuid;
+    /** For `document`: the doc template this step renders. */
+    template_id?: Uuid;
+}
+/** One step of a checklist, as it is WRITTEN — not as it is run. */
+interface ChecklistStepSpec {
+    /** The name the checklist refers to this step by; lower-case, unique. */
+    ref: string;
+    /** What a person reads in their work. */
+    title: string;
+    /** Which role owns it. A role the checklist never declares is refused at save. */
+    role?: string;
+    /** How many days after the run starts it is due. */
+    due_days?: number;
+    /** Steps it waits for. A step waits only for steps listed above it. */
+    depends_on?: string[];
+    requires?: ChecklistRequirement;
+}
+/** A role, and the person who stands in it by default. */
+interface ChecklistRoleSpec {
+    role: string;
+    label?: string;
+    user_id?: Uuid | null;
+}
+/** What starts a run. */
+type ChecklistTriggerKind = "manual" | "record_created" | "status_reached";
+interface ChecklistTrigger {
+    kind: ChecklistTriggerKind;
+    /** The Table being watched, for the two kinds that watch one. */
+    table_id?: Uuid;
+    /** The state, for `status_reached`. */
+    status?: string;
+}
+/** THE COMPLETE DECLARATIVE CHECKLIST — one object, one call, a whole process. */
+interface ChecklistSpec {
+    name: string;
+    /** The Table a run is ABOUT: People, Hires, Jobs, Matters. */
+    about_table_id: Uuid;
+    roles?: ChecklistRoleSpec[];
+    trigger?: ChecklistTrigger;
+    steps: ChecklistStepSpec[];
+}
+/** What `custom.checklist_declare` answers. */
+interface ChecklistDeclared {
+    template_id: Uuid;
+    name: string;
+    about_table_id: Uuid;
+    steps_table_id: Uuid;
+    steps: number;
+    roles: number;
+    trigger: ChecklistTrigger;
+    created: boolean;
+    message: string;
+    ms: number;
+}
+/** One row of `custom.checklist_templates`. */
+interface ChecklistTemplateSummary {
+    template_id: Uuid;
+    name: string;
+    about_table_id: Uuid | null;
+    about_table: string | null;
+    steps: number;
+    roles: number;
+    trigger_kind: ChecklistTriggerKind;
+    trigger_status: string | null;
+    open_runs: number;
+    total_runs: number;
+    updated_at: Timestamp;
+}
+/** `custom.checklist_template_shape` — the spec, plus what the editor needs. */
+type ChecklistTemplateShape = ChecklistSpec & {
+    template_id: Uuid;
+    steps_table_id: Uuid | null;
+    may_change: boolean;
+};
+/** What `custom.checklist_start` answers. */
+interface ChecklistRunStarted {
+    run_id: Uuid;
+    template_id: Uuid;
+    template: string;
+    about_record_id: Uuid | null;
+    about: string | null;
+    steps_table_id: Uuid;
+    steps_created: number;
+    assigned: number;
+    unassigned: number;
+    origin: string;
+    steps: Array<{
+        ref: string;
+        step_id: Uuid;
+        title: string;
+        role: string | null;
+    }>;
+    /** Roles nobody is named for, so the screen can say so rather than show blanks. */
+    waiting_on_a_name: string[];
+    message: string;
+    ms: number;
+}
+/** One step of a RUN, as `custom.checklist_run` answers it. */
+interface ChecklistRunStep {
+    step_id: Uuid;
+    step_order: number;
+    ref: string;
+    title: string;
+    role: string | null;
+    assignee_name: string | null;
+    assignee_user_id: Uuid | null;
+    due_on: Timestamp | null;
+    due_state: WorkDueState;
+    status: string | null;
+    finished: boolean;
+    requires: ChecklistRequirementKind;
+    /**
+     * The key the answer is filed under, as the checklist named it. A screen files
+     * evidence under THIS, never under a name it invented — the store looks for
+     * exactly this key and nothing else.
+     */
+    requires_key: string | null;
+    requires_label: string | null;
+    /** The form or the document template this step is, when it is one. */
+    requires_id: Uuid | null;
+    evidence: Record<string, unknown>;
+    /** The titles of the steps it is still waiting for. */
+    blocked_by: string[];
+    may_complete: boolean;
+    /** Why it cannot be finished right now, in the words a person would use. */
+    refusal: string | null;
+}
+/** One row of `custom.checklist_runs`. */
+interface ChecklistRunSummary {
+    run_id: Uuid;
+    name: string;
+    template_id: Uuid | null;
+    template: string | null;
+    about_record_id: Uuid | null;
+    about: string | null;
+    about_table_id: Uuid | null;
+    started_at: Timestamp | null;
+    started_by: Uuid | null;
+    origin: string;
+    step_count: number;
+    done: number;
+    overdue: number;
+    next_step: string | null;
+    next_due: Timestamp | null;
+    closed_at: Timestamp | null;
+}
+/** What `custom.checklist_step_complete` answers. */
+interface ChecklistStepCompleted {
+    step_id: Uuid;
+    run_id?: Uuid;
+    completed: boolean;
+    evidence?: Record<string, unknown>;
+    steps_left?: number;
+    run_closed?: boolean;
+    message: string;
+}
+
 /**
  * VIS-31. A signed-in OUTSIDER, with the reason in plain English.
  *
@@ -5920,6 +6099,67 @@ interface RecordsClient {
         form_id: Uuid;
         published?: boolean;
     }): Promise<RecordsResult<Timestamp | null>>;
+    /**
+     * What is wrong with a checklist somebody is writing, in the words they would
+     * use. `null` means it is fine. Pure — it reads no row and writes nothing —
+     * so an editor may ask it on every keystroke and the refusal arrives BEFORE
+     * the save rather than after it.
+     */
+    checklistRefusal(args: {
+        spec: ChecklistSpec;
+    }): Promise<RecordsResult<string | null>>;
+    /**
+     * Store a checklist, whole: ordered steps, who each belongs to by role, how
+     * many days in each is due, what each waits for, what each asks for, and what
+     * starts a run. Pass `template_id` to change the checklist that already
+     * exists rather than making a second one.
+     */
+    checklistDeclare(args: {
+        spec: ChecklistSpec;
+        template_id?: Uuid | null;
+    }): Promise<RecordsResult<ChecklistDeclared>>;
+    checklistTemplates(args?: {
+        about_table_id?: Uuid | null;
+        limit?: number;
+    }): Promise<RecordsResult<ChecklistTemplateSummary[]>>;
+    checklistTemplateShape(args: {
+        template_id: Uuid;
+    }): Promise<RecordsResult<ChecklistTemplateShape>>;
+    /**
+     * Run a checklist for one record: one work item per step in the ONE work
+     * layer, assigned by role to real people, dated from the offsets,
+     * dependencies carried across. `roles` names who stands in each role for THIS
+     * run, over whatever the checklist says by default.
+     */
+    checklistStart(args: {
+        template_id: Uuid;
+        about_record_id?: Uuid | null;
+        roles?: Record<string, Uuid>;
+        startingAt?: Timestamp | null;
+    }): Promise<RecordsResult<ChecklistRunStarted>>;
+    checklistRun(args: {
+        run_id: Uuid;
+    }): Promise<RecordsResult<ChecklistRunStep[]>>;
+    checklistRuns(args?: {
+        about_table_id?: Uuid | null;
+        about_record_id?: Uuid | null;
+        includeClosed?: boolean;
+        limit?: number;
+    }): Promise<RecordsResult<ChecklistRunSummary[]>>;
+    /**
+     * Tick a step off with whatever it asked for. Refused by name while a step it
+     * waits for is open, or while what it asks for is missing — and the same
+     * refusal meets `workSetState`, because the rule lives in the store and not
+     * in this door.
+     */
+    checklistStepComplete(args: {
+        step_id: Uuid;
+        evidence?: Record<string, unknown>;
+    }): Promise<RecordsResult<ChecklistStepCompleted>>;
+    /** Why this step cannot be finished right now. `null` means it can. */
+    checklistStepRefusal(args: {
+        step_id: Uuid;
+    }): Promise<RecordsResult<string | null>>;
     /** The five states and what each one may become. Asked, never hardcoded in a picker. */
     workStates(): Promise<RecordsResult<WorkState[]>>;
     /** Why this graph would be refused — asked BEFORE it is written. `null` means it is fine. */
@@ -6344,4 +6584,4 @@ declare function useFieldMutation(): UseFieldMutation;
  */
 declare function useMergeField(key: string | null, state?: Record<string, unknown>): MergeFieldResolution | null;
 
-export { ABSENCE_REASONS, ACTOR_VOCABULARY, type AbsenceReason, type Actor, type AggregateBucket, type AggregateFilter, type AggregateMeasure, type AggregateOperation, type AggregateRow, type AggregateWindow, type AnonTokenBinding, COMPUTE_ON, CONTEXT_POLICIES, type ChoiceOption, type CommentThreadRead, type CommentWritten, type ComputeOn, type ContextPolicy, type ConversationScope, type ConversationScopeContext, type CustomFieldTableType, DELIVERIES, type DashboardBlock, type DashboardBlockKind, type DashboardBlockResult, type DashboardRunResult, type DashboardSummary, type Delivery, type DocRenderRow, type DocSignatureCheck, type DocSignatureRow, type DocTemplateRow, type DocToken, type DocUnresolvedToken, ENTITY_TOKENS, type EntityFieldRights, type EntityFieldValue, type EntityRecordMatch, type EntityRecordRead, type EntityRecordsFound, type EntityTableFacts, type EntityToken, type ExternalPrincipalCard, FIELD_SENSITIVITIES, FIELD_SOURCES, FRESHNESS, type Field, type FieldBehavior, type FieldHistoryEntry, type FieldPatch, type FieldProposal, type FieldRule, type FieldSensitivity, type FieldSource, type FieldTypeWord, type ForbiddenEnvelopeWord, type FormSummary, type Freshness, type HiddenFieldNotice, type HistoryActor, type HistoryActorKind, type HistoryChange, type Home, type ImportBatchResult, type ImportColumnPlan, type ImportFinished, type ImportOpened, type ImportOutcome, type ImportPlan, type ImportPolicy, type ImportProposal, type ImportReport, type ImportRun, type InboundAddress, type InboundDeclared, KERNEL_TABLES, type KernelTableName, MERGE_FIELD_MODIFIERS, MERGE_FIELD_SEMANTIC_TYPES, MERGE_FIELD_SOURCES, type MergeField, type MergeFieldModifier, type MergeFieldProvenance, type MergeFieldResolution, type MergeFieldSemanticType, type MergeFieldSource, type MergeFieldTransform, type MissingBehavior, type MyLevel, type MySubscription, type NewEntityFieldDeclaration, type NewFieldDeclaration, ON_DELETE, OVERRIDE_POLICIES, type OnDelete, type OverridePolicy, PARITY_FIELD_TYPES, PERMISSION_LEVELS, PER_VALUE_ACCESS_WORDS, type ParityFieldType, type ParityFieldTypeDescriptor, type PerValueAccessWord, type PermissionLevel, type PgError, type PortalCard, type PortalInvitation, type PortalPreviewRow, type PortalPrincipal, type PortalRevocation, type PortalSummary, type PortalTableExposure, type PredictedRefusal, type ProvenancePointer, type PublishBinding, RELATION_BINDINGS, RELATION_CARDINALITIES, RELATION_FLAVORS, RETIRED_ACTOR_WORDS, RULE_NODE_KINDS, RULE_USES, type ReadRow, type ReadValue, type RecordComment, type RecordDocument, type RecordHistoryEntry, type RecordRead, type RecordRevision, type RecordScopeComment, type RecordScopeContext, type RecordScopeField, type RecordScopeHistoryEntry, type RecordScopeRelation, type RecordScopeWithheld, type RecordsActor, type RecordsConfig, type RecordsDataSource, type RecordsError, type RecordsErrorCode, type RecordsErrorSink, type RecordsFilter, RecordsProvider, type RecordsProviderProps, type RecordsRealtimePort, type RecordsResolverPort, type RecordsResponse, type RecordsResult, type RecordsTableQuery, type RegisteredTable, type Relation, type RelationBinding, type RelationCardinality, type RelationCarries, type RelationCoordinate, type RelationFlavor, type RelationProperties, type RelationTarget, type ResolutionTriple, type ResolvedPublishBinding, type RestorePreview, type RestoreResult, type RetiredActorWord, type Rule, type RuleAnswer, type RuleExpression, type RuleNodeKind, type RuleUse, STORAGE_MODES, STORE_DOORS, STORE_KNOBS, STORE_REFUSAL_CODES, type StaleWriteDetail, type StorageMode, type StoreDoorName, type StoreRefusalCode, type StoredRecord, type StuckRow, type Subscription, type SubscriptionBlock, type SubscriptionCadence, TABLE_DISPLAYS, TABLE_ORIGINS, TABLE_TYPES, type Table, type TableCapacity, type TableDisplay, type TableOrigin, type TableProposal, type TableType, type Timestamp, type UseEntityFieldMutation, type UseFieldMutation, type UseRecordMutation, type UseRecordsOptions, type UseRecordsState, type Uuid, VALUE_ALTERNATE_KEYS, VALUE_ENVELOPE_KEYS, type ValueAlternate, type ValueAlternateKey, type ValueEnvelope, type ValueEnvelopeKey, type ValueSource, type WorkApprovalDecision, type WorkApprovalFiled, type WorkApprover, type WorkAssignment, type WorkAssignmentField, type WorkChange, type WorkDueState, type WorkGraph, type WorkInboxItem, type WorkInboxKind, type WorkInstantiation, type WorkListFlavour, type WorkListItem, type WorkOrigin, type WorkRecordState, type WorkSlotHold, type WorkState, type WorkTemplateNode, type WorkTemplateRelation, type WorkTurn, type WriteConflict, asPermissionLevel, atLeast, choiceSlug, choiceValuesOf, choicesOf, err, highestLevel, holdsARetiredChoice, isRecordsErr, isTheChosen, looksLikeAnId, measureKey, ok, optionKey, optionLabel, portalPath, publicFormPath, scopeChip, useEntityFieldMutation, useEntityFieldRights, useEntityFields, useEntityRecord, useEntityTable, useFieldMutation, useFields, useMergeField, useMyLevel, useMyLevels, useOptionalRecordsClient, useRecord, useRecordMutation, useRecords, useRecordsActor, useRecordsClient, useTable, useTables };
+export { ABSENCE_REASONS, ACTOR_VOCABULARY, type AbsenceReason, type Actor, type AggregateBucket, type AggregateFilter, type AggregateMeasure, type AggregateOperation, type AggregateRow, type AggregateWindow, type AnonTokenBinding, COMPUTE_ON, CONTEXT_POLICIES, type ChecklistDeclared, type ChecklistRequirement, type ChecklistRequirementKind, type ChecklistRoleSpec, type ChecklistRunStarted, type ChecklistRunStep, type ChecklistRunSummary, type ChecklistSpec, type ChecklistStepCompleted, type ChecklistStepSpec, type ChecklistTemplateShape, type ChecklistTemplateSummary, type ChecklistTrigger, type ChecklistTriggerKind, type ChoiceOption, type CommentThreadRead, type CommentWritten, type ComputeOn, type ContextPolicy, type ConversationScope, type ConversationScopeContext, type CustomFieldTableType, DELIVERIES, type DashboardBlock, type DashboardBlockKind, type DashboardBlockResult, type DashboardRunResult, type DashboardSummary, type Delivery, type DocRenderRow, type DocSignatureCheck, type DocSignatureRow, type DocTemplateRow, type DocToken, type DocUnresolvedToken, ENTITY_TOKENS, type EntityFieldRights, type EntityFieldValue, type EntityRecordMatch, type EntityRecordRead, type EntityRecordsFound, type EntityTableFacts, type EntityToken, type ExternalPrincipalCard, FIELD_SENSITIVITIES, FIELD_SOURCES, FRESHNESS, type Field, type FieldBehavior, type FieldHistoryEntry, type FieldPatch, type FieldProposal, type FieldRule, type FieldSensitivity, type FieldSource, type FieldTypeWord, type ForbiddenEnvelopeWord, type FormSummary, type Freshness, type HiddenFieldNotice, type HistoryActor, type HistoryActorKind, type HistoryChange, type Home, type ImportBatchResult, type ImportColumnPlan, type ImportFinished, type ImportOpened, type ImportOutcome, type ImportPlan, type ImportPolicy, type ImportProposal, type ImportReport, type ImportRun, type InboundAddress, type InboundDeclared, KERNEL_TABLES, type KernelTableName, MERGE_FIELD_MODIFIERS, MERGE_FIELD_SEMANTIC_TYPES, MERGE_FIELD_SOURCES, type MergeField, type MergeFieldModifier, type MergeFieldProvenance, type MergeFieldResolution, type MergeFieldSemanticType, type MergeFieldSource, type MergeFieldTransform, type MissingBehavior, type MyLevel, type MySubscription, type NewEntityFieldDeclaration, type NewFieldDeclaration, ON_DELETE, OVERRIDE_POLICIES, type OnDelete, type OverridePolicy, PARITY_FIELD_TYPES, PERMISSION_LEVELS, PER_VALUE_ACCESS_WORDS, type ParityFieldType, type ParityFieldTypeDescriptor, type PerValueAccessWord, type PermissionLevel, type PgError, type PortalCard, type PortalInvitation, type PortalPreviewRow, type PortalPrincipal, type PortalRevocation, type PortalSummary, type PortalTableExposure, type PredictedRefusal, type ProvenancePointer, type PublishBinding, RELATION_BINDINGS, RELATION_CARDINALITIES, RELATION_FLAVORS, RETIRED_ACTOR_WORDS, RULE_NODE_KINDS, RULE_USES, type ReadRow, type ReadValue, type RecordComment, type RecordDocument, type RecordHistoryEntry, type RecordRead, type RecordRevision, type RecordScopeComment, type RecordScopeContext, type RecordScopeField, type RecordScopeHistoryEntry, type RecordScopeRelation, type RecordScopeWithheld, type RecordsActor, type RecordsConfig, type RecordsDataSource, type RecordsError, type RecordsErrorCode, type RecordsErrorSink, type RecordsFilter, RecordsProvider, type RecordsProviderProps, type RecordsRealtimePort, type RecordsResolverPort, type RecordsResponse, type RecordsResult, type RecordsTableQuery, type RegisteredTable, type Relation, type RelationBinding, type RelationCardinality, type RelationCarries, type RelationCoordinate, type RelationFlavor, type RelationProperties, type RelationTarget, type ResolutionTriple, type ResolvedPublishBinding, type RestorePreview, type RestoreResult, type RetiredActorWord, type Rule, type RuleAnswer, type RuleExpression, type RuleNodeKind, type RuleUse, STORAGE_MODES, STORE_DOORS, STORE_KNOBS, STORE_REFUSAL_CODES, type StaleWriteDetail, type StorageMode, type StoreDoorName, type StoreRefusalCode, type StoredRecord, type StuckRow, type Subscription, type SubscriptionBlock, type SubscriptionCadence, TABLE_DISPLAYS, TABLE_ORIGINS, TABLE_TYPES, type Table, type TableCapacity, type TableDisplay, type TableOrigin, type TableProposal, type TableType, type Timestamp, type UseEntityFieldMutation, type UseFieldMutation, type UseRecordMutation, type UseRecordsOptions, type UseRecordsState, type Uuid, VALUE_ALTERNATE_KEYS, VALUE_ENVELOPE_KEYS, type ValueAlternate, type ValueAlternateKey, type ValueEnvelope, type ValueEnvelopeKey, type ValueSource, type WorkApprovalDecision, type WorkApprovalFiled, type WorkApprover, type WorkAssignment, type WorkAssignmentField, type WorkChange, type WorkDueState, type WorkGraph, type WorkInboxItem, type WorkInboxKind, type WorkInstantiation, type WorkListFlavour, type WorkListItem, type WorkOrigin, type WorkRecordState, type WorkSlotHold, type WorkState, type WorkTemplateNode, type WorkTemplateRelation, type WorkTurn, type WriteConflict, asPermissionLevel, atLeast, choiceSlug, choiceValuesOf, choicesOf, err, highestLevel, holdsARetiredChoice, isRecordsErr, isTheChosen, looksLikeAnId, measureKey, ok, optionKey, optionLabel, portalPath, publicFormPath, scopeChip, useEntityFieldMutation, useEntityFieldRights, useEntityFields, useEntityRecord, useEntityTable, useFieldMutation, useFields, useMergeField, useMyLevel, useMyLevels, useOptionalRecordsClient, useRecord, useRecordMutation, useRecords, useRecordsActor, useRecordsClient, useTable, useTables };

package/dist/react/index.js

@@ -1994,6 +1994,16 @@ var DOORS = {
   workApprovalMayDecide: "work_approval_may_decide",
   workApprovalDecide: "work_approval_decide",
   workApprovalRead: "work_approval_read",
+  // PRODUCTS row 13 — checklists and SOP runs.
+  checklistRefusal: "checklist_refusal",
+  checklistDeclare: "checklist_declare",
+  checklistTemplates: "checklist_templates",
+  checklistTemplateShape: "checklist_template_shape",
+  checklistStart: "checklist_start",
+  checklistRun: "checklist_run",
+  checklistRuns: "checklist_runs",
+  checklistStepComplete: "checklist_step_complete",
+  checklistStepRefusal: "checklist_step_refusal",
   // Declared here BECAUSE they do not exist yet: naming them is what makes the
   // absence visible to `pnpm check:store-registry` and to the suite.
   metadataSearch: "metadata_search",
@@ -3324,6 +3334,86 @@ function createRecordsClient(config) {
         "workSlotExpire"
       );
     },
+    // ── checklists and SOP runs ──────────────────────────────────────────
+    async checklistRefusal({ spec }) {
+      return callDoor(
+        DOORS.checklistRefusal,
+        { p_spec: spec },
+        "checklistRefusal"
+      );
+    },
+    async checklistDeclare({ spec, template_id = null }) {
+      return callDoor(
+        DOORS.checklistDeclare,
+        { p_organization_id: org, p_spec: spec, p_template_id: template_id },
+        "checklistDeclare"
+      );
+    },
+    async checklistTemplates(args) {
+      return callDoor(
+        DOORS.checklistTemplates,
+        {
+          p_organization_id: org,
+          p_about_table_id: args?.about_table_id ?? null,
+          p_limit: args?.limit ?? 100
+        },
+        "checklistTemplates"
+      );
+    },
+    async checklistTemplateShape({ template_id }) {
+      return callDoor(
+        DOORS.checklistTemplateShape,
+        { p_organization_id: org, p_template_id: template_id },
+        "checklistTemplateShape"
+      );
+    },
+    async checklistStart({ template_id, about_record_id = null, roles = {}, startingAt = null }) {
+      return callDoor(
+        DOORS.checklistStart,
+        {
+          p_organization_id: org,
+          p_template_id: template_id,
+          p_about_record_id: about_record_id,
+          p_roles: roles,
+          p_starting_at: startingAt
+        },
+        "checklistStart"
+      );
+    },
+    async checklistRun({ run_id }) {
+      return callDoor(
+        DOORS.checklistRun,
+        { p_organization_id: org, p_run_id: run_id },
+        "checklistRun"
+      );
+    },
+    async checklistRuns(args) {
+      return callDoor(
+        DOORS.checklistRuns,
+        {
+          p_organization_id: org,
+          p_about_table_id: args?.about_table_id ?? null,
+          p_about_record_id: args?.about_record_id ?? null,
+          p_include_closed: args?.includeClosed ?? true,
+          p_limit: args?.limit ?? 100
+        },
+        "checklistRuns"
+      );
+    },
+    async checklistStepComplete({ step_id, evidence = {} }) {
+      return callDoor(
+        DOORS.checklistStepComplete,
+        { p_organization_id: org, p_step_id: step_id, p_evidence: evidence },
+        "checklistStepComplete"
+      );
+    },
+    async checklistStepRefusal({ step_id }) {
+      return callDoor(
+        DOORS.checklistStepRefusal,
+        { p_organization_id: org, p_step_id: step_id },
+        "checklistStepRefusal"
+      );
+    },
     // ── the work layer a person actually uses ────────────────────────────
     async workInbox(args) {
       return callDoor(