waha-shared 1.0.1

package/types/analytics.ts

@@ -0,0 +1,147 @@
+import type { ArticleSession, BibleSession, WahaShareContent } from './users'
+
+type Meeting =
+  | {
+      name: 'OpenPlayScreen'
+      payload: {
+        isLessonDownloaded: boolean
+      }
+    }
+  | {
+      name: 'CompleteLesson'
+      payload: {
+        timeToCompletion: number
+        isAudioFacilitator: boolean
+      }
+    }
+  | {
+      name: 'ScheduleNextMeeting'
+      payload: {
+        date: number
+      }
+    }
+  | {
+      name: 'LeavePlayScreen'
+      payload: {
+        sessionLength: number
+        endedInCompletion: boolean
+      }
+    }
+  | {
+      name: 'DbsCast'
+      payload: null
+    }
+
+type Article = {
+  name: 'ArticleSession'
+  payload: ArticleSession
+}
+
+type Share = {
+  name: 'Share'
+  payload: {
+    content: WahaShareContent
+    lessonId?: string
+  }
+}
+
+type Misc =
+  | {
+      name: 'UnlockMobilizationTools'
+      payload: null
+    }
+  | {
+      name: 'EnableSecurityMode'
+      payload: null
+    }
+  | {
+      name: 'ClearStorage'
+      payload: {
+        languageToClear: string
+      }
+    }
+  | {
+      name: 'RequestCode'
+      payload: null
+    }
+  | {
+      name: 'ClickGiveButton'
+      payload: null
+    }
+  | {
+      name: 'NotificationOptIn'
+      payload: {
+        enabled: boolean
+      }
+    }
+  | {
+      name: 'FinishOnboarding'
+      payload: {
+        skipped: boolean
+      }
+    }
+  | {
+      name: 'ClickNotification'
+      payload: {
+        id: string
+        notificationDate: string
+      }
+    }
+  | {
+      name: 'ClickNotificationLink'
+      payload: {
+        id: string
+        notificationDate: string
+      }
+    }
+  | {
+      name: 'SetInitialLanguages'
+      payload: {
+        ipCountry: string
+        phoneCountry: string
+        languages: string[]
+      }
+    }
+  | {
+      name: 'ChangeInitialLanguages'
+      payload: {
+        ipCountry: string
+        phoneCountry: string
+        languages: string[]
+      }
+    }
+  | {
+      name: 'AskForReview'
+      payload: null
+    }
+
+type Note =
+  | {
+      name: 'MakeNote'
+      payload: null
+    }
+  | {
+      name: 'EditNote'
+      payload: null
+    }
+  | {
+      name: 'ViewNotes'
+      payload: null
+    }
+  | {
+      name: 'SavedNote'
+      payload: {
+        length: number
+      }
+    }
+  | {
+      name: 'DeleteNote'
+      payload: null
+    }
+
+type Bible = {
+  name: 'BibleSession'
+  payload: BibleSession
+}
+
+export type AnalyticsEvent = Meeting | Share | Misc | Article | Bible | Note

package/types/completions.ts

@@ -0,0 +1,9 @@
+import type { CompletionEvent } from './users'
+
+export interface SetProgress {
+  completionEvents: CompletionEvent[]
+  uniqueCompletions: CompletionEvent[]
+  total: number
+  progress: number
+  percent: number
+}

package/types/feedback.ts

@@ -0,0 +1,27 @@
+import { z } from 'zod'
+
+export const FeedbackSchema = z.object({
+  language: z.string(),
+  appVersion: z.string(),
+  OS: z.string(),
+  timeSubmitted: z.number(),
+  formName: z.string(),
+  country: z.string().optional(),
+  city: z.string().optional(),
+  lessonId: z.string().nullable().optional(),
+  wahaUserId: z.string().optional(),
+  name: z.string().optional(),
+  email: z.string().email(),
+  // For the standard contact us form.
+  message: z.string().optional(),
+  // For the code request form.
+  journey: z.union([z.string(), z.record(z.string(), z.boolean())]).optional(),
+  goals: z.string().optional(),
+  hear: z.string().optional(),
+  // For the share story form.
+  beforeWaha: z.string().optional(),
+  godDone: z.string().optional(),
+  findOut: z.string().optional(),
+})
+
+export type Feedback = z.infer<typeof FeedbackSchema>

package/types/languages.ts

