vite-plugin-decap-cms 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 [fullname]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,69 @@
+# vite-plugin-decap-cms
+
+> A Vite plugin to connect Decap CMS
+
+![NPM Version](https://img.shields.io/npm/v/vite-plugin-decap-cms)
+![NPM Downloads](https://img.shields.io/npm/dm/vite-plugin-decap-cms)
+![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/ghostrider-05/vite-plugin-decap-cms)
+
+
+> [!DANGER] Unstable version
+> This plugin has not reached a stable version, 1.0.0, and can include breaking changes following the semver specification. This plugin is open for contributions, both for code, suggestions and (missing) documentation.
+
+## Install
+
+```sh
+pnpm add vite-plugin-decap-cms -D
+npm install vite-plugin-decap-cms -D
+yarn add vite-plugin-decap-cms -D
+```
+
+## Usage
+
+```ts
+// vite.config.ts
+import { defineConfig } from 'vite'
+import decap, {
+    createFolderCollection,
+    createField,
+} from 'vite-plugin-decap-cms'
+
+export default defineConfig({
+    publicDir: 'public',
+    plugins: [
+        decap({
+            config: {
+                backend: {
+                    name: 'test-repo',
+                },
+                mediaFolder: '/src/public/',
+                collections: [
+                    createFolderCollection({
+                        name: 'test',
+                        label: 'Test collection',
+                        folder: 'test',
+                        fields: [
+                            createField('markdown', { name: 'body' }),
+                        ],
+                    }),
+                ]
+            }
+        })
+    ],
+})
+```
+
+## Example
+
+See [the documentation](https://vite-plugin-decap.pages.dev) for an example
+
+## Development
+
+```sh
+npm run docs:dev
+npm run cms:dev
+```
+
+## License
+
+[MIT](LICENSE)

package/dist/index.cjs

@@ -0,0 +1,446 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __defProps = Object.defineProperties;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+var __objRest = (source, exclude) => {
+  var target = {};
+  for (var prop in source)
+    if (__hasOwnProp.call(source, prop) && exclude.indexOf(prop) < 0)
+      target[prop] = source[prop];
+  if (source != null && __getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum.call(source, prop))
+        target[prop] = source[prop];
+    }
+  return target;
+};
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  VitePress: () => VitePress,
+  createField: () => createField,
+  createFile: () => createFile,
+  createFileCollection: () => createFileCollection,
+  createFolderCollection: () => createFolderCollection,
+  default: () => VitePluginDecapCMS,
+  getGitData: () => getGitData
+});
+module.exports = __toCommonJS(src_exports);
+var import_yaml = require("yaml");
+
+// src/util.ts
+var import_child_process = require("child_process");
+function getGitData() {
+  const executeGit = (command) => {
+    try {
+      return (0, import_child_process.execSync)(command).toString("utf8").replace(/[\n\r\s]+$/, "");
+    } catch (e) {
+    }
+  };
+  return {
+    get branch() {
+      return executeGit("git rev-parse --abbrev-ref HEAD");
+    },
+    get commitSha() {
+      return executeGit("git rev-parse HEAD");
+    }
+  };
+}
+function createField(widget, data) {
+  return __spreadProps(__spreadValues({}, data), {
+    widget
+  });
+}
+function createFolderCollection(data) {
+  return data;
+}
+function createFile(data) {
+  return data;
+}
+function createFileCollection(data) {
+  return data;
+}
+function createOverwriteableField(widget, data, overwrites) {
+  if (overwrites != void 0) {
+    const toAdd = (key) => {
+      if ((overwrites == null ? void 0 : overwrites[key]) != void 0 && data[key] !== overwrites[key])
+        data[key] = overwrites[key];
+    };
+    for (const key of Object.keys(overwrites)) {
+      if (key !== "hidden") {
+        toAdd(key);
+      }
+    }
+  }
+  if ((overwrites == null ? void 0 : overwrites.hidden) && widget !== "hidden")
+    return createField("hidden", data);
+  else
+    return __spreadProps(__spreadValues({}, data), {
+      widget
+    });
+}
+var VitePress = class {
+  /**
+   * Create fields for:
+   * - navbar
+   * - sidebar
+   * - aside
+   * - outline
+   * - lastUpdated
+   * - editLink
+   * - footer
+   * - pageClass
+   * 
+   * Does not create the default page fields, such as title and description. 
+   * @param options Options for overwriting field data
+   * @see https://vitepress.dev/reference/frontmatter-config#default-theme-only
+   */
+  static createDefaultThemeNormalPageFields(options) {
+    const { overwrites } = options != null ? options : {};
+    return [
+      createOverwriteableField("boolean", {
+        name: "navbar",
+        label: "Whether to display the navbar",
+        default: true,
+        required: false
+      }, overwrites == null ? void 0 : overwrites.navbar),
+      createOverwriteableField("boolean", {
+        name: "sidebar",
+        label: "Whether to display the sidebar",
+        default: true
+      }, overwrites == null ? void 0 : overwrites.sidebar),
+      // TODO: add aside 'left' option
+      createOverwriteableField("boolean", {
+        name: "aside",
+        label: "Whether to display the aside container",
+        default: true
+      }, overwrites == null ? void 0 : overwrites.aside),
+      // TODO: add support for [number, number] | 'deep' | false
+      createOverwriteableField("number", {
+        name: "outline",
+        label: "The header levels in the outline",
+        default: 2
+      }, overwrites == null ? void 0 : overwrites.outline),
+      // TODO: add support for Date 
+      createOverwriteableField("boolean", {
+        name: "lastUpdated",
+        label: "Whether to display last updated text",
+        default: true
+      }, overwrites == null ? void 0 : overwrites.lastUpdated),
+      createOverwriteableField("boolean", {
+        name: "editLink",
+        label: "Whether to display edit link text",
+        default: true
+      }, overwrites == null ? void 0 : overwrites.editLink),
+      createOverwriteableField("boolean", {
+        name: "footer",
+        label: "Whether to display footer text",
+        default: true
+      }, overwrites == null ? void 0 : overwrites.footer),
+      createOverwriteableField("string", {
+        name: "pageClass",
+        label: "Page class",
+        required: false
+      }, overwrites == null ? void 0 : overwrites.pageClass)
+    ];
+  }
+  /**
+   * Create fields for:
+   * - title
+   * - titleTemplate
+   * - description
+   * - head
+   * @param options.overwrites Overwrite data, such as labels, for the fields
+   * @see https://vitepress.dev/reference/frontmatter-config
+   */
+  static createDefaultPageFields(options) {
+    var _a;
+    const { additionalFields, overwrites } = options != null ? options : {};
+    const fields = [
+      createOverwriteableField("string", {
+        name: "title",
+        label: "Title"
+      }, overwrites == null ? void 0 : overwrites.title),
+      createOverwriteableField("string", {
+        name: "titleTemplate",
+        label: "Title template",
+        required: false
+      }, overwrites == null ? void 0 : overwrites.titleTemplate),
+      createOverwriteableField("text", {
+        name: "description",
+        label: "Description",
+        required: false
+      }, overwrites == null ? void 0 : overwrites.description),
+      createOverwriteableField("list", {
+        name: "head",
+        label: "Head"
+      }, overwrites == null ? void 0 : overwrites.head)
+    ];
+    return fields.concat(additionalFields != null ? additionalFields : []).concat(createOverwriteableField("markdown", __spreadProps(__spreadValues({}, (_a = options == null ? void 0 : options.markdownOptions) != null ? _a : {}), {
+      name: "body",
+      label: "Page content"
+    }), overwrites == null ? void 0 : overwrites.body));
+  }
+  static createDefaultPageFolderCollection(name, folder, options) {
+    const _a = options != null ? options : {}, { collection } = _a, fieldsOptions = __objRest(_a, ["collection"]);
+    const fields = this.createDefaultPageFields(fieldsOptions);
+    return createFolderCollection(__spreadProps(__spreadValues({
+      name,
+      label: name,
+      folder
+    }, collection != null ? collection : {}), {
+      fields
+    }));
+  }
+  static createDefaultPageFile(name, file, options) {
+    const _a = options != null ? options : {}, { collection } = _a, fieldsOptions = __objRest(_a, ["collection"]);
+    const fields = this.createDefaultPageFields(fieldsOptions);
+    return createFile(__spreadProps(__spreadValues({
+      name,
+      file,
+      label: name
+    }, collection != null ? collection : {}), {
+      fields
+    }));
+  }
+  static createDefaultPageFileCollection(name, files, options) {
+    var _a;
+    return createFileCollection(__spreadProps(__spreadValues({
+      name,
+      label: name
+    }, (_a = options == null ? void 0 : options.collection) != null ? _a : {}), {
+      files: files.map((params) => this.createDefaultPageFile(...params))
+    }));
+  }
+};
+
+// src/files/config.ts
+var objToSnakeCase = (obj) => {
+  const ignoredKeys = ["i18n"];
+  const camelToSnakeCase = (str) => str.replace(/[A-Z]/g, (letter) => `_${letter.toLowerCase()}`);
+  return Object.fromEntries(
+    Object.entries(obj).map(([k, v]) => [ignoredKeys.includes(k) ? k : camelToSnakeCase(k), v])
+  );
+};
+function getBooleanFromEnv(value, command) {
+  return value === "dev" ? command === "serve" : value === "prod" ? command === "build" : value != null ? value : false;
+}
+function resolveBackend(options, command) {
+  const _a = options, { local, name } = _a, backend = __objRest(_a, ["local", "name"]);
+  const branch = "useCurrentBranch" in options && getBooleanFromEnv(options.useCurrentBranch, command) ? getGitData().branch : "branch" in backend ? backend.branch : void 0;
+  delete backend.useCurrentBranch;
+  const resolved = {
+    local_backend: typeof local === "object" ? objToSnakeCase(local) : getBooleanFromEnv(local, command),
+    backend: __spreadProps(__spreadValues({}, objToSnakeCase(backend)), {
+      branch,
+      name
+    })
+  };
+  return resolved;
+}
+function createConfigFile(config, command) {
+  const _a = config, { backend, collections } = _a, options = __objRest(_a, ["backend", "collections"]);
+  return __spreadProps(__spreadValues(__spreadValues({}, resolveBackend(backend, command)), objToSnakeCase(options)), {
+    collections: collections.map((col) => {
+      if ("fields" in col) {
+        const _a2 = col, { fields } = _a2, data = __objRest(_a2, ["fields"]);
+        return __spreadProps(__spreadValues({}, objToSnakeCase(data)), {
+          fields: fields.map(objToSnakeCase)
+        });
+      } else if ("files" in col) {
+        const _b = col, { files } = _b, data = __objRest(_b, ["files"]);
+        return __spreadProps(__spreadValues({}, objToSnakeCase(data)), {
+          files: files.map((file) => {
+            const _a3 = file, { fields } = _a3, _data = __objRest(_a3, ["fields"]);
+            return __spreadProps(__spreadValues({}, objToSnakeCase(_data)), {
+              fields: fields.map(objToSnakeCase)
+            });
+          })
+        });
+      } else
+        throw new Error("Missing either fields or files property in collection");
+    })
+  });
+}
+
+// src/script.ts
+function createScript(options) {
+  const _a = options, {
+    useManualInitialization,
+    onGenerated: onGenerated,
+    onInitialized
+  } = _a, eventHooks = __objRest(_a, [
+    "useManualInitialization",
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    "onGenerated",
+    "onInitialized"
+  ]);
+  const events = Object.keys(eventHooks).map((hookName) => {
+    const hook = eventHooks[hookName];
+    if (!hook)
+      return null;
+    else {
+      const name = hookName.slice(2)[0].toLowerCase() + hookName.slice(3);
+      return `CMS.registerEventListener({ name: '${name}', handler: data => { function ${hook.toString()}; ${hookName}({ app: CMS, ...data }) } })`;
+    }
+  }).join("\n");
+  return `
+<script>
+${useManualInitialization ? "window.CMS_MANUAL_INIT = true;" : ""}
+${onInitialized != void 0 ? `window.onload = () => { function ${onInitialized.toString()}; onInitialized({ app: CMS }) }` : ""}
+${events}
+</script>`;
+}
+
+// src/files/index.ts
+function resolveCdnRoute(options) {
+  const getUrl = (host = "https://unpkg.com/", version = "3.1.3") => {
+    return `${host.endsWith("/") ? host : host + "/"}decap-cms@^${version}/dist/decap-cms.js`;
+  };
+  return typeof options === "boolean" ? options ? getUrl() : void 0 : typeof options === "string" ? options : options != void 0 ? getUrl(options.base, options.version) : void 0;
+}
+function getIndexFeatures(options) {
+  var _a, _b;
+  function useNetlifyIdentity(options2) {
+    return options2.config.backend.name === "git-gateway";
+  }
+  return {
+    cdn_route: resolveCdnRoute(options.load == void 0 || options.load.method === "cdn" ? (_b = (_a = options.load) == null ? void 0 : _a.options) != null ? _b : true : void 0),
+    custom_logo: "logoUrl" in options.config ? options.config.logoUrl != void 0 : "logo_url" in options.config ? options.config.logo_url != void 0 : false,
+    netlify_identity: useNetlifyIdentity(options),
+    config_route: options.config.dir ? options.config.dir + (!options.config.dir.endsWith("/") ? "/" : "") + "config.yml" : void 0
+  };
+}
+function createIndexFile(_options) {
+  var _a, _b;
+  const features = getIndexFeatures(_options);
+  const options = _options.login;
+  const identifyScript = '<script src="https://identity.netlify.com/v1/netlify-identity-widget.js"></script>';
+  return `<!DOCTYPE html>
+<html>
+    <head>
+        <meta charset="utf-8" />
+        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+        <meta name="robots" content="noindex" />
+        <title>${(_a = options == null ? void 0 : options.title) != null ? _a : "Content Manager"}</title>${features.netlify_identity ? identifyScript : ""}
+        ${features.config_route ? `<link href="${features.config_route}" type="text/yaml" rel="cms-config-url">` : ""}
+        ${((_b = options == null ? void 0 : options.head) != null ? _b : []).join("\n" + " ".repeat(8))}
+    </head>
+    <body>
+        ${features.cdn_route ? `<script src="${features.cdn_route}"></script>` : ""}
+        ${_options.script ? createScript(_options.script) : ""}
+    </body>
+</html>${features.custom_logo ? `
+
+<style>
+span[class*='CustomIconWrapper'] {
+    width: auto;
+}
+</style>` : ""}`;
+}
+
+// src/files.ts
+var import_promises = require("fs/promises");
+var import_path = require("path");
+function resolveDir(publicDir, dir) {
+  return dir ? (0, import_path.isAbsolute)(dir) ? dir : (0, import_path.resolve)(dir) : publicDir;
+}
+async function writeToFolder(folder, options) {
+  const dir = folder + (options.subfolder ? import_path.sep + options.subfolder : "");
+  await (0, import_promises.mkdir)(dir, { recursive: true });
+  for (const file of options.files.filter((f) => !f.skip)) {
+    await (0, import_promises.writeFile)(dir + import_path.sep + file.name, file.content, {
+      encoding: "utf-8"
+    });
+  }
+}
+
+// src/index.ts
+function validateLoadOptions(options) {
+  var _a;
+  const valid = ["npm", "cdn"].includes((_a = options == null ? void 0 : options.method) != null ? _a : "cdn");
+  if (!valid)
+    throw new Error("Invalid load options for decap-cms provided");
+}
+async function updateConfig(options, config) {
+  var _a, _b, _c, _d, _e, _f;
+  validateLoadOptions(options.load);
+  const loginFile = createIndexFile(options);
+  const configFile = createConfigFile(options.config, config.command);
+  await writeToFolder(
+    resolveDir(config.publicDir, options.dir),
+    {
+      subfolder: "admin",
+      files: [
+        { name: "index.html", content: loginFile },
+        { name: "config.yml", content: (0, import_yaml.stringify)(configFile, (_a = options.yml) == null ? void 0 : _a.replacer, (_b = options.yml) == null ? void 0 : _b.options) }
+        // { name: 'npm.js', content: createCustomScript(), skip: options.load?.method !== 'npm' },
+      ]
+    }
+  );
+  await ((_d = (_c = options.script) == null ? void 0 : _c.onConfigUpdated) == null ? void 0 : _d.call(_c));
+  if (config.command === "build") {
+    await ((_f = (_e = options.script) == null ? void 0 : _e.onGenerated) == null ? void 0 : _f.call(_e));
+  }
+}
+function VitePluginDecapCMS(options) {
+  let stored = null;
+  const debug = (...str) => {
+    if (options.debug)
+      console.debug(str);
+  };
+  return {
+    name: "vite-plugin-decap-cms",
+    async configResolved(config) {
+      const isUpdated = stored != null ? stored.command !== config.command || stored.publicDir !== config.publicDir : true;
+      if (isUpdated) {
+        await updateConfig(options, config);
+        stored = config;
+        debug("\nUpdated Decap CMS configuration");
+      } else {
+        debug("\nSkipped updating Decap CMS");
+      }
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  VitePress,
+  createField,
+  createFile,
+  createFileCollection,
+  createFolderCollection,
+  getGitData
+});