waha-shared 1.0.19 → 1.0.21

package/dist/types/analytics.d.ts

@@ -115,5 +115,23 @@ type Bible = {
     name: 'BibleSession';
     payload: BibleSession;
 };
-export type AnalyticsEvent = Meeting | Share | Misc | Article | Bible | Note;
+type Worksheets = {
+    name: 'WorksheetNotificationResponse';
+    payload: {
+        worksheetId: string;
+        didApply: boolean;
+    };
+} | {
+    name: 'WorksheetStart';
+    payload: {
+        worksheetId: string;
+    };
+} | {
+    name: 'WorksheetComplete';
+    payload: {
+        worksheetId: string;
+        timeToCompletion: number;
+    };
+};
+export type AnalyticsEvent = Meeting | Share | Misc | Article | Bible | Note | Worksheets;
 export {};

package/dist/types/notifications.d.ts

@@ -1,5 +1,6 @@
 import { z } from 'zod';
 export declare const PushNotificationPayloadSchema: z.ZodObject<{
+    /** Optional URL to open when the primary notification action is taken. */
     actionUrl: z.ZodOptional<z.ZodString>;
     /**
      * We want the full title, not the push title, to be attached to the
@@ -14,29 +15,38 @@ export declare const PushNotificationPayloadSchema: z.ZodObject<{
     titleSource: z.ZodString;
     bodySource: z.ZodString;
     verified: z.ZodBoolean;
+    /**
+     * Either a remote url to an image to show with the notification or the name
+     * of a waha icon. See [SVG.tsx](src/components/General/SVG.tsx) for supported
+     * icons.
+     */
     imageUrl: z.ZodOptional<z.ZodString>;
-    wahaUserId: z.ZodString;
+    wahaUserId: z.ZodOptional<z.ZodString>;
+    /**
+     * ISO string date in a special format. See [toIsoString
+     * function](src/functions/dates.ts).
+     */
     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;
+    wahaUserId?: string | undefined;
 }, {
     date: string;
     title: string;
     body: string;
     verified: boolean;
-    wahaUserId: string;
     titleSource: string;
     bodySource: string;
     actionUrl?: string | undefined;
     imageUrl?: string | undefined;
+    wahaUserId?: string | undefined;
 }>;
 export type PushNotificationPayload = z.infer<typeof PushNotificationPayloadSchema>;
 export declare const PushNotificationRecordSchema: z.ZodObject<{

package/dist/types/notifications.js

@@ -4,6 +4,7 @@ exports.PushNotificationRecordSchema = exports.PushNotificationPayloadSchema = v
 const zod_1 = require("zod");
 const notification_1 = require("../data/typescript/notification");
 exports.PushNotificationPayloadSchema = zod_1.z.object({
+    /** Optional URL to open when the primary notification action is taken. */
     actionUrl: zod_1.z.string().url().optional(),
     /**
      * We want the full title, not the push title, to be attached to the
@@ -18,8 +19,21 @@ exports.PushNotificationPayloadSchema = zod_1.z.object({
     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(),
+    /**
+     * Either a remote url to an image to show with the notification or the name
+     * of a waha icon. See [SVG.tsx](src/components/General/SVG.tsx) for supported
+     * icons.
+     */
+    imageUrl: zod_1.z
+        .string()
+        .url()
+        .optional()
+        .describe('URL of an image to show with the notification.'),
+    wahaUserId: zod_1.z.string().optional(),
+    /**
+     * ISO string date in a special format. See [toIsoString
+     * function](src/functions/dates.ts).
+     */
     date: zod_1.z.string(),
 });
 exports.PushNotificationRecordSchema = zod_1.z.object({

package/dist/types/sets.d.ts

@@ -47,6 +47,7 @@ export interface DbsInfo extends BaseInfo, SetInfo, Lesson {
     };
     lessonIntroduction: string | undefined;
     passagesString: string;
+    sectionTimings: Map<string, number>;
 }
 export interface VideoInfo extends BaseInfo, SetInfo, Lesson {
     type: 'video';

package/dist/types/users.d.ts

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+export type FaithJourney = 'seekers' | 'believers' | 'all';
 export declare const WahaUserLocationSchema: z.ZodObject<{
     city: z.ZodOptional<z.ZodString>;
     country: z.ZodOptional<z.ZodString>;
@@ -161,6 +162,67 @@ export declare const CompletionEventSchema: z.ZodObject<{
     manual?: boolean | undefined;
 }>;
 export type CompletionEvent = z.infer<typeof CompletionEventSchema>;
+declare const WorksheetAnswerSchema: z.ZodObject<{
+    question: z.ZodString;
+    answer: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    question: string;
+    answer: string;
+}, {
+    question: string;
+    answer: string;
+}>;
+export type WorksheetAnswer = z.infer<typeof WorksheetAnswerSchema>;
+declare const WorksheetCompletionEventSchema: z.ZodObject<{
+    startTime: z.ZodNumber;
+    completionTime: z.ZodOptional<z.ZodNumber>;
+    worksheetId: z.ZodString;
+    answers: z.ZodArray<z.ZodObject<{
+        question: z.ZodString;
+        answer: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        question: string;
+        answer: string;
+    }, {
+        question: string;
+        answer: string;
+    }>, "many">;
+    country: z.ZodOptional<z.ZodString>;
+    region: z.ZodOptional<z.ZodString>;
+    city: z.ZodOptional<z.ZodString>;
+    didApply: z.ZodOptional<z.ZodBoolean>;
+    notificationText: z.ZodOptional<z.ZodString>;
+    feedback: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    startTime: number;
+    worksheetId: string;
+    answers: {
+        question: string;
+        answer: string;
+    }[];
+    city?: string | undefined;
+    country?: string | undefined;
+    region?: string | undefined;
+    completionTime?: number | undefined;
+    didApply?: boolean | undefined;
+    notificationText?: string | undefined;
+    feedback?: string | undefined;
+}, {
+    startTime: number;
+    worksheetId: string;
+    answers: {
+        question: string;
+        answer: string;
+    }[];
+    city?: string | undefined;
+    country?: string | undefined;
+    region?: string | undefined;
+    completionTime?: number | undefined;
+    didApply?: boolean | undefined;
+    notificationText?: string | undefined;
+    feedback?: string | undefined;
+}>;
+export type WorksheetCompletionEvent = z.infer<typeof WorksheetCompletionEventSchema>;
 export declare const WahaShareContentSchema: z.ZodEnum<["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>;
 export declare const ShareLogEventSchema: z.ZodObject<{
@@ -187,13 +249,13 @@ export declare const BibleSessionSchema: z.ZodObject<{
     translation: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     chapter: string;
-    timeSpent: number;
     startTime: number;
+    timeSpent: number;
     translation: string;
 }, {
     chapter: string;
-    timeSpent: number;
     startTime: number;
+    timeSpent: number;
     translation: string;
 }>;
 export type BibleSession = z.infer<typeof BibleSessionSchema>;
@@ -202,13 +264,13 @@ export declare const ArticleSessionSchema: z.ZodObject<{
     timeSpent: z.ZodNumber;
     startTime: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
+    startTime: number;
     articleSlug: string;
     timeSpent: number;
-    startTime: number;
 }, {
+    startTime: number;
     articleSlug: string;
     timeSpent: number;
-    startTime: number;
 }>;
 export type ArticleSession = z.infer<typeof ArticleSessionSchema>;
 export declare const WahaUserSchema: z.ZodObject<{
@@ -322,13 +384,13 @@ export declare const WahaUserSchema: z.ZodObject<{
         translation: z.ZodString;
     }, "strip", z.ZodTypeAny, {
         chapter: string;
-        timeSpent: number;
         startTime: number;
+        timeSpent: number;
         translation: string;
     }, {
         chapter: string;
-        timeSpent: number;
         startTime: number;
+        timeSpent: number;
         translation: string;
     }>, "many">>;
     articleSessions: z.ZodOptional<z.ZodArray<z.ZodObject<{
@@ -336,15 +398,56 @@ export declare const WahaUserSchema: z.ZodObject<{
         timeSpent: z.ZodNumber;
         startTime: z.ZodNumber;
     }, "strip", z.ZodTypeAny, {
+        startTime: number;
         articleSlug: string;
         timeSpent: number;
-        startTime: number;
     }, {
+        startTime: number;
         articleSlug: string;
         timeSpent: number;
-        startTime: number;
     }>, "many">>;
     activated: z.ZodOptional<z.ZodBoolean>;
+    worksheetCompletions: z.ZodOptional<z.ZodArray<z.ZodObject<Omit<{
+        startTime: z.ZodNumber;
+        completionTime: z.ZodOptional<z.ZodNumber>;
+        worksheetId: z.ZodString;
+        answers: z.ZodArray<z.ZodObject<{
+            question: z.ZodString;
+            answer: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            question: string;
+            answer: string;
+        }, {
+            question: string;
+            answer: string;
+        }>, "many">;
+        country: z.ZodOptional<z.ZodString>;
+        region: z.ZodOptional<z.ZodString>;
+        city: z.ZodOptional<z.ZodString>;
+        didApply: z.ZodOptional<z.ZodBoolean>;
+        notificationText: z.ZodOptional<z.ZodString>;
+        feedback: z.ZodOptional<z.ZodString>;
+    }, "answers">, "strip", z.ZodTypeAny, {
+        startTime: number;
+        worksheetId: string;
+        city?: string | undefined;
+        country?: string | undefined;
+        region?: string | undefined;
+        completionTime?: number | undefined;
+        didApply?: boolean | undefined;
+        notificationText?: string | undefined;
+        feedback?: string | undefined;
+    }, {
+        startTime: number;
+        worksheetId: string;
+        city?: string | undefined;
+        country?: string | undefined;
+        region?: string | undefined;
+        completionTime?: number | undefined;
+        didApply?: boolean | undefined;
+        notificationText?: string | undefined;
+        feedback?: string | undefined;
+    }>, "many">>;
 }, "strip", z.ZodTypeAny, {
     appInterface: string;
     meet: string;
@@ -404,16 +507,27 @@ export declare const WahaUserSchema: z.ZodObject<{
     }[] | undefined;
     bibleSessions?: {
         chapter: string;
-        timeSpent: number;
         startTime: number;
+        timeSpent: number;
         translation: string;
     }[] | undefined;
     articleSessions?: {
+        startTime: number;
         articleSlug: string;
         timeSpent: number;
-        startTime: number;
     }[] | undefined;
     activated?: boolean | undefined;
+    worksheetCompletions?: {
+        startTime: number;
+        worksheetId: string;
+        city?: string | undefined;
+        country?: string | undefined;
+        region?: string | undefined;
+        completionTime?: number | undefined;
+        didApply?: boolean | undefined;
+        notificationText?: string | undefined;
+        feedback?: string | undefined;
+    }[] | undefined;
 }, {
     appInterface: string;
     meet: string;
@@ -473,16 +587,27 @@ export declare const WahaUserSchema: z.ZodObject<{
     }[] | undefined;
     bibleSessions?: {
         chapter: string;
-        timeSpent: number;
         startTime: number;
+        timeSpent: number;
         translation: string;
     }[] | undefined;
     articleSessions?: {
+        startTime: number;
         articleSlug: string;
         timeSpent: number;
-        startTime: number;
     }[] | undefined;
     activated?: boolean | undefined;
+    worksheetCompletions?: {
+        startTime: number;
+        worksheetId: string;
+        city?: string | undefined;
+        country?: string | undefined;
+        region?: string | undefined;
+        completionTime?: number | undefined;
+        didApply?: boolean | undefined;
+        notificationText?: string | undefined;
+        feedback?: string | undefined;
+    }[] | undefined;
 }>;
 export declare const PushEnabledWahaUserSchema: z.ZodObject<Omit<{
     wahaUserId: z.ZodOptional<z.ZodString>;
@@ -595,13 +720,13 @@ export declare const PushEnabledWahaUserSchema: z.ZodObject<Omit<{
         translation: z.ZodString;
     }, "strip", z.ZodTypeAny, {
         chapter: string;
-        timeSpent: number;
         startTime: number;
+        timeSpent: number;
         translation: string;
     }, {
         chapter: string;
-        timeSpent: number;
         startTime: number;
+        timeSpent: number;
         translation: string;
     }>, "many">>;
     articleSessions: z.ZodOptional<z.ZodArray<z.ZodObject<{
@@ -609,15 +734,56 @@ export declare const PushEnabledWahaUserSchema: z.ZodObject<Omit<{
         timeSpent: z.ZodNumber;
         startTime: z.ZodNumber;
     }, "strip", z.ZodTypeAny, {
+        startTime: number;
         articleSlug: string;
         timeSpent: number;
-        startTime: number;
     }, {
+        startTime: number;
         articleSlug: string;
         timeSpent: number;
-        startTime: number;
     }>, "many">>;
     activated: z.ZodOptional<z.ZodBoolean>;
+    worksheetCompletions: z.ZodOptional<z.ZodArray<z.ZodObject<Omit<{
+        startTime: z.ZodNumber;
+        completionTime: z.ZodOptional<z.ZodNumber>;
+        worksheetId: z.ZodString;
+        answers: z.ZodArray<z.ZodObject<{
+            question: z.ZodString;
+            answer: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            question: string;
+            answer: string;
+        }, {
+            question: string;
+            answer: string;
+        }>, "many">;
+        country: z.ZodOptional<z.ZodString>;
+        region: z.ZodOptional<z.ZodString>;
+        city: z.ZodOptional<z.ZodString>;
+        didApply: z.ZodOptional<z.ZodBoolean>;
+        notificationText: z.ZodOptional<z.ZodString>;
+        feedback: z.ZodOptional<z.ZodString>;
+    }, "answers">, "strip", z.ZodTypeAny, {
+        startTime: number;
+        worksheetId: string;
+        city?: string | undefined;
+        country?: string | undefined;
+        region?: string | undefined;
+        completionTime?: number | undefined;
+        didApply?: boolean | undefined;
+        notificationText?: string | undefined;
+        feedback?: string | undefined;
+    }, {
+        startTime: number;
+        worksheetId: string;
+        city?: string | undefined;
+        country?: string | undefined;
+        region?: string | undefined;
+        completionTime?: number | undefined;
+        didApply?: boolean | undefined;
+        notificationText?: string | undefined;
+        feedback?: string | undefined;
+    }>, "many">>;
 }, "wahaUserId" | "pushToken" | "notificationPermission"> & {
     wahaUserId: z.ZodString;
     pushToken: z.ZodString;
@@ -681,16 +847,27 @@ export declare const PushEnabledWahaUserSchema: z.ZodObject<Omit<{
     }[] | undefined;
     bibleSessions?: {
         chapter: string;
-        timeSpent: number;
         startTime: number;
+        timeSpent: number;
         translation: string;
     }[] | undefined;
     articleSessions?: {
+        startTime: number;
         articleSlug: string;
         timeSpent: number;
-        startTime: number;
     }[] | undefined;
     activated?: boolean | undefined;
+    worksheetCompletions?: {
+        startTime: number;
+        worksheetId: string;
+        city?: string | undefined;
+        country?: string | undefined;
+        region?: string | undefined;
+        completionTime?: number | undefined;
+        didApply?: boolean | undefined;
+        notificationText?: string | undefined;
+        feedback?: string | undefined;
+    }[] | undefined;
 }, {
     appInterface: string;
     meet: string;
@@ -750,16 +927,28 @@ export declare const PushEnabledWahaUserSchema: z.ZodObject<Omit<{
     }[] | undefined;
     bibleSessions?: {
         chapter: string;
-        timeSpent: number;
         startTime: number;
+        timeSpent: number;
         translation: string;
     }[] | undefined;
     articleSessions?: {
+        startTime: number;
         articleSlug: string;
         timeSpent: number;
-        startTime: number;
     }[] | undefined;
     activated?: boolean | undefined;
+    worksheetCompletions?: {
+        startTime: number;
+        worksheetId: string;
+        city?: string | undefined;
+        country?: string | undefined;
+        region?: string | undefined;
+        completionTime?: number | undefined;
+        didApply?: boolean | undefined;
+        notificationText?: string | undefined;
+        feedback?: string | undefined;
+    }[] | undefined;
 }>;
 export type PushEnabledWahaUser = z.infer<typeof PushEnabledWahaUserSchema>;
 export type WahaUser = z.infer<typeof WahaUserSchema>;
+export {};

package/dist/types/users.js

@@ -67,6 +67,22 @@ exports.CompletionEventSchema = zod_1.z.object({
      */
     manual: zod_1.z.boolean().optional(),
 });
+const WorksheetAnswerSchema = zod_1.z.object({
+    question: zod_1.z.string(),
+    answer: zod_1.z.string(),
+});
+const WorksheetCompletionEventSchema = zod_1.z.object({
+    startTime: zod_1.z.number(),
+    completionTime: zod_1.z.number().optional(),
+    worksheetId: zod_1.z.string(),
+    answers: zod_1.z.array(WorksheetAnswerSchema),
+    country: zod_1.z.string().optional(),
+    region: zod_1.z.string().optional(),
+    city: zod_1.z.string().optional(),
+    didApply: zod_1.z.boolean().optional(),
+    notificationText: zod_1.z.string().optional(),
+    feedback: zod_1.z.string().optional(),
+});
 exports.WahaShareContentSchema = zod_1.z.enum([
     'app',
     'passcode',
@@ -125,6 +141,9 @@ exports.WahaUserSchema = exports.WahaUserStateSchema.extend({
     bibleSessions: zod_1.z.array(exports.BibleSessionSchema).optional(),
     articleSessions: zod_1.z.array(exports.ArticleSessionSchema).optional(),
     activated: zod_1.z.boolean().optional(),
+    worksheetCompletions: zod_1.z
+        .array(WorksheetCompletionEventSchema.omit({ answers: true }))
+        .optional(),
 });
 exports.PushEnabledWahaUserSchema = exports.WahaUserSchema.omit({
     wahaUserId: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "waha-shared",
-  "version": "1.0.19",
+  "version": "1.0.21",
   "author": "Waha",
   "dependencies": {
     "@types/signale": "^1.4.7",
@@ -12,7 +12,8 @@
     "typescript": "~5.9.2"
   },
   "files": [
-    "dist"
+    "dist",
+    "assets/fonts"
   ],
   "license": "MIT"
 }