waha-shared 1.0.457 → 1.0.458

package/dist/functions/userPaths.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.userPaths = exports.SYNCED_SCALARS = exports.SYNCED_SUBCOLLECTIONS = exports.DEVICES_SUBCOLLECTION = exports.USERS_COLLECTION = void 0;
+const zod_1 = require("zod");
+const languages_zod_1 = require("../data/languages/languages.zod");
+const bookmarks_1 = require("../types/bookmarks");
+const completions_1 = require("../types/completions");
+const meetFavorites_1 = require("../types/meetFavorites");
+const notes_1 = require("../types/notes");
+/** Top-level collection holding one document per Waha user. */
+exports.USERS_COLLECTION = 'users2';
+/**
+ * The per-device subcollection segment under a user doc.
+ */
+exports.DEVICES_SUBCOLLECTION = 'devices';
+/**
+ * The per-item, 2-way-synced subcollections under a user doc, each paired with
+ * the Zod schema its docs are validated against.
+ */
+exports.SYNCED_SUBCOLLECTIONS = {
+    completions: { segment: 'completions', schema: completions_1.CompletionEvent },
+    bookmarks: { segment: 'bookmarks', schema: bookmarks_1.Bookmark },
+    notes: { segment: 'notes', schema: notes_1.Note },
+    meetFavorites: {
+        segment: 'meetFavorites',
+        schema: meetFavorites_1.MeetFavorite,
+    },
+};
+/** Synced scalar docs (shape `{ value }`). */
+exports.SYNCED_SCALARS = {
+    trainingUnlocked: { segment: 'synced/trainingUnlocked', schema: zod_1.z.boolean() },
+    appLanguage: { segment: 'synced/appLanguage', schema: languages_zod_1.LanguageId },
+};
+/**
+ * Builds every Firestore path under a single user's document. Path strings work
+ * with both the admin and react-native Firestore SDKs, so this is shared.
+ */
+const userPaths = (uid) => {
+    const base = `${exports.USERS_COLLECTION}/${uid}`;
+    /** Join arbitrary segments onto the user doc, e.g. `child('devices', id)` */
+    const child = (...segments) => [base, ...segments].join('/');
+    return {
+        // The user document itself: `users2/{uid}`
+        base,
+        // The `devices` subcollection
+        devices: child(exports.DEVICES_SUBCOLLECTION),
+        device: (deviceId) => child(exports.DEVICES_SUBCOLLECTION, deviceId),
+        syncedSubcollection: (key) => child(exports.SYNCED_SUBCOLLECTIONS[key].segment),
+        // A single doc within a synced subcollection
+        syncedSubcollectionDoc: (key, id) => child(exports.SYNCED_SUBCOLLECTIONS[key].segment, id),
+        // A synced scalar doc
+        syncedScalar: (key) => child(exports.SYNCED_SCALARS[key].segment),
+    };
+};
+exports.userPaths = userPaths;

package/dist/types/analytics.d.ts

@@ -1,7 +1,7 @@
 import z from 'zod';
 import type { LanguageId } from '../data/languages/languages.zod';
+import type { ArticleSession, BibleSession, WahaShareContent } from './logs';
 import { StoplightOption } from './stoplight';
