regions-config 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,294 @@
+import { z } from 'zod';
+
+declare const GROUP_REGIONS: Record<string, number>;
+declare const EUROPE_COUNTRIES: number[];
+declare const US_CANADA_JAPAN_COUNTRIES: number[];
+declare const US_CANADA_COUNTRIES: number[];
+declare const WORLD_COUNTRIES: number[];
+
+type DocumentTypeOption = {
+    label: string;
+    value: string;
+};
+type DocumentTypeOptionsByOrigin = {
+    local: Array<DocumentTypeOption>;
+    foreign: Array<DocumentTypeOption>;
+};
+type RedirectCountry = {
+    countryId: string;
+    name?: string;
+};
+type RedirectGroup = {
+    label: string;
+    countries: Array<RedirectCountry>;
+};
+type CountryToRedirect = {
+    countryId: string;
+    countryRegion: string;
+    regionLabel: string;
+    name?: string;
+};
+type RegionToGroup = {
+    priority: 'high' | 'medium' | 'low';
+    countries: number[];
+    regionId: number;
+};
+type PaymentCardType = {
+    id: number;
+    name: string;
+    imagePath: string;
+};
+declare const RegionConfigSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    gtmId: z.ZodString;
+    countriesToRedirect: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        label: z.ZodString;
+        countries: z.ZodArray<z.ZodObject<{
+            countryId: z.ZodString;
+            name: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            countryId: string;
+            name?: string | undefined;
+        }, {
+            countryId: string;
+            name?: string | undefined;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        label: string;
+        countries: {
+            countryId: string;
+            name?: string | undefined;
+        }[];
+    }, {
+        label: string;
+        countries: {
+            countryId: string;
+            name?: string | undefined;
+        }[];
+    }>>>;
+    regionUrls: z.ZodOptional<z.ZodObject<{
+        staging: z.ZodString;
+        production: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        staging: string;
+        production: string;
+    }, {
+        staging: string;
+        production: string;
+    }>>;
+    timeZone: z.ZodString;
+    regionsToGroup: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        priority: z.ZodEnum<["high", "medium", "low"]>;
+        countries: z.ZodArray<z.ZodNumber, "many">;
+        regionId: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        countries: number[];
+        priority: "high" | "medium" | "low";
+        regionId: number;
+    }, {
+        countries: number[];
+        priority: "high" | "medium" | "low";
+        regionId: number;
+    }>, "many">>;
+    footer: z.ZodArray<z.ZodObject<{
+        href: z.ZodString;
+        label: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        label: string;
+        href: string;
+    }, {
+        label: string;
+        href: string;
+    }>, "many">;
+    documentTypeOptions: z.ZodArray<z.ZodObject<{
+        label: z.ZodString;
+        value: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        label: string;
+    }, {
+        value: string;
+        label: string;
+    }>, "many">;
+    documentTypeOptionsByOrigin: z.ZodOptional<z.ZodObject<{
+        local: z.ZodArray<z.ZodObject<{
+            label: z.ZodString;
+            value: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            label: string;
+        }, {
+            value: string;
+            label: string;
+        }>, "many">;
+        foreign: z.ZodArray<z.ZodObject<{
+            label: z.ZodString;
+            value: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            label: string;
+        }, {
+            value: string;
+            label: string;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        local: {
+            value: string;
+            label: string;
+        }[];
+        foreign: {
+            value: string;
+            label: string;
+        }[];
+    }, {
+        local: {
+            value: string;
+            label: string;
+        }[];
+        foreign: {
+            value: string;
+            label: string;
+        }[];
+    }>>;
+    dateFormat: z.ZodString;
+    regionCode: z.ZodEnum<["es-ES", "es-MX", "en-EU", "en-ROW", "it-IT", "pt-PT", "es-CO", "es-PE"]>;
+    paymentCardTypes: z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        name: z.ZodString;
+        imagePath: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        id: number;
+        name: string;
+        imagePath: string;
+    }, {
+        id: number;
+        name: string;
+        imagePath: string;
+    }>, "many">;
+    webSitePath: z.ZodOptional<z.ZodString>;
+}, "strict", z.ZodTypeAny, {
+    id: number;
+    gtmId: string;
+    timeZone: string;
+    footer: {
+        label: string;
+        href: string;
+    }[];
+    documentTypeOptions: {
+        value: string;
+        label: string;
+    }[];
+    dateFormat: string;
+    regionCode: "es-ES" | "es-MX" | "en-EU" | "en-ROW" | "it-IT" | "pt-PT" | "es-CO" | "es-PE";
+    paymentCardTypes: {
+        id: number;
+        name: string;
+        imagePath: string;
+    }[];
+    countriesToRedirect?: Record<string, {
+        label: string;
+        countries: {
+            countryId: string;
+            name?: string | undefined;
+        }[];
+    }> | undefined;
+    regionUrls?: {
+        staging: string;
+        production: string;
+    } | undefined;
+    regionsToGroup?: {
+        countries: number[];
+        priority: "high" | "medium" | "low";
+        regionId: number;
+    }[] | undefined;
+    documentTypeOptionsByOrigin?: {
+        local: {
+            value: string;
+            label: string;
+        }[];
+        foreign: {
+            value: string;
+            label: string;
+        }[];
+    } | undefined;
+    webSitePath?: string | undefined;
+}, {
+    id: number;
+    gtmId: string;
+    timeZone: string;
+    footer: {
+        label: string;
+        href: string;
+    }[];
+    documentTypeOptions: {
+        value: string;
+        label: string;
+    }[];
+    dateFormat: string;
+    regionCode: "es-ES" | "es-MX" | "en-EU" | "en-ROW" | "it-IT" | "pt-PT" | "es-CO" | "es-PE";
+    paymentCardTypes: {
+        id: number;
+        name: string;
+        imagePath: string;
+    }[];
+    countriesToRedirect?: Record<string, {
+        label: string;
+        countries: {
+            countryId: string;
+            name?: string | undefined;
+        }[];
+    }> | undefined;
+    regionUrls?: {
+        staging: string;
+        production: string;
+    } | undefined;
+    regionsToGroup?: {
+        countries: number[];
+        priority: "high" | "medium" | "low";
+        regionId: number;
+    }[] | undefined;
+    documentTypeOptionsByOrigin?: {
+        local: {
+            value: string;
+            label: string;
+        }[];
+        foreign: {
+            value: string;
+            label: string;
+        }[];
+    } | undefined;
+    webSitePath?: string | undefined;
+}>;
+type CountriesToRedirectMap = Record<string, RedirectGroup>;
+type RegionConfig = Omit<z.infer<typeof RegionConfigSchema>, 'countriesToRedirect'> & {
+    countriesToRedirect?: CountriesToRedirectMap;
+};
+type RegionsConfig = {
+    [key: string]: RegionConfig;
+};
+type RegionConfigJson = Omit<RegionConfig, 'regionsToGroup' | 'footer' | 'regionCode'> & {
+    regionCode: string;
+    regionsToGroup?: Array<{
+        priority: string;
+        countries: string;
+        regionId: string;
+    }>;
+    footer: Array<{
+        href: string;
+        label: string;
+    }>;
+};
+
+declare const regionsConfig: RegionsConfig;
+
+declare const getRegionConfig: (name: string) => RegionConfig;
+
+declare const getRegionConfigById: (id: number) => RegionConfig;
+
+declare const getRegionConfigByRegionCode: (regionCode: RegionConfig["regionCode"]) => RegionConfig;
+
+declare const resolveDocumentTypeOptions: (documentTypeOptions: Array<DocumentTypeOption>, documentTypeOptionsByOrigin?: DocumentTypeOptionsByOrigin, originCountryId?: string | number, siteCountryId?: number) => Array<DocumentTypeOption>;
+
+declare const validateRegion: (region: RegionConfig["regionCode"]) => void;
+
+export { type CountriesToRedirectMap, type CountryToRedirect, type DocumentTypeOption, type DocumentTypeOptionsByOrigin, EUROPE_COUNTRIES, GROUP_REGIONS, type PaymentCardType, type RedirectCountry, type RedirectGroup, type RegionConfig, type RegionConfigJson, RegionConfigSchema, type RegionToGroup, type RegionsConfig, US_CANADA_COUNTRIES, US_CANADA_JAPAN_COUNTRIES, WORLD_COUNTRIES, getRegionConfig, getRegionConfigById, getRegionConfigByRegionCode, regionsConfig, resolveDocumentTypeOptions, validateRegion };