@juun-roh/cesium-utils 0.0.20 → 0.1.1

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.
package/README.md CHANGED
@@ -5,21 +5,23 @@
5
5
  [![Documentation](https://img.shields.io/badge/docs-typedoc-blue)](https://juunie-roh.github.io/cesium-utils/)
6
6
  [![Build Status](https://img.shields.io/github/actions/workflow/status/juunie-roh/cesium-utils/release-and-publish.yml)](https://github.com/juunie-roh/cesium-utils/actions)
7
7
 
8
- A utility library for Cesium.js that simplifies working with collections and terrain providers.
8
+ A utility library for Cesium.js that simplifies working with collections, terrain providers and highlights.
9
9
 
10
10
  [📚 API Documentation](https://juunie-roh.github.io/cesium-utils/) | [📦 NPM Package](https://www.npmjs.com/package/@juun-roh/cesium-utils) | [▶️ Demonstration](https://juun.vercel.app/cesium-utils)
11
11
 
12
12
  ## Installation
13
13
 
14
+ This library requires `cesium` to run.
15
+
14
16
  ```bash
15
17
  # npm
16
- npm install @juun-roh/cesium-utils
18
+ npm install @juun-roh/cesium-utils cesium
17
19
 
18
20
  # yarn
19
- yarn add @juun-roh/cesium-utils
21
+ yarn add @juun-roh/cesium-utils cesium
20
22
 
21
23
  # pnpm
22
- pnpm add @juun-roh/cesium-utils
24
+ pnpm add @juun-roh/cesium-utils cesium
23
25
  ```
24
26
 
25
27
  ## Browser Compatibility
@@ -31,14 +33,17 @@ This library works in both modern browsers and Node.js environments. It supports
31
33
 
32
34
  ## Modular Exports
33
35
 
34
- This library supports modular exports, which enables for you to import only needed modules.
35
- Though this library is about 140kB, you can minimize the size for importing this library.
36
+ This library supports modular exports, enabling you to import only the functionality you need rather than the entire package. This helps reduce bundle size and improves build performance by explicitly avoiding unused code.
36
37
 
37
38
  ```typescript
38
- // This imports all modules of the package
39
- import { Collection } from "@juun-roh/cesium-utils";
40
- // To minimize the imported modules size, try this:
39
+ // Import everything from the main package
40
+ import { Collection, Highlight, TerrainVisualizer } from "@juun-roh/cesium-utils";
41
+
42
+ // Or import specific modules to minimize bundle size
43
+ import { Collection } from "@juun-roh/cesium-utils/collection";
41
44
  import { Highlight } from "@juun-roh/cesium-utils/highlight";
45
+ import { TerrainVisualizer } from "@juun-roh/cesium-utils/utils";
46
+ import { cloneViewer, syncCamera } from "@juun-roh/cesium-utils/viewer";
42
47
  ```
43
48
 
44
49
  ## Development
@@ -10,7 +10,7 @@ interface WithTag {
10
10
  /**
11
11
  * Collection event types
12
12
  */
13
- type CollectionEventType = 'add' | 'remove' | 'update' | 'clear';
13
+ type CollectionEventType = "add" | "remove" | "update" | "clear";
14
14
  /**
15
15
  * Event handler function type
16
16
  */
@@ -10,7 +10,7 @@ interface WithTag {
10
10
  /**
11
11
  * Collection event types
12
12
  */
13
- type CollectionEventType = 'add' | 'remove' | 'update' | 'clear';
13
+ type CollectionEventType = "add" | "remove" | "update" | "clear";
14
14
  /**
15
15
  * Event handler function type
16
16
  */
package/package.json CHANGED
@@ -1,21 +1,21 @@
1
1
  {
2
2
  "name": "@juun-roh/cesium-utils",
3
- "version": "0.0.20",
3
+ "version": "0.1.1",
4
4
  "description": "Utilities to handle Cesium classes easier.",
5
5
  "keywords": [
6
+ "3d",
7
+ "3d-gis",
6
8
  "cesium",
7
9
  "cesiumjs",
8
- "utility",
9
10
  "collection",
10
- "terrain",
11
- "tagged",
12
- "3d",
13
- "3d-gis",
11
+ "geospatial",
14
12
  "gis",
13
+ "highlight",
15
14
  "mapping",
15
+ "tagged",
16
+ "terrain",
16
17
  "terrain-provider",
17
- "entity-collection",
18
- "geospatial",
18
+ "utility",
19
19
  "webgl"
20
20
  ],
21
21
  "repository": {
@@ -88,12 +88,12 @@
88
88
  "@commitlint/cz-commitlint": "^19.8.1",
89
89
  "@commitlint/format": "^19.8.1",
90
90
  "@commitlint/types": "^19.8.1",
91
- "@eslint/js": "^9.29.0",
91
+ "@eslint/js": "^9.30.0",
92
92
  "@typescript-eslint/eslint-plugin": "^8.35.0",
93
93
  "@typescript-eslint/parser": "^8.35.0",
94
94
  "@vitest/coverage-v8": "^3.2.4",
95
95
  "cesium": "^1.130.1",
96
- "eslint": "^9.29.0",
96
+ "eslint": "^9.30.0",
97
97
  "eslint-plugin-jsdoc": "^51.2.3",
98
98
  "eslint-plugin-prettier": "^5.5.1",
99
99
  "eslint-plugin-simple-import-sort": "^12.1.1",
@@ -102,7 +102,7 @@
102
102
  "jsdom": "^26.1.0",
103
103
  "rimraf": "^6.0.1",
104
104
  "tsup": "^8.5.0",
105
- "typedoc": "^0.28.5",
105
+ "typedoc": "^0.28.6",
106
106
  "typescript": "^5.8.3",
107
107
  "vite": "^7.0.0",
108
108
  "vitest": "^3.2.4"