@salla.sa/twilight 1.0.18 → 1.6.13

package/types/api/loyalty.d.ts

@@ -0,0 +1,226 @@
+import { SuccessResponse } from '../common'
+
+
+export interface Loyalty {
+    id: number;
+    name: string;
+    description: string;
+    image: string;
+    points_validity_by: null;
+    points_validity_value: null;
+    prize_promotion_title: string;
+    prize_promotion_description: string;
+    prize_promotion_logo: string;
+    customer: Customer;
+    points: Point[];
+    prizes: Prize[];
+}
+
+export interface Customer {
+    id: number;
+    currency: string;
+    language: string;
+    first_name: string;
+    last_name: string;
+    phone: Phone;
+    email: string;
+    avatar: string;
+    gender: string;
+    birthday: Date;
+    loyalty_program_points: number;
+}
+
+export interface Phone {
+    code: string;
+    number: number;
+    country: string;
+}
+
+export interface Point {
+    id: number;
+    key: string;
+    name: string;
+    description: string;
+    points: number;
+    icon: number;
+    color: number;
+    is_completed: boolean;
+    target_url: string;
+    share_store_url: string;
+    conditions: Condition[];
+}
+
+export interface Condition {
+    key: string;
+    points: number;
+    condition: null | string;
+    value?: 'fixed_amount' | 'total_order';
+    op: string;
+}
+
+export interface Prize {
+    type: string | 'free_shipping' | 'free_product' | 'coupon';
+    title: string;
+    items: Item[];
+}
+
+export interface Item {
+    id: number;
+    key: string;
+    name: string;
+    description: string;
+    image: string;
+    cost_points: number;
+    coupon_type: null | string;
+    coupon_amount: string;
+    coupon_maximum_amount: string;
+    included_category_ids: number[];
+    order_minimum_amount: string;
+    product_id: number | null;
+    use_product_image: number;
+    free_shipping_maximum_amount: string;
+    free_shipping_terms_apply: boolean;
+    prize_url: string;
+}
+
+/**
+ * Loyalty exchange Points
+ */
+export interface ExchangePoint {
+    message: string;
+    cart: Cart;
+}
+
+export interface Cart {
+    items: ExchangeItem[];
+    require_shipping: boolean;
+    cart_total: CartTotal;
+    total_before_discount: CartTotal;
+    coupon: null;
+    free_shipping: FreeShipping;
+    loyalty_program: LoyaltyProgram;
+}
+
+export interface CartTotal {
+    amount: number;
+    currency: Currency;
+}
+
+export enum Currency {
+    Sar = "SAR",
+}
+
+export interface FreeShipping {
+    remaining_to_free_shipping: null;
+    has_free_shipping: boolean;
+}
+
+export interface ExchangeItem {
+    id: number;
+    url: string;
+    quantity: number;
+    product_id: number;
+    notes: null | string;
+    name: string;
+    price: CartTotal;
+    sale_price: CartTotal;
+    has_special_price: boolean;
+    regular_price: CartTotal;
+    image: string;
+    type: string;
+    hide_quantity: boolean;
+    features: Features;
+    discount_details: DiscountDetails | null;
+    max_items_per_user: number;
+    active_advance: boolean;
+    weight_label: string;
+    uploaded_files: any[];
+    options: Option[];
+    selected_options: SelectedOption[];
+    skus: any[];
+}
+
+export interface DiscountDetails {
+    discount: number;
+    item_total_price: CartTotal;
+    offer_type: null;
+    has_free_items: boolean;
+    offer_items_count: number;
+    special_price: CartTotal;
+    is_free: boolean;
+    name: string;
+}
+
+export interface Features {
+    upload_file: boolean;
+    note: boolean;
+}
+
+export interface Option {
+    id: number;
+    name: string;
+    description: string;
+    type: string;
+    required: boolean;
+    associated_with_order_time: number;
+    availability_range: boolean;
+    not_same_day_order: boolean;
+    choose_date_time: null;
+    from_date_time: null;
+    to_date_time: null;
+    sort: number;
+    advance: boolean;
+    display_type: null;
+    visibility: string;
+    translations: Object;
+    values: ValueElement[];
+}
+
+export interface ValueElement {
+    id: number;
+    name: string;
+    price: CartTotal;
+    display_value: null;
+    advance: boolean;
+    option_id: number;
+    image_url: null;
+    hashed_display_value: null;
+    translations: Object;
+}
+
+export interface SelectedOption {
+    id: number;
+    value: string[] | number;
+}
+
+export interface LoyaltyProgram {
+    points: number;
+    prize: ExchangePrize;
+}
+
+export interface ExchangePrize {
+    id: number;
+    name: string;
+    discount_amount: number;
+    points: number;
+}
+
+
+export namespace LoyaltyApiResponse {
+
+    export interface program extends SuccessResponse {
+        data: Loyalty
+    }
+
+
+    export interface point extends SuccessResponse {
+        data: ExchangePoint
+    }
+}
+
+
+export default interface LoyaltyApi {
+    getProgram: () => Promise<LoyaltyApiResponse.program>
+    exchange: (prize_id: number, cart_id?: number) => Promise<LoyaltyApiResponse.point>
+    reset: () => Promise<SuccessResponse>
+}

