Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/generated-api-runtime.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@ankhorage/runtime': major
---

Consume the canonical Contracts 4 and Data Sources 1 API taxonomy, remove the obsolete `manifest.data.apis` seed-loader surface, and execute database-backed generated API operations through their referenced runtime database adapters.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# @ankhorage/runtime

![license: MIT](./paradox/badges/license.svg) ![npm: v0.2.4](./paradox/badges/npm.svg) ![runtime: bun](./paradox/badges/runtime.svg) ![typescript: strict](./paradox/badges/typescript.svg) ![eslint: checked](./paradox/badges/eslint.svg) ![prettier: checked](./paradox/badges/prettier.svg) ![build: checked](./paradox/badges/build.svg) ![tests: checked](./paradox/badges/tests.svg) ![docs: paradox](./paradox/badges/docs.svg)
![license: MIT](./paradox/badges/license.svg) ![npm: v0.3.0](./paradox/badges/npm.svg) ![runtime: bun](./paradox/badges/runtime.svg) ![typescript: strict](./paradox/badges/typescript.svg) ![eslint: checked](./paradox/badges/eslint.svg) ![prettier: checked](./paradox/badges/prettier.svg) ![build: checked](./paradox/badges/build.svg) ![tests: checked](./paradox/badges/tests.svg) ![docs: paradox](./paradox/badges/docs.svg)

Platform-neutral runtime contracts and helpers for Ankhorage generated apps.

