@nixxie-cms/fields-rating 2.1.0 → 2.1.1

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

@@ -1,6 +1,11 @@
 import type { IntegerFieldConfig } from '@nixxie-cms/core/fields';
 import type { BaseCollectionTypeInfo, FieldTypeFunc } from '@nixxie-cms/core/types';
 export type RatingFieldConfig<CollectionTypeInfo extends BaseCollectionTypeInfo> = Omit<IntegerFieldConfig<CollectionTypeInfo>, 'validation' | 'defaultValue'> & {
+    /**
+     * How the rating is stored. `'integer'` (default) only allows whole numbers,
+     * `'float'` allows fractional values such as 4.8.
+     */
+    type?: 'integer' | 'float';
     /** Highest allowed rating. Default: 5 */
     max?: number;
     /** Lowest allowed rating. Default: 0 */
@@ -11,7 +16,9 @@ export type RatingFieldConfig<CollectionTypeInfo extends BaseCollectionTypeInfo>
     };
 };
 /**
- * A rating field (e.g. 0–5 stars). Built on the core `integer` field with a constrained range.
+ * A rating field (e.g. 0–5 stars). Built on the core `integer` field with a
+ * constrained range, or the `float` field when `type: 'float'` is set so it can
+ * store fractional ratings like 4.8.
  */
 export declare function rating<CollectionTypeInfo extends BaseCollectionTypeInfo>(config?: RatingFieldConfig<CollectionTypeInfo>): FieldTypeFunc<CollectionTypeInfo>;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +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,sBAAsB,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAEnF,MAAM,MAAM,iBAAiB,CAAC,kBAAkB,SAAS,sBAAsB,IAAI,IAAI,CACrF,kBAAkB,CAAC,kBAAkB,CAAC,EACtC,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,kBAAkB,SAAS,sBAAsB,EACtE,MAAM,GAAE,iBAAiB,CAAC,kBAAkB,CAAM,GACjD,aAAa,CAAC,kBAAkB,CAAC,CASnC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"../../../src","sources":["index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAoB,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AACnF,OAAO,KAAK,EAAE,sBAAsB,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAEnF,MAAM,MAAM,iBAAiB,CAAC,kBAAkB,SAAS,sBAAsB,IAAI,IAAI,CACrF,kBAAkB,CAAC,kBAAkB,CAAC,EACtC,YAAY,GAAG,cAAc,CAC9B,GAAG;IACF;;;OAGG;IACH,IAAI,CAAC,EAAE,SAAS,GAAG,OAAO,CAAA;IAC1B,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;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,kBAAkB,SAAS,sBAAsB,EACtE,MAAM,GAAE,iBAAiB,CAAC,kBAAkB,CAAM,GACjD,aAAa,CAAC,kBAAkB,CAAC,CAoBnC"}

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

