nuxt-strapi-blocks-renderer 1.0.7 → 1.0.9

package/README.md

@@ -53,6 +53,7 @@ text editor element:
 </script>
 
 <template>
+    <!-- Render blocks text -->
     <StrapiBlocksText :nodes="blockNodes" />
 </template>
 ```
@@ -180,9 +181,7 @@ Custom blockquote and code tags (`<blockquote>`, `<pre>`):
 
 <!-- components/StrapiBlocksTextCodeNode.vue -->
 <template>
-    <pre class="my-custom-class-for-pre">
-        <slot />
-    </pre>
+    <pre class="my-custom-class-for-pre"><slot /></pre>
 </template>
 ```
 
@@ -344,6 +343,17 @@ To run the Vitest unit tests, run the following command:
 npm run test
 ````
 
+### Build
+
+To build the module, first install all dependencies and [generate the type stubs](#type-stubs).
+Then run the build script:
+
+```bash
+npm run build
+```
+
+The module files will be output to the `dist` folder.
+
 ### Release
 
 To release a new version of the strapi blocks renderer nuxt module, take the following steps:
@@ -351,12 +361,18 @@ To release a new version of the strapi blocks renderer nuxt module, take the fol
 1. Increment version number in the `package.json` file
 2. Add changelog entry for the new version number
 3. Run linters and unit tests
-4. Log in to NPM using your access token
-5. Run the `release` command
-
-```bash
-npm run release
-```
+4. Build the nuxt module
+ 
+   ```bash
+   npm run build
+   ```
+
+5. Log in to NPM using your access token
+6. Run the `release` command
+
+   ```bash
+   npm run release
+   ```
 
 [github-actions-src]: https://github.com/freb97/nuxt-strapi-blocks-renderer/actions/workflows/ci.yml/badge.svg
 [github-actions-href]: https://github.com/freb97/nuxt-strapi-blocks-renderer/actions

package/dist/module.d.mts

@@ -1,9 +1,9 @@
 import * as _nuxt_schema from '@nuxt/schema';
 
-type ModuleOptions = {
+interface ModuleOptions {
     prefix: string;
     blocksPrefix: string;
-};
+}
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
 
 export { type ModuleOptions, _default as default };

package/dist/module.d.ts

@@ -1,9 +1,9 @@
 import * as _nuxt_schema from '@nuxt/schema';
 
-type ModuleOptions = {
+interface ModuleOptions {
     prefix: string;
     blocksPrefix: string;
-};
+}
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
 
 export { type ModuleOptions, _default as default };

package/dist/module.json

@@ -1,9 +1,9 @@
 {
   "name": "nuxt-strapi-blocks-renderer",
   "configKey": "strapiBlocksRenderer",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "builder": {
-    "@nuxt/module-builder": "0.8.0",
+    "@nuxt/module-builder": "0.8.3",
     "unbuild": "2.0.0"
   }
 }

package/dist/runtime/components/StrapiBlocksText.vue

@@ -1,11 +1,11 @@
 <script setup lang="ts">
-    import { useBlocksText } from '#strapi-blocks-renderer/composables/useBlocksText';
-
     import type { VNode } from 'vue';
     import type { BlockNode } from '#strapi-blocks-renderer/types';
 
+    import { useBlocksText } from '#strapi-blocks-renderer/composables/useBlocksText';
+
     const props = defineProps<{
-        nodes: BlockNode[];
+        nodes: BlockNode[]
     }>();
 
     const { text } = useBlocksText(props.nodes);

package/dist/runtime/components/blocks/CodeNode.vue

@@ -1,5 +1,3 @@
 <template>
-    <pre>
-        <slot />
-    </pre>
+    <pre><slot /></pre>
 </template>

package/dist/runtime/components/blocks/ImageNode.vue

@@ -1,6 +1,6 @@
 <script setup lang="ts">
     const props = defineProps<{
-        image: any;
+        image: any
     }>();
 </script>
 

package/dist/runtime/components/blocks/inline/LinkInlineNode.vue

@@ -1,6 +1,6 @@
 <script setup lang="ts">
     const props = defineProps<{
-        url: string;
+        url: string
     }>();
 </script>
 

package/dist/runtime/composables/useBlocksText.d.ts

@@ -1,6 +1,6 @@
 import type { VNode } from 'vue';
 import type { BlockNode } from '#strapi-blocks-renderer/types';
-export type UseBlocksTextReturn = {
+export interface UseBlocksTextReturn {
     text: VNode[];
-};
+}
 export declare const useBlocksText: (blockNodes: BlockNode[]) => UseBlocksTextReturn;

package/dist/runtime/types/index.d.ts

@@ -1,67 +1,67 @@
 // Inline nodes
 
-export type TextInlineNode = {
-    type: 'text';
-    text: string;
-    bold?: boolean;
-    italic?: boolean;
-    underline?: boolean;
-    strikethrough?: boolean;
-    code?: boolean;
-};
+export interface TextInlineNode {
+    type: 'text'
+    text: string
+    bold?: boolean
+    italic?: boolean
+    underline?: boolean
+    strikethrough?: boolean
+    code?: boolean
+}
 
-export type LinkInlineNode = {
-    type: 'link';
-    url: string;
-    children: TextInlineNode[];
-};
+export interface LinkInlineNode {
+    type: 'link'
+    url: string
+    children: TextInlineNode[]
+}
 
-export type ListItemInlineNode = {
-    type: 'list-item';
-    children: DefaultInlineNode[];
-};
+export interface ListItemInlineNode {
+    type: 'list-item'
+    children: DefaultInlineNode[]
+}
 
 export type DefaultInlineNode = TextInlineNode | LinkInlineNode;
 
 // Typed nodes
 
-export type ParagraphBlockNode = {
-    type: 'paragraph';
-    children: DefaultInlineNode[];
-};
+export interface ParagraphBlockNode {
+    type: 'paragraph'
+    children: DefaultInlineNode[]
+}
 
-export type HeadingBlockNode = {
-    type: 'heading';
-    level: 1 | 2 | 3 | 4 | 5 | 6;
-    children: DefaultInlineNode[];
-};
+export interface HeadingBlockNode {
+    type: 'heading'
+    level: 1 | 2 | 3 | 4 | 5 | 6
+    children: DefaultInlineNode[]
+}
 
-export type ListBlockNode = {
-    type: 'list';
-    format: 'ordered' | 'unordered';
-    children: (ListItemInlineNode | ListBlockNode)[];
-};
+export interface ListBlockNode {
+    type: 'list'
+    format: 'ordered' | 'unordered'
+    children: (ListItemInlineNode | ListBlockNode)[]
+}
 
-export type QuoteBlockNode = {
-    type: 'quote';
-    children: DefaultInlineNode[];
-};
+export interface QuoteBlockNode {
+    type: 'quote'
+    children: DefaultInlineNode[]
+}
 
-export type CodeBlockNode = {
-    type: 'code';
-    children: TextInlineNode[];
-};
+export interface CodeBlockNode {
+    type: 'code'
+    children: TextInlineNode[]
+}
 
-export type ImageBlockNode = {
-    type: 'image';
-    image: any;
-    children: [{ type: 'text'; text: '' }];
-};
+export interface ImageBlockNode {
+    type: 'image'
+    image: any
+    children: [{ type: 'text', text: '' }]
+}
 
 export type BlockNode =
-    ParagraphBlockNode |
-    QuoteBlockNode |
-    CodeBlockNode |
-    HeadingBlockNode |
-    ListBlockNode |
-    ImageBlockNode;
+  ParagraphBlockNode |
+  QuoteBlockNode |
+  CodeBlockNode |
+  HeadingBlockNode |
+  ListBlockNode |
+  ImageBlockNode;

package/dist/runtime/utils/index.js

@@ -1,4 +1,4 @@
-import { resolveComponent, useRuntimeConfig, h } from "#imports";
+import { h, resolveComponent, useRuntimeConfig } from "#imports";
 const prefix = () => {
   const { public: { strapiBlocksRenderer } } = useRuntimeConfig();
   return strapiBlocksRenderer.blocksPrefix;
@@ -15,20 +15,15 @@ const getNodeText = (node) => {
 };
 export const textInlineNode = (node) => {
   const text = getNodeText(node);
-  if (node.bold)
-    return h(resolveComponent(prefix() + "BoldInlineNode"), () => text);
-  if (node.italic)
-    return h(resolveComponent(prefix() + "ItalicInlineNode"), () => text);
-  if (node.underline)
-    return h(resolveComponent(prefix() + "UnderlineInlineNode"), () => text);
-  if (node.strikethrough)
-    return h(resolveComponent(prefix() + "StrikethroughInlineNode"), () => text);
-  if (node.code)
-    return h(resolveComponent(prefix() + "CodeInlineNode"), () => text);
+  if (node.bold) return h(resolveComponent(`${prefix()}BoldInlineNode`), () => text);
+  if (node.italic) return h(resolveComponent(`${prefix()}ItalicInlineNode`), () => text);
+  if (node.underline) return h(resolveComponent(`${prefix()}UnderlineInlineNode`), () => text);
+  if (node.strikethrough) return h(resolveComponent(`${prefix()}StrikethroughInlineNode`), () => text);
+  if (node.code) return h(resolveComponent(`${prefix()}CodeInlineNode`), () => text);
   return text;
 };
 export const linkInlineNode = (node) => {
-  const linkComponent = resolveComponent(prefix() + "LinkInlineNode");
+  const linkComponent = resolveComponent(`${prefix()}LinkInlineNode`);
   return h(linkComponent, { url: node.url }, () => node.children.map((childNode) => {
     return textInlineNode(childNode);
   }));
@@ -41,65 +36,49 @@ export const defaultInlineNode = (node) => {
   }
 };
 export const listItemInlineNode = (node) => {
-  const listItemComponent = resolveComponent(prefix() + "ListItemInlineNode");
-  return h(
-    listItemComponent,
-    () => node.children.map(
-      (childNode) => defaultInlineNode(childNode)
-    )
-  );
+  const listItemComponent = resolveComponent(`${prefix()}ListItemInlineNode`);
+  return h(listItemComponent, () => node.children.map(
+    (childNode) => defaultInlineNode(childNode)
+  ));
 };
 export const headingBlockNode = (node) => {
-  const headingComponent = resolveComponent(prefix() + "Heading" + node.level + "Node");
-  return h(
-    headingComponent,
-    () => node.children.map(
-      (childNode) => defaultInlineNode(childNode)
-    )
-  );
+  const headingComponent = resolveComponent(`${prefix()}Heading${node.level}Node`);
+  return h(headingComponent, () => node.children.map(
+    (childNode) => defaultInlineNode(childNode)
+  ));
 };
 export const paragraphBlockNode = (node) => {
-  const paragraphComponent = resolveComponent(prefix() + "ParagraphNode");
-  return h(
-    paragraphComponent,
-    () => node.children.map(
-      (childNode) => defaultInlineNode(childNode)
-    )
-  );
+  const paragraphComponent = resolveComponent(`${prefix()}ParagraphNode`);
+  return h(paragraphComponent, () => node.children.map(
+    (childNode) => defaultInlineNode(childNode)
+  ));
 };
 export const codeBlockNode = (node) => {
-  const codeComponent = resolveComponent(prefix() + "CodeNode");
-  return h(
-    codeComponent,
-    () => node.children.map(
-      (childNode) => textInlineNode(childNode)
-    )
-  );
+  const codeComponent = resolveComponent(`${prefix()}CodeNode`);
+  return h(codeComponent, () => node.children.map(
+    (childNode) => textInlineNode(childNode)
+  ));
 };
 export const quoteBlockNode = (node) => {
-  const quoteComponent = resolveComponent(prefix() + "QuoteNode");
-  return h(
-    quoteComponent,
-    () => node.children.map(
-      (childNode) => defaultInlineNode(childNode)
-    )
-  );
+  const quoteComponent = resolveComponent(`${prefix()}QuoteNode`);
+  return h(quoteComponent, () => node.children.map(
+    (childNode) => defaultInlineNode(childNode)
+  ));
 };
 export const listBlockNode = (node) => {
   const listType = node.format === "ordered" ? "OrderedListNode" : "UnorderedListNode";
   const listComponent = resolveComponent(prefix() + listType);
   return h(listComponent, () => node.children.map(
     (childNode) => {
-      if (childNode.type === "list") {
-        return listBlockNode(childNode);
-      } else if (childNode.type === "list-item") {
+      if (childNode.type === "list-item") {
         return listItemInlineNode(childNode);
       }
+      return listBlockNode(childNode);
     }
   ));
 };
 export const imageBlockNode = (node) => {
-  const imageComponent = resolveComponent(prefix() + "ImageNode");
+  const imageComponent = resolveComponent(`${prefix()}ImageNode`);
   return h(imageComponent, {
     image: node.image
   });
@@ -109,8 +88,6 @@ export const renderBlocks = (blockNodes) => {
     switch (blockNode.type) {
       case "heading":
         return headingBlockNode(blockNode);
-      case "paragraph":
-        return paragraphBlockNode(blockNode);
       case "code":
         return codeBlockNode(blockNode);
       case "list":
@@ -119,6 +96,8 @@ export const renderBlocks = (blockNodes) => {
         return quoteBlockNode(blockNode);
       case "image":
         return imageBlockNode(blockNode);
+      default:
+        return paragraphBlockNode(blockNode);
     }
   });
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "nuxt-strapi-blocks-renderer",
-    "version": "1.0.7",
+    "version": "1.0.9",
     "description": "Renderer for the strapi CMS blocks text content element.",
     "license": "MIT",
     "repository": {
@@ -27,43 +27,42 @@
     "scripts": {
         "prepack": "nuxt-module-build build",
         "dev": "npm run dev:basic",
-        "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare",
+        "dev:prepare": "nuxt-module-build prepare && nuxi prepare playground/basic && nuxi prepare playground/custom",
         "dev:basic": "nuxi dev playground/basic",
         "dev:custom": "nuxi dev playground/custom",
+        "build": "nuxt-module-build build",
         "release": "npm run lint && npm run test && npm run prepack && npm publish",
         "release:ci": "npm run prepack && npm publish",
         "lint:es": "eslint './**/*.{js,ts,vue}' --max-warnings=0",
         "lint:types": "vue-tsc --noEmit",
         "test": "vitest run",
-        "test:watch": "vitest watch"
+        "test:watch": "vitest watch",
+        "renovate:config:validate": "renovate-config-validator"
     },
     "dependencies": {
-        "@nuxt/kit": "^3.12.2",
+        "@nuxt/kit": "^3.12.3",
         "defu": "^6.1.4"
     },
     "devDependencies": {
-        "@nuxt/devtools": "^1.3.7",
-        "@nuxt/eslint-config": "^0.3.13",
-        "@nuxt/module-builder": "^0.8.0",
-        "@nuxt/schema": "^3.12.2",
-        "@nuxt/test-utils": "^3.13.1",
-        "@stylistic/eslint-plugin": "^2.3.0",
-        "@types/node": "^20.14.9",
-        "@typescript-eslint/eslint-plugin": "^7.14.1",
+        "@antfu/eslint-config": "^2.25.1",
+        "@nuxt/devtools": "^1.3.9",
+        "@nuxt/module-builder": "^0.8.3",
+        "@nuxt/schema": "^3.12.4",
+        "@nuxt/test-utils": "^3.14.1",
+        "@types/node": "^22.3.0",
         "eslint": "^8.57.0",
-        "nuxt": "^3.12.2",
-        "typescript": "^5.5.2",
-        "vitest": "^1.6.0",
-        "vue": "^3.4.31",
-        "vue-eslint-parser": "^9.4.3",
-        "vue-tsc": "^2.0.22"
+        "nuxt": "^3.12.4",
+        "renovate": "^38.37.1",
+        "vitest": "^2.0.5",
+        "vue-tsc": "^2.0.29"
     },
-    "packageManager": "npm@10.2.4",
+    "keywords": [
+        "nuxt", "nuxt3", "nuxtjs", "nuxt-module", "strapi", "strapi-cms", "json", "blocks"
+    ],
     "engines": {
-        "node": "^18.x || ^20.x"
+        "node": "^18.x || ^20.x || ^22.x"
     },
     "stackblitz": {
-        "startCommand": "npm run dev:prepare && npm run dev",
-        "file": "playground/basic/pages/index.vue"
+        "startCommand": "npm run dev:prepare && npm run dev"
     }
 }