@websolutespa/bom-mixer-models 0.0.1

package/.turbo/turbo-build.log

@@ -0,0 +1,17 @@
+
+> @websolutespa/bom-mixer-models@0.0.1 build
+> tsup ./src/index.ts --format esm,cjs --dts --external react
+
+CLI Building entry: ./src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v6.6.3
+CLI Target: es2020
+ESM Build start
+CJS Build start
+CJS dist\index.js 97.35 KB
+CJS ⚡️ Build success in 219ms
+ESM dist\index.mjs 94.70 KB
+ESM ⚡️ Build success in 220ms
+DTS Build start
+DTS ⚡️ Build success in 7745ms
+DTS dist\index.d.ts 12.45 KB

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @websolutespa/bom-mixer-models
+
+## 0.0.1
+
+### Patch Changes
+
+- Added: first release.

package/dist/index.d.ts

@@ -0,0 +1,409 @@
+import { ISchema, IEquatable, IEntity, ILocalizedString, QueryParams, IOption, INamedEntity, ValueOf, IQuerable } from '@websolutespa/bom-mixer-core';
+import { NextRequest, NextFetchEvent, NextResponse } from 'next/server';
+
+type IMediaType = 'image' | 'video' | string;
+type IMedia = {
+    src: string;
+    type: IMediaType;
+    alt?: string;
+    title?: string;
+    abstract?: string;
+    width?: number;
+    height?: number;
+    url?: string;
+    media?: IMedia;
+};
+
+type ICartItem = ISchema & {
+    id: IEquatable;
+    schema: string;
+    media: IMedia;
+    title: string;
+    abstract?: string;
+    href: string;
+    price: number;
+    qty: number;
+};
+type ICartAddItem = Omit<ICartItem, 'qty'>;
+
+type ICategory = IEntity & {
+    id: IEquatable;
+    slug?: ILocalizedString | string;
+    title?: ILocalizedString | string;
+    media?: IMedia;
+    schema?: string;
+    page?: IEquatable;
+    category?: IEquatable | ICategory;
+};
+type ICategoryItem = ICategory & {
+    items: ICategory[];
+};
+type ICategorized = {
+    id: IEquatable;
+    schema?: string;
+    category: IEquatable | ICategory;
+    isDefault?: boolean;
+    slug?: ILocalizedString | string;
+    title?: ILocalizedString | string;
+    media?: IMedia;
+};
+
+declare function getCategories(params?: QueryParams): Promise<ICategory[]>;
+declare function getSegments(item: ICategorized, params?: QueryParams): Promise<ICategory[]>;
+declare function getRouteSegments(schema: string | undefined, item: ICategorized, categories: ICategory[]): ICategory[];
+
+type IUserLogin = {
+    email: string;
+    password: string;
+    rememberMe: boolean;
+};
+type IUserRegister = {
+    firstName: string;
+    lastName: string;
+    email: string;
+    password: string;
+    confirmPassword: string;
+    privacy: boolean;
+};
+type IUserForgot = {
+    email: string;
+};
+type IUserChangePassword = {
+    oldPassword: string;
+    newPassword: string;
+    confirmNewPassword: string;
+};
+type IUser = ISchema & {
+    id: IEquatable;
+    firstName: string;
+    lastName: string;
+    email: string;
+};
+type IAddress = {
+    name: string;
+    firstName: string;
+    lastName: string;
+    address: string;
+    streetNumber: string;
+    zipCode: string;
+    city: string;
+    country: IOption;
+    region?: IOption;
+    province?: IOption;
+    email: string;
+    phoneNumber: string;
+};
+type IAddressOptions = {
+    countries: IOption[];
+    regions: IOption[];
+    provinces: IOption[];
+};
+type IUserAddress = Omit<IAddress, 'name'>;
+type ICompanyAddress = Omit<IAddress, 'firstName' | 'lastName'>;
+
+type ICheckout = {
+    items: ICheckoutItem[];
+    user?: Partial<IUser>;
+    shippingAddress: IUserAddress;
+    hasInvoice?: boolean;
+    hasBilling?: boolean;
+    billingAddress?: IUserAddress;
+    delivery: ICheckoutDelivery;
+    store: ICheckoutStore;
+    discounts: ICheckoutDiscount[];
+    payment: ICheckoutPayment;
+    subTotal: number;
+    subTotalFull: number;
+    taxes: number;
+    total: number;
+};
+type ICheckoutPartial = Partial<ICheckout>;
+type ICheckoutItem = ICartItem & {
+    fullPrice: number;
+};
+type ICheckoutInfo = {
+    user?: Partial<IUser>;
+    shippingAddress: IUserAddress;
+    hasInvoice?: boolean;
+    hasBilling?: boolean;
+    billingAddress?: IUserAddress;
+};
+type ICheckoutDelivery = IOption & {
+    abstract: string;
+    price: number;
+    fullPrice: number;
+};
+type ICheckoutStore = Partial<ICompanyAddress> & IOption & {
+    category?: IOption;
+    timetable?: string[];
+    position?: {
+        latitude: number;
+        longitude: number;
+    };
+    distance?: number;
+    rank?: number;
+};
+type ICheckoutDiscount = IOption & {
+    abstract?: string;
+    price: number;
+    validFrom: Date | string;
+    validTo: Date | string;
+};
+type ICheckoutPayment = IOption & {
+    abstract?: string;
+    media?: IMedia;
+};
+
+declare function getItems(items: ICartItem[], market: string, locale: string, user?: IUser): Promise<ICheckoutItem[]>;
+declare function getInfo(checkout: ICheckoutPartial, market: string, locale: string): Promise<IAddressOptions>;
+declare function getDeliveries(checkout: ICheckoutPartial, market: string, locale: string): Promise<ICheckoutDelivery[]>;
+declare function getStores(checkout: ICheckoutPartial, market: string, locale: string): Promise<ICheckoutStore[]>;
+declare function getPayments(checkout: ICheckoutPartial, market: string, locale: string): Promise<ICheckoutPayment[]>;
+declare function updateCheckout(checkout: ICheckoutPartial, action: string, market: string, locale: string): Promise<ICheckoutPartial>;
+declare function setDiscountCode(discountCode: string, checkout: ICheckoutPartial, market: string, locale: string): Promise<ICheckoutPartial>;
+declare function getPayment(checkout: ICheckoutPartial, market: string, locale: string): Promise<{
+    redirectUrl: string;
+}>;
+
+declare function getCountries(locale?: string): Promise<INamedEntity[]>;
+
+type IFeatureType = {
+    id: string;
+    schema?: string;
+    title: string;
+    mode: string;
+    features?: {
+        id: IEquatable;
+        title: string;
+        [key: string]: unknown;
+    }[];
+};
+
+declare function getFeatureTypes(params?: QueryParams): Promise<IFeatureType[]>;
+
+type ILabel = IEntity & {
+    id: IEquatable;
+    text?: string | ILocalizedString;
+};
+
+declare function getLabels(params?: QueryParams): Promise<ILabel[]>;
+declare function resolveLabel(labels: ILabel[], id: string): string;
+
+type ILocale = IEntity & {
+    id: string;
+    title?: string;
+    isActive?: boolean;
+    isDefault?: boolean;
+};
+
+type IMarket = IEntity & {
+    id: string;
+    title?: string;
+    isActive?: boolean;
+    isDefault?: boolean;
+    countries?: string[];
+    languages?: string[];
+    defaultLanguage?: string;
+};
+
+type IRoute = {
+    id: string;
+    market: string;
+    locale: string;
+    category: string;
+    page: IEquatable;
+    schema: string;
+    template?: string;
+};
+type IRouteLink = {
+    id: IEquatable;
+    href: string;
+    title: string;
+    items?: IRouteLink[];
+    media?: IMedia;
+};
+type IRouteParams = {
+    id: IEquatable;
+    market: string;
+    locale: string;
+    [key: string]: any;
+};
+type SchemaType = string;
+
+type ILayout = {
+    market: string;
+    locale: string;
+    markets: IMarket[];
+    locales: ILocale[];
+    labels: ILabel[];
+    tree?: IRouteLink;
+    navs: {
+        [key: string]: IRouteLink[];
+    };
+    topLevelRoutes: {
+        [key: string]: IRouteLink;
+    };
+    topLevelHrefs: {
+        [key: string]: string;
+    };
+};
+
+declare function getLayout(market: string, locale: string): Promise<ILayout>;
+
+type ILink = {
+    href: string;
+    title: string;
+    type?: string;
+    secure?: boolean;
+};
+
+type IList = INamedEntity & {
+    key?: string;
+    listId?: IEquatable;
+    items?: IList[];
+};
+type IKeyedList = IList & {
+    key: string;
+};
+
+declare function getLists(locale?: string): Promise<IList[]>;
+declare function getListByKeys(keys: string[], locale?: string): Promise<{
+    [key: string]: IList[];
+}>;
+
+declare function getLocales(params?: QueryParams): Promise<ILocale[]>;
+
+declare function getMarkets(params?: QueryParams): Promise<IMarket[]>;
+
+type IMenu = IEntity & {
+    id: IEquatable;
+    items: IMenuItem[];
+};
+type IMenuItem = {
+    name: string;
+    href: string;
+};
+
+declare function getMenu(id: IEquatable): Promise<IMenu | undefined>;
+declare function getMenus(): Promise<IMenu[]>;
+
+declare const IOrderStatus: {
+    Pending: string;
+    AwaitingPayment: string;
+    AwaitingFulfillment: string;
+    AwaitingShipment: string;
+    AwaitingPickup: string;
+    PartiallyShipped: string;
+    Completed: string;
+    Shipped: string;
+    Cancelled: string;
+    Declined: string;
+    Refunded: string;
+    Disputed: string;
+    ManualVerificationRequired: string;
+    PartiallyRefunded: string;
+};
+type IOrderStatusValue = ValueOf<typeof IOrderStatus>;
+type IOrder = ICheckout & {
+    id: IEquatable;
+    date: Date | string;
+    status: IOrderStatusValue;
+};
+type IOrderDetail = IOrder & {
+    href: string;
+};
+
+declare function getOrders(market: string, locale: string): Promise<IOrderDetail[]>;
+declare function getOrder(id: IEquatable, market: string, locale: string): Promise<IOrderDetail | null>;
+
+type IMeta = {
+    title?: string;
+    description?: string;
+    keywords?: string;
+    robots?: string;
+};
+type IImage = {
+    url: string;
+    type?: string;
+    alt?: string;
+    title?: string;
+    caption?: string;
+    width?: number;
+    height?: number;
+};
+type IPage = IEntity & {
+    category: string | number | ICategory;
+    slug?: string;
+    href: string;
+    alternates: IRoute[];
+    breadcrumb: IRouteLink[];
+    parentRoute?: IRouteLink;
+    title?: string;
+    abstract?: string;
+    description?: string;
+    content?: string;
+    createdAt?: Date;
+    updatedAt?: Date;
+    meta?: IMeta;
+    media?: IMedia;
+    [key: string]: any;
+};
+type PageProps<T extends IPage = IPage> = {
+    layout: ILayout;
+    page: T;
+    params: IRouteParams;
+    locales?: string[];
+    locale?: string;
+    defaultLocale?: string;
+};
+
+declare function findPage<T extends IPage>(schema: string, params?: QueryParams): Promise<T | undefined>;
+declare function getPage<T extends IPage>(schema: string, id: IEquatable, market?: string, locale?: string): Promise<T | undefined>;
+declare function getPageCategory<T extends IPage>(schema: string, page?: IPage, market?: string, locale?: string): Promise<T | undefined>;
+declare function getErrorPageLayout(): Promise<{
+    layout: ILayout;
+    page: IPage;
+}>;
+
+declare function getProvinces(locale?: string): Promise<INamedEntity[]>;
+
+declare function getRegions(locale?: string): Promise<INamedEntity[]>;
+
+declare function routeInterceptor(request: NextRequest, next: NextFetchEvent): Promise<NextResponse | undefined>;
+
+declare function getRoutes(params?: QueryParams): Promise<IRoute[]>;
+declare function getRoute(id: string): Promise<IRoute | undefined>;
+declare function getRoutesForSchemas(schemas: string[], market?: string, locale?: string): Promise<{
+    [key: string]: string;
+}>;
+declare function getRoutesForTemplates(templates: string[], market?: string, locale?: string): Promise<{
+    [key: string]: string;
+}>;
+declare function getStaticPathsForSchema(schema: string): Promise<StaticPath[]>;
+declare function decorateHref(item: any, market?: string, locale?: string): Promise<any>;
+declare function getBreadcrumbFromSegments(segments: ICategory[], market?: string, locale?: string): Promise<IRouteLink[]>;
+declare function getRouteLinkTree(market?: string, locale?: string): Promise<IRouteLink | undefined>;
+declare function categoryToRouteLink(routes: IRoute[], categories: ICategory[], category: ICategory, locale?: string): IRouteLink;
+declare function resolveRoute(route: IRoute): string;
+type StaticPath = {
+    params: {
+        [key: string]: string;
+    };
+};
+
+type IModelStore = {
+    category: IQuerable<ICategory>;
+    feature_type: IQuerable<IFeatureType>;
+    label: IQuerable<ILabel>;
+    list: IQuerable<IList>;
+    locale: IQuerable<ILocale>;
+    market: IQuerable<IMarket>;
+    menu: IQuerable<IMenu>;
+    route: IQuerable<IRoute>;
+    i18n_country: IQuerable<INamedEntity>;
+    i18n_province: IQuerable<INamedEntity>;
+    i18n_region: IQuerable<INamedEntity>;
+    [key: string]: IQuerable<IEntity>;
+};
+
+export { IAddress, IAddressOptions, ICartAddItem, ICartItem, ICategorized, ICategory, ICategoryItem, ICheckout, ICheckoutDelivery, ICheckoutDiscount, ICheckoutInfo, ICheckoutItem, ICheckoutPartial, ICheckoutPayment, ICheckoutStore, ICompanyAddress, IFeatureType, IImage, IKeyedList, ILabel, ILayout, ILink, IList, ILocale, IMarket, IMedia, IMediaType, IMenu, IMenuItem, IMeta, IModelStore, IOrder, IOrderDetail, IOrderStatus, IOrderStatusValue, IPage, IRoute, IRouteLink, IRouteParams, IUser, IUserAddress, IUserChangePassword, IUserForgot, IUserLogin, IUserRegister, PageProps, SchemaType, StaticPath, categoryToRouteLink, decorateHref, findPage, getBreadcrumbFromSegments, getCategories, getCountries, getDeliveries, getErrorPageLayout, getFeatureTypes, getInfo, getItems, getLabels, getLayout, getListByKeys, getLists, getLocales, getMarkets, getMenu, getMenus, getOrder, getOrders, getPage, getPageCategory, getPayment, getPayments, getProvinces, getRegions, getRoute, getRouteLinkTree, getRouteSegments, getRoutes, getRoutesForSchemas, getRoutesForTemplates, getSegments, getStaticPathsForSchema, getStores, resolveLabel, resolveRoute, routeInterceptor, setDiscountCode, updateCheckout };