-import type { ArticleSession, BibleSession, WahaShareContent } from './users';
 export interface BaseEventParams {
     meetLanguageId: LanguageId;
     appInterfaceLanguageId: LanguageId;
@@ -59,6 +59,8 @@ type Share = {
     payload: {
         content: WahaShareContent;
         lessonId?: string;
+        articleSlug?: string;
+        microLessonSlug?: string;
     };
 };
 type Misc = {

package/dist/types/bibleChapters.d.ts

@@ -20,6 +20,14 @@ export declare const BibleChapter: z.ZodObject<{
     }, z.core.$strict>>;
 }, z.core.$strict>;
 export type BibleChapter = z.infer<typeof BibleChapter>;
+export declare const BibleChapterFields: {
+    verses: "verses";
+    titles: "titles";
+    bookName: "bookName";
+    chapterId: "chapterId";
+    reference: "reference";
+    translationId: "translationId";
+};
 export declare const BibleChapters: z.ZodArray<z.ZodObject<{
     bookName: z.ZodString;
     chapterId: z.ZodString;

package/dist/types/bibleChapters.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BibleChapters = exports.BibleChapter = exports.BibleVerse = void 0;
+exports.BibleChapters = exports.BibleChapterFields = exports.BibleChapter = exports.BibleVerse = void 0;
 const zod_1 = require("zod");
 exports.BibleVerse = zod_1.z
     .object({
@@ -24,4 +24,5 @@ exports.BibleChapter = zod_1.z
     verses: zod_1.z.array(exports.BibleVerse).min(1),
 })
     .strict();
+exports.BibleChapterFields = exports.BibleChapter.keyof().enum;
 exports.BibleChapters = zod_1.z.array(exports.BibleChapter);

package/dist/types/bookmarks.d.ts

@@ -0,0 +1,23 @@
+import { z } from 'zod';
+export declare const BookmarkIconName: z.ZodEnum<{
+    leaf: "leaf";
+    stars: "stars";
+    apple: "apple";
+    fish: "fish";
+    sunny: "sunny";
+}>;
+export type BookmarkIconName = z.infer<typeof BookmarkIconName>;
+export declare const bookmarkIcons: ("leaf" | "stars" | "apple" | "fish" | "sunny")[];
+/** A single bookmarked lesson. Keyed in Firestore by `icon`. */
+export declare const Bookmark: z.ZodObject<{
+    icon: z.ZodEnum<{
+        leaf: "leaf";
+        stars: "stars";
+        apple: "apple";
+        fish: "fish";
+        sunny: "sunny";
+    }>;
+    languageId: z.ZodString;
+    lessonId: z.ZodString;
+}, z.core.$strip>;
+export type Bookmark = z.infer<typeof Bookmark>;

package/dist/types/bookmarks.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Bookmark = exports.bookmarkIcons = exports.BookmarkIconName = void 0;
+const zod_1 = require("zod");
+const languages_zod_1 = require("../data/languages/languages.zod");
+exports.BookmarkIconName = zod_1.z.enum([
+    'leaf',
+    'stars',
+    'apple',
+    'fish',
+    'sunny',
+]);
+exports.bookmarkIcons = exports.BookmarkIconName.options;
+/** A single bookmarked lesson. Keyed in Firestore by `icon`. */
+exports.Bookmark = zod_1.z.object({
+    icon: exports.BookmarkIconName,
+    languageId: languages_zod_1.LanguageId,
+    lessonId: zod_1.z.string(),
+});

package/dist/types/completions.d.ts

@@ -1,4 +1,4 @@
-import type { CompletionEvent } from './users';
+import z from 'zod';
 export interface SetProgress {
     completionEvents: CompletionEvent[];
     uniqueCompletions: CompletionEvent[];
@@ -6,3 +6,34 @@ export interface SetProgress {
     progress: number;
     percent: number;
 }
+export declare const CompletionEvent: z.ZodObject<{
+    lessonId: z.ZodString;
+    meetLanguageId: z.ZodString;
+    time: z.ZodNumber;
+    country: z.ZodOptional<z.ZodString>;
+    region: z.ZodOptional<z.ZodString>;
+    city: z.ZodOptional<z.ZodString>;
+    manual: z.ZodOptional<z.ZodBoolean>;
+    howManyObeyed: z.ZodOptional<z.ZodEnum<{
+        red: "red";
+        yellow: "yellow";
+        green: "green";
+    }>>;
+    howManyShared: z.ZodOptional<z.ZodEnum<{
+        red: "red";
+        yellow: "yellow";
+        green: "green";
+    }>>;
+}, z.core.$strip>;
+export type CompletionEvent = z.infer<typeof CompletionEvent>;
+export declare const CompletionEventFields: {
+    city: "city";
+    lessonId: "lessonId";
+    meetLanguageId: "meetLanguageId";
+    time: "time";
+    country: "country";
+    region: "region";
+    manual: "manual";
+    howManyObeyed: "howManyObeyed";
+    howManyShared: "howManyShared";
+};

package/dist/types/completions.js

@@ -1,2 +1,24 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CompletionEventFields = exports.CompletionEvent = void 0;
+const zod_1 = __importDefault(require("zod"));
+const languages_zod_1 = require("../data/languages/languages.zod");
+const stoplight_1 = require("./stoplight");
+exports.CompletionEvent = zod_1.default.object({
+    lessonId: zod_1.default.string(),
+    meetLanguageId: languages_zod_1.LanguageId,
+    time: zod_1.default.number(),
+    country: zod_1.default.string().optional(),
+    region: zod_1.default.string().optional(),
+    city: zod_1.default.string().optional(),
+    manual: zod_1.default
+        .boolean()
+        .optional()
+        .describe('Indicates that the lesson was completed manually from the lesson sheet rather than automatically by doing the lesson on the lesson screen.'),
+    howManyObeyed: stoplight_1.StoplightOption.optional(),
+    howManyShared: stoplight_1.StoplightOption.optional(),
+});
+exports.CompletionEventFields = exports.CompletionEvent.keyof().enum;

package/dist/types/logs.d.ts

@@ -0,0 +1,83 @@
+import z from 'zod';
+export declare const WahaShareContent: z.ZodEnum<{
+    lesson: "lesson";
+    note: "note";
+    setLink: "setLink";
+    lessonLink: "lessonLink";
+    app: "app";
+    passcode: "passcode";
+    lessonAudio: "lessonAudio";
+    lessonText: "lessonText";
+    storyText: "storyText";
+    storyAudio: "storyAudio";
+    meetingInvite: "meetingInvite";
+    meetingInviteOnboarding: "meetingInviteOnboarding";
+    articleLink: "articleLink";
+    videoLink: "videoLink";
+    notification: "notification";
+    meetingSchedule: "meetingSchedule";
+    scriptureText: "scriptureText";
+    mt: "mt";
+    scriptureAudio: "scriptureAudio";
+    inviteGroup: "inviteGroup";
+    offlineVersionLink: "offlineVersionLink";
+    customSet: "customSet";
+    microLesson: "microLesson";
+}>;
+export type WahaShareContent = z.infer<typeof WahaShareContent>;
+export declare const ShareLogEvent: z.ZodObject<{
+    time: z.ZodNumber;
+    content: z.ZodEnum<{
+        lesson: "lesson";
+        note: "note";
+        setLink: "setLink";
+        lessonLink: "lessonLink";
+        app: "app";
+        passcode: "passcode";
+        lessonAudio: "lessonAudio";
+        lessonText: "lessonText";
+        storyText: "storyText";
+        storyAudio: "storyAudio";
+        meetingInvite: "meetingInvite";
+        meetingInviteOnboarding: "meetingInviteOnboarding";
+        articleLink: "articleLink";
+        videoLink: "videoLink";
+        notification: "notification";
+        meetingSchedule: "meetingSchedule";
+        scriptureText: "scriptureText";
+        mt: "mt";
+        scriptureAudio: "scriptureAudio";
+        inviteGroup: "inviteGroup";
+        offlineVersionLink: "offlineVersionLink";
+        customSet: "customSet";
+        microLesson: "microLesson";
+    }>;
+    lessonId: z.ZodOptional<z.ZodString>;
+    articleSlug: z.ZodOptional<z.ZodString>;
+    microLessonSlug: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type ShareLogEvent = z.infer<typeof ShareLogEvent>;
+export declare const BibleSession: z.ZodObject<{
+    chapter: z.ZodString;
+    timeSpent: z.ZodNumber;
+    startTime: z.ZodNumber;
+    translation: z.ZodString;
+}, z.core.$strip>;
+export type BibleSession = z.infer<typeof BibleSession>;
+export declare const BibleSessionFields: {
+    chapter: "chapter";
+    startTime: "startTime";
+    timeSpent: "timeSpent";
+    translation: "translation";
+};
+export declare const ArticleSession: z.ZodObject<{
+    articleSlug: z.ZodString;
+    timeSpent: z.ZodNumber;
+    startTime: z.ZodNumber;
+}, z.core.$strip>;
+export type ArticleSession = z.infer<typeof ArticleSession>;
+export declare const ArticleSessionFields: {
+    startTime: "startTime";
+    articleSlug: "articleSlug";
+    timeSpent: "timeSpent";
+};

package/dist/types/logs.js

@@ -0,0 +1,52 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArticleSessionFields = exports.ArticleSession = exports.BibleSessionFields = exports.BibleSession = exports.ShareLogEvent = exports.WahaShareContent = void 0;
+const zod_1 = __importDefault(require("zod"));
+exports.WahaShareContent = zod_1.default.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.ShareLogEvent = zod_1.default.object({
+    time: zod_1.default.number(),
+    content: exports.WahaShareContent,
+    lessonId: zod_1.default.string().optional(),
+    articleSlug: zod_1.default.string().optional(),
+    microLessonSlug: zod_1.default.string().optional(),
+});
+exports.BibleSession = zod_1.default.object({
+    chapter: zod_1.default.string(),
+    timeSpent: zod_1.default.number(),
+    startTime: zod_1.default.number(),
+    translation: zod_1.default.string(),
+});
+exports.BibleSessionFields = exports.BibleSession.keyof().enum;
+exports.ArticleSession = zod_1.default.object({
+    articleSlug: zod_1.default.string(),
+    timeSpent: zod_1.default.number(),
+    startTime: zod_1.default.number(),
+});
+exports.ArticleSessionFields = exports.ArticleSession.keyof().enum;

package/dist/types/meetFavorites.d.ts

@@ -0,0 +1,10 @@
+import { z } from 'zod';
+/**
+ * A single favorited meet language. Stored this way both locally and as its own
+ * Firestore doc (`meetFavorites/{languageId}`), so the local slice mirrors the
+ * subcollection exactly — like completions/bookmarks/notes.
+ */
+export declare const MeetFavorite: z.ZodObject<{
+    languageId: z.ZodString;
+}, z.core.$strip>;
+export type MeetFavorite = z.infer<typeof MeetFavorite>;

package/dist/types/meetFavorites.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MeetFavorite = void 0;
+const zod_1 = require("zod");
+const languages_zod_1 = require("../data/languages/languages.zod");
+/**
+ * A single favorited meet language. Stored this way both locally and as its own
+ * Firestore doc (`meetFavorites/{languageId}`), so the local slice mirrors the
+ * subcollection exactly — like completions/bookmarks/notes.
+ */
+exports.MeetFavorite = zod_1.z.object({ languageId: languages_zod_1.LanguageId });

package/dist/types/notes.d.ts

@@ -0,0 +1,10 @@
+import { z } from 'zod';
+/** A single user note. Keyed in Firestore by `sessionId`. */
+export declare const Note: z.ZodObject<{
+    sessionId: z.ZodString;
+    content: z.ZodString;
+    createdAt: z.ZodNumber;
+    lessonId: z.ZodString;
+    languageId: z.ZodString;
+}, z.core.$strip>;
+export type Note = z.infer<typeof Note>;

package/dist/types/notes.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Note = void 0;
+const zod_1 = require("zod");
+const languages_zod_1 = require("../data/languages/languages.zod");
+/** A single user note. Keyed in Firestore by `sessionId`. */
+exports.Note = zod_1.z.object({
+    sessionId: zod_1.z.string(),
+    content: zod_1.z.string(),
+    createdAt: zod_1.z.number(),
+    lessonId: zod_1.z.string(),
+    languageId: languages_zod_1.LanguageId,
+});