@ankhorage/runtime 5.0.6 → 5.1.0

package/paradox/diagrams/sequences/runtime-screen.mmd

@@ -3,12 +3,17 @@ sequenceDiagram
   participant participant_createRuntimeScreenOperationLoaderRequestLifecycle as createRuntimeScreenOperationLoaderRequestLifecycle
   participant participant_RuntimeScreen as RuntimeScreen
   participant participant_use as use
+  participant participant_useOptionalManifestContext as useOptionalManifestContext
   participant participant_useRuntimeRendererConfig as useRuntimeRendererConfig
   participant participant_useRuntimeScreenOperationLoaders as useRuntimeScreenOperationLoaders
   participant_RuntimeScreen->>participant_useRuntimeRendererConfig: useRuntimeRendererConfig()
   participant_useRuntimeRendererConfig->>participant_use: use()
   participant_use-->>participant_useRuntimeRendererConfig: return
   participant_useRuntimeRendererConfig-->>participant_RuntimeScreen: return
+  participant_RuntimeScreen->>participant_useOptionalManifestContext: useOptionalManifestContext()
+  participant_useOptionalManifestContext->>participant_use: use()
+  participant_use-->>participant_useOptionalManifestContext: return
+  participant_useOptionalManifestContext-->>participant_RuntimeScreen: return
   participant_RuntimeScreen->>participant_useRuntimeScreenOperationLoaders: useRuntimeScreenOperationLoaders()
   participant_useRuntimeScreenOperationLoaders->>participant_createRuntimeScreenOperationLoaderRequestLifecycle: createRuntimeScreenOperationLoaderRequestLifecycle()
   participant_createRuntimeScreenOperationLoaderRequestLifecycle-->>participant_useRuntimeScreenOperationLoaders: return

package/paradox/exports.json

