@qlik/embed-runtime - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

CHANGELOG.md

 # @qlik/embed-runtime
 
+## 1.0.3
+
+### Patch Changes
+
+- 1cea463: feat: update exported types from the qix module
+
 ## 1.0.2
@@ -4,0 +10,0 @@

dist/qix.d.ts

@@ -1,70 +0,4 @@
-import { HostConfig } from '@qlik/api/auth';
+import { OpenAppSessionProps, AppSession } from '@qlik/api/qix';
+export { AppSession, OpenAppSessionProps } from '@qlik/api/qix';
 
-/**
- * @experimental
- * The type of event that is sent to any listeners added through onWebSocketEvent.
- */
-type OpenAppSessionProps = {
-    appId: string;
-    identity?: string;
-    hostConfig?: HostConfig;
-};
-/**
- * @experimental
- * The type of event that is sent to any listeners added through onWebSocketEvent.
- */
-type WebSocketEventPayloads = {
-    opened: object;
-    suspended: {
-        code: number;
-        reason: string;
-        initiator: "manual" | "network";
-    };
-    resuming: object;
-    resumed: object;
-    closed: {
-        code: number;
-        reason: string;
-    };
-};
-type WebSocketEventType = keyof WebSocketEventPayloads;
-/**
- * @experimental
- * The type of event that is sent to any listeners added through onWebSocketEvent.
- */
-type WebSocketEvent<ET extends WebSocketEventType = WebSocketEventType> = {
-    [K in WebSocketEventType]: {
-        eventType: K;
-    } & WebSocketEventPayloads[K] & OpenAppSessionProps;
-}[ET];
-/**
- * An object that represents one usage of an enigma websocket connected to the engine.
- */
-type AppSession = {
-    /**
-     * Returns a promise of the Qix Doc object with a set of client-side Api extensions.
-     * Note that while the AppSession object is returned immediately this promise might take a while
-     * to resolve for bigger apps.
-     */
-    getDoc: () => Promise<unknown>;
-    /**
-     * When the app session is no longer in use it must be closed using this function.
-     * If the same underlying enigma websocket is used somewhere else in the browser
-     * this is basically a no op, but if this is the last/only usage
-     * of the underlying enigma websocket that websocket will be closed.
-     */
-    close: () => Promise<void>;
-    /**
-     * @experimental
-     * Add an event-listener for this app-session.
-     */
-    onWebSocketEvent: (listener: (event: WebSocketEvent) => void) => () => void;
-    /**
-     * @experimental
-     * Resume a suspended session. This will resume exactly
-     * once if the session is currently suspended, otherwise
-     * nothing will be done.
-     */
-    resume: () => Promise<void>;
-};
 interface QixRuntimeApiV1 {
@@ -75,2 +9,2 @@ openAppSession(appSessionProps: OpenAppSessionProps): AppSession;
 
-export { type AppSession, type QixRuntimeApiV1, _default as default };
+export { type QixRuntimeApiV1, _default as default };

package.json

 {
   "name": "@qlik/embed-runtime",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Types for Qlik Embed libraries",
@@ -20,12 +20,12 @@ "license": "ISC",
   "dependencies": {
-    "@qlik/api": "1.4.1"
+    "@qlik/api": "1.5.0"
   },
   "devDependencies": {
-    "@qlik/eslint-config": "0.7.19",
+    "@qlik/eslint-config": "0.7.20",
     "@qlik/prettier-config": "0.4.13",
     "@qlik/tsconfig": "0.2.5",
-    "@types/node": "20.12.8",
+    "@types/node": "20.12.11",
     "eslint": "8.57.0",
     "prettier": "3.2.5",
-    "rimraf": "5.0.5",
+    "rimraf": "5.0.6",
     "tsup": "8.0.2",
@@ -32,0 +32,0 @@ "typescript": "5.4.5"

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

16178

decreased by-10.72%

Lines of code

341

decreased by-16.22%

Dependency changes

• + Added@qlik/api@1.5.0(transitive)

• - Removed@qlik/api@1.4.1(transitive)

• - Removed@qlik/embed-runtime@0.7.0(transitive)

• - Removed@qlik/runtime-module-loader@0.2.7(transitive)

• - Removedajv@8.17.1(transitive)

• - Removedbufferutil@4.0.9(transitive)

• - Removedfast-deep-equal@3.1.3(transitive)

• - Removedfast-uri@3.0.6(transitive)

• - Removedjson-schema-traverse@1.0.0(transitive)

• - Removednode-gyp-build@4.8.4(transitive)

• - Removedrequire-from-string@2.0.2(transitive)

• Updated@qlik/api@1.5.0