@happyvertical/smrt-ui 0.49.2 → 0.49.4
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.
|
@@ -6,265 +6,8 @@
|
|
|
6
6
|
* may register a mounted surface here; adapters above smrt-ui can expose the
|
|
7
7
|
* resulting serializable contracts to people or agents.
|
|
8
8
|
*/
|
|
9
|
-
|
|
10
|
-
export type
|
|
11
|
-
[key: string]: DataSurfaceJsonValue;
|
|
12
|
-
};
|
|
13
|
-
export type DataSurfaceJsonObject = {
|
|
14
|
-
[key: string]: DataSurfaceJsonValue;
|
|
15
|
-
};
|
|
16
|
-
export type DataSurfaceRowId = string | number;
|
|
17
|
-
export type DataSurfaceKind = 'table' | 'list' | 'report' | 'custom';
|
|
18
|
-
export type DataSurfaceSensitivity = 'public' | 'personal' | 'sensitive' | 'secret';
|
|
19
|
-
export interface DataSurfaceSubject {
|
|
20
|
-
type: string;
|
|
21
|
-
id: string;
|
|
22
|
-
label?: string;
|
|
23
|
-
}
|
|
24
|
-
/** Stable address for one mounted instance, never an authority boundary. */
|
|
25
|
-
export interface DataSurfaceIdentity {
|
|
26
|
-
surfaceId: string;
|
|
27
|
-
kind: DataSurfaceKind;
|
|
28
|
-
subject?: DataSurfaceSubject;
|
|
29
|
-
}
|
|
30
|
-
export type DataSurfaceColumnCapability = 'read' | 'search' | 'filter' | 'sort' | 'project';
|
|
31
|
-
/** Presentation tier emitted by policy-aware domain adapters. */
|
|
32
|
-
export type DataSurfaceColumnVisibility = 'basic' | 'advanced' | 'hidden';
|
|
33
|
-
/** A domain-neutral column role. Adapters use roles to protect structural columns. */
|
|
34
|
-
export type DataSurfaceColumnRole = 'data' | 'status' | 'computed' | 'row-key' | 'selection' | 'action';
|
|
35
|
-
/** Operator allowlists are intentionally strings: #2444 owns query semantics. */
|
|
36
|
-
export interface DataSurfaceColumnOperators {
|
|
37
|
-
search?: string[];
|
|
38
|
-
filter?: string[];
|
|
39
|
-
sort?: string[];
|
|
40
|
-
}
|
|
41
|
-
export interface DataSurfaceColumnDescriptor {
|
|
42
|
-
id: string;
|
|
43
|
-
label: string;
|
|
44
|
-
description?: string;
|
|
45
|
-
sensitivity?: DataSurfaceSensitivity;
|
|
46
|
-
capabilities: DataSurfaceColumnCapability[];
|
|
47
|
-
/** Domain field identity; never accepted as a request path. */
|
|
48
|
-
fieldName?: string;
|
|
49
|
-
/** Effective policy visibility, when a domain adapter supplies one. */
|
|
50
|
-
visibility?: DataSurfaceColumnVisibility;
|
|
51
|
-
/** Stable policy order; domain column ids remain unchanged. */
|
|
52
|
-
order?: number;
|
|
53
|
-
/** Structural columns are preserved even when field policy narrows data columns. */
|
|
54
|
-
role?: DataSurfaceColumnRole;
|
|
55
|
-
/** Responsive adapters consume this without importing DataTable types. */
|
|
56
|
-
responsivePriority?: number;
|
|
57
|
-
/** Per-operation operator allowlists, narrowed by policy adapters. */
|
|
58
|
-
operators?: DataSurfaceColumnOperators;
|
|
59
|
-
/** Explicit aliases for adapters that mirror the canonical query schema. */
|
|
60
|
-
searchOperators?: string[];
|
|
61
|
-
filterOperators?: string[];
|
|
62
|
-
sortOperators?: string[];
|
|
63
|
-
/** Explicit readability is useful when read capability is policy-gated. */
|
|
64
|
-
readable?: boolean;
|
|
65
|
-
}
|
|
66
|
-
/** #2444 owns the canonical query language; this declares only its bounds. */
|
|
67
|
-
export type DataSurfaceQueryMode = 'rows' | 'count' | 'facets';
|
|
68
|
-
export interface DataSurfaceQueryCapabilities {
|
|
69
|
-
modes: DataSurfaceQueryMode[];
|
|
70
|
-
/** Explicit allowlist; field paths are not accepted in requests. */
|
|
71
|
-
projectableColumnIds: string[];
|
|
72
|
-
/** Explicit allowlists for non-projection query operations. */
|
|
73
|
-
searchableColumnIds?: string[];
|
|
74
|
-
filterableColumnIds?: string[];
|
|
75
|
-
sortableColumnIds?: string[];
|
|
76
|
-
}
|
|
77
|
-
export interface DataSurfaceVisibleControl {
|
|
78
|
-
/** Stable command name accepted by the mounted surface. */
|
|
79
|
-
id: string;
|
|
80
|
-
label: string;
|
|
81
|
-
description?: string;
|
|
82
|
-
}
|
|
83
|
-
export type DataSurfaceSelectionScope = 'current-page' | 'explicit-ids' | 'all-matching';
|
|
84
|
-
export interface DataSurfaceActionDescriptor {
|
|
85
|
-
id: string;
|
|
86
|
-
label: string;
|
|
87
|
-
description?: string;
|
|
88
|
-
sensitivity?: DataSurfaceSensitivity;
|
|
89
|
-
selectionScopes: DataSurfaceSelectionScope[];
|
|
90
|
-
requiresConfirmation?: boolean;
|
|
91
|
-
/** Optional column dependencies used by field-policy adapters. */
|
|
92
|
-
columnIds?: string[];
|
|
93
|
-
}
|
|
94
|
-
/** Per-surface limits; generic envelopes use DATA_SURFACE_MAX_REQUEST_BYTES. */
|
|
95
|
-
export interface DataSurfaceLimits {
|
|
96
|
-
maxQueryRows: number;
|
|
97
|
-
maxQueryBytes: number;
|
|
98
|
-
maxSelectionSize: number;
|
|
99
|
-
}
|
|
100
|
-
/** Public, serializable discovery metadata for a mounted data surface. */
|
|
101
|
-
export interface DataSurfaceDescriptor {
|
|
102
|
-
version: 1;
|
|
103
|
-
identity: DataSurfaceIdentity;
|
|
104
|
-
/** Version of the domain adapter's descriptor and view-state schema. */
|
|
105
|
-
schemaVersion: number;
|
|
106
|
-
label: string;
|
|
107
|
-
description?: string;
|
|
108
|
-
/** Stable row-identity column, including when it is not visibly rendered. */
|
|
109
|
-
rowKey: string;
|
|
110
|
-
columns: DataSurfaceColumnDescriptor[];
|
|
111
|
-
query: DataSurfaceQueryCapabilities;
|
|
112
|
-
controls: DataSurfaceVisibleControl[];
|
|
113
|
-
actions: DataSurfaceActionDescriptor[];
|
|
114
|
-
limits: DataSurfaceLimits;
|
|
115
|
-
}
|
|
116
|
-
export type DataSurfaceSelectionReference = {
|
|
117
|
-
scope: 'current-page';
|
|
118
|
-
} | {
|
|
119
|
-
scope: 'explicit-ids';
|
|
120
|
-
rowIds: DataSurfaceRowId[];
|
|
121
|
-
} | {
|
|
122
|
-
scope: 'all-matching';
|
|
123
|
-
queryFingerprint: string;
|
|
124
|
-
};
|
|
125
|
-
/** Input supplied by a mounted renderer/controller, before registry wrapping. */
|
|
126
|
-
export interface DataSurfaceSnapshotState {
|
|
127
|
-
revision: number;
|
|
128
|
-
state: DataSurfaceJsonObject;
|
|
129
|
-
selection?: DataSurfaceSelectionReference | null;
|
|
130
|
-
}
|
|
131
|
-
/** Deterministic inspect/result envelope. It intentionally has no timestamp. */
|
|
132
|
-
export interface DataSurfaceSnapshot {
|
|
133
|
-
version: 1;
|
|
134
|
-
descriptor: DataSurfaceDescriptor;
|
|
135
|
-
revision: number;
|
|
136
|
-
state: DataSurfaceJsonObject;
|
|
137
|
-
selection: DataSurfaceSelectionReference | null;
|
|
138
|
-
}
|
|
139
|
-
/** A browser-visible state transition, not a server-side query or mutation. */
|
|
140
|
-
export interface DataSurfaceVisibleCommand {
|
|
141
|
-
version: 1;
|
|
142
|
-
commandId: string;
|
|
143
|
-
identity: DataSurfaceIdentity;
|
|
144
|
-
expectedRevision: number;
|
|
145
|
-
controlId: string;
|
|
146
|
-
payload?: DataSurfaceJsonValue;
|
|
147
|
-
}
|
|
148
|
-
export type DataSurfaceCommandFailureReason = 'not_found' | 'unsupported' | 'stale_revision' | 'idempotency_conflict' | 'denied' | 'execution_failed' | 'non_monotonic_revision';
|
|
149
|
-
export interface DataSurfaceCommandResult {
|
|
150
|
-
ok: boolean;
|
|
151
|
-
commandId: string;
|
|
152
|
-
identity: DataSurfaceIdentity;
|
|
153
|
-
revision?: number;
|
|
154
|
-
snapshot?: DataSurfaceSnapshot;
|
|
155
|
-
reason?: DataSurfaceCommandFailureReason;
|
|
156
|
-
}
|
|
157
|
-
/**
|
|
158
|
-
* This intentionally contains only bounded read shape. #2444 adds the
|
|
159
|
-
* canonical filters, ordering, cursors, totals, and normalized result details.
|
|
160
|
-
*/
|
|
161
|
-
export type DataSurfaceQueryRequest = {
|
|
162
|
-
version: 1;
|
|
163
|
-
requestId: string;
|
|
164
|
-
identity: DataSurfaceIdentity;
|
|
165
|
-
kind: 'rows';
|
|
166
|
-
limit: number;
|
|
167
|
-
cursor?: string;
|
|
168
|
-
projection?: string[];
|
|
169
|
-
} | {
|
|
170
|
-
version: 1;
|
|
171
|
-
requestId: string;
|
|
172
|
-
identity: DataSurfaceIdentity;
|
|
173
|
-
kind: 'count';
|
|
174
|
-
} | {
|
|
175
|
-
version: 1;
|
|
176
|
-
requestId: string;
|
|
177
|
-
identity: DataSurfaceIdentity;
|
|
178
|
-
kind: 'facets';
|
|
179
|
-
columnId: string;
|
|
180
|
-
limit: number;
|
|
181
|
-
};
|
|
182
|
-
interface DataSurfaceQueryResultBase {
|
|
183
|
-
version: 1;
|
|
184
|
-
requestId: string;
|
|
185
|
-
identity: DataSurfaceIdentity;
|
|
186
|
-
revision: number;
|
|
187
|
-
}
|
|
188
|
-
/** Bounded read result shapes; #2444 owns their canonical query semantics. */
|
|
189
|
-
export type DataSurfaceQueryResult = (DataSurfaceQueryResultBase & {
|
|
190
|
-
kind: 'rows';
|
|
191
|
-
rowKey: string;
|
|
192
|
-
rows: DataSurfaceJsonObject[];
|
|
193
|
-
hasMore: boolean;
|
|
194
|
-
truncated: boolean;
|
|
195
|
-
nextCursor?: string;
|
|
196
|
-
}) | (DataSurfaceQueryResultBase & {
|
|
197
|
-
kind: 'count';
|
|
198
|
-
count: number;
|
|
199
|
-
}) | (DataSurfaceQueryResultBase & {
|
|
200
|
-
kind: 'facets';
|
|
201
|
-
columnId: string;
|
|
202
|
-
facets: Array<{
|
|
203
|
-
value: DataSurfaceJsonPrimitive;
|
|
204
|
-
count: number;
|
|
205
|
-
}>;
|
|
206
|
-
truncated: boolean;
|
|
207
|
-
});
|
|
208
|
-
/** Preview/apply is a contract only here; server-side adapters execute it. */
|
|
209
|
-
export interface DataSurfaceActionRequest {
|
|
210
|
-
version: 1;
|
|
211
|
-
requestId: string;
|
|
212
|
-
identity: DataSurfaceIdentity;
|
|
213
|
-
actionId: string;
|
|
214
|
-
phase: 'preview' | 'apply';
|
|
215
|
-
selection: DataSurfaceSelectionReference;
|
|
216
|
-
payload?: DataSurfaceJsonValue;
|
|
217
|
-
/** Opaque confirmation produced by a prior preview, never an authority. */
|
|
218
|
-
confirmationToken?: string;
|
|
219
|
-
}
|
|
220
|
-
export interface DataSurfaceActionResult {
|
|
221
|
-
version: 1;
|
|
222
|
-
requestId: string;
|
|
223
|
-
identity: DataSurfaceIdentity;
|
|
224
|
-
actionId: string;
|
|
225
|
-
phase: 'preview' | 'apply';
|
|
226
|
-
ok: boolean;
|
|
227
|
-
reason?: string;
|
|
228
|
-
confirmationToken?: string;
|
|
229
|
-
details?: DataSurfaceJsonObject;
|
|
230
|
-
}
|
|
231
|
-
export type DataSurfaceValidationReason = 'not_found' | 'unsupported' | 'invalid_request' | 'limit_exceeded' | 'projection_not_allowed' | 'selection_not_supported' | 'confirmation_required';
|
|
232
|
-
export interface DataSurfaceValidationResult {
|
|
233
|
-
ok: boolean;
|
|
234
|
-
reason?: DataSurfaceValidationReason;
|
|
235
|
-
}
|
|
236
|
-
export type DataSurfaceCommandExecution = {
|
|
237
|
-
ok: false;
|
|
238
|
-
} | undefined;
|
|
239
|
-
/** Runtime-only handle supplied by a mounted renderer or controller. */
|
|
240
|
-
export interface DataSurfaceRegistration {
|
|
241
|
-
descriptor: DataSurfaceDescriptor;
|
|
242
|
-
getSnapshot: () => DataSurfaceSnapshotState;
|
|
243
|
-
execute?: (command: DataSurfaceVisibleCommand) => DataSurfaceCommandExecution | Promise<DataSurfaceCommandExecution>;
|
|
244
|
-
/**
|
|
245
|
-
* A host-owned redaction boundary. It cannot change identity or revision and
|
|
246
|
-
* the registry validates its output before exposing it.
|
|
247
|
-
*/
|
|
248
|
-
redact?: (snapshot: DataSurfaceSnapshot) => DataSurfaceSnapshot;
|
|
249
|
-
}
|
|
250
|
-
export interface DataSurfaceRegistryEvent {
|
|
251
|
-
type: 'registered' | 'unregistered' | 'command';
|
|
252
|
-
sequence: number;
|
|
253
|
-
identity: DataSurfaceIdentity;
|
|
254
|
-
revision: number;
|
|
255
|
-
command?: DataSurfaceVisibleCommand;
|
|
256
|
-
result?: DataSurfaceCommandResult;
|
|
257
|
-
}
|
|
258
|
-
export interface DataSurfaceRegistry {
|
|
259
|
-
register(registration: DataSurfaceRegistration): () => void;
|
|
260
|
-
unregister(identity: DataSurfaceIdentity): void;
|
|
261
|
-
list(): DataSurfaceDescriptor[];
|
|
262
|
-
inspect(identity: DataSurfaceIdentity): DataSurfaceSnapshot | undefined;
|
|
263
|
-
execute(command: DataSurfaceVisibleCommand): Promise<DataSurfaceCommandResult>;
|
|
264
|
-
validateQuery(request: DataSurfaceQueryRequest): DataSurfaceValidationResult;
|
|
265
|
-
validateAction(request: DataSurfaceActionRequest): DataSurfaceValidationResult;
|
|
266
|
-
subscribe(listener: (event: DataSurfaceRegistryEvent) => void): () => void;
|
|
267
|
-
}
|
|
9
|
+
import type { DataSurfaceActionRequest, DataSurfaceDescriptor, DataSurfaceQueryRequest, DataSurfaceRegistry, DataSurfaceSnapshot, DataSurfaceVisibleCommand } from '@happyvertical/smrt-types';
|
|
10
|
+
export type { DataSurfaceActionDescriptor, DataSurfaceActionRequest, DataSurfaceActionResult, DataSurfaceActionRowOutcome, DataSurfaceActionWireRequest, DataSurfaceColumnCapability, DataSurfaceColumnDescriptor, DataSurfaceColumnOperators, DataSurfaceColumnRole, DataSurfaceColumnVisibility, DataSurfaceCommandExecution, DataSurfaceCommandFailureReason, DataSurfaceCommandResult, DataSurfaceDescriptor, DataSurfaceIdentity, DataSurfaceJsonObject, DataSurfaceJsonPrimitive, DataSurfaceJsonValue, DataSurfaceKind, DataSurfaceLimits, DataSurfaceQueryCapabilities, DataSurfaceQueryMode, DataSurfaceQueryRequest, DataSurfaceQueryResult, DataSurfaceRegistration, DataSurfaceRegistry, DataSurfaceRegistryEvent, DataSurfaceRowId, DataSurfaceSelectionReference, DataSurfaceSelectionScope, DataSurfaceSensitivity, DataSurfaceSnapshot, DataSurfaceSnapshotState, DataSurfaceSubject, DataSurfaceValidationReason, DataSurfaceValidationResult, DataSurfaceVisibleCommand, DataSurfaceVisibleControl, } from '@happyvertical/smrt-types';
|
|
268
11
|
/** Generic browser-transport ceiling for normalized command/action envelopes. */
|
|
269
12
|
export declare const DATA_SURFACE_MAX_REQUEST_BYTES = 100000;
|
|
270
13
|
/** Maximum length shared by every DataSurface protocol identifier. */
|
|
@@ -278,5 +21,4 @@ export declare function normalizeDataSurfaceQueryRequest(value: DataSurfaceQuery
|
|
|
278
21
|
export declare function normalizeDataSurfaceActionRequest(value: DataSurfaceActionRequest): DataSurfaceActionRequest;
|
|
279
22
|
/** Create an isolated registry; applications choose how it is exposed. */
|
|
280
23
|
export declare function createDataSurfaceRegistry(): DataSurfaceRegistry;
|
|
281
|
-
export {};
|
|
282
24
|
//# sourceMappingURL=data-surface.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"data-surface.d.ts","sourceRoot":"","sources":["../../../src/components/data/data-surface.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,
|
|
1
|
+
{"version":3,"file":"data-surface.d.ts","sourceRoot":"","sources":["../../../src/components/data/data-surface.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EACV,wBAAwB,EAOxB,qBAAqB,EAMrB,uBAAuB,EAEvB,mBAAmB,EAMnB,mBAAmB,EAGnB,yBAAyB,EAC1B,MAAM,2BAA2B,CAAC;AAGnC,YAAY,EACV,2BAA2B,EAC3B,wBAAwB,EACxB,uBAAuB,EACvB,2BAA2B,EAC3B,4BAA4B,EAC5B,2BAA2B,EAC3B,2BAA2B,EAC3B,0BAA0B,EAC1B,qBAAqB,EACrB,2BAA2B,EAC3B,2BAA2B,EAC3B,+BAA+B,EAC/B,wBAAwB,EACxB,qBAAqB,EACrB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,EACxB,oBAAoB,EACpB,eAAe,EACf,iBAAiB,EACjB,4BAA4B,EAC5B,oBAAoB,EACpB,uBAAuB,EACvB,sBAAsB,EACtB,uBAAuB,EACvB,mBAAmB,EACnB,wBAAwB,EACxB,gBAAgB,EAChB,6BAA6B,EAC7B,yBAAyB,EACzB,sBAAsB,EACtB,mBAAmB,EACnB,wBAAwB,EACxB,kBAAkB,EAClB,2BAA2B,EAC3B,2BAA2B,EAC3B,yBAAyB,EACzB,yBAAyB,GAC1B,MAAM,2BAA2B,CAAC;AAEnC,iFAAiF;AACjF,eAAO,MAAM,8BAA8B,SAAU,CAAC;AAEtD,sEAAsE;AACtE,eAAO,MAAM,kCAAkC,MAAM,CAAC;AAEtD,mEAAmE;AACnE,eAAO,MAAM,+BAA+B,MAAM,CAAC;AAypBnD,wBAAgB,8BAA8B,CAC5C,KAAK,EAAE,qBAAqB,GAC3B,qBAAqB,CAgSvB;AAED,wBAAgB,4BAA4B,CAC1C,KAAK,EAAE,mBAAmB,GACzB,mBAAmB,CAsBrB;AAED,wBAAgB,kCAAkC,CAChD,KAAK,EAAE,yBAAyB,GAC/B,yBAAyB,CAoC3B;AAED,wBAAgB,gCAAgC,CAC9C,KAAK,EAAE,uBAAuB,GAC7B,uBAAuB,CA+FzB;AAED,wBAAgB,iCAAiC,CAC/C,KAAK,EAAE,wBAAwB,GAC9B,wBAAwB,CAmD1B;AAmED,0EAA0E;AAC1E,wBAAgB,yBAAyB,IAAI,mBAAmB,CAka/D"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@happyvertical/smrt-ui",
|
|
3
|
-
"version": "0.49.
|
|
3
|
+
"version": "0.49.4",
|
|
4
4
|
"smrtJsdoc": "strict",
|
|
5
5
|
"description": "Domain-agnostic Svelte 5 UI runtime for SMRT: primitives, i18n client, theme system, and module UI registry",
|
|
6
6
|
"type": "module",
|
|
@@ -129,7 +129,7 @@
|
|
|
129
129
|
"access": "public"
|
|
130
130
|
},
|
|
131
131
|
"dependencies": {
|
|
132
|
-
"@happyvertical/smrt-types": "0.49.
|
|
132
|
+
"@happyvertical/smrt-types": "0.49.4",
|
|
133
133
|
"esm-env": "^1.2.2"
|
|
134
134
|
},
|
|
135
135
|
"peerDependencies": {
|