nuxt-content-assets 1.3.3 → 1.3.7

package/README.md

@@ -70,7 +70,7 @@ To clone and run the demo locally:
 ```bash
 git clone https://github.com/davestewart/nuxt-content-assets.git
 cd nuxt-content-assets
-npm install
+npm install && npm install --prefix ./demo
 npm run dev
 ```
 
@@ -205,7 +205,7 @@ See demo component [here](demo/components/content/ContentImage.vue).
 
 ### Nuxt Image compatibility
 
-Nuxt Content Assets works with [Nuxt Image](https://v1.image.nuxtjs.org/) with just a little configuration.
+Nuxt Content Assets works with [Nuxt Image](https://image.nuxtjs.org/) with just a little configuration.
 
 First, configure Nuxt Image to use Nuxt Content Asset's public folder:
 
@@ -318,13 +318,16 @@ In development, file watching propagates asset changes to the public folder, upd
 
 Should you wish to develop the project, the scripts are:
 
-Develop the module itself:
+Develop the module (running a demo which uses the live module code):
 
 ```bash
 # install dependencies
 npm install
 
-# develop (runs using the demo)
+# generate demo type stubs (for the first time)
+npm run dev:prepare
+
+# develop (runs the demo app)
 npm run dev
 
 # run eslint
@@ -335,23 +338,20 @@ npm run test
 npm run test:watch
 ```
 
-Build and check the demo:
+Build and check the demo (simulating users' final build choices):
 
 ```bash
-# generate demo type stubs
-npm run demo:prepare
-
-# generate the demo output
-npm run demo:generate
-
-# serve the demo output
-npm run demo:serve
+# generate the demo
+npm run dev:generate
 
 # build the demo
-npm run demo:build
+npm run dev:build
+
+# serve the built demo
+npm run dev:serve
 ```
 
-Make a new release:
+Make a new release (so users can install the module):
 
 ```bash
 # release new version
@@ -361,24 +361,21 @@ npm run release
 npm run release:dry
 ```
 
-Make sure to edit changelog and update `package.json` version first!
+Make sure to edit changelog and update `package.json` version before releasing!
 
-## Troubleshooting
+## Maintenance
 
-### Prepare script hangs
+This module was created using the Nuxt [Module Builder](https://github.com/nuxt/module-builder) command:
 
-As of Nuxt `3.7` it seems there might be issues running prepare scripts for some modules:
-
-- [nuxt/cli / nuxt prepare step hangs](https://github.com/nuxt/cli/issues/169)
-
-If that's the case with you, fix Nuxt at `3.6.5` (if you can) and you should be fine.
+```bash
+npx nuxi init -t module nuxt-content-assets
+```
 
-Failing that, watch that ticket (or these ones):
+This created the module code from the starter template found here:
 
-- https://github.com/nuxt/cli/issues/185
-- https://github.com/davestewart/nuxt-content-assets/issues/49
+- https://github.com/nuxt/starter/tree/module
 
-I'll update when there is more info.
+Both [Nuxi](https://github.com/nuxt/cli) and the module's dependencies and scripts are updated fairly regularly, so from time to time this module will / does need to be updated to keep in sync. So far, this has meant just updating the dependencies and scripts, which are found in the starter template code mentioned above.
 
 <!-- Badges -->
 [npm-version-src]: https://img.shields.io/npm/v/nuxt-content-assets/latest.svg?style=flat&colorA=18181B&colorB=28CF8D

package/dist/module.d.mts

@@ -0,0 +1,29 @@
+import * as _nuxt_schema from '@nuxt/schema';
+
+interface ModuleOptions {
+    /**
+     * Image size hints
+     *
+     * @example 'attrs style url'
+     * @default 'style'
+     */
+    imageSize?: string | string[] | false;
+    /**
+     * List of content extensions; anything else as an asset
+     *
+     * @example 'md'
+     * @default 'md csv ya?ml json'
+     */
+    contentExtensions?: string | string[];
+    /**
+     * Display debug messages
+     *
+     * @example true
+     * @default false
+     */
+    debug?: boolean;
+}
+
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
+
+export { _default as default };

package/dist/module.json

@@ -4,5 +4,5 @@
   "compatibility": {
     "nuxt": "^3.0.0"
   },
-  "version": "1.3.3"
+  "version": "1.3.5"
 }

package/dist/module.mjs

@@ -1,5 +1,7 @@
-import Fs from 'fs';
-import Path from 'crosspath';
+import * as Fs from 'fs';
+import Fs__default from 'fs';
+import * as Path from 'crosspath';
+import Path__default from 'crosspath';
 import { useNuxt, createResolver, defineNuxtModule, addPlugin } from '@nuxt/kit';
 import { visit, SKIP, CONTINUE } from 'unist-util-visit';
 import { listen } from 'listhen';
@@ -51,7 +53,7 @@ function isExcluded(path) {
   return path.split("/").some((segment) => segment.startsWith(".") || segment.startsWith("_"));
 }
 function isImage(path) {
-  const ext = Path.extname(path).substring(1);
+  const ext = Path__default.extname(path).substring(1);
   return extensions.image.includes(ext);
 }
 function isArticle(path) {
@@ -153,33 +155,33 @@ function buildQuery(...expr) {
 }
 
 function readFile(path, asJson = false) {
-  const text = Fs.readFileSync(path, { encoding: "utf8" });
+  const text = Fs__default.readFileSync(path, { encoding: "utf8" });
   return asJson ? JSON.parse(text) : text;
 }
 function writeFile(path, data) {
   const text = typeof data === "object" ? JSON.stringify(data, null, "  ") : String(data);
-  createFolder(Path.dirname(path));
-  Fs.writeFileSync(path, text, { encoding: "utf8" });
+  createFolder(Path__default.dirname(path));
+  Fs__default.writeFileSync(path, text, { encoding: "utf8" });
 }
 async function writeBlob(path, data) {
   const buffer = Buffer.from(await data.arrayBuffer());
-  createFolder(Path.dirname(path));
-  Fs.writeFileSync(path, buffer);
+  createFolder(Path__default.dirname(path));
+  Fs__default.writeFileSync(path, buffer);
 }
 function copyFile(src, trg) {
-  createFolder(Path.dirname(trg));
-  Fs.copyFileSync(src, trg);
+  createFolder(Path__default.dirname(trg));
+  Fs__default.copyFileSync(src, trg);
 }
 function removeFile(src) {
-  Fs.rmSync(src);
+  Fs__default.rmSync(src);
 }
 function createFolder(path) {
-  Fs.mkdirSync(path, { recursive: true });
+  Fs__default.mkdirSync(path, { recursive: true });
 }
 function removeFolder(path) {
-  const isDownstream = path.startsWith(Path.resolve());
+  const isDownstream = path.startsWith(Path__default.resolve());
   if (isDownstream) {
-    Fs.rmSync(path, { recursive: true, force: true });
+    Fs__default.rmSync(path, { recursive: true, force: true });
   }
 }
 
@@ -329,13 +331,13 @@ function makeSourceManager(key, source, publicPath, callback) {
     return toPath(key2).replace(/\w+/, "").replace(source.prefix || "", "");
   }
   function getAbsSrc(key2) {
-    return Path.join(source.base, getRelSrc(key2));
+    return Path__default.join(source.base, getRelSrc(key2));
   }
   function getRelTrg(key2) {
-    return Path.join(source.prefix || "", toPath(deKey(key2)));
+    return Path__default.join(source.prefix || "", toPath(deKey(key2)));
   }
   function getAbsTrg(key2) {
-    return Path.join(publicPath, getRelTrg(key2));
+    return Path__default.join(publicPath, getRelTrg(key2));
   }
   function removeItem(key2) {
     const absTrg = getAbsTrg(key2);
@@ -384,14 +386,16 @@ function makeSourceManager(key, source, publicPath, callback) {
   };
 }
 
-function makeAssetsManager(publicPath) {
+function makeAssetsManager(publicPath, shouldWatch = true) {
   const indexKey = "assets.json";
-  const storage = makeSourceStorage(Path.join(publicPath, ".."));
-  void storage.watch(async (event, key) => {
-    if (event === "update" && key === indexKey) {
-      await load();
-    }
-  });
+  const storage = makeSourceStorage(Path__default.join(publicPath, ".."));
+  if (shouldWatch) {
+    void storage.watch(async (event, key) => {
+      if (event === "update" && key === indexKey) {
+        await load();
+      }
+    });
+  }
   const assets = {};
   async function load() {
     const data = await storage.getItem(indexKey);
@@ -401,8 +405,8 @@ function makeAssetsManager(publicPath) {
     void storage.setItem(indexKey, assets);
   }, 50);
   function resolveAsset(content, relAsset, registerContent = false) {
-    const srcDir = Path.dirname(content._file);
-    const srcAsset = Path.join(srcDir, relAsset);
+    const srcDir = Path__default.dirname(content._file);
+    const srcAsset = Path__default.join(srcDir, relAsset);
     const asset = assets[srcAsset];
     if (asset && registerContent) {
       const { _id } = content;
@@ -445,11 +449,15 @@ function makeAssetsManager(publicPath) {
     setAsset,
     getAsset,
     removeAsset,
-    resolveAsset
+    resolveAsset,
+    dispose: async () => {
+      await storage.unwatch();
+      await storage.dispose();
+    }
   };
 }
 function getAssetPaths(srcDir, srcAbs) {
-  const srcRel = Path.relative(srcDir, srcAbs);
+  const srcRel = Path__default.relative(srcDir, srcAbs);
   const srcAttr = "/" + srcRel;
   return {
     srcRel,
@@ -515,7 +523,6 @@ const module = defineNuxtModule({
     debug: false
   },
   async setup(options, nuxt) {
-    var _a, _b;
     const buildPath = nuxt.options.buildDir;
     const assetsPath = Path.join(buildPath, "content-assets");
     const publicPath = Path.join(assetsPath, "public");
@@ -527,9 +534,9 @@ const module = defineNuxtModule({
     removeFolder(assetsPath);
     const { contentExtensions } = options;
     if (contentExtensions) {
-      (_a = nuxt.options).content || (_a.content = {});
+      nuxt.options.content ||= {};
       if (nuxt.options.content) {
-        (_b = nuxt.options.content).ignores || (_b.ignores = []);
+        nuxt.options.content.ignores ||= [];
       }
       const ignores = makeIgnores(contentExtensions);
       nuxt.options.content?.ignores.push(ignores);
@@ -550,7 +557,8 @@ const module = defineNuxtModule({
         };
       }
     }
-    const assets = makeAssetsManager(publicPath);
+    const assets = makeAssetsManager(publicPath, nuxt.options.dev);
+    nuxt.hooks.hook("close", () => assets.dispose());
     function onAssetChange(event, absTrg) {
       let src = "";
       let width;
@@ -588,6 +596,12 @@ const module = defineNuxtModule({
       }
       managers[key] = makeSourceManager(key, source, publicPath, onAssetChange);
     }
+    nuxt.hook("close", async () => {
+      for (const key in managers) {
+        await managers[key].storage.unwatch();
+        await managers[key].storage.dispose();
+      }
+    });
     nuxt.hook("build:before", async function() {
       for (const [key, manager] of Object.entries(managers)) {
         const paths = await manager.init();
@@ -605,16 +619,17 @@ const module = defineNuxtModule({
       makeVar("debug", options.debug)
     ].join("\n");
     nuxt.hook("nitro:config", async (config) => {
-      config.plugins || (config.plugins = []);
+      config.plugins ||= [];
       config.plugins.push(pluginPath);
-      config.virtual || (config.virtual = {});
+      config.virtual ||= {};
       config.virtual[`#${meta.name}`] = () => {
         return virtualConfig;
       };
-      config.publicAssets || (config.publicAssets = []);
+      config.publicAssets ||= [];
       config.publicAssets.push({
-        dir: publicPath
-        // maxAge: 60 * 60 * 24 * 365 // 1 year
+        dir: publicPath,
+        maxAge: 60 * 60 * 24 * 7
+        // 7 days
       });
     });
   }

package/dist/runtime/assets/public.d.ts

@@ -1,12 +1,13 @@
-import { ParsedContent, AssetConfig } from '../../types';
+import type { ParsedContent, AssetConfig } from '../../types';
 /**
  * Manages the public assets
  */
-export declare function makeAssetsManager(publicPath: string): {
+export declare function makeAssetsManager(publicPath: string, shouldWatch?: boolean): {
     setAsset: (path: string) => AssetConfig;
     getAsset: (path: string) => AssetConfig | undefined;
     removeAsset: (path: string) => AssetConfig | undefined;
     resolveAsset: (content: ParsedContent, relAsset: string, registerContent?: boolean) => AssetConfig;
+    dispose: () => Promise<void>;
 };
 /**
  * Hash of replacer functions

package/dist/runtime/assets/public.mjs

@@ -4,14 +4,16 @@ import debounce from "debounce";
 import { hash } from "ohash";
 import { makeSourceStorage } from "./source.mjs";
 import { isImage, warn, log } from "../utils/index.mjs";
-export function makeAssetsManager(publicPath) {
+export function makeAssetsManager(publicPath, shouldWatch = true) {
   const indexKey = "assets.json";
   const storage = makeSourceStorage(Path.join(publicPath, ".."));
-  void storage.watch(async (event, key) => {
-    if (event === "update" && key === indexKey) {
-      await load();
-    }
-  });
+  if (shouldWatch) {
+    void storage.watch(async (event, key) => {
+      if (event === "update" && key === indexKey) {
+        await load();
+      }
+    });
+  }
   const assets = {};
   async function load() {
     const data = await storage.getItem(indexKey);
@@ -65,7 +67,11 @@ export function makeAssetsManager(publicPath) {
     setAsset,
     getAsset,
     removeAsset,
-    resolveAsset
+    resolveAsset,
+    dispose: async () => {
+      await storage.unwatch();
+      await storage.dispose();
+    }
   };
 }
 export const replacers = {

package/dist/runtime/assets/source.d.ts

@@ -1,5 +1,5 @@
-import { MountOptions } from '@nuxt/content';
-import { WatchEvent, Storage } from 'unstorage';
+import { type MountOptions } from '@nuxt/content';
+import { type WatchEvent, type Storage } from 'unstorage';
 /**
  * Make a Storage instance that monitors assets from a single source
  */

package/dist/runtime/content/plugin.mjs

@@ -1,55 +1,55 @@
 import { buildQuery, buildStyle, isValidAsset, list, parseQuery, removeQuery, walkBody, walkMeta } from "../utils/index.mjs";
 import { makeAssetsManager } from "../assets/public.mjs";
 import { debug, imageSizes, publicPath } from "#nuxt-content-assets";
-function processMeta(content, imageSizes2 = [], updated = []) {
-  walkMeta(content, (value, parent, key) => {
-    if (isValidAsset(value)) {
-      const { srcAttr, width, height } = resolveAsset(content, removeQuery(value), true);
-      if (srcAttr) {
-        const query = width && height && (imageSizes2.includes("src") || imageSizes2.includes("url")) ? `width=${width}&height=${height}` : "";
-        const srcUrl = query ? buildQuery(srcAttr, parseQuery(value), query) : srcAttr;
-        parent[key] = srcUrl;
-        updated.push(`meta: ${key} to "${srcUrl}"`);
-      }
-    }
-  });
-}
-function processBody(content, imageSizes2 = [], updated = []) {
-  walkBody(content, function(node) {
-    const { tag, props } = node;
-    for (const [prop, value] of Object.entries(props)) {
-      if (typeof value !== "string") {
-        return;
+const plugin = async (nitro) => {
+  function processMeta(content, imageSizes2 = [], updated = []) {
+    walkMeta(content, (value, parent, key) => {
+      if (isValidAsset(value)) {
+        const { srcAttr, width, height } = resolveAsset(content, removeQuery(value), true);
+        if (srcAttr) {
+          const query = width && height && (imageSizes2.includes("src") || imageSizes2.includes("url")) ? `width=${width}&height=${height}` : "";
+          const srcUrl = query ? buildQuery(srcAttr, parseQuery(value), query) : srcAttr;
+          parent[key] = srcUrl;
+          updated.push(`meta: ${key} to "${srcUrl}"`);
+        }
       }
-      const { srcAttr, width, height } = resolveAsset(content, value, true);
-      if (srcAttr) {
-        node.props[prop] = srcAttr;
-        if (node.tag === "img" || node.tag === "nuxt-img") {
-          if (width && height) {
-            if (imageSizes2.includes("attrs")) {
-              node.props.width = width;
-              node.props.height = height;
-            }
-            if (imageSizes2.includes("style")) {
-              const ratio = `${width}/${height}`;
-              if (typeof node.props.style === "string") {
-                node.props.style = buildStyle(node.props.style, `aspect-ratio: ${ratio}`);
-              } else {
-                node.props.style ||= {};
-                node.props.style.aspectRatio = ratio;
+    });
+  }
+  function processBody(content, imageSizes2 = [], updated = []) {
+    walkBody(content, function(node) {
+      const { tag, props } = node;
+      for (const [prop, value] of Object.entries(props)) {
+        if (typeof value !== "string") {
+          return;
+        }
+        const { srcAttr, width, height } = resolveAsset(content, value, true);
+        if (srcAttr) {
+          node.props[prop] = srcAttr;
+          if (node.tag === "img" || node.tag === "nuxt-img") {
+            if (width && height) {
+              if (imageSizes2.includes("attrs")) {
+                node.props.width = width;
+                node.props.height = height;
+              }
+              if (imageSizes2.includes("style")) {
+                const ratio = `${width}/${height}`;
+                if (typeof node.props.style === "string") {
+                  node.props.style = buildStyle(node.props.style, `aspect-ratio: ${ratio}`);
+                } else {
+                  node.props.style ||= {};
+                  node.props.style.aspectRatio = ratio;
+                }
               }
             }
+          } else if (node.tag === "a") {
+            node.props.target ||= "_blank";
           }
-        } else if (node.tag === "a") {
-          node.props.target ||= "_blank";
+          updated.push(`page: ${tag}[${prop}] to "${srcAttr}"`);
         }
-        updated.push(`page: ${tag}[${prop}] to "${srcAttr}"`);
       }
-    }
-  });
-}
-const { resolveAsset } = makeAssetsManager(publicPath);
-const plugin = async (nitro) => {
+    });
+  }
+  const { resolveAsset, dispose } = makeAssetsManager(publicPath, import.meta.dev);
   nitro.hooks.hook("content:file:afterParse", function(content) {
     if (content._extension === "md") {
       const updated = [];
@@ -61,5 +61,6 @@ const plugin = async (nitro) => {
       }
     }
   });
+  nitro.hooks.hook("close", dispose);
 };
 export default plugin;

package/dist/runtime/sockets/factory.d.ts

@@ -1,4 +1,4 @@
-import { Callback } from '../../types';
+import type { Callback } from '../../types';
 export interface Logger {
     log: (...args: any[]) => void;
     warn: (...args: any[]) => void;

package/dist/runtime/sockets/plugin.mjs

@@ -1,8 +1,8 @@
 import { defineNuxtPlugin, refreshNuxtData, useRuntimeConfig } from "#imports";
 export default defineNuxtPlugin(async () => {
-  if (process.client) {
+  if (import.meta.client) {
     const url = useRuntimeConfig().public.sockets?.wsUrl;
-    const socket = await import("./setup").then(({ setupSocketClient }) => {
+    const socket = await import("./setup.mjs").then(({ setupSocketClient }) => {
       return setupSocketClient(url, "content-assets");
     });
     if (socket) {

package/dist/runtime/sockets/setup.d.ts

@@ -1,2 +1,2 @@
-import { Callback, SocketInstance } from '../../types';
+import type { Callback, SocketInstance } from '../../types';
 export declare function setupSocketClient(url: string, channel: string, callback?: Callback): SocketInstance | null;

package/dist/runtime/utils/content.d.ts

@@ -1,5 +1,5 @@
-import { ParsedContent } from '../../types';
-import { WalkCallback } from './object';
+import type { ParsedContent } from '../../types';
+import { type WalkCallback } from './object';
 /**
  * Walk parsed content meta, only processing relevant properties
  *

package/dist/types.d.mts

@@ -0,0 +1,8 @@
+
+import type {  } from './module.js'
+
+
+
+
+
+export type { default } from './module.js'

package/dist/types.d.ts

@@ -1,6 +1,8 @@
 
-import {  } from './module'
+import type {  } from './module'
 
 
 
-export { default } from './module'
+
+
+export type { default } from './module'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-content-assets",
-  "version": "1.3.3",
+  "version": "1.3.7",
   "description": "Enable locally-located assets in Nuxt Content",
   "repository": "davestewart/nuxt-content-assets",
   "license": "MIT",
@@ -19,23 +19,22 @@
   ],
   "scripts": {
     "dev": "nuxi dev demo",
-    "build": "nuxt-module-build",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare demo",
+    "dev:generate": "nuxi generate demo",
+    "dev:build": "nuxi build demo",
+    "dev:serve": "npx serve demo/dist",
+    "release": "npm run lint && npm run test && nuxt-module-build build && changelogen --release && npm publish && git push --follow-tags",
+    "release:dry": "npm run lint && npm run test && nuxt-module-build build && npm publish --dry-run",
     "lint": "eslint .",
     "test": "vitest run",
-    "test:watch": "vitest watch",
-    "demo:prepare": "nuxt-module-build --stub && nuxi prepare demo",
-    "demo:generate": "nuxt generate demo",
-    "demo:serve": "npx serve demo/dist",
-    "demo:build": "nuxi build demo",
-    "release": "npm run lint && npm run test && npm run build && npm publish && git push --follow-tags",
-    "release:dry": "npm run lint && npm run test && npm run build && npm publish --dry-run"
+    "test:watch": "vitest watch"
   },
   "dependencies": {
-    "@nuxt/kit": "^3.3.2",
+    "@nuxt/kit": "^3.11.2",
     "crosspath": "^2.0.0",
     "debounce": "^1.2.1",
     "image-size": "^1.0.2",
-    "listhen": "^1.0.4",
+    "listhen": "^1.7.2",
     "ohash": "^1.0.0",
     "unist-util-visit": "^4.1.2",
     "unstorage": "^1.4.1",
@@ -45,17 +44,20 @@
     "@nuxt/content": "^2.0.0"
   },
   "devDependencies": {
-    "@nuxt/eslint-config": "^0.1.1",
-    "@nuxt/module-builder": "^0.2.1",
-    "@nuxt/schema": "^3.3.2",
-    "@nuxt/test-utils": "^3.3.2",
+    "@types/node": "^20.12.4",
+    "@nuxt/devtools": "latest",
+    "@nuxt/eslint-config": "^0.2.0",
+    "@nuxt/module-builder": "^0.5.5",
+    "@nuxt/schema": "^3.11.2",
+    "@nuxt/test-utils": "^3.12.0",
+    "changelogen": "^0.5.5",
+    "eslint": "^8.57.0",
+    "nuxt": "^3.11.2",
+    "vitest": "^1.4.0",
     "@types/debounce": "^1.2.1",
-    "@types/ws": "^8.5.4",
-    "eslint": "^8.36.0",
-    "nuxt": "3.6.5",
-    "vitest": "^0.30.0"
+    "@types/ws": "^8.5.10"
   },
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=16.0.0"
   }
-}
+}