feeef 0.0.27 → 0.1.0

package/src/core/entities/store.ts

@@ -1,155 +0,0 @@
-import { EmbaddedAddress } from "../embadded/address.js";
-import { EmbaddedCategory } from "../embadded/category.js";
-import { EmbaddedContact } from "../embadded/contact.js";
-// import { OrderEntity } from "./order.js";
-// import { ShippingMethodEntity } from "./shipping_method.js";
-import { UserEntity } from "./user.js";
-import { DateTime } from "luxon";
-
-export interface StoreEntity {
-  id: string;
-  slug: string;
-  banner: StoreBanner | null;
-  action: StoreAction | null;
-  domain: StoreDomain | null;
-  decoration: StoreDecoration | null;
-  name: string;
-  logoUrl: string | null;
-  ondarkLogoUrl: string | null;
-  userId: string;
-  categories: EmbaddedCategory[];
-  title: string | null;
-  description: string | null;
-  addresses: EmbaddedAddress[];
-  metadata: Record<string, any>;
-  contacts: EmbaddedContact[];
-  integrations: StoreIntegrations;
-  verifiedAt: any | null;
-  blockedAt: any | null;
-  createdAt: any;
-  updatedAt: any;
-  // products: ProductEntity[];
-  user?: UserEntity;
-  // orders: OrderEntity[];
-  // shippingMethods: ShippingMethodEntity[];
-  defaultShippingRates: (number | null)[][] | null;
-
-  // subscription
-  subscription?: any;
-  due?: number;
-
-  // StoreConfigs
-  configs?: StoreConfigs;
-
-  // metaPixelIds
-  metaPixelIds?: string[];
-}
-
-export interface StoreConfigs {
-  currencies: StoreCurrencyConfig[];
-  defaultCurrency: number;
-}
-
-export interface StoreCurrencyConfig {
-  code: string;
-  symbol: string;
-  precision: number;
-  rate: number;
-}
-
-export interface StoreDomain {
-  name: string;
-  verifiedAt: any | null;
-  metadata: Record<string, any>;
-}
-export interface StoreBanner {
-  title: string;
-  url?: string | null;
-  enabled: boolean;
-  metadata: Record<string, any>;
-}
-
-export interface StoreDecoration {
-  primary: number;
-  onPrimary?: number;
-  showStoreLogoInHeader?: boolean;
-  logoFullHeight?: boolean;
-  showStoreNameInHeader?: boolean;
-  metadata?: Record<string, any>;
-}
-
-export interface StoreAction {
-  label: string;
-  url: string;
-  type: StoreActionType;
-}
-
-export enum StoreActionType {
-  link = "link",
-  whatsapp = "whatsapp",
-  telegram = "telegram",
-  phone = "phone",
-}
-export interface MetaPixel {
-  id: string;
-  key?: string;
-}
-export interface MetaPixelIntegration {
-  id: string;
-  pixels: MetaPixel[];
-  active: boolean;
-  metadata: Record<string, any>;
-}
-
-export interface StoreIntegrations {
-  [key: string]: any;
-  metadata?: Record<string, any>;
-
-  // @Default('default') String id,
-  // @Default([]) List<MetaPixel> pixels,
-  // @Default(true) bool active,
-  // @Default({}) Map<String, dynamic> metadata,
-  metaPixel?: MetaPixelIntegration;
-  googleAnalytics?: any;
-  googleSheet?: any;
-  sms?: any;
-  telegram?: any;
-  yalidine?: any;
-  maystroDelivery?: any;
-  echotrak?: any;
-  procolis?: any;
-  noest?: any;
-}
-
-export enum StoreSubscriptionStatus {
-  active = "active",
-  inactive = "inactive",
-}
-
-export enum StoreSubscriptionType {
-  free = "free",
-  quota = "quota",
-  percentage = "percentage",
-}
-
-export interface StoreSubscription {
-  type: StoreSubscriptionType;
-  status: StoreSubscriptionStatus;
-  startedAt: DateTime;
-  expiresAt: DateTime | null;
-  metadata: Record<string, any>;
-}
-
-export interface StoreFreeSubscription extends StoreSubscription {
-  type: StoreSubscriptionType.free;
-}
-
-export interface StoreQuotaSubscription extends StoreSubscription {
-  type: StoreSubscriptionType.quota;
-  quota: number;
-}
-// another way is by taking percentage of the sales
-export interface StorePercentageSubscription extends StoreSubscription {
-  type: StoreSubscriptionType.percentage;
-  percentage: number;
-}

