@cms-lab/sanity 1.0.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Afaq Rashid
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,28 @@
+# @cms-lab/sanity
+
+Sanity adapter for cms-lab.
+
+```ts
+cms: {
+  provider: "sanity",
+  projectId: "my-project",
+  dataset: "production",
+  apiVersion: "2025-02-19",
+  token: process.env.SANITY_READ_TOKEN,
+  contentTypes: [
+    {
+      type: "page",
+      documentType: "page",
+      uidField: "slug.current",
+      urlField: "seo.canonical",
+    },
+  ],
+}
+```
+
+The adapter reads Sanity documents through the HTTP Query API, one configured
+document type at a time, and normalizes them into cms-lab `CMSDocument` objects.
+Documents whose `_id` starts with `drafts.` are marked as drafts.
+
+Use `uidField` or `urlField` when your project stores route values in custom
+fields. Both options read dotted paths from `document.data`.

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+import { FetchLike, SanityCmsProviderConfig, CMSDocument, SanityContentTypeConfig } from '@cms-lab/core';
+
+type FetchSanityDocumentsOptions = {
+    fetch?: FetchLike;
+};
+declare function fetchSanityDocuments(config: SanityCmsProviderConfig, options?: FetchSanityDocumentsOptions): Promise<CMSDocument[]>;
+declare function normalizeSanityDocument(contentType: string | SanityContentTypeConfig, document: unknown): CMSDocument;
+
+export { type FetchSanityDocumentsOptions, fetchSanityDocuments, normalizeSanityDocument };

package/dist/index.js

@@ -0,0 +1,108 @@
+// src/index.ts
+import {
+  CmsFetchError,
+  readCmsDataPath
+} from "@cms-lab/core";
+var defaultApiVersion = "2025-02-19";
+async function fetchSanityDocuments(config, options = {}) {
+  const fetchImpl = options.fetch ?? fetch;
+  const documents = [];
+  for (const contentType of config.contentTypes) {
+    const url = sanityQueryUrl(config);
+    url.searchParams.set("query", "*[_type == $type]");
+    url.searchParams.set("$type", JSON.stringify(contentType.documentType));
+    url.searchParams.set("perspective", config.perspective ?? "published");
+    const response = await fetchJson(
+      fetchImpl,
+      url,
+      authHeaders(config.token)
+    );
+    const rows = Array.isArray(response.result) ? response.result : [];
+    documents.push(
+      ...rows.map((document) => normalizeSanityDocument(contentType, document))
+    );
+  }
+  return documents;
+}
+function normalizeSanityDocument(contentType, document) {
+  const config = contentTypeConfig(contentType);
+  const data = asRecord(document);
+  const id = stringFrom(data._id, "Sanity document is missing _id");
+  return {
+    id,
+    type: config.type,
+    uid: optionalString(
+      mappedValue(data, config.uidField) ?? data.uid ?? slugValue(data.slug)
+    ),
+    url: optionalString(mappedValue(data, config.urlField)),
+    status: id.startsWith("drafts.") ? "draft" : "published",
+    data
+  };
+}
+async function fetchJson(fetchImpl, url, headers) {
+  let response;
+  try {
+    response = await fetchImpl(url, { headers });
+  } catch (error) {
+    throw new CmsFetchError(
+      error instanceof Error ? error.message : `Failed to reach ${url}`
+    );
+  }
+  if (!response.ok) {
+    throw new CmsFetchError(
+      `Sanity request failed with HTTP ${response.status}`
+    );
+  }
+  return await response.json();
+}
+function sanityQueryUrl(config) {
+  const host = `${config.projectId}.${config.useCdn ? "apicdn" : "api"}.sanity.io`;
+  const version = apiVersion(config.apiVersion ?? defaultApiVersion);
+  return new URL(
+    `https://${host}/${version}/data/query/${encodeURIComponent(config.dataset)}`
+  );
+}
+function apiVersion(value) {
+  return value.startsWith("v") ? value : `v${value}`;
+}
+function authHeaders(token) {
+  return token ? { Accept: "application/json", Authorization: `Bearer ${token}` } : { Accept: "application/json" };
+}
+function asRecord(value) {
+  return value && typeof value === "object" ? value : {};
+}
+function slugValue(value) {
+  if (typeof value === "string") {
+    return value;
+  }
+  const record = value && typeof value === "object" ? value : void 0;
+  return record?.current;
+}
+function stringFrom(value, message) {
+  if (typeof value === "string" && value.length > 0) {
+    return value;
+  }
+  if (typeof value === "number" && Number.isFinite(value)) {
+    return String(value);
+  }
+  throw new CmsFetchError(message);
+}
+function optionalString(value) {
+  if (typeof value === "string" && value.length > 0) {
+    return value;
+  }
+  if (typeof value === "number" && Number.isFinite(value)) {
+    return String(value);
+  }
+  return void 0;
+}
+function contentTypeConfig(contentType) {
+  return typeof contentType === "string" ? { type: contentType, documentType: contentType } : contentType;
+}
+function mappedValue(data, path) {
+  return path ? readCmsDataPath(data, path) : void 0;
+}
+export {
+  fetchSanityDocuments,
+  normalizeSanityDocument
+};

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@cms-lab/sanity",
+  "version": "1.0.5",
+  "type": "module",
+  "description": "Sanity document adapter for cms-lab.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/i-afaqrashid/cms-lab.git",
+    "directory": "packages/sanity"
+  },
+  "homepage": "https://cmslab.afaqrashid.com",
+  "bugs": {
+    "url": "https://github.com/i-afaqrashid/cms-lab/issues"
+  },
+  "keywords": [
+    "cms",
+    "sanity",
+    "testing"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=20.10"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@cms-lab/core": "1.0.5"
+  },
+  "author": "Afaq Rashid",
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --dts --clean --tsconfig ../../tsconfig.base.json"
+  }
+}