@arkcit/engine-render-layer 0.3.0

package/dist/resolution.d.ts

@@ -0,0 +1,185 @@
+import { ResolvedNodeChildDescriptor, ResolvedNodeContentDescriptor, ResolvedNodeBase, ResolvedNode } from '@arkcit/engine-core';
+import { UINode } from '@arkcit/engine-schema';
+import { UIRuntime } from '@arkcit/engine-runtime';
+
+declare const resolveChildContentDescriptor: ({ childDescriptors, }: {
+    childDescriptors: ResolvedNodeChildDescriptor[];
+}) => ResolvedNodeContentDescriptor;
+
+declare const resolveChildDescriptors: ({ node, internalStudioNodeTypes, }: {
+    node: UINode;
+    internalStudioNodeTypes: Set<string>;
+}) => ResolvedNodeChildDescriptor[];
+
+type CoverContentDescriptor = {
+    actionNodes: UINode[];
+    contentNodes: UINode[];
+};
+declare const resolveCoverContentDescriptor: ({ rawChildren, }: {
+    rawChildren: UINode[];
+}) => CoverContentDescriptor;
+
+type ButtonTogglePlan = {
+    kind: "button-toggle";
+    disableOnClick: boolean;
+};
+type FormFieldPlan = {
+    kind: "form-field";
+};
+type StudioFormPlan = {
+    kind: "studio-form";
+    visibleChildren: UINode[];
+};
+type CoverContentPlan = {
+    kind: "cover-content";
+    rawChildren: UINode[];
+    descriptor: CoverContentDescriptor;
+};
+type ScrollRevealPlan = {
+    kind: "scroll-reveal";
+    rawChildren: UINode[];
+};
+type ContentCompositionPlan = ButtonTogglePlan | FormFieldPlan | StudioFormPlan | CoverContentPlan | ScrollRevealPlan;
+declare const resolveContentCompositionPlan: ({ node, isStudioRendererContext, internalStudioNodeTypes, }: {
+    node: UINode;
+    isStudioRendererContext: boolean;
+    internalStudioNodeTypes: Set<string>;
+}) => ContentCompositionPlan[];
+
+type StyleSizingPlan = {
+    kind: "style-sizing";
+    style: Record<string, unknown>;
+};
+type ConfigureStudioLinkPlan = {
+    kind: "configure-studio-link";
+};
+type CleanupStudioPropsPlan = {
+    kind: "cleanup-studio-props";
+};
+type TableFallbackPlan = {
+    kind: "table-fallback";
+};
+type FinalRenderPlan = StyleSizingPlan | ConfigureStudioLinkPlan | CleanupStudioPropsPlan | TableFallbackPlan;
+declare const resolveFinalRenderPlan: ({ node, componentProps, isStudioRendererContext, studioSizing, }: {
+    node: UINode;
+    componentProps: Record<string, unknown>;
+    isStudioRendererContext: boolean;
+    studioSizing?: {
+        widthPct: number | null;
+        heightPct: number | null;
+        heightPx: number | null;
+    };
+}) => FinalRenderPlan[];
+
+declare const resolveNodeBase: ({ node, runtime, internalStudioNodeTypes, }: {
+    node: UINode;
+    runtime: UIRuntime;
+    internalStudioNodeTypes: Set<string>;
+}) => ResolvedNodeBase;
+
+type AccordionItemDescriptor = {
+    id: string;
+    title: string;
+    disabled: boolean;
+    contentKind: "text" | "nodes";
+    contentText: string | null;
+    contentNodes: UINode[];
+};
+type ExpandablePanelContentDescriptor = {
+    kind: "empty" | "nodes";
+    nodes: UINode[];
+};
+declare const resolveAccordionItemDescriptors: ({ accordionChildren, }: {
+    accordionChildren: UINode[];
+}) => AccordionItemDescriptor[];
+declare const resolveExpandablePanelContentDescriptor: ({ panelChildren, }: {
+    panelChildren: UINode[];
+}) => ExpandablePanelContentDescriptor;
+
+type TabsContentDescriptor = {
+    id: string;
+    title: unknown;
+    label: unknown;
+    contentKind: "nodes" | "fallback";
+    contentNodes: UINode[];
+    fallbackContent: unknown;
+};
+declare const resolveTabsContentDescriptors: ({ tabItems, rawChildren, runtime, }: {
+    tabItems: Array<Record<string, unknown>>;
+    rawChildren: UINode[];
+    runtime: UIRuntime;
+}) => TabsContentDescriptor[];
+
+type FormWizardPlan = {
+    kind: "form-wizard";
+};
+type AccordionPlan = {
+    kind: "accordion";
+    accordionChildren: UINode[];
+    itemDescriptors: AccordionItemDescriptor[];
+};
+type ExpandablePanelPlan = {
+    kind: "expandable-panel";
+    panelChildren: UINode[];
+    contentDescriptor: ExpandablePanelContentDescriptor;
+};
+type TabsPlan = {
+    kind: "tabs";
+    normalizedComponentProps: Record<string, unknown>;
+    rawChildren: UINode[];
+    tabDescriptors: TabsContentDescriptor[];
+};
+type NavigationCompositionPlan = FormWizardPlan | AccordionPlan | ExpandablePanelPlan | TabsPlan;
+declare const resolveNavigationCompositionPlan: ({ node, componentProps, internalStudioNodeTypes, runtime, }: {
+    node: UINode;
+    componentProps: Record<string, unknown>;
+    internalStudioNodeTypes: Set<string>;
+    runtime: UIRuntime;
+}) => NavigationCompositionPlan[];
+
+type RowColumnBindingDirective = {
+    kind: "rows-columns-binding";
+    rowsBindingKey: string;
+    columnsBindingKey: string;
+};
+type ObjectBindingDirective = {
+    kind: "object-binding";
+    bindingKey: string;
+};
+type TranslationBindingDirective = {
+    kind: "decode-translation-binding";
+    tagContentTranslationKey: string;
+    tagContentTranslationValue: string;
+    hrefTranslationKey: string;
+    hrefTranslationValue: string;
+};
+type CoverMediaDirective = {
+    kind: "cover-media";
+    mediaSource: string;
+    mediaSrc: string;
+    mediaAlt: string;
+};
+type FilterRowsDirective = {
+    kind: "filter-rows-by-query";
+    nodeId: string;
+};
+type RenderDirectivePlan = RowColumnBindingDirective | ObjectBindingDirective | TranslationBindingDirective | CoverMediaDirective | FilterRowsDirective;
+declare const resolveRenderDirectivePlan: ({ node, renderBindingProps, }: {
+    node: UINode;
+    renderBindingProps: Record<string, unknown>;
+}) => RenderDirectivePlan[];
+
+type ResolvedEngineNode = ResolvedNode<ContentCompositionPlan, NavigationCompositionPlan, RenderDirectivePlan, FinalRenderPlan>;
+declare const resolveResolvedNode: ({ node, runtime, internalStudioNodeTypes, isStudioRendererContext, studioSizing, }: {
+    node: UINode;
+    runtime: UIRuntime;
+    internalStudioNodeTypes: Set<string>;
+    isStudioRendererContext: boolean;
+    studioSizing?: {
+        widthPct: number | null;
+        heightPct: number | null;
+        heightPx: number | null;
+    };
+}) => ResolvedEngineNode;
+
+export { type AccordionItemDescriptor, type ContentCompositionPlan, type CoverContentDescriptor, type ExpandablePanelContentDescriptor, type FinalRenderPlan, type NavigationCompositionPlan, type RenderDirectivePlan, type ResolvedEngineNode, type TabsContentDescriptor, resolveAccordionItemDescriptors, resolveChildContentDescriptor, resolveChildDescriptors, resolveContentCompositionPlan, resolveCoverContentDescriptor, resolveExpandablePanelContentDescriptor, resolveFinalRenderPlan, resolveNavigationCompositionPlan, resolveNodeBase, resolveRenderDirectivePlan, resolveResolvedNode, resolveTabsContentDescriptors };