@praxisui/editorial-forms 8.0.0-beta.1 → 8.0.0-beta.11

package/README.md

@@ -40,6 +40,31 @@ Optional integration:
 
 - `@praxisui/dynamic-form` if your `dataCollection` blocks should render real forms instead of fallback content
 
+## App provider
+
+Register the package provider in hosts that render the runtime through dynamic
+widget composition, including `@praxisui/core` dynamic pages, page-builder
+previews, examples, recipes and labs:
+
+```ts
+import { providePraxisEditorialForms } from '@praxisui/editorial-forms';
+
+export const appConfig = {
+  providers: [
+    providePraxisEditorialForms(),
+  ],
+};
+```
+
+`providePraxisEditorialForms()` registers the package dynamic widget metadata for
+`praxis-editorial-form-runtime`. It does not register the optional
+`@praxisui/dynamic-form` adapter and does not create a global singleton runtime
+graph.
+
+Without this provider, hosts may still use `EditorialFormRuntimeComponent`
+directly through a standalone import, but `DynamicWidgetLoader` cannot discover
+`praxis-editorial-form-runtime` from a JSON page definition.
+
 ## Core concepts
 
 - `solution`: canonical editorial definition
@@ -144,6 +169,34 @@ Recommended host usage:
 - use `operationalEvent` for technical telemetry, not as primary user-facing UI content
 - keep `runtimeContext` immutable from the host side; the runtime now emits refreshed state as blocks and adapters materialize `formData`
 
+## Dynamic widget composition
+
+The runtime publishes `praxis-editorial-form-runtime` as dynamic widget metadata
+with these canonical component ports:
+
+Inputs:
+
+- `solution`
+- `instance`
+- `runtimeContext`
+- `hostConfig`
+
+Outputs:
+
+- `snapshotChange`
+- `fallbackChange`
+- `operationalEvent`
+
+Nested dynamic page links must target these ports through
+`composition.links` using `component-port` endpoints. When the editorial runtime
+is nested inside a container such as Tabs or Expansion, persist the nested child
+identity through `nestedPath` and keep the terminal segment as a widget segment
+with stable `key` and `componentType: "praxis-editorial-form-runtime"`.
+
+Do not expose `widgetEvent`, `bindingPath`, host-specific aliases, or
+container-owned child-specific ports as the final contract for editorial runtime
+composition.
+
 ## Presentation layer
 
 The runtime now supports an optional `presentation` contract inside the editorial `solution`.

package/fesm2022/praxisui-editorial-forms.mjs

@@ -1,22 +1,10 @@
 import * as i0 from '@angular/core';
-import { makeEnvironmentProviders, InjectionToken, inject, DestroyRef, viewChild, ViewContainerRef, input, output, signal, computed, effect, ChangeDetectionStrategy, Component, reflectComponentType, Input } from '@angular/core';
+import { InjectionToken, makeEnvironmentProviders, inject, DestroyRef, viewChild, ViewContainerRef, input, output, signal, computed, effect, ChangeDetectionStrategy, Component, ENVIRONMENT_INITIALIZER, reflectComponentType, Input } from '@angular/core';
+import { PraxisI18nService, PraxisIconDirective, DynamicWidgetLoaderDirective, ComponentMetadataRegistry, providePraxisI18n } from '@praxisui/core';
 import { CommonModule } from '@angular/common';
-import { PraxisI18nService, PraxisIconDirective, DynamicWidgetLoaderDirective, providePraxisI18n } from '@praxisui/core';
 import * as i1 from '@angular/material/icon';
 import { MatIconModule } from '@angular/material/icon';
 
