feeef 0.0.9 → 0.0.10

package/build/index.d.ts

@@ -0,0 +1 @@
+export * as core from "./src/core/core.js";

package/build/index.js

@@ -0,0 +1 @@
+export * as core from "./src/core/core.js";

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

@@ -0,0 +1,8 @@
+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';
+export * from './embadded/address.js';
+export * from './embadded/category.js';
+export * from './embadded/contact.js';

package/build/src/core/core.js

@@ -0,0 +1,10 @@
+// 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/build/src/core/embadded/address.d.ts

@@ -0,0 +1,13 @@
+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/build/src/core/embadded/address.js

@@ -0,0 +1 @@
+export {};

package/build/src/core/embadded/category.d.ts

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

package/build/src/core/embadded/category.js

@@ -0,0 +1 @@
+export {};

package/build/src/core/embadded/contact.d.ts

@@ -0,0 +1,21 @@
+export declare 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"
+}
+export interface EmbaddedContact {
+    type: EmbaddedContactType;
+    value: string;
+    metadata?: Record<string, any>;
+}

package/build/src/core/embadded/contact.js

@@ -0,0 +1,17 @@
+export var EmbaddedContactType;
+(function (EmbaddedContactType) {
+    EmbaddedContactType["phone"] = "phone";
+    EmbaddedContactType["email"] = "email";
+    EmbaddedContactType["facebook"] = "facebook";
+    EmbaddedContactType["twitter"] = "twitter";
+    EmbaddedContactType["instagram"] = "instagram";
+    EmbaddedContactType["linkedin"] = "linkedin";
+    EmbaddedContactType["website"] = "website";
+    EmbaddedContactType["whatsapp"] = "whatsapp";
+    EmbaddedContactType["telegram"] = "telegram";
+    EmbaddedContactType["signal"] = "signal";
+    EmbaddedContactType["viber"] = "viber";
+    EmbaddedContactType["skype"] = "skype";
+    EmbaddedContactType["zoom"] = "zoom";
+    EmbaddedContactType["other"] = "other";
+})(EmbaddedContactType || (EmbaddedContactType = {}));

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

@@ -0,0 +1,49 @@
+export declare enum OrderStatus {
+    draft = "draft",
+    pending = "pending",
+    processing = "processing",
+    completed = "completed",
+    cancelled = "cancelled"
+}
+export declare enum PaymentStatus {
+    unpaid = "unpaid",
+    paid = "paid",
+    received = "received"
+}
+export declare 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/build/src/core/entities/order.js

@@ -0,0 +1,22 @@
+export var OrderStatus;
+(function (OrderStatus) {
+    OrderStatus["draft"] = "draft";
+    OrderStatus["pending"] = "pending";
+    OrderStatus["processing"] = "processing";
+    OrderStatus["completed"] = "completed";
+    OrderStatus["cancelled"] = "cancelled";
+})(OrderStatus || (OrderStatus = {}));
+// PaymentStatus
+export var PaymentStatus;
+(function (PaymentStatus) {
+    PaymentStatus["unpaid"] = "unpaid";
+    PaymentStatus["paid"] = "paid";
+    PaymentStatus["received"] = "received";
+})(PaymentStatus || (PaymentStatus = {}));
+export var DeliveryStatus;
+(function (DeliveryStatus) {
+    DeliveryStatus["pending"] = "pending";
+    DeliveryStatus["delivering"] = "delivering";
+    DeliveryStatus["delivered"] = "delivered";
+    DeliveryStatus["returned"] = "returned";
+})(DeliveryStatus || (DeliveryStatus = {}));

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

@@ -0,0 +1,65 @@
+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: 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 declare 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 declare enum VariantOptionType {
+    color = "color",
+    image = "image",
+    text = "text"
+}
+export declare enum ProductType {
+    physical = "physical",
+    digital = "digital",
+    service = "service"
+}

package/build/src/core/entities/product.js

@@ -0,0 +1,19 @@
+export var ProductStatus;
+(function (ProductStatus) {
+    ProductStatus["draft"] = "draft";
+    ProductStatus["published"] = "published";
+    ProductStatus["archived"] = "archived";
+    ProductStatus["deleted"] = "deleted";
+})(ProductStatus || (ProductStatus = {}));
+export var VariantOptionType;
+(function (VariantOptionType) {
+    VariantOptionType["color"] = "color";
+    VariantOptionType["image"] = "image";
+    VariantOptionType["text"] = "text";
+})(VariantOptionType || (VariantOptionType = {}));
+export var ProductType;
+(function (ProductType) {
+    ProductType["physical"] = "physical";
+    ProductType["digital"] = "digital";
+    ProductType["service"] = "service";
+})(ProductType || (ProductType = {}));

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

@@ -0,0 +1,29 @@
+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 declare enum ShippingMethodStatus {
+    draft = "draft",
+    published = "published",
+    archived = "archived"
+}
+export declare enum ShippingMethodPolicy {
+    private = "private",
+    public = "public"
+}

package/build/src/core/entities/shipping_method.js

@@ -0,0 +1,11 @@
+export var ShippingMethodStatus;
+(function (ShippingMethodStatus) {
+    ShippingMethodStatus["draft"] = "draft";
+    ShippingMethodStatus["published"] = "published";
+    ShippingMethodStatus["archived"] = "archived";
+})(ShippingMethodStatus || (ShippingMethodStatus = {}));
+export var ShippingMethodPolicy;
+(function (ShippingMethodPolicy) {
+    ShippingMethodPolicy["private"] = "private";
+    ShippingMethodPolicy["public"] = "public";
+})(ShippingMethodPolicy || (ShippingMethodPolicy = {}));

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

@@ -0,0 +1,71 @@
+import { EmbaddedAddress } from '../embadded/address.js';
+import { EmbaddedCategory } from '../embadded/category.js';
+import { EmbaddedContact } from '../embadded/contact.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;
+    user: UserEntity;
+    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;
+    [key: string]: any;
+    metadata: Record<string, any>;
+}
+export declare 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 declare enum StoreActionType {
+    link = "link",
+    whatsapp = "whatsapp",
+    telegram = "telegram",
+    phone = "phone"
+}

package/build/src/core/entities/store.js

@@ -0,0 +1,15 @@
+export var StoreIntegrations;
+(function (StoreIntegrations) {
+    StoreIntegrations["telegram"] = "telegram";
+    StoreIntegrations["facebookPixel"] = "facebook_pixel";
+    StoreIntegrations["googleAnalytics"] = "google_analytics";
+    StoreIntegrations["googleSheet"] = "google_sheet";
+    StoreIntegrations["sms"] = "sms";
+})(StoreIntegrations || (StoreIntegrations = {}));
+export var StoreActionType;
+(function (StoreActionType) {
+    StoreActionType["link"] = "link";
+    StoreActionType["whatsapp"] = "whatsapp";
+    StoreActionType["telegram"] = "telegram";
+    StoreActionType["phone"] = "phone";
+})(StoreActionType || (StoreActionType = {}));

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

@@ -0,0 +1,23 @@
+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/build/src/core/entities/user.js

@@ -0,0 +1 @@
+export {};

package/build/src/core/sdk/fif.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/core/sdk/fif.js

@@ -0,0 +1,4 @@
+class FifStoreSdk {
+    constructor(parameters) { }
+}
+export {};

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

@@ -0,0 +1,62 @@
+import { AxiosInstance } from "axios";
+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 declare 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);
+}

package/build/src/feeef/feeef.js

@@ -0,0 +1,65 @@
+import axios 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";
+/**
+ * Represents the FeeeF class.
+ */
+export class FeeeF {
+    /**
+     * 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 }) {
+        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,
+                // 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/build/src/feeef/repositories/orders.d.ts

@@ -0,0 +1,21 @@
+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 declare 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);
+    /**
+     * 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.
+     */
+    send(data: InferInput<typeof SendOrderSchema>): Promise<OrderEntity>;
+}

package/build/src/feeef/repositories/orders.js

@@ -0,0 +1,27 @@
+import vine from "@vinejs/vine";
+import { SendOrderSchema } from "../validators/order";
+import { ModelRepository } from "./repository";
+/**
+ * Represents a repository for managing orders.
+ */
+export class OrderRepository 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 = 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/build/src/feeef/repositories/products.d.ts

@@ -0,0 +1,15 @@
+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 declare 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);
+}

package/build/src/feeef/repositories/products.js

@@ -0,0 +1,13 @@
+import { ModelRepository } from "./repository";
+/**
+ * Represents a repository for managing products.
+ */
+export class ProductRepository extends ModelRepository {
+    /**
+     * Creates a new instance of the ProductRepository class.
+     * @param client - The AxiosInstance used for making HTTP requests.
+     */
+    constructor(client) {
+        super("products", client);
+    }
+}