@bisondesk/website-commons-sdk 1.0.33 → 1.0.35

package/src/types/seo-stock-path.ts

@@ -0,0 +1,30 @@
+type BaseSEOStockPath = {
+  /* The path i.e /truck */
+  id: string;
+};
+
+export type CanonicalSEOStockPath = BaseSEOStockPath & {
+  filters: Record<string, unknown>;
+  canonical?: undefined;
+
+  /* The SEO path for markdown content i.e /truck/daf */
+  seoPath: string;
+};
+
+export type LocalizedSEOStockPath = BaseSEOStockPath & {
+  /* The canonical id for the localised stock path, null if canonical */
+  language: string;
+  canonical: string;
+};
+
+export type SEOStockPath = CanonicalSEOStockPath | LocalizedSEOStockPath;
+
+export type GroupedSEOStockPaths = {
+  canonical: CanonicalSEOStockPath;
+  localizations: LocalizedSEOStockPath[];
+}[];
+
+export type LocalizedSEOStockPathWithCanonical = {
+  localizedData?: LocalizedSEOStockPath;
+  canonicalData?: CanonicalSEOStockPath;
+};

package/src/types/user-searches.ts

@@ -18,7 +18,7 @@ const BaseUserSearch = z
 type BaseUserSearch = z.infer<typeof BaseUserSearch>;
 
 export const UserSearch = BaseUserSearch.extend({
-  id: z.uuidv7(),
+  id: z.string().uuid(),
   createdBy: z.string(),
   createdAt: z.string(),
 });

package/src/types/user.ts

@@ -1,3 +1,4 @@
+import { z } from 'zod';
 import { MarketingChannel } from './index.js';
 
 export type AuthRequest = {
@@ -10,20 +11,29 @@ export enum FleetSize {
   Large = '6+',
 }
 
-export type UserDetails = {
-  firstName?: string;
-  lastName?: string;
-  phone?: string;
-  preferredLanguage?: string;
-  fleetSize?: FleetSize;
-  trader?: boolean;
-  email?: string;
-  company: {
-    country?: string;
-    city?: string | undefined;
-    name?: string | undefined;
-    vat?: string | undefined;
-    postalCode?: string | undefined;
-  };
-  marketingChannels: MarketingChannel[];
-};
+export const UserDetails = z.object({
+  firstName: z.string().optional(),
+  lastName: z.string().optional(),
+  phone: z.string().optional(),
+  preferredLanguage: z.string().optional(),
+  fleetSize: z.nativeEnum(FleetSize).optional(),
+  trader: z.boolean().optional(),
+  email: z.string().email().optional(),
+  company: z.object({
+    country: z.string().optional(),
+    city: z.string().optional(),
+    name: z.string().optional(),
+    vat: z.string().optional(),
+    postalCode: z.string().optional(),
+  }),
+  marketingChannels: z.array(z.nativeEnum(MarketingChannel)),
+});
+
+export type UserDetails = z.infer<typeof UserDetails>;
+
+export const UserDetailsRequest = z.object({
+  subsribeToNewsletter: z.boolean().optional(),
+  data: UserDetails,
+});
+
+export type UserDetailsRequest = z.infer<typeof UserDetailsRequest>;

package/src/utils/index.ts

@@ -1,4 +1,5 @@
 import { customAlphabet } from 'nanoid';
+import slug from 'slug';
 
 export enum Alphabet {
   Full = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz_',
@@ -33,3 +34,55 @@ const isValid = (id: string): boolean => {
 
   return true;
 };
+
+const arabic = {
+  ء: 'ء',
+  ا: 'ا',
+  أ: 'أ',
+  إ: 'إ',
+  آ: 'آ',
+  ؤ: 'ؤ',
+  ئ: 'ئ',
+  ب: 'ب',
+  ت: 'ت',
+  ث: 'ث',
+  ج: 'ج',
+  ح: 'ح',
+  خ: 'خ',
+  د: 'د',
+  ذ: 'ذ',
+  ر: 'ر',
+  ز: 'ز',
+  س: 'س',
+  ش: 'ش',
+  ص: 'ص',
+  ض: 'ض',
+  ط: 'ط',
+  ظ: 'ظ',
+  ع: 'ع',
+  غ: 'غ',
+  ف: 'ف',
+  ق: 'ق',
+  ك: 'ك',
+  ل: 'ل',
+  م: 'م',
+  ن: 'ن',
+  ه: 'ه',
+  و: 'و',
+  ي: 'ي',
+  ة: 'ة',
+  ى: 'ى',
+};
+
+slug.extend(arabic);
+
+export const slugify = (str: string, opts?: slug.Options) =>
+  slug(str, {
+    lower: true,
+    // Preserve Arabic characters
+    remove: /[$*_+~.()'"!\-:@]+/g,
+    ...opts,
+  });
+
+export const normalizeSlug = (slug: (string | undefined)[], locale?: string) =>
+  slug.filter((v: string | undefined): v is string => !!v).map((s) => slugify(s, { locale }));

package/src/utils/utils.test.ts

@@ -0,0 +1,29 @@
+import { slugify } from './index.js';
+
+describe('utils', () => {
+  test.each([
+    {
+      actual: 'سيارة إسعاف سيارة إسعاف',
+      expected: 'سيارة-إسعاف-سيارة-إسعاف',
+      locale: 'ar',
+    },
+    {
+      actual: 'رأس جرار',
+      expected: 'رأس-جرار',
+      locale: 'ar',
+    },
+    {
+      actual: 'اختبار خاص!@#',
+      expected: 'اختبار-خاص',
+      locale: 'ar',
+    },
+    {
+      actual: 'Café com leite',
+      expected: 'cafe-com-leite',
+    },
+  ])('slug', ({ actual, expected, locale }) => {
+    const slugified = slugify(actual, { locale });
+
+    expect(slugified).toBe(expected);
+  });
+});