feeef 0.0.8 → 0.0.10

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

@@ -0,0 +1,112 @@
+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 declare abstract class ModelRepository<T, C, U> {
+    resource: string;
+    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);
+    /**
+     * 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.
+     */
+    find(options: ModelFindOptions): Promise<T>;
+    /**
+     * 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.
+     */
+    list(options?: ModelListOptions): Promise<ListResponse<T>>;
+    /**
+     * Creates a new model.
+     * @param options - The options for creating the model.
+     * @returns A promise that resolves to the created model.
+     */
+    create(options: ModelCreateOptions<C>): Promise<T>;
+    /**
+     * Updates an existing model.
+     * @param options - The options for updating the model.
+     * @returns A promise that resolves to the updated model.
+     */
+    update(options: ModelUpdateOptions<U>): Promise<T>;
+    /**
+     * 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.
+     */
+    delete(options: ModelFindOptions): Promise<void>;
+}
+/**
+ * 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;
+}
+export {};

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

@@ -0,0 +1,96 @@
+/**
+ * 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 class ModelRepository {
+    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 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) {
+        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,
+            },
+        });
+    }
+}

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

@@ -0,0 +1,22 @@
+import { InferInput } from "@vinejs/vine/types";
+import { AxiosInstance } from "axios";
+import { StoreEntity } from "../../core/core";
+import { CreateStoreSchema } from "../validators/stores";
+import { CreateUserStoreSchema, UpdateUserStoreSchema } from "../validators/user_stores";
+import { ModelRepository, ModelCreateOptions } from "./repository";
+/**
+ * Repository for managing Store entities.
+ */
+export declare 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);
+    /**
+     * Creates a new Store entity.
+     * @param options The options for creating the Store entity.
+     * @returns A Promise that resolves to the created Store entity.
+     */
+    create(options: ModelCreateOptions<InferInput<typeof CreateStoreSchema>>): Promise<StoreEntity>;
+}

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

@@ -0,0 +1,25 @@
+import vine from "@vinejs/vine";
+import { CreateStoreSchema } from "../validators/stores";
+import { ModelRepository } from "./repository";
+/**
+ * Repository for managing Store entities.
+ */
+export class StoreRepository 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 = vine.compile(CreateStoreSchema);
+        const output = await validator.validate(options.data);
+        return super.create({ ...options, data: output });
+    }
+}

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

@@ -0,0 +1,51 @@
+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 declare class UserRepository extends ModelRepository<UserEntity, InferInput<typeof CreateUserSchema>, InferInput<typeof UpdateUserSchema>> {
+    /**
+     * Represents the authentication response.
+     */
+    auth: AuthResponse | null;
+    /**
+     * Constructs a new UserRepository instance.
+     * @param client - The AxiosInstance used for making HTTP requests.
+     */
+    constructor(client: AxiosInstance);
+    /**
+     * Signs in a user with the provided credentials.
+     * @param credentials - The user credentials.
+     * @returns A promise that resolves to the authentication response.
+     */
+    signin(credentials: InferInput<typeof SigninSchema>): Promise<AuthResponse>;
+    /**
+     * Signs up a new user with the provided credentials.
+     * @param credentials - The user credentials.
+     * @returns A promise that resolves to the authentication response.
+     */
+    signup(credentials: InferInput<typeof CreateUserSchema>): Promise<AuthResponse>;
+    /**
+     * Signs out the currently authenticated user.
+     * @returns A promise that resolves when the user is signed out.
+     */
+    signout(): Promise<void>;
+    /**
+     * Updates the authenticated user's data.
+     * @param data - The updated user data.
+     * @returns A promise that resolves to the updated user entity.
+     */
+    updateMe(data: InferInput<typeof AuthUpdateUserSchema>): Promise<UserEntity>;
+}

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

@@ -0,0 +1,65 @@
+import vine from "@vinejs/vine";
+import { SigninSchema, AuthUpdateUserSchema } from "../validators/auth";
+import { CreateUserSchema } from "../validators/users";
+import { ModelRepository } from "./repository";
+/**
+ * Represents a repository for managing user data.
+ * Extends the ModelRepository class.
+ */
+export class UserRepository 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) {
+        // 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) {
+        // 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() {
+        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 = vine.compile(AuthUpdateUserSchema);
+        const output = await validator.validate(data);
+        const res = await this.client.put(`/${this.resource}/auth`, output);
+        return res.data;
+    }
+}

