feeef 0.0.7 → 0.0.9

package/package.json

@@ -1,9 +1,18 @@
 {
   "name": "feeef",
   "description": "FeeeF sdk",
-  "main": "src/index.ts",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "type": "module",
+  "main": "build/index.js",
+  "files": [
+    "build",
+    "!build/bin",
+    "!build/tests",
+    "!build/factories"
+  ],
+  "exports": {
+    ".": "./build/index.js"
+  },
   "scripts": {
     "dev": "vite --host",
     "build": "tsc && vite build",
@@ -25,5 +34,16 @@
     "eslint-plugin-react-refresh": "^0.4.3",
     "typescript": "^5.0.2",
     "vite": "^4.4.5"
+  },
+  "tsup": {
+    "entry": [
+      "./index.ts"
+    ],
+    "outDir": "./build",
+    "clean": true,
+    "format": "esm",
+    "dts": false,
+    "sourcemap": true,
+    "target": "esnext"
   }
 }

package/.eslintrc.cjs

@@ -1,19 +0,0 @@
-module.exports = {
-  root: true,
-  env: { browser: true, es2020: true },
-  extends: [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:react-hooks/recommended",
-  ],
-  ignorePatterns: ["dist", ".eslintrc.cjs"],
-  parser: "@typescript-eslint/parser",
-  plugins: ["react-refresh"],
-  rules: {
-    "react-refresh/only-export-components": [
-      "warn",
-      { allowConstantExport: true },
-    ],
-    "@typescript-eslint/no-explicit-any": "off",
-  },
-};

package/src/core/core.ts

@@ -1,10 +0,0 @@
-// entities
-export * from './entities/order.js'
-export * from './entities/store.js'
-export * from './entities/product.js'
-export * from './entities/user.js'
-export * from './entities/shipping_method.js'
-// embaddeds
-export * from './embadded/address.js'
-export * from './embadded/category.js'
-export * from './embadded/contact.js'

package/src/core/embadded/address.ts

@@ -1,13 +0,0 @@
-export interface EmbaddedAddress {
-  city: string
-  state: string
-  country?: string
-  street?: string
-  zip?: string
-  location?: {
-    geohash?: string
-    lat: number
-    long: number
-  }
-  metadata?: Record<string, any>
-}

package/src/core/embadded/category.ts

@@ -1,7 +0,0 @@
-export interface EmbaddedCategory {
-  name: string
-  description: string | null
-  photoUrl: string | null
-  ondarkPhotoUrl?: string | null
-  metadata?: Record<string, any>
-}

package/src/core/embadded/contact.ts

@@ -1,24 +0,0 @@
-export enum EmbaddedContactType {
-  phone = 'phone',
-  email = 'email',
-  facebook = 'facebook',
-  twitter = 'twitter',
-  instagram = 'instagram',
-  linkedin = 'linkedin',
-  website = 'website',
-  whatsapp = 'whatsapp',
-  telegram = 'telegram',
-  signal = 'signal',
-  viber = 'viber',
-  skype = 'skype',
-  zoom = 'zoom',
-  other = 'other',
-}
-
-// EmbaddedContactType is not enum but can only be: "phone" | "email" | "facebook" | "twitter" | "instagram" | "linkedin" | "website" | "whatsapp" | "telegram" | "signal" | "viber" | "skype" | "zoom" | "other
-
-export interface EmbaddedContact {
-  type: EmbaddedContactType
-  value: string
-  metadata?: Record<string, any>
-}

package/src/core/entities/order.ts

@@ -1,52 +0,0 @@
-export enum OrderStatus {
-  draft = "draft",
-  pending = "pending",
-  processing = "processing",
-  completed = "completed",
-  cancelled = "cancelled",
-}
-
-// PaymentStatus
-export enum PaymentStatus {
-  unpaid = "unpaid",
-  paid = "paid",
-  received = "received",
-}
-export enum DeliveryStatus {
-  pending = "pending",
-  delivering = "delivering",
-  delivered = "delivered",
-  returned = "returned",
-}
-
-export interface OrderEntity {
-  id: string;
-  customerName: string | null;
-  customerPhone: string;
-  customerIp: string | null;
-  shippingAddress: string | null;
-  shippingCity: string | null;
-  shippingState: string | null;
-  shippingMethodId: string | null;
-  paymentMethodId: string | null;
-  items: OrderItem[];
-  subtotal: number;
-  shippingPrice: number;
-  total: number;
-  discount: number;
-  coupon: string | null;
-  storeId: string;
-  metadata: any;
-  status: OrderStatus;
-  paymentStatus: PaymentStatus;
-  deliveryStatus: DeliveryStatus;
-  createdAt: any;
-  updatedAt: any;
-}
-export interface OrderItem {
-  productId: string;
-  productName: string;
-  variantPath?: string;
-  quantity: number;
-  price: number;
-}

package/src/core/entities/product.ts

