@brytdesigns/shopify-ajax-predictive-search-api 1.0.5 → 3.0.0

package/dist/main/index.d.ts

@@ -1,32 +1,150 @@
 // Generated by dts-bundle-generator v9.5.1
 
+import * as Cause from 'effect/Cause';
+import * as Context from 'effect/Context';
+import * as Data from 'effect/Data';
+import * as Effect from 'effect/Effect';
+import { HttpClient } from 'effect/http';
+import * as Layer from 'effect/Layer';
+import * as LogLevel from 'effect/LogLevel';
+import * as Pipeable from 'effect/Pipeable';
 import * as Schema from 'effect/Schema';
+import * as Scope from 'effect/Scope';
 
-export type Input = Schema.Schema.Encoded<typeof Input>;
-declare const Input: Schema.extend<Schema.Struct<{
-	sections: Schema.optional<Schema.transform<Schema.Array$<typeof Schema.String>, typeof Schema.String>>;
-	sections_url: Schema.optional<typeof Schema.String>;
-}>, Schema.Struct<{
-	q: typeof Schema.String;
-	resources: Schema.optional<Schema.Struct<{
-		limit: Schema.optionalWith<Schema.filter<typeof Schema.Number>, {
-			default: () => number;
-		}>;
-		limit_scope: Schema.optionalWith<Schema.Literal<[
+declare const Input: Schema.Struct<{
+	readonly sections: Schema.optional<Schema.decodeTo<Schema.String, Schema.$Array<Schema.String>, never, never>>;
+	readonly sections_url: Schema.optional<Schema.String>;
+}>;
+export type UniqueKeys<T extends string> = T extends `${infer K},${infer Rest}` ? K | UniqueKeys<Rest> : T;
+declare function makeResponseSchema<const T extends string>(input: T): Schema.$Record<Schema.Literals<UniqueKeys<T>[]>, Schema.NullOr<Schema.decodeTo<Schema.instanceOf<Element, Element>, Schema.String, never, never>>>;
+declare const Origins: Context.Reference<readonly string[]>;
+declare const layer$1: (origins: readonly string[]) => Layer.Layer<never>;
+export interface IShopifyRoutes {
+	readonly account_addresses_url: string;
+	readonly account_login_url: string;
+	readonly account_logout_url: string;
+	readonly account_recover_url: string;
+	readonly account_register_url: string;
+	readonly account_url: string;
+	readonly all_products_collection_url: string;
+	readonly product_url: string;
+	readonly products_url: string;
+	readonly cart_add_url: string;
+	readonly cart_change_url: string;
+	readonly cart_clear_url: string;
+	readonly cart_update_url: string;
+	readonly cart_url: string;
+	readonly collections_url: string;
+	readonly predictive_search_url: string;
+	readonly product_recommendations_url: string;
+	readonly root_url: string;
+	readonly search_url: string;
+	readonly storefront_login_url: string;
+}
+export interface IStorefrontClientConfig {
+	readonly accessToken: string;
+	readonly shopName: string;
+	apiVersion: string;
+}
+declare const Defaults: IShopifyRoutes;
+declare class ShopifyRoutes extends Data.Class<IShopifyRoutes> {
+	constructor();
+}
+declare const make: () => ShopifyRoutes;
+declare const Routes: Context.Reference<IShopifyRoutes>;
+declare const layer$2: (routes: IShopifyRoutes) => Layer.Layer<never>;
+declare class StorefrontClientConfig extends Data.Class<IStorefrontClientConfig> {
+	constructor();
+}
+declare const make$1: () => StorefrontClientConfig;
+declare const Origin: Context.Reference<string>;
+declare const layer$3: (origin: string) => Layer.Layer<never>;
+declare namespace Sections {
+	export { Input, makeResponseSchema };
+}
+declare namespace StorefrontOrigin {
+	export { Origin, layer$3 as layer$3 };
+}
+declare namespace AllowedRouteOrigins {
+	export { Origins, layer$1 as layer$1 };
+}
+declare namespace ShopifyRoutes$1 {
+	export { Defaults, Routes, ShopifyRoutes, layer$2 as layer$2, make };
+}
+declare namespace StorefrontClientConfig$1 {
+	export { StorefrontClientConfig, make$1 as make$1 };
+}
+declare namespace Window$1 {
+	export { AllowedRouteOrigins, ShopifyRoutes$1 as ShopifyRoutes$1, StorefrontClientConfig$1 as StorefrontClientConfig$1, StorefrontOrigin };
+}
+declare namespace Ajax {
+	export { Sections, Window$1 as Window$1 };
+}
+/**
+ * Every route's input extends Shopify's `sections` pair, decoded.
+ *
+ * Constraining the descriptor on this is what lets {@link execute} read
+ * `decodedInput.sections` and {@link withSections} write it without a cast.
+ */
+export type AjaxInput = typeof Ajax.Sections.Input.Type;
+/**
+ * The same input, encoded — which is what a descriptor actually carries.
+ *
+ * Worth stating plainly because the two differ in a way that bites:
+ * `sections` decodes from `ReadonlyArray<string>` to a comma-joined `string`,
+ * so the encoded side is the array. A descriptor holds encoded input, so
+ * {@link withSections} takes the array form.
+ */
+export type AjaxInputEncoded = typeof Ajax.Sections.Input.Encoded;
+declare const METHODS_BY_URL: {
+	readonly products_url: "get";
+	readonly product_url: "get";
+	readonly predictive_search_url: "get";
+	readonly product_recommendations_url: "get";
+	readonly cart_add_url: "post";
+	readonly cart_update_url: "post";
+	readonly cart_url: "get";
+	readonly cart_change_url: "post";
+	readonly cart_clear_url: "post";
+};
+export type ValidAjaxRoutes = keyof typeof METHODS_BY_URL;
+declare const TypeIdSymbol: unique symbol;
+export type TypeId = typeof TypeIdSymbol;
+/**
+ * A description of a Shopify Ajax request, before it is run.
+ *
+ * The reason this type exists at all: headers, sections and input are consumed
+ * *inside* the request effect, so there is nothing to modify once that effect
+ * has been constructed. `pipe(getCart(), withHeaders(...))` can only work if
+ * the thing in the pipe is a description rather than an `Effect`. {@link execute}
+ * is where the description becomes one.
+ */
+export interface AjaxRequest<A extends AjaxInput, I extends AjaxInputEncoded, RD, B, J, SD> extends Pipeable.Pipeable {
+	readonly [TypeIdSymbol]: TypeId;
+	readonly routeName: ValidAjaxRoutes;
+	readonly inputSchema: Schema.Codec<A, I, RD>;
+	readonly outputSchema: (sections?: string) => Schema.Codec<B, J, SD>;
+	readonly input: I;
+	readonly headers: Readonly<Record<string, string>>;
+}
+type Input$1 = Schema.Codec.Encoded<typeof Input$1>;
+declare const Input$1: Schema.Struct<{
+	readonly sections: Schema.optional<Schema.decodeTo<Schema.String, Schema.$Array<Schema.String>, never, never>>;
+	readonly sections_url: Schema.optional<Schema.String>;
+	readonly q: Schema.String;
+	readonly resources: Schema.optional<Schema.Struct<{
+		readonly limit: Schema.withDecodingDefaultType<Schema.Number, never>;
+		readonly limit_scope: Schema.withDecodingDefaultType<Schema.Literals<readonly [
 			"all",
 			"each"
-		]>, {
-			default: () => "all";
-		}>;
-		options: Schema.optional<Schema.Struct<{
-			unavailable_products: Schema.optionalWith<Schema.Literal<[
+		]>, never>;
+		readonly options: Schema.optional<Schema.Struct<{
+			readonly unavailable_products: Schema.withDecodingDefaultType<Schema.Literals<readonly [
 				"show",
 				"hide",
 				"last"
-			]>, {
-				default: () => "last";
-			}>;
-			fields: Schema.optional<Schema.transform<Schema.Array$<Schema.Literal<[
+			]>, never>;
+			readonly fields: Schema.optional<Schema.decodeTo<Schema.String, Schema.$Array<Schema.Literals<readonly [
 				"author",
 				"body",
 				"product_type",
@@ -36,17 +154,38 @@ declare const Input: Schema.extend<Schema.Struct<{
 				"variants.sku",
 				"variants.title",
 				"vendor"
-			]>>, typeof Schema.String>>;
+			]>>, never, never>>;
 		}>>;
 	}>>;
-}>>;
+}>;
 declare namespace get {
-	type Input = Input;
+	type Input = Input$1;
 }
-declare const get: (input?: ({
+declare const get: (input?: {
+	readonly q: string;
+	readonly resources?: {
+		readonly limit?: number | undefined;
+		readonly limit_scope?: "all" | "each" | undefined;
+		readonly options?: {
+			readonly unavailable_products?: "show" | "hide" | "last" | undefined;
+			readonly fields?: readonly ("author" | "body" | "product_type" | "tag" | "title" | "variants.barcode" | "variants.sku" | "variants.title" | "vendor")[] | undefined;
+		} | undefined;
+	} | undefined;
 	readonly sections?: readonly string[] | undefined;
 	readonly sections_url?: string | undefined;
-} & {
+} | undefined) => AjaxRequest<{
+	readonly q: string;
+	readonly resources?: {
+		readonly limit: number;
+		readonly limit_scope: "all" | "each";
+		readonly options?: {
+			readonly unavailable_products: "show" | "hide" | "last";
+			readonly fields?: string | undefined;
+		} | undefined;
+	} | undefined;
+	readonly sections?: string | undefined;
+	readonly sections_url?: string | undefined;
+}, {
 	readonly q: string;
 	readonly resources?: {
 		readonly limit?: number | undefined;
@@ -56,33 +195,125 @@ declare const get: (input?: ({
 			readonly fields?: readonly ("author" | "body" | "product_type" | "tag" | "title" | "variants.barcode" | "variants.sku" | "variants.title" | "vendor")[] | undefined;
 		} | undefined;
 	} | undefined;
-}) | undefined, options?: {
-	headers?: Record<string, string>;
-}) => import("effect/Effect").Effect<{
-	readonly data?: undefined;
-	readonly error?: {
-		status: number;
-		message: string;
-		description?: string;
-	} | undefined;
-} | {
-	readonly data?: {
-		readonly resources: {
-			readonly results: {
-				readonly queries: readonly {
-					readonly url: string;
-					readonly text: string;
-					readonly styled_text: string;
-				}[];
-				readonly products: readonly {
-					readonly body: string;
+	readonly sections?: readonly string[] | undefined;
+	readonly sections_url?: string | undefined;
+}, never, {
+	readonly resources: {
+		readonly results: {
+			readonly queries: readonly {
+				readonly url: string;
+				readonly text: string;
+				readonly styled_text: string;
+			}[];
+			readonly products: readonly {
+				readonly available: boolean;
+				readonly body: string;
+				readonly compare_at_price_max: number;
+				readonly compare_at_price_min: number;
+				readonly handle: string;
+				readonly id: string | number;
+				readonly image: string | null;
+				readonly price: number;
+				readonly price_max: number;
+				readonly price_min: number;
+				readonly tags: readonly string[];
+				readonly title: string;
+				readonly type: string;
+				readonly url: string;
+				readonly variants: readonly {
+					readonly available: boolean;
+					readonly compare_at_price: number | null;
+					readonly id: string | number;
+					readonly image: string | null;
+					readonly price: number;
 					readonly title: string;
-					readonly vendor: string | null;
 					readonly url: string;
+					readonly featured_image: {
+						readonly aspect_ratio: number | null;
+						readonly alt: string | null;
+						readonly height: number | null;
+						readonly url: string | null;
+						readonly width: number | null;
+					};
+				}[];
+				readonly vendor: string | null;
+				readonly featured_image: {
+					readonly aspect_ratio: number | null;
+					readonly alt: string | null;
+					readonly height: number | null;
+					readonly url: string | null;
+					readonly width: number | null;
+				};
+			}[];
+			readonly collections: readonly {
+				readonly body: string;
+				readonly handle: string;
+				readonly id: string | number;
+				readonly featured_image: {
+					readonly aspect_ratio: number | null;
+					readonly alt: string | null;
+					readonly height: number | null;
+					readonly url: string | null;
+					readonly width: number | null;
+				};
+				readonly published_at: Date;
+				readonly title: string;
+				readonly url: string;
+			}[];
+			readonly pages: readonly {
+				readonly author: string;
+				readonly body: string;
+				readonly handle: string;
+				readonly id: string | number;
+				readonly published_at: Date;
+				readonly title: string;
+				readonly url: string;
+			}[];
+			readonly articles: readonly {
+				readonly author: string;
+				readonly body: string;
+				readonly handle: string;
+				readonly id: string | number;
+				readonly published_at: Date;
+				readonly summary_html: string;
+				readonly tags: readonly string[];
+				readonly title: string;
+				readonly url: string;
+			}[];
+		};
+	};
+}, {
+	readonly resources: {
+		readonly results: {
+			readonly queries?: readonly {
+				readonly url: string;
+				readonly text: string;
+				readonly styled_text: string;
+			}[] | undefined;
+			readonly products?: readonly {
+				readonly body: string;
+				readonly title: string;
+				readonly vendor: string | null;
+				readonly url: string;
+				readonly image: string | null;
+				readonly available: boolean;
+				readonly id: string | number;
+				readonly price: string;
+				readonly featured_image: {
+					readonly aspect_ratio: number | null;
+					readonly alt: string | null;
+					readonly height: number | null;
+					readonly url: string | null;
+					readonly width: number | null;
+				};
+				readonly variants: readonly {
 					readonly available: boolean;
+					readonly compare_at_price: string | null;
 					readonly id: string | number;
 					readonly image: string | null;
-					readonly price: number;
+					readonly price: string;
+					readonly title: string;
+					readonly url: string;
 					readonly featured_image: {
 						readonly aspect_ratio: number | null;
 						readonly alt: string | null;
@@ -90,21 +321,120 @@ declare const get: (input?: ({
 						readonly url: string | null;
 						readonly width: number | null;
 					};
+				}[];
+				readonly compare_at_price_max: string;
+				readonly compare_at_price_min: string;
+				readonly handle: string;
+				readonly price_max: string;
+				readonly price_min: string;
+				readonly type: string;
+				readonly tags?: readonly string[] | undefined;
+			}[] | undefined;
+			readonly collections?: readonly {
+				readonly body: string;
+				readonly handle: string;
+				readonly id: string | number;
+				readonly featured_image: {
+					readonly aspect_ratio: number | null;
+					readonly alt: string | null;
+					readonly height: number | null;
+					readonly url: string | null;
+					readonly width: number | null;
+				};
+				readonly published_at: string;
+				readonly title: string;
+				readonly url: string;
+			}[] | undefined;
+			readonly pages?: readonly {
+				readonly author: string;
+				readonly body: string;
+				readonly handle: string;
+				readonly id: string | number;
+				readonly published_at: string;
+				readonly title: string;
+				readonly url: string;
+			}[] | undefined;
+			readonly articles?: readonly {
+				readonly author: string;
+				readonly body: string;
+				readonly title: string;
+				readonly url: string;
+				readonly id: string | number;
+				readonly handle: string;
+				readonly published_at: string;
+				readonly summary_html: string;
+				readonly tags?: readonly string[] | undefined;
+			}[] | undefined;
+		};
+	};
+}, never>;
+export declare namespace createPredictiveSearchApi {
+	type Options = {
+		debug?: boolean;
+		/**
+		 * Replaces the HTTP layer.
+		 *
+		 * The default is `AjaxClient.layer`, which is `fetch`. Overriding it is
+		 * the only way to exercise this client without a network - the
+		 * alternative was spying on the `layer` export, which tests how the
+		 * module is wired rather than what it sends.
+		 */
+		httpClient?: Layer.Layer<HttpClient.HttpClient>;
+	};
+	type RequestOptions = {
+		signal?: AbortSignal;
+		headers?: Record<string, string>;
+	};
+}
+/**
+ * Creates a predictive search client.
+ *
+ * `get` resolves to the decoded results and **rejects** on failure. There is no
+ * `{ data, error }` envelope: a non-200 rejects with `AjaxResponseError`, and
+ * transport, encode and decode failures reject with Effect's own tagged errors.
+ *
+ * @param options - Optional settings.
+ * @param options.debug - Enables request logging. Default `false`.
+ */
+export declare const createPredictiveSearchApi: ({ debug, httpClient, }?: createPredictiveSearchApi.Options) => {
+	/**
+	 * Runs a predictive search.
+	 *
+	 * @param input - The query, and which resources to search.
+	 * @param options - An `AbortSignal` to cancel with, and custom headers.
+	 * @returns A Promise resolving to the decoded results.
+	 */
+	get: (input?: get.Input, options?: createPredictiveSearchApi.RequestOptions) => Promise<{
+		readonly resources: {
+			readonly results: {
+				readonly queries: readonly {
+					readonly url: string;
+					readonly text: string;
+					readonly styled_text: string;
+				}[];
+				readonly products: readonly {
+					readonly available: boolean;
+					readonly body: string;
 					readonly compare_at_price_max: number;
 					readonly compare_at_price_min: number;
 					readonly handle: string;
+					readonly id: string | number;
+					readonly image: string | null;
+					readonly price: number;
 					readonly price_max: number;
 					readonly price_min: number;
 					readonly tags: readonly string[];
+					readonly title: string;
 					readonly type: string;
+					readonly url: string;
 					readonly variants: readonly {
-						readonly title: string;
-						readonly url: string;
 						readonly available: boolean;
 						readonly compare_at_price: number | null;
 						readonly id: string | number;
 						readonly image: string | null;
 						readonly price: number;
+						readonly title: string;
+						readonly url: string;
 						readonly featured_image: {
 							readonly aspect_ratio: number | null;
 							readonly alt: string | null;
@@ -113,11 +443,18 @@ declare const get: (input?: ({
 							readonly width: number | null;
 						};
 					}[];
+					readonly vendor: string | null;
+					readonly featured_image: {
+						readonly aspect_ratio: number | null;
+						readonly alt: string | null;
+						readonly height: number | null;
+						readonly url: string | null;
+						readonly width: number | null;
+					};
 				}[];
 				readonly collections: readonly {
 					readonly body: string;
-					readonly title: string;
-					readonly url: string;
+					readonly handle: string;
 					readonly id: string | number;
 					readonly featured_image: {
 						readonly aspect_ratio: number | null;
@@ -126,149 +463,32 @@ declare const get: (input?: ({
 						readonly url: string | null;
 						readonly width: number | null;
 					};
-					readonly handle: string;
 					readonly published_at: Date;
+					readonly title: string;
+					readonly url: string;
 				}[];
 				readonly pages: readonly {
 					readonly author: string;
 					readonly body: string;
-					readonly title: string;
-					readonly url: string;
-					readonly id: string | number;
 					readonly handle: string;
+					readonly id: string | number;
 					readonly published_at: Date;
+					readonly title: string;
+					readonly url: string;
 				}[];
 				readonly articles: readonly {
 					readonly author: string;
 					readonly body: string;
-					readonly title: string;
-					readonly url: string;
-					readonly id: string | number;
 					readonly handle: string;
-					readonly tags: readonly string[];
+					readonly id: string | number;
 					readonly published_at: Date;
 					readonly summary_html: string;
+					readonly tags: readonly string[];
+					readonly title: string;
+					readonly url: string;
 				}[];
 			};
 		};
-	} | undefined;
-	readonly error?: {
-		status: number;
-		message: string;
-		description?: string;
-	} | undefined;
-}, Error, import("@effect/platform/HttpClient").HttpClient>;
-export declare namespace createPredictiveSearchApi {
-	type Options = {
-		debug?: boolean;
-	};
-	type RequestOptions = {
-		signal?: AbortSignal;
-		headers?: Record<string, string>;
-	};
-}
-export declare const createPredictiveSearchApi: ({ debug }: {
-	debug?: boolean | undefined;
-}) => {
-	get: (input: get.Input, options?: createPredictiveSearchApi.RequestOptions) => Promise<{
-		readonly data?: undefined;
-		readonly error?: {
-			status: number;
-			message: string;
-			description?: string;
-		} | undefined;
-	} | {
-		readonly data?: {
-			readonly resources: {
-				readonly results: {
-					readonly queries: readonly {
-						readonly url: string;
-						readonly text: string;
-						readonly styled_text: string;
-					}[];
-					readonly products: readonly {
-						readonly body: string;
-						readonly title: string;
-						readonly vendor: string | null;
-						readonly url: string;
-						readonly available: boolean;
-						readonly id: string | number;
-						readonly image: string | null;
-						readonly price: number;
-						readonly featured_image: {
-							readonly aspect_ratio: number | null;
-							readonly alt: string | null;
-							readonly height: number | null;
-							readonly url: string | null;
-							readonly width: number | null;
-						};
-						readonly compare_at_price_max: number;
-						readonly compare_at_price_min: number;
-						readonly handle: string;
-						readonly price_max: number;
-						readonly price_min: number;
-						readonly tags: readonly string[];
-						readonly type: string;
-						readonly variants: readonly {
-							readonly title: string;
-							readonly url: string;
-							readonly available: boolean;
-							readonly compare_at_price: number | null;
-							readonly id: string | number;
-							readonly image: string | null;
-							readonly price: number;
-							readonly featured_image: {
-								readonly aspect_ratio: number | null;
-								readonly alt: string | null;
-								readonly height: number | null;
-								readonly url: string | null;
-								readonly width: number | null;
-							};
-						}[];
-					}[];
-					readonly collections: readonly {
-						readonly body: string;
-						readonly title: string;
-						readonly url: string;
-						readonly id: string | number;
-						readonly featured_image: {
-							readonly aspect_ratio: number | null;
-							readonly alt: string | null;
-							readonly height: number | null;
-							readonly url: string | null;
-							readonly width: number | null;
-						};
-						readonly handle: string;
-						readonly published_at: Date;
-					}[];
-					readonly pages: readonly {
-						readonly author: string;
-						readonly body: string;
-						readonly title: string;
-						readonly url: string;
-						readonly id: string | number;
-						readonly handle: string;
-						readonly published_at: Date;
-					}[];
-					readonly articles: readonly {
-						readonly author: string;
-						readonly body: string;
-						readonly title: string;
-						readonly url: string;
-						readonly id: string | number;
-						readonly handle: string;
-						readonly tags: readonly string[];
-						readonly published_at: Date;
-						readonly summary_html: string;
-					}[];
-				};
-			};
-		} | undefined;
-		readonly error?: {
-			status: number;
-			message: string;
-			description?: string;
-		} | undefined;
 	}>;
 };