@contrail/documents 2.4.0-alpha.9ac43de → 2.4.0-alpha.a27dfea
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +26 -13
- package/lib/containers/container-kind.d.ts +0 -1
- package/lib/containers/container-kind.js +2 -10
- package/lib/containers/document-container-index.d.ts +1 -0
- package/lib/containers/document-container-index.js +9 -0
- package/lib/containers/document-container.service.js +13 -19
- package/lib/util/dynamic-text/dynamic-text-util.js +3 -2
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -13,12 +13,15 @@ Also shipped on the 1.x line as 1.21.0.
|
|
|
13
13
|
|
|
14
14
|
- `DocumentContainerService.buildIndex` and `DocumentContainerIndex` — which containers hold which
|
|
15
15
|
elements, for one document, resolved once and read back by lookup. A container is a frame or a
|
|
16
|
-
section, described by a `ContainerKind` carrying `elementType
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
16
|
+
section, described by a `ContainerKind` carrying `elementType` and `nests`. An element belongs to
|
|
17
|
+
the container whose box covers its anchor point and which is drawn below it, unless the element's
|
|
18
|
+
own box encloses that container or the element is a group holding it. `nests` decides the shape of
|
|
19
|
+
the answer: sections nest, so an element in a section inside another is in both, and the chain
|
|
20
|
+
requires the inner container to be drawn above the outer; frames do not, so an element covered by
|
|
21
|
+
two frames is in the topmost. A container of another kind is placed by the same rules as any
|
|
22
|
+
element, so a frame can be in a section and a section drawn above a frame is in that frame. The
|
|
23
|
+
rule is written out in `src/containers/DOCUMENT_CONTAINERS_SPEC.md`, which the code is measured
|
|
24
|
+
against.
|
|
22
25
|
- `SECTION_ELEMENT_TYPE`, `FRAME_ELEMENT_TYPE` and `SHAPE_ELEMENT_TYPES` in
|
|
23
26
|
`document-element-constants`, so the rule above has one definition rather than one per app.
|
|
24
27
|
- `DocumentContainerUtil` — the container geometry as statics, with `anchorFor` for a caller
|
|
@@ -51,10 +54,17 @@ Also shipped on the 1.x line as 1.21.0.
|
|
|
51
54
|
- The corner is the rotated one (VIBE-9567). A 200x20 text turned on its side draws as a 20x200
|
|
52
55
|
column, and its unrotated `position` can sit well clear of the frame it is visibly on, which
|
|
53
56
|
reported "Move to a frame" for a vertical text the user could see was placed correctly.
|
|
54
|
-
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
57
|
+
- An element covering a container is not inside it, whatever its type. This replaces a rule that
|
|
58
|
+
excluded only shapes wider and taller than the container, which let a background image join the
|
|
59
|
+
frame it covered and needed an exemption for dynamic text, whose size the container decides. An
|
|
60
|
+
unrotated dynamic text cannot be excluded by enclosure, since its anchor is the corner of the box
|
|
61
|
+
it would have to cover with.
|
|
62
|
+
- `isDynamicText` requires a `propertyBindings.text` binding, which is the one the value is read
|
|
63
|
+
from. The text tool creates an element with empty `propertyBindings` and `propertyBindingsMetaData`
|
|
64
|
+
and both are truthy, so an unconfigured text was anchored at its corner while the canvas centred
|
|
65
|
+
it.
|
|
66
|
+
- A line or callout is measured from the elements it connects even with no stored `position` of its
|
|
67
|
+
own, where it was previously left out of the index entirely.
|
|
58
68
|
- `min` and `max` rendered an infinity sign when every member value was empty. The early return
|
|
59
69
|
checked the list length before the empty values were filtered out, so `Math.min` of nothing
|
|
60
70
|
reached the formatter. Both now fall through to `n/a`.
|
|
@@ -71,9 +81,12 @@ Also shipped on the 1.x line as 1.21.0.
|
|
|
71
81
|
caller holding an element gets the answer the index would give it. Reading `size` directly
|
|
72
82
|
disagreed for the types whose box is not position plus size: a component's box is built from the
|
|
73
83
|
rows it draws, and a line's comes from its `lineDefinition`.
|
|
74
|
-
-
|
|
75
|
-
|
|
76
|
-
|
|
84
|
+
- A container path is a containment chain, walked outward from the container the element sits on.
|
|
85
|
+
Two containers that merely cross are not a chain, so the later-drawn one takes the element rather
|
|
86
|
+
than both claiming it. `containerPathAtPoint` walks the same chain, so a drop preview agrees with
|
|
87
|
+
the drop; it applies only the anchor rule, having no element to compare against a container.
|
|
88
|
+
- `buildIndex` scans element types before measuring anything, so a document holding no containers
|
|
89
|
+
of the kinds asked for returns an empty index without a geometry pass.
|
|
77
90
|
|
|
78
91
|
## [2.3.0] - 2026-09-21
|
|
79
92
|
|
|
@@ -3,7 +3,6 @@ export type ContainerElementType = typeof FRAME_ELEMENT_TYPE | typeof SECTION_EL
|
|
|
3
3
|
export interface ContainerKind {
|
|
4
4
|
elementType: ContainerElementType;
|
|
5
5
|
nests: boolean;
|
|
6
|
-
canBeContentOf: readonly ContainerElementType[];
|
|
7
6
|
}
|
|
8
7
|
export declare const SECTION_KIND: ContainerKind;
|
|
9
8
|
export declare const FRAME_KIND: ContainerKind;
|
|
@@ -2,14 +2,6 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.CONTAINER_KINDS = exports.FRAME_KIND = exports.SECTION_KIND = void 0;
|
|
4
4
|
const document_element_constants_1 = require("../document-element-constants");
|
|
5
|
-
exports.SECTION_KIND = {
|
|
6
|
-
|
|
7
|
-
nests: true,
|
|
8
|
-
canBeContentOf: [document_element_constants_1.SECTION_ELEMENT_TYPE],
|
|
9
|
-
};
|
|
10
|
-
exports.FRAME_KIND = {
|
|
11
|
-
elementType: document_element_constants_1.FRAME_ELEMENT_TYPE,
|
|
12
|
-
nests: false,
|
|
13
|
-
canBeContentOf: [document_element_constants_1.SECTION_ELEMENT_TYPE],
|
|
14
|
-
};
|
|
5
|
+
exports.SECTION_KIND = { elementType: document_element_constants_1.SECTION_ELEMENT_TYPE, nests: true };
|
|
6
|
+
exports.FRAME_KIND = { elementType: document_element_constants_1.FRAME_ELEMENT_TYPE, nests: false };
|
|
15
7
|
exports.CONTAINER_KINDS = [exports.SECTION_KIND, exports.FRAME_KIND];
|
|
@@ -10,6 +10,7 @@ export declare class DocumentContainerIndex {
|
|
|
10
10
|
memberIdsByContainerId: Map<string, string[]>;
|
|
11
11
|
containerIdsByElementType: Map<string, string[]>;
|
|
12
12
|
});
|
|
13
|
+
static empty(): DocumentContainerIndex;
|
|
13
14
|
getContainer(containerId: string): DocumentContainer | null;
|
|
14
15
|
containersOf(documentElementId: string, elementType: ContainerElementType): DocumentContainer[];
|
|
15
16
|
containerIdsOf(documentElementId: string, elementType: ContainerElementType): readonly string[];
|
|
@@ -6,6 +6,15 @@ class DocumentContainerIndex {
|
|
|
6
6
|
constructor(data) {
|
|
7
7
|
this.data = data;
|
|
8
8
|
}
|
|
9
|
+
static empty() {
|
|
10
|
+
return new DocumentContainerIndex({
|
|
11
|
+
documentElementsById: new Map(),
|
|
12
|
+
containersById: new Map(),
|
|
13
|
+
containerPathsByDocumentElementId: new Map(),
|
|
14
|
+
memberIdsByContainerId: new Map(),
|
|
15
|
+
containerIdsByElementType: new Map(),
|
|
16
|
+
});
|
|
17
|
+
}
|
|
9
18
|
getContainer(containerId) {
|
|
10
19
|
var _a;
|
|
11
20
|
return (_a = this.data.containersById.get(containerId)) !== null && _a !== void 0 ? _a : null;
|
|
@@ -8,7 +8,13 @@ const document_container_1 = require("./document-container");
|
|
|
8
8
|
class DocumentContainerService {
|
|
9
9
|
static buildIndex(documentElements, kinds = container_kind_1.CONTAINER_KINDS) {
|
|
10
10
|
var _a, _b;
|
|
11
|
-
const
|
|
11
|
+
const elements = documentElements !== null && documentElements !== void 0 ? documentElements : [];
|
|
12
|
+
const containerElementTypes = new Set(kinds.map((kind) => kind.elementType));
|
|
13
|
+
if (!elements.some((element) => containerElementTypes.has(element === null || element === void 0 ? void 0 : element.type))) {
|
|
14
|
+
return document_container_index_1.DocumentContainerIndex.empty();
|
|
15
|
+
}
|
|
16
|
+
const documentElementsById = new Map(elements.map((element) => [element.id, element]));
|
|
17
|
+
const measuredDocumentElements = this.measureDocumentElements(elements, documentElementsById);
|
|
12
18
|
const containersByElementType = new Map(kinds.map((kind) => [kind.elementType, this.collectContainers(measuredDocumentElements, kind)]));
|
|
13
19
|
const containersById = new Map();
|
|
14
20
|
const containerIdsByElementType = new Map();
|
|
@@ -24,12 +30,6 @@ class DocumentContainerService {
|
|
|
24
30
|
}
|
|
25
31
|
pathsByMeasured.set(measured, byElementType);
|
|
26
32
|
}
|
|
27
|
-
const measuredById = new Map();
|
|
28
|
-
for (const measured of measuredDocumentElements) {
|
|
29
|
-
if (!measuredById.has(measured.documentElement.id)) {
|
|
30
|
-
measuredById.set(measured.documentElement.id, measured);
|
|
31
|
-
}
|
|
32
|
-
}
|
|
33
33
|
const containerPathsByDocumentElementId = new Map();
|
|
34
34
|
const memberIdsByContainerId = new Map();
|
|
35
35
|
for (const measured of measuredDocumentElements) {
|
|
@@ -50,7 +50,7 @@ class DocumentContainerService {
|
|
|
50
50
|
containerPathsByDocumentElementId.set(documentElementId, pathsByElementType);
|
|
51
51
|
}
|
|
52
52
|
return new document_container_index_1.DocumentContainerIndex({
|
|
53
|
-
documentElementsById
|
|
53
|
+
documentElementsById,
|
|
54
54
|
containersById,
|
|
55
55
|
containerPathsByDocumentElementId,
|
|
56
56
|
memberIdsByContainerId,
|
|
@@ -60,8 +60,7 @@ class DocumentContainerService {
|
|
|
60
60
|
static isContainer(documentElement, kinds = container_kind_1.CONTAINER_KINDS) {
|
|
61
61
|
return kinds.some((kind) => kind.elementType === (documentElement === null || documentElement === void 0 ? void 0 : documentElement.type));
|
|
62
62
|
}
|
|
63
|
-
static measureDocumentElements(documentElements) {
|
|
64
|
-
const documentElementsById = new Map(documentElements.map((documentElement) => [documentElement.id, documentElement]));
|
|
63
|
+
static measureDocumentElements(documentElements, documentElementsById) {
|
|
65
64
|
return documentElements.map((documentElement, drawOrder) => ({
|
|
66
65
|
documentElement,
|
|
67
66
|
drawOrder,
|
|
@@ -70,7 +69,8 @@ class DocumentContainerService {
|
|
|
70
69
|
}
|
|
71
70
|
static measure(documentElement, documentElementsById) {
|
|
72
71
|
var _a, _b;
|
|
73
|
-
|
|
72
|
+
const isDerivedFromEndpoints = (documentElement === null || documentElement === void 0 ? void 0 : documentElement.type) === 'line' || (documentElement === null || documentElement === void 0 ? void 0 : documentElement.type) === 'callout';
|
|
73
|
+
if (!(documentElement === null || documentElement === void 0 ? void 0 : documentElement.position) && !isDerivedFromEndpoints) {
|
|
74
74
|
return null;
|
|
75
75
|
}
|
|
76
76
|
try {
|
|
@@ -98,14 +98,8 @@ class DocumentContainerService {
|
|
|
98
98
|
if (!containers.length || !measured.box) {
|
|
99
99
|
return [];
|
|
100
100
|
}
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
if (ownKind.elementType === kind.elementType) {
|
|
104
|
-
return kind.nests ? document_container_1.DocumentContainerUtil.chain(this.enclosersOf(measured, containers)) : [];
|
|
105
|
-
}
|
|
106
|
-
if (!ownKind.canBeContentOf.includes(kind.elementType)) {
|
|
107
|
-
return [];
|
|
108
|
-
}
|
|
101
|
+
if (measured.documentElement.type === kind.elementType) {
|
|
102
|
+
return kind.nests ? document_container_1.DocumentContainerUtil.chain(this.enclosersOf(measured, containers)) : [];
|
|
109
103
|
}
|
|
110
104
|
const candidates = this.candidateContainers(measured, containers);
|
|
111
105
|
return kind.nests ? document_container_1.DocumentContainerUtil.chain(candidates) : document_container_1.DocumentContainerUtil.topmost(candidates);
|
|
@@ -56,8 +56,9 @@ function isContainerBinding(bindingProperty) {
|
|
|
56
56
|
}
|
|
57
57
|
class DynamicTextUtil {
|
|
58
58
|
static isDynamicText(documentElement) {
|
|
59
|
+
var _a;
|
|
59
60
|
return ((documentElement === null || documentElement === void 0 ? void 0 : documentElement.type) === 'text' &&
|
|
60
|
-
!!documentElement.propertyBindings &&
|
|
61
|
+
!!((_a = documentElement.propertyBindings) === null || _a === void 0 ? void 0 : _a.text) &&
|
|
61
62
|
!!documentElement.propertyBindingsMetaData);
|
|
62
63
|
}
|
|
63
64
|
static takesValueFromContainer(bindingProperty) {
|
|
@@ -208,7 +209,7 @@ class DynamicTextUtil {
|
|
|
208
209
|
}
|
|
209
210
|
else if (displayFunction === DynamicTextDisplayFunction.UNIQUE_ARRAY) {
|
|
210
211
|
text = Array.from(new Set(memberValues
|
|
211
|
-
.filter((e) => e !== null && e !== undefined)
|
|
212
|
+
.filter((e) => e !== null && e !== undefined && e !== '')
|
|
212
213
|
.flat()
|
|
213
214
|
.map((e) => formatter.formatValueForProperty(e, property))))
|
|
214
215
|
.sort()
|