@misterhomer1992/miit-bot-payment 1.1.7 → 2.0.4

package/src/modules/tokenPack/types.ts

@@ -0,0 +1,131 @@
+import { NestedPathsAccess } from '../../types/utilities';
+
+type TokenPackEntity = {
+    /** Auto-generated unique ID (document ID) */
+    id: string;
+    /** The Telegram User ID this token pack belongs to */
+    userId: string;
+    /** Platform/app namespace */
+    platform: string;
+    /** The identifier for the token pack type */
+    packId: string;
+    /** Number of tokens in this pack */
+    tokens: number;
+    /** Number of tokens remaining */
+    tokensRemaining: number;
+    /** The lifecycle state of this token pack */
+    status: 'active' | 'depleted' | 'expired';
+    /** Timestamp when this token pack was purchased */
+    purchasedAt: string;
+    /** Timestamp when this token pack expires (optional) */
+    expiresAt?: string;
+    /** Payment provider */
+    provider: 'wayforpay' | 'platform';
+};
+
+type TokenPackFieldPath = NestedPathsAccess<TokenPackEntity>;
+
+/**
+ * Interface for token pack repository operations.
+ * Defines the contract for data access layer.
+ */
+interface ITokenPackRepository {
+    /**
+     * Retrieves a token pack by ID.
+     * @param id - The token pack ID
+     * @returns Promise resolving to TokenPackEntity or null if not found
+     */
+    getById(id: string): Promise<TokenPackEntity | null>;
+
+    /**
+     * Retrieves all token packs for a specific user.
+     * @param params - Query parameters
+     * @returns Promise resolving to array of TokenPackEntity
+     */
+    getByUser(params: {
+        userId: string;
+        platform: string;
+        status?: TokenPackEntity['status'] | TokenPackEntity['status'][];
+    }): Promise<TokenPackEntity[]>;
+
+    /**
+     * Creates a new token pack record in the database.
+     * @param params - Token pack creation parameters
+     * @returns Promise resolving to created TokenPackEntity with ID
+     */
+    create(params: Omit<TokenPackEntity, 'id' | 'status' | 'tokensRemaining'>): Promise<TokenPackEntity>;
+
+    /**
+     * Updates specific fields of a token pack identified by ID.
+     * @param params - Update parameters
+     */
+    updateFieldsById(params: { id: string; fields: any }): Promise<void>;
+
+    /**
+     * Deducts tokens from a token pack.
+     * @param params - Deduction parameters
+     */
+    deductTokens(params: { id: string; amount: number }): Promise<void>;
+
+    /**
+     * Retrieves all active token packs that have expired.
+     * @returns Promise resolving to array of expired TokenPackEntity
+     */
+    getExpiredActiveTokenPacks(): Promise<TokenPackEntity[]>;
+}
+
+/**
+ * Interface for token pack service operations.
+ * Defines the contract for business logic layer.
+ */
+interface ITokenPackService {
+    /**
+     * Retrieves a token pack by ID.
+     * @param id - The token pack ID
+     * @returns Promise resolving to TokenPackEntity or null if not found
+     */
+    getById(id: string): Promise<TokenPackEntity | null>;
+
+    /**
+     * Retrieves all token packs for a specific user.
+     * @param params - Query parameters
+     * @returns Promise resolving to array of TokenPackEntity
+     */
+    getByUser(params: {
+        userId: string;
+        platform: string;
+        status?: TokenPackEntity['status'] | TokenPackEntity['status'][];
+    }): Promise<TokenPackEntity[]>;
+
+    /**
+     * Creates a new token pack record in the database.
+     * @param params - Token pack creation parameters
+     * @returns Promise resolving to created TokenPackEntity with ID
+     */
+    create(params: Omit<TokenPackEntity, 'id' | 'status' | 'tokensRemaining'>): Promise<TokenPackEntity>;
+
+    /**
+     * Updates specific fields of a token pack identified by ID.
+     * @param params - Update parameters
+     */
+    updateFieldsById(params: { id: string; fields: any }): Promise<void>;
+
+    /**
+     * Deducts tokens from a token pack.
+     * @param params - Deduction parameters
+     */
+    deductTokens(params: { id: string; amount: number }): Promise<void>;
+
+    /**
+     * Retrieves all active token packs that have expired.
+     * @returns Promise resolving to array of expired TokenPackEntity
+     */
+    getExpiredActiveTokenPacks(): Promise<TokenPackEntity[]>;
+}
+
+export type {
+    TokenPackEntity,
+    TokenPackFieldPath,
+    ITokenPackRepository,
+    ITokenPackService,
+};

