@opendoor/partner-sdk-client-vue 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,362 @@
+import { Address } from '../../client-js-core/src/index.ts';
+import { Address as Address_2 } from '../../../../client-js-core/src/index.ts';
+import { AddressSuggestionsResponse } from '../../client-js-core/src/index.ts';
+import { AnswerValue } from '../../../../client-js-core/src/internal/questionnaire/index.ts';
+import { ComponentOptionsMixin } from 'vue';
+import { ComponentProvideOptions } from 'vue';
+import { ComputedRef } from 'vue';
+import { CreateOfferRequest } from '../../client-js-core/src/index.ts';
+import { CreateOfferResponse } from '../../client-js-core/src/index.ts';
+import { DefineComponent } from 'vue';
+import { ExtractPropTypes } from 'vue';
+import { OpendoorAppearance } from '../../client-js-core/src/index.ts';
+import { OpendoorAppearance as OpendoorAppearance_2 } from '../../../../client-js-core/src/index.ts';
+import { OpendoorClient } from '../../client-js-core/src/index.ts';
+import { OpendoorClient as OpendoorClient_2 } from '../../../client-js-core/src/index.ts';
+import { OpendoorClientConfig } from '../../client-js-core/src/index.ts';
+import { OpendoorThemeVariables } from '../../client-js-core/src/index.ts';
+import { PropType } from 'vue';
+import { PublicProps } from 'vue';
+import { resolveAppearance } from '../../client-js-core/src/index.ts';
+import { THEMES } from '../../client-js-core/src/index.ts';
+
+declare const __VLS_component: DefineComponent<ExtractPropTypes<__VLS_TypePropsToRuntimeProps<{
+client: OpendoorClient;
+}>>, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<__VLS_TypePropsToRuntimeProps<{
+client: OpendoorClient;
+}>>> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+
+declare const __VLS_component_2: DefineComponent<ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps_2<{
+enableAddressSuggestions?: boolean;
+debounceMs?: number;
+showAttribution?: boolean;
+disabled?: boolean;
+placeholderText?: string;
+buttonText?: string;
+showButton?: boolean;
+manualEntryText?: string;
+appearance?: OpendoorAppearance_2;
+}>, {
+enableAddressSuggestions: boolean;
+debounceMs: number;
+showAttribution: boolean;
+disabled: boolean;
+placeholderText: string;
+buttonText: string;
+showButton: boolean;
+manualEntryText: string;
+}>>, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+change: (address: Partial<Address_2>) => void;
+error: (error: Error) => void;
+"address-select": (address: Address_2) => void;
+ready: () => void;
+"validation-error": (error: string) => void;
+"address-suggestions-start": (query: string) => void;
+"address-suggestions-complete": (suggestions: Address_2[]) => void;
+}, string, PublicProps, Readonly<ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps_2<{
+enableAddressSuggestions?: boolean;
+debounceMs?: number;
+showAttribution?: boolean;
+disabled?: boolean;
+placeholderText?: string;
+buttonText?: string;
+showButton?: boolean;
+manualEntryText?: string;
+appearance?: OpendoorAppearance_2;
+}>, {
+enableAddressSuggestions: boolean;
+debounceMs: number;
+showAttribution: boolean;
+disabled: boolean;
+placeholderText: string;
+buttonText: string;
+showButton: boolean;
+manualEntryText: string;
+}>>> & Readonly<{
+onChange?: ((address: Partial<Address_2>) => any) | undefined;
+onError?: ((error: Error) => any) | undefined;
+"onAddress-select"?: ((address: Address_2) => any) | undefined;
+onReady?: (() => any) | undefined;
+"onValidation-error"?: ((error: string) => any) | undefined;
+"onAddress-suggestions-start"?: ((query: string) => any) | undefined;
+"onAddress-suggestions-complete"?: ((suggestions: Address_2[]) => any) | undefined;
+}>, {
+enableAddressSuggestions: boolean;
+debounceMs: number;
+showAttribution: boolean;
+disabled: boolean;
+placeholderText: string;
+buttonText: string;
+showButton: boolean;
+manualEntryText: string;
+}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+
+declare type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+
+declare type __VLS_NonUndefinedable_2<T> = T extends undefined ? never : T;
+
+declare type __VLS_NonUndefinedable_3<T> = T extends undefined ? never : T;
+
+declare type __VLS_NonUndefinedable_4<T> = T extends undefined ? never : T;
+
+declare type __VLS_NonUndefinedable_5<T> = T extends undefined ? never : T;
+
+declare type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+
+declare type __VLS_Prettify_2<T> = {
+    [K in keyof T]: T[K];
+} & {};
+
+declare type __VLS_Prettify_3<T> = {
+    [K in keyof T]: T[K];
+} & {};
+
+declare function __VLS_template(): {
+    default?(_: {}): any;
+};
+
+declare function __VLS_template_2(): Readonly<{
+    'button-icon'?: () => unknown;
+    'input-icon'?: () => unknown;
+}> & {
+    'button-icon'?: () => unknown;
+    'input-icon'?: () => unknown;
+};
+
+declare type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: PropType<T[K]>;
+        required: true;
+    };
+};
+
+declare type __VLS_TypePropsToRuntimeProps_2<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: PropType<__VLS_NonUndefinedable_2<T[K]>>;
+    } : {
+        type: PropType<T[K]>;
+        required: true;
+    };
+};
+
+declare type __VLS_TypePropsToRuntimeProps_3<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: PropType<__VLS_NonUndefinedable_3<T[K]>>;
+    } : {
+        type: PropType<T[K]>;
+        required: true;
+    };
+};
+
+declare type __VLS_TypePropsToRuntimeProps_4<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: PropType<__VLS_NonUndefinedable_4<T[K]>>;
+    } : {
+        type: PropType<T[K]>;
+        required: true;
+    };
+};
+
+declare type __VLS_TypePropsToRuntimeProps_5<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: PropType<__VLS_NonUndefinedable_5<T[K]>>;
+    } : {
+        type: PropType<T[K]>;
+        required: true;
+    };
+};
+
+declare type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+
+declare type __VLS_WithDefaults_2<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify_2<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+
+declare type __VLS_WithDefaults_3<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify_3<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+
+declare type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
+declare type __VLS_WithTemplateSlots_2<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
+export { Address }
+
+export declare const AddressEntry: __VLS_WithTemplateSlots_2<typeof __VLS_component_2, ReturnType<typeof __VLS_template_2>>;
+
+export declare const AddressMap: DefineComponent<ExtractPropTypes<__VLS_WithDefaults_2<__VLS_TypePropsToRuntimeProps_3<{
+address: Address_2;
+appearance?: OpendoorAppearance_2;
+mapboxAccessToken?: string;
+mapPinMarker?: string;
+width?: number;
+height?: number;
+zoom?: number;
+borderRadius?: string;
+}>, {
+width: number;
+height: number;
+zoom: number;
+}>>, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+error: (error: Error) => void;
+load: () => void;
+}, string, PublicProps, Readonly<ExtractPropTypes<__VLS_WithDefaults_2<__VLS_TypePropsToRuntimeProps_3<{
+address: Address_2;
+appearance?: OpendoorAppearance_2;
+mapboxAccessToken?: string;
+mapPinMarker?: string;
+width?: number;
+height?: number;
+zoom?: number;
+borderRadius?: string;
+}>, {
+width: number;
+height: number;
+zoom: number;
+}>>> & Readonly<{
+onError?: ((error: Error) => any) | undefined;
+onLoad?: (() => any) | undefined;
+}>, {
+width: number;
+height: number;
+zoom: number;
+}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+
+export { AddressSuggestionsResponse }
+
+export declare const AddressUnitConfirmation: DefineComponent<ExtractPropTypes<__VLS_TypePropsToRuntimeProps_4<{
+address: Address_2;
+appearance?: OpendoorAppearance_2;
+}>>, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+error: (error: Error) => void;
+ready: () => void;
+confirm: (address: Address_2) => void;
+edit: () => void;
+}, string, PublicProps, Readonly<ExtractPropTypes<__VLS_TypePropsToRuntimeProps_4<{
+address: Address_2;
+appearance?: OpendoorAppearance_2;
+}>>> & Readonly<{
+onError?: ((error: Error) => any) | undefined;
+onReady?: (() => any) | undefined;
+onConfirm?: ((address: Address_2) => any) | undefined;
+onEdit?: (() => any) | undefined;
+}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+
+export { CreateOfferRequest }
+
+export { CreateOfferResponse }
+
+export declare const DtcOnboardingFlow: DefineComponent<ExtractPropTypes<__VLS_WithDefaults_3<__VLS_TypePropsToRuntimeProps_5<{
+/** The selected address for the offer. */
+address: Address_2;
+/** URL to the partner's logo image. Displayed in the header next to "Opendoor". */
+partnerLogoUrl?: string;
+/** Theme customization. Uses 'minimal' defaults if not provided. */
+appearance?: OpendoorAppearance_2;
+/** Pre-filled answers (e.g., from address lookup or prior session). */
+initialAnswers?: Record<string, AnswerValue>;
+/** Market identifier for market-dependent questions (e.g., eligibility criteria). */
+market?: string;
+/**
+* Called when the close (X) button is clicked.
+* When provided, the close button is rendered in the header.
+* When omitted, no close button is shown (matches React parity).
+*/
+onClose?: () => void;
+}>, {
+appearance: () => {
+theme: "minimal";
+};
+}>>, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+error: (error: Error) => void;
+submit: (answers: Record<string, AnswerValue>) => void;
+ready: () => void;
+"page-change": (pageIndex: number, pageId: string) => void;
+"answer-change": (key: string, value: AnswerValue) => void;
+}, string, PublicProps, Readonly<ExtractPropTypes<__VLS_WithDefaults_3<__VLS_TypePropsToRuntimeProps_5<{
+/** The selected address for the offer. */
+address: Address_2;
+/** URL to the partner's logo image. Displayed in the header next to "Opendoor". */
+partnerLogoUrl?: string;
+/** Theme customization. Uses 'minimal' defaults if not provided. */
+appearance?: OpendoorAppearance_2;
+/** Pre-filled answers (e.g., from address lookup or prior session). */
+initialAnswers?: Record<string, AnswerValue>;
+/** Market identifier for market-dependent questions (e.g., eligibility criteria). */
+market?: string;
+/**
+* Called when the close (X) button is clicked.
+* When provided, the close button is rendered in the header.
+* When omitted, no close button is shown (matches React parity).
+*/
+onClose?: () => void;
+}>, {
+appearance: () => {
+theme: "minimal";
+};
+}>>> & Readonly<{
+onError?: ((error: Error) => any) | undefined;
+onSubmit?: ((answers: Record<string, AnswerValue>) => any) | undefined;
+onReady?: (() => any) | undefined;
+"onPage-change"?: ((pageIndex: number, pageId: string) => any) | undefined;
+"onAnswer-change"?: ((key: string, value: AnswerValue) => any) | undefined;
+}>, {
+appearance: OpendoorAppearance_2;
+}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+
+export { OpendoorAppearance }
+
+export { OpendoorClient }
+
+export { OpendoorClientConfig }
+
+export declare const OpendoorProvider: __VLS_WithTemplateSlots<typeof __VLS_component, ReturnType<typeof __VLS_template>>;
+
+export { OpendoorThemeVariables }
+
+export { resolveAppearance }
+
+export { THEMES }
+
+/**
+ * Access the OpendoorClient provided by {@link OpendoorProvider}.
+ * Must be called inside a component wrapped in `<OpendoorProvider>`.
+ *
+ * Returns a `ComputedRef` so the value stays reactive — if the parent
+ * changes the `client` prop on `OpendoorProvider`, consumers automatically
+ * see the new client when accessing `.value`.
+ *
+ * @throws Error if called outside of an `<OpendoorProvider>`.
+ *
+ * @example
+ * ```vue
+ * <script setup lang="ts">
+ * import { useOpendoorClient } from '@opendoor/partner-sdk-client-vue';
+ * const client = useOpendoorClient();
+ * const suggestions = await client.value.getAddressSuggestions('123 Main');
+ * </script>
+ * ```
+ */
+export declare function useOpendoorClient(): ComputedRef<OpendoorClient_2>;
+
+export { }