@sanity/client 7.26.1 → 8.0.0

package/dist/types-CfGzbXrl.d.ts

@@ -0,0 +1,108 @@
+import { ContentSourceMap as ContentSourceMap$2, ContentSourceMapDocuments, ContentSourceMapParsedPath, ContentSourceMapParsedPath as ContentSourceMapParsedPath$1, ContentSourceMapParsedPathKeyedSegment, ResolveStudioUrl, StudioBaseRoute, StudioBaseUrl, StudioUrl, StudioUrl as StudioUrl$1 } from "@sanity/client/csm";
+import { ClientConfig, InitializedClientConfig, RawQueryResponse } from "@sanity/client";
+/** @public */
+type ContentSourceMapQueryResponse = RawQueryResponse<unknown> | Pick<RawQueryResponse<unknown>, 'result' | 'resultSourceMap'>;
+/** @public */
+interface StegaConfig {
+  /**
+       * Enable or disable stega encoded strings in query results
+       * ```ts
+        {
+          enabled: process.env.VERCEL_ENV !== 'production'
+        }
+      * ```
+      * @defaultValue `false`
+      */
+  enabled?: boolean;
+  /**
+   * Where the Studio is hosted.
+   * If it's embedded in the app, use the base path for example `/studio`.
+   * Otherwise provide the full URL to where the Studio is hosted, for example: `https://blog.sanity.studio`.
+   *
+   */
+  studioUrl?: StudioUrl | ResolveStudioUrl;
+  filter?: FilterDefault;
+  /**
+   * Specify a `console.log` compatible logger to see debug logs, which keys are encoded and which are not.
+   */
+  logger?: Logger;
+  /**
+   * Set to `true` to omit cross dataset reference specific data from encoded strings
+   */
+  omitCrossDatasetReferenceData?: boolean;
+}
+/** @public */
+type StegaConfigRequiredKeys = Extract<keyof StegaConfig, 'enabled'>;
+/** @public */
+type InitializedStegaConfig = Omit<StegaConfig, StegaConfigRequiredKeys> & Required<Pick<StegaConfig, StegaConfigRequiredKeys>>;
+/**
+ * @public
+ * @deprecated -- use `ClientConfig` instead
+ */
+interface ClientStegaConfig extends ClientConfig {}
+/**
+ * @public
+ * @deprecated -- use `InitializedClientConfig` instead
+ */
+interface InitializedClientStegaConfig extends InitializedClientConfig {}
+/** @public */
+type FilterDefault = (props: {
+  /**
+   * The path to the value in the source document, for example if you queried for a document like this:
+   * `*[_type == "author"][0]{"slug": slug.current}`
+   * Then the `sourcePath` for `result.slug` would be `['slug', 'current']`.
+   *
+   */
+  sourcePath: ContentSourceMapParsedPath;
+  /**
+   * If `sourcePath` alone isn't enough to tell you if it's safe to contain stega strings, then you can use `sourceDocument`
+   * for additional metadata.
+   * It'll always have a `_type` property, which can be used to trace it to the Studio Schema that were used initially.
+   * It also has `_id` to help you debug and look at the whole document when troubleshooting.
+   * Finally, if the document origins in a Cross Dataset Reference you'll also have `_projectId` and `_dataset` properties to help you trace it.
+   */
+  sourceDocument: ContentSourceMapDocuments[number];
+  /**
+   * If you don't colocate your Studio Schemas with your GROQ queries it might be hard to make sense of `sourcePath`,
+   * as it operates on the original shape of a document.
+   * In that case `resultPath` can be used, as it mirrors the path to the value in the result.
+   * For example in a query like this:
+   * `*[_type == "author"][0]{"slug": slug.current}`
+   * The `resultPath` for `result.slug` would be `['slug']`, while `sourcePath` will be `['slug', 'current']`.
+   */
+  resultPath: ContentSourceMapParsedPath;
+  /**
+   * You can also use your own string validation logic to determine if it's safe.
+   */
+  value: string;
+  /**
+     * If you want to keep the default filtering behavior, but only override it for a specific path, you can use `filterDefault` to do that.
+     * For example, here all "icon" documents in a Page Builder skips encoding:
+     * ```ts
+          {
+            filter: (props) => {
+              switch (props.sourceDocument._type) {
+                case 'icon':
+                  return false
+                default:
+                  return props.filterDefault(props)
+              }
+            }
+          }
+         * ```
+     */
+  filterDefault: FilterDefault;
+}) => boolean;
+/** @public */
+type Logger = typeof console | Partial<Pick<typeof console, 'debug' | 'error' | 'groupCollapsed' | 'groupEnd' | 'log' | 'table'>>;
+/**
+ * @internal
+ */
+type Encoder = (context: {
+  sourcePath: ContentSourceMapParsedPath;
+  sourceDocument: ContentSourceMapDocuments[number];
+  resultPath: ContentSourceMapParsedPath;
+  value: string;
+}) => string;
+export { ContentSourceMapQueryResponse as a, InitializedClientStegaConfig as c, ResolveStudioUrl as d, StegaConfig as f, StudioUrl$1 as g, StudioBaseUrl as h, ContentSourceMapParsedPathKeyedSegment as i, InitializedStegaConfig as l, StudioBaseRoute as m, ContentSourceMap$2 as n, Encoder as o, StegaConfigRequiredKeys as p, ContentSourceMapParsedPath$1 as r, FilterDefault as s, ClientStegaConfig as t, Logger as u };
+//# sourceMappingURL=types-CfGzbXrl.d.ts.map