package/src/core/entities/user.ts

@@ -1,30 +0,0 @@
-export interface UserEntity {
-  id: string
-  name: string | null
-  email: string
-  phone: string
-  password: string
-  photoUrl: string | null
-  emailVerifiedAt: any | null
-  phoneVerifiedAt: any | null
-  verifiedAt: any | null
-  blockedAt: any | null
-  createdAt: any
-  updatedAt: any | null
-  metadata: Record<string, any>
-  wallet: EmbaddedWallet
-}
-
-export interface EmbaddedWallet {
-  currency: 'DZD' | 'USD' | 'EUR'
-  balance: number
-}
-
-export interface AuthToken {
-  type: string
-  name: string | null
-  token: string
-  abilities: string[]
-  lastUsedAt: any
-  expiresAt: any
-}

package/src/feeef/feeef.ts

@@ -1,110 +0,0 @@
-import axios, { AxiosInstance } from "axios";
-import {
-  buildMemoryStorage,
-  buildWebStorage,
-  setupCache,
-} from "axios-cache-interceptor";
-import { OrderRepository } from "./repositories/orders";
-import { ProductRepository } from "./repositories/products";
-import { StoreRepository } from "./repositories/stores";
-import { UserRepository } from "./repositories/users";
-
-/**
- * Configuration options for the FeeeF module.
- */
-export interface FeeeFConfig {
-  /**
-   * The API key to be used for authentication.
-   */
-  apiKey: string;
-
-  /**
-   * An optional Axios instance to be used for making HTTP requests.
-   */
-  client?: AxiosInstance;
-
-  /**
-   * Specifies whether caching should be enabled or disabled.
-   * If set to a number, it represents the maximum number of seconds to cache the responses.
-   * If set to `false`, caching will be disabled (5s).
-   * cannot be less than 5 seconds
-   */
-  cache?: false | number;
-
-  /**
-   * The base URL for the API.
-   */
-  baseURL?: string;
-}
-
-/**
- * Represents the FeeeF class.
- */
-export class FeeeF {
-  /**
-   * The API key used for authentication.
-   */
-  apiKey: string;
-
-  /**
-   * The Axios instance used for making HTTP requests.
-   */
-  client: AxiosInstance;
-
-  /**
-   * The repository for managing stores.
-   */
-  stores: StoreRepository;
-
-  /**
-   * The repository for managing products.
-   */
-  products: ProductRepository;
-
-  /**
-   * The repository for managing users.
-   */
-  users: UserRepository;
-
-  /**
-   * The repository for managing orders.
-   */
-  orders: OrderRepository;
-
-  /**
-   * Constructs a new instance of the FeeeF class.
-   * @param {FeeeFConfig} config - The configuration object.
-   * @param {string} config.apiKey - The API key used for authentication.
-   * @param {AxiosInstance} config.client - The Axios instance used for making HTTP requests.
-   * @param {boolean | number} config.cache - The caching configuration. Set to `false` to disable caching, or provide a number to set the cache TTL in milliseconds.
-   */
-  constructor({
-    apiKey,
-    client,
-    cache,
-    baseURL = "http://localhost:3333/api/v1",
-  }: FeeeFConfig) {
-    this.apiKey = apiKey;
-    // get th "cache" search param
-    // if is 0 or false, disable cache
-    if (cache === false) {
-      this.client = client || axios;
-    } else {
-      const isInBrowser =
-        typeof window !== "undefined" && typeof localStorage !== "undefined";
-      this.client = setupCache(client || axios, {
-        ttl: cache === undefined ? 1000 * 60 * 5 : Math.max(cache!, 1000), //|| 1 * 60 * 1000, // 1 minute by default
-        // for persistent cache use buildWebStorage
-        storage: isInBrowser
-          ? buildWebStorage(localStorage, "ff:")
-          : buildMemoryStorage(),
-      });
-    }
-    // set base url
-    this.client.defaults.baseURL = baseURL;
-    this.stores = new StoreRepository(this.client);
-    this.products = new ProductRepository(this.client);
-    this.users = new UserRepository(this.client);
-    this.orders = new OrderRepository(this.client);
-  }
-}

