@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.
Files changed (36) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/README.md +1 -1
  3. package/dist/RuntimeScreen.d.ts.map +1 -1
  4. package/dist/RuntimeScreen.js +5 -43
  5. package/dist/RuntimeScreen.js.map +1 -1
  6. package/dist/index.d.ts +1 -3
  7. package/dist/index.d.ts.map +1 -1
  8. package/dist/index.js +1 -2
  9. package/dist/index.js.map +1 -1
  10. package/dist/runtimeDataSourceOperations.d.ts +3 -1
  11. package/dist/runtimeDataSourceOperations.d.ts.map +1 -1
  12. package/dist/runtimeDataSourceOperations.js +31 -26
  13. package/dist/runtimeDataSourceOperations.js.map +1 -1
  14. package/dist/runtimeDatabaseOperationExecutor.d.ts +9 -0
  15. package/dist/runtimeDatabaseOperationExecutor.d.ts.map +1 -0
  16. package/dist/runtimeDatabaseOperationExecutor.js +228 -0
  17. package/dist/runtimeDatabaseOperationExecutor.js.map +1 -0
  18. package/dist/runtimeScreenLoaders.d.ts +1 -2
  19. package/dist/runtimeScreenLoaders.d.ts.map +1 -1
  20. package/dist/runtimeScreenLoaders.js +1 -4
  21. package/dist/runtimeScreenLoaders.js.map +1 -1
  22. package/package.json +3 -3
  23. package/paradox/badges/npm.svg +3 -3
  24. package/paradox/components.md +1 -1
  25. package/paradox/diagrams/architecture-overview.mmd +5 -9
  26. package/paradox/diagrams/export-graph.mmd +1 -28
  27. package/paradox/diagrams/module-relationships.mmd +4 -7
  28. package/paradox/diagrams/sequences/runtime-screen.mmd +0 -3
  29. package/paradox/exports.json +30 -293
  30. package/paradox/exports.md +94 -193
  31. package/paradox/index.html +377 -700
  32. package/paradox/paradox.json +686 -890
  33. package/dist/runtimeApiLoaders.d.ts +0 -35
  34. package/dist/runtimeApiLoaders.d.ts.map +0 -1
  35. package/dist/runtimeApiLoaders.js +0 -218
  36. package/dist/runtimeApiLoaders.js.map +0 -1
package/paradox/exports.json CHANGED
@@ -230,7 +230,7 @@
230
230
  "modulePath": "src/runtimeScreenLoaders.ts",
231
231
  "sourceLocation": {
232
232
  "filePath": "src/runtimeScreenLoaders.ts",
233
- "line": 93,
233
+ "line": 82,
234
234
  "column": 1
235
235
  },
236
236
  "exportPaths": ["src/index.ts"],
@@ -333,7 +333,7 @@
333
333
  "modulePath": "src/runtimeDataSourceOperations.ts",
334
334
  "sourceLocation": {
335
335
  "filePath": "src/runtimeDataSourceOperations.ts",
336
- "line": 12,
336
+ "line": 14,
337
337
  "column": 1
338
338
  },
339
339
  "exportPaths": ["src/index.ts"],
@@ -432,7 +432,7 @@
432
432
  "modulePath": "src/runtimeScreenLoaders.ts",
433
433
  "sourceLocation": {
434
434
  "filePath": "src/runtimeScreenLoaders.ts",
435
- "line": 60,
435
+ "line": 49,
436
436
  "column": 1
437
437
  },
438
438
  "exportPaths": ["src/index.ts"],
@@ -651,38 +651,6 @@
651
651
  "members": [],
652
652
  "structuredRows": []
653
653
  },
