@mytmpvpn/mytmpvpn-common 6.2.0 → 7.0.0

package/dist/src/errors.d.ts

@@ -25,3 +25,45 @@ export declare class MinDeleteAfterError extends InvalidVpnConfigError {
 export declare class MaxDeleteAfterError extends InvalidVpnConfigError {
     constructor(max: number, given: number);
 }
+export declare enum ReferralErrorCode {
+    UNKNOWN = 0,
+    INVALID_CODE = 1,
+    CODE_EXPIRED = 2,
+    CODE_ALREADY_USED = 3,
+    SELF_REFERRAL = 4,
+    INACTIVE_CODE = 5,
+    USER_NOT_ELIGIBLE = 6,
+    REWARD_DISTRIBUTION_FAILED = 7,
+    SUSPICIOUS_ACTIVITY = 8
+}
+export declare class ReferralServiceError extends MyTmpVpnError {
+    constructor(msg: string);
+}
+export declare class IneligibleReferralServiceUserError extends ReferralServiceError {
+    constructor(referre: string);
+}
+export declare class DisabledReferralServiceError extends ReferralServiceError {
+    constructor();
+}
+export declare class ReferralCodeError extends ReferralServiceError {
+    errorCode: ReferralErrorCode;
+    constructor(errorCode: ReferralErrorCode, referralCode: string, msg: string);
+}
+export declare class InvalidReferralCodeError extends ReferralCodeError {
+    constructor(referralCode: string);
+}
+export declare class UnknownReferralCodeError extends ReferralCodeError {
+    constructor(referralCode: string);
+}
+export declare class ExpiredReferralCodeError extends ReferralCodeError {
+    constructor(referralCode: string);
+}
+export declare class AlreadyUsedReferralCodeError extends ReferralCodeError {
+    constructor(referralCode: string, alreadyUsedReferralCode: string);
+}
+export declare class SelfReferralCodeError extends ReferralCodeError {
+    constructor(referralCode: string);
+}
+export declare class InactiveReferralCodeError extends ReferralCodeError {
+    constructor(referralCode: string);
+}

package/dist/src/errors.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MaxDeleteAfterError = exports.MinDeleteAfterError = exports.NotEnoughPeanutsError = exports.MaxPeanutsError = exports.MinPeanutsError = exports.InvalidVpnConfigError = exports.NegativeBalanceError = exports.InvalidUserConfigError = exports.MyTmpVpnError = void 0;
+exports.InactiveReferralCodeError = exports.SelfReferralCodeError = exports.AlreadyUsedReferralCodeError = exports.ExpiredReferralCodeError = exports.UnknownReferralCodeError = exports.InvalidReferralCodeError = exports.ReferralCodeError = exports.DisabledReferralServiceError = exports.IneligibleReferralServiceUserError = exports.ReferralServiceError = exports.ReferralErrorCode = exports.MaxDeleteAfterError = exports.MinDeleteAfterError = exports.NotEnoughPeanutsError = exports.MaxPeanutsError = exports.MinPeanutsError = exports.InvalidVpnConfigError = exports.NegativeBalanceError = exports.InvalidUserConfigError = exports.MyTmpVpnError = void 0;
 const peanuts_1 = require("./models/peanuts");
 class MyTmpVpnError extends Error {
     constructor(msg) {
@@ -74,3 +74,96 @@ class MaxDeleteAfterError extends InvalidVpnConfigError {
     }
 }
 exports.MaxDeleteAfterError = MaxDeleteAfterError;
+var ReferralErrorCode;
+(function (ReferralErrorCode) {
+    ReferralErrorCode[ReferralErrorCode["UNKNOWN"] = 0] = "UNKNOWN";
+    ReferralErrorCode[ReferralErrorCode["INVALID_CODE"] = 1] = "INVALID_CODE";
+    ReferralErrorCode[ReferralErrorCode["CODE_EXPIRED"] = 2] = "CODE_EXPIRED";
+    ReferralErrorCode[ReferralErrorCode["CODE_ALREADY_USED"] = 3] = "CODE_ALREADY_USED";
+    ReferralErrorCode[ReferralErrorCode["SELF_REFERRAL"] = 4] = "SELF_REFERRAL";
+    ReferralErrorCode[ReferralErrorCode["INACTIVE_CODE"] = 5] = "INACTIVE_CODE";
+    ReferralErrorCode[ReferralErrorCode["USER_NOT_ELIGIBLE"] = 6] = "USER_NOT_ELIGIBLE";
+    ReferralErrorCode[ReferralErrorCode["REWARD_DISTRIBUTION_FAILED"] = 7] = "REWARD_DISTRIBUTION_FAILED";
+    ReferralErrorCode[ReferralErrorCode["SUSPICIOUS_ACTIVITY"] = 8] = "SUSPICIOUS_ACTIVITY";
+})(ReferralErrorCode = exports.ReferralErrorCode || (exports.ReferralErrorCode = {}));
+class ReferralServiceError extends MyTmpVpnError {
+    constructor(msg) {
+        super(msg);
+        // Set the prototype explicitly.
+        Object.setPrototypeOf(this, ReferralServiceError.prototype);
+    }
+}
+exports.ReferralServiceError = ReferralServiceError;
+class IneligibleReferralServiceUserError extends ReferralServiceError {
+    constructor(referre) {
+        super(`ineligible. See referral program conditions.`);
+        // Set the prototype explicitly.
+        Object.setPrototypeOf(this, IneligibleReferralServiceUserError.prototype);
+    }
+}
+exports.IneligibleReferralServiceUserError = IneligibleReferralServiceUserError;
+class DisabledReferralServiceError extends ReferralServiceError {
+    constructor() {
+        super(`Referral service is currently disabled.`);
+        // Set the prototype explicitly.
+        Object.setPrototypeOf(this, DisabledReferralServiceError.prototype);
+    }
+}
+exports.DisabledReferralServiceError = DisabledReferralServiceError;
+class ReferralCodeError extends ReferralServiceError {
+    constructor(errorCode, referralCode, msg) {
+        super(`Error with referral code: ${referralCode}: ${msg}`);
+        this.errorCode = errorCode;
+        // Set the prototype explicitly.
+        Object.setPrototypeOf(this, ReferralCodeError.prototype);
+    }
+}
+exports.ReferralCodeError = ReferralCodeError;
+class InvalidReferralCodeError extends ReferralCodeError {
+    constructor(referralCode) {
+        super(ReferralErrorCode.INVALID_CODE, referralCode, `Code must be of 8 hexadecimal digits, e.g.: ABCDEF12`);
+        // Set the prototype explicitly.
+        Object.setPrototypeOf(this, InvalidReferralCodeError.prototype);
+    }
+}
+exports.InvalidReferralCodeError = InvalidReferralCodeError;
+class UnknownReferralCodeError extends ReferralCodeError {
+    constructor(referralCode) {
+        super(ReferralErrorCode.INVALID_CODE, referralCode, `Unknown code`);
+        // Set the prototype explicitly.
+        Object.setPrototypeOf(this, UnknownReferralCodeError.prototype);
+    }
+}
+exports.UnknownReferralCodeError = UnknownReferralCodeError;
+class ExpiredReferralCodeError extends ReferralCodeError {
+    constructor(referralCode) {
+        super(ReferralErrorCode.INVALID_CODE, referralCode, `expired`);
+        // Set the prototype explicitly.
+        Object.setPrototypeOf(this, ExpiredReferralCodeError.prototype);
+    }
+}
+exports.ExpiredReferralCodeError = ExpiredReferralCodeError;
+class AlreadyUsedReferralCodeError extends ReferralCodeError {
+    constructor(referralCode, alreadyUsedReferralCode) {
+        super(ReferralErrorCode.CODE_ALREADY_USED, referralCode, `you have already used a referral code: ${alreadyUsedReferralCode}`);
+        // Set the prototype explicitly.
+        Object.setPrototypeOf(this, AlreadyUsedReferralCodeError.prototype);
+    }
+}
+exports.AlreadyUsedReferralCodeError = AlreadyUsedReferralCodeError;
+class SelfReferralCodeError extends ReferralCodeError {
+    constructor(referralCode) {
+        super(ReferralErrorCode.SELF_REFERRAL, referralCode, `you cannot use you're own referral code`);
+        // Set the prototype explicitly.
+        Object.setPrototypeOf(this, SelfReferralCodeError.prototype);
+    }
+}
+exports.SelfReferralCodeError = SelfReferralCodeError;
+class InactiveReferralCodeError extends ReferralCodeError {
+    constructor(referralCode) {
+        super(ReferralErrorCode.INACTIVE_CODE, referralCode, `inactive`);
+        // Set the prototype explicitly.
+        Object.setPrototypeOf(this, InactiveReferralCodeError.prototype);
+    }
+}
+exports.InactiveReferralCodeError = InactiveReferralCodeError;

package/dist/src/models/index.d.ts

@@ -1,2 +1,3 @@
 export * as vpn from './vpn';
 export * as uservpn from './uservpn';
+export * as referral from './referral';

package/dist/src/models/index.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.uservpn = exports.vpn = void 0;
+exports.referral = exports.uservpn = exports.vpn = void 0;
 exports.vpn = require("./vpn");
 exports.uservpn = require("./uservpn");
+exports.referral = require("./referral");

package/dist/src/models/referral.d.ts

@@ -0,0 +1,49 @@
+export interface ReferralCode {
+    code: string;
+    createdAt: Date;
+    isActive: boolean;
+    usageCount: number;
+}
+export interface ReferralStats {
+    totalReferrals: number;
+    successfulReferrals: number;
+    totalRewardsEarned: number;
+}
+export interface ReferralRelationship {
+    referralCode: string;
+    createdAt: string;
+    rewardsProcessed: boolean;
+    referrerReward: number;
+    refereeReward: number;
+    version: string;
+}
+export interface ValidateReferralCodeRequest {
+    referralCode: string;
+}
+export interface ValidateReferralCodeResponse {
+    isValid?: boolean;
+    error?: string;
+}
+export type GetReferralCodeResponse = string;
+export type GetReferrerCodeResponse = string | undefined;
+export type GetReferralStatsResponse = ReferralStats;
+export interface ReferralHistoryItem {
+    relationshipId: string;
+    referralCode: string;
+    createdAt: string;
+    rewardsProcessed: boolean;
+    referrerReward: number;
+    refereeReward: number;
+}
+export interface GetReferralHistoryResponse {
+    history: ReferralHistoryItem[];
+    pagination: {
+        nextToken?: string;
+        hasMore: boolean;
+    };
+}
+export interface GetReferralHistoryRequest {
+    limit?: number;
+    nextToken?: string;
+}
+export declare function validateReferralCodeSyntax(code: string): void;

package/dist/src/models/referral.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateReferralCodeSyntax = void 0;
+const errors_1 = require("../errors");
+const loglevel_1 = require("loglevel");
+function validateReferralCodeSyntax(code) {
+    if (code === null || code === undefined) {
+        loglevel_1.default.error(`Referral code cannot be null or undefined: `, code);
+        throw new errors_1.InvalidReferralCodeError(code);
+    }
+    if (!code || code.trim() === '') {
+        loglevel_1.default.error(`Referral code cannot be empty: `, code);
+        throw new errors_1.InvalidReferralCodeError(code);
+    }
+    if (code.length !== 8) {
+        loglevel_1.default.error(`Invalid referral code format: `, code);
+        throw new errors_1.InvalidReferralCodeError(code);
+    }
+    if (!/^[A-Z0-9]{8}$/.test(code)) {
+        loglevel_1.default.error(`Referral code must contain only uppercase letters and numbers: `, code);
+        throw new errors_1.InvalidReferralCodeError(code);
+    }
+}
+exports.validateReferralCodeSyntax = validateReferralCodeSyntax;

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@mytmpvpn/mytmpvpn-common",
-  "version": "6.2.0",
+  "version": "7.0.0",
   "description": "Common library for all MyTmpVpn related projects",
-  "types": "dist/index.d.ts",
+  "types": "dist/src/index.d.ts",
   "files": [
     "/dist"
   ],