package/src/feeef/repositories/orders.ts

@@ -1,37 +0,0 @@
-import vine from "@vinejs/vine";
-import { InferInput } from "@vinejs/vine/types";
-import { AxiosInstance } from "axios";
-import { OrderEntity } from "../../core/core";
-import { CreateOrderSchema, SendOrderSchema } from "../validators/order";
-import { ModelRepository } from "./repository";
-
-/**
- * Represents a repository for managing orders.
- */
-export class OrderRepository extends ModelRepository<
-  OrderEntity,
-  InferInput<typeof CreateOrderSchema>,
-  InferInput<typeof CreateOrderSchema>
-> {
-  /**
-   * Constructs a new OrderRepository instance.
-   * @param client - The AxiosInstance used for making HTTP requests.
-   */
-  constructor(client: AxiosInstance) {
-    super("orders", client);
-  }
-
-  /**
-   * Sends an order from an anonymous user.
-   * @param data - The data representing the order to be sent.
-   * @returns A Promise that resolves to the sent OrderEntity.
-   */
-  async send(data: InferInput<typeof SendOrderSchema>): Promise<OrderEntity> {
-    const validator = vine.compile(SendOrderSchema);
-    const output = await validator.validate(data);
-    const res = await this.client.post(`/${this.resource}/send`, output);
-
-    // Return the sent OrderEntity
-    return res.data;
-  }
-}

package/src/feeef/repositories/products.ts

@@ -1,25 +0,0 @@
-import { InferInput } from "@vinejs/vine/types";
-import { AxiosInstance } from "axios";
-import { ProductEntity } from "../../core/core";
-import {
-  CreateProductSchema,
-  UpdateProductSchema,
-} from "../validators/product";
-import { ModelRepository } from "./repository";
-
-/**
- * Represents a repository for managing products.
- */
-export class ProductRepository extends ModelRepository<
-  ProductEntity,
-  InferInput<typeof CreateProductSchema>,
-  InferInput<typeof UpdateProductSchema>
-> {
-  /**
-   * Creates a new instance of the ProductRepository class.
-   * @param client - The AxiosInstance used for making HTTP requests.
-   */
-  constructor(client: AxiosInstance) {
-    super("products", client);
-  }
-}

package/src/feeef/repositories/repository.ts