Expand Down
12 changes: 5 additions & 7 deletions bun.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@
"version-packages": "changeset version"
},
"dependencies": {
"@ankhorage/contracts": "^2.1.0",
"@ankhorage/data-sources": "^0.5.1"
"@ankhorage/contracts": "^4.0.2",
"@ankhorage/data-sources": "^1.0.0"
},
"peerDependencies": {
"react": "19.1.0",
Expand Down
6 changes: 3 additions & 3 deletions paradox/badges/npm.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion paradox/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Export paths: `src/index.ts`

## RuntimeScreen

Source: `src/RuntimeScreen.tsx:24:1`
Source: `src/RuntimeScreen.tsx:17:1`

Export paths: `src/index.ts`

Expand Down
14 changes: 5 additions & 9 deletions paradox/diagrams/architecture-overview.mmd
Original file line number Diff line number Diff line change
Expand Up @@ -29,26 +29,22 @@ graph TD
package__ankhorage_runtime -.-> module_src_runtimeActionRegistry_ts
module_src_runtimeActionRegistry_ts --> module_src_runtimeBindings_ts
module_src_runtimeActionRegistry_ts --> module_src_RuntimeRendererConfig_tsx
module_src_runtimeApiLoaders_test_ts["src/runtimeApiLoaders.test.ts"]
package__ankhorage_runtime -.-> module_src_runtimeApiLoaders_test_ts
module_src_runtimeApiLoaders_test_ts --> module_src_runtimeApiLoaders_ts
module_src_runtimeApiLoaders_test_ts --> module_src_runtimeBindings_ts
module_src_runtimeApiLoaders_test_ts --> module_src_runtimeStateAdapter_ts
module_src_runtimeApiLoaders_ts["src/runtimeApiLoaders.ts"]
package__ankhorage_runtime -.-> module_src_runtimeApiLoaders_ts
module_src_runtimeApiLoaders_ts --> module_src_runtimeStateAdapter_ts
module_src_runtimeBindings_test_ts["src/runtimeBindings.test.ts"]
package__ankhorage_runtime -.-> module_src_runtimeBindings_test_ts
module_src_runtimeBindings_test_ts --> module_src_runtimeBindings_ts
module_src_runtimeBindings_test_ts --> module_src_runtimeNodeProps_ts
module_src_runtimeBindings_ts["src/runtimeBindings.ts"]
package__ankhorage_runtime -.-> module_src_runtimeBindings_ts
module_src_runtimeDatabaseOperationExecutor_ts["src/runtimeDatabaseOperationExecutor.ts"]
package__ankhorage_runtime -.-> module_src_runtimeDatabaseOperationExecutor_ts
module_src_runtimeDatabaseOperationExecutor_ts --> module_src_runtimeBindings_ts
module_src_runtimeDataSourceOperations_test_ts["src/runtimeDataSourceOperations.test.ts"]
package__ankhorage_runtime -.-> module_src_runtimeDataSourceOperations_test_ts
module_src_runtimeDataSourceOperations_test_ts --> module_src_runtimeDataSourceOperations_ts
module_src_runtimeDataSourceOperations_ts["src/runtimeDataSourceOperations.ts"]
package__ankhorage_runtime -.-> module_src_runtimeDataSourceOperations_ts
module_src_runtimeDataSourceOperations_ts --> module_src_runtimeBindings_ts
module_src_runtimeDataSourceOperations_ts --> module_src_runtimeDatabaseOperationExecutor_ts
module_src_runtimeDbPersist_test_ts["src/runtimeDbPersist.test.ts"]
package__ankhorage_runtime -.-> module_src_runtimeDbPersist_test_ts
module_src_runtimeDbPersist_test_ts --> module_src_runtimeActionRegistry_ts
Expand Down Expand Up @@ -112,10 +108,10 @@ graph TD
module_src_RuntimeScreen_tsx["src/RuntimeScreen.tsx"]
package__ankhorage_runtime -.-> module_src_RuntimeScreen_tsx
module_src_RuntimeScreen_tsx --> module_src_registry_tsx
module_src_RuntimeScreen_tsx --> module_src_runtimeApiLoaders_ts
module_src_RuntimeScreen_tsx --> module_src_RuntimeRenderer_tsx
module_src_RuntimeScreen_tsx --> module_src_RuntimeRendererConfig_tsx
module_src_RuntimeScreen_tsx --> module_src_runtimeScreenLoaders_ts
module_src_RuntimeScreen_tsx --> module_src_runtimeStateAdapter_ts
module_src_runtimeScreenLoaders_arrayPath_test_ts["src/runtimeScreenLoaders.arrayPath.test.ts"]
package__ankhorage_runtime -.-> module_src_runtimeScreenLoaders_arrayPath_test_ts
module_src_runtimeScreenLoaders_arrayPath_test_ts --> module_src_runtimeBindings_ts
Expand Down
29 changes: 1 addition & 28 deletions paradox/diagrams/export-graph.mmd
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,9 @@ graph LR
module_src_rendering_ts["src/rendering.ts"]
module_src_runtimeActionRegistry_test_ts["src/runtimeActionRegistry.test.ts"]
module_src_runtimeActionRegistry_ts["src/runtimeActionRegistry.ts"]
module_src_runtimeApiLoaders_test_ts["src/runtimeApiLoaders.test.ts"]
module_src_runtimeApiLoaders_ts["src/runtimeApiLoaders.ts"]
module_src_runtimeBindings_test_ts["src/runtimeBindings.test.ts"]
module_src_runtimeBindings_ts["src/runtimeBindings.ts"]
module_src_runtimeDatabaseOperationExecutor_ts["src/runtimeDatabaseOperationExecutor.ts"]
module_src_runtimeDataSourceOperations_test_ts["src/runtimeDataSourceOperations.test.ts"]
module_src_runtimeDataSourceOperations_ts["src/runtimeDataSourceOperations.ts"]
module_src_runtimeDbPersist_test_ts["src/runtimeDbPersist.test.ts"]
Expand Down Expand Up @@ -106,10 +105,6 @@ graph LR
module_src_runtimeDbPersist_ts --> export_executeDbPersistAction
export_executeDbPersistAction -.-> export_RuntimeActionHandlerArgs
export_executeDbPersistAction -.-> export_RuntimeDbPersistExecutionResult
export_executeRuntimeApiLoaders["executeRuntimeApiLoaders"]
module_src_runtimeApiLoaders_ts --> export_executeRuntimeApiLoaders
export_executeRuntimeApiLoaders -.-> export_RuntimeApiLoaderDefinition
export_executeRuntimeApiLoaders -.-> export_RuntimeApiLoaderExecutionResult
export_executeRuntimeScreenOperationLoaders["executeRuntimeScreenOperationLoaders"]
module_src_runtimeScreenLoaders_ts --> export_executeRuntimeScreenOperationLoaders
export_executeRuntimeScreenOperationLoaders -.-> export_RuntimeBindingOperationExecutor
Expand All @@ -122,10 +117,6 @@ graph LR
module_src_ManifestContext_tsx --> export_ManifestContext
export_ManifestProvider["ManifestProvider"]
module_src_ManifestContext_tsx --> export_ManifestProvider
export_materializeRuntimeApiLoaderState["materializeRuntimeApiLoaderState"]
module_src_runtimeApiLoaders_ts --> export_materializeRuntimeApiLoaderState
export_materializeRuntimeApiLoaderState -.-> export_RuntimeApiLoaderDefinition
export_materializeRuntimeApiLoaderState -.-> export_RuntimeApiLoaderMaterializationResult
export_mergeRuntimeRendererConfig["mergeRuntimeRendererConfig"]
module_src_RuntimeRendererConfig_tsx --> export_mergeRuntimeRendererConfig
export_mergeRuntimeRendererConfig -.-> export_RuntimeRendererConfig
Expand Down Expand Up @@ -155,8 +146,6 @@ graph LR
export_resolveRuntimeBindingValueSync["resolveRuntimeBindingValueSync"]
module_src_runtimeBindings_ts --> export_resolveRuntimeBindingValueSync
export_resolveRuntimeBindingValueSync -.-> export_RuntimeBindingResolutionContext
export_resolveScreenApiLoaders["resolveScreenApiLoaders"]
module_src_runtimeScreenLoaders_ts --> export_resolveScreenApiLoaders
export_resolveScreenOperationLoaders["resolveScreenOperationLoaders"]
module_src_runtimeScreenLoaders_ts --> export_resolveScreenOperationLoaders
export_RUNTIME_CAPABILITIES["RUNTIME_CAPABILITIES"]
Expand Down Expand Up @@ -186,18 +175,6 @@ graph LR
module_src_runtimeActionRegistry_ts --> export_RuntimeActionResolutionScope
export_RuntimeAdapterDescriptor["RuntimeAdapterDescriptor"]
module_src_runtimeManifest_ts --> export_RuntimeAdapterDescriptor
export_RuntimeApiLoaderDefinition["RuntimeApiLoaderDefinition"]
module_src_runtimeApiLoaders_ts --> export_RuntimeApiLoaderDefinition
export_RuntimeApiLoaderDiagnostic["RuntimeApiLoaderDiagnostic"]
module_src_runtimeApiLoaders_ts --> export_RuntimeApiLoaderDiagnostic
export_RuntimeApiLoaderExecutionResult["RuntimeApiLoaderExecutionResult"]
module_src_runtimeApiLoaders_ts --> export_RuntimeApiLoaderExecutionResult
export_RuntimeApiLoaderExecutionResult -.-> export_RuntimeApiLoaderDiagnostic
export_RuntimeApiLoaderMaterializationResult["RuntimeApiLoaderMaterializationResult"]
module_src_runtimeApiLoaders_ts --> export_RuntimeApiLoaderMaterializationResult
export_RuntimeApiLoaderMaterializationResult -.-> export_RuntimeApiLoaderDiagnostic
export_RuntimeApiLoaderMode["RuntimeApiLoaderMode"]
module_src_runtimeApiLoaders_ts --> export_RuntimeApiLoaderMode
export_RuntimeBindingDescriptor["RuntimeBindingDescriptor"]
module_src_runtimeManifest_ts --> export_RuntimeBindingDescriptor
export_RuntimeBindingOperationExecutionArgs["RuntimeBindingOperationExecutionArgs"]
Expand Down Expand Up @@ -303,10 +280,6 @@ graph LR
module_src_ManifestContext_tsx --> export_useManifestContext
export_useOptionalManifestContext["useOptionalManifestContext"]
module_src_ManifestContext_tsx --> export_useOptionalManifestContext
export_useRuntimeApiStateLoaders["useRuntimeApiStateLoaders"]
module_src_runtimeApiLoaders_ts --> export_useRuntimeApiStateLoaders
export_useRuntimeApiStateLoaders -.-> export_RuntimeApiLoaderDefinition
export_useRuntimeApiStateLoaders -.-> export_RuntimeApiLoaderDiagnostic
export_useRuntimeRendererConfig["useRuntimeRendererConfig"]
module_src_RuntimeRendererConfig_tsx --> export_useRuntimeRendererConfig
export_useRuntimeRendererConfig -.-> export_RuntimeRendererConfig
Expand Down
11 changes: 4 additions & 7 deletions paradox/diagrams/module-relationships.mmd
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,9 @@ graph LR
module_src_rendering_ts["src/rendering.ts"]
module_src_runtimeActionRegistry_test_ts["src/runtimeActionRegistry.test.ts"]
module_src_runtimeActionRegistry_ts["src/runtimeActionRegistry.ts"]
module_src_runtimeApiLoaders_test_ts["src/runtimeApiLoaders.test.ts"]
module_src_runtimeApiLoaders_ts["src/runtimeApiLoaders.ts"]
module_src_runtimeBindings_test_ts["src/runtimeBindings.test.ts"]
module_src_runtimeBindings_ts["src/runtimeBindings.ts"]
module_src_runtimeDatabaseOperationExecutor_ts["src/runtimeDatabaseOperationExecutor.ts"]
module_src_runtimeDataSourceOperations_test_ts["src/runtimeDataSourceOperations.test.ts"]
module_src_runtimeDataSourceOperations_ts["src/runtimeDataSourceOperations.ts"]
module_src_runtimeDbPersist_test_ts["src/runtimeDbPersist.test.ts"]
Expand Down Expand Up @@ -46,14 +45,12 @@ graph LR
module_src_runtimeActionRegistry_test_ts --> module_src_runtimeBindings_ts
module_src_runtimeActionRegistry_ts --> module_src_runtimeBindings_ts
module_src_runtimeActionRegistry_ts --> module_src_RuntimeRendererConfig_tsx
module_src_runtimeApiLoaders_test_ts --> module_src_runtimeApiLoaders_ts
module_src_runtimeApiLoaders_test_ts --> module_src_runtimeBindings_ts
module_src_runtimeApiLoaders_test_ts --> module_src_runtimeStateAdapter_ts
module_src_runtimeApiLoaders_ts --> module_src_runtimeStateAdapter_ts
module_src_runtimeBindings_test_ts --> module_src_runtimeBindings_ts
module_src_runtimeBindings_test_ts --> module_src_runtimeNodeProps_ts
module_src_runtimeDatabaseOperationExecutor_ts --> module_src_runtimeBindings_ts
module_src_runtimeDataSourceOperations_test_ts --> module_src_runtimeDataSourceOperations_ts
module_src_runtimeDataSourceOperations_ts --> module_src_runtimeBindings_ts
module_src_runtimeDataSourceOperations_ts --> module_src_runtimeDatabaseOperationExecutor_ts
module_src_runtimeDbPersist_test_ts --> module_src_runtimeActionRegistry_ts
module_src_runtimeDbPersist_test_ts --> module_src_runtimeDbPersist_ts
module_src_runtimeDbPersist_ts --> module_src_RuntimeRendererConfig_tsx
Expand Down Expand Up @@ -83,10 +80,10 @@ graph LR
module_src_runtimeRepeat_test_ts --> module_src_runtimeRepeat_ts
module_src_runtimeRepeat_ts --> module_src_runtimeBindings_ts
module_src_RuntimeScreen_tsx --> module_src_registry_tsx
module_src_RuntimeScreen_tsx --> module_src_runtimeApiLoaders_ts
module_src_RuntimeScreen_tsx --> module_src_RuntimeRenderer_tsx
module_src_RuntimeScreen_tsx --> module_src_RuntimeRendererConfig_tsx
module_src_RuntimeScreen_tsx --> module_src_runtimeScreenLoaders_ts
module_src_RuntimeScreen_tsx --> module_src_runtimeStateAdapter_ts
module_src_runtimeScreenLoaders_arrayPath_test_ts --> module_src_runtimeBindings_ts
module_src_runtimeScreenLoaders_arrayPath_test_ts --> module_src_runtimeScreenLoaders_ts
module_src_runtimeScreenLoaders_test_ts --> module_src_runtimeBindings_ts
Expand Down
3 changes: 0 additions & 3 deletions paradox/diagrams/sequences/runtime-screen.mmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,12 @@ sequenceDiagram
participant participant_createRuntimeScreenOperationLoaderLifecycle as createRuntimeScreenOperationLoaderLifecycle
participant participant_RuntimeScreen as RuntimeScreen
participant participant_useContext as useContext
participant participant_useRuntimeApiStateLoaders as useRuntimeApiStateLoaders
participant participant_useRuntimeRendererConfig as useRuntimeRendererConfig
participant participant_useRuntimeScreenOperationLoaders as useRuntimeScreenOperationLoaders
participant_RuntimeScreen->>participant_useRuntimeRendererConfig: useRuntimeRendererConfig()
participant_useRuntimeRendererConfig->>participant_useContext: useContext()
participant_useContext-->>participant_useRuntimeRendererConfig: return
participant_useRuntimeRendererConfig-->>participant_RuntimeScreen: return
participant_RuntimeScreen->>participant_useRuntimeApiStateLoaders: useRuntimeApiStateLoaders()
participant_useRuntimeApiStateLoaders-->>participant_RuntimeScreen: return
participant_RuntimeScreen->>participant_useRuntimeScreenOperationLoaders: useRuntimeScreenOperationLoaders()
participant_useRuntimeScreenOperationLoaders->>participant_createRuntimeScreenOperationLoaderLifecycle: createRuntimeScreenOperationLoaderLifecycle()
participant_createRuntimeScreenOperationLoaderLifecycle-->>participant_useRuntimeScreenOperationLoaders: return
Expand Down
Loading
Loading