feeef 0.5.38-dev.3 → 0.5.38-dev.4

package/build/src/core/entities/currency.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Currency Entity
+ *
+ * Represents a currency with ISO 4217 code.
+ */
+export interface CurrencyEntity {
+    /** ISO 4217 currency code (e.g., USD, EUR, SAR) */
+    code: string;
+    /** Currency name (e.g., US Dollar, Euro, Saudi Riyal) */
+    name: string;
+    /** Currency symbol (e.g., $, €, ﷼) */
+    symbol?: string;
+    /** Number of decimal places */
+    decimals: number;
+    /** Exchange rate relative to base currency */
+    rate: number;
+    /** Additional metadata as key-value pairs */
+    metadata?: Record<string, any>;
+    /** Creation timestamp */
+    createdAt: any;
+}

package/build/src/core/entities/user.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Represents a user entity in the system.
+ */
 export interface UserEntity {
     id: string;
     name: string | null;
@@ -14,10 +17,16 @@ export interface UserEntity {
     metadata: Record<string, any>;
     wallet: EmbaddedWallet;
 }
+/**
+ * Represents an embedded wallet in a user entity.
+ */
 export interface EmbaddedWallet {
     currency: 'DZD' | 'USD' | 'EUR';
     balance: number;
 }
+/**
+ * Represents an authentication token.
+ */
 export interface AuthToken {
     type: string;
     name: string | null;
@@ -26,3 +35,149 @@ export interface AuthToken {
     lastUsedAt: any;
     expiresAt: any;
 }
+/**
+ * Options for creating a user (admin panel)
+ */
+export interface CreateUserOptions {
+    name: string;
+    email: string;
+    phone?: string;
+    password: string;
+    photoUrl?: string;
+    metadata?: Record<string, any>;
+    emailVerifiedAt?: string | Date;
+    phoneVerifiedAt?: string | Date;
+    verifiedAt?: string | Date;
+    blockedAt?: string | Date;
+    createdByAdmin?: boolean;
+    initialBalance?: number;
+}
+/**
+ * Options for updating a user
+ */
+export interface UpdateUserOptions {
+    name?: string;
+    email?: string;
+    phone?: string;
+    password?: string;
+    password_confirmation?: string;
+    photoUrl?: string;
+    metadata?: Record<string, any>;
+    emailVerifiedAt?: string | Date;
+    phoneVerifiedAt?: string | Date;
+    verifiedAt?: string | Date;
+    blockedAt?: string | Date;
+}
+/**
+ * Represents an access token (returned from tokens endpoint).
+ */
+export interface AccessToken {
+    id: string;
+    type: string;
+    name: string | null;
+    token: string;
+    abilities: string[];
+    lastUsedAt: any | null;
+    expiresAt: any | null;
+    createdAt: any;
+}
+/**
+ * Credentials for signing in.
+ */
+export interface SigninCredentials {
+    email: string;
+    password: string;
+    fcmToken?: string | null;
+}
+/**
+ * Credentials for signing up.
+ */
+export interface SignupCredentials {
+    referral?: string | null;
+    name: string;
+    email: string;
+    phone?: string;
+    password: string;
+    photoUrl?: string;
+    fcmToken?: string | null;
+}
+/**
+ * Options for updating user profile.
+ */
+export interface UserUpdate {
+    name?: string;
+    email?: string;
+    phone?: string;
+    photoUrl?: string;
+    oldPassword?: string;
+    newPassword?: string;
+}
+/**
+ * Options for transferring money between users.
+ */
+export interface TransferMoneyOptions {
+    recipientId?: string;
+    recipientEmail?: string;
+    recipientPhone?: string;
+    amount: number;
+    note?: string;
+}
+/**
+ * Response from a money transfer operation.
+ */
+export interface TransferMoneyResponse {
+    success: boolean;
+    sender: UserEntity;
+    recipient: UserEntity;
+    amount: number;
+    currency: string;
+}
+/**
+ * Options for linking a social account.
+ */
+export interface LinkSocialAccountOptions {
+    provider: 'google' | 'github' | 'apple';
+    code: string;
+}
+/**
+ * Options for signing in with a social provider.
+ */
+export interface SigninWithSocialOptions {
+    code: string;
+    fcmToken?: string | null;
+}
+/**
+ * Options for passkey registration start.
+ */
+export interface StartPasskeyRegistrationOptions {
+    deviceName?: string;
+}
+/**
+ * Options for finishing passkey registration.
+ */
+export interface FinishPasskeyRegistrationOptions {
+    registrationResponse: Record<string, any>;
+    deviceName?: string;
+}
+/**
+ * Options for starting passkey authentication.
+ */
+export interface StartPasskeyAuthenticationOptions {
+    email?: string;
+}
+/**
+ * Options for finishing passkey authentication.
+ */
+export interface FinishPasskeyAuthenticationOptions {
+    authenticationResponse: Record<string, any>;
+}
+/**
+ * Represents a passkey entry.
+ */
+export interface Passkey {
+    id: string;
+    name: string;
+    deviceName?: string;
+    createdAt: any;
+    lastUsedAt: any | null;
+}

package/build/src/feeef/feeef.d.ts

@@ -4,10 +4,12 @@ import { ProductRepository } from './repositories/products.js';
 import { StoreRepository } from './repositories/stores.js';
 import { UserRepository } from './repositories/users.js';
 import { DepositRepository } from './repositories/deposits.js';
+import { TransferRepository } from './repositories/transfers.js';
 import { CategoryRepository } from './repositories/categories.js';
 import { CountryRepository } from './repositories/countries.js';
 import { StateRepository } from './repositories/states.js';
 import { CityRepository } from './repositories/cities.js';
+import { CurrencyRepository } from './repositories/currencies.js';
 import { ShippingPriceRepository } from './repositories/shipping_prices.js';
 import { CartService } from './services/cart.js';
 import { ActionsService } from './services/actions.js';
@@ -67,6 +69,10 @@ export declare class FeeeF {
      * The repository for managing deposits.
      */
     deposits: DepositRepository;
+    /**
+     * The repository for managing transfers.
+     */
+    transfers: TransferRepository;
     /**
      * The repository for managing categories.
      */
@@ -83,6 +89,10 @@ export declare class FeeeF {
      * The repository for managing cities.
      */
     cities: CityRepository;
+    /**
+     * The repository for managing currencies.
+     */
+    currencies: CurrencyRepository;
     /**
      * The repository for managing shipping prices.
      */

package/build/src/feeef/repositories/currencies.d.ts

@@ -0,0 +1,20 @@
+import { AxiosInstance } from 'axios';
+import { ModelRepository } from './repository.js';
+import { CurrencyEntity } from '../../core/entities/currency.js';
+/**
+ * Repository for managing Currency entities.
+ */
+export declare class CurrencyRepository extends ModelRepository<CurrencyEntity, any, any> {
+    /**
+     * Constructs a new CurrencyRepository instance.
+     * @param client The AxiosInstance used for making HTTP requests.
+     */
+    constructor(client: AxiosInstance);
+    /**
+     * Finds a currency by its code (ID is the currency code).
+     * @param code - The currency code (ISO 4217, e.g., USD, EUR).
+     * @param params - Optional query parameters.
+     * @returns A Promise that resolves to the found Currency entity.
+     */
+    findByCode(code: string, params?: Record<string, any>): Promise<CurrencyEntity>;
+}

package/build/src/feeef/repositories/transfers.d.ts

@@ -0,0 +1,38 @@
+import { AxiosInstance } from 'axios';
+import { ModelRepository } from './repository.js';
+/**
+ * Represents a transfer entity for double-entry accounting transactions
+ */
+export interface TransferEntity {
+    id: string;
+    debitAccountId: string;
+    creditAccountId: string;
+    amount: number;
+    type: 'deposit' | 'subscription' | 'points' | 'store_due' | 'user_transfer' | 'ai_generation' | 'refund' | 'adjustment';
+    referenceId?: string | null;
+    description?: string | null;
+    metadata: Record<string, any>;
+    createdAt: any;
+}
+/**
+ * Input data for creating a new transfer
+ */
+export interface TransferCreateInput {
+    debitAccountId: string;
+    creditAccountId: string;
+    amount: number;
+    type: TransferEntity['type'];
+    referenceId?: string | null;
+    description?: string | null;
+    metadata?: Record<string, any>;
+}
+/**
+ * Repository for managing transfer data
+ */
+export declare class TransferRepository extends ModelRepository<TransferEntity, TransferCreateInput, any> {
+    /**
+     * Constructs a new TransferRepository instance
+     * @param client - The AxiosInstance used for making HTTP requests
+     */
+    constructor(client: AxiosInstance);
+}

package/build/src/feeef/repositories/users.d.ts

@@ -1,6 +1,6 @@
 import { AxiosInstance } from 'axios';
 import { ModelRepository } from './repository.js';
-import { AuthToken, UserEntity } from '../../core/entities/user.js';
+import { AccessToken, AuthToken, CreateUserOptions, FinishPasskeyAuthenticationOptions, FinishPasskeyRegistrationOptions, LinkSocialAccountOptions, Passkey, SigninCredentials, SigninWithSocialOptions, SignupCredentials, TransferMoneyOptions, TransferMoneyResponse, UpdateUserOptions, UserEntity, UserUpdate, StartPasskeyAuthenticationOptions, StartPasskeyRegistrationOptions } from '../../core/entities/user.js';
 /**
  * Represents the response returned by the authentication process.
  */
@@ -9,14 +9,23 @@ export interface AuthResponse {
     user: UserEntity;
 }
 /**
- * Represents a repository for managing user data.
- * Extends the ModelRepository class.
+ * Represents a repository for managing user data and authentication.
+ * Extends the ModelRepository class with authentication capabilities.
  */
-export declare class UserRepository extends ModelRepository<UserEntity, any, any> {
+export declare class UserRepository extends ModelRepository<UserEntity, CreateUserOptions, UpdateUserOptions> {
     /**
-     * Represents the authentication response.
+     * Represents the current authentication response.
+     * Set automatically after signin, signup, or signinWithToken.
      */
-    auth: AuthResponse | null;
+    private _auth;
+    /**
+     * Gets the current authentication response.
+     */
+    get auth(): AuthResponse | null;
+    /**
+     * Sets the authentication response and updates the Authorization header.
+     */
+    private set auth(value);
     /**
      * Constructs a new UserRepository instance.
      * @param client - The AxiosInstance used for making HTTP requests.
@@ -24,25 +33,128 @@ export declare class UserRepository extends ModelRepository<UserEntity, any, any
     constructor(client: AxiosInstance);
     /**
      * Signs in a user with the provided credentials.
-     * @param credentials - The user credentials.
+     * @param credentials - The user credentials (email, password, optional fcmToken).
      * @returns A promise that resolves to the authentication response.
      */
-    signin(credentials: any): Promise<AuthResponse>;
+    signin(credentials: SigninCredentials): Promise<AuthResponse>;
     /**
      * Signs up a new user with the provided credentials.
-     * @param credentials - The user credentials.
+     * @param credentials - The user signup credentials.
+     * @returns A promise that resolves to the authentication response.
+     */
+    signup(credentials: SignupCredentials): Promise<AuthResponse>;
+    /**
+     * Signs in a user with an existing token.
+     * Useful for restoring authentication state from localStorage.
+     * @param token - The authentication token.
+     * @param fcmToken - Optional FCM token for push notifications.
      * @returns A promise that resolves to the authentication response.
      */
-    signup(credentials: any): Promise<AuthResponse>;
+    signinWithToken(token: string, fcmToken?: string | null): Promise<AuthResponse>;
     /**
      * Signs out the currently authenticated user.
+     * Deletes the token on the server and clears local auth state.
      * @returns A promise that resolves when the user is signed out.
      */
     signout(): Promise<void>;
     /**
-     * Updates the authenticated user's data.
+     * Gets the currently authenticated user.
+     * @returns A promise that resolves to the authentication response with current user.
+     */
+    me(): Promise<AuthResponse>;
+    /**
+     * Updates the authenticated user's profile.
      * @param data - The updated user data.
      * @returns A promise that resolves to the updated user entity.
      */
-    updateMe(data: any): Promise<UserEntity>;
+    updateMe(data: UserUpdate): Promise<UserEntity>;
+    /**
+     * Sends a password reset email to the user.
+     * @param email - The user's email address.
+     * @returns A promise that resolves when the email is sent.
+     */
+    sendResetPasswordEmail(email: string): Promise<void>;
+    /**
+     * Resets the password using a token from the reset email.
+     * @param uid - The user ID.
+     * @param token - The reset token from the email.
+     * @returns A promise that resolves when the password is reset.
+     */
+    resetPasswordWithToken(uid: string, token: string): Promise<void>;
+    /**
+     * Gets all access tokens for the authenticated user.
+     * @returns A promise that resolves to an array of access tokens.
+     */
+    tokens(): Promise<AccessToken[]>;
+    /**
+     * Signs in with Google OAuth.
+     * @param options - The OAuth code and optional FCM token.
+     * @returns A promise that resolves to the authentication response.
+     */
+    signinWithGoogle(options: SigninWithSocialOptions): Promise<AuthResponse>;
+    /**
+     * Signs in with GitHub OAuth.
+     * @param options - The OAuth code and optional FCM token.
+     * @returns A promise that resolves to the authentication response.
+     */
+    signinWithGitHub(options: SigninWithSocialOptions): Promise<AuthResponse>;
+    /**
+     * Signs in with Apple OAuth.
+     * @param options - The OAuth code and optional FCM token.
+     * @returns A promise that resolves to the authentication response.
+     */
+    signinWithApple(options: SigninWithSocialOptions): Promise<AuthResponse>;
+    /**
+     * Links a social account to the current user.
+     * @param options - The provider and OAuth code.
+     * @returns A promise that resolves to the updated user entity.
+     */
+    linkSocialAccount(options: LinkSocialAccountOptions): Promise<UserEntity>;
+    /**
+     * Unlinks a social account from the current user.
+     * @param provider - The social provider to unlink.
+     * @returns A promise that resolves to the updated user entity.
+     */
+    unlinkSocialAccount(provider: 'google' | 'github' | 'apple'): Promise<UserEntity>;
+    /**
+     * Transfers money from the authenticated user to another user.
+     * @param options - Transfer options including recipient and amount.
+     * @returns A promise that resolves to the transfer response with updated users.
+     */
+    transferMoney(options: TransferMoneyOptions): Promise<TransferMoneyResponse>;
+    /**
+     * Starts passkey registration.
+     * @param options - Optional device name for the passkey.
+     * @returns A promise that resolves to the registration challenge data.
+     */
+    startPasskeyRegistration(options?: StartPasskeyRegistrationOptions): Promise<Record<string, any>>;
+    /**
+     * Finishes passkey registration.
+     * @param options - The registration response from the authenticator.
+     * @returns A promise that resolves to the authentication response.
+     */
+    finishPasskeyRegistration(options: FinishPasskeyRegistrationOptions): Promise<AuthResponse>;
+    /**
+     * Starts passkey authentication.
+     * @param options - Optional email to identify the user.
+     * @returns A promise that resolves to the authentication challenge data.
+     */
+    startPasskeyAuthentication(options?: StartPasskeyAuthenticationOptions): Promise<Record<string, any>>;
+    /**
+     * Finishes passkey authentication.
+     * @param options - The authentication response from the authenticator.
+     * @returns A promise that resolves to the authentication response.
+     */
+    finishPasskeyAuthentication(options: FinishPasskeyAuthenticationOptions): Promise<AuthResponse>;
+    /**
+     * Lists all passkeys for the authenticated user.
+     * @returns A promise that resolves to an array of passkeys.
+     */
+    listPasskeys(): Promise<Passkey[]>;
+    /**
+     * Deletes a passkey.
+     * @param passkeyId - The ID of the passkey to delete.
+     * @returns A promise that resolves when the passkey is deleted.
+     */
+    deletePasskey(passkeyId: string): Promise<void>;
 }

package/build/src/index.d.ts

@@ -9,8 +9,13 @@ export * from './core/entities/category.js';
 export * from './core/entities/country.js';
 export * from './core/entities/state.js';
 export * from './core/entities/city.js';
+export * from './core/entities/currency.js';
 export * from './feeef/repositories/deposits.js';
+export * from './feeef/repositories/transfers.js';
 export * from './feeef/repositories/shipping_prices.js';
+export * from './feeef/repositories/users.js';
+export type { TransferEntity, TransferCreateInput } from './feeef/repositories/transfers.js';
+export type { DepositEntity, DepositCreateInput } from './feeef/repositories/deposits.js';
 export * from './core/embadded/address.js';
 export * from './core/embadded/category.js';
 export * from './core/embadded/contact.js';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "feeef",
   "description": "feeef sdk for javascript",
-  "version": "0.5.38-dev.3",
+  "version": "0.5.38-dev.4",
   "main": "build/index.js",
   "type": "module",
   "files": [