@qlik/embed-runtime - npm Package Compare versions

Comparing version 1.2.3 to 1.2.4

CHANGELOG.md

 # @qlik/embed-runtime
 
+## 1.2.4
+
+### Patch Changes
+
+- c32da18: Update SheetProps type to accept both objectId and sheetId. Both can be used to render a sheet and should be the sheet id. They cannot be used together.
+
 ## 1.2.3
@@ -4,0 +10,0 @@

dist/embed.d.ts

@@ -66,6 +66,19 @@ import { HostConfig } from '@qlik/api/auth';
 };
-type SheetProps = CommonAnalyticsProps & {
-    /** The id of the object to render  */
+/**
+ * Properties for an embedded sheet
+ * Accepts either a sheetId or an objectId
+ * both can be used and should be the id of the sheet to render
+ * but they cannot be used together
+ */
+type SheetProps = CommonAnalyticsProps & ({
+    /** The id of the sheet to render  */
     sheetId: string;
-};
+    /** The id of the sheet to render  */
+    objectId?: never;
+} | {
+    /** The id of the sheet to render  */
+    objectId: string;
+    /** The id of the sheet to render  */
+    sheetId?: never;
+});
 type FieldProps = CommonAnalyticsProps & ({
@@ -72,0 +85,0 @@ /**

package.json

 {
   "name": "@qlik/embed-runtime",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "description": "Types for Qlik Embed libraries",
@@ -5,0 +5,0 @@ "license": "ISC",

No alert changes

Improved metrics

Total package byte prevSize

18532

increased by3.23%

Lines of code

381

increased by3.53%

No dependency changes