@brytdesigns/shopify-ajax-client 1.0.7 → 3.0.0

package/dist/main/index.d.ts

@@ -1,11 +1,115 @@
 // Generated by dts-bundle-generator v9.5.1
 
-import * as HttpClient from '@effect/platform/HttpClient';
+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';
 
+/**
+ * The shape Shopify returns in a non-200 response body.
+ *
+ * Distinct from {@link AjaxResponseError}: this is plain decoded JSON, that is
+ * the tagged error we raise from it. v3's looser response types let the two be
+ * conflated by a cast; v4 does not.
+ */
+export interface AjaxErrorBody {
+	status: number;
+	message: string;
+	description: string;
+}
+declare const AjaxResponseError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").VoidIfEmpty<{
+	readonly [P in keyof A as P extends "_tag" ? never : P]: A[P];
+}>) => import("effect/Cause").YieldableError & {
+	readonly _tag: "@brytdesigns/ajax-client/AjaxResponseError";
+} & Readonly<A>;
+/**
+ * A non-200 response from a Shopify Ajax route.
+ *
+ * This is the error channel's version of what used to be
+ * `AjaxClientResponse.error`. The envelope made every failure look like a
+ * success carrying an error payload, so each of the nine call sites in
+ * `shopify-ajax-cart` re-raised it by hand — with `throw response.error`,
+ * which threw a plain object with no stack and no `_tag`. Failing properly
+ * means `Effect.catchTag("...AjaxResponseError", ...)` works upstream, and
+ * `instanceof` works for plain-JS consumers once the facade squashes it.
+ *
+ * `route` is carried because the status and message alone rarely identify
+ * which request failed when several are in flight.
+ */
+export declare class AjaxResponseError extends AjaxResponseError_base<{
+	status: number;
+	message: string;
+	description?: string;
+	route: string;
+}> {
+}
+declare const InvalidAjaxMethodError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").VoidIfEmpty<{
+	readonly [P in keyof A as P extends "_tag" ? never : P]: A[P];
+}>) => import("effect/Cause").YieldableError & {
+	readonly _tag: "@brytdesigns/ajax-client/InvalidAjaxMethodError";
+} & Readonly<A>;
+/**
+ * A route was declared with an HTTP method this client cannot issue.
+ *
+ * Not reachable while every route in `METHODS_BY_URL` is `get` or `post`, which
+ * is all of them today. It is what `execute`'s method dispatch fails with if
+ * that stops being true. The alternative — a POST-or-else-GET fallback — would
+ * quietly issue a GET for a route declared as anything else.
+ */
+export declare class InvalidAjaxMethodError extends InvalidAjaxMethodError_base<{
+	message: string;
+}> {
+	constructor();
+}
+declare const UnsafeAjaxRouteError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").VoidIfEmpty<{
+	readonly [P in keyof A as P extends "_tag" ? never : P]: A[P];
+}>) => import("effect/Cause").YieldableError & {
+	readonly _tag: "@brytdesigns/ajax-client/UnsafeAjaxRouteError";
+} & Readonly<A>;
+/**
+ * A route in the table did not resolve to the storefront origin.
+ *
+ * The table is `{ ...Defaults, ...window.BrytDesigns.routes }`, so anything
+ * that can set that global contributes paths which every cart request is then
+ * sent to — with the shopper's session cookies attached. The old
+ * `` `${origin}${route}` `` concatenation made that an off-origin POST for a
+ * route as unremarkable-looking as `"@evil.com/collect"`, because
+ * `https://shop.myshopify.com@evil.com/collect` parses `shop.myshopify.com`
+ * as userinfo and `evil.com` as the host.
+ *
+ * Calibration: whoever can write `window.BrytDesigns.routes` can usually
+ * patch `fetch` too, so this is defence in depth rather than a privilege
+ * boundary. It earns its place by also catching the honest typo — a route of
+ * `"cart.js"` concatenated to an origin yielded
+ * `https://shop.myshopify.comcart.js`, which fails as a DNS error somewhere
+ * far from the mistake.
+ */
+export declare class UnsafeAjaxRouteError extends UnsafeAjaxRouteError_base<{
+	message: string;
+	route: string;
+	routeName: string;
+	origin: string;
+}> {
+	constructor(options: {
+		route: string;
+		routeName: string;
+		origin: string;
+	});
+}
+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;
@@ -38,94 +142,180 @@ 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 Input: Schema.Struct<{
-	sections: Schema.optional<Schema.transform<Schema.Array$<typeof Schema.String>, typeof Schema.String>>;
-	sections_url: Schema.optional<typeof 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.SchemaClass<UniqueKeys<T>, UniqueKeys<T>, never>, Schema.NullOr<Schema.transformOrFail<typeof Schema.String, Schema.instanceOf<Element>, never>>>;
-declare namespace StorefrontClientConfig$1 {
-	export { StorefrontClientConfig, make$1 as make$1 };
+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, ShopifyRoutes, make };
+	export { Defaults, Routes, ShopifyRoutes, layer$2 as layer$2, make };
 }
