@sanity/preview-kit - npm Package Compare versions

Comparing version 1.2.4 to 1.2.5

dist/index.d.ts

@@ -101,7 +101,3 @@ import type { Config } from '@sanity/groq-store'
     Config,
-    | 'projectId'
-    | 'dataset'
-    | 'documentLimit'
-    | 'subscriptionThrottleMs'
-    | 'includeTypes'
+    'projectId' | 'dataset' | 'subscriptionThrottleMs' | 'includeTypes'
   > {
@@ -139,2 +135,8 @@ /**
   /**
+   * The maximum number of documents, to prevent using too much memory unexpectedly
+   * Throws on the first operation (query, retrieval, subscription) if reaching this limit.
+   * @defaultValue 3000
+   */
+  documentLimit?: number
+  /**
    * Lazy load `@sanity/groq-store` either using Suspense or `React.use` and `React.cache`.
@@ -141,0 +143,0 @@ */

dist/index.js

@@ -42,3 +42,3 @@ 'use client';
     dataset,
-    documentLimit,
+    documentLimit = 3e3,
     subscriptionThrottleMs,
@@ -45,0 +45,0 @@ importEventSourcePolyfill,

package.json

 {
   "name": "@sanity/preview-kit",
-  "version": "1.2.4",
+  "version": "1.2.5",
   "description": "General purpose live previews, like next-sanity",
@@ -66,3 +66,3 @@ "keywords": [
   "dependencies": {
-    "@sanity/groq-store": "^1.1.1",
+    "@sanity/groq-store": "^1.1.2",
     "@types/event-source-polyfill": "^1.0.0",
@@ -69,0 +69,0 @@ "event-source-polyfill": "^1.0.31",

src/definePreview.ts

@@ -39,2 +39,9 @@ import type { Config, GroqStore } from '@sanity/groq-store'
   /**
+   * The maximum number of documents, to prevent using too much memory unexpectedly
+   * Throws on the first operation (query, retrieval, subscription) if reaching this limit.
+   * @defaultValue 3000
+   */
+  documentLimit?: number
+
+  /**
    * Lazy load `@sanity/groq-store` either using Suspense or `React.use` and `React.cache`.
@@ -63,5 +70,2 @@ */
   checkAuth: (projectId: string, token: string | null) => boolean
-  /**
-   * Specify a
-   */
 }
@@ -87,3 +91,3 @@
   dataset,
-  documentLimit,
+  documentLimit = 3000,
   subscriptionThrottleMs,
@@ -202,7 +206,3 @@ importEventSourcePolyfill,
     Config,
-    | 'projectId'
-    | 'dataset'
-    | 'documentLimit'
-    | 'subscriptionThrottleMs'
-    | 'includeTypes'
+    'projectId' | 'dataset' | 'subscriptionThrottleMs' | 'includeTypes'
   > {
@@ -209,0 +209,0 @@ /**

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

82189

increased by0.96%

Lines of code

828

increased by0.12%

Dependency changes

• Updated@sanity/groq-store@^1.1.2