waha-shared 1.0.456 → 1.0.458

package/dist/types/users.js

@@ -1,149 +1,166 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PushEnabledWahaUser = exports.WahaUser = exports.ArticleSession = exports.BibleSession = exports.ShareLogEvent = exports.WahaShareContent = exports.CompletionEvent = exports.WahaAppVersion = exports.WahaUserState = exports.DesireId = void 0;
-const zod_1 = require("zod");
+exports.LegacyWahaUserFields = exports.LegacyWahaUser = exports.WahaUserFields = exports.WahaUser = exports.DeviceInfoFields = exports.DeviceInfo = exports.DevicePlatform = exports.WahaAppVersion = exports.UserReduxState = exports.DeviceUserReduxState = exports.SharedUserReduxState = exports.NotificationPermission = void 0;
+const zod_1 = __importDefault(require("zod"));
 const languages_zod_1 = require("../data/languages/languages.zod");
+const completions_1 = require("./completions");
 const location_1 = require("./location");
+const logs_1 = require("./logs");
 const microLessons_1 = require("./microLessons");
-const stoplight_1 = require("./stoplight");
-exports.DesireId = zod_1.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',
+exports.NotificationPermission = zod_1.default.enum([
+    'granted',
+    'undetermined',
+    'denied',
 ]);
