@ankhorage/runtime 0.3.0 → 1.1.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 +12 -0
- package/README.md +2 -2
- package/dist/RuntimeRenderer.d.ts +4 -1
- package/dist/RuntimeRenderer.d.ts.map +1 -1
- package/dist/RuntimeRenderer.js +32 -13
- package/dist/RuntimeRenderer.js.map +1 -1
- package/dist/RuntimeRendererConfig.d.ts +4 -1
- package/dist/RuntimeRendererConfig.d.ts.map +1 -1
- package/dist/RuntimeRendererConfig.js +2 -0
- package/dist/RuntimeRendererConfig.js.map +1 -1
- package/dist/RuntimeScreen.d.ts.map +1 -1
- package/dist/RuntimeScreen.js +5 -43
- package/dist/RuntimeScreen.js.map +1 -1
- package/dist/index.d.ts +2 -4
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -3
- package/dist/index.js.map +1 -1
- package/dist/readme-usage.js +1 -1
- package/dist/readme-usage.js.map +1 -1
- package/dist/runtimeDataSourceOperations.d.ts +3 -1
- package/dist/runtimeDataSourceOperations.d.ts.map +1 -1
- package/dist/runtimeDataSourceOperations.js +31 -26
- package/dist/runtimeDataSourceOperations.js.map +1 -1
- package/dist/runtimeDatabaseOperationExecutor.d.ts +9 -0
- package/dist/runtimeDatabaseOperationExecutor.d.ts.map +1 -0
- package/dist/runtimeDatabaseOperationExecutor.js +228 -0
- package/dist/runtimeDatabaseOperationExecutor.js.map +1 -0
- package/dist/runtimeMedia.d.ts +13 -0
- package/dist/runtimeMedia.d.ts.map +1 -0
- package/dist/runtimeMedia.js +80 -0
- package/dist/runtimeMedia.js.map +1 -0
- package/dist/runtimeMediaCache.d.ts +8 -0
- package/dist/runtimeMediaCache.d.ts.map +1 -0
- package/dist/runtimeMediaCache.js +14 -0
- package/dist/runtimeMediaCache.js.map +1 -0
- package/dist/runtimeScreenLoaders.d.ts +1 -2
- package/dist/runtimeScreenLoaders.d.ts.map +1 -1
- package/dist/runtimeScreenLoaders.js +1 -4
- package/dist/runtimeScreenLoaders.js.map +1 -1
- package/dist/useRuntimeMediaProps.d.ts +9 -0
- package/dist/useRuntimeMediaProps.d.ts.map +1 -0
- package/dist/useRuntimeMediaProps.js +61 -0
- package/dist/useRuntimeMediaProps.js.map +1 -0
- package/package.json +5 -4
- package/paradox/badges/npm.svg +3 -3
- package/paradox/components.md +5 -3
- package/paradox/diagrams/architecture-overview.mmd +23 -9
- package/paradox/diagrams/export-graph.mmd +14 -47
- package/paradox/diagrams/module-relationships.mmd +17 -7
- package/paradox/diagrams/sequences/runtime-screen.mmd +0 -3
- package/paradox/exports.json +136 -496
- package/paradox/exports.md +136 -278
- package/paradox/index.html +991 -1119
- package/paradox/paradox.json +1405 -1254
- package/dist/runtimeApiLoaders.d.ts +0 -35
- package/dist/runtimeApiLoaders.d.ts.map +0 -1
- package/dist/runtimeApiLoaders.js +0 -218
- package/dist/runtimeApiLoaders.js.map +0 -1
package/paradox/exports.md
CHANGED
|
@@ -10,7 +10,7 @@ Source: `src/componentRegistry.ts:3:1`
|
|
|
10
10
|
|
|
11
11
|
Kind: `function`
|
|
12
12
|
Module: `src/RuntimeRendererConfig.tsx`
|
|
13
|
-
Source: `src/RuntimeRendererConfig.tsx:
|
|
13
|
+
Source: `src/RuntimeRendererConfig.tsx:92:1`
|
|
14
14
|
|
|
15
15
|
### Signatures
|
|
16
16
|
|
|
@@ -23,7 +23,7 @@ Source: `src/RuntimeRendererConfig.tsx:88:1`
|
|
|
23
23
|
|
|
24
24
|
Kind: `function`
|
|
25
25
|
Module: `src/RuntimeRendererConfig.tsx`
|
|
26
|
-
Source: `src/RuntimeRendererConfig.tsx:
|
|
26
|
+
Source: `src/RuntimeRendererConfig.tsx:77:1`
|
|
27
27
|
|
|
28
28
|
### Signatures
|
|
29
29
|
|
|
@@ -84,7 +84,7 @@ Source: `src/runtimeDbPersist.ts:126:1`
|
|
|
84
84
|
|
|
85
85
|
Kind: `function`
|
|
86
86
|
Module: `src/runtimeScreenLoaders.ts`
|
|
87
|
-
Source: `src/runtimeScreenLoaders.ts:
|
|
87
|
+
Source: `src/runtimeScreenLoaders.ts:82:1`
|
|
88
88
|
|
|
89
89
|
### Signatures
|
|
90
90
|
|
|
@@ -120,7 +120,7 @@ Source: `src/runtimeBindings.ts:163:1`
|
|
|
120
120
|
|
|
121
121
|
Kind: `function`
|
|
122
122
|
Module: `src/runtimeDataSourceOperations.ts`
|
|
123
|
-
Source: `src/runtimeDataSourceOperations.ts:
|
|
123
|
+
Source: `src/runtimeDataSourceOperations.ts:14:1`
|
|
124
124
|
|
|
125
125
|
### Signatures
|
|
126
126
|
|
|
@@ -128,18 +128,6 @@ Source: `src/runtimeDataSourceOperations.ts:12:1`
|
|
|
128
128
|
- options: `RuntimeDataSourceOperationExecutorOptions`
|
|
129
129
|
- returns: `RuntimeBindingOperationExecutor`
|
|
130
130
|
|
|
131
|
-
## createRuntimeManifest
|
|
132
|
-
|
|
133
|
-
Kind: `function`
|
|
134
|
-
Module: `src/runtimeManifest.ts`
|
|
135
|
-
Source: `src/runtimeManifest.ts:81:1`
|
|
136
|
-
|
|
137
|
-
### Signatures
|
|
138
|
-
|
|
139
|
-
- `(input: RuntimeManifestInput) => RuntimeManifest`
|
|
140
|
-
- input: `RuntimeManifestInput`
|
|
141
|
-
- returns: `RuntimeManifest`
|
|
142
|
-
|
|
143
131
|
## createRuntimeMemoryStateAdapter
|
|
144
132
|
|
|
145
133
|
Kind: `function`
|
|
@@ -156,7 +144,7 @@ Source: `src/runtimeStateAdapter.ts:18:1`
|
|
|
156
144
|
|
|
157
145
|
Kind: `function`
|
|
158
146
|
Module: `src/runtimeScreenLoaders.ts`
|
|
159
|
-
Source: `src/runtimeScreenLoaders.ts:
|
|
147
|
+
Source: `src/runtimeScreenLoaders.ts:49:1`
|
|
160
148
|
|
|
161
149
|
### Signatures
|
|
162
150
|
|
|
@@ -164,42 +152,6 @@ Source: `src/runtimeScreenLoaders.ts:60:1`
|
|
|
164
152
|
- args: `{ readonly screenId: string; readonly loaders: readonly OperationScreenDataLoaderDefinition[]; readonly bindingContext?: Record<string, unknown>; readonly operationResults?: RuntimeBindingOperationResultCache; }`
|
|
165
153
|
- returns: `string`
|
|
166
154
|
|
|
167
|
-
## defineRuntimeAction
|
|
168
|
-
|
|
169
|
-
Kind: `function`
|
|
170
|
-
Module: `src/runtimeManifest.ts`
|
|
171
|
-
Source: `src/runtimeManifest.ts:63:1`
|
|
172
|
-
|
|
173
|
-
### Signatures
|
|
174
|
-
|
|
175
|
-
- `(action: RuntimeActionDescriptor<Data>) => RuntimeActionDescriptor<Data>`
|
|
176
|
-
- action: `RuntimeActionDescriptor<Data>`
|
|
177
|
-
- returns: `RuntimeActionDescriptor<Data>`
|
|
178
|
-
|
|
179
|
-
## defineRuntimeAdapter
|
|
180
|
-
|
|
181
|
-
Kind: `function`
|
|
182
|
-
Module: `src/runtimeManifest.ts`
|
|
183
|
-
Source: `src/runtimeManifest.ts:69:1`
|
|
184
|
-
|
|
185
|
-
### Signatures
|
|
186
|
-
|
|
187
|
-
- `(adapter: RuntimeAdapterDescriptor<Options>) => RuntimeAdapterDescriptor<Options>`
|
|
188
|
-
- adapter: `RuntimeAdapterDescriptor<Options>`
|
|
189
|
-
- returns: `RuntimeAdapterDescriptor<Options>`
|
|
190
|
-
|
|
191
|
-
## defineRuntimeBinding
|
|
192
|
-
|
|
193
|
-
Kind: `function`
|
|
194
|
-
Module: `src/runtimeManifest.ts`
|
|
195
|
-
Source: `src/runtimeManifest.ts:75:1`
|
|
196
|
-
|
|
197
|
-
### Signatures
|
|
198
|
-
|
|
199
|
-
- `(binding: RuntimeBindingDescriptor<Value>) => RuntimeBindingDescriptor<Value>`
|
|
200
|
-
- binding: `RuntimeBindingDescriptor<Value>`
|
|
201
|
-
- returns: `RuntimeBindingDescriptor<Value>`
|
|
202
|
-
|
|
203
155
|
## dispatchRuntimeComponentEvent
|
|
204
156
|
|
|
205
157
|
Kind: `function`
|
|
@@ -236,23 +188,11 @@ Source: `src/runtimeDbPersist.ts:48:1`
|
|
|
236
188
|
- args: `{ readonly dbAdapter: DbAdapter; readonly handlerArgs: RuntimeActionHandlerArgs; }`
|
|
237
189
|
- returns: `Promise<RuntimeDbPersistExecutionResult>`
|
|
238
190
|
|
|
239
|
-
## executeRuntimeApiLoaders
|
|
240
|
-
|
|
241
|
-
Kind: `function`
|
|
242
|
-
Module: `src/runtimeApiLoaders.ts`
|
|
243
|
-
Source: `src/runtimeApiLoaders.ts:100:1`
|
|
244
|
-
|
|
245
|
-
### Signatures
|
|
246
|
-
|
|
247
|
-
- `(args: { readonly data?: AppDataManifest; readonly loaders: readonly RuntimeApiLoaderDefinition[]; readonly stateAdapter: StateAdapter; }) => RuntimeApiLoaderExecutionResult`
|
|
248
|
-
- args: `{ readonly data?: AppDataManifest; readonly loaders: readonly RuntimeApiLoaderDefinition[]; readonly stateAdapter: StateAdapter; }`
|
|
249
|
-
- returns: `RuntimeApiLoaderExecutionResult`
|
|
250
|
-
|
|
251
191
|
## executeRuntimeScreenOperationLoaders
|
|
252
192
|
|
|
253
193
|
Kind: `function`
|
|
254
194
|
Module: `src/runtimeScreenLoaders.ts`
|
|
255
|
-
Source: `src/runtimeScreenLoaders.ts:
|
|
195
|
+
Source: `src/runtimeScreenLoaders.ts:178:1`
|
|
256
196
|
|
|
257
197
|
### Signatures
|
|
258
198
|
|
|
@@ -260,17 +200,6 @@ Source: `src/runtimeScreenLoaders.ts:189:1`
|
|
|
260
200
|
- args: `{ readonly bindingContext?: Record<string, unknown>; readonly dataSources?: RuntimeBindingResolutionContext["dataSources"]; readonly executeOperation?: RuntimeBindingOperationExecutor; readonly operationResults?: RuntimeBindingOperationResultCache; readonly screen: ScreenSpec; readonly loaders: readonly OperationScreenDataLoaderDefinition[]; }`
|
|
261
201
|
- returns: `Promise<RuntimeScreenOperationLoaderExecutionResult>`
|
|
262
202
|
|
|
263
|
-
## listRuntimeCapabilities
|
|
264
|
-
|
|
265
|
-
Kind: `function`
|
|
266
|
-
Module: `src/runtimeManifest.ts`
|
|
267
|
-
Source: `src/runtimeManifest.ts:93:1`
|
|
268
|
-
|
|
269
|
-
### Signatures
|
|
270
|
-
|
|
271
|
-
- `() => readonly ("runtime.render" | "runtime.actions" | "runtime.bindings" | "runtime.adapters")[]`
|
|
272
|
-
- returns: `readonly ("runtime.render" | "runtime.actions" | "runtime.bindings" | "runtime.adapters")[]`
|
|
273
|
-
|
|
274
203
|
## ManifestContext
|
|
275
204
|
|
|
276
205
|
Kind: `value`
|
|
@@ -289,23 +218,11 @@ Source: `src/ManifestContext.tsx:12:1`
|
|
|
289
218
|
- props: `ManifestContextValue & { children: React.ReactNode; }`
|
|
290
219
|
- returns: `React.JSX.Element`
|
|
291
220
|
|
|
292
|
-
## materializeRuntimeApiLoaderState
|
|
293
|
-
|
|
294
|
-
Kind: `function`
|
|
295
|
-
Module: `src/runtimeApiLoaders.ts`
|
|
296
|
-
Source: `src/runtimeApiLoaders.ts:40:1`
|
|
297
|
-
|
|
298
|
-
### Signatures
|
|
299
|
-
|
|
300
|
-
- `(args: { readonly data?: AppDataManifest; readonly loaders: readonly RuntimeApiLoaderDefinition[]; }) => RuntimeApiLoaderMaterializationResult`
|
|
301
|
-
- args: `{ readonly data?: AppDataManifest; readonly loaders: readonly RuntimeApiLoaderDefinition[]; }`
|
|
302
|
-
- returns: `RuntimeApiLoaderMaterializationResult`
|
|
303
|
-
|
|
304
221
|
## mergeRuntimeRendererConfig
|
|
305
222
|
|
|
306
223
|
Kind: `function`
|
|
307
224
|
Module: `src/RuntimeRendererConfig.tsx`
|
|
308
|
-
Source: `src/RuntimeRendererConfig.tsx:
|
|
225
|
+
Source: `src/RuntimeRendererConfig.tsx:110:1`
|
|
309
226
|
|
|
310
227
|
### Signatures
|
|
311
228
|
|
|
@@ -418,23 +335,11 @@ Source: `src/runtimeBindings.ts:116:1`
|
|
|
418
335
|
- diagnostics: `DataSourceDiagnostic[]` (optional)
|
|
419
336
|
- returns: `unknown`
|
|
420
337
|
|
|
421
|
-
## resolveScreenApiLoaders
|
|
422
|
-
|
|
423
|
-
Kind: `function`
|
|
424
|
-
Module: `src/runtimeScreenLoaders.ts`
|
|
425
|
-
Source: `src/runtimeScreenLoaders.ts:44:1`
|
|
426
|
-
|
|
427
|
-
### Signatures
|
|
428
|
-
|
|
429
|
-
- `(screen: ScreenSpec) => readonly ApiScreenDataLoaderDefinition[]`
|
|
430
|
-
- screen: `ScreenSpec`
|
|
431
|
-
- returns: `readonly ApiScreenDataLoaderDefinition[]`
|
|
432
|
-
|
|
433
338
|
## resolveScreenOperationLoaders
|
|
434
339
|
|
|
435
340
|
Kind: `function`
|
|
436
341
|
Module: `src/runtimeScreenLoaders.ts`
|
|
437
|
-
Source: `src/runtimeScreenLoaders.ts:
|
|
342
|
+
Source: `src/runtimeScreenLoaders.ts:43:1`
|
|
438
343
|
|
|
439
344
|
### Signatures
|
|
440
345
|
|
|
@@ -442,23 +347,11 @@ Source: `src/runtimeScreenLoaders.ts:52:1`
|
|
|
442
347
|
- screen: `ScreenSpec`
|
|
443
348
|
- returns: `readonly OperationScreenDataLoaderDefinition[]`
|
|
444
349
|
|
|
445
|
-
## RUNTIME_CAPABILITIES
|
|
446
|
-
|
|
447
|
-
Kind: `value`
|
|
448
|
-
Module: `src/runtimeManifest.ts`
|
|
449
|
-
Source: `src/runtimeManifest.ts:1:14`
|
|
450
|
-
|
|
451
|
-
## RUNTIME_MANIFEST_KIND
|
|
452
|
-
|
|
453
|
-
Kind: `value`
|
|
454
|
-
Module: `src/runtimeManifest.ts`
|
|
455
|
-
Source: `src/runtimeManifest.ts:8:14`
|
|
456
|
-
|
|
457
350
|
## RuntimeAction
|
|
458
351
|
|
|
459
352
|
Kind: `unknown`
|
|
460
353
|
Module: `src/RuntimeRendererConfig.tsx`
|
|
461
|
-
Source: `src/RuntimeRendererConfig.tsx:
|
|
354
|
+
Source: `src/RuntimeRendererConfig.tsx:45:1`
|
|
462
355
|
|
|
463
356
|
## RuntimeActionDescriptor
|
|
464
357
|
|
|
@@ -479,19 +372,19 @@ Source: `src/runtimeManifest.ts:24:1`
|
|
|
479
372
|
|
|
480
373
|
Kind: `unknown`
|
|
481
374
|
Module: `src/RuntimeRendererConfig.tsx`
|
|
482
|
-
Source: `src/RuntimeRendererConfig.tsx:
|
|
375
|
+
Source: `src/RuntimeRendererConfig.tsx:48:1`
|
|
483
376
|
|
|
484
377
|
## RuntimeActionHandler
|
|
485
378
|
|
|
486
379
|
Kind: `unknown`
|
|
487
380
|
Module: `src/RuntimeRendererConfig.tsx`
|
|
488
|
-
Source: `src/RuntimeRendererConfig.tsx:
|
|
381
|
+
Source: `src/RuntimeRendererConfig.tsx:46:1`
|
|
489
382
|
|
|
490
383
|
## RuntimeActionHandlerArgs
|
|
491
384
|
|
|
492
385
|
Kind: `type`
|
|
493
386
|
Module: `src/RuntimeRendererConfig.tsx`
|
|
494
|
-
Source: `src/RuntimeRendererConfig.tsx:
|
|
387
|
+
Source: `src/RuntimeRendererConfig.tsx:38:1`
|
|
495
388
|
|
|
496
389
|
### Members
|
|
497
390
|
|
|
@@ -506,7 +399,7 @@ Source: `src/RuntimeRendererConfig.tsx:36:1`
|
|
|
506
399
|
|
|
507
400
|
Kind: `unknown`
|
|
508
401
|
Module: `src/RuntimeRendererConfig.tsx`
|
|
509
|
-
Source: `src/RuntimeRendererConfig.tsx:
|
|
402
|
+
Source: `src/RuntimeRendererConfig.tsx:47:1`
|
|
510
403
|
|
|
511
404
|
## RuntimeActionRegistry
|
|
512
405
|
|
|
@@ -564,58 +457,6 @@ Source: `src/runtimeManifest.ts:39:1`
|
|
|
564
457
|
| kind | property | `string` | yes | |
|
|
565
458
|
| options | property | `Options \| undefined` | no | |
|
|
566
459
|
|
|
567
|
-
## RuntimeApiLoaderDefinition
|
|
568
|
-
|
|
569
|
-
Kind: `unknown`
|
|
570
|
-
Module: `src/runtimeApiLoaders.ts`
|
|
571
|
-
Source: `src/runtimeApiLoaders.ts:17:1`
|
|
572
|
-
|
|
573
|
-
## RuntimeApiLoaderDiagnostic
|
|
574
|
-
|
|
575
|
-
Kind: `type`
|
|
576
|
-
Module: `src/runtimeApiLoaders.ts`
|
|
577
|
-
Source: `src/runtimeApiLoaders.ts:19:1`
|
|
578
|
-
|
|
579
|
-
### Members
|
|
580
|
-
|
|
581
|
-
| Name | Kind | Type | Required | Description |
|
|
582
|
-
| ---------- | -------- | ---------------------------------------------------------------------------------------------------------- | -------- | ----------- |
|
|
583
|
-
| apiId | property | `string \| undefined` | no | |
|
|
584
|
-
| code | property | `"invalid-record" \| "missing-api" \| "missing-target-path" \| "state-set-failed" \| "unsupported-loader"` | yes | |
|
|
585
|
-
| message | property | `string` | yes | |
|
|
586
|
-
| targetPath | property | `string \| undefined` | no | |
|
|
587
|
-
|
|
588
|
-
## RuntimeApiLoaderExecutionResult
|
|
589
|
-
|
|
590
|
-
Kind: `type`
|
|
591
|
-
Module: `src/runtimeApiLoaders.ts`
|
|
592
|
-
Source: `src/runtimeApiLoaders.ts:31:1`
|
|
593
|
-
|
|
594
|
-
### Members
|
|
595
|
-
|
|
596
|
-
| Name | Kind | Type | Required | Description |
|
|
597
|
-
| ----------- | -------- | --------------------------------------- | -------- | ----------- |
|
|
598
|
-
| diagnostics | property | `readonly RuntimeApiLoaderDiagnostic[]` | yes | |
|
|
599
|
-
|
|
600
|
-
## RuntimeApiLoaderMaterializationResult
|
|
601
|
-
|
|
602
|
-
Kind: `type`
|
|
603
|
-
Module: `src/runtimeApiLoaders.ts`
|
|
604
|
-
Source: `src/runtimeApiLoaders.ts:35:1`
|
|
605
|
-
|
|
606
|
-
### Members
|
|
607
|
-
|
|
608
|
-
| Name | Kind | Type | Required | Description |
|
|
609
|
-
| ----------- | -------- | --------------------------------------- | -------- | ----------- |
|
|
610
|
-
| diagnostics | property | `readonly RuntimeApiLoaderDiagnostic[]` | yes | |
|
|
611
|
-
| state | property | `Readonly<Record<string, StateValue>>` | yes | |
|
|
612
|
-
|
|
613
|
-
## RuntimeApiLoaderMode
|
|
614
|
-
|
|
615
|
-
Kind: `unknown`
|
|
616
|
-
Module: `src/runtimeApiLoaders.ts`
|
|
617
|
-
Source: `src/runtimeApiLoaders.ts:15:1`
|
|
618
|
-
|
|
619
460
|
## RuntimeBindingDescriptor
|
|
620
461
|
|
|
621
462
|
Kind: `type`
|
|
@@ -686,17 +527,17 @@ Source: `src/runtimeBindings.ts:64:1`
|
|
|
686
527
|
|
|
687
528
|
### Members
|
|
688
529
|
|
|
689
|
-
| Name | Kind | Type
|
|
690
|
-
| ---------------- | -------- |
|
|
691
|
-
| context | property | `Record<string, unknown> \| undefined`
|
|
692
|
-
| dataBindings | property | `Readonly<Record<string, import("
|
|
693
|
-
| dataSources | property | `Readonly<Record<string, DataSourceConfig>> \| undefined`
|
|
694
|
-
| event | property | `ComponentEventDto<string, object> \| undefined`
|
|
695
|
-
| executeOperation | property | `RuntimeBindingOperationExecutor \| undefined`
|
|
696
|
-
| node | property | `UiNode`
|
|
697
|
-
| operationResults | property | `Readonly<Record<string, BindingValue \| undefined>> \| undefined`
|
|
698
|
-
| props | property | `Record<string, unknown>`
|
|
699
|
-
| stateAdapter | property | `StateAdapter \| undefined`
|
|
530
|
+
| Name | Kind | Type | Required | Description |
|
|
531
|
+
| ---------------- | -------- | ---------------------------------------------------------------------------------------------------------- | -------- | ----------- |
|
|
532
|
+
| context | property | `Record<string, unknown> \| undefined` | no | |
|
|
533
|
+
| dataBindings | property | `Readonly<Record<string, import("@ankhorage/contracts/dist/bindings").ComponentDataBinding>> \| undefined` | no | |
|
|
534
|
+
| dataSources | property | `Readonly<Record<string, DataSourceConfig>> \| undefined` | no | |
|
|
535
|
+
| event | property | `ComponentEventDto<string, object> \| undefined` | no | |
|
|
536
|
+
| executeOperation | property | `RuntimeBindingOperationExecutor \| undefined` | no | |
|
|
537
|
+
| node | property | `UiNode` | yes | |
|
|
538
|
+
| operationResults | property | `Readonly<Record<string, BindingValue \| undefined>> \| undefined` | no | |
|
|
539
|
+
| props | property | `Record<string, unknown>` | yes | |
|
|
540
|
+
| stateAdapter | property | `StateAdapter \| undefined` | no | |
|
|
700
541
|
|
|
701
542
|
## RuntimeBindingResolutionContext
|
|
702
543
|
|
|
@@ -706,15 +547,15 @@ Source: `src/runtimeBindings.ts:54:1`
|
|
|
706
547
|
|
|
707
548
|
### Members
|
|
708
549
|
|
|
709
|
-
| Name | Kind | Type
|
|
710
|
-
| ---------------- | -------- |
|
|
711
|
-
| context | property | `Record<string, unknown> \| undefined`
|
|
712
|
-
| dataBindings | property | `Readonly<Record<string, import("
|
|
713
|
-
| dataSources | property | `Readonly<Record<string, DataSourceConfig>> \| undefined`
|
|
714
|
-
| event | property | `ComponentEventDto<string, object> \| undefined`
|
|
715
|
-
| executeOperation | property | `RuntimeBindingOperationExecutor \| undefined`
|
|
716
|
-
| operationResults | property | `Readonly<Record<string, BindingValue \| undefined>> \| undefined`
|
|
717
|
-
| stateAdapter | property | `StateAdapter \| undefined`
|
|
550
|
+
| Name | Kind | Type | Required | Description |
|
|
551
|
+
| ---------------- | -------- | ---------------------------------------------------------------------------------------------------------- | -------- | ----------- |
|
|
552
|
+
| context | property | `Record<string, unknown> \| undefined` | no | |
|
|
553
|
+
| dataBindings | property | `Readonly<Record<string, import("@ankhorage/contracts/dist/bindings").ComponentDataBinding>> \| undefined` | no | |
|
|
554
|
+
| dataSources | property | `Readonly<Record<string, DataSourceConfig>> \| undefined` | no | |
|
|
555
|
+
| event | property | `ComponentEventDto<string, object> \| undefined` | no | |
|
|
556
|
+
| executeOperation | property | `RuntimeBindingOperationExecutor \| undefined` | no | |
|
|
557
|
+
| operationResults | property | `Readonly<Record<string, BindingValue \| undefined>> \| undefined` | no | |
|
|
558
|
+
| stateAdapter | property | `StateAdapter \| undefined` | no | |
|
|
718
559
|
|
|
719
560
|
## RuntimeBindingResolutionResult
|
|
720
561
|
|
|
@@ -743,32 +584,33 @@ Source: `src/runtimeActionRegistry.ts:46:1`
|
|
|
743
584
|
|
|
744
585
|
### Members
|
|
745
586
|
|
|
746
|
-
| Name | Kind | Type
|
|
747
|
-
| -------------------- | -------- |
|
|
748
|
-
| context | property | `Record<string, unknown> \| undefined`
|
|
749
|
-
| dataBindings | property | `Readonly<Record<string, import("
|
|
750
|
-
| dataSources | property | `Readonly<Record<string, DataSourceConfig>> \| undefined`
|
|
751
|
-
| event | property | `ComponentEventDto<string, object>`
|
|
752
|
-
| eventName | property | `string \| undefined`
|
|
753
|
-
| executeAction | property | `RuntimeActionHandler \| undefined`
|
|
754
|
-
| executeOperation | property | `RuntimeBindingOperationExecutor \| undefined`
|
|
755
|
-
| node | property | `UiNode`
|
|
756
|
-
| operationResults | property | `Readonly<Record<string, BindingValue \| undefined>> \| undefined`
|
|
757
|
-
| state | property | `Record<string, unknown> \| undefined`
|
|
758
|
-
| writeOperationResult | property | `RuntimeBindingOperationResultWriter \| undefined`
|
|
587
|
+
| Name | Kind | Type | Required | Description |
|
|
588
|
+
| -------------------- | -------- | ---------------------------------------------------------------------------------------------------------- | -------- | ----------- |
|
|
589
|
+
| context | property | `Record<string, unknown> \| undefined` | no | |
|
|
590
|
+
| dataBindings | property | `Readonly<Record<string, import("@ankhorage/contracts/dist/bindings").ComponentDataBinding>> \| undefined` | no | |
|
|
591
|
+
| dataSources | property | `Readonly<Record<string, DataSourceConfig>> \| undefined` | no | |
|
|
592
|
+
| event | property | `ComponentEventDto<string, object>` | yes | |
|
|
593
|
+
| eventName | property | `string \| undefined` | no | |
|
|
594
|
+
| executeAction | property | `RuntimeActionHandler \| undefined` | no | |
|
|
595
|
+
| executeOperation | property | `RuntimeBindingOperationExecutor \| undefined` | no | |
|
|
596
|
+
| node | property | `UiNode` | yes | |
|
|
597
|
+
| operationResults | property | `Readonly<Record<string, BindingValue \| undefined>> \| undefined` | no | |
|
|
598
|
+
| state | property | `Record<string, unknown> \| undefined` | no | |
|
|
599
|
+
| writeOperationResult | property | `RuntimeBindingOperationResultWriter \| undefined` | no | |
|
|
759
600
|
|
|
760
601
|
## RuntimeDataSourceOperationExecutorOptions
|
|
761
602
|
|
|
762
603
|
Kind: `type`
|
|
763
604
|
Module: `src/runtimeDataSourceOperations.ts`
|
|
764
|
-
Source: `src/runtimeDataSourceOperations.ts:
|
|
605
|
+
Source: `src/runtimeDataSourceOperations.ts:8:1`
|
|
765
606
|
|
|
766
607
|
### Members
|
|
767
608
|
|
|
768
|
-
| Name | Kind | Type
|
|
769
|
-
| ------------------ | -------- |
|
|
770
|
-
| credentialResolver | property | `EndpointTestCredentialResolver \| undefined`
|
|
771
|
-
|
|
|
609
|
+
| Name | Kind | Type | Required | Description |
|
|
610
|
+
| ------------------ | -------- | -------------------------------------------------- | -------- | ----------- |
|
|
611
|
+
| credentialResolver | property | `EndpointTestCredentialResolver \| undefined` | no | |
|
|
612
|
+
| databaseAdapters | property | `Readonly<Record<string, DbAdapter>> \| undefined` | no | |
|
|
613
|
+
| fetch | property | `EndpointTestFetch \| undefined` | no | |
|
|
772
614
|
|
|
773
615
|
## RuntimeDbPersistError
|
|
774
616
|
|
|
@@ -837,16 +679,16 @@ Source: `src/runtimeActionRegistry.ts:57:1`
|
|
|
837
679
|
|
|
838
680
|
### Members
|
|
839
681
|
|
|
840
|
-
| Name | Kind | Type
|
|
841
|
-
| ---------------------- | -------- |
|
|
842
|
-
| context | property | `Record<string, unknown> \| undefined`
|
|
843
|
-
| dataBindings | property | `Readonly<Record<string, import("
|
|
844
|
-
| disableActions | property | `boolean`
|
|
845
|
-
| dispatchComponentEvent | property | `(args: RuntimeComponentEventDispatchArgs) => Promise<void> \| void`
|
|
846
|
-
| node | property | `UiNode`
|
|
847
|
-
| operationResults | property | `Readonly<Record<string, BindingValue \| undefined>> \| undefined`
|
|
848
|
-
| props | property | `Record<string, unknown>`
|
|
849
|
-
| state | property | `Record<string, unknown> \| undefined`
|
|
682
|
+
| Name | Kind | Type | Required | Description |
|
|
683
|
+
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------- | -------- | ----------- |
|
|
684
|
+
| context | property | `Record<string, unknown> \| undefined` | no | |
|
|
685
|
+
| dataBindings | property | `Readonly<Record<string, import("@ankhorage/contracts/dist/bindings").ComponentDataBinding>> \| undefined` | no | |
|
|
686
|
+
| disableActions | property | `boolean` | yes | |
|
|
687
|
+
| dispatchComponentEvent | property | `(args: RuntimeComponentEventDispatchArgs) => Promise<void> \| void` | yes | |
|
|
688
|
+
| node | property | `UiNode` | yes | |
|
|
689
|
+
| operationResults | property | `Readonly<Record<string, BindingValue \| undefined>> \| undefined` | no | |
|
|
690
|
+
| props | property | `Record<string, unknown>` | yes | |
|
|
691
|
+
| state | property | `Record<string, unknown> \| undefined` | no | |
|
|
850
692
|
|
|
851
693
|
## RuntimeManifest
|
|
852
694
|
|
|
@@ -896,6 +738,24 @@ Source: `src/runtimeManifest.ts:55:1`
|
|
|
896
738
|
| config | property | `RuntimeManifestConfig` | yes | |
|
|
897
739
|
| diagnostics | property | `readonly RuntimeDiagnostic[] \| undefined` | no | |
|
|
898
740
|
|
|
741
|
+
## RuntimeMediaAssetResolver
|
|
742
|
+
|
|
743
|
+
Kind: `unknown`
|
|
744
|
+
Module: `src/runtimeMedia.ts`
|
|
745
|
+
Source: `src/runtimeMedia.ts:13:1`
|
|
746
|
+
|
|
747
|
+
## RuntimeMediaAssetResolverArgs
|
|
748
|
+
|
|
749
|
+
Kind: `type`
|
|
750
|
+
Module: `src/runtimeMedia.ts`
|
|
751
|
+
Source: `src/runtimeMedia.ts:9:1`
|
|
752
|
+
|
|
753
|
+
### Members
|
|
754
|
+
|
|
755
|
+
| Name | Kind | Type | Required | Description |
|
|
756
|
+
| ----- | -------- | ------------ | -------- | ----------- |
|
|
757
|
+
| asset | property | `MediaAsset` | yes | |
|
|
758
|
+
|
|
899
759
|
## RuntimeMemoryStateAdapterOptions
|
|
900
760
|
|
|
901
761
|
Kind: `type`
|
|
@@ -918,7 +778,7 @@ Source: `node_modules/@ankhorage/contracts/dist/runtimeCallbacks.d.ts:6:1`
|
|
|
918
778
|
|
|
919
779
|
Kind: `function`
|
|
920
780
|
Module: `src/RuntimeRenderer.tsx`
|
|
921
|
-
Source: `src/RuntimeRenderer.tsx:
|
|
781
|
+
Source: `src/RuntimeRenderer.tsx:76:1`
|
|
922
782
|
|
|
923
783
|
### Signatures
|
|
924
784
|
|
|
@@ -930,34 +790,36 @@ Source: `src/RuntimeRenderer.tsx:67:1`
|
|
|
930
790
|
|
|
931
791
|
Kind: `type`
|
|
932
792
|
Module: `src/RuntimeRendererConfig.tsx`
|
|
933
|
-
Source: `src/RuntimeRendererConfig.tsx:
|
|
793
|
+
Source: `src/RuntimeRendererConfig.tsx:50:1`
|
|
934
794
|
|
|
935
795
|
### Members
|
|
936
796
|
|
|
937
|
-
| Name | Kind | Type
|
|
938
|
-
| -------------------- | -------- |
|
|
939
|
-
| actionHandlers | property | `RuntimeActionHandlers \| undefined`
|
|
940
|
-
| bindingContext | property | `Record<string, unknown> \| undefined`
|
|
941
|
-
| dataBindings | property | `Readonly<Record<string, import("
|
|
942
|
-
| dataSources | property | `Readonly<Record<string, import("
|
|
943
|
-
| dbAdapter | property | `DbAdapter \| undefined`
|
|
944
|
-
| dbRealtimeAdapter | property | `DbRealtimeAdapter \| undefined`
|
|
945
|
-
| disableActions | property | `boolean \| undefined`
|
|
946
|
-
| executeAction | property | `RuntimeActionHandler \| undefined`
|
|
947
|
-
| executeOperation | property | `RuntimeBindingOperationExecutor \| undefined`
|
|
948
|
-
|
|
|
949
|
-
|
|
|
950
|
-
|
|
|
951
|
-
|
|
|
952
|
-
|
|
|
953
|
-
|
|
|
954
|
-
|
|
|
797
|
+
| Name | Kind | Type | Required | Description |
|
|
798
|
+
| -------------------- | -------- | --------------------------------------------------------------------------------------------------------------- | -------- | ----------- |
|
|
799
|
+
| actionHandlers | property | `RuntimeActionHandlers \| undefined` | no | |
|
|
800
|
+
| bindingContext | property | `Record<string, unknown> \| undefined` | no | |
|
|
801
|
+
| dataBindings | property | `Readonly<Record<string, import("@ankhorage/contracts/dist/bindings").ComponentDataBinding>> \| undefined` | no | |
|
|
802
|
+
| dataSources | property | `Readonly<Record<string, import("@ankhorage/contracts/dist/index").DataSourceConfig>> \| undefined` | no | |
|
|
803
|
+
| dbAdapter | property | `DbAdapter \| undefined` | no | |
|
|
804
|
+
| dbRealtimeAdapter | property | `DbRealtimeAdapter \| undefined` | no | |
|
|
805
|
+
| disableActions | property | `boolean \| undefined` | no | |
|
|
806
|
+
| executeAction | property | `RuntimeActionHandler \| undefined` | no | |
|
|
807
|
+
| executeOperation | property | `RuntimeBindingOperationExecutor \| undefined` | no | |
|
|
808
|
+
| mediaAssets | property | `Readonly<Record<string, import("@ankhorage/contracts/dist/media").MediaAsset>> \| undefined` | no | |
|
|
809
|
+
| onDiagnostics | property | `((diagnostics: readonly DataSourceDiagnostic[]) => void) \| undefined` | no | |
|
|
810
|
+
| operationResults | property | `Readonly<Record<string, import("@ankhorage/contracts/dist/bindings").BindingValue \| undefined>> \| undefined` | no | |
|
|
811
|
+
| registry | property | `Readonly<Record<string, React.ElementType<any, keyof React.JSX.IntrinsicElements>>> \| undefined` | no | |
|
|
812
|
+
| resolveMediaAsset | property | `RuntimeMediaAssetResolver \| undefined` | no | |
|
|
813
|
+
| resolveNodeProps | property | `RuntimeNodePropsResolver \| undefined` | no | |
|
|
814
|
+
| stateAdapter | property | `StateAdapter \| undefined` | no | |
|
|
815
|
+
| wrapNode | property | `((args: RuntimeRendererWrapArgs) => React.ReactNode) \| undefined` | no | |
|
|
816
|
+
| writeOperationResult | property | `RuntimeBindingOperationResultWriter \| undefined` | no | |
|
|
955
817
|
|
|
956
818
|
## RuntimeRendererConfigProvider
|
|
957
819
|
|
|
958
820
|
Kind: `function`
|
|
959
821
|
Module: `src/RuntimeRendererConfig.tsx`
|
|
960
|
-
Source: `src/RuntimeRendererConfig.tsx:
|
|
822
|
+
Source: `src/RuntimeRendererConfig.tsx:158:1`
|
|
961
823
|
|
|
962
824
|
### Signatures
|
|
963
825
|
|
|
@@ -969,33 +831,35 @@ Source: `src/RuntimeRendererConfig.tsx:152:1`
|
|
|
969
831
|
|
|
970
832
|
Kind: `type`
|
|
971
833
|
Module: `src/RuntimeRenderer.tsx`
|
|
972
|
-
Source: `src/RuntimeRenderer.tsx:
|
|
834
|
+
Source: `src/RuntimeRenderer.tsx:56:1`
|
|
973
835
|
|
|
974
836
|
### Members
|
|
975
837
|
|
|
976
|
-
| Name | Kind | Type
|
|
977
|
-
| ----------------- | -------- |
|
|
978
|
-
| bindingContext | property | `Record<string, unknown> \| undefined`
|
|
979
|
-
| dataBindings | property | `Readonly<Record<string, import("
|
|
980
|
-
| dataSources | property | `Readonly<Record<string, import("
|
|
981
|
-
| dbAdapter | property | `DbAdapter \| undefined`
|
|
982
|
-
| dbRealtimeAdapter | property | `DbRealtimeAdapter \| undefined`
|
|
983
|
-
| disableActions | property | `boolean \| undefined`
|
|
984
|
-
| executeAction | property | `import("
|
|
985
|
-
| executeOperation | property | `RuntimeBindingOperationExecutor \| undefined`
|
|
986
|
-
| isRoot | property | `boolean \| undefined`
|
|
987
|
-
|
|
|
988
|
-
|
|
|
989
|
-
|
|
|
990
|
-
|
|
|
991
|
-
|
|
|
992
|
-
|
|
|
838
|
+
| Name | Kind | Type | Required | Description |
|
|
839
|
+
| ----------------- | -------- | ---------------------------------------------------------------------------------------------------------- | -------- | ----------- |
|
|
840
|
+
| bindingContext | property | `Record<string, unknown> \| undefined` | no | |
|
|
841
|
+
| dataBindings | property | `Readonly<Record<string, import("@ankhorage/contracts/dist/bindings").ComponentDataBinding>> \| undefined` | no | |
|
|
842
|
+
| dataSources | property | `Readonly<Record<string, import("@ankhorage/contracts/dist/index").DataSourceConfig>> \| undefined` | no | |
|
|
843
|
+
| dbAdapter | property | `DbAdapter \| undefined` | no | |
|
|
844
|
+
| dbRealtimeAdapter | property | `DbRealtimeAdapter \| undefined` | no | |
|
|
845
|
+
| disableActions | property | `boolean \| undefined` | no | |
|
|
846
|
+
| executeAction | property | `import("./src/RuntimeRendererConfig").RuntimeActionHandler \| undefined` | no | |
|
|
847
|
+
| executeOperation | property | `RuntimeBindingOperationExecutor \| undefined` | no | |
|
|
848
|
+
| isRoot | property | `boolean \| undefined` | no | |
|
|
849
|
+
| mediaAssets | property | `Readonly<Record<string, import("@ankhorage/contracts/dist/media").MediaAsset>> \| undefined` | no | |
|
|
850
|
+
| node | property | `UiNode` | yes | |
|
|
851
|
+
| onDiagnostics | property | `((diagnostics: readonly DataSourceDiagnostic[]) => void) \| undefined` | no | |
|
|
852
|
+
| operationResults | property | `Readonly<Record<string, BindingValue \| undefined>> \| undefined` | no | |
|
|
853
|
+
| registry | property | `Readonly<Record<string, React.ElementType<any, keyof React.JSX.IntrinsicElements>>> \| undefined` | no | |
|
|
854
|
+
| resolveMediaAsset | property | `RuntimeMediaAssetResolver \| undefined` | no | |
|
|
855
|
+
| stateAdapter | property | `StateAdapter \| undefined` | no | |
|
|
856
|
+
| wrapNode | property | `((args: RuntimeRendererWrapArgs) => React.ReactNode) \| undefined` | no | |
|
|
993
857
|
|
|
994
858
|
## RuntimeRendererWrapArgs
|
|
995
859
|
|
|
996
860
|
Kind: `type`
|
|
997
861
|
Module: `src/RuntimeRendererConfig.tsx`
|
|
998
|
-
Source: `src/RuntimeRendererConfig.tsx:
|
|
862
|
+
Source: `src/RuntimeRendererConfig.tsx:32:1`
|
|
999
863
|
|
|
1000
864
|
### Members
|
|
1001
865
|
|
|
@@ -1005,6 +869,12 @@ Source: `src/RuntimeRendererConfig.tsx:30:1`
|
|
|
1005
869
|
| node | property | `UiNode` | yes | |
|
|
1006
870
|
| rendered | property | `React.ReactNode` | yes | |
|
|
1007
871
|
|
|
872
|
+
## RuntimeResolvedMediaValue
|
|
873
|
+
|
|
874
|
+
Kind: `unknown`
|
|
875
|
+
Module: `src/runtimeMedia.ts`
|
|
876
|
+
Source: `src/runtimeMedia.ts:7:1`
|
|
877
|
+
|
|
1008
878
|
## RuntimeResolveNodePropsArgs
|
|
1009
879
|
|
|
1010
880
|
Kind: `type`
|
|
@@ -1022,7 +892,7 @@ Source: `node_modules/@ankhorage/contracts/dist/runtimeCallbacks.d.ts:2:1`
|
|
|
1022
892
|
|
|
1023
893
|
Kind: `function`
|
|
1024
894
|
Module: `src/RuntimeScreen.tsx`
|
|
1025
|
-
Source: `src/RuntimeScreen.tsx:
|
|
895
|
+
Source: `src/RuntimeScreen.tsx:17:1`
|
|
1026
896
|
|
|
1027
897
|
### Signatures
|
|
1028
898
|
|
|
@@ -1034,7 +904,7 @@ Source: `src/RuntimeScreen.tsx:24:1`
|
|
|
1034
904
|
|
|
1035
905
|
Kind: `type`
|
|
1036
906
|
Module: `src/runtimeScreenLoaders.ts`
|
|
1037
|
-
Source: `src/runtimeScreenLoaders.ts:
|
|
907
|
+
Source: `src/runtimeScreenLoaders.ts:25:1`
|
|
1038
908
|
|
|
1039
909
|
### Members
|
|
1040
910
|
|
|
@@ -1048,7 +918,7 @@ Source: `src/runtimeScreenLoaders.ts:26:1`
|
|
|
1048
918
|
|
|
1049
919
|
Kind: `type`
|
|
1050
920
|
Module: `src/runtimeScreenLoaders.ts`
|
|
1051
|
-
Source: `src/runtimeScreenLoaders.ts:
|
|
921
|
+
Source: `src/runtimeScreenLoaders.ts:18:1`
|
|
1052
922
|
|
|
1053
923
|
### Members
|
|
1054
924
|
|
|
@@ -1063,7 +933,7 @@ Source: `src/runtimeScreenLoaders.ts:19:1`
|
|
|
1063
933
|
|
|
1064
934
|
Kind: `type`
|
|
1065
935
|
Module: `src/RuntimeScreen.tsx`
|
|
1066
|
-
Source: `src/RuntimeScreen.tsx:
|
|
936
|
+
Source: `src/RuntimeScreen.tsx:10:1`
|
|
1067
937
|
|
|
1068
938
|
### Members
|
|
1069
939
|
|
|
@@ -1119,23 +989,11 @@ Source: `src/ManifestContext.tsx:38:1`
|
|
|
1119
989
|
- `() => ManifestContextValue | null`
|
|
1120
990
|
- returns: `ManifestContextValue | null`
|
|
1121
991
|
|
|
1122
|
-
## useRuntimeApiStateLoaders
|
|
1123
|
-
|
|
1124
|
-
Kind: `function`
|
|
1125
|
-
Module: `src/runtimeApiLoaders.ts`
|
|
1126
|
-
Source: `src/runtimeApiLoaders.ts:125:1`
|
|
1127
|
-
|
|
1128
|
-
### Signatures
|
|
1129
|
-
|
|
1130
|
-
- `(args: { readonly data?: AppDataManifest; readonly loaders?: readonly RuntimeApiLoaderDefinition[]; readonly stateAdapter?: StateAdapter; }) => { readonly diagnostics: readonly RuntimeApiLoaderDiagnostic[]; readonly stateAdapter: StateAdapter; readonly stateVersion: number; }`
|
|
1131
|
-
- args: `{ readonly data?: AppDataManifest; readonly loaders?: readonly RuntimeApiLoaderDefinition[]; readonly stateAdapter?: StateAdapter; }`
|
|
1132
|
-
- returns: `{ readonly diagnostics: readonly RuntimeApiLoaderDiagnostic[]; readonly stateAdapter: StateAdapter; readonly stateVersion: number; }`
|
|
1133
|
-
|
|
1134
992
|
## useRuntimeRendererConfig
|
|
1135
993
|
|
|
1136
994
|
Kind: `function`
|
|
1137
995
|
Module: `src/RuntimeRendererConfig.tsx`
|
|
1138
|
-
Source: `src/RuntimeRendererConfig.tsx:
|
|
996
|
+
Source: `src/RuntimeRendererConfig.tsx:173:1`
|
|
1139
997
|
|
|
1140
998
|
### Signatures
|
|
1141
999
|
|
|
@@ -1146,7 +1004,7 @@ Source: `src/RuntimeRendererConfig.tsx:167:1`
|
|
|
1146
1004
|
|
|
1147
1005
|
Kind: `function`
|
|
1148
1006
|
Module: `src/runtimeScreenLoaders.ts`
|
|
1149
|
-
Source: `src/runtimeScreenLoaders.ts:
|
|
1007
|
+
Source: `src/runtimeScreenLoaders.ts:273:1`
|
|
1150
1008
|
|
|
1151
1009
|
### Signatures
|
|
1152
1010
|
|