@nixxie-cms/fields-currency 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,14 @@
+# @nixxie-cms/fields-currency
+
+A money field for Nixxie CMS. Stores the amount in **minor units** (e.g. cents) as an integer to
+avoid floating-point errors, plus a `formatCurrency` helper for display.
+
+```ts
+import { currency, formatCurrency } from '@nixxie-cms/fields-currency'
+
+fields: {
+  price: currency({ currency: 'USD' }),
+}
+
+formatCurrency(1999, 'USD') // "$19.99"
+```

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

@@ -0,0 +1,24 @@
+import type { IntegerFieldConfig } from '@nixxie-cms/core/fields';
+import type { BaseListTypeInfo, FieldTypeFunc } from '@nixxie-cms/core/types';
+export type CurrencyFieldConfig<ListTypeInfo extends BaseListTypeInfo> = Omit<IntegerFieldConfig<ListTypeInfo>, 'validation' | 'defaultValue'> & {
+    /** ISO 4217 currency code stored only as documentation/metadata, e.g. 'USD'. Default: 'USD' */
+    currency?: string;
+    /** Allow negative amounts (e.g. refunds/credits). Default: false */
+    allowNegative?: boolean;
+    defaultValue?: number | null;
+    validation?: {
+        isRequired?: boolean;
+    };
+};
+/**
+ * A monetary field storing the amount in **minor units** (e.g. cents) as an integer, which avoids
+ * floating-point rounding errors. Format for display on the frontend with `Intl.NumberFormat`.
+ */
+export declare function currency<ListTypeInfo extends BaseListTypeInfo>(config?: CurrencyFieldConfig<ListTypeInfo>): FieldTypeFunc<ListTypeInfo>;
+/**
+ * Helper: format a minor-unit amount for display. When `minorUnitDigits` is omitted it is derived
+ * from the currency (2 for USD/EUR, 0 for JPY/KRW, 3 for KWD/BHD, …) so the divisor is correct for
+ * currencies whose minor unit is not 1/100.
+ */
+export declare function formatCurrency(minorUnits: number, currency?: string, locale?: string, minorUnitDigits?: number): string;
+//# 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,mBAAmB,CAAC,YAAY,SAAS,gBAAgB,IAAI,IAAI,CAC3E,kBAAkB,CAAC,YAAY,CAAC,EAChC,YAAY,GAAG,cAAc,CAC9B,GAAG;IACF,+FAA+F;IAC/F,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,oEAAoE;IACpE,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,UAAU,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE,CAAA;CACtC,CAAA;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,YAAY,SAAS,gBAAgB,EAC5D,MAAM,GAAE,mBAAmB,CAAC,YAAY,CAAM,GAC7C,aAAa,CAAC,YAAY,CAAC,CAY7B;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAC5B,UAAU,EAAE,MAAM,EAClB,QAAQ,SAAQ,EAChB,MAAM,CAAC,EAAE,MAAM,EACf,eAAe,CAAC,EAAE,MAAM,GACvB,MAAM,CAIR"}

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

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

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

@@ -0,0 +1,49 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var fields = require('@nixxie-cms/core/fields');
+
+/**
+ * A monetary field storing the amount in **minor units** (e.g. cents) as an integer, which avoids
+ * floating-point rounding errors. Format for display on the frontend with `Intl.NumberFormat`.
+ */
+function currency(config = {}) {
+  const {
+    currency = 'USD',
+    allowNegative = false,
+    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: allowNegative ? undefined : 0
+    },
+    ui: {
+      description: `Amount in minor units of ${currency} (e.g. cents)`,
+      ...rest.ui
+    }
+  });
+}
+
+/**
+ * Helper: format a minor-unit amount for display. When `minorUnitDigits` is omitted it is derived
+ * from the currency (2 for USD/EUR, 0 for JPY/KRW, 3 for KWD/BHD, …) so the divisor is correct for
+ * currencies whose minor unit is not 1/100.
+ */
+function formatCurrency(minorUnits, currency = 'USD', locale, minorUnitDigits) {
+  var _ref;
+  const formatter = new Intl.NumberFormat(locale, {
+    style: 'currency',
+    currency
+  });
+  const digits = (_ref = minorUnitDigits !== null && minorUnitDigits !== void 0 ? minorUnitDigits : formatter.resolvedOptions().maximumFractionDigits) !== null && _ref !== void 0 ? _ref : 2;
+  return formatter.format(minorUnits / 10 ** digits);
+}
+
+exports.currency = currency;
+exports.formatCurrency = formatCurrency;

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

