@nixxie-cms/fields-slug 1.0.1

package/LICENSE

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2026 Nixxie International DMCC
+Portions Copyright (c) 2023 Thinkmill Labs Pty Ltd and contributors
+(this software is derived from the KeystoneJS project, https://keystonejs.com)
+
+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,13 @@
+# @nixxie-cms/fields-slug
+
+A URL-slug field for Nixxie CMS. Stores a normalised, lowercased, hyphenated string and is unique
+by default. When no value is supplied it derives one from another field (default `title`).
+
+```ts
+import { slug } from '@nixxie-cms/fields-slug'
+
+fields: {
+  title: text(),
+  slug: slug({ from: 'title' }),
+}
+```

package/dist/declarations/src/index.d.ts

@@ -0,0 +1,17 @@
+import type { TextFieldConfig } from '@nixxie-cms/core/fields';
+import type { BaseListTypeInfo, FieldTypeFunc } from '@nixxie-cms/core/types';
+/** Lightweight, dependency-free slugifier. */
+export declare function slugify(input: string): string;
+export type SlugFieldConfig<ListTypeInfo extends BaseListTypeInfo> = Omit<TextFieldConfig<ListTypeInfo>, 'isIndexed'> & {
+    /** Source field to derive the slug from when none is provided. Default: 'title' */
+    from?: string;
+    /** Indexing — slugs are unique by default. */
+    isIndexed?: boolean | 'unique';
+};
+/**
+ * A URL slug field. Stores a normalised, lowercased, hyphenated string. When no value is supplied
+ * it is derived from the `from` field (default `title`). Built on top of the core `text` field, so
+ * it uses the standard text Admin UI.
+ */
+export declare function slug<ListTypeInfo extends BaseListTypeInfo>(config?: SlugFieldConfig<ListTypeInfo>): FieldTypeFunc<ListTypeInfo>;
+//# sourceMappingURL=index.d.ts.map

package/dist/declarations/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"../../../src","sources":["index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,KAAK,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAE7E,8CAA8C;AAC9C,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAS7C;AAED,MAAM,MAAM,eAAe,CAAC,YAAY,SAAS,gBAAgB,IAAI,IAAI,CACvE,eAAe,CAAC,YAAY,CAAC,EAC7B,WAAW,CACZ,GAAG;IACF,mFAAmF;IACnF,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,8CAA8C;IAC9C,SAAS,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAA;CAC/B,CAAA;AAED;;;;GAIG;AACH,wBAAgB,IAAI,CAAC,YAAY,SAAS,gBAAgB,EACxD,MAAM,GAAE,eAAe,CAAC,YAAY,CAAM,GACzC,aAAa,CAAC,YAAY,CAAC,CAsC7B"}

package/dist/nixxie-cms-fields-slug.cjs.d.ts

@@ -0,0 +1,2 @@
+export * from "./declarations/src/index.js";
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibml4eGllLWNtcy1maWVsZHMtc2x1Zy5janMuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4vZGVjbGFyYXRpb25zL3NyYy9pbmRleC5kLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBIn0=

package/dist/nixxie-cms-fields-slug.cjs.js

@@ -0,0 +1,65 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var fields = require('@nixxie-cms/core/fields');
+
+/** Lightweight, dependency-free slugifier. */
+function slugify(input) {
+  return input.toString().normalize('NFKD').replace(/[\u0300-\u036f]/g, '').toLowerCase().trim().replace(/[^a-z0-9]+/g, '-').replace(/^-+|-+$/g, '');
+}
+/**
+ * A URL slug field. Stores a normalised, lowercased, hyphenated string. When no value is supplied
+ * it is derived from the `from` field (default `title`). Built on top of the core `text` field, so
+ * it uses the standard text Admin UI.
+ */
+function slug(config = {}) {
+  const {
+    from = 'title',
+    isIndexed = 'unique',
+    hooks,
+    ...rest
+  } = config;
+  const userValidate = hooks === null || hooks === void 0 ? void 0 : hooks.validate;
+  return fields.text({
+    ...rest,
+    isIndexed,
+    hooks: {
+      ...hooks,
+      resolveInput: args => {
+        var _resolvedData$from;
+        const {
+          resolvedData,
+          item,
+          fieldKey
+        } = args;
+        const provided = resolvedData[fieldKey];
+        if (typeof provided === 'string' && provided.length > 0) return slugify(provided);
+        const source = (_resolvedData$from = resolvedData[from]) !== null && _resolvedData$from !== void 0 ? _resolvedData$from : item === null || item === void 0 ? void 0 : item[from];
+        if (typeof source === 'string' && source.length > 0) return slugify(source);
+        return provided;
+      },
+      validate: async args => {
+        var _userValidate;
+        // Preserve any user-supplied validate hook (function or { create, update, delete } form).
+        if (typeof userValidate === 'function') await userValidate(args);else await (userValidate === null || userValidate === void 0 || (_userValidate = userValidate[args.operation]) === null || _userValidate === void 0 ? void 0 : _userValidate.call(userValidate, args));
+        const {
+          resolvedData,
+          fieldKey,
+          addValidationError,
+          operation
+        } = args;
+        if (operation === 'delete') return;
+        // slugify() yields '' for input with no [a-z0-9] characters (e.g. non-Latin scripts). An
+        // empty slug would either silently store blank or, with the default unique index, surface a
+        // raw DB constraint error on the second one — give a clear validation message instead.
+        if (resolvedData[fieldKey] === '') {
+          addValidationError(`${fieldKey} could not be generated — provide a value containing letters or numbers`);
+        }
+      }
+    }
+  });
+}
+
+exports.slug = slug;
+exports.slugify = slugify;

package/dist/nixxie-cms-fields-slug.esm.js

@@ -0,0 +1,60 @@
+import { text } from '@nixxie-cms/core/fields';
+
+/** Lightweight, dependency-free slugifier. */
+function slugify(input) {
+  return input.toString().normalize('NFKD').replace(/[\u0300-\u036f]/g, '').toLowerCase().trim().replace(/[^a-z0-9]+/g, '-').replace(/^-+|-+$/g, '');
+}
+/**
+ * A URL slug field. Stores a normalised, lowercased, hyphenated string. When no value is supplied
+ * it is derived from the `from` field (default `title`). Built on top of the core `text` field, so
+ * it uses the standard text Admin UI.
+ */
+function slug(config = {}) {
+  const {
+    from = 'title',
+    isIndexed = 'unique',
+    hooks,
+    ...rest
+  } = config;
+  const userValidate = hooks === null || hooks === void 0 ? void 0 : hooks.validate;
+  return text({
+    ...rest,
+    isIndexed,
+    hooks: {
+      ...hooks,
+      resolveInput: args => {
+        var _resolvedData$from;
+        const {
+          resolvedData,
+          item,
+          fieldKey
+        } = args;
+        const provided = resolvedData[fieldKey];
+        if (typeof provided === 'string' && provided.length > 0) return slugify(provided);
+        const source = (_resolvedData$from = resolvedData[from]) !== null && _resolvedData$from !== void 0 ? _resolvedData$from : item === null || item === void 0 ? void 0 : item[from];
+        if (typeof source === 'string' && source.length > 0) return slugify(source);
+        return provided;
+      },
+      validate: async args => {
+        var _userValidate;
+        // Preserve any user-supplied validate hook (function or { create, update, delete } form).
+        if (typeof userValidate === 'function') await userValidate(args);else await (userValidate === null || userValidate === void 0 || (_userValidate = userValidate[args.operation]) === null || _userValidate === void 0 ? void 0 : _userValidate.call(userValidate, args));
+        const {
+          resolvedData,
+          fieldKey,
+          addValidationError,
+          operation
+        } = args;
+        if (operation === 'delete') return;
+        // slugify() yields '' for input with no [a-z0-9] characters (e.g. non-Latin scripts). An
+        // empty slug would either silently store blank or, with the default unique index, surface a
+        // raw DB constraint error on the second one — give a clear validation message instead.
+        if (resolvedData[fieldKey] === '') {
+          addValidationError(`${fieldKey} could not be generated — provide a value containing letters or numbers`);
+        }
+      }
+    }
+  });
+}
+
+export { slug, slugify };

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@nixxie-cms/fields-slug",
+  "version": "1.0.1",
+  "license": "MIT",
+  "main": "dist/nixxie-cms-fields-slug.cjs.js",
+  "module": "dist/nixxie-cms-fields-slug.esm.js",
+  "exports": {
+    ".": {
+      "types": "./dist/nixxie-cms-fields-slug.cjs.js",
+      "module": "./dist/nixxie-cms-fields-slug.esm.js",
+      "default": "./dist/nixxie-cms-fields-slug.cjs.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@babel/runtime": "^7.24.7"
+  },
+  "devDependencies": {
+    "@nixxie-cms/core": "^1.0.1"
+  },
+  "peerDependencies": {
+    "@nixxie-cms/core": "^1.0.1"
+  },
+  "preconstruct": {
+    "entrypoints": [
+      "index.ts"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/nixxiecms/nixxie/tree/main/packages/fields-slug"
+  }
+}

package/src/index.ts

@@ -0,0 +1,72 @@
+import { text } from '@nixxie-cms/core/fields'
+import type { TextFieldConfig } from '@nixxie-cms/core/fields'
+import type { BaseListTypeInfo, FieldTypeFunc } from '@nixxie-cms/core/types'
+
+/** Lightweight, dependency-free slugifier. */
+export function slugify(input: string): string {
+  return input
+    .toString()
+    .normalize('NFKD')
+    .replace(/[\u0300-\u036f]/g, '')
+    .toLowerCase()
+    .trim()
+    .replace(/[^a-z0-9]+/g, '-')
+    .replace(/^-+|-+$/g, '')
+}
+
+export type SlugFieldConfig<ListTypeInfo extends BaseListTypeInfo> = Omit<
+  TextFieldConfig<ListTypeInfo>,
+  'isIndexed'
+> & {
+  /** Source field to derive the slug from when none is provided. Default: 'title' */
+  from?: string
+  /** Indexing — slugs are unique by default. */
+  isIndexed?: boolean | 'unique'
+}
+
+/**
+ * A URL slug field. Stores a normalised, lowercased, hyphenated string. When no value is supplied
+ * it is derived from the `from` field (default `title`). Built on top of the core `text` field, so
+ * it uses the standard text Admin UI.
+ */
+export function slug<ListTypeInfo extends BaseListTypeInfo>(
+  config: SlugFieldConfig<ListTypeInfo> = {}
+): FieldTypeFunc<ListTypeInfo> {
+  const { from = 'title', isIndexed = 'unique', hooks, ...rest } = config
+  const userValidate = hooks?.validate as
+    | ((args: any) => unknown)
+    | { create?: (args: any) => unknown; update?: (args: any) => unknown; delete?: (args: any) => unknown }
+    | undefined
+
+  return text<ListTypeInfo>({
+    ...(rest as TextFieldConfig<ListTypeInfo>),
+    isIndexed,
+    hooks: {
+      ...hooks,
+      resolveInput: (args: any) => {
+        const { resolvedData, item, fieldKey } = args
+        const provided = resolvedData[fieldKey]
+        if (typeof provided === 'string' && provided.length > 0) return slugify(provided)
+        const source = resolvedData[from] ?? item?.[from]
+        if (typeof source === 'string' && source.length > 0) return slugify(source)
+        return provided
+      },
+      validate: async (args: any) => {
+        // Preserve any user-supplied validate hook (function or { create, update, delete } form).
+        if (typeof userValidate === 'function') await userValidate(args)
+        else await userValidate?.[args.operation as 'create' | 'update' | 'delete']?.(args)
+
+        const { resolvedData, fieldKey, addValidationError, operation } = args
+        if (operation === 'delete') return
+        // slugify() yields '' for input with no [a-z0-9] characters (e.g. non-Latin scripts). An
+        // empty slug would either silently store blank or, with the default unique index, surface a
+        // raw DB constraint error on the second one — give a clear validation message instead.
+        if (resolvedData[fieldKey] === '') {
+          addValidationError(
+            `${fieldKey} could not be generated — provide a value containing letters or numbers`
+          )
+        }
+      },
+    },
+  })
+}