654
- {
655
- "name": "executeRuntimeApiLoaders",
656
- "description": null,
657
- "isReadme": false,
658
- "examples": [],
659
- "kind": "function",
660
- "modulePath": "src/runtimeApiLoaders.ts",
661
- "sourceLocation": {
662
- "filePath": "src/runtimeApiLoaders.ts",
663
- "line": 100,
664
- "column": 1
665
- },
666
- "exportPaths": ["src/index.ts"],
667
- "relatedSymbols": ["RuntimeApiLoaderDefinition", "RuntimeApiLoaderExecutionResult"],
668
- "signatures": [
669
- {
670
- "label": "(args: { readonly data?: AppDataManifest; readonly loaders: readonly RuntimeApiLoaderDefinition[]; readonly stateAdapter: StateAdapter; }) => RuntimeApiLoaderExecutionResult",
671
- "parameters": [
672
- {
673
- "name": "args",
674
- "type": "{ readonly data?: AppDataManifest; readonly loaders: readonly RuntimeApiLoaderDefinition[]; readonly stateAdapter: StateAdapter; }",
675
- "required": true,
676
- "description": null
677
- }
678
- ],
679
- "returnType": "RuntimeApiLoaderExecutionResult",
680
- "returnDescription": null
681
- }
682
- ],
683
- "members": [],
684
- "structuredRows": []
685
- },
686
654
  {
687
655
  "name": "executeRuntimeScreenOperationLoaders",
688
656
  "description": null,
@@ -692,7 +660,7 @@
692
660
  "modulePath": "src/runtimeScreenLoaders.ts",
693
661
  "sourceLocation": {
694
662
  "filePath": "src/runtimeScreenLoaders.ts",
695
- "line": 189,
663
+ "line": 178,
696
664
  "column": 1
697
665
  },
698
666
  "exportPaths": ["src/index.ts"],
@@ -795,38 +763,6 @@
795
763
  "members": [],
796
764
  "structuredRows": []
797
765
  },
798
- {
799
- "name": "materializeRuntimeApiLoaderState",
800
- "description": null,
801
- "isReadme": false,
802
- "examples": [],
803
- "kind": "function",
804
- "modulePath": "src/runtimeApiLoaders.ts",
805
- "sourceLocation": {
806
- "filePath": "src/runtimeApiLoaders.ts",
807
- "line": 40,
808
- "column": 1
809
- },
810
- "exportPaths": ["src/index.ts"],
811
- "relatedSymbols": ["RuntimeApiLoaderDefinition", "RuntimeApiLoaderMaterializationResult"],
812
- "signatures": [
813
- {
814
- "label": "(args: { readonly data?: AppDataManifest; readonly loaders: readonly RuntimeApiLoaderDefinition[]; }) => RuntimeApiLoaderMaterializationResult",
815
- "parameters": [
816
- {
817
- "name": "args",
818
- "type": "{ readonly data?: AppDataManifest; readonly loaders: readonly RuntimeApiLoaderDefinition[]; }",
819
- "required": true,
820
- "description": null
821
- }
822
- ],
823
- "returnType": "RuntimeApiLoaderMaterializationResult",
824
- "returnDescription": null
825
- }
826
- ],
827
- "members": [],
828
- "structuredRows": []
829
- },
830
766
  {
831
767
  "name": "mergeRuntimeRendererConfig",
832
768
  "description": null,
@@ -1169,38 +1105,6 @@
1169
1105
  "members": [],
1170
1106
  "structuredRows": []
1171
1107
  },
1172
- {
1173
- "name": "resolveScreenApiLoaders",
1174
- "description": null,
1175
- "isReadme": false,
1176
- "examples": [],
1177
- "kind": "function",
1178
- "modulePath": "src/runtimeScreenLoaders.ts",
1179
- "sourceLocation": {
1180
- "filePath": "src/runtimeScreenLoaders.ts",
1181
- "line": 44,
1182
- "column": 1
1183
- },
1184
- "exportPaths": ["src/index.ts"],
1185
- "relatedSymbols": [],
1186
- "signatures": [
1187
- {
1188
- "label": "(screen: ScreenSpec) => readonly ApiScreenDataLoaderDefinition[]",
1189
- "parameters": [
1190
- {
1191
- "name": "screen",
1192
- "type": "ScreenSpec",
1193
- "required": true,
1194
- "description": null
1195
- }
1196
- ],
1197
- "returnType": "readonly ApiScreenDataLoaderDefinition[]",
1198
- "returnDescription": null
1199
- }
1200
- ],
1201
- "members": [],
1202
- "structuredRows": []
1203
- },
1204
1108
  {
1205
1109
  "name": "resolveScreenOperationLoaders",
1206
1110
  "description": null,
@@ -1210,7 +1114,7 @@
1210
1114
  "modulePath": "src/runtimeScreenLoaders.ts",
1211
1115
  "sourceLocation": {
1212
1116
  "filePath": "src/runtimeScreenLoaders.ts",
1213
- "line": 52,
1117
+ "line": 43,
1214
1118
  "column": 1
1215
1119
  },
1216
1120
  "exportPaths": ["src/index.ts"],
@@ -1595,148 +1499,6 @@
1595
1499
  ],
