@purpleschool/gptbot 0.19.12-stage-2 → 0.19.14-stage-2

package/build/api/controllers/http/index.d.ts

@@ -89,3 +89,4 @@ export * from './canvas-template';
 export * from './app-login';
 export * from './greetings';
 export * from './motion-control';
+export * from './onboarding';

package/build/api/controllers/http/index.js

@@ -105,3 +105,4 @@ __exportStar(require("./canvas-template"), exports);
 __exportStar(require("./app-login"), exports);
 __exportStar(require("./greetings"), exports);
 __exportStar(require("./motion-control"), exports);
+__exportStar(require("./onboarding"), exports);

package/build/api/controllers/http/onboarding.d.ts

@@ -0,0 +1,5 @@
+export declare const ONBOARDING_PRIVATE_CONTROLLER: 'private/onboarding';
+export declare const ONBOARDING_ROUTES: {
+    readonly GET: '';
+    readonly ACK: 'notifications/ack';
+};

package/build/api/controllers/http/onboarding.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ONBOARDING_ROUTES = exports.ONBOARDING_PRIVATE_CONTROLLER = void 0;
+exports.ONBOARDING_PRIVATE_CONTROLLER = 'private/onboarding';
+exports.ONBOARDING_ROUTES = {
+    GET: '',
+    ACK: 'notifications/ack',
+};

package/build/api/routes.d.ts

