feat: init commit

Author: ComfortablyCoding

.editorconfig

@@ -0,0 +1,7 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = false
+indent_style = tab
+indent_size = 2

.eslintrc.js

@@ -0,0 +1,20 @@
+module.exports = {
+	$schema: 'https://json.schemastore.org/eslintrc',
+	env: {
+		es6: true,
+		node: true,
+	},
+	parserOptions: {
+		ecmaVersion: 2018,
+	},
+	rules: {
+		indent: ['error', 'tab'],
+		'linebreak-style': ['error', 'unix'],
+		quotes: ['error', 'single'],
+		semi: ['error', 'always'],
+	},
+	globals: {
+		strapi: 'readonly',
+	},
+	extends: ['eslint:recommended', 'plugin:node/recommended', 'prettier'],
+};

.gitattributes

@@ -0,0 +1,99 @@
+# From https://github.com/Danimoth/gitattributes/blob/master/Web.gitattributes
+
+# Handle line endings automatically for files detected as text
+# and leave all files detected as binary untouched.
+* text=auto
+
+#
+# The above will handle all files NOT found below
+#
+
+#
+## These files are text and should be normalized (Convert crlf => lf)
+#
+
+# source code
+*.php text
+*.css text
+*.sass text
+*.scss text
+*.less text
+*.styl text
+*.js text eol=lf
+*.coffee text
+*.json text
+*.htm text
+*.html text
+*.xml text
+*.svg text
+*.txt text
+*.ini text
+*.inc text
+*.pl text
+*.rb text
+*.py text
+*.scm text
+*.sql text
+*.sh text
+*.bat text
+
+# templates
+*.ejs text
+*.hbt text
+*.jade text
+*.haml text
+*.hbs text
+*.dot text
+*.tmpl text
+*.phtml text
+
+# git config
+.gitattributes text
+.gitignore text
+.gitconfig text
+
+# code analysis config
+.jshintrc text
+.jscsrc text
+.jshintignore text
+.csslintrc text
+
+# misc config
+*.yaml text
+*.yml text
+.editorconfig text
+
+# build config
+*.npmignore text
+*.bowerrc text
+
+# Documentation
+*.md text
+LICENSE text
+AUTHORS text
+
+
+#
+## These files are binary and should be left untouched
+#
+
+# (binary is a macro for -text -diff)
+*.png binary
+*.jpg binary
+*.jpeg binary
+*.gif binary
+*.ico binary
+*.mov binary
+*.mp4 binary
+*.mp3 binary
+*.flv binary
+*.fla binary
+*.swf binary
+*.gz binary
+*.zip binary
+*.7z binary
+*.ttf binary
+*.eot binary
+*.woff binary
+*.pyc binary
+*.pdf binary

.github/workflows/npm-publish.yml

@@ -0,0 +1,31 @@
+# This workflow will publish a package to NPM when a release is created
+
+name: Publish to NPM
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout branch
+        uses: actions/checkout@v2
+
+      - name: Install Node v14
+        uses: actions/setup-node@v2
+        with:
+          node-version: '14.x'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install Yarn
+        run: npm install -g yarn
+
+      - name: Clean install deps
+        run: yarn install --frozen-lockfile
+
+      - name: Publish to NPM
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

.gitignore

@@ -0,0 +1,9 @@
+# Don't check auto-generated stuff into git
+coverage
+node_modules
+stats.json
+
+# Cruft
+.DS_Store
+npm-debug.log
+.idea

.npmignore

@@ -0,0 +1,23 @@
+# npm
+npm-debug.log
+
+# git
+.git
+.gitattributes
+
+# vscode
+.vscode
+
+# RC files
+.eslintrc.js
+.prettierrc.json
+
+# ignore files
+.prettierignore
+.gitignore
+
+# config files
+.editorconfig
+
+# github
+.github

.prettierignore

@@ -0,0 +1 @@
+package-lock.json

.prettierrc.json