package/types/api/order.d.ts

@@ -0,0 +1,15 @@
+import {SuccessResponse} from "../common";
+
+export interface CreateCartFromOrderResponse extends SuccessResponse {
+    data: {
+        cart_id: number;
+        url: string;
+    };
+}
+
+export default interface OrderApi {
+    createCartFromOrder: (order_id?: number) => Promise<CreateCartFromOrderResponse>;
+    cancel: (order_id?: number) => Promise<SuccessResponse>;
+    sendInvoice: (order_id?: number) => Promise<SuccessResponse>;
+    show: (payload: { order_id: number, url: string }) => Promise<void>; //should be called from thank you page to trigger native order details page in apps
+}

package/types/api/product/index.d.ts

@@ -0,0 +1,17 @@
+import { SuccessResponse } from "../../common";
+import { ProductResponse } from "./response";
+import { ProductRequest } from "./request";
+
+export * from "./request";
+export * from "./response";
+
+export default interface ProductApi {
+    getPrice: (data: /*product_id*/number | ProductRequest.addItem) => Promise<ProductResponse.getPrice>;
+    availabilitySubscribe: (product_id: number | ProductRequest.availability) => Promise<SuccessResponse>;
+    search: (keyword: string | ProductRequest.search) => Promise<ProductResponse.search>;
+    categories: (categoryId?: number) => Promise<ProductResponse.categories>; //get all categories or sub_categories
+    offers: (product_id: number) => Promise<ProductResponse.offers>; //get all categories or sub_categories
+    getGiftDetails: (product_id: number) => Promise<ProductResponse.giftResponse>;
+    addGiftToCart: (product_id: number, payload: Object, withRedirect: boolean) => Promise<ProductResponse.giftToCart>;
+    uploadGiftImage: (multiPartData: FormData) => Promise<ProductResponse.giftImageUpload>;
+}

package/types/api/product/request.d.ts

@@ -0,0 +1,53 @@
+export interface Category {
+    id: string;
+    id_: number;
+    name: string;
+    url: string;
+    sub_categories: Category[];
+}
+
+export type ProductOption = { [key: number]: number | string | number[] };
+
+
+export interface Receiver {
+    name: string;
+    country_code: string;
+    mobile: string;
+}
+
+
+export namespace ProductRequest {
+    export interface addItem {
+        id: number;
+        quantity: 1 | number;
+        options?: ProductOption;
+    }
+
+    export interface search {
+        query: string;
+        type?: 'keyword' | 'tag';//default => 'keyword'
+        sort_by?: 'ourSuggest' | 'default' | 'bestSell' | 'topRated' | 'priceFromTopToLow' | 'priceFromLowToTop'; //default => 'ourSuggest'
+        per_page?: 32 | number;//max 50
+        brands?: number[];
+        categories?: number[];// max 5 ids
+        branches?: number[];// max 5 ids
+    }
+
+    export interface availability {
+        id: number;
+        //💡 Following properties required for guests
+        email?: string;//required when request without mobile
+        country_code?: string | 'SA';//required when request without email
+        phone?: string | '555555555';//required when request without email
+    }
+
+    export interface giftToCart {
+        text: string;
+        sender_name: string;
+        receiver: Receiver;
+        quantity: number;
+        deliver_at: string;
+        image_url: string;
+        time_zone: string;
+    }
+}

