@nivaro/sdk 0.1.23 → 0.1.25

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/README.md CHANGED
@@ -825,6 +825,80 @@ These hooks work alongside `useNivaroForm` and require a form returned by that h
825
825
 
826
826
  ---
827
827
 
828
+ ## SDK — React Live Data (@nivaro/react)
829
+
830
+ `useLiveRecord` and `useLiveList` are react-query reads that stay current. When the host mounts a realtime adapter, other people's writes are patched into the cached data in place; without one (or while the socket reconnects) the read polls instead. Nothing to wire by hand: no socket events, no invalidation.
831
+
832
+ ### Connect the socket once
833
+
834
+ `createSocketRealtime` turns the Socket.io connection your app already holds into the adapter every live surface reads (`RealtimeContext`). Your app keeps owning the socket: it connects, sends `auth {token}` and its `client:hello`. The adapter joins and leaves collection rooms, admin watch rooms and live operations topics (reference counted), joins them again after every reconnect, replays missed events, and raises the same window events the admin app does (`nvr:catchup-full`, `nvr:access-changed`, `nvr:config-update`, `nvr:force-refresh`).
835
+
836
+ ```typescript
837
+ import { io } from 'socket.io-client'
838
+ import { createSocketRealtime, RealtimeContext } from '@nivaro/react'
839
+
840
+ const socket = io(API_URL, { transports: ['websocket', 'polling'], withCredentials: true })
841
+ socket.on('connect', async () => socket.emit('auth', { token: await wsToken() }))
842
+
843
+ // Once, at module level — the adapter is shared by every component.
844
+ const realtime = createSocketRealtime({ socket })
845
+
846
+ <NivaroProvider client={client}>
847
+ <RealtimeContext.Provider value={realtime}>
848
+ <App />
849
+ </RealtimeContext.Provider>
850
+ </NivaroProvider>
851
+ ```
852
+
853
+ > **Note:** Shared components (My Work, Notes, tasks, record pages, collection lists, queues) read the same context, so mounting the adapter makes them live too. Set `windowEvents: { forceRefresh: false }` (or another key) when your app already raises that window event itself.
854
+
855
+ ### useLiveRecord
856
+
857
+ ```typescript
858
+ const { data: order, deleted, live, isLoading } = useLiveRecord('orders', id, {
859
+ fields: ['title', 'status', 'customer.name']
860
+ })
861
+ if (deleted) return <p>This order was deleted.</p>
862
+ ```
863
+
864
+ With an explicit `fields` list a change re-reads only the requested fields it touched (`customer` changed → `customer.name` is read again) and merges them into the cached record; a change to a field you did not ask for costs no request. Without `fields` the whole record is re-read, because a virtual computed field may depend on any column. `data` is null when the record does not exist or the viewer cannot read it.
865
+
866
+ ### useLiveList
867
+
868
+ ```typescript
869
+ const { data: page, live } = useLiveList('orders', {
870
+ filter: { status: { _eq: 'open' } },
871
+ sort: ['-created_at'],
872
+ fields: ['title', 'status'],
873
+ limit: 25
874
+ })
875
+ ```
876
+
877
+ | Someone else… | What the list does |
878
+ | --- | --- |
879
+ | changes a row on the page | Re-reads that row as the viewer under the list's own filter and search, and patches it in place. |
880
+ | changes a row so it no longer matches | The re-read returns nothing, so the row leaves (a paged list refetches to fill the gap). |
881
+ | creates or changes a record so it now matches | Refetches the page quietly; where it belongs in the sort order is the server's to decide. |
882
+ | changes a sort field of a row on the page | Refetches the page (the order may have moved). |
883
+ | deletes a row on the page | Drops it from the cached page. |
884
+ | runs a bulk or raw write | Refetches the page quietly. |
885
+ | changes a record the filter cannot see | Nothing: an update that touches no field the filter reads cannot bring a record in. |
886
+
887
+ | Option | Default | Meaning |
888
+ | --- | --- | --- |
889
+ | enabled | true | Pause the read and the live feed. |
890
+ | pollMs | 30000 | Poll interval while there is no live socket (0 = never). |
891
+ | safetyPollMs | none | A slow poll while the socket is live. |
892
+ | debounceMs | 250 | Events inside this window are handled as one patch. |
893
+ | includeOwn | false | Also react to this tab's own writes (a save never echoes back by default). |
894
+ | fields (useLiveRecord) | all | Fields to read; enables the partial re-read. |
895
+
896
+ > **Note:** The socket only says THAT a record changed (its id, the action and the changed field names). Values always come from a fresh read through the viewer's own permission-checked `/items` route, so row filters, User Scopes and field policies apply exactly as on the first load. A list read always carries `id` (it is added to an explicit `fields` list) so rows can be matched to events. Changes to a related record (a filter on `customer.region`) do not reach a list of orders; pass `safetyPollMs` when that matters.
897
+
898
+ Query keys are `liveRecordKey(collection, id, fields)` and `liveListKey(collection, query)` — invalidate them yourself after a write if you set `includeOwn: false` and want the list re-sorted at once.
899
+
900
+ ---
901
+
828
902
  ## SDK — Notifications & Inbox
829
903
 
830
904
  Manage your notification inbox. Notifications are created by rules, workflows, comments (@mentions), and alerts — use these endpoints to read, mark as read, and delete them.
