@lasterp/shared 1.0.0-alpha.0

package/dist/index.d.cts

@@ -0,0 +1,298 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+export { decamelize as camelToSnake, decamelizeKeys as objectCamelToSnake, camelizeKeys as objectSnakeToCamel, camelize as snakeToCamel } from 'humps';
+import * as _tanstack_react_query from '@tanstack/react-query';
+import { UseQueryOptions } from '@tanstack/react-query';
+
+interface FrappeDoc {
+    name: string;
+    creation?: string;
+    modified?: string;
+    modifiedBy?: string;
+    owner?: string;
+    docStatus?: number;
+    idx?: number;
+}
+interface FrappeChildDoc extends FrappeDoc {
+    parent: string;
+    parentType: string;
+    parentField: string;
+}
+
+interface FrappeResponse<T = any> {
+    message?: T;
+    docs?: T[];
+    exc?: string;
+    exc_type?: string;
+    _server_messages?: string;
+    _error_message?: string;
+}
+interface FrappeError {
+    message: string;
+    statusCode?: number;
+    exc?: string;
+    excType?: string;
+    serverMessages?: string;
+}
+interface AuthOptions {
+    token?: string;
+    apiKey?: {
+        key: string;
+        secret: string;
+    };
+}
+
+declare function frappeCall<T = any>(baseUrl: string, method: string, args?: Record<string, any>, auth?: AuthOptions): Promise<T>;
+declare function frappeCallGet<T = any>(baseUrl: string, method: string, args?: Record<string, any>, auth?: AuthOptions): Promise<T>;
+declare function getList<T = any>(baseUrl: string, params: {
+    doctype: string;
+    fields?: string[];
+    filters?: Record<string, any>;
+    orderBy?: string;
+    limitStart?: number;
+    limitPageLength?: number;
+}, auth?: AuthOptions): Promise<T[]>;
+declare function getDoc<T = any>(baseUrl: string, doctype: string, name: string, auth?: AuthOptions): Promise<T>;
+declare function createDoc<T = any>(baseUrl: string, doctype: string, doc: Record<string, any>, auth?: AuthOptions): Promise<T>;
+declare function updateDoc<T = any>(baseUrl: string, doctype: string, name: string, doc: Record<string, any>, auth?: AuthOptions): Promise<T>;
+declare function deleteDoc(baseUrl: string, doctype: string, name: string, auth?: AuthOptions): Promise<void>;
+declare function getValue<T = any>(baseUrl: string, doctype: string, name: string, fieldname: string, auth?: AuthOptions): Promise<T>;
+declare function setValue<T = any>(baseUrl: string, doctype: string, name: string, fieldname: string, value: any, auth?: AuthOptions): Promise<T>;
+declare function getCount(baseUrl: string, doctype: string, filters?: Record<string, any>, auth?: AuthOptions): Promise<number>;
+declare function getCurrentUser(baseUrl: string, auth?: AuthOptions): Promise<any>;
+
+interface FrappeContextValue {
+    baseUrl: string;
+    token?: string;
+    apiKey?: {
+        key: string;
+        secret: string;
+    };
+}
+interface FrappeProviderProps {
+    baseUrl: string;
+    token?: string;
+    apiKey?: {
+        key: string;
+        secret: string;
+    };
+    autoLoadAuth?: boolean;
+    onLoadAuth?: () => Promise<{
+        token?: string;
+        apiKey?: {
+            key: string;
+            secret: string;
+        };
+    }> | {
+        token?: string;
+        apiKey?: {
+            key: string;
+            secret: string;
+        };
+    };
+    children: ReactNode;
+}
+declare function FrappeProvider({ baseUrl, token: initialToken, apiKey: initialApiKey, autoLoadAuth, onLoadAuth, children, }: FrappeProviderProps): react_jsx_runtime.JSX.Element;
+declare function useFrappeConfig(): FrappeContextValue;
+
+declare function useFrappe(): {
+    call: <T = any>(method: string, args?: Record<string, any>) => Promise<T>;
+    callGet: <T = any>(method: string, args?: Record<string, any>) => Promise<T>;
+    getList: <T = any>(params: {
+        doctype: string;
+        fields?: string[];
+        filters?: Record<string, any>;
+        orderBy?: string;
+        limitStart?: number;
+        limitPageLength?: number;
+    }) => Promise<T[]>;
+    getDoc: <T = any>(doctype: string, name: string) => Promise<T>;
+    createDoc: <T = any>(doctype: string, doc: Record<string, any>) => Promise<T>;
+    updateDoc: <T = any>(doctype: string, name: string, doc: Record<string, any>) => Promise<T>;
+    deleteDoc: (doctype: string, name: string) => Promise<void>;
+    baseUrl: string;
+    auth: AuthOptions;
+};
+
+interface StorageAdapter {
+    getItem(key: string): string | null | Promise<string | null>;
+    setItem(key: string, value: string): void | Promise<void>;
+    removeItem(key: string): void | Promise<void>;
+}
+declare const webStorageAdapter: StorageAdapter;
+declare function setStorageAdapter(adapter: StorageAdapter): void;
+declare function getStorageAdapter(): StorageAdapter;
+declare function getToken(): string | null | Promise<string | null>;
+declare function setToken(token: string): void | Promise<void>;
+declare function clearToken(): void | Promise<void>;
+declare function getApiKey(): Promise<{
+    key: string;
+    secret: string;
+} | null>;
+declare function setApiKey(key: string, secret: string): Promise<void>;
+declare function clearApiKey(): Promise<void>;
+declare function clearAuth(): Promise<void>;
+declare function isAuthenticated(): Promise<boolean>;
+
+interface Brand {
+    brandImage?: string;
+}
+interface NavbarItem {
+    label: string;
+    enableDropdown: boolean;
+    enableLink: boolean;
+    link?: string;
+    dropdownDescription?: string;
+    dropdownCta?: string;
+    groups?: NavbarSubItemGroup[];
+}
+interface NavbarSubItemGroup {
+    title?: string;
+    items: NavbarSubItem[];
+}
+interface NavbarSubItem {
+    label: string;
+    description?: string;
+    image?: string;
+    link?: string;
+}
+interface Topbar {
+    topbarEnabled?: boolean;
+    items: TopbarItem[];
+}
+interface TopbarItem {
+    icon?: string;
+    label: string;
+    link?: string;
+}
+interface Header {
+    brand: Brand;
+    headerType?: string;
+    tabs: NavbarItem[];
+    topbar: Topbar;
+}
+
+interface FooterItemGroup {
+    title: string;
+    items: FooterItem[];
+}
+interface FooterItem {
+    label: string;
+    link?: string;
+}
+interface Footer {
+    footerType?: string;
+    groups: FooterItemGroup[];
+    copyright?: string;
+    address?: string;
+    country?: string;
+    phone?: string;
+    email?: string;
+}
+
+interface Globals {
+    header: Header;
+    footer: Footer;
+}
+
+interface Hero {
+    type: string;
+    data: Record<string, unknown>;
+}
+interface Block {
+    type: string;
+    data?: Record<string, unknown>;
+}
+interface Page {
+    slug: string;
+    hero?: Hero;
+    blocks: Block[];
+}
+
+declare function getPage(baseUrl: string, slug: string, auth?: AuthOptions): Promise<Page>;
+
+interface AaveFeatureSlidesData {
+    feature1Title: string;
+    feature1Description: string;
+    feature1Cta?: string;
+    feature2Title: string;
+    feature2Description: string;
+    feature2Cta?: string;
+}
+
+interface Item {
+    itemCode: string;
+    region: string;
+    grade: string;
+    gradeIssuer: string;
+    color: string;
+    storage: string;
+    memory: string;
+    network: string;
+}
+interface ItemVariant extends Item {
+    itemVariant: string;
+}
+interface ModelNumber {
+    modelNumber: string;
+    simCardType: string;
+}
+interface Colour {
+    name: string;
+    color: string;
+}
+
+interface Category {
+    name: string;
+    categoryName: string;
+    sequenceId: number;
+    itemCode: string[];
+    itemGroup: string[];
+    brand: string[];
+    os: string[];
+}
+interface Product extends Item {
+    name: string;
+    image: string;
+}
+interface ProductVariant extends ItemVariant {
+    id: string;
+    specs: Record<string, string>;
+    price: number;
+    stock: number;
+}
+interface ShopContext {
+    title?: string;
+    categories?: Category[];
+    selectedCategory?: Category;
+    grades?: string[];
+    selectedGrade?: string;
+    products: Product[];
+}
+interface ProductContext {
+    currency: string;
+    product: Product;
+    specs: Record<string, string[]>;
+    variants: ProductVariant[];
+    modelNumbers: Record<string, ModelNumber>;
+    colours: Record<string, Colour>;
+    variantImages: Record<string, string[]>;
+}
+
+declare function getShopContext(baseUrl: string, params?: {
+    categoryName?: string;
+    gradeName?: string;
+}, auth?: AuthOptions): Promise<ShopContext>;
+declare function getProductContext(baseUrl: string, productName: string, auth?: AuthOptions): Promise<ProductContext>;
+
+declare function useShopContext(params?: {
+    categoryName?: string;
+    gradeName?: string;
+}, options?: Omit<UseQueryOptions<ShopContext, Error>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<ShopContext, Error>;
+declare function useProductContext(productName: string, options?: Omit<UseQueryOptions<ProductContext, Error>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<ProductContext, Error>;
+
+declare function toDescription(modelNumber: ModelNumber): string | null;
+
+declare function equalsIgnoreCase(str1: string, str2: string): boolean;
+
+export { type AaveFeatureSlidesData, type AuthOptions, type Block, type Brand, type Category, type Colour, type Footer, type FooterItem, type FooterItemGroup, type FrappeChildDoc, type FrappeContextValue, type FrappeDoc, type FrappeError, FrappeProvider, type FrappeProviderProps, type FrappeResponse, type Globals, type Header, type Hero, type Item, type ItemVariant, type ModelNumber, type NavbarItem, type NavbarSubItem, type NavbarSubItemGroup, type Page, type Product, type ProductContext, type ProductVariant, type ShopContext, type StorageAdapter, type Topbar, type TopbarItem, clearApiKey, clearAuth, clearToken, createDoc, deleteDoc, equalsIgnoreCase, frappeCall, frappeCallGet, getApiKey, getCount, getCurrentUser, getDoc, getList, getPage, getProductContext, getShopContext, getStorageAdapter, getToken, getValue, isAuthenticated, setApiKey, setStorageAdapter, setToken, setValue, toDescription, updateDoc, useFrappe, useFrappeConfig, useProductContext, useShopContext, webStorageAdapter };

package/dist/index.d.ts

@@ -0,0 +1,298 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+export { decamelize as camelToSnake, decamelizeKeys as objectCamelToSnake, camelizeKeys as objectSnakeToCamel, camelize as snakeToCamel } from 'humps';
+import * as _tanstack_react_query from '@tanstack/react-query';
+import { UseQueryOptions } from '@tanstack/react-query';
+
+interface FrappeDoc {
+    name: string;
+    creation?: string;
+    modified?: string;
+    modifiedBy?: string;
+    owner?: string;
+    docStatus?: number;
+    idx?: number;
+}
+interface FrappeChildDoc extends FrappeDoc {
+    parent: string;
+    parentType: string;
+    parentField: string;
+}
+
+interface FrappeResponse<T = any> {
+    message?: T;
+    docs?: T[];
+    exc?: string;
+    exc_type?: string;
+    _server_messages?: string;
+    _error_message?: string;
+}
+interface FrappeError {
+    message: string;
+    statusCode?: number;
+    exc?: string;
+    excType?: string;
+    serverMessages?: string;
+}
+interface AuthOptions {
+    token?: string;
+    apiKey?: {
+        key: string;
+        secret: string;
+    };
+}
+
+declare function frappeCall<T = any>(baseUrl: string, method: string, args?: Record<string, any>, auth?: AuthOptions): Promise<T>;
+declare function frappeCallGet<T = any>(baseUrl: string, method: string, args?: Record<string, any>, auth?: AuthOptions): Promise<T>;
+declare function getList<T = any>(baseUrl: string, params: {
+    doctype: string;
+    fields?: string[];
+    filters?: Record<string, any>;
+    orderBy?: string;
+    limitStart?: number;
+    limitPageLength?: number;
+}, auth?: AuthOptions): Promise<T[]>;
+declare function getDoc<T = any>(baseUrl: string, doctype: string, name: string, auth?: AuthOptions): Promise<T>;
+declare function createDoc<T = any>(baseUrl: string, doctype: string, doc: Record<string, any>, auth?: AuthOptions): Promise<T>;
+declare function updateDoc<T = any>(baseUrl: string, doctype: string, name: string, doc: Record<string, any>, auth?: AuthOptions): Promise<T>;
+declare function deleteDoc(baseUrl: string, doctype: string, name: string, auth?: AuthOptions): Promise<void>;
+declare function getValue<T = any>(baseUrl: string, doctype: string, name: string, fieldname: string, auth?: AuthOptions): Promise<T>;
+declare function setValue<T = any>(baseUrl: string, doctype: string, name: string, fieldname: string, value: any, auth?: AuthOptions): Promise<T>;
+declare function getCount(baseUrl: string, doctype: string, filters?: Record<string, any>, auth?: AuthOptions): Promise<number>;
+declare function getCurrentUser(baseUrl: string, auth?: AuthOptions): Promise<any>;
+
+interface FrappeContextValue {
+    baseUrl: string;
+    token?: string;
+    apiKey?: {
+        key: string;
+        secret: string;
+    };
+}
+interface FrappeProviderProps {
+    baseUrl: string;
+    token?: string;
+    apiKey?: {
+        key: string;
+        secret: string;
+    };
+    autoLoadAuth?: boolean;
+    onLoadAuth?: () => Promise<{
+        token?: string;
+        apiKey?: {
+            key: string;
+            secret: string;
+        };
+    }> | {
+        token?: string;
+        apiKey?: {
+            key: string;
+            secret: string;
+        };
+    };
+    children: ReactNode;
+}
+declare function FrappeProvider({ baseUrl, token: initialToken, apiKey: initialApiKey, autoLoadAuth, onLoadAuth, children, }: FrappeProviderProps): react_jsx_runtime.JSX.Element;
+declare function useFrappeConfig(): FrappeContextValue;
+
+declare function useFrappe(): {
+    call: <T = any>(method: string, args?: Record<string, any>) => Promise<T>;
+    callGet: <T = any>(method: string, args?: Record<string, any>) => Promise<T>;
+    getList: <T = any>(params: {
+        doctype: string;
+        fields?: string[];
+        filters?: Record<string, any>;
+        orderBy?: string;
+        limitStart?: number;
+        limitPageLength?: number;
+    }) => Promise<T[]>;
+    getDoc: <T = any>(doctype: string, name: string) => Promise<T>;
+    createDoc: <T = any>(doctype: string, doc: Record<string, any>) => Promise<T>;
+    updateDoc: <T = any>(doctype: string, name: string, doc: Record<string, any>) => Promise<T>;
+    deleteDoc: (doctype: string, name: string) => Promise<void>;
+    baseUrl: string;
+    auth: AuthOptions;
+};
+
+interface StorageAdapter {
+    getItem(key: string): string | null | Promise<string | null>;
+    setItem(key: string, value: string): void | Promise<void>;
+    removeItem(key: string): void | Promise<void>;
+}
+declare const webStorageAdapter: StorageAdapter;
+declare function setStorageAdapter(adapter: StorageAdapter): void;
+declare function getStorageAdapter(): StorageAdapter;
+declare function getToken(): string | null | Promise<string | null>;
+declare function setToken(token: string): void | Promise<void>;
+declare function clearToken(): void | Promise<void>;
+declare function getApiKey(): Promise<{
+    key: string;
+    secret: string;
+} | null>;
+declare function setApiKey(key: string, secret: string): Promise<void>;
+declare function clearApiKey(): Promise<void>;
+declare function clearAuth(): Promise<void>;
+declare function isAuthenticated(): Promise<boolean>;
+
+interface Brand {
+    brandImage?: string;
+}
+interface NavbarItem {
+    label: string;
+    enableDropdown: boolean;
+    enableLink: boolean;
+    link?: string;
+    dropdownDescription?: string;
+    dropdownCta?: string;
+    groups?: NavbarSubItemGroup[];
+}
+interface NavbarSubItemGroup {
+    title?: string;
+    items: NavbarSubItem[];
+}
+interface NavbarSubItem {
+    label: string;
+    description?: string;
+    image?: string;
+    link?: string;
+}
+interface Topbar {
+    topbarEnabled?: boolean;
+    items: TopbarItem[];
+}
+interface TopbarItem {
+    icon?: string;
+    label: string;
+    link?: string;
+}
+interface Header {
+    brand: Brand;
+    headerType?: string;
+    tabs: NavbarItem[];
+    topbar: Topbar;
+}
+
+interface FooterItemGroup {
+    title: string;
+    items: FooterItem[];
+}
+interface FooterItem {
+    label: string;
+    link?: string;
+}
+interface Footer {
+    footerType?: string;
+    groups: FooterItemGroup[];
+    copyright?: string;
+    address?: string;
+    country?: string;
+    phone?: string;
+    email?: string;
+}
+
+interface Globals {
+    header: Header;
+    footer: Footer;
+}
+
+interface Hero {
+    type: string;
+    data: Record<string, unknown>;
+}
+interface Block {
+    type: string;
+    data?: Record<string, unknown>;
+}
+interface Page {
+    slug: string;
+    hero?: Hero;
+    blocks: Block[];
+}
+
+declare function getPage(baseUrl: string, slug: string, auth?: AuthOptions): Promise<Page>;
+
+interface AaveFeatureSlidesData {
+    feature1Title: string;
+    feature1Description: string;
+    feature1Cta?: string;
+    feature2Title: string;
+    feature2Description: string;
+    feature2Cta?: string;
+}
+
+interface Item {
+    itemCode: string;
+    region: string;
+    grade: string;
+    gradeIssuer: string;
+    color: string;
+    storage: string;
+    memory: string;
+    network: string;
+}
+interface ItemVariant extends Item {
+    itemVariant: string;
+}
+interface ModelNumber {
+    modelNumber: string;
+    simCardType: string;
+}
+interface Colour {
+    name: string;
+    color: string;
+}
+
+interface Category {
+    name: string;
+    categoryName: string;
+    sequenceId: number;
+    itemCode: string[];
+    itemGroup: string[];
+    brand: string[];
+    os: string[];
+}
+interface Product extends Item {
+    name: string;
+    image: string;
+}
+interface ProductVariant extends ItemVariant {
+    id: string;
+    specs: Record<string, string>;
+    price: number;
+    stock: number;
+}
+interface ShopContext {
+    title?: string;
+    categories?: Category[];
+    selectedCategory?: Category;
+    grades?: string[];
+    selectedGrade?: string;
+    products: Product[];
+}
+interface ProductContext {
+    currency: string;
+    product: Product;
+    specs: Record<string, string[]>;
+    variants: ProductVariant[];
+    modelNumbers: Record<string, ModelNumber>;
+    colours: Record<string, Colour>;
+    variantImages: Record<string, string[]>;
+}
+
+declare function getShopContext(baseUrl: string, params?: {
+    categoryName?: string;
+    gradeName?: string;
+}, auth?: AuthOptions): Promise<ShopContext>;
+declare function getProductContext(baseUrl: string, productName: string, auth?: AuthOptions): Promise<ProductContext>;
+
+declare function useShopContext(params?: {
+    categoryName?: string;
+    gradeName?: string;
+}, options?: Omit<UseQueryOptions<ShopContext, Error>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<ShopContext, Error>;
+declare function useProductContext(productName: string, options?: Omit<UseQueryOptions<ProductContext, Error>, 'queryKey' | 'queryFn'>): _tanstack_react_query.UseQueryResult<ProductContext, Error>;
+
+declare function toDescription(modelNumber: ModelNumber): string | null;
+
+declare function equalsIgnoreCase(str1: string, str2: string): boolean;
+
+export { type AaveFeatureSlidesData, type AuthOptions, type Block, type Brand, type Category, type Colour, type Footer, type FooterItem, type FooterItemGroup, type FrappeChildDoc, type FrappeContextValue, type FrappeDoc, type FrappeError, FrappeProvider, type FrappeProviderProps, type FrappeResponse, type Globals, type Header, type Hero, type Item, type ItemVariant, type ModelNumber, type NavbarItem, type NavbarSubItem, type NavbarSubItemGroup, type Page, type Product, type ProductContext, type ProductVariant, type ShopContext, type StorageAdapter, type Topbar, type TopbarItem, clearApiKey, clearAuth, clearToken, createDoc, deleteDoc, equalsIgnoreCase, frappeCall, frappeCallGet, getApiKey, getCount, getCurrentUser, getDoc, getList, getPage, getProductContext, getShopContext, getStorageAdapter, getToken, getValue, isAuthenticated, setApiKey, setStorageAdapter, setToken, setValue, toDescription, updateDoc, useFrappe, useFrappeConfig, useProductContext, useShopContext, webStorageAdapter };