@salla.sa/twilight 1.6.15 → 2.0.0

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

@@ -1,42 +0,0 @@
-export namespace AuthRequest {
-    export interface loginByMobile {
-        phone: string;
-        type: 'mobile';
-        country_code: string | 'SA';
-    }
-
-    export interface loginByEmail {
-        email: string;
-        type: 'email';
-    }
-
-    export interface verifyByEmail {
-        type: 'email';
-        code: string;
-        email: string;
-    }
-
-    export interface verifyByMobile {
-        type: 'mobile';
-        code: string;
-        phone: string;
-        country_code: string | "SA";
-    }
-
-    export interface register {
-        first_name: string;
-        last_name: string;
-        phone: string;
-        country_code: string | 'SA';
-        verified_by: 'email' | 'phone';
-        email?: string;
-        code: number;
-    }
-
-    export interface resend {
-        type: 'mobile' | 'email';
-        phone?: string;
-        country_code?: string | "SA";
-        email?: string;
-    }
-}

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

@@ -1,22 +0,0 @@
-import {SuccessResponse} from "../../common";
-
-export type VerificationStatus = {
-    type: 'mobile' | 'email';
-    status: 'success' | 'pending' | 'failed';
-}
-export namespace AuthResponse {
-    export interface verify extends SuccessResponse {
-        data: {
-            case: 'authenticated' | 'new_customer';
-            redirect_url?: string;
-            token?: string;
-            verification?: VerificationStatus;
-        }
-    }
-
-    export interface loginOrResendCode extends SuccessResponse {
-        data: {
-            resend_counter?: 2 | 3 | 4;//when resend code
-        }
-    }
-}

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

@@ -1,24 +0,0 @@
-export * from "./request";
-export * from "./response";
-import {SuccessResponse} from "../../common";
-import {CartResponse} from "./response";
-import {CartRequest} from "./request";
-
-export default interface CartApi {
-    latest: () => Promise<CartResponse.update>;
-    details: () => Promise<CartResponse.update>;
-    quickAdd: (/*product_id*/id: number) => Promise<CartResponse.update>;
-    addItem: (data: CartRequest.addItem) => Promise<CartResponse.update>;
-    deleteItem: (item_id: number) => Promise<CartResponse.update>;
-    updateItem: (data: CartRequest.addItem) => Promise<CartResponse.update>;
-    deleteImage: (file_id: number) => Promise<SuccessResponse>;
-    status: () => Promise<CartResponse.status>;
-    reset: () => void;
-    submit: () => void;
-
-    getUploadImageEndpoint: (cartId?: number) => string;
-
-    //coupons
-    addCoupon: (coupon: string) => Promise<CartResponse.update>;
-    deleteCoupon: () => Promise<CartResponse.update>;
-}

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

@@ -1,8 +0,0 @@
-import ProductPayload from "../product";
-
-export namespace CartRequest {
-    export interface addItem extends ProductPayload {
-        notes?: string;
-        file?: BinaryType | string;
-    }
-}

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

@@ -1,66 +0,0 @@
-import { SuccessResponse } from "../../common";
-export namespace CartResponse {
-    export interface update extends SuccessResponse {
-        data: CartUpdatedData;
-    }
-
-    export interface status extends SuccessResponse {
-        data: {
-            active: boolean;
-            next_step: {
-                to: 'refresh' | 'login' | 'checkout';
-                url?: string;
-            };
-        }
-    }
-}
-
-
-export interface CartUpdatedData extends Object {
-    product_id?: number;
-    offer?: OfferSummary;
-    googleTags: string;//json string
-    cart: CartSummary;
-}
-
-export interface itemOffer {
-    discount: number;
-    is_free: boolean;
-    names: string;
-}
-
-export interface CartItem {
-    id: number;
-    product_id: number;
-    product_price: number;
-    price: number;
-    total: number;
-    is_available: true;
-    offer?: itemOffer;
-    quantity: number;
-    total_special_price: number;
-    special_price: number;
-}
-
-export interface CartSummary {
-    id: number;
-    user_id: number | string;
-    store_id: number;
-    real_shipping_cost?: number;
-    free_shipping_bar?: {
-        minimum_amount: number;
-        has_free_shipping: boolean;
-        percent: number | 0 | 100;
-        remaining: number;
-    };
-    sub_total: number;
-    discount: number;
-    total: number;
-    count: number;
-    items?: CartItem[];
-}
-
-export interface OfferSummary {
-    id: number;
-    product_id: number;
-}

package/types/api/comment.d.ts

@@ -1,18 +0,0 @@
-import {SuccessResponse} from "../common";
-
-export interface AddCommentResponse extends SuccessResponse {
-    data: {
-        case: 'success' | 'error';
-        message: string;
-    }
-}
-
-export interface AddCommentPayload {
-    id: number;
-    comment: string;
-    type: 'product' | 'page';
-}
-
-export default interface CommentApi {
-    add: (data: AddCommentPayload) => Promise<AddCommentResponse>;
-}

