@ankhorage/runtime 0.3.0 → 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 +6 -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 +1 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -2
- package/dist/index.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 -9
- package/paradox/diagrams/export-graph.mmd +1 -28
- package/paradox/diagrams/module-relationships.mmd +4 -7
- package/paradox/diagrams/sequences/runtime-screen.mmd +0 -3
- package/paradox/exports.json +30 -293
- package/paradox/exports.md +94 -193
- package/paradox/index.html +377 -700
- package/paradox/paradox.json +686 -890
- 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
|
@@ -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
|
|
|
@@ -156,7 +156,7 @@ Source: `src/runtimeStateAdapter.ts:18:1`
|
|
|
156
156
|
|
|
157
157
|
Kind: `function`
|
|
158
158
|
Module: `src/runtimeScreenLoaders.ts`
|
|
159
|
-
Source: `src/runtimeScreenLoaders.ts:
|
|
159
|
+
Source: `src/runtimeScreenLoaders.ts:49:1`
|
|
160
160
|
|
|
161
161
|
### Signatures
|
|
162
162
|
|
|
@@ -236,23 +236,11 @@ Source: `src/runtimeDbPersist.ts:48:1`
|
|
|
236
236
|
- args: `{ readonly dbAdapter: DbAdapter; readonly handlerArgs: RuntimeActionHandlerArgs; }`
|
|
237
237
|
- returns: `Promise<RuntimeDbPersistExecutionResult>`
|
|
238
238
|
|
|
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
239
|
## executeRuntimeScreenOperationLoaders
|
|
252
240
|
|
|
253
241
|
Kind: `function`
|
|
254
242
|
Module: `src/runtimeScreenLoaders.ts`
|
|
255
|
-
Source: `src/runtimeScreenLoaders.ts:
|
|
243
|
+
Source: `src/runtimeScreenLoaders.ts:178:1`
|
|
256
244
|
|
|
257
245
|
### Signatures
|
|
258
246
|
|
|
@@ -289,18 +277,6 @@ Source: `src/ManifestContext.tsx:12:1`
|
|
|
289
277
|
- props: `ManifestContextValue & { children: React.ReactNode; }`
|
|
290
278
|
- returns: `React.JSX.Element`
|
|
291
279
|
|
|
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
280
|
## mergeRuntimeRendererConfig
|
|
305
281
|
|
|
306
282
|
Kind: `function`
|
|
@@ -418,23 +394,11 @@ Source: `src/runtimeBindings.ts:116:1`
|
|
|
418
394
|
- diagnostics: `DataSourceDiagnostic[]` (optional)
|
|
419
395
|
- returns: `unknown`
|
|
420
396
|
|
|
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
397
|
## resolveScreenOperationLoaders
|
|
434
398
|
|
|
435
399
|
Kind: `function`
|
|
436
400
|
Module: `src/runtimeScreenLoaders.ts`
|
|
437
|
-
Source: `src/runtimeScreenLoaders.ts:
|
|
401
|
+
Source: `src/runtimeScreenLoaders.ts:43:1`
|
|
438
402
|
|
|
439
403
|
### Signatures
|
|
440
404
|
|
|
@@ -564,58 +528,6 @@ Source: `src/runtimeManifest.ts:39:1`
|
|
|
564
528
|
| kind | property | `string` | yes | |
|
|
565
529
|
| options | property | `Options \| undefined` | no | |
|
|
566
530
|
|
|
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
531
|
## RuntimeBindingDescriptor
|
|
620
532
|
|
|
621
533
|
Kind: `type`
|
|
@@ -686,17 +598,17 @@ Source: `src/runtimeBindings.ts:64:1`
|
|
|
686
598
|
|
|
687
599
|
### Members
|
|
688
600
|
|
|
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`
|
|
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 | |
|
|
700
612
|
|
|
701
613
|
## RuntimeBindingResolutionContext
|
|
702
614
|
|
|
@@ -706,15 +618,15 @@ Source: `src/runtimeBindings.ts:54:1`
|
|
|
706
618
|
|
|
707
619
|
### Members
|
|
708
620
|
|
|
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`
|
|
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 | |
|
|
718
630
|
|
|
719
631
|
## RuntimeBindingResolutionResult
|
|
720
632
|
|
|
@@ -743,32 +655,33 @@ Source: `src/runtimeActionRegistry.ts:46:1`
|
|
|
743
655
|
|
|
744
656
|
### Members
|
|
745
657
|
|
|
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`
|
|
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 | |
|
|
759
671
|
|
|
760
672
|
## RuntimeDataSourceOperationExecutorOptions
|
|
761
673
|
|
|
762
674
|
Kind: `type`
|
|
763
675
|
Module: `src/runtimeDataSourceOperations.ts`
|
|
764
|
-
Source: `src/runtimeDataSourceOperations.ts:
|
|
676
|
+
Source: `src/runtimeDataSourceOperations.ts:8:1`
|
|
765
677
|
|
|
766
678
|
### Members
|
|
767
679
|
|
|
768
|
-
| Name | Kind | Type
|
|
769
|
-
| ------------------ | -------- |
|
|
770
|
-
| credentialResolver | property | `EndpointTestCredentialResolver \| undefined`
|
|
771
|
-
|
|
|
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 | |
|
|
772
685
|
|
|
773
686
|
## RuntimeDbPersistError
|
|
774
687
|
|
|
@@ -837,16 +750,16 @@ Source: `src/runtimeActionRegistry.ts:57:1`
|
|
|
837
750
|
|
|
838
751
|
### Members
|
|
839
752
|
|
|
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`
|
|
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 | |
|
|
850
763
|
|
|
851
764
|
## RuntimeManifest
|
|
852
765
|
|
|
@@ -934,24 +847,24 @@ Source: `src/RuntimeRendererConfig.tsx:48:1`
|
|
|
934
847
|
|
|
935
848
|
### Members
|
|
936
849
|
|
|
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
|
-
| onDiagnostics | property | `((diagnostics: readonly DataSourceDiagnostic[]) => void) \| undefined`
|
|
949
|
-
| operationResults | property | `Readonly<Record<string, import("/
|
|
950
|
-
| registry | property | `Readonly<Record<string, React.ElementType<any, keyof React.JSX.IntrinsicElements>>> \| undefined`
|
|
951
|
-
| resolveNodeProps | property | `RuntimeNodePropsResolver \| undefined`
|
|
952
|
-
| stateAdapter | property | `StateAdapter \| undefined`
|
|
953
|
-
| wrapNode | property | `((args: RuntimeRendererWrapArgs) => React.ReactNode) \| undefined`
|
|
954
|
-
| 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 | |
|
|
955
868
|
|
|
956
869
|
## RuntimeRendererConfigProvider
|
|
957
870
|
|
|
@@ -973,23 +886,23 @@ Source: `src/RuntimeRenderer.tsx:49:1`
|
|
|
973
886
|
|
|
974
887
|
### Members
|
|
975
888
|
|
|
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
|
-
| node | property | `UiNode`
|
|
988
|
-
| onDiagnostics | property | `((diagnostics: readonly DataSourceDiagnostic[]) => void) \| undefined`
|
|
989
|
-
| operationResults | property | `Readonly<Record<string, BindingValue \| undefined>> \| undefined`
|
|
990
|
-
| registry | property | `Readonly<Record<string, React.ElementType<any, keyof React.JSX.IntrinsicElements>>> \| undefined`
|
|
991
|
-
| stateAdapter | property | `StateAdapter \| undefined`
|
|
992
|
-
| 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 | |
|
|
993
906
|
|
|
994
907
|
## RuntimeRendererWrapArgs
|
|
995
908
|
|
|
@@ -1022,7 +935,7 @@ Source: `node_modules/@ankhorage/contracts/dist/runtimeCallbacks.d.ts:2:1`
|
|
|
1022
935
|
|
|
1023
936
|
Kind: `function`
|
|
1024
937
|
Module: `src/RuntimeScreen.tsx`
|
|
1025
|
-
Source: `src/RuntimeScreen.tsx:
|
|
938
|
+
Source: `src/RuntimeScreen.tsx:17:1`
|
|
1026
939
|
|
|
1027
940
|
### Signatures
|
|
1028
941
|
|
|
@@ -1034,7 +947,7 @@ Source: `src/RuntimeScreen.tsx:24:1`
|
|
|
1034
947
|
|
|
1035
948
|
Kind: `type`
|
|
1036
949
|
Module: `src/runtimeScreenLoaders.ts`
|
|
1037
|
-
Source: `src/runtimeScreenLoaders.ts:
|
|
950
|
+
Source: `src/runtimeScreenLoaders.ts:25:1`
|
|
1038
951
|
|
|
1039
952
|
### Members
|
|
1040
953
|
|
|
@@ -1048,7 +961,7 @@ Source: `src/runtimeScreenLoaders.ts:26:1`
|
|
|
1048
961
|
|
|
1049
962
|
Kind: `type`
|
|
1050
963
|
Module: `src/runtimeScreenLoaders.ts`
|
|
1051
|
-
Source: `src/runtimeScreenLoaders.ts:
|
|
964
|
+
Source: `src/runtimeScreenLoaders.ts:18:1`
|
|
1052
965
|
|
|
1053
966
|
### Members
|
|
1054
967
|
|
|
@@ -1063,7 +976,7 @@ Source: `src/runtimeScreenLoaders.ts:19:1`
|
|
|
1063
976
|
|
|
1064
977
|
Kind: `type`
|
|
1065
978
|
Module: `src/RuntimeScreen.tsx`
|
|
1066
|
-
Source: `src/RuntimeScreen.tsx:
|
|
979
|
+
Source: `src/RuntimeScreen.tsx:10:1`
|
|
1067
980
|
|
|
1068
981
|
### Members
|
|
1069
982
|
|
|
@@ -1119,18 +1032,6 @@ Source: `src/ManifestContext.tsx:38:1`
|
|
|
1119
1032
|
- `() => ManifestContextValue | null`
|
|
1120
1033
|
- returns: `ManifestContextValue | null`
|
|
1121
1034
|
|
|
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
1035
|
## useRuntimeRendererConfig
|
|
1135
1036
|
|
|
1136
1037
|
Kind: `function`
|
|
@@ -1146,7 +1047,7 @@ Source: `src/RuntimeRendererConfig.tsx:167:1`
|
|
|
1146
1047
|
|
|
1147
1048
|
Kind: `function`
|
|
1148
1049
|
Module: `src/runtimeScreenLoaders.ts`
|
|
1149
|
-
Source: `src/runtimeScreenLoaders.ts:
|
|
1050
|
+
Source: `src/runtimeScreenLoaders.ts:273:1`
|
|
1150
1051
|
|
|
1151
1052
|
### Signatures
|
|
1152
1053
|
|