@app-brew/brewery 1.0.0

package/src/types/src/config.ts

@@ -0,0 +1,705 @@
+import { CountryCode, CurrencyCode } from './countries'
+import { z } from 'zod'
+import { appBarBlockSchema } from './blocks'
+import { blockSchema, tabSchema } from './common'
+import {
+  baseIconStyleSchema,
+  baseStyleSchema,
+  baseTextStyleSchema,
+} from './style'
+
+const CountryCodeValues = Object.values(CountryCode)
+const CurrencyCodeValues = Object.values(CurrencyCode)
+
+export const storeDetailsSchema = z.object({
+  domain: z.string(),
+  shopifyDomain: z.string(),
+  customCheckoutDomain: z.string().optional(),
+  logo: z.string().optional(),
+  splashScreen: z.string().optional(),
+  deepLinkPrefix: z.array(z.string()).optional(),
+  priceDecimalAccuracy: z.number().optional(),
+  countryCode: z
+    .enum([CountryCodeValues[0], ...CountryCodeValues.slice(1)])
+    .optional(),
+  country: z
+    .object({
+      isoCode: z.enum([CountryCodeValues[0], ...CountryCodeValues.slice(1)]),
+      name: z.string(),
+      unitSystem: z.string(),
+      currency: z.object({
+        isoCode: z.enum([
+          CurrencyCodeValues[0],
+          ...CurrencyCodeValues.slice(1),
+        ]),
+        name: z.string(),
+        symbol: z.string(),
+      }),
+    })
+    .optional()
+    .or(z.string().optional()),
+  showCurrencyPrompt: z.boolean().optional(),
+})
+
+export const settingsSchema = z.record(z.any())
+
+export const integrationCommonSchema = z.object({
+  eventsMapper: z.record(z.string(), z.string()).optional(),
+  paramsMapper: z.record(z.string(), z.string()).optional(),
+  eventsWhitelist: z.array(z.string()).optional(),
+  paramsWhitelist: z.array(z.string()).optional(),
+})
+
+export const flitsSchema = z.object({
+  token: z.string(),
+  userId: z.string(),
+  baseUrl: z.string(),
+  signInActionUrl: z.string().optional(),
+  signInActionKey: z.string().optional(),
+})
+
+export const vipSchema = z.object({
+  shopifyDomain: z.string(),
+})
+
+export const wishlistPlusSchema = z.object({
+  pid: z.string(),
+  endpoint: z.string(),
+})
+
+export const growSimpleeSchema = z.object({
+  endpoints: z.object({
+    main: z.string(),
+    authToken: z.string(),
+  }),
+  sourcePincode: z.string().optional(),
+})
+
+export const shopifySchema = z.object({
+  storefrontAccessToken: z.string(),
+  domain: z.string(),
+  appOnlyCouponCodeSuffix: z.string().optional(),
+})
+
+export const zeviSchema = z.object({
+  store: z.string(),
+  baseUrl: z.string(),
+  searchSuggetionsUrl: z.string(),
+})
+export const searchtapSchema = z.object({
+  baseUrl: z.string(),
+  bearerToken: z.string(),
+  defaultOptions: z.record(z.any()),
+  defaultSearchSuggestionsOptions: z.record(z.any()),
+  defaultTrendingSearchesOptions: z.record(z.any()),
+  defaultCollectionLinksInSuggestionsOptions: z.record(z.any()).optional(),
+})
+export const findifySchema = z.object({
+  key: z.string(),
+})
+export const judgemeSchema = z.object({
+  storeDomain: z.string(),
+  platform: z.string(),
+  publicToken: z.string(),
+  stylesheet: z.string().optional(),
+  primaryColor: z.string().optional(),
+  textDark: z.string().optional(),
+  starColor: z.string().optional(),
+  bgVeryLight: z.string().optional(),
+  textOnPrimary: z.string().optional(),
+  fontFamily: z.string().optional(),
+  buttonBorderRadius: z.string().optional(),
+  customHtmlPageUrl: z.string().optional(),
+})
+
+export const opinewSchema = z.object({
+  domain: z.string(),
+  widgetType: z.string(),
+})
+
+export const socialSigninSchema = z.object({
+  googleWebClientId: z.string(),
+  googleiOSClientId: z.string().optional(),
+})
+
+export const otpSigninSchema = z.object({
+  otpPinCount: z.number().optional(),
+  skipEmailValidation: z.boolean().optional(),
+})
+
+export const gokwikSchema = z.object({
+  merchantId: z.string(),
+  environment: z.string().optional(),
+  isSnowplowTrackingEnabled: z.boolean().optional(),
+  enableKwikpass: z.boolean().optional(),
+  kcMerchantId: z.string().optional(),
+  kcMerchantToken: z.string().optional(),
+})
+
+export const shopfloSchema = z.object({
+  salesChannelApiKey: z.string(),
+})
+
+export const rebidSchema = integrationCommonSchema.merge(
+  z.object({
+    eventMapping: z.record(z.string(), z.string()).optional(),
+    paramMapping: z.record(z.string(), z.string()).optional(),
+    appKey: z.string().optional(),
+  })
+)
+
+export const contloSchema = z.object({
+  apiKey: z.string(),
+})
+
+export const searchaniseSchema = z.object({
+  apiKey: z.string(),
+  shopDomain: z.string(),
+})
+
+export const adjustSchema = integrationCommonSchema.merge(
+  z.object({
+    ios: z
+      .object({
+        appToken: z.string(),
+        eventMapping: z.record(z.string(), z.string()),
+      })
+      .optional(),
+    android: z
+      .object({
+        appToken: z.string(),
+        eventMapping: z.record(z.string(), z.string()),
+      })
+      .optional(),
+  })
+)
+
+export const boostSchema = z.object({
+  shop: z.string(),
+  buildFilterTree: z.boolean(),
+  // for empty options in filters
+  zeroOptions: z.boolean(),
+  // show only available products
+  productAvailable: z.boolean(),
+})
+
+export const kiwiSchema = z.object({
+  apiUrl: z.string(),
+  shop: z.string(),
+  expiryTimeSeconds: z.number(),
+})
+
+export const searchspringSchema = z.object({
+  siteId: z.string(),
+  apiUrl: z.string().optional(),
+})
+
+export const rebuySchema = z.object({
+  key: z.string(),
+  url: z.string(),
+  collectionId: z.string().optional(),
+})
+export const klaviyoSchema = integrationCommonSchema.merge(
+  z.object({
+    companyId: z.string(),
+  })
+)
+
+export const junipScheam = z.object({
+  key: z.string(),
+  baseURL: z.string(),
+  include: z.string().optional(),
+  'sort[field]': z.string().optional(),
+  'sort[order]': z.string().optional(),
+  'page[size]': z.string().optional(),
+  'page[after]': z.string().optional(),
+})
+
+export const ninetyNineMindsSchema = z.object({
+  apiKey: z.string(),
+  shopDomain: z.string(),
+  signInActionId: z.string().optional(),
+  serverApiKey: z.string().optional(),
+})
+
+// For mergeing extra fields
+// integrationCommonSchema.merge(z.object({
+//   fireld1: z.string(),
+//   field2: z.boolean(),
+// }));
+
+export const moengageSchema = integrationCommonSchema.merge(
+  z.object({
+    eventMapping: z.record(z.string(), z.string()).optional(),
+    paramMapping: z.record(z.string(), z.string()).optional(),
+    uniqueId: z.string().optional(),
+  })
+)
+
+export const firebaseSchema = integrationCommonSchema
+
+export const webengageSchema = integrationCommonSchema
+
+export const branchSchema = integrationCommonSchema
+
+export const googleAdsSchema = integrationCommonSchema
+
+export const clevertapSchmea = integrationCommonSchema
+
+export const bitespeedSchema = integrationCommonSchema.merge(
+  z.object({
+    apiKey: z.string(),
+  })
+)
+
+export const deltaxSchema = integrationCommonSchema.merge(
+  z.object({
+    trackingDomain: z.string(),
+    fallbackUrl: z.string(),
+    xb: z.string(),
+  })
+)
+
+export const netcoreSchema = integrationCommonSchema
+
+export const facebookAdsSchema = integrationCommonSchema.merge(
+  z.object({
+    contentIdTemplate: z.string().optional(),
+  })
+)
+// export const moengageSchema = z.object({
+//   eventMapping: z.record(z.string(), z.string()).optional(),
+//   paramMapping: z.record(z.string(), z.string()).optional(),
+//   uniqueId: z.string().optional(),
+// })
+
+export const fenixSchema = z.object({
+  tenantId: z.string(),
+  apiKey: z.string(),
+})
+export const wizzySchema = z.object({
+  // API credentials - only these are stored at integration level
+  baseUrl: z.string().optional(),
+  storeId: z.string(),
+  apiKey: z.string(),
+  // Note: Other settings (facets, swatch, sortSettings, etc.) come from appConfig.settings.integrations.wizzy
+})
+export const neonSchema = z.object({
+  shop: z.string(),
+  api: z.string(),
+})
+
+export const visenzeSchema = integrationCommonSchema.merge(
+  z.object({
+    appKey: z.string(),
+    baseURL: z.string(),
+  })
+)
+
+export const okendoSchema = z.object({
+  okendoUserId: z.string(),
+  baseURL: z.string(),
+})
+
+export const appbrewCurrencySchema = z.object({
+  defaultCountryCode: z.string(),
+  supportedCountries: z.array(z.string()),
+})
+
+const richSizeGuideSchema = z.object({
+  sizeGuide: z.record(z.string(), z.record(z.string(), z.any())),
+  enableTaggedSizeChart: z.boolean().optional(),
+})
+
+const appsflyerSchema = integrationCommonSchema.merge(
+  z.object({
+    devKey: z.string(),
+    appId: z.string(),
+    timeToWaitForATTUserAuthorization: z.number(),
+  })
+)
+
+const pdpTemplatesSchema = z.object({
+  products: z.record(z.string(), z.string()),
+})
+
+const collectionTemplatesSchema = z.object({
+  collections: z.record(z.string(), z.string()),
+})
+
+export const integrationSchema = z.object({
+  appsflyer: appsflyerSchema.optional(),
+  shopify: shopifySchema.optional(),
+  zevi: zeviSchema.optional(),
+  vip: vipSchema.optional(),
+  flits: flitsSchema.optional(),
+  findify: findifySchema.optional(),
+  judgeme: judgemeSchema.optional(),
+  socialSignin: socialSigninSchema.optional(),
+  searchtap: searchtapSchema.optional(),
+  contlo: contloSchema.optional(),
+  wishlistPlus: wishlistPlusSchema.optional(),
+  searchanise: searchaniseSchema.optional(),
+  adjust: adjustSchema.optional(),
+  boost: boostSchema.optional(),
+  searchspring: searchspringSchema.optional(),
+  opinew: opinewSchema.optional(),
+  growSimplee: growSimpleeSchema.optional(),
+  kiwi: kiwiSchema.optional(),
+  rebuy: rebuySchema.optional(),
+  klaviyo: klaviyoSchema.optional(),
+  junip: junipScheam.optional(),
+  moengage: moengageSchema.optional(),
+  firebase: firebaseSchema.optional(),
+  webengage: webengageSchema.optional(),
+  branch: branchSchema.optional(),
+  fenix: fenixSchema.optional(),
+  wizzy: wizzySchema.optional(),
+  neon: neonSchema.optional(),
+  visenze: visenzeSchema.optional(),
+  'appbrew-currency': appbrewCurrencySchema.optional(),
+  okendo: okendoSchema.optional(),
+  'rich-size-guide': richSizeGuideSchema.optional(),
+  'pdp-templates': pdpTemplatesSchema.optional(),
+  'collection-templates': collectionTemplatesSchema.optional(),
+  'facebook-ads': facebookAdsSchema.optional(),
+  'google-ads': googleAdsSchema.optional(),
+  clevertap: clevertapSchmea.optional(),
+  deltax: deltaxSchema.optional(),
+  netcore: netcoreSchema.optional(),
+  otpSignin: otpSigninSchema.optional(),
+  gokwik: gokwikSchema.optional(),
+  bitespeed: bitespeedSchema.optional(),
+  shopflo: shopfloSchema.optional(),
+  rebid: rebidSchema.optional(),
+  '99minds': ninetyNineMindsSchema.optional(),
+})
+
+export const screenLayoutSchema = z.object({
+  kind: z.string(),
+  blocks: z.array(blockSchema),
+  header: blockSchema.optional(),
+  footer: blockSchema.optional(),
+  tabs: z.array(tabSchema).optional(),
+})
+
+export const screenSchema = z.object({
+  title: z.string(),
+  id: z.string(),
+  entityId: z.string(),
+  authenticated: z.boolean(),
+  layout: screenLayoutSchema,
+  snapPoints: z.array(z.union([z.string(), z.number()])).optional(),
+  enableContentPanningGesture: z.boolean().optional(),
+  numberOfBlocksAllowed: z.number().min(0).optional(),
+  contentType: z.enum(['default', 'tabbed']).optional(),
+  style: z
+    .object({
+      insets: z
+        .object({
+          top: baseStyleSchema.optional(),
+          bottom: baseStyleSchema
+            .extend({ fraction: z.number().min(0).optional() })
+            .optional(),
+        })
+        .optional(),
+      gradient: baseStyleSchema.optional(),
+      tabBar: z
+        .object({
+          root: baseStyleSchema.optional(),
+          fixedContainer: baseStyleSchema.optional(),
+          scrollContainer: baseStyleSchema.optional(),
+          tab: baseStyleSchema.optional(),
+          tabText: baseTextStyleSchema.optional(),
+          selectedTabText: baseTextStyleSchema.optional(),
+          lineIndicator: baseStyleSchema.optional(),
+          backgroundIndicator: baseStyleSchema.optional(),
+        })
+        .optional(),
+    })
+    .optional(),
+  options: z
+    .object({
+      animation: z.string().optional().optional(),
+      stickyHeaderIndices: z.array(z.number()).optional(),
+      showTopInset: z.boolean().optional(),
+      hideAppbar: z.boolean().optional(),
+      enableFloatingHeader: z.boolean().optional(),
+      tabBar: z
+        .object({
+          indicator: z.enum(['line', 'background']).optional(),
+          mode: z.enum(['fixed', 'scrollable']).optional(),
+        })
+        .optional(),
+      gradient: z
+        .object({
+          colors: z.array(z.string().or(z.string())), // mandatory
+          start: z.object({ x: z.number(), y: z.number() }).optional(),
+          end: z.object({ x: z.number(), y: z.number() }).optional(),
+          locations: z.array(z.number()).optional(),
+          useAngle: z.boolean().optional(),
+          angleCenter: z.object({ x: z.number(), y: z.number() }).optional(),
+          angle: z.number().optional(),
+        })
+        .optional(),
+    })
+    .optional(),
+  modal: z
+    .object({
+      snapPoints: z.array(z.union([z.string(), z.number()])).optional(),
+      dismissable: z.boolean().optional(),
+    })
+    .optional(),
+})
+
+export const baseNavSchema = z.object({
+  appBar: appBarBlockSchema,
+})
+
+export const bottomBarNavSchema = baseNavSchema.extend({
+  kind: z.literal('bottom-bar'),
+  bottomBar: z.object({
+    tabs: z.array(
+      z.object({
+        screenId: z.string(),
+        icon: z.string(),
+        label: z.string(),
+        badgeLocation: z
+          .enum(['top-right', 'top-left', 'bottom-right', 'bottom-left'])
+          .optional(),
+        signedInLabel: z.string().optional(),
+      })
+    ),
+    exclude: z.array(z.string()).optional(),
+    include: z.array(z.string()).optional(),
+    showOnAllScreens: z.boolean().optional(),
+    defaultActiveScreenId: z.string().optional(),
+    account: z
+      .object({
+        numberOfCharsInUserInitials: z.number().optional(),
+        showInitials: z.boolean().optional(),
+      })
+      .optional(),
+  }),
+})
+
+export const dummyNavSchema = baseNavSchema.extend({
+  kind: z.literal('dummy'),
+})
+
+export const bottomBarThemeSchema = z.object({
+  root: baseStyleSchema,
+  tab: z.object({
+    iconWrapper: baseStyleSchema.optional(),
+    cartIcon: baseIconStyleSchema.optional(),
+    badge: baseStyleSchema
+      .extend({
+        count: z
+          .object({
+            root: baseStyleSchema.optional(),
+            text: baseTextStyleSchema.optional(),
+            wrapper: baseStyleSchema.optional(),
+          })
+          .optional(),
+      })
+      .optional(),
+    icon: z.object({
+      color: z.string(),
+      height: z.number(),
+      width: z.number(),
+    }),
+    label: z.object({
+      color: z.string(),
+      fontSize: z.number(),
+    }),
+    active: z.object({
+      root: baseStyleSchema.extend({
+        backgroundColor: z.string(),
+      }),
+      icon: z.object({
+        color: z.string(),
+      }),
+      label: z.object({
+        color: z.string(),
+      }),
+    }),
+  }),
+  accountTab: z.object({
+    badge: z
+      .object({
+        color: z.string(),
+        count: z
+          .object({
+            wrapper: baseStyleSchema.optional(),
+            root: baseStyleSchema.optional(),
+            text: baseTextStyleSchema.optional(),
+          })
+          .optional(),
+        backgroundColor: z.string().optional(),
+      })
+      .optional(),
+    avatar: z
+      .object({
+        icon: baseStyleSchema.optional(),
+        text: baseTextStyleSchema.optional(),
+      })
+      .optional(),
+    root: baseStyleSchema.optional(),
+    icon: baseIconStyleSchema.optional(),
+    iconWrapper: baseStyleSchema.optional(),
+    active: z
+      .object({
+        icon: baseIconStyleSchema.optional(),
+        label: baseTextStyleSchema.optional(),
+        avatar: z
+          .object({
+            icon: baseStyleSchema.optional(),
+            text: baseTextStyleSchema.optional(),
+          })
+          .optional(),
+        root: baseStyleSchema.optional(),
+      })
+      .optional(),
+    label: baseTextStyleSchema.optional(),
+  }),
+})
+
+export const buyNowBarSchema = z.object({
+  root: baseStyleSchema,
+  addToCartButton: baseStyleSchema.extend({
+    text: baseTextStyleSchema,
+  }),
+  buyNowButton: baseStyleSchema.extend({
+    text: baseTextStyleSchema,
+  }),
+  outOfStock: baseStyleSchema.extend({
+    root: baseStyleSchema,
+    text: baseTextStyleSchema,
+  }),
+})
+
+//TODO: think of a method to constrain key types
+export const themeSchema = z.union([
+  z.object({
+    insets: z
+      .object({
+        top: baseStyleSchema.optional(),
+        bottom: baseStyleSchema.optional(),
+      })
+      .optional(),
+    atoms: z.any().optional(),
+    base: z
+      .object({
+        colors: z.record(z.string()).optional(),
+        typography: z.any().optional(),
+      })
+      .optional(),
+    text: z
+      .object({
+        fontFamily: z.string().optional(),
+      })
+      .optional(),
+    appBar: z
+      .object({
+        root: baseStyleSchema,
+        heading: baseTextStyleSchema,
+        iconStyle: baseIconStyleSchema,
+        badge: z.object({}),
+      })
+      .required(),
+    bottomBar: bottomBarThemeSchema,
+    toast: z
+      .object({
+        success: z.object({
+          root: baseStyleSchema,
+          text: baseTextStyleSchema,
+        }),
+        addToCart: z.object({
+          root: baseStyleSchema,
+          text: baseTextStyleSchema,
+          button: z.object({
+            root: baseStyleSchema,
+            text: baseTextStyleSchema,
+          }),
+        }),
+      })
+      .optional(),
+    screen: baseStyleSchema.optional(),
+    customScreens: z.record(z.any()).optional(),
+    refreshingSkeleton: baseStyleSchema.optional(),
+  }),
+  z.record(z.any()),
+])
+
+// export const navigationSchema = z.discriminatedUnion('kind', [
+//   dummyNavSchema, // this is a placeholder config, when we add a new kind of navigation it will be removed
+//   bottomBarNavSchema,
+// ])
+
+export const navigationSchema = bottomBarNavSchema
+
+export const appSchema: z.ZodType<{
+  store: any
+  integrations: any
+  navigation: any
+  screens: Record<string, any>
+  theme: any
+  settings?: any
+  extraScreens?: Record<string, any>
+}> = z.object({
+  store: storeDetailsSchema,
+  integrations: integrationSchema,
+  navigation: navigationSchema,
+  screens: z.record(screenSchema),
+  theme: themeSchema,
+  settings: z.optional(settingsSchema),
+  extraScreens: z.record(z.any()).optional(),
+})
+
+export function isBottomBar(
+  value: AppConfig['navigation']
+): value is AppConfig['navigation'] & { kind: 'bottom-bar' } {
+  return value.kind === 'bottom-bar'
+}
+
+export type AppConfig = z.infer<typeof appSchema>
+export type ScreenConfig = z.infer<typeof screenSchema>
+export type ScreenLayoutConfig = z.infer<typeof screenLayoutSchema>
+export type IntegrationsConfig = z.infer<typeof integrationSchema>
+export type ShopifyConfig = z.infer<typeof shopifySchema>
+export type BlockConfig = z.infer<typeof blockSchema>
+export type TabConfig = z.infer<typeof tabSchema>
+export type ThemeConfig = z.infer<typeof themeSchema>
+export type BottomBarThemeConfig = z.infer<typeof bottomBarThemeSchema>
+export type BottomBarNavConfig = z.infer<typeof bottomBarNavSchema>
+
+/**
+ * Default screens excluded from bottom bar when showOnAllScreens is true.
+ * Used as fallback when config.navigation.bottomBar.exclude is not specified.
+ */
+export const DEFAULT_BOTTOMBAR_EXCLUDED_SCREENS = [
+  'rewards',
+  'add-address',
+  'address-list',
+  'apply-coupon',
+  'change-password',
+  'password',
+  'order-cancel',
+  'order-details',
+  'order-list',
+  'privacy',
+  'search-suggestions',
+  'checkout-address',
+  'payment',
+  'editAddress',
+  'shipping-policy',
+  'signinV2',
+  'signup',
+  'terms-of-service',
+  'web-view',
+] as const
+
+export type BuyNowBarConfig = z.infer<typeof buyNowBarSchema>
+export type BoostConfig = z.infer<typeof boostSchema>
+export type SearchSpringConfig = z.infer<typeof searchspringSchema>
+export type WizzyConfig = z.infer<typeof wizzySchema>