-declare namespace Window$1 {
-	export { ShopifyRoutes$1 as ShopifyRoutes$1, StorefrontClientConfig$1 as StorefrontClientConfig$1 };
+declare namespace StorefrontClientConfig$1 {
+	export { StorefrontClientConfig, make$1 as make$1 };
 }
-declare namespace Sections {
-	export { Input, makeResponseSchema };
+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 };
 }
 /**
- * Represents a response from an AJAX client.
+ * Every route's input extends Shopify's `sections` pair, decoded.
  *
- * @template TData - The type of data expected in the response.
+ * Constraining the descriptor on this is what lets {@link execute} read
+ * `decodedInput.sections` and {@link withSections} write it without a cast.
  */
-export interface IAjaxClientResponse<TData = any> {
-	/**
-	 * The data received from the server.
-	 */
-	data?: TData;
-	/**
-	 * An error object if the request failed.
-	 */
-	error?: {
-		/**
-		 * The HTTP status code of the error response.
-		 */
-		status: number;
-		/**
-		 * A brief description of the error.
-		 */
-		message: string;
-		/**
-		 * A more detailed description of the error.
-		 */
-		description?: string;
-	};
-}
-declare class AjaxClientResponse<TData = any> extends Data.Class<IAjaxClientResponse<TData>> {
-}
+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 BaseOutputSchema: Schema.Struct<{}>;
-declare const ProductInputSchema: 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<{
-	handle: typeof Schema.String;
-}>>;
-export declare const Default: import("effect/Layer").Layer<HttpClient.HttpClient, never, never>;
-export type ValidAjaxRoutes = keyof Pick<Ajax.Window.ShopifyRoutes.ShopifyRoutes, "product_url" | "products_url" | "predictive_search_url" | "product_recommendations_url" | "cart_add_url" | "cart_update_url" | "cart_url" | "cart_change_url" | "cart_clear_url">;
+declare const ProductInputSchema: Schema.Struct<{
+	readonly sections: Schema.optional<Schema.decodeTo<Schema.String, Schema.$Array<Schema.String>, never, never>>;
+	readonly sections_url: Schema.optional<Schema.String>;
+	readonly handle: Schema.String;
+}>;
+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>>;
+}
+/** Narrows an unknown value to an {@link AjaxRequest}. */
+export declare const isAjaxRequest: (u: unknown) => u is AjaxRequest<AjaxInput, AjaxInputEncoded, unknown, unknown, unknown, unknown>;
 /**
- * A factory function that creates an Effect to make AJAX requests to Shopify routes.
- *
- * @template RouteName - The type of Shopify route to make the request to.
- * @template A - The type of input data for the request.
- * @template I - The type of input data after decoding.
- * @template R - The type of input data after decoding, but with additional information.
- * @template B - The type of output data expected from the request.
- * @template J - The type of output data after decoding.
- * @template S - The type of output data after decoding, but with additional information.
- *
- * @param {object} params - The parameters for creating the factory function.
- * @param {RouteName} params.routeName - The name of the Shopify route to make the request to.
- * @param {Schema<A, I, R>} params.inputSchema - The schema for validating and decoding the input data.
- * @param {Schema<B, J, S>} params.outputSchema - The schema for validating and decoding the output data.
- *
- * - A function that takes input data and options, and returns an Effect to make the AJAX request.
+ * Builds a route constructor.
+ *
+ * Replaces `makeFactory`. The difference is only in what the returned function
+ * gives back: a description that can be piped through the combinators below,
+ * rather than an `Effect` that is already closed over its headers.
+ *
+ * @example
+ * ```ts
+ * const getCart = Request.makeRoute({
+ *   routeName: "cart_url",
+ *   inputSchema: CartGetInput,
+ *   outputSchema: makeCartOutput,
+ * });
+ *
+ * pipe(
+ *   getCart(),
+ *   Request.withSections("cart-drawer"),
+ *   Request.withHeader("X-Foo", "1"),
+ *   Request.execute,
+ * );
+ * ```
  */
