waha-shared 1.0.1 → 1.0.2

package/dist/types/analytics.d.ts

@@ -0,0 +1,119 @@
+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;
+export {};

package/dist/types/analytics.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/completions.d.ts

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

package/dist/types/completions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/feedback.d.ts

@@ -0,0 +1,60 @@
+import { z } from 'zod';
+export declare const FeedbackSchema: z.ZodObject<{
+    language: z.ZodString;
+    appVersion: z.ZodString;
+    OS: z.ZodString;
+    timeSubmitted: z.ZodNumber;
+    formName: z.ZodString;
+    country: z.ZodOptional<z.ZodString>;
+    city: z.ZodOptional<z.ZodString>;
+    lessonId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    wahaUserId: z.ZodOptional<z.ZodString>;
+    name: z.ZodOptional<z.ZodString>;
+    email: z.ZodString;
+    message: z.ZodOptional<z.ZodString>;
+    journey: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodBoolean>]>>;
+    goals: z.ZodOptional<z.ZodString>;
+    hear: z.ZodOptional<z.ZodString>;
+    beforeWaha: z.ZodOptional<z.ZodString>;
+    godDone: z.ZodOptional<z.ZodString>;
+    findOut: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    language: string;
+    email: string;
+    appVersion: string;
+    OS: string;
+    timeSubmitted: number;
+    formName: string;
+    message?: string | undefined;
+    name?: string | undefined;
+    city?: string | undefined;
+    lessonId?: string | null | undefined;
+    country?: string | undefined;
+    wahaUserId?: string | undefined;
+    journey?: string | Record<string, boolean> | undefined;
+    goals?: string | undefined;
+    hear?: string | undefined;
+    beforeWaha?: string | undefined;
+    godDone?: string | undefined;
+    findOut?: string | undefined;
+}, {
+    language: string;
+    email: string;
+    appVersion: string;
+    OS: string;
+    timeSubmitted: number;
+    formName: string;
+    message?: string | undefined;
+    name?: string | undefined;
+    city?: string | undefined;
+    lessonId?: string | null | undefined;
+    country?: string | undefined;
+    wahaUserId?: string | undefined;
+    journey?: string | Record<string, boolean> | undefined;
+    goals?: string | undefined;
+    hear?: string | undefined;
+    beforeWaha?: string | undefined;
+    godDone?: string | undefined;
+    findOut?: string | undefined;
+}>;
+export type Feedback = z.infer<typeof FeedbackSchema>;

package/dist/types/feedback.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FeedbackSchema = void 0;
+const zod_1 = require("zod");
+exports.FeedbackSchema = zod_1.z.object({
+    language: zod_1.z.string(),
+    appVersion: zod_1.z.string(),
+    OS: zod_1.z.string(),
+    timeSubmitted: zod_1.z.number(),
+    formName: zod_1.z.string(),
+    country: zod_1.z.string().optional(),
+    city: zod_1.z.string().optional(),
+    lessonId: zod_1.z.string().nullable().optional(),
+    wahaUserId: zod_1.z.string().optional(),
+    name: zod_1.z.string().optional(),
+    email: zod_1.z.string().email(),
+    // For the standard contact us form.
+    message: zod_1.z.string().optional(),
+    // For the code request form.
+    journey: zod_1.z.union([zod_1.z.string(), zod_1.z.record(zod_1.z.string(), zod_1.z.boolean())]).optional(),
+    goals: zod_1.z.string().optional(),
+    hear: zod_1.z.string().optional(),
+    // For the share story form.
+    beforeWaha: zod_1.z.string().optional(),
+    godDone: zod_1.z.string().optional(),
+    findOut: zod_1.z.string().optional(),
+});

package/dist/types/languages.d.ts

@@ -0,0 +1,31 @@
+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];
+}
+export {};

package/dist/types/languages.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/notifications.d.ts

