@abyss-project/main 1.0.45 → 1.0.47

package/dist/types/enum/index.d.ts

@@ -18,3 +18,5 @@ export * from './subscription-level.enum';
 export * from './newsletter-type.enum';
 export * from './project-status.enum';
 export * from './abyss-application-event.enum';
+export * from './user-type.enum';
+export * from './onboarding-steps.enum';

package/dist/types/enum/index.js

@@ -34,3 +34,5 @@ __exportStar(require("./subscription-level.enum"), exports);
 __exportStar(require("./newsletter-type.enum"), exports);
 __exportStar(require("./project-status.enum"), exports);
 __exportStar(require("./abyss-application-event.enum"), exports);
+__exportStar(require("./user-type.enum"), exports);
+__exportStar(require("./onboarding-steps.enum"), exports);

package/dist/types/enum/onboarding-steps.enum.d.ts

@@ -0,0 +1,15 @@
+export declare enum OnboardingSteps {
+    LANDING = "LANDING",
+    USER_DETAILS = "USER_DETAILS",
+    USER_TYPE = "USER_TYPE",
+    DEVELOPER_CREATE_PROJECT = "DEVELOPER_CREATE_PROJECT",
+    DEVELOPER_DISCOVER_MONITOR = "DEVELOPER_DISCOVER_MONITOR",
+    DEVELOPER_DISCOVER_STORAGE = "DEVELOPER_DISCOVER_STORAGE",
+    USER_FEATURE_SELECT = "USER_FEATURE_SELECT",
+    USER_CREATE_CLOUD = "USER_CREATE_CLOUD",
+    USER_CONNECT_BANK = "USER_CONNECT_BANK",
+    USER_CREATE_MEMORIES = "USER_CREATE_MEMORIES",
+    USER_CREATE_FORM = "USER_CREATE_FORM",
+    USER_CREATE_SPOTLIGHT = "USER_CREATE_SPOTLIGHT",
+    END = "END"
+}

package/dist/types/enum/onboarding-steps.enum.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OnboardingSteps = void 0;
+var OnboardingSteps;
+(function (OnboardingSteps) {
+    OnboardingSteps["LANDING"] = "LANDING";
+    OnboardingSteps["USER_DETAILS"] = "USER_DETAILS";
+    OnboardingSteps["USER_TYPE"] = "USER_TYPE";
+    OnboardingSteps["DEVELOPER_CREATE_PROJECT"] = "DEVELOPER_CREATE_PROJECT";
+    OnboardingSteps["DEVELOPER_DISCOVER_MONITOR"] = "DEVELOPER_DISCOVER_MONITOR";
+    OnboardingSteps["DEVELOPER_DISCOVER_STORAGE"] = "DEVELOPER_DISCOVER_STORAGE";
+    OnboardingSteps["USER_FEATURE_SELECT"] = "USER_FEATURE_SELECT";
+    OnboardingSteps["USER_CREATE_CLOUD"] = "USER_CREATE_CLOUD";
+    OnboardingSteps["USER_CONNECT_BANK"] = "USER_CONNECT_BANK";
+    OnboardingSteps["USER_CREATE_MEMORIES"] = "USER_CREATE_MEMORIES";
+    OnboardingSteps["USER_CREATE_FORM"] = "USER_CREATE_FORM";
+    OnboardingSteps["USER_CREATE_SPOTLIGHT"] = "USER_CREATE_SPOTLIGHT";
+    OnboardingSteps["END"] = "END";
+})(OnboardingSteps || (exports.OnboardingSteps = OnboardingSteps = {}));

package/dist/types/enum/subscription-level.enum.d.ts

