@ai-matrx/records 0.17.0 → 0.21.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +149 -0
- package/dist/core/index.cjs +494 -10
- package/dist/core/index.cjs.map +1 -1
- package/dist/core/index.d.cts +295 -3
- package/dist/core/index.d.ts +295 -3
- package/dist/core/index.js +494 -10
- package/dist/core/index.js.map +1 -1
- package/dist/index.cjs +99 -11
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1040 -11
- package/dist/index.d.ts +1040 -11
- package/dist/index.js +99 -11
- package/dist/index.js.map +1 -1
- package/dist/react/index.cjs +494 -10
- package/dist/react/index.cjs.map +1 -1
- package/dist/react/index.d.cts +1299 -11
- package/dist/react/index.d.ts +1299 -11
- package/dist/react/index.js +494 -10
- package/dist/react/index.js.map +1 -1
- package/package.json +1 -1
package/dist/core/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { Timestamp, Uuid, RelationCoordinate, RecordsConfig, RecordDocument, RecordsResult, RecordRead, ReadRow, Table, Field, StoredRecord, TableCapacity, NewFieldDeclaration, FieldPatch, EntityTableFacts, NewEntityFieldDeclaration, EntityFieldRights, EntityRecordRead, EntityRecordsFound, FormSummary, PortalSummary, PortalCard, PortalInvitation, PortalRevocation, PortalPreviewRow, DashboardSummary, DashboardBlock, AggregateFilter, DashboardRunResult, StuckRow, AggregateMeasure, AggregateBucket, AggregateRow, Subscription, MySubscription, DocToken, DocUnresolvedToken, DocTemplateRow, DocRenderRow, DocSignatureRow, RecordRevision, ReadValue, AnonTokenBinding, WorkState, WorkGraph, WorkInstantiation, WorkTurn, WorkAssignmentField, WorkSlotHold, WorkInboxItem, WorkListFlavour, WorkListItem, WorkAssignment, WorkRecordState, WorkApprover, WorkChange, WorkApprovalFiled, WorkApprovalDecision, ExternalPrincipalCard, PublishBinding, ResolvedPublishBinding, FieldProposal, TableProposal, MyLevel, RecordsError, WriteConflict, PgError, RecordsDataSource, StaleWriteDetail, PredictedRefusal } from '../index.js';
|
|
2
|
-
export { ABSENCE_REASONS, ACTOR_VOCABULARY, AbsenceReason, Actor, AggregateOperation, AggregateWindow, COMPUTE_ON, CONTEXT_POLICIES, ChoiceOption, ComputeOn, ContextPolicy, CustomFieldTableType, DELIVERIES, DashboardBlockKind, DashboardBlockResult, Delivery, DocSignatureCheck, ENTITY_TOKENS, EntityFieldValue, EntityRecordMatch, EntityToken, FIELD_SENSITIVITIES, FIELD_SOURCES, FRESHNESS, FieldBehavior, FieldRule, FieldSensitivity, FieldSource, FieldTypeWord, ForbiddenEnvelopeWord, Freshness, HiddenFieldNotice, Home, KERNEL_TABLES, KernelTableName, MERGE_FIELD_MODIFIERS, MERGE_FIELD_SEMANTIC_TYPES, MERGE_FIELD_SOURCES, MergeField, MergeFieldModifier, MergeFieldProvenance, MergeFieldResolution, MergeFieldSemanticType, MergeFieldSource, MergeFieldTransform, MissingBehavior, ON_DELETE, OVERRIDE_POLICIES, OnDelete, OverridePolicy, PARITY_FIELD_TYPES, PERMISSION_LEVELS, PER_VALUE_ACCESS_WORDS, ParityFieldType, ParityFieldTypeDescriptor, PerValueAccessWord, PermissionLevel, PortalPrincipal, PortalTableExposure, ProvenancePointer, RELATION_BINDINGS, RELATION_CARDINALITIES, RELATION_FLAVORS, RETIRED_ACTOR_WORDS, RULE_NODE_KINDS, RULE_USES, RecordsActor, RecordsErrorCode, RecordsErrorSink, RecordsFilter, RecordsRealtimePort, RecordsResolverPort, RecordsResponse, RecordsTableQuery, RegisteredTable, Relation, RelationBinding, RelationCardinality, RelationCarries, RelationFlavor, RelationProperties, RelationTarget, ResolutionTriple, RetiredActorWord, Rule, RuleAnswer, RuleExpression, RuleNodeKind, RuleUse, STORAGE_MODES, STORE_DOORS, STORE_KNOBS, STORE_REFUSAL_CODES, StorageMode, StoreDoorName, StoreRefusalCode, SubscriptionBlock, SubscriptionCadence, TABLE_DISPLAYS, TABLE_ORIGINS, TABLE_TYPES, TableDisplay, TableOrigin, TableType, VALUE_ALTERNATE_KEYS, VALUE_ENVELOPE_KEYS, ValueAlternate, ValueAlternateKey, ValueEnvelope, ValueEnvelopeKey, ValueSource, WorkDueState, WorkInboxKind, WorkOrigin, WorkTemplateNode, WorkTemplateRelation, asPermissionLevel, atLeast, choiceSlug, choiceValuesOf, choicesOf, err, highestLevel, holdsARetiredChoice, isRecordsErr, isTheChosen, looksLikeAnId, measureKey, ok, optionKey, optionLabel, portalPath, publicFormPath } from '../index.js';
|
|
1
|
+
import { Timestamp, Uuid, RelationCoordinate, RecordsConfig, RecordDocument, RecordsResult, RecordRead, ReadRow, Table, Field, StoredRecord, TableCapacity, NewFieldDeclaration, FieldPatch, EntityTableFacts, NewEntityFieldDeclaration, EntityFieldRights, EntityRecordRead, EntityRecordsFound, FormSummary, ImportPlan, ImportPolicy, ImportOpened, ImportBatchResult, ImportFinished, ImportReport, ImportRun, InboundDeclared, InboundAddress, PortalSummary, PortalCard, PortalInvitation, PortalRevocation, PortalPreviewRow, DashboardSummary, DashboardBlock, AggregateFilter, DashboardRunResult, StuckRow, AggregateMeasure, AggregateBucket, AggregateRow, Subscription, MySubscription, DocToken, DocUnresolvedToken, DocTemplateRow, DocRenderRow, DocSignatureRow, RecordRevision, RecordHistoryEntry, RecordScopeContext, ConversationScope, ConversationScopeContext, FieldHistoryEntry, RestorePreview, RestoreResult, CommentThreadRead, CommentWritten, ReadValue, AnonTokenBinding, ChecklistSpec, ChecklistDeclared, ChecklistTemplateSummary, ChecklistTemplateShape, ChecklistRunStarted, ChecklistRunStep, ChecklistRunSummary, ChecklistStepCompleted, WorkState, WorkGraph, WorkInstantiation, WorkTurn, WorkAssignmentField, WorkSlotHold, WorkInboxItem, WorkListFlavour, WorkListItem, WorkAssignment, WorkRecordState, WorkApprover, WorkChange, WorkApprovalFiled, WorkApprovalDecision, ExternalPrincipalCard, PublishBinding, ResolvedPublishBinding, FieldProposal, TableProposal, MyLevel, RecordsError, WriteConflict, PgError, RecordsDataSource, StaleWriteDetail, PredictedRefusal } from '../index.js';
|
|
2
|
+
export { ABSENCE_REASONS, ACTOR_VOCABULARY, AbsenceReason, Actor, AggregateOperation, AggregateWindow, COMPUTE_ON, CONTEXT_POLICIES, ChecklistRequirement, ChecklistRequirementKind, ChecklistRoleSpec, ChecklistStepSpec, ChecklistTrigger, ChecklistTriggerKind, ChoiceOption, ComputeOn, ContextPolicy, CustomFieldTableType, DELIVERIES, DashboardBlockKind, DashboardBlockResult, Delivery, DocSignatureCheck, ENTITY_TOKENS, EntityFieldValue, EntityRecordMatch, EntityToken, FIELD_SENSITIVITIES, FIELD_SOURCES, FRESHNESS, FieldBehavior, FieldRule, FieldSensitivity, FieldSource, FieldTypeWord, ForbiddenEnvelopeWord, Freshness, HiddenFieldNotice, HistoryActor, HistoryActorKind, HistoryChange, Home, ImportColumnPlan, ImportOutcome, ImportProposal, KERNEL_TABLES, KernelTableName, MERGE_FIELD_MODIFIERS, MERGE_FIELD_SEMANTIC_TYPES, MERGE_FIELD_SOURCES, MergeField, MergeFieldModifier, MergeFieldProvenance, MergeFieldResolution, MergeFieldSemanticType, MergeFieldSource, MergeFieldTransform, MissingBehavior, ON_DELETE, OVERRIDE_POLICIES, OnDelete, OverridePolicy, PARITY_FIELD_TYPES, PERMISSION_LEVELS, PER_VALUE_ACCESS_WORDS, ParityFieldType, ParityFieldTypeDescriptor, PerValueAccessWord, PermissionLevel, PortalPrincipal, PortalTableExposure, ProvenancePointer, RELATION_BINDINGS, RELATION_CARDINALITIES, RELATION_FLAVORS, RETIRED_ACTOR_WORDS, RULE_NODE_KINDS, RULE_USES, RecordComment, RecordScopeComment, RecordScopeField, RecordScopeHistoryEntry, RecordScopeRelation, RecordScopeWithheld, RecordsActor, RecordsErrorCode, RecordsErrorSink, RecordsFilter, RecordsRealtimePort, RecordsResolverPort, RecordsResponse, RecordsTableQuery, RegisteredTable, Relation, RelationBinding, RelationCardinality, RelationCarries, RelationFlavor, RelationProperties, RelationTarget, ResolutionTriple, RetiredActorWord, Rule, RuleAnswer, RuleExpression, RuleNodeKind, RuleUse, STORAGE_MODES, STORE_DOORS, STORE_KNOBS, STORE_REFUSAL_CODES, StorageMode, StoreDoorName, StoreRefusalCode, SubscriptionBlock, SubscriptionCadence, TABLE_DISPLAYS, TABLE_ORIGINS, TABLE_TYPES, TableDisplay, TableOrigin, TableType, VALUE_ALTERNATE_KEYS, VALUE_ENVELOPE_KEYS, ValueAlternate, ValueAlternateKey, ValueEnvelope, ValueEnvelopeKey, ValueSource, WorkDueState, WorkInboxKind, WorkOrigin, WorkTemplateNode, WorkTemplateRelation, asPermissionLevel, atLeast, choiceSlug, choiceValuesOf, choicesOf, err, highestLevel, holdsARetiredChoice, isRecordsErr, isTheChosen, looksLikeAnId, measureKey, ok, optionKey, optionLabel, portalPath, publicFormPath, scopeChip } from '../index.js';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* DOOR-8. As-of on EITHER clock, and they are different questions:
|
|
@@ -272,6 +272,95 @@ interface RecordsClient {
|
|
|
272
272
|
form_id?: Uuid | null;
|
|
273
273
|
slug?: string | null;
|
|
274
274
|
}): Promise<RecordsResult<Uuid>>;
|
|
275
|
+
/**
|
|
276
|
+
* What the store makes of a file's columns, before anything is written.
|
|
277
|
+
* `columns` is `[{header, samples}]` — the first page of the file is plenty.
|
|
278
|
+
*/
|
|
279
|
+
importPlan(args: {
|
|
280
|
+
table_id: Uuid;
|
|
281
|
+
columns: Array<{
|
|
282
|
+
header: string;
|
|
283
|
+
samples: unknown[];
|
|
284
|
+
}>;
|
|
285
|
+
}): Promise<RecordsResult<ImportPlan>>;
|
|
286
|
+
/**
|
|
287
|
+
* Open a run. `file_hash` is the run's IDENTITY: the same bytes into the same
|
|
288
|
+
* table a second time answer the FIRST run with `already: true` and write
|
|
289
|
+
* nothing, so a re-import doubles nothing. `force` re-opens deliberately.
|
|
290
|
+
*/
|
|
291
|
+
importBegin(args: {
|
|
292
|
+
table_id: Uuid;
|
|
293
|
+
format?: "csv" | "xlsx";
|
|
294
|
+
source_name?: string | null;
|
|
295
|
+
source_columns?: unknown[];
|
|
296
|
+
file_hash?: string | null;
|
|
297
|
+
policy?: ImportPolicy;
|
|
298
|
+
/** A Field key. A row whose value for it is already here is a duplicate. */
|
|
299
|
+
dedupe_key?: string | null;
|
|
300
|
+
file_bytes?: number | null;
|
|
301
|
+
force?: boolean;
|
|
302
|
+
}): Promise<RecordsResult<ImportOpened>>;
|
|
303
|
+
/**
|
|
304
|
+
* One BATCH of rows. Every row is written through the ONE write door inside
|
|
305
|
+
* its own subtransaction, so a refused row leaves nothing behind and never
|
|
306
|
+
* costs the rows before it. Send a few hundred at a time.
|
|
307
|
+
*/
|
|
308
|
+
importRows(args: {
|
|
309
|
+
import_id: Uuid;
|
|
310
|
+
rows: Array<Record<string, unknown>>;
|
|
311
|
+
/** Header -> Field key. A header that already spells a key needs no entry. */
|
|
312
|
+
mapping?: Record<string, string>;
|
|
313
|
+
}): Promise<RecordsResult<ImportBatchResult>>;
|
|
314
|
+
/**
|
|
315
|
+
* Close the run and decide the columns the file had and the table did not:
|
|
316
|
+
* `propose` (the ONE approvals inbox, and the only choice a non-admin has),
|
|
317
|
+
* `create` (an admin adds them outright) or `ignore`.
|
|
318
|
+
*/
|
|
319
|
+
importFinish(args: {
|
|
320
|
+
import_id: Uuid;
|
|
321
|
+
unmapped?: "propose" | "create" | "ignore";
|
|
322
|
+
}): Promise<RecordsResult<ImportFinished>>;
|
|
323
|
+
/** The refused rows, or the ones already here, WITH the source row on each. */
|
|
324
|
+
importReport(args: {
|
|
325
|
+
import_id: Uuid;
|
|
326
|
+
state?: "refused" | "duplicate";
|
|
327
|
+
limit?: number;
|
|
328
|
+
offset?: number;
|
|
329
|
+
}): Promise<RecordsResult<ImportReport>>;
|
|
330
|
+
/** This organization's import runs, newest first. How you find yesterday's. */
|
|
331
|
+
imports(args?: {
|
|
332
|
+
table_id?: Uuid | null;
|
|
333
|
+
limit?: number;
|
|
334
|
+
}): Promise<RecordsResult<ImportRun[]>>;
|
|
335
|
+
/**
|
|
336
|
+
* Forget the RECEIPT for a file so the same bytes can be imported again
|
|
337
|
+
* deliberately. Never touches the records that import wrote.
|
|
338
|
+
*/
|
|
339
|
+
importForget(args: {
|
|
340
|
+
import_id: Uuid;
|
|
341
|
+
}): Promise<RecordsResult<boolean>>;
|
|
342
|
+
/**
|
|
343
|
+
* Give a table its own address. The answer carries `mail_route`: the one
|
|
344
|
+
* sentence saying what has to exist in DNS before anything arrives. Show it
|
|
345
|
+
* wherever the address is shown — an address that silently swallows mail is
|
|
346
|
+
* the failure this whole door is against.
|
|
347
|
+
*/
|
|
348
|
+
inboundDeclare(args: {
|
|
349
|
+
table_id: Uuid;
|
|
350
|
+
label?: string | null;
|
|
351
|
+
}): Promise<RecordsResult<InboundDeclared>>;
|
|
352
|
+
inboundAddresses(args?: {
|
|
353
|
+
table_id?: Uuid | null;
|
|
354
|
+
}): Promise<RecordsResult<InboundAddress[]>>;
|
|
355
|
+
inboundSet(args: {
|
|
356
|
+
inbound_id: Uuid;
|
|
357
|
+
enabled: boolean;
|
|
358
|
+
}): Promise<RecordsResult<{
|
|
359
|
+
inbound_id: Uuid;
|
|
360
|
+
address: string;
|
|
361
|
+
enabled: boolean;
|
|
362
|
+
message: string;
|
|
363
|
+
}>>;
|
|
275
364
|
/** Every portal over this organization the caller may know about, with its numbers. */
|
|
276
365
|
portals(): Promise<RecordsResult<PortalSummary[]>>;
|
|
277
366
|
/** ONE portal in full: what it shows, and who it was opened to. */
|
|
@@ -496,6 +585,115 @@ interface RecordsClient {
|
|
|
496
585
|
revisions(args: {
|
|
497
586
|
record_id: Uuid;
|
|
498
587
|
}): Promise<RecordsResult<RecordRevision[]>>;
|
|
588
|
+
/**
|
|
589
|
+
* PRODUCTS row 4. One record's version list, newest first: who (a person, or
|
|
590
|
+
* an agent AND the person it acted for), when, the operation in the word
|
|
591
|
+
* somebody used, and every field that moved with its before, its after, the
|
|
592
|
+
* Rule version that produced a derived value and its source pointer. Viewer
|
|
593
|
+
* on the record — reading how something got to be the way it is is reading.
|
|
594
|
+
*/
|
|
595
|
+
recordHistory(args: {
|
|
596
|
+
record_id: Uuid;
|
|
597
|
+
limit?: number;
|
|
598
|
+
offset?: number;
|
|
599
|
+
}): Promise<RecordsResult<RecordHistoryEntry[]>>;
|
|
600
|
+
/**
|
|
601
|
+
* AGT-N-9 — EVERYTHING A CHAT OPENED ON THIS RECORD MAY KNOW, IN ONE ROUND TRIP.
|
|
602
|
+
*
|
|
603
|
+
* The Fields with their `(record, field, value version)` triples, the relations one hop
|
|
604
|
+
* out, the history, the comments and the Table's other records — assembled INSIDE the
|
|
605
|
+
* database, every piece through the read door, under this person's own field-level
|
|
606
|
+
* security. A Field the store masks comes back in `withheld` with the store's own
|
|
607
|
+
* sentence and no value; a Field the organization keeps out of conversations comes back
|
|
608
|
+
* there too, saying which of the two it is.
|
|
609
|
+
*/
|
|
610
|
+
recordScopeContext(args: {
|
|
611
|
+
record_id: Uuid;
|
|
612
|
+
relations?: number;
|
|
613
|
+
history?: number;
|
|
614
|
+
siblings?: number;
|
|
615
|
+
}): Promise<RecordsResult<RecordScopeContext>>;
|
|
616
|
+
/** What is this conversation about? */
|
|
617
|
+
conversationScope(args: {
|
|
618
|
+
conversation_id: Uuid;
|
|
619
|
+
}): Promise<RecordsResult<ConversationScope>>;
|
|
620
|
+
/** Point a conversation at one record. Refused unless this person may open it. */
|
|
621
|
+
conversationScopeBind(args: {
|
|
622
|
+
conversation_id: Uuid;
|
|
623
|
+
record_id: Uuid;
|
|
624
|
+
}): Promise<RecordsResult<ConversationScope>>;
|
|
625
|
+
/** This conversation is no longer about a particular record. */
|
|
626
|
+
conversationScopeUnbind(args: {
|
|
627
|
+
conversation_id: Uuid;
|
|
628
|
+
}): Promise<RecordsResult<ConversationScope>>;
|
|
629
|
+
/** The binding AND the context of a bound conversation, in one round trip. */
|
|
630
|
+
conversationScopeContext(args: {
|
|
631
|
+
conversation_id: Uuid;
|
|
632
|
+
relations?: number;
|
|
633
|
+
history?: number;
|
|
634
|
+
siblings?: number;
|
|
635
|
+
}): Promise<RecordsResult<ConversationScopeContext>>;
|
|
636
|
+
/**
|
|
637
|
+
* "Who changed the price on ANY record?" One column's history across a whole
|
|
638
|
+
* Table, narrowed to the records this person may see by a predicate in the
|
|
639
|
+
* same statement. A column that names no Field is refused BY NAME, never
|
|
640
|
+
* answered empty.
|
|
641
|
+
*/
|
|
642
|
+
fieldHistory(args: {
|
|
643
|
+
table_id: Uuid;
|
|
644
|
+
field_key: string;
|
|
645
|
+
limit?: number;
|
|
646
|
+
offset?: number;
|
|
647
|
+
record_id?: Uuid;
|
|
648
|
+
}): Promise<RecordsResult<FieldHistoryEntry[]>>;
|
|
649
|
+
/**
|
|
650
|
+
* WHAT A RESTORE WOULD CHANGE, BEFORE IT DOES. Editor on the record: this is
|
|
651
|
+
* the first half of an act, and somebody who may not perform it is not shown
|
|
652
|
+
* its preview. Pass `field_key` for one column.
|
|
653
|
+
*/
|
|
654
|
+
restorePreview(args: {
|
|
655
|
+
record_id: Uuid;
|
|
656
|
+
version: number;
|
|
657
|
+
field_key?: string;
|
|
658
|
+
}): Promise<RecordsResult<RestorePreview>>;
|
|
659
|
+
/** Put the whole record back to a version, as a NEW version. Editor. */
|
|
660
|
+
restoreVersion(args: {
|
|
661
|
+
record_id: Uuid;
|
|
662
|
+
version: number;
|
|
663
|
+
}): Promise<RecordsResult<RestoreResult>>;
|
|
664
|
+
/** Put ONE column back to what it said at a version, as a NEW version (HIS-N-2). Editor. */
|
|
665
|
+
valueRestore(args: {
|
|
666
|
+
record_id: Uuid;
|
|
667
|
+
field_key: string;
|
|
668
|
+
version: number;
|
|
669
|
+
}): Promise<RecordsResult<RestoreResult>>;
|
|
670
|
+
/**
|
|
671
|
+
* SCR-18. The record's comment thread with everybody named, plus what THIS
|
|
672
|
+
* person may do in it — decided by the store, in the same call, so a screen
|
|
673
|
+
* never draws a composer the write door will refuse.
|
|
674
|
+
*/
|
|
675
|
+
commentThread(args: {
|
|
676
|
+
record_id: Uuid;
|
|
677
|
+
include_resolved?: boolean;
|
|
678
|
+
}): Promise<RecordsResult<CommentThreadRead>>;
|
|
679
|
+
/**
|
|
680
|
+
* Write a comment at the `commenter` rung, optionally naming people. A
|
|
681
|
+
* mention is a reference and not a regex over the body: the ids come from the
|
|
682
|
+
* picker and the store refuses one who is not in the organization, or who
|
|
683
|
+
* cannot open the record — because that notification would be a dead end.
|
|
684
|
+
*/
|
|
685
|
+
commentWrite(args: {
|
|
686
|
+
record_id: Uuid;
|
|
687
|
+
body: string;
|
|
688
|
+
field_key?: string;
|
|
689
|
+
parent_comment_id?: Uuid;
|
|
690
|
+
mentions?: Uuid[];
|
|
691
|
+
}): Promise<RecordsResult<CommentWritten>>;
|
|
692
|
+
/** Resolve (or re-open) a thread. `commenter` — resolution is not a delete. */
|
|
693
|
+
commentResolve(args: {
|
|
694
|
+
comment_id: Uuid;
|
|
695
|
+
resolved?: boolean;
|
|
696
|
+
}): Promise<RecordsResult<boolean>>;
|
|
499
697
|
/**
|
|
500
698
|
* Every value of one record WITH its envelope — its own version, who wrote
|
|
501
699
|
* it, who they were acting for and when. The timeline IS the record (REC-19);
|
|
@@ -565,6 +763,67 @@ interface RecordsClient {
|
|
|
565
763
|
form_id: Uuid;
|
|
566
764
|
published?: boolean;
|
|
567
765
|
}): Promise<RecordsResult<Timestamp | null>>;
|
|
766
|
+
/**
|
|
767
|
+
* What is wrong with a checklist somebody is writing, in the words they would
|
|
768
|
+
* use. `null` means it is fine. Pure — it reads no row and writes nothing —
|
|
769
|
+
* so an editor may ask it on every keystroke and the refusal arrives BEFORE
|
|
770
|
+
* the save rather than after it.
|
|
771
|
+
*/
|
|
772
|
+
checklistRefusal(args: {
|
|
773
|
+
spec: ChecklistSpec;
|
|
774
|
+
}): Promise<RecordsResult<string | null>>;
|
|
775
|
+
/**
|
|
776
|
+
* Store a checklist, whole: ordered steps, who each belongs to by role, how
|
|
777
|
+
* many days in each is due, what each waits for, what each asks for, and what
|
|
778
|
+
* starts a run. Pass `template_id` to change the checklist that already
|
|
779
|
+
* exists rather than making a second one.
|
|
780
|
+
*/
|
|
781
|
+
checklistDeclare(args: {
|
|
782
|
+
spec: ChecklistSpec;
|
|
783
|
+
template_id?: Uuid | null;
|
|
784
|
+
}): Promise<RecordsResult<ChecklistDeclared>>;
|
|
785
|
+
checklistTemplates(args?: {
|
|
786
|
+
about_table_id?: Uuid | null;
|
|
787
|
+
limit?: number;
|
|
788
|
+
}): Promise<RecordsResult<ChecklistTemplateSummary[]>>;
|
|
789
|
+
checklistTemplateShape(args: {
|
|
790
|
+
template_id: Uuid;
|
|
791
|
+
}): Promise<RecordsResult<ChecklistTemplateShape>>;
|
|
792
|
+
/**
|
|
793
|
+
* Run a checklist for one record: one work item per step in the ONE work
|
|
794
|
+
* layer, assigned by role to real people, dated from the offsets,
|
|
795
|
+
* dependencies carried across. `roles` names who stands in each role for THIS
|
|
796
|
+
* run, over whatever the checklist says by default.
|
|
797
|
+
*/
|
|
798
|
+
checklistStart(args: {
|
|
799
|
+
template_id: Uuid;
|
|
800
|
+
about_record_id?: Uuid | null;
|
|
801
|
+
roles?: Record<string, Uuid>;
|
|
802
|
+
startingAt?: Timestamp | null;
|
|
803
|
+
}): Promise<RecordsResult<ChecklistRunStarted>>;
|
|
804
|
+
checklistRun(args: {
|
|
805
|
+
run_id: Uuid;
|
|
806
|
+
}): Promise<RecordsResult<ChecklistRunStep[]>>;
|
|
807
|
+
checklistRuns(args?: {
|
|
808
|
+
about_table_id?: Uuid | null;
|
|
809
|
+
about_record_id?: Uuid | null;
|
|
810
|
+
includeClosed?: boolean;
|
|
811
|
+
limit?: number;
|
|
812
|
+
}): Promise<RecordsResult<ChecklistRunSummary[]>>;
|
|
813
|
+
/**
|
|
814
|
+
* Tick a step off with whatever it asked for. Refused by name while a step it
|
|
815
|
+
* waits for is open, or while what it asks for is missing — and the same
|
|
816
|
+
* refusal meets `workSetState`, because the rule lives in the store and not
|
|
817
|
+
* in this door.
|
|
818
|
+
*/
|
|
819
|
+
checklistStepComplete(args: {
|
|
820
|
+
step_id: Uuid;
|
|
821
|
+
evidence?: Record<string, unknown>;
|
|
822
|
+
}): Promise<RecordsResult<ChecklistStepCompleted>>;
|
|
823
|
+
/** Why this step cannot be finished right now. `null` means it can. */
|
|
824
|
+
checklistStepRefusal(args: {
|
|
825
|
+
step_id: Uuid;
|
|
826
|
+
}): Promise<RecordsResult<string | null>>;
|
|
568
827
|
/** The five states and what each one may become. Asked, never hardcoded in a picker. */
|
|
569
828
|
workStates(): Promise<RecordsResult<WorkState[]>>;
|
|
570
829
|
/** Why this graph would be refused — asked BEFORE it is written. `null` means it is fine. */
|
|
@@ -859,6 +1118,17 @@ declare const DOORS: {
|
|
|
859
1118
|
readonly ruleEval: "rule_eval";
|
|
860
1119
|
readonly forms: "forms";
|
|
861
1120
|
readonly formDeclare: "form_declare";
|
|
1121
|
+
readonly importPlan: "io_import_plan";
|
|
1122
|
+
readonly importBegin: "io_import_begin";
|
|
1123
|
+
readonly importRows: "io_import_rows";
|
|
1124
|
+
readonly importFinish: "io_import_finish";
|
|
1125
|
+
readonly importReport: "io_import_report";
|
|
1126
|
+
readonly imports: "io_imports";
|
|
1127
|
+
readonly importForget: "io_import_forget";
|
|
1128
|
+
readonly inferColumn: "io_infer_column";
|
|
1129
|
+
readonly inboundDeclare: "inbound_declare";
|
|
1130
|
+
readonly inboundAddresses: "inbound_addresses";
|
|
1131
|
+
readonly inboundSet: "inbound_set";
|
|
862
1132
|
readonly portals: "portals";
|
|
863
1133
|
readonly portalCard: "portal_card";
|
|
864
1134
|
readonly portalDeclare: "portal_declare";
|
|
@@ -870,6 +1140,19 @@ declare const DOORS: {
|
|
|
870
1140
|
readonly dashboardRun: "dashboard_run";
|
|
871
1141
|
readonly dashboardStuck: "dashboard_stuck";
|
|
872
1142
|
readonly dashboardDelete: "dashboard_delete";
|
|
1143
|
+
readonly recordHistory: "record_history";
|
|
1144
|
+
readonly fieldHistory: "field_history";
|
|
1145
|
+
readonly restorePreview: "record_restore_preview";
|
|
1146
|
+
readonly restoreVersion: "record_restore_version";
|
|
1147
|
+
readonly valueRestore: "value_restore";
|
|
1148
|
+
readonly recordScopeContext: "record_scope_context";
|
|
1149
|
+
readonly conversationScope: "conversation_scope";
|
|
1150
|
+
readonly conversationScopeBind: "conversation_scope_bind";
|
|
1151
|
+
readonly conversationScopeUnbind: "conversation_scope_unbind";
|
|
1152
|
+
readonly conversationScopeContext: "conversation_scope_context";
|
|
1153
|
+
readonly commentThread: "comment_thread";
|
|
1154
|
+
readonly commentWrite: "comment_write";
|
|
1155
|
+
readonly commentResolve: "io_comment_resolve";
|
|
873
1156
|
readonly recordAggregate: "record_aggregate";
|
|
874
1157
|
readonly aggOperations: "agg_operations";
|
|
875
1158
|
readonly aggBuckets: "agg_buckets";
|
|
@@ -927,6 +1210,15 @@ declare const DOORS: {
|
|
|
927
1210
|
readonly workApprovalMayDecide: "work_approval_may_decide";
|
|
928
1211
|
readonly workApprovalDecide: "work_approval_decide";
|
|
929
1212
|
readonly workApprovalRead: "work_approval_read";
|
|
1213
|
+
readonly checklistRefusal: "checklist_refusal";
|
|
1214
|
+
readonly checklistDeclare: "checklist_declare";
|
|
1215
|
+
readonly checklistTemplates: "checklist_templates";
|
|
1216
|
+
readonly checklistTemplateShape: "checklist_template_shape";
|
|
1217
|
+
readonly checklistStart: "checklist_start";
|
|
1218
|
+
readonly checklistRun: "checklist_run";
|
|
1219
|
+
readonly checklistRuns: "checklist_runs";
|
|
1220
|
+
readonly checklistStepComplete: "checklist_step_complete";
|
|
1221
|
+
readonly checklistStepRefusal: "checklist_step_refusal";
|
|
930
1222
|
readonly metadataSearch: "metadata_search";
|
|
931
1223
|
readonly ruleDeclare: "rule_declare";
|
|
932
1224
|
readonly fieldPropose: "field_propose";
|
|
@@ -1047,4 +1339,4 @@ declare function parseCsv(text: string): string[][];
|
|
|
1047
1339
|
declare function importCsv(fields: Field[], text: string): ParsedImport;
|
|
1048
1340
|
declare function importXlsx(fields: Field[], bytes: ArrayBuffer | Uint8Array): Promise<ParsedImport>;
|
|
1049
1341
|
|
|
1050
|
-
export { AggregateBucket, AggregateFilter, AggregateMeasure, AggregateRow, AnonTokenBinding, type AsOf, DEFAULT_DOCUMENT_MAX_BYTES, DEFAULT_PAGE_SIZE, DEFAULT_VALUE_MAX_BYTES, DOORS, DashboardBlock, DashboardRunResult, DashboardSummary, DocRenderRow, DocSignatureRow, DocTemplateRow, DocToken, DocUnresolvedToken, type DoorKey, EntityFieldRights, EntityRecordRead, EntityRecordsFound, EntityTableFacts, type ExportRow, ExternalPrincipalCard, Field, FieldPatch, FieldProposal, FormSummary, MAPPED_SQLSTATES, type MirrorLimits, MyLevel, MySubscription, NewEntityFieldDeclaration, NewFieldDeclaration, type ParsedImport, PgError, PortalCard, PortalInvitation, PortalPreviewRow, PortalRevocation, PortalSummary, PredictedRefusal, type PromotedPredicate, PublishBinding, type QueryPlan, ReadRow, ReadValue, RecordDocument, type RecordQuery, RecordRead, RecordRevision, type RecordsClient, RecordsConfig, RecordsDataSource, RecordsError, RecordsResult, RelationCoordinate, ResolvedPublishBinding, StaleWriteDetail, StoredRecord, StuckRow, Subscription, type SupabaseLike, Table, TableCapacity, TableProposal, Timestamp, Uuid, WorkApprovalDecision, WorkApprovalFiled, WorkApprover, WorkAssignment, WorkAssignmentField, WorkChange, WorkGraph, WorkInboxItem, WorkInstantiation, WorkListFlavour, WorkListItem, WorkRecordState, WorkSlotHold, WorkState, WorkTurn, WriteConflict, asWriteConflict, cellText, createRecordsClient, doorAbsent, doorCensus, doorExists, exportCsv, exportXlsx, importCsv, importXlsx, intersectIds, mapPgError, parseCsv, planQuery, predictEnvelopeRefusal, predictSizeRefusal, predictValueRefusals, predictWriteRefusals, staleWriteDetail, supabaseDataSource, toAoa };
|
|
1342
|
+
export { AggregateBucket, AggregateFilter, AggregateMeasure, AggregateRow, AnonTokenBinding, type AsOf, ChecklistDeclared, ChecklistRunStarted, ChecklistRunStep, ChecklistRunSummary, ChecklistSpec, ChecklistStepCompleted, ChecklistTemplateShape, ChecklistTemplateSummary, CommentThreadRead, CommentWritten, ConversationScope, ConversationScopeContext, DEFAULT_DOCUMENT_MAX_BYTES, DEFAULT_PAGE_SIZE, DEFAULT_VALUE_MAX_BYTES, DOORS, DashboardBlock, DashboardRunResult, DashboardSummary, DocRenderRow, DocSignatureRow, DocTemplateRow, DocToken, DocUnresolvedToken, type DoorKey, EntityFieldRights, EntityRecordRead, EntityRecordsFound, EntityTableFacts, type ExportRow, ExternalPrincipalCard, Field, FieldHistoryEntry, FieldPatch, FieldProposal, FormSummary, ImportBatchResult, ImportFinished, ImportOpened, ImportPlan, ImportPolicy, ImportReport, ImportRun, InboundAddress, InboundDeclared, MAPPED_SQLSTATES, type MirrorLimits, MyLevel, MySubscription, NewEntityFieldDeclaration, NewFieldDeclaration, type ParsedImport, PgError, PortalCard, PortalInvitation, PortalPreviewRow, PortalRevocation, PortalSummary, PredictedRefusal, type PromotedPredicate, PublishBinding, type QueryPlan, ReadRow, ReadValue, RecordDocument, RecordHistoryEntry, type RecordQuery, RecordRead, RecordRevision, RecordScopeContext, type RecordsClient, RecordsConfig, RecordsDataSource, RecordsError, RecordsResult, RelationCoordinate, ResolvedPublishBinding, RestorePreview, RestoreResult, StaleWriteDetail, StoredRecord, StuckRow, Subscription, type SupabaseLike, Table, TableCapacity, TableProposal, Timestamp, Uuid, WorkApprovalDecision, WorkApprovalFiled, WorkApprover, WorkAssignment, WorkAssignmentField, WorkChange, WorkGraph, WorkInboxItem, WorkInstantiation, WorkListFlavour, WorkListItem, WorkRecordState, WorkSlotHold, WorkState, WorkTurn, WriteConflict, asWriteConflict, cellText, createRecordsClient, doorAbsent, doorCensus, doorExists, exportCsv, exportXlsx, importCsv, importXlsx, intersectIds, mapPgError, parseCsv, planQuery, predictEnvelopeRefusal, predictSizeRefusal, predictValueRefusals, predictWriteRefusals, staleWriteDetail, supabaseDataSource, toAoa };
|