sowhat-types 1.0.0 → 2.0.0

package/index.d.ts

@@ -0,0 +1,253 @@
+declare enum AuthenticationMethodEnum {
+    PHONE = "PHONE",
+    EMAIL = "EMAIL"
+}
+
+declare enum MobilityTypeEnum {
+    CAR = "CAR",
+    MOTORCYCLE = "MOTORCYCLE",
+    BICYCLE = "BICYCLE",
+    OTHER = "OTHER"
+}
+
+declare enum BankAccountSchemeNameEnum {
+    IBAN = "IBAN",
+    BBAN = "BBAN",
+    SORT_CODE_ACCOUNT_NUMBER = "SORT_CODE_ACCOUNT_NUMBER",
+    CPAN = "CPAN",
+    TPAN = "TPAN"
+}
+
+declare enum BankAccountTransactionTypeEnum {
+    TRANSFER = "TRANSFER",// Transfer
+    ORDER = "ORDER",// Order
+    CHECK = "CHECK",// Check
+    DEPOSIT = "DEPOSIT",// Mandatory/voluntary deposits, contributions, money transfers
+    PAYBACK = "PAYBACK",// Payback
+    WITHDRAWAL = "WITHDRAWAL",// Withdrawal
+    LOAN_REPAYMENT = "LOAN_REPAYMENT",// Loan payment
+    BANK = "BANK",// Bank fees
+    CARD = "CARD",// Card operation
+    DEFERRED_CARD = "DEFERRED_CARD",// Deferred card operation
+    SUMMARY_CARD = "SUMMARY_CARD",// Monthly debit of a deferred card
+    UNKNOWN = "UNKNOWN",//Unknown transaction type
+    MARKET_ORDER = "MARKET_ORDER",// Market order
+    MARKET_FEE = "MARKET_FEE",// Fees regarding a market order
+    ARBITRAGE = "ARBITRAGE",// Arbitrage
+    PROFIT = "PROFIT"
+}
+
+declare enum BankAccountTypeEnum {
+    CHECKING = "CHECKING",
+    SAVINGS = "SAVINGS",
+    OTHER = "OTHER"
+}
+
+interface CreateAssetCoOwnerInput {
+    id: string;
+    coOwnershipShare: number;
+    coOwnerFinancialShare: number;
+}
+
+interface CreateAssetDateOfAcquisitionInput {
+    month: number;
+    year: number;
+}
+
+interface FetchUserBankAccountsInput {
+    userId: string;
+    accountId: number;
+}
+
+interface CreateMobilityInput {
+    userId: string;
+    customTitle: string;
+    customImage: string | null;
+    price: number;
+    licenceNumber: string | null;
+    dateOfAcquisition: CreateAssetDateOfAcquisitionInput | null;
+    mobilityType: MobilityTypeEnum;
+    mileage: number | null;
+    note: string | null;
+    gotLoan: boolean;
+    coOwner: CreateAssetCoOwnerInput | null;
+}
+
+interface CreateRealEstateInput {
+    userId: string;
+    gotLoan: boolean;
+    customTitle: string;
+    customImage: string | null;
+    price: number;
+    note: string | null;
+    isMainResidence: boolean;
+    coOwner: CreateAssetCoOwnerInput | null;
+}
+
+interface BankAccountBalancesResponse {
+    /**
+     * total balance for checking type accounts
+     */
+    checking: number | null;
+    /**
+     * total incoming balance for checking type accounts
+     */
+    incomingChecking: number | null;
+    /**
+     * total balance for savings type accounts
+     */
+    savings: number | null;
+    /**
+     * total incoming balance for savings type accounts
+     */
+    incomingSavings: number | null;
+    /**
+     * e.g. '€'
+     */
+    currency: string;
+}
+
+interface BankAccountOriginalTransactionResponse {
+    value: number;
+    currency: string;
+    commission: number | null;
+    commissionCurrency: string | null;
+}
+
+interface BankAccountTransactionCounterpartyResponse {
+    label: string | null;
+    accountScheme: BankAccountSchemeNameEnum | null;
+    type: string | null;
+}
+
+interface BankAccountTransactionExtraDataResponse {
+    datetime: Date | null;
+    counterparty: BankAccountTransactionCounterpartyResponse | null;
+    country: string | null;
+}
+
+interface BankAccountTransactionWordingResponse {
+    original: string;
+    stemmed: string;
+    simplified: string;
+    /**
+     * The one that can be edited by the user and update in the transaction by Powens API
+     */
+    custom: string | null;
+}
+
+interface BankAccountTransactionResponse {
+    id: string;
+    accountId: string;
+    date: Date;
+    value: number | null;
+    currency: string | null;
+    wording: BankAccountTransactionWordingResponse;
+    coming: boolean;
+    active: boolean;
+    comment: string | null;
+    lastUpdate: Date | null;
+    deleted: Date | null;
+    cardNumber: string | null;
+    type: BankAccountTransactionTypeEnum;
+    new: boolean;
+    originalTransaction: BankAccountOriginalTransactionResponse | null;
+    extraData: BankAccountTransactionExtraDataResponse;
+}
+
+interface BankAccountTransactionsResponse {
+    transactions: BankAccountTransactionResponse[];
+}
+
+interface BankAccountResponse {
+    id: number;
+    balance: number | null;
+    name: string;
+    originalName: string;
+    currency: string;
+    type: BankAccountTypeEnum;
+    gotLoan: boolean;
+    iban: string | null;
+}
+
+interface BankAccountsResponse {
+    accounts: BankAccountResponse[];
+    balances: BankAccountBalancesResponse | null;
+}
+
+interface CryptocurrencyResponse {
+    id: string;
+}
+
+interface MobilityDeletedResponse {
+    deleted: boolean;
+    errorMessage: string | null;
+}
+
+interface AssetCoOwnerResponse {
+    id: string;
+    customName: string;
+    coOwnershipShare: number;
+    coOwnerFinancialShare: number;
+}
+
+interface AssetDateOfAcquisitionResponse {
+    month: number;
+    year: number;
+}
+
+interface MobilityResponse {
+    id: string;
+    userId: string;
+    customImage: string | null;
+    customTitle: string;
+    price: number;
+    licenceNumber: string | null;
+    dateOfAcquisition: AssetDateOfAcquisitionResponse | null;
+    mobilityType: MobilityTypeEnum;
+    mileage: number | null;
+    note: string | null;
+    gotLoan: boolean;
+    coOwner: AssetCoOwnerResponse | null;
+    createdAt: Date;
+    updatedAt: Date;
+}
+
+interface OtherAssetResponse {
+    id: string;
+}
+
+interface RealEstateDeletedResponse {
+    deleted: boolean;
+    errorMessage: string | null;
+}
+
+interface RealEstateResponse {
+    id: string;
+    userId: string;
+    gotLoan: boolean;
+    customTitle: string;
+    customImage: string | null;
+    price: number;
+    note: string | null;
+    isMainResidence: boolean;
+    coOwner: AssetCoOwnerResponse | null;
+    createdAt: Date;
+    updatedAt: Date;
+}
+
+interface StockExchangeResponse {
+    id: string;
+}
+
+interface AssetsResponse {
+    realEstateAssets: RealEstateResponse[];
+    mobilityAssets: MobilityResponse[];
+    cryptocurrencyAssets: CryptocurrencyResponse[];
+    stockExchangeAssets: StockExchangeResponse[];
+    otherAssets: OtherAssetResponse[];
+}
+
+type ExactMatch<T, U extends T> = T & Record<keyof T, keyof U>;
+
+export { type AssetCoOwnerResponse, type AssetDateOfAcquisitionResponse, type AssetsResponse, AuthenticationMethodEnum, type BankAccountBalancesResponse, type BankAccountOriginalTransactionResponse, type BankAccountResponse, BankAccountSchemeNameEnum, type BankAccountTransactionCounterpartyResponse, type BankAccountTransactionExtraDataResponse, type BankAccountTransactionResponse, BankAccountTransactionTypeEnum, type BankAccountTransactionWordingResponse, type BankAccountTransactionsResponse, BankAccountTypeEnum, type BankAccountsResponse, type CreateAssetCoOwnerInput, type CreateAssetDateOfAcquisitionInput, type CreateMobilityInput, type CreateRealEstateInput, type CryptocurrencyResponse, type ExactMatch, type FetchUserBankAccountsInput, type MobilityDeletedResponse, type MobilityResponse, MobilityTypeEnum, type OtherAssetResponse, type RealEstateDeletedResponse, type RealEstateResponse, type StockExchangeResponse };

