@paroicms/site-generator-plugin 0.26.1 → 0.27.1

package/backend/dist/generator/fake-content-generator/content-report.js

@@ -56,7 +56,9 @@ function createIdPicker(ids, childNodeIds) {
         const nodeIds = new Set();
         for (const language of Object.keys(ids)) {
             const found = getNodeIdsByLanguageAndType(language, typeName);
-            found.forEach((id) => nodeIds.add(id));
+            for (const id of found) {
+                nodeIds.add(id);
+            }
         }
         return Array.from(nodeIds);
     };

package/backend/dist/generator/fake-content-generator/create-node-contents.js

@@ -1,13 +1,14 @@
-import markdownToDelta from "markdown-to-quill-delta";
+import { convertMarkdownToTiptap } from "@paroicms/markdown-to-tiptap-json";
 import { getRandomImagePath } from "../lib/images-lib.js";
 export function createNodeContents(options) {
-    const { nodeType, count, generatedContents, outputTags, language } = options;
+    const { ctx, nodeType, count, generatedContents, outputTags, language } = options;
     const result = [];
     for (let i = 0; i < count; ++i) {
         const generatedContent = generatedContents ? generatedContents[i] : {};
         if (generatedContent === undefined)
             break; // The LLM produced less than expected
         const nodeContent = createNodeContent({
+            ctx,
             nodeType,
             language,
             generatedContent,
@@ -18,11 +19,11 @@ export function createNodeContents(options) {
     return result;
 }
 function createNodeContent(options) {
-    const { nodeType, language, generatedContent, outputTags } = options;
+    const { ctx, nodeType, language, generatedContent, outputTags } = options;
     const fieldTypes = nodeType.fields ?? [];
     if (nodeType.kind === "document") {
         const { title, ...generatedFields } = generatedContent;
-        const fields = toRiFieldSetContent(generatedFields, outputTags, fieldTypes, language);
+        const fields = toRiFieldSetContent(ctx, generatedFields, outputTags, fieldTypes, language);
         const featuredImage = nodeType.withFeaturedImage
             ? {
                 file: getRandomImagePath(),
@@ -34,16 +35,17 @@ function createNodeContent(options) {
             fields,
         };
     }
-    const fields = toRiFieldSetContent(generatedContent, outputTags, fieldTypes, language);
+    const fields = toRiFieldSetContent(ctx, generatedContent, outputTags, fieldTypes, language);
     return { fields };
 }
-function toRiFieldSetContent(content, outputTags, fieldTypes, language) {
+function toRiFieldSetContent(ctx, content, outputTags, fieldTypes, language) {
     const result = {};
     for (const fieldType of fieldTypes) {
         const isMarkdown = outputTags.find((tag) => tag.key === fieldType.name)?.format === "markdown";
         const localized = fieldType.localized;
         const value = content[fieldType.name];
         const fieldContent = toRiFieldContent({
+            ctx,
             fieldType,
             generatedValue: value,
             localized,
@@ -57,7 +59,7 @@ function toRiFieldSetContent(content, outputTags, fieldTypes, language) {
     return result;
 }
 function toRiFieldContent(options) {
-    const { fieldType, generatedValue, localized, language, isMarkdown } = options;
+    const { ctx, fieldType, generatedValue, localized, language, isMarkdown } = options;
     if (generatedValue !== undefined && localized) {
         if (fieldType.dataType === "string") {
             return {
@@ -66,8 +68,11 @@ function toRiFieldContent(options) {
                 value: generatedValue,
             };
         }
-        if (fieldType.dataType === "json" && fieldType.renderAs === "html" && isMarkdown) {
-            return toRiQuillDeltaContent(generatedValue);
+        if (fieldType.dataType === "json" &&
+            fieldType.renderAs === "html" &&
+            fieldType.pluginName === "@paroicms/tiptap-editor-plugin" &&
+            isMarkdown) {
+            return toTiptapRiJsonContent(ctx, generatedValue);
         }
     }
     if (fieldType.storedAs === "mediaHandle") {
@@ -126,18 +131,17 @@ function toRiFieldContent(options) {
     if (fieldType.storedAs === "labeling")
         return; // TODO: Generate values for labeling fields
 }
-function toRiQuillDeltaContent(content) {
+function toTiptapRiJsonContent(ctx, content) {
     return {
         dataType: "json",
         localized: true,
-        value: Object.fromEntries(Object.entries(content).map(([language, text]) => [
-            language,
-            {
-                j: {
-                    ops: markdownToDelta(text),
-                },
-            },
-        ])),
+        value: Object.fromEntries(Object.entries(content).map(([language, text]) => {
+            const { result, issues } = convertMarkdownToTiptap(text);
+            if (issues && issues.length > 0) {
+                ctx.logger.warn(`Markdown conversion issues for language ${language}:`, issues);
+            }
+            return [language, { j: result }];
+        })),
     };
 }
 function getDefaultStringValueForField(fieldName) {
@@ -147,18 +151,17 @@ function getDefaultStringValueForField(fieldName) {
         return JSON.stringify(["0123456789", "9876543210"]);
     if (fieldName === "updateDateTime")
         return new Date().toISOString();
-    return undefined;
+    return;
 }
-export function generateLocalizedFooterMention(siteSchema) {
+export function generateLocalizedFooterMention(ctx, siteSchema) {
     const { languages } = siteSchema;
-    return Object.fromEntries(languages.map((language) => [
-        language,
-        {
-            j: {
-                ops: markdownToDelta(getPoweredByLabel(language)),
-            },
-        },
-    ]));
+    return Object.fromEntries(languages.map((language) => {
+        const { result, issues } = convertMarkdownToTiptap(getPoweredByLabel(language));
+        if (issues && issues.length > 0) {
+            ctx.logger.warn(`Markdown conversion issues for footer mention (${language}):`, issues);
+        }
+        return [language, { j: result }];
+    }));
 }
 function getPoweredByLabel(language) {
     const translations = {

package/backend/dist/generator/fake-content-generator/fill-site-fields.js

@@ -54,7 +54,7 @@ export async function updateSiteFields(ctx, _report, options) {
             {
                 dataType: "json",
                 localized: true,
-                value: generateLocalizedFooterMention(siteSchema),
+                value: generateLocalizedFooterMention(ctx, siteSchema),
             },
         ]);
     }

package/backend/dist/generator/fake-content-generator/generate-fake-content.js

@@ -63,6 +63,7 @@ export async function generateMultipleFieldSetContents(ctx, options, report) {
     }
     report.add(count, output?.llmReport);
     return createNodeContents({
+        ctx,
         nodeType,
         count,
         generatedContents: output?.contents,

package/backend/dist/generator/llm-queries/invoke-update-site-schema.js

@@ -164,11 +164,11 @@ function fixSiteSchema(siteSchema) {
     for (const nodeType of siteSchema.nodeTypes ?? []) {
         if (!nodeType.fields)
             continue;
-        // Add Quill plugin to fields with renderAs "html"
+        // Add Tiptap plugin to fields with renderAs "html"
         for (const field of nodeType.fields) {
             if (typeof field !== "string" && field.renderAs === "html") {
                 field.dataType = "json";
-                field.plugin = "@paroicms/quill-editor-plugin";
+                field.plugin = "@paroicms/tiptap-editor-plugin";
             }
         }
         // Move labeling fields to the beginning of the fields array

package/backend/dist/generator/site-generator/document-template-creator.js

@@ -159,20 +159,19 @@ function templateOfRegularDocumentCards(ctx, parentType, parentIdKeyProvider, {
 function templateOfFields(ctx, fields, { parentKey }) {
     if (!fields || fields.length === 0)
         return;
-    const fieldTemplates = fields.map((fieldOrName) => templateOfField(ctx, fieldOrName, parentKey));
+    const fieldTemplates = fields.map((fieldOrQualifiedName) => templateOfField(ctx, fieldOrQualifiedName, parentKey));
     return fieldTemplates.join("\n");
 }
-function templateOfField(ctx, fieldOrName, parentKey) {
-    const fieldName = typeof fieldOrName === "string" ? fieldOrName : fieldOrName.name;
-    const { dataType, renderAs } = typeof fieldOrName === "string"
-        ? getPredefinedDataType(ctx, fieldName)
-        : fieldOrName.storedAs === "labeling"
-            ? { dataType: "labeling" }
-            : fieldOrName;
+function templateOfField(ctx, fieldOrQualifiedName, parentKey) {
+    const { dataType, renderAs, name } = typeof fieldOrQualifiedName === "string"
+        ? getPredefinedDataType(ctx, fieldOrQualifiedName)
+        : fieldOrQualifiedName.storedAs === "labeling"
+            ? { dataType: "labeling", renderAs: undefined, name: fieldOrQualifiedName.name }
+            : fieldOrQualifiedName;
     if (dataType === "labeling") {
-        return `{% if ${parentKey}.${fieldName} %}
+        return `{% if ${parentKey}.${name} %}
   <div class="Field">
-    {% for tag in ${parentKey}.${fieldName} %}
+    {% for tag in ${parentKey}.${name} %}
       {% if tag.inRightLanguage %}
         <a class="Label" href="{{ tag.url }}">{{ tag.title }}</a>
       {% else %}
@@ -183,20 +182,20 @@ function templateOfField(ctx, fieldOrName, parentKey) {
 {% endif %}`;
     }
     if (renderAs === "html") {
-        return `<div class="Field Text">{{ ${parentKey}.${fieldName} | raw }}</div>`;
+        return `<div class="Field Text">{{ ${parentKey}.${name} | raw }}</div>`;
     }
     if (dataType === "date") {
-        return `<div class="Field">{{ ${parentKey}.${fieldName} | formatDate: "short" }}</div>`;
+        return `<div class="Field">{{ ${parentKey}.${name} | formatDate: "short" }}</div>`;
     }
     if (dataType === "dateTime") {
-        return `<div class="Field">{{ ${parentKey}.${fieldName} | formatDate: "long" }}</div>`;
+        return `<div class="Field">{{ ${parentKey}.${name} | formatDate: "long" }}</div>`;
     }
     if (dataType === "json") {
-        return `<div class="Field">{{ ${parentKey}.${fieldName} | json }}</div>`;
+        return `<div class="Field">{{ ${parentKey}.${name} | json }}</div>`;
     }
     if (dataType === "gallery") {
         return `<div class="Field">
-  {% for media in ${parentKey}.${fieldName} %}
+  {% for media in ${parentKey}.${name} %}
     {% set im = image(media, resize: "150x150") %}
     <img
       class="Field-img"
@@ -211,7 +210,7 @@ function templateOfField(ctx, fieldOrName, parentKey) {
 </div>`;
     }
     if (dataType === "media") {
-        const mediaKey = `${parentKey}.${fieldName}`;
+        const mediaKey = `${parentKey}.${name}`;
         return `{% set im = image(${mediaKey}, resize: "x250x") %}
 <div class="Field">
   <img
@@ -225,10 +224,10 @@ function templateOfField(ctx, fieldOrName, parentKey) {
   >
 </div>`;
     }
-    if (fieldName === "title") {
-        return `<h2>{{ ${parentKey}.${fieldName} }}</h2>`;
+    if (name === "title") {
+        return `<h2>{{ ${parentKey}.${name} }}</h2>`;
     }
-    return `<div class="Field">{{ ${parentKey}.${fieldName} }}</div>`;
+    return `<div class="Field">{{ ${parentKey}.${name} }}</div>`;
 }
 function templateOfPicture({ imageKey }) {
     return `{% if ${imageKey} %}

package/backend/dist/generator/site-generator/labeled-list-template-creator.js

@@ -13,7 +13,7 @@ export function templatesOfLabeledList(ctx, documentType) {
             sameClusterAs: labeledDocument.taxonomyType,
         });
         if (!parentRoutingKey)
-            return;
+            return undefined;
         const labeledListKey = `labeled${upperCaseFirstLetter(labeledDocument.parentDocumentType.typeName)}`;
         const cardTemplateName = `${camelToKebabCase(labeledDocument.documentType.typeName)}-card.public`;
         addLiquidFile("partials", `${cardTemplateName}.liquid`, templateOfDocumentCard(ctx, "doc", { parentType: labeledDocument.parentDocumentType }), { skipIfExists: true });

package/backend/dist/generator/site-generator/site-generator.js

@@ -81,8 +81,8 @@ function getPackageJsonContent(options) {
             "@paroicms/internal-link-plugin": "*",
             "@paroicms/list-field-plugin": "*",
             "@paroicms/public-menu-plugin": "*",
-            "@paroicms/quill-editor-plugin": "*",
-            "@paroicms/video-plugin": "*",
+            "@paroicms/tiptap-editor-plugin": "*",
+            "@paroicms/platform-video-plugin": "*",
             "@paroicms/server": "*",
         },
         devDependencies: {

package/backend/dist/generator/site-generator/template-helpers.js

@@ -8,13 +8,15 @@ export function indent(template, level, { skipFirst = false } = {}) {
     // For firstLine true, indent all lines.
     return template.replace(/^/gm, indentStr);
 }
-export function getPredefinedDataType(ctx, fieldName) {
-    const predefinedField = ctx.predefinedFields.get(fieldName);
-    if (!predefinedField)
-        return { dataType: "string", renderAs: undefined };
+export function getPredefinedDataType(ctx, qualifiedFieldName) {
+    const predefinedField = ctx.predefinedFields.get(qualifiedFieldName);
+    if (!predefinedField) {
+        throw new Error(`Predefined field not found: "${qualifiedFieldName}"`);
+    }
     return {
         dataType: predefinedField.dataType,
         renderAs: predefinedField.renderAs,
+        name: predefinedField.fieldName,
     };
 }
 export function localizedLabelTemplate(ctx, label) {

package/backend/dist/generator/site-generator/theme-creator-context.js

@@ -6,11 +6,16 @@ export function createThemeCreatorContext(siteSchema) {
     const otherFiles = new Map();
     const issues = [];
     const getParentTypes = makeGetParentTypes(siteSchema);
+    const predefinedFieldsWithFieldName = getPredefinedFields().map((f) => ({
+        ...f,
+        fieldName: extractFieldName(f.qualifiedFieldName),
+    }));
+    const predefinedFields = new Map(predefinedFieldsWithFieldName.map((f) => [f.qualifiedFieldName, f]));
     return {
         siteSchema,
         labeledDocuments: getLabeledDocuments(siteSchema, getParentTypes),
         getParentTypes,
-        predefinedFields: new Map(getPredefinedFields().map((f) => [f.fieldName, f])),
+        predefinedFields,
         setLocalizedLabel(label) {
             for (const language of languages) {
                 const value = label[language];
@@ -107,3 +112,7 @@ function getLabeledDocuments(siteSchema, getParentTypes) {
     }
     return result;
 }
+function extractFieldName(qualifiedFieldName) {
+    const bracketIndex = qualifiedFieldName.indexOf("[");
+    return bracketIndex === -1 ? qualifiedFieldName : qualifiedFieldName.slice(0, bracketIndex);
+}

package/backend/dist/generator/site-schema-generator/create-site-schema.js

@@ -10,8 +10,8 @@ export function createSiteSchemaFromAnalysis(analysis) {
             "@paroicms/internal-link-plugin",
             "@paroicms/list-field-plugin",
             "@paroicms/public-menu-plugin",
-            "@paroicms/quill-editor-plugin",
-            "@paroicms/video-plugin",
+            "@paroicms/tiptap-editor-plugin",
+            "@paroicms/platform-video-plugin",
         ],
         nodeTypes: [
             {
@@ -136,7 +136,9 @@ function walkTree(saNode, parentNode, ctx) {
             throw new Error(`Unexpected node kind: "${saNode.kind}"`);
         }
     }
-    saNode.children?.forEach((child) => walkTree(child, nodeType, ctx));
+    for (const child of saNode.children ?? []) {
+        walkTree(child, nodeType, ctx);
+    }
 }
 function appendAsRoutingChild(options) {
     const { nodeType, typeName, parentNode } = options;
@@ -172,7 +174,9 @@ function appendAsChildRegularDocument(options, ctx) {
         parentNode.regularChildrenSorting = saType.temporal ? "publishDate desc" : "title asc";
     }
     parentNode.regularChildren.push(typeName);
-    children?.forEach((child) => walkTree(child, nodeType, ctx));
+    for (const child of children ?? []) {
+        walkTree(child, nodeType, ctx);
+    }
 }
 function appendAsChildPart(options, ctx) {
     const { nodeType, typeName, parentNode, children, listName } = options;
@@ -202,7 +206,9 @@ function appendAsChildPart(options, ctx) {
     else {
         throw new Error(`Unexpected kind: "${parentNode.kind}"`);
     }
-    children?.forEach((child) => walkTree(child, nodeType, ctx));
+    for (const child of children ?? []) {
+        walkTree(child, nodeType, ctx);
+    }
 }
 export function toNodeType(typeName, saType) {
     if (saType.kind === "part")

package/backend/prompts/initial-2-fields.md

@@ -30,21 +30,21 @@ Guidelines for creating the dictionnary YAML:
 - Documents and parts already contains a _publish date_ and a _draft_ flag.
 - A document already contains a _title_ and a _featured image_, but a part doesn't. That's why the predefined `title` field can be used on part types when needed.
 - Default values:
-  - By default, for most of node types, if you are not sure about what could be the best fields, then remember that a document is a webpage and just use a `[htmlContent[@paroicms/quill-editor-plugin]]`.
-  - Except if there are specific instructions in the website description, here is the default value for the `_site` node type: `["logo", "footerMention[@paroicms/quill-editor-plugin]"]`.
+  - By default, for most of node types, if you are not sure about what could be the best fields, then remember that a document is a webpage and just use a `[htmlContent[@paroicms/tiptap-editor-plugin]]`.
+  - Except if there are specific instructions in the website description, here is the default value for the `_site` node type: `["logo", "footerMention[@paroicms/tiptap-editor-plugin]"]`.
 - Gallery of medias: there is a predefined field named `"gallery"`. It contains a list of medias. The theme can render it as a carousel, a slider, an image gallery, a slideshow, etc.
 - This task is about predefined fields only. Custom fields will be added in a further step.
 
 Here is an example of expected output:
 
 <correct_example>
-_site: [logo, "footerMention[@paroicms/quill-editor-plugin]"]
-home: ["htmlContent[@paroicms/quill-editor-plugin]"]
+_site: [logo, "footerMention[@paroicms/tiptap-editor-plugin]"]
+home: ["htmlContent[@paroicms/tiptap-editor-plugin]"]
 searchPage: []
-contactPage: ["introduction[@paroicms/quill-editor-plugin]"]
-regularDocumentExemple1: [gallery, "htmlContent[@paroicms/quill-editor-plugin]"]
-partExemple2: [title, image, "htmlContent[@paroicms/quill-editor-plugin]"]
-aBlogPostExample: ["leadParagraph[@paroicms/quill-editor-plugin]", "htmlContent[@paroicms/quill-editor-plugin]"]
+contactPage: ["introduction[@paroicms/tiptap-editor-plugin]"]
+regularDocumentExemple1: [gallery, "htmlContent[@paroicms/tiptap-editor-plugin]"]
+partExemple2: [title, image, "htmlContent[@paroicms/tiptap-editor-plugin]"]
+aBlogPostExample: ["leadParagraph[@paroicms/tiptap-editor-plugin]", "htmlContent[@paroicms/tiptap-editor-plugin]"]
 </correct_example>
 
 Provide the YAML result within <yaml_result> tags. Do not write any explanation or commentary outside the tags.

package/backend/prompts/predefined-fields.json

@@ -1,6 +1,6 @@
 [
   {
-    "qualifiedFieldName": "leadParagraph[@paroicms/quill-editor-plugin]",
+    "qualifiedFieldName": "leadParagraph[@paroicms/tiptap-editor-plugin]",
     "localized": true,
     "dataType": "json",
     "renderAs": "html",
@@ -8,7 +8,7 @@
     "description": "Lead paragraph, or \"chapo\", of a post (HTML)"
   },
   {
-    "qualifiedFieldName": "htmlContent[@paroicms/quill-editor-plugin]",
+    "qualifiedFieldName": "htmlContent[@paroicms/tiptap-editor-plugin]",
     "localized": true,
     "dataType": "json",
     "renderAs": "html",
@@ -16,7 +16,7 @@
     "description": "HTML Content"
   },
   {
-    "qualifiedFieldName": "introduction[@paroicms/quill-editor-plugin]",
+    "qualifiedFieldName": "introduction[@paroicms/tiptap-editor-plugin]",
     "localized": true,
     "dataType": "json",
     "renderAs": "html",
@@ -24,7 +24,7 @@
     "description": "A short introduction (HTML)"
   },
   {
-    "qualifiedFieldName": "footerMention[@paroicms/quill-editor-plugin]",
+    "qualifiedFieldName": "footerMention[@paroicms/tiptap-editor-plugin]",
     "dataType": "json",
     "renderAs": "html",
     "normalizeTypography": true,
@@ -107,13 +107,13 @@
     "description": "A list of phone numbers"
   },
   {
-    "qualifiedFieldName": "video[@paroicms/video-plugin]",
+    "qualifiedFieldName": "video[@paroicms/platform-video-plugin]",
     "localized": false,
     "dataType": "string",
     "description": "A YouTube video"
   },
   {
-    "qualifiedFieldName": "oneLanguageVideo[@paroicms/video-plugin]",
+    "qualifiedFieldName": "oneLanguageVideo[@paroicms/platform-video-plugin]",
     "localized": true,
     "dataType": "string",
     "description": "A YouTube video, but different for each language"

package/backend/prompts/update-site-schema-2-execute.md

@@ -1,6 +1,6 @@
 You are tasked with modifying a JSON object based on a given TypeScript type definition and an update message. Follow these steps carefully:
 
-# 1. Review the TypeScript type definition of the JSON structure:
+# 1. Review the TypeScript type definition of the JSON structure
 
 <site_schema_ts_defs>
 {{siteSchemaTsDefs}}
@@ -26,7 +26,7 @@ Here is an example of an object for describing a custom **HTML** field type:
   "dataType": "json",
   "renderAs": "html",
   "useAsExcerpt": 1,
-  "plugin": "@paroicms/quill-editor-plugin"
+  "plugin": "@paroicms/tiptap-editor-plugin"
 }
 </field_type_example>
 
@@ -89,7 +89,7 @@ A labeling field lets the user assign taxonomy terms to a document (or part).
 
 Most of the time, the field name will be the same as the taxonomy type name.
 
-# 4. Examine the current JSON data, which conforms to the `JtSiteSchema` type:
+# 4. Examine the current JSON data, which conforms to the `JtSiteSchema` type
 
 <site_schema_json>
 {{siteSchemaJson}}
@@ -101,7 +101,7 @@ Also, the attached locales:
 {{l10nJson}}
 </l10n_json>
 
-# 5. Now, here is what to do:
+# 5. Now, here is what to do
 
 <user_request>
 {{taskDetailsMd}}