@paroicms/site-generator-plugin 0.31.3 → 0.31.5

package/backend/dist/commands/execute-command.js

@@ -45,18 +45,19 @@ export async function executeCommand(commandCtx, input) {
             };
         }
         if (input.command === "createSiteSchema") {
-            const errorResponse = await invokeMessageGuard(ctx, input);
-            if (errorResponse)
-                return errorResponse;
+            const guardResult = await invokeMessageGuard(ctx, input);
+            if ("success" in guardResult)
+                return guardResult;
             return {
                 success: true,
                 result: await startInitialAnalysis(ctx, input),
+                detectedLanguage: guardResult.detectedLanguage,
             };
         }
         if (input.command === "updateSiteSchema") {
-            const errorResponse = await invokeMessageGuard(ctx, input, { skipOutOfScopeCheck: true });
-            if (errorResponse)
-                return errorResponse;
+            const guardResult = await invokeMessageGuard(ctx, input, { skipOutOfScopeCheck: true });
+            if ("success" in guardResult)
+                return guardResult;
             return {
                 success: true,
                 result: await startUpdateSiteSchema(ctx, input),

package/backend/dist/generator/lib/parse-llm-response.js

@@ -1,4 +1,3 @@
-import { parse } from "yaml";
 export function parseLlmResponseAsProperties(llmResponse, outputTags) {
     const rawTags = parseLlmRawTags(llmResponse, outputTags.map((tag) => tag.tagName));
     const map = new Map(rawTags.map((tag) => [tag.tagName, tag]));
@@ -107,8 +106,6 @@ function formatRawContent(rawContent, tag) {
     if (!rawContent && optional)
         return;
     switch (format) {
-        case "yaml":
-            return parse(rawContent);
         case "json":
             return JSON.parse(rawContent);
         case "markdown":

package/backend/dist/generator/llm-queries/invoke-message-guard.js

@@ -35,9 +35,9 @@ export async function invokeMessageGuard(ctx, input, { skipOutOfScopeCheck = fal
     }
     const rawReport = parseLlmResponseAsProperties(llmOutput.output, [
         {
-            tagName: "guard_yaml",
+            tagName: "guard_json",
             key: "guard",
-            format: "yaml",
+            format: "json",
         },
     ]);
     const report = MessageGuardReportAT.assert(rawReport.guard);
@@ -48,7 +48,7 @@ export async function invokeMessageGuard(ctx, input, { skipOutOfScopeCheck = fal
         }
     }
     if (report.valid)
-        return;
+        return { detectedLanguage: report.language };
     await insertIssueEvent(ctx, {
         eventType: "blockedByGuard",
         llmTaskName: "guard",

package/backend/dist/generator/llm-queries/invoke-new-site-analysis.js

@@ -87,9 +87,9 @@ async function invokeAnalysisStep1(ctx, input, stepHandle) {
     }
     const rawAnalysis = parseLlmResponseAsProperties(llmOutput.output, [
         {
-            tagName: "website_properties_yaml",
+            tagName: "website_properties_json",
             key: "siteProperties",
-            format: "yaml",
+            format: "json",
         },
         {
             tagName: "hierarchical_md",
@@ -97,9 +97,9 @@ async function invokeAnalysisStep1(ctx, input, stepHandle) {
             format: "markdown",
         },
         {
-            tagName: "dictionary_yaml",
+            tagName: "dictionary_json",
             key: "dictionary",
-            format: "yaml",
+            format: "json",
         },
         {
             tagName: "explanation_md",
@@ -154,9 +154,9 @@ siteSchema, stepHandle) {
     }
     const { assignedFields, unusedInformation } = parseLlmResponseAsProperties(llmOutput.output, [
         {
-            tagName: "yaml_result",
+            tagName: "json_result",
             key: "assignedFields",
-            format: "yaml",
+            format: "json",
         },
         {
             tagName: "unused_information_md",

package/backend/prompts/initial-1-analysis.md

@@ -1,8 +1,8 @@
 You will be given a description of a website's structure. Your task is to **analyze** the website description, then you will generate three things:
 
-1. A YAML for website properties.
+1. A JSON object for website properties.
 2. A Markdown bulleted list that represents the hierarchy of node types (routing documents, regular documents and parts) within the site.
-3. A YAML key/value dictionnary to describe each node type.
+3. A JSON object to describe each node type.
 
 Here is the website description:
 
@@ -12,9 +12,9 @@ Here is the website description:
 
 Notice: If the website description doesn't mention a _contact page_ and a _search page_, then append them by default as routing documents, children of the home page.
 
-## Step 1 - Instructions for the website properties YAML
+## Step 1 - Instructions for the website properties JSON
 
-In the first step, you are tasked to write global properties of the website as a YAML.
+In the first step, you are tasked to write global properties of the website as a JSON object.
 
 Provide the following website properties:
 
@@ -119,13 +119,13 @@ Here's an example of correct output using parts, and with the default contact an
 
 When you have a choice, keep it simple. If the user lets you invent the site's structure, limit the site's sections to **2 main entries**. For example, a “news” routing document with a list of articles and categories, and a list of pages on the site's theme. Plus the usual contact and search pages.
 
-## Step 3 - Instructions for the dictionnary YAML
+## Step 3 - Instructions for the dictionary JSON
 
-In the third step, you are tasked to produce a YAML that describes every node type and list of parts identified in the hierarchical YAML.
+In the third step, you are tasked to produce a JSON object that describes every node type and list of parts identified in the hierarchical markdown.
 
-Guidelines for creating the dictionnary YAML:
+Guidelines for creating the dictionary JSON:
 
-- Use a YAML syntax: pay attention to the indentation.
+- Use JSON syntax.
 - 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:
@@ -147,74 +147,89 @@ Guidelines for creating the dictionnary YAML:
 Here is an example of expected output:
 
 <correct_example>
-home:
-  confidence: 1
-  kind: routingDocument
-  entryPage: true
-  label: Home page
-  description: This is the home page of the website.
-homeSections:
-  confidence: 0.9
-  kind: partList
-  label: Sections
-  description: This list contains the main sections of the home page.
-homeSection:
-  confidence: 0.7
-  kind: part
-  label: Section
-  description: A home section is a sub-part of the home page.
-pages:
-  confidence: 0.9
-  kind: routingDocument
-  label: Pages
-  description: This is the document for grouping all pages.
-page:
-  confidence: 0.9
-  kind: regularDocument
-  temporal: false
-  label: Page
-  description: ...
-pageSections:
-  confidence: 0.9
-  kind: partList
-  label: Sections
-  description: ...
-pageSection:
-  confidence: 0.8
-  kind: part
-  label: Section
-  description: ...
+{
+  "home": {
+    "confidence": 1,
+    "kind": "routingDocument",
+    "entryPage": true,
+    "label": "Home page",
+    "description": "This is the home page of the website."
+  },
+  "homeSections": {
+    "confidence": 0.9,
+    "kind": "partList",
+    "label": "Sections",
+    "description": "This list contains the main sections of the home page."
+  },
+  "homeSection": {
+    "confidence": 0.7,
+    "kind": "part",
+    "label": "Section",
+    "description": "A home section is a sub-part of the home page."
+  },
+  "pages": {
+    "confidence": 0.9,
+    "kind": "routingDocument",
+    "label": "Pages",
+    "description": "This is the document for grouping all pages."
+  },
+  "page": {
+    "confidence": 0.9,
+    "kind": "regularDocument",
+    "temporal": false,
+    "label": "Page",
+    "description": "..."
+  },
+  "pageSections": {
+    "confidence": 0.9,
+    "kind": "partList",
+    "label": "Sections",
+    "description": "..."
+  },
+  "pageSection": {
+    "confidence": 0.8,
+    "kind": "part",
+    "label": "Section",
+    "description": "..."
+  }
+}
 </correct_example>
 
 Here is how to specify posts with a "tags" taxonomy:
 
 <correct_example>
-news:
-  confidence: 1
-  kind: routingDocument
-  entryPage: true
-  label: News
-  description: This is the blog section of the website. The news document contains all the topical posts.
-post:
-  confidence: 0.8
-  kind: regularDocument
-  temporal: true
-  jsonLdType: Article
-  label: Post
-  description: A topical post about the subject of the website whatever it is.
-  prompt: Add a labeling field using the tags taxonomy (allow multiple tags)
-tags:
-  confidence: 0.9
-  kind: routingDocument
-  taxonomy: true
-  label: Tags
-  description: Tags taxonomy for post documents.
-tag:
-  confidence: 0.9
-  kind: regularDocument
-  temporal: false
-  label: Tag
-  description: A tag is a term in the tags taxonomy.
+{
+  "news": {
+    "confidence": 1,
+    "kind": "routingDocument",
+    "entryPage": true,
+    "label": "News",
+    "description": "This is the blog section of the website. The news document contains all the topical posts."
+  },
+  "post": {
+    "confidence": 0.8,
+    "kind": "regularDocument",
+    "temporal": true,
+    "jsonLdType": "Article",
+    "label": "Post",
+    "description": "A topical post about the subject of the website whatever it is.",
+    "prompt": "Add a labeling field using the tags taxonomy (allow multiple tags)"
+  },
+  "tags": {
+    "confidence": 0.9,
+    "kind": "routingDocument",
+    "taxonomy": true,
+    "label": "Tags",
+    "description": "Tags taxonomy for post documents."
+  },
+  "tag": {
+    "confidence": 0.9,
+    "kind": "regularDocument",
+    "temporal": false,
+    "label": "Tag",
+    "description": "A tag is a term in the tags taxonomy."
+  }
+}
 </correct_example>
 
 Note the `prompt` property in the `post` type: in this way, tags can be assigned to a post.
@@ -227,11 +242,11 @@ Before providing your final answer, use the scratchpad to organize your thoughts
 [Use this space to analyze the website description, identify node types, and plan the hierarchy]
 </scratchpad>
 
-Once you have organized your thoughts, provide the first YAML for website properties (step 1) within <website_properties_yaml> tags.
+Once you have organized your thoughts, provide the JSON for website properties (step 1) within <website_properties_json> tags.
 
 Then, provide the mardown representing the website tree structure (step 2) within <hierarchical_md> tags.
 
-Provide the node types properties (step 3) within <dictionary_yaml> tags.
+Provide the node types properties (step 3) within <dictionary_json> tags.
 
 Also, write a short explanation of your choices regarding the 3 steps, within <explanation_md> tags. Write the explanation in markdown and in the website description language. Your explanation message will be shown to the end-user as a message in a chat. The user will also see the website structure and its properties, so don't repeat descriptions, don't describe choices when they're obvious. Be as succinct as possible. If there is nothing valuable to say, then let this tag empty.
 

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

@@ -22,9 +22,9 @@ You are tasked of assigning predefined fields for each node type (routing docume
 
 Create a key/value dictionnary. Keys are the node type names of the provided site schema. Value are arrays of field names.
 
-Guidelines for creating the dictionnary YAML:
+Guidelines for creating the dictionary JSON:
 
-- Use a YAML syntax.
+- Use JSON syntax.
 - All the node types must have a key in your result.
 - If there is no need of a field for a node type, then leave an empty array.
 - Documents and parts already contains a _publish date_ and a _draft_ flag.
@@ -39,16 +39,18 @@ Guidelines for creating the dictionnary YAML:
 Here is an example of expected output:
 
 <correct_example>
-_site: [logo, "footerMention[@paroicms/tiptap-editor-plugin]"]
-home: [gallery, "introduction[@paroicms/tiptap-editor-plugin]"]
-posts: ["introduction[@paroicms/tiptap-editor-plugin]"]
-searchPage: []
-contactPage: ["introduction[@paroicms/tiptap-editor-plugin]"]
-regularDocumentExemple1: [gallery, "htmlContent[@paroicms/tiptap-editor-plugin]"]
-partExemple2: [title, image, "htmlContent[@paroicms/tiptap-editor-plugin]"]
-aBlogPostExample: [gallery, "leadParagraph[@paroicms/tiptap-editor-plugin]", "htmlContent[@paroicms/tiptap-editor-plugin]"]
+{
+  "_site": ["logo", "footerMention[@paroicms/tiptap-editor-plugin]"],
+  "home": ["gallery", "introduction[@paroicms/tiptap-editor-plugin]"],
+  "posts": ["introduction[@paroicms/tiptap-editor-plugin]"],
+  "searchPage": [],
+  "contactPage": ["introduction[@paroicms/tiptap-editor-plugin]"],
+  "regularDocumentExemple1": ["gallery", "htmlContent[@paroicms/tiptap-editor-plugin]"],
+  "partExemple2": ["title", "image", "htmlContent[@paroicms/tiptap-editor-plugin]"],
+  "aBlogPostExample": ["gallery", "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.
+Provide the JSON result within <json_result> tags. Do not write any explanation or commentary outside the tags.
 
 Additionally, write within <unused_information_md> tags the information from the user instructions that you weren't able to use here, in the form of a short prompt, in markdown format. Do not invent anything. Do not imagine anything. If there is no remaining information, then let this tag empty.

package/backend/prompts/message-guard.md

@@ -33,9 +33,9 @@ Here is the user request:
 {{message}}
 </user_message>
 
-# The output format in YAML
+# The output format in JSON
 
-Generate your evaluation as a YAML object. It contains:
+Generate your evaluation as a JSON object. It contains:
 
 - `language`: The language used in <website_description>, as a two-letters code. Return this key only if you are sure.
 - `valid`: A boolean value.
@@ -49,35 +49,33 @@ Generate your evaluation as a YAML object. It contains:
 
 Examples of outputs:
 
-```yaml
-language: en
-valid: true
+```json
+{ "language": "en", "valid": true }
 ```
 
-```yaml
-language: en
-valid: false
-causes:
-- technicalLimits
-explanation: We can't implement online shop.
+```json
+{
+  "language": "en",
+  "valid": false,
+  "causes": ["technicalLimits"],
+  "explanation": "We can't implement online shop."
+}
 ```
 
-```yaml
-valid: false
-causes:
-- noSense
+```json
+{ "valid": false, "causes": ["noSense"] }
 ```
 
-```yaml
-language: en
-valid: false
-causes:
-- rude
-- outOfScope
+```json
+{
+  "language": "en",
+  "valid": false,
+  "causes": ["rude", "outOfScope"]
+}
 ```
 
 Notice: no need of explanation if the user message is rude.
 
-Provide the YAML properties within <guard_yaml> tags.
+Provide the JSON object within <guard_json> tags.
 
-Just return the YAML. Do not include any other explanation or commentary outside these tags.
+Just return the JSON. Do not include any other explanation or commentary outside these tags.