@@ -1,175 +0,0 @@
-import { AxiosInstance } from "axios";
-
-/**
- * Represents a generic model repository.
- * @template T - The type of the model.
- * @template C - The type of the create options.
- * @template U - The type of the update options.
- */
-export abstract class ModelRepository<T, C, U> {
-  resource: string;
-  // client
-  client: AxiosInstance;
-
-  /**
-   * Constructs a new instance of the ModelRepository class.
-   * @param resource - The resource name.
-   * @param client - The Axios instance used for making HTTP requests.
-   */
-  constructor(resource: string, client: AxiosInstance) {
-    this.resource = resource;
-    this.client = client;
-  }
-
-  /**
-   * Finds a model by its ID or other criteria.
-   * @param options - The options for finding the model.
-   * @returns A promise that resolves to the found model.
-   */
-  async find(options: ModelFindOptions): Promise<T> {
-    const { id, by, params } = options;
-    const res = await this.client.get(`/${this.resource}/${id}`, {
-      params: {
-        by: by || "id",
-        ...params,
-      },
-    });
-    return res.data;
-  }
-
-  /**
-   * Lists models with optional pagination and filtering.
-   * @param options - The options for listing the models.
-   * @returns A promise that resolves to a list of models.
-   */
-  async list(options?: ModelListOptions): Promise<ListResponse<T>> {
-    const { page, offset, limit, params } = options || {};
-    const res = await this.client.get(`/${this.resource}`, {
-      params: { page, offset, limit, ...params },
-    });
-    // if res.data is an array then create ListResponse
-    if (Array.isArray(res.data)) {
-      return {
-        data: res.data,
-      };
-    } else {
-      return {
-        data: res.data.data,
-        total: res.data.meta.total,
-        page: res.data.meta.currentPage,
-        limit: res.data.meta.perPage,
-      };
-    }
-  }
-
-  /**
-   * Creates a new model.
-   * @param options - The options for creating the model.
-   * @returns A promise that resolves to the created model.
-   */
-  async create(options: ModelCreateOptions<C>): Promise<T> {
-    const { data, params } = options;
-    const res = await this.client.post(`/${this.resource}`, data, { params });
-    return res.data;
-  }
-
-  /**
-   * Updates an existing model.
-   * @param options - The options for updating the model.
-   * @returns A promise that resolves to the updated model.
-   */
-  async update(options: ModelUpdateOptions<U>): Promise<T> {
-    const { id, data, params } = options;
-    const res = await this.client.put(`/${this.resource}/${id}`, data, {
-      params,
-    });
-    return res.data;
-  }
-
-  /**
-   * Deletes a model by its ID or other criteria.
-   * @param options - The options for deleting the model.
-   * @returns A promise that resolves when the model is deleted.
-   */
-  async delete(options: ModelFindOptions): Promise<void> {
-    const { id, by, params } = options;
-    await this.client.delete(`/${this.resource}/${id}`, {
-      params: {
-        by: by || "id",
-        ...params,
-      },
-    });
-  }
-}
-
-/**
- * Represents a list response containing an array of data of type T.
- */
-export interface ListResponse<T> {
-  data: T[];
-  total?: number;
-  page?: number;
-  limit?: number;
-}
-
-/**
- * Represents the options for making a request.
- */
-interface RequestOptions {
-  params?: Record<string, any>;
-}
-
-export interface ModelFindOptions extends RequestOptions {
-  /**
-   * The ID of the model to find or the value to find by.
-   */
-  id: string;
-  /**
-   * The field to find by.
-   * @default "id" - The ID field.
-   */
-  by?: string;
-}
-
-/**
- * Options for listing models.
- */
-export interface ModelListOptions extends RequestOptions {
-  /**
-   * The page number to retrieve.
-   */
-  page?: number;
-
-  /**
-   * The offset from the beginning of the list.
-   */
-  offset?: number;
-
-  /**
-   * The maximum number of models to retrieve per page.
-   */
-  limit?: number;
-}
-
-/**
- * Represents the options for creating a model.
- * @template T - The type of data being created.
- */
-export interface ModelCreateOptions<T> extends RequestOptions {
-  data: T;
-}
-
-/**
- * Represents the options for updating a model.
- * @template T - The type of the data being updated.
- */
-export interface ModelUpdateOptions<T> extends RequestOptions {
-  /**
-   * The ID of the model to update.
-   */
-  id: string;
-  /**
-   * The data to update the model with.
-   */
-  data: T;
-}

package/src/feeef/repositories/stores.ts

