structured-render 0.0.0 → 0.0.2

package/dist/structured-render-data/sections/source.section.js

@@ -0,0 +1,47 @@
+import { check, checkWrap } from '@augment-vir/assert';
+import { ensureArray } from '@augment-vir/common';
+import { defineShape, exactShape, nullableShape } from 'object-shape-tester';
+/**
+ * Shape definition for {@link StructuredRenderFileBoundingBox}.
+ *
+ * @category Internal
+ */
+export const structuredRenderFileBoundingBoxShape = defineShape({
+    x1: -1,
+    y1: -1,
+    x2: -1,
+    y2: -1,
+});
+/**
+ * A shape definition for structured render sources. Any structured render can have sources.
+ *
+ * @category Internal
+ */
+export const structuredRenderSourceShape = defineShape({
+    type: exactShape('source'),
+    pageNumbers: nullableShape([nullableShape(-1)]),
+    fileName: nullableShape(''),
+    fileBoundingBoxes: nullableShape([
+        nullableShape(structuredRenderFileBoundingBoxShape),
+    ]),
+    quote: nullableShape(''),
+});
+/**
+ * Handle all the possible values for sources and combine them into an easy to use return type.
+ *
+ * @category Internal
+ */
+export function createCleanSources(rawSources) {
+    return checkWrap.isLengthAtLeast(ensureArray(rawSources).filter(sourceHasContent), 1);
+}
+/**
+ * Check if a source section has any content.
+ *
+ * @category Internal
+ */
+export function sourceHasContent(section) {
+    return !!(section &&
+        (section.quote?.trim() ||
+            section.fileName ||
+            section.pageNumbers?.filter(check.isDefined).length));
+}