feat: Move currency, timezone & units from config to admin settings

treoden · treoden · commit e2ec21235f4f · 2026-06-30T16:18:34.000+07:00
diff --git a/packages/evershop/src/bin/install/templates/config.json b/packages/evershop/src/bin/install/templates/config.json
@@ -1,9 +1,6 @@
 {
   "shop": {
-    "currency": "USD",
     "language": "en",
-    "weightUnit": "kg",
-    "dimensionUnit": "cm",
     "timezone": "UTC"
   },
   "system": {
diff --git a/packages/evershop/src/lib/locale/timezones.ts b/packages/evershop/src/lib/locale/timezones.ts
@@ -4,6 +4,13 @@ export interface Timezone {
 }
 
 export const timezones: Timezone[] = [
+  // UTC first: it's the default `shop.timezone`, so the Store Settings timezone
+  // picker must offer it as a selectable option (otherwise the field renders blank
+  // on a fresh store). Valid IANA zone, accepted by Luxon and Postgres alike.
+  {
+    code: 'UTC',
+    name: 'Coordinated Universal Time (UTC)'
+  },
   {
     code: 'Australia/Darwin',
     name: 'AUS Central Standard Time (Australia/Darwin)'
diff --git a/packages/evershop/src/lib/mail/emailHelper.ts b/packages/evershop/src/lib/mail/emailHelper.ts
@@ -1,6 +1,7 @@
 import Handlebars from 'handlebars';
 import {
   getSetting,
+  getStoreCurrency,
   getStoreLanguage
 } from '../../modules/setting/services/setting.js';
 import { countries } from '../locale/countries.js';
@@ -42,7 +43,7 @@ Handlebars.registerHelper('currency', function (value) {
 
   return new Intl.NumberFormat(locale, {
     style: 'currency',
-    currency: getConfig('shop.currency', 'USD'),
+    currency: getStoreCurrency(),
     minimumFractionDigits: 0,
     maximumFractionDigits: 2
   }).format(number);
diff --git a/packages/evershop/src/lib/metafield/compileField.ts b/packages/evershop/src/lib/metafield/compileField.ts
@@ -1,4 +1,4 @@
-import { getConfig } from '../util/getConfig.js';
+import { getStoreCurrency } from '../../modules/setting/services/setting.js';
 import { MAX_DEPTH } from './types.js';
 import type { FieldDescriptor, Validation } from './types.js';
 
@@ -50,8 +50,8 @@ function compileScalar(field: FieldDescriptor): JSONSchema {
     case 'boolean':
       return { type: 'boolean' };
     case 'money': {
-      // currency must match the store currency (spec §3.6)
-      const currency = getConfig('shop.currency', '');
+      // currency must match the store currency (spec §3.6) — admin setting, legacy config fallback
+      const currency = getStoreCurrency();
       return {
         type: 'object',
         properties: {
diff --git a/packages/evershop/src/lib/util/getConfig.ts b/packages/evershop/src/lib/util/getConfig.ts
@@ -4,11 +4,14 @@ type ConfigStructure = {
   shop: {
     language: string;
     timezone: string;
-    currency: string;
-    weightUnit: string;
-    /** Unit for package dimensions: 'cm' | 'mm' | 'in' (default 'cm'). */
-    dimensionUnit: string;
     homeUrl: string;
+    // NOTE: `currency`, `weightUnit` and `dimensionUnit` are intentionally absent — they are
+    // admin settings now (the `setting` table), read via getStoreCurrency / getWeightUnit /
+    // getDimensionUnit in modules/setting/services; config.json is only a legacy fallback, read
+    // untyped there (getLegacyConfig). `timezone` and `language` stay typed because they are
+    // still read directly/operationally — `shop.timezone` sets the DB session in connection.ts
+    // (before any query, so it can't be a DB setting), and `shop.language` is the locale system's
+    // synchronous fallback across translate/render/formatters.
   };
   system: {
     file_storage: string;
diff --git a/packages/evershop/src/modules/base/bootstrap.js b/packages/evershop/src/modules/base/bootstrap.js
@@ -21,12 +21,6 @@ export default async () => {
               type: 'string',
               format: 'uri'
             },
-            weightUnit: {
-              type: 'string'
-            },
-            currency: {
-              type: 'string'
-            },
             language: {
               type: 'string'
             },
diff --git a/packages/evershop/src/modules/base/graphql/types/DateTime/DateTime.resolvers.js b/packages/evershop/src/modules/base/graphql/types/DateTime/DateTime.resolvers.js
@@ -1,18 +1,18 @@
 import { DateTime } from 'luxon';
 import { getConfig } from '../../../../../lib/util/getConfig.js';
+import { getStoreTimezone } from '../../../../setting/services/setting.js';
 
 export default {
   DateTime: {
     value: (dateTime) => dateTime,
-    timezone: async () => {
-      const timeZone = getConfig('shop.timezone', 'UTC');
-      return timeZone;
-    },
-    text: async (value, { format = 'yyyy-LL-dd' }) => {
+    // Display timezone (admin setting `storeTimeZone`), falling back to the operational
+    // `shop.timezone` config when unset. NOT the DB-session timezone.
+    timezone: () => getStoreTimezone(),
+    text: (value, { format = 'yyyy-LL-dd' }) => {
       if (!DateTime.fromJSDate(value).isValid) {
         return null;
       }
-      const timeZone = getConfig('shop.timezone', 'UTC');
+      const timeZone = getStoreTimezone();
       const language = getConfig('shop.language', 'en');
       const date = DateTime.fromJSDate(value, { zone: timeZone })
         .setLocale(language)
diff --git a/packages/evershop/src/modules/checkout/api/createCart/createNewCart.js b/packages/evershop/src/modules/checkout/api/createCart/createNewCart.js
@@ -1,21 +1,21 @@
 import { select } from '@evershop/postgres-query-builder';
 import { translate } from '../../../../lib/locale/translate/translate.js';
 import { pool } from '../../../../lib/postgres/connection.js';
-import { getConfig } from '../../../../lib/util/getConfig.js';
 import {
   INVALID_PAYLOAD,
   INTERNAL_SERVER_ERROR,
   OK
 } from '../../../../lib/util/httpStatus.js';
 import { setContextValue } from '../../../graphql/services/contextHelper.js';
+import { getStoreCurrency } from '../../../setting/services/setting.js';
 import { Cart } from '../../services/cart/Cart.js';
 import { saveCart } from '../../services/saveCart.js';
 
 export default async (request, response, next) => {
   try {
     const { items, customer_full_name, customer_email } = request.body;
     const cartData = {
-      currency: getConfig('shop.currency', 'USD')
+      currency: getStoreCurrency()
     };
     if (customer_full_name) {
       cartData.customer_full_name = customer_full_name;
diff --git a/packages/evershop/src/modules/checkout/bootstrap.ts b/packages/evershop/src/modules/checkout/bootstrap.ts
@@ -74,21 +74,10 @@ export default () => {
               type: 'boolean'
             }
           }
-        },
-        shop: {
-          type: 'object',
-          properties: {
-            // Unit for package dimensions (`package` table, cart/order item
-            // snapshots). Pinned to the `Dimensions.unit` vocabulary in
-            // oms/types/carrier.ts so no mapping layer is needed. Same model
-            // as shop.weightUnit: store-wide, values reinterpreted (not
-            // converted) if changed after data exists.
-            dimensionUnit: {
-              type: 'string',
-              enum: ['cm', 'mm', 'in']
-            }
-          }
         }
+        // `shop.dimensionUnit` used to be declared here. It is an admin setting now
+        // (read via getDimensionUnit in modules/setting/services); config.json keeps
+        // working as an untyped legacy fallback, so no schema entry is needed.
       }
     });
     return schema;
diff --git a/packages/evershop/src/modules/checkout/graphql/types/Dimension/Dimension.resolvers.js b/packages/evershop/src/modules/checkout/graphql/types/Dimension/Dimension.resolvers.js
@@ -1,12 +1,12 @@
-import { getConfig } from '../../../../../lib/util/getConfig.js';
+import { getDimensionUnit } from '../../../../setting/services/setting.js';
 
 export default {
   Dimension: {
     value: (raw) => parseFloat(raw),
-    unit: () => getConfig('shop.dimensionUnit', 'cm'),
+    unit: () => getDimensionUnit(),
     text: (raw) => {
       const value = parseFloat(raw);
-      const unit = getConfig('shop.dimensionUnit', 'cm');
+      const unit = getDimensionUnit();
       return `${value} ${unit}`;
     }
   },
diff --git a/packages/evershop/src/modules/checkout/graphql/types/Price/Price.resolvers.js b/packages/evershop/src/modules/checkout/graphql/types/Price/Price.resolvers.js
@@ -1,15 +1,13 @@
 import { getConfig } from '../../../../../lib/util/getConfig.js';
+import { getStoreCurrency } from '../../../../setting/services/setting.js';
 
 export default {
   Price: {
     value: (rawPrice) => parseFloat(rawPrice), // TODO: Format for decimal value?
-    currency: async (_, { currency }) => {
-      const curr = currency || getConfig('shop.currency', 'USD');
-      return curr;
-    },
-    text: async (rawPrice, { currency }) => {
+    currency: (_, { currency }) => currency || getStoreCurrency(),
+    text: (rawPrice, { currency }) => {
       const price = parseFloat(rawPrice); // TODO: Format for decimal value?
-      const curr = currency || getConfig('shop.currency', 'USD');
+      const curr = currency || getStoreCurrency();
       const language = getConfig('shop.language', 'en');
       return new Intl.NumberFormat(language, {
         style: 'currency',
diff --git a/packages/evershop/src/modules/checkout/graphql/types/Weight/Weight.resolvers.js b/packages/evershop/src/modules/checkout/graphql/types/Weight/Weight.resolvers.js
@@ -1,15 +1,12 @@
-import { getConfig } from '../../../../../lib/util/getConfig.js';
+import { getWeightUnit } from '../../../../setting/services/setting.js';
 
 export default {
   Weight: {
     value: (raw) => parseFloat(raw),
-    unit: () => {
-      const unit = getConfig('shop.weightUnit', 'kg');
-      return unit;
-    },
+    unit: () => getWeightUnit(),
     text: (raw) => {
       const weight = parseFloat(raw);
-      const unit = getConfig('shop.weightUnit', 'kg');
+      const unit = getWeightUnit();
       // Localize the weight
       return `${weight} ${unit}`;
     }
diff --git a/packages/evershop/src/modules/checkout/services/cart/registerCartBaseFields.js b/packages/evershop/src/modules/checkout/services/cart/registerCartBaseFields.js
@@ -5,7 +5,10 @@ import { pool } from '../../../../lib/postgres/connection.js';
 import { getConfig } from '../../../../lib/util/getConfig.js';
 import { getValueSync } from '../../../../lib/util/registry.js';
 import { validateAddress } from '../../../../modules/customer/services/index.js';
-import { getSetting } from '../../../../modules/setting/services/setting.js';
+import {
+  getSetting,
+  getStoreCurrency
+} from '../../../../modules/setting/services/setting.js';
 import { calculateTaxAmount } from '../../../../modules/tax/services/calculateTaxAmount.js';
 import { getTaxPercent } from '../../../../modules/tax/services/getTaxPercent.js';
 import { getTaxRates } from '../../../../modules/tax/services/getTaxRates.js';
@@ -41,9 +44,8 @@ export function registerCartBaseFields(fields) {
     {
       key: 'currency',
       resolvers: [
-        async function resolver() {
-          const currency = getConfig('shop.currency', 'USD');
-          return currency;
+        function resolver() {
+          return getStoreCurrency();
         }
       ]
     },
diff --git a/packages/evershop/src/modules/checkout/services/shipping/buildShippingContext.ts b/packages/evershop/src/modules/checkout/services/shipping/buildShippingContext.ts
@@ -1,4 +1,3 @@
-import { getConfig } from '../../../../lib/util/getConfig.js';
 import type { Address } from '../../../../types/customerAddress.js';
 import type {
   ShippingZoneRow,
@@ -8,6 +7,7 @@ import type {
   ShippingContext,
   ShippingProvider
 } from '../../../../types/shippingProvider.js';
+import { getStoreCurrency } from '../../../setting/services/setting.js';
 import { getOriginAddress } from './getOriginAddress.js';
 import { serializeItems } from './serializeItems.js';
 
@@ -63,8 +63,7 @@ export async function buildShippingContext(
   const items = serializeItems(cart);
 
   const currency =
-    (cart.getData('currency') as string | undefined) ||
-    (getConfig('shop.currency', 'USD') as string);
+    (cart.getData('currency') as string | undefined) || getStoreCurrency();
 
   return {
     origin,
diff --git a/packages/evershop/src/modules/checkout/services/shipping/serializeItems.ts b/packages/evershop/src/modules/checkout/services/shipping/serializeItems.ts
@@ -1,5 +1,5 @@
-import { getConfig } from '../../../../lib/util/getConfig.js';
 import type { ShippingItem } from '../../../../types/shippingProvider.js';
+import { getDimensionUnit } from '../../../setting/services/setting.js';
 
 /**
  * Minimal interface a cart item must satisfy. Avoids depending on the
@@ -37,9 +37,9 @@ function toInt(value: unknown): number {
  *
  * See wiki/shipping-provider-design.md → "Provider DTO principle".
  */
-/** Normalize `shop.dimensionUnit` to the `Dimensions.unit` vocabulary. */
+/** Normalize the store dimension unit (admin setting) to the `Dimensions.unit` vocabulary. */
 function dimensionUnit(): 'cm' | 'mm' | 'in' {
-  const unit = String(getConfig('shop.dimensionUnit', 'cm')).toLowerCase();
+  const unit = String(getDimensionUnit()).toLowerCase();
   return unit === 'mm' || unit === 'in' ? unit : 'cm';
 }
 
diff --git a/packages/evershop/src/modules/checkout/services/toPrice.ts b/packages/evershop/src/modules/checkout/services/toPrice.ts
@@ -1,4 +1,5 @@
 import { getConfig } from '../../../lib/util/getConfig.js';
+import { getStoreCurrency } from '../../setting/services/setting.js';
 
 export type RoundType = 'up' | 'down' | 'round';
 export function toPrice(value: string, forDisplay: boolean = false) {
@@ -26,7 +27,7 @@ export function toPrice(value: string, forDisplay: boolean = false) {
   if (!forDisplay) {
     return price;
   } else {
-    const currency = getConfig('shop.currency', 'USD');
+    const currency = getStoreCurrency();
     const language = getConfig('shop.language', 'en');
     return new Intl.NumberFormat(language, {
       style: 'currency',
diff --git a/packages/evershop/src/modules/oms/api/lifetimesales/loadData.js b/packages/evershop/src/modules/oms/api/lifetimesales/loadData.js
@@ -1,6 +1,7 @@
 import { select } from '@evershop/postgres-query-builder';
 import { pool } from '../../../../lib/postgres/connection.js';
 import { getConfig } from '../../../../lib/util/getConfig.js';
+import { getStoreCurrency } from '../../../setting/services/setting.js';
 
 export default async (request, response, next) => {
   const query = select();
@@ -29,7 +30,7 @@ export default async (request, response, next) => {
       cancelled += 1;
     }
   });
-  const currency = getConfig('shop.currency', 'USD');
+  const currency = getStoreCurrency();
   const language = getConfig('shop.language', 'en');
   const formatedTotal = new Intl.NumberFormat(language, {
     style: 'currency',
diff --git a/packages/evershop/src/modules/oms/services/createShipment.ts b/packages/evershop/src/modules/oms/services/createShipment.ts
@@ -22,12 +22,14 @@ import {
   type PackingCandidate
 } from '../../checkout/services/cart/packing.js';
 import {
+  getDimensionUnit,
   getStoreAddress,
   getStoreCity,
   getStoreCountry,
   getStoreName,
   getStorePostalCode,
-  getStoreProvince
+  getStoreProvince,
+  getWeightUnit
 } from '../../setting/services/setting.js';
 import type {
   Carrier,
@@ -324,17 +326,17 @@ async function buildCreateLabelInput(
     postcode: postcode ?? '',
     country: country ?? ''
   };
-  // Weight unit is store-wide (`shop.weightUnit`); `order_item.product_weight`
+  // Weight unit is store-wide (admin setting `weightUnit`); `order_item.product_weight`
   // is stored in that unit. Normalize to the `Weight.unit` vocabulary.
-  const rawUnit = String(getConfig('shop.weightUnit', 'kg'))
+  const rawUnit = String(getWeightUnit())
     .toLowerCase()
     .replace(/s$/, '');
   const weightUnit = (['kg', 'g', 'lb', 'oz'] as const).find(
     (u) => u === rawUnit
   ) ?? 'kg';
-  // Dimension unit is store-wide (`shop.dimensionUnit`); the order_item
+  // Dimension unit is store-wide (admin setting `dimensionUnit`); the order_item
   // package snapshot is stored in that unit.
-  const rawDimUnit = String(getConfig('shop.dimensionUnit', 'cm')).toLowerCase();
+  const rawDimUnit = String(getDimensionUnit()).toLowerCase();
   const dimensionUnit = (['cm', 'mm', 'in'] as const).find(
     (u) => u === rawDimUnit
   ) ?? 'cm';
diff --git a/packages/evershop/src/modules/setting/bootstrap.ts b/packages/evershop/src/modules/setting/bootstrap.ts
@@ -0,0 +1,17 @@
+import { error } from '../../lib/log/logger.js';
+import { refreshSetting } from './services/setting.js';
+
+export default async () => {
+  // Warm the in-memory setting cache so the synchronous accessors (`getSettingSync` and the
+  // `*Sync` getters) are reliable from the first request onward — the pricing formatter,
+  // email Handlebars helpers and metafield schema builders all read settings synchronously.
+  // Runs in every process that loads module bootstraps (HTTP, cron, subscriber).
+  //
+  // A failure here is non-fatal: on a fresh install the `setting` table may not be migrated
+  // yet, in which case the async `getSetting` path lazy-loads the cache on first use instead.
+  try {
+    await refreshSetting();
+  } catch (e) {
+    error(e);
+  }
+};
diff --git a/packages/evershop/src/modules/setting/graphql/types/ShippingSetting/ShippingSetting.resolvers.js b/packages/evershop/src/modules/setting/graphql/types/ShippingSetting/ShippingSetting.resolvers.js
@@ -1,4 +1,7 @@
-import { getConfig } from '../../../../../lib/util/getConfig.js';
+import {
+  getDimensionUnit,
+  getWeightUnit
+} from '../../../services/setting.js';
 
 export default {
   Setting: {
@@ -12,7 +15,7 @@ export default {
         return ['US'];
       }
     },
-    weightUnit: () => getConfig('shop.weightUnit', 'kg'),
-    dimensionUnit: () => getConfig('shop.dimensionUnit', 'cm')
+    weightUnit: () => getWeightUnit(),
+    dimensionUnit: () => getDimensionUnit()
   }
 };
diff --git a/packages/evershop/src/modules/setting/graphql/types/StoreSetting/StoreSetting.resolvers.js b/packages/evershop/src/modules/setting/graphql/types/StoreSetting/StoreSetting.resolvers.js
diff --git a/packages/evershop/src/modules/setting/pages/admin/storeSetting/StoreSetting.tsx b/packages/evershop/src/modules/setting/pages/admin/storeSetting/StoreSetting.tsx
diff --git a/packages/evershop/src/modules/setting/services/setting.ts b/packages/evershop/src/modules/setting/services/setting.ts

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,13 @@ export interface Timezone {`
`4`	`4`	`}`
`5`	`5`
`6`	`6`	`export const timezones: Timezone[] = [`
	`7`	+ // UTC first: it's the default `shop.timezone`, so the Store Settings timezone
	`8`	`+ // picker must offer it as a selectable option (otherwise the field renders blank`
	`9`	`+ // on a fresh store). Valid IANA zone, accepted by Luxon and Postgres alike.`
	`10`	`+ {`
	`11`	`+ code: 'UTC',`
	`12`	`+ name: 'Coordinated Universal Time (UTC)'`
	`13`	`+ },`
`7`	`14`	`{`
`8`	`15`	`code: 'Australia/Darwin',`
`9`	`16`	`name: 'AUS Central Standard Time (Australia/Darwin)'`