Initial commit

Author: KaneFreeman

.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": [["babel-preset-gatsby-package", { "browser": true }]]
+}

.gitignore

@@ -0,0 +1 @@
+/*.js

.npmignore

@@ -0,0 +1,34 @@
+# Logs
+logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
+node_modules
+*.un~
+yarn.lock
+src
+flow-typed
+coverage
+decls
+examples

CHANGELOG.md

@@ -0,0 +1 @@
+# Changelog: `gatsby-plugin-static-cms`

README.md

@@ -0,0 +1,255 @@
+# gatsby-plugin-static-cms
+
+## Overview
+
+Automatically generates an `admin/index.html` with a default Static CMS implementation.
+
+Static CMS is a React single page app for editing git based content via API.
+Its built for non-technical and technical editors alike, and its super easy to
+install and configure. For more details, check out the [docs
+site](https://staticjscms.netlify.app).
+
+## Install
+
+```shell
+npm install @staticcms/core gatsby-plugin-static-cms
+```
+
+## How to use
+
+Add the Static CMS plugin in your `gatsby-config.js`:
+
+```javascript
+plugins: [`gatsby-plugin-static-cms`]
+```
+
+Then add your Static CMS [configuration
+file](https://staticjscms.netlify.app/docs/add-to-your-site-cdn#configuration) in
+`static/admin/config.yml`.
+
+## Options
+
+Static CMS can be configured via the plugin options below. You can learn
+about how to pass options to plugins in the [Gatsby
+docs](https://www.gatsbyjs.com/docs/plugins/#how-to-use-gatsby-plugins).
+
+### `modulePath`
+
+(_optional_, type: `string | Array<string>`, default: `undefined`)
+
+If you need to customize Static CMS, e.g. registering [custom
+widgets](https://staticjscms.netlify.app/docs/custom-widgets/#registerwidget) or
+styling the [preview
+pane](https://staticjscms.netlify.app/docs/customization/#registerpreviewstyle),
+you'll need to do so in a JavaScript module and provide Gatsby with the path to
+your module via the `modulePath` option. Any styles imported by this module (or
+by the modules that it imports, all the way down the chain) are automatically
+applied to the editor preview pane by the plugin.
+
+```javascript
+plugins: [
+  {
+    resolve: `gatsby-plugin-static-cms`,
+    options: {
+      /**
+       * One convention is to place your Static CMS customization code in a
+       * `src/cms` directory.
+       */
+      modulePath: `${__dirname}/src/cms/cms.js`,
+    },
+  },
+]
+```
+
+The js module might look like this:
+
+```javascript
+/**
+ * The default export of `@staticcms/core` is an object with all of the Static CMS
+ * extension registration methods, such as `registerWidget` and
+ * `registerPreviewTemplate`.
+ */
+import CMS from "@staticcms/core"
+
+/**
+ * Any imported styles should be automatically be applied to the editor preview
+ * pane thus eliminating the need to use `registerPreviewStyle` for imported
+ * styles. However if you are experiencing build errors regarding importing css,
+ * sass or scss into a cms module when deploying to the netlify platform, you
+ * may need to follow the implementation found in netlify documentation here:
+ * https://staticjscms.netlify.app/docs/beta-features/#raw-css-in-registerpreviewstyle
+ * All of the example imports below would result in styles being applied to the
+ * preview pane.
+ */
+import "module-that-imports-styles.js"
+import "styles.scss"
+import "../other-styles.css"
+
+/**
+ * Let's say you've created widget and preview components for a custom image
+ * gallery widget in separate files:
+ */
+import ImageGalleryWidget from "./image-gallery-widget.js"
+import ImageGalleryPreview from "./image-gallery-preview.js"
+
+/**
+ * Register the imported widget:
+ */
+CMS.registerWidget(`image-gallery`, ImageGalleryWidget, ImageGalleryPreview)
+```
+
+### `manualInit`
+
+(_optional_, type: `boolean`, default: `false`)
+
+Set this to `true` If you need to [manually initialize](https://staticjscms.netlify.app/docs/beta-features/#manual-initialization) Static CMS. The plugin will take care of setting `window.CMS_MANUAL_INIT` to `true`:
+
+```javascript
+plugins: [
+  {
+    resolve: `gatsby-plugin-static-cms`,
+    options: {
+      manualInit: true,
+    },
+  },
+]
+```
+
+The js module might look like this:
+
+```javascript
+import CMS from "@staticcms/core"
+
+/**
+ * Optionally pass in a config object. This object will be merged into `config.yml` if it exists
+ */
+
+CMS.init({
+  config: {
+    backend: {
+      name: "git-gateway",
+    },
+  },
+})
+```
+
+### `enableIdentityWidget`
+
+(_optional_, type: `boolean`, default: `true`)
+
+`enableIdentityWidget` is `true` by default, allowing [Netlify
+Identity](https://www.netlify.com/docs/identity/) to be used without
+configuration. Disable it when not using Netlify Identity to reduce bundle size.
+
+```javascript
+plugins: [
+  {
+    resolve: `gatsby-plugin-static-cms`,
+    options: {
+      enableIdentityWidget: true,
+    },
+  },
+]
+```
+
+### `publicPath`
+
+(_optional_, type: `string`, default: `"admin"`)
+
+Customize the path to Static CMS on your Gatsby site.
+
+### `htmlTitle`
+
+(_optional_, type: `string`, default: `Content Manager`)
+
+Customize the value of the `title` tag in your CMS HTML (shows in the browser
+bar).
+
+### `htmlFavicon`
+
+(_optional_, type: `string`, default: `""`)
+
+Customize the value of the `favicon` tag in your CMS HTML (shows in the browser
+bar).
+
+### `includeRobots`
+
+(_optional_, type: `boolean`, default: `false`)
+
+By default, the CMS page is not indexed by crawlers. Use this to add a `meta` tag to invite robots to index the CMS page.
+
+### `customizeWebpackConfig`
+
+(_optional_, type: `function`)
+
+Function to customize webpack configuration.
+
+Function parameters:
+
+- config: webpack configuration for StaticCMS
+- destructured object from onCreateWebpackConfig { store, stage, pathPrefix, getConfig, rules, loaders, plugins} as seen in https://www.gatsbyjs.com/docs/node-apis/#onCreateWebpackConfig
+
+```javascript
+plugins: [
+  {
+    resolve: `gatsby-plugin-static-cms`,
+    options: {
+      customizeWebpackConfig: (config, { plugins }) => {
+        const Plugin = require("...")
+
+        config.plugins.push(
+          plugins.define({
+            "process.env.MY_VAR": JSON.stringify("my var value"),
+          })
+        )
+
+        config.plugins.push(new Plugin())
+      },
+    },
+  },
+]
+```
+
+## Example
+
+Here is the plugin with example values for all options (note that no option is
+required):
+
+```javascript
+plugins: [
+  {
+    resolve: `gatsby-plugin-static-cms`,
+    options: {
+      modulePath: `path/to/custom/script.js`, // default: undefined
+      enableIdentityWidget: true,
+      publicPath: `admin`,
+      htmlTitle: `Content Manager`,
+      htmlFavicon: `path/to/favicon`,
+      includeRobots: false,
+    },
+  },
+]
+```
+
+## Disable widget on site
+
+If you're not using Netlify Identity within your site you have the option to completely disable the widget (and not the CMS). To do so, add the following to `gatsby-node.js`:
+
+```javascript
+const webpack = require(`webpack`)
+
+exports.onCreateWebpackConfig = ({ actions }) => {
+  actions.setWebpackConfig({
+    plugins: [
+      new webpack.IgnorePlugin({
+        resourceRegExp: /^netlify-identity-widget$/,
+      }),
+    ],
+  })
+}
+```
+
+## Support
+
+For help with integrating Static CMS with Gatsby, check out the community
+[Slack](https://staticjscms.netlify.app/chat).

package.json

@@ -0,0 +1,58 @@
+{
+  "name": "gatsby-plugin-static-cms",
+  "description": "A Gatsby plugin which generates the Static CMS single page app",
+  "version": "1.0.0",
+  "author": "Shawn Erquhart <[email protected]>",
+  "bugs": {
+    "url": "https://github.com/gatsbyjs/gatsby/issues"
+  },
+  "dependencies": {
+    "@babel/runtime": "^7.15.4",
+    "@soda/friendly-errors-webpack-plugin": "1.8.1",
+    "copy-webpack-plugin": "^7.0.0",
+    "html-webpack-plugin": "^5.3.2",
+    "html-webpack-skip-assets-plugin": "^1.0.3",
+    "html-webpack-tags-plugin": "^3.0.2",
+    "lodash": "^4.17.21",
+    "mini-css-extract-plugin": "1.6.2",
+    "netlify-identity-widget": "^1.9.2"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.15.4",
+    "@babel/core": "^7.15.5",
+    "babel-preset-gatsby-package": "^3.0.0-next.1",
+    "cross-env": "^7.0.3",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "homepage": "https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-plugin-static-cms#readme",
+  "keywords": [
+    "gatsby",
+    "gatsby-plugin",
+    "netlify",
+    "static-cms",
+    "cms"
+  ],
+  "license": "MIT",
+  "main": "index.js",
+  "peerDependencies": {
+    "gatsby": "^5.0.0-alpha-v5",
+    "@staticcms/core": "next",
+    "react": "^18.0.0 || ^0.0.0",
+    "react-dom": "^18.0.0 || ^0.0.0",
+    "webpack": "^5.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gatsbyjs/gatsby.git",
+    "directory": "packages/gatsby-plugin-static-cms"
+  },
+  "scripts": {
+    "build": "babel src --out-dir . --ignore \"**/__tests__\"",
+    "prepare": "cross-env NODE_ENV=production npm run build",
+    "watch": "babel -w src --out-dir . --ignore \"**/__tests__\""
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}

src/cms-identity.js

@@ -0,0 +1,25 @@
+/* global CMS_PUBLIC_PATH */
+import netlifyIdentityWidget from "netlify-identity-widget"
+
+window.netlifyIdentity = netlifyIdentityWidget
+
+const addLoginListener = () =>
+  netlifyIdentityWidget.on(`login`, () => {
+    document.location.href = `${__PATH_PREFIX__}/${CMS_PUBLIC_PATH}/`
+  })
+
+netlifyIdentityWidget.on(`init`, user => {
+  if (!user) {
+    addLoginListener()
+  } else {
+    netlifyIdentityWidget.on(`logout`, () => {
+      addLoginListener()
+    })
+  }
+})
+
+// Boot on next tick to prevent clashes with css injected into StaticCMS
+// preview pane.
+setImmediate(() => {
+  netlifyIdentityWidget.init()
+})