-export declare const makeFactory: <RouteName extends ValidAjaxRoutes, A extends RouteName extends "product_url" ? typeof ProductInputSchema.Type : typeof Ajax.Sections.Input.Type, I, R, B extends typeof BaseOutputSchema.Type, J, S>({ routeName, inputSchema, outputSchema, }: {
+export declare const makeRoute: <RouteName extends ValidAjaxRoutes, A extends RouteName extends "product_url" ? typeof ProductInputSchema.Type : AjaxInput, I extends AjaxInputEncoded, RD, B extends typeof BaseOutputSchema.Type, J, SD>({ routeName, inputSchema, outputSchema, }: {
 	routeName: RouteName;
-	inputSchema: Schema.Schema<A, I, R>;
-	outputSchema: Schema.Schema<B, J, S>;
-}) => (input?: Schema.Schema<A, I, R>["Encoded"], options?: {
-	headers?: Record<string, string>;
-}) => Effect.Effect<AjaxClientResponse<undefined> | AjaxClientResponse<B>, Error, HttpClient.HttpClient | Exclude<R, import("effect/Scope").Scope> | Exclude<S, import("effect/Scope").Scope>>;
+	inputSchema: Schema.Codec<A, I, RD>;
+	/**
+	 * Built per request from the caller's `sections` input.
+	 *
+	 * v4's schema extension (`fieldsAssign` / `extendTo`) only applies to a
+	 * `Struct`, and output schemas here are transforms. Composing the
+	 * sections field is therefore the caller's job - it holds the
+	 * pre-transform struct and can extend that instead.
+	 */
+	outputSchema: (sections?: string) => Schema.Codec<B, J, SD>;
+}) => (input?: I) => AjaxRequest<A, I, RD, B, J, SD>;
+/**
+ * Merges headers into the request, right-biased.
+ *
+ * Dual: `withHeaders(request, h)` and `pipe(request, withHeaders(h))` are the
+ * same call.
+ */
+export declare const withHeaders: {
+	(headers: Readonly<Record<string, string>>): <A extends AjaxInput, I extends AjaxInputEncoded, RD, B, J, SD>(self: AjaxRequest<A, I, RD, B, J, SD>) => AjaxRequest<A, I, RD, B, J, SD>;
+	<A extends AjaxInput, I extends AjaxInputEncoded, RD, B, J, SD>(self: AjaxRequest<A, I, RD, B, J, SD>, headers: Readonly<Record<string, string>>): AjaxRequest<A, I, RD, B, J, SD>;
+};
+/** Sets a single header. Dual. */
+export declare const withHeader: {
+	(name: string, value: string): <A extends AjaxInput, I extends AjaxInputEncoded, RD, B, J, SD>(self: AjaxRequest<A, I, RD, B, J, SD>) => AjaxRequest<A, I, RD, B, J, SD>;
+	<A extends AjaxInput, I extends AjaxInputEncoded, RD, B, J, SD>(self: AjaxRequest<A, I, RD, B, J, SD>, name: string, value: string): AjaxRequest<A, I, RD, B, J, SD>;
+};
+/** Replaces the request input wholesale. Dual. */
+export declare const withInput: {
+	<I extends AjaxInputEncoded>(input: I): <A extends AjaxInput, RD, B, J, SD>(self: AjaxRequest<A, I, RD, B, J, SD>) => AjaxRequest<A, I, RD, B, J, SD>;
+	<A extends AjaxInput, I extends AjaxInputEncoded, RD, B, J, SD>(self: AjaxRequest<A, I, RD, B, J, SD>, input: I): AjaxRequest<A, I, RD, B, J, SD>;
+};
+/**
+ * Asks Shopify to re-render `sections` alongside the response.
+ *
+ * Sugar over {@link withInput} for the one input field every route shares, and
+ * the field {@link AjaxRequest.outputSchema} is keyed on. Dual.
+ */
+export declare const withSections: {
+	(sections: string | ReadonlyArray<string>): <A extends AjaxInput, I extends AjaxInputEncoded, RD, B, J, SD>(self: AjaxRequest<A, I, RD, B, J, SD>) => AjaxRequest<A, I, RD, B, J, SD>;
+	<A extends AjaxInput, I extends AjaxInputEncoded, RD, B, J, SD>(self: AjaxRequest<A, I, RD, B, J, SD>, sections: string | ReadonlyArray<string>): AjaxRequest<A, I, RD, B, J, SD>;
+};
+/**
+ * Runs the description.
+ *
+ * Named rather than untraced: this is the one place in the package worth a
+ * span, and upstream's guidance is to reserve `Effect.fn` for genuine tracing
+ * boundaries and prefer `fnUntraced` inside library internals. Transforms are
+ * passed as trailing arguments because `Effect.fn` explicitly must not be
+ * `.pipe`d.
+ *
+ * Errors are left as they come. `RequestError`, `ResponseError`, `ParseError`
+ * and `HttpBodyError` are already tagged, and flattening them into a plain
+ * `Error` — which this package used to do — destroyed the only machine-readable
+ * thing about them.
+ */
+export declare const execute: <A extends AjaxInput, I extends AjaxInputEncoded, RD, B, J, SD>(self: AjaxRequest<A, I, RD, B, J, SD>) => Effect.Effect<B, AjaxResponseError | InvalidAjaxMethodError | UnsafeAjaxRouteError | Schema.SchemaError | import("effect/http/HttpClientError").HttpClientError | import("effect/http/HttpBody").HttpBodyError, HttpClient.HttpClient | Exclude<RD, import("effect/Scope").Scope> | Exclude<SD, import("effect/Scope").Scope>>;
+/** Named `layer` per the v4 convention, which replaces v3's `Default`/`Live`. */
+export declare const layer: import("effect/Layer").Layer<import("effect/http/HttpClient").HttpClient, never, never>;
+
+declare namespace Request$1 {
+	export { AjaxInput, AjaxInputEncoded, AjaxRequest, TypeId, ValidAjaxRoutes, execute, isAjaxRequest, makeRoute, withHeader, withHeaders, withInput, withSections };
+}
+
+export {
+	Request$1 as Request,
+};
 
 export {};

package/dist/main/index.js