package/src/modules/user/index.ts

@@ -0,0 +1,3 @@
+export * from './userRepository';
+export * from './userService';
+export * from './types';

package/src/modules/user/types.ts

@@ -0,0 +1,143 @@
+import { NestedPathsAccess } from '../../types/utilities';
+
+export interface User {
+    user: {
+        id: string;
+        lastUpdate: null | string;
+        createdDate: null | string;
+        name: null | string;
+    };
+    subscription: {
+        isActive: boolean;
+        isTrial: boolean;
+        payments?: {
+            planId: string;
+            orderReference: string;
+            url: string;
+            createdDate: string;
+        }[];
+        paymentUrlMessageId?: number;
+    };
+    personality?: string;
+    messages: Record<string, Record<string, unknown>>;
+    commands?: Record<string, unknown>;
+    keyboardContext?: Record<string, unknown>;
+    settings: {
+        voiceResponse: boolean;
+        languageCode: string;
+        activeMessageThread: string;
+        requestCount: number;
+        imageAutoDetection: boolean;
+        imageResolution: string;
+        activeKeyboardMessageId?: number;
+        hasFakeImage?: boolean;
+    };
+}
+
+export interface UserAnalytics {
+    id: string;
+    platform: string;
+    createdDate: string;
+    chatGPT: {
+        completions: Partial<
+            Record<
+                number,
+                {
+                    requestTokensCount: number;
+                    responseTokensCount: number;
+                }
+            >
+        >;
+        image: {
+            create?: {
+                '11': {
+                    count: number;
+                    inputImageTokens: number;
+                    outputImageTokens: number;
+                    inputTextTokens: number;
+                };
+                '12': {
+                    count: number;
+                };
+                '18': {
+                    count: number;
+                };
+            };
+            vision: Partial<
+                Record<
+                    number,
+                    {
+                        requestTokensCount: number;
+                        responseTokensCount: number;
+                    }
+                >
+            >;
+        };
+        speechToText: {
+            'whisper-1': {
+                seconds: number;
+            };
+        };
+        textToSpeech: {
+            'tts-1': {
+                charsCount: number;
+            };
+        };
+    };
+}
+
+export type UserFieldPath = NestedPathsAccess<User>;
+
+export type UserFieldAnalyticsPath = NestedPathsAccess<UserAnalytics>;
+
+/**
+ * Interface for user repository operations.
+ * Defines the contract for data access layer.
+ */
+export interface IUserRepository {
+    /**
+     * Retrieves a user by their ID.
+     * @param params - Query parameters
+     * @returns Promise resolving to User or null if not found
+     */
+    getByUser(params: { userId: string; platform: string }): Promise<User | null>;
+
+    /**
+     * Creates a new user record in the database.
+     * @param params - User creation parameters
+     * @returns Promise resolving when user is created
+     */
+    create(params: { user: User; platform: string }): Promise<void>;
+
+    /**
+     * Updates specific fields of a user identified by userId.
+     * @param params - Update parameters
+     */
+    updateFieldsByUserId(params: { platform: string; userId: string; fields: any }): Promise<void>;
+}
+
+/**
+ * Interface for user service operations.
+ * Defines the contract for business logic layer.
+ */
+export interface IUserService {
+    /**
+     * Retrieves a user by their ID.
+     * @param params - Query parameters
+     * @returns Promise resolving to User or null if not found
+     */
+    getByUser(params: { userId: string; platform: string }): Promise<User | null>;
+
+    /**
+     * Creates a new user record in the database.
+     * @param params - User creation parameters
+     * @returns Promise resolving when user is created
+     */
+    create(params: { user: User; platform: string }): Promise<void>;
+
+    /**
+     * Updates specific fields of a user identified by userId.
+     * @param params - Update parameters
+     */
+    updateFieldsByUserId(params: { platform: string; userId: string; fields: any }): Promise<void>;
+}

package/src/modules/user/userRepository.ts

