bestraw-sdk 1.0.0

package/dist/index.d.cts

@@ -0,0 +1,509 @@
+interface BestrawConfig {
+    baseUrl: string;
+    apiToken?: string;
+    defaultLocale?: string;
+    getAuthToken?: () => string | null | Promise<string | null>;
+}
+declare class BestrawError extends Error {
+    status: number;
+    code?: string;
+    meta?: Record<string, unknown>;
+    details?: unknown;
+    constructor(status: number, message: string, details?: unknown);
+}
+interface RequestOptions extends RequestInit {
+    locale?: string;
+}
+declare class BaseClient {
+    protected baseUrl: string;
+    protected defaultLocale?: string;
+    private apiToken?;
+    private getAuthToken?;
+    constructor(config: BestrawConfig);
+    private headers;
+    private appendLocale;
+    request<T>(path: string, options?: RequestOptions): Promise<T>;
+}
+
+interface StrapiResponse<T> {
+    data: T;
+    meta?: {
+        pagination?: {
+            page: number;
+            pageSize: number;
+            pageCount: number;
+            total: number;
+        };
+    };
+}
+interface StrapiListResponse<T> {
+    data: T[];
+    meta?: {
+        pagination?: {
+            page: number;
+            pageSize: number;
+            pageCount: number;
+            total: number;
+        };
+    };
+}
+interface Picture {
+    id: number;
+    documentId: string;
+    url: string;
+    alternativeText?: string;
+    width?: number;
+    height?: number;
+    formats?: Record<string, {
+        url: string;
+        width: number;
+        height: number;
+    }>;
+}
+interface Sauce {
+    id?: number;
+    name: string;
+    description?: string;
+}
+interface Side {
+    id?: number;
+    name: string;
+    description?: string;
+}
+interface Field {
+    id?: number;
+    name: string;
+    value: string;
+}
+interface Meal {
+    id: number;
+    documentId: string;
+    name: string;
+    description: string;
+    price: number;
+    sortOrder: number;
+    available: boolean;
+    show: boolean;
+    pictures?: Picture[];
+    sauces?: Sauce[];
+    sides?: Side[];
+    fields?: Field[];
+    allergens?: number[];
+}
+interface Category {
+    id: number;
+    documentId: string;
+    name: string;
+    description?: string;
+    sortOrder: number;
+    picture?: Picture;
+    meals?: Meal[];
+}
+interface Variant {
+    id: number;
+    documentId: string;
+    name: string;
+    description?: string;
+    pictures?: Picture[];
+    categories?: Category[];
+}
+interface Menu {
+    id: number;
+    documentId: string;
+    name: string;
+    description?: string;
+    variants?: Variant[];
+    activeVariant?: Variant;
+}
+type CreateMenuInput = Pick<Menu, 'name'> & Partial<Pick<Menu, 'description'>>;
+type UpdateMenuInput = Partial<Pick<Menu, 'name' | 'description'>>;
+type CreateVariantInput = Pick<Variant, 'name'> & Partial<Pick<Variant, 'description'>> & {
+    menu: string;
+};
+type UpdateVariantInput = Partial<Pick<Variant, 'name' | 'description'>>;
+type CreateCategoryInput = Pick<Category, 'name'> & Partial<Pick<Category, 'description'>> & {
+    variant: string;
+};
+type UpdateCategoryInput = Partial<Pick<Category, 'name' | 'description' | 'sortOrder'>>;
+type CreateMealInput = Pick<Meal, 'name' | 'description' | 'price'> & {
+    category: string;
+    available?: boolean;
+    show?: boolean;
+    sauces?: Sauce[];
+    sides?: Side[];
+    fields?: Field[];
+    allergens?: number[];
+};
+type UpdateMealInput = Partial<Omit<Meal, 'id' | 'documentId' | 'pictures'>>;
+interface Customer {
+    documentId: string;
+    phone?: string;
+    email?: string;
+    name?: string;
+    locale?: string;
+    lastSeenAt?: string;
+    metadata?: Record<string, any>;
+}
+type UpdateCustomerInput = Partial<Pick<Customer, 'name' | 'locale'>>;
+type OrderStatus = 'pending' | 'confirmed' | 'preparing' | 'ready' | 'completed' | 'cancelled';
+type OrderType = 'dine-in' | 'takeaway';
+interface OrderItem {
+    mealDocumentId: string;
+    mealName: string;
+    quantity: number;
+    unitPrice: number;
+    totalPrice: number;
+    selectedSauces?: string[];
+    selectedSides?: string[];
+    specialInstructions?: string;
+}
+interface Order {
+    documentId: string;
+    orderNumber: string;
+    status: OrderStatus;
+    type: OrderType;
+    tableNumber?: string;
+    customer?: Customer;
+    items: OrderItem[];
+    subtotal: number;
+    discount?: number;
+    discountLabel?: string;
+    rewardIndex?: number;
+    tax: number;
+    total: number;
+    notes?: string;
+    estimatedReadyAt?: string;
+    confirmedAt?: string;
+    completedAt?: string;
+    cancelledAt?: string;
+    cancelReason?: string;
+    createdAt: string;
+}
+interface CreateOrderInput {
+    items: Array<{
+        mealDocumentId: string;
+        quantity: number;
+        selectedSauces?: string[];
+        selectedSides?: string[];
+        specialInstructions?: string;
+    }>;
+    type: OrderType;
+    tableNumber?: string;
+    notes?: string;
+    rewardIndex?: number;
+}
+interface OrderSettings {
+    orderingEnabled: boolean;
+    takeawayEnabled: boolean;
+    dineInEnabled: boolean;
+    taxRate: number;
+    estimatedPrepMinutes: number;
+    autoConfirm: boolean;
+    maxActiveOrders: number;
+}
+interface PublicOrderSettings {
+    orderingEnabled: boolean;
+    takeawayEnabled: boolean;
+    dineInEnabled: boolean;
+    estimatedPrepMinutes: number;
+}
+type PaymentStatus = 'pending' | 'processing' | 'succeeded' | 'failed' | 'refunded' | 'partially_refunded';
+interface Payment {
+    documentId: string;
+    stripePaymentIntentId: string;
+    stripeClientSecret?: string;
+    status: PaymentStatus;
+    amount: number;
+    currency: string;
+    refundedAmount: number;
+    metadata?: Record<string, any>;
+    failureMessage?: string;
+    order?: Order;
+}
+type LoyaltyTier = 'bronze' | 'silver' | 'gold';
+interface LoyaltyReward {
+    name: string;
+    description?: string;
+    pointsCost: number;
+    type: 'free-item' | 'discount-percent' | 'discount-fixed';
+    value?: number;
+    mealDocumentId?: string;
+    active: boolean;
+}
+interface LoyaltyProgram {
+    enabled: boolean;
+    pointsPerEuro: number;
+    rewards?: LoyaltyReward[];
+}
+interface LoyaltyAccount {
+    documentId: string;
+    customer?: Customer;
+    points: number;
+    totalPointsEarned: number;
+    totalPointsRedeemed: number;
+    tier: LoyaltyTier;
+}
+interface LoyaltyTransaction {
+    documentId: string;
+    type: 'earn' | 'redeem' | 'adjust' | 'expire';
+    points: number;
+    description?: string;
+    orderDocumentId?: string;
+    rewardDocumentId?: string;
+    createdAt: string;
+}
+interface Address {
+    street: string;
+    city: string;
+    postalCode: string;
+    country: string;
+    lat?: number;
+    lng?: number;
+}
+interface SocialLink {
+    platform: string;
+    url: string;
+}
+interface TimeSlot {
+    dayOfWeek: number;
+    openTime: string;
+    closeTime: string;
+    label?: string;
+}
+interface Closure {
+    date: string;
+    reason?: string;
+}
+interface RestaurantInfo {
+    name: string;
+    description?: string;
+    logo?: Picture;
+    coverImage?: Picture;
+    phone?: string;
+    email?: string;
+    website?: string;
+    address?: Address;
+    socialLinks?: SocialLink[];
+    timezone: string;
+    currency: string;
+    locale: string;
+}
+interface OpeningHours {
+    slots?: TimeSlot[];
+    specialClosures?: Closure[];
+}
+interface RestaurantStatus {
+    isOpen: boolean;
+    closureReason?: string;
+    todaySlots: Array<{
+        openTime: string;
+        closeTime: string;
+    }>;
+    nextOpenSlot?: {
+        dayOfWeek: number;
+        openTime: string;
+    };
+}
+interface Theme {
+    primaryColor: string;
+    accentColor: string;
+    fontFamily: string;
+    darkMode: boolean;
+    favicon?: Picture;
+    customCSS?: string;
+}
+interface BlogArticle {
+    documentId: string;
+    title: string;
+    slug: string;
+    excerpt?: string;
+    content?: string;
+    coverImage?: Picture;
+    published: boolean;
+    featured: boolean;
+    category?: BlogCategory;
+    tags?: string[];
+    authorName?: string;
+    readingTime?: number;
+    publishDate?: string;
+    seo?: {
+        metaTitle?: string;
+        metaDescription?: string;
+        metaKeywords?: string;
+    };
+    createdAt: string;
+    updatedAt: string;
+}
+interface BlogCategory {
+    documentId: string;
+    name: string;
+    slug: string;
+    description?: string;
+}
+
+declare class MenuNamespace {
+    private client;
+    constructor(client: BaseClient);
+    getMenus(locale?: string): Promise<Menu[]>;
+    getMenu(documentId: string, options?: {
+        populate?: string;
+        locale?: string;
+    }): Promise<Menu>;
+    createMenu(data: CreateMenuInput, locale?: string): Promise<Menu>;
+    updateMenu(documentId: string, data: UpdateMenuInput, locale?: string): Promise<Menu>;
+    deleteMenu(documentId: string): Promise<void>;
+    getVariants(menuDocumentId: string, locale?: string): Promise<Variant[]>;
+    getActiveVariant(menuDocumentId: string, locale?: string): Promise<Variant>;
+    setActiveVariant(menuDocumentId: string, variantDocumentId: string): Promise<void>;
+    createVariant(data: CreateVariantInput, locale?: string): Promise<Variant>;
+    updateVariant(documentId: string, data: UpdateVariantInput, locale?: string): Promise<Variant>;
+    deleteVariant(documentId: string): Promise<void>;
+    createCategory(data: CreateCategoryInput, locale?: string): Promise<Category>;
+    updateCategory(documentId: string, data: UpdateCategoryInput, locale?: string): Promise<Category>;
+    deleteCategory(documentId: string): Promise<void>;
+    sortCategories(variantDocumentId: string, sortedCategoryIds: string[]): Promise<void>;
+    createMeal(data: CreateMealInput, locale?: string): Promise<Meal>;
+    updateMeal(documentId: string, data: UpdateMealInput, locale?: string): Promise<Meal>;
+    deleteMeal(documentId: string): Promise<void>;
+    sortMeals(categoryDocumentId: string, sortedMealIds: string[]): Promise<void>;
+    uploadPicture(file: File | Blob, ref: string, refId: string, field: string): Promise<Picture[]>;
+    deletePicture(pictureId: number): Promise<void>;
+}
+
+declare class RestaurantNamespace {
+    private client;
+    constructor(client: BaseClient);
+    getInfo(locale?: string): Promise<RestaurantInfo>;
+    updateInfo(data: Partial<RestaurantInfo>, locale?: string): Promise<RestaurantInfo>;
+    getHours(): Promise<OpeningHours>;
+    getStatus(): Promise<RestaurantStatus>;
+    updateHours(data: Partial<OpeningHours>): Promise<OpeningHours>;
+    getTheme(): Promise<Theme>;
+    updateTheme(data: Partial<Theme>): Promise<Theme>;
+}
+
+declare class CustomerNamespace {
+    private client;
+    constructor(client: BaseClient);
+    requestOtp(phone: string): Promise<{
+        message: string;
+    }>;
+    verifyOtp(phone: string, code: string): Promise<{
+        token: string;
+        customer: Customer;
+    }>;
+    requestEmailOtp(email: string): Promise<{
+        message: string;
+    }>;
+    verifyEmailOtp(email: string, code: string): Promise<{
+        token: string;
+        customer: Customer;
+    }>;
+    getMe(): Promise<Customer>;
+    updateMe(data: UpdateCustomerInput): Promise<Customer>;
+}
+
+declare class OrderingNamespace {
+    private client;
+    constructor(client: BaseClient);
+    createOrder(data: CreateOrderInput): Promise<Order>;
+    getMyOrders(): Promise<Order[]>;
+    getMyOrder(documentId: string): Promise<Order>;
+    cancelOrder(documentId: string, reason?: string): Promise<Order>;
+    getOrders(query?: Record<string, unknown>): Promise<Order[]>;
+    getOrder(documentId: string): Promise<Order>;
+    updateOrderStatus(documentId: string, status: OrderStatus): Promise<Order>;
+    getActiveOrders(): Promise<Order[]>;
+    getPublicOrderSettings(): Promise<PublicOrderSettings>;
+    getOrderSettings(): Promise<OrderSettings>;
+    updateOrderSettings(data: Partial<OrderSettings>): Promise<OrderSettings>;
+}
+
+declare class PaymentNamespace {
+    private client;
+    constructor(client: BaseClient);
+    createPaymentIntent(orderDocumentId: string): Promise<{
+        clientSecret: string;
+        paymentId: string;
+    }>;
+    getPayment(documentId: string): Promise<Payment>;
+    refundPayment(documentId: string, amount?: number): Promise<Payment>;
+}
+
+declare class LoyaltyNamespace {
+    private client;
+    constructor(client: BaseClient);
+    getMyAccount(): Promise<LoyaltyAccount>;
+    getMyTransactions(): Promise<LoyaltyTransaction[]>;
+    redeemReward(rewardIndex: number): Promise<LoyaltyTransaction>;
+    getProgram(): Promise<LoyaltyProgram>;
+    getAccounts(): Promise<LoyaltyAccount[]>;
+    adjustPoints(accountDocumentId: string, points: number, description: string): Promise<LoyaltyTransaction>;
+}
+
+declare class BlogNamespace {
+    private client;
+    constructor(client: BaseClient);
+    getArticles(options?: {
+        category?: string;
+        tag?: string;
+        featured?: boolean;
+        page?: number;
+        pageSize?: number;
+        locale?: string;
+    }): Promise<BlogArticle[]>;
+    getArticle(slug: string, locale?: string): Promise<BlogArticle>;
+    getCategories(locale?: string): Promise<BlogCategory[]>;
+}
+
+declare class BestrawClient extends BaseClient {
+    readonly menu: MenuNamespace;
+    readonly restaurant: RestaurantNamespace;
+    readonly customer: CustomerNamespace;
+    readonly ordering: OrderingNamespace;
+    readonly payment: PaymentNamespace;
+    readonly loyalty: LoyaltyNamespace;
+    readonly blog: BlogNamespace;
+    constructor(config: BestrawConfig);
+}
+
+declare const ErrorCode: {
+    readonly UNKNOWN: "UNKNOWN";
+    readonly NETWORK_ERROR: "NETWORK_ERROR";
+    readonly AUTH_REQUIRED: "AUTH_REQUIRED";
+    readonly INVALID_PHONE: "INVALID_PHONE";
+    readonly INVALID_EMAIL: "INVALID_EMAIL";
+    readonly NO_ACTIVE_SESSION: "NO_ACTIVE_SESSION";
+    readonly OTP_EXPIRED: "OTP_EXPIRED";
+    readonly OTP_TOO_MANY_ATTEMPTS: "OTP_TOO_MANY_ATTEMPTS";
+    readonly OTP_INVALID: "OTP_INVALID";
+    readonly INVALID_TOKEN: "INVALID_TOKEN";
+    readonly ORDER_DISABLED: "ORDER_DISABLED";
+    readonly TAKEAWAY_DISABLED: "TAKEAWAY_DISABLED";
+    readonly DINEIN_DISABLED: "DINEIN_DISABLED";
+    readonly MAX_ORDERS_REACHED: "MAX_ORDERS_REACHED";
+    readonly EMPTY_ORDER: "EMPTY_ORDER";
+    readonly MEAL_NOT_FOUND: "MEAL_NOT_FOUND";
+    readonly MEAL_UNAVAILABLE: "MEAL_UNAVAILABLE";
+    readonly ORDER_NOT_FOUND: "ORDER_NOT_FOUND";
+    readonly INVALID_STATUS_TRANSITION: "INVALID_STATUS_TRANSITION";
+    readonly CANNOT_CANCEL_ORDER: "CANNOT_CANCEL_ORDER";
+    readonly PAYMENT_ORDER_NOT_FOUND: "PAYMENT_ORDER_NOT_FOUND";
+    readonly PAYMENT_INVALID_ORDER_STATUS: "PAYMENT_INVALID_ORDER_STATUS";
+    readonly PAYMENT_NOT_FOUND: "PAYMENT_NOT_FOUND";
+    readonly PAYMENT_CANNOT_REFUND: "PAYMENT_CANNOT_REFUND";
+    readonly PAYMENT_FAILED: "PAYMENT_FAILED";
+    readonly LOYALTY_ACCOUNT_NOT_FOUND: "LOYALTY_ACCOUNT_NOT_FOUND";
+    readonly REWARD_NOT_FOUND: "REWARD_NOT_FOUND";
+    readonly REWARD_INACTIVE: "REWARD_INACTIVE";
+    readonly NOT_ENOUGH_POINTS: "NOT_ENOUGH_POINTS";
+};
+type ErrorCodeValue = (typeof ErrorCode)[keyof typeof ErrorCode];
+declare class AppError extends Error {
+    readonly code: ErrorCodeValue;
+    readonly statusCode: number;
+    readonly meta?: Record<string, unknown>;
+    constructor(code: ErrorCodeValue, statusCode: number, message: string, meta?: Record<string, unknown>);
+}
+
+export { type Address, AppError, BaseClient, BestrawClient, type BestrawConfig, BestrawError, type BlogArticle, type BlogCategory, BlogNamespace, type Category, type Closure, type CreateCategoryInput, type CreateMealInput, type CreateMenuInput, type CreateOrderInput, type CreateVariantInput, type Customer, CustomerNamespace, ErrorCode, type ErrorCodeValue, type Field, type LoyaltyAccount, LoyaltyNamespace, type LoyaltyProgram, type LoyaltyReward, type LoyaltyTier, type LoyaltyTransaction, type Meal, type Menu, MenuNamespace, type OpeningHours, type Order, type OrderItem, type OrderSettings, type OrderStatus, type OrderType, OrderingNamespace, type Payment, PaymentNamespace, type PaymentStatus, type Picture, type PublicOrderSettings, type RestaurantInfo, RestaurantNamespace, type RestaurantStatus, type Sauce, type Side, type SocialLink, type StrapiListResponse, type StrapiResponse, type Theme, type TimeSlot, type UpdateCategoryInput, type UpdateCustomerInput, type UpdateMealInput, type UpdateMenuInput, type UpdateVariantInput, type Variant };