@prismicio/api-renderer - npm Package Compare versions

Comparing version 6.2.0-alpha.4 to 6.2.0-alpha.5

lib/widgets/nestable/index.d.ts

@@ -10,1 +10,2 @@ export { default as BooleanRenderer } from "./BooleanRenderer";
 export { default as StructuredTextRenderer } from "./StructuredTextContent";
+export { default as TableRenderer } from "./TableRenderer";

lib/widgets/nestable/index.js

@@ -6,3 +6,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StructuredTextRenderer = exports.SeparatorRenderer = exports.LinkRenderer = exports.ImageLinkRenderer = exports.FileLinkRenderer = exports.ExternalLinkRenderer = exports.DocumentLinkRenderer = exports.IntegrationFieldsRenderer = exports.ImageRenderer = exports.GeoPointRenderer = exports.FieldRenderer = exports.EmbedRenderer = exports.BooleanRenderer = void 0;
+exports.TableRenderer = exports.StructuredTextRenderer = exports.SeparatorRenderer = exports.LinkRenderer = exports.ImageLinkRenderer = exports.FileLinkRenderer = exports.ExternalLinkRenderer = exports.DocumentLinkRenderer = exports.IntegrationFieldsRenderer = exports.ImageRenderer = exports.GeoPointRenderer = exports.FieldRenderer = exports.EmbedRenderer = exports.BooleanRenderer = void 0;
 var BooleanRenderer_1 = require("./BooleanRenderer");
@@ -30,1 +30,3 @@ Object.defineProperty(exports, "BooleanRenderer", { enumerable: true, get: function () { return __importDefault(BooleanRenderer_1).default; } });
 Object.defineProperty(exports, "StructuredTextRenderer", { enumerable: true, get: function () { return __importDefault(StructuredTextContent_1).default; } });
+var TableRenderer_1 = require("./TableRenderer");
+Object.defineProperty(exports, "TableRenderer", { enumerable: true, get: function () { return __importDefault(TableRenderer_1).default; } });

lib/widgets/nestable/TableRenderer.js

@@ -6,7 +6,2 @@ "use strict";
 const StructuredTextContent_1 = tslib_1.__importDefault(require("./StructuredTextContent"));
