tabshift/payloadcms
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

feat: revert enforce kebab-case slugs (#1322) (#1325)

Browse Source
This commit is contained in:
Elliot DeNolf
2022-10-31 16:10:11 -04:00
committed by GitHub
parent e2ec2f7b97
commit 2255ebb64a
9 changed files with 11 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/authentication/overview.mdx
View File

@@ -36,7 +36,7 @@ Simple example collection:
import { CollectionConfig } from 'payload/types';
const Admins: CollectionConfig = {
slug: 'admins',
slug:
// highlight-start
auth: {
tokenExpiration: 7200, // How many seconds to keep the user logged in

2
docs/configuration/collections.mdx
View File

@@ -14,7 +14,7 @@ It's often best practice to write your Collections in separate files and then im
| Option | Description |
| ---------------- | -------------|
| **`slug`** * | Unique, URL-friendly string that will act as an identifier for this Collection. Must be kebab-case. |
| **`slug`** * | Unique, URL-friendly string that will act as an identifier for this Collection. |
| **`fields`** * | Array of field types that will determine the structure and functionality of the data stored within this Collection. [Click here](/docs/fields/overview) for a full list of field types as well as how to configure them. |
| **`labels`** | Singular and plural labels for use in identifying this Collection throughout Payload. Auto-generated from slug if not defined. |
| **`admin`** | Admin-specific configuration. See below for [more detail](#admin-options). |

2
docs/configuration/globals.mdx
View File

@@ -14,7 +14,7 @@ As with Collection configs, it's often best practice to write your Globals in se
| Option | Description |
| ---------------- | -------------|
| **`slug`** * | Unique, URL-friendly string that will act as an identifier for this Global. Must be kebab-case. |
| **`slug`** * | Unique, URL-friendly string that will act as an identifier for this Global. |
| **`fields`** * | Array of field types that will determine the structure and functionality of the data stored within this Global. [Click here](/docs/fields/overview) for a full list of field types as well as how to configure them. |
| **`label`** | Singular label for use in identifying this Global throughout Payload. Auto-generated from slug if not defined. |
| **`description`**| Text or React component to display below the Global header to give editors more information. |

4
docs/rest-api/overview.mdx
View File

@@ -64,8 +64,8 @@ Globals cannot be created or deleted, so there are only two REST endpoints opene
| Method | Path | Description |
| -------- | --------------------------- | ----------------------- |
| `GET` | `/api/globals/{global-slug}` | Get a global by slug |
| `POST` | `/api/globals/{global-slug}` | Update a global by slug |
| `GET` | `/api/globals/{globalSlug}` | Get a global by slug |
| `POST` | `/api/globals/{globalSlug}` | Update a global by slug |
## Preferences

12
docs/versions/overview.mdx
View File

@@ -101,9 +101,9 @@ Versions expose new operations for both collections and globals. They allow you
| Method | Path | Description |
| -------- | ------------------------------------ | -------------------------------------- |
| `GET` | `/api/{collection-slug}/versions` | Find and query paginated versions |
| `GET` | `/api/{collection-slug}/versions/:id` | Find a specific version by ID |
| `POST` | `/api/{collection-slug}/versions/:id` | Restore a version by ID |
| `GET` | `/api/{collectionSlug}/versions` | Find and query paginated versions |
| `GET` | `/api/{collectionSlug}/versions/:id` | Find a specific version by ID |
| `POST` | `/api/{collectionSlug}/versions/:id` | Restore a version by ID |
**Collection GraphQL queries:**
@@ -174,9 +174,9 @@ const result = await payload.restoreVersion({
| Method | Path | Description |
| -------- | ---------------------------------------- | -------------------------------------- |
| `GET` | `/api/globals/{global-slug}/versions` | Find and query paginated versions |
| `GET` | `/api/globals/{global-slug}/versions/:id` | Find a specific version by ID |
| `POST` | `/api/globals/{global-slug}/versions/:id` | Restore a version by ID |
| `GET` | `/api/globals/{globalSlug}/versions` | Find and query paginated versions |
| `GET` | `/api/globals/{globalSlug}/versions/:id` | Find a specific version by ID |
| `POST` | `/api/globals/{globalSlug}/versions/:id` | Restore a version by ID |
**Global GraphQL queries:**

10
src/collections/config/sanitize.ts
View File

@@ -15,7 +15,6 @@ import { versionCollectionDefaults } from '../../versions/defaults';
import baseVersionFields from '../../versions/baseFields';
import TimestampsRequired from '../../errors/TimestampsRequired';
import mergeBaseFields from '../../fields/mergeBaseFields';
import Logger from '../../utilities/logger';
const sanitizeCollection = (config: Config, collection: CollectionConfig): SanitizedCollectionConfig => {
// /////////////////////////////////
@@ -26,15 +25,6 @@ const sanitizeCollection = (config: Config, collection: CollectionConfig): Sanit
isMergeableObject: isPlainObject,
});
const logger = Logger();
// Pre-validate slug to enforce kebab-case
if (!sanitized.slug.match(new RegExp('^([a-z][a-z0-9]*)(-[a-z0-9]+)*$'))) {
logger.error(`Collection slug "${sanitized.slug}" should be kebab-case.`);
process.exit(1);
}
// Normalize slug and labels to kebab-case
sanitized.slug = toKebabCase(sanitized.slug);
sanitized.labels = sanitized.labels || formatLabels(sanitized.slug);

3
src/collections/config/types.ts
View File

@@ -204,9 +204,6 @@ export type CollectionAdminOptions = {
}
export type CollectionConfig = {
/**
* Name of the collection in kebab-case
*/
slug: string;
/**
* Label configuration

9
src/globals/config/sanitize.ts
View File

@@ -7,20 +7,11 @@ import defaultAccess from '../../auth/defaultAccess';
import baseVersionFields from '../../versions/baseFields';
import mergeBaseFields from '../../fields/mergeBaseFields';
import { versionGlobalDefaults } from '../../versions/defaults';
import Logger from '../../utilities/logger';
const sanitizeGlobals = (collections: CollectionConfig[], globals: GlobalConfig[]): SanitizedGlobalConfig[] => {
const sanitizedGlobals = globals.map((global) => {
const sanitizedGlobal = { ...global };
const logger = Logger();
// Pre-validate slug to enforce kebab-case
if (!sanitizedGlobal.slug.match(new RegExp('^([a-z][a-z0-9]*)(-[a-z0-9]+)*$'))) {
logger.error(`Global slug "${sanitizedGlobal.slug}" should be kebab-case.`);
process.exit(1);
}
sanitizedGlobal.label = sanitizedGlobal.label || toWords(sanitizedGlobal.slug);
// /////////////////////////////////

3
src/globals/config/types.ts
View File

@@ -45,9 +45,6 @@ export interface GlobalModel extends Model<Document> {
}
export type GlobalConfig = {
/**
* Name of the global in kebab-case
*/
slug: string
label?: string
preview?: GeneratePreviewURL