package/package.json

@@ -1,181 +1,104 @@
 {
   "name": "@sanity/client",
-  "version": "7.26.1",
+  "version": "8.0.0",
   "description": "Client for retrieving, creating and patching data from Sanity.io",
   "keywords": [
-    "sanity",
+    "api",
+    "client",
     "cms",
-    "headless",
-    "realtime",
     "content",
-    "client",
     "fetch",
-    "api"
+    "headless",
+    "realtime",
+    "sanity"
   ],
   "homepage": "https://www.sanity.io/",
   "bugs": {
     "url": "https://github.com/sanity-io/client/issues"
   },
+  "license": "MIT",
+  "author": "Sanity.io <hello@sanity.io>",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/sanity-io/client.git"
   },
-  "license": "MIT",
-  "author": "Sanity.io <hello@sanity.io>",
-  "sideEffects": false,
+  "files": [
+    "dist",
+    "src"
+  ],
   "type": "module",
+  "sideEffects": false,
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "source": "./src/index.ts",
-      "browser": {
-        "source": "./src/index.browser.ts",
-        "import": "./dist/index.browser.js",
-        "require": "./dist/index.browser.cjs"
+      "react-server": "./dist/index.js",
+      "sanity-function": "./dist/index.js",
+      "deno": "./dist/index.js",
+      "bun": "./dist/index.js",
+      "workerd": "./dist/index.js",
+      "worker": "./dist/index.js",
+      "node": {
+        "import": "./dist/index.node.js",
+        "default": "./dist/index.node.js"
       },
-      "react-native": {
-        "import": "./dist/index.browser.js",
-        "require": "./dist/index.browser.cjs"
-      },
-      "sanity-function": "./dist/index.browser.js",
-      "react-server": "./dist/index.browser.js",
-      "bun": "./dist/index.browser.js",
-      "deno": "./dist/index.browser.js",
-      "edge": "./dist/index.browser.js",
-      "edge-light": "./dist/index.browser.js",
-      "worker": "./dist/index.browser.js",
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs",
       "default": "./dist/index.js"
     },
-    "./csm": {
-      "source": "./src/csm/index.ts",
-      "import": "./dist/csm.js",
-      "require": "./dist/csm.cjs",
-      "default": "./dist/csm.js"
-    },
-    "./stega": {
-      "source": "./src/stega/index.ts",
-      "browser": {
-        "source": "./src/stega/index.ts",
-        "import": "./dist/stega.browser.js",
-        "require": "./dist/stega.browser.cjs"
-      },
-      "import": "./dist/stega.js",
-      "require": "./dist/stega.cjs",
-      "default": "./dist/stega.js"
-    },
-    "./media-library": {
-      "source": "./src/media-library.ts",
-      "import": "./dist/media-library.js",
-      "require": "./dist/media-library.cjs",
-      "default": "./dist/media-library.js"
-    },
+    "./csm": "./dist/csm.js",
+    "./stega": "./dist/stega.js",
+    "./media-library": "./dist/media-library.js",
     "./package.json": "./package.json"
   },