@@ -0,0 +1,37 @@
+import type { BibleAudios } from '../data/typescript/bibleAudios'
+import type { BibleTexts } from '../data/typescript/bibleTexts'
+import type { IntroductionTranslations } from '../data/typescript/introductionTranslations'
+import type { Languages } from '../data/typescript/languages'
+import type { QuestionsCurriculums } from '../data/typescript/questionsCurriculums'
+import type { QuestionTranslations } from '../data/typescript/questionTranslations'
+import type { SetTranslations } from '../data/typescript/setTranslations'
+
+type Language = Languages[number]
+type BibleText = BibleTexts[number]
+type BibleAudio = BibleAudios[number]
+
+export interface BibleInfo
+  extends Omit<BibleText, 'language' | 'copyright'>,
+    Omit<BibleAudio, 'language' | 'copyright'> {
+  language: Language
+  availableTextChapters: string[]
+  availableAudioChapters: string[]
+  fullCopyright: string
+  bookNames: Record<string, string>
+}
+
+export interface LanguageInfo
+  extends Omit<Language, 'bible' | 'bibleFallback'> {
+  sets: string[]
+  questionSets: QuestionsCurriculums[number]['questionSets']
+  bible: BibleInfo
+  bibleFallback: BibleInfo | undefined
+  trainingVideoLanguage: string
+  isRtl: boolean
+}
+
+export interface MeetTranslations {
+  sets: SetTranslations[string]
+  questions: QuestionTranslations[string]
+  introductions: IntroductionTranslations[string]
+}

package/types/notifications.ts

@@ -0,0 +1,37 @@
+import { notification } from '../data/typescript/notification'
+import { z } from 'zod'
+
+export const PushNotificationPayloadSchema = z.object({
+  actionUrl: z.string().url().optional(),
+  /**
+   * We want the full title, not the push title, to be attached to the
+   * notification.
+   */
+  title: z.string(),
+  /**
+   * We want the full body, not the push body, to be attached to the
+   * notification.
+   */
+  body: z.string(),
+  titleSource: z.string(),
+  bodySource: z.string(),
+  verified: z.boolean(),
+  imageUrl: z.string().url().optional(),
+  wahaUserId: z.string(),
+  date: z.string(),
+})
+
+export type PushNotificationPayload = z.infer<
+  typeof PushNotificationPayloadSchema
+>
+
+export const PushNotificationRecordSchema = z.object({
+  date: z.string(),
+  notification,
+  receivedTokens: z.array(z.string()),
+  receivedUserIds: z.array(z.string()),
+})
+
+export type PushNotificationRecord = z.infer<
+  typeof PushNotificationRecordSchema
+>

package/types/sets.ts

@@ -0,0 +1,84 @@
+import { type Languages } from '../data/typescript/languages'
+import { type Sets } from '../data/typescript/sets'
+
+export type Set = Sets[number]
+export type Lesson = Sets[number]['lessons'][number]
+
+export type SetCategory = 'Foundations' | 'Topics' | 'WahaTraining'
+
+export interface SetInfo extends Set {
+  // Id info.
+  meetLanguageId: Languages[number]['languageId']
+  category: SetCategory
+  setNumber: string
+  // Translations.
+  setTitle?: string
+  setSubtitle: string
+  setDescription?: string
+  setTag?: string
+  setLink: string
+}
+
+export interface Content {
+  languageId: string
+  id: string
+  localFileName: string
+  remoteFileName: string
+  path: string
+  url: string
+}
+
+interface BaseInfo {
+  lessonNumber: string
+  // Translations.
+  lessonTitle: string | undefined
+  lessonIntroduction: string | undefined
+  lessonLink: string
+  sections: Section[]
+}
+
+export interface Section {
+  id: string
+  header: string | null
+  text: string
+  isChapter: boolean
+  hasBeep: boolean
+  index: number
+  indexWithinChapter: number
+  chapter: Chapter | null
+}
+
+export interface DbsInfo extends BaseInfo, SetInfo, Lesson {
+  type: 'dbs'
+  full: Content
+  dbsCast: {
+    remoteFileName: string
+    url: string
+  }
+  lessonIntroduction: string | undefined
+  passagesString: string
+}
+
+export interface VideoInfo extends BaseInfo, SetInfo, Lesson {
+  type: 'video'
+  video: Content
+  lessonSectionHeader: string | undefined
+  lessonSectionBody: string | undefined
+  youtubeLink: string | undefined
+  passagesString: string
+}
+
+export interface EqInfo extends BaseInfo, SetInfo, Lesson {
+  type: 'eq'
+  // text: string
+  eq: Content
+}
+
+export type LessonInfo = DbsInfo | VideoInfo | EqInfo
+
+export enum Chapter {
+  FELLOWSHIP = 'f',
+  INTRODUCTION = 'i',
+  STORY = 's',
+  APPLICATION = 'a',
+}

package/types/users.ts

