sveltekit-data-plugin 1.0.0

package/README.md

@@ -0,0 +1,53 @@
+# Sveltekit Data Plugin
+
+Quite a mouthful. This tries to be a plugin for importing data easily, including the elephant in the room, images.
+
+This is designed to use with `@sveltejs/enhanced-img` and will turn your image assets into valid `Picture` objects to pass directly to your `<enhanced:img/>` components, from markdown files in a folder, generated by something like [Netlify CMS](https://decapcms.org/docs/intro/)
+
+## Install
+
+```
+npm install -D sveltekit-data-plugin
+```
+
+## Usage
+
+In your `vite.config.js` file
+
+```vite.config.js
+import SveltekitData from 'sveltekit-data-plugin';
+import { enhancedImages } from '@sveltejs/enhanced-img';
+
+export default defineConfig({
+	plugins: [
+		SveltekitData(enhancedImages()),
+  ]
+})
+```
+
+This is optional, but creating a data alias in `svelte.config.js` is also nice for this
+
+```svelte.config.js
+const config = {
+	kit: {
+		alias: {
+			$data: './src/data'
+		},
+	},
+};
+
+export default config;
+```
+
+Then you can import a markdown file in a `page.js`, or whatever, like
+
+```page.js
+/** @type {import('./$types').PageLoad} */
+export async function load() {
+	const d = await import('$data/home.md').then((mod) => mod.default);
+
+	return d;
+}
+```
+
+And you will get a front-matter parsed markdown file

package/dist/plugin.js

@@ -0,0 +1,109 @@
+(function(global, factory) {
+  typeof exports === "object" && typeof module !== "undefined" ? module.exports = factory(require("front-matter"), require("path"), require("fs/promises")) : typeof define === "function" && define.amd ? define(["front-matter", "path", "fs/promises"], factory) : (global = typeof globalThis !== "undefined" ? globalThis : global || self, global["Sveltekit Data Plugin"] = factory(global.fm, global.path, global.fs));
+})(this, function(fm, path, fs) {
+  "use strict";
+  function stampURL(src, base) {
+    return `${path.resolve(base, src)}?enhanced`;
+  }
+  function parseObject(str) {
+    const updated = str.replaceAll(/{(\n\s*)?/gm, '{"').replaceAll(":", '":').replaceAll(/,(\n\s*)?([^ ])/g, ',"$2');
+    try {
+      return JSON.parse(updated);
+    } catch {
+      throw new Error(`Failed parsing string to object: ${str}`);
+    }
+  }
+  async function convert(opts, obj, base, depth = 1) {
+    if (typeof obj !== "object") {
+      if (typeof obj === "string" && /^\S*(jpg|png|webp|avif|jpeg)$/.test(obj)) {
+        const img = await opts.imagetools_plugin.load.call(
+          opts.plugin_context,
+          stampURL(obj, base)
+        );
+        return parseObject(img.slice("export default".length, -1));
+      }
+      if (typeof obj === "string" && /^\S*(.md)$/.test(obj) && depth === 1) {
+        try {
+          const contents = await fs.readFile(path.resolve(base, obj), "utf-8");
+          const data = fm(contents);
+          const attributes = await convert(
+            opts,
+            data.attributes,
+            base,
+            depth + 1
+          );
+          return {
+            attributes: {
+              ...attributes,
+              id: path.basename(obj)
+            },
+            body: data.body
+          };
+        } catch {
+          return obj;
+        }
+      }
+      return obj;
+    }
+    const entries = await Promise.all(
+      Object.entries(obj).map(async ([key, value]) => {
+        if (Array.isArray(value)) {
+          const values = await Promise.all(
+            value.map((item) => convert(opts, item, base))
+          );
+          return [key, values];
+        }
+        const v = await convert(opts, value, base);
+        return [key, v];
+      })
+    );
+    return entries.reduce((dict, curr) => {
+      return {
+        ...dict,
+        [curr[0]]: curr[1]
+      };
+    }, {});
+  }
+  function importDataPlugin(imagetools_plugin, { base = "./src/data" } = {}) {
+    const opts = {
+      /** @type {import('rollup').PluginContext | null} */
+      plugin_context: null,
+      /** @type {import('vite').ResolvedConfig | null} */
+      vite_config: null,
+      imagetools_plugin,
+      base
+    };
+    return {
+      name: "import-data",
+      enforce: "pre",
+      configResolved(config) {
+        opts.vite_config = config;
+      },
+      buildStart() {
+        opts.plugin_context = this;
+      },
+      async transform(src, id) {
+        var _a;
+        if (/\.(md)$/.test(id)) {
+          const base2 = path.resolve(((_a = opts.vite_config) == null ? void 0 : _a.root) ?? "", opts.base);
+          const d = fm(src);
+          const attributes = await convert(opts, d.attributes, base2);
+          return `export default ${JSON.stringify({
+            attributes,
+            body: d.body
+          })}`;
+        }
+      }
+    };
+  }
+  function plugin(imagePlugins) {
+    const enhancedImagesPlugin = imagePlugins.find(
+      (item) => item.name === "imagetools"
+    );
+    if (!enhancedImagesPlugin) {
+      throw new Error("Cannot find enhanced image plugin");
+    }
+    return [importDataPlugin(enhancedImagesPlugin), ...imagePlugins];
+  }
+  return plugin;
+});

package/dist/plugin.mjs

@@ -0,0 +1,109 @@
+import fm from "front-matter";
+import path from "path";
+import fs from "fs/promises";
+function stampURL(src, base) {
+  return `${path.resolve(base, src)}?enhanced`;
+}
+function parseObject(str) {
+  const updated = str.replaceAll(/{(\n\s*)?/gm, '{"').replaceAll(":", '":').replaceAll(/,(\n\s*)?([^ ])/g, ',"$2');
+  try {
+    return JSON.parse(updated);
+  } catch {
+    throw new Error(`Failed parsing string to object: ${str}`);
+  }
+}
+async function convert(opts, obj, base, depth = 1) {
+  if (typeof obj !== "object") {
+    if (typeof obj === "string" && /^\S*(jpg|png|webp|avif|jpeg)$/.test(obj)) {
+      const img = await opts.imagetools_plugin.load.call(
+        opts.plugin_context,
+        stampURL(obj, base)
+      );
+      return parseObject(img.slice("export default".length, -1));
+    }
+    if (typeof obj === "string" && /^\S*(.md)$/.test(obj) && depth === 1) {
+      try {
+        const contents = await fs.readFile(path.resolve(base, obj), "utf-8");
+        const data = fm(contents);
+        const attributes = await convert(
+          opts,
+          data.attributes,
+          base,
+          depth + 1
+        );
+        return {
+          attributes: {
+            ...attributes,
+            id: path.basename(obj)
+          },
+          body: data.body
+        };
+      } catch {
+        return obj;
+      }
+    }
+    return obj;
+  }
+  const entries = await Promise.all(
+    Object.entries(obj).map(async ([key, value]) => {
+      if (Array.isArray(value)) {
+        const values = await Promise.all(
+          value.map((item) => convert(opts, item, base))
+        );
+        return [key, values];
+      }
+      const v = await convert(opts, value, base);
+      return [key, v];
+    })
+  );
+  return entries.reduce((dict, curr) => {
+    return {
+      ...dict,
+      [curr[0]]: curr[1]
+    };
+  }, {});
+}
+function importDataPlugin(imagetools_plugin, { base = "./src/data" } = {}) {
+  const opts = {
+    /** @type {import('rollup').PluginContext | null} */
+    plugin_context: null,
+    /** @type {import('vite').ResolvedConfig | null} */
+    vite_config: null,
+    imagetools_plugin,
+    base
+  };
+  return {
+    name: "import-data",
+    enforce: "pre",
+    configResolved(config) {
+      opts.vite_config = config;
+    },
+    buildStart() {
+      opts.plugin_context = this;
+    },
+    async transform(src, id) {
+      var _a;
+      if (/\.(md)$/.test(id)) {
+        const base2 = path.resolve(((_a = opts.vite_config) == null ? void 0 : _a.root) ?? "", opts.base);
+        const d = fm(src);
+        const attributes = await convert(opts, d.attributes, base2);
+        return `export default ${JSON.stringify({
+          attributes,
+          body: d.body
+        })}`;
+      }
+    }
+  };
+}
+function plugin(imagePlugins) {
+  const enhancedImagesPlugin = imagePlugins.find(
+    (item) => item.name === "imagetools"
+  );
+  if (!enhancedImagesPlugin) {
+    throw new Error("Cannot find enhanced image plugin");
+  }
+  return [importDataPlugin(enhancedImagesPlugin), ...imagePlugins];
+}
+export {
+  plugin as default
+};

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "sveltekit-data-plugin",
+  "version": "1.0.0",
+  "author": {
+    "name": "Jonny Thaw",
+    "url": "https://jthaw.me"
+  },
+  "devDependencies": {
+    "standard-version": "^9.5.0",
+    "vite": "^6.2.2"
+  },
+  "peerDependencies": {
+    "@sveltejs/enhanced-img": "^0.4.4"
+  },
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/plugin.js",
+  "module": "./dist/plugin.mjs",
+  "exports": {
+    ".": {
+      "import": "./dist/plugin.mjs",
+      "require": "./dist/plugin.js"
+    }
+  },
+  "scripts": {
+    "build": "vite build",
+    "release": "npm run build && standard-version && npm publish"
+  },
+  "dependencies": {
+    "front-matter": "^4.0.2"
+  }
+}