Export the Viz type

mdaines · Jan 5, 2024 · ab72f38 · ab72f38
1 parent 012cc0a
commit ab72f38
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 17 deletions.
diff --git a/.github/workflows/viz-build.yml b/.github/workflows/viz-build.yml
@@ -115,5 +115,4 @@ jobs:
         run: |
           yarn install --frozen-lockfile
           yarn check-types
-          yarn check-types-esnext
         working-directory: packages/viz/test/types
diff --git a/packages/viz/CHANGELOG.md b/packages/viz/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+* Export the Viz type (#224, #225)
+
 ## 3.2.3
 
 * Add a workaround for node names not being used as labels (#218)

diff --git a/packages/viz/test/types/not-exported.ts b/packages/viz/test/types/not-exported.ts
@@ -0,0 +1,8 @@
+// @ts-expect-error
+import { Viz } from "@viz-js/viz";
+
+// @ts-expect-error
+import { type SuccessResult } from "@viz-js/viz";
+
+// @ts-expect-error
+import { type FailureResult } from "@viz-js/viz";
diff --git a/packages/viz/test/types/package.json b/packages/viz/test/types/package.json
@@ -1,11 +1,11 @@
 {
   "private": true,
+  "type": "module",
   "dependencies": {
     "@viz-js/viz": "link:../..",
     "typescript": "^5.1.3"
   },
   "scripts": {
-    "check-types": "tsc --strict --lib es2015,dom --noEmit *.ts",
-    "check-types-esnext": "tsc --strict --lib es2015,dom --module esnext --moduleResolution bundler --noEmit *.ts"
+    "check-types": "tsc --strict --lib es2015,dom --module esnext --moduleResolution bundler --verbatimModuleSyntax --noEmit *.ts"
   }
 }
diff --git a/packages/viz/test/types/top-level.ts b/packages/viz/test/types/top-level.ts
@@ -1,16 +1,4 @@
-import { instance, graphvizVersion, formats, engines, type RenderOptions, type RenderResult, type RenderError } from "@viz-js/viz";
-
-// @ts-expect-error
-import { Viz } from "@viz-js/viz";
-
-// @ts-expect-error
-import { type Viz } from "@viz-js/viz";
-
-// @ts-expect-error
-import { type SuccessResult } from "@viz-js/viz";
-
-// @ts-expect-error
-import { type FailureResult } from "@viz-js/viz";
+import { instance, graphvizVersion, formats, engines, type RenderOptions, type RenderResult, type RenderError, type Viz } from "@viz-js/viz";
 
 let version: string = graphvizVersion;
 

diff --git a/packages/viz/test/types/viz.ts b/packages/viz/test/types/viz.ts
@@ -1,4 +1,8 @@
-import { instance } from "@viz-js/viz";
+import { instance, type Viz } from "@viz-js/viz";
+
+export function myRender(viz: Viz, src: string): string {
+  return viz.renderString(src, { graphAttributes: { label: "My graph" } });
+}
 
 instance().then(viz => {
   viz.render("digraph { a -> b }");
@@ -11,6 +15,8 @@ instance().then(viz => {
 
   viz.render({ edges: [{ tail: "a", head: "b" }] });
 
+  myRender(viz, "digraph { a -> b }");
+
   // @ts-expect-error
   viz.render("digraph { a -> b }", { format: false });
 

diff --git a/packages/viz/types/index.d.ts b/packages/viz/types/index.d.ts
@@ -18,6 +18,8 @@ declare class Viz {
   renderJSON(input: string | Graph, options?: RenderOptions): object
 }
 
+export { type Viz }
+
 export interface RenderOptions {
   format?: string
   engine?: string