feeef 0.0.27 → 0.1.1

package/build/index.js

@@ -0,0 +1,647 @@
+// src/feeef/feeef.ts
+import axios from "axios";
+
+// src/feeef/repositories/orders.ts
+import vine4 from "@vinejs/vine";
+
+// src/feeef/validators/order.ts
+import vine3 from "@vinejs/vine";
+
+// src/feeef/validators/auth.ts
+import vine2 from "@vinejs/vine";
+
+// src/feeef/validators/helpers.ts
+import vine from "@vinejs/vine";
+var AvatarFileSchema = vine.any();
+var ImageFileSchema = vine.any();
+var DomainSchema = vine.object({
+  name: vine.string().minLength(3).maxLength(32),
+  verifiedAt: vine.date().optional(),
+  metadata: vine.object({}).optional()
+});
+var StoreDecorationSchema = vine.object({
+  primary: vine.number().min(0).max(4294967295),
+  onPrimary: vine.number().min(0).max(4294967295),
+  showStoreLogoInHeader: vine.boolean().optional(),
+  logoFullHeight: vine.boolean().optional(),
+  showStoreNameInHeader: vine.boolean().optional(),
+  metadata: vine.any().optional()
+});
+var EmbaddedCategorySchema = vine.object({
+  name: vine.string().minLength(2).maxLength(32),
+  description: vine.string().minLength(2).maxLength(255).optional(),
+  photoUrl: vine.string().optional(),
+  ondarkPhotoUrl: vine.string().optional(),
+  photoFile: AvatarFileSchema.optional(),
+  ondarkPhotoFile: AvatarFileSchema.optional(),
+  metadata: vine.object({}).optional()
+});
+var EmbaddedAddressSchema = vine.object({
+  country: vine.string().minLength(2).maxLength(32).optional(),
+  state: vine.string().minLength(2).maxLength(32).optional(),
+  city: vine.string().minLength(2).maxLength(32).optional(),
+  street: vine.string().minLength(2).maxLength(32).optional(),
+  zip: vine.string().minLength(2).maxLength(32).optional(),
+  metadata: vine.object({}).optional().optional()
+});
+var EmbaddedContactSchema = vine.object({
+  type: vine.string().minLength(2).maxLength(32),
+  value: vine.string().minLength(2).maxLength(255),
+  metadata: vine.object({}).optional()
+});
+var StoreBunner = vine.object({
+  url: vine.string().url().optional(),
+  title: vine.string(),
+  enabled: vine.boolean().optional(),
+  metadata: vine.object({}).optional()
+});
+
+// src/feeef/validators/auth.ts
+var PhoneShema = vine2.string().regex(/^0(5|6|7)\d{8}$|^0(2)\d{7}$/);
+var SignupSchema = vine2.object({
+  name: vine2.string().minLength(2).maxLength(32),
+  email: vine2.string(),
+  // .unique(async (db, value, field) => {
+  //   const user = await db.from('users').where('email', value).first()
+  //   return !user
+  // })
+  phone: PhoneShema.optional(),
+  photoFile: ImageFileSchema.optional(),
+  photoUrl: vine2.string().optional(),
+  password: vine2.string().minLength(8).maxLength(32)
+});
+var SigninSchema = vine2.object({
+  email: vine2.string().email(),
+  password: vine2.string().minLength(8).maxLength(32)
+});
+var AuthUpdateUserSchema = vine2.object({
+  name: vine2.string().minLength(2).maxLength(32).optional(),
+  email: vine2.string().optional(),
+  phone: PhoneShema.optional(),
+  // for upload file
+  photoFile: vine2.any(),
+  photoUrl: vine2.string().optional(),
+  oldPassword: vine2.string().minLength(8).maxLength(32).optional(),
+  newPassword: vine2.string().minLength(8).maxLength(32).notSameAs("oldPassword").optional()
+});
+
+// src/core/entities/order.ts
+var OrderStatus = /* @__PURE__ */ ((OrderStatus2) => {
+  OrderStatus2["draft"] = "draft";
+  OrderStatus2["pending"] = "pending";
+  OrderStatus2["review"] = "review";
+  OrderStatus2["accepted"] = "accepted";
+  OrderStatus2["processing"] = "processing";
+  OrderStatus2["completed"] = "completed";
+  OrderStatus2["cancelled"] = "cancelled";
+  return OrderStatus2;
+})(OrderStatus || {});
+var PaymentStatus = /* @__PURE__ */ ((PaymentStatus2) => {
+  PaymentStatus2["unpaid"] = "unpaid";
+  PaymentStatus2["paid"] = "paid";
+  PaymentStatus2["received"] = "received";
+  return PaymentStatus2;
+})(PaymentStatus || {});
+var DeliveryStatus = /* @__PURE__ */ ((DeliveryStatus2) => {
+  DeliveryStatus2["pending"] = "pending";
+  DeliveryStatus2["delivering"] = "delivering";
+  DeliveryStatus2["delivered"] = "delivered";
+  DeliveryStatus2["returned"] = "returned";
+  return DeliveryStatus2;
+})(DeliveryStatus || {});
+
+// src/feeef/validators/order.ts
+var OrderItemSchema = vine3.object({
+  productId: vine3.string(),
+  // productId: vine.string().exists(async (db, value, field) => {
+  //   const product = await db.from('products').where('id', value).first()
+  //   return !!product
+  // }),
+  productName: vine3.string().optional(),
+  variant: vine3.any().optional(),
+  quantity: vine3.number(),
+  price: vine3.number().optional()
+});
+var GuestOrderItemSchema = vine3.object({
+  productId: vine3.string(),
+  variantPath: vine3.string().optional(),
+  quantity: vine3.number()
+});
+var SendOrderSchema = vine3.object({
+  id: vine3.string().optional(),
+  customerName: vine3.string().optional(),
+  customerPhone: vine3.string(),
+  //   customerIp: vine.string().optional(),
+  shippingAddress: vine3.string().optional(),
+  shippingCity: vine3.string().optional(),
+  shippingState: vine3.string().optional(),
+  shippingMethodId: vine3.string().optional(),
+  paymentMethodId: vine3.string().optional(),
+  items: vine3.array(GuestOrderItemSchema).minLength(1),
+  //   subtotal: vine.number().optional(),
+  //   shippingPrice: vine.number().optional(),
+  //   total: vine.number().optional(),
+  //   discount: vine.number().optional(),
+  coupon: vine3.string().optional(),
+  status: vine3.enum(["pending", "draft"]),
+  // TODO: validate storeId is exists and not blocked
+  storeId: vine3.string(),
+  metadata: vine3.any().optional()
+});
+var CreateOrderSchema = vine3.object({
+  id: vine3.string().optional(),
+  customerName: vine3.string().optional(),
+  customerPhone: PhoneShema,
+  customerIp: vine3.string().optional(),
+  shippingAddress: vine3.string().optional(),
+  shippingCity: vine3.string().optional(),
+  shippingState: vine3.string().optional(),
+  shippingMethodId: vine3.string().optional(),
+  paymentMethodId: vine3.string().optional(),
+  items: vine3.array(OrderItemSchema).minLength(1),
+  subtotal: vine3.number().optional(),
+  shippingPrice: vine3.number().optional(),
+  total: vine3.number().optional(),
+  discount: vine3.number().optional(),
+  coupon: vine3.string().optional(),
+  status: vine3.enum(Object.values(OrderStatus)).optional(),
+  storeId: vine3.string(),
+  metadata: vine3.any().optional()
+});
+var UpdateOrderSchema = vine3.object({
+  id: vine3.string().optional(),
+  customerName: vine3.string().optional(),
+  customerPhone: PhoneShema.optional(),
+  customerIp: vine3.string().optional(),
+  shippingAddress: vine3.string().optional(),
+  shippingCity: vine3.string().optional(),
+  shippingState: vine3.string().optional(),
+  shippingMethodId: vine3.string().optional(),
+  paymentMethodId: vine3.string().optional(),
+  items: vine3.array(OrderItemSchema).minLength(1).optional(),
+  subtotal: vine3.number().optional(),
+  shippingPrice: vine3.number().optional(),
+  total: vine3.number().optional(),
+  discount: vine3.number().optional(),
+  coupon: vine3.string().optional(),
+  status: vine3.enum(Object.values(OrderStatus)).optional(),
+  storeId: vine3.string(),
+  metadata: vine3.any().optional()
+});
+
+// src/feeef/repositories/repository.ts
+var ModelRepository = class {
+  resource;
+  // client
+  client;
+  /**
+   * 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, client) {
+    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) {
+    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) {
+    const { page, offset, limit, params } = options || {};
+    const res = await this.client.get(`/${this.resource}`, {
+      params: { page, offset, limit, ...params }
+    });
+    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) {
+    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) {
+    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) {
+    const { id, by, params } = options;
+    await this.client.delete(`/${this.resource}/${id}`, {
+      params: {
+        by: by || "id",
+        ...params
+      }
+    });
+  }
+};
+
+// src/feeef/repositories/orders.ts
+var OrderRepository = class extends ModelRepository {
+  /**
+   * Constructs a new OrderRepository instance.
+   * @param client - The AxiosInstance used for making HTTP requests.
+   */
+  constructor(client) {
+    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) {
+    const validator = vine4.compile(SendOrderSchema);
+    const output = await validator.validate(data);
+    const res = await this.client.post(`/${this.resource}/send`, output);
+    return res.data;
+  }
+  /**
+   * track the order by the order id
+   * it will return the order status and history
+   * @param options - The options for finding the model.
+   * @returns A promise that resolves to the found model.
+   */
+  async track(options) {
+    const { id, params } = options;
+    const res = await this.client.get(`/${this.resource}/${id}`, {
+      params: {
+        ...params
+      }
+    });
+    return res.data;
+  }
+};
+
+// src/feeef/repositories/products.ts
+var ProductRepository = class extends ModelRepository {
+  /**
+   * Creates a new instance of the ProductRepository class.
+   * @param client - The AxiosInstance used for making HTTP requests.
+   */
+  constructor(client) {
+    super("products", client);
+  }
+};
+
+// src/feeef/repositories/stores.ts
+import vine6 from "@vinejs/vine";
+
+// src/feeef/validators/user_stores.ts
+import vine5 from "@vinejs/vine";
+var DefaultShippingRatesSchema = vine5.array(
+  vine5.array(vine5.number().min(0).max(1e5).nullable()).nullable()
+);
+var CreateUserStoreSchema = vine5.object({
+  name: vine5.string().minLength(2).maxLength(32),
+  slug: vine5.string().regex(/^[a-z0-9-]+$/).minLength(2).maxLength(32),
+  // .unique(async (db, value, field) => {
+  //   const store = await db.from('stores').where('slug', value).first()
+  //   return !store
+  // })
+  domain: vine5.object({
+    name: vine5.string().minLength(2).maxLength(32)
+  }).optional(),
+  decoration: StoreDecorationSchema.optional(),
+  banner: StoreBunner.optional(),
+  logoUrl: vine5.string().optional(),
+  ondarkLogoUrl: vine5.string().optional(),
+  logoFile: AvatarFileSchema.optional(),
+  ondarkLogoFile: AvatarFileSchema.optional(),
+  categories: vine5.array(EmbaddedCategorySchema).optional(),
+  title: vine5.string().minLength(2).maxLength(255).optional(),
+  description: vine5.string().minLength(2).maxLength(255).optional(),
+  addresses: vine5.array(EmbaddedAddressSchema).optional(),
+  metadata: vine5.object({}).optional(),
+  contacts: vine5.array(
+    vine5.object({
+      type: vine5.string().minLength(2).maxLength(32),
+      value: vine5.string().minLength(2).maxLength(255),
+      metadata: vine5.object({}).optional()
+    })
+  ).optional(),
+  defaultShippingRates: DefaultShippingRatesSchema.optional(),
+  integrations: vine5.array(vine5.any()).optional()
+});
+var UpdateUserStoreSchema = vine5.object({
+  name: vine5.string().minLength(2).maxLength(32).optional(),
+  slug: vine5.string().regex(/^[a-z0-9-]+$/).minLength(2).maxLength(32).optional(),
+  domain: DomainSchema.optional(),
+  decoration: StoreDecorationSchema.optional(),
+  banner: StoreBunner.optional(),
+  logoUrl: vine5.string().nullable().optional(),
+  ondarkLogoUrl: vine5.string().nullable().optional(),
+  logoFile: AvatarFileSchema.optional(),
+  ondarkLogoFile: AvatarFileSchema.optional(),
+  categories: vine5.array(EmbaddedCategorySchema).optional(),
+  title: vine5.string().minLength(2).maxLength(255).optional(),
+  description: vine5.string().minLength(2).maxLength(255).optional(),
+  addresses: vine5.array(EmbaddedAddressSchema).optional(),
+  metadata: vine5.object({}).optional(),
+  contacts: vine5.array(EmbaddedContactSchema).optional(),
+  defaultShippingRates: DefaultShippingRatesSchema.optional(),
+  integrations: vine5.array(vine5.any()).optional()
+});
+
+// src/feeef/repositories/stores.ts
+var StoreRepository = class extends ModelRepository {
+  /**
+   * Constructs a new StoreRepository instance.
+   * @param client The AxiosInstance used for making HTTP requests.
+   */
+  constructor(client) {
+    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) {
+    const validator = vine6.compile(CreateUserStoreSchema);
+    const output = await validator.validate(options.data);
+    return super.create({ ...options, data: output });
+  }
+};
+
+// src/feeef/repositories/users.ts
+import vine8 from "@vinejs/vine";
+
+// src/feeef/validators/users.ts
+import vine7 from "@vinejs/vine";
+var CreateUserSchema = vine7.object({
+  name: vine7.string().minLength(2).maxLength(32),
+  email: vine7.string(),
+  // .unique(async (db, value, field) => {
+  //   const user = await db.from('users').where('email', value).first()
+  //   return !user
+  // }),
+  phone: vine7.string().regex(/^0(5|6|7)\d{8}$|^0(2)\d{7}$/).optional(),
+  password: vine7.string().minLength(8).maxLength(32),
+  // for upload file
+  photoFile: vine7.any(),
+  // .file({
+  //   size: '1mb',
+  //   extnames: ['jpg', 'jpeg', 'png', 'gif', 'webp'],
+  // })
+  // .optional(),
+  photoUrl: vine7.string().optional(),
+  // metadata (any object)
+  metadata: vine7.object({}).optional(),
+  // dates
+  emailVerifiedAt: vine7.date().optional(),
+  phoneVerifiedAt: vine7.date().optional(),
+  verifiedAt: vine7.date().optional(),
+  blockedAt: vine7.date().optional()
+});
+var UpdateUserSchema = vine7.object({
+  name: vine7.string().minLength(2).maxLength(32).optional(),
+  email: vine7.string().optional(),
+  phone: vine7.string().regex(/^0(5|6|7)\d{8}$|^0(2)\d{7}$/).optional(),
+  password: vine7.string().minLength(8).maxLength(32).confirmed().optional(),
+  // for upload file
+  photoFile: vine7.any(),
+  photoUrl: vine7.string().optional(),
+  // metadata (any object)
+  metadata: vine7.object({}).optional(),
+  // dates
+  emailVerifiedAt: vine7.date().optional(),
+  phoneVerifiedAt: vine7.date().optional(),
+  verifiedAt: vine7.string().optional(),
+  blockedAt: vine7.date().optional()
+});
+
+// src/feeef/repositories/users.ts
+var UserRepository = class extends ModelRepository {
+  /**
+   * Represents the authentication response.
+   */
+  auth = null;
+  /**
+   * Constructs a new UserRepository instance.
+   * @param client - The AxiosInstance used for making HTTP requests.
+   */
+  constructor(client) {
+    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) {
+    const validator = vine8.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) {
+    const validator = vine8.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() {
+    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) {
+    const validator = vine8.compile(AuthUpdateUserSchema);
+    const output = await validator.validate(data);
+    const res = await this.client.put(`/${this.resource}/auth`, output);
+    return res.data;
+  }
+};
+
+// src/feeef/feeef.ts
+var FeeeF = class {
+  /**
+   * The API key used for authentication.
+   */
+  apiKey;
+  /**
+   * The Axios instance used for making HTTP requests.
+   */
+  client;
+  /**
+   * The repository for managing stores.
+   */
+  stores;
+  /**
+   * The repository for managing products.
+   */
+  products;
+  /**
+   * The repository for managing users.
+   */
+  users;
+  /**
+   * The repository for managing orders.
+   */
+  orders;
+  /**
+   * 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" }) {
+    console.log(cache);
+    this.apiKey = apiKey;
+    this.client = client || axios;
+    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);
+  }
+};
+
+// src/core/entities/store.ts
+var StoreActionType = /* @__PURE__ */ ((StoreActionType2) => {
+  StoreActionType2["link"] = "link";
+  StoreActionType2["whatsapp"] = "whatsapp";
+  StoreActionType2["telegram"] = "telegram";
+  StoreActionType2["phone"] = "phone";
+  return StoreActionType2;
+})(StoreActionType || {});
+var StoreSubscriptionStatus = /* @__PURE__ */ ((StoreSubscriptionStatus2) => {
+  StoreSubscriptionStatus2["active"] = "active";
+  StoreSubscriptionStatus2["inactive"] = "inactive";
+  return StoreSubscriptionStatus2;
+})(StoreSubscriptionStatus || {});
+var StoreSubscriptionType = /* @__PURE__ */ ((StoreSubscriptionType2) => {
+  StoreSubscriptionType2["free"] = "free";
+  StoreSubscriptionType2["quota"] = "quota";
+  StoreSubscriptionType2["percentage"] = "percentage";
+  return StoreSubscriptionType2;
+})(StoreSubscriptionType || {});
+
+// src/core/entities/product.ts
+var ProductStatus = /* @__PURE__ */ ((ProductStatus2) => {
+  ProductStatus2["draft"] = "draft";
+  ProductStatus2["published"] = "published";
+  ProductStatus2["archived"] = "archived";
+  ProductStatus2["deleted"] = "deleted";
+  return ProductStatus2;
+})(ProductStatus || {});
+var VariantOptionType = /* @__PURE__ */ ((VariantOptionType2) => {
+  VariantOptionType2["color"] = "color";
+  VariantOptionType2["image"] = "image";
+  VariantOptionType2["text"] = "text";
+  return VariantOptionType2;
+})(VariantOptionType || {});
+var ProductType = /* @__PURE__ */ ((ProductType2) => {
+  ProductType2["physical"] = "physical";
+  ProductType2["digital"] = "digital";
+  ProductType2["service"] = "service";
+  return ProductType2;
+})(ProductType || {});
+
+// src/core/entities/shipping_method.ts
+var ShippingMethodStatus = /* @__PURE__ */ ((ShippingMethodStatus2) => {
+  ShippingMethodStatus2["draft"] = "draft";
+  ShippingMethodStatus2["published"] = "published";
+  ShippingMethodStatus2["archived"] = "archived";
+  return ShippingMethodStatus2;
+})(ShippingMethodStatus || {});
+var ShippingMethodPolicy = /* @__PURE__ */ ((ShippingMethodPolicy2) => {
+  ShippingMethodPolicy2["private"] = "private";
+  ShippingMethodPolicy2["public"] = "public";
+  return ShippingMethodPolicy2;
+})(ShippingMethodPolicy || {});
+
+// src/core/embadded/contact.ts
+var EmbaddedContactType = /* @__PURE__ */ ((EmbaddedContactType2) => {
+  EmbaddedContactType2["phone"] = "phone";
+  EmbaddedContactType2["email"] = "email";
+  EmbaddedContactType2["facebook"] = "facebook";
+  EmbaddedContactType2["twitter"] = "twitter";
+  EmbaddedContactType2["instagram"] = "instagram";
+  EmbaddedContactType2["linkedin"] = "linkedin";
+  EmbaddedContactType2["website"] = "website";
+  EmbaddedContactType2["whatsapp"] = "whatsapp";
+  EmbaddedContactType2["telegram"] = "telegram";
+  EmbaddedContactType2["signal"] = "signal";
+  EmbaddedContactType2["viber"] = "viber";
+  EmbaddedContactType2["skype"] = "skype";
+  EmbaddedContactType2["zoom"] = "zoom";
+  EmbaddedContactType2["other"] = "other";
+  return EmbaddedContactType2;
+})(EmbaddedContactType || {});
+export {
+  DeliveryStatus,
+  EmbaddedContactType,
+  FeeeF,
+  OrderStatus,
+  PaymentStatus,
+  ProductStatus,
+  ProductType,
+  ShippingMethodPolicy,
+  ShippingMethodStatus,
+  StoreActionType,
+  StoreSubscriptionStatus,
+  StoreSubscriptionType,
+  VariantOptionType
+};
+//# sourceMappingURL=index.js.map