@@ -4,19 +4,21 @@ 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.
+/**
+ * A rating field (e.g. 0–5 stars). Built on the core `integer` field with a
+ * constrained range, or the `float` field when `type: 'float'` is set so it can
+ * store fractional ratings like 4.8.
  */
 function rating(config = {}) {
   const {
+    type = 'integer',
     max = 5,
     min = 0,
     defaultValue,
     validation,
     ...rest
   } = config;
-  return fields.integer({
-    ...rest,
+  const shared = {
     defaultValue: defaultValue !== null && defaultValue !== void 0 ? defaultValue : null,
     validation: {
       isRequired: validation === null || validation === void 0 ? void 0 : validation.isRequired,
@@ -27,6 +29,16 @@ function rating(config = {}) {
       description: `A rating from ${min} to ${max}`,
       ...rest.ui
     }
+  };
+  if (type === 'float') {
+    return fields.float({
+      ...rest,
+      ...shared
+    });
+  }
+  return fields.integer({
+    ...rest,
+    ...shared
   });
 }
 

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

@@ -1,18 +1,20 @@
-import { integer } from '@nixxie-cms/core/fields';
+import { float, integer } from '@nixxie-cms/core/fields';
 
-/**
- * A rating field (e.g. 0–5 stars). Built on the core `integer` field with a constrained range.
+/**
+ * A rating field (e.g. 0–5 stars). Built on the core `integer` field with a
+ * constrained range, or the `float` field when `type: 'float'` is set so it can
+ * store fractional ratings like 4.8.
  */
 function rating(config = {}) {
   const {
+    type = 'integer',
     max = 5,
     min = 0,
     defaultValue,
     validation,
     ...rest
   } = config;
-  return integer({
-    ...rest,
+  const shared = {
     defaultValue: defaultValue !== null && defaultValue !== void 0 ? defaultValue : null,
     validation: {
       isRequired: validation === null || validation === void 0 ? void 0 : validation.isRequired,
@@ -23,6 +25,16 @@ function rating(config = {}) {
       description: `A rating from ${min} to ${max}`,
       ...rest.ui
     }
+  };
+  if (type === 'float') {
+    return float({
+      ...rest,
+      ...shared
+    });
+  }
+  return integer({
+    ...rest,
+    ...shared
   });
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nixxie-cms/fields-rating",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "license": "MIT",
   "main": "dist/nixxie-cms-fields-rating.cjs.js",
   "module": "dist/nixxie-cms-fields-rating.esm.js",

package/src/index.ts

@@ -1,31 +1,49 @@
-import { integer } from '@nixxie-cms/core/fields'
-import type { IntegerFieldConfig } from '@nixxie-cms/core/fields'
-import type { BaseCollectionTypeInfo, FieldTypeFunc } from '@nixxie-cms/core/types'
-
-export type RatingFieldConfig<CollectionTypeInfo extends BaseCollectionTypeInfo> = Omit<
-  IntegerFieldConfig<CollectionTypeInfo>,
-  '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<CollectionTypeInfo extends BaseCollectionTypeInfo>(
-  config: RatingFieldConfig<CollectionTypeInfo> = {}
-): FieldTypeFunc<CollectionTypeInfo> {
-  const { max = 5, min = 0, defaultValue, validation, ...rest } = config
-
-  return integer<CollectionTypeInfo>({
-    ...(rest as IntegerFieldConfig<CollectionTypeInfo>),
-    defaultValue: defaultValue ?? null,
-    validation: { isRequired: validation?.isRequired, min, max },
-    ui: { description: `A rating from ${min} to ${max}`, ...rest.ui },
-  })
-}
+import { float, integer } from '@nixxie-cms/core/fields'
+import type { FloatFieldConfig, IntegerFieldConfig } from '@nixxie-cms/core/fields'
+import type { BaseCollectionTypeInfo, FieldTypeFunc } from '@nixxie-cms/core/types'
+
+export type RatingFieldConfig<CollectionTypeInfo extends BaseCollectionTypeInfo> = Omit<
+  IntegerFieldConfig<CollectionTypeInfo>,
+  'validation' | 'defaultValue'
+> & {
+  /**
+   * How the rating is stored. `'integer'` (default) only allows whole numbers,
+   * `'float'` allows fractional values such as 4.8.
+   */
+  type?: 'integer' | 'float'
+  /** 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, or the `float` field when `type: 'float'` is set so it can
+ * store fractional ratings like 4.8.
+ */
+export function rating<CollectionTypeInfo extends BaseCollectionTypeInfo>(
+  config: RatingFieldConfig<CollectionTypeInfo> = {}
+): FieldTypeFunc<CollectionTypeInfo> {
+  const { type = 'integer', max = 5, min = 0, defaultValue, validation, ...rest } = config
+
+  const shared = {
+    defaultValue: defaultValue ?? null,
+    validation: { isRequired: validation?.isRequired, min, max },
+    ui: { description: `A rating from ${min} to ${max}`, ...rest.ui },
+  }
+
+  if (type === 'float') {
+    return float<CollectionTypeInfo>({
+      ...(rest as FloatFieldConfig<CollectionTypeInfo>),
+      ...shared,
+    })
+  }
+
+  return integer<CollectionTypeInfo>({
+    ...(rest as IntegerFieldConfig<CollectionTypeInfo>),
+    ...shared,
+  })
+}