-// TO_DO: Move this to types-internal
-const structuredTextDef = {
-    type: "StructuredText",
-    config: customtypes_1.TableCellConfig.config,
-};
 const TableRenderer = (ctx) => ({
@@ -18,3 +13,3 @@ renderV1(_content, _fetch) {
     renderV2(_def, content, fetch) {
-        const renderStructuredText = (cellContent) => (0, StructuredTextContent_1.default)(ctx).renderV2(structuredTextDef, cellContent, fetch);
+        const renderStructuredText = (cellContent) => (0, StructuredTextContent_1.default)(ctx).renderV2(customtypes_1.TableCell, cellContent, fetch);
         return renderTable(content, renderStructuredText);
@@ -37,4 +32,3 @@ },
     return {
-        // TO_DISCUSS: Should we not return head at all when there is no header row?
-        head: renderHead(headRow, renderStructuredText),
+        ...(headRow ? { head: renderHead(headRow, renderStructuredText) } : {}),
         body: renderBody(bodyRows, renderStructuredText),
@@ -44,4 +38,7 @@ };
 function renderHead(row, renderStructuredText) {
+    if (!row) {
+        return undefined;
+    }
     return {
-        rows: row ? [renderRow(row, renderStructuredText)] : [],
+        rows: [renderRow(row, renderStructuredText)],
     };
@@ -73,6 +70,5 @@ }
 };
-// TO_DISCUSS: What should be the default table? `{}`, something else or like I did
 function renderDefaultTable() {
-    return { head: { rows: [] }, body: { rows: [] } };
+    return null;
 }
 exports.default = TableRenderer;

lib/widgets/SimpleWidgetRenderer.js

@@ -8,3 +8,2 @@ "use strict";
 const nestable_1 = require("./nestable");
-const TableRenderer_1 = tslib_1.__importDefault(require("./nestable/TableRenderer"));
 const UIDRenderer_1 = tslib_1.__importDefault(require("./UIDRenderer"));
@@ -68,3 +67,3 @@ function extractSimpleFieldIfAny(field) {
         else if ((0, content_1.isTableContent)(content)) {
-            return (0, TableRenderer_1.default)(ctx).renderV1(content, extractSimpleFieldIfAny(fetch));
+            return (0, nestable_1.TableRenderer)(ctx).renderV1(content, extractSimpleFieldIfAny(fetch));
         }
@@ -112,3 +111,3 @@ else {
         else if (def.type === "Table" && (0, content_1.isTableContent)(content)) {
-            return (0, TableRenderer_1.default)(ctx).renderV2(def, content, extractSimpleFieldIfAny(fetch));
+            return (0, nestable_1.TableRenderer)(ctx).renderV2(def, content, extractSimpleFieldIfAny(fetch));
         }
@@ -145,3 +144,3 @@ else {
         else if (def.type === "Table") {
-            return (0, TableRenderer_1.default)(ctx).renderDefault(def);
+            return (0, nestable_1.TableRenderer)(ctx).renderDefault(def);
         }
@@ -187,3 +186,3 @@ else {
         else if (def.type === "Table" && (0, content_1.isTableContent)(content)) {
-            return (0, TableRenderer_1.default)(ctx).renderMocks(def, content);
+            return (0, nestable_1.TableRenderer)(ctx).renderMocks(def, content);
         }
@@ -190,0 +189,0 @@ else {

package.json

 {
 	"name": "@prismicio/api-renderer",
-	"version": "6.2.0-alpha.4",
+	"version": "6.2.0-alpha.5",
 	"description": "Prismic renderers for the content API",
@@ -38,3 +38,3 @@ "keywords": [
 	"dependencies": {
-		"@prismicio/types-internal": "3.4.0-alpha.16",
+		"@prismicio/types-internal": "3.5.0",
 		"tslib": "^2.5.0",
@@ -76,6 +76,3 @@ "uuid": "^9.0.0"
 		"access": "public"
-	},
-	"overrides": {
-		"@prismicio/types-internal": "3.4.0-alpha.16"
 	}
 }

src/widgets/nestable/index.ts

@@ -16,1 +16,2 @@ export { default as BooleanRenderer } from "./BooleanRenderer"
 export { default as StructuredTextRenderer } from "./StructuredTextContent"
+export { default as TableRenderer } from "./TableRenderer"

src/widgets/nestable/TableRenderer.ts

@@ -8,3 +8,3 @@ import type {
 } from "@prismicio/types-internal/lib/content"
-import { type RichText, type Table, TableCellConfig } from "@prismicio/types-internal/lib/customtypes"
+import { type Table, TableCell } from "@prismicio/types-internal/lib/customtypes"
 
@@ -15,8 +15,2 @@ import type { RenderContext, Renderer } from "../../models"
 
-// TO_DO: Move this to types-internal
-const structuredTextDef: RichText = {
-	type: "StructuredText",
-	config: TableCellConfig.config,
-}
-
 const TableRenderer: (ctx: RenderContext) => Renderer<Table, TableContent, SimpleField> = (ctx) => ({
@@ -30,3 +24,3 @@ renderV1(_content: TableContent, _fetch: SimpleField | undefined): unknown {
 		const renderStructuredText = (cellContent: RichTextContent) =>
-			StructuredTextRenderer(ctx).renderV2(structuredTextDef, cellContent, fetch)
+			StructuredTextRenderer(ctx).renderV2(TableCell, cellContent, fetch)
 
@@ -55,4 +49,3 @@ return renderTable(content, renderStructuredText)
 	return {
-		// TO_DISCUSS: Should we not return head at all when there is no header row?
-		head: renderHead(headRow, renderStructuredText),
+		...(headRow ? { head: renderHead(headRow, renderStructuredText) } : {}),
 		body: renderBody(bodyRows, renderStructuredText),
@@ -63,4 +56,8 @@ }
 function renderHead(row: TableRow | undefined, renderStructuredText: (cellContent: RichTextContent) => unknown) {
+	if (!row) {
+		return undefined
+	}
+
 	return {
-		rows: row ? [renderRow(row, renderStructuredText)] : [],
+		rows: [renderRow(row, renderStructuredText)],
 	}
@@ -100,7 +97,6 @@ }
 
-// TO_DISCUSS: What should be the default table? `{}`, something else or like I did
 function renderDefaultTable() {
-	return { head: { rows: [] }, body: { rows: [] } }
+	return null
 }
 
 export default TableRenderer

src/widgets/SimpleWidgetRenderer.ts

@@ -45,4 +45,4 @@ import {
 	StructuredTextRenderer,
+	TableRenderer,
 } from "./nestable"
-import TableRenderer from "./nestable/TableRenderer"
 import UIDRenderer from "./UIDRenderer"
@@ -49,0 +49,0 @@

No alert changes

Worsened metrics

Total package byte prevSize

1150299

decreased by-0.04%

Lines of code

27391

decreased by-0.02%

Dependency changes

• + Added@prismicio/types-internal@3.5.0(transitive)

• - Removed@prismicio/types-internal@3.4.0-alpha.16(transitive)

• Updated@prismicio/types-internal@3.5.0