@@ -1,158 +1,10 @@
-import * as Effect from 'effect/Effect';
-import * as Schema from 'effect/Schema';
-import * as Function from 'effect/Function';
-import * as HttpClient from '@effect/platform/HttpClient';
-import * as HttpClientResponse from '@effect/platform/HttpClientResponse';
-import * as HttpClientRequest from '@effect/platform/HttpClientRequest';
-import * as FetchHttpClient from '@effect/platform/FetchHttpClient';
-import { Ajax } from '@brytdesigns/shopify-utils/effect';
-import * as LoggerUtils from './LoggerUtils.js';
-import { InvalidAjaxMethodError } from './errors.js';
-import * as AjaxClientResponse from './AjaxClientResponse.js';
+import { AjaxResponseError, InvalidAjaxMethodError, UnsafeAjaxRouteError } from "./errors.js";
+import { Request_exports, execute, isAjaxRequest, makeRoute, withHeader, withHeaders, withInput, withSections } from "./Request.js";
+import { FetchHttpClient } from "effect/http";
+//#region src/index.ts
+/** Named `layer` per the v4 convention, which replaces v3's `Default`/`Live`. */
+var layer = FetchHttpClient.layer;
+//#endregion
+export { AjaxResponseError, InvalidAjaxMethodError, Request_exports as Request, UnsafeAjaxRouteError, execute, isAjaxRequest, layer, makeRoute, withHeader, withHeaders, withInput, withSections };
 
