@siteping/server 0.0.0-stage → 0.1.0

package/dist/wire.d.cts

@@ -0,0 +1,68 @@
+/**
+ * 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";
+/**
+ * A fresh `clientId` for a write the server dedupes a resend of — a feedback,
+ * or a reply in a thread.
+ */
+export declare function newClientId(): string;
+/**
+ * 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;
+/**
+ * Merge caller-supplied `extra` headers over a client's `defaults`
+ * (`Content-Type`, `Authorization` from `apiKey`). Header names are
+ * case-insensitive, so a default spelled differently is dropped and the
+ * explicit value replaces it — a plain object merge kept both, and fetch
+ * joined them (`authorization: "Basic x"` over an apiKey went out as
+ * "Bearer k, Basic x").
+ */
+export declare function mergeRequestHeaders(defaults: Record<string, string>, extra: Record<string, string> | undefined): Record<string, string>;
+/**
+ * Append `params` to `endpoint`, which may already carry a query string
+ * (`/api/siteping?tenant=acme`) or a fragment — naive `${endpoint}?${params}`
+ * produced `?tenant=acme?projectName=…`, a 400. Plain string work, so
+ * relative endpoints stay relative and nothing depends on `location`.
+ */
+export declare function withSearchParams(endpoint: string, params: URLSearchParams): string;
+/**
+ * Map a non-OK `Response` to the appropriate typed error:
+ *   - 401 / 403 → `SitepingAuthError`, with its `status`
+ *   - other 4xx → `SitepingValidationError`, with its `status`
+ *   - 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>;
+/**
+ * Whether a failed reply met a full thread — a store's `StoreLimitError`, or
+ * a 409 (the endpoint's other 409, a clientId reused on another feedback,
+ * never comes from clients that mint one per reply). Retrying won't help.
+ */
+export declare function isThreadFull(error: unknown): boolean;
+/**
+ * Whether a failed reply delete found nothing to delete — a store's
+ * `StoreNotFoundError`, or a 404: it is gone already. (Unlike
+ * `isStoreNotFound`, no Prisma `P2025`: a browser source never meets one.)
+ */
+export declare function isCommentGone(error: unknown): boolean;
+/**
+ * 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,68 @@
+/**
+ * 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";
+/**
+ * A fresh `clientId` for a write the server dedupes a resend of — a feedback,
+ * or a reply in a thread.
+ */
+export declare function newClientId(): string;
+/**
+ * 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;
+/**
+ * Merge caller-supplied `extra` headers over a client's `defaults`
+ * (`Content-Type`, `Authorization` from `apiKey`). Header names are
+ * case-insensitive, so a default spelled differently is dropped and the
+ * explicit value replaces it — a plain object merge kept both, and fetch
+ * joined them (`authorization: "Basic x"` over an apiKey went out as
+ * "Bearer k, Basic x").
+ */
+export declare function mergeRequestHeaders(defaults: Record<string, string>, extra: Record<string, string> | undefined): Record<string, string>;
+/**
+ * Append `params` to `endpoint`, which may already carry a query string
+ * (`/api/siteping?tenant=acme`) or a fragment — naive `${endpoint}?${params}`
+ * produced `?tenant=acme?projectName=…`, a 400. Plain string work, so
+ * relative endpoints stay relative and nothing depends on `location`.
+ */
+export declare function withSearchParams(endpoint: string, params: URLSearchParams): string;
+/**
+ * Map a non-OK `Response` to the appropriate typed error:
+ *   - 401 / 403 → `SitepingAuthError`, with its `status`
+ *   - other 4xx → `SitepingValidationError`, with its `status`
+ *   - 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>;
+/**
+ * Whether a failed reply met a full thread — a store's `StoreLimitError`, or
+ * a 409 (the endpoint's other 409, a clientId reused on another feedback,
+ * never comes from clients that mint one per reply). Retrying won't help.
+ */
+export declare function isThreadFull(error: unknown): boolean;
+/**
+ * Whether a failed reply delete found nothing to delete — a store's
+ * `StoreNotFoundError`, or a 404: it is gone already. (Unlike
+ * `isStoreNotFound`, no Prisma `P2025`: a browser source never meets one.)
+ */
+export declare function isCommentGone(error: unknown): boolean;
+/**
+ * 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

@@ -1,6 +1,66 @@
 {
   "name": "@siteping/server",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Store- and framework-agnostic HTTP handler for Siteping — any SitepingStore behind one Fetch API endpoint",
+  "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"
+      }
+    }
+  },
+  "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",
+    "server",
+    "api-handler",
+    "fetch-api",
+    "feedback",
+    "feedback-api",
+    "self-hosted",
+    "typescript"
+  ],
+  "author": "neosianexus",
+  "license": "MIT",
+  "homepage": "https://siteping.dev",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/NeosiaNexus/SitePing.git",
+    "directory": "packages/server"
+  },
+  "bugs": {
+    "url": "https://github.com/NeosiaNexus/SitePing/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "dependencies": {
+    "zod": "^4.6.5"
+  },
+  "devDependencies": {
+    "@siteping/adapter-memory": "workspace:*",
+    "@siteping/core": "workspace:*",
+    "better-auth": "^1.7.5",
+    "jose": "^6.2.12"
+  }
+}