@@ -0,0 +1,64 @@
+import { FieldValue, Firestore, getFirestore, DocumentSnapshot } from 'firebase-admin/firestore';
+import { User, UserFieldPath, IUserRepository } from './types';
+
+export type UpdateDBUserFields = [UserFieldPath, FieldValue | string | number | boolean | Date | [] | {}][];
+
+export class UserRepository implements IUserRepository {
+    private readonly db: Firestore;
+
+    constructor({ db }: { db?: Firestore } = {}) {
+        this.db = db || getFirestore();
+    }
+
+    public async getByUser(params: { userId: string; platform: string }): Promise<User | null> {
+        const { userId, platform } = params;
+
+        const docSnapshot = await this.db.collection(`platform/${platform}/users`).doc(userId).get();
+
+        if (!docSnapshot.exists) {
+            return null;
+        }
+
+        return this.mapDocumentToEntity(docSnapshot);
+    }
+
+    public async create(params: { user: User; platform: string }): Promise<void> {
+        const { user, platform } = params;
+
+        await this.db.collection(`platform/${platform}/users`).doc(user.user.id).set(user);
+    }
+
+    public async updateFieldsByUserId(params: {
+        platform: string;
+        userId: string;
+        fields: UpdateDBUserFields;
+    }): Promise<void> {
+        const { userId, platform, fields } = params;
+
+        const updateObject = this.buildUpdateObject(fields);
+
+        const snapshot = await this.db.collection(`platform/${platform}/users`).doc(userId).get();
+
+        if (!snapshot.exists) {
+            throw new Error(`User not found: ${userId}`);
+        }
+
+        await snapshot.ref.update(updateObject);
+    }
+
+    private mapDocumentToEntity(doc: DocumentSnapshot): User {
+        return doc.data() as User;
+    }
+
+    private buildUpdateObject(fields: UpdateDBUserFields): Record<string, any> {
+        const updateObject: Record<string, any> = {};
+
+        fields
+            .filter((f) => Array.isArray(f))
+            .forEach(([fieldPath, value]) => {
+                updateObject[fieldPath] = value;
+            });
+
+        return updateObject;
+    }
+}

package/src/modules/user/userService.ts

@@ -0,0 +1,68 @@
+import { Logger } from '../logger/types';
+import { UserRepository, UpdateDBUserFields } from './userRepository';
+import { User, IUserRepository, IUserService } from './types';
+
+export class UserService implements IUserService {
+    private readonly logger: Logger;
+    private readonly repository: IUserRepository;
+
+    constructor({ logger, repository }: { logger: Logger; repository?: IUserRepository }) {
+        this.logger = logger;
+        this.repository = repository || new UserRepository();
+    }
+
+    public async getByUser(params: { userId: string; platform: string }): Promise<User | null> {
+        try {
+            return await this.repository.getByUser(params);
+        } catch (error) {
+            this.logger.error({
+                message: 'Error in user service getByUser',
+                payload: {
+                    userId: params.userId,
+                    platform: params.platform,
+                    error: JSON.stringify(error),
+                },
+            });
+            return null;
+        }
+    }
+
+    public async create(params: { user: User; platform: string }): Promise<void> {
+        try {
+            await this.repository.create(params);
+        } catch (error) {
+            this.logger.error({
+                message: 'Error in user service create',
+                payload: {
+                    userId: params.user.user.id,
+                    platform: params.platform,
+                    error: JSON.stringify(error),
+                },
+            });
+
+            throw error;
+        }
+    }
+
+    public async updateFieldsByUserId(params: {
+        platform: string;
+        userId: string;
+        fields: UpdateDBUserFields;
+    }): Promise<void> {
+        try {
+            await this.repository.updateFieldsByUserId(params);
+        } catch (error) {
+            this.logger.error({
+                message: 'Error in user service updateFieldsByUserId',
+                payload: {
+                    userId: params.userId,
+                    platform: params.platform,
+                    fields: JSON.stringify(params.fields),
+                    error: JSON.stringify(error),
+                },
+            });
+
+            throw error;
+        }
+    }
+}

package/src/types/extend-express.d.ts

@@ -0,0 +1,16 @@
+import { ParsedReferenceString } from '../functions/process-purchase-transaction/utils';
+import { ServiceUrlRequestParams1, ServiceUrlRequestParams2, SubscriptionEntity } from '../modules/subscription/types';
+import { User } from '../modules/user/types';
+
+declare global {
+    namespace Express {
+        interface Locals {
+            requestData: ServiceUrlRequestParams1 | ServiceUrlRequestParams2;
+            parsedOrderReference: ParsedReferenceString;
+            user: User;
+            subscription: SubscriptionEntity;
+        }
+    }
+}
+
+export {};