@@ -48,6 +48,7 @@ type ProjectConfigPerService = {
         statsHistoryDays: number;
         maxStoreEntry: number;
         eventPublishLimitPerDay: number;
+        maxSentinelCountPerProject: number;
     };
     [AbyssService.ABYSS_STORAGE]: {
         maxFileSizeMo: number;

package/dist/types/enum/subscription-level.enum.js

@@ -113,6 +113,7 @@ exports.PROJECT_SUBSCRIPTION_CONFIG = {
             statsHistoryDays: 3,
             maxStoreEntry: 10,
             eventPublishLimitPerDay: 100,
+            maxSentinelCountPerProject: 5,
         },
         ABYSS_FORM: {
             maxDocumentPerForm: 10,
@@ -137,6 +138,7 @@ exports.PROJECT_SUBSCRIPTION_CONFIG = {
             statsHistoryDays: 7,
             maxStoreEntry: 100,
             eventPublishLimitPerDay: 1000,
+            maxSentinelCountPerProject: 30,
         },
         ABYSS_FORM: {
             maxDocumentPerForm: 50,
@@ -161,6 +163,7 @@ exports.PROJECT_SUBSCRIPTION_CONFIG = {
             statsHistoryDays: Infinity,
             maxStoreEntry: 500,
             eventPublishLimitPerDay: 10000,
+            maxSentinelCountPerProject: 100,
         },
         ABYSS_FORM: {
             maxDocumentPerForm: 100,

package/dist/types/enum/user-type.enum.d.ts

@@ -0,0 +1,4 @@
+export declare enum UserType {
+    DEVELOPER = "DEVELOPER",
+    USER = "USER"
+}

package/dist/types/enum/user-type.enum.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserType = void 0;
+var UserType;
+(function (UserType) {
+    UserType["DEVELOPER"] = "DEVELOPER";
+    UserType["USER"] = "USER";
+})(UserType || (exports.UserType = UserType = {}));

package/dist/types/interface/api/requests/user.request.d.ts

@@ -1,5 +1,6 @@
 import { SubscriptionLevel, UserCreditPurchaseCurrency, UserLanguage } from '../../../enum';
 import { TokenHistoryMetadataUserInvitation } from '../../models/token-history.model';
+import { UserOnboardingStatus } from '../../models/user.model';
 import { QueryPaginate } from '../type-message/base-paginate';
 import * as core from 'express-serve-static-core';
 export interface ISponsorUserQuery {
@@ -26,6 +27,7 @@ export type IPaginateSponsorUserQuery = {
 export interface IUpdateSettingsUserBody {
     language?: UserLanguage;
     currency?: UserCreditPurchaseCurrency;
+    onboardingStatus?: UserOnboardingStatus;
 }
 export interface ICreateSubscriptionUserBody {
     level: SubscriptionLevel;

package/dist/types/interface/models/user.model.d.ts

@@ -1,10 +1,13 @@
 import { IGiftCodeActivation, IOAuthAccount, IProject, IUserTransaction } from '..';
-import { AbyssService, UserCreditPurchaseCurrency, UserLanguage } from '../../enum';
+import { AbyssService, OnboardingSteps, UserCreditPurchaseCurrency, UserLanguage, UserType } from '../../enum';
+import { OnboardingData } from '../../utils';
 import { ISubscription } from './subscription.model';
 import { IUserNotification } from './user-notification.model';
 export interface IUserSetting {
     language?: UserLanguage;
     currency?: UserCreditPurchaseCurrency | null;
+    onboardingStatus?: UserOnboardingStatus | null;
+    userType?: UserType;
 }
 export interface IUser {
     id?: string;
@@ -35,3 +38,8 @@ export interface IUser {
     subscription?: ISubscription | null;
     project?: IProject[];
 }
+export type UserOnboardingStatus = {
+    completedAt?: Date | null;
+    step?: OnboardingSteps | null;
+    data?: OnboardingData | null;
+};

package/dist/types/utils/index.d.ts

@@ -4,4 +4,5 @@ export * from './convert-query.util';
 export * from './notifications.type-util';
 export * from './billing.util';
 export * from './email.utils';
+export * from './onboarding.utils';
 export type ValueOf<T> = T[keyof T];

package/dist/types/utils/index.js

@@ -20,3 +20,4 @@ __exportStar(require("./convert-query.util"), exports);
 __exportStar(require("./notifications.type-util"), exports);
 __exportStar(require("./billing.util"), exports);
 __exportStar(require("./email.utils"), exports);
+__exportStar(require("./onboarding.utils"), exports);

package/dist/types/utils/onboarding.utils.d.ts

@@ -0,0 +1,34 @@
+import { OnboardingSteps, UserType } from '../enum';
+export declare const ABYSS_MEMORIES_PLAY_STORE_URL = "https://play.google.com/store/apps/details?id=abyss.project.memories&pcampaignid=web_share";
+export declare const ABYSS_CLOUD_PLAY_STORE_URL = "https://play.google.com/store/apps/details?id=abyss.project.cloud&pcampaignid=web_share";
+export declare const ABYSS_MEMORIES_APPLE_STORE_URL = "https://apps.apple.com/fr/app/abyss-memories/id6505037238";
+export declare const ABYSS_CLOUD_APPLE_STORE_URL = "https://apps.apple.com/fr/app/abyss-cloud/id6636511562";
+export declare const COMMONS_STEPS: OnboardingSteps[];
+export type OnboardingData = {
+    userDetails: {
+        name: string;
+        familyName: string;
+        email: string;
+        signupAsCompany: boolean;
+        companyName?: string;
+        companyRole?: string;
+        companyWebsite?: string;
+    };
+    userType: {
+        type: UserType | null;
+    };
+    userFeatures: {
+        cloud: boolean;
+        banking: boolean;
+        memories: boolean;
+        form: boolean;
+        spotlight: boolean;
+    };
+};
+export declare const getOnboardingProgression: (currentStep: OnboardingSteps, onboardingData: OnboardingData) => {
+    nextStep: OnboardingSteps;
+    steps: OnboardingSteps[];
+    progression: number;
+    stepIndex: number;
+    isLastStep: boolean;
+};

package/dist/types/utils/onboarding.utils.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOnboardingProgression = exports.COMMONS_STEPS = exports.ABYSS_CLOUD_APPLE_STORE_URL = exports.ABYSS_MEMORIES_APPLE_STORE_URL = exports.ABYSS_CLOUD_PLAY_STORE_URL = exports.ABYSS_MEMORIES_PLAY_STORE_URL = void 0;
+const enum_1 = require("../enum");
+exports.ABYSS_MEMORIES_PLAY_STORE_URL = 'https://play.google.com/store/apps/details?id=abyss.project.memories&pcampaignid=web_share';
+exports.ABYSS_CLOUD_PLAY_STORE_URL = 'https://play.google.com/store/apps/details?id=abyss.project.cloud&pcampaignid=web_share';
+exports.ABYSS_MEMORIES_APPLE_STORE_URL = 'https://apps.apple.com/fr/app/abyss-memories/id6505037238';
+exports.ABYSS_CLOUD_APPLE_STORE_URL = 'https://apps.apple.com/fr/app/abyss-cloud/id6636511562';
+exports.COMMONS_STEPS = [
+    enum_1.OnboardingSteps.LANDING,
+    enum_1.OnboardingSteps.USER_DETAILS,
+    enum_1.OnboardingSteps.USER_TYPE,
+];
+const getOnboardingProgression = (currentStep, onboardingData) => {
+    var _a, _b, _c, _d, _e, _f, _g, _h;
+    const allSteps = [
+        ...exports.COMMONS_STEPS,
+        ...(((_a = onboardingData.userType) === null || _a === void 0 ? void 0 : _a.type) === enum_1.UserType.DEVELOPER
+            ? [
+                enum_1.OnboardingSteps.DEVELOPER_CREATE_PROJECT,
+                enum_1.OnboardingSteps.DEVELOPER_DISCOVER_MONITOR,
+                enum_1.OnboardingSteps.DEVELOPER_DISCOVER_STORAGE,
+            ]
+            : []),
+        ...(((_b = onboardingData.userType) === null || _b === void 0 ? void 0 : _b.type) === enum_1.UserType.USER
+            ? [enum_1.OnboardingSteps.USER_FEATURE_SELECT]
+            : []),
+        ...(((_c = onboardingData.userType) === null || _c === void 0 ? void 0 : _c.type) === enum_1.UserType.USER
+            ? [
+                ...(((_d = onboardingData.userFeatures) === null || _d === void 0 ? void 0 : _d.cloud) ? [enum_1.OnboardingSteps.USER_CREATE_CLOUD] : []),
+                ...(((_e = onboardingData.userFeatures) === null || _e === void 0 ? void 0 : _e.banking) ? [enum_1.OnboardingSteps.USER_CONNECT_BANK] : []),
+                ...(((_f = onboardingData.userFeatures) === null || _f === void 0 ? void 0 : _f.memories) ? [enum_1.OnboardingSteps.USER_CREATE_MEMORIES] : []),
+                ...(((_g = onboardingData.userFeatures) === null || _g === void 0 ? void 0 : _g.form) ? [enum_1.OnboardingSteps.USER_CREATE_FORM] : []),
+                ...(((_h = onboardingData.userFeatures) === null || _h === void 0 ? void 0 : _h.spotlight)
+                    ? [enum_1.OnboardingSteps.USER_CREATE_SPOTLIGHT]
+                    : []),
+            ]
+            : []),
+        enum_1.OnboardingSteps.END,
+    ];
+    const isLastStep = currentStep === allSteps.at(-1);
+    const currentIndex = allSteps.indexOf(currentStep);
+    return {
+        nextStep: enum_1.OnboardingSteps.USER_DETAILS,
+        steps: allSteps,
+        progression: (currentIndex + 1) / allSteps.length,
+        stepIndex: currentIndex,
+        isLastStep,
+    };
+};
+exports.getOnboardingProgression = getOnboardingProgression;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abyss-project/main",
-  "version": "1.0.45",
+  "version": "1.0.47",
   "description": "Core package to interact with Abyss-Project",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",