@mcdylanproperenterprise/nodejs-proper-money-types 0.0.6 → 0.0.7

package/enum.ts

@@ -1,8 +1,3 @@
-export enum EEnvironmentType {
-  PRODUCTION = "PRODUCTION",
-  STAGING = "STAGING",
-}
-
 export enum ESubscriptionEntitlement {
   starter = "Starter",
   plus = "Plus",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mcdylanproperenterprise/nodejs-proper-money-types",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "",
   "main": "",
   "types": "index.d.ts",

package/types.ts

@@ -0,0 +1,433 @@
+import {
+  EMissionType,
+  EPointFromType,
+  EPointType,
+  ERewardType,
+  ESubscriptionEntitlement,
+  ETransactionCategoryType,
+  EVerificationOneTimePasswordType,
+} from "./enum";
+import { EGetTransactionsBySort, EGetTransactionsByType } from "./enum";
+
+export type TJwtTokenObject = {
+  userId: string;
+};
+
+export type TJwtToken = {
+  accessToken: string;
+  refreshToken: string;
+};
+
+export type TMission = {
+  userId?: String;
+  type: EMissionType;
+  description: string;
+  missionCount: {
+    completedCount: number;
+    totalCount: number;
+  };
+  point: Number;
+  isClaimed: boolean;
+  isClaimable: boolean;
+  isActive: boolean;
+};
+
+export type TGetMissionQuery = {
+  entitlement: ESubscriptionEntitlement;
+};
+
+export type TGetMissionResponse = {
+  dailyMissions: {
+    missions: TMission[];
+    refreshAt: string;
+  };
+  weeklyMissions: {
+    missions: TMission[];
+    period: {
+      startAt: Date;
+      endAt: Date;
+    };
+    refreshAt: string;
+  };
+};
+
+export type TPoint = {
+  _id: string;
+  userId: string;
+  type: EPointType;
+  value: number;
+  pointFrom: {
+    type: EPointFromType;
+    id: string | null;
+    documentType: ERewardType | EMissionType;
+  };
+  expiryAt: Date;
+  createdAt: Date;
+};
+
+export type TGetPointTotalResponse = {
+  totalPoints: number;
+};
+
+export type TPostPointClaimBody = {
+  missionType: EMissionType;
+  entitlement: ESubscriptionEntitlement;
+};
+
+export type TReward = {
+  _id: string;
+  userId: string;
+  type: ERewardType;
+  value: number;
+  expiryAt: Date;
+  isRedeemed: boolean;
+  phoneNumber: null | string;
+  emailAddress: null | string;
+};
+
+export type TRewardStoreItem = {
+  name: string;
+  description: string;
+  type: ERewardType;
+  price: number;
+  refreshAt: string;
+  inventoryLeft: number;
+};
+
+export type TGetRewardQuery = {
+  isValid: string;
+  page: string;
+  limit: string;
+};
+
+export type TGetRewardResponse = {
+  rewards: TReward[];
+  pagination: {
+    last_visible_page: number;
+    has_next_page: boolean;
+  };
+};
+
+export type TPostRewardSubmitBody = {
+  rewardId: string;
+  phoneNumber: string;
+};
+
+export type TPostRewardClaimBody = {
+  rewardId: string;
+};
+
+export type TGetRewardStoreResponse = {
+  rewardStoreItems: TRewardStoreItem[];
+};
+
+export type TPostRewardRedeemBody = {
+  rewardType: ERewardType;
+};
+
+export type TPostRewardRedeemResponse = {
+  value: string;
+};
+
+export type TPostTopUpCreateBillBody = {
+  userId: string;
+  productId: string;
+  description: string;
+  name: string;
+  email: string;
+  amount: string;
+};
+
+export type TPostTopUpCreateReferenceBody = {
+  userId: string;
+  productId: string;
+  referenceNo: string;
+};
+
+export type TPostTopUpEditReferenceBody = {
+  iPayEightyEightResponse: Object;
+  iPayEightyEightBackend: Object;
+};
+
+export type TTransaction = {
+  _id: string;
+  userId: string;
+  transactionCategoryId: string;
+  transactionLabelIds: string[];
+  transactionCategory: TTransactionCategory;
+  transactionLabels: TTransactionLabel[] | null;
+  currency: string;
+  amount: number;
+  imagePath: string | null;
+  note: string | null;
+  isDeleted: boolean;
+  transactedAt: Date;
+  updatedAt: Date;
+  createdAt: Date;
+};
+
+export type TTimelineTransaction = {
+  date: string;
+  records: TTransaction[];
+  totalIncome: number;
+  totalExpense: number;
+  totalCurrenciesIncomeAndExpenses: {
+    currency: string;
+    totalIncomes: number;
+    totalExpenses: number;
+  }[];
+};
+
+export type TGetTransactionsDashboardQuery = {
+  startTransactedAt: string;
+  endTransactedAt: string;
+};
+
+export type TGetTransactionDashboardResponse = {
+  user: {
+    transactions: TTransaction[];
+    transactionCategories: TTransactionCategory[];
+    transactionLabels: TTransactionLabel[];
+    timelineTransactions: TTimelineTransaction[];
+  };
+  sharedUser: {
+    transactions: TTransaction[];
+    transactionCategories: TTransactionCategory[];
+    transactionLabels: TTransactionLabel[];
+    timelineTransactions: TTimelineTransaction[];
+  };
+  total: {
+    transactions: TTransaction[];
+    transactionCategories: TTransactionCategory[];
+    transactionLabels: TTransactionLabel[];
+    timelineTransactions: TTimelineTransaction[];
+  };
+};
+
+export type TPostTransactionCreateBody = {
+  transactionCategoryId: string;
+  transactionLabelIds: string[];
+  currency: string;
+  amount: number;
+  imagePath: string | null;
+  note: string | null;
+  transactedAt: Date;
+};
+
+export type TPostTransactionUpdateBody = {
+  _id: string;
+  transactionCategoryId: string;
+  transactionLabelIds: string[];
+  currency: string;
+  amount: number;
+  imagePath: string | null;
+  note: string | null;
+  transactedAt: Date;
+};
+
+export type TPostTransactionDeleteBody = {
+  _id: string;
+};
+
+export type TGetTransactionQuery = {
+  sort: EGetTransactionsBySort;
+  page: string;
+  limit: string;
+  targetUserId: string;
+  _id: string;
+  type: EGetTransactionsByType;
+  startTransactedAt: string | null;
+  endTransactedAt: string | null;
+};
+
+export type TGetTransactionResponse = {
+  transactions: TTransaction[];
+  totalAmount: number;
+  totalTransactionsLength: number;
+  pagination: {
+    last_visible_page: number;
+    has_next_page: boolean;
+  };
+};
+
+export type TTransactionCategory = {
+  _id: string;
+  name: string;
+  type: ETransactionCategoryType;
+  backgroundColor: string;
+  imagePath: string;
+  userId: string;
+  isDeleted: boolean;
+  updatedAt: Date;
+  createdAt: Date;
+};
+
+export type TGetTransactionCategoryResponse = {
+  categories: TTransactionCategory[];
+};
+
+export type TPostTransactionCategoryCreateBody = {
+  name: string;
+  type: ETransactionCategoryType;
+  backgroundColor: string;
+  imagePath: string;
+};
+
+export type TPostTransactionCategoryCreateResponse = {
+  _id: string;
+};
+
+export type TPostTransactionCategoryUpdateBody = {
+  _id: string;
+  name: string;
+  type: ETransactionCategoryType;
+  backgroundColor: string;
+  imagePath: string;
+};
+
+export type TPostTransactionCategoryDeleteBody = {
+  _id: string;
+};
+
+export type TGetTransactionCategoryAssetsResponse = {
+  icons: string[];
+  backgroundColors: string[];
+};
+
+export type TTransactionLabel = {
+  _id: string;
+  name: string;
+  userId: string;
+  isDeleted: boolean;
+  updatedAt: Date;
+  createdAt: Date;
+};
+
+export type TGetTransactionLabelResponse = {
+  labels: TTransactionLabel[];
+};
+
+export type TPostTransactionLabelCreateBody = {
+  name: string;
+};
+
+export type TPostTransactionLabelCreateResponse = {
+  _id: string;
+};
+
+export type TPostTransactionLabelUpdateBody = {
+  _id: string;
+  name: string;
+};
+
+export type TPostTransactionLabelDeleteBody = {
+  _id: string;
+};
+
+export type TUser = {
+  _id: string;
+  phoneNumber: string;
+  profileImage: string;
+  displayName: string;
+  language: string;
+  currency: string;
+  sharedUserId: string | null;
+  sharedUserInfo: TSharedUserInfo;
+  lastActiveAt: Date;
+  premiumMemberTrialEndAt: Date | null;
+  topUpMemberRole: ESubscriptionEntitlement | null;
+  topUpMemberEndAt: Date | null;
+  createdAt: Date;
+  notificationToken: string | null;
+};
+
+export type TMemberFeature = {
+  name: ESubscriptionEntitlement;
+  maximumCategories: number;
+  maximumLabels: number;
+  claimPointMultiplier: number;
+  isAblePhotoAI: boolean;
+};
+
+export const memberFeatureFree: TMemberFeature = {
+  name: ESubscriptionEntitlement.starter,
+  maximumCategories: 5,
+  maximumLabels: 10,
+  claimPointMultiplier: 1,
+  isAblePhotoAI: false,
+};
+
+export const memberFeaturePlus: TMemberFeature = {
+  name: ESubscriptionEntitlement.plus,
+  maximumCategories: 50,
+  maximumLabels: 100,
+  claimPointMultiplier: 2,
+  isAblePhotoAI: false,
+};
+
+export const memberFeaturePremium: TMemberFeature = {
+  name: ESubscriptionEntitlement.premium,
+  maximumCategories: 100,
+  maximumLabels: 200,
+  claimPointMultiplier: 4,
+  isAblePhotoAI: true,
+};
+
+export type TSharedUserInfo = {
+  _id: string;
+  id: string;
+  profileImage: string;
+  emailAddress: string | null;
+  phoneNumber: string | null;
+  displayName: string;
+  notificationToken: string | null;
+} | null;
+
+export type TGetUserDetailResponse = TUser;
+
+export type TPostUserRemoveSharedUserBody = {
+  sharedUserId: string;
+};
+
+export type TPostUserRequestOTPBody = {
+  phoneNumber: string;
+};
+
+export type TPostUserRequestOTPResponse = {
+  verificationOneTimePasswordType: EVerificationOneTimePasswordType;
+};
+
+export type TPostUserUpdateBody = Partial<TUser>;
+
+export type TVerification = {
+  _id: string;
+  userId: string;
+  type: EVerificationOneTimePasswordType;
+  oneTimePassword: string;
+  phoneNumber: string | null;
+  expiryAt: Date;
+  isVerify: boolean;
+  verifiedAt: Date | null;
+  createdAt: Date;
+};
+
+export type TPostVerificationVerifyBody = {
+  phoneNumber: string;
+  oneTimePassword: string;
+  oneTimePasswordType: EVerificationOneTimePasswordType;
+};
+
+export type TPostVerificationVerifyResponse = TJwtToken;
+
+export type TGetVerificationPostGenerateShareIdResponse = {
+  oneTimePassword: string;
+  expiryAt: Date;
+};
+
+export type TPostVerifyShareIdBody = {
+  oneTimePassword: string;
+};
+
+export type TPostVerifyShareIdReponse = {
+  sharedUserId: string;
+};

package/middleware.ts

@@ -1,8 +0,0 @@
-export type TJwtTokenObject = {
-  userId: string;
-};
-
-export type TJwtToken = {
-  accessToken: string;
-  refreshToken: string;
-};

package/mission.ts

@@ -1,34 +0,0 @@
-import { EMissionType, ESubscriptionEntitlement } from "./enum";
-
-export type TMission = {
-  userId?: String;
-  type: EMissionType;
-  description: string;
-  missionCount: {
-    completedCount: number;
-    totalCount: number;
-  };
-  point: Number;
-  isClaimed: boolean;
-  isClaimable: boolean;
-  isActive: boolean;
-};
-
-export type TMissionGetMissionsQuery = {
-  entitlement: ESubscriptionEntitlement;
-};
-
-export type TMissionGetMissionsResponse = {
-  dailyMissions: {
-    missions: TMission[];
-    refreshAt: string;
-  };
-  weeklyMissions: {
-    missions: TMission[];
-    period: {
-      startAt: Date;
-      endAt: Date;
-    };
-    refreshAt: string;
-  };
-};

package/point.ts

@@ -1,30 +0,0 @@
-import {
-  EMissionType,
-  EPointFromType,
-  EPointType,
-  ERewardType,
-  ESubscriptionEntitlement,
-} from "./enum";
-
-export type TPoint = {
-  _id: string;
-  userId: string;
-  type: EPointType;
-  value: number;
-  pointFrom: {
-    type: EPointFromType;
-    id: string | null;
-    documentType: ERewardType | EMissionType;
-  };
-  expiryAt: Date;
-  createdAt: Date;
-};
-
-export type TPointGetTotalPointsResponse = {
-  totalPoints: number;
-};
-
-export type TPointClaimPointBody = {
-  missionType: EMissionType;
-  entitlement: ESubscriptionEntitlement;
-};

package/reward.ts

@@ -1,56 +0,0 @@
-import { ERewardType } from "./enum";
-
-export type TReward = {
-  _id: string;
-  userId: string;
-  type: ERewardType;
-  value: number;
-  expiryAt: Date;
-  isRedeemed: boolean;
-  phoneNumber: null | string;
-  emailAddress: null | string;
-};
-
-export type TRewardStoreItem = {
-  name: string;
-  description: string;
-  type: ERewardType;
-  price: number;
-  refreshAt: string;
-  inventoryLeft: number;
-};
-
-export type TRewardGetRewardsQuery = {
-  isValid: string;
-  page: string;
-  limit: string;
-};
-
-export type TRewardGetRewardsResponse = {
-  rewards: TReward[];
-  pagination: {
-    last_visible_page: number;
-    has_next_page: boolean;
-  };
-};
-
-export type TRewardSubmitRedeemFormBody = {
-  rewardId: string;
-  phoneNumber: string;
-};
-
-export type TRewardClaimRewardPointBody = {
-  rewardId: string;
-};
-
-export type TRewardGetRewardStoreItemsResponse = {
-  rewardStoreItems: TRewardStoreItem[];
-};
-
-export type TRewardRedeemStoreItemBody = {
-  rewardType: ERewardType;
-};
-
-export type TRewardRedeemStoreItemResponse = {
-  value: string;
-};

package/topup.ts

@@ -1,19 +0,0 @@
-export type TTopUpCreateBillBody = {
-  userId: string;
-  productId: string;
-  description: string;
-  name: string;
-  email: string;
-  amount:string;
-}
-
-export type TTopUpCreateReferenceBody = {
-  userId: string;
-  productId: string;
-  referenceNo: string;
-};
-
-export type TTopUpEditReferenceBody = {
-  iPayEightyEightResponse: Object;
-  iPayEightyEightBackend: Object;
-};

package/transaction.ts

@@ -1,104 +0,0 @@
-import { EGetTransactionsBySort, EGetTransactionsByType } from "./enum";
-import { TTransactionCategory } from "./transactionCategory";
-import { TTransactionLabel } from "./transactionLabel";
-
-export type TTransaction = {
-  _id: string;
-  userId: string;
-  transactionCategoryId: string;
-  transactionLabelIds: string[];
-  transactionCategory: TTransactionCategory;
-  transactionLabels: TTransactionLabel[] | null;
-  currency: string;
-  amount: number;
-  imagePath: string | null;
-  note: string | null;
-  isDeleted: boolean;
-  transactedAt: Date;
-  updatedAt: Date;
-  createdAt: Date;
-};
-
-export type TTimelineTransaction = {
-  date: string;
-  records: TTransaction[];
-  totalIncome: number;
-  totalExpense: number;
-  totalCurrenciesIncomeAndExpenses: {
-    currency: string;
-    totalIncomes: number;
-    totalExpenses: number;
-  }[];
-};
-
-export type TTransactionGetTransactionsQuery = {
-  startTransactedAt: string;
-  endTransactedAt: string;
-};
-
-export type TTransactionGetTransactionsResponse = {
-  user: {
-    transactions: TTransaction[];
-    transactionCategories: TTransactionCategory[];
-    transactionLabels: TTransactionLabel[];
-    timelineTransactions: TTimelineTransaction[];
-  };
-  sharedUser: {
-    transactions: TTransaction[];
-    transactionCategories: TTransactionCategory[];
-    transactionLabels: TTransactionLabel[];
-    timelineTransactions: TTimelineTransaction[];
-  };
-  total: {
-    transactions: TTransaction[];
-    transactionCategories: TTransactionCategory[];
-    transactionLabels: TTransactionLabel[];
-    timelineTransactions: TTimelineTransaction[];
-  };
-};
-
-export type TTransactionCreateTransactionBody = {
-  transactionCategoryId: string;
-  transactionLabelIds: string[];
-  currency: string;
-  amount: number;
-  imagePath: string | null;
-  note: string | null;
-  transactedAt: Date;
-};
-
-export type TTransactionEditTransactionBody = {
-  _id: string;
-  transactionCategoryId: string;
-  transactionLabelIds: string[];
-  currency: string;
-  amount: number;
-  imagePath: string | null;
-  note: string | null;
-  transactedAt: Date;
-};
-
-export type TTransactionDeleteTransactionBody = {
-  _id: string;
-};
-
-export type TTransactionGetTransactionsByIdQuery = {
-  sort: EGetTransactionsBySort;
-  targetUserId: string;
-  _id: string;
-  type: EGetTransactionsByType;
-  page: string;
-  limit: string;
-  startTransactedAt: string | null;
-  endTransactedAt: string | null;
-};
-
-export type TTransactionGetTransactionsByIdResponse = {
-  transactions: TTransaction[];
-  totalAmount: number;
-  totalTransactionsLength: number;
-  pagination: {
-    last_visible_page: number;
-    has_next_page: boolean;
-  };
-};

package/transactionCategory.ts

@@ -1,45 +0,0 @@
-import { ETransactionCategoryType } from "./enum";
-
-export type TTransactionCategory = {
-  _id: string;
-  name: string;
-  type: ETransactionCategoryType;
-  backgroundColor: string;
-  imagePath: string;
-  userId: string;
-  isDeleted: boolean;
-  updatedAt: Date;
-  createdAt: Date;
-};
-
-export type TTransactionCategoryGetTransactionCategoryResponse = {
-  categories: TTransactionCategory[];
-};
-
-export type TTransactionCategoryCreateTransactionCategoryBody = {
-  name: string;
-  type: ETransactionCategoryType;
-  backgroundColor: string;
-  imagePath: string;
-};
-
-export type TTransactionCategoryCreateTransactionCategoryResponse = {
-  _id: string;
-};
-
-export type TTransactionCategoryEditTransactionCategoryBody = {
-  _id: string;
-  name: string;
-  type: ETransactionCategoryType;
-  backgroundColor: string;
-  imagePath: string;
-};
-
-export type TTransactionCategoryDeleteTransactionCategoryBody = {
-  _id: string;
-};
-
-export type TTransactionCategoryGetTransactionCategoryAssetResponse = {
-  icons: string[];
-  backgroundColors: string[];
-};

package/transactionLabel.ts

@@ -1,29 +0,0 @@
-export type TTransactionLabel = {
-  _id: string;
-  name: string;
-  userId: string;
-  isDeleted: boolean;
-  updatedAt: Date;
-  createdAt: Date;
-};
-
-export type TTransactionLabelGetTransactionLabelResponse = {
-  labels: TTransactionLabel[];
-};
-
-export type TTransactionLabelCreateTransactionLabelBody = {
-  name: string;
-};
-
-export type TTransactionLabelCreateTransactionLabelResponse = {
-  _id: string;
-};
-
-export type TTransactionLabelEditTransactionLabelBody = {
-  _id: string;
-  name: string;
-};
-
-export type TTransactionLabelDeleteTransactionLabelBody = {
-  _id: string;
-};

package/user.ts

@@ -1,79 +0,0 @@
-import {
-  ESubscriptionEntitlement,
-  EVerificationOneTimePasswordType,
-} from "./enum";
-
-export type TUser = {
-  _id: string;
-  phoneNumber: string;
-  profileImage: string;
-  displayName: string;
-  language: string;
-  currency: string;
-  sharedUserId: string | null;
-  sharedUserInfo: TSharedUserInfo;
-  lastActiveAt: Date;
-  premiumMemberTrialEndAt: Date | null;
-  topUpMemberRole: ESubscriptionEntitlement | null;
-  topUpMemberEndAt: Date | null;
-  createdAt: Date;
-  notificationToken: string | null;
-};
-
-export type TMemberFeature = {
-  name: ESubscriptionEntitlement;
-  maximumCategories: number;
-  maximumLabels: number;
-  claimPointMultiplier: number;
-  isAblePhotoAI: boolean;
-};
-
-export const memberFeatureFree: TMemberFeature = {
-  name: ESubscriptionEntitlement.starter,
-  maximumCategories: 5,
-  maximumLabels: 10,
-  claimPointMultiplier: 1,
-  isAblePhotoAI: false,
-};
-
-export const memberFeaturePlus: TMemberFeature = {
-  name: ESubscriptionEntitlement.plus,
-  maximumCategories: 50,
-  maximumLabels: 100,
-  claimPointMultiplier: 2,
-  isAblePhotoAI: false,
-};
-
-export const memberFeaturePremium: TMemberFeature = {
-  name: ESubscriptionEntitlement.premium,
-  maximumCategories: 100,
-  maximumLabels: 200,
-  claimPointMultiplier: 4,
-  isAblePhotoAI: true,
-};
-
-export type TSharedUserInfo = {
-  _id: string;
-  id: string;
-  profileImage: string;
-  emailAddress: string | null;
-  phoneNumber: string | null;
-  displayName: string;
-  notificationToken: string | null;
-} | null;
-
-export type TUserDetailResponse = TUser;
-
-export type TUserRemoveSharedUserBody = {
-  sharedUserId: string;
-};
-
-export type TUserRequestOTPBody = {
-  phoneNumber: string;
-};
-
-export type TUserRequestOTPResponse = {
-  verificationOneTimePasswordType: EVerificationOneTimePasswordType;
-};
-
-export type TUserUpdateBody = Partial<TUser>;

package/verification.ts

@@ -1,35 +0,0 @@
-import { EVerificationOneTimePasswordType } from "./enum";
-import { TJwtToken } from "./middleware";
-
-export type TVerification = {
-  _id: string;
-  userId: string;
-  type: EVerificationOneTimePasswordType;
-  oneTimePassword: string;
-  phoneNumber: string | null;
-  expiryAt: Date;
-  isVerify: boolean;
-  verifiedAt: Date | null;
-  createdAt: Date;
-};
-
-export type TVerificationVerifyBody = {
-  phoneNumber: string;
-  oneTimePassword: string;
-  oneTimePasswordType: EVerificationOneTimePasswordType;
-};
-
-export type TVerificationVerifyResponse = TJwtToken;
-
-export type TVerificationGetShareIdResponse = {
-  oneTimePassword: string;
-  expiryAt: Date;
-};
-
-export type TVerifyShareIdBody = {
-  oneTimePassword: string;
-};
-
-export type TVerifyShareIdReponse = {
-  sharedUserId: string;
-};