-  "main": "./dist/index.cjs",
-  "unpkg": "umd/sanityClient.min.js",
-  "module": "./dist/index.js",
-  "browser": {
-    "./dist/index.cjs": "./dist/index.browser.cjs",
-    "./dist/index.js": "./dist/index.browser.js"
-  },
-  "types": "./dist/index.d.ts",
-  "typesVersions": {
-    "*": {
-      "csm": [
-        "./dist/csm.d.ts"
-      ],
-      "stega": [
-        "./dist/stega.d.ts"
-      ],
-      "media-library": [
-        "./dist/media-library.d.ts"
-      ]
-    }
-  },
-  "files": [
-    "dist",
-    "src",
-    "umd"
-  ],
-  "scripts": {
-    "benchmark": "npm test -- bench",
-    "prebuild": "npm run clean",
-    "build": "pkg build --strict && pkg --strict && npm run rollup && npm run minify",
-    "check-esm-compatibility": "node scripts/check-esm-compatibility.mjs",
-    "clean": "npx rimraf dist coverage umd/*.js",
-    "coverage": "vitest run --coverage",
-    "lint": "eslint . --max-warnings 0",
-    "minify": "terser -c -m -- umd/sanityClient.js > umd/sanityClient.min.js",
-    "prepublishOnly": "npm run build",
-    "rollup": "NODE_ENV=production rollup -c rollup.config.cjs",
-    "test": "vitest",
-    "test:browser": "npm test -- --config ./vitest.browser.config.ts",
-    "test:bun": "bun test runtimes/bun",
-    "test:deno": "deno test --allow-read --allow-net --allow-env --fail-fast --import-map=runtimes/deno/import_map.json runtimes/deno",
-    "test:deno:update_import_map": "deno run --allow-read --allow-write runtimes/deno/update_import_map.ts",
-    "test:edge-runtime": "npm test -- --config vitest.edge.config.ts",
-    "test:next": "npm test -- --config ./vitest.next.config.ts",
-    "test:node-runtimes": "(cd runtimes/node && node --test)"
-  },
-  "browserslist": "extends @sanity/browserslist-config",
-  "prettier": {
-    "bracketSpacing": false,
-    "plugins": [
-      "prettier-plugin-packagejson"
-    ],
-    "printWidth": 100,
-    "semi": false,
-    "singleQuote": true
-  },
   "dependencies": {
-    "@sanity/eventsource": "^5.0.4",
-    "get-it": "^8.8.0",
-    "nanoid": "^3.3.11",
-    "rxjs": "^7.0.0"
+    "eventsource": "^5.0.0",
+    "get-it": "^9.4.1",
+    "nanoid": "^6.0.1",
+    "obug": "^2.1.4",
+    "rxjs": "^7.8.2"
   },
   "devDependencies": {
+    "@changesets/cli": "^2.31.1",
+    "@cloudflare/vitest-pool-workers": "^0.20.1",
     "@edge-runtime/types": "^4.0.0",
     "@edge-runtime/vm": "^5.0.0",
-    "@eslint/eslintrc": "^3.3.1",
-    "@eslint/js": "^9.24.0",
-    "@rollup/plugin-commonjs": "^28.0.3",
-    "@rollup/plugin-node-resolve": "^16.0.1",
-    "@sanity/client-latest": "npm:@sanity/client@latest",
-    "@sanity/pkg-utils": "^7.2.2",
+    "@sanity/pkg-utils": "^12.1.2",
     "@types/json-diff": "^1.0.3",
-    "@types/node": "^22.9.0",
-    "@types/react": "^19.2.17",
-    "@typescript-eslint/eslint-plugin": "^8.29.1",
-    "@typescript-eslint/parser": "^8.29.1",
+    "@types/node": "^22.20.1",
+    "@types/react": "^19.2.18",
     "@vercel/stega": "1.1.0",
-    "@vitest/coverage-v8": "3.1.1",
-    "eslint": "^9.24.0",
-    "eslint-config-prettier": "^10.1.1",
-    "eslint-formatter-compact": "^8.40.0",
-    "eslint-plugin-prettier": "^5.2.6",
-    "eslint-plugin-simple-import-sort": "^12.1.1",
-    "eslint-plugin-tsdoc": "^0.4.0",
-    "eslint-plugin-unused-imports": "^4.1.4",
-    "globals": "^16.0.0",
-    "happy-dom": "^12.10.3",
+    "@vitest/coverage-v8": "^4.1.10",
+    "eventsource-encoder": "^1.0.2",
+    "happy-dom": "^20.11.1",
     "json-diff": "^1.0.6",
-    "ls-engines": "^0.9.3",
-    "msw": "^2.7.3",
-    "next": "15.5.8",
-    "nock": "^13.5.6",
-    "pkg-pr-new": "^0.0.60",
-    "prettier": "^3.5.3",
-    "prettier-plugin-packagejson": "^2.5.10",
-    "rimraf": "^5.0.7",
-    "rollup": "^4.39.0",
-    "sse-channel": "^4.0.0",
-    "terser": "^5.39.0",
-    "typescript": "5.8.3",
-    "vitest": "3.1.1"
+    "ls-engines": "^0.10.1",
+    "next": "^16.3.0",
+    "oxfmt": "^0.63.0",
+    "oxlint": "^1.78.0",
+    "oxlint-tsgolint": "^7.0.2001",
+    "pkg-pr-new": "^0.0.86",
+    "typescript": "7.0.2",
+    "vitest": "^4.1.10"
   },
-  "packageManager": "npm@11.4.1",
+  "browserslist": "extends @sanity/browserslist-config",
   "engines": {
-    "node": ">=20"
+    "node": ">=22.12.0"
+  },
+  "inlinedDependencies": {
+    "@vercel/stega": "1.1.0"
+  },
+  "scripts": {
+    "build": "pkg build --strict && pkg --strict",
+    "coverage": "vitest run --coverage",
+    "lint": "oxlint",
+    "release": "changeset publish",
+    "test": "vitest",
+    "test:browser": "vitest run --config ./vitest.browser.config.ts",
+    "test:bun": "bun test runtimes/bun",
+    "test:deno": "npm pack --pack-destination runtimes/deno && cd runtimes/deno && npm install --no-save --no-package-lock ./sanity-client-*.tgz @types/node && deno test --allow-read --allow-net --allow-env --fail-fast --node-modules-dir=manual .",
+    "test:next": "vitest run --config ./vitest.next.config.ts",
+    "test:node-runtimes": "(cd runtimes/node && node --test)",
+    "test:vercel-edge": "vitest run --config ./vitest.vercel-edge.config.ts",
+    "test:workerd": "vitest run --config ./vitest.workerd.config.ts",
+    "format": "oxfmt",
+    "format:check": "oxfmt --check"
   }
-}
+}