waha-shared 1.0.264 → 1.0.266

package/dist/types/microLessons.js

@@ -7,15 +7,19 @@ exports.MicroLessonLanguagesResponseSchema = exports.MicroLessonSubmissionSchema
 const v4_1 = __importDefault(require("zod/v4"));
 const users_1 = require("./users");
 const webContent_1 = require("./webContent");
-exports.MicroLessonRadioButtonSchema = v4_1.default.object({
+exports.MicroLessonRadioButtonSchema = v4_1.default
+    .object({
     heading: v4_1.default.string().optional(),
     body: v4_1.default.string().optional(),
-});
-exports.MicroLessonCtaButtonSchema = v4_1.default.object({
+})
+    .describe('A single radio button option for a micro lesson page. Heading will show in bold and body will show in regular, gray text.');
+exports.MicroLessonCtaButtonSchema = v4_1.default
+    .object({
     show: v4_1.default.boolean(),
     label: v4_1.default.string(),
     href: v4_1.default.string(),
-});
+})
+    .describe('A call-to-action button that will appear at the bottom of a micro lesson page.');
 exports.MicroLessonSchema = v4_1.default.object({
     title: v4_1.default.string(),
     subtitle: v4_1.default.string().optional(),
@@ -23,44 +27,70 @@ exports.MicroLessonSchema = v4_1.default.object({
     isDraft: webContent_1.IsDraftSchema,
     seekerFriendly: webContent_1.SeekerFriendlySchema,
     platform: webContent_1.PlatformSchema,
-    image: v4_1.default.string().optional(),
+    image: v4_1.default
+        .string()
+        .describe("Cover image for the micro lesson. Will display on the micro lesson's card."),
     category: webContent_1.CategorySchema,
     campaign: v4_1.default
         .string()
         .optional()
         .describe('Optional campaign identifier for tracking purposes.'),
-    pages: v4_1.default.array(v4_1.default
+    pages: v4_1.default
+        .array(v4_1.default
         .object({
-        heading: v4_1.default.string().describe('The heading of the page'),
-        body: v4_1.default.string().optional(),
-        icon: v4_1.default.string().optional(),
-        image: v4_1.default.string().optional(),
+        heading: v4_1.default
+            .string()
+            .describe('The heading of the page. Will appear in large, bold text.'),
+        body: v4_1.default
+            .string()
+            .optional()
+            .describe('The body text of the page. Will appear below the heading in regular, gray text.'),
+        icon: v4_1.default
+            .string()
+            .optional()
+            .describe('An svg icon to display on the page. This will appear fairly small, left-aligned above the heading.'),
+        image: v4_1.default
+            .string()
+            .optional()
+            .describe('The image to display on the page. This will appear full width and below the heading.'),
         audio: webContent_1.AudioSchema,
         video: webContent_1.VideoSchema,
         textInput: v4_1.default
             .object({
-            show: v4_1.default.boolean(),
-            placeholder: v4_1.default.string().optional(),
-            showCopyButton: v4_1.default.boolean().optional(),
-            prefilledText: v4_1.default.string().optional(),
+            show: v4_1.default
+                .boolean()
+                .describe('Whether or not the page should show a text input field or not.'),
+            placeholder: v4_1.default
+                .string()
+                .optional()
+                .describe('The placeholder text that will appear in the text input field before the user starts typing.'),
+            showCopyButton: v4_1.default
+                .boolean()
+                .optional()
+                .describe('Whether or not there should be a copy/share button below the text input field. Button will say "Share" on the mobile app version of the micro lesson and will open the share sheet. Button will say "Copy to Clipboard" on the web version and will copy the text to the user\'s clipboard.'),
+            prefilledText: v4_1.default
+                .string()
+                .optional()
+                .describe('The prefilled text that will auto-populate the text input field of the page. Useful if you want to prefill a share message that the user can edit and send.'),
         })
+            .describe('Options for the text input field of the page.')
             .optional(),
         ctaButton: exports.MicroLessonCtaButtonSchema.optional(),
         radioButtons: v4_1.default.array(exports.MicroLessonRadioButtonSchema).optional(),
         platform: webContent_1.PlatformSchema.optional(),
         notification: v4_1.default
             .object({
-            title: v4_1.default.string().optional(),
-            body: v4_1.default.string().optional(),
+            title: v4_1.default.string(),
+            body: v4_1.default.string(),
             delayInHours: v4_1.default
                 .number()
-                .optional()
                 .describe('The delay in hours before the notification is sent.'),
         })
             .optional()
             .describe('Optional notification to send after the lesson is completed.'),
     })
-        .describe('The pages of the micro lesson. The last page is always considered the completion page and often contains a CTA button.')),
+        .describe('A single page of the micro lesson.'))
+        .describe('The pages that make up the micro lesson. The last page is the completion page and will always have a button redirecting the user back.'),
 });
 exports.ResponseMicroLessonSchema = v4_1.default.object({
     id: v4_1.default.string(),

package/dist/types/users.d.ts

@@ -94,32 +94,12 @@ export declare const CompletionEventSchema: z.ZodObject<{
     manual: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
 export type CompletionEvent = z.infer<typeof CompletionEventSchema>;
-declare const WorksheetAnswerSchema: z.ZodObject<{
-    question: z.ZodString;
-    answer: z.ZodString;
-}, z.core.$strip>;
-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;
-    }, z.core.$strip>>;
-    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>;
-}, z.core.$strip>;
-export type WorksheetCompletionEvent = z.infer<typeof WorksheetCompletionEventSchema>;
 export declare const WahaShareContentSchema: z.ZodEnum<{
     lesson: "lesson";
     note: "note";
     setLink: "setLink";
     lessonLink: "lessonLink";
+    notification: "notification";
     app: "app";
     passcode: "passcode";
     lessonAudio: "lessonAudio";
@@ -129,7 +109,6 @@ export declare const WahaShareContentSchema: z.ZodEnum<{
     meetingInvite: "meetingInvite";
     articleLink: "articleLink";
     videoLink: "videoLink";
-    notification: "notification";
     meetingSchedule: "meetingSchedule";
     scriptureText: "scriptureText";
     mt: "mt";
@@ -147,6 +126,7 @@ export declare const ShareLogEventSchema: z.ZodObject<{
         note: "note";
         setLink: "setLink";
         lessonLink: "lessonLink";
+        notification: "notification";
         app: "app";
         passcode: "passcode";
         lessonAudio: "lessonAudio";
@@ -156,7 +136,6 @@ export declare const ShareLogEventSchema: z.ZodObject<{
         meetingInvite: "meetingInvite";
         articleLink: "articleLink";
         videoLink: "videoLink";
-        notification: "notification";
         meetingSchedule: "meetingSchedule";
         scriptureText: "scriptureText";
         mt: "mt";
@@ -168,6 +147,7 @@ export declare const ShareLogEventSchema: z.ZodObject<{
     }>;
     lessonId: z.ZodOptional<z.ZodString>;
     articleSlug: z.ZodOptional<z.ZodString>;
+    microLessonSlug: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export type ShareLogEvent = z.infer<typeof ShareLogEventSchema>;
 export declare const BibleSessionSchema: z.ZodObject<{
@@ -269,6 +249,7 @@ export declare const WahaUserSchema: z.ZodObject<{
             note: "note";
             setLink: "setLink";
             lessonLink: "lessonLink";
+            notification: "notification";
             app: "app";
             passcode: "passcode";
             lessonAudio: "lessonAudio";
@@ -278,7 +259,6 @@ export declare const WahaUserSchema: z.ZodObject<{
             meetingInvite: "meetingInvite";
             articleLink: "articleLink";
             videoLink: "videoLink";
-            notification: "notification";
             meetingSchedule: "meetingSchedule";
             scriptureText: "scriptureText";
             mt: "mt";
@@ -290,6 +270,7 @@ export declare const WahaUserSchema: z.ZodObject<{
         }>;
         lessonId: z.ZodOptional<z.ZodString>;
         articleSlug: z.ZodOptional<z.ZodString>;
+        microLessonSlug: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>>;
     bibleSessions: z.ZodOptional<z.ZodArray<z.ZodObject<{
         chapter: z.ZodString;
@@ -303,16 +284,22 @@ export declare const WahaUserSchema: z.ZodObject<{
         startTime: z.ZodNumber;
     }, z.core.$strip>>>;
     activated: z.ZodOptional<z.ZodBoolean>;
-    worksheetCompletions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+    microLessonCompletions: z.ZodOptional<z.ZodArray<z.ZodObject<{
         city: z.ZodOptional<z.ZodString>;
         country: z.ZodOptional<z.ZodString>;
         region: z.ZodOptional<z.ZodString>;
-        startTime: z.ZodNumber;
-        completionTime: z.ZodOptional<z.ZodNumber>;
-        worksheetId: z.ZodString;
-        didApply: z.ZodOptional<z.ZodBoolean>;
-        notificationText: z.ZodOptional<z.ZodString>;
-        feedback: z.ZodOptional<z.ZodString>;
+        microLessonId: z.ZodString;
+        userId: z.ZodString;
+        microLessonTitle: z.ZodString;
+        languageId: z.ZodString;
+        campaign: z.ZodOptional<z.ZodString>;
+        timeStarted: z.ZodNumber;
+        timeSubmitted: z.ZodNumber;
+        platform: z.ZodEnum<{
+            web: "web";
+            ios: "ios";
+            android: "android";
+        }>;
     }, z.core.$strip>>>;
 }, z.core.$strip>;
 export declare const PushEnabledWahaUserSchema: z.ZodObject<{
@@ -320,6 +307,7 @@ export declare const PushEnabledWahaUserSchema: z.ZodObject<{
     appInterface: z.ZodString;
     email: z.ZodOptional<z.ZodEmail>;
     meet: z.ZodString;
+    platform: z.ZodString;
     location: z.ZodOptional<z.ZodObject<{
         city: z.ZodOptional<z.ZodString>;
         country: z.ZodOptional<z.ZodString>;
@@ -373,7 +361,6 @@ export declare const PushEnabledWahaUserSchema: z.ZodObject<{
     securityModeOn: z.ZodOptional<z.ZodBoolean>;
     appVersion: z.ZodString;
     lastUpdate: z.ZodNumber;
-    platform: z.ZodString;
     completions: z.ZodArray<z.ZodObject<{
         lessonId: z.ZodString;
         meetLanguageId: z.ZodString;
@@ -394,6 +381,7 @@ export declare const PushEnabledWahaUserSchema: z.ZodObject<{
             note: "note";
             setLink: "setLink";
             lessonLink: "lessonLink";
+            notification: "notification";
             app: "app";
             passcode: "passcode";
             lessonAudio: "lessonAudio";
@@ -403,7 +391,6 @@ export declare const PushEnabledWahaUserSchema: z.ZodObject<{
             meetingInvite: "meetingInvite";
             articleLink: "articleLink";
             videoLink: "videoLink";
-            notification: "notification";
             meetingSchedule: "meetingSchedule";
             scriptureText: "scriptureText";
             mt: "mt";
@@ -415,6 +402,7 @@ export declare const PushEnabledWahaUserSchema: z.ZodObject<{
         }>;
         lessonId: z.ZodOptional<z.ZodString>;
         articleSlug: z.ZodOptional<z.ZodString>;
+        microLessonSlug: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>>;
     bibleSessions: z.ZodOptional<z.ZodArray<z.ZodObject<{
         chapter: z.ZodString;
@@ -428,16 +416,22 @@ export declare const PushEnabledWahaUserSchema: z.ZodObject<{
         startTime: z.ZodNumber;
     }, z.core.$strip>>>;
     activated: z.ZodOptional<z.ZodBoolean>;
-    worksheetCompletions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+    microLessonCompletions: z.ZodOptional<z.ZodArray<z.ZodObject<{
         city: z.ZodOptional<z.ZodString>;
         country: z.ZodOptional<z.ZodString>;
         region: z.ZodOptional<z.ZodString>;
-        startTime: z.ZodNumber;
-        completionTime: z.ZodOptional<z.ZodNumber>;
-        worksheetId: z.ZodString;
-        didApply: z.ZodOptional<z.ZodBoolean>;
-        notificationText: z.ZodOptional<z.ZodString>;
-        feedback: z.ZodOptional<z.ZodString>;
+        microLessonId: z.ZodString;
+        userId: z.ZodString;
+        microLessonTitle: z.ZodString;
+        languageId: z.ZodString;
+        campaign: z.ZodOptional<z.ZodString>;
+        timeStarted: z.ZodNumber;
+        timeSubmitted: z.ZodNumber;
+        platform: z.ZodEnum<{
+            web: "web";
+            ios: "ios";
+            android: "android";
+        }>;
     }, z.core.$strip>>>;
     wahaUserId: z.ZodString;
     pushToken: z.ZodString;
@@ -445,4 +439,3 @@ export declare const PushEnabledWahaUserSchema: z.ZodObject<{
 }, z.core.$strip>;
 export type PushEnabledWahaUser = z.infer<typeof PushEnabledWahaUserSchema>;
 export type WahaUser = z.infer<typeof WahaUserSchema>;
-export {};

package/dist/types/users.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PushEnabledWahaUserSchema = exports.WahaUserSchema = exports.ArticleSessionSchema = exports.BibleSessionSchema = exports.ShareLogEventSchema = exports.WahaShareContentSchema = exports.CompletionEventSchema = exports.WahaAppVersionSchema = exports.WahaUserStateSchema = exports.DesireIdSchema = exports.WahaUserLocationSchema = void 0;
 const zod_1 = require("zod");
+const microLessons_1 = require("./microLessons");
 exports.WahaUserLocationSchema = zod_1.z.object({
     city: zod_1.z.string().optional(),
     country: zod_1.z.string().optional(),
@@ -73,22 +74,6 @@ 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',
@@ -118,6 +103,7 @@ exports.ShareLogEventSchema = zod_1.z.object({
     content: exports.WahaShareContentSchema,
     lessonId: zod_1.z.string().optional(),
     articleSlug: zod_1.z.string().optional(),
+    microLessonSlug: zod_1.z.string().optional(),
 });
 exports.BibleSessionSchema = zod_1.z.object({
     chapter: zod_1.z.string(),
@@ -148,9 +134,7 @@ 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(),
+    microLessonCompletions: zod_1.z.array(microLessons_1.MicroLessonSubmissionSchema).optional(),
 });
 exports.PushEnabledWahaUserSchema = exports.WahaUserSchema.omit({
     wahaUserId: true,

package/dist/types/webContent.js

@@ -24,6 +24,7 @@ exports.AudioSchema = zod_1.default
     audioUrl: zod_1.default.string(),
     loop: zod_1.default.boolean().optional(),
 })
+    .describe('Optional audio to embed on the page.')
     .optional();
 exports.VideoSchema = zod_1.default
     .object({
@@ -32,6 +33,7 @@ exports.VideoSchema = zod_1.default
     loop: zod_1.default.boolean().optional(),
     disableControls: zod_1.default.boolean().optional(),
 })
+    .describe('Optional video to embed on the page.')
     .optional();
 exports.CategorySchema = zod_1.default.enum([
     'Case Studies',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "waha-shared",
-  "version": "1.0.264",
+  "version": "1.0.266",
   "author": "Waha",
   "dependencies": {
     "@types/signale": "^1.4.7",