@automattic/data-stores 3.0.1 → 3.1.0-rc.1

package/dist/types/domain-suggestions/queries.d.ts

@@ -0,0 +1,323 @@
+import type { DomainSuggestion, DomainSuggestionSelectorOptions } from './types';
+export declare function useGetDomainSuggestions(search?: string | null, searchOptions?: DomainSuggestionSelectorOptions, queryOptions?: {}): {
+    invalidateCache: () => Promise<void>;
+    data: DomainSuggestion[];
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoadingError: false;
+    isRefetchError: true;
+    isSuccess: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isPlaceholderData: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD")._ | undefined) => Promise<import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD").ad<DomainSuggestion[], Error>>;
+    fetchStatus: import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD").a6;
+} | {
+    invalidateCache: () => Promise<void>;
+    data: DomainSuggestion[];
+    error: null;
+    isError: false;
+    isPending: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isPlaceholderData: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD")._ | undefined) => Promise<import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD").ad<DomainSuggestion[], Error>>;
+    fetchStatus: import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD").a6;
+} | {
+    invalidateCache: () => Promise<void>;
+    data: undefined;
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoadingError: true;
+    isRefetchError: false;
+    isSuccess: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isPlaceholderData: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD")._ | undefined) => Promise<import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD").ad<DomainSuggestion[], Error>>;
+    fetchStatus: import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD").a6;
+} | {
+    invalidateCache: () => Promise<void>;
+    data: undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isPlaceholderData: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD")._ | undefined) => Promise<import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD").ad<DomainSuggestion[], Error>>;
+    fetchStatus: import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD").a6;
+};
+/**
+ * Returns the expected *.wordpress.com for a given domain name
+ */
+export declare function useGetWordPressSubdomain(paidDomainName?: string | null): {
+    invalidateCache: () => Promise<void>;
+    data: DomainSuggestion[];
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoadingError: false;
+    isRefetchError: true;
+    isSuccess: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isPlaceholderData: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD")._ | undefined) => Promise<import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD").ad<DomainSuggestion[], Error>>;
+    fetchStatus: import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD").a6;
+} | {
+    invalidateCache: () => Promise<void>;
+    data: DomainSuggestion[];
+    error: null;
+    isError: false;
+    isPending: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isPlaceholderData: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD")._ | undefined) => Promise<import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD").ad<DomainSuggestion[], Error>>;
+    fetchStatus: import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD").a6;
+} | {
+    invalidateCache: () => Promise<void>;
+    data: undefined;
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoadingError: true;
+    isRefetchError: false;
+    isSuccess: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isPlaceholderData: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD")._ | undefined) => Promise<import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD").ad<DomainSuggestion[], Error>>;
+    fetchStatus: import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD").a6;
+} | {
+    invalidateCache: () => Promise<void>;
+    data: undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isPlaceholderData: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD")._ | undefined) => Promise<import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD").ad<DomainSuggestion[], Error>>;
+    fetchStatus: import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD").a6;
+};
+/**
+ * Returns a custom .com domain suggestion for a given query
+ */
+export declare function useGetSingleCustomDotComDomainSuggestion(query?: string | null, locale?: string): {
+    invalidateCache: () => Promise<void>;
+    data: DomainSuggestion[];
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoadingError: false;
+    isRefetchError: true;
+    isSuccess: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isPlaceholderData: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD")._ | undefined) => Promise<import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD").ad<DomainSuggestion[], Error>>;
+    fetchStatus: import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD").a6;
+} | {
+    invalidateCache: () => Promise<void>;
+    data: DomainSuggestion[];
+    error: null;
+    isError: false;
+    isPending: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isPlaceholderData: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD")._ | undefined) => Promise<import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD").ad<DomainSuggestion[], Error>>;
+    fetchStatus: import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD").a6;
+} | {
+    invalidateCache: () => Promise<void>;
+    data: undefined;
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoadingError: true;
+    isRefetchError: false;
+    isSuccess: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isPlaceholderData: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD")._ | undefined) => Promise<import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD").ad<DomainSuggestion[], Error>>;
+    fetchStatus: import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD").a6;
+} | {
+    invalidateCache: () => Promise<void>;
+    data: undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isPlaceholderData: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD")._ | undefined) => Promise<import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD").ad<DomainSuggestion[], Error>>;
+    fetchStatus: import("@tanstack/query-core/build/legacy/queryClient-bm-z2rsD").a6;
+};
+//# sourceMappingURL=queries.d.ts.map