package/index.js

@@ -0,0 +1,51 @@
+var AuthenticationMethodEnum;
+(function (AuthenticationMethodEnum) {
+    AuthenticationMethodEnum["PHONE"] = "PHONE";
+    AuthenticationMethodEnum["EMAIL"] = "EMAIL";
+})(AuthenticationMethodEnum || (AuthenticationMethodEnum = {}));
+
+var MobilityTypeEnum;
+(function (MobilityTypeEnum) {
+    MobilityTypeEnum["CAR"] = "CAR";
+    MobilityTypeEnum["MOTORCYCLE"] = "MOTORCYCLE";
+    MobilityTypeEnum["BICYCLE"] = "BICYCLE";
+    MobilityTypeEnum["OTHER"] = "OTHER";
+})(MobilityTypeEnum || (MobilityTypeEnum = {}));
+
+var BankAccountSchemeNameEnum;
+(function (BankAccountSchemeNameEnum) {
+    BankAccountSchemeNameEnum["IBAN"] = "IBAN";
+    BankAccountSchemeNameEnum["BBAN"] = "BBAN";
+    BankAccountSchemeNameEnum["SORT_CODE_ACCOUNT_NUMBER"] = "SORT_CODE_ACCOUNT_NUMBER";
+    BankAccountSchemeNameEnum["CPAN"] = "CPAN";
+    BankAccountSchemeNameEnum["TPAN"] = "TPAN";
+})(BankAccountSchemeNameEnum || (BankAccountSchemeNameEnum = {}));
+
+var BankAccountTransactionTypeEnum;
+(function (BankAccountTransactionTypeEnum) {
+    BankAccountTransactionTypeEnum["TRANSFER"] = "TRANSFER";
+    BankAccountTransactionTypeEnum["ORDER"] = "ORDER";
+    BankAccountTransactionTypeEnum["CHECK"] = "CHECK";
+    BankAccountTransactionTypeEnum["DEPOSIT"] = "DEPOSIT";
+    BankAccountTransactionTypeEnum["PAYBACK"] = "PAYBACK";
+    BankAccountTransactionTypeEnum["WITHDRAWAL"] = "WITHDRAWAL";
+    BankAccountTransactionTypeEnum["LOAN_REPAYMENT"] = "LOAN_REPAYMENT";
+    BankAccountTransactionTypeEnum["BANK"] = "BANK";
+    BankAccountTransactionTypeEnum["CARD"] = "CARD";
+    BankAccountTransactionTypeEnum["DEFERRED_CARD"] = "DEFERRED_CARD";
+    BankAccountTransactionTypeEnum["SUMMARY_CARD"] = "SUMMARY_CARD";
+    BankAccountTransactionTypeEnum["UNKNOWN"] = "UNKNOWN";
+    BankAccountTransactionTypeEnum["MARKET_ORDER"] = "MARKET_ORDER";
+    BankAccountTransactionTypeEnum["MARKET_FEE"] = "MARKET_FEE";
+    BankAccountTransactionTypeEnum["ARBITRAGE"] = "ARBITRAGE";
+    BankAccountTransactionTypeEnum["PROFIT"] = "PROFIT";
+})(BankAccountTransactionTypeEnum || (BankAccountTransactionTypeEnum = {}));
+
+var BankAccountTypeEnum;
+(function (BankAccountTypeEnum) {
+    BankAccountTypeEnum["CHECKING"] = "CHECKING";
+    BankAccountTypeEnum["SAVINGS"] = "SAVINGS";
+    BankAccountTypeEnum["OTHER"] = "OTHER";
+})(BankAccountTypeEnum || (BankAccountTypeEnum = {}));
+
+export { AuthenticationMethodEnum, BankAccountSchemeNameEnum, BankAccountTransactionTypeEnum, BankAccountTypeEnum, MobilityTypeEnum };