package/src/types/function.ts

@@ -0,0 +1,5 @@
+export type SimpleFn = (...args: any[]) => any;
+
+export type ExtendFn<Fn extends SimpleFn = SimpleFn, K extends any[] = Parameters<Fn>> = (
+    ...args: [...K]
+) => ReturnType<Fn>;

package/src/types/utilities.ts

@@ -0,0 +1,22 @@
+type NonFunctionPropertyNames<T> = {
+    // eslint-disable-next-line @typescript-eslint/ban-types
+    [K in keyof T]: T[K] extends Function ? never : K;
+}[keyof T];
+
+export type Primitive = string | number | boolean;
+
+export type IsArray<T> = T extends Array<any> ? true : false;
+
+export type NestedPathsAccess<T, Prev extends string = ''> = T extends Primitive
+    ? never
+    : T extends Array<infer U>
+      ? U extends Primitive
+          ? `${Prev}[${number}]`
+          : `${Prev}[${number}]` | NestedPathsAccess<U, `${Prev}[${number}].`>
+      : {
+            [K in NonFunctionPropertyNames<T> & string]: T[K] extends Primitive
+                ? `${Prev}${K}`
+                : IsArray<T[K]> extends true
+                  ? `${Prev}${K}` | NestedPathsAccess<T[K], `${Prev}${K}`>
+                  : `${Prev}${K}` | NestedPathsAccess<T[K], `${Prev}${K}.`>;
+        }[NonFunctionPropertyNames<T> & string];

package/src/utils.ts

@@ -0,0 +1,53 @@
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+require('dotenv').config();
+
+import path from 'path';
+
+const firebaseAdminServiceAccountName = 'miia-telegram-bot-e3993ff1611c.json';
+
+function getGoogleServiceAccount() {
+    return require(path.resolve(process.cwd(), 'keys', firebaseAdminServiceAccountName));
+}
+
+function isUndefined(val: unknown): val is undefined {
+    return typeof val === 'undefined';
+}
+
+function isNull(val: unknown): val is null {
+    return val === null;
+}
+
+function isNullOrUndefined(val: unknown) {
+    return isNull(val) || isUndefined(val);
+}
+
+function isNumber(val: unknown): val is number {
+    return typeof val === 'number' && Number.isFinite(Number(val));
+}
+
+function isObject(val: unknown): val is object {
+    return Object.prototype.toString.call(val).slice(8, -1).toLowerCase() === 'object';
+}
+
+function isError(val: unknown): val is Error {
+    return Object.prototype.toString.call(val).slice(8, -1).toLowerCase() === 'error';
+}
+
+function isBadOrEmptyString(val: unknown) {
+    if (isNullOrUndefined(val) || typeof val !== 'string') {
+        return true;
+    }
+
+    return val.trim().length === 0;
+}
+
+export {
+    getGoogleServiceAccount,
+    isUndefined,
+    isNull,
+    isNullOrUndefined,
+    isNumber,
+    isObject,
+    isError,
+    isBadOrEmptyString,
+};

package/tsconfig.json

@@ -0,0 +1,29 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "lib": [
+      "ES2020"
+    ],
+    "declaration": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "noImplicitAny": false,
+    "strict": false,
+    "esModuleInterop": true,
+    "skipLibCheck": true
+  },
+  "include": [
+    "src/**/*"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist",
+    "**/*.test.ts"
+  ]
+}

package/dist/modules/subscription/subscriptionPlan.d.ts

@@ -1,4 +0,0 @@
-import { SubscriptionPlan } from './types';
-declare const SUBSCRIPTION_PLAN: SubscriptionPlan[];
-export { SUBSCRIPTION_PLAN };
-//# sourceMappingURL=subscriptionPlan.d.ts.map

package/dist/modules/subscription/subscriptionPlan.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"subscriptionPlan.d.ts","sourceRoot":"","sources":["../../../src/modules/subscription/subscriptionPlan.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAE3C,QAAA,MAAM,iBAAiB,EAAE,gBAAgB,EA6DxC,CAAC;AAEF,OAAO,EAAE,iBAAiB,EAAE,CAAC"}

package/dist/modules/subscription/subscriptionPlan.js

