import { Extension, I18n, Storage, Language, Country, AuthenticatedAccount, GraphQLError, StorefrontApiVersion, SessionToken, Analytics, CustomerPrivacy, ApplyTrackingConsentChangeType, ToastApi, Intents, SubscribableSignalLike } from '../shared';
import type { ExtensionTarget } from '../../extension-targets';
/**
 * The merchant-defined setting values for the extension.
 */
export interface ExtensionSettings {
    [key: string]: string | number | boolean | undefined;
}
/**
 * The following APIs are provided to all extension targets.
 */
export interface StandardApi<Target extends ExtensionTarget = ExtensionTarget> {
    /**
     * The identifier that specifies where in Shopify’s UI your code is being
     * injected. This will be one of the targets you have included in your
     * extension’s configuration file.
     *
     * @example 'customer-account.order-status.block.render'
     * @see https://shopify.dev/docs/api/customer-account-ui-extensions/extension-targets-overview
     * @see https://shopify.dev/docs/apps/app-extensions/configuration#targets
     *
     * @deprecated Deprecated as of version `2023-07`, use `extension.target` instead.
     */
    extensionPoint: Target;
    /**
     * Meta information about the extension.
     */
    extension: Extension;
    /**
     * Information about the authenticated account.
     */
    authenticatedAccount: AuthenticatedAccount;
    /**
     * The renderer version being used for the extension.
     *
     * @example 'unstable'
     */
    version: Version;
    /**
     * Details about the language of the buyer.
     */
    localization: Localization;
    /**
     * Utilities for translating content and formatting values according to the current `localization`
     * of the user.
     */
    i18n: I18n;
    /**
     * Key-value storage for the extension target.
     */
    storage: Storage;
    /**
     * Provides access to session tokens, which can be used to verify token claims on your app's server.
     *
     * See [session token examples](https://shopify.dev/docs/api/customer-account-ui-extensions/apis/session-token#examples) for more information.
     */
    sessionToken: SessionToken;
    /**
     * Methods for interacting with [Web Pixels](https://shopify.dev/docs/apps/marketing), such as emitting an event.
     *
     * > Note: Requires to [connect a third-party domain](https://help.shopify.com/en/manual/domains/add-a-domain/connecting-domains/connect-domain-customer-account) to Shopify for your customer account pages.
     */
    analytics: Analytics;
    /**
     * Entry point for Shopify intents.
     *
     * Intents pair an `action` (verb) with a resource `type` and optional `value`
     * and `data` to request a workflow.
     */
    intents: Intents;
    /**
     * The settings matching the settings definition written in the
     * [`shopify.ui.extension.toml`](https://shopify.dev/docs/api/customer-account-ui-extensions/configuration) file.
     *
     *  See [settings examples](https://shopify.dev/docs/api/customer-account-ui-extensions/apis/order-status-api/settings#examples) for more information.
     *
     * > Note: When an extension is being installed in the editor, the settings will be empty until
     * a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.
     */
    settings: SubscribableSignalLike<ExtensionSettings>;
    /**
     * The Toast API displays a non-disruptive message that displays at the bottom
     * of the interface to provide quick, at-a-glance feedback on the outcome
     * of an action.
     *
     * How to use:
     *
     * - Use toasts to confirm successful actions.
     *
     * - Aim for two words.
     *
     * - Use noun + past tense verb format. For example, \`Changes saved\`.
     *
     * For errors, or information that needs to persist on the page, use a [banner](/docs/api/checkout-ui-extensions/polaris-web-components/feedback/banner) component.
     */
    toast: ToastApi;
    /**
     * Used to query the Storefront GraphQL API with a prefetched token.
     *
     * See [storefront api access examples](https://shopify.dev/docs/api/customer-account-ui-extensions/apis/storefront-api#examples) for more information.
     */
    query: <Data = unknown, Variables = {
        [key: string]: unknown;
    }>(query: string, options?: {
        variables?: Variables;
        version?: StorefrontApiVersion;
    }) => Promise<{
        data?: Data;
        errors?: GraphQLError[];
    }>;
    /**
     * Customer privacy consent settings and a flag denoting if consent has previously been collected.
     */
    customerPrivacy: SubscribableSignalLike<CustomerPrivacy>;
    /**
     * Allows setting and updating customer privacy consent settings and tracking consent metafields.
     *
     * > Note: Requires the [`customer_privacy` capability](https://shopify.dev/docs/api/customer-account-ui-extensions/configuration#collect-buyer-consent) to be set to `true`.
     *
     * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
     */
    applyTrackingConsentChange: ApplyTrackingConsentChangeType;
}
export interface CompanyLocationApi {
    locationId: string;
}
export interface FulfillmentApi {
    /**
     * Id of a single fulfillment.
     */
    fulfillmentId: string;
}
export interface ReturnApi {
    /**
     * Id of a single return.
     */
    returnId: string;
}
export interface OrderApi {
    orderId: string;
}
export interface Localization {
    /**
     * The language the buyer sees in the customer account hub.
     */
    language: SubscribableSignalLike<Language>;
    /**
     * This is the buyer's language, as supported by the extension.
     * If the buyer's actual language is not supported by the extension,
     * this is the fallback locale used for translations.
     *
     * For example, if the buyer's language is 'fr-CA' but your extension
     * only supports translations for 'fr', then the `isoCode` for this
     * language is 'fr'. If your extension does not provide french
     * translations at all, this value is the default locale for your
     * extension (that is, the one matching your .default.json file).
     */
    extensionLanguage: SubscribableSignalLike<Language>;
    /**
     * The country context of the buyer sees in the customer account.
     * It will update if the buyer changes the country in the customer account
     * If the country is unknown, then the value is undefined.
     */
    country: SubscribableSignalLike<Country | undefined>;
}
/**
 * An enumerated value representing the type of navigation.
 */
