@nfcard/validation 0.14.0 → 0.16.0

package/dist/index.d.ts

@@ -5300,6 +5300,34 @@ declare const digitalConfigSchema: z.ZodObject<{
         label?: string | undefined;
     }[] | undefined;
 }>;
+declare const entrySourceSchema: z.ZodObject<{
+    output: z.ZodOptional<z.ZodEnum<["with-card", "digital-only"]>>;
+    entryFlow: z.ZodOptional<z.ZodEnum<["order", "try"]>>;
+    ref: z.ZodOptional<z.ZodString>;
+    path: z.ZodOptional<z.ZodString>;
+    referrer: z.ZodOptional<z.ZodString>;
+    material: z.ZodOptional<z.ZodEnum<["plastic", "3dprint_standard", "metal", "bamboo"]>>;
+    template: z.ZodOptional<z.ZodString>;
+    utm: z.ZodOptional<z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodString>, Record<string, string>, Record<string, string>>>;
+}, "strict", z.ZodTypeAny, {
+    path?: string | undefined;
+    material?: "plastic" | "3dprint_standard" | "metal" | "bamboo" | undefined;
+    template?: string | undefined;
+    output?: "with-card" | "digital-only" | undefined;
+    entryFlow?: "order" | "try" | undefined;
+    ref?: string | undefined;
+    referrer?: string | undefined;
+    utm?: Record<string, string> | undefined;
+}, {
+    path?: string | undefined;
+    material?: "plastic" | "3dprint_standard" | "metal" | "bamboo" | undefined;
+    template?: string | undefined;
+    output?: "with-card" | "digital-only" | undefined;
+    entryFlow?: "order" | "try" | undefined;
+    ref?: string | undefined;
+    referrer?: string | undefined;
+    utm?: Record<string, string> | undefined;
+}>;
 declare const configurationCreateSchema: z.ZodObject<{
     sessionId: z.ZodString;
     userData: z.ZodObject<{
@@ -8838,6 +8866,34 @@ declare const configurationCreateSchema: z.ZodObject<{
     quantity: z.ZodDefault<z.ZodNumber>;
     existingProfileId: z.ZodOptional<z.ZodString>;
     physicalTemplateId: z.ZodOptional<z.ZodString>;
+    entrySource: z.ZodOptional<z.ZodObject<{
+        output: z.ZodOptional<z.ZodEnum<["with-card", "digital-only"]>>;
+        entryFlow: z.ZodOptional<z.ZodEnum<["order", "try"]>>;
+        ref: z.ZodOptional<z.ZodString>;
+        path: z.ZodOptional<z.ZodString>;
+        referrer: z.ZodOptional<z.ZodString>;
+        material: z.ZodOptional<z.ZodEnum<["plastic", "3dprint_standard", "metal", "bamboo"]>>;
+        template: z.ZodOptional<z.ZodString>;
+        utm: z.ZodOptional<z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodString>, Record<string, string>, Record<string, string>>>;
+    }, "strict", z.ZodTypeAny, {
+        path?: string | undefined;
+        material?: "plastic" | "3dprint_standard" | "metal" | "bamboo" | undefined;
+        template?: string | undefined;
+        output?: "with-card" | "digital-only" | undefined;
+        entryFlow?: "order" | "try" | undefined;
+        ref?: string | undefined;
+        referrer?: string | undefined;
+        utm?: Record<string, string> | undefined;
+    }, {
+        path?: string | undefined;
+        material?: "plastic" | "3dprint_standard" | "metal" | "bamboo" | undefined;
+        template?: string | undefined;
+        output?: "with-card" | "digital-only" | undefined;
+        entryFlow?: "order" | "try" | undefined;
+        ref?: string | undefined;
+        referrer?: string | undefined;
+        utm?: Record<string, string> | undefined;
+    }>>;
 }, "strip", z.ZodTypeAny, {
     sessionId: string;
     userData: {
@@ -9194,6 +9250,16 @@ declare const configurationCreateSchema: z.ZodObject<{
     quantity: number;
     existingProfileId?: string | undefined;
     physicalTemplateId?: string | undefined;
+    entrySource?: {
+        path?: string | undefined;
+        material?: "plastic" | "3dprint_standard" | "metal" | "bamboo" | undefined;
+        template?: string | undefined;
+        output?: "with-card" | "digital-only" | undefined;
+        entryFlow?: "order" | "try" | undefined;
+        ref?: string | undefined;
+        referrer?: string | undefined;
+        utm?: Record<string, string> | undefined;
+    } | undefined;
 }, {
     sessionId: string;
     userData: {
@@ -9550,6 +9616,16 @@ declare const configurationCreateSchema: z.ZodObject<{
     quantity?: number | undefined;
     existingProfileId?: string | undefined;
     physicalTemplateId?: string | undefined;
+    entrySource?: {
+        path?: string | undefined;
+        material?: "plastic" | "3dprint_standard" | "metal" | "bamboo" | undefined;
+        template?: string | undefined;
+        output?: "with-card" | "digital-only" | undefined;
+        entryFlow?: "order" | "try" | undefined;
+        ref?: string | undefined;
+        referrer?: string | undefined;
+        utm?: Record<string, string> | undefined;
+    } | undefined;
 }>;
 declare const configurationUpdateSchema: z.ZodObject<{
     userData: z.ZodOptional<z.ZodObject<{
@@ -19709,4 +19785,4 @@ declare function validatePhysicalConfig(data: unknown): ValidationResult<z.infer
 declare function validateDigitalConfig(data: unknown): ValidationResult<z.infer<typeof digitalConfigSchema>>;
 declare function validateConfiguration(data: unknown): ValidationResult<z.infer<typeof configurationCreateSchema>>;
 
-export { CARD_H_MM, CARD_W_MM, CHIP_RADIUS_MM, CHIP_SCALE_FLOOR, type ChipAxis, EDGE_MARGIN_MM, MAX_CTA_BUTTONS, MIN_WALL_MM, NFC_COIL_DIAMETER_MM, NFC_RADIAL_CLEARANCE_MM, type PrintabilityCtx, type Pt, QR_MATRIX_CELLS, QR_MIN_SIZE_MM, QR_MODULE_MIN_MM, TEXT_MIN_EM_MM, type ValidationResult, type Violation, adminCardCreateSchema, cardAssetSchema, cardDesignMaterialSchema, cardDesignPatternSchema, cardDesignSchema, cardElementSchema, cardElementsSchema, cardProfileUpdateSchema, cardUpdateSchema, chipAnchorToMm, comboIdSchema, configurationCreateSchema, configurationUpdateSchema, contactDetailTogglesSchema, contactExchangeSchema, cornersOnCard, createOrderSchema, ctaButtonSchema, ctaButtonsSchema, digitalConfigSchema, digitalVisibilitySchema, elementPrintability, elementTransformSchema, hubConfigSchema, hubProfilesUpdateSchema, isFiniteTransform, materialSchema, mmToNearestChipAnchor, obbCorners, patternFamilySchema, physicalConfigSchema, physicalContentOverridesSchema, profileAccessTokenCreateSchema, profileCreateSchema, profilePinVerifySchema, profileUpdateSchema, profileUserDataSchema, profileVisibilitySchema, sanitizeHttpUrl, sanitizeText, signupWithProfileSchema, socialLinksSchema, socialOverridesSchema, userDataSchema, validateConfiguration, validateDigitalConfig, validatePhysicalConfig, validateUserData, webAddressSchema };
+export { CARD_H_MM, CARD_W_MM, CHIP_RADIUS_MM, CHIP_SCALE_FLOOR, type ChipAxis, EDGE_MARGIN_MM, MAX_CTA_BUTTONS, MIN_WALL_MM, NFC_COIL_DIAMETER_MM, NFC_RADIAL_CLEARANCE_MM, type PrintabilityCtx, type Pt, QR_MATRIX_CELLS, QR_MIN_SIZE_MM, QR_MODULE_MIN_MM, TEXT_MIN_EM_MM, type ValidationResult, type Violation, adminCardCreateSchema, cardAssetSchema, cardDesignMaterialSchema, cardDesignPatternSchema, cardDesignSchema, cardElementSchema, cardElementsSchema, cardProfileUpdateSchema, cardUpdateSchema, chipAnchorToMm, comboIdSchema, configurationCreateSchema, configurationUpdateSchema, contactDetailTogglesSchema, contactExchangeSchema, cornersOnCard, createOrderSchema, ctaButtonSchema, ctaButtonsSchema, digitalConfigSchema, digitalVisibilitySchema, elementPrintability, elementTransformSchema, entrySourceSchema, hubConfigSchema, hubProfilesUpdateSchema, isFiniteTransform, materialSchema, mmToNearestChipAnchor, obbCorners, patternFamilySchema, physicalConfigSchema, physicalContentOverridesSchema, profileAccessTokenCreateSchema, profileCreateSchema, profilePinVerifySchema, profileUpdateSchema, profileUserDataSchema, profileVisibilitySchema, sanitizeHttpUrl, sanitizeText, signupWithProfileSchema, socialLinksSchema, socialOverridesSchema, userDataSchema, validateConfiguration, validateDigitalConfig, validatePhysicalConfig, validateUserData, webAddressSchema };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nfcard/validation",
-  "version": "0.14.0",
+  "version": "0.16.0",
   "description": "Shared Zod validation schemas for the NFCard product family.",
   "type": "module",
   "main": "./dist/index.js",

package/src/index.test.ts

@@ -4,6 +4,7 @@ import {
   cardElementsSchema,
   comboIdSchema,
   configurationCreateSchema,
+  configurationUpdateSchema,
   contactExchangeSchema,
   createOrderSchema,
   ctaButtonsSchema,
@@ -973,3 +974,104 @@ describe('physicalConfig.cardDesign (nested, not stripped)', () => {
     expect(physicalConfigSchema.safeParse(validPhysicalConfig).success).toBe(true);
   });
 });
+
+// -- entrySourceSchema (NFCARD-392) --------------------------------
+
+describe('entrySourceSchema on configurationCreateSchema', () => {
+  const base = {
+    sessionId: '550e8400-e29b-41d4-a716-446655440000',
+    userData: validUserData,
+    physicalConfig: validPhysicalConfig,
+    digitalConfig: validDigitalConfig,
+  };
+
+  it('accepts a full entry-attribution blob', () => {
+    const r = configurationCreateSchema.safeParse({
+      ...base,
+      entrySource: {
+        output: 'with-card',
+        entryFlow: 'order',
+        ref: 'PROMO24',
+        path: '/configurator',
+        referrer: 'google.com',
+        utm: { utm_source: 'ads', utm_campaign: 'launch' },
+      },
+    });
+    expect(r.success).toBe(true);
+    if (r.success) expect(r.data.entrySource?.output).toBe('with-card');
+  });
+
+  it('is optional — older clients omit it entirely', () => {
+    const r = configurationCreateSchema.safeParse(base);
+    expect(r.success).toBe(true);
+    if (r.success) expect(r.data.entrySource).toBeUndefined();
+  });
+
+  it('rejects unknown keys (strict) and out-of-enum values', () => {
+    expect(
+      configurationCreateSchema.safeParse({
+        ...base,
+        entrySource: { output: 'with-card', evil: 'payload' },
+      }).success,
+    ).toBe(false);
+    expect(
+      configurationCreateSchema.safeParse({
+        ...base,
+        entrySource: { output: 'both-please' },
+      }).success,
+    ).toBe(false);
+  });
+
+  it('bounds the utm map (max 10 entries, capped value length)', () => {
+    const utm: Record<string, string> = {};
+    for (let i = 0; i < 11; i++) utm['k' + i] = 'v';
+    expect(
+      configurationCreateSchema.safeParse({ ...base, entrySource: { utm } }).success,
+    ).toBe(false);
+    expect(
+      configurationCreateSchema.safeParse({
+        ...base,
+        entrySource: { referrer: 'x'.repeat(300) },
+      }).success,
+    ).toBe(false);
+  });
+
+  it('is create-only: the update schema strips/ignores it', () => {
+    const r = configurationUpdateSchema.safeParse({
+      entrySource: { output: 'with-card' },
+    });
+    // z.object strips unknown keys by default - the field must not survive.
+    expect(r.success).toBe(true);
+    if (r.success) expect((r.data as Record<string, unknown>).entrySource).toBeUndefined();
+  });
+});
+
+describe('entrySourceSchema material/template preselects (NFCARD-393)', () => {
+  const base = {
+    sessionId: '550e8400-e29b-41d4-a716-446655440000',
+    userData: validUserData,
+    physicalConfig: validPhysicalConfig,
+    digitalConfig: validDigitalConfig,
+  };
+
+  it('accepts the deep-link preselects', () => {
+    const r = configurationCreateSchema.safeParse({
+      ...base,
+      entrySource: { output: 'with-card', material: '3dprint_standard', template: 'tpl-pvc-white' },
+    });
+    expect(r.success).toBe(true);
+    if (r.success) {
+      expect(r.data.entrySource?.material).toBe('3dprint_standard');
+      expect(r.data.entrySource?.template).toBe('tpl-pvc-white');
+    }
+  });
+
+  it('rejects a non-enum material', () => {
+    expect(
+      configurationCreateSchema.safeParse({
+        ...base,
+        entrySource: { material: 'carbon-fiber' },
+      }).success,
+    ).toBe(false);
+  });
+});