@anywidget/types - npm Package Compare versions

Comparing version 0.1.5 to 0.1.6

./index.ts

@@ -62,1 +62,10 @@ import type { IWidgetManager } from "@jupyter-widgets/base";
 }
+
+interface WidgetDef<T extends ObjectHash = ObjectHash> {
+	initialize?: Initialize<T>;
+	render?: Render<T>;
+}
+
+export type AnyWidget<T extends ObjectHash = ObjectHash> =
+	| WidgetDef<T>
+	| (() => Awaitable<WidgetDef<T>>);

dist/index.d.ts

@@ -39,2 +39,7 @@ import type { IWidgetManager } from "@jupyter-widgets/base";
 }
+interface WidgetDef<T extends ObjectHash = ObjectHash> {
+    initialize?: Initialize<T>;
+    render?: Render<T>;
+}
+export type AnyWidget<T extends ObjectHash = ObjectHash> = WidgetDef<T> | (() => Awaitable<WidgetDef<T>>);
 export {};

dist/index.test-d.js

@@ -61,1 +61,36 @@ import { describe, expectTypeOf, it } from "vitest";
 });
+describe("Define AnyWidget", () => {
+    it("infers initialize and render for static widget", () => {
+        let w = {
+            initialize({ model }) {
+                expectTypeOf(model.get("value")).toEqualTypeOf();
+            },
+            render({ model, el }) {
+                expectTypeOf(el).toEqualTypeOf();
+                expectTypeOf(model.get("value")).toEqualTypeOf();
+            },
+        };
+    });
+    it("infers initialize and render for function widget", () => {
+        let w = () => ({
+            initialize({ model }) {
+                expectTypeOf(model.get("value")).toEqualTypeOf();
+            },
+            render({ model, el }) {
+                expectTypeOf(el).toEqualTypeOf();
+                expectTypeOf(model.get("value")).toEqualTypeOf();
+            },
+        });
+    });
+    it("infers initialize and render for async function widget", () => {
+        let w = async () => ({
+            initialize({ model }) {
+                expectTypeOf(model.get("value")).toEqualTypeOf();
+            },
+            render({ model, el }) {
+                expectTypeOf(el).toEqualTypeOf();
+                expectTypeOf(model.get("value")).toEqualTypeOf();
+            },
+        });
+    });
+});

package.json

 {
   "name": "@anywidget/types",
   "type": "module",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "utility types for anywidget",
@@ -18,4 +18,4 @@ "main": "dist/index.js",
   "dependencies": {
-    "@jupyter-widgets/base": "^6.0.6"
+    "@jupyter-widgets/base": "^6.0.7"
   }
 }

README.md

@@ -19,4 +19,4 @@ # @anywidget/types
 
+/** @type {import("@anywidget/types").AnyWidget<Model>} */
 export default {
-	/** @type {import("@anywidget/types").Initialize<Model>} */
 	initialize({ model }) {
@@ -26,3 +26,2 @@ let value = model.get("value");
 	},
-	/** @type {import("@anywidget/types").Render<Model>} */
 	render({ model, el }) {
@@ -29,0 +28,0 @@ let value = model.get("value");

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

Total package byte prevSize

9880

19.55%

Lines of code

203

30.13%

Number of medium supply chain risk alerts

0

-100%

Worsened metrics

Number of lines in readme file

41

-2.38%

Dependency changes

• Updated

  @jupyter-widgets/base@^6.0.7