@sanity/core-loader - npm Package Compare versions

Comparing version 0.8.1-pink-lizard to 0.9.0-pink-lizard

CHANGELOG.md

 # Changelog
 
+## [0.9.0-pink-lizard](https://github.com/sanity-io/visual-editing/compare/core-loader-v0.8.1-pink-lizard...core-loader-v0.9.0-pink-lizard) (2023-11-13)
+
+
+### Features
+
+* add `encodeDataAttribute` API ([d9179f3](https://github.com/sanity-io/visual-editing/commit/d9179f30ab0defb1539d589a24c230683cce9c4e))
+
+
+### Bug Fixes
+
+* **deps:** Update dependency @sanity/client to ^6.8.2 ([#356](https://github.com/sanity-io/visual-editing/issues/356)) ([b80dfa5](https://github.com/sanity-io/visual-editing/commit/b80dfa519c9790efdfdc0590ad7eb3f56998ea01))
+* **deps:** Update dependency @sanity/client to ^6.8.4 ([5dbbe06](https://github.com/sanity-io/visual-editing/commit/5dbbe062ac1dd71a251e70d15caa1c5d53a505f6))
+* **deps:** Update dependency @sanity/client to ^6.8.5 ([#361](https://github.com/sanity-io/visual-editing/issues/361)) ([e8e61c1](https://github.com/sanity-io/visual-editing/commit/e8e61c1a377b2737db60a1c3e42160794b26ad9b))
+
 ## [0.8.1-pink-lizard](https://github.com/sanity-io/visual-editing/compare/core-loader-v0.8.0-pink-lizard...core-loader-v0.8.1-pink-lizard) (2023-11-13)
@@ -4,0 +18,0 @@

dist/index.d.ts

@@ -7,2 +7,4 @@ import { Cache as Cache_2 } from 'async-cache-dedupe'
 import type { SanityStegaClient } from '@sanity/client/stega'
+import type { StegaConfig } from '@sanity/client/stega'
+import type { StudioPathLike } from '@sanity/client/csm'
 
@@ -71,2 +73,13 @@ declare const actionId: unique symbol
 
+/**
+ * Creates a encoded payload suitable for passing to a `data-sanity` attribute, which are used by `@sanity/overlays`
+ * @public
+ */
+export declare type EncodeDataAttribute<QueryResponseResult = unknown> = (
+  result: QueryResponseResult,
+  sourceMap: ContentSourceMap | undefined,
+  studioUrl: Exclude<StegaConfig['studioUrl'], undefined>,
+  path: StudioPathLike,
+) => string | undefined
+
 /** @internal */
@@ -193,4 +206,4 @@ export declare interface Fetcher {
       data: QueryResponseResult
-      sourceMap: ContentSourceMap | undefined
-      perspective: ClientPerspective | undefined
+      sourceMap?: ContentSourceMap
+      perspective?: ClientPerspective
     },
@@ -230,6 +243,6 @@ ) => MapStore<QueryStoreState<QueryResponseResult, QueryResponseError>>
   loading: boolean
-  error: QueryResponseError | undefined
-  data: QueryResponseResult | undefined
-  sourceMap: ContentSourceMap | undefined
-  perspective: ClientPerspective | undefined
+  error?: QueryResponseError
+  data?: QueryResponseResult
+  sourceMap?: ContentSourceMap
+  perspective?: ClientPerspective
 }
@@ -236,0 +249,0 @@

dist/index.js

@@ -1,1 +0,1 @@
-import"async-cache-dedupe";export{c as createQueryStore,r as runtime}from"./_chunks/index-9FdVYKzy.js";//# sourceMappingURL=index.js.map
+import"async-cache-dedupe";export{c as createQueryStore,r as runtime}from"./_chunks/index-_W1UJAA8.js";//# sourceMappingURL=index.js.map

package.json

 {
   "name": "@sanity/core-loader",
-  "version": "0.8.1-pink-lizard",
+  "version": "0.9.0-pink-lizard",
   "homepage": "https://github.com/sanity-io/visual-editing/tree/main/packages/core-loader#readme",
@@ -29,2 +29,13 @@ "bugs": {
     },
+    "./encode-data-attribute": {
+      "types": "./dist/encode-data-attribute.d.ts",
+      "source": "./src/encodeDataAttribute.ts",
+      "require": "./dist/encode-data-attribute.cjs",
+      "node": {
+        "module": "./dist/encode-data-attribute.js",
+        "import": "./dist/encode-data-attribute.cjs.js"
+      },
+      "import": "./dist/encode-data-attribute.js",
+      "default": "./dist/encode-data-attribute.js"
+    },
     "./package.json": "./package.json"
@@ -36,2 +47,9 @@ },
   "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "encode-data-attribute": [
+        "./dist/encode-data-attribute.d.ts"
+      ]
+    }
+  },
   "files": [
@@ -104,6 +122,6 @@ "dist",
   "devDependencies": {
-    "@sanity/client": "^6.8.1",
+    "@sanity/client": "^6.8.5",
     "@sanity/pkg-utils": "^3.2.3",
-    "@typescript-eslint/eslint-plugin": "^6.10.0",
-    "@typescript-eslint/parser": "^6.10.0",
+    "@typescript-eslint/eslint-plugin": "^6.11.0",
+    "@typescript-eslint/parser": "^6.11.0",
     "eslint": "^8.53.0",
@@ -119,3 +137,3 @@ "eslint-config-prettier": "^9.0.0",
   "peerDependencies": {
-    "@sanity/client": "^6.8.1"
+    "@sanity/client": "^6.8.5"
   },
@@ -122,0 +140,0 @@ "engines": {

New alerts

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Fixed alerts

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

443189

increased by152.03%

Number of package files

24

increased by33.33%

Lines of code

455

increased by14.32%

Worsened metrics

Number of low quality alerts

4

increased by33.33%

No dependency changes