1596
1500
  "structuredRows": []
1597
1501
  },
1598
- {
1599
- "name": "RuntimeApiLoaderDefinition",
1600
- "description": null,
1601
- "isReadme": false,
1602
- "examples": [],
1603
- "kind": "unknown",
1604
- "modulePath": "src/runtimeApiLoaders.ts",
1605
- "sourceLocation": {
1606
- "filePath": "src/runtimeApiLoaders.ts",
1607
- "line": 17,
1608
- "column": 1
1609
- },
1610
- "exportPaths": ["src/index.ts"],
1611
- "relatedSymbols": [],
1612
- "signatures": [],
1613
- "members": [],
1614
- "structuredRows": []
1615
- },
1616
- {
1617
- "name": "RuntimeApiLoaderDiagnostic",
1618
- "description": null,
1619
- "isReadme": false,
1620
- "examples": [],
1621
- "kind": "type",
1622
- "modulePath": "src/runtimeApiLoaders.ts",
1623
- "sourceLocation": {
1624
- "filePath": "src/runtimeApiLoaders.ts",
1625
- "line": 19,
1626
- "column": 1
1627
- },
1628
- "exportPaths": ["src/index.ts"],
1629
- "relatedSymbols": [],
1630
- "signatures": [],
1631
- "members": [
1632
- {
1633
- "name": "apiId",
1634
- "kind": "property",
1635
- "type": "string | undefined",
1636
- "required": false,
1637
- "description": null
1638
- },
1639
- {
1640
- "name": "code",
1641
- "kind": "property",
1642
- "type": "\"invalid-record\" | \"missing-api\" | \"missing-target-path\" | \"state-set-failed\" | \"unsupported-loader\"",
1643
- "required": true,
1644
- "description": null
1645
- },
1646
- {
1647
- "name": "message",
1648
- "kind": "property",
1649
- "type": "string",
1650
- "required": true,
1651
- "description": null
1652
- },
1653
- {
1654
- "name": "targetPath",
1655
- "kind": "property",
1656
- "type": "string | undefined",
1657
- "required": false,
1658
- "description": null
1659
- }
1660
- ],
1661
- "structuredRows": []
1662
- },
1663
- {
1664
- "name": "RuntimeApiLoaderExecutionResult",
1665
- "description": null,
1666
- "isReadme": false,
1667
- "examples": [],
1668
- "kind": "type",
1669
- "modulePath": "src/runtimeApiLoaders.ts",
1670
- "sourceLocation": {
1671
- "filePath": "src/runtimeApiLoaders.ts",
1672
- "line": 31,
1673
- "column": 1
1674
- },
1675
- "exportPaths": ["src/index.ts"],
1676
- "relatedSymbols": ["RuntimeApiLoaderDiagnostic"],
1677
- "signatures": [],
1678
- "members": [
1679
- {
1680
- "name": "diagnostics",
1681
- "kind": "property",
1682
- "type": "readonly RuntimeApiLoaderDiagnostic[]",
1683
- "required": true,
1684
- "description": null
1685
- }
1686
- ],
1687
- "structuredRows": []
1688
- },
1689
- {
1690
- "name": "RuntimeApiLoaderMaterializationResult",
1691
- "description": null,
1692
- "isReadme": false,
1693
- "examples": [],
1694
- "kind": "type",
1695
- "modulePath": "src/runtimeApiLoaders.ts",
1696
- "sourceLocation": {
1697
- "filePath": "src/runtimeApiLoaders.ts",
1698
- "line": 35,
1699
- "column": 1
1700
- },
1701
- "exportPaths": ["src/index.ts"],
1702
- "relatedSymbols": ["RuntimeApiLoaderDiagnostic"],
1703
- "signatures": [],
1704
- "members": [
1705
- {
1706
- "name": "diagnostics",
1707
- "kind": "property",
1708
- "type": "readonly RuntimeApiLoaderDiagnostic[]",
1709
- "required": true,
1710
- "description": null
1711
- },
1712
- {
1713
- "name": "state",
1714
- "kind": "property",
1715
- "type": "Readonly<Record<string, StateValue>>",
1716
- "required": true,
1717
- "description": null
1718
- }
1719
- ],
1720
- "structuredRows": []
1721
- },
1722
- {
1723
- "name": "RuntimeApiLoaderMode",
1724
- "description": null,
1725
- "isReadme": false,
1726
- "examples": [],
1727
- "kind": "unknown",
1728
- "modulePath": "src/runtimeApiLoaders.ts",
1729
- "sourceLocation": {
1730
- "filePath": "src/runtimeApiLoaders.ts",
1731
- "line": 15,
1732
- "column": 1
1733
- },
1734
- "exportPaths": ["src/index.ts"],
1735
- "relatedSymbols": [],
1736
- "signatures": [],
1737
- "members": [],
1738
- "structuredRows": []
1739
- },
1740
1502
  {
1741
1503
  "name": "RuntimeBindingDescriptor",
1742
1504
  "description": null,
@@ -1961,7 +1723,7 @@
1961
1723
  {
1962
1724
  "name": "dataBindings",
1963
1725
  "kind": "property",
1964
- "type": "Readonly<Record<string, import(\"/Users/a_rtiphishl_e/git/runtime/node_modules/@ankhorage/contracts/dist/bindings\").ComponentDataBinding>> | undefined",
1726
+ "type": "Readonly<Record<string, import(\"/home/runner/work/runtime/runtime/node_modules/@ankhorage/contracts/dist/bindings\").ComponentDataBinding>> | undefined",
1965
1727
  "required": false,
1966
1728
  "description": null
1967
1729
  },
@@ -2043,7 +1805,7 @@
2043
1805
  {
2044
1806
  "name": "dataBindings",
2045
1807
  "kind": "property",
2046
- "type": "Readonly<Record<string, import(\"/Users/a_rtiphishl_e/git/runtime/node_modules/@ankhorage/contracts/dist/bindings\").ComponentDataBinding>> | undefined",
1808
+ "type": "Readonly<Record<string, import(\"/home/runner/work/runtime/runtime/node_modules/@ankhorage/contracts/dist/bindings\").ComponentDataBinding>> | undefined",
2047
1809
  "required": false,
2048
1810
  "description": null
2049
1811
  },
@@ -2166,7 +1928,7 @@
2166
1928
  {
2167
1929
  "name": "dataBindings",
2168
1930
  "kind": "property",
2169
- "type": "Readonly<Record<string, import(\"/Users/a_rtiphishl_e/git/runtime/node_modules/@ankhorage/contracts/dist/bindings\").ComponentDataBinding>> | undefined",
1931
+ "type": "Readonly<Record<string, import(\"/home/runner/work/runtime/runtime/node_modules/@ankhorage/contracts/dist/bindings\").ComponentDataBinding>> | undefined",
2170
1932
  "required": false,
2171
1933
  "description": null
2172
1934
  },
@@ -2245,7 +2007,7 @@
2245
2007
  "modulePath": "src/runtimeDataSourceOperations.ts",
2246
2008
  "sourceLocation": {
2247
2009
  "filePath": "src/runtimeDataSourceOperations.ts",
2248
- "line": 7,
2010
+ "line": 8,
2249
2011
  "column": 1
2250
2012
  },
2251
2013
  "exportPaths": ["src/index.ts"],
@@ -2259,11 +2021,18 @@
2259
2021
  "required": false,
2260
2022
  "description": null
2261
2023
  },