package/types/api/currency.d.ts

@@ -1,17 +0,0 @@
-import {Currency, SuccessResponse} from "../common";
-
-export interface ChangeCurrencyResponse extends SuccessResponse {
-    data: {
-        code: 'SAR' | string;
-        symbol: string;
-    }
-}
-
-export interface ListCurrenciesResponse extends SuccessResponse {
-    data: Array<Currency>
-}
-
-export default interface CurrencyApi {
-    change: (currency_code: 'SAR' | 'USD' | string) => Promise<ChangeCurrencyResponse>;
-    list: () => Promise<ListCurrenciesResponse>;
-}

package/types/api/document.d.ts

@@ -1,3 +0,0 @@
-
-export default interface DocumentApi {
-}

package/types/api/index.d.ts

@@ -1,110 +0,0 @@
-import CartApi from "./cart";
-import AuthApi from "./auth";
-import OrderApi from "./order";
-import RatingApi from "./rating";
-import CommentApi from "./comment";
-import LoyaltyApi from "./loyalty";
-import ProductApi from "./product";
-import ProfileApi from "./profile";
-import CurrencyApi from "./currency";
-import DocumentApi from "./document";
-import WishlistApi from "./wishlist";
-import ScopeApi from "./scope";
-import {ErrorResponse, SuccessResponse} from "@salla.sa/base/types/common";
-
-export {
-    CartApi,
-    AuthApi,
-    OrderApi,
-    RatingApi,
-    CommentApi,
-    LoyaltyApi,
-    ProductApi,
-    ProfileApi,
-    CurrencyApi,
-    DocumentApi,
-    WishlistApi,
-    ScopeApi,
-};
-export type ApiActionName =
-    'auth.login'
-    | 'auth.resend'
-    | 'auth.verify'
-    | 'auth.register'
-    | 'auth.logout'
-    | 'auth.refresh'
-    | 'cart.latest'
-    | 'cart.details'
-    | 'cart.summary'
-    | 'cart.quickAdd'
-    | 'cart.addItem'
-    | 'cart.deleteItem'
-    | 'cart.updateItem'
-    | 'cart.deleteImage'
-    | 'cart.status'
-    | 'cart.addCoupon'
-    | 'cart.deleteCoupon'
-    | 'loyalty.exchange'
-    | 'loyalty.getProgram'
-    | 'loyalty.reset'
-    | 'order.cancel'
-    | 'order.reOrder'
-    | 'order.send'
-    | 'product.getPrice'
-    | 'product.availabilitySubscribe'
-    | 'product.purchaseNow'
-    | 'product.search'
-    | 'product.categories'
-    | 'product.offers'
-    | 'profile.update'
-    | 'profile.getSizeGuides'
-    | 'profile.getGiftDetails'
-    | 'profile.addGiftToCart'
-    | 'profile.uploadGiftImage'
-    | 'comment.add'
-    | 'currency.change'
-    | 'currency.list'
-    | 'rating.store'
-    | 'rating.products'
-    | 'rating.shipping'
-    | 'rating.order'
-    | 'wishlist.add'
-    | 'wishlist.remove'
-    | 'scope.get'
-    | 'scope.change'
-    | 'scope.getProductAvailability'
-    | 'withoutNotifier';
-
-export default interface Api {
-    cart: CartApi;
-    auth: AuthApi;
-    order: OrderApi;
-    rating: RatingApi;
-    comment: CommentApi;
-    loyalty: LoyaltyApi;
-    product: ProductApi;
-    profile: ProfileApi;
-    currency: CurrencyApi;
-    document: DocumentApi;
-    wishlist: WishlistApi;
-    scope: ScopeApi;
-    withoutNotifier: (callback: Function) => Promise<void>;
-    getHeaders: () => {
-        Accept: string | 'application/json, text/plain, */*',
-        "X-Requested-With": 'XMLHttpRequest',
-        "S-SOURCE": 'twilight',
-        "Store-Identifier"?: number,
-        currency?: string | 'SAR',
-        "accept-language"?: string | 'ar',
-        Authorization?: string
-    }
-    request(endPoint: string, formData: undefined | object, method: string, options: object): Promise<any>
-    handleAfterResponseActions(response: SuccessResponse|ErrorResponse|any): void;
-    fireEventsForResponse(response: SuccessResponse|ErrorResponse|any): void;
-    showAlert(response: SuccessResponse|ErrorResponse|any): void;
-    handleErrorResponse(error: object): void;
-    handleInvalidFields(error: object): void;
-    errorPromise(data: any): Promise<any>;
-    successPromise(data: any): Promise<any>;
-    isFastRequestsAllowed(): boolean;
-}

package/types/api/loyalty.d.ts

@@ -1,226 +0,0 @@
-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

@@ -1,15 +0,0 @@
-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

@@ -1,17 +0,0 @@
-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

@@ -1,53 +0,0 @@
-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;
-    }
-}