@@ -66,7 +66,7 @@
   {
     "name": "composeRuntimeCapabilityExecutor",
     "title": null,
-    "description": "Routes manifest-owned API capabilities before delegating application-owned capabilities.",
+    "description": "Routes API and state capabilities before delegating application-owned capabilities.",
     "isReadme": false,
     "see": [],
     "security": [],
@@ -74,7 +74,7 @@
     "modulePath": "src/runtimeCapabilityExecutor.ts",
     "sourceLocation": {
       "filePath": "src/runtimeCapabilityExecutor.ts",
-      "line": 13,
+      "line": 17,
       "column": 1
     },
     "exportPaths": [
@@ -472,7 +472,7 @@
     "modulePath": "src/runtimeStateAdapter.ts",
     "sourceLocation": {
       "filePath": "src/runtimeStateAdapter.ts",
-      "line": 18,
+      "line": 22,
       "column": 1
     },
     "exportPaths": [
@@ -810,7 +810,7 @@
     "modulePath": "src/ManifestContext.tsx",
     "sourceLocation": {
       "filePath": "src/ManifestContext.tsx",
-      "line": 10,
+      "line": 13,
       "column": 14
     },
     "exportPaths": [
@@ -824,7 +824,7 @@
   {
     "name": "ManifestProvider",
     "title": null,
-    "description": null,
+    "description": "Owns one configured state adapter for every Runtime screen in an application tree.",
     "isReadme": false,
     "see": [],
     "security": [],
@@ -832,7 +832,7 @@
     "modulePath": "src/ManifestContext.tsx",
     "sourceLocation": {
       "filePath": "src/ManifestContext.tsx",
-      "line": 12,
+      "line": 16,
       "column": 1
     },
     "exportPaths": [
@@ -2122,7 +2122,7 @@
     "modulePath": "src/runtimeCapabilityExecutor.ts",
     "sourceLocation": {
       "filePath": "src/runtimeCapabilityExecutor.ts",
-      "line": 7,
+      "line": 10,
       "column": 1
     },
     "exportPaths": [
@@ -2146,6 +2146,13 @@
         "type": "RuntimeCapabilityExecutor | undefined",
         "required": false,
         "description": null
+      },
+      {
+        "name": "stateAdapter",
+        "kind": "property",
+        "type": "StateAdapter | undefined",
+        "required": false,
+        "description": null
       }
     ],
     "structuredRows": []
@@ -2890,7 +2897,7 @@
     "modulePath": "src/runtimeStateAdapter.ts",
     "sourceLocation": {
       "filePath": "src/runtimeStateAdapter.ts",
-      "line": 14,
+      "line": 18,
       "column": 1
     },
     "exportPaths": [
@@ -2942,7 +2949,7 @@
     "modulePath": "src/RuntimeRenderer.tsx",
     "sourceLocation": {
       "filePath": "src/RuntimeRenderer.tsx",
-      "line": 73,
+      "line": 74,
       "column": 1
     },
     "exportPaths": [
@@ -3176,7 +3183,7 @@
     "modulePath": "src/RuntimeRenderer.tsx",
     "sourceLocation": {
       "filePath": "src/RuntimeRenderer.tsx",
-      "line": 54,
+      "line": 55,
       "column": 1
     },
     "exportPaths": [
@@ -3419,7 +3426,7 @@
     "modulePath": "src/RuntimeScreen.tsx",
     "sourceLocation": {
       "filePath": "src/RuntimeScreen.tsx",
-      "line": 19,
+      "line": 20,
       "column": 1
     },
     "exportPaths": [
@@ -3552,7 +3559,7 @@
     "modulePath": "src/RuntimeScreen.tsx",
     "sourceLocation": {
       "filePath": "src/RuntimeScreen.tsx",
-      "line": 12,
+      "line": 13,
       "column": 1
     },
     "exportPaths": [
@@ -3631,7 +3638,7 @@
   {
     "name": "useManifest",
     "title": null,
-    "description": null,
+    "description": "Returns the active application manifest from the owning Runtime provider.",
     "isReadme": false,
     "see": [],
     "security": [],
@@ -3639,7 +3646,7 @@
     "modulePath": "src/ManifestContext.tsx",
     "sourceLocation": {
       "filePath": "src/ManifestContext.tsx",
-      "line": 22,
+      "line": 38,
       "column": 1
     },
     "exportPaths": [
@@ -3660,7 +3667,7 @@
   {
     "name": "useManifestContext",
     "title": null,
-    "description": null,
+    "description": "Returns the active manifest scope, including its application-lifetime state adapter.",
     "isReadme": false,
     "see": [],
     "security": [],
@@ -3668,7 +3675,7 @@
     "modulePath": "src/ManifestContext.tsx",
     "sourceLocation": {
       "filePath": "src/ManifestContext.tsx",
-      "line": 30,
+      "line": 47,
       "column": 1
     },
     "exportPaths": [
@@ -3689,7 +3696,7 @@
   {
     "name": "useOptionalManifestContext",
     "title": null,
-    "description": null,
+    "description": "Reads an enclosing manifest scope without requiring hosts to provide one.",
     "isReadme": false,
     "see": [],
     "security": [],
@@ -3697,7 +3704,7 @@
     "modulePath": "src/ManifestContext.tsx",
     "sourceLocation": {
       "filePath": "src/ManifestContext.tsx",
-      "line": 38,
+      "line": 56,
       "column": 1
     },
     "exportPaths": [

package/paradox/exports.md

@@ -25,9 +25,9 @@ Source: `src/componentRegistry.ts:3:1`
 
 Kind: `function`
 Module: `src/runtimeCapabilityExecutor.ts`
-Source: `src/runtimeCapabilityExecutor.ts:13:1`
+Source: `src/runtimeCapabilityExecutor.ts:17:1`
 
-Routes manifest-owned API capabilities before delegating application-owned capabilities.
+Routes API and state capabilities before delegating application-owned capabilities.
 
 ### Signatures
 
@@ -158,7 +158,7 @@ Source: `src/runtimeEventOperationLifecycle.ts:40:1`
 
 Kind: `function`
 Module: `src/runtimeStateAdapter.ts`
-Source: `src/runtimeStateAdapter.ts:18:1`
+Source: `src/runtimeStateAdapter.ts:22:1`
 
 ### Signatures
 
@@ -274,13 +274,15 @@ Determines whether a dot-separated path is exposed by a capability output schema
 
 Kind: `value`
 Module: `src/ManifestContext.tsx`
-Source: `src/ManifestContext.tsx:10:14`
+Source: `src/ManifestContext.tsx:13:14`
 
 ## ManifestProvider
 
 Kind: `function`
 Module: `src/ManifestContext.tsx`
-Source: `src/ManifestContext.tsx:12:1`
+Source: `src/ManifestContext.tsx:16:1`
+
+Owns one configured state adapter for every Runtime screen in an application tree.
 
 ### Signatures
 
@@ -676,7 +678,7 @@ Source: `src/runtimeBindings.ts:36:1`
 
 Kind: `type`
 Module: `src/runtimeCapabilityExecutor.ts`
-Source: `src/runtimeCapabilityExecutor.ts:7:1`
+Source: `src/runtimeCapabilityExecutor.ts:10:1`
 
 ### Members
 
@@ -684,6 +686,7 @@ Source: `src/runtimeCapabilityExecutor.ts:7:1`
 | --- | --- | --- | --- | --- |
 | apiCapabilityExecutor | property | `RuntimeCapabilityExecutor` | yes |  |
 | capabilityExecutor | property | `RuntimeCapabilityExecutor \| undefined` | no |  |
+| stateAdapter | property | `StateAdapter \| undefined` | no |  |
 
 ## RuntimeComponentEventDispatchArgs
 
@@ -889,7 +892,7 @@ Source: `src/runtimeMedia.ts:9:1`
 
 Kind: `type`
 Module: `src/runtimeStateAdapter.ts`
-Source: `src/runtimeStateAdapter.ts:14:1`
+Source: `src/runtimeStateAdapter.ts:18:1`
 
 ### Members
 
@@ -907,7 +910,7 @@ Source: `node_modules/@ankhorage/contracts/dist/runtimeCallbacks.d.ts:6:1`
 
 Kind: `function`
 Module: `src/RuntimeRenderer.tsx`
-Source: `src/RuntimeRenderer.tsx:73:1`
+Source: `src/RuntimeRenderer.tsx:74:1`
 
 ### Signatures
 
@@ -960,7 +963,7 @@ Source: `src/RuntimeRendererConfig.tsx:139:1`
 
 Kind: `type`
 Module: `src/RuntimeRenderer.tsx`
-Source: `src/RuntimeRenderer.tsx:54:1`
+Source: `src/RuntimeRenderer.tsx:55:1`
 
 ### Members
 
@@ -1020,7 +1023,7 @@ Source: `node_modules/@ankhorage/contracts/dist/runtimeCallbacks.d.ts:2:1`
 
 Kind: `function`
 Module: `src/RuntimeScreen.tsx`
-Source: `src/RuntimeScreen.tsx:19:1`
+Source: `src/RuntimeScreen.tsx:20:1`
 
 ### Signatures
 
@@ -1061,7 +1064,7 @@ Source: `src/runtimeScreenLoaders.ts:17:1`
 
 Kind: `type`
 Module: `src/RuntimeScreen.tsx`
-Source: `src/RuntimeScreen.tsx:12:1`
+Source: `src/RuntimeScreen.tsx:13:1`
 
 ### Members
 
@@ -1088,7 +1091,9 @@ Source: `src/runtimeRepeatEmptyState.ts:3:1`
 
 Kind: `function`
 Module: `src/ManifestContext.tsx`
-Source: `src/ManifestContext.tsx:22:1`
+Source: `src/ManifestContext.tsx:38:1`
+
+Returns the active application manifest from the owning Runtime provider.
 
 ### Signatures
 
@@ -1099,7 +1104,9 @@ Source: `src/ManifestContext.tsx:22:1`
 
 Kind: `function`
 Module: `src/ManifestContext.tsx`
-Source: `src/ManifestContext.tsx:30:1`
+Source: `src/ManifestContext.tsx:47:1`
+
+Returns the active manifest scope, including its application-lifetime state adapter.
 
 ### Signatures
 
@@ -1110,7 +1117,9 @@ Source: `src/ManifestContext.tsx:30:1`
 
 Kind: `function`
 Module: `src/ManifestContext.tsx`
-Source: `src/ManifestContext.tsx:38:1`
+Source: `src/ManifestContext.tsx:56:1`
+
+Reads an enclosing manifest scope without requiring hosts to provide one.
 
 ### Signatures