@nixxie-cms/fields-color 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,12 @@
+# @nixxie-cms/fields-color
+
+A colour field for Nixxie CMS. Stores a validated, lowercased CSS hex value (`#rgb`, `#rrggbb` or
+`#rrggbbaa`).
+
+```ts
+import { color } from '@nixxie-cms/fields-color'
+
+fields: {
+  brandColor: color({ validation: { isRequired: true } }),
+}
+```

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

@@ -0,0 +1,14 @@
+import type { TextFieldConfig } from '@nixxie-cms/core/fields';
+import type { BaseListTypeInfo, FieldTypeFunc } from '@nixxie-cms/core/types';
+export type ColorFieldConfig<ListTypeInfo extends BaseListTypeInfo> = Omit<TextFieldConfig<ListTypeInfo>, 'validation'> & {
+    validation?: {
+        /** Reject saving when no value is present. */
+        isRequired?: boolean;
+    };
+};
+/**
+ * A colour field storing a CSS hex value (`#rgb`, `#rrggbb` or `#rrggbbaa`). Built on the core
+ * `text` field with hex validation. Values are normalised to lowercase.
+ */
+export declare function color<ListTypeInfo extends BaseListTypeInfo>(config?: ColorFieldConfig<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;AAI7E,MAAM,MAAM,gBAAgB,CAAC,YAAY,SAAS,gBAAgB,IAAI,IAAI,CACxE,eAAe,CAAC,YAAY,CAAC,EAC7B,YAAY,CACb,GAAG;IACF,UAAU,CAAC,EAAE;QACX,8CAA8C;QAC9C,UAAU,CAAC,EAAE,OAAO,CAAA;KACrB,CAAA;CACF,CAAA;AAED;;;GAGG;AACH,wBAAgB,KAAK,CAAC,YAAY,SAAS,gBAAgB,EACzD,MAAM,GAAE,gBAAgB,CAAC,YAAY,CAAM,GAC1C,aAAa,CAAC,YAAY,CAAC,CAuB7B"}

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

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

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

@@ -0,0 +1,50 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var fields = require('@nixxie-cms/core/fields');
+
+const HEX = /^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$/;
+/**
+ * A colour field storing a CSS hex value (`#rgb`, `#rrggbb` or `#rrggbbaa`). Built on the core
+ * `text` field with hex validation. Values are normalised to lowercase.
+ */
+function color(config = {}) {
+  const {
+    hooks,
+    validation,
+    ...rest
+  } = config;
+  return fields.text({
+    ...rest,
+    validation: {
+      isRequired: validation === null || validation === void 0 ? void 0 : validation.isRequired
+    },
+    ui: {
+      description: 'Hex colour, e.g. #1a2b3c',
+      ...rest.ui
+    },
+    hooks: {
+      ...hooks,
+      resolveInput: args => {
+        const v = args.resolvedData[args.fieldKey];
+        return typeof v === 'string' ? v.toLowerCase() : v;
+      },
+      validate: args => {
+        const {
+          resolvedData,
+          fieldKey,
+          addValidationError,
+          operation
+        } = args;
+        if (operation === 'delete') return;
+        const value = resolvedData[fieldKey];
+        if (typeof value === 'string' && value.length > 0 && !HEX.test(value)) {
+          addValidationError(`${fieldKey} must be a hex colour like #1a2b3c`);
+        }
+      }
+    }
+  });
+}
+
+exports.color = color;

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

@@ -0,0 +1,46 @@
+import { text } from '@nixxie-cms/core/fields';
+
+const HEX = /^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$/;
+/**
+ * A colour field storing a CSS hex value (`#rgb`, `#rrggbb` or `#rrggbbaa`). Built on the core
+ * `text` field with hex validation. Values are normalised to lowercase.
+ */
+function color(config = {}) {
+  const {
+    hooks,
+    validation,
+    ...rest
+  } = config;
+  return text({
+    ...rest,
+    validation: {
+      isRequired: validation === null || validation === void 0 ? void 0 : validation.isRequired
+    },
+    ui: {
+      description: 'Hex colour, e.g. #1a2b3c',
+      ...rest.ui
+    },
+    hooks: {
+      ...hooks,
+      resolveInput: args => {
+        const v = args.resolvedData[args.fieldKey];
+        return typeof v === 'string' ? v.toLowerCase() : v;
+      },
+      validate: args => {
+        const {
+          resolvedData,
+          fieldKey,
+          addValidationError,
+          operation
+        } = args;
+        if (operation === 'delete') return;
+        const value = resolvedData[fieldKey];
+        if (typeof value === 'string' && value.length > 0 && !HEX.test(value)) {
+          addValidationError(`${fieldKey} must be a hex colour like #1a2b3c`);
+        }
+      }
+    }
+  });
+}
+
+export { color };

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@nixxie-cms/fields-color",
+  "version": "1.0.1",
+  "license": "MIT",
+  "main": "dist/nixxie-cms-fields-color.cjs.js",
+  "module": "dist/nixxie-cms-fields-color.esm.js",
+  "exports": {
+    ".": {
+      "types": "./dist/nixxie-cms-fields-color.cjs.js",
+      "module": "./dist/nixxie-cms-fields-color.esm.js",
+      "default": "./dist/nixxie-cms-fields-color.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-color"
+  }
+}

package/src/index.ts

@@ -0,0 +1,46 @@
+import { text } from '@nixxie-cms/core/fields'
+import type { TextFieldConfig } from '@nixxie-cms/core/fields'
+import type { BaseListTypeInfo, FieldTypeFunc } from '@nixxie-cms/core/types'
+
+const HEX = /^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$/
+
+export type ColorFieldConfig<ListTypeInfo extends BaseListTypeInfo> = Omit<
+  TextFieldConfig<ListTypeInfo>,
+  'validation'
+> & {
+  validation?: {
+    /** Reject saving when no value is present. */
+    isRequired?: boolean
+  }
+}
+
+/**
+ * A colour field storing a CSS hex value (`#rgb`, `#rrggbb` or `#rrggbbaa`). Built on the core
+ * `text` field with hex validation. Values are normalised to lowercase.
+ */
+export function color<ListTypeInfo extends BaseListTypeInfo>(
+  config: ColorFieldConfig<ListTypeInfo> = {}
+): FieldTypeFunc<ListTypeInfo> {
+  const { hooks, validation, ...rest } = config
+
+  return text<ListTypeInfo>({
+    ...(rest as TextFieldConfig<ListTypeInfo>),
+    validation: { isRequired: validation?.isRequired },
+    ui: { description: 'Hex colour, e.g. #1a2b3c', ...rest.ui },
+    hooks: {
+      ...hooks,
+      resolveInput: (args: any) => {
+        const v = args.resolvedData[args.fieldKey]
+        return typeof v === 'string' ? v.toLowerCase() : v
+      },
+      validate: (args: any) => {
+        const { resolvedData, fieldKey, addValidationError, operation } = args
+        if (operation === 'delete') return
+        const value = resolvedData[fieldKey]
+        if (typeof value === 'string' && value.length > 0 && !HEX.test(value)) {
+          addValidationError(`${fieldKey} must be a hex colour like #1a2b3c`)
+        }
+      },
+    },
+  })
+}