@wix/sdk 1.5.9 → 1.6.0

package/build/index.d.ts

@@ -1,389 +0,0 @@
-import { Host, RESTFunctionDescriptor, BuildRESTFunction, HostModule, HostModuleAPI, AuthenticationStrategy, BoundAuthenticationStrategy } from '@wix/sdk-types';
-export * from '@wix/sdk-types';
-import { ConditionalExcept, EmptyObject } from 'type-fest';
-import { ImageTransformOptions } from '@wix/image-kit';
-import { authentication } from '@wix/identity';
-
-type PublicMetadata = {
-    PACKAGE_NAME?: string;
-};
-declare const API_URL = "www.wixapis.com";
-
-declare const getDefaultDomain: (method: string, url: string) => "www.wixapis.com" | "readonly.wixapis.com";
-
-type RequestContext = {
-    isSSR: boolean;
-    host: string;
-    protocol?: string;
-};
-/**
- * Ambassador request options types are copied mostly from AxiosRequestConfig.
- * They are copied and not imported to reduce the amount of dependencies (to reduce install time).
- * https://github.com/axios/axios/blob/3f53eb6960f05a1f88409c4b731a40de595cb825/index.d.ts#L307-L315
- */
-type Method = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH' | 'purge' | 'PURGE' | 'link' | 'LINK' | 'unlink' | 'UNLINK';
-type ResponseTransformer = (data: any, headers?: any) => any;
-type AmbassadorRequestOptions<T = any> = {
-    _?: T;
-    url?: string;
-    method?: Method;
-    params?: any;
-    data?: any;
-    transformResponse?: ResponseTransformer | ResponseTransformer[];
-};
-type AmbassadorFactory<Request, Response> = (payload: Request) => ((context: RequestContext) => AmbassadorRequestOptions<Response>) & {
-    __isAmbassador: boolean;
-};
-type AmbassadorFunctionDescriptor<Request = any, Response = any> = AmbassadorFactory<Request, Response>;
-type BuildAmbassadorFunction<T extends AmbassadorFunctionDescriptor> = T extends AmbassadorFunctionDescriptor<infer Request, infer Response> ? (req: Request) => Promise<Response> : never;
-
-/**
- * Represents a location in a Source.
- */
-interface SourceLocation {
-  readonly line: number;
-  readonly column: number;
-}
-
-/**
- * See: https://spec.graphql.org/draft/#sec-Errors
- */
-interface GraphQLFormattedError {
-  /**
-   * A short, human-readable summary of the problem that **SHOULD NOT** change
-   * from occurrence to occurrence of the problem, except for purposes of
-   * localization.
-   */
-  readonly message: string;
-  /**
-   * If an error can be associated to a particular point in the requested
-   * GraphQL document, it should contain a list of locations.
-   */
-  readonly locations?: ReadonlyArray<SourceLocation>;
-  /**
-   * If an error can be associated to a particular field in the GraphQL result,
-   * it _must_ contain an entry with the key `path` that details the path of
-   * the response field which experienced the error. This allows clients to
-   * identify whether a null result is intentional or caused by a runtime error.
-   */
-  readonly path?: ReadonlyArray<string | number>;
-  /**
-   * Reserved for implementors to extend the protocol however they see fit,
-   * and hence there are no additional restrictions on its contents.
-   */
-  readonly extensions?: {
-    [key: string]: unknown;
-  };
-}
-
-type Headers = Record<string, string>;
-/**
- * This type takes in a descriptors object of a certain Host (including an `unknown` host)
- * and returns an object with the same structure, but with all descriptors replaced with their API.
- * Any non-descriptor properties are removed from the returned object, including descriptors that
- * do not match the given host (as they will not work with the given host).
- */
-type BuildDescriptors<T extends Descriptors, H extends Host<any> | undefined> = BuildRESTDescriptors<T> & BuildAmbassadorDescriptors<T> & (H extends Host<any> ? BuildHostDescriptors<T> : {});
-type BuildRESTDescriptors<T extends Descriptors> = T extends RESTFunctionDescriptor ? BuildRESTFunction<T> : ConditionalExcept<{
-    [Key in keyof T]: T[Key] extends Descriptors ? BuildRESTDescriptors<T[Key]> : never;
-}, EmptyObject>;
-type BuildAmbassadorDescriptors<T extends Descriptors> = T extends AmbassadorFunctionDescriptor ? BuildAmbassadorFunction<T> : ConditionalExcept<{
-    [Key in keyof T]: T[Key] extends Descriptors ? BuildAmbassadorDescriptors<T[Key]> : never;
-}, EmptyObject>;
-type BuildHostDescriptors<T extends Descriptors> = T extends HostModule<any, any> ? HostModuleAPI<T> : ConditionalExcept<{
-    [Key in keyof T]: T[Key] extends Descriptors ? BuildHostDescriptors<T[Key]> : never;
-}, EmptyObject>;
-/**
- * Descriptors are objects that describe the API of a module, and the module
- * can either be a REST module or a host module.
- * This type is recursive, so it can describe nested modules.
- */
-type Descriptors = RESTFunctionDescriptor | AmbassadorFunctionDescriptor | HostModule<any, any> | {
-    [key: string]: Descriptors | PublicMetadata | any;
-};
-/**
- * This type is used in `createClient` to ensure that the given host matches the host of the given descriptors.
- * If the host does not match, the descriptor is replaced with a host module that will throw an error when used.
- */
-type AssertHostMatches<T extends Descriptors, H extends Host<any>> = T extends HostModule<any, infer U> ? H extends undefined ? never : H extends U ? T : HostModule<any, H> : T extends RESTFunctionDescriptor<any> ? T : {
-    [Key in keyof T]: T[Key] extends Descriptors ? AssertHostMatches<T[Key], H> : T[Key];
-};
-type TypedQueryInput<Result = {
-    [key: string]: any;
-}, Variables = {
-    [key: string]: any;
-}> = {
-    /**
-     * Type to support `@graphql-typed-document-node/core`
-     * @internal
-     */
-    __apiType?: (variables: Variables) => Result;
-    /**
-     * Type to support `TypedQueryDocumentNode` from `graphql`
-     * @internal
-     */
-    __ensureTypesOfVariablesAndResultMatching?: (variables: Variables) => Result;
-};
-type WixClient<H extends Host<any> | undefined = undefined, Z extends AuthenticationStrategy<H> = AuthenticationStrategy<H>, T extends Descriptors = Descriptors> = {
-    setHeaders(headers: Headers): void;
-    auth: Omit<Z, 'getAuthHeaders'> & BoundAuthenticationStrategy;
-    fetch(relativeUrl: string, options: RequestInit): Promise<Response>;
-    use<R extends Descriptors = EmptyObject>(modules: H extends Host<any> ? AssertHostMatches<R, H> : R): BuildDescriptors<R, H>;
-    graphql<Result, Variables>(query: string | ((string | String) & TypedQueryInput<Result, Variables>), variables?: Variables): Promise<{
-        data: Result;
-        errors?: GraphQLFormattedError[];
-    }>;
-} & BuildDescriptors<T, H>;
-declare function createClient<H extends Host<any> | undefined = undefined, Z extends AuthenticationStrategy<H> = AuthenticationStrategy<H>, T extends Descriptors = EmptyObject>(config: {
-    modules?: H extends Host<any> ? AssertHostMatches<T, H> : T;
-    auth?: Z;
-    headers?: Headers;
-    host?: H;
-}): WixClient<H, Z, T>;
-
-declare function getScaledToFillImageUrl(wixMediaIdentifier: string, targetWidth: number, targetHeight: number, options: ImageTransformOptions): string;
-declare function getScaledToFitImageUrl(wixMediaIdentifier: string, targetWidth: number, targetHeight: number, options: ImageTransformOptions): string;
-declare function getCroppedImageUrl(wixMediaIdentifier: string, cropX: number, cropY: number, cropWidth: number, cropHeight: number, targetWidth: number, targetHeight: number, options?: ImageTransformOptions): string;
-declare function getImageUrl(val: string): {
-    id: string;
-    url: string;
-    height: number;
-    width: number;
-    altText?: string;
-    filename?: string;
-};
-declare function getVideoUrl(val: string, resolution?: VideoResolution): {
-    id: string;
-    url: string;
-    thumbnail: string;
-    filename?: string;
-};
-declare function getAudioUrl(val: string): {
-    id: string;
-    url: string;
-    duration: number;
-    filename?: string;
-};
-declare function getDocumentUrl(val: string): {
-    id: string;
-    url: string;
-    filename?: string;
-};
-declare function decodeText(s: string): string;
-declare enum VideoResolution {
-    MOBILE = "360p",
-    LOW = "480p",
-    MID = "720p",
-    HIGH = "1080p"
-}
-declare const media: {
-    getCroppedImageUrl: typeof getCroppedImageUrl;
-    getScaledToFillImageUrl: typeof getScaledToFillImageUrl;
-    getScaledToFitImageUrl: typeof getScaledToFitImageUrl;
-    getImageUrl: typeof getImageUrl;
-    getVideoUrl: typeof getVideoUrl;
-    getAudioUrl: typeof getAudioUrl;
-    getDocumentUrl: typeof getDocumentUrl;
-};
-
-interface Tokens {
-    accessToken: AccessToken;
-    refreshToken: RefreshToken;
-}
-interface Token {
-    value: string;
-}
-interface AccessToken extends Token {
-    expiresAt: number;
-}
-interface RefreshToken extends Token {
-    role: TokenRole;
-}
-interface OauthData extends OauthPKCE {
-    originalUri: string;
-    redirectUri: string;
-}
-interface OauthPKCE {
-    codeVerifier: string;
-    codeChallenge: string;
-    state: string;
-}
-interface RegisterParams extends LoginParams {
-    profile?: authentication.IdentityProfile;
-}
-interface LoginParams {
-    email: string;
-    password: string;
-    captchaTokens?: {
-        invisibleRecaptchaToken?: string;
-        recaptchaToken?: string;
-    };
-}
-interface IOAuthStrategy extends AuthenticationStrategy {
-    generateVisitorTokens(tokens?: {
-        refreshToken?: RefreshToken;
-        accessToken?: AccessToken;
-    }): Promise<Tokens>;
-    renewToken: (refreshToken: RefreshToken) => Promise<Tokens>;
-    setTokens: (tokens: Tokens) => void;
-    getTokens: () => Tokens;
-    generateOAuthData: (redirectUri: string, originalUri?: string) => OauthData;
-    getAuthUrl: (oauthData: OauthData, opts?: {
-        prompt?: 'login' | 'none';
-        responseMode?: 'fragment' | 'web_message' | 'query';
-    }) => Promise<{
-        authUrl: string;
-    }>;
-    getMemberTokens: (code: string, state: string, oauthData: OauthData) => Promise<Tokens>;
-    logout: (originalUrl: string) => Promise<{
-        logoutUrl: string;
-    }>;
-    parseFromUrl: (url?: string, responseMode?: 'query' | 'fragment') => {
-        code: string;
-        state: string;
-        error?: string;
-        errorDescription?: string;
-    };
-    register: (params: RegisterParams) => Promise<StateMachine>;
-    login: (params: LoginParams) => Promise<StateMachine>;
-    processVerification<T extends ProcessableState>(nextInputs: CalculateNextState<T>, state?: StateMachine): Promise<StateMachine>;
-    getMemberTokensForDirectLogin: (sessionToken: string) => Promise<Tokens>;
-    sendPasswordResetEmail: (email: string, redirectUri: string) => Promise<void>;
-    captchaInvisibleSiteKey: string;
-    captchaVisibleSiteKey: string;
-    loggedIn: () => boolean;
-}
-declare enum LoginState {
-    SUCCESS = "SUCCESS",
-    INITIAL = "INITIAL",
-    FAILURE = "FAILURE",
-    EMAIL_VERIFICATION_REQUIRED = "EMAIL_VERIFICATION_REQUIRED",
-    OWNER_APPROVAL_REQUIRED = "OWNER_APPROVAL_REQUIRED",
-    USER_CAPTCHA_REQUIRED = "USER_CAPTCHA_REQUIRED",
-    SILENT_CAPTCHA_REQUIRED = "SILENT_CAPTCHA_REQUIRED"
-}
-interface LoginResults<LK extends LoginState> {
-    loginState: LK;
-}
-interface SuccessState extends LoginResults<LoginState.SUCCESS> {
-    data: {
-        sessionToken: string;
-    };
-}
-interface InitialState extends LoginResults<LoginState.INITIAL> {
-}
-interface ErrorState extends LoginResults<LoginState.FAILURE> {
-    errorCode?: 'invalidEmail' | 'invalidPassword' | 'resetPassword' | 'missingCaptchaToken' | 'emailAlreadyExists' | 'invalidCaptchaToken';
-    error: string;
-}
-interface EmailVerificationRequiredState extends LoginResults<LoginState.EMAIL_VERIFICATION_REQUIRED> {
-    data: {
-        stateToken: string;
-    };
-}
-interface OwnerApprovalRequiredState extends LoginResults<LoginState.OWNER_APPROVAL_REQUIRED> {
-}
-interface SilentCaptchaRequiredState extends LoginResults<LoginState.SILENT_CAPTCHA_REQUIRED> {
-    data: {
-        stateToken: string;
-    };
-}
-interface UserCaptchaRequiredState extends LoginResults<LoginState.USER_CAPTCHA_REQUIRED> {
-    data: {
-        stateToken: string;
-    };
-}
-declare enum TokenRole {
-    NONE = "none",
-    VISITOR = "visitor",
-    MEMBER = "member"
-}
-type StateMachine = InitialState | SuccessState | ErrorState | EmailVerificationRequiredState | OwnerApprovalRequiredState | SilentCaptchaRequiredState | UserCaptchaRequiredState;
-type VerificationCode = {
-    verificationCode: string;
-};
-type CalculateNextState<T> = T extends EmailVerificationRequiredState ? VerificationCode : never;
-type ProcessableState = EmailVerificationRequiredState;
-
-declare function OAuthStrategy(config: {
-    clientId: string;
-    tokens?: Tokens;
-}): IOAuthStrategy;
-interface TokenResponse {
-    access_token: string;
-    expires_in: number;
-    refresh_token: string | null;
-    token_type: string;
-    scope?: string | null;
-}
-
-interface IApiKeyStrategy extends AuthenticationStrategy {
-    setSiteId(siteId?: string): void;
-    setAccountId(accountId?: string): void;
-}
-type Context = {
-    siteId: string;
-    accountId?: string;
-} | {
-    siteId?: string;
-    accountId: string;
-};
-declare function ApiKeyStrategy({ siteId, accountId, apiKey, }: {
-    apiKey: string;
-} & Context): IApiKeyStrategy;
-
-type WixAppOAuthStrategy = AuthenticationStrategy & {
-    getInstallUrl({ redirectUrl }: {
-        redirectUrl: string;
-    }): string;
-    handleOAuthCallback(url: string, opts?: {
-        state: string;
-    }): Promise<{
-        instanceId: string;
-        accessToken: string;
-        refreshToken: string;
-    }>;
-};
-/**
- * Creates an authentication strategy for Wix Apps OAuth installation process.
- * Use this authentication strategy when making requests to Wix APIs from your Wix App backend.
- * @param opts Options for initializing the authentication strategy
- * @param opts.appId The Wix App ID
- * @param opts.appSecret The Wix App Secret
- * @param opts.refreshToken An optional refresh token previously retrieved from Wix OAuth API
- * @returns An authentication strategy that can be used with WixClient
- * @example
- * ```ts
- * import { WixAppOAuthStrategy, createClient } from '@wix/sdk';
- * import { products } from '@wix/stores';
- *
- * const client = createClient({
- *  auth: WixAppOAuthStrategy({
- *   appId: 'appId',
- *   appSecret: 'appSecret',
- *  }),
- *  modules: { products },
- * });
- *
- * const installUrl = client.auth.getInstallUrl({ redirectUrl: 'https://example.com' });
- * // Redirect the user to the installUrl
- *
- * ...
- *
- * // in the callback handler of your http server
- * // req.url is the url of the callback request
- * const { instanceId, refreshToken } = await client.auth.handleOAuthCallback(req.url);
- *
- * // store the instanceId and refreshToken in your database
- * // use the authorized client
- * const products = await client.products.queryProducts().find();
- *
- * ```
- */
-declare function WixAppOAuthStrategy(opts: {
-    appId: string;
-    appSecret: string;
-    refreshToken?: string;
-}): WixAppOAuthStrategy;
-
-export { API_URL, type AccessToken, ApiKeyStrategy, type AssertHostMatches, type BuildDescriptors, type CalculateNextState, type Descriptors, type IApiKeyStrategy, type IOAuthStrategy, type LoginParams, LoginState, OAuthStrategy, type OauthData, type OauthPKCE, type ProcessableState, type RefreshToken, type RegisterParams, type StateMachine, type Token, type TokenResponse, TokenRole, type Tokens, VideoResolution, WixAppOAuthStrategy, type WixClient, createClient, decodeText, getDefaultDomain, media };