@sanity/core-loader - npm Package Compare versions

Comparing version 1.6.12 to 1.6.13

CHANGELOG.md

@@ -21,2 +21,11 @@ <!-- markdownlint-disable --><!-- textlint-disable -->
 
+## [1.6.13](https://github.com/sanity-io/visual-editing/compare/core-loader-v1.6.12...core-loader-v1.6.13) (2024-05-13)
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * devDependencies
+    * @repo/visual-editing-helpers bumped from 0.6.10 to 0.6.11
+
 ## [1.6.12](https://github.com/sanity-io/visual-editing/compare/core-loader-v1.6.11...core-loader-v1.6.12) (2024-05-05)
@@ -23,0 +32,0 @@

dist/create-data-attribute.d.ts

@@ -6,47 +6,79 @@ import type {StudioPathLike} from '@sanity/client/csm'
  */
-export declare type CreateDataAttribute = {
-  /**
-   * @public
-   * Returns a string representation of the data attribute
-   * @param path - An optional path to concatenate with any existing path
-   */
-  (path?: StudioPathLike): string
-  /**
-   * @public
-   * Concatenate the data attribute current path with a new path
-   * @param path - A path to concatenate with any existing path
-   */
-  scope(path: StudioPathLike): CreateDataAttribute
-  /**
-   * @public
-   * Combines the current data attribute props with additional props
-   * @param props - New props to merge with any existing props
-   */
-  combine(props: CreateDataAttributeProps): CreateDataAttribute
-  /**
-   * @public
-   * Returns a string representation of the data attribute
-   */
-  toString(): string
-}
+export declare type CreateDataAttribute<T extends CreateDataAttributeProps> =
+  (T extends WithRequired<CreateDataAttributeProps, 'id' | 'type' | 'path'>
+    ? {
+        /**
+         * Returns a string representation of the data attribute
+         * @param path - An optional path to concatenate with any existing path
+         * @public
+         */
+        (path?: StudioPathLike): string
+        /**
+         * Returns a string representation of the data attribute
+         * @public
+         */
+        toString(): string
+      }
+    : T extends WithRequired<CreateDataAttributeProps, 'id' | 'type'>
+      ? (path: StudioPathLike) => string
+      : object) & {
+    /**
+     * Concatenate the current path with a new path
+     * @param path - A path to concatenate with any existing path
+     * @public
+     */
+    scope(path: StudioPathLike): CreateDataAttribute<
+      T & {
+        path: StudioPathLike
+      }
+    >
+    /**
+     * Combines the current props with additional props
+     * @param props - New props to merge with any existing props
+     * @public
+     */
+    combine: <U extends CreateDataAttributeProps>(props: U) => CreateDataAttribute<T & U>
+  }
 
 /**
+ * A helper function for creating `data-sanity` attributes by explicitly providing metadata.
+ * @returns An object with methods for incrementally adding and scoping metadata, and for generating a data attribute string.
  * @public
  */
-export declare function createDataAttribute(props: CreateDataAttributeProps): CreateDataAttribute
+export declare function createDataAttribute<T extends CreateDataAttributeProps>(
+  props: T,
+): CreateDataAttribute<T>
 
 /**
+ * The metadata that can be embedded in a data attribute.
+ * All values are marked optional in the base type as they can be provided incrementally using the `createDataAttribute` function.
  * @public
  */
 export declare interface CreateDataAttributeProps {
+  /** The studio base URL, optional */
   baseUrl?: string
+  /** The dataset, optional */
   dataset?: string
+  /** The document ID, required */
   id?: string
+  /** The field path, required */
   path?: StudioPathLike
+  /** The project ID, optional */
   projectId?: string
+  /** The studio tool name, optional */
   tool?: string
+  /** The document type, required */
   type?: string
+  /** The studio workspace, optional */
   workspace?: string
 }
 
+/**
+ * Helper
+ * @internal
+ */
+declare type WithRequired<T, K extends keyof T> = T & {
+  [P in K]-?: T[P]
+}
+
 export {}

dist/create-data-attribute.js

@@ -1,1 +0,1 @@
-import{studioPath as t}from"@sanity/client/csm";import{x as r}from"./_chunks-es/transformSanityNodeData.js";function e(a){function n(r){return r?"string"==typeof r?t.fromString(r):r:[]}function o(e){if(!e.id)throw new Error("`id` is required to create a data attribute");if(!e.type)throw new Error("`type` is required to create a data attribute");if(!e.path||!e.path.length)throw new Error("`path` is required to create a data attribute");const a={baseUrl:e.baseUrl||"/",workspace:e.workspace,tool:e.tool,type:e.type,id:e.id,path:"string"==typeof e.path?e.path:t.toString(e.path)};return r(a)}const i=function(t){return o({...a,path:[...n(a.path),...n(t)]})};return i.toString=function(){return o(a)},i.combine=function(t){return e({...a,...t})},i.scope=function(t){return e({...a,path:[...n(a.path),...n(t)]})},i}export{e as createDataAttribute};//# sourceMappingURL=create-data-attribute.js.map
+import{studioPath as t}from"@sanity/client/csm";import{x as r}from"./_chunks-es/transformSanityNodeData.js";function e(a){function o(r){return r?"string"==typeof r?t.fromString(r):r:[]}function n(e){if(!e.id)throw new Error("`id` is required to create a data attribute");if(!e.type)throw new Error("`type` is required to create a data attribute");if(!e.path||!e.path.length)throw new Error("`path` is required to create a data attribute");const a={baseUrl:e.baseUrl||"/",workspace:e.workspace,tool:e.tool,type:e.type,id:e.id,path:"string"==typeof e.path?e.path:t.toString(e.path)};return r(a)}const i=t=>n({...a,path:[...o(a.path),...o(t)]});return i.toString=function(){return n(a)},i.combine=function(t){return e({...a,...t})},i.scope=function(t){return e({...a,path:[...o(a.path),...o(t)]})},i}export{e as createDataAttribute};//# sourceMappingURL=create-data-attribute.js.map

package.json

 {
   "name": "@sanity/core-loader",
-  "version": "1.6.12",
+  "version": "1.6.13",
   "homepage": "https://github.com/sanity-io/visual-editing/tree/main/packages/core-loader#readme",
@@ -107,5 +107,5 @@ "bugs": {
     "@repo/channels": "0.4.0",
-    "@repo/visual-editing-helpers": "0.6.10",
-    "@sanity/client": "^6.17.2",
-    "@sanity/pkg-utils": "6.8.11",
+    "@repo/visual-editing-helpers": "0.6.11",
+    "@sanity/client": "^6.18.0",
+    "@sanity/pkg-utils": "6.8.14",
     "@typescript-eslint/eslint-plugin": "^7.8.0",
@@ -118,3 +118,3 @@ "@typescript-eslint/parser": "^7.8.0",
     "eslint-plugin-simple-import-sort": "^12.1.0",
-    "happy-dom": "^14.7.1",
+    "happy-dom": "^14.10.1",
     "nanostores": "0.10.3",
@@ -126,3 +126,3 @@ "typescript": "5.4.5",
   "peerDependencies": {
-    "@sanity/client": "^6.17.2"
+    "@sanity/client": "^6.18.0"
   },
@@ -129,0 +129,0 @@ "engines": {

No alert changes

Improved metrics

Total package byte prevSize

818508

0.32%

Lines of code

811

3.97%

No dependency changes