@nixxie-cms/fields-rating 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-rating
+
+A rating field for Nixxie CMS (e.g. 0–5 stars). Built on the core `integer` field with a
+constrained range.
+
+```ts
+import { rating } from '@nixxie-cms/fields-rating'
+
+fields: {
+  score: rating({ max: 5 }),
+}
+```

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

@@ -0,0 +1,17 @@
+import type { IntegerFieldConfig } from '@nixxie-cms/core/fields';
+import type { BaseListTypeInfo, FieldTypeFunc } from '@nixxie-cms/core/types';
+export type RatingFieldConfig<ListTypeInfo extends BaseListTypeInfo> = Omit<IntegerFieldConfig<ListTypeInfo>, 'validation' | 'defaultValue'> & {
+    /** Highest allowed rating. Default: 5 */
+    max?: number;
+    /** Lowest allowed rating. Default: 0 */
+    min?: number;
+    defaultValue?: number | null;
+    validation?: {
+        isRequired?: boolean;
+    };
+};
+/**
+ * A rating field (e.g. 0–5 stars). Built on the core `integer` field with a constrained range.
+ */
+export declare function rating<ListTypeInfo extends BaseListTypeInfo>(config?: RatingFieldConfig<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,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AACjE,OAAO,KAAK,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAE7E,MAAM,MAAM,iBAAiB,CAAC,YAAY,SAAS,gBAAgB,IAAI,IAAI,CACzE,kBAAkB,CAAC,YAAY,CAAC,EAChC,YAAY,GAAG,cAAc,CAC9B,GAAG;IACF,yCAAyC;IACzC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,wCAAwC;IACxC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,UAAU,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE,CAAA;CACtC,CAAA;AAED;;GAEG;AACH,wBAAgB,MAAM,CAAC,YAAY,SAAS,gBAAgB,EAC1D,MAAM,GAAE,iBAAiB,CAAC,YAAY,CAAM,GAC3C,aAAa,CAAC,YAAY,CAAC,CAS7B"}

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

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

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

@@ -0,0 +1,33 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var fields = require('@nixxie-cms/core/fields');
+
+/**
+ * A rating field (e.g. 0–5 stars). Built on the core `integer` field with a constrained range.
+ */
+function rating(config = {}) {
+  const {
+    max = 5,
+    min = 0,
+    defaultValue,
+    validation,
+    ...rest
+  } = config;
+  return fields.integer({
+    ...rest,
+    defaultValue: defaultValue !== null && defaultValue !== void 0 ? defaultValue : null,
+    validation: {
+      isRequired: validation === null || validation === void 0 ? void 0 : validation.isRequired,
+      min,
+      max
+    },
+    ui: {
+      description: `A rating from ${min} to ${max}`,
+      ...rest.ui
+    }
+  });
+}
+
+exports.rating = rating;

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

@@ -0,0 +1,29 @@
+import { integer } from '@nixxie-cms/core/fields';
+
+/**
+ * A rating field (e.g. 0–5 stars). Built on the core `integer` field with a constrained range.
+ */
+function rating(config = {}) {
+  const {
+    max = 5,
+    min = 0,
+    defaultValue,
+    validation,
+    ...rest
+  } = config;
+  return integer({
+    ...rest,
+    defaultValue: defaultValue !== null && defaultValue !== void 0 ? defaultValue : null,
+    validation: {
+      isRequired: validation === null || validation === void 0 ? void 0 : validation.isRequired,
+      min,
+      max
+    },
+    ui: {
+      description: `A rating from ${min} to ${max}`,
+      ...rest.ui
+    }
+  });
+}
+
+export { rating };

package/package.json

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

package/src/index.ts

@@ -0,0 +1,31 @@
+import { integer } from '@nixxie-cms/core/fields'
+import type { IntegerFieldConfig } from '@nixxie-cms/core/fields'
+import type { BaseListTypeInfo, FieldTypeFunc } from '@nixxie-cms/core/types'
+
+export type RatingFieldConfig<ListTypeInfo extends BaseListTypeInfo> = Omit<
+  IntegerFieldConfig<ListTypeInfo>,
+  'validation' | 'defaultValue'
+> & {
+  /** Highest allowed rating. Default: 5 */
+  max?: number
+  /** Lowest allowed rating. Default: 0 */
+  min?: number
+  defaultValue?: number | null
+  validation?: { isRequired?: boolean }
+}
+
+/**
+ * A rating field (e.g. 0–5 stars). Built on the core `integer` field with a constrained range.
+ */
+export function rating<ListTypeInfo extends BaseListTypeInfo>(
+  config: RatingFieldConfig<ListTypeInfo> = {}
+): FieldTypeFunc<ListTypeInfo> {
+  const { max = 5, min = 0, defaultValue, validation, ...rest } = config
+
+  return integer<ListTypeInfo>({
+    ...(rest as IntegerFieldConfig<ListTypeInfo>),
+    defaultValue: defaultValue ?? null,
+    validation: { isRequired: validation?.isRequired, min, max },
+    ui: { description: `A rating from ${min} to ${max}`, ...rest.ui },
+  })
+}