package/build/src/feeef/validators/auth.js

@@ -0,0 +1,46 @@
+import vine from '@vinejs/vine';
+import { ImageFileSchema } from './helpers.js';
+export const PhoneShema = vine.string().regex(/^0(5|6|7)\d{8}$|^0(2)\d{7}$/);
+export const SignupSchema = vine.object({
+    name: vine.string().minLength(2).maxLength(32),
+    email: vine.string()
+    // .unique(async (db, value, field) => {
+    //   const user = await db.from('users').where('email', value).first()
+    //   return !user
+    // })
+    ,
+    phone: PhoneShema
+        // .unique(async (db, value, field) => {
+        //   const user = await db.from('users').where('phone', value).first()
+        //   return !user
+        // })
+        .optional(),
+    photoFile: ImageFileSchema.optional(),
+    photoUrl: vine.string().optional(),
+    password: vine.string().minLength(8).maxLength(32),
+});
+export const SigninSchema = vine.object({
+    email: vine.string().email(),
+    password: vine.string().minLength(8).maxLength(32),
+});
+export const AuthUpdateUserSchema = vine.object({
+    name: vine.string().minLength(2).maxLength(32).optional(),
+    email: vine
+        .string()
+        // .unique(async (db, value, field) => {
+        //   const user = await db.from('users').where('email', value).first()
+        //   return !user
+        // })
+        .optional(),
+    phone: PhoneShema.optional(),
+    // for upload file
+    photoFile: vine
+        // .file({
+        //   size: '1mb',
+        //   extnames: ['jpg', 'jpeg', 'png', 'gif', 'webp'],
+        // })
+        .any(),
+    photoUrl: vine.string().optional(),
+    oldPassword: vine.string().minLength(8).maxLength(32).optional(),
+    newPassword: vine.string().minLength(8).maxLength(32).notSameAs('oldPassword').optional(),
+});

package/build/src/feeef/validators/custom/datetime.d.ts

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

package/build/src/feeef/validators/custom/datetime.js

@@ -0,0 +1,7 @@
+// import { FieldContext } from '@vinejs/compiler/types'
+// import vine from '@vinejs/vine'
+export {};
+// type Options = {}
+// // custom rule (datetime ISO 8601)
+// async function datetime(value: unknown, options: Options, field: FieldContext) {}
+// export const datetimeRule = vine.createRule(datetime)

package/build/src/feeef/validators/helpers.js

@@ -0,0 +1,65 @@
+import vine from "@vinejs/vine";
+export const AvatarFileSchema = vine.any();
+// .file({
+//   size: '1mb',
+//   extnames: ['jpg', 'jpeg', 'png', 'gif', 'webp'],
+// })
+export const ImageFileSchema = vine.any();
+// .file({
+//   size: '1mb',
+//   extnames: ['jpg', 'jpeg', 'png', 'gif', 'webp'],
+// })
+export const DomainSchema = vine.object({
+    name: vine.string().minLength(3).maxLength(32),
+    verifiedAt: vine.date().optional(),
+    metadata: vine.object({}).optional(),
+});
+// decoration
+export const StoreDecorationSchema = vine.object({
+    primary: vine.number().min(0x0).max(0xffffffff),
+    onPrimary: vine.number().min(0x0).max(0xffffffff),
+    showStoreLogoInHeader: vine.boolean().optional(),
+    logoFullHeight: vine.boolean().optional(),
+    showStoreNameInHeader: vine.boolean().optional(),
+    metadata: vine.any().optional(),
+});
+// export const EmbaddedImageSchema = vine.object({
+//   url: vine.string().url(),
+//   alt: vine.string().optional(),
+//   width: vine.number().optional(),
+//   height: vine.number().optional(),
+// })
+export const 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(),
+});
+export const 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(),
+});
+export const EmbaddedContactSchema = vine.object({
+    type: vine.string().minLength(2).maxLength(32),
+    value: vine.string().minLength(2).maxLength(255),
+    metadata: vine.object({}).optional(),
+});
+export const ContactSchema = vine.object({
+    type: vine.string().minLength(2).maxLength(32),
+    value: vine.string().minLength(2).maxLength(255),
+    metadata: vine.object({}).optional(),
+});
+// StoreBunner
+export const StoreBunner = vine.object({
+    url: vine.string().url().optional(),
+    title: vine.string(),
+    enabled: vine.boolean().optional(),
+    metadata: vine.object({}).optional(),
+});