@@ -0,0 +1,44 @@
+import { integer } from '@nixxie-cms/core/fields';
+
+/**
+ * A monetary field storing the amount in **minor units** (e.g. cents) as an integer, which avoids
+ * floating-point rounding errors. Format for display on the frontend with `Intl.NumberFormat`.
+ */
+function currency(config = {}) {
+  const {
+    currency = 'USD',
+    allowNegative = false,
+    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: allowNegative ? undefined : 0
+    },
+    ui: {
+      description: `Amount in minor units of ${currency} (e.g. cents)`,
+      ...rest.ui
+    }
+  });
+}
+
+/**
+ * Helper: format a minor-unit amount for display. When `minorUnitDigits` is omitted it is derived
+ * from the currency (2 for USD/EUR, 0 for JPY/KRW, 3 for KWD/BHD, …) so the divisor is correct for
+ * currencies whose minor unit is not 1/100.
+ */
+function formatCurrency(minorUnits, currency = 'USD', locale, minorUnitDigits) {
+  var _ref;
+  const formatter = new Intl.NumberFormat(locale, {
+    style: 'currency',
+    currency
+  });
+  const digits = (_ref = minorUnitDigits !== null && minorUnitDigits !== void 0 ? minorUnitDigits : formatter.resolvedOptions().maximumFractionDigits) !== null && _ref !== void 0 ? _ref : 2;
+  return formatter.format(minorUnits / 10 ** digits);
+}
+
+export { currency, formatCurrency };

package/package.json

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

package/src/index.ts

@@ -0,0 +1,51 @@
+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 CurrencyFieldConfig<ListTypeInfo extends BaseListTypeInfo> = Omit<
+  IntegerFieldConfig<ListTypeInfo>,
+  'validation' | 'defaultValue'
+> & {
+  /** ISO 4217 currency code stored only as documentation/metadata, e.g. 'USD'. Default: 'USD' */
+  currency?: string
+  /** Allow negative amounts (e.g. refunds/credits). Default: false */
+  allowNegative?: boolean
+  defaultValue?: number | null
+  validation?: { isRequired?: boolean }
+}
+
+/**
+ * A monetary field storing the amount in **minor units** (e.g. cents) as an integer, which avoids
+ * floating-point rounding errors. Format for display on the frontend with `Intl.NumberFormat`.
+ */
+export function currency<ListTypeInfo extends BaseListTypeInfo>(
+  config: CurrencyFieldConfig<ListTypeInfo> = {}
+): FieldTypeFunc<ListTypeInfo> {
+  const { currency = 'USD', allowNegative = false, defaultValue, validation, ...rest } = config
+
+  return integer<ListTypeInfo>({
+    ...(rest as IntegerFieldConfig<ListTypeInfo>),
+    defaultValue: defaultValue ?? null,
+    validation: {
+      isRequired: validation?.isRequired,
+      min: allowNegative ? undefined : 0,
+    },
+    ui: { description: `Amount in minor units of ${currency} (e.g. cents)`, ...rest.ui },
+  })
+}
+
+/**
+ * Helper: format a minor-unit amount for display. When `minorUnitDigits` is omitted it is derived
+ * from the currency (2 for USD/EUR, 0 for JPY/KRW, 3 for KWD/BHD, …) so the divisor is correct for
+ * currencies whose minor unit is not 1/100.
+ */
+export function formatCurrency(
+  minorUnits: number,
+  currency = 'USD',
+  locale?: string,
+  minorUnitDigits?: number
+): string {
+  const formatter = new Intl.NumberFormat(locale, { style: 'currency', currency })
+  const digits = minorUnitDigits ?? formatter.resolvedOptions().maximumFractionDigits ?? 2
+  return formatter.format(minorUnits / 10 ** digits)
+}