-exports.WahaUserState = zod_1.z.object({
-    wahaUserId: zod_1.z.string().optional(),
-    name: zod_1.z.string().optional(),
-    email: zod_1.z.email().optional(),
-    location: location_1.WahaUserLocation.optional(),
-    pastLocations: zod_1.z.array(location_1.WahaUserLocation).optional(),
-    phoneLocation: zod_1.z.string().optional(),
-    isSubscribedToEmailUpdates: zod_1.z.boolean().optional(),
-    pushToken: zod_1.z.string().optional(),
-    notificationPermission: zod_1.z.enum(['granted', 'undetermined', 'denied']),
-    utm: zod_1.z.record(zod_1.z.string(), zod_1.z.string()).optional(),
-    firstOpen: zod_1.z.number().optional(),
-    finishedOnboarding: zod_1.z.number().optional(),
-    howFamiliarWithBible: zod_1.z.number().optional(),
-    followingFor2Years: zod_1.z.number().optional(),
-    notificationsClicked: zod_1.z.number().optional(),
-    notificationLinksClicked: zod_1.z.number().optional(),
-    isBeliever: zod_1.z.boolean().optional(),
-    isInAGroup: zod_1.z.boolean().optional(),
-    desires: zod_1.z.array(exports.DesireId).optional(),
-    customDesire: zod_1.z.string().optional(),
-    isCCWorker: zod_1.z.boolean().optional(),
-    isAdvocate: zod_1.z.boolean().optional(),
-    phoneNumber: zod_1.z.string().optional(),
-    engagementScore: zod_1.z.number().optional(),
-    hasDonated: zod_1.z.boolean().optional(),
-    lastDonationAsk: zod_1.z.number().optional(),
-    numberOfDonationAsks: zod_1.z.number().optional(),
-    lastSeenBannerAskNumber: zod_1.z.number().optional(),
-    onboardingStatus: zod_1.z
-        .enum([
-        'skipped-from-first',
-        'skipped-from-second',
-        'finished-from-first',
-        'finished-from-second',
-        'finished-from-languages',
-    ])
-        .optional(),
-});
-exports.WahaAppVersion = zod_1.z.string().regex(/^\d+\.\d+\.\d+$/);
-exports.CompletionEvent = zod_1.z.object({
-    lessonId: zod_1.z.string(),
-    meetLanguageId: languages_zod_1.LanguageId,
-    time: zod_1.z.number(),
-    country: zod_1.z.string().optional(),
-    region: zod_1.z.string().optional(),
-    city: zod_1.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: zod_1.z.boolean().optional(),
-    howManyObeyed: stoplight_1.StoplightOption.optional(),
-    howManyShared: stoplight_1.StoplightOption.optional(),
+/** User data that is shared across devices. */
+exports.SharedUserReduxState = zod_1.default
+    .object({
+    email: zod_1.default.email(),
+    location: location_1.WahaUserLocation,
+    phoneNumber: zod_1.default.string(),
+    isInAGroup: zod_1.default.boolean(),
+    isSubscribedToEmailUpdates: zod_1.default.boolean(),
+    hasDonated: zod_1.default.boolean(),
+})
+    .partial();
+/**
+ * User data that is device-specific.
+ */
+exports.DeviceUserReduxState = zod_1.default
+    .object({
+    pastLocations: zod_1.default.array(location_1.WahaUserLocation),
+    utm: zod_1.default.record(zod_1.default.string(), zod_1.default.string()),
+    engagementScore: zod_1.default.number(),
+    finishedOnboarding: zod_1.default.number(),
+    firstOpen: zod_1.default.number(),
+})
+    .partial();
+exports.UserReduxState = zod_1.default.object({
+    ...exports.SharedUserReduxState.shape,
+    ...exports.DeviceUserReduxState.shape,
 });
-exports.WahaShareContent = zod_1.z.enum([
-    'app',
-    'passcode',
-    'lessonAudio',
-    'lessonText',
-    'storyText',
-    'storyAudio',
-    'lessonLink',
-    'setLink',
-    'meetingInvite',
-    'meetingInviteOnboarding',
-    'articleLink',
-    'videoLink',
-    'notification',
-    'meetingSchedule',
-    'scriptureText',
-    'mt',
-    'scriptureAudio',
-    'inviteGroup',
-    'lesson',
-    'offlineVersionLink',
-    'note',
-    'customSet',
-    'microLesson',
+exports.WahaAppVersion = zod_1.default.string().regex(/^\d+\.\d+\.\d+$/);
+exports.DevicePlatform = zod_1.default.enum([
+    'ios',
+    'android',
+    'macos',
+    'windows',
+    'web',
 ]);
-exports.ShareLogEvent = zod_1.z.object({
-    time: zod_1.z.number(),
-    content: exports.WahaShareContent,
-    lessonId: zod_1.z.string().optional(),
-    articleSlug: zod_1.z.string().optional(),
-    microLessonSlug: zod_1.z.string().optional(),
-});
-exports.BibleSession = zod_1.z.object({
-    chapter: zod_1.z.string(),
-    timeSpent: zod_1.z.number(),
-    startTime: zod_1.z.number(),
-    translation: zod_1.z.string(),
+/**
+ * Everything known about a single device/install. One doc per device in the
+ * `users2/{uid}/devices/{deviceId}` subcollection.
+ */
+exports.DeviceInfo = exports.DeviceUserReduxState.extend({
+    phoneLocation: zod_1.default.string().optional(),
+    pushToken: zod_1.default.string().optional(),
+    notificationPermission: exports.NotificationPermission.optional(),
+    platform: exports.DevicePlatform,
+    osVersion: zod_1.default.union([zod_1.default.string(), zod_1.default.number()]),
+    appVersion: exports.WahaAppVersion,
+    securityModeOn: zod_1.default.boolean(),
+    lastUpdate: zod_1.default.number(),
 });
-exports.ArticleSession = zod_1.z.object({
-    articleSlug: zod_1.z.string(),
-    timeSpent: zod_1.z.number(),
-    startTime: zod_1.z.number(),
+exports.DeviceInfoFields = exports.DeviceInfo.keyof().enum;
+/**
+ * User object in Firestore. Subcollections (devices, completions, etc.) are
+ * not included in this schema. One doc per user in the `users2/{uid}`
+ * collection.
+ */
+exports.WahaUser = exports.SharedUserReduxState.extend({
+    /** Unique uid from Firebase auth state. */
+    wahaUserId: zod_1.default.string(),
+    /**
+     * The user's name. Sourced from Firebase auth `displayName`.
+     */
+    name: zod_1.default.string().optional(),
+    /** True once the user has a real (non-anonymous) credential attached. */
+    hasAccount: zod_1.default.boolean(),
+    /**
+     * User's most recently used meet language. Not synced between devices, only
+     * useful for CRM purposes. From meetLanguage redux reducer.
+     */
+    meet: languages_zod_1.LanguageId,
+    /** From `__DEV__`. */
+    isDev: zod_1.default.boolean(),
+    /**
+     * Whether user has done a lesson within the first 2 weeks of downloading the
+     * app. Derived from first open and completions. See useUpdateUserData.ts.
+     */
+    activated: zod_1.default.boolean().optional(),
+    /**
+     * See useUserScores.ts. Derived from completions.
+     */
+    obedienceScore: zod_1.default.number().optional(),
+    /**
+     * See useUserScores.ts. Derived from completions.
+     */
+    sharingScore: zod_1.default.number().optional(),
+    /**
+     * Whether the user is a potential Waha advocate. Phone location = US and IP
+     * location = US. Derived from location data.
+     */
+    isAdvocate: zod_1.default.boolean().optional(),
+    /**
+     * Whether the user is a potential cross-cultural worker. Phone location = US
+     * and IP location != US. Derived from location data.
+     */
+    isCCWorker: zod_1.default.boolean().optional(),
+    /** The last time the user's data was updated. Auto-set. */
+    lastUpdate: zod_1.default.number(),
 });
-exports.WahaUser = exports.WahaUserState.extend({
-    pushToken: zod_1.z.string().optional(),
-    securityModeOn: zod_1.z.boolean().optional(),
+exports.WahaUserFields = exports.WahaUser.keyof().enum;
+/**
+ * The legacy user object before version 9.
+ */
+exports.LegacyWahaUser = zod_1.default.object({
+    wahaUserId: zod_1.default.string(),
+    name: zod_1.default.string().optional(),
+    email: zod_1.default.email().optional(),
+    location: location_1.WahaUserLocation.optional(),
+    pastLocations: zod_1.default.array(location_1.WahaUserLocation).optional(),
+    phoneLocation: zod_1.default.string().optional(),
+    isSubscribedToEmailUpdates: zod_1.default.boolean().optional(),
+    pushToken: zod_1.default.string().optional(),
+    notificationPermission: exports.NotificationPermission.optional(),
+    utm: zod_1.default.record(zod_1.default.string(), zod_1.default.string()).optional(),
+    firstOpen: zod_1.default.number().optional(),
+    finishedOnboarding: zod_1.default.number().optional(),
+    howFamiliarWithBible: zod_1.default.number().optional(),
+    followingFor2Years: zod_1.default.number().optional(),
+    notificationsClicked: zod_1.default.number().optional(),
+    notificationLinksClicked: zod_1.default.number().optional(),
+    isBeliever: zod_1.default.boolean().optional(),
+    isInAGroup: zod_1.default.boolean().optional(),
+    customDesire: zod_1.default.string().optional(),
+    isCCWorker: zod_1.default.boolean().optional(),
+    isAdvocate: zod_1.default.boolean().optional(),
+    phoneNumber: zod_1.default.string().optional(),
+    engagementScore: zod_1.default.number().optional(),
+    hasDonated: zod_1.default.boolean().optional(),
+    lastDonationAsk: zod_1.default.number().optional(),
+    numberOfDonationAsks: zod_1.default.number().optional(),
+    lastSeenBannerAskNumber: zod_1.default.number().optional(),
+    securityModeOn: zod_1.default.boolean().optional(),
     appVersion: exports.WahaAppVersion,
-    lastUpdate: zod_1.z.number(),
-    platform: zod_1.z.string(),
-    completions: zod_1.z.array(exports.CompletionEvent),
-    trainingUnlocked: zod_1.z.boolean().optional(),
+    lastUpdate: zod_1.default.number(),
+    platform: exports.DevicePlatform,
+    completions: zod_1.default.array(completions_1.CompletionEvent),
+    trainingUnlocked: zod_1.default.boolean().optional(),
     meet: languages_zod_1.LanguageId,
     appInterface: languages_zod_1.LanguageId,
-    meetFavorites: zod_1.z.array(languages_zod_1.LanguageId),
-    osVersion: zod_1.z.string().nullable(),
-    isDev: zod_1.z.boolean(),
-    shareLog: zod_1.z.array(exports.ShareLogEvent).optional(),
-    bibleSessions: zod_1.z.array(exports.BibleSession).optional(),
-    articleSessions: zod_1.z.array(exports.ArticleSession).optional(),
-    activated: zod_1.z.boolean().optional(),
-    microLessonCompletions: zod_1.z.array(microLessons_1.MicroLessonSubmission).optional(),
-    obedienceScore: zod_1.z.number().optional(),
-    sharingScore: zod_1.z.number().optional(),
-});
-exports.PushEnabledWahaUser = exports.WahaUser.omit({
-    wahaUserId: true,
-    pushToken: true,
-    notificationPermission: true,
-}).extend({
-    wahaUserId: zod_1.z.string(),
-    pushToken: zod_1.z.string(),
-    notificationPermission: zod_1.z.literal('granted'),
+    meetFavorites: zod_1.default.array(languages_zod_1.LanguageId),
+    osVersion: zod_1.default.union([zod_1.default.string(), zod_1.default.number()]).nullable(),
+    isDev: zod_1.default.boolean(),
+    shareLog: zod_1.default.array(logs_1.ShareLogEvent).optional(),
+    bibleSessions: zod_1.default.array(logs_1.BibleSession).optional(),
+    articleSessions: zod_1.default.array(logs_1.ArticleSession).optional(),
+    activated: zod_1.default.boolean().optional(),
+    microLessonCompletions: zod_1.default.array(microLessons_1.MicroLessonSubmission).optional(),
+    obedienceScore: zod_1.default.number().optional(),
+    sharingScore: zod_1.default.number().optional(),
 });
+exports.LegacyWahaUserFields = exports.LegacyWahaUser.keyof().enum;

package/package.json

@@ -1,23 +1,23 @@
 {
   "name": "waha-shared",
-  "version": "1.0.456",
+  "version": "1.0.458",
   "author": "Waha",
   "dependencies": {
+    "@types/react": "^19.2.18",
     "@types/signale": "^1.4.7",
-    "signale": "^1.4.0"
+    "react": "^19.2.8",
+    "signale": "^1.4.0",
+    "zod": "^4.5.4"
   },
   "peerDependencies": {
-    "@types/react": "^18.2.0",
-    "react": "^18.2.0",
-    "zod": ">=4.0.0"
+    "@types/react": ">=18.2.0",
+    "react": ">=18.2.0",
+    "zod": ">=4.3.6"
   },
   "description": "Shared assets for Waha's various apps",
   "devDependencies": {
-    "@types/react": "^18.2.0",
     "copyfiles": "^2.4.1",
-    "react": "^18.2.0",
-    "typescript": "~5.9.2",
-    "zod": "^4.3.6"
+    "typescript": "~5.9.2"
   },
   "files": [
     "dist",