@@ -0,0 +1,11 @@
+{
+	"$schema": "http://json.schemastore.org/prettierrc",
+	"trailingComma": "es5",
+	"tabWidth": 2,
+	"semi": true,
+	"singleQuote": true,
+	"useTabs": true,
+	"arrowParens": "always",
+	"endOfLine": "lf",
+	"printWidth": 100
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 @ComfortablyCoding
+
+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.

README.md

@@ -0,0 +1,116 @@
+# strapi-plugin-slugify
+
+A plugin for [Strapi](https://github.com/strapi/strapi) that provides the ability to auto slugify a field for any content type. It also provides a findOne by slug endpoint as a utility.
+
+## Requirements
+
+The installation requirements are the same as Strapi itself and can be found in the documentation on the [Quick Start](https://strapi.io/documentation/developer-docs/latest/getting-started/quick-start.html) page in the Prerequisites info card.
+
+### Supported Strapi versions
+
+- v4.x.x
+
+**NOTE**: While this plugin may work with the older Strapi versions, they are not supported, it is always recommended to use the latest version of Strapi.
+
+## Installation
+
+```sh
+npm install strapi-plugin-slugify
+```
+
+**or**
+
+```sh
+yarn add strapi-plugin-slugify
+```
+
+## Configuration
+
+The plugin configuration is stored in a config file located at `./config/plugins.js`.
+
+A sample configuration
+
+```javascript
+module.exports = ({ env }) => ({
+	slugify: {
+		enabled: true,
+		config: {
+			contentTypes: {
+				article: {
+					field: 'slug',
+					references: 'title',
+				},
+			},
+		},
+	},
+});
+```
+
+This will listen for any record created or updated in the article content type and set a slugified value for the slug field automatically based on the title field.
+
+**IMPORTANT NOTE**: Make sure any sensitive data is stored in env files.
+
+### The Complete Plugin Configuration Object
+
+| Property | Description | Type | Default | Required |
+| -------- | ----------- | ---- | ------- | -------- |
+| contentTypes | The Content Types to add auto slugification and search findOne by slug search utility to | Object | {} | No |
+| contentTypes[modelName] | The model name of the content type (it is the `singularName` in the [model schema](https://docs.strapi.io/developer-docs/latest/development/backend-customization/models.html#model-schema)) | String | N/A | Yes |
+| contentTypes[modelName]field | The name of the field to add the slug  | String | N/A | Yes |
+| contentTypes[modelName]references | The name of the field that is used to build the slug | String | N/A     | Yes |
+| slugifyOptions | The options to pass the the slugify function. All options can be found in the [slugify docs](https://github.com/sindresorhus/slugify#api) | Object | {} | No |
+
+## Usage
+
+Once the plugin has been installed, configured and enabled the configured content types will have the following additional functionality
+
+### Slugification
+
+Any time the respective content types have an entity created or updated the slug field defined in the settings will be auto generated based on the provided reference field.
+
+### Find One by Slug
+
+Hitting the `/api/slugify/slugs/:modelName/:slug` endpoint for any configured content types will return the entity type that matches the slug in the url.
+
+#### Additional Requirements
+
+Like all other created API endpoints the `findSlug` route must be allowed under `User & Permissions -> Roles -> Public/Authenticated` for the user to be able to access the route.
+
+#### Example Request
+
+Making the following request with the sample configuration will look as follows
+
+```js
+await fetch(`${API_URL}/api/slugify/slugs/article/lorem-ipsum-dolor`);
+// GET /api/slugify/slugs/article/lorem-ipsum-dolor
+```
+
+#### Example Response
+
+If an article with the slug of `lorem-ipsum-dolor` exists the reponse will look the same as a single entity response
+
+```json
+{
+	"data": {
+		"id": 1,
+		"title": "lorem ipsum dolor",
+		"slug": "lorem-ipsum-dolor",
+		"createdAt": "2022-02-17T01:49:31.961Z",
+		"updatedAt": "2022-02-17T03:47:09.950Z",
+		"publishedAt": null
+	}
+}
+```
+
+**IMPORTANT NOTE** To be inline with Strapi's default behaviour for single types if an article with the slug of `lorem-ipsum-dolor` does not exist a 404 error will be returned.
+
+```json
+{
+	"data": null,
+	"error": { "status": 404, "name": "NotFoundError", "message": "Not Found", "details": {} }
+}
+```
+
+## Bugs
+
+If any bugs are found please report them as a [Github Issue](https://github.com/ComfortablyCoding/strapi-plugin-slugify/issues)