@paroicms/site-generator-plugin 0.5.2 → 0.7.0

package/gen-backend/dist/generator/fake-content-generator.ts/create-database-with-fake-content.js

@@ -114,7 +114,7 @@ async function updateSiteFields(ctx, options) {
         fields.push([
             "footerMention",
             {
-                dataType: "quillDelta",
+                dataType: "json",
                 localized: true,
                 value: generateLocalizedFooterMention(siteSchema),
             },

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

@@ -66,7 +66,7 @@ function toRiFieldContent(options) {
                 value: generatedValue,
             };
         }
-        if (fieldType.dataType === "quillDelta" && isMarkdown) {
+        if (fieldType.dataType === "json" && fieldType.renderAs === "html" && isMarkdown) {
             return toRiQuillDeltaContent(generatedValue);
         }
     }
@@ -123,15 +123,19 @@ function toRiFieldContent(options) {
                 };
         }
     }
+    if (fieldType.storedAs === "labeling")
+        return; // TODO: Generate values for labeling fields
 }
 function toRiQuillDeltaContent(content) {
     return {
-        dataType: "quillDelta",
+        dataType: "json",
         localized: true,
         value: Object.fromEntries(Object.entries(content).map(([language, text]) => [
             language,
             {
-                ops: markdownToDelta(text),
+                j: {
+                    ops: markdownToDelta(text),
+                },
             },
         ])),
     };
@@ -150,7 +154,9 @@ export function generateLocalizedFooterMention(siteSchema) {
     return Object.fromEntries(languages.map((language) => [
         language,
         {
-            ops: markdownToDelta(`Powered by ParoiCMS in ${languageLabels[language]}`),
+            j: {
+                ops: markdownToDelta(`Powered by ParoiCMS in ${languageLabels[language]}`),
+            },
         },
     ]));
 }

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

@@ -107,7 +107,8 @@ async function invokeUpdateSiteSchemaStep2(ctx, input) {
 function fixSiteSchema(siteSchema) {
     for (const nodeType of siteSchema.nodeTypes ?? []) {
         for (const field of nodeType.fields ?? []) {
-            if (typeof field !== "string" && field.dataType === "quillDelta") {
+            if (typeof field !== "string" && field.renderAs === "html") {
+                field.dataType = "json";
                 field.plugin = "@paroicms/quill-editor-plugin";
             }
         }

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

@@ -164,8 +164,25 @@ function templateOfFields(ctx, fields, { parentKey }) {
 }
 function templateOfField(ctx, fieldOrName, parentKey) {
     const fieldName = typeof fieldOrName === "string" ? fieldOrName : fieldOrName.name;
-    const dataType = typeof fieldOrName === "string" ? getPredefinedDataType(ctx, fieldName) : fieldOrName.dataType;
-    if (dataType === "html" || dataType === "quillDelta") {
+    const { dataType, renderAs } = typeof fieldOrName === "string"
+        ? getPredefinedDataType(ctx, fieldName)
+        : fieldOrName.storedAs === "labeling"
+            ? { dataType: "labeling" }
+            : fieldOrName;
+    if (dataType === "labeling") {
+        return `{% if ${parentKey}.${fieldName} %}
+  <div class="Field">
+    {% for tag in ${parentKey}.${fieldName} %}
+      {% if tag.inRightLanguage %}
+        <a href="{{ tag.url }}">{{ tag.title }}</a>
+      {% else %}
+        <span>{{ tag.title }}</span>
+      {% endif %}
+    {% endfor %}
+  </div>
+{% endif %}`;
+    }
+    if (renderAs === "html") {
         return `<div class="Field Text">{{ ${parentKey}.${fieldName} | raw }}</div>`;
     }
     if (dataType === "date") {

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

@@ -11,8 +11,11 @@ export function indent(template, level, { skipFirst = false } = {}) {
 export function getPredefinedDataType(ctx, fieldName) {
     const predefinedField = ctx.predefinedFields.get(fieldName);
     if (!predefinedField)
-        return "string";
-    return predefinedField.dataType;
+        return { dataType: "string", renderAs: undefined };
+    return {
+        dataType: predefinedField.dataType,
+        renderAs: predefinedField.renderAs,
+    };
 }
 export function localizedLabelTemplate(ctx, label) {
     const { siteSchema, setLocalizedLabel: appendLocalizedLabel } = ctx;

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

@@ -2,7 +2,7 @@ import { generateSlug } from "@paroicms/public-anywhere-lib";
 export function createSiteSchemaFromAnalysis(analysis) {
     const { siteProperties } = analysis;
     const siteSchema = {
-        version: "7",
+        version: "8",
         languages: [siteProperties.language],
         plugins: [
             "@paroicms/quill-editor-plugin",

package/gen-backend/prompts/generate-fake-content-multiple-documents.md

@@ -14,7 +14,7 @@ Make sure web pages are distinct from each other by:
 
 Guidelines:
 
-- NEVER repeat a title among several sub-contents.
+- NEVER repeat the same title among several sub-contents.
 - Never invite the user to write a comment. There is no comment system.
 
 Each web page is composed by several sub-contents. Use the following exact format:

package/gen-backend/prompts/new-site-1-analysis.md

@@ -55,11 +55,10 @@ Guidelines for creating the hierarchical bullet list:
   - Write `"list of"`, and then the **type name** within backquotes.
   - Append `(parts)`.
   - Add a coma, then write: `"list name:"` and append an identifier for the list name.
-- Each distinct node type must have a unique name through the whole tree structure.
-- Reusing the same node type several times (for recursivity etc.):
-  - When the same node type is reused as a child in several places, then write its children only on the first occurence.
+- Avoid recursivity. But if you can't avoid reusing a node type, then write its children only on the first occurence.
 - On this task, do not focus on fields. If the website description provide fields then you will report them in the unused information. In particular, a collection of medias (a carousel, a slider, an image gallery, a slideshow, etc.) is a type of field.
 - Don't try to provide a comment mechanism when the user requests a blog. Blog comments do not belong to the hierarchy of node types.
+- NEVER ever reuse the same type name for 2 distinct node type. Pay particular attention to words spelled identically in the singular and plural. Each distinct node type must have a unique name through the whole tree structure.
 
 Here's an example of a correct output:
 
@@ -83,27 +82,18 @@ Here is another incorrect example:
 
 <incorrect_example>
 * `home` (routing document)
-  * `animals`
-    * `pages` (regular document)
-      * list of `page` (regular documents)
-  * `vegetals`
-    * `pages` (regular document)
-      * list of `page` (regular documents)
+  * `species` (routing document)
+    * list of `species` (regular documents)
 </incorrect_example>
 
-This incorrect example fails because the children of `pages` node should not be written the second time we use this node type. Here is how to fix that:
+This incorrect example fails because the type name `species` is used for 2 different types. You can distinguish them by suffixing both the collection and the item types:
 
 <correct_example>
 * `home` (routing document)
-  * `animals`
-    * `pages` (regular document)
-      * list of `page` (regular documents)
-  * `vegetals`
-    * `pages` (regular document)
+  * `speciesColl` (routing document)
+    * list of `speciesItem` (regular documents)
 </correct_example>
 
-Notice: the `pages` node will have the same child types for both usage. But we describe them only the first time it appears on the tree.
-
 Here's an example of correct output using parts, and with the default contact and search pages:
 
 <correct_example>
@@ -126,6 +116,7 @@ Guidelines for creating the dictionnary YAML:
 
 - Use a YAML syntax: pay attention to the indentation.
 - Keys: each key is the name of a node type or the name of a list of parts.
+- If the same type is reused several times, then write only one entry in this dictionnary.
 - Values contains the properties. For a node type, provide the following properties:
   - confidence: Your confidence level for the accuracy of this node type (0.0-1.0).
   - kind: Can be `routingDocument`, `regularDocument`, `part`.

package/gen-backend/prompts/predefined-fields.json

@@ -1,110 +1,114 @@
 [
   {
     "fieldName": "leadParagraph",
-    "dataType": "quillDelta",
     "localized": true,
+    "dataType": "json",
+    "renderAs": "html",
     "description": "Lead paragraph, or \"chapo\", of a post (HTML)"
   },
   {
     "fieldName": "htmlContent",
-    "dataType": "quillDelta",
     "localized": true,
+    "dataType": "json",
+    "renderAs": "html",
     "description": "HTML Content"
   },
   {
     "fieldName": "introduction",
-    "dataType": "quillDelta",
     "localized": true,
+    "dataType": "json",
+    "renderAs": "html",
     "description": "A short introduction (HTML)"
   },
   {
     "fieldName": "footerMention",
-    "dataType": "quillDelta",
+    "dataType": "json",
+    "renderAs": "html",
     "localized": true,
     "description": "The footer mention is used to display a legal notice or a disclaimer (HTML). Usually included as a site field."
   },
   {
     "fieldName": "logo",
-    "dataType": "media",
     "localized": false,
+    "dataType": "media",
     "description": "A logo is an image that represents a brand"
   },
   {
     "fieldName": "slogan",
-    "dataType": "string",
     "localized": true,
+    "dataType": "string",
     "description": "A slogan is a memorable motto or phrase as a repetitive expression of an idea or purpose"
   },
   {
     "fieldName": "phone",
-    "dataType": "string",
     "localized": false,
+    "dataType": "string",
     "description": "Phone number"
   },
   {
     "fieldName": "phone2",
-    "dataType": "string",
     "localized": false,
+    "dataType": "string",
     "description": "Secondary phone number"
   },
   {
     "fieldName": "title",
-    "dataType": "string",
     "localized": true,
+    "dataType": "string",
     "description": "Store a title"
   },
   {
     "fieldName": "shortTitle",
-    "dataType": "string",
     "localized": true,
+    "dataType": "string",
     "description": "A short title can be useful for buttons or menu items"
   },
   {
     "fieldName": "gallery",
-    "dataType": "gallery",
     "localized": false,
+    "dataType": "gallery",
     "description": "A collection of medias. It can be rendered as a carousel, a slider, a slideshow, an image gallery etc."
   },
   {
     "fieldName": "image",
-    "dataType": "media",
     "localized": false,
+    "dataType": "media",
     "description": "An image"
   },
   {
     "fieldName": "backgroundImage",
-    "dataType": "media",
     "localized": false,
+    "dataType": "media",
     "description": "A background image"
   },
   {
     "fieldName": "translatedImage",
-    "dataType": "media",
     "localized": true,
+    "dataType": "media",
     "description": "Image that will be different depending on the language (localized)"
   },
   {
     "fieldName": "featuredDocument",
-    "dataType": "string",
     "localized": false,
+    "dataType": "string",
     "description": "A link to a featured document"
   },
   {
     "fieldName": "phones",
-    "dataType": "json",
     "localized": false,
+    "dataType": "json",
     "description": "A list of phone numbers"
   },
   {
     "fieldName": "video",
-    "dataType": "string",
     "localized": false,
-    "description": "A Youtube video"
+    "dataType": "string",
+    "description": "A YouTube video"
   },
   {
-    "fieldName": "translatedVideo",
-    "dataType": "string",
+    "fieldName": "oneLanguageVideo",
     "localized": true,
-    "description": "A Youtube video with translations"
+    "dataType": "string",
+    "description": "A YouTube video, but different for each language"
   }
 ]

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

@@ -23,7 +23,8 @@ Here is an example of an object for describing a custom **HTML** field type:
   "name": "myCustomField",
   "localized": true,
   "storedAs": "text",
-  "dataType": "quillDelta",
+  "dataType": "json",
+  "renderAs": "html",
   "useAsExcerpt": 1,
   "plugin": "@paroicms/quill-editor-plugin"
 }}