package/dist/types/domain-suggestions/queries.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../src/domain-suggestions/queries.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,gBAAgB,EAAE,+BAA+B,EAAE,MAAM,SAAS,CAAC;AAIjF,wBAAgB,uBAAuB,CACtC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,EACtB,aAAa,GAAE,+BAAoC,EACnD,YAAY,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+CjB;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAE,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQvE;AAED;;GAEG;AACH,wBAAgB,wCAAwC,CAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,EAAE,MAAM,CAAC,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQ/F"}

package/dist/types/domain-suggestions/reducer.d.ts

@@ -7,6 +7,6 @@ declare const reducer: Reducer<import("redux").CombinedState<{
     domainSuggestions: DomainSuggestionState;
     availability: DomainAvailabilities;
 }>, Action>;
-export declare type State = ReturnType<typeof reducer>;
+export type State = ReturnType<typeof reducer>;
 export default reducer;
 //# sourceMappingURL=reducer.d.ts.map

package/dist/types/domain-suggestions/reducer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reducer.d.ts","sourceRoot":"","sources":["../../../src/domain-suggestions/reducer.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,KAAK,EAAE,cAAc,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAC3F,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAUrC,eAAO,MAAM,iBAAiB,EAAE,OAAO,CAAE,qBAAqB,EAAE,MAAM,CAsCrE,CAAC;AAmBF,QAAA,MAAM,OAAO;;;;WAAqE,CAAC;AAEnF,oBAAY,KAAK,GAAG,UAAU,CAAE,OAAO,OAAO,CAAE,CAAC;AAEjD,eAAe,OAAO,CAAC"}
+{"version":3,"file":"reducer.d.ts","sourceRoot":"","sources":["../../../src/domain-suggestions/reducer.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,KAAK,EAAE,cAAc,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAC3F,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAUrC,eAAO,MAAM,iBAAiB,EAAE,OAAO,CAAE,qBAAqB,EAAE,MAAM,CAsCrE,CAAC;AAmBF,QAAA,MAAM,OAAO;;;;WAAqE,CAAC;AAEnF,MAAM,MAAM,KAAK,GAAG,UAAU,CAAE,OAAO,OAAO,CAAE,CAAC;AAEjD,eAAe,OAAO,CAAC"}

package/dist/types/domain-suggestions/resolvers.d.ts

@@ -1,7 +1,7 @@
 import type { DomainSuggestion, DomainSuggestionQuery } from './types';
 export declare const isAvailable: (domainName: string) => Generator<{
     readonly type: "FETCH_AND_PARSE";
-    readonly resource: RequestInfo;
+    readonly resource: RequestInfo | URL;
     readonly options: RequestInit | undefined;
 }, {
     readonly type: "RECEIVE_DOMAIN_AVAILABILITY";
@@ -12,7 +12,7 @@ export declare const isAvailable: (domainName: string) => Generator<{
 }>;
 export declare function getCategories(): Generator<{
     readonly type: "FETCH_AND_PARSE";
-    readonly resource: RequestInfo;
+    readonly resource: RequestInfo | URL;
     readonly options: RequestInit | undefined;
 }, {
     readonly type: "RECEIVE_CATEGORIES";
@@ -22,7 +22,7 @@ export declare function getCategories(): Generator<{
 }>;
 export declare function __internalGetDomainSuggestions(queryObject: DomainSuggestionQuery): Generator<{
     type: "WPCOM_REQUEST";
-    request: import("wpcom-proxy-request/types").WpcomRequestParams;
+    request: import("wpcom-proxy-request").WpcomRequestParams;
 } | {
     readonly type: "FETCH_DOMAIN_SUGGESTIONS";
     readonly timeStamp: number;

package/dist/types/domain-suggestions/selectors.d.ts

@@ -8,7 +8,6 @@ export declare const getDomainErrorMessage: (state: State) => string | null;
 export declare const isLoadingDomainSuggestions: (_state: State, search: string, options?: DomainSuggestionSelectorOptions) => boolean;
 /**
  * Do not use this selector. It is for internal use.
- *
  * @param state Store state
  * @param queryObject Normalized object representing the query
  * @returns suggestions

package/dist/types/domain-suggestions/selectors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"selectors.d.ts","sourceRoot":"","sources":["../../../src/domain-suggestions/selectors.ts"],"names":[],"mappings":"AACA,OAAO,EAAa,UAAU,EAAE,MAAM,aAAa,CAAC;AAEpD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,KAAK,EACX,kBAAkB,EAClB,oBAAoB,EACpB,cAAc,EACd,gBAAgB,EAChB,qBAAqB,EACrB,+BAA+B,EAC/B,MAAM,SAAS,CAAC;AAEjB,eAAO,MAAM,aAAa,UAAY,KAAK,KAAI,cAAc,EAU5D,CAAC;AAEF,eAAO,MAAM,oBAAoB,WACxB,KAAK,UACL,MAAM,YACL,+BAA+B,KACtC,gBAAgB,EAAE,GAAG,SAKvB,CAAC;AAEF,eAAO,MAAM,cAAc,UAAY,KAAK,KAAI,UAE/C,CAAC;AAEF,eAAO,MAAM,qBAAqB,UAAY,KAAK,KAAI,MAAM,GAAG,IAE/D,CAAC;AAIF,eAAO,MAAM,0BAA0B,WAC9B,KAAK,UACL,MAAM,YACL,+BAA+B,KACtC,OAMF,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,8BAA8B,UACnC,KAAK,eACC,qBAAqB,KAChC,gBAAgB,EAAE,GAAG,SAEvB,CAAC;AAEF,eAAO,MAAM,WAAW,UAAY,KAAK,cAAc,MAAM,KAAI,kBAAkB,GAAG,SAErF,CAAC;AAEF,eAAO,MAAM,uBAAuB,UAAY,KAAK,KAAI,oBAExD,CAAC"}
+{"version":3,"file":"selectors.d.ts","sourceRoot":"","sources":["../../../src/domain-suggestions/selectors.ts"],"names":[],"mappings":"AACA,OAAO,EAAa,UAAU,EAAE,MAAM,aAAa,CAAC;AAEpD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,KAAK,EACX,kBAAkB,EAClB,oBAAoB,EACpB,cAAc,EACd,gBAAgB,EAChB,qBAAqB,EACrB,+BAA+B,EAC/B,MAAM,SAAS,CAAC;AAEjB,eAAO,MAAM,aAAa,UAAY,KAAK,KAAI,cAAc,EAU5D,CAAC;AAEF,eAAO,MAAM,oBAAoB,WACxB,KAAK,UACL,MAAM,YACL,+BAA+B,KACtC,gBAAgB,EAAE,GAAG,SAWvB,CAAC;AAEF,eAAO,MAAM,cAAc,UAAY,KAAK,KAAI,UAE/C,CAAC;AAEF,eAAO,MAAM,qBAAqB,UAAY,KAAK,KAAI,MAAM,GAAG,IAE/D,CAAC;AAIF,eAAO,MAAM,0BAA0B,WAC9B,KAAK,UACL,MAAM,YACL,+BAA+B,KACtC,OAQF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,8BAA8B,UACnC,KAAK,eACC,qBAAqB,KAChC,gBAAgB,EAAE,GAAG,SAEvB,CAAC;AAEF,eAAO,MAAM,WAAW,UAAY,KAAK,cAAc,MAAM,KAAI,kBAAkB,GAAG,SAErF,CAAC;AAEF,eAAO,MAAM,uBAAuB,UAAY,KAAK,KAAI,oBAExD,CAAC"}

package/dist/types/domain-suggestions/types.d.ts

@@ -1,26 +1,29 @@
+import * as selectors from './selectors';
 import type { DataStatus } from './constants';
+import type { SelectFromMap } from '../mapped-types';
 export interface DomainSuggestionQuery {
     /**
      * True to include .blog subdomain suggestions
-     *
      * @example
      * example.photo.blog
      */
     include_dotblogsubdomain: boolean;
     /**
      * True to include WordPress.com subdomain suggestions
-     *
      * @example
      * example.wordpress.com
      */
     include_wordpressdotcom: boolean;
+    /**
+     * True to include domains registered with wpcom in the response
+     */
+    include_internal_move_eligible?: boolean;
     /**
      * Localizes domain results, e.g., price format
      */
     locale?: string;
     /**
      * True to only provide a wordpress.com subdomain
-     *
      * @example
      * example.wordpress.com
      */
@@ -51,35 +54,30 @@ export interface DomainSuggestionQuery {
      */
     category_slug?: string;
 }
-export declare type DomainName = string;
+export type DomainName = string;
 export interface DomainSuggestion {
     /**
      * The domain name
-     *
      * @example "example.com"
      */
     domain_name: DomainName;
     /**
      * Rendered formatted cost
-     *
      * @example "Free" or "€15.00"
      */
     cost: string;
     /**
      * Raw price
-     *
      * @example 40
      */
     raw_price: number;
     /**
      * Currency code
-     *
      * @example USD
      */
     currency_code: string;
     /**
      * Relevance as a percent: 0 <= relevance <= 1
-     *
      * @example 0.9
      */
     relevance?: number;
@@ -93,7 +91,6 @@ export interface DomainSuggestion {
     vendor?: string;
     /**
      * Reasons for suggestion the domain
-     *
      * @example [ "exact-match" ]
      */
     match_reasons?: readonly string[];
@@ -113,10 +110,17 @@ export interface DomainSuggestion {
      * Whether the domain requires HSTS
      */
     hsts_required?: boolean;
+    /**
+     * Whether the domain requires to show the notice for .gay tld
+     */
+    is_dot_gay_notice_required?: boolean;
     /**
      * Whether the domain is unavailable
      */
     unavailable: boolean;
+    isRecommended?: boolean;
+    isBestAlternative?: boolean;
+    is_premium?: boolean;
 }
 export interface DomainCategory {
     /**
@@ -159,7 +163,6 @@ export interface DomainAvailability {
     product_slug?: string;
     /**
      * Rendered cost with currency
-     *
      * @example "€15.00"
      */
     cost?: string;
@@ -171,9 +174,13 @@ export interface DomainAvailability {
      * Whether the domain requires HSTS
      */
     hsts_required?: boolean;
+    /**
+     * Whether the domain requires to show the notice for .gay tld
+     */
+    is_dot_gay_notice_required?: boolean;
 }
-export declare type TimestampMS = ReturnType<typeof Date.now>;
-export declare type DomainSuggestions = Record<string, DomainSuggestion[] | undefined>;
+export type TimestampMS = ReturnType<typeof Date.now>;
+export type DomainSuggestions = Record<string, DomainSuggestion[] | undefined>;
 export interface DomainSuggestionState {
     /**
      * The state of the DomainSuggestions e.g. pending, failure etc
@@ -196,6 +203,7 @@ export interface DomainSuggestionState {
      */
     pendingSince: TimestampMS | undefined;
 }
-export declare type DomainAvailabilities = Record<string, DomainAvailability | undefined>;
-export declare type DomainSuggestionSelectorOptions = Partial<Exclude<DomainSuggestionQuery, 'query'>>;
+export type DomainAvailabilities = Record<string, DomainAvailability | undefined>;
+export type DomainSuggestionSelectorOptions = Partial<Exclude<DomainSuggestionQuery, 'query'>>;
+export type DomainSuggestionsSelect = SelectFromMap<typeof selectors>;
 //# sourceMappingURL=types.d.ts.map

package/dist/types/domain-suggestions/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/domain-suggestions/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE9C,MAAM,WAAW,qBAAqB;IACrC;;;;;OAKG;IACH,wBAAwB,EAAE,OAAO,CAAC;IAElC;;;;;OAKG;IACH,uBAAuB,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,oBAAY,UAAU,GAAG,MAAM,CAAC;AAEhC,MAAM,WAAW,gBAAgB;IAChC;;;;OAIG;IACH,WAAW,EAAE,UAAU,CAAC;IAExB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAElC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;CACrB;AACD,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IAClC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,oBAAY,WAAW,GAAG,UAAU,CAAE,OAAO,IAAI,CAAC,GAAG,CAAE,CAAC;AAExD,oBAAY,iBAAiB,GAAG,MAAM,CAAE,MAAM,EAAE,gBAAgB,EAAE,GAAG,SAAS,CAAE,CAAC;AAEjF,MAAM,WAAW,qBAAqB;IACrC;;OAEG;IACH,KAAK,EAAE,UAAU,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,iBAAiB,CAAC;IAExB;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC;IAEzB;;OAEG;IACH,YAAY,EAAE,WAAW,GAAG,SAAS,CAAC;CACtC;AAED,oBAAY,oBAAoB,GAAG,MAAM,CAAE,MAAM,EAAE,kBAAkB,GAAG,SAAS,CAAE,CAAC;AAEpF,oBAAY,+BAA+B,GAAG,OAAO,CAAE,OAAO,CAAE,qBAAqB,EAAE,OAAO,CAAE,CAAE,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/domain-suggestions/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,SAAS,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,WAAW,qBAAqB;IACrC;;;;OAIG;IACH,wBAAwB,EAAE,OAAO,CAAC;IAElC;;;;OAIG;IACH,uBAAuB,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAC;IAEzC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAEhC,MAAM,WAAW,gBAAgB;IAChC;;;OAGG;IACH,WAAW,EAAE,UAAU,CAAC;IAExB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAElC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IAErC;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;CACrB;AACD,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IAClC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;CACrC;AAED,MAAM,MAAM,WAAW,GAAG,UAAU,CAAE,OAAO,IAAI,CAAC,GAAG,CAAE,CAAC;AAExD,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAE,MAAM,EAAE,gBAAgB,EAAE,GAAG,SAAS,CAAE,CAAC;AAEjF,MAAM,WAAW,qBAAqB;IACrC;;OAEG;IACH,KAAK,EAAE,UAAU,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,iBAAiB,CAAC;IAExB;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC;IAEzB;;OAEG;IACH,YAAY,EAAE,WAAW,GAAG,SAAS,CAAC;CACtC;AAED,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAE,MAAM,EAAE,kBAAkB,GAAG,SAAS,CAAE,CAAC;AAEpF,MAAM,MAAM,+BAA+B,GAAG,OAAO,CAAE,OAAO,CAAE,qBAAqB,EAAE,OAAO,CAAE,CAAE,CAAC;AAEnG,MAAM,MAAM,uBAAuB,GAAG,aAAa,CAAE,OAAO,SAAS,CAAE,CAAC"}

package/dist/types/domain-suggestions/utils.d.ts

@@ -1,14 +1,12 @@
 import type { DomainSuggestionQuery, DomainSuggestionSelectorOptions } from './types';
 /**
  * Stable transform to an object key for storage and access.
- *
  * @see client/state/domains/suggestions/utils.js
  */
 export declare const stringifyDomainQueryObject: (q: DomainSuggestionQuery) => string;
 /**
  * Formats the domain suggestion price according to 'format-currency' package rules
  * We use this for consistency in prices formats across plans and domains
- *
  * @param price the domain suggestion raw price
  * @param currencyCode the currency code to be used when formatting price
  */
@@ -18,10 +16,8 @@ export declare function getFormattedPrice(price: number, currencyCode: string):
  *
  * It's important to have a consistent, reproduceable representation of a domains query so that the result can be
  * stored and retrieved.
- *
  * @see client/state/domains/suggestions/utils.js
  * @see client/components/data/query-domains-suggestions/index.jsx
- *
  * @param search       Domain search string
  * @param queryOptions Optional paramaters for the query
  * @returns Normalized query object

package/dist/types/domain-suggestions/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/domain-suggestions/utils.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,+BAA+B,EAAE,MAAM,SAAS,CAAC;AAEtF;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,EAAE,CAAE,CAAC,EAAE,qBAAqB,KAAM,MAClD,CAAC;AAExB;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAI,MAAM,CAI/E;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,8BAA8B,CAC7C,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,+BAA+B,GAC3C,qBAAqB,CAevB"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/domain-suggestions/utils.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,+BAA+B,EAAE,MAAM,SAAS,CAAC;AAEtF;;;GAGG;AACH,eAAO,MAAM,0BAA0B,EAAE,CAAE,CAAC,EAAE,qBAAqB,KAAM,MAClD,CAAC;AAExB;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAI,MAAM,CAI/E;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,8BAA8B,CAC7C,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,+BAA+B,GAC3C,qBAAqB,CAevB"}