@@ -1,99 +0,0 @@
-import { EmbaddedCategory } from "../embadded/category.js";
-
-export interface ProductEntity {
-  id: string;
-
-  slug: string;
-
-  decoration: ProductDecoration | null;
-
-  name: string | null;
-
-  photoUrl: string | null;
-
-  media: string[];
-
-  storeId: string;
-
-  category: EmbaddedCategory;
-
-  title: string | null;
-
-  description: string | null;
-
-  body: string | null;
-
-  // sku
-  sku: string | null;
-
-  price: number;
-
-  discount: number | null;
-
-  stock: number;
-
-  sold: number;
-
-  views: number;
-
-  likes: number;
-
-  dislikes: number;
-
-  variant?: ProductVariant | null;
-
-  metadata: Record<string, any>;
-
-  status: ProductStatus;
-
-  type: ProductType;
-
-  verifiedAt: any | null;
-
-  blockedAt: any | null;
-
-  createdAt: any;
-
-  updatedAt: any;
-}
-
-export enum ProductStatus {
-  draft = "draft",
-  published = "published",
-  archived = "archived",
-  deleted = "deleted",
-}
-
-export interface ProductDecoration {
-  metadata: Record<string, any>;
-}
-
-export interface ProductVariant {
-  name: string;
-  options: ProductVariantOption[];
-}
-
-export interface ProductVariantOption {
-  name: string;
-  sku?: string | null;
-  price?: number | null;
-  discount?: number | null;
-  stock?: number | null;
-  sold?: number | null;
-  type?: VariantOptionType;
-  child?: ProductVariant | null;
-  mediaIndex?: number | null;
-  hint?: string | null;
-}
-
-export enum VariantOptionType {
-  color = "color",
-  image = "image",
-  text = "text",
-}
-
-export enum ProductType {
-  physical = "physical",
-  digital = "digital",
-  service = "service",
-}

package/src/core/entities/shipping_method.ts

@@ -1,32 +0,0 @@
-import { OrderEntity } from "./order.js";
-
-export interface ShippingMethodEntity {
-  id: string;
-  name: string;
-  description: string | null;
-  logoUrl: string | null;
-  ondarkLogoUrl: string | null;
-  price: number;
-  forks: number;
-  sourceId: string;
-  storeId: string;
-  rates: (number | null)[];
-  status: ShippingMethodStatus;
-  policy: ShippingMethodPolicy;
-  verifiedAt: any;
-  createdAt: any;
-  updatedAt: any;
-  orders: OrderEntity[];
-  source: ShippingMethodEntity | null;
-}
-
-export enum ShippingMethodStatus {
-  draft = "draft",
-  published = "published",
-  archived = "archived",
-}
-
-export enum ShippingMethodPolicy {
-  private = "private",
-  public = "public",
-}

package/src/core/entities/store.ts

@@ -1,84 +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'
-
-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: StoreIntegration[]
-  verifiedAt: any | null
-  blockedAt: any | null
-  createdAt: any
-  updatedAt: any
-  // products: ProductEntity[];
-  user: UserEntity
-  // orders: OrderEntity[];
-  // shippingMethods: ShippingMethodEntity[];
-  defaultShippingRates: (number | null)[][] | null
-}
-
-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 StoreIntegration {
-  type: StoreIntegrations
-  // any
-  [key: string]: any
-  metadata: Record<string, any>
-}
-
-export enum StoreIntegrations {
-  telegram = 'telegram',
-  facebookPixel = 'facebook_pixel',
-  googleAnalytics = 'google_analytics',
-  googleSheet = 'google_sheet',
-  sms = 'sms',
-}
-
-export interface StoreAction {
-  label: string
-  url: string
-  type: StoreActionType
-}
-
-export enum StoreActionType {
-  link = 'link',
-  whatsapp = 'whatsapp',
-  telegram = 'telegram',
-  phone = 'phone',
-}

package/src/core/entities/user.ts

@@ -1,24 +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>
-}
-
-export interface AuthToken {
-  type: string
-  name: string | null
-  token: string
-  abilities: string[]
-  lastUsedAt: any
-  expiresAt: any
-}

package/src/core/sdk/fif.ts

@@ -1,3 +0,0 @@
-abstract class FifStoreSdk {
-  constructor(parameters) {}
-}

package/src/feeef/feeef.ts

@@ -1,94 +0,0 @@
-import axios, { AxiosInstance } from "axios";
-import { 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;
-}
-
-/**
- * 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 }: FeeeFConfig) {
-    this.apiKey = apiKey;
-    // get th "cache" search param
-    const urlParams = new URLSearchParams(window.location.search);
-    const cacheParam = urlParams.get("cache");
-    // if is 0 or false, disable cache
-    if (cacheParam == '0') {
-      this.client = client || axios;
-    } else {
-      this.client = setupCache(client || axios, {
-        ttl: cache === false ? 5 : Math.max(cache!, 5) || 1 * 60 * 1000, // 1 minute by default
-        // for persistent cache use buildWebStorage
-        storage: buildWebStorage(localStorage, "ff:"),
-      });
-    }
-    // set base url
-    this.client.defaults.baseURL = "http://localhost:3333/api/v1";
-    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);
-  }
-}