@ankhorage/runtime 3.0.5 → 3.0.7
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/package.json +4 -4
- package/paradox/badges/npm.svg +3 -3
- package/paradox/components.md +39 -39
- package/paradox/exports.json +401 -141
- package/paradox/exports.md +230 -230
- package/paradox/index.html +5082 -8430
- package/paradox/paradox.json +597 -214
package/paradox/exports.md
CHANGED
|
@@ -404,12 +404,12 @@ Source: `src/runtimeManifest.ts:24:1`
|
|
|
404
404
|
|
|
405
405
|
### Members
|
|
406
406
|
|
|
407
|
-
| Name
|
|
408
|
-
|
|
|
409
|
-
| capability
|
|
410
|
-
| data
|
|
411
|
-
| description | property | `string \| undefined`
|
|
412
|
-
| id
|
|
407
|
+
| Name | Kind | Type | Required | Description |
|
|
408
|
+
| --- | --- | --- | --- | --- |
|
|
409
|
+
| capability | property | `"runtime.render" \| "runtime.actions" \| "runtime.bindings" \| "runtime.adapters" \| undefined` | no | |
|
|
410
|
+
| data | property | `Data \| undefined` | no | |
|
|
411
|
+
| description | property | `string \| undefined` | no | |
|
|
412
|
+
| id | property | `string` | yes | |
|
|
413
413
|
|
|
414
414
|
## RuntimeActionExecutor
|
|
415
415
|
|
|
@@ -431,12 +431,12 @@ Source: `src/RuntimeRendererConfig.tsx:39:1`
|
|
|
431
431
|
|
|
432
432
|
### Members
|
|
433
433
|
|
|
434
|
-
| Name
|
|
435
|
-
|
|
|
436
|
-
| action
|
|
437
|
-
| event
|
|
438
|
-
| node
|
|
439
|
-
| resolvedPayload | property | `object \| undefined`
|
|
434
|
+
| Name | Kind | Type | Required | Description |
|
|
435
|
+
| --- | --- | --- | --- | --- |
|
|
436
|
+
| action | property | `RuntimeAction` | yes | |
|
|
437
|
+
| event | property | `ComponentEventDto<string, object> \| undefined` | no | |
|
|
438
|
+
| node | property | `UiNode \| undefined` | no | |
|
|
439
|
+
| resolvedPayload | property | `object \| undefined` | no | |
|
|
440
440
|
|
|
441
441
|
## RuntimeActionHandlers
|
|
442
442
|
|
|
@@ -452,10 +452,10 @@ Source: `src/runtimeActionRegistry.ts:34:1`
|
|
|
452
452
|
|
|
453
453
|
### Members
|
|
454
454
|
|
|
455
|
-
| Name
|
|
456
|
-
|
|
|
457
|
-
| dispatchComponentEvent | method | `(args: RuntimeComponentEventDispatchArgs) => Promise<void>`
|
|
458
|
-
| registerActionHandler
|
|
455
|
+
| Name | Kind | Type | Required | Description |
|
|
456
|
+
| --- | --- | --- | --- | --- |
|
|
457
|
+
| dispatchComponentEvent | method | `(args: RuntimeComponentEventDispatchArgs) => Promise<void>` | yes | |
|
|
458
|
+
| registerActionHandler | method | `(type: string, handler: RuntimeActionHandler) => () => void` | yes | |
|
|
459
459
|
|
|
460
460
|
## RuntimeActionResolutionArgs
|
|
461
461
|
|
|
@@ -465,12 +465,12 @@ Source: `src/runtimeActionRegistry.ts:45:1`
|
|
|
465
465
|
|
|
466
466
|
### Members
|
|
467
467
|
|
|
468
|
-
| Name
|
|
469
|
-
|
|
|
470
|
-
| context
|
|
471
|
-
| event
|
|
472
|
-
| operationResults | property | `Readonly<Record<string, import("@ankhorage/contracts").SerializableValue \| undefined>> \| undefined` | no
|
|
473
|
-
| state
|
|
468
|
+
| Name | Kind | Type | Required | Description |
|
|
469
|
+
| --- | --- | --- | --- | --- |
|
|
470
|
+
| context | property | `Record<string, unknown> \| undefined` | no | |
|
|
471
|
+
| event | property | `ComponentEventDto<string, object>` | yes | |
|
|
472
|
+
| operationResults | property | `Readonly<Record<string, import("@ankhorage/contracts").SerializableValue \| undefined>> \| undefined` | no | |
|
|
473
|
+
| state | property | `Record<string, unknown> \| undefined` | no | |
|
|
474
474
|
|
|
475
475
|
## RuntimeActionResolutionScope
|
|
476
476
|
|
|
@@ -480,11 +480,11 @@ Source: `src/runtimeActionRegistry.ts:39:1`
|
|
|
480
480
|
|
|
481
481
|
### Members
|
|
482
482
|
|
|
483
|
-
| Name
|
|
484
|
-
|
|
|
485
|
-
| context
|
|
486
|
-
| operationResults | property | `Readonly<Record<string, import("@ankhorage/contracts").SerializableValue \| undefined>> \| undefined` | no
|
|
487
|
-
| state
|
|
483
|
+
| Name | Kind | Type | Required | Description |
|
|
484
|
+
| --- | --- | --- | --- | --- |
|
|
485
|
+
| context | property | `Record<string, unknown> \| undefined` | no | |
|
|
486
|
+
| operationResults | property | `Readonly<Record<string, import("@ankhorage/contracts").SerializableValue \| undefined>> \| undefined` | no | |
|
|
487
|
+
| state | property | `Record<string, unknown> \| undefined` | no | |
|
|
488
488
|
|
|
489
489
|
## RuntimeAdapterDescriptor
|
|
490
490
|
|
|
@@ -494,11 +494,11 @@ Source: `src/runtimeManifest.ts:39:1`
|
|
|
494
494
|
|
|
495
495
|
### Members
|
|
496
496
|
|
|
497
|
-
| Name
|
|
498
|
-
|
|
|
499
|
-
| id
|
|
500
|
-
| kind
|
|
501
|
-
| options | property | `Options \| undefined` | no
|
|
497
|
+
| Name | Kind | Type | Required | Description |
|
|
498
|
+
| --- | --- | --- | --- | --- |
|
|
499
|
+
| id | property | `string` | yes | |
|
|
500
|
+
| kind | property | `string` | yes | |
|
|
501
|
+
| options | property | `Options \| undefined` | no | |
|
|
502
502
|
|
|
503
503
|
## RuntimeApiOperationExecutorOptions
|
|
504
504
|
|
|
@@ -508,10 +508,10 @@ Source: `src/runtimeApiOperations.ts:7:1`
|
|
|
508
508
|
|
|
509
509
|
### Members
|
|
510
510
|
|
|
511
|
-
| Name
|
|
512
|
-
|
|
|
513
|
-
| credentialResolver | property | `EndpointTestCredentialResolver \| undefined` | no
|
|
514
|
-
| fetch
|
|
511
|
+
| Name | Kind | Type | Required | Description |
|
|
512
|
+
| --- | --- | --- | --- | --- |
|
|
513
|
+
| credentialResolver | property | `EndpointTestCredentialResolver \| undefined` | no | |
|
|
514
|
+
| fetch | property | `EndpointTestFetch \| undefined` | no | |
|
|
515
515
|
|
|
516
516
|
## RuntimeApiOperationSelection
|
|
517
517
|
|
|
@@ -521,10 +521,10 @@ Source: `src/runtimeApiSelection.ts:10:1`
|
|
|
521
521
|
|
|
522
522
|
### Members
|
|
523
523
|
|
|
524
|
-
| Name
|
|
525
|
-
|
|
|
526
|
-
| api
|
|
527
|
-
| endpoint | property | `DataEndpointConfig` | yes
|
|
524
|
+
| Name | Kind | Type | Required | Description |
|
|
525
|
+
| --- | --- | --- | --- | --- |
|
|
526
|
+
| api | property | `ApiDefinition` | yes | |
|
|
527
|
+
| endpoint | property | `DataEndpointConfig` | yes | |
|
|
528
528
|
|
|
529
529
|
## RuntimeBindingDescriptor
|
|
530
530
|
|
|
@@ -534,13 +534,13 @@ Source: `src/runtimeManifest.ts:31:1`
|
|
|
534
534
|
|
|
535
535
|
### Members
|
|
536
536
|
|
|
537
|
-
| Name
|
|
538
|
-
|
|
|
539
|
-
| actionId | property | `string \| undefined` | no
|
|
540
|
-
| id
|
|
541
|
-
| source
|
|
542
|
-
| target
|
|
543
|
-
| value
|
|
537
|
+
| Name | Kind | Type | Required | Description |
|
|
538
|
+
| --- | --- | --- | --- | --- |
|
|
539
|
+
| actionId | property | `string \| undefined` | no | |
|
|
540
|
+
| id | property | `string` | yes | |
|
|
541
|
+
| source | property | `string` | yes | |
|
|
542
|
+
| target | property | `string` | yes | |
|
|
543
|
+
| value | property | `Value \| undefined` | no | |
|
|
544
544
|
|
|
545
545
|
## RuntimeBindingOperationExecutionArgs
|
|
546
546
|
|
|
@@ -550,13 +550,13 @@ Source: `src/runtimeBindings.ts:24:1`
|
|
|
550
550
|
|
|
551
551
|
### Members
|
|
552
552
|
|
|
553
|
-
| Name
|
|
554
|
-
|
|
|
555
|
-
| api
|
|
556
|
-
| endpoint
|
|
557
|
-
| input
|
|
558
|
-
| node
|
|
559
|
-
| operation | property | `BindingOperationRef`
|
|
553
|
+
| Name | Kind | Type | Required | Description |
|
|
554
|
+
| --- | --- | --- | --- | --- |
|
|
555
|
+
| api | property | `ApiDefinition` | yes | |
|
|
556
|
+
| endpoint | property | `DataEndpointConfig` | yes | |
|
|
557
|
+
| input | property | `import("@ankhorage/contracts").SerializableValue \| undefined` | no | |
|
|
558
|
+
| node | property | `UiNode \| undefined` | no | |
|
|
559
|
+
| operation | property | `BindingOperationRef` | yes | |
|
|
560
560
|
|
|
561
561
|
## RuntimeBindingOperationExecutionResult
|
|
562
562
|
|
|
@@ -596,17 +596,17 @@ Source: `src/runtimeBindings.ts:66:1`
|
|
|
596
596
|
|
|
597
597
|
### Members
|
|
598
598
|
|
|
599
|
-
| Name
|
|
600
|
-
|
|
|
601
|
-
| apis
|
|
602
|
-
| context
|
|
603
|
-
| dataBindings
|
|
604
|
-
| event
|
|
605
|
-
| executeOperation | property | `RuntimeBindingOperationExecutor \| undefined`
|
|
606
|
-
| node
|
|
607
|
-
| operationResults | property | `Readonly<Record<string, import("@ankhorage/contracts").SerializableValue \| undefined>> \| undefined` | no
|
|
608
|
-
| props
|
|
609
|
-
| stateAdapter
|
|
599
|
+
| Name | Kind | Type | Required | Description |
|
|
600
|
+
| --- | --- | --- | --- | --- |
|
|
601
|
+
| apis | property | `ApiDefinitionRegistry \| undefined` | no | |
|
|
602
|
+
| context | property | `Record<string, unknown> \| undefined` | no | |
|
|
603
|
+
| dataBindings | property | `ComponentDataBindingRegistry \| undefined` | no | |
|
|
604
|
+
| event | property | `ComponentEventDto<string, object> \| undefined` | no | |
|
|
605
|
+
| executeOperation | property | `RuntimeBindingOperationExecutor \| undefined` | no | |
|
|
606
|
+
| node | property | `UiNode` | yes | |
|
|
607
|
+
| operationResults | property | `Readonly<Record<string, import("@ankhorage/contracts").SerializableValue \| undefined>> \| undefined` | no | |
|
|
608
|
+
| props | property | `Record<string, unknown>` | yes | |
|
|
609
|
+
| stateAdapter | property | `StateAdapter \| undefined` | no | |
|
|
610
610
|
|
|
611
611
|
## RuntimeBindingResolutionContext
|
|
612
612
|
|
|
@@ -616,15 +616,15 @@ Source: `src/runtimeBindings.ts:56:1`
|
|
|
616
616
|
|
|
617
617
|
### Members
|
|
618
618
|
|
|
619
|
-
| Name
|
|
620
|
-
|
|
|
621
|
-
| apis
|
|
622
|
-
| context
|
|
623
|
-
| dataBindings
|
|
624
|
-
| event
|
|
625
|
-
| executeOperation | property | `RuntimeBindingOperationExecutor \| undefined`
|
|
626
|
-
| operationResults | property | `Readonly<Record<string, import("@ankhorage/contracts").SerializableValue \| undefined>> \| undefined` | no
|
|
627
|
-
| stateAdapter
|
|
619
|
+
| Name | Kind | Type | Required | Description |
|
|
620
|
+
| --- | --- | --- | --- | --- |
|
|
621
|
+
| apis | property | `ApiDefinitionRegistry \| undefined` | no | |
|
|
622
|
+
| context | property | `Record<string, unknown> \| undefined` | no | |
|
|
623
|
+
| dataBindings | property | `ComponentDataBindingRegistry \| undefined` | no | |
|
|
624
|
+
| event | property | `ComponentEventDto<string, object> \| undefined` | no | |
|
|
625
|
+
| executeOperation | property | `RuntimeBindingOperationExecutor \| undefined` | no | |
|
|
626
|
+
| operationResults | property | `Readonly<Record<string, import("@ankhorage/contracts").SerializableValue \| undefined>> \| undefined` | no | |
|
|
627
|
+
| stateAdapter | property | `StateAdapter \| undefined` | no | |
|
|
628
628
|
|
|
629
629
|
## RuntimeBindingResolutionResult
|
|
630
630
|
|
|
@@ -634,10 +634,10 @@ Source: `src/runtimeBindings.ts:71:1`
|
|
|
634
634
|
|
|
635
635
|
### Members
|
|
636
636
|
|
|
637
|
-
| Name
|
|
638
|
-
|
|
|
639
|
-
| diagnostics | property | `readonly DataSourceDiagnostic[]` | yes
|
|
640
|
-
| props
|
|
637
|
+
| Name | Kind | Type | Required | Description |
|
|
638
|
+
| --- | --- | --- | --- | --- |
|
|
639
|
+
| diagnostics | property | `readonly DataSourceDiagnostic[]` | yes | |
|
|
640
|
+
| props | property | `Record<string, unknown>` | yes | |
|
|
641
641
|
|
|
642
642
|
## RuntimeCapability
|
|
643
643
|
|
|
@@ -653,20 +653,20 @@ Source: `src/runtimeActionRegistry.ts:49:1`
|
|
|
653
653
|
|
|
654
654
|
### Members
|
|
655
655
|
|
|
656
|
-
| Name
|
|
657
|
-
|
|
|
658
|
-
| apis
|
|
659
|
-
| context
|
|
660
|
-
| dataBindings
|
|
661
|
-
| event
|
|
662
|
-
| eventName
|
|
663
|
-
| eventOperationLifecycle | property | `RuntimeEventOperationLifecycle \| undefined`
|
|
664
|
-
| executeAction
|
|
665
|
-
| executeOperation
|
|
666
|
-
| node
|
|
667
|
-
| operationResults
|
|
668
|
-
| state
|
|
669
|
-
| writeOperationResult
|
|
656
|
+
| Name | Kind | Type | Required | Description |
|
|
657
|
+
| --- | --- | --- | --- | --- |
|
|
658
|
+
| apis | property | `ApiDefinitionRegistry \| undefined` | no | |
|
|
659
|
+
| context | property | `Record<string, unknown> \| undefined` | no | |
|
|
660
|
+
| dataBindings | property | `ComponentDataBindingRegistry \| undefined` | no | |
|
|
661
|
+
| event | property | `ComponentEventDto<string, object>` | yes | |
|
|
662
|
+
| eventName | property | `string \| undefined` | no | |
|
|
663
|
+
| eventOperationLifecycle | property | `RuntimeEventOperationLifecycle \| undefined` | no | |
|
|
664
|
+
| executeAction | property | `RuntimeActionHandler \| undefined` | no | |
|
|
665
|
+
| executeOperation | property | `RuntimeBindingOperationExecutor \| undefined` | no | |
|
|
666
|
+
| node | property | `UiNode` | yes | |
|
|
667
|
+
| operationResults | property | `Readonly<Record<string, import("@ankhorage/contracts").SerializableValue \| undefined>> \| undefined` | no | |
|
|
668
|
+
| state | property | `Record<string, unknown> \| undefined` | no | |
|
|
669
|
+
| writeOperationResult | property | `RuntimeBindingOperationResultWriter \| undefined` | no | |
|
|
670
670
|
|
|
671
671
|
## RuntimeDbPersistError
|
|
672
672
|
|
|
@@ -676,10 +676,10 @@ Source: `src/runtimeDbPersist.ts:16:1`
|
|
|
676
676
|
|
|
677
677
|
### Members
|
|
678
678
|
|
|
679
|
-
| Name
|
|
680
|
-
|
|
|
681
|
-
| code
|
|
682
|
-
| message | property | `string` | yes
|
|
679
|
+
| Name | Kind | Type | Required | Description |
|
|
680
|
+
| --- | --- | --- | --- | --- |
|
|
681
|
+
| code | property | `string` | yes | |
|
|
682
|
+
| message | property | `string` | yes | |
|
|
683
683
|
|
|
684
684
|
## RuntimeDbPersistExecutionResult
|
|
685
685
|
|
|
@@ -695,10 +695,10 @@ Source: `src/runtimeDbPersist.ts:11:1`
|
|
|
695
695
|
|
|
696
696
|
### Members
|
|
697
697
|
|
|
698
|
-
| Name
|
|
699
|
-
|
|
|
700
|
-
| input
|
|
701
|
-
| result | property | `DbResult<DbRecord[]>`
|
|
698
|
+
| Name | Kind | Type | Required | Description |
|
|
699
|
+
| --- | --- | --- | --- | --- |
|
|
700
|
+
| input | property | `DbInsertInput<DbRecord>` | yes | |
|
|
701
|
+
| result | property | `DbResult<DbRecord[]>` | yes | |
|
|
702
702
|
|
|
703
703
|
## RuntimeDiagnostic
|
|
704
704
|
|
|
@@ -708,11 +708,11 @@ Source: `src/runtimeManifest.ts:12:1`
|
|
|
708
708
|
|
|
709
709
|
### Members
|
|
710
710
|
|
|
711
|
-
| Name
|
|
712
|
-
|
|
|
713
|
-
| code
|
|
714
|
-
| message
|
|
715
|
-
| severity | property | `"error" \| "info" \| "warning"` | yes
|
|
711
|
+
| Name | Kind | Type | Required | Description |
|
|
712
|
+
| --- | --- | --- | --- | --- |
|
|
713
|
+
| code | property | `string` | yes | |
|
|
714
|
+
| message | property | `string` | yes | |
|
|
715
|
+
| severity | property | `"error" \| "info" \| "warning"` | yes | |
|
|
716
716
|
|
|
717
717
|
## RuntimeEventDiagnosticsReporter
|
|
718
718
|
|
|
@@ -722,10 +722,10 @@ Source: `src/runtimeEventExecution.ts:9:1`
|
|
|
722
722
|
|
|
723
723
|
### Members
|
|
724
724
|
|
|
725
|
-
| Name
|
|
726
|
-
|
|
|
727
|
-
| consoleImpl
|
|
728
|
-
| onDiagnostics | property | `((diagnostics: readonly DataSourceDiagnostic[]) => void) \| undefined` | no
|
|
725
|
+
| Name | Kind | Type | Required | Description |
|
|
726
|
+
| --- | --- | --- | --- | --- |
|
|
727
|
+
| consoleImpl | property | `Pick<Console, "error" \| "warn"> \| undefined` | no | |
|
|
728
|
+
| onDiagnostics | property | `((diagnostics: readonly DataSourceDiagnostic[]) => void) \| undefined` | no | |
|
|
729
729
|
|
|
730
730
|
## RuntimeEventOperationInvocation
|
|
731
731
|
|
|
@@ -735,9 +735,9 @@ Source: `src/runtimeEventOperationLifecycle.ts:14:1`
|
|
|
735
735
|
|
|
736
736
|
### Members
|
|
737
737
|
|
|
738
|
-
| Name | Kind
|
|
739
|
-
|
|
|
740
|
-
| id
|
|
738
|
+
| Name | Kind | Type | Required | Description |
|
|
739
|
+
| --- | --- | --- | --- | --- |
|
|
740
|
+
| id | property | `number` | yes | |
|
|
741
741
|
|
|
742
742
|
## RuntimeEventOperationLifecycle
|
|
743
743
|
|
|
@@ -747,11 +747,11 @@ Source: `src/runtimeEventOperationLifecycle.ts:18:1`
|
|
|
747
747
|
|
|
748
748
|
### Members
|
|
749
749
|
|
|
750
|
-
| Name
|
|
751
|
-
|
|
|
752
|
-
| fail
|
|
753
|
-
| start
|
|
754
|
-
| succeed | method | `(invocation: RuntimeEventOperationInvocation) => void`
|
|
750
|
+
| Name | Kind | Type | Required | Description |
|
|
751
|
+
| --- | --- | --- | --- | --- |
|
|
752
|
+
| fail | method | `(invocation: RuntimeEventOperationInvocation, message: string) => void` | yes | |
|
|
753
|
+
| start | method | `(args: { readonly nodeId: string; readonly operation: BindingOperationRef; }) => RuntimeEventOperationInvocation \| undefined` | yes | |
|
|
754
|
+
| succeed | method | `(invocation: RuntimeEventOperationInvocation) => void` | yes | |
|
|
755
755
|
|
|
756
756
|
## RuntimeEventOperationState
|
|
757
757
|
|
|
@@ -761,13 +761,13 @@ Source: `src/runtimeEventOperationLifecycle.ts:6:1`
|
|
|
761
761
|
|
|
762
762
|
### Members
|
|
763
763
|
|
|
764
|
-
| Name
|
|
765
|
-
|
|
|
766
|
-
| errorMessage | property | `string`
|
|
767
|
-
| loading
|
|
768
|
-
| nodeId
|
|
769
|
-
| operation
|
|
770
|
-
| status
|
|
764
|
+
| Name | Kind | Type | Required | Description |
|
|
765
|
+
| --- | --- | --- | --- | --- |
|
|
766
|
+
| errorMessage | property | `string` | yes | |
|
|
767
|
+
| loading | property | `boolean` | yes | |
|
|
768
|
+
| nodeId | property | `string \| undefined` | no | |
|
|
769
|
+
| operation | property | `BindingOperationRef \| undefined` | no | |
|
|
770
|
+
| status | property | `RuntimeEventOperationStatus` | yes | |
|
|
771
771
|
|
|
772
772
|
## RuntimeEventOperationStatus
|
|
773
773
|
|
|
@@ -783,16 +783,16 @@ Source: `src/runtimeActionRegistry.ts:61:1`
|
|
|
783
783
|
|
|
784
784
|
### Members
|
|
785
785
|
|
|
786
|
-
| Name
|
|
787
|
-
|
|
|
788
|
-
| context
|
|
789
|
-
| dataBindings
|
|
790
|
-
| disableActions
|
|
791
|
-
| dispatchComponentEvent | property | `(args: RuntimeComponentEventDispatchArgs) => Promise<void> \| void`
|
|
792
|
-
| node
|
|
793
|
-
| operationResults
|
|
794
|
-
| props
|
|
795
|
-
| state
|
|
786
|
+
| Name | Kind | Type | Required | Description |
|
|
787
|
+
| --- | --- | --- | --- | --- |
|
|
788
|
+
| context | property | `Record<string, unknown> \| undefined` | no | |
|
|
789
|
+
| dataBindings | property | `ComponentDataBindingRegistry \| undefined` | no | |
|
|
790
|
+
| disableActions | property | `boolean` | yes | |
|
|
791
|
+
| dispatchComponentEvent | property | `(args: RuntimeComponentEventDispatchArgs) => Promise<void> \| void` | yes | |
|
|
792
|
+
| node | property | `UiNode` | yes | |
|
|
793
|
+
| operationResults | property | `Readonly<Record<string, import("@ankhorage/contracts").SerializableValue \| undefined>> \| undefined` | no | |
|
|
794
|
+
| props | property | `Record<string, unknown>` | yes | |
|
|
795
|
+
| state | property | `Record<string, unknown> \| undefined` | no | |
|
|
796
796
|
|
|
797
797
|
## RuntimeManifest
|
|
798
798
|
|
|
@@ -802,15 +802,15 @@ Source: `src/runtimeManifest.ts:45:1`
|
|
|
802
802
|
|
|
803
803
|
### Members
|
|
804
804
|
|
|
805
|
-
| Name
|
|
806
|
-
|
|
|
807
|
-
| actions
|
|
808
|
-
| adapters
|
|
809
|
-
| bindings
|
|
810
|
-
| config
|
|
811
|
-
| diagnostics | property | `readonly RuntimeDiagnostic[]`
|
|
812
|
-
| kind
|
|
813
|
-
| version
|
|
805
|
+
| Name | Kind | Type | Required | Description |
|
|
806
|
+
| --- | --- | --- | --- | --- |
|
|
807
|
+
| actions | property | `readonly RuntimeActionDescriptor<unknown>[]` | yes | |
|
|
808
|
+
| adapters | property | `readonly RuntimeAdapterDescriptor<unknown>[]` | yes | |
|
|
809
|
+
| bindings | property | `readonly RuntimeBindingDescriptor<unknown>[]` | yes | |
|
|
810
|
+
| config | property | `RuntimeManifestConfig` | yes | |
|
|
811
|
+
| diagnostics | property | `readonly RuntimeDiagnostic[]` | yes | |
|
|
812
|
+
| kind | property | `"ankhorage-runtime-manifest"` | yes | |
|
|
813
|
+
| version | property | `1` | yes | |
|
|
814
814
|
|
|
815
815
|
## RuntimeManifestConfig
|
|
816
816
|
|
|
@@ -820,11 +820,11 @@ Source: `src/runtimeManifest.ts:18:1`
|
|
|
820
820
|
|
|
821
821
|
### Members
|
|
822
822
|
|
|
823
|
-
| Name
|
|
824
|
-
|
|
|
825
|
-
| appId
|
|
826
|
-
| environment | property | `string \| undefined`
|
|
827
|
-
| values
|
|
823
|
+
| Name | Kind | Type | Required | Description |
|
|
824
|
+
| --- | --- | --- | --- | --- |
|
|
825
|
+
| appId | property | `string` | yes | |
|
|
826
|
+
| environment | property | `string \| undefined` | no | |
|
|
827
|
+
| values | property | `Readonly<Record<string, unknown>> \| undefined` | no | |
|
|
828
828
|
|
|
829
829
|
## RuntimeManifestInput
|
|
830
830
|
|
|
@@ -834,13 +834,13 @@ Source: `src/runtimeManifest.ts:55:1`
|
|
|
834
834
|
|
|
835
835
|
### Members
|
|
836
836
|
|
|
837
|
-
| Name
|
|
838
|
-
|
|
|
839
|
-
| actions
|
|
840
|
-
| adapters
|
|
841
|
-
| bindings
|
|
842
|
-
| config
|
|
843
|
-
| diagnostics | property | `readonly RuntimeDiagnostic[] \| undefined`
|
|
837
|
+
| Name | Kind | Type | Required | Description |
|
|
838
|
+
| --- | --- | --- | --- | --- |
|
|
839
|
+
| actions | property | `readonly RuntimeActionDescriptor<unknown>[] \| undefined` | no | |
|
|
840
|
+
| adapters | property | `readonly RuntimeAdapterDescriptor<unknown>[] \| undefined` | no | |
|
|
841
|
+
| bindings | property | `readonly RuntimeBindingDescriptor<unknown>[] \| undefined` | no | |
|
|
842
|
+
| config | property | `RuntimeManifestConfig` | yes | |
|
|
843
|
+
| diagnostics | property | `readonly RuntimeDiagnostic[] \| undefined` | no | |
|
|
844
844
|
|
|
845
845
|
## RuntimeMediaAssetResolver
|
|
846
846
|
|
|
@@ -856,9 +856,9 @@ Source: `src/runtimeMedia.ts:9:1`
|
|
|
856
856
|
|
|
857
857
|
### Members
|
|
858
858
|
|
|
859
|
-
| Name
|
|
860
|
-
|
|
|
861
|
-
| asset | property | `MediaAsset` | yes
|
|
859
|
+
| Name | Kind | Type | Required | Description |
|
|
860
|
+
| --- | --- | --- | --- | --- |
|
|
861
|
+
| asset | property | `MediaAsset` | yes | |
|
|
862
862
|
|
|
863
863
|
## RuntimeMemoryStateAdapterOptions
|
|
864
864
|
|
|
@@ -868,9 +868,9 @@ Source: `src/runtimeStateAdapter.ts:14:1`
|
|
|
868
868
|
|
|
869
869
|
### Members
|
|
870
870
|
|
|
871
|
-
| Name
|
|
872
|
-
|
|
|
873
|
-
| initialState | property | `Readonly<Record<string, import("@ankhorage/contracts").SerializableValue>> \| undefined` | no
|
|
871
|
+
| Name | Kind | Type | Required | Description |
|
|
872
|
+
| --- | --- | --- | --- | --- |
|
|
873
|
+
| initialState | property | `Readonly<Record<string, import("@ankhorage/contracts").SerializableValue>> \| undefined` | no | |
|
|
874
874
|
|
|
875
875
|
## RuntimeNodePropsResolver
|
|
876
876
|
|
|
@@ -898,28 +898,28 @@ Source: `src/RuntimeRendererConfig.tsx:51:1`
|
|
|
898
898
|
|
|
899
899
|
### Members
|
|
900
900
|
|
|
901
|
-
| Name
|
|
902
|
-
|
|
|
903
|
-
| actionHandlers
|
|
904
|
-
| apis
|
|
905
|
-
| bindingContext
|
|
906
|
-
| dataBindings
|
|
907
|
-
| dbAdapter
|
|
908
|
-
| dbRealtimeAdapter
|
|
909
|
-
| disableActions
|
|
910
|
-
| eventOperationLifecycle | property | `RuntimeEventOperationLifecycle \| undefined`
|
|
911
|
-
| eventOperationState
|
|
912
|
-
| executeAction
|
|
913
|
-
| executeOperation
|
|
914
|
-
| mediaAssets
|
|
915
|
-
| onDiagnostics
|
|
916
|
-
| operationResults
|
|
917
|
-
| registry
|
|
918
|
-
| resolveMediaAsset
|
|
919
|
-
| resolveNodeProps
|
|
920
|
-
| stateAdapter
|
|
921
|
-
| wrapNode
|
|
922
|
-
| writeOperationResult
|
|
901
|
+
| Name | Kind | Type | Required | Description |
|
|
902
|
+
| --- | --- | --- | --- | --- |
|
|
903
|
+
| actionHandlers | property | `RuntimeActionHandlers \| undefined` | no | |
|
|
904
|
+
| apis | property | `ApiDefinitionRegistry \| undefined` | no | |
|
|
905
|
+
| bindingContext | property | `Record<string, unknown> \| undefined` | no | |
|
|
906
|
+
| dataBindings | property | `ComponentDataBindingRegistry \| undefined` | no | |
|
|
907
|
+
| dbAdapter | property | `DbAdapter \| undefined` | no | |
|
|
908
|
+
| dbRealtimeAdapter | property | `DbRealtimeAdapter \| undefined` | no | |
|
|
909
|
+
| disableActions | property | `boolean \| undefined` | no | |
|
|
910
|
+
| eventOperationLifecycle | property | `RuntimeEventOperationLifecycle \| undefined` | no | |
|
|
911
|
+
| eventOperationState | property | `RuntimeEventOperationState \| undefined` | no | |
|
|
912
|
+
| executeAction | property | `RuntimeActionHandler \| undefined` | no | |
|
|
913
|
+
| executeOperation | property | `RuntimeBindingOperationExecutor \| undefined` | no | |
|
|
914
|
+
| mediaAssets | property | `MediaAssetRegistry \| undefined` | no | |
|
|
915
|
+
| onDiagnostics | property | `((diagnostics: readonly DataSourceDiagnostic[]) => void) \| undefined` | no | |
|
|
916
|
+
| operationResults | property | `Readonly<Record<string, import("@ankhorage/contracts").SerializableValue \| undefined>> \| undefined` | no | |
|
|
917
|
+
| registry | property | `Readonly<Record<string, React.ElementType<any, keyof React.JSX.IntrinsicElements>>> \| undefined` | no | |
|
|
918
|
+
| resolveMediaAsset | property | `RuntimeMediaAssetResolver \| undefined` | no | |
|
|
919
|
+
| resolveNodeProps | property | `RuntimeNodePropsResolver \| undefined` | no | |
|
|
920
|
+
| stateAdapter | property | `StateAdapter \| undefined` | no | |
|
|
921
|
+
| wrapNode | property | `((args: RuntimeRendererWrapArgs) => React.ReactNode) \| undefined` | no | |
|
|
922
|
+
| writeOperationResult | property | `RuntimeBindingOperationResultWriter \| undefined` | no | |
|
|
923
923
|
|
|
924
924
|
## RuntimeRendererConfigProvider
|
|
925
925
|
|
|
@@ -941,25 +941,25 @@ Source: `src/RuntimeRenderer.tsx:61:1`
|
|
|
941
941
|
|
|
942
942
|
### Members
|
|
943
943
|
|
|
944
|
-
| Name
|
|
945
|
-
|
|
|
946
|
-
| apis
|
|
947
|
-
| bindingContext
|
|
948
|
-
| dataBindings
|
|
949
|
-
| dbAdapter
|
|
950
|
-
| dbRealtimeAdapter | property | `DbRealtimeAdapter \| undefined`
|
|
951
|
-
| disableActions
|
|
952
|
-
| executeAction
|
|
953
|
-
| executeOperation
|
|
954
|
-
| isRoot
|
|
955
|
-
| mediaAssets
|
|
956
|
-
| node
|
|
957
|
-
| onDiagnostics
|
|
958
|
-
| operationResults
|
|
959
|
-
| registry
|
|
960
|
-
| resolveMediaAsset | property | `RuntimeMediaAssetResolver \| undefined`
|
|
961
|
-
| stateAdapter
|
|
962
|
-
| wrapNode
|
|
944
|
+
| Name | Kind | Type | Required | Description |
|
|
945
|
+
| --- | --- | --- | --- | --- |
|
|
946
|
+
| apis | property | `ApiDefinitionRegistry \| undefined` | no | |
|
|
947
|
+
| bindingContext | property | `Record<string, unknown> \| undefined` | no | |
|
|
948
|
+
| dataBindings | property | `ComponentDataBindingRegistry \| undefined` | no | |
|
|
949
|
+
| dbAdapter | property | `DbAdapter \| undefined` | no | |
|
|
950
|
+
| dbRealtimeAdapter | property | `DbRealtimeAdapter \| undefined` | no | |
|
|
951
|
+
| disableActions | property | `boolean \| undefined` | no | |
|
|
952
|
+
| executeAction | property | `import("./RuntimeRendererConfig").RuntimeActionHandler \| undefined` | no | |
|
|
953
|
+
| executeOperation | property | `RuntimeBindingOperationExecutor \| undefined` | no | |
|
|
954
|
+
| isRoot | property | `boolean \| undefined` | no | |
|
|
955
|
+
| mediaAssets | property | `MediaAssetRegistry \| undefined` | no | |
|
|
956
|
+
| node | property | `UiNode` | yes | |
|
|
957
|
+
| onDiagnostics | property | `((diagnostics: readonly DataSourceDiagnostic[]) => void) \| undefined` | no | |
|
|
958
|
+
| operationResults | property | `Readonly<Record<string, import("@ankhorage/contracts").SerializableValue \| undefined>> \| undefined` | no | |
|
|
959
|
+
| registry | property | `Readonly<Record<string, React.ElementType<any, keyof React.JSX.IntrinsicElements>>> \| undefined` | no | |
|
|
960
|
+
| resolveMediaAsset | property | `RuntimeMediaAssetResolver \| undefined` | no | |
|
|
961
|
+
| stateAdapter | property | `StateAdapter \| undefined` | no | |
|
|
962
|
+
| wrapNode | property | `((args: RuntimeRendererWrapArgs) => React.ReactNode) \| undefined` | no | |
|
|
963
963
|
|
|
964
964
|
## RuntimeRendererWrapArgs
|
|
965
965
|
|
|
@@ -969,11 +969,11 @@ Source: `src/RuntimeRendererConfig.tsx:33:1`
|
|
|
969
969
|
|
|
970
970
|
### Members
|
|
971
971
|
|
|
972
|
-
| Name
|
|
973
|
-
|
|
|
974
|
-
| isRoot
|
|
975
|
-
| node
|
|
976
|
-
| rendered | property | `React.ReactNode` | yes
|
|
972
|
+
| Name | Kind | Type | Required | Description |
|
|
973
|
+
| --- | --- | --- | --- | --- |
|
|
974
|
+
| isRoot | property | `boolean` | yes | |
|
|
975
|
+
| node | property | `UiNode` | yes | |
|
|
976
|
+
| rendered | property | `React.ReactNode` | yes | |
|
|
977
977
|
|
|
978
978
|
## RuntimeResolvedMediaValue
|
|
979
979
|
|
|
@@ -989,10 +989,10 @@ Source: `node_modules/@ankhorage/contracts/dist/runtimeCallbacks.d.ts:2:1`
|
|
|
989
989
|
|
|
990
990
|
### Members
|
|
991
991
|
|
|
992
|
-
| Name
|
|
993
|
-
|
|
|
994
|
-
| node
|
|
995
|
-
| props | property | `Record<string, unknown>` | yes
|
|
992
|
+
| Name | Kind | Type | Required | Description |
|
|
993
|
+
| --- | --- | --- | --- | --- |
|
|
994
|
+
| node | property | `UiNode` | yes | |
|
|
995
|
+
| props | property | `Record<string, unknown>` | yes | |
|
|
996
996
|
|
|
997
997
|
## RuntimeScreen
|
|
998
998
|
|
|
@@ -1014,11 +1014,11 @@ Source: `src/runtimeScreenLoaders.ts:25:1`
|
|
|
1014
1014
|
|
|
1015
1015
|
### Members
|
|
1016
1016
|
|
|
1017
|
-
| Name
|
|
1018
|
-
|
|
|
1019
|
-
| dependencyKey
|
|
1020
|
-
| diagnostics
|
|
1021
|
-
| operationResults | property | `Readonly<Record<string, import("@ankhorage/contracts").SerializableValue \| undefined>>` | yes
|
|
1017
|
+
| Name | Kind | Type | Required | Description |
|
|
1018
|
+
| --- | --- | --- | --- | --- |
|
|
1019
|
+
| dependencyKey | property | `string` | yes | |
|
|
1020
|
+
| diagnostics | property | `readonly DataSourceDiagnostic[]` | yes | |
|
|
1021
|
+
| operationResults | property | `Readonly<Record<string, import("@ankhorage/contracts").SerializableValue \| undefined>>` | yes | |
|
|
1022
1022
|
|
|
1023
1023
|
## RuntimeScreenOperationLoaderState
|
|
1024
1024
|
|
|
@@ -1028,12 +1028,12 @@ Source: `src/runtimeScreenLoaders.ts:18:1`
|
|
|
1028
1028
|
|
|
1029
1029
|
### Members
|
|
1030
1030
|
|
|
1031
|
-
| Name
|
|
1032
|
-
|
|
|
1033
|
-
| dependencyKey
|
|
1034
|
-
| diagnostics
|
|
1035
|
-
| operationResults | property | `Readonly<Record<string, import("@ankhorage/contracts").SerializableValue \| undefined>>` | yes
|
|
1036
|
-
| renderVersion
|
|
1031
|
+
| Name | Kind | Type | Required | Description |
|
|
1032
|
+
| --- | --- | --- | --- | --- |
|
|
1033
|
+
| dependencyKey | property | `string` | yes | |
|
|
1034
|
+
| diagnostics | property | `readonly DataSourceDiagnostic[]` | yes | |
|
|
1035
|
+
| operationResults | property | `Readonly<Record<string, import("@ankhorage/contracts").SerializableValue \| undefined>>` | yes | |
|
|
1036
|
+
| renderVersion | property | `number` | yes | |
|
|
1037
1037
|
|
|
1038
1038
|
## RuntimeScreenProps
|
|
1039
1039
|
|
|
@@ -1043,12 +1043,12 @@ Source: `src/RuntimeScreen.tsx:10:1`
|
|
|
1043
1043
|
|
|
1044
1044
|
### Members
|
|
1045
1045
|
|
|
1046
|
-
| Name
|
|
1047
|
-
|
|
|
1048
|
-
| manifest
|
|
1049
|
-
| registry
|
|
1050
|
-
| screen
|
|
1051
|
-
| stateAdapter | property | `StateAdapter \| undefined`
|
|
1046
|
+
| Name | Kind | Type | Required | Description |
|
|
1047
|
+
| --- | --- | --- | --- | --- |
|
|
1048
|
+
| manifest | property | `AppManifest` | yes | |
|
|
1049
|
+
| registry | property | `Readonly<Record<string, React.ElementType<any, keyof React.JSX.IntrinsicElements>>> \| undefined` | no | |
|
|
1050
|
+
| screen | property | `ScreenSpec` | yes | |
|
|
1051
|
+
| stateAdapter | property | `StateAdapter \| undefined` | no | |
|
|
1052
1052
|
|
|
1053
1053
|
## shouldRenderRuntimeRepeatEmptyState
|
|
1054
1054
|
|
|
@@ -1126,8 +1126,8 @@ Source: `src/runtimeApiSelection.ts:15:1`
|
|
|
1126
1126
|
|
|
1127
1127
|
### Signatures
|
|
1128
1128
|
|
|
1129
|
-
- `(operation: BindingOperationRef, apis:
|
|
1130
|
-
- apis: `
|
|
1129
|
+
- `(operation: BindingOperationRef, apis: ApiDefinitionRegistry | undefined) => readonly DataSourceDiagnostic[]`
|
|
1130
|
+
- apis: `ApiDefinitionRegistry | undefined`
|
|
1131
1131
|
- operation: `BindingOperationRef`
|
|
1132
1132
|
- returns: `readonly DataSourceDiagnostic[]`
|
|
1133
1133
|
|