package/types/api/product/response.d.ts

@@ -0,0 +1,103 @@
+import {Category as ShortCategory, Product, SuccessResponse} from "../../common";
+import {Category} from "./request";
+type offerType = 'buy_x_get_y' | 'percentage' | 'fixed_amount';
+type paymentMethod = {
+    id: number;
+    slug: 'bank';
+    name: 'BankTransfer';
+};
+export interface SizeGuide {
+    name: string;
+    description: string;
+}
+export interface Offer {
+    id: number;
+    name: string;
+    message: string;
+    expiry_date: string | '2022-02-22 00:00:00';
+    formatted_date: string;
+    offer_type: offerType;
+    applied_to: 'order' | 'category' | 'product' | 'paymentMethod';
+    buy: {
+        type: 'product' | 'category';
+        quantity: number;
+        products?: Product[];
+        categories?: ShortCategory[];
+        min_amount?: number; //when offer_type != 'buy_x_get_y'
+        min_items?: number; //when offer_type != 'buy_x_get_y'
+        payment_methods: paymentMethod[];
+    };
+    get: {
+        products?: Product[];
+        categories?: ShortCategory[];
+        type: 'product' | 'category';
+        discount_type: 'free-product' | 'percentage';
+        quantity?: number;//when discount_type == 'percentage'
+        discount_amount?: number; //when offer_type != 'buy_x_get_y' or get.discount_type !='free-product'
+    }
+}
+
+/**
+ * Gifting System
+ */
+ export interface Gift {
+    quantity: number;
+    product: Product;
+    sender_name: string;
+    images: GiftImage[];
+    texts: GiftText[];
+}
+
+export interface GiftImage {
+    id: number;
+    url: string;
+}
+
+export interface GiftText {
+    id: number;
+    text: string;
+}
+
+export namespace ProductResponse {
+    export interface search extends SuccessResponse {
+        data: Product[];
+        cursor: {
+            current: number;
+            previous?: string;
+            next?: string;
+            count: number;
+        };
+    }
+
+    export interface getPrice extends SuccessResponse {
+        data: {
+            price: number;
+            regular_price: number;
+            has_sale_price: boolean;
+        }
+    }
+
+    export interface categories extends SuccessResponse {
+        data: Category | Category[]; //single category when getting subCategories by passing categoryId
+    }
+
+    export interface offers extends SuccessResponse {
+        data: Offer[] | [];
+    }
+
+    export interface sizeGuides extends SuccessResponse {
+        data: Array<SizeGuide>;
+    }
+
+    export interface giftResponse extends SuccessResponse {
+        data: Gift
+    }
+
+    export interface giftToCart extends SuccessResponse {
+        data: Object
+    }
+
+    export interface giftImageUpload extends SuccessResponse {
+        data: Object | String
+    }
+}

package/types/api/profile.d.ts

@@ -0,0 +1,50 @@
+import {SuccessResponse} from "../common";
+import {AuthRequest, VerificationStatus} from "./auth";
+
+export interface ProfileUpdatePayload {
+    first_name: string;
+    last_name: string;
+    birthday?: string | '2022-02-22';
+    gender?: 'male' | 'female';
+    avatar?: BinaryType;
+}
+
+export interface ProfileUpdateContactPayload {
+    phone?: string | number; //required if there is no email
+    country_code?: string | 'SA'; //required if there is phone
+    email?: string; //required if there is no phone
+}
+
+export interface ProfileResponse extends SuccessResponse {
+    data: {
+        id: number;
+        first_name: string;
+        last_name: string;
+        currency: string | 'SAR';
+        language: string | 'ar';
+        phone: {
+            code: string | "+966";
+            number: string | number;
+            country: string | "SA";
+        };
+        email: string;
+        avatar: string;
+        gender?: 'male' | 'female';
+        birthday: string | '2022-02-22';
+        verification?: VerificationStatus; //exists when trying to update email/phone
+    };
+}
+
+export interface VerifyContactResponse extends SuccessResponse {
+    data: {
+        message: string;
+        verification: VerificationStatus;
+    }
+}
+
+export default interface ProfileApi {
+    info: () => Promise<ProfileResponse>;
+    update: (data: ProfileUpdatePayload) => Promise<ProfileResponse>;
+    verify: (data: AuthRequest.verifyByMobile | AuthRequest.verifyByEmail) => Promise<VerifyContactResponse>;
+    updateContacts: (data: ProfileUpdateContactPayload) => Promise<ProfileResponse>;//need to verify after success event
+}