export type NavigationTypeString = 'push' | 'replace' | 'traverse';
export interface NavigationNavigateOptions {
    /**
     * Developer-defined information to be stored in the associated NavigationHistoryEntry once the navigation is complete, retrievable via getState().
     */
    state?: unknown;
    /**
     * An enumerated value that sets the history behavior of this navigation.
     */
    history: 'auto' | 'push' | 'replace';
}
/**
 * The NavigationHistoryEntry interface of the Navigation API represents a single navigation history entry.
 */
export interface NavigationHistoryEntry {
    /** Returns the key of the history entry. This is a unique, UA-generated value that represents the history entry's slot in the entries list rather than the entry itself. */
    key: string;
    /**
     * Returns the URL of this history entry.
     */
    url: string | null;
    /**
     * Returns a clone of the available state associated with this history entry.
     */
    getState(): unknown;
}
export interface NavigationUpdateCurrentEntryOptions {
    state: unknown;
}
/**
 * The NavigationCurrentEntryChangeEvent interface of the Navigation API is the event object for the currententrychange event, which fires when the Navigation.currentEntry has changed.
 */
export interface NavigationCurrentEntryChangeEvent {
    /**
     * Returns the type of the navigation that resulted in the change.
     */
    navigationType?: NavigationTypeString;
    /**
     * Returns the NavigationHistoryEntry that was navigated from.
     */
    from: NavigationHistoryEntry;
}
export interface Navigation {
    /**
     * The navigate() method navigates to a specific URL, updating any provided state in the history entries list.
     */
    navigate: NavigateFunction;
    /**
     * The currentEntry read-only property of the Navigation interface returns a NavigationHistoryEntry object representing the location the user is currently navigated to right now.
     */
    currentEntry: NavigationHistoryEntry;
    /**
     * The updateCurrentEntry() method of the Navigation interface updates the state of the currentEntry; used in cases where the state change will be independent of a navigation or reload.
     */
    updateCurrentEntry(options: NavigationUpdateCurrentEntryOptions): void;
    addEventListener(type: 'currententrychange', cb: (event: NavigationCurrentEntryChangeEvent) => void): void;
    removeEventListener(type: 'currententrychange', cb: (event: NavigationCurrentEntryChangeEvent) => void): void;
}
export interface NavigateFunction {
    /**
     * Navigates to a specific URL, updating any provided state in the history entries list.
     * @param url The destination URL to navigate to.
     */
    (url: string, options?: NavigationNavigateOptions): void;
}
export type Version = string;
//# sourceMappingURL=standard-api.d.ts.map