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

package/dist/main/index.js

@@ -1,39 +1,62 @@
-import * as Effect from 'effect/Effect';
-import * as Logger from 'effect/Logger';
-import * as Layer from 'effect/Layer';
-import * as LogLevel from 'effect/LogLevel';
-import * as API from './effect/index.js';
-import * as AjaxClient from '@brytdesigns/shopify-ajax-client';
-
-const createPredictiveSearchApi = ({ debug = false }) => {
-  let baseLayer = Layer.empty;
-  let minimumLogLevel = LogLevel.None;
-  let loggerLayer = Logger.pretty;
-  if (debug) {
-    baseLayer = Layer.mergeAll(loggerLayer);
-    minimumLogLevel = LogLevel.All;
-  }
-  const ajaxLayer = Layer.mergeAll(baseLayer, AjaxClient.Default);
-  return {
-    get: (input, options) => Effect.runPromise(
-      API.get(input, {
-        ...options || {},
-        headers: {
-          "X-SDK-Variant-Source": "shopify-ajax-predictive-search-api",
-          "X-Library-Source": "brytdesigns-shopify-ajax-predictive-search-api",
-          ...options?.headers || {}
-        }
-      }).pipe(
-        Logger.withMinimumLogLevel(minimumLogLevel),
-        Effect.provide(ajaxLayer)
-      ),
-      {
-        signal: options?.signal
-      }
-    )
-  };
+import { get } from "./effect/index.js";
+import * as AjaxClient from "@brytdesigns/shopify-ajax-client";
+import * as Cause from "effect/Cause";
+import * as Effect from "effect/Effect";
+import * as Exit from "effect/Exit";
+import * as Layer from "effect/Layer";
+import * as Logger from "effect/Logger";
+import * as References from "effect/References";
+//#region src/index.ts
+/** Identifies this package on every request it makes. */
+var SOURCE_HEADERS = {
+	"X-SDK-Variant-Source": "shopify-ajax-predictive-search-api",
+	"X-Library-Source": "brytdesigns-shopify-ajax-predictive-search-api"
 };
-
+/**
+* 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`.
+*/
+var createPredictiveSearchApi = ({ debug = false, httpClient } = {}) => {
+	let baseLayer = Layer.empty;
+	let minimumLogLevel = "None";
+	if (debug) {
+		baseLayer = Logger.layer([Logger.consolePretty(), Logger.tracerLogger]);
+		minimumLogLevel = "All";
+	}
+	const ajaxLayer = Layer.mergeAll(baseLayer, httpClient ?? AjaxClient.layer);
+	/**
+	* Runs a request to a promise that rejects with the failure itself.
+	*
+	* `Effect.runPromise` rejects with a `FiberFailure` wrapping the error,
+	* which would force a plain-JS caller to understand Effect internals to get
+	* at their own tagged error. Squashing the cause means `catch (e)` sees the
+	* `AjaxResponseError` directly and `instanceof` behaves as expected.
+	*/
+	const settle = async (effect, signal) => {
+		const exit = await Effect.runPromiseExit(effect.pipe(Effect.provideService(References.MinimumLogLevel, minimumLogLevel), Effect.provide(ajaxLayer)), { signal });
+		if (Exit.isSuccess(exit)) return exit.value;
+		throw Cause.squash(exit.cause);
+	};
+	return { 
+	/**
+	* 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, options) => settle(get(input).pipe(AjaxClient.withHeaders({
+		...SOURCE_HEADERS,
+		...options?.headers ?? {}
+	}), AjaxClient.execute), options?.signal) };
+};
+//#endregion
 export { createPredictiveSearchApi };
-//# sourceMappingURL=index.js.map
+
 //# sourceMappingURL=index.js.map

package/dist/main/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;AAkBO,MAAM,yBAA4B,GAAA,CAAC,EAAE,KAAA,GAAQ,OAAY,KAAA;AAC9D,EAAA,IAAI,YAAY,KAAM,CAAA,KAAA;AACtB,EAAA,IAAI,kBAAkB,QAAS,CAAA,IAAA;AAC/B,EAAA,IAAI,cAAc,MAAO,CAAA,MAAA;AAEzB,EAAA,IAAI,KAAO,EAAA;AACT,IAAY,SAAA,GAAA,KAAA,CAAM,SAAS,WAAW,CAAA;AACtC,IAAA,eAAA,GAAkB,QAAS,CAAA,GAAA;AAAA;AAG7B,EAAA,MAAM,SAAY,GAAA,KAAA,CAAM,QAAS,CAAA,SAAA,EAAW,WAAW,OAAO,CAAA;AAE9D,EAAO,OAAA;AAAA,IACL,GAAK,EAAA,CACH,KACA,EAAA,OAAA,KAEA,MAAO,CAAA,UAAA;AAAA,MACL,GAAA,CAAI,IAAI,KAAO,EAAA;AAAA,QACb,GAAI,WAAW,EAAC;AAAA,QAChB,OAAS,EAAA;AAAA,UACP,sBAAwB,EAAA,oCAAA;AAAA,UACxB,kBACE,EAAA,gDAAA;AAAA,UACF,GAAI,OAAS,EAAA,OAAA,IAAW;AAAC;AAC3B,OACD,CAAE,CAAA,IAAA;AAAA,QACD,MAAA,CAAO,oBAAoB,eAAe,CAAA;AAAA,QAC1C,MAAA,CAAO,QAAQ,SAAS;AAAA,OAC1B;AAAA,MACA;AAAA,QACE,QAAQ,OAAS,EAAA;AAAA;AACnB;AACF,GACJ;AACF","file":"index.js","sourcesContent":["import * as Effect from \"effect/Effect\";\nimport * as Logger from \"effect/Logger\";\nimport * as Layer from \"effect/Layer\";\nimport * as LogLevel from \"effect/LogLevel\";\nimport * as API from \"./effect/index.js\";\nimport * as AjaxClient from \"@brytdesigns/shopify-ajax-client\";\n\nexport namespace createPredictiveSearchApi {\n  export type Options = {\n    debug?: boolean;\n  };\n\n  export type RequestOptions = {\n    signal?: AbortSignal;\n    headers?: Record<string, string>;\n  };\n}\n\nexport const createPredictiveSearchApi = ({ debug = false }) => {\n  let baseLayer = Layer.empty;\n  let minimumLogLevel = LogLevel.None;\n  let loggerLayer = Logger.pretty;\n\n  if (debug) {\n    baseLayer = Layer.mergeAll(loggerLayer);\n    minimumLogLevel = LogLevel.All;\n  }\n\n  const ajaxLayer = Layer.mergeAll(baseLayer, AjaxClient.Default);\n\n  return {\n    get: (\n      input: API.get.Input,\n      options?: createPredictiveSearchApi.RequestOptions,\n    ) =>\n      Effect.runPromise(\n        API.get(input, {\n          ...(options || {}),\n          headers: {\n            \"X-SDK-Variant-Source\": \"shopify-ajax-predictive-search-api\",\n            \"X-Library-Source\":\n              \"brytdesigns-shopify-ajax-predictive-search-api\",\n            ...(options?.headers || {}),\n          },\n        }).pipe(\n          Logger.withMinimumLogLevel(minimumLogLevel),\n          Effect.provide(ajaxLayer),\n        ),\n        {\n          signal: options?.signal,\n        },\n      ),\n  };\n};\n"]}
+{"version":3,"file":"index.js","names":[],"sources":["../../src/index.ts"],"sourcesContent":["import * as AjaxClient from \"@brytdesigns/shopify-ajax-client\";\nimport * as Cause from \"effect/Cause\";\nimport * as Effect from \"effect/Effect\";\nimport * as Exit from \"effect/Exit\";\nimport type { HttpClient } from \"effect/http\";\nimport * as Layer from \"effect/Layer\";\nimport * as Logger from \"effect/Logger\";\nimport type * as LogLevel from \"effect/LogLevel\";\nimport * as References from \"effect/References\";\nimport * as API from \"./effect/index.js\";\n\nexport namespace createPredictiveSearchApi {\n\texport type Options = {\n\t\tdebug?: boolean;\n\t\t/**\n\t\t * Replaces the HTTP layer.\n\t\t *\n\t\t * The default is `AjaxClient.layer`, which is `fetch`. Overriding it is\n\t\t * the only way to exercise this client without a network - the\n\t\t * alternative was spying on the `layer` export, which tests how the\n\t\t * module is wired rather than what it sends.\n\t\t */\n\t\thttpClient?: Layer.Layer<HttpClient.HttpClient>;\n\t};\n\n\texport type RequestOptions = {\n\t\tsignal?: AbortSignal;\n\t\theaders?: Record<string, string>;\n\t};\n}\n\n/** Identifies this package on every request it makes. */\nconst SOURCE_HEADERS = {\n\t\"X-SDK-Variant-Source\": \"shopify-ajax-predictive-search-api\",\n\t\"X-Library-Source\": \"brytdesigns-shopify-ajax-predictive-search-api\",\n} as const;\n\n/**\n * Creates a predictive search client.\n *\n * `get` resolves to the decoded results and **rejects** on failure. There is no\n * `{ data, error }` envelope: a non-200 rejects with `AjaxResponseError`, and\n * transport, encode and decode failures reject with Effect's own tagged errors.\n *\n * @param options - Optional settings.\n * @param options.debug - Enables request logging. Default `false`.\n */\nexport const createPredictiveSearchApi = ({\n\tdebug = false,\n\thttpClient,\n}: createPredictiveSearchApi.Options = {}) => {\n\tlet baseLayer: Layer.Layer<never> = Layer.empty;\n\t// v4 levels are string literals, and Logger.layer replaces the active set\n\t// rather than adding to it - tracerLogger keeps v3's built-in behaviour.\n\tlet minimumLogLevel: LogLevel.LogLevel = \"None\";\n\n\tif (debug) {\n\t\tbaseLayer = Logger.layer([Logger.consolePretty(), Logger.tracerLogger]);\n\t\tminimumLogLevel = \"All\";\n\t}\n\n\tconst ajaxLayer = Layer.mergeAll(baseLayer, httpClient ?? AjaxClient.layer);\n\n\t/**\n\t * Runs a request to a promise that rejects with the failure itself.\n\t *\n\t * `Effect.runPromise` rejects with a `FiberFailure` wrapping the error,\n\t * which would force a plain-JS caller to understand Effect internals to get\n\t * at their own tagged error. Squashing the cause means `catch (e)` sees the\n\t * `AjaxResponseError` directly and `instanceof` behaves as expected.\n\t */\n\tconst settle = async <A, E>(\n\t\teffect: Effect.Effect<A, E, HttpClient.HttpClient>,\n\t\tsignal?: AbortSignal,\n\t): Promise<A> => {\n\t\tconst exit = await Effect.runPromiseExit(\n\t\t\teffect.pipe(\n\t\t\t\tEffect.provideService(References.MinimumLogLevel, minimumLogLevel),\n\t\t\t\tEffect.provide(ajaxLayer),\n\t\t\t),\n\t\t\t{ signal },\n\t\t);\n\n\t\tif (Exit.isSuccess(exit)) return exit.value;\n\n\t\tthrow Cause.squash(exit.cause);\n\t};\n\n\treturn {\n\t\t/**\n\t\t * Runs a predictive search.\n\t\t *\n\t\t * @param input - The query, and which resources to search.\n\t\t * @param options - An `AbortSignal` to cancel with, and custom headers.\n\t\t * @returns A Promise resolving to the decoded results.\n\t\t */\n\t\tget: (\n\t\t\tinput?: API.get.Input,\n\t\t\toptions?: createPredictiveSearchApi.RequestOptions,\n\t\t) =>\n\t\t\tsettle(\n\t\t\t\tAPI.get(input).pipe(\n\t\t\t\t\tAjaxClient.withHeaders({\n\t\t\t\t\t\t...SOURCE_HEADERS,\n\t\t\t\t\t\t...(options?.headers ?? {}),\n\t\t\t\t\t}),\n\t\t\t\t\tAjaxClient.execute,\n\t\t\t\t),\n\t\t\t\toptions?.signal,\n\t\t\t),\n\t};\n};\n"],"mappings":";;;;;;;;;;AAgCA,IAAM,iBAAiB;CACtB,wBAAwB;CACxB,oBAAoB;AACrB;;;;;;;;;;;AAYA,IAAa,6BAA6B,EACzC,QAAQ,OACR,eACsC,CAAC,MAAM;CAC7C,IAAI,YAAgC,MAAM;CAG1C,IAAI,kBAAqC;CAEzC,IAAI,OAAO;EACV,YAAY,OAAO,MAAM,CAAC,OAAO,cAAc,GAAG,OAAO,YAAY,CAAC;EACtE,kBAAkB;CACnB;CAEA,MAAM,YAAY,MAAM,SAAS,WAAW,cAAc,WAAW,KAAK;;;;;;;;;CAU1E,MAAM,SAAS,OACd,QACA,WACgB;EAChB,MAAM,OAAO,MAAM,OAAO,eACzB,OAAO,KACN,OAAO,eAAe,WAAW,iBAAiB,eAAe,GACjE,OAAO,QAAQ,SAAS,CACzB,GACA,EAAE,OAAO,CACV;EAEA,IAAI,KAAK,UAAU,IAAI,GAAG,OAAO,KAAK;EAEtC,MAAM,MAAM,OAAO,KAAK,KAAK;CAC9B;CAEA,OAAO;;;;;;;;AAQN,MACC,OACA,YAEA,OACC,IAAQ,KAAK,CAAC,CAAC,KACd,WAAW,YAAY;EACtB,GAAG;EACH,GAAI,SAAS,WAAW,CAAC;CAC1B,CAAC,GACD,WAAW,OACZ,GACA,SAAS,MACV,EACF;AACD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brytdesigns/shopify-ajax-predictive-search-api",
-  "version": "1.0.5",
+  "version": "3.0.0",
   "description": "The api for handling the ajax version of predictive search",
   "main": "./dist/main/index.js",
   "types": "./dist/main/index.d.ts",
@@ -11,7 +11,11 @@
   "exports": {
     ".": {
       "types": "./dist/main/index.d.ts",
-      "import": "./dist/main/index.js"
+      "default": "./dist/main/index.js"
+    },
+    "./effect": {
+      "types": "./dist/effect/index.d.ts",
+      "default": "./dist/effect/index.js"
     }
   },
   "type": "module",
@@ -19,19 +23,18 @@
   "author": "Bryt Designs",
   "license": "ISC",
   "devDependencies": {
-    "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-ajax-client": "1.0.7",
-    "@brytdesigns/shopify-utils": "1.2.22"
+    "@brytdesigns/shopify-ajax-client": "3.0.0",
+    "@brytdesigns/shopify-utils": "3.0.0",
+    "effect": "4.0.3",
+    "lz-string": "^1.5.0"
   },
   "scripts": {
-    "build": "tsup --clean",
+    "build": "vite build && vite build --mode effect",
     "dev": "tsx src/index.ts",
     "typecheck": "tsc --noEmit",
     "test": "vitest"