@@ -0,0 +1,162 @@
+import { z } from 'zod'
+
+const WahaUserLocationSchema = z.object({
+  city: z.string().optional(),
+  country: z.string().optional(),
+  region: z.string().optional(),
+})
+export type WahaUserLocation = z.infer<typeof WahaUserLocationSchema>
+
+export type WahaAppVersion = `${number}.${number}.${number}`
+
+const DesireIdSchema = z.enum([
+  'talk_to_others_about_jesus',
+  'build_a_team_of_disciple_makers',
+  'reach_my_entire_people_or_nation_for_god',
+  'understand_wahas_impact',
+  'understand_how_waha_works',
+  'get_coaching',
+  'see_god_transform_my_community',
+  'discover_whats_in_the_bible',
+  'find_hope_in_my_troubles',
+  'get_right_with_god',
+  'learn_more_about_jesus',
+])
+export type DesireId = z.infer<typeof DesireIdSchema>
+
+const WahaUserStateSchema = z.object({
+  wahaUserId: z.string().optional(),
+  name: z.string().optional(),
+  email: z.string().email().optional(),
+  location: WahaUserLocationSchema.optional(),
+  pastLocations: z.array(WahaUserLocationSchema).optional(),
+  phoneLocation: z.string().optional(),
+  isSubscribedToEmailUpdates: z.boolean().optional(),
+  pushToken: z.string().optional(),
+  notificationPermission: z.enum(['granted', 'undetermined', 'denied']),
+  utm: z.record(z.string(), z.string()).optional(),
+  firstOpen: z.number().optional(),
+  finishedOnboarding: z.number().optional(),
+  howFamiliarWithBible: z.number().optional(),
+  followingFor2Years: z.number().optional(),
+  notificationsClicked: z.number().optional(),
+  notificationLinksClicked: z.number().optional(),
+  isBeliever: z.boolean().optional(),
+  isInAGroup: z.boolean().optional(),
+  desires: z.array(DesireIdSchema).optional(),
+  customDesire: z.string().optional(),
+  isCCWorker: z.boolean().optional(),
+  isAdvocate: z.boolean().optional(),
+  onboardingStatus: z
+    .enum([
+      'skipped-from-first',
+      'skipped-from-second',
+      'finished-from-first',
+      'finished-from-second',
+      'finished-from-languages',
+    ])
+    .optional(),
+})
+
+export type WahaUserState = z.infer<typeof WahaUserStateSchema>
+
+const WahaAppVersionSchema = z.string().regex(/^\d+\.\d+\.\d+$/)
+
+const CompletionEventSchema = z.object({
+  lessonId: z.string(),
+  meetLanguageId: z.string(),
+  time: z.number(),
+  country: z.string().optional(),
+  region: z.string().optional(),
+  city: z.string().optional(),
+  /**
+   * Indicates that the lesson was completed manually from the lesson sheet
+   * rather than automatically by doing the lesson on the lesson screen.
+   */
+  manual: z.boolean().optional(),
+})
+
+export type CompletionEvent = z.infer<typeof CompletionEventSchema>
+
+const WahaShareContentSchema = z.enum([
+  'app',
+  'passcode',
+  'lessonAudio',
+  'lessonText',
+  'storyText',
+  'storyAudio',
+  'lessonLink',
+  'setLink',
+  'meetingInvite',
+  'articleLink',
+  'videoLink',
+  'notification',
+  'meetingSchedule',
+  'scriptureText',
+  'mt',
+  'scriptureAudio',
+  'inviteGroup',
+  'lesson',
+  'offlineVersionLink',
+  'note',
+  'customSet',
+])
+export type WahaShareContent = z.infer<typeof WahaShareContentSchema>
+
+const ShareLogEventSchema = z.object({
+  time: z.number(),
+  content: WahaShareContentSchema,
+  lessonId: z.string().optional(),
+  articleSlug: z.string().optional(),
+})
+
+export type ShareLogEvent = z.infer<typeof ShareLogEventSchema>
+
+const BibleSessionSchema = z.object({
+  chapter: z.string(),
+  timeSpent: z.number(),
+  startTime: z.number(),
+  translation: z.string(),
+})
+export type BibleSession = z.infer<typeof BibleSessionSchema>
+
+const ArticleSessionSchema = z.object({
+  articleSlug: z.string(),
+  timeSpent: z.number(),
+  startTime: z.number(),
+})
+export type ArticleSession = z.infer<typeof ArticleSessionSchema>
+
+// Zod schema for WahaUser extending WahaUserStateSchema
+export const WahaUserSchema = WahaUserStateSchema.extend({
+  pushToken: z.string().optional(),
+  securityModeOn: z.boolean().optional(),
+  appVersion: WahaAppVersionSchema,
+  lastUpdate: z.number(),
+  platform: z.string(),
+  completions: z.array(CompletionEventSchema),
+  trainingUnlocked: z.boolean().optional(),
+  meet: z.string(),
+  appInterface: z.string(),
+  meetFavorites: z.array(z.string()),
+  osVersion: z.string().nullable(),
+  isDev: z.boolean(),
+  shareLog: z.array(ShareLogEventSchema).optional(),
+  bibleSessions: z.array(BibleSessionSchema).optional(),
+  articleSessions: z.array(ArticleSessionSchema).optional(),
+  activated: z.boolean().optional(),
+})
+
+export const PushEnabledWahaUserSchema = WahaUserSchema.omit({
+  wahaUserId: true,
+  pushToken: true,
+  notificationPermission: true,
+}).extend({
+  wahaUserId: z.string(),
+  pushToken: z.string(),
+  notificationPermission: z.literal('granted'),
+})
+export type PushEnabledWahaUser = z.infer<typeof PushEnabledWahaUserSchema>
+
+// Type inferred from the Zod schema
+export type WahaUser = z.infer<typeof WahaUserSchema>