@@ -1,5 +1,9 @@
 export declare const ROOT: '/api';
 export declare const REST_API: {
+    readonly ONBOARDING_PRIVATE: {
+        readonly GET: "/api/private/onboarding";
+        readonly ACK: "/api/private/onboarding/notifications/ack";
+    };
     readonly APP_LOGIN: {
         readonly CODE: "/api/app-login/code";
         readonly REDEEM: "/api/app-login/redeem";

package/build/api/routes.js

@@ -38,6 +38,10 @@ const constants_1 = require("../constants");
 const CONTROLLERS = __importStar(require("./controllers"));
 exports.ROOT = '/api';
 exports.REST_API = {
+    ONBOARDING_PRIVATE: {
+        GET: `${exports.ROOT}/${CONTROLLERS.ONBOARDING_PRIVATE_CONTROLLER}`,
+        ACK: `${exports.ROOT}/${CONTROLLERS.ONBOARDING_PRIVATE_CONTROLLER}/${CONTROLLERS.ONBOARDING_ROUTES.ACK}`,
+    },
     APP_LOGIN: {
         CODE: `${exports.ROOT}/${CONTROLLERS.APP_LOGIN_CONTROLLER}/${CONTROLLERS.APP_LOGIN_ROUTES.CODE}`,
         REDEEM: `${exports.ROOT}/${CONTROLLERS.APP_LOGIN_CONTROLLER}/${CONTROLLERS.APP_LOGIN_ROUTES.REDEEM}`,

package/build/commands/index.d.ts

@@ -60,3 +60,4 @@ export * from './team-to-subscription';
 export * from './team-to-product';
 export * from './app-login';
 export * from './partner-codes';
+export * from './onboarding';

package/build/commands/index.js

@@ -76,3 +76,4 @@ __exportStar(require("./team-to-subscription"), exports);
 __exportStar(require("./team-to-product"), exports);
 __exportStar(require("./app-login"), exports);
 __exportStar(require("./partner-codes"), exports);
+__exportStar(require("./onboarding"), exports);

package/build/commands/onboarding/index.d.ts

@@ -0,0 +1,122 @@
+import { z } from 'zod';
+export declare namespace GetOnboardingCommand {
+    type Request = void;
+    const ResponseSchema: z.ZodObject<{
+        data: z.ZodObject<{
+            visible: z.ZodBoolean;
+            canParticipate: z.ZodBoolean;
+            blockedReason: z.ZodNullable<z.ZodLiteral<"email_confirmation_required">>;
+            visibleUntil: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+            completedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+            tasks: z.ZodArray<z.ZodObject<{
+                code: z.ZodEnum<{
+                    first_chat: "first_chat";
+                    first_image: "first_image";
+                    first_photo: "first_photo";
+                    first_video: "first_video";
+                    first_voice: "first_voice";
+                }>;
+                title: z.ZodString;
+                description: z.ZodString;
+                action: z.ZodObject<{
+                    type: z.ZodEnum<{
+                        chat: "chat";
+                        "image-editor": "image-editor";
+                        "image-generation": "image-generation";
+                        tts: "tts";
+                        video: "video";
+                    }>;
+                }, z.core.$strict>;
+                rewardStars: z.ZodNumber;
+                completedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+                awardedStars: z.ZodNumber;
+            }, z.core.$strip>>;
+            completedCount: z.ZodNumber;
+            totalCount: z.ZodNumber;
+            earnedStars: z.ZodNumber;
+            totalRewardStars: z.ZodNumber;
+            currentStepCode: z.ZodNullable<z.ZodEnum<{
+                first_chat: "first_chat";
+                first_image: "first_image";
+                first_photo: "first_photo";
+                first_video: "first_video";
+                first_voice: "first_voice";
+            }>>;
+            unseenCompletions: z.ZodArray<z.ZodObject<{
+                id: z.ZodUUID;
+                taskCode: z.ZodEnum<{
+                    first_chat: "first_chat";
+                    first_image: "first_image";
+                    first_photo: "first_photo";
+                    first_video: "first_video";
+                    first_voice: "first_voice";
+                }>;
+                awardedStars: z.ZodNumber;
+                completedAt: z.ZodCoercedDate<unknown>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    type Response = z.infer<typeof ResponseSchema>;
+}
+export declare namespace AckOnboardingNotificationsCommand {
+    const RequestSchema: z.ZodObject<{
+        ids: z.ZodArray<z.ZodUUID>;
+    }, z.core.$strict>;
+    type Request = z.infer<typeof RequestSchema>;
+    const ResponseSchema: z.ZodObject<{
+        data: z.ZodObject<{
+            visible: z.ZodBoolean;
+            canParticipate: z.ZodBoolean;
+            blockedReason: z.ZodNullable<z.ZodLiteral<"email_confirmation_required">>;
+            visibleUntil: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+            completedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+            tasks: z.ZodArray<z.ZodObject<{
+                code: z.ZodEnum<{
+                    first_chat: "first_chat";
+                    first_image: "first_image";
+                    first_photo: "first_photo";
+                    first_video: "first_video";
+                    first_voice: "first_voice";
+                }>;
+                title: z.ZodString;
+                description: z.ZodString;
+                action: z.ZodObject<{
+                    type: z.ZodEnum<{
+                        chat: "chat";
+                        "image-editor": "image-editor";
+                        "image-generation": "image-generation";
+                        tts: "tts";
+                        video: "video";
+                    }>;
+                }, z.core.$strict>;
+                rewardStars: z.ZodNumber;
+                completedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+                awardedStars: z.ZodNumber;
+            }, z.core.$strip>>;
+            completedCount: z.ZodNumber;
+            totalCount: z.ZodNumber;
+            earnedStars: z.ZodNumber;
+            totalRewardStars: z.ZodNumber;
+            currentStepCode: z.ZodNullable<z.ZodEnum<{
+                first_chat: "first_chat";
+                first_image: "first_image";
+                first_photo: "first_photo";
+                first_video: "first_video";
+                first_voice: "first_voice";
+            }>>;
+            unseenCompletions: z.ZodArray<z.ZodObject<{
+                id: z.ZodUUID;
+                taskCode: z.ZodEnum<{
+                    first_chat: "first_chat";
+                    first_image: "first_image";
+                    first_photo: "first_photo";
+                    first_video: "first_video";
+                    first_voice: "first_voice";
+                }>;
+                awardedStars: z.ZodNumber;
+                completedAt: z.ZodCoercedDate<unknown>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    type Response = GetOnboardingCommand.Response;
+}

package/build/commands/onboarding/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AckOnboardingNotificationsCommand = exports.GetOnboardingCommand = void 0;
+const zod_1 = require("zod");
+const onboarding_schema_1 = require("../../models/onboarding.schema");
+var GetOnboardingCommand;
+(function (GetOnboardingCommand) {
+    GetOnboardingCommand.ResponseSchema = zod_1.z.object({ data: onboarding_schema_1.OnboardingStateSchema });
+})(GetOnboardingCommand || (exports.GetOnboardingCommand = GetOnboardingCommand = {}));
+var AckOnboardingNotificationsCommand;
+(function (AckOnboardingNotificationsCommand) {
+    AckOnboardingNotificationsCommand.RequestSchema = zod_1.z.object({ ids: zod_1.z.array(zod_1.z.uuid()).min(1).max(100) }).strict();
+    AckOnboardingNotificationsCommand.ResponseSchema = GetOnboardingCommand.ResponseSchema;
+})(AckOnboardingNotificationsCommand || (exports.AckOnboardingNotificationsCommand = AckOnboardingNotificationsCommand = {}));

package/build/commands/user/get-me.command.d.ts

@@ -2,6 +2,10 @@ import { z } from 'zod';
 import { SIGNUP_METHOD, USER_STATUS } from '../../constants';
 import { LOCALE } from '@purpleschool/rugpt-lib-common';
 export declare namespace GetMeCommand {
+    const OnboardingAccessSchema: z.ZodObject<{
+        visibleUntil: z.ZodNullable<z.ZodISODateTime>;
+    }, z.core.$strip>;
+    type OnboardingAccess = z.infer<typeof OnboardingAccessSchema>;
     const RequestSchema: z.ZodObject<{}, z.core.$strip>;
     type Request = z.infer<typeof RequestSchema>;
     const ResponseSchema: z.ZodObject<{
@@ -43,6 +47,9 @@ export declare namespace GetMeCommand {
                     renewalBonusPercent: z.ZodNumber;
                 }, z.core.$strip>>;
             }, z.core.$strip>;
+            onboarding: z.ZodOptional<z.ZodObject<{
+                visibleUntil: z.ZodNullable<z.ZodISODateTime>;
+            }, z.core.$strip>>;
         }, z.core.$strip>;
     }, z.core.$strip>;
     type Response = z.infer<typeof ResponseSchema>;

package/build/commands/user/get-me.command.js

@@ -7,6 +7,9 @@ const models_1 = require("../../models");
 const rugpt_lib_common_1 = require("@purpleschool/rugpt-lib-common");
 var GetMeCommand;
 (function (GetMeCommand) {
+    GetMeCommand.OnboardingAccessSchema = zod_1.z.object({
+        visibleUntil: zod_1.z.iso.datetime().nullable(),
+    });
     GetMeCommand.RequestSchema = zod_1.z.object({});
     GetMeCommand.ResponseSchema = zod_1.z.object({
         data: zod_1.z.object({
@@ -22,6 +25,8 @@ var GetMeCommand;
             digitalProcessingConsent: zod_1.z.boolean(),
             profile: models_1.UserProfileResponseSchema,
             loyaltyStatus: models_1.UserLoyaltyStatusResponseSchema,
+            // Optional for compatibility with API versions deployed before onboarding.
+            onboarding: GetMeCommand.OnboardingAccessSchema.optional(),
         }),
     });
 })(GetMeCommand || (exports.GetMeCommand = GetMeCommand = {}));

package/build/constants/user/enums/index.d.ts

@@ -2,3 +2,4 @@ export * from './singup-method.enum';
 export * from './user-status';
 export * from './user-sort-by.enum';
 export * from './sort-order.enum';
+export * from './registration-platform.enum';

package/build/constants/user/enums/index.js

@@ -18,3 +18,4 @@ __exportStar(require("./singup-method.enum"), exports);
 __exportStar(require("./user-status"), exports);
 __exportStar(require("./user-sort-by.enum"), exports);
 __exportStar(require("./sort-order.enum"), exports);
+__exportStar(require("./registration-platform.enum"), exports);

package/build/constants/user/enums/registration-platform.enum.d.ts

@@ -0,0 +1,5 @@
+export declare enum REGISTRATION_PLATFORM {
+    WEB = "web",
+    IOS = "ios",
+    ANDROID = "android"
+}

package/build/constants/user/enums/registration-platform.enum.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.REGISTRATION_PLATFORM = void 0;
+var REGISTRATION_PLATFORM;
+(function (REGISTRATION_PLATFORM) {
+    REGISTRATION_PLATFORM["WEB"] = "web";
+    REGISTRATION_PLATFORM["IOS"] = "ios";
+    REGISTRATION_PLATFORM["ANDROID"] = "android";
+})(REGISTRATION_PLATFORM || (exports.REGISTRATION_PLATFORM = REGISTRATION_PLATFORM = {}));

package/build/models/index.d.ts

@@ -84,3 +84,4 @@ export * from './team-account';
 export * from './partner-codes';
 export * from './canvas-template.schema';
 export * from './user-loyalty-status.schema';
+export * from './onboarding.schema';

package/build/models/index.js

@@ -100,3 +100,4 @@ __exportStar(require("./team-account"), exports);
 __exportStar(require("./partner-codes"), exports);
 __exportStar(require("./canvas-template.schema"), exports);
 __exportStar(require("./user-loyalty-status.schema"), exports);
+__exportStar(require("./onboarding.schema"), exports);

package/build/models/onboarding.schema.d.ts

@@ -0,0 +1,124 @@
+import { z } from 'zod';
+export declare const OnboardingTaskCodeSchema: z.ZodEnum<{
+    first_chat: "first_chat";
+    first_image: "first_image";
+    first_photo: "first_photo";
+    first_video: "first_video";
+    first_voice: "first_voice";
+}>;
+export declare const OnboardingConditionSchema: z.ZodEnum<{
+    chat_completed: "chat_completed";
+    image_completed: "image_completed";
+    photo_completed: "photo_completed";
+    tts_completed: "tts_completed";
+    video_completed: "video_completed";
+}>;
+export declare const OnboardingActionTypeSchema: z.ZodEnum<{
+    chat: "chat";
+    "image-editor": "image-editor";
+    "image-generation": "image-generation";
+    tts: "tts";
+    video: "video";
+}>;
+export declare const OnboardingActionSchema: z.ZodObject<{
+    type: z.ZodEnum<{
+        chat: "chat";
+        "image-editor": "image-editor";
+        "image-generation": "image-generation";
+        tts: "tts";
+        video: "video";
+    }>;
+}, z.core.$strict>;
+export declare const OnboardingTaskSchema: z.ZodObject<{
+    code: z.ZodEnum<{
+        first_chat: "first_chat";
+        first_image: "first_image";
+        first_photo: "first_photo";
+        first_video: "first_video";
+        first_voice: "first_voice";
+    }>;
+    title: z.ZodString;
+    description: z.ZodString;
+    action: z.ZodObject<{
+        type: z.ZodEnum<{
+            chat: "chat";
+            "image-editor": "image-editor";
+            "image-generation": "image-generation";
+            tts: "tts";
+            video: "video";
+        }>;
+    }, z.core.$strict>;
+    rewardStars: z.ZodNumber;
+    completedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+    awardedStars: z.ZodNumber;
+}, z.core.$strip>;
+export declare const OnboardingCompletionSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    taskCode: z.ZodEnum<{
+        first_chat: "first_chat";
+        first_image: "first_image";
+        first_photo: "first_photo";
+        first_video: "first_video";
+        first_voice: "first_voice";
+    }>;
+    awardedStars: z.ZodNumber;
+    completedAt: z.ZodCoercedDate<unknown>;
+}, z.core.$strip>;
+export declare const OnboardingStateSchema: z.ZodObject<{
+    visible: z.ZodBoolean;
+    canParticipate: z.ZodBoolean;
+    blockedReason: z.ZodNullable<z.ZodLiteral<"email_confirmation_required">>;
+    visibleUntil: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+    completedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+    tasks: z.ZodArray<z.ZodObject<{
+        code: z.ZodEnum<{
+            first_chat: "first_chat";
+            first_image: "first_image";
+            first_photo: "first_photo";
+            first_video: "first_video";
+            first_voice: "first_voice";
+        }>;
+        title: z.ZodString;
+        description: z.ZodString;
+        action: z.ZodObject<{
+            type: z.ZodEnum<{
+                chat: "chat";
+                "image-editor": "image-editor";
+                "image-generation": "image-generation";
+                tts: "tts";
+                video: "video";
+            }>;
+        }, z.core.$strict>;
+        rewardStars: z.ZodNumber;
+        completedAt: z.ZodNullable<z.ZodCoercedDate<unknown>>;
+        awardedStars: z.ZodNumber;
+    }, z.core.$strip>>;
+    completedCount: z.ZodNumber;
+    totalCount: z.ZodNumber;
+    earnedStars: z.ZodNumber;
+    totalRewardStars: z.ZodNumber;
+    currentStepCode: z.ZodNullable<z.ZodEnum<{
+        first_chat: "first_chat";
+        first_image: "first_image";
+        first_photo: "first_photo";
+        first_video: "first_video";
+        first_voice: "first_voice";
+    }>>;
+    unseenCompletions: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        taskCode: z.ZodEnum<{
+            first_chat: "first_chat";
+            first_image: "first_image";
+            first_photo: "first_photo";
+            first_video: "first_video";
+            first_voice: "first_voice";
+        }>;
+        awardedStars: z.ZodNumber;
+        completedAt: z.ZodCoercedDate<unknown>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type OnboardingTaskCode = z.infer<typeof OnboardingTaskCodeSchema>;
+export type OnboardingCondition = z.infer<typeof OnboardingConditionSchema>;
+export type OnboardingActionType = z.infer<typeof OnboardingActionTypeSchema>;
+export type OnboardingTask = z.infer<typeof OnboardingTaskSchema>;
+export type OnboardingState = z.infer<typeof OnboardingStateSchema>;

package/build/models/onboarding.schema.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OnboardingStateSchema = exports.OnboardingCompletionSchema = exports.OnboardingTaskSchema = exports.OnboardingActionSchema = exports.OnboardingActionTypeSchema = exports.OnboardingConditionSchema = exports.OnboardingTaskCodeSchema = void 0;
+const zod_1 = require("zod");
+exports.OnboardingTaskCodeSchema = zod_1.z.enum([
+    'first_chat',
+    'first_image',
+    'first_photo',
+    'first_voice',
+    'first_video',
+]);
+exports.OnboardingConditionSchema = zod_1.z.enum([
+    'chat_completed',
+    'image_completed',
+    'photo_completed',
+    'tts_completed',
+    'video_completed',
+]);
+exports.OnboardingActionTypeSchema = zod_1.z.enum([
+    'chat',
+    'image-generation',
+    'image-editor',
+    'tts',
+    'video',
+]);
+exports.OnboardingActionSchema = zod_1.z.object({ type: exports.OnboardingActionTypeSchema }).strict();
+exports.OnboardingTaskSchema = zod_1.z.object({
+    code: exports.OnboardingTaskCodeSchema,
+    title: zod_1.z.string(),
+    description: zod_1.z.string(),
+    action: exports.OnboardingActionSchema,
+    rewardStars: zod_1.z.number().int().nonnegative(),
+    completedAt: zod_1.z.coerce.date().nullable(),
+    awardedStars: zod_1.z.number().int().nonnegative(),
+});
+exports.OnboardingCompletionSchema = zod_1.z.object({
+    id: zod_1.z.uuid(),
+    taskCode: exports.OnboardingTaskCodeSchema,
+    awardedStars: zod_1.z.number().int().nonnegative(),
+    completedAt: zod_1.z.coerce.date(),
+});
+exports.OnboardingStateSchema = zod_1.z.object({
+    visible: zod_1.z.boolean(),
+    canParticipate: zod_1.z.boolean(),
+    blockedReason: zod_1.z.literal('email_confirmation_required').nullable(),
+    visibleUntil: zod_1.z.coerce.date().nullable(),
+    completedAt: zod_1.z.coerce.date().nullable(),
+    tasks: zod_1.z.array(exports.OnboardingTaskSchema),
+    completedCount: zod_1.z.number().int().nonnegative(),
+    totalCount: zod_1.z.number().int().nonnegative(),
+    earnedStars: zod_1.z.number().int().nonnegative(),
+    totalRewardStars: zod_1.z.number().int().nonnegative(),
+    currentStepCode: exports.OnboardingTaskCodeSchema.nullable(),
+    unseenCompletions: zod_1.z.array(exports.OnboardingCompletionSchema),
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@purpleschool/gptbot",
-  "version": "0.19.12-stage-2",
+  "version": "0.19.14-stage-2",
   "description": "",
   "main": "build/index.js",
   "types": "build/index.d.ts",