vis-core 0.33.5 → 0.33.6

package/README.md

@@ -0,0 +1,58 @@
+# vis-core
+
+`vis-core` owns scene documents, project material catalogs, map/earth behavior
+and multi-scene navigation. `gl-draw` supplies rendering, native objects,
+resources and snapshot primitives.
+
+Use the root for SDK APIs, and `/io` for lightweight document transport:
+
+```ts
+import {
+  SceneManager,
+  splitSceneDocument,
+  materialDocumentOperations,
+  duplicateSceneDocument,
+  editorObjects,
+  findAdcodeInfo,
+  type VisSceneDocument,
+  type MaterialAsset,
+} from 'vis-core';
+import { jsonFetch } from 'vis-core/io';
+```
+
+| Entry | Responsibility |
+| --- | --- |
+| `vis-core` | Scene runtime, documents, material catalogs, editing operations, object registries, THREE/TWEEN and version |
+| `vis-core/io` | JSON/GZip transport and request-cache options without renderer dependencies |
+
+The former `/document`, `/materials`, `/operations` and `/editor` entries have
+been merged into `vis-core`. Update their import paths to the root, including
+type imports. Their named exports and behavior are retained; the old subpaths
+are no longer exported. Base, Map, Earth and PlaneMap remain public types.
+SceneManager continues to create and own scene instances.
+
+The release contains two JavaScript entries, one shared transport chunk and two
+bundled declaration files. The main entry retains bundled Three.js and gl-draw.
+Runtime and editor APIs share one declaration bundle, including classes with
+private members. Consumers can use strict NodeNext or Bundler resolution without
+source aliases or `skipLibCheck`.
+
+Only the two declared package entries are public. Source/build paths and aliases
+such as `@sdk` and `@vis` are internal. Local source integration only needs aliases
+for `vis-core` and `vis-core/io`.
+
+Implementation modules stay grouped under `src/sdk/document`, `materials`,
+`vis/sceneManager`, `vis/map`, `vis/base`, `vis/earth` and object directories.
+They import concrete lower-level modules instead of their package root. The
+internal `sceneDocument.ts` and `materials/projectMaterials.ts` facades remain
+for SDK code; they are not additional package entries.
+
+SceneManager owns navigation cancellation, transactions and disposal. Map owns
+region rebuilding and Base lifecycle. See `src/sdk/vis/LIFECYCLE.md` for resource
+ownership and commit/rollback rules.
+
+Run `pnpm --filter vis-core test` for unit regressions and
+`pnpm --filter vis-core test:dist` for release checks. Those tests install only
+`package.json` and `dist` into an isolated consumer, check the complete public
+API, shared types/runtime identities and private paths, and compile strict
+NodeNext/Bundler consumers. They also verify that `/io` stays renderer-free.