structured-render 0.0.0 → 0.0.1

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

@@ -0,0 +1,115 @@
+import { assert } from '@augment-vir/assert';
+import { arrayToObject, ensureArray } from '@augment-vir/common';
+import { unionShape } from 'object-shape-tester';
+import { structuredRenderCodeBlockShape } from './sections/code-block.section.js';
+import { structuredRenderEmptyShape } from './sections/empty.section.js';
+import { structuredRenderIconShape } from './sections/icon.section.js';
+import { structuredRenderInlineCodeShape } from './sections/inline-code.section.js';
+import { structuredRenderListShape } from './sections/list.section.js';
+import { renderDataMarkdownShape } from './sections/markdown.section.js';
+import { structuredRenderProcessingShape } from './sections/processing.section.js';
+import { sourceHasContent, structuredRenderSourceShape } from './sections/source.section.js';
+import { structuredRenderTableShape } from './sections/table.section.js';
+import { structuredRenderTagShape } from './sections/tag.section.js';
+import { structuredRenderTextShape } from './sections/text.section.js';
+/**
+ * All structured render section shapes.
+ *
+ * @category Internal
+ */
+export const allStructuredRenderSectionShapes = [
+    structuredRenderCodeBlockShape,
+    structuredRenderInlineCodeShape,
+    structuredRenderEmptyShape,
+    structuredRenderListShape,
+    renderDataMarkdownShape,
+    structuredRenderTagShape,
+    structuredRenderProcessingShape,
+    structuredRenderSourceShape,
+    structuredRenderTableShape,
+    structuredRenderTextShape,
+    structuredRenderIconShape,
+];
+/**
+ * A union of all structured render section shapes.
+ *
+ * @category Internal
+ */
+export const structuredRenderSectionShape = unionShape(...allStructuredRenderSectionShapes);
+/**
+ * An enum of all supported structured render section types.
+ *
+ * @category Internal
+ */
+export const StructuredRenderSectionType = arrayToObject(allStructuredRenderSectionShapes, (sectionShape) => {
+    return {
+        key: sectionShape.default.type,
+        value: sectionShape.default.type,
+    };
+}, {
+    useRequired: true,
+});
+/**
+ * Checks if the given structured render section has any content.
+ *
+ * @category Util
+ */
+export function doesSectionHaveContent(section) {
+    if (!section) {
+        return false;
+    }
+    else if (section.type === StructuredRenderSectionType.list) {
+        return section.items.some((item) => ensureArray(item.content).some((content) => {
+            return doesSectionHaveContent(content);
+        }));
+    }
+    else if (section.type === StructuredRenderSectionType.empty ||
+        section.type === StructuredRenderSectionType.processing) {
+        return false;
+    }
+    else if (section.type === StructuredRenderSectionType.tag) {
+        return !!section.text;
+    }
+    else if (section.type === StructuredRenderSectionType.codeBlock) {
+        return !!section.code;
+    }
+    else if (section.type === StructuredRenderSectionType.inlineCode) {
+        return !!section.code;
+    }
+    else if (section.type === StructuredRenderSectionType.markdown) {
+        return !!section.markdown;
+    }
+    else if (section.type === StructuredRenderSectionType.table) {
+        return section.entries.some((entry) => {
+            return Object.values(entry.data).some((value) => ensureArray(value).some((innerValue) => doesSectionHaveContent(innerValue)));
+        });
+    }
+    else if (section.type === StructuredRenderSectionType.text) {
+        return !!String(section.text) || !!section.icon;
+    }
+    else if (section.type === StructuredRenderSectionType.source) {
+        return sourceHasContent(section);
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    }
+    else if (section.type === StructuredRenderSectionType.icon) {
+        return true;
+    }
+    else {
+        assert.tsType(section).equals();
+        assert.never(`Unexpected section type: ${String(section.type)}`);
+    }
+}
+/**
+ * A helper for falling back to a different structured render section if the given structured render
+ * table is empty.
+ *
+ * @category Util
+ */
+export function emptyStructuredRenderTableFallback(table, fallback) {
+    if (doesSectionHaveContent(table)) {
+        return table;
+    }
+    else {
+        return fallback;
+    }
+}

package/package.json

@@ -1,13 +1,77 @@
 {
-  "name": "structured-render",
-  "version": "0.0.0",
-  "description": "",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "MIT",
-  "type": "commonjs"
+    "name": "structured-render",
+    "version": "0.0.1",
+    "description": "A library for safely rendering arbitrary data generated from any source.",
+    "keywords": [
+        "render",
+        "data",
+        "structure",
+        "typed",
+        "markdown"
+    ],
+    "homepage": "https://github.com/electrovir/structured-render",
+    "bugs": {
+        "url": "https://github.com/electrovir/structured-render/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/electrovir/structured-render.git"
+    },
+    "license": "(MIT or CC0 1.0)",
+    "author": {
+        "name": "electrovir",
+        "url": "https://github.com/electrovir"
+    },
+    "sideEffects": false,
+    "type": "module",
+    "main": "dist/index.js",
+    "module": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "scripts": {
+        "build": "virmator frontend build",
+        "compile": "virmator compile",
+        "docs": "virmator docs",
+        "start": "virmator frontend",
+        "test": "runstorm --names web,node \"npm run test:web\" \"npm run test:node\"",
+        "test:docs": "virmator docs check",
+        "test:node": "virmator test node src/render/browser-rendering.test.node.ts",
+        "test:update": "npm run test:web update",
+        "test:web": "virmator test web"
+    },
+    "dependencies": {
+        "@augment-vir/assert": "^31.65.0",
+        "@augment-vir/common": "^31.65.0",
+        "@augment-vir/web": "^31.65.0",
+        "@electrovir/color": "^1.7.8",
+        "dompurify": "^3.3.1",
+        "element-vir": "^26.14.3",
+        "html2pdf.js": "^0.14.0",
+        "lit-css-vars": "^3.5.0",
+        "marked": "^17.0.3",
+        "object-shape-tester": "^6.11.0",
+        "theme-vir": "^28.22.0",
+        "type-fest": "^5.4.4",
+        "vira": "^29.6.1"
+    },
+    "devDependencies": {
+        "@augment-vir/test": "^31.65.0",
+        "@virmator/test": "^14.7.2",
+        "@web/dev-server-esbuild": "^1.0.5",
+        "@web/test-runner": "^0.20.2",
+        "@web/test-runner-playwright": "^0.11.1",
+        "istanbul-smart-text-reporter": "^1.1.5",
+        "markdown-code-example-inserter": "^3.0.3",
+        "typedoc": "^0.28.17",
+        "typescript": "^5.9.3",
+        "vite": "^7.3.1"
+    },
+    "peerDependencies": {
+        "playwright": "*"
+    },
+    "engines": {
+        "node": ">=22"
+    },
+    "publishConfig": {
+        "access": "public"
+    }
 }