@acorex-platform/framework-client 0.0.25 → 0.0.30

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@acorex-platform/framework-client",
-  "version": "0.0.25",
+  "version": "0.0.30",
   "peerDependencies": {
-    "@acorex-platform/framework-shared": "0.0.25",
+    "@acorex-platform/framework-shared": "0.0.30",
     "@acorex/cdk": "^19.0.0 || ^20.0.0 || ^22.0.0-next.0 || ^22.1.0-next.0 || ^22.1.0-next.0",
     "@acorex/charts": "^19.0.0 || ^20.0.0 || ^22.0.0-next.0 || ^22.1.0-next.0 || ^22.1.0-next.0",
     "@acorex/components": "^19.0.0 || ^20.0.0 || ^22.0.0-next.0 || ^22.1.0-next.0 || ^22.1.0-next.0",
     "@acorex/core": "^19.0.0 || ^20.0.0 || ^22.0.0-next.0 || ^22.1.0-next.0 || ^22.1.0-next.0",
     "@acorex/styles": "^19.0.0 || ^20.0.0 || ^22.0.0-next.0 || ^22.1.0-next.0 || ^22.1.0-next.0",
-    "@angular/animations": "^21.0.0",
+    "@angular/animations": "^21.0.0 || ^22.0.0",
     "@ngrx/signals": "^21.0.0",
     "dexie": "^3.2.7",
     "dom-to-image": "^2.6.0",

package/runtime/README.md

@@ -2,16 +2,28 @@
 
 Secondary entry point of `@acorex-platform/framework-client/platform`. It can be used by importing from `@acorex-platform/framework-client/runtime`.
 
-## External bulk transport (other API stacks)
+## External runtime transport (other API stacks)
 
-When the host app uses only this client library and implements the API elsewhere, override bulk with:
+When the host app uses only this client library and implements the API elsewhere, override remote CQRS with:
 
 ```typescript
-import { provideExternalRuntimeBulkTransport } from '@acorex-platform/framework-client/runtime';
+import {
+  provideExternalRuntimeQueryTransport,
+  provideExternalRuntimeCommandTransport,
+  provideExternalRuntimeBulkTransport,
+} from '@acorex-platform/framework-client/runtime';
 
 providers: [
+  ...provideExternalRuntimeQueryTransport((name, input, options) => myApi.query(name, input, options)),
+  ...provideExternalRuntimeCommandTransport((name, input, options) => myApi.command(name, input, options)),
   ...provideExternalRuntimeBulkTransport((request) => myApi.bulk(request)),
 ]
 ```
 
+Nest / demo-api hosts should import `AXCRuntimeRemoteApiModule` from `@acorex-platform/client-connectivity-api` instead (also registered by `AXMSettingsManagementModule`). Endpoints:
+
+- `POST /v1/runtime/queries` and `/v1/runtime/queries/invoke`
+- `POST /v1/runtime/commands` and `/v1/runtime/commands/invoke`
+- `POST /v1/runtime/commands/bulk`
+
 See [`src/lib/RUNTIME_REMOTE_BULK_TRANSPORT.md`](./src/lib/RUNTIME_REMOTE_BULK_TRANSPORT.md).

package/types/acorex-platform-framework-client-common.d.ts

@@ -732,7 +732,7 @@ declare class AXPCommonModule {
      */
     constructor(instances: any[], _keyboardShortcutsHelp: AXPKeyboardShortcutsHelpService, formatterRegistry: AXFormatterRegistryService);
     static ɵfac: i0.ɵɵFactoryDeclaration<AXPCommonModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<AXPCommonModule, never, [typeof i1.AXPComponentSlotModule, typeof i2.AXPopupModule, typeof i3.AXDateTimeModule, typeof i4.AXToastModule, typeof i1.AXPModuleManifestModule], [typeof _angular_router.RouterModule]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<AXPCommonModule, never, [typeof i1.AXPComponentSlotModule, typeof i2.AXPopupModule, typeof i3.AXDateTimeModule, typeof i4.AXToastModule, typeof i1.AXPModuleManifestModule, typeof _angular_router.RouterModule], [typeof _angular_router.RouterModule]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<AXPCommonModule>;
 }
 

package/types/acorex-platform-framework-client-layout-entity.d.ts

@@ -14,13 +14,12 @@ import { AXPPageLayoutBaseComponent } from '@acorex-platform/framework-client/la
 export { AXPEntityDefinitionCrudService, AXP_ENTITY_DEFINITION_CRUD_SERVICE } from '@acorex-platform/framework-client/domain';
 import { AXClickEvent, AXStyleColorType, AXDataSource, AXDataSourceFilterOption, AXDataSourceSortOption, AXValueChangedEvent, AXFocusEvent, AXHtmlEvent } from '@acorex/cdk/common';
 import { AXPHookService, AXHighlightService, AXPEntityBroadcastService, AXPDeviceService, AXPExpressionEvaluatorService, AXPContextEvalFactory, AXPContextStore } from '@acorex-platform/framework-client/core';
-import * as i5 from '@acorex-platform/framework-client/layout/widget-core';
+import * as i4 from '@acorex-platform/framework-client/layout/widget-core';
 import { AXPColumnWidgetComponent, AXPValueWidgetComponent, AXPWidgetCoreElementAPI, AXPWidgetCoreService, AXPWidgetRendererDirective } from '@acorex-platform/framework-client/layout/widget-core';
-import * as i1 from '@angular/router';
 import { ParamMap, ResolveFn, RedirectCommand } from '@angular/router';
 import * as rxjs from 'rxjs';
 import { Subject } from 'rxjs';
-import * as i6 from '@acorex-platform/framework-client/layout/builder';
+import * as i5 from '@acorex-platform/framework-client/layout/builder';
 import { IActionBuilder, AXPDialogRef, IFormFieldBuilder } from '@acorex-platform/framework-client/layout/builder';
 import { AXPSessionService } from '@acorex-platform/framework-client/auth';
 import { AXPQueryExecutor, AXPCommandService, AXPCommandMiddleware, AXPQueryMiddleware } from '@acorex-platform/framework-client/runtime';
@@ -2449,7 +2448,7 @@ declare class AXPGalleryPluginModule {
 declare class AXPEntityModule {
     constructor();
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<AXPEntityModule, never>;
-    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<AXPEntityModule, never, [typeof i1.RouterModule, typeof AXPAttachmentsPluginModule, typeof AXPClientLocalPluginModule, typeof AXPGalleryPluginModule, typeof i5.AXPWidgetCoreModule, typeof i6.LayoutBuilderModule], never>;
+    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<AXPEntityModule, never, [typeof AXPAttachmentsPluginModule, typeof AXPClientLocalPluginModule, typeof AXPGalleryPluginModule, typeof i4.AXPWidgetCoreModule, typeof i5.LayoutBuilderModule], never>;
     static ɵinj: _angular_core.ɵɵInjectorDeclaration<AXPEntityModule>;
 }
 

package/types/acorex-platform-framework-client-runtime.d.ts

@@ -359,8 +359,13 @@ declare class AXPRuntimeModule {
  * Distributed hook keys for remote (non-local) command/query execution.
  * Connectivity (or another transport) implements these via {@link AXPHookService.runAsync}.
  *
+ * Official Nest / demo-api hosts import `AXCRuntimeRemoteApiModule` from
+ * `@acorex-platform/client-connectivity-api` (also wired by `AXMSettingsManagementModule`).
+ *
  * Host apps that only consume the client lib and call a different API stack should
- * register {@link provideExternalRuntimeBulkTransport} for {@link AXPRuntimeRemoteHookKeys.CommandExecuteBulk}
+ * register {@link provideExternalRuntimeQueryTransport},
+ * {@link provideExternalRuntimeCommandTransport}, and
+ * {@link provideExternalRuntimeBulkTransport}
  * (see `RUNTIME_REMOTE_BULK_TRANSPORT.md`).
  */
 declare const AXPRuntimeRemoteHookKeys: {
@@ -461,5 +466,87 @@ interface AXPExternalRuntimeBulkTransportOptions {
  */
 declare function provideExternalRuntimeBulkTransport(transport: AXPExternalRuntimeBulkTransport, options?: AXPExternalRuntimeBulkTransportOptions): Provider[];
 
-export { AXPBulkCommandService, AXPCommandEventsService, AXPCommandExecutor, AXPCommandRegistry, AXPCommandService, AXPPolicyEngineContext, AXPPolicyEngineDirective, AXPPolicyEngineRegistry, AXPPolicyEngineService, AXPQueryEventsService, AXPQueryExecutor, AXPQueryRegistry, AXPQueryService, AXPRuntimeModule, AXPRuntimeRemoteHookKeys, AXPRuntimeTransportHookKeys, AXPRuntimeTransportService, AXPViewExecutor, AXPViewRegistry, AXPViewService, AXP_COMMAND_EXTENSION, AXP_COMMAND_MIDDLEWARE_SETUP, AXP_COMMAND_SETUP, AXP_POLICY_ENGINE_MIDDLEWARE_SETUP, AXP_POLICY_EXTENSION, AXP_QUERY_EXTENSION, AXP_QUERY_MIDDLEWARE_SETUP, AXP_QUERY_SETUP, AXP_VIEW_EXTENSION, AXP_VIEW_SETUP, composePolicyEngineMiddlewares, composeViewMiddlewares, provideCommand, provideCommandMiddleware, provideCommandSetups, provideExternalRuntimeBulkTransport, providePolicySetups, provideQueryMiddleware, provideQuerySetups, provideViewSetup, provideViewSetups };
-export type { AXPCommandExecutionEvent, AXPCommandExecutionStage, AXPCommandExtension, AXPExternalRuntimeBulkTransport, AXPExternalRuntimeBulkTransportOptions, AXPPolicy, AXPPolicyEngineMiddleware, AXPPolicyExtension, AXPQueryExecutionEvent, AXPQueryExecutionStage, AXPQueryExtension, AXPRuntimeCommandExecuteBulkHookPayload, AXPRuntimeCommandExecuteHookPayload, AXPRuntimeQueryExecuteHookPayload, AXPRuntimeTransportExecuteHookPayload, AXPViewExtension, AXPViewMiddleware };
+/**
+ * Host-app transport for a single remote command. Must POST to the host API and
+ * return the full runtime command envelope.
+ *
+ * Nest reference: `POST {baseUrl}/v1/runtime/commands` with body
+ * `{ name, input, options? }`, or `POST {baseUrl}/v1/runtime/commands/invoke?name=…`
+ * with body `input` when `options` is omitted.
+ */
+type AXPExternalRuntimeCommandTransport = (name: string, input: unknown, options?: AXPCommandExecuteOptions) => Promise<AXPRuntimeCommandResult>;
+interface AXPExternalRuntimeCommandTransportOptions {
+    /**
+     * Hook waterfall order (ascending). Default `-100` so this runs before the
+     * connectivity default (`priority` unset / `0`) and can mark `handled: true`.
+     */
+    priority?: number;
+}
+/**
+ * Registers an external-stack implementation of `runtime.command.execute`.
+ *
+ * Use this when the host app consumes only the ACoreX **client** libraries and
+ * implements the API in another stack. Official Nest / demo-api hosts should
+ * import `AXCRuntimeRemoteApiModule` from `@acorex-platform/client-connectivity-api`
+ * instead.
+ *
+ * @example
+ * ```typescript
+ * providers: [
+ *   ...provideExternalRuntimeCommandTransport(async (name, input, options) => {
+ *     const response = await fetch(`${apiBase}/v1/runtime/commands`, {
+ *       method: 'POST',
+ *       credentials: 'include',
+ *       headers: { 'Content-Type': 'application/json' },
+ *       body: JSON.stringify({ name, input: input ?? {}, options }),
+ *     });
+ *     return response.json();
+ *   }),
+ * ]
+ * ```
+ */
+declare function provideExternalRuntimeCommandTransport(transport: AXPExternalRuntimeCommandTransport, options?: AXPExternalRuntimeCommandTransportOptions): Provider[];
+
+/**
+ * Host-app transport for a single remote query. Must POST to the host API and
+ * return the full runtime query envelope (not unwrapped `data`).
+ *
+ * Nest reference: `POST {baseUrl}/v1/runtime/queries` with body
+ * `{ name, input, options? }`, or `POST {baseUrl}/v1/runtime/queries/invoke?name=…`
+ * with body `input` when `options` is omitted.
+ */
+type AXPExternalRuntimeQueryTransport = (name: string, input: unknown, options?: AXPQueryExecuteOptions) => Promise<AXPRuntimeQueryResult>;
+interface AXPExternalRuntimeQueryTransportOptions {
+    /**
+     * Hook waterfall order (ascending). Default `-100` so this runs before the
+     * connectivity default (`priority` unset / `0`) and can mark `handled: true`.
+     */
+    priority?: number;
+}
+/**
+ * Registers an external-stack implementation of `runtime.query.execute`.
+ *
+ * Use this when the host app consumes only the ACoreX **client** libraries and
+ * implements the API in another stack. Official Nest / demo-api hosts should
+ * import `AXCRuntimeRemoteApiModule` from `@acorex-platform/client-connectivity-api`
+ * instead (also pulled in by `AXMSettingsManagementModule`).
+ *
+ * @example
+ * ```typescript
+ * providers: [
+ *   ...provideExternalRuntimeQueryTransport(async (name, input, options) => {
+ *     const response = await fetch(`${apiBase}/v1/runtime/queries`, {
+ *       method: 'POST',
+ *       credentials: 'include',
+ *       headers: { 'Content-Type': 'application/json' },
+ *       body: JSON.stringify({ name, input: input ?? {}, options }),
+ *     });
+ *     return response.json();
+ *   }),
+ * ]
+ * ```
+ */
+declare function provideExternalRuntimeQueryTransport(transport: AXPExternalRuntimeQueryTransport, options?: AXPExternalRuntimeQueryTransportOptions): Provider[];
+
+export { AXPBulkCommandService, AXPCommandEventsService, AXPCommandExecutor, AXPCommandRegistry, AXPCommandService, AXPPolicyEngineContext, AXPPolicyEngineDirective, AXPPolicyEngineRegistry, AXPPolicyEngineService, AXPQueryEventsService, AXPQueryExecutor, AXPQueryRegistry, AXPQueryService, AXPRuntimeModule, AXPRuntimeRemoteHookKeys, AXPRuntimeTransportHookKeys, AXPRuntimeTransportService, AXPViewExecutor, AXPViewRegistry, AXPViewService, AXP_COMMAND_EXTENSION, AXP_COMMAND_MIDDLEWARE_SETUP, AXP_COMMAND_SETUP, AXP_POLICY_ENGINE_MIDDLEWARE_SETUP, AXP_POLICY_EXTENSION, AXP_QUERY_EXTENSION, AXP_QUERY_MIDDLEWARE_SETUP, AXP_QUERY_SETUP, AXP_VIEW_EXTENSION, AXP_VIEW_SETUP, composePolicyEngineMiddlewares, composeViewMiddlewares, provideCommand, provideCommandMiddleware, provideCommandSetups, provideExternalRuntimeBulkTransport, provideExternalRuntimeCommandTransport, provideExternalRuntimeQueryTransport, providePolicySetups, provideQueryMiddleware, provideQuerySetups, provideViewSetup, provideViewSetups };
+export type { AXPCommandExecutionEvent, AXPCommandExecutionStage, AXPCommandExtension, AXPExternalRuntimeBulkTransport, AXPExternalRuntimeBulkTransportOptions, AXPExternalRuntimeCommandTransport, AXPExternalRuntimeCommandTransportOptions, AXPExternalRuntimeQueryTransport, AXPExternalRuntimeQueryTransportOptions, AXPPolicy, AXPPolicyEngineMiddleware, AXPPolicyExtension, AXPQueryExecutionEvent, AXPQueryExecutionStage, AXPQueryExtension, AXPRuntimeCommandExecuteBulkHookPayload, AXPRuntimeCommandExecuteHookPayload, AXPRuntimeQueryExecuteHookPayload, AXPRuntimeTransportExecuteHookPayload, AXPViewExtension, AXPViewMiddleware };