@@ -0,0 +1,128 @@
+import { z } from 'zod';
+export declare const PushNotificationPayloadSchema: z.ZodObject<{
+    actionUrl: z.ZodOptional<z.ZodString>;
+    /**
+     * We want the full title, not the push title, to be attached to the
+     * notification.
+     */
+    title: z.ZodString;
+    /**
+     * We want the full body, not the push body, to be attached to the
+     * notification.
+     */
+    body: z.ZodString;
+    titleSource: z.ZodString;
+    bodySource: z.ZodString;
+    verified: z.ZodBoolean;
+    imageUrl: z.ZodOptional<z.ZodString>;
+    wahaUserId: z.ZodString;
+    date: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    date: string;
+    title: string;
+    body: string;
+    verified: boolean;
+    wahaUserId: string;
+    titleSource: string;
+    bodySource: string;
+    actionUrl?: string | undefined;
+    imageUrl?: string | undefined;
+}, {
+    date: string;
+    title: string;
+    body: string;
+    verified: boolean;
+    wahaUserId: string;
+    titleSource: string;
+    bodySource: string;
+    actionUrl?: string | undefined;
+    imageUrl?: string | undefined;
+}>;
+export type PushNotificationPayload = z.infer<typeof PushNotificationPayloadSchema>;
+export declare const PushNotificationRecordSchema: z.ZodObject<{
+    date: z.ZodString;
+    notification: z.ZodObject<{
+        title: z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNever]>>, Record<string, string>, Record<string, string>>;
+        body: z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNever]>>, Record<string, string>, Record<string, string>>;
+        actionUrl: z.ZodOptional<z.ZodString>;
+        countriesToNotSendTo: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        countriesToSendTo: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        faithJourney: z.ZodOptional<z.ZodEnum<["all", "seekers", "believers"]>>;
+        imageUrl: z.ZodOptional<z.ZodString>;
+        meetLanguages: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"all">, z.ZodArray<z.ZodString, "many">]>>;
+        minCompletions: z.ZodOptional<z.ZodNumber>;
+        pushBody: z.ZodOptional<z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNever]>>, Record<string, string>, Record<string, string>>>;
+        pushTitle: z.ZodOptional<z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNever]>>, Record<string, string>, Record<string, string>>>;
+        pushTokens: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        verified: z.ZodArray<z.ZodString, "many">;
+    }, "strict", z.ZodTypeAny, {
+        title: Record<string, string>;
+        body: Record<string, string>;
+        verified: string[];
+        actionUrl?: string | undefined;
+        countriesToNotSendTo?: string[] | undefined;
+        countriesToSendTo?: string[] | undefined;
+        faithJourney?: "all" | "seekers" | "believers" | undefined;
+        imageUrl?: string | undefined;
+        meetLanguages?: string[] | "all" | undefined;
+        minCompletions?: number | undefined;
+        pushBody?: Record<string, string> | undefined;
+        pushTitle?: Record<string, string> | undefined;
+        pushTokens?: string[] | undefined;
+    }, {
+        title: Record<string, string>;
+        body: Record<string, string>;
+        verified: string[];
+        actionUrl?: string | undefined;
+        countriesToNotSendTo?: string[] | undefined;
+        countriesToSendTo?: string[] | undefined;
+        faithJourney?: "all" | "seekers" | "believers" | undefined;
+        imageUrl?: string | undefined;
+        meetLanguages?: string[] | "all" | undefined;
+        minCompletions?: number | undefined;
+        pushBody?: Record<string, string> | undefined;
+        pushTitle?: Record<string, string> | undefined;
+        pushTokens?: string[] | undefined;
+    }>;
+    receivedTokens: z.ZodArray<z.ZodString, "many">;
+    receivedUserIds: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    date: string;
+    notification: {
+        title: Record<string, string>;
+        body: Record<string, string>;
+        verified: string[];
+        actionUrl?: string | undefined;
+        countriesToNotSendTo?: string[] | undefined;
+        countriesToSendTo?: string[] | undefined;
+        faithJourney?: "all" | "seekers" | "believers" | undefined;
+        imageUrl?: string | undefined;
+        meetLanguages?: string[] | "all" | undefined;
+        minCompletions?: number | undefined;
+        pushBody?: Record<string, string> | undefined;
+        pushTitle?: Record<string, string> | undefined;
+        pushTokens?: string[] | undefined;
+    };
+    receivedTokens: string[];
+    receivedUserIds: string[];
+}, {
+    date: string;
+    notification: {
+        title: Record<string, string>;
+        body: Record<string, string>;
+        verified: string[];
+        actionUrl?: string | undefined;
+        countriesToNotSendTo?: string[] | undefined;
+        countriesToSendTo?: string[] | undefined;
+        faithJourney?: "all" | "seekers" | "believers" | undefined;
+        imageUrl?: string | undefined;
+        meetLanguages?: string[] | "all" | undefined;
+        minCompletions?: number | undefined;
+        pushBody?: Record<string, string> | undefined;
+        pushTitle?: Record<string, string> | undefined;
+        pushTokens?: string[] | undefined;
+    };
+    receivedTokens: string[];
+    receivedUserIds: string[];
+}>;
+export type PushNotificationRecord = z.infer<typeof PushNotificationRecordSchema>;

package/dist/types/notifications.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PushNotificationRecordSchema = exports.PushNotificationPayloadSchema = void 0;
+const notification_1 = require("../data/typescript/notification");
+const zod_1 = require("zod");
+exports.PushNotificationPayloadSchema = zod_1.z.object({
+    actionUrl: zod_1.z.string().url().optional(),
+    /**
+     * We want the full title, not the push title, to be attached to the
+     * notification.
+     */
+    title: zod_1.z.string(),
+    /**
+     * We want the full body, not the push body, to be attached to the
+     * notification.
+     */
+    body: zod_1.z.string(),
+    titleSource: zod_1.z.string(),
+    bodySource: zod_1.z.string(),
+    verified: zod_1.z.boolean(),
+    imageUrl: zod_1.z.string().url().optional(),
+    wahaUserId: zod_1.z.string(),
+    date: zod_1.z.string(),
+});
+exports.PushNotificationRecordSchema = zod_1.z.object({
+    date: zod_1.z.string(),
+    notification: notification_1.notification,
+    receivedTokens: zod_1.z.array(zod_1.z.string()),
+    receivedUserIds: zod_1.z.array(zod_1.z.string()),
+});

package/dist/types/sets.d.ts

@@ -0,0 +1,70 @@
+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 {
+    meetLanguageId: Languages[number]['languageId'];
+    category: SetCategory;
+    setNumber: string;
+    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;
+    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';
+    eq: Content;
+}
+export type LessonInfo = DbsInfo | VideoInfo | EqInfo;
+export declare enum Chapter {
+    FELLOWSHIP = "f",
+    INTRODUCTION = "i",
+    STORY = "s",
+    APPLICATION = "a"
+}
+export {};

package/dist/types/sets.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Chapter = void 0;
+var Chapter;
+(function (Chapter) {
+    Chapter["FELLOWSHIP"] = "f";
+    Chapter["INTRODUCTION"] = "i";
+    Chapter["STORY"] = "s";
+    Chapter["APPLICATION"] = "a";
+})(Chapter || (exports.Chapter = Chapter = {}));