@vertexvis/doc-viewer 1.0.2-canary.20 → 1.0.2-canary.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/collection/index.js +4 -0
  2. package/dist/types/index.d.ts +4 -0
  3. package/package.json +5 -4
  4. package/readme.md +3 -0
  5. package/readme.template.md +20 -0
package/dist/collection/index.js CHANGED
@@ -1,5 +1,9 @@
1
1
  /*!
2
2
  * Copyright (c) 2026 Vertex Software LLC. All rights reserved.
3
3
  */
4
+ /**
5
+ * @module DocumentViewer
6
+ * @document component-readmes.md
7
+ */
4
8
  export * from './components';
5
9
  export * from './lib';
package/dist/types/index.d.ts CHANGED
@@ -1,3 +1,7 @@
1
+ /**
2
+ * @module DocumentViewer
3
+ * @document component-readmes.md
4
+ */
1
5
  export * from './components';
2
6
  export * from './lib';
3
7
  //# sourceMappingURL=index.d.ts.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vertexvis/doc-viewer",
3
- "version": "1.0.2-canary.20",
3
+ "version": "1.0.2-canary.22",
4
4
  "description": "The Vertex SDK for viewing documents.",
5
5
  "type": "module",
6
6
  "main": "dist/index.cjs",
@@ -78,6 +78,7 @@
78
78
  "test:ci": "stencil test --spec --coverage --runInBand",
79
79
  "test:coverage": "stencil test --spec --coverage --runInBand",
80
80
  "generate": "stencil generate",
81
+ "generate:docs": "../../scripts/generate_docs.sh",
81
82
  "release:stage": "yarn generate:docs"
82
83
  },
83
84
  "devDependencies": {
@@ -95,11 +96,11 @@
95
96
  "typescript": "~5.9.3"
96
97
  },
97
98
  "dependencies": {
98
- "@vertexvis/geometry": "1.0.2-canary.20",
99
- "@vertexvis/utils": "1.0.2-canary.20",
99
+ "@vertexvis/geometry": "1.0.2-canary.22",
100
+ "@vertexvis/utils": "1.0.2-canary.22",
100
101
  "classnames": "^2.5.1",
101
102
  "pdfjs-dist": "^5.5.207",
102
103
  "resize-observer": "^1.0.4"
103
104
  },
104
- "gitHead": "512f90c967cd8ae376ddbe880e1598702a10fe39"
105
+ "gitHead": "81b8fcc50348d2d0d968f167bd3696accced790d"
105
106
  }
package/readme.md CHANGED
@@ -1,3 +1,6 @@
1
+ <!-- DO NOT EDIT THE README.md DIRECTLY. THIS FILE IS AUTO-GENERATED. -->
2
+ <!-- INSTEAD EDIT README.template.md -->
3
+
1
4
  [![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D&colorA=16161d&style=flat-square)](https://stenciljs.com)
2
5
 
3
6
  # Note: This SDK is a work in progress and is subject to regular breaking changes
package/readme.template.md ADDED
@@ -0,0 +1,20 @@
1
+ <!-- DO NOT EDIT THE README.md DIRECTLY. THIS FILE IS AUTO-GENERATED. -->
2
+ <!-- INSTEAD EDIT README.template.md -->
3
+
4
+ [![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D&colorA=16161d&style=flat-square)](https://stenciljs.com)
5
+
6
+ # Note: This SDK is a work in progress and is subject to regular breaking changes
7
+ Please reach out to Vertex directly for assistance if you're interested in using this package.
8
+
9
+ # Vertex Document Viewer SDK
10
+
11
+ This project contains Vertex's 2D Viewer SDK. Vertex is a cloud platform for
12
+ rendering large 3D models. See [Vertex's website][vertex] for more information.
13
+
14
+ Our 2D viewer is distributed as a set of standards-based [web components] that
15
+ can run in any browser supporting the Custom Elements v1 specification. For
16
+ browsers that do not support the Custom Elements v1 spec, a polyfill will
17
+ automatically be used.
18
+
19
+ [vertex]: https://www.vertex3d.com
20
+ [web components]: https://developer.mozilla.org/en-US/docs/Web/Web_Components