-Schema.Struct({});
-Schema.extend(
-  Ajax.Sections.Input,
-  Schema.Struct({
-    handle: Schema.String
-  })
-);
-const Default = FetchHttpClient.layer;
-const METHOD = {
-  GET: "get",
-  POST: "post"
-};
-const METHODS_BY_URL = {
-  products_url: METHOD.GET,
-  product_url: METHOD.GET,
-  predictive_search_url: METHOD.GET,
-  product_recommendations_url: METHOD.GET,
-  cart_add_url: METHOD.POST,
-  cart_update_url: METHOD.POST,
-  cart_url: METHOD.GET,
-  cart_change_url: METHOD.POST,
-  cart_clear_url: METHOD.POST
-};
-const makeFactory = ({
-  routeName,
-  inputSchema,
-  outputSchema
-}) => (input, options) => Effect.gen(function* () {
-  const client = yield* HttpClient.HttpClient;
-  const decodedInput = yield* Schema.decodeUnknown(inputSchema)(
-    input || {}
-  );
-  const routes = Ajax.Window.ShopifyRoutes.make();
-  let route;
-  if (routeName === "product_url" && "handle" in decodedInput) {
-    route = routes[routeName].replace(":handle", decodedInput.handle);
-  } else {
-    route = routes[routeName];
-  }
-  const url = `${window.location.origin}${route}`;
-  const method = METHODS_BY_URL[routeName];
-  let request;
-  if (method === "post") {
-    request = yield* HttpClientRequest.post(url, {
-      acceptJson: true,
-      headers: {
-        "X-SDK-Variant": "brytdesigns",
-        "X-SDK-Variant-Source": "shopify-ajax-client",
-        ...options?.headers || {}
-      }
-    }).pipe(HttpClientRequest.bodyJson(decodedInput));
-  } else if (method === "get") {
-    request = HttpClientRequest.get(url, {
-      acceptJson: true,
-      headers: {
-        "X-SDK-Variant": "brytdesigns",
-        "X-SK-Variant-Source": "shopify-ajax-client",
-        ...options?.headers || {}
-      }
-    }).pipe(HttpClientRequest.setUrlParams(decodedInput));
-  } else {
-    return yield* Effect.fail(new InvalidAjaxMethodError());
-  }
-  const response = yield* client.execute(request);
-  if (response.status !== 200) {
-    const data = yield* response.json;
-    return AjaxClientResponse.make({
-      error: {
-        description: data.description,
-        status: data.status,
-        message: data.message
-      }
-    });
-  }
-  if (decodedInput.sections) {
-    const output2 = outputSchema.pipe(
-      Schema.extend(
-        Schema.Struct({
-          sections: Ajax.Sections.makeResponseSchema(decodedInput.sections)
-        })
-      )
-    );
-    const json2 = yield* Function.pipe(
-      response,
-      HttpClientResponse.schemaBodyJson(output2)
-    );
-    const clientResponse2 = AjaxClientResponse.make({
-      data: json2
-    });
-    yield* Effect.annotateLogsScoped({
-      method,
-      route,
-      input: decodedInput,
-      output: clientResponse2
-    });
-    return clientResponse2;
-  }
-  const output = outputSchema;
-  const json = yield* Function.pipe(
-    response,
-    HttpClientResponse.schemaBodyJson(output)
-  );
-  const clientResponse = AjaxClientResponse.make({
-    data: json
-  });
-  yield* Effect.annotateLogsScoped({
-    method,
-    route,
-    input: decodedInput,
-    output: clientResponse
-  });
-  yield* Effect.logInfo("Request");
-  return clientResponse;
-}).pipe(
-  Effect.scoped,
-  LoggerUtils.withNamespacedLogSpan(
-    routeName.replace("_url", "").replace("_", ":")
-  ),
-  Effect.catchAll((error) => {
-    if (error._tag === "ParseError" || error._tag === "RequestError" || error._tag === "ResponseError" || error._tag === "@brytdesigns/ajax-client/InvalidAjaxMethodError") {
-      return Effect.fail(
-        new Error(error.message, {
-          cause: error.cause
-        })
-      );
-    }
-    if (error._tag === "HttpBodyError") {
-      const reason = error.reason;
-      if (reason._tag === "JsonError") {
-        return Effect.fail(new Error("Failed to parse JSON response"));
-      }
-      if (reason._tag === "SchemaError") {
-        return Effect.fail(
-          new Error(reason.error.message, {
-            cause: reason.error.cause
-          })
-        );
-      }
-    }
-    return Effect.fail(new Error(error.toString()));
-  })
-);
-
-export { Default, makeFactory };
-//# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/dist/main/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts"],"names":["output","json","clientResponse"],"mappings":";;;;;;;;;;;;AAcyB,MAAA,CAAO,MAAO,CAAA,EAAE;AACd,MAAO,CAAA,MAAA;AAAA,EAChC,KAAK,QAAS,CAAA,KAAA;AAAA,EACd,OAAO,MAAO,CAAA;AAAA,IACZ,QAAQ,MAAO,CAAA;AAAA,GAChB;AACH;AAEO,MAAM,UAAU,eAAgB,CAAA;AAEvC,MAAM,MAAS,GAAA;AAAA,EACb,GAAK,EAAA,KAAA;AAAA,EACL,IAAM,EAAA;AACR,CAAA;AAEA,MAAM,cAAiB,GAAA;AAAA,EACrB,cAAc,MAAO,CAAA,GAAA;AAAA,EACrB,aAAa,MAAO,CAAA,GAAA;AAAA,EACpB,uBAAuB,MAAO,CAAA,GAAA;AAAA,EAC9B,6BAA6B,MAAO,CAAA,GAAA;AAAA,EACpC,cAAc,MAAO,CAAA,IAAA;AAAA,EACrB,iBAAiB,MAAO,CAAA,IAAA;AAAA,EACxB,UAAU,MAAO,CAAA,GAAA;AAAA,EACjB,iBAAiB,MAAO,CAAA,IAAA;AAAA,EACxB,gBAAgB,MAAO,CAAA;AACzB,CAAA;AAiCO,MAAM,cACX,CAUE;AAAA,EACA,SAAA;AAAA,EACA,WAAA;AAAA,EACA;AACF,CAAA,KAKA,CACE,KAAA,EACA,OAEA,KAAA,MAAA,CAAO,IAAI,aAAa;AACtB,EAAM,MAAA,MAAA,GAAS,OAAO,UAAW,CAAA,UAAA;AACjC,EAAA,MAAM,YAAe,GAAA,OAAO,MAAO,CAAA,aAAA,CAAc,WAAW,CAAA;AAAA,IAC1D,SAAS;AAAC,GACZ;AACA,EAAA,MAAM,MAAS,GAAA,IAAA,CAAK,MAAO,CAAA,aAAA,CAAc,IAAK,EAAA;AAE9C,EAAI,IAAA,KAAA;AAEJ,EAAI,IAAA,SAAA,KAAc,aAAiB,IAAA,QAAA,IAAY,YAAc,EAAA;AAC3D,IAAA,KAAA,GAAQ,OAAO,SAAS,CAAA,CAAE,OAAQ,CAAA,SAAA,EAAW,aAAa,MAAM,CAAA;AAAA,GAC3D,MAAA;AACL,IAAA,KAAA,GAAQ,OAAO,SAAS,CAAA;AAAA;AAG1B,EAAA,MAAM,MAAM,CAAG,EAAA,MAAA,CAAO,QAAS,CAAA,MAAM,GAAG,KAAK,CAAA,CAAA;AAC7C,EAAM,MAAA,MAAA,GAAS,eAAe,SAAS,CAAA;AAEvC,EAAI,IAAA,OAAA;AAEJ,EAAA,IAAI,WAAW,MAAQ,EAAA;AACrB,IAAU,OAAA,GAAA,OAAO,iBAAkB,CAAA,IAAA,CAAK,GAAK,EAAA;AAAA,MAC3C,UAAY,EAAA,IAAA;AAAA,MACZ,OAAS,EAAA;AAAA,QACP,eAAiB,EAAA,aAAA;AAAA,QACjB,sBAAwB,EAAA,qBAAA;AAAA,QACxB,GAAI,OAAS,EAAA,OAAA,IAAW;AAAC;AAC3B,KACD,CAAE,CAAA,IAAA,CAAK,iBAAkB,CAAA,QAAA,CAAS,YAAY,CAAC,CAAA;AAAA,GAClD,MAAA,IAAW,WAAW,KAAO,EAAA;AAC3B,IAAU,OAAA,GAAA,iBAAA,CAAkB,IAAI,GAAK,EAAA;AAAA,MACnC,UAAY,EAAA,IAAA;AAAA,MACZ,OAAS,EAAA;AAAA,QACP,eAAiB,EAAA,aAAA;AAAA,QACjB,qBAAuB,EAAA,qBAAA;AAAA,QACvB,GAAI,OAAS,EAAA,OAAA,IAAW;AAAC;AAC3B,KACD,CAAE,CAAA,IAAA,CAAK,iBAAkB,CAAA,YAAA,CAAa,YAAY,CAAC,CAAA;AAAA,GAC/C,MAAA;AACL,IAAA,OAAO,OAAO,MAAA,CAAO,IAAK,CAAA,IAAI,wBAAwB,CAAA;AAAA;AAGxD,EAAA,MAAM,QAAW,GAAA,OAAO,MAAO,CAAA,OAAA,CAAQ,OAAO,CAAA;AAE9C,EAAI,IAAA,QAAA,CAAS,WAAW,GAAK,EAAA;AAC3B,IAAM,MAAA,IAAA,GAAQ,OAAO,QAAS,CAAA,IAAA;AAC9B,IAAA,OAAO,mBAAmB,IAAK,CAAA;AAAA,MAC7B,KAAO,EAAA;AAAA,QACL,aAAa,IAAK,CAAA,WAAA;AAAA,QAClB,QAAQ,IAAK,CAAA,MAAA;AAAA,QACb,SAAS,IAAK,CAAA;AAAA;AAChB,KACD,CAAA;AAAA;AAGH,EAAA,IAAI,aAAa,QAAU,EAAA;AACzB,IAAA,MAAMA,UAAS,YAAa,CAAA,IAAA;AAAA,MAC1B,MAAO,CAAA,MAAA;AAAA,QACL,OAAO,MAAO,CAAA;AAAA,UACZ,QAAU,EAAA,IAAA,CAAK,QAAS,CAAA,kBAAA,CAAmB,aAAa,QAAQ;AAAA,SACjE;AAAA;AACH,KACF;AAEA,IAAMC,MAAAA,KAAAA,GAAO,OAAO,QAAS,CAAA,IAAA;AAAA,MAC3B,QAAA;AAAA,MACA,kBAAA,CAAmB,eAAeD,OAAM;AAAA,KAC1C;AAEA,IAAME,MAAAA,eAAAA,GAAiB,mBAAmB,IAAK,CAAA;AAAA,MAC7C,IAAMD,EAAAA;AAAA,KACP,CAAA;AAED,IAAA,OAAO,OAAO,kBAAmB,CAAA;AAAA,MAC/B,MAAA;AAAA,MACA,KAAA;AAAA,MACA,KAAO,EAAA,YAAA;AAAA,MACP,MAAQC,EAAAA;AAAA,KACT,CAAA;AAED,IAAOA,OAAAA,eAAAA;AAAA;AAGT,EAAA,MAAM,MAAS,GAAA,YAAA;AAEf,EAAM,MAAA,IAAA,GAAO,OAAO,QAAS,CAAA,IAAA;AAAA,IAC3B,QAAA;AAAA,IACA,kBAAA,CAAmB,eAAe,MAAM;AAAA,GAC1C;AAEA,EAAM,MAAA,cAAA,GAAiB,mBAAmB,IAAK,CAAA;AAAA,IAC7C,IAAM,EAAA;AAAA,GACP,CAAA;AAED,EAAA,OAAO,OAAO,kBAAmB,CAAA;AAAA,IAC/B,MAAA;AAAA,IACA,KAAA;AAAA,IACA,KAAO,EAAA,YAAA;AAAA,IACP,MAAQ,EAAA;AAAA,GACT,CAAA;AAED,EAAO,OAAA,MAAA,CAAO,QAAQ,SAAS,CAAA;AAE/B,EAAO,OAAA,cAAA;AACT,CAAC,CAAE,CAAA,IAAA;AAAA,EACD,MAAO,CAAA,MAAA;AAAA,EACP,WAAY,CAAA,qBAAA;AAAA,IACV,UAAU,OAAQ,CAAA,MAAA,EAAQ,EAAE,CAAE,CAAA,OAAA,CAAQ,KAAK,GAAG;AAAA,GAChD;AAAA,EACA,MAAA,CAAO,QAAS,CAAA,CAAC,KAAU,KAAA;AACzB,IACE,IAAA,KAAA,CAAM,IAAS,KAAA,YAAA,IACf,KAAM,CAAA,IAAA,KAAS,cACf,IAAA,KAAA,CAAM,IAAS,KAAA,eAAA,IACf,KAAM,CAAA,IAAA,KAAS,iDACf,EAAA;AACA,MAAA,OAAO,MAAO,CAAA,IAAA;AAAA,QACZ,IAAI,KAAM,CAAA,KAAA,CAAM,OAAS,EAAA;AAAA,UACvB,OAAO,KAAM,CAAA;AAAA,SACd;AAAA,OACH;AAAA;AAEF,IAAI,IAAA,KAAA,CAAM,SAAS,eAAiB,EAAA;AAClC,MAAA,MAAM,SAAS,KAAM,CAAA,MAAA;AACrB,MAAI,IAAA,MAAA,CAAO,SAAS,WAAa,EAAA;AAC/B,QAAA,OAAO,MAAO,CAAA,IAAA,CAAK,IAAI,KAAA,CAAM,+BAA+B,CAAC,CAAA;AAAA;AAE/D,MAAI,IAAA,MAAA,CAAO,SAAS,aAAe,EAAA;AACjC,QAAA,OAAO,MAAO,CAAA,IAAA;AAAA,UACZ,IAAI,KAAA,CAAM,MAAO,CAAA,KAAA,CAAM,OAAS,EAAA;AAAA,YAC9B,KAAA,EAAO,OAAO,KAAM,CAAA;AAAA,WACrB;AAAA,SACH;AAAA;AACF;AAEF,IAAA,OAAO,OAAO,IAAK,CAAA,IAAI,MAAM,KAAM,CAAA,QAAA,EAAU,CAAC,CAAA;AAAA,GAC/C;AACH","file":"index.js","sourcesContent":["import * as Effect from \"effect/Effect\";\nimport * as Schema from \"effect/Schema\";\nimport * as Function from \"effect/Function\";\nimport * as HttpClient from \"@effect/platform/HttpClient\";\nimport * as HttpClientResponse from \"@effect/platform/HttpClientResponse\";\nimport * as HttpClientRequest from \"@effect/platform/HttpClientRequest\";\nimport * as FetchHttpClient from \"@effect/platform/FetchHttpClient\";\n\nimport { Ajax } from \"@brytdesigns/shopify-utils/effect\";\n\nimport * as LoggerUtils from \"./LoggerUtils.js\";\nimport { type CartError, InvalidAjaxMethodError } from \"./errors.js\";\nimport * as AjaxClientResponse from \"./AjaxClientResponse.js\";\n\nconst BaseOutputSchema = Schema.Struct({});\nconst ProductInputSchema = Schema.extend(\n  Ajax.Sections.Input,\n  Schema.Struct({\n    handle: Schema.String,\n  })\n);\n\nexport const Default = FetchHttpClient.layer;\n\nconst METHOD = {\n  GET: \"get\",\n  POST: \"post\",\n};\n\nconst METHODS_BY_URL = {\n  products_url: METHOD.GET,\n  product_url: METHOD.GET,\n  predictive_search_url: METHOD.GET,\n  product_recommendations_url: METHOD.GET,\n  cart_add_url: METHOD.POST,\n  cart_update_url: METHOD.POST,\n  cart_url: METHOD.GET,\n  cart_change_url: METHOD.POST,\n  cart_clear_url: METHOD.POST,\n};\n\ntype ValidAjaxRoutes = keyof Pick<\n  Ajax.Window.ShopifyRoutes.ShopifyRoutes,\n  | \"product_url\"\n  | \"products_url\"\n  | \"predictive_search_url\"\n  | \"product_recommendations_url\"\n  | \"cart_add_url\"\n  | \"cart_update_url\"\n  | \"cart_url\"\n  | \"cart_change_url\"\n  | \"cart_clear_url\"\n>;\n\n/**\n * A factory function that creates an Effect to make AJAX requests to Shopify routes.\n *\n * @template RouteName - The type of Shopify route to make the request to.\n * @template A - The type of input data for the request.\n * @template I - The type of input data after decoding.\n * @template R - The type of input data after decoding, but with additional information.\n * @template B - The type of output data expected from the request.\n * @template J - The type of output data after decoding.\n * @template S - The type of output data after decoding, but with additional information.\n *\n * @param {object} params - The parameters for creating the factory function.\n * @param {RouteName} params.routeName - The name of the Shopify route to make the request to.\n * @param {Schema<A, I, R>} params.inputSchema - The schema for validating and decoding the input data.\n * @param {Schema<B, J, S>} params.outputSchema - The schema for validating and decoding the output data.\n *\n * - A function that takes input data and options, and returns an Effect to make the AJAX request.\n */\nexport const makeFactory =\n  <\n    RouteName extends ValidAjaxRoutes,\n    A extends RouteName extends \"product_url\"\n      ? typeof ProductInputSchema.Type\n      : typeof Ajax.Sections.Input.Type,\n    I,\n    R,\n    B extends typeof BaseOutputSchema.Type,\n    J,\n    S,\n  >({\n    routeName,\n    inputSchema,\n    outputSchema,\n  }: {\n    routeName: RouteName;\n    inputSchema: Schema.Schema<A, I, R>;\n    outputSchema: Schema.Schema<B, J, S>;\n  }) =>\n  (\n    input?: Schema.Schema<A, I, R>[\"Encoded\"],\n    options?: { headers?: Record<string, string> }\n  ) =>\n    Effect.gen(function* () {\n      const client = yield* HttpClient.HttpClient;\n      const decodedInput = yield* Schema.decodeUnknown(inputSchema)(\n        input || {}\n      );\n      const routes = Ajax.Window.ShopifyRoutes.make();\n\n      let route: string;\n\n      if (routeName === \"product_url\" && \"handle\" in decodedInput) {\n        route = routes[routeName].replace(\":handle\", decodedInput.handle);\n      } else {\n        route = routes[routeName];\n      }\n\n      const url = `${window.location.origin}${route}`;\n      const method = METHODS_BY_URL[routeName];\n\n      let request: HttpClientRequest.HttpClientRequest;\n\n      if (method === \"post\") {\n        request = yield* HttpClientRequest.post(url, {\n          acceptJson: true,\n          headers: {\n            \"X-SDK-Variant\": \"brytdesigns\",\n            \"X-SDK-Variant-Source\": \"shopify-ajax-client\",\n            ...(options?.headers || {}),\n          },\n        }).pipe(HttpClientRequest.bodyJson(decodedInput));\n      } else if (method === \"get\") {\n        request = HttpClientRequest.get(url, {\n          acceptJson: true,\n          headers: {\n            \"X-SDK-Variant\": \"brytdesigns\",\n            \"X-SK-Variant-Source\": \"shopify-ajax-client\",\n            ...(options?.headers || {}),\n          },\n        }).pipe(HttpClientRequest.setUrlParams(decodedInput));\n      } else {\n        return yield* Effect.fail(new InvalidAjaxMethodError());\n      }\n\n      const response = yield* client.execute(request);\n\n      if (response.status !== 200) {\n        const data = (yield* response.json) as CartError;\n        return AjaxClientResponse.make({\n          error: {\n            description: data.description,\n            status: data.status,\n            message: data.message,\n          },\n        });\n      }\n\n      if (decodedInput.sections) {\n        const output = outputSchema.pipe(\n          Schema.extend(\n            Schema.Struct({\n              sections: Ajax.Sections.makeResponseSchema(decodedInput.sections),\n            })\n          )\n        );\n\n        const json = yield* Function.pipe(\n          response,\n          HttpClientResponse.schemaBodyJson(output)\n        );\n\n        const clientResponse = AjaxClientResponse.make({\n          data: json,\n        });\n\n        yield* Effect.annotateLogsScoped({\n          method,\n          route,\n          input: decodedInput,\n          output: clientResponse,\n        });\n\n        return clientResponse;\n      }\n\n      const output = outputSchema;\n\n      const json = yield* Function.pipe(\n        response,\n        HttpClientResponse.schemaBodyJson(output)\n      );\n\n      const clientResponse = AjaxClientResponse.make({\n        data: json,\n      });\n\n      yield* Effect.annotateLogsScoped({\n        method,\n        route,\n        input: decodedInput,\n        output: clientResponse,\n      });\n\n      yield* Effect.logInfo(\"Request\");\n\n      return clientResponse;\n    }).pipe(\n      Effect.scoped,\n      LoggerUtils.withNamespacedLogSpan(\n        routeName.replace(\"_url\", \"\").replace(\"_\", \":\")\n      ),\n      Effect.catchAll((error) => {\n        if (\n          error._tag === \"ParseError\" ||\n          error._tag === \"RequestError\" ||\n          error._tag === \"ResponseError\" ||\n          error._tag === \"@brytdesigns/ajax-client/InvalidAjaxMethodError\"\n        ) {\n          return Effect.fail(\n            new Error(error.message, {\n              cause: error.cause,\n            })\n          );\n        }\n        if (error._tag === \"HttpBodyError\") {\n          const reason = error.reason;\n          if (reason._tag === \"JsonError\") {\n            return Effect.fail(new Error(\"Failed to parse JSON response\"));\n          }\n          if (reason._tag === \"SchemaError\") {\n            return Effect.fail(\n              new Error(reason.error.message, {\n                cause: reason.error.cause,\n              })\n            );\n          }\n        }\n        return Effect.fail(new Error(error.toString()));\n      })\n    );\n"]}
+{"version":3,"file":"index.js","names":[],"sources":["../../src/index.ts"],"sourcesContent":["// v4 absorbed @effect/platform into the core package. These sat under\n// effect/unstable/http during the RCs and graduated to effect/http at 4.0.0,\n// so they are covered by semver now rather than exempt from it.\nimport { FetchHttpClient } from \"effect/http\";\n\n/** Named `layer` per the v4 convention, which replaces v3's `Default`/`Live`. */\nexport const layer = FetchHttpClient.layer;\n\nexport {\n\ttype AjaxErrorBody,\n\tAjaxResponseError,\n\tInvalidAjaxMethodError,\n\tUnsafeAjaxRouteError,\n} from \"./errors.js\";\nexport type {\n\tAjaxInput,\n\tAjaxInputEncoded,\n\tAjaxRequest,\n\tValidAjaxRoutes,\n} from \"./Request.js\";\nexport * as Request from \"./Request.js\";\nexport {\n\texecute,\n\tisAjaxRequest,\n\tmakeRoute,\n\twithHeader,\n\twithHeaders,\n\twithInput,\n\twithSections,\n} from \"./Request.js\";\n"],"mappings":";;;;;AAMA,IAAa,QAAQ,gBAAgB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brytdesigns/shopify-ajax-client",
-  "version": "1.0.7",
+  "version": "3.0.0",
   "description": "An AJAX cart that integrates with ALL shopify ajax apis",
   "main": "./dist/main/index.js",
   "types": "./dist/main/index.d.ts",
@@ -11,11 +11,7 @@
   "exports": {
     ".": {
       "types": "./dist/main/index.d.ts",
-      "import": "./dist/main/index.js"
-    },
-    "./effect": {
-      "types": "./dist/effect/index.d.ts",
-      "import": "./dist/effect/index.js"
+      "default": "./dist/main/index.js"
     }
   },
   "type": "module",
@@ -23,19 +19,17 @@
   "author": "Bryt Designs",
   "license": "ISC",
   "devDependencies": {
-    "@effect/vitest": "^0.19.0",
-    "dts-bundle-generator": "^9.5.1",
-    "tsup": "^8.4.0",
-    "vitest": "^3.0.6"
+    "@repo/vite-config": "0.0.0",
+    "vite": "^8.2.2",
+    "vitest": "^3.2.7"
   },
   "dependencies": {
-    "@effect/platform": "0.94.1",
-    "effect": "3.19.14",
-    "lz-string": "^1.5.0",
-    "@brytdesigns/shopify-utils": "1.2.22"
+    "@brytdesigns/shopify-utils": "3.0.0",
+    "effect": "4.0.3",
+    "lz-string": "^1.5.0"
   },
   "scripts": {
-    "build": "tsup --clean",
+    "build": "vite build",
     "dev": "tsx src/index.ts",
     "typecheck": "tsc --noEmit",
     "test": "vitest"