2024
+ {
2025
+ "name": "databaseAdapters",
2026
+ "kind": "property",
2027
+ "type": "Readonly<Record<string, DbAdapter>> | undefined",
2028
+ "required": false,
2029
+ "description": null
2030
+ },
2262
2031
  {
2263
2032
  "name": "fetch",
2264
2033
  "kind": "property",
2265
- "type": "EndpointTestFetch",
2266
- "required": true,
2034
+ "type": "EndpointTestFetch | undefined",
2035
+ "required": false,
2267
2036
  "description": null
2268
2037
  }
2269
2038
  ],
@@ -2452,7 +2221,7 @@
2452
2221
  {
2453
2222
  "name": "dataBindings",
2454
2223
  "kind": "property",
2455
- "type": "Readonly<Record<string, import(\"/Users/a_rtiphishl_e/git/runtime/node_modules/@ankhorage/contracts/dist/bindings\").ComponentDataBinding>> | undefined",
2224
+ "type": "Readonly<Record<string, import(\"/home/runner/work/runtime/runtime/node_modules/@ankhorage/contracts/dist/bindings\").ComponentDataBinding>> | undefined",
2456
2225
  "required": false,
2457
2226
  "description": null
2458
2227
  },
@@ -2791,14 +2560,14 @@
2791
2560
  {
2792
2561
  "name": "dataBindings",
2793
2562
  "kind": "property",
2794
- "type": "Readonly<Record<string, import(\"/Users/a_rtiphishl_e/git/runtime/node_modules/@ankhorage/contracts/dist/bindings\").ComponentDataBinding>> | undefined",
2563
+ "type": "Readonly<Record<string, import(\"/home/runner/work/runtime/runtime/node_modules/@ankhorage/contracts/dist/bindings\").ComponentDataBinding>> | undefined",
2795
2564
  "required": false,
2796
2565
  "description": null
2797
2566
  },
