@ankhorage/runtime 0.2.4 → 1.0.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 +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 +2 -3
- package/dist/index.js.map +1 -1
- package/dist/registry.d.ts +0 -1
- package/dist/registry.d.ts.map +1 -1
- package/dist/registry.js +0 -1
- package/dist/registry.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/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/package.json +3 -3
- package/paradox/badges/npm.svg +3 -3
- package/paradox/components.md +1 -1
- package/paradox/diagrams/architecture-overview.mmd +5 -12
- package/paradox/diagrams/export-graph.mmd +1 -31
- package/paradox/diagrams/module-relationships.mmd +4 -9
- package/paradox/diagrams/sequences/runtime-screen.mmd +0 -3
- package/paradox/exports.json +30 -311
- package/paradox/exports.md +94 -199
- package/paradox/index.html +382 -744
- package/paradox/paradox.json +685 -928
- package/dist/appExtensionRegistry.d.ts +0 -3
- package/dist/appExtensionRegistry.d.ts.map +0 -1
- package/dist/appExtensionRegistry.js +0 -2
- package/dist/appExtensionRegistry.js.map +0 -1
- 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
|
@@ -1,11 +1,5 @@
|
|
|
1
1
|
# Public API
|
|
2
2
|
|
|
3
|
-
## APP_EXTENSION_COMPONENT_REGISTRY
|
|
4
|
-
|
|
5
|
-
Kind: `value`
|
|
6
|
-
Module: `src/appExtensionRegistry.ts`
|
|
7
|
-
Source: `src/appExtensionRegistry.ts:3:14`
|
|
8
|
-
|
|
9
3
|
## ComponentRegistry
|
|
10
4
|
|
|
11
5
|
Kind: `unknown`
|
|
@@ -90,7 +84,7 @@ Source: `src/runtimeDbPersist.ts:126:1`
|
|
|
90
84
|
|
|
91
85
|
Kind: `function`
|
|
92
86
|
Module: `src/runtimeScreenLoaders.ts`
|
|
93
|
-
Source: `src/runtimeScreenLoaders.ts:
|
|
87
|
+
Source: `src/runtimeScreenLoaders.ts:82:1`
|
|
94
88
|
|
|
95
89
|
### Signatures
|
|
96
90
|
|
|
@@ -126,7 +120,7 @@ Source: `src/runtimeBindings.ts:163:1`
|
|
|
126
120
|
|
|
127
121
|
Kind: `function`
|
|
128
122
|
Module: `src/runtimeDataSourceOperations.ts`
|
|
129
|
-
Source: `src/runtimeDataSourceOperations.ts:
|
|
123
|
+
Source: `src/runtimeDataSourceOperations.ts:14:1`
|
|
130
124
|
|
|
131
125
|
### Signatures
|
|
132
126
|
|
|
@@ -162,7 +156,7 @@ Source: `src/runtimeStateAdapter.ts:18:1`
|
|
|
162
156
|
|
|
163
157
|
Kind: `function`
|
|
164
158
|
Module: `src/runtimeScreenLoaders.ts`
|
|
165
|
-
Source: `src/runtimeScreenLoaders.ts:
|
|
159
|
+
Source: `src/runtimeScreenLoaders.ts:49:1`
|
|
166
160
|
|
|
167
161
|
### Signatures
|
|
168
162
|
|
|
@@ -242,23 +236,11 @@ Source: `src/runtimeDbPersist.ts:48:1`
|
|
|
242
236
|
- args: `{ readonly dbAdapter: DbAdapter; readonly handlerArgs: RuntimeActionHandlerArgs; }`
|
|
243
237
|
- returns: `Promise<RuntimeDbPersistExecutionResult>`
|
|
244
238
|
|
|
245
|
-
## executeRuntimeApiLoaders
|
|
246
|
-
|
|
247
|
-
Kind: `function`
|
|
248
|
-
Module: `src/runtimeApiLoaders.ts`
|
|
249
|
-
Source: `src/runtimeApiLoaders.ts:100:1`
|
|
250
|
-
|
|
251
|
-
### Signatures
|
|
252
|
-
|
|
253
|
-
- `(args: { readonly data?: AppDataManifest; readonly loaders: readonly RuntimeApiLoaderDefinition[]; readonly stateAdapter: StateAdapter; }) => RuntimeApiLoaderExecutionResult`
|
|
254
|
-
- args: `{ readonly data?: AppDataManifest; readonly loaders: readonly RuntimeApiLoaderDefinition[]; readonly stateAdapter: StateAdapter; }`
|
|
255
|
-
- returns: `RuntimeApiLoaderExecutionResult`
|
|
256
|
-
|
|
257
239
|
## executeRuntimeScreenOperationLoaders
|
|
258
240
|
|
|
259
241
|
Kind: `function`
|
|
260
242
|
Module: `src/runtimeScreenLoaders.ts`
|
|
261
|
-
Source: `src/runtimeScreenLoaders.ts:
|
|
243
|
+
Source: `src/runtimeScreenLoaders.ts:178:1`
|
|
262
244
|
|
|
263
245
|
### Signatures
|
|
264
246
|
|
|
@@ -295,18 +277,6 @@ Source: `src/ManifestContext.tsx:12:1`
|
|
|
295
277
|
- props: `ManifestContextValue & { children: React.ReactNode; }`
|
|
296
278
|
- returns: `React.JSX.Element`
|
|
297
279
|
|
|
298
|
-
## materializeRuntimeApiLoaderState
|
|
299
|
-
|
|
300
|
-
Kind: `function`
|
|
301
|
-
Module: `src/runtimeApiLoaders.ts`
|
|
302
|
-
Source: `src/runtimeApiLoaders.ts:40:1`
|
|
303
|
-
|
|
304
|
-
### Signatures
|
|
305
|
-
|
|
306
|
-
- `(args: { readonly data?: AppDataManifest; readonly loaders: readonly RuntimeApiLoaderDefinition[]; }) => RuntimeApiLoaderMaterializationResult`
|
|
307
|
-
- args: `{ readonly data?: AppDataManifest; readonly loaders: readonly RuntimeApiLoaderDefinition[]; }`
|
|
308
|
-
- returns: `RuntimeApiLoaderMaterializationResult`
|
|
309
|
-
|
|
310
280
|
## mergeRuntimeRendererConfig
|
|
311
281
|
|
|
312
282
|
Kind: `function`
|
|
@@ -424,23 +394,11 @@ Source: `src/runtimeBindings.ts:116:1`
|
|
|
424
394
|
- diagnostics: `DataSourceDiagnostic[]` (optional)
|
|
425
395
|
- returns: `unknown`
|
|
426
396
|
|
|
427
|
-
## resolveScreenApiLoaders
|
|
428
|
-
|
|
429
|
-
Kind: `function`
|
|
430
|
-
Module: `src/runtimeScreenLoaders.ts`
|
|
431
|
-
Source: `src/runtimeScreenLoaders.ts:44:1`
|
|
432
|
-
|
|
433
|
-
### Signatures
|
|
434
|
-
|
|
435
|
-
- `(screen: ScreenSpec) => readonly ApiScreenDataLoaderDefinition[]`
|
|
436
|
-
- screen: `ScreenSpec`
|
|
437
|
-
- returns: `readonly ApiScreenDataLoaderDefinition[]`
|
|
438
|
-
|
|
439
397
|
## resolveScreenOperationLoaders
|
|
440
398
|
|
|
441
399
|
Kind: `function`
|
|
442
400
|
Module: `src/runtimeScreenLoaders.ts`
|
|
443
|
-
Source: `src/runtimeScreenLoaders.ts:
|
|
401
|
+
Source: `src/runtimeScreenLoaders.ts:43:1`
|
|
444
402
|
|
|
445
403
|
### Signatures
|
|
446
404
|
|
|
@@ -570,58 +528,6 @@ Source: `src/runtimeManifest.ts:39:1`
|
|
|
570
528
|
| kind | property | `string` | yes | |
|
|
571
529
|
| options | property | `Options \| undefined` | no | |
|
|
572
530
|
|
|
573
|
-
## RuntimeApiLoaderDefinition
|
|
574
|
-
|
|
575
|
-
Kind: `unknown`
|
|
576
|
-
Module: `src/runtimeApiLoaders.ts`
|
|
577
|
-
Source: `src/runtimeApiLoaders.ts:17:1`
|
|
578
|
-
|
|
579
|
-
## RuntimeApiLoaderDiagnostic
|
|
580
|
-
|
|
581
|
-
Kind: `type`
|
|
582
|
-
Module: `src/runtimeApiLoaders.ts`
|
|
583
|
-
Source: `src/runtimeApiLoaders.ts:19:1`
|
|
584
|
-
|
|
585
|
-
### Members
|
|
586
|
-
|
|
587
|
-
| Name | Kind | Type | Required | Description |
|
|
588
|
-
| ---------- | -------- | ---------------------------------------------------------------------------------------------------------- | -------- | ----------- |
|
|
589
|
-
| apiId | property | `string \| undefined` | no | |
|
|
590
|
-
| code | property | `"invalid-record" \| "missing-api" \| "missing-target-path" \| "state-set-failed" \| "unsupported-loader"` | yes | |
|
|
591
|
-
| message | property | `string` | yes | |
|
|
592
|
-
| targetPath | property | `string \| undefined` | no | |
|
|
593
|
-
|
|
594
|
-
## RuntimeApiLoaderExecutionResult
|
|
595
|
-
|
|
596
|
-
Kind: `type`
|
|
597
|
-
Module: `src/runtimeApiLoaders.ts`
|
|
598
|
-
Source: `src/runtimeApiLoaders.ts:31:1`
|
|
599
|
-
|
|
600
|
-
### Members
|
|
601
|
-
|
|
602
|
-
| Name | Kind | Type | Required | Description |
|
|
603
|
-
| ----------- | -------- | --------------------------------------- | -------- | ----------- |
|
|
604
|
-
| diagnostics | property | `readonly RuntimeApiLoaderDiagnostic[]` | yes | |
|
|
605
|
-
|
|
606
|
-
## RuntimeApiLoaderMaterializationResult
|
|
607
|
-
|
|
608
|
-
Kind: `type`
|
|
609
|
-
Module: `src/runtimeApiLoaders.ts`
|
|
610
|
-
Source: `src/runtimeApiLoaders.ts:35:1`
|
|
611
|
-
|
|
612
|
-
### Members
|
|
613
|
-
|
|
614
|
-
| Name | Kind | Type | Required | Description |
|
|
615
|
-
| ----------- | -------- | --------------------------------------- | -------- | ----------- |
|
|
616
|
-
| diagnostics | property | `readonly RuntimeApiLoaderDiagnostic[]` | yes | |
|
|
617
|
-
| state | property | `Readonly<Record<string, StateValue>>` | yes | |
|
|
618
|
-
|
|
619
|
-
## RuntimeApiLoaderMode
|
|
620
|
-
|
|
621
|
-
Kind: `unknown`
|
|
622
|
-
Module: `src/runtimeApiLoaders.ts`
|
|
623
|
-
Source: `src/runtimeApiLoaders.ts:15:1`
|
|
624
|
-
|
|
625
531
|
## RuntimeBindingDescriptor
|
|
626
532
|
|
|
627
533
|
Kind: `type`
|
|
@@ -692,17 +598,17 @@ Source: `src/runtimeBindings.ts:64:1`
|
|
|
692
598
|
|
|
693
599
|
### Members
|
|
694
600
|
|
|
695
|
-
| Name | Kind | Type
|
|
696
|
-
| ---------------- | -------- |
|
|
697
|
-
| context | property | `Record<string, unknown> \| undefined`
|
|
698
|
-
| dataBindings | property | `Readonly<Record<string, import("/
|
|
699
|
-
| dataSources | property | `Readonly<Record<string, DataSourceConfig>> \| undefined`
|
|
700
|
-
| event | property | `ComponentEventDto<string, object> \| undefined`
|
|
701
|
-
| executeOperation | property | `RuntimeBindingOperationExecutor \| undefined`
|
|
702
|
-
| node | property | `UiNode`
|
|
703
|
-
| operationResults | property | `Readonly<Record<string, BindingValue \| undefined>> \| undefined`
|
|
704
|
-
| props | property | `Record<string, unknown>`
|
|
705
|
-
| stateAdapter | property | `StateAdapter \| undefined`
|
|
601
|
+
| Name | Kind | Type | Required | Description |
|
|
602
|
+
| ---------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------- |
|
|
603
|
+
| context | property | `Record<string, unknown> \| undefined` | no | |
|
|
604
|
+
| dataBindings | property | `Readonly<Record<string, import("/home/runner/work/runtime/runtime/node_modules/@ankhorage/contracts/dist/bindings").ComponentDataBinding>> \| undefined` | no | |
|
|
605
|
+
| dataSources | property | `Readonly<Record<string, DataSourceConfig>> \| undefined` | no | |
|
|
606
|
+
| event | property | `ComponentEventDto<string, object> \| undefined` | no | |
|
|
607
|
+
| executeOperation | property | `RuntimeBindingOperationExecutor \| undefined` | no | |
|
|
608
|
+
| node | property | `UiNode` | yes | |
|
|
609
|
+
| operationResults | property | `Readonly<Record<string, BindingValue \| undefined>> \| undefined` | no | |
|
|
610
|
+
| props | property | `Record<string, unknown>` | yes | |
|
|
611
|
+
| stateAdapter | property | `StateAdapter \| undefined` | no | |
|
|
706
612
|
|
|
707
613
|
## RuntimeBindingResolutionContext
|
|
708
614
|
|
|
@@ -712,15 +618,15 @@ Source: `src/runtimeBindings.ts:54:1`
|
|
|
712
618
|
|
|
713
619
|
### Members
|
|
714
620
|
|
|
715
|
-
| Name | Kind | Type
|
|
716
|
-
| ---------------- | -------- |
|
|
717
|
-
| context | property | `Record<string, unknown> \| undefined`
|
|
718
|
-
| dataBindings | property | `Readonly<Record<string, import("/
|
|
719
|
-
| dataSources | property | `Readonly<Record<string, DataSourceConfig>> \| undefined`
|
|
720
|
-
| event | property | `ComponentEventDto<string, object> \| undefined`
|
|
721
|
-
| executeOperation | property | `RuntimeBindingOperationExecutor \| undefined`
|
|
722
|
-
| operationResults | property | `Readonly<Record<string, BindingValue \| undefined>> \| undefined`
|
|
723
|
-
| stateAdapter | property | `StateAdapter \| undefined`
|
|
621
|
+
| Name | Kind | Type | Required | Description |
|
|
622
|
+
| ---------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------- |
|
|
623
|
+
| context | property | `Record<string, unknown> \| undefined` | no | |
|
|
624
|
+
| dataBindings | property | `Readonly<Record<string, import("/home/runner/work/runtime/runtime/node_modules/@ankhorage/contracts/dist/bindings").ComponentDataBinding>> \| undefined` | no | |
|
|
625
|
+
| dataSources | property | `Readonly<Record<string, DataSourceConfig>> \| undefined` | no | |
|
|
626
|
+
| event | property | `ComponentEventDto<string, object> \| undefined` | no | |
|
|
627
|
+
| executeOperation | property | `RuntimeBindingOperationExecutor \| undefined` | no | |
|
|
628
|
+
| operationResults | property | `Readonly<Record<string, BindingValue \| undefined>> \| undefined` | no | |
|
|
629
|
+
| stateAdapter | property | `StateAdapter \| undefined` | no | |
|
|
724
630
|
|
|
725
631
|
## RuntimeBindingResolutionResult
|
|
726
632
|
|
|
@@ -749,32 +655,33 @@ Source: `src/runtimeActionRegistry.ts:46:1`
|
|
|
749
655
|
|
|
750
656
|
### Members
|
|
751
657
|
|
|
752
|
-
| Name | Kind | Type
|
|
753
|
-
| -------------------- | -------- |
|
|
754
|
-
| context | property | `Record<string, unknown> \| undefined`
|
|
755
|
-
| dataBindings | property | `Readonly<Record<string, import("/
|
|
756
|
-
| dataSources | property | `Readonly<Record<string, DataSourceConfig>> \| undefined`
|
|
757
|
-
| event | property | `ComponentEventDto<string, object>`
|
|
758
|
-
| eventName | property | `string \| undefined`
|
|
759
|
-
| executeAction | property | `RuntimeActionHandler \| undefined`
|
|
760
|
-
| executeOperation | property | `RuntimeBindingOperationExecutor \| undefined`
|
|
761
|
-
| node | property | `UiNode`
|
|
762
|
-
| operationResults | property | `Readonly<Record<string, BindingValue \| undefined>> \| undefined`
|
|
763
|
-
| state | property | `Record<string, unknown> \| undefined`
|
|
764
|
-
| writeOperationResult | property | `RuntimeBindingOperationResultWriter \| undefined`
|
|
658
|
+
| Name | Kind | Type | Required | Description |
|
|
659
|
+
| -------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------- |
|
|
660
|
+
| context | property | `Record<string, unknown> \| undefined` | no | |
|
|
661
|
+
| dataBindings | property | `Readonly<Record<string, import("/home/runner/work/runtime/runtime/node_modules/@ankhorage/contracts/dist/bindings").ComponentDataBinding>> \| undefined` | no | |
|
|
662
|
+
| dataSources | property | `Readonly<Record<string, DataSourceConfig>> \| undefined` | no | |
|
|
663
|
+
| event | property | `ComponentEventDto<string, object>` | yes | |
|
|
664
|
+
| eventName | property | `string \| undefined` | no | |
|
|
665
|
+
| executeAction | property | `RuntimeActionHandler \| undefined` | no | |
|
|
666
|
+
| executeOperation | property | `RuntimeBindingOperationExecutor \| undefined` | no | |
|
|
667
|
+
| node | property | `UiNode` | yes | |
|
|
668
|
+
| operationResults | property | `Readonly<Record<string, BindingValue \| undefined>> \| undefined` | no | |
|
|
669
|
+
| state | property | `Record<string, unknown> \| undefined` | no | |
|
|
670
|
+
| writeOperationResult | property | `RuntimeBindingOperationResultWriter \| undefined` | no | |
|
|
765
671
|
|
|
766
672
|
## RuntimeDataSourceOperationExecutorOptions
|
|
767
673
|
|
|
768
674
|
Kind: `type`
|
|
769
675
|
Module: `src/runtimeDataSourceOperations.ts`
|
|
770
|
-
Source: `src/runtimeDataSourceOperations.ts:
|
|
676
|
+
Source: `src/runtimeDataSourceOperations.ts:8:1`
|
|
771
677
|
|
|
772
678
|
### Members
|
|
773
679
|
|
|
774
|
-
| Name | Kind | Type
|
|
775
|
-
| ------------------ | -------- |
|
|
776
|
-
| credentialResolver | property | `EndpointTestCredentialResolver \| undefined`
|
|
777
|
-
|
|
|
680
|
+
| Name | Kind | Type | Required | Description |
|
|
681
|
+
| ------------------ | -------- | -------------------------------------------------- | -------- | ----------- |
|
|
682
|
+
| credentialResolver | property | `EndpointTestCredentialResolver \| undefined` | no | |
|
|
683
|
+
| databaseAdapters | property | `Readonly<Record<string, DbAdapter>> \| undefined` | no | |
|
|
684
|
+
| fetch | property | `EndpointTestFetch \| undefined` | no | |
|
|
778
685
|
|
|
779
686
|
## RuntimeDbPersistError
|
|
780
687
|
|
|
@@ -843,16 +750,16 @@ Source: `src/runtimeActionRegistry.ts:57:1`
|
|
|
843
750
|
|
|
844
751
|
### Members
|
|
845
752
|
|
|
846
|
-
| Name | Kind | Type
|
|
847
|
-
| ---------------------- | -------- |
|
|
848
|
-
| context | property | `Record<string, unknown> \| undefined`
|
|
849
|
-
| dataBindings | property | `Readonly<Record<string, import("/
|
|
850
|
-
| disableActions | property | `boolean`
|
|
851
|
-
| dispatchComponentEvent | property | `(args: RuntimeComponentEventDispatchArgs) => Promise<void> \| void`
|
|
852
|
-
| node | property | `UiNode`
|
|
853
|
-
| operationResults | property | `Readonly<Record<string, BindingValue \| undefined>> \| undefined`
|
|
854
|
-
| props | property | `Record<string, unknown>`
|
|
855
|
-
| state | property | `Record<string, unknown> \| undefined`
|
|
753
|
+
| Name | Kind | Type | Required | Description |
|
|
754
|
+
| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------- |
|
|
755
|
+
| context | property | `Record<string, unknown> \| undefined` | no | |
|
|
756
|
+
| dataBindings | property | `Readonly<Record<string, import("/home/runner/work/runtime/runtime/node_modules/@ankhorage/contracts/dist/bindings").ComponentDataBinding>> \| undefined` | no | |
|
|
757
|
+
| disableActions | property | `boolean` | yes | |
|
|
758
|
+
| dispatchComponentEvent | property | `(args: RuntimeComponentEventDispatchArgs) => Promise<void> \| void` | yes | |
|
|
759
|
+
| node | property | `UiNode` | yes | |
|
|
760
|
+
| operationResults | property | `Readonly<Record<string, BindingValue \| undefined>> \| undefined` | no | |
|
|
761
|
+
| props | property | `Record<string, unknown>` | yes | |
|
|
762
|
+
| state | property | `Record<string, unknown> \| undefined` | no | |
|
|
856
763
|
|
|
857
764
|
## RuntimeManifest
|
|
858
765
|
|
|
@@ -940,24 +847,24 @@ Source: `src/RuntimeRendererConfig.tsx:48:1`
|
|
|
940
847
|
|
|
941
848
|
### Members
|
|
942
849
|
|
|
943
|
-
| Name | Kind | Type
|
|
944
|
-
| -------------------- | -------- |
|
|
945
|
-
| actionHandlers | property | `RuntimeActionHandlers \| undefined`
|
|
946
|
-
| bindingContext | property | `Record<string, unknown> \| undefined`
|
|
947
|
-
| dataBindings | property | `Readonly<Record<string, import("/
|
|
948
|
-
| dataSources | property | `Readonly<Record<string, import("/
|
|
949
|
-
| dbAdapter | property | `DbAdapter \| undefined`
|
|
950
|
-
| dbRealtimeAdapter | property | `DbRealtimeAdapter \| undefined`
|
|
951
|
-
| disableActions | property | `boolean \| undefined`
|
|
952
|
-
| executeAction | property | `RuntimeActionHandler \| undefined`
|
|
953
|
-
| executeOperation | property | `RuntimeBindingOperationExecutor \| undefined`
|
|
954
|
-
| onDiagnostics | property | `((diagnostics: readonly DataSourceDiagnostic[]) => void) \| undefined`
|
|
955
|
-
| operationResults | property | `Readonly<Record<string, import("/
|
|
956
|
-
| registry | property | `Readonly<Record<string, React.ElementType<any, keyof React.JSX.IntrinsicElements>>> \| undefined`
|
|
957
|
-
| resolveNodeProps | property | `RuntimeNodePropsResolver \| undefined`
|
|
958
|
-
| stateAdapter | property | `StateAdapter \| undefined`
|
|
959
|
-
| wrapNode | property | `((args: RuntimeRendererWrapArgs) => React.ReactNode) \| undefined`
|
|
960
|
-
| writeOperationResult | property | `RuntimeBindingOperationResultWriter \| undefined`
|
|
850
|
+
| Name | Kind | Type | Required | Description |
|
|
851
|
+
| -------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------- |
|
|
852
|
+
| actionHandlers | property | `RuntimeActionHandlers \| undefined` | no | |
|
|
853
|
+
| bindingContext | property | `Record<string, unknown> \| undefined` | no | |
|
|
854
|
+
| dataBindings | property | `Readonly<Record<string, import("/home/runner/work/runtime/runtime/node_modules/@ankhorage/contracts/dist/bindings").ComponentDataBinding>> \| undefined` | no | |
|
|
855
|
+
| dataSources | property | `Readonly<Record<string, import("/home/runner/work/runtime/runtime/node_modules/@ankhorage/contracts/dist/index").DataSourceConfig>> \| undefined` | no | |
|
|
856
|
+
| dbAdapter | property | `DbAdapter \| undefined` | no | |
|
|
857
|
+
| dbRealtimeAdapter | property | `DbRealtimeAdapter \| undefined` | no | |
|
|
858
|
+
| disableActions | property | `boolean \| undefined` | no | |
|
|
859
|
+
| executeAction | property | `RuntimeActionHandler \| undefined` | no | |
|
|
860
|
+
| executeOperation | property | `RuntimeBindingOperationExecutor \| undefined` | no | |
|
|
861
|
+
| onDiagnostics | property | `((diagnostics: readonly DataSourceDiagnostic[]) => void) \| undefined` | no | |
|
|
862
|
+
| operationResults | property | `Readonly<Record<string, import("/home/runner/work/runtime/runtime/node_modules/@ankhorage/contracts/dist/bindings").BindingValue \| undefined>> \| undefined` | no | |
|
|
863
|
+
| registry | property | `Readonly<Record<string, React.ElementType<any, keyof React.JSX.IntrinsicElements>>> \| undefined` | no | |
|
|
864
|
+
| resolveNodeProps | property | `RuntimeNodePropsResolver \| undefined` | no | |
|
|
865
|
+
| stateAdapter | property | `StateAdapter \| undefined` | no | |
|
|
866
|
+
| wrapNode | property | `((args: RuntimeRendererWrapArgs) => React.ReactNode) \| undefined` | no | |
|
|
867
|
+
| writeOperationResult | property | `RuntimeBindingOperationResultWriter \| undefined` | no | |
|
|
961
868
|
|
|
962
869
|
## RuntimeRendererConfigProvider
|
|
963
870
|
|
|
@@ -979,23 +886,23 @@ Source: `src/RuntimeRenderer.tsx:49:1`
|
|
|
979
886
|
|
|
980
887
|
### Members
|
|
981
888
|
|
|
982
|
-
| Name | Kind | Type
|
|
983
|
-
| ----------------- | -------- |
|
|
984
|
-
| bindingContext | property | `Record<string, unknown> \| undefined`
|
|
985
|
-
| dataBindings | property | `Readonly<Record<string, import("/
|
|
986
|
-
| dataSources | property | `Readonly<Record<string, import("/
|
|
987
|
-
| dbAdapter | property | `DbAdapter \| undefined`
|
|
988
|
-
| dbRealtimeAdapter | property | `DbRealtimeAdapter \| undefined`
|
|
989
|
-
| disableActions | property | `boolean \| undefined`
|
|
990
|
-
| executeAction | property | `import("/
|
|
991
|
-
| executeOperation | property | `RuntimeBindingOperationExecutor \| undefined`
|
|
992
|
-
| isRoot | property | `boolean \| undefined`
|
|
993
|
-
| node | property | `UiNode`
|
|
994
|
-
| onDiagnostics | property | `((diagnostics: readonly DataSourceDiagnostic[]) => void) \| undefined`
|
|
995
|
-
| operationResults | property | `Readonly<Record<string, BindingValue \| undefined>> \| undefined`
|
|
996
|
-
| registry | property | `Readonly<Record<string, React.ElementType<any, keyof React.JSX.IntrinsicElements>>> \| undefined`
|
|
997
|
-
| stateAdapter | property | `StateAdapter \| undefined`
|
|
998
|
-
| wrapNode | property | `((args: RuntimeRendererWrapArgs) => React.ReactNode) \| undefined`
|
|
889
|
+
| Name | Kind | Type | Required | Description |
|
|
890
|
+
| ----------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------- |
|
|
891
|
+
| bindingContext | property | `Record<string, unknown> \| undefined` | no | |
|
|
892
|
+
| dataBindings | property | `Readonly<Record<string, import("/home/runner/work/runtime/runtime/node_modules/@ankhorage/contracts/dist/bindings").ComponentDataBinding>> \| undefined` | no | |
|
|
893
|
+
| dataSources | property | `Readonly<Record<string, import("/home/runner/work/runtime/runtime/node_modules/@ankhorage/contracts/dist/index").DataSourceConfig>> \| undefined` | no | |
|
|
894
|
+
| dbAdapter | property | `DbAdapter \| undefined` | no | |
|
|
895
|
+
| dbRealtimeAdapter | property | `DbRealtimeAdapter \| undefined` | no | |
|
|
896
|
+
| disableActions | property | `boolean \| undefined` | no | |
|
|
897
|
+
| executeAction | property | `import("/home/runner/work/runtime/runtime/src/RuntimeRendererConfig").RuntimeActionHandler \| undefined` | no | |
|
|
898
|
+
| executeOperation | property | `RuntimeBindingOperationExecutor \| undefined` | no | |
|
|
899
|
+
| isRoot | property | `boolean \| undefined` | no | |
|
|
900
|
+
| node | property | `UiNode` | yes | |
|
|
901
|
+
| onDiagnostics | property | `((diagnostics: readonly DataSourceDiagnostic[]) => void) \| undefined` | no | |
|
|
902
|
+
| operationResults | property | `Readonly<Record<string, BindingValue \| undefined>> \| undefined` | no | |
|
|
903
|
+
| registry | property | `Readonly<Record<string, React.ElementType<any, keyof React.JSX.IntrinsicElements>>> \| undefined` | no | |
|
|
904
|
+
| stateAdapter | property | `StateAdapter \| undefined` | no | |
|
|
905
|
+
| wrapNode | property | `((args: RuntimeRendererWrapArgs) => React.ReactNode) \| undefined` | no | |
|
|
999
906
|
|
|
1000
907
|
## RuntimeRendererWrapArgs
|
|
1001
908
|
|
|
@@ -1028,7 +935,7 @@ Source: `node_modules/@ankhorage/contracts/dist/runtimeCallbacks.d.ts:2:1`
|
|
|
1028
935
|
|
|
1029
936
|
Kind: `function`
|
|
1030
937
|
Module: `src/RuntimeScreen.tsx`
|
|
1031
|
-
Source: `src/RuntimeScreen.tsx:
|
|
938
|
+
Source: `src/RuntimeScreen.tsx:17:1`
|
|
1032
939
|
|
|
1033
940
|
### Signatures
|
|
1034
941
|
|
|
@@ -1040,7 +947,7 @@ Source: `src/RuntimeScreen.tsx:24:1`
|
|
|
1040
947
|
|
|
1041
948
|
Kind: `type`
|
|
1042
949
|
Module: `src/runtimeScreenLoaders.ts`
|
|
1043
|
-
Source: `src/runtimeScreenLoaders.ts:
|
|
950
|
+
Source: `src/runtimeScreenLoaders.ts:25:1`
|
|
1044
951
|
|
|
1045
952
|
### Members
|
|
1046
953
|
|
|
@@ -1054,7 +961,7 @@ Source: `src/runtimeScreenLoaders.ts:26:1`
|
|
|
1054
961
|
|
|
1055
962
|
Kind: `type`
|
|
1056
963
|
Module: `src/runtimeScreenLoaders.ts`
|
|
1057
|
-
Source: `src/runtimeScreenLoaders.ts:
|
|
964
|
+
Source: `src/runtimeScreenLoaders.ts:18:1`
|
|
1058
965
|
|
|
1059
966
|
### Members
|
|
1060
967
|
|
|
@@ -1069,7 +976,7 @@ Source: `src/runtimeScreenLoaders.ts:19:1`
|
|
|
1069
976
|
|
|
1070
977
|
Kind: `type`
|
|
1071
978
|
Module: `src/RuntimeScreen.tsx`
|
|
1072
|
-
Source: `src/RuntimeScreen.tsx:
|
|
979
|
+
Source: `src/RuntimeScreen.tsx:10:1`
|
|
1073
980
|
|
|
1074
981
|
### Members
|
|
1075
982
|
|
|
@@ -1125,18 +1032,6 @@ Source: `src/ManifestContext.tsx:38:1`
|
|
|
1125
1032
|
- `() => ManifestContextValue | null`
|
|
1126
1033
|
- returns: `ManifestContextValue | null`
|
|
1127
1034
|
|
|
1128
|
-
## useRuntimeApiStateLoaders
|
|
1129
|
-
|
|
1130
|
-
Kind: `function`
|
|
1131
|
-
Module: `src/runtimeApiLoaders.ts`
|
|
1132
|
-
Source: `src/runtimeApiLoaders.ts:125:1`
|
|
1133
|
-
|
|
1134
|
-
### Signatures
|
|
1135
|
-
|
|
1136
|
-
- `(args: { readonly data?: AppDataManifest; readonly loaders?: readonly RuntimeApiLoaderDefinition[]; readonly stateAdapter?: StateAdapter; }) => { readonly diagnostics: readonly RuntimeApiLoaderDiagnostic[]; readonly stateAdapter: StateAdapter; readonly stateVersion: number; }`
|
|
1137
|
-
- args: `{ readonly data?: AppDataManifest; readonly loaders?: readonly RuntimeApiLoaderDefinition[]; readonly stateAdapter?: StateAdapter; }`
|
|
1138
|
-
- returns: `{ readonly diagnostics: readonly RuntimeApiLoaderDiagnostic[]; readonly stateAdapter: StateAdapter; readonly stateVersion: number; }`
|
|
1139
|
-
|
|
1140
1035
|
## useRuntimeRendererConfig
|
|
1141
1036
|
|
|
1142
1037
|
Kind: `function`
|
|
@@ -1152,7 +1047,7 @@ Source: `src/RuntimeRendererConfig.tsx:167:1`
|
|
|
1152
1047
|
|
|
1153
1048
|
Kind: `function`
|
|
1154
1049
|
Module: `src/runtimeScreenLoaders.ts`
|
|
1155
|
-
Source: `src/runtimeScreenLoaders.ts:
|
|
1050
|
+
Source: `src/runtimeScreenLoaders.ts:273:1`
|
|
1156
1051
|
|
|
1157
1052
|
### Signatures
|
|
1158
1053
|
|