-/**
- * Root provider entrypoint for the editorial runtime package.
- *
- * Intentionally minimal in v1:
- * - no global singleton graph yet
- * - no dependency on @praxisui/dynamic-form
- * - safe to consume from apps without pulling generic form authoring
- */
-function providePraxisEditorialForms() {
-    return makeEnvironmentProviders([]);
-}
-
 const DEFAULT_EDITORIAL_RUNTIME_HOST_CONFIG = {
     emitOperationalEvents: true,
     forwardAdapterOperationalEvents: true,
@@ -3775,6 +3763,172 @@ function formatScopeLabel(labelName, label, id) {
     return null;
 }
 
+const EDITORIAL_FORM_RUNTIME_PORTS = [
+    {
+        id: 'solution',
+        label: 'Editorial solution',
+        direction: 'input',
+        semanticKind: 'config-fragment',
+        schema: {
+            id: 'EditorialSolutionDefinition',
+            kind: 'ts-type',
+            ref: 'EditorialSolutionDefinition',
+        },
+        description: 'Canonical editorial solution definition consumed by the runtime.',
+        exposure: { public: true, group: 'config' },
+    },
+    {
+        id: 'instance',
+        label: 'Editorial instance',
+        direction: 'input',
+        semanticKind: 'config-fragment',
+        schema: {
+            id: 'EditorialTemplateInstance',
+            kind: 'ts-type',
+            ref: 'EditorialTemplateInstance',
+        },
+        description: 'Runtime instance with persisted context, overrides and selected template reference.',
+        exposure: { public: true, group: 'config' },
+    },
+    {
+        id: 'runtimeContext',
+        label: 'Runtime context',
+        direction: 'input',
+        semanticKind: 'view-context',
+        schema: {
+            id: 'Record<string, unknown>',
+            kind: 'ts-type',
+            ref: 'Record<string, unknown>',
+        },
+        description: 'Host-provided context merged with the editorial instance context.',
+        exposure: { public: true, group: 'context' },
+    },
+    {
+        id: 'snapshotChange',
+        label: 'Snapshot change',
+        direction: 'output',
+        semanticKind: 'event',
+        cardinality: 'stream',
+        schema: {
+            id: 'EditorialRuntimeSnapshot',
+            kind: 'ts-type',
+            ref: 'EditorialRuntimeSnapshot',
+        },
+        description: 'Resolved editorial runtime snapshot emitted when solution, instance or context changes.',
+        exposure: { public: true, group: 'events' },
+    },
+    {
+        id: 'fallbackChange',
+        label: 'Fallback change',
+        direction: 'output',
+        semanticKind: 'status',
+        cardinality: 'stream',
+        schema: {
+            id: 'EditorialRuntimeFallbackState',
+            kind: 'ts-type',
+            ref: 'EditorialRuntimeFallbackState',
+        },
+        description: 'Operational fallback state emitted when diagnostics affect runtime health.',
+        exposure: { public: true, group: 'status' },
+    },
+    {
+        id: 'operationalEvent',
+        label: 'Operational event',
+        direction: 'output',
+        semanticKind: 'diagnostic',
+        cardinality: 'stream',
+        schema: {
+            id: 'EditorialRuntimeOperationalEvent',
+            kind: 'ts-type',
+            ref: 'EditorialRuntimeOperationalEvent',
+        },
+        description: 'Technical event stream for diagnostics, blocking errors and adapter state.',
+        exposure: { public: true, advanced: true, group: 'diagnostics' },
+    },
+];
+const EDITORIAL_FORM_RUNTIME_COMPONENT_METADATA = {
+    id: 'praxis-editorial-form-runtime',
+    componentType: 'praxis-editorial-form-runtime',
+    selector: 'praxis-editorial-form-runtime',
+    component: EditorialFormRuntimeComponent,
+    friendlyName: 'Praxis Editorial Form Runtime',
+    displayName: 'Praxis Editorial Form Runtime',
+    description: 'Guided editorial runtime for solution and instance driven form experiences.',
+    icon: 'article',
+    lib: '@praxisui/editorial-forms',
+    tags: ['widget', 'editorial', 'forms', 'runtime', 'guided-flow'],
+    inputs: [
+        {
+            name: 'solution',
+            type: 'EditorialSolutionDefinition | null',
+            description: 'Canonical editorial solution definition.',
+        },
+        {
+            name: 'instance',
+            type: 'EditorialTemplateInstance | null',
+            description: 'Editorial instance with context and overrides.',
+        },
+        {
+            name: 'runtimeContext',
+            type: 'Record<string, unknown> | null',
+            description: 'Host context merged into the resolved runtime context.',
+        },
+        {
+            name: 'hostConfig',
+            type: 'EditorialRuntimeHostConfig | null',
+            description: 'Host controls for operational event forwarding.',
+        },
+    ],
+    outputs: [
+        {
+            name: 'snapshotChange',
+            type: 'EditorialRuntimeSnapshot',
+            description: 'Resolved snapshot emitted by the editorial runtime.',
+        },
+        {
+            name: 'fallbackChange',
+            type: 'EditorialRuntimeFallbackState',
+            description: 'Fallback state emitted when diagnostics affect runtime health.',
+        },
+        {
+            name: 'operationalEvent',
+            type: 'EditorialRuntimeOperationalEvent',
+            description: 'Operational diagnostics event stream.',
+        },
+    ],
+    ports: EDITORIAL_FORM_RUNTIME_PORTS,
+    layoutHints: {
+        recommendedCols: 6,
+        recommendedRows: 6,
+        minCols: 4,
+        minRows: 4,
+    },
+};
+function providePraxisEditorialFormRuntimeMetadata() {
+    return {
+        provide: ENVIRONMENT_INITIALIZER,
+        multi: true,
+        useFactory: (registry) => () => {
+            registry.register(EDITORIAL_FORM_RUNTIME_COMPONENT_METADATA);
+        },
+        deps: [ComponentMetadataRegistry],
+    };
+}
+
+/**
+ * Root provider entrypoint for the editorial runtime package.
+ *
+ * Registers the public DynamicWidgetLoader metadata for
+ * praxis-editorial-form-runtime in ComponentMetadataRegistry. This is the
+ * canonical setup hook for hosts that render editorial forms through dynamic
+ * composition; it does not introduce a separate global runtime singleton graph.
+ */
+function providePraxisEditorialForms() {
+    return makeEnvironmentProviders([
+        providePraxisEditorialFormRuntimeMetadata(),
+    ]);
+}
+
 const REQUIRED_DYNAMIC_FORM_INPUTS = ['config', 'formId', 'editorialContext'];
 function readRuntimeFormData(runtimeContext) {
     const formData = runtimeContext?.['formData'];
@@ -4301,4 +4455,4 @@ function getHarnessDataEngineComponent() {
  * Generated bundle index. Do not edit.
  */
 
-export { DEFAULT_EDITORIAL_RUNTIME_HOST_CONFIG, EDITORIAL_DATA_BLOCK_ADAPTER, EditorialBlockRendererComponent, EditorialDataBlockAdapterRegistry, EditorialDataCollectionBlockOutletComponent, EditorialFormRuntimeComponent, EditorialIntroHeroBlockComponent, EditorialReviewSectionsBlockComponent, EditorialRuntimeState, EditorialSelectionCardsBlockComponent, EditorialStepperComponent, EditorialSuccessPanelBlockComponent, HarnessDataEngineComponent, PRAXIS_EDITORIAL_FORMS_EN_US, PRAXIS_EDITORIAL_FORMS_PT_BR, buildRuntimeCssVars, buildRuntimeLayoutCss, createEditorialDynamicFormAdapter, createEditorialRuntimeHarnessCatalog, createPraxisEditorialFormsI18nConfig, deriveRuntimeFallbackState, getHarnessDataEngineComponent, getStepDisplayState, getValueAtPath, getVisibleBlocks, isBlockVisible, matchesVisibilityRule, provideEditorialDataBlockAdapter, provideEditorialDynamicFormAdapter, providePraxisEditorialForms, providePraxisEditorialFormsI18n, resolveActiveJourney, resolveActiveStep, resolveDensity, resolveEditorialDataBlockAdapter, resolveEditorialDataBlockFormConfig, resolveEditorialDataBlockFormConfigDetails, resolveEditorialRuntimeSnapshot, resolveRuntimeOrientation, resolveShellVariant };
+export { DEFAULT_EDITORIAL_RUNTIME_HOST_CONFIG, EDITORIAL_DATA_BLOCK_ADAPTER, EDITORIAL_FORM_RUNTIME_COMPONENT_METADATA, EditorialBlockRendererComponent, EditorialDataBlockAdapterRegistry, EditorialDataCollectionBlockOutletComponent, EditorialFormRuntimeComponent, EditorialIntroHeroBlockComponent, EditorialReviewSectionsBlockComponent, EditorialRuntimeState, EditorialSelectionCardsBlockComponent, EditorialStepperComponent, EditorialSuccessPanelBlockComponent, HarnessDataEngineComponent, PRAXIS_EDITORIAL_FORMS_EN_US, PRAXIS_EDITORIAL_FORMS_PT_BR, buildRuntimeCssVars, buildRuntimeLayoutCss, createEditorialDynamicFormAdapter, createEditorialRuntimeHarnessCatalog, createPraxisEditorialFormsI18nConfig, deriveRuntimeFallbackState, getHarnessDataEngineComponent, getStepDisplayState, getValueAtPath, getVisibleBlocks, isBlockVisible, matchesVisibilityRule, provideEditorialDataBlockAdapter, provideEditorialDynamicFormAdapter, providePraxisEditorialFormRuntimeMetadata, providePraxisEditorialForms, providePraxisEditorialFormsI18n, resolveActiveJourney, resolveActiveStep, resolveDensity, resolveEditorialDataBlockAdapter, resolveEditorialDataBlockFormConfig, resolveEditorialDataBlockFormConfigDetails, resolveEditorialRuntimeSnapshot, resolveRuntimeOrientation, resolveShellVariant };

package/index.d.ts

@@ -1,15 +1,15 @@
 import * as _angular_core from '@angular/core';
-import { EnvironmentProviders, Type, InjectionToken } from '@angular/core';
+import { EnvironmentProviders, Provider, Type, InjectionToken } from '@angular/core';
 import * as _praxisui_core from '@praxisui/core';
-import { EditorialProblemType, EditorialWizardPresentation, EditorialThemePreset, EditorialCompliancePreset, EditorialStepKind, EditorialIconSpec, EditorialStepVisualConfig, EditorialBlock, EditorialDataCollectionBlock, EditorialSolutionDefinition, EditorialTemplateInstance, PraxisTranslationParams, FormConfig, EditorialLayoutConfig, EditorialStepperConfig, EditorialOrientation, EditorialThemeTokens, EditorialBlockVisibilityRule, PraxisI18nDictionary, PraxisI18nConfig, EditorialIntroHeroBlock, EditorialHeroBlock, EditorialRichTextBlock, EditorialPolicyListBlock, EditorialTimelineStepsBlock, EditorialReviewSummaryBlock, EditorialReviewSectionsBlock, EditorialContextSummaryBlock, EditorialSelectionCardsBlock, EditorialInfoCardsBlock, EditorialSuccessPanelBlock, EditorialFaqAccordionBlock, EditorialPresentationalAction, EditorialReviewSectionField } from '@praxisui/core';
+import { EditorialProblemType, EditorialWizardPresentation, EditorialThemePreset, EditorialCompliancePreset, EditorialStepKind, EditorialIconSpec, EditorialStepVisualConfig, EditorialBlock, EditorialDataCollectionBlock, EditorialSolutionDefinition, EditorialTemplateInstance, PraxisTranslationParams, ComponentDocMeta, FormConfig, EditorialLayoutConfig, EditorialStepperConfig, EditorialOrientation, EditorialThemeTokens, EditorialBlockVisibilityRule, PraxisI18nDictionary, PraxisI18nConfig, EditorialIntroHeroBlock, EditorialHeroBlock, EditorialRichTextBlock, EditorialPolicyListBlock, EditorialTimelineStepsBlock, EditorialReviewSummaryBlock, EditorialReviewSectionsBlock, EditorialContextSummaryBlock, EditorialSelectionCardsBlock, EditorialInfoCardsBlock, EditorialSuccessPanelBlock, EditorialFaqAccordionBlock, EditorialPresentationalAction, EditorialReviewSectionField } from '@praxisui/core';
 
 /**
  * Root provider entrypoint for the editorial runtime package.
  *
- * Intentionally minimal in v1:
- * - no global singleton graph yet
- * - no dependency on @praxisui/dynamic-form
- * - safe to consume from apps without pulling generic form authoring
+ * Registers the public DynamicWidgetLoader metadata for
+ * praxis-editorial-form-runtime in ComponentMetadataRegistry. This is the
+ * canonical setup hook for hosts that render editorial forms through dynamic
+ * composition; it does not introduce a separate global runtime singleton graph.
  */
 declare function providePraxisEditorialForms(): EnvironmentProviders;
 
@@ -257,6 +257,9 @@ declare class EditorialFormRuntimeComponent {
     static ɵcmp: _angular_core.ɵɵComponentDeclaration<EditorialFormRuntimeComponent, "praxis-editorial-form-runtime", never, { "solution": { "alias": "solution"; "required": false; "isSignal": true; }; "instance": { "alias": "instance"; "required": false; "isSignal": true; }; "runtimeContext": { "alias": "runtimeContext"; "required": false; "isSignal": true; }; "hostConfig": { "alias": "hostConfig"; "required": false; "isSignal": true; }; }, { "snapshotChange": "snapshotChange"; "fallbackChange": "fallbackChange"; "operationalEvent": "operationalEvent"; }, never, never, true, never>;
 }
 
+declare const EDITORIAL_FORM_RUNTIME_COMPONENT_METADATA: ComponentDocMeta;
+declare function providePraxisEditorialFormRuntimeMetadata(): Provider;
+
 type EditorialDataBlockComponentInputs = Record<string, unknown>;
 interface EditorialDataBlockValueChangeEvent {
     formData: Record<string, unknown>;
@@ -748,5 +751,5 @@ interface EditorialRuntimeHarnessCatalog {
 declare function createEditorialRuntimeHarnessCatalog(): EditorialRuntimeHarnessCatalog;
 declare function getHarnessDataEngineComponent(): Type<unknown>;
 
-export { DEFAULT_EDITORIAL_RUNTIME_HOST_CONFIG, EDITORIAL_DATA_BLOCK_ADAPTER, EditorialBlockRendererComponent, EditorialDataBlockAdapterRegistry, EditorialDataCollectionBlockOutletComponent, EditorialFormRuntimeComponent, EditorialIntroHeroBlockComponent, EditorialReviewSectionsBlockComponent, EditorialRuntimeState, EditorialSelectionCardsBlockComponent, EditorialStepperComponent, EditorialSuccessPanelBlockComponent, HarnessDataEngineComponent, PRAXIS_EDITORIAL_FORMS_EN_US, PRAXIS_EDITORIAL_FORMS_PT_BR, buildRuntimeCssVars, buildRuntimeLayoutCss, createEditorialDynamicFormAdapter, createEditorialRuntimeHarnessCatalog, createPraxisEditorialFormsI18nConfig, deriveRuntimeFallbackState, getHarnessDataEngineComponent, getStepDisplayState, getValueAtPath, getVisibleBlocks, isBlockVisible, matchesVisibilityRule, provideEditorialDataBlockAdapter, provideEditorialDynamicFormAdapter, providePraxisEditorialForms, providePraxisEditorialFormsI18n, resolveActiveJourney, resolveActiveStep, resolveDensity, resolveEditorialDataBlockAdapter, resolveEditorialDataBlockFormConfig, resolveEditorialDataBlockFormConfigDetails, resolveEditorialRuntimeSnapshot, resolveRuntimeOrientation, resolveShellVariant };
+export { DEFAULT_EDITORIAL_RUNTIME_HOST_CONFIG, EDITORIAL_DATA_BLOCK_ADAPTER, EDITORIAL_FORM_RUNTIME_COMPONENT_METADATA, EditorialBlockRendererComponent, EditorialDataBlockAdapterRegistry, EditorialDataCollectionBlockOutletComponent, EditorialFormRuntimeComponent, EditorialIntroHeroBlockComponent, EditorialReviewSectionsBlockComponent, EditorialRuntimeState, EditorialSelectionCardsBlockComponent, EditorialStepperComponent, EditorialSuccessPanelBlockComponent, HarnessDataEngineComponent, PRAXIS_EDITORIAL_FORMS_EN_US, PRAXIS_EDITORIAL_FORMS_PT_BR, buildRuntimeCssVars, buildRuntimeLayoutCss, createEditorialDynamicFormAdapter, createEditorialRuntimeHarnessCatalog, createPraxisEditorialFormsI18nConfig, deriveRuntimeFallbackState, getHarnessDataEngineComponent, getStepDisplayState, getValueAtPath, getVisibleBlocks, isBlockVisible, matchesVisibilityRule, provideEditorialDataBlockAdapter, provideEditorialDynamicFormAdapter, providePraxisEditorialFormRuntimeMetadata, providePraxisEditorialForms, providePraxisEditorialFormsI18n, resolveActiveJourney, resolveActiveStep, resolveDensity, resolveEditorialDataBlockAdapter, resolveEditorialDataBlockFormConfig, resolveEditorialDataBlockFormConfigDetails, resolveEditorialRuntimeSnapshot, resolveRuntimeOrientation, resolveShellVariant };
 export type { DynamicFormCompatibleComponent, EditorialDataBlockAdapter, EditorialDataBlockAdapterResolution, EditorialDataBlockAdapterResolutionStatus, EditorialDataBlockComponentInputs, EditorialDataBlockContext, EditorialDataBlockResolution, EditorialDataBlockValueChangeEvent, EditorialDynamicFormAdapterOptions, EditorialResolvedBlock, EditorialResolvedBlockBase, EditorialResolvedBlockCompositionEntry, EditorialResolvedBlockCompositionOperation, EditorialResolvedBlockProvenance, EditorialResolvedBlockSourceKind, EditorialResolvedBlockSourceRef, EditorialResolvedDataCollectionBlock, EditorialResolvedDataCollectionState, EditorialResolvedJourney, EditorialResolvedStep, EditorialRuntimeDiagnostic, EditorialRuntimeDiagnosticCode, EditorialRuntimeDiagnosticScopeKind, EditorialRuntimeDiagnosticSeverity, EditorialRuntimeDiagnostics, EditorialRuntimeFallbackMode, EditorialRuntimeFallbackScope, EditorialRuntimeFallbackState, EditorialRuntimeFixture, EditorialRuntimeHarnessCatalog, EditorialRuntimeHostConfig, EditorialRuntimeInput, EditorialRuntimeOperationalEvent, EditorialRuntimeOperationalEventBase, EditorialRuntimeOperationalEventSeverity, EditorialRuntimeOperationalEventType, EditorialRuntimeSnapshot, PraxisEditorialFormsI18nOptions, ResolveEditorialRuntimeSnapshotInput };

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@praxisui/editorial-forms",
-  "version": "8.0.0-beta.1",
+  "version": "8.0.0-beta.11",
   "description": "Editorial form runtime for Praxis UI: journeys, presets, semantic blocks, and specialist hosting for editorial experiences.",
   "peerDependencies": {
     "@angular/common": "^20.0.0",
     "@angular/core": "^20.0.0",
-    "@praxisui/core": "^8.0.0-beta.1"
+    "@praxisui/core": "^8.0.0-beta.11"
   },
   "dependencies": {
     "tslib": "^2.3.0"