package/dist/index.d.ts CHANGED
@@ -2111,8 +2111,8 @@ declare function listTasks(query?: {
2111
2111
  item?: string;
2112
2112
  assignee?: string;
2113
2113
  created_by?: string;
2114
- /** 'active' = open + in progress. */
2115
- status?: TaskStatus | 'active';
2114
+ /** 'active' = open + in progress; 'all' = every status. */
2115
+ status?: TaskStatus | 'active' | 'all';
2116
2116
  priority?: TaskPriority;
2117
2117
  due?: 'overdue' | 'today' | 'week' | 'none';
2118
2118
  search?: string;
@@ -4469,6 +4469,13 @@ declare function listFiles(options?: {
4469
4469
  }): Command<{
4470
4470
  data: FileRecord[];
4471
4471
  }>;
4472
+ /** Metadata for a known set of file ids (the shape the file fields batch-resolve with). */
4473
+ declare function readFilesByIds(ids: string[]): Command<{
4474
+ data: Array<FileRecord & {
4475
+ uploaded_by_name?: string | null;
4476
+ }>;
4477
+ total: number;
4478
+ }>;
4472
4479
  declare function readFileMeta(id: string): Command<{
4473
4480
  data: FileRecord;
4474
4481
  }>;
@@ -5446,6 +5453,267 @@ declare function listRetentionRuns(policyId: number): Command<{
5446
5453
  data: RetentionRun[];
5447
5454
  }>;
5448
5455
 
5456
+ /**
5457
+ * Operations reads (admin): readiness, detailed health, this process's runtime
5458
+ * stats, the instance roster, the DB connection pool, expensive SQL, the
5459
+ * Traffic Map snapshot, the background-job registry + run history, and a
5460
+ * summarized CPU profile of the replica that answers.
5461
+ */
5462
+
5463
+ interface ReadyReport {
5464
+ ready: boolean;
5465
+ checks: Array<{
5466
+ id: string;
5467
+ ok: boolean;
5468
+ summary: string;
5469
+ }>;
5470
+ }
5471
+ /** May traffic be routed here? Public; answers 503 (with the same body) when not ready. */
5472
+ declare function readReadiness(): Command<ReadyReport>;
5473
+ interface HealthDetailed {
5474
+ db: {
5475
+ ok: boolean;
5476
+ latency_ms: number;
5477
+ };
5478
+ redis: {
5479
+ ok: boolean;
5480
+ latency_ms: number;
5481
+ };
5482
+ migrations: {
5483
+ latest: string | null;
5484
+ count: number;
5485
+ };
5486
+ sockets: {
5487
+ connections: number | null;
5488
+ };
5489
+ read_gate?: Record<string, unknown>;
5490
+ redis_degradation?: {
5491
+ redis_ok: boolean;
5492
+ consumers: Array<Record<string, unknown>>;
5493
+ };
5494
+ db_posture?: unknown;
5495
+ uptime_s: number;
5496
+ version: string;
5497
+ node_version: string;
5498
+ memory_mb: number;
5499
+ }
5500
+ /** Subsystem diagnostics for the replica that answers (admin). */
5501
+ declare function readHealthDetailed(): Command<{
5502
+ data: HealthDetailed;
5503
+ }>;
5504
+ interface PoolStats {
5505
+ used: number;
5506
+ free: number;
5507
+ pending_acquires: number;
5508
+ pending_creates: number;
5509
+ max: number;
5510
+ }
5511
+ interface RuntimeStats {
5512
+ uptime_seconds: number;
5513
+ rss_mb: number;
5514
+ heap_used_mb: number;
5515
+ heap_total_mb: number;
5516
+ event_loop_lag_ms: {
5517
+ current: number;
5518
+ max_1m: number;
5519
+ };
5520
+ pool: PoolStats;
5521
+ }
5522
+ /** Memory, event-loop lag and pool of the replica that answers (admin). */
5523
+ declare function readRuntimeStats(): Command<{
5524
+ data: RuntimeStats;
5525
+ }>;
5526
+ /** Every registered API process, plus which one holds the scheduler lease (admin). */
5527
+ declare function readInstanceRoster(): Command<{
5528
+ data: Array<Record<string, unknown>>;
5529
+ scheduler: Record<string, unknown> | null;
5530
+ }>;
5531
+ interface CpuProfileSummary {
5532
+ /** The saved .cpuprofile, downloadable from /ops-runtime/cpu-profile/:name. */
5533
+ name: string;
5534
+ seconds: number;
5535
+ busy_ms: number;
5536
+ idle_ms: number;
5537
+ gc_ms: number;
5538
+ self: Array<{
5539
+ fn: string;
5540
+ where: string;
5541
+ ms: number;
5542
+ }>;
5543
+ files: Array<{
5544
+ where: string;
5545
+ ms: number;
5546
+ }>;
5547
+ ours: Array<{
5548
+ fn: string;
5549
+ where: string;
5550
+ ms: number;
5551
+ }>;
5552
+ }
5553
+ /** Sample the answering replica's CPU for `seconds` (1–30, default 10) and summarize it
5554
+ * (admin). One at a time (409); refused in cloud mode (403). */
5555
+ declare function captureCpuProfile(seconds?: number): Command<{
5556
+ data: CpuProfileSummary;
5557
+ }>;
5558
+ /** A DMV panel: rows, or why the database login cannot read them. */
5559
+ type DmvResult<T> = {
5560
+ data: T;
5561
+ } | {
5562
+ unavailable: string;
5563
+ };
5564
+ /** The connection pool right now, with the requests holding connections (admin). */
5565
+ declare function readDbPool(): Command<{
5566
+ data: PoolStats & {
5567
+ held: Array<{
5568
+ held_ms: number;
5569
+ hint: string | null;
5570
+ }>;
5571
+ pressure: Record<string, unknown>;
5572
+ };
5573
+ }>;
5574
+ interface ExpensiveStatement {
5575
+ total_cpu_ms: number;
5576
+ execution_count: number;
5577
+ avg_cpu_ms: number;
5578
+ avg_elapsed_ms: number;
5579
+ last_execution_time: ISODate;
5580
+ statement_text: string;
5581
+ }
5582
+ /** The 15 statements with the most total CPU since the plan cache last cleared (admin). */
5583
+ declare function readExpensiveSql(): Command<DmvResult<ExpensiveStatement[]>>;
5584
+ interface TrafficSnapshotEntity {
5585
+ key: string;
5586
+ lane: string;
5587
+ entity: string;
5588
+ label: string;
5589
+ system: boolean;
5590
+ req: number;
5591
+ read: number;
5592
+ create: number;
5593
+ update: number;
5594
+ delete: number;
5595
+ error: number;
5596
+ p50: number;
5597
+ p95: number;
5598
+ routes: Array<{
5599
+ route: string;
5600
+ n: number;
5601
+ }>;
5602
+ callers: Array<{
5603
+ key: string;
5604
+ n: number;
5605
+ }>;
5606
+ [key: string]: unknown;
5607
+ }
5608
+ interface TrafficSnapshot {
5609
+ instance: string;
5610
+ node_scope: string;
5611
+ at: ISODate;
5612
+ window_s: number;
5613
+ uptime_s: number;
5614
+ entities: TrafficSnapshotEntity[];
5615
+ callers: Array<{
5616
+ key: string;
5617
+ req: number;
5618
+ error: number;
5619
+ }>;
5620
+ down: Array<{
5621
+ id: string;
5622
+ label: string;
5623
+ kind: string;
5624
+ req: number;
5625
+ error: number;
5626
+ p95: number;
5627
+ }>;
5628
+ totals: {
5629
+ req: number;
5630
+ read: number;
5631
+ create: number;
5632
+ update: number;
5633
+ delete: number;
5634
+ error: number;
5635
+ p50: number;
5636
+ p95: number;
5637
+ outbound_req: number;
5638
+ outbound_error: number;
5639
+ };
5640
+ sockets: {
5641
+ count: number;
5642
+ users: number;
5643
+ };
5644
+ sources?: Array<{
5645
+ id: string;
5646
+ label: string;
5647
+ kind: string;
5648
+ req: number;
5649
+ error: number;
5650
+ }>;
5651
+ [key: string]: unknown;
5652
+ }
5653
+ /** The live Traffic Map over the last `window` seconds (60, 300 or 900; admin). */
5654
+ declare function readTrafficSnapshot(window?: 60 | 300 | 900): Command<{
5655
+ data: TrafficSnapshot;
5656
+ }>;
5657
+ interface JobRun {
5658
+ id: number;
5659
+ kind: string;
5660
+ job_id: string;
5661
+ label: string | null;
5662
+ extension_id: string | null;
5663
+ status: string;
5664
+ started_at: ISODate;
5665
+ finished_at: ISODate | null;
5666
+ duration_ms: number | null;
5667
+ outcome: string | null;
5668
+ error: string | null;
5669
+ progress: string | null;
5670
+ triggered_by: UUID | null;
5671
+ triggered_by_name?: string | null;
5672
+ }
5673
+ interface JobRegistryCron {
5674
+ id: string;
5675
+ expression: string;
5676
+ default_expression: string;
5677
+ overridden: boolean;
5678
+ extension_id: string | null;
5679
+ next_run: ISODate | null;
5680
+ paused: boolean;
5681
+ heavy: boolean;
5682
+ idempotent: boolean | 'unknown';
5683
+ description: string | null;
5684
+ timezone: string | null;
5685
+ last: {
5686
+ status: string;
5687
+ started_at: ISODate;
5688
+ duration_ms: number | null;
5689
+ outcome: string | null;
5690
+ error: string | null;
5691
+ } | null;
5692
+ errors_7d: number;
5693
+ [key: string]: unknown;
5694
+ }
5695
+ /** Every scheduled job with its latest run and 7-day error count, plus what is running now
5696
+ * (admin). */
5697
+ declare function readJobRegistry(): Command<{
5698
+ data: {
5699
+ crons: JobRegistryCron[];
5700
+ ticks_enabled: boolean;
5701
+ scheduler: Record<string, unknown> | null;
5702
+ running: JobRun[];
5703
+ };
5704
+ }>;
5705
+ /** Background-job run history, newest first (admin). `job_id` is a contains-match. */
5706
+ declare function listJobRuns(query?: {
5707
+ kind?: string;
5708
+ job_id?: string;
5709
+ status?: string;
5710
+ page?: number;
5711
+ limit?: number;
5712
+ }): Command<{
5713
+ data: JobRun[];
5714
+ total: number;
5715
+ }>;
5716
+
5449
5717
  /**
5450
5718
  * Queue commands: cross-collection worklists — queue CRUD, source config,
5451
5719
  * item resolution (scoped/filtered/sorted/paginated), claims, saved views,
@@ -6156,6 +6424,19 @@ interface Comment {
6156
6424
  id: number;
6157
6425
  user: string;
6158
6426
  }>;
6427
+ /** True once the text has been changed after posting. */
6428
+ edited?: boolean;
6429
+ version_count?: number;
6430
+ /** Tombstone: the comment was deleted (text is empty). */
6431
+ deleted?: boolean;
6432
+ deleted_by_name?: string | null;
6433
+ }
6434
+ interface CommentVersion {
6435
+ version: number;
6436
+ text: string;
6437
+ user: string | null;
6438
+ user_name: string | null;
6439
+ created_at: ISODate;
6159
6440
  }
6160
6441
  interface CustomQuery {
6161
6442
  id: number;
@@ -6753,6 +7034,10 @@ declare function updateComment(id: string, body: {
6753
7034
  data: Comment;
6754
7035
  }>;
6755
7036
  declare function deleteComment(id: string): Command<void>;
7037
+ /** Earlier versions of a comment, oldest first. Admins, record owners and the author only. */
7038
+ declare function getCommentHistory(id: string): Command<{
7039
+ data: CommentVersion[];
7040
+ }>;
6756
7041
  declare function listFlowRuns(flowId: string, params?: {
6757
7042
  limit?: number;
6758
7043
  offset?: number;
@@ -6766,6 +7051,23 @@ declare function getFlowRun(runId: string): Command<{
6766
7051
  declare function listCustomQueries(): Command<{
6767
7052
  data: CustomQuery[];
6768
7053
  }>;
7054
+ interface CustomQueryCatalogEntry {
7055
+ id: number;
7056
+ slug: string;
7057
+ name: string;
7058
+ description: string | null;
7059
+ params: Array<{
7060
+ name: string;
7061
+ type: string;
7062
+ required: boolean;
7063
+ default?: unknown;
7064
+ }>;
7065
+ }
7066
+ /** The queries any signed-in user may run (enabled, access 'authenticated'), with
7067
+ * their parameter definitions. Never carries the SQL. */
7068
+ declare function listCustomQueryCatalog(): Command<{
7069
+ data: CustomQueryCatalogEntry[];
7070
+ }>;
6769
7071
  declare function executeCustomQuery(slug: string, params?: Record<string, unknown>): Command<{
6770
7072
  data: unknown[];
6771
7073
  cached: boolean;
@@ -7638,4 +7940,4 @@ declare function submitFormItem(collection: string, values: Record<string, unkno
7638
7940
  data: Record<string, unknown>;
7639
7941
  }>;
7640
7942
 
7641
- export { type AccessAudit, type AccessAuditFinding, type AccessAuditRun, type AccessAuditSubject, type AccessReason, type ActivityEntry, type ActivityQuery, type ActivityReportQuery, type ActivityReportRow, type ActivityReportSummary, type Addendum, type AddendumStatus, type AggregateQuery, type AggregateRow, type AiChatTraceEntry, type AiCollectionSettings, type AiColumnMapping, type AiDuplicateMatch, type AiQueryFilter, type AiQueryResult, type AiReviewFinding, type AiViolation, type AlertDefinition, type AlertLogEntry, type AlertSubscription, type AnomalyDefinition, type AnomalyRule, type ApiAnalyticsBucket, type ApiAnalyticsCollection, type ApiAnalyticsPath, type ApiAnalyticsSummary, type ApiErrorLog, type ApiKey, type ApiKeyScope, type ApprovalBrief, type ApprovalChain, type ApprovalChainStep, type ApprovalDecision, type ApprovalInstance, type ApprovalInstanceDetail, type ApprovalStatus, type ApprovalStepInput, type AtRiskCondition, type AtRiskOp, type AtRiskResult, type AtRiskRule, type AtRiskSummaryEntry, type AttributeDefinition, type AttributeValue, type BatchRead, type BatchReadResult, type BlackoutDate, type BoolFilterOps, type CMSCollection, type CascadeFilterRule, type ChangeOrder, type ChatChannel, type ChatChannelMember, type ChatDirectoryChannel, type ChatMessage, type ChatPin, type ChatReaction, type ChatRoomKind, type ChatRoomSummary, type ChatRoomType, type ChatSearchHit, type CollectionLayout, type CollectionPresetSummary, type Command, type Comment, type ConfigSnapshot, type ConfigTableClassification, type ContentBundle, type ContentExportFormat, type ContentExportOptions, type CoverageGapItem, type CoverageGapOwner, type CoverageGapReport, type CronJob, type CustomQuery, type DataQualityRule, type DataQualityRuleResult, type DataQualityRuleType, type DataQualityRun, type DataQualitySeverity, type DeadLetter, type DraftPublishConfig, type DraftStatus, type DryRunReport, type ErpSubmission, type ErpSubmissionStatus, type ExtensionManifest, type ExternalApi, type ExternalApiEndpoint, type ExternalApiSchema, type ExternalApiSlotContext, type ExternalApiSpecImportResult, type ExternalApiTestResult, type FieldChangeEntry, type FieldCondition, type FieldConfig, type FieldDependencyConfig, type FieldFilter, type FieldGroup, type FieldTranslations, type FieldVisibilityRules, type FieldWatch, type FileRecord, type FileUploadResult, type FileUsageEntry, type Filter, type FlowReplayResult, type FlowRun, type FlowTestStep, type FormFieldDescriptor, type FormFieldRelation, type FormGroupDescriptor, type FormLockCondition, type FormSchema, type FormValidationRule, type FormVisibilityRule, type GlobalSearchRecord, type GlobalSearchResults, type GraphQLResponse, type HelpVideo, type HelpVideoClick, type HelpVideoContext, type HelpVideoDownloadUrls, type HelpVideoFinalizedUpload, type HelpVideoProgress, type HelpVideoUploadSession, type HelpVideoVersion, type HelpVideoVisibility, type HelpVideoWalkStep, type HelpVideoWhatsNew, type HierarchyConfigDef, type HierarchyFlatNode, type HierarchyLevelDef, type HierarchyNestedNode, type IDFilterOps, type ISODate, type ImportDefinition, type ImportJob, type ImportParseResponse, type ImportPreview, type ImportPreviewDiff, type ImportTemplateSummary, type InstanceOwner, type IntegrationApiHealth, type InternalWidget, type Issue, type IssueSeverity, type IssueStatus, type IssueSummary, type ItemLock, type LastTouch, type LayoutAssignment, type LayoutGroup, type LayoutVersion, type ListResponse, type ManagedUser, type MetricAlertRule, type MetricAlertSubscription, type MetricDefinition, type MyTask, type MyWorkOwnedEntry, type MyWorkSla, type MyWorkSummary, type NivaroClient, type NivaroClientOptions, type NivaroExtensionPlugin, type NivaroRealtime, type NivaroRuntime, type NotificationItem, type NotificationPage, type NotificationSubscription, type NumberFilterOps, type OmniSearchHit, type OnlinePresenceConfig, type OnlinePresenceUser, type Page, type PageLayout, type PageSlotKey, type PageWidget, type PdfTemplate, type PermissionSimulation, type PersistedQuery, type PickerExclusionStatus, type PipelineFlowEdge, type PipelineFlowState, type PipelineImpactResult, type PipelineOwnerGroup, type PipelineOwnerGroupUser, type PipelineSimulation, type PipelineState, type PipelineVersionEntry, type PluginSlots, type Policy, type PreflightCheck, type PreflightReport, type PreflightSeverity, type PresenceClient, type PresenceOptions, type PresenceSession, type PresenceSessionInfo, type PresenceViewer, type PromotionApplyResult, type PromotionPreview, type Query, type Queue, type QueueColumnPrefs, type QueueCondition, type QueueDetail, type QueueDisplayConfig, type QueueItem, type QueueItemsResult, type QueueOwner, type QueueRowClickMode, type QueueScope, type QueueSource, type QueueSourceType, type QueueStats, type QueueTrendPoint, type QueueView, type QueueViewKind, type QueueWorkloadRow, READ_MANY_MAX, type RealtimeEvent, type RecordGraphEdge, type RecordGraphNode, type RecordLink, type RecordLinkType, type RecordTemplate, type RecordViewRecap, type RegisteredAction, type RelatedCommentEntry, type RelationFilter, type RelationOption, type ReportAlert, type ReportAlertCondition, type ReportAlertLogEntry, type ReportAnnotation, type ReportColumnFormat, type ReportDateRange, type ReportDef, type ReportEntityFilter, type ReportFilterPreset, type ReportQueryColumn, type ReportQueryWidgetConfig, type ReportSnapshotEntry, type ReportSubscription, type ReportTemplateEntry, type ReportVersionEntry, type ReportWidget, type ReportWidgetConfig, type ReportWidgetData, type ReportWidgetPreset, type ReportWidgetType, type RequestTrace, type ResolvedOwner, type RetentionPolicy, type RetentionRun, type RetentionRunResult, type Revision, type Role, type Rule, type SavedView, type ScheduledChange, type ScheduledReport, type ScopeDimension, type ScopeDimensionInfo, type SemanticSearchMatch, type SessionRecording, type SessionReplayMasking, type ShareLink, type SlaBatchStatus, type SlaRule, type SlaStatus, type StagedImportRun, type StagedImportStats, type StringFilterOps, type SubRow, type SubRowTemplate, type SyncJob, type Task, type TaskDoneWhenRule, type TaskPriority, type TaskStatus, type TimelineEvent, type TraceSpan, type TreeFlatNode, type TreeNestedNode, type TreeNodeConfig, type TreePermission, type TreePermissionAction, type UUID, type UserActivityEntry, type UserActivitySummary, type UserScopesInfo, type ViewSubscription, type VirtualCollection, type Webhook, type WebhookDelivery, type WidgetFeed, type WorkflowBinding, type WorkflowHistoryEntry, type WorkflowInstance, type WorkflowInstanceData, type WorkflowState, type WorkflowTransition, type Workspace, type WorkspaceQuotas, type WorkspaceTemplate, type WorkspaceUsage, _and, _contains, _ends_with, _eq, _gt, _gte, _in, _lt, _lte, _ncontains, _neq, _nin, _nnull, _none, _null, _or, _some, _starts_with, abandonHelpVideoUpload, acquireItemLock, activateLayout, addChatChannelMember, addInstanceOwner, addSubRow, aggregateItems, aiBrief, aiBuildReport, aiChat, aiCheckDuplicates, aiGenerate, aiMapColumns, aiQuery, aiReportFilters, aiReview, aiSummarize, aiValidate, appendSessionRecordingEvents, applyContentBundle, applyHelpVideoPackageImport, applyRecordTemplate, applySubRowTemplate, approveAddendum, approveAiProposal, archiveHelpVideo, asc, backupExportPath, batchPickerExclusionStatus, bulkPickerExclusion, callExternalApi, callExternalApiEndpoint, cancelScheduledChange, cancelStagedImport, cascadeFieldDependencies, checkBlackoutDate, claimQueueItem, claimTask, clearTraces, cloneItem, cloneLayout, cloneReport, compareConfigSnapshot, completeTask, copyReportWidget, createAccessAudit, createAddendum, createAlertDefinition, createAlertSubscription, createAnomalyRule, createApiKey, createApprovalChain, createAtRiskRule, createAttributeDefinition, createBlackoutDate, createChatChannel, createChatRoomType, createCollectionLayout, createComment, createDataQualityRule, createExternalApi, createExternalApiEndpoint, createFieldGroup, createFieldWatch, createGroupDm, createHelpVideo, createHierarchyConfig, createImportDefinition, createImportJob, createImportJobFromUrl, createInternalWidget, createIssue, createItem, createMetricAlertRule, createNivaro, createNotification, createNotificationSubscription, createPage, createPdfTemplate, createPersistedQuery, createPresence, createQueue, createQueueView, createRealtime, createRecordLink, createRecordTemplate, createReport, createReportAlert, createReportAnnotation, createReportFromTemplate, createReportSnapshot, createReportWidgetPreset, createRetentionPolicy, createRole, createRolePolicy, createRule, createSavedView, createScheduledChange, createScheduledReport, createShareLink, createSlaRule, createSubRowTemplate, createSyncJob, createTask, createTreePermission, createUser, createViewSubscription, createVirtualCollection, createWebhook, createWidgetFeed, createWorkspace, createWorkspaceTemplate, decideApproval, deleteAccessAudit, deleteAddendum, deleteAlertDefinition, deleteAlertSubscription, deleteAnomalyRule, deleteApiKey, deleteApprovalChain, deleteAtRiskRule, deleteAttributeDefinition, deleteBlackoutDate, deleteChatMessage, deleteCollectionLayout, deleteComment, deleteDataQualityRule, deleteExternalApi, deleteExternalApiEndpoint, deleteExternalApiSchema, deleteFieldGroup, deleteFieldTranslations, deleteFieldWatch, deleteFile, deleteHierarchyConfig, deleteImportJob, deleteInternalWidget, deleteIssue, deleteItem, deleteMetricAlertRule, deleteNotification, deleteNotificationSubscription, deletePage, deletePdfTemplate, deletePersistedQuery, deleteQueue, deleteQueueView, deleteRecordLink, deleteRecordTemplate, deleteReport, deleteReportAlert, deleteReportAnnotation, deleteReportFilterPreset, deleteReportSnapshot, deleteReportTemplate, deleteReportWidgetPreset, deleteRetentionPolicy, deleteRole, deleteRolePolicy, deleteRule, deleteSavedView, deleteScheduledReport, deleteSessionRecording, deleteSlaRule, deleteSubRow, deleteSubRowTemplate, deleteSyncJob, deleteTask, deleteTreePermission, deleteUser, deleteViewSubscription, deleteVirtualCollection, deleteWebhook, deleteWidgetFeed, deleteWorkspace, deleteWorkspaceTemplate, deployImportProcedure, desc, disableTwoFactor, discardHelpVideoPackageImport, drillReportRow, editChatMessage, endSessionRecording, evaluateAlerts, evaluateAtRisk, evaluateFieldDefaults, evaluateFieldLock, evaluateFieldRules, evaluateFieldVisibility, excludeFromPicker, executeBulkAction, executeCustomQuery, executeImportTemplate, executeItemAction, executeScheduledChange, explainRecordAccess, explainReportTrend, exportBlueprint, exportConfigSnapshot, exportContent, exportContentBundle, exportHelpVideoPackage, exportSchemaSnapshot, fetchFormSchema, fileDownloadPath, fileTransformPath, finalizeHelpVideoUpload, generateToken, generateUserToken, getAlertDefinition, getAttributeValues, getBrunoCollection, getExternalApi, getExternalApiEndpoint, getFieldTranslations, getFlowRun, getLocales, getOpenApi, getPickerExclusionStatus, getPostmanCollection, getPresence, getRetentionPolicy, getSlaRule, getSlaStatus, getTranslations, getTypes, getWebhook, globalSearch, heartbeatItemLock, helpVideosFor, importExternalApiSpec, importSchemaSnapshot, includeInPicker, installBlueprint, installCollectionPreset, invokeInternalWidgetAction, isPageSlot, joinChatRoom, leaveChatRoom, listAccessAuditRuns, listAccessAudits, listActiveAtRiskRules, listActivePresence, listAddendums, listAlertDefinitions, listAlertSubscriptions, listAllNotificationSubscriptions, listAnomalyDefinitions, listAnomalyRules, listApiKeys, listApprovalChains, listApprovalInstances, listAtRiskRules, listAttributeDefinitions, listBlackoutDates, listBulkActions, listChangeOrders, listChatChannelMembers, listChatMessages, listChatPins, listChatRoles, listChatRoomTypes, listChatRooms, listCollectionPresets, listCollectionRecordTemplates, listComments, listCronJobs, listCustomQueries, listDataQualityRules, listDataQualityRuns, listDeadLetters, listExternalApiEndpoints, listExternalApiSchemas, listExternalApis, listFieldGroups, listFieldWatches, listFiles, listFlowRuns, listHelpVideoPages, listHelpVideoVersions, listHelpVideos, listHierarchyConfigs, listImportDefinitionVersions, listImportDefinitions, listImportJobs, listImportTemplates, listInternalWidgets, listIssues, listItemActions, listItemScheduledChanges, listLayoutVersions, listMetricAlertRules, listMetricAlertSubscriptions, listMetricDefinitions, listMyHelpVideoUploads, listMyTasks, listNotificationSubscriptions, listNotifications, listOrphanFiles, listPages, listPdfTemplates, listPersistedQueries, listPinnedItems, listPipelineVersions, listQueueViews, listQueues, listRecordLinks, listRecordTemplates, listRegisteredExtensions, listRegisteredFlowOperations, listRegisteredFlowTriggers, listRelatedComments, listReportAlerts, listReportAnnotations, listReportFilterPresets, listReportSnapshots, listReportTemplates, listReportVersions, listReportWidgetPresets, listReports, listRequestedTasks, listRetentionPolicies, listRetentionRuns, listRolePolicies, listRoleUsers, listRoles, listRules, listSavedViews, listScheduledChanges, listScheduledReports, listScopeDimensions, listSessionRecordings, listShareLinks, listSlaRules, listStagedImports, listSubRowTemplates, listSubRows, listSyncJobs, listTasks, listTeamTasks, listThroughputCollections, listTraces, listTreePermissions, listViewSubscriptions, listVirtualCollections, listWebhookDeliveries, listWebhooks, listWidgetFeeds, listWorkspaceTemplates, listWorkspaces, markAllNotificationsRead, markChatRoomRead, markNotificationRead, markNotificationsRead, moveTreeNode, nudgeTask, omniSearch, openHelpVideoPackageImport, openHelpVideoUpload, presignFileUpload, previewContentBundle, previewHelpVideoPackageImport, previewImportJob, previewReportWidget, publishHelpVideo, publishItem, queryVirtualCollection, readAccessAuditFindings, readActiveLayout, readActivity, readActivityReportSummary, readAddendum, readAiSettings, readAlertLog, readAllStateOwners, readAnomalyLog, readApiAnalyticsErrors, readApiAnalyticsSummary, readApiAnalyticsTimeseries, readApiAnalyticsTopCollections, readApiAnalyticsTopPaths, readApiKey, readApprovalBrief, readApprovalChain, readAtRiskSummary, readBackupManifest, readChatConfig, readChatDirectory, readChatPeerRead, readCollection, readCollectionLayout, readCollectionLayouts, readCollections, readConfigInventory, readCoverageGaps, readDataQualityRun, readDetailLayout, readDistinctValues, readDraftPublishConfig, readErpSubmissionHistory, readFieldChangeHistory, readFieldConfig, readFieldImpact, readFieldWatch, readFileMeta, readFileUsage, readHelpVideo, readHelpVideoAnalytics, readHelpVideoDownloadLink, readHelpVideoDraft, readHelpVideoWalk, readHierarchyConfig, readHierarchyNodeAncestors, readHierarchyNodeChildren, readHierarchyNodes, readHierarchyTree, readImportJob, readImportProcedure, readInstanceOwners, readIntegrationHealth, readInternalWidget, readIssue, readIssueSummary, readItem, readItemLock, readItemLockConfig, readItems, readLastTouch, readLayoutAssignments, readLayoutGroups, readMany, readMe, readMetricAlertLog, readMyScopes, readMyWork, readNotificationCount, readNotificationSubscriptionStats, readOnlinePresence, readOwnerGroups, readPage, readPageWidgetData, readPdfTemplate, readPersistedQuery, readPipelineFlowMap, readPipelineReplay, readPipelineTemplate, readPipelineTemplates, readPipelineVersion, readPreflight, readQueue, readQueueCollectionStates, readQueueColumnPrefs, readQueueItems, readQueueTrends, readQueueWorkload, readRecordGraph, readRelationOptions, readReport, readReportAlertLog, readReportAlertsLog, readReportFilterOptions, readReportFiring, readReportSnapshot, readReportSubscription, readReportUsage, readReportWidgetData, readRequiredHelpVideos, readRevision, readRevisions, readRole, readScopeDimensionCoverage, readSessionRecordingEvents, readSettings, readSingleton, readSlaStatusBatch, readStagedImport, readStagedImportStats, readStateOwnerGroups, readStateOwners, readStateOwnersBatch, readSyncJob, readTask, readTaskCounts, readTaskHistory, readThroughputReport, readTimeline, readTrace, readTreeAncestors, readTreeChildren, readTreeConfig, readTreeDescendants, readTreeNested, readTreeNodes, readTwoFactorStatus, readUnreadNotificationCount, readUser, readUserActivity, readUserActivitySummary, readUserCard, readUserScopes, readUsers, readWorkflowBindings, readWorkflowInstance, readWorkflowInstances, readWorkspace, readWorkspaceUsage, rebuildTreePaths, recordHelpVideoProgress, registerHelpVideoPage, rehearseCreateItem, reindexSemanticSearch, rejectAddendum, rejectAiProposal, releaseItemLock, releaseQueueItem, rematerializeQueue, removeChatChannelMember, removeInstanceOwner, renderInternalWidget, renderPdfTemplate, reorderFieldGroups, reorderSubRows, reorderTreeSiblings, replaceSubRows, replayActivityEvent, replayFlow, reportClientError, requestRecordAccess, requeueStagedImport, rerecordHelpVideo, rerenderHelpVideo, resetReportCache, resolveReportAlert, restoreHelpVideoVersion, restoreImportDefinitionVersion, restoreLayoutVersion, restorePipelineVersion, restoreReportVersion, retryDeadLetter, retryErpSubmission, retryWebhookDelivery, revokeApiKey, revokeShareLink, revokeToken, revokeUserToken, rollbackRevision, rotateWidgetFeedToken, runAccessAudit, runActivityReport, runActivityReportCsv, runCronJob, runDataQuality, runRetentionPolicy, runScheduledReport, runSyncJob, saveHelpVideoDraft, saveMyScopeDefaults, saveReportFilterPreset, saveReportTemplate, saveReportWidgets, saveUserScope, searchChatMessages, semanticSearch, sendBulkNotification, sendChatMessage, sendTestMail, sessionRecordingEnabled, setHelpVideoContexts, setHelpVideoRequirements, setMyDelegate, setQueueDefaultView, setReportSubscription, setTranslations, setupTwoFactor, simulatePermissions, simulatePipeline, simulatePipelineImpact, startApproval, startMasquerade, startSessionRecording, startWorkflow, stopMasquerade, submitAddendum, submitFormItem, submitItemForReview, submitToErp, subscribeFieldWatch, subscribeMetricAlert, suggestImportValidation, suggestQueueLabels, switchWorkspace, testExternalApi, testFlow, testWebhook, toggleChatPin, toggleChatReaction, togglePinnedItem, toggleReportAlert, touchRecordView, transitionWorkflow, unpublishItem, unsubscribeFieldWatch, unsubscribeMetricAlert, updateAccessAudit, updateAddendum, updateAiSettings, updateAlertDefinition, updateAnomalyLogEntry, updateAnomalyRule, updateApiKey, updateApprovalChain, updateAtRiskRule, updateAttributeDefinition, updateAttributeValues, updateChatChannel, updateChatRoom, updateChatRoomType, updateCollectionLayout, updateComment, updateDataQualityRule, updateDraftPublishConfig, updateErpSubmissionStatus, updateExternalApi, updateExternalApiEndpoint, updateFieldConfig, updateFieldGroup, updateFieldWatch, updateFileMeta, updateHelpVideo, updateHierarchyConfig, updateImportDefinition, updateInternalWidget, updateIssue, updateItem, updateItemLockConfig, updateLayoutAssignments, updateLayoutUngroupedSort, updateMe, updateMetricAlertRule, updateMetricAlertSubscription, updateNotificationSubscription, updatePage, updatePdfTemplate, updatePersistedQuery, updateQueue, updateQueueSources, updateQueueView, updateRecordTemplate, updateReport, updateReportAlert, updateReportWidgetPreset, updateRetentionPolicy, updateRole, updateRolePolicy, updateRoleUiPermissions, updateRule, updateSavedView, updateScheduledReport, updateSettings, updateSingleton, updateSlaRule, updateSyncJob, updateTask, updateTreePermission, updateUser, updateVirtualCollection, updateWebhook, updateWidgetFeed, updateWorkflowBinding, updateWorkspace, validateVirtualCollectionSql, verifyTwoFactor };
7943
+ export { type AccessAudit, type AccessAuditFinding, type AccessAuditRun, type AccessAuditSubject, type AccessReason, type ActivityEntry, type ActivityQuery, type ActivityReportQuery, type ActivityReportRow, type ActivityReportSummary, type Addendum, type AddendumStatus, type AggregateQuery, type AggregateRow, type AiChatTraceEntry, type AiCollectionSettings, type AiColumnMapping, type AiDuplicateMatch, type AiQueryFilter, type AiQueryResult, type AiReviewFinding, type AiViolation, type AlertDefinition, type AlertLogEntry, type AlertSubscription, type AnomalyDefinition, type AnomalyRule, type ApiAnalyticsBucket, type ApiAnalyticsCollection, type ApiAnalyticsPath, type ApiAnalyticsSummary, type ApiErrorLog, type ApiKey, type ApiKeyScope, type ApprovalBrief, type ApprovalChain, type ApprovalChainStep, type ApprovalDecision, type ApprovalInstance, type ApprovalInstanceDetail, type ApprovalStatus, type ApprovalStepInput, type AtRiskCondition, type AtRiskOp, type AtRiskResult, type AtRiskRule, type AtRiskSummaryEntry, type AttributeDefinition, type AttributeValue, type BatchRead, type BatchReadResult, type BlackoutDate, type BoolFilterOps, type CMSCollection, type CascadeFilterRule, type ChangeOrder, type ChatChannel, type ChatChannelMember, type ChatDirectoryChannel, type ChatMessage, type ChatPin, type ChatReaction, type ChatRoomKind, type ChatRoomSummary, type ChatRoomType, type ChatSearchHit, type CollectionLayout, type CollectionPresetSummary, type Command, type Comment, type CommentVersion, type ConfigSnapshot, type ConfigTableClassification, type ContentBundle, type ContentExportFormat, type ContentExportOptions, type CoverageGapItem, type CoverageGapOwner, type CoverageGapReport, type CpuProfileSummary, type CronJob, type CustomQuery, type CustomQueryCatalogEntry, type DataQualityRule, type DataQualityRuleResult, type DataQualityRuleType, type DataQualityRun, type DataQualitySeverity, type DeadLetter, type DmvResult, type DraftPublishConfig, type DraftStatus, type DryRunReport, type ErpSubmission, type ErpSubmissionStatus, type ExpensiveStatement, type ExtensionManifest, type ExternalApi, type ExternalApiEndpoint, type ExternalApiSchema, type ExternalApiSlotContext, type ExternalApiSpecImportResult, type ExternalApiTestResult, type FieldChangeEntry, type FieldCondition, type FieldConfig, type FieldDependencyConfig, type FieldFilter, type FieldGroup, type FieldTranslations, type FieldVisibilityRules, type FieldWatch, type FileRecord, type FileUploadResult, type FileUsageEntry, type Filter, type FlowReplayResult, type FlowRun, type FlowTestStep, type FormFieldDescriptor, type FormFieldRelation, type FormGroupDescriptor, type FormLockCondition, type FormSchema, type FormValidationRule, type FormVisibilityRule, type GlobalSearchRecord, type GlobalSearchResults, type GraphQLResponse, type HealthDetailed, type HelpVideo, type HelpVideoClick, type HelpVideoContext, type HelpVideoDownloadUrls, type HelpVideoFinalizedUpload, type HelpVideoProgress, type HelpVideoUploadSession, type HelpVideoVersion, type HelpVideoVisibility, type HelpVideoWalkStep, type HelpVideoWhatsNew, type HierarchyConfigDef, type HierarchyFlatNode, type HierarchyLevelDef, type HierarchyNestedNode, type IDFilterOps, type ISODate, type ImportDefinition, type ImportJob, type ImportParseResponse, type ImportPreview, type ImportPreviewDiff, type ImportTemplateSummary, type InstanceOwner, type IntegrationApiHealth, type InternalWidget, type Issue, type IssueSeverity, type IssueStatus, type IssueSummary, type ItemLock, type JobRegistryCron, type JobRun, type LastTouch, type LayoutAssignment, type LayoutGroup, type LayoutVersion, type ListResponse, type ManagedUser, type MetricAlertRule, type MetricAlertSubscription, type MetricDefinition, type MyTask, type MyWorkOwnedEntry, type MyWorkSla, type MyWorkSummary, type NivaroClient, type NivaroClientOptions, type NivaroExtensionPlugin, type NivaroRealtime, type NivaroRuntime, type NotificationItem, type NotificationPage, type NotificationSubscription, type NumberFilterOps, type OmniSearchHit, type OnlinePresenceConfig, type OnlinePresenceUser, type Page, type PageLayout, type PageSlotKey, type PageWidget, type PdfTemplate, type PermissionSimulation, type PersistedQuery, type PickerExclusionStatus, type PipelineFlowEdge, type PipelineFlowState, type PipelineImpactResult, type PipelineOwnerGroup, type PipelineOwnerGroupUser, type PipelineSimulation, type PipelineState, type PipelineVersionEntry, type PluginSlots, type Policy, type PoolStats, type PreflightCheck, type PreflightReport, type PreflightSeverity, type PresenceClient, type PresenceOptions, type PresenceSession, type PresenceSessionInfo, type PresenceViewer, type PromotionApplyResult, type PromotionPreview, type Query, type Queue, type QueueColumnPrefs, type QueueCondition, type QueueDetail, type QueueDisplayConfig, type QueueItem, type QueueItemsResult, type QueueOwner, type QueueRowClickMode, type QueueScope, type QueueSource, type QueueSourceType, type QueueStats, type QueueTrendPoint, type QueueView, type QueueViewKind, type QueueWorkloadRow, READ_MANY_MAX, type ReadyReport, type RealtimeEvent, type RecordGraphEdge, type RecordGraphNode, type RecordLink, type RecordLinkType, type RecordTemplate, type RecordViewRecap, type RegisteredAction, type RelatedCommentEntry, type RelationFilter, type RelationOption, type ReportAlert, type ReportAlertCondition, type ReportAlertLogEntry, type ReportAnnotation, type ReportColumnFormat, type ReportDateRange, type ReportDef, type ReportEntityFilter, type ReportFilterPreset, type ReportQueryColumn, type ReportQueryWidgetConfig, type ReportSnapshotEntry, type ReportSubscription, type ReportTemplateEntry, type ReportVersionEntry, type ReportWidget, type ReportWidgetConfig, type ReportWidgetData, type ReportWidgetPreset, type ReportWidgetType, type RequestTrace, type ResolvedOwner, type RetentionPolicy, type RetentionRun, type RetentionRunResult, type Revision, type Role, type Rule, type RuntimeStats, type SavedView, type ScheduledChange, type ScheduledReport, type ScopeDimension, type ScopeDimensionInfo, type SemanticSearchMatch, type SessionRecording, type SessionReplayMasking, type ShareLink, type SlaBatchStatus, type SlaRule, type SlaStatus, type StagedImportRun, type StagedImportStats, type StringFilterOps, type SubRow, type SubRowTemplate, type SyncJob, type Task, type TaskDoneWhenRule, type TaskPriority, type TaskStatus, type TimelineEvent, type TraceSpan, type TrafficSnapshot, type TrafficSnapshotEntity, type TreeFlatNode, type TreeNestedNode, type TreeNodeConfig, type TreePermission, type TreePermissionAction, type UUID, type UserActivityEntry, type UserActivitySummary, type UserScopesInfo, type ViewSubscription, type VirtualCollection, type Webhook, type WebhookDelivery, type WidgetFeed, type WorkflowBinding, type WorkflowHistoryEntry, type WorkflowInstance, type WorkflowInstanceData, type WorkflowState, type WorkflowTransition, type Workspace, type WorkspaceQuotas, type WorkspaceTemplate, type WorkspaceUsage, _and, _contains, _ends_with, _eq, _gt, _gte, _in, _lt, _lte, _ncontains, _neq, _nin, _nnull, _none, _null, _or, _some, _starts_with, abandonHelpVideoUpload, acquireItemLock, activateLayout, addChatChannelMember, addInstanceOwner, addSubRow, aggregateItems, aiBrief, aiBuildReport, aiChat, aiCheckDuplicates, aiGenerate, aiMapColumns, aiQuery, aiReportFilters, aiReview, aiSummarize, aiValidate, appendSessionRecordingEvents, applyContentBundle, applyHelpVideoPackageImport, applyRecordTemplate, applySubRowTemplate, approveAddendum, approveAiProposal, archiveHelpVideo, asc, backupExportPath, batchPickerExclusionStatus, bulkPickerExclusion, callExternalApi, callExternalApiEndpoint, cancelScheduledChange, cancelStagedImport, captureCpuProfile, cascadeFieldDependencies, checkBlackoutDate, claimQueueItem, claimTask, clearTraces, cloneItem, cloneLayout, cloneReport, compareConfigSnapshot, completeTask, copyReportWidget, createAccessAudit, createAddendum, createAlertDefinition, createAlertSubscription, createAnomalyRule, createApiKey, createApprovalChain, createAtRiskRule, createAttributeDefinition, createBlackoutDate, createChatChannel, createChatRoomType, createCollectionLayout, createComment, createDataQualityRule, createExternalApi, createExternalApiEndpoint, createFieldGroup, createFieldWatch, createGroupDm, createHelpVideo, createHierarchyConfig, createImportDefinition, createImportJob, createImportJobFromUrl, createInternalWidget, createIssue, createItem, createMetricAlertRule, createNivaro, createNotification, createNotificationSubscription, createPage, createPdfTemplate, createPersistedQuery, createPresence, createQueue, createQueueView, createRealtime, createRecordLink, createRecordTemplate, createReport, createReportAlert, createReportAnnotation, createReportFromTemplate, createReportSnapshot, createReportWidgetPreset, createRetentionPolicy, createRole, createRolePolicy, createRule, createSavedView, createScheduledChange, createScheduledReport, createShareLink, createSlaRule, createSubRowTemplate, createSyncJob, createTask, createTreePermission, createUser, createViewSubscription, createVirtualCollection, createWebhook, createWidgetFeed, createWorkspace, createWorkspaceTemplate, decideApproval, deleteAccessAudit, deleteAddendum, deleteAlertDefinition, deleteAlertSubscription, deleteAnomalyRule, deleteApiKey, deleteApprovalChain, deleteAtRiskRule, deleteAttributeDefinition, deleteBlackoutDate, deleteChatMessage, deleteCollectionLayout, deleteComment, deleteDataQualityRule, deleteExternalApi, deleteExternalApiEndpoint, deleteExternalApiSchema, deleteFieldGroup, deleteFieldTranslations, deleteFieldWatch, deleteFile, deleteHierarchyConfig, deleteImportJob, deleteInternalWidget, deleteIssue, deleteItem, deleteMetricAlertRule, deleteNotification, deleteNotificationSubscription, deletePage, deletePdfTemplate, deletePersistedQuery, deleteQueue, deleteQueueView, deleteRecordLink, deleteRecordTemplate, deleteReport, deleteReportAlert, deleteReportAnnotation, deleteReportFilterPreset, deleteReportSnapshot, deleteReportTemplate, deleteReportWidgetPreset, deleteRetentionPolicy, deleteRole, deleteRolePolicy, deleteRule, deleteSavedView, deleteScheduledReport, deleteSessionRecording, deleteSlaRule, deleteSubRow, deleteSubRowTemplate, deleteSyncJob, deleteTask, deleteTreePermission, deleteUser, deleteViewSubscription, deleteVirtualCollection, deleteWebhook, deleteWidgetFeed, deleteWorkspace, deleteWorkspaceTemplate, deployImportProcedure, desc, disableTwoFactor, discardHelpVideoPackageImport, drillReportRow, editChatMessage, endSessionRecording, evaluateAlerts, evaluateAtRisk, evaluateFieldDefaults, evaluateFieldLock, evaluateFieldRules, evaluateFieldVisibility, excludeFromPicker, executeBulkAction, executeCustomQuery, executeImportTemplate, executeItemAction, executeScheduledChange, explainRecordAccess, explainReportTrend, exportBlueprint, exportConfigSnapshot, exportContent, exportContentBundle, exportHelpVideoPackage, exportSchemaSnapshot, fetchFormSchema, fileDownloadPath, fileTransformPath, finalizeHelpVideoUpload, generateToken, generateUserToken, getAlertDefinition, getAttributeValues, getBrunoCollection, getCommentHistory, getExternalApi, getExternalApiEndpoint, getFieldTranslations, getFlowRun, getLocales, getOpenApi, getPickerExclusionStatus, getPostmanCollection, getPresence, getRetentionPolicy, getSlaRule, getSlaStatus, getTranslations, getTypes, getWebhook, globalSearch, heartbeatItemLock, helpVideosFor, importExternalApiSpec, importSchemaSnapshot, includeInPicker, installBlueprint, installCollectionPreset, invokeInternalWidgetAction, isPageSlot, joinChatRoom, leaveChatRoom, listAccessAuditRuns, listAccessAudits, listActiveAtRiskRules, listActivePresence, listAddendums, listAlertDefinitions, listAlertSubscriptions, listAllNotificationSubscriptions, listAnomalyDefinitions, listAnomalyRules, listApiKeys, listApprovalChains, listApprovalInstances, listAtRiskRules, listAttributeDefinitions, listBlackoutDates, listBulkActions, listChangeOrders, listChatChannelMembers, listChatMessages, listChatPins, listChatRoles, listChatRoomTypes, listChatRooms, listCollectionPresets, listCollectionRecordTemplates, listComments, listCronJobs, listCustomQueries, listCustomQueryCatalog, listDataQualityRules, listDataQualityRuns, listDeadLetters, listExternalApiEndpoints, listExternalApiSchemas, listExternalApis, listFieldGroups, listFieldWatches, listFiles, listFlowRuns, listHelpVideoPages, listHelpVideoVersions, listHelpVideos, listHierarchyConfigs, listImportDefinitionVersions, listImportDefinitions, listImportJobs, listImportTemplates, listInternalWidgets, listIssues, listItemActions, listItemScheduledChanges, listJobRuns, listLayoutVersions, listMetricAlertRules, listMetricAlertSubscriptions, listMetricDefinitions, listMyHelpVideoUploads, listMyTasks, listNotificationSubscriptions, listNotifications, listOrphanFiles, listPages, listPdfTemplates, listPersistedQueries, listPinnedItems, listPipelineVersions, listQueueViews, listQueues, listRecordLinks, listRecordTemplates, listRegisteredExtensions, listRegisteredFlowOperations, listRegisteredFlowTriggers, listRelatedComments, listReportAlerts, listReportAnnotations, listReportFilterPresets, listReportSnapshots, listReportTemplates, listReportVersions, listReportWidgetPresets, listReports, listRequestedTasks, listRetentionPolicies, listRetentionRuns, listRolePolicies, listRoleUsers, listRoles, listRules, listSavedViews, listScheduledChanges, listScheduledReports, listScopeDimensions, listSessionRecordings, listShareLinks, listSlaRules, listStagedImports, listSubRowTemplates, listSubRows, listSyncJobs, listTasks, listTeamTasks, listThroughputCollections, listTraces, listTreePermissions, listViewSubscriptions, listVirtualCollections, listWebhookDeliveries, listWebhooks, listWidgetFeeds, listWorkspaceTemplates, listWorkspaces, markAllNotificationsRead, markChatRoomRead, markNotificationRead, markNotificationsRead, moveTreeNode, nudgeTask, omniSearch, openHelpVideoPackageImport, openHelpVideoUpload, presignFileUpload, previewContentBundle, previewHelpVideoPackageImport, previewImportJob, previewReportWidget, publishHelpVideo, publishItem, queryVirtualCollection, readAccessAuditFindings, readActiveLayout, readActivity, readActivityReportSummary, readAddendum, readAiSettings, readAlertLog, readAllStateOwners, readAnomalyLog, readApiAnalyticsErrors, readApiAnalyticsSummary, readApiAnalyticsTimeseries, readApiAnalyticsTopCollections, readApiAnalyticsTopPaths, readApiKey, readApprovalBrief, readApprovalChain, readAtRiskSummary, readBackupManifest, readChatConfig, readChatDirectory, readChatPeerRead, readCollection, readCollectionLayout, readCollectionLayouts, readCollections, readConfigInventory, readCoverageGaps, readDataQualityRun, readDbPool, readDetailLayout, readDistinctValues, readDraftPublishConfig, readErpSubmissionHistory, readExpensiveSql, readFieldChangeHistory, readFieldConfig, readFieldImpact, readFieldWatch, readFileMeta, readFileUsage, readFilesByIds, readHealthDetailed, readHelpVideo, readHelpVideoAnalytics, readHelpVideoDownloadLink, readHelpVideoDraft, readHelpVideoWalk, readHierarchyConfig, readHierarchyNodeAncestors, readHierarchyNodeChildren, readHierarchyNodes, readHierarchyTree, readImportJob, readImportProcedure, readInstanceOwners, readInstanceRoster, readIntegrationHealth, readInternalWidget, readIssue, readIssueSummary, readItem, readItemLock, readItemLockConfig, readItems, readJobRegistry, readLastTouch, readLayoutAssignments, readLayoutGroups, readMany, readMe, readMetricAlertLog, readMyScopes, readMyWork, readNotificationCount, readNotificationSubscriptionStats, readOnlinePresence, readOwnerGroups, readPage, readPageWidgetData, readPdfTemplate, readPersistedQuery, readPipelineFlowMap, readPipelineReplay, readPipelineTemplate, readPipelineTemplates, readPipelineVersion, readPreflight, readQueue, readQueueCollectionStates, readQueueColumnPrefs, readQueueItems, readQueueTrends, readQueueWorkload, readReadiness, readRecordGraph, readRelationOptions, readReport, readReportAlertLog, readReportAlertsLog, readReportFilterOptions, readReportFiring, readReportSnapshot, readReportSubscription, readReportUsage, readReportWidgetData, readRequiredHelpVideos, readRevision, readRevisions, readRole, readRuntimeStats, readScopeDimensionCoverage, readSessionRecordingEvents, readSettings, readSingleton, readSlaStatusBatch, readStagedImport, readStagedImportStats, readStateOwnerGroups, readStateOwners, readStateOwnersBatch, readSyncJob, readTask, readTaskCounts, readTaskHistory, readThroughputReport, readTimeline, readTrace, readTrafficSnapshot, readTreeAncestors, readTreeChildren, readTreeConfig, readTreeDescendants, readTreeNested, readTreeNodes, readTwoFactorStatus, readUnreadNotificationCount, readUser, readUserActivity, readUserActivitySummary, readUserCard, readUserScopes, readUsers, readWorkflowBindings, readWorkflowInstance, readWorkflowInstances, readWorkspace, readWorkspaceUsage, rebuildTreePaths, recordHelpVideoProgress, registerHelpVideoPage, rehearseCreateItem, reindexSemanticSearch, rejectAddendum, rejectAiProposal, releaseItemLock, releaseQueueItem, rematerializeQueue, removeChatChannelMember, removeInstanceOwner, renderInternalWidget, renderPdfTemplate, reorderFieldGroups, reorderSubRows, reorderTreeSiblings, replaceSubRows, replayActivityEvent, replayFlow, reportClientError, requestRecordAccess, requeueStagedImport, rerecordHelpVideo, rerenderHelpVideo, resetReportCache, resolveReportAlert, restoreHelpVideoVersion, restoreImportDefinitionVersion, restoreLayoutVersion, restorePipelineVersion, restoreReportVersion, retryDeadLetter, retryErpSubmission, retryWebhookDelivery, revokeApiKey, revokeShareLink, revokeToken, revokeUserToken, rollbackRevision, rotateWidgetFeedToken, runAccessAudit, runActivityReport, runActivityReportCsv, runCronJob, runDataQuality, runRetentionPolicy, runScheduledReport, runSyncJob, saveHelpVideoDraft, saveMyScopeDefaults, saveReportFilterPreset, saveReportTemplate, saveReportWidgets, saveUserScope, searchChatMessages, semanticSearch, sendBulkNotification, sendChatMessage, sendTestMail, sessionRecordingEnabled, setHelpVideoContexts, setHelpVideoRequirements, setMyDelegate, setQueueDefaultView, setReportSubscription, setTranslations, setupTwoFactor, simulatePermissions, simulatePipeline, simulatePipelineImpact, startApproval, startMasquerade, startSessionRecording, startWorkflow, stopMasquerade, submitAddendum, submitFormItem, submitItemForReview, submitToErp, subscribeFieldWatch, subscribeMetricAlert, suggestImportValidation, suggestQueueLabels, switchWorkspace, testExternalApi, testFlow, testWebhook, toggleChatPin, toggleChatReaction, togglePinnedItem, toggleReportAlert, touchRecordView, transitionWorkflow, unpublishItem, unsubscribeFieldWatch, unsubscribeMetricAlert, updateAccessAudit, updateAddendum, updateAiSettings, updateAlertDefinition, updateAnomalyLogEntry, updateAnomalyRule, updateApiKey, updateApprovalChain, updateAtRiskRule, updateAttributeDefinition, updateAttributeValues, updateChatChannel, updateChatRoom, updateChatRoomType, updateCollectionLayout, updateComment, updateDataQualityRule, updateDraftPublishConfig, updateErpSubmissionStatus, updateExternalApi, updateExternalApiEndpoint, updateFieldConfig, updateFieldGroup, updateFieldWatch, updateFileMeta, updateHelpVideo, updateHierarchyConfig, updateImportDefinition, updateInternalWidget, updateIssue, updateItem, updateItemLockConfig, updateLayoutAssignments, updateLayoutUngroupedSort, updateMe, updateMetricAlertRule, updateMetricAlertSubscription, updateNotificationSubscription, updatePage, updatePdfTemplate, updatePersistedQuery, updateQueue, updateQueueSources, updateQueueView, updateRecordTemplate, updateReport, updateReportAlert, updateReportWidgetPreset, updateRetentionPolicy, updateRole, updateRolePolicy, updateRoleUiPermissions, updateRule, updateSavedView, updateScheduledReport, updateSettings, updateSingleton, updateSlaRule, updateSyncJob, updateTask, updateTreePermission, updateUser, updateVirtualCollection, updateWebhook, updateWidgetFeed, updateWorkflowBinding, updateWorkspace, validateVirtualCollectionSql, verifyTwoFactor };
package/dist/index.js CHANGED
@@ -1339,6 +1339,12 @@ function stopMasquerade() {
1339
1339
  function listFiles(options = {}) {
1340
1340
  return cmd("GET", "/files", options);
1341
1341
  }
1342
+ function readFilesByIds(ids) {
1343
+ return cmd("GET", "/files", {
1344
+ filter: JSON.stringify({ id: { _in: ids } }),
1345
+ limit: Math.max(1, ids.length)
1346
+ });
1347
+ }
1342
1348
  function readFileMeta(id) {
1343
1349
  return cmd("GET", `/files/${id}/meta`);
1344
1350
  }
@@ -1634,6 +1640,40 @@ function listRetentionRuns(policyId) {
1634
1640
  return cmd("GET", `/retention/${policyId}/runs`);
1635
1641
  }
1636
1642
 
1643
+ // src/commands/ops.ts
1644
+ function readReadiness() {
1645
+ return cmd("GET", "/ready");
1646
+ }
1647
+ function readHealthDetailed() {
1648
+ return cmd("GET", "/health/detailed");
1649
+ }
1650
+ function readRuntimeStats() {
1651
+ return cmd("GET", "/ops-runtime/runtime");
1652
+ }
1653
+ function readInstanceRoster() {
1654
+ return cmd("GET", "/ops-runtime/roster");
1655
+ }
1656
+ function captureCpuProfile(seconds) {
1657
+ return cmd("POST", "/ops-runtime/cpu-profile", void 0, seconds ? { seconds } : {});
1658
+ }
1659
+ function readDbPool() {
1660
+ return cmd("GET", "/ops-db/pool");
1661
+ }
1662
+ function readExpensiveSql() {
1663
+ return cmd("GET", "/ops-db/expensive-sql");
1664
+ }
1665
+ function readTrafficSnapshot(window2 = 60) {
1666
+ return cmd("GET", "/traffic-map/snapshot", { window: window2 });
1667
+ }
1668
+ function readJobRegistry() {
1669
+ return cmd("GET", "/job-runs/registry");
1670
+ }
1671
+ function listJobRuns(query) {
1672
+ const params = {};
1673
+ for (const [k, v] of Object.entries(query ?? {})) if (v !== void 0 && v !== "") params[k] = v;
1674
+ return cmd("GET", "/job-runs", params);
1675
+ }
1676
+
1637
1677
  // src/commands/queues.ts
1638
1678
  function listQueues() {
1639
1679
  return cmd("GET", "/queues");
@@ -2161,6 +2201,9 @@ function updateComment(id, body) {
2161
2201
  function deleteComment(id) {
2162
2202
  return cmd("DELETE", `/comments/${id}`);
2163
2203
  }
2204
+ function getCommentHistory(id) {
2205
+ return cmd("GET", `/comments/${id}/history`);
2206
+ }
2164
2207
  function listFlowRuns(flowId, params) {
2165
2208
  const p = {};
2166
2209
  if (params?.limit != null) p.limit = params.limit;
@@ -2174,6 +2217,9 @@ function getFlowRun(runId) {
2174
2217
  function listCustomQueries() {
2175
2218
  return cmd("GET", "/custom-queries");
2176
2219
  }
2220
+ function listCustomQueryCatalog() {
2221
+ return cmd("GET", "/custom-queries/catalog");
2222
+ }
2177
2223
  function executeCustomQuery(slug, params) {
2178
2224
  return cmd("POST", `/custom-queries/${slug}/execute`, void 0, { params });
2179
2225
  }
@@ -2712,6 +2758,7 @@ export {
2712
2758
  callExternalApiEndpoint,
2713
2759
  cancelScheduledChange,
2714
2760
  cancelStagedImport,
2761
+ captureCpuProfile,
2715
2762
  cascadeFieldDependencies,
2716
2763
  checkBlackoutDate,
2717
2764
  claimQueueItem,
@@ -2890,6 +2937,7 @@ export {
2890
2937
  getAlertDefinition,
2891
2938
  getAttributeValues,
2892
2939
  getBrunoCollection,
2940
+ getCommentHistory,
2893
2941
  getExternalApi,
2894
2942
  getExternalApiEndpoint,
2895
2943
  getFieldTranslations,
@@ -2946,6 +2994,7 @@ export {
2946
2994
  listComments,
2947
2995
  listCronJobs,
2948
2996
  listCustomQueries,
2997
+ listCustomQueryCatalog,
2949
2998
  listDataQualityRules,
2950
2999
  listDataQualityRuns,
2951
3000
  listDeadLetters,
@@ -2968,6 +3017,7 @@ export {
2968
3017
  listIssues,
2969
3018
  listItemActions,
2970
3019
  listItemScheduledChanges,
3020
+ listJobRuns,
2971
3021
  listLayoutVersions,
2972
3022
  listMetricAlertRules,
2973
3023
  listMetricAlertSubscriptions,
@@ -3074,16 +3124,20 @@ export {
3074
3124
  readConfigInventory,
3075
3125
  readCoverageGaps,
3076
3126
  readDataQualityRun,
3127
+ readDbPool,
3077
3128
  readDetailLayout,
3078
3129
  readDistinctValues,
3079
3130
  readDraftPublishConfig,
3080
3131
  readErpSubmissionHistory,
3132
+ readExpensiveSql,
3081
3133
  readFieldChangeHistory,
3082
3134
  readFieldConfig,
3083
3135
  readFieldImpact,
3084
3136
  readFieldWatch,
3085
3137
  readFileMeta,
3086
3138
  readFileUsage,
3139
+ readFilesByIds,
3140
+ readHealthDetailed,
3087
3141
  readHelpVideo,
3088
3142
  readHelpVideoAnalytics,
3089
3143
  readHelpVideoDownloadLink,
@@ -3097,6 +3151,7 @@ export {
3097
3151
  readImportJob,
3098
3152
  readImportProcedure,
3099
3153
  readInstanceOwners,
3154
+ readInstanceRoster,
3100
3155
  readIntegrationHealth,
3101
3156
  readInternalWidget,
3102
3157
  readIssue,
@@ -3105,6 +3160,7 @@ export {
3105
3160
  readItemLock,
3106
3161
  readItemLockConfig,
3107
3162
  readItems,
3163
+ readJobRegistry,
3108
3164
  readLastTouch,
3109
3165
  readLayoutAssignments,
3110
3166
  readLayoutGroups,
@@ -3133,6 +3189,7 @@ export {
3133
3189
  readQueueItems,
3134
3190
  readQueueTrends,
3135
3191
  readQueueWorkload,
3192
+ readReadiness,
3136
3193
  readRecordGraph,
3137
3194
  readRelationOptions,
3138
3195
  readReport,
@@ -3148,6 +3205,7 @@ export {
3148
3205
  readRevision,
3149
3206
  readRevisions,
3150
3207
  readRole,
3208
+ readRuntimeStats,
3151
3209
  readScopeDimensionCoverage,
3152
3210
  readSessionRecordingEvents,
3153
3211
  readSettings,
@@ -3165,6 +3223,7 @@ export {
3165
3223
  readThroughputReport,
3166
3224
  readTimeline,
3167
3225
  readTrace,
3226
+ readTrafficSnapshot,
3168
3227
  readTreeAncestors,
3169
3228
  readTreeChildren,
3170
3229
  readTreeConfig,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nivaro/sdk",
3
- "version": "0.1.23",
3
+ "version": "0.1.25",
4
4
  "description": "TypeScript SDK for Nivaro CMS — typed REST client, GraphQL, realtime subscriptions, and presence.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",