@contrail/documents 1.15.0 → 1.15.1-alpha.c8c648c

package/CHANGELOG.md

@@ -5,6 +5,16 @@ All notable changes to `@contrail/documents` are documented here.
 Format follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 Versioning follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.15.1] - 2026-08-28
+
+### Added
+
+- `DYNAMIC_TEXT_DATA_SOURCE.SECTION`, the `DynamicTextContainer` type, `MOVE_TO_SECTION_TEXT`, and `isContainerBinding()`. `DynamicTextUtil.getDynamicTextValue` now evaluates `section.*` bindings (`name`, `count`, `itemFamilyCount`, `itemOptionCount`, `colorCount`) the same way it already evaluates `frame.*`.
+
+### Changed
+
+- `getDynamicTextValue`'s fourth parameter is typed `DynamicTextContainer` rather than `{ name, id }`. This is source-compatible: `source` is optional and a container without one is treated as a frame, so existing callers need no change. Which kind of container is rendered is read from the binding (`frame.count` vs `section.count`); `source` records what the caller resolved.
+
 ## [1.15.0] - 2026-08-21
 
 ### Added

package/lib/util/dynamic-text/dynamic-text-util.d.ts

@@ -4,7 +4,14 @@ export declare enum DYNAMIC_TEXT_DATA_SOURCE {
     PROJECT = "project",
     BOARD = "board",
     SHOWCASE = "showcase",
-    FRAME = "frame"
+    FRAME = "frame",
+    SECTION = "section"
+}
+export type DynamicTextContainerSource = DYNAMIC_TEXT_DATA_SOURCE.FRAME | DYNAMIC_TEXT_DATA_SOURCE.SECTION;
+export interface DynamicTextContainer {
+    name: string;
+    id?: string;
+    source?: DynamicTextContainerSource;
 }
 export declare enum DynamicTextDisplayFunction {
     VALUE = "value",
@@ -18,6 +25,7 @@ export declare enum DynamicTextDisplayFunction {
     SUM = "sum"
 }
 export declare const MOVE_TO_FRAME_TEXT = "Move to a frame";
+export declare const MOVE_TO_SECTION_TEXT = "Move to a section";
 export declare const CLICK_TO_CONFIGURE = "Click to configure";
 export declare const HARD_CODED_TEXT: {
     'project.name': string;
@@ -34,12 +42,15 @@ export declare const HARD_CODED_TEXT: {
     'frame.itemFamilyCount': string;
     'frame.itemOptionCount': string;
     'frame.colorCount': string;
+    'section.name': string;
+    'section.count': string;
+    'section.itemFamilyCount': string;
+    'section.itemOptionCount': string;
+    'section.colorCount': string;
 };
+export declare function isContainerBinding(bindingProperty: string): boolean;
 export declare class DynamicTextUtil {
-    static getDynamicTextValue(dynamicTextElement: DocumentElement, property: TypeProperty, propertyLevel: PropertyLevel, frame: {
-        name: string;
-        id?: string;
-    }, componentModels: any[], ownerReferenceModel?: any): string;
+    static getDynamicTextValue(dynamicTextElement: DocumentElement, property: TypeProperty, propertyLevel: PropertyLevel, container: DynamicTextContainer, componentModels: any[], ownerReferenceModel?: any): string;
     static calculateSize(dynamicTextElement: DocumentElement, entityType: any, text: string): import("../..").SizeDefinition;
     static getTextFromFrameMemberValues(displayFunction: string, property: any, memberValues: any[]): string;
     private static getItemCount;

package/lib/util/dynamic-text/dynamic-text-util.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DynamicTextUtil = exports.HARD_CODED_TEXT = exports.CLICK_TO_CONFIGURE = exports.MOVE_TO_FRAME_TEXT = exports.DynamicTextDisplayFunction = exports.DYNAMIC_TEXT_DATA_SOURCE = void 0;
+exports.DynamicTextUtil = exports.HARD_CODED_TEXT = exports.CLICK_TO_CONFIGURE = exports.MOVE_TO_SECTION_TEXT = exports.MOVE_TO_FRAME_TEXT = exports.DynamicTextDisplayFunction = exports.DYNAMIC_TEXT_DATA_SOURCE = void 0;
+exports.isContainerBinding = isContainerBinding;
 const types_1 = require("@contrail/types");
 const util_1 = require("@contrail/util");
 const document_util_1 = require("@contrail/document-util");
@@ -10,6 +11,7 @@ var DYNAMIC_TEXT_DATA_SOURCE;
     DYNAMIC_TEXT_DATA_SOURCE["BOARD"] = "board";
     DYNAMIC_TEXT_DATA_SOURCE["SHOWCASE"] = "showcase";
     DYNAMIC_TEXT_DATA_SOURCE["FRAME"] = "frame";
+    DYNAMIC_TEXT_DATA_SOURCE["SECTION"] = "section";
 })(DYNAMIC_TEXT_DATA_SOURCE || (exports.DYNAMIC_TEXT_DATA_SOURCE = DYNAMIC_TEXT_DATA_SOURCE = {}));
 var DynamicTextDisplayFunction;
 (function (DynamicTextDisplayFunction) {
@@ -24,6 +26,7 @@ var DynamicTextDisplayFunction;
     DynamicTextDisplayFunction["SUM"] = "sum";
 })(DynamicTextDisplayFunction || (exports.DynamicTextDisplayFunction = DynamicTextDisplayFunction = {}));
 exports.MOVE_TO_FRAME_TEXT = 'Move to a frame';
+exports.MOVE_TO_SECTION_TEXT = 'Move to a section';
 exports.CLICK_TO_CONFIGURE = 'Click to configure';
 exports.HARD_CODED_TEXT = {
     'project.name': 'Project name',
@@ -40,16 +43,23 @@ exports.HARD_CODED_TEXT = {
     'frame.itemFamilyCount': 'Item family count',
     'frame.itemOptionCount': 'Item option count',
     'frame.colorCount': 'Color count',
+    'section.name': 'Section name',
+    'section.count': 'Total count',
+    'section.itemFamilyCount': 'Item family count',
+    'section.itemOptionCount': 'Item option count',
+    'section.colorCount': 'Color count',
 };
-const frameProperties = [
-    'frame.name',
-    'frame.count',
-    'frame.itemFamilyCount',
-    'frame.itemOptionCount',
-    'frame.colorCount',
-];
+const CONTAINER_PROPERTY_SLUGS = ['name', 'count', 'itemFamilyCount', 'itemOptionCount', 'colorCount'];
+const CONTAINER_SOURCES = [DYNAMIC_TEXT_DATA_SOURCE.FRAME, DYNAMIC_TEXT_DATA_SOURCE.SECTION];
+function isContainerBinding(bindingProperty) {
+    if (!bindingProperty) {
+        return false;
+    }
+    const [entityType, propertySlug] = bindingProperty.split('.');
+    return CONTAINER_SOURCES.includes(entityType) && CONTAINER_PROPERTY_SLUGS.includes(propertySlug);
+}
 class DynamicTextUtil {
-    static getDynamicTextValue(dynamicTextElement, property, propertyLevel, frame, componentModels, ownerReferenceModel = null) {
+    static getDynamicTextValue(dynamicTextElement, property, propertyLevel, container, componentModels, ownerReferenceModel = null) {
         var _a, _b, _c, _d;
         if (!dynamicTextElement.propertyBindings || !dynamicTextElement.propertyBindings.text) {
             return exports.CLICK_TO_CONFIGURE;
@@ -78,11 +88,11 @@ class DynamicTextUtil {
                 : formatter.formatValue(text, types_1.PropertyType.String);
         }
         else {
-            if (!frame && !isSpecRelated) {
-                text = exports.MOVE_TO_FRAME_TEXT;
+            if (!container && !isSpecRelated) {
+                text = entityType === DYNAMIC_TEXT_DATA_SOURCE.SECTION ? exports.MOVE_TO_SECTION_TEXT : exports.MOVE_TO_FRAME_TEXT;
             }
             else {
-                if (entityType === 'frame') {
+                if (CONTAINER_SOURCES.includes(entityType)) {
                     if (propertySlug === 'count') {
                         text = componentModels.length.toString();
                     }
@@ -90,11 +100,11 @@ class DynamicTextUtil {
                         text = this.getItemCount(propertySlug, componentModels);
                     }
                     else {
-                        text = frame === null || frame === void 0 ? void 0 : frame.name;
+                        text = container === null || container === void 0 ? void 0 : container.name;
                     }
                 }
                 else {
-                    if (frameProperties.includes(bindingProperty)) {
+                    if (isContainerBinding(bindingProperty)) {
                         property = null;
                     }
                     const frameMemberValues = [];
@@ -121,13 +131,13 @@ class DynamicTextUtil {
             }
         }
         if (displayFunction === DynamicTextDisplayFunction.LABEL) {
-            if (['showcase', 'board', 'project', 'frame'].includes(entityType) || isSpecRelated) {
+            if (['showcase', 'board', 'project', ...CONTAINER_SOURCES].includes(entityType) || isSpecRelated) {
                 text = exports.HARD_CODED_TEXT[bindingProperty] || (property === null || property === void 0 ? void 0 : property.label);
             }
-            else if (!frame) {
+            else if (!container) {
                 text = exports.MOVE_TO_FRAME_TEXT;
             }
-            else if (frame) {
+            else {
                 text = property === null || property === void 0 ? void 0 : property.label;
             }
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/documents",
-  "version": "1.15.0",
+  "version": "1.15.1-alpha.c8c648c",
   "description": "Documents library for contrail platform",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",