@siteping/adapter-kit 0.1.0

package/dist/wire.d.cts

@@ -0,0 +1,35 @@
+/**
+ * HTTP wire helpers shared by every client that talks to a Siteping
+ * endpoint (widget `ApiClient`, dashboard `createEndpointSource`).
+ *
+ * One definition of the query-string encoding and the HTTP→typed-error
+ * mapping — two clients implementing them independently already drifted
+ * once (the dashboard forgot to serialize `statuses`), so they live here
+ * now.
+ */
+import { SitepingError, SitepingNetworkError } from "./errors.cjs";
+import type { FeedbackQuery } from "./types.cjs";
+/**
+ * Encode a `FeedbackQuery` as the endpoint's expected query string.
+ * Omitted/empty filters are not serialized; `statuses` uses the CSV form
+ * the server's schema splits (`statuses=open,in_progress`).
+ */
+export declare function feedbackQueryToSearchParams(query: FeedbackQuery): URLSearchParams;
+/**
+ * Map a non-OK `Response` to the appropriate typed error:
+ *   - 401 / 403 → `SitepingAuthError`
+ *   - other 4xx → `SitepingValidationError`
+ *   - 5xx (or anything else) → generic `SitepingError` (code `"SERVER"`)
+ *
+ * The response body is consumed via `.text()` so the caller keeps the
+ * server-supplied message in the thrown error; `.text()` failures fall back
+ * to `"Unknown error"` (kept verbatim — host apps grep for it).
+ */
+export declare function errorFromResponse(response: Response, label: string): Promise<SitepingError>;
+/**
+ * Normalise an exception thrown by `fetch` (or a timeout AbortController)
+ * into a `SitepingNetworkError`. AbortErrors count as network failures —
+ * in Siteping client code they always come from internal timeouts, never a
+ * user-driven cancellation.
+ */
+export declare function networkErrorFromException(error: unknown, label: string): SitepingNetworkError;

package/dist/wire.d.ts

@@ -0,0 +1,35 @@
+/**
+ * HTTP wire helpers shared by every client that talks to a Siteping
+ * endpoint (widget `ApiClient`, dashboard `createEndpointSource`).
+ *
+ * One definition of the query-string encoding and the HTTP→typed-error
+ * mapping — two clients implementing them independently already drifted
+ * once (the dashboard forgot to serialize `statuses`), so they live here
+ * now.
+ */
+import { SitepingError, SitepingNetworkError } from "./errors.js";
+import type { FeedbackQuery } from "./types.js";
+/**
+ * Encode a `FeedbackQuery` as the endpoint's expected query string.
+ * Omitted/empty filters are not serialized; `statuses` uses the CSV form
+ * the server's schema splits (`statuses=open,in_progress`).
+ */
+export declare function feedbackQueryToSearchParams(query: FeedbackQuery): URLSearchParams;
+/**
+ * Map a non-OK `Response` to the appropriate typed error:
+ *   - 401 / 403 → `SitepingAuthError`
+ *   - other 4xx → `SitepingValidationError`
+ *   - 5xx (or anything else) → generic `SitepingError` (code `"SERVER"`)
+ *
+ * The response body is consumed via `.text()` so the caller keeps the
+ * server-supplied message in the thrown error; `.text()` failures fall back
+ * to `"Unknown error"` (kept verbatim — host apps grep for it).
+ */
+export declare function errorFromResponse(response: Response, label: string): Promise<SitepingError>;
+/**
+ * Normalise an exception thrown by `fetch` (or a timeout AbortController)
+ * into a `SitepingNetworkError`. AbortErrors count as network failures —
+ * in Siteping client code they always come from internal timeouts, never a
+ * user-driven cancellation.
+ */
+export declare function networkErrorFromException(error: unknown, label: string): SitepingNetworkError;

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@siteping/adapter-kit",
+  "version": "0.1.0",
+  "description": "Everything needed to build and conformance-test a custom Siteping store adapter",
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./testing": {
+      "import": {
+        "types": "./dist/testing.d.ts",
+        "default": "./dist/testing.js"
+      },
+      "require": {
+        "types": "./dist/testing.d.cts",
+        "default": "./dist/testing.cjs"
+      }
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup && node ../../scripts/fix-dts.mjs dist",
+    "check": "tsc --noEmit",
+    "clean": "rm -rf dist"
+  },
+  "keywords": [
+    "siteping",
+    "adapter",
+    "store",
+    "conformance",
+    "testing",
+    "feedback",
+    "typescript"
+  ],
+  "author": "neosianexus",
+  "license": "MIT",
+  "homepage": "https://siteping.dev",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/NeosiaNexus/SitePing.git",
+    "directory": "packages/adapter-kit"
+  },
+  "bugs": {
+    "url": "https://github.com/NeosiaNexus/SitePing/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "peerDependencies": {
+    "vitest": ">=3"
+  },
+  "peerDependenciesMeta": {
+    "vitest": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@siteping/core": "workspace:*"
+  }
+}