package/index.ts

@@ -1,2 +1,4 @@
-export * from "./user/user";
-export * from "./asset/create-asset-co-owner";
+export * from './enums/index';
+export * from './inputs/index';
+export * from './responses/index';
+export * from './exact-match';

package/package.json

@@ -1,11 +1,25 @@
 {
   "name": "sowhat-types",
-  "version": "1.0.0",
+  "version": "2.0.0",
+  "type": "module",
   "description": "sowhat types",
   "main": "index.ts",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "publish-on-npm": "npm run prepublish:only && npm publish",
+    "prepublish:only": "tsc && rollup -c"
   },
   "author": "hugobayoud",
-  "license": "ISC"
+  "license": "ISC",
+  "devDependencies": {
+    "rollup": "^4.19.1",
+    "typescript": "^5.5.4"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ],
+  "dependencies": {
+    "rollup-plugin-dts": "^6.1.1"
+  }
 }

package/asset/create-asset-co-owner.ts

@@ -1,5 +0,0 @@
-export class CreateAssetCoOwner {
-  id: string;
-  coOwnershipShare: number;
-  coOwnerFinancialShare: number;
-}

package/user/user.ts

@@ -1,10 +0,0 @@
-export interface User {
-  id: string;
-  clerkId: string;
-  firstname: string;
-  lastname: string | null;
-  email: string | null;
-  // status: UserStatusEnum;
-  createdAt: Date;
-  updatedAt: Date;
-}