package/types/api/rating.d.ts

@@ -0,0 +1,49 @@
+import { Product, Rating, SuccessResponse} from "../common";
+
+export interface OrderDetailsResponse extends SuccessResponse {
+    data: {
+        id: number;
+        store?: { feedback: RatingContent };
+        shipping?: {
+            feedback: RatingContent;
+            company: {
+                id: number;
+                name: string;
+                logo?: string;
+            }
+        };
+        products: Array<{ feedback: RatingContent; product: Product; }>;
+        testimonials_enabled: boolean;
+        shipping_enabled: boolean;
+        products_enabled: boolean;
+        thanks_message: string;
+    }
+}
+
+export interface RatingContent {
+    content: string;
+    rating: Rating;
+    status?: 'approved' | 'pending';
+}
+
+export interface RatingStorePayload {
+    comment: string;
+    order_id: number;
+    rating: Rating;
+}
+
+export interface RatingProductsPayload {
+    products: Array<{ product_id: number; comment: string; rating: Rating; }>
+    order_id: number;
+}
+
+export interface RatingShippingPayload extends RatingStorePayload {
+    shipping_company_id: number;
+}
+
+export default interface RatingApi {
+    order: (order_id: number) => Promise<OrderDetailsResponse>;
+    store: (data: RatingStorePayload) => Promise<SuccessResponse>;
+    products: (data: RatingProductsPayload) => Promise<SuccessResponse>;
+    shipping: (data: RatingShippingPayload) => Promise<SuccessResponse>;
+}

package/types/api/scope.d.ts

@@ -0,0 +1,42 @@
+import { SuccessResponse } from "../common";
+
+export interface Scope {
+    id: number;
+    name: string;
+    selected: boolean;
+}
+
+export interface ProductAvailability {
+    name: string;
+    selected: boolean;
+    availability: Availability;
+}
+
+export interface Availability {
+    label: string;
+    key: string;
+    color: string;
+}
+
+
+export namespace ScopeApiResponse {
+
+    export interface scopeList extends SuccessResponse {
+        data: Scope[];
+    }
+
+    export interface scopeAddition extends SuccessResponse {
+        data: Scope
+    }
+
+    export interface availability extends SuccessResponse {
+        data: ProductAvailability[];
+    }
+}
+
+
+export default interface ScopeApi {
+    get: () => Promise<ScopeApiResponse.scopeList>
+    change: (payload: Object) => Promise<SuccessResponse>
+    getProductAvailability: (product_id: number) => Promise<ScopeApiResponse.availability>
+}

package/types/api/wishlist.d.ts

@@ -0,0 +1,7 @@
+import {SuccessResponse} from "../common";
+
+export default interface WishlistApi {
+    add: (product_id: number) => Promise<SuccessResponse>;
+    remove: (product_id: number) => Promise<SuccessResponse>;
+    toggle: (product_id: number) => Promise<SuccessResponse>;
+}

package/types/common.d.ts

@@ -0,0 +1,75 @@
+type ProductType = 'product' | 'service' | 'group_products' | 'codes' | 'digital' | 'food' | 'donating';
+type Rating = 1 | 2 | 3 | 4 | 5;
+type RequestError = Error & { response: any }
+type RequestErrorEvent = (callback: (error: RequestError | string) => void) => void;
+type RequestErrorEventWithData<data> = (callback: (error: RequestError | string, data) => void) => void;
+
+export interface Price {
+    amount: string;
+    currency: string;
+}
+
+export interface SuccessResponse {
+    status: 200;
+    success: true;
+    data: {
+        message?: string;
+        events?: { [event_name: string]: any };
+        [key: string]: any;
+    };
+}
+
+export interface ErrorResponse {
+    status: 422 | 404;
+    success: false;
+    error: {
+        message?: string | 'alert.invalid_fields';
+        code?: any;
+        case?: string | 'resend_counter' | 'invalid_code';
+        events?: { [event_name: string]: any };
+        fields?: { [field_name: string]: Array<string> };
+        [key: string]: any;
+    }
+}
+
+export interface Currency {
+    code: string | 'SAR';
+    name: string;
+    symbol: string;
+    amount?: number;
+    country_code?: string;
+}
+
+export interface Product {
+    id: number;
+    name: string;
+    type: ProductType;
+    promotion: {
+        title?: string;
+        sub_title?: string;
+    };
+    price: Price;
+    sale_price?: Price;
+    regular_price: Price;
+    has_special_price: boolean;
+    status: 'sale' | 'out';
+    is_available: boolean;
+    sku?: string;
+    currency: string | 'SAR';
+    url: string;
+    thumbnail: string;
+    calories?: number;
+}
+
+export interface Category {
+    id: number;
+    name: string;
+    url: string;
+}
+
+export interface RequestInfo {
+    endPoint: string;
+    method: string;
+    payload: any,
+    options: {},
+}