2798
2567
  {
2799
2568
  "name": "dataSources",
2800
2569
  "kind": "property",
2801
- "type": "Readonly<Record<string, import(\"/Users/a_rtiphishl_e/git/runtime/node_modules/@ankhorage/contracts/dist/index\").DataSourceConfig>> | undefined",
2570
+ "type": "Readonly<Record<string, import(\"/home/runner/work/runtime/runtime/node_modules/@ankhorage/contracts/dist/index\").DataSourceConfig>> | undefined",
2802
2571
  "required": false,
2803
2572
  "description": null
2804
2573
  },
@@ -2847,7 +2616,7 @@
2847
2616
  {
2848
2617
  "name": "operationResults",
2849
2618
  "kind": "property",
2850
- "type": "Readonly<Record<string, import(\"/Users/a_rtiphishl_e/git/runtime/node_modules/@ankhorage/contracts/dist/bindings\").BindingValue | undefined>> | undefined",
2619
+ "type": "Readonly<Record<string, import(\"/home/runner/work/runtime/runtime/node_modules/@ankhorage/contracts/dist/bindings\").BindingValue | undefined>> | undefined",
2851
2620
  "required": false,
2852
2621
  "description": null
2853
2622
  },
@@ -2952,14 +2721,14 @@
2952
2721
  {
2953
2722
  "name": "dataBindings",
2954
2723
  "kind": "property",
2955
- "type": "Readonly<Record<string, import(\"/Users/a_rtiphishl_e/git/runtime/node_modules/@ankhorage/contracts/dist/bindings\").ComponentDataBinding>> | undefined",
2724
+ "type": "Readonly<Record<string, import(\"/home/runner/work/runtime/runtime/node_modules/@ankhorage/contracts/dist/bindings\").ComponentDataBinding>> | undefined",
2956
2725
  "required": false,
2957
2726
  "description": null
2958
2727
  },
2959
2728
  {
2960
2729
  "name": "dataSources",
2961
2730
  "kind": "property",
2962
- "type": "Readonly<Record<string, import(\"/Users/a_rtiphishl_e/git/runtime/node_modules/@ankhorage/contracts/dist/index\").DataSourceConfig>> | undefined",
2731
+ "type": "Readonly<Record<string, import(\"/home/runner/work/runtime/runtime/node_modules/@ankhorage/contracts/dist/index\").DataSourceConfig>> | undefined",
2963
2732
  "required": false,
2964
2733
  "description": null
2965
2734
  },
@@ -2987,7 +2756,7 @@
2987
2756
  {
2988
2757
  "name": "executeAction",
2989
2758
  "kind": "property",
2990
- "type": "import(\"/Users/a_rtiphishl_e/git/runtime/src/RuntimeRendererConfig\").RuntimeActionHandler | undefined",
2759
+ "type": "import(\"/home/runner/work/runtime/runtime/src/RuntimeRendererConfig\").RuntimeActionHandler | undefined",
2991
2760
  "required": false,
2992
2761
  "description": null
2993
2762
  },
