@myparcel-dev/pdk-admin 2.1.0 → 2.2.0

package/src/forms/shipmentOptions/fields/createDimensionFields.spec.ts

@@ -0,0 +1,49 @@
+import {describe, expect, it, vi} from 'vitest';
+import {FIELD_HEIGHT, FIELD_LENGTH, FIELD_WIDTH} from '../field';
+import {createDimensionFields} from './createDimensionFields';
+
+// Full mock (no importOriginal) to avoid the Vue file import chain
+// that triggers "Install @vitejs/plugin-vue" errors.
+vi.mock('../../helpers', () => ({
+  resolveFormComponent: () => 'MockNumberInput',
+  defineFormField: (config: Record<string, unknown>) => config,
+}));
+
+describe('createDimensionFields', () => {
+  it('creates a field per dimension, in centimeters', () => {
+    const fields = createDimensionFields({});
+
+    expect(fields.map((field) => field.name)).toEqual([FIELD_LENGTH, FIELD_WIDTH, FIELD_HEIGHT]);
+    expect(fields.map((field) => field.label)).toEqual(['length_in_cm', 'width_in_cm', 'height_in_cm']);
+  });
+
+  /**
+   * Only `attributes` is bound to the rendered input; `props` is merely readable from `element.props`
+   * by components that opt in, and no number input does. A `min` on `props` would silently do nothing,
+   * so assert the channel and not just the value.
+   */
+  it('puts min on attributes so it reaches the input', () => {
+    const fields = createDimensionFields({});
+
+    fields.forEach((field) => {
+      expect(field.attributes).toEqual({min: 0});
+      expect(field.props?.min).toBeUndefined();
+    });
+  });
+
+  it('leaves untouched fields undefined rather than defaulting them to 0', () => {
+    const fields = createDimensionFields({});
+
+    expect(fields.map((field) => field.ref?.value)).toEqual([undefined, undefined, undefined]);
+  });
+
+  it('seeds each field from the order refs when a value was stored', () => {
+    const fields = createDimensionFields({
+      [FIELD_LENGTH]: 40,
+      [FIELD_WIDTH]: 20,
+      [FIELD_HEIGHT]: 30,
+    });
+
+    expect(fields.map((field) => field.ref?.value)).toEqual([40, 20, 30]);
+  });
+});

package/src/forms/shipmentOptions/fields/createDimensionFields.ts

@@ -0,0 +1,32 @@
+import {type InteractiveElementConfiguration} from '@myparcel-dev/vue-form-builder';
+import {type ShipmentOptionsRefs} from '../types';
+import {FIELD_HEIGHT, FIELD_LENGTH, FIELD_WIDTH, type FieldName} from '../field';
+import {defineFormField, resolveFormComponent} from '../../helpers';
+import {AdminComponent} from '../../../data';
+import {createRef} from './createRef';
+
+/**
+ * The parcel dimensions the merchant may fill in manually, in centimeters — the same unit the API
+ * expects and the backoffice shows, so nothing is converted.
+ *
+ * `min` is a UX guard, not validation
+ *
+ * The refs have no fallback on purpose. An untouched field must stay undefined so it is left out of
+ * the request entirely; defaulting to 0 would send a dimension the merchant never entered.
+ */
+const DIMENSION_FIELDS: [name: FieldName, label: string][] = [
+  [FIELD_LENGTH, 'length_in_cm'],
+  [FIELD_WIDTH, 'width_in_cm'],
+  [FIELD_HEIGHT, 'height_in_cm'],
+];
+
+export const createDimensionFields = (refs: ShipmentOptionsRefs): InteractiveElementConfiguration[] =>
+  DIMENSION_FIELDS.map(([name, label]) =>
+    defineFormField({
+      name,
+      label,
+      ref: createRef<number | undefined>(refs, name),
+      component: resolveFormComponent(AdminComponent.NumberInput),
+      attributes: {min: 0},
+    }),
+  );

package/src/forms/shipmentOptions/fields/index.ts

@@ -1,4 +1,5 @@
 export * from './createDigitalStampRangeField';
+export * from './createDimensionFields';
 export * from './createInsuranceField';
 export * from './createLabelAmountField';
 export * from './createPackageTypeField';