package/types/event/auth.d.ts

@@ -0,0 +1,18 @@
+import {AuthResponse} from "../api/auth";
+import {RequestError, SuccessResponse} from "../common";
+
+export default interface AuthEvent {
+    //Success Responses
+    onCodeSent: (callback: (response: AuthResponse.loginOrResendCode, type?: 'mobile' | 'email') => void) => void;
+    onVerified: (callback: (response: AuthResponse.verify, type?: 'mobile' | 'email') => void) => void;
+    onRegistered: (callback: (response: AuthResponse.verify) => void) => void;
+    onLoggedIn: (callback: (response: AuthResponse.verify) => void) => void;
+    onLoggedOut: (callback: (response: SuccessResponse) => void) => void;
+
+    //Error Responses
+    onCodeNotSent: (callback: (error: RequestError | string, type?: 'mobile' | 'email') => void) => void;
+    onVerificationFailed: (callback: (error: RequestError | string, type?: 'mobile' | 'email') => void) => void;
+    onRegistrationFailed: (callback: (error: RequestError) => void) => void;
+    onFailedLogout: (callback: (error: RequestError) => void) => void;
+    onRefreshFailed: (callback: (error: RequestError) => void) => void;
+}

package/types/event/cart.d.ts

@@ -0,0 +1,30 @@
+import {CartResponse, CartSummary} from "../api/cart";
+import { RequestError, SuccessResponse} from "../common";
+
+export default interface CartEvent {
+    // listeners
+    onUpdated: (callback: (cart_summary: CartSummary) => void) => void;
+    onItemAdded: (callback: (response: CartResponse.update, product_id: number) => void) => void;
+    onItemUpdated: (callback: (response: CartResponse.update, product_id: number) => void) => void;
+    onItemDeleted: (callback: (response: CartResponse.update, product_id: number) => void) => void;
+    onLatestFetched: (callback: (response: CartResponse.update) => void) => void;
+    onSubmitted: (callback: (response: CartResponse.status) => void) => void;
+    onImageDeleted: (callback: (response: SuccessResponse, file_id: number) => void) => void;
+    onDetailsFetched: (callback: (response: CartResponse.status) => void) => void;
+    onSuccessReset: (callback: () => void) => void;
+
+    //errors
+    onLatestFailed: (callback: (error: RequestError) => void) => void;
+    onItemUpdatedFailed: (callback: (error: RequestError | 'There is no "id"!', item_id?: number) => void) => void;
+    onItemAddedFailed: (callback: (error: RequestError | 'There is no product "id"!', product_id?: number) => void) => void;
+    onItemDeletedFailed: (callback: (error: RequestError | 'There is no "id"!', item_id?: number) => void) => void;
+    onSubmitFailed: (callback: (error: RequestError | "Can't find next_step );") => void) => void;
+    onImageNotDeleted: (callback: (error: RequestError | 'There is no "id"!', file_id?: number) => void) => void;
+    onDetailsNotFetched: (callback: (error: RequestError) => void) => void;
+
+    //coupons
+    onCouponAdded: (callback: (response: CartResponse.update, cart_id: number) => void) => void;
+    onCouponDeleted: (callback: (response: CartResponse.update, cart_id: number) => void) => void;
+    onCouponAdditionFailed: (callback: (error: RequestError, cart_id?: number) => void) => void;
+    onCouponDeletionFailed: (callback: (error: RequestError, cart_id?: number) => void) => void;
+}