@@ -1,67 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SUBSCRIPTION_PLAN = void 0;
-const SUBSCRIPTION_PLAN = [
-    {
-        id: 'basic',
-        titleCode: 'subscription.plan.1.title',
-        descriptionCode: 'subscription.plan.1.description',
-        amount: 7,
-        currency: 'UAH',
-        features: {
-            messages: 1000,
-            images: 0,
-            voice: 50,
-            study: 2,
-        },
-        regularMode: 'monthly',
-        count: 2,
-    },
-    {
-        id: 'pro',
-        titleCode: 'subscription.plan.2.title',
-        descriptionCode: 'subscription.plan.2.description',
-        amount: 10,
-        currency: 'UAH',
-        features: {
-            messages: 2000,
-            images: 20,
-            voice: 50,
-            study: 2,
-        },
-        regularMode: 'monthly',
-        count: 2,
-    },
-    {
-        id: 'basic-daily',
-        titleCode: 'subscription.plan.3.title',
-        descriptionCode: 'subscription.plan.1.description',
-        amount: 7,
-        currency: 'UAH',
-        features: {
-            messages: 10,
-            images: 0,
-            voice: 50,
-            study: 2,
-        },
-        regularMode: 'daily',
-        count: 1,
-    },
-    {
-        id: 'pro-daily',
-        titleCode: 'subscription.plan.3.title',
-        descriptionCode: 'subscription.plan.2.description',
-        amount: 10,
-        currency: 'UAH',
-        features: {
-            messages: 20,
-            images: 20,
-            voice: 50,
-            study: 2,
-        },
-        regularMode: 'daily',
-        count: 1,
-    },
-];
-exports.SUBSCRIPTION_PLAN = SUBSCRIPTION_PLAN;
-//# sourceMappingURL=subscriptionPlan.js.map

package/dist/modules/subscription/subscriptionPlan.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"subscriptionPlan.js","sourceRoot":"","sources":["../../../src/modules/subscription/subscriptionPlan.ts"],"names":[],"mappings":";;;AAEA,MAAM,iBAAiB,GAAuB;IAC1C;QACI,EAAE,EAAE,OAAO;QACX,SAAS,EAAE,2BAA2B;QACtC,eAAe,EAAE,iCAAiC;QAClD,MAAM,EAAE,CAAC;QACT,QAAQ,EAAE,KAAK;QACf,QAAQ,EAAE;YACN,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,CAAC;YACT,KAAK,EAAE,EAAE;YACT,KAAK,EAAE,CAAC;SACX;QACD,WAAW,EAAE,SAAS;QACtB,KAAK,EAAE,CAAC;KACX;IACD;QACI,EAAE,EAAE,KAAK;QACT,SAAS,EAAE,2BAA2B;QACtC,eAAe,EAAE,iCAAiC;QAClD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE,KAAK;QACf,QAAQ,EAAE;YACN,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,EAAE;YACV,KAAK,EAAE,EAAE;YACT,KAAK,EAAE,CAAC;SACX;QACD,WAAW,EAAE,SAAS;QACtB,KAAK,EAAE,CAAC;KACX;IACD;QACI,EAAE,EAAE,aAAa;QACjB,SAAS,EAAE,2BAA2B;QACtC,eAAe,EAAE,iCAAiC;QAClD,MAAM,EAAE,CAAC;QACT,QAAQ,EAAE,KAAK;QACf,QAAQ,EAAE;YACN,QAAQ,EAAE,EAAE;YACZ,MAAM,EAAE,CAAC;YACT,KAAK,EAAE,EAAE;YACT,KAAK,EAAE,CAAC;SACX;QACD,WAAW,EAAE,OAAO;QACpB,KAAK,EAAE,CAAC;KACX;IACD;QACI,EAAE,EAAE,WAAW;QACf,SAAS,EAAE,2BAA2B;QACtC,eAAe,EAAE,iCAAiC;QAClD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE,KAAK;QACf,QAAQ,EAAE;YACN,QAAQ,EAAE,EAAE;YACZ,MAAM,EAAE,EAAE;YACV,KAAK,EAAE,EAAE;YACT,KAAK,EAAE,CAAC;SACX;QACD,WAAW,EAAE,OAAO;QACpB,KAAK,EAAE,CAAC;KACX;CACJ,CAAC;AAEO,8CAAiB"}