@@ -3132,7 +2901,7 @@
3132
2901
  "modulePath": "src/RuntimeScreen.tsx",
3133
2902
  "sourceLocation": {
3134
2903
  "filePath": "src/RuntimeScreen.tsx",
3135
- "line": 24,
2904
+ "line": 17,
3136
2905
  "column": 1
3137
2906
  },
3138
2907
  "exportPaths": ["src/index.ts"],
@@ -3164,7 +2933,7 @@
3164
2933
  "modulePath": "src/runtimeScreenLoaders.ts",
3165
2934
  "sourceLocation": {
3166
2935
  "filePath": "src/runtimeScreenLoaders.ts",
3167
- "line": 26,
2936
+ "line": 25,
3168
2937
  "column": 1
3169
2938
  },
3170
2939
  "exportPaths": ["src/index.ts"],
@@ -3204,7 +2973,7 @@
3204
2973
  "modulePath": "src/runtimeScreenLoaders.ts",
3205
2974
  "sourceLocation": {
3206
2975
  "filePath": "src/runtimeScreenLoaders.ts",
3207
- "line": 19,
2976
+ "line": 18,
3208
2977
  "column": 1
3209
2978
  },
3210
2979
  "exportPaths": ["src/index.ts"],
@@ -3251,7 +3020,7 @@
3251
3020
  "modulePath": "src/RuntimeScreen.tsx",
3252
3021
  "sourceLocation": {
3253
3022
  "filePath": "src/RuntimeScreen.tsx",
3254
- "line": 17,
3023
+ "line": 10,
3255
3024
  "column": 1
3256
3025
  },
3257
3026
  "exportPaths": ["src/index.ts"],
@@ -3396,38 +3165,6 @@
3396
3165
  "members": [],
3397
3166
  "structuredRows": []
3398
3167
  },
3399
- {
3400
- "name": "useRuntimeApiStateLoaders",
3401
- "description": null,
3402
- "isReadme": false,
3403
- "examples": [],
3404
- "kind": "function",
3405
- "modulePath": "src/runtimeApiLoaders.ts",
3406
- "sourceLocation": {
3407
- "filePath": "src/runtimeApiLoaders.ts",
3408
- "line": 125,
3409
- "column": 1
3410
- },
3411
- "exportPaths": ["src/index.ts"],
3412
- "relatedSymbols": ["RuntimeApiLoaderDefinition", "RuntimeApiLoaderDiagnostic"],
3413
- "signatures": [
3414
- {
3415
- "label": "(args: { readonly data?: AppDataManifest; readonly loaders?: readonly RuntimeApiLoaderDefinition[]; readonly stateAdapter?: StateAdapter; }) => { readonly diagnostics: readonly RuntimeApiLoaderDiagnostic[]; readonly stateAdapter: StateAdapter; readonly stateVersion: number; }",
3416
- "parameters": [
3417
- {
3418
- "name": "args",
3419
- "type": "{ readonly data?: AppDataManifest; readonly loaders?: readonly RuntimeApiLoaderDefinition[]; readonly stateAdapter?: StateAdapter; }",
3420
- "required": true,
3421
- "description": null
3422
- }
3423
- ],
3424
- "returnType": "{ readonly diagnostics: readonly RuntimeApiLoaderDiagnostic[]; readonly stateAdapter: StateAdapter; readonly stateVersion: number; }",
3425
- "returnDescription": null
3426
- }
3427
- ],
3428
- "members": [],
3429
- "structuredRows": []
3430
- },
3431
3168
  {
3432
3169
  "name": "useRuntimeRendererConfig",
3433
3170
  "description": null,
@@ -3462,7 +3199,7 @@
3462
3199
  "modulePath": "src/runtimeScreenLoaders.ts",
3463
3200
  "sourceLocation": {
3464
3201
  "filePath": "src/runtimeScreenLoaders.ts",
3465
- "line": 284,
3202
+ "line": 273,
3466
3203
  "column": 1
3467
3204
  },
3468
3205
  "exportPaths": ["src/index.ts"],