@@ -1,39 +0,0 @@
-import vine from "@vinejs/vine";
-import { InferInput } from "@vinejs/vine/types";
-import { AxiosInstance } from "axios";
-import { StoreEntity } from "../../core/core";
-import {
-  CreateUserStoreSchema,
-  UpdateUserStoreSchema,
-} from "../validators/user_stores";
-import { ModelRepository, ModelCreateOptions } from "./repository";
-
-/**
- * Repository for managing Store entities.
- */
-export class StoreRepository extends ModelRepository<
-  StoreEntity,
-  InferInput<typeof CreateUserStoreSchema>,
-  InferInput<typeof UpdateUserStoreSchema>
-> {
-  /**
-   * Constructs a new StoreRepository instance.
-   * @param client The AxiosInstance used for making HTTP requests.
-   */
-  constructor(client: AxiosInstance) {
-    super("stores", client);
-  }
-
-  /**
-   * Creates a new Store entity.
-   * @param options The options for creating the Store entity.
-   * @returns A Promise that resolves to the created Store entity.
-   */
-  async create(
-    options: ModelCreateOptions<InferInput<typeof CreateUserStoreSchema>>
-  ): Promise<StoreEntity> {
-    const validator = vine.compile(CreateUserStoreSchema);
-    const output = await validator.validate(options.data);
-    return super.create({ ...options, data: output });
-  }
-}

package/src/feeef/repositories/users.ts

@@ -1,92 +0,0 @@
-import vine from "@vinejs/vine";
-import { InferInput } from "@vinejs/vine/types";
-import { AxiosInstance } from "axios";
-import { AuthToken, UserEntity } from "../../core/core";
-import { SigninSchema, AuthUpdateUserSchema } from "../validators/auth";
-import { CreateUserSchema, UpdateUserSchema } from "../validators/users";
-import { ModelRepository } from "./repository";
-
-/**
- * Represents the response returned by the authentication process.
- */
-export interface AuthResponse {
-  token: AuthToken;
-  user: UserEntity;
-}
-
-/**
- * Represents a repository for managing user data.
- * Extends the ModelRepository class.
- */
-export class UserRepository extends ModelRepository<
-  UserEntity,
-  InferInput<typeof CreateUserSchema>,
-  InferInput<typeof UpdateUserSchema>
-> {
-  /**
-   * Represents the authentication response.
-   */
-  auth: AuthResponse | null = null;
-
-  /**
-   * Constructs a new UserRepository instance.
-   * @param client - The AxiosInstance used for making HTTP requests.
-   */
-  constructor(client: AxiosInstance) {
-    super("users", client);
-  }
-
-  /**
-   * Signs in a user with the provided credentials.
-   * @param credentials - The user credentials.
-   * @returns A promise that resolves to the authentication response.
-   */
-  async signin(
-    credentials: InferInput<typeof SigninSchema>
-  ): Promise<AuthResponse> {
-    // validate the input
-    const validator = vine.compile(SigninSchema);
-    const output = await validator.validate(credentials);
-    const res = await this.client.post(`/${this.resource}/auth/signin`, output);
-    this.auth = res.data;
-    return res.data;
-  }
-
-  /**
-   * Signs up a new user with the provided credentials.
-   * @param credentials - The user credentials.
-   * @returns A promise that resolves to the authentication response.
-   */
-  async signup(
-    credentials: InferInput<typeof CreateUserSchema>
-  ): Promise<AuthResponse> {
-    // validate the input
-    const validator = vine.compile(CreateUserSchema);
-    const output = await validator.validate(credentials);
-    const res = await this.client.post(`/${this.resource}/auth/signup`, output);
-    this.auth = res.data;
-    return res.data;
-  }
-
-  /**
-   * Signs out the currently authenticated user.
-   * @returns A promise that resolves when the user is signed out.
-   */
-  async signout(): Promise<void> {
-    this.auth = null;
-  }
-
-  /**
-   * Updates the authenticated user's data.
-   * @param data - The updated user data.
-   * @returns A promise that resolves to the updated user entity.
-   */
-  async updateMe(
-    data: InferInput<typeof AuthUpdateUserSchema>
-  ): Promise<UserEntity> {
-    const validator = vine.compile(AuthUpdateUserSchema);
-    const output = await validator.validate(data);
-    const res = await this.client.put(`/${this.resource}/auth`, output);
-    return res.data;
-  }
-}