package/build/src/feeef/validators/order.js

@@ -0,0 +1,84 @@
+// import { OrderStatus } from '#core/core'
+import vine from "@vinejs/vine";
+import { PhoneShema } from "./auth.js";
+import { OrderStatus } from "../../core/core.js";
+export const OrderItemSchema = vine.object({
+    productId: vine.string(),
+    // productId: vine.string().exists(async (db, value, field) => {
+    //   const product = await db.from('products').where('id', value).first()
+    //   return !!product
+    // }),
+    productName: vine.string().optional(),
+    variant: vine.any().optional(),
+    quantity: vine.number(),
+    price: vine.number().optional(),
+});
+export const GuestOrderItemSchema = vine.object({
+    productId: vine.string(),
+    variantPath: vine.string().optional(),
+    quantity: vine.number(),
+});
+export const SendOrderSchema = vine.object({
+    id: vine.string().optional(),
+    customerName: vine.string().optional(),
+    customerPhone: vine.string(),
+    //   customerIp: vine.string().optional(),
+    shippingAddress: vine.string().optional(),
+    shippingCity: vine.string().optional(),
+    shippingState: vine.string().optional(),
+    shippingMethodId: vine.string().optional(),
+    paymentMethodId: vine.string().optional(),
+    items: vine.array(GuestOrderItemSchema).minLength(1),
+    //   subtotal: vine.number().optional(),
+    //   shippingPrice: vine.number().optional(),
+    //   total: vine.number().optional(),
+    //   discount: vine.number().optional(),
+    coupon: vine.string().optional(),
+    status: vine.enum(["pending", "draft"]),
+    // TODO: validate storeId is exists and not blocked
+    storeId: vine.string(),
+    metadata: vine.any().optional(),
+});
+/// store owner section
+// CreateOrderSchema
+export const CreateOrderSchema = vine.object({
+    id: vine.string().optional(),
+    customerName: vine.string().optional(),
+    customerPhone: PhoneShema,
+    customerIp: vine.string().optional(),
+    shippingAddress: vine.string().optional(),
+    shippingCity: vine.string().optional(),
+    shippingState: vine.string().optional(),
+    shippingMethodId: vine.string().optional(),
+    paymentMethodId: vine.string().optional(),
+    items: vine.array(OrderItemSchema).minLength(1),
+    subtotal: vine.number().optional(),
+    shippingPrice: vine.number().optional(),
+    total: vine.number().optional(),
+    discount: vine.number().optional(),
+    coupon: vine.string().optional(),
+    status: vine.enum(OrderStatus),
+    storeId: vine.string(),
+    metadata: vine.any().optional(),
+});
+// UpdateOrderSchema
+export const UpdateOrderSchema = vine.object({
+    id: vine.string().optional(),
+    customerName: vine.string().optional(),
+    customerPhone: PhoneShema.optional(),
+    customerIp: vine.string().optional(),
+    shippingAddress: vine.string().optional(),
+    shippingCity: vine.string().optional(),
+    shippingState: vine.string().optional(),
+    shippingMethodId: vine.string().optional(),
+    paymentMethodId: vine.string().optional(),
+    items: vine.array(OrderItemSchema).minLength(1).optional(),
+    subtotal: vine.number().optional(),
+    shippingPrice: vine.number().optional(),
+    total: vine.number().optional(),
+    discount: vine.number().optional(),
+    coupon: vine.string().optional(),
+    status: vine.enum(OrderStatus).optional(),
+    storeId: vine.string(),
+    metadata: vine.any().optional(),
+});

package/build/src/feeef/validators/product.js

