@vue-storefront/next 7.0.0-next.3 → 7.0.0-next.5

package/dist/types-FGnrBhjy.d.ts

@@ -1,241 +0,0 @@
-import { SDKApi, buildModule, middlewareModule } from '@alokai/connect/sdk';
-import { cookies } from 'next/headers';
-import React, { PropsWithChildren, ReactNode } from 'react';
-
-type Maybe<TType> = null | TType;
-
-type SfContract = {
-    SfCart: unknown;
-    SfCurrency: unknown;
-    SfCustomer: unknown;
-    SfLocale: unknown;
-};
-interface SfStateProps<TSfContract extends SfContract> {
-    currencies: TSfContract["SfCurrency"][];
-    currency: TSfContract["SfCurrency"];
-    locale: TSfContract["SfLocale"];
-    locales: TSfContract["SfLocale"][];
-}
-interface SfState<TSfContract extends SfContract> extends SfStateProps<TSfContract> {
-    cart: null | TSfContract["SfCart"] | undefined;
-    customer: null | TSfContract["SfCustomer"] | undefined;
-    setCart: (cart?: null | TSfContract["SfCart"]) => void;
-    setCurrencies: (currencies: TSfContract["SfCurrency"][]) => void;
-    setCurrency: (currency: TSfContract["SfCurrency"]) => void;
-    setCustomer: (customer?: null | TSfContract["SfCustomer"]) => void;
-    setLocale: (locale: TSfContract["SfLocale"]) => void;
-    setLocales: (locales: TSfContract["SfLocale"][]) => void;
-}
-declare function createSfStateProvider<TSfContract extends SfContract>(): {
-    SfStateProvider: ({ children, initialData, }: {
-        initialData: SfStateProps<TSfContract>;
-    } & PropsWithChildren) => React.JSX.Element;
-    useSfCartState: () => [null | TSfContract["SfCart"] | undefined, (cart?: null | TSfContract["SfCart"]) => void];
-    useSfCurrenciesState: () => [TSfContract["SfCurrency"][], (currencies: TSfContract["SfCurrency"][]) => void];
-    useSfCurrencyState: () => [TSfContract["SfCurrency"], (currency: TSfContract["SfCurrency"]) => void];
-    useSfCustomerState: () => [null | TSfContract["SfCustomer"] | undefined, (customer?: null | TSfContract["SfCustomer"]) => void];
-    useSfLocalesState: () => [TSfContract["SfLocale"][], (locales: TSfContract["SfLocale"][]) => void];
-    useSfLocaleState: () => [TSfContract["SfLocale"], (locale: TSfContract["SfLocale"]) => void];
-};
-
-declare const defaultMethodsRequestConfig: {
-    readonly unifiedCms: {
-        readonly middlewareModule: {
-            readonly getEntries: {
-                readonly method: "GET";
-            };
-            readonly getPage: {
-                readonly method: "GET";
-            };
-        };
-    };
-    readonly unifiedCommerce: {
-        readonly middlewareModule: {
-            readonly getCategories: {
-                readonly method: "GET";
-            };
-            readonly getCategory: {
-                readonly method: "GET";
-            };
-            readonly getCurrencies: {
-                readonly method: "GET";
-            };
-            readonly getProductDetails: {
-                readonly method: "GET";
-            };
-            readonly getProductReviews: {
-                readonly method: "GET";
-            };
-            readonly getProducts: {
-                readonly method: "GET";
-            };
-            readonly searchProducts: {
-                readonly method: "GET";
-            };
-        };
-    };
-};
-
-interface MiddlewareConfig {
-    /**
-     * The URL of the middleware.
-     * @example "http://localhost:4000"
-     */
-    apiUrl: string;
-    /**
-     * This is identifier used to invalidate the cache on CDN when the assets change.
-     * Usually it's a commit hash.
-     * @example "2c106d9619c71c3082c9b59b1d72817363c8ecb9"
-     * @default "no-cache-busting-id-set"
-     */
-    cdnCacheBustingId?: string;
-    /**
-     * The URL of the middleware for server-side rendering.
-     * @example "http://localhost:4000"
-     */
-    ssrApiUrl: string;
-}
-interface MultistoreConfig {
-    /**
-     * Whether the multistore is enabled or not.
-     * @example false
-     * @default false
-     */
-    enabled: boolean;
-}
-interface CreateSdkOptions {
-    middleware: MiddlewareConfig;
-    multistore?: MultistoreConfig;
-}
-type Cookies = Awaited<ReturnType<typeof cookies>>;
-type RequestHeaders = {
-    cookies: Cookies;
-    headers: Headers;
-} | Headers | undefined;
-type GetSdkContext = {
-    /**
-     * A function that returns the current locale string;
-     */
-    getLocale?: () => string;
-    /**
-     * A function that returns the request headers.
-     */
-    getRequestHeaders?: () => Promise<RequestHeaders> | RequestHeaders;
-};
-type DynamicContext = {
-    getRequestHeaders: () => Promise<Record<string, string | string[]>>;
-};
-type StaticContext = {
-    buildModule: typeof buildModule;
-    config: {
-        apiUrl: string;
-        cdnCacheBustingId: string;
-        defaultMethodsRequestConfig: typeof defaultMethodsRequestConfig;
-        ssrApiUrl: string;
-    };
-    /**
-     * @deprecated Use `config.defaultMethodsRequestConfig` instead.
-     */
-    defaults: typeof defaultMethodsRequestConfig;
-    middlewareModule: typeof middlewareModule;
-};
-type InjectedContext = DynamicContext & StaticContext;
-type Config<TConfig> = (context: InjectedContext) => TConfig;
-type AlokaiProviderProps<TSdk, TSfContract extends SfContract> = {
-    children: ReactNode;
-    initialData: SfStateProps<TSfContract>;
-    sdk: TSdk;
-};
-interface CreateSdkReturn<TConfig extends Record<string, any>> {
-    /**
-     * Creates a new SDK instance. This function is dedicated for server-side usage,
-     * where a new SDK instance should be created for each request.
-     * For the client side usage, use the `createSdkContext` function instead.
-     *
-     * @param dynamicContext - The dynamic, request-specific, context
-     *
-     * @returns The SDK instance.
-     *
-     * @example
-     * For the Pages Router, you can use the `getSdk` function in the `getServerSideProps` function:
-     * ```tsx
-     * import type { GetServerSideProps } from "next";
-     * import { getSdk } from "../../sdk.config";
-     *
-     * export const getServerSideProps: GetServerSideProps = async ({ req, locale }) => {
-     *  const sdk = await getSdk({
-     *    getRequestHeaders: () => Promise.resolve(req.headers),
-     *    getLocale: () => locale,
-     *  });
-     *  const { products } = await sdk.unified.getProducts();
-     *
-     *  return {
-     *    props: {...}
-     *  }
-     * };
-     * ```
-     *
-     * @example
-     * For the App Router, you can use the `getSdk` function in your React Server Component:
-     * ```tsx
-     * import { headers } from "next/headers";
-     * import { getSdk } from "../../sdk.config";
-     *
-     * export default async function SsrPage() {
-     *  const locale = await getLocale();
-     *  const sdk = await getSdk({
-     *    getRequestHeaders: () => headers(),
-     *    getLocale: () => locale,
-     *  });
-     *  const { products } = await sdk.unified.getProducts();
-     *
-     *  return <div>...</div>
-     * };
-     * ```
-     */
-    getSdk: (dynamicContext?: GetSdkContext) => SDKApi<TConfig>;
-}
-type CreateSdkContextReturn<TSdk extends SDKApi<any>, TSfContract extends SfContract> = Readonly<{
-    AlokaiProvider: ({ children, }: AlokaiProviderProps<TSdk, TSfContract>) => JSX.Element;
-    useSdk: () => TSdk;
-    useSfCartState: ReturnType<typeof createSfStateProvider<TSfContract>>["useSfCartState"];
-    useSfCurrenciesState: ReturnType<typeof createSfStateProvider<TSfContract>>["useSfCurrenciesState"];
-    useSfCurrencyState: ReturnType<typeof createSfStateProvider<TSfContract>>["useSfCurrencyState"];
-    useSfCustomerState: ReturnType<typeof createSfStateProvider<TSfContract>>["useSfCustomerState"];
-    useSfLocalesState: ReturnType<typeof createSfStateProvider<TSfContract>>["useSfLocalesState"];
-    useSfLocaleState: ReturnType<typeof createSfStateProvider<TSfContract>>["useSfLocaleState"];
-}>;
-
-/**
- * Retrieves an environment variable value.
- * On the server side, it reads from process.env.
- * On the client side, it reads from window.__ALOKAI_ENV__ to support runtime environment variables.
- *
- * @param key - The environment variable key (e.g., "NEXT_PUBLIC_API_URL")
- * @returns The environment variable value or undefined if not found
- *
- * @example
- * ```tsx
- * import { env } from "@vue-storefront/next/client";
- *
- * const apiUrl = env("NEXT_PUBLIC_API_URL");
- * ```
- */
-declare function env(key: string): string | undefined;
-
-/**
- * Type representing environment variables as key-value pairs
- */
-interface PublicEnv {
-    [key: string]: string | undefined;
-}
-/**
- * Extended window interface to include Alokai environment variables
- */
-declare global {
-    interface Window {
-        __ALOKAI_ENV__?: PublicEnv;
-    }
-}
-
-export { type CreateSdkContextReturn as C, type InjectedContext as I, type Maybe as M, type SfContract as S, type SfStateProps as a, type SfState as b, createSfStateProvider as c, type CreateSdkOptions as d, env as e, type Config as f, type CreateSdkReturn as g };