@@ -0,0 +1,92 @@
+// import { ProductStatus } from '#models/product'
+import vine from "@vinejs/vine";
+import { EmbaddedCategorySchema, ImageFileSchema } from "./helpers.js";
+import { ProductStatus } from "../../core/core.js";
+// import Store from '#models/store'
+export const ProductVariantOptionSchema = vine.object({
+    name: vine.string().minLength(1).maxLength(32),
+    sku: vine.string().optional(),
+    price: vine.number().min(0).max(1000000).optional().nullable(),
+    discount: vine.number().min(0).max(1000000).optional().nullable(),
+    stock: vine.number().min(0).max(1000000).optional().nullable(),
+    sold: vine.number().min(0).max(1000000).optional().nullable(),
+    child: vine.any().optional().nullable(),
+});
+export const ProductVariantSchema = vine
+    .object({
+    name: vine.string().minLength(1).maxLength(32),
+    options: vine.array(ProductVariantOptionSchema),
+})
+    .optional();
+export const CreateProductSchema = vine.object({
+    slug: vine
+        .string()
+        .regex(/^[a-z0-9-]+$/)
+        .minLength(2)
+        .maxLength(32),
+    // .unique(async (db, value, field) => {
+    //   const product = await db.from('products').where('slug', value).first()
+    //   return !product
+    // }),
+    sku: vine.string().optional(),
+    decoration: vine.object({}).optional(),
+    name: vine.string().minLength(2).maxLength(32),
+    photoUrl: vine.string().optional(),
+    photoFile: ImageFileSchema.optional(),
+    media: vine.array(vine.string()).optional(),
+    mediaFiles: vine.array(ImageFileSchema).optional(),
+    // storeId must exist in the database
+    storeId: vine.string(),
+    // .exists(async (db, value, field) => {
+    //   return !!field.meta.store && (field.meta.store as Store).userId === field.meta.userId
+    // }),
+    category: EmbaddedCategorySchema.optional(),
+    title: vine.string().minLength(2).maxLength(255),
+    description: vine.string().minLength(2).maxLength(255).optional(),
+    body: vine.string().minLength(2).maxLength(1000).optional(),
+    price: vine.number().min(0).max(1000000),
+    discount: vine.number().min(0).max(1000000).optional(),
+    stock: vine.number().min(0).max(1000000).optional(),
+    variant: ProductVariantSchema,
+    metadata: vine.object({}).optional(),
+    status: vine.enum(ProductStatus),
+    verifiedAt: vine.date().optional(),
+    blockedAt: vine.date().optional(),
+});
+export const UpdateProductSchema = vine.object({
+    slug: vine
+        .string()
+        .regex(/^[a-z0-9-]+$/)
+        .minLength(2)
+        .maxLength(32)
+        // .unique(async (db, value, field) => {
+        //   const product = await db.from('products').where('slug', value).first()
+        //   return !product
+        // })
+        .optional(),
+    sku: vine.string().optional(),
+    decoration: vine.object({}).optional(),
+    name: vine.string().minLength(2).maxLength(32).optional(),
+    photoUrl: vine.string().optional(),
+    photoFile: ImageFileSchema.optional(),
+    media: vine.array(vine.string()).optional(),
+    mediaFiles: vine.array(ImageFileSchema).optional(),
+    // storeId must exist in the database
+    storeId: vine.string(),
+    // .exists(async (db, value, field) => {
+    //   return !!field.meta.store && (field.meta.store as Store).userId === field.meta.userId
+    // })
+    // .optional(),
+    category: EmbaddedCategorySchema.optional(),
+    title: vine.string().minLength(2).maxLength(255).optional(),
+    description: vine.string().minLength(2).maxLength(255).optional(),
+    body: vine.string().minLength(2).maxLength(1000).optional(),
+    price: vine.number().min(0).max(1000000).optional(),
+    discount: vine.number().min(0).max(1000000).optional(),
+    stock: vine.number().min(0).max(1000000).optional(),
+    variant: ProductVariantSchema,
+    metadata: vine.object({}).optional(),
+    status: vine.enum(ProductStatus).optional(),
+    verifiedAt: vine.date().optional(),
+    blockedAt: vine.date().optional(),
+});