Undo monorepo conversion

.c8rc.json

@@ -1,9 +1,9 @@
 {
     "exclude": [
-        "**specs/**/*Spec.ts"
+        "specs/**/*Spec.ts"
     ],
     "include": [
-        "packages/**/src/**/*.ts"
+        "src/**/*.ts"
     ],
     "reporter": [
         "html",

.eslintignore

@@ -4,5 +4,4 @@ node_modules
 dist
 etc
 generateThirdParty.js
-packages/ktx/src/ktx/external/basis_encoder.cjs
-packages/cli/bin/cli.mjs
+src/ktx/ktx/external/basis_encoder.cjs

.gitignore

@@ -9,6 +9,7 @@ package-lock.json
 /build
 /dist
 /data
+/temp
 /output
 /specs/data/output
 /specs/data/migration/output_gltf

.npmignore

@@ -1,5 +1,4 @@
 /.github
-/.nyc_output
 /bin
 /coverage
 /demos
@@ -14,11 +13,12 @@
 .eslintrc.json
 .gitignore
 .npmignore
-.nycrc
+.c8rc.json
 .prettierignore
 .prettierrc.json
 api-extractor.jsonc
 generateThirdParty.js
 ThirdParty.json
+ThirdParty.extra.json
 tsconfig.json
 *.tgz

.prettierignore

@@ -2,10 +2,8 @@
 !src/**/
 !demos/**/
 !specs/**/
-!packages/**/
 !**/*.js
 !**/*.ts
-src/**/*.ts
 specs/data/
-packages/**/build/
-packages/ktx/src/ktx/external/basis_encoder.js
+build/
+src/ktx/ktx/external/basis_encoder.js

CHANGES.md

@@ -1,7 +1,13 @@
 Change Log
 ==========
 
-### 0.4.0 - 2024-02-06
+### 0.4.1 - 2024-02-20
+
+- The packages that have been introduced in version `0.4.0` have been merged back into a single package.
+  Details about the structure can be found in the [implementation notes](./IMPLEMENTATION.md).
+
+
+### 0.4.0 - 2024-02-06 (not released)
 
 - The 3D Tiles Tools have been split into multiple packages.
   For users of the command-line interface, this should not make a noticable difference: The installed package declares all other packages as its dependencies, and installs them transparently. 

IMPLEMENTATION.md

@@ -4,119 +4,33 @@ Parts of the current implementation may still change. This page is only a short
 
 ## Internal notes
 
-The original 3D Tiles Tools have been converted into a monorepo with different packages.
-
-The packages are 
-
-- [`base`](./packages/base/) - Basic utility classes shared by nearly all other packages
-- [`structure`](./packages/structure/) - Typescript types for the elements of a 3D Tiles tileset JSON
-- [`ktx`](./packages/structure/) - A convenience wrapper around the BinomialLLC basis (KTX) encoder WASM module
-- [`gltf-extensions`](./packages/gltf-extensions/) - Implementations of the Cesium glTF extensions based on glTF-Transform
-- [`metadata`](./packages/metadata/) - Basic classes for the implementation of the 3D Metadata Specification
-- [`tilesets`](./packages/tilesets/) - Classes for handling 3D Tiles tileset data (including tile content and tileset packages)
-- [`tools`](./packages/tools/) - The main classes implementing the 3D Tiles Tools functionalities
-- [`cli`](./packages/cli/) - The main command line application for the 3D Tiles tools
-- [`spec-helpers`](./packages/spec-helpers/) - Internal utility classes for running the specs (unit tests)
-
-### Structure of `package.json`
-
-From the perspective of the top-level `package.json`, each package is a _workspace_. This means that each package has its own `package.json` that declares its dependencies and basic build- and test commands. The top-level `package.json` only declares
-```
-  "workspaces": [
-    "packages/*"
-  ],
-```
-which allows certain operations (like packaging) to be run in a "bulk" fashion on all the packages at once.
-
-It is important to run `npm install` at the root directory after cloning the repo (preferably even before opening VSCode). When workspaces are present, then this will establish one symbolic link for each package in the `node_modules` repository, making sure that "the packages know each other". 
-
-### Structure of `tsconfig.json`
-
-The goal of splitting the 3D Tiles Tools into modules originally was to create ESM modules. However, due to limited interoperability of ESM modules and CommonJS projects, it was decided to offer the tools as CommonJS modules instead. 
-
-- The `package.json` of each package declares `"type": "commonjs"`
-- The `compilerOptions` of the `tsconfig.json` declares `"module": "CommonJS"`
-
-The root-level `tsconfig.json` defines the common settings. Each package contains further `tsconfig.json` files that _inherit_ from the root-level one (See [TSConfig `extends`](https://www.typescriptlang.org/tsconfig#extends)).
-
-The structure of the project and its packages is reflected in the `tsconfig.json` files via _Project References_ (See [TypeScript: 'Project References](https://www.typescriptlang.org/docs/handbook/project-references.html)). Each `tsconfig.json` in the packages has to declare
-```
-  "compilerOptions": {
-    "declaration": true,
-    "composite": true,
-  },
-```
-so that the respective `tsconfig.json` may be used via a Project Reference.
-
-Each package contains three `tsconfig.json` files: 
-- `<package>/tsconfig.json`: The main config file for the package
-  - This may add package-specific settings in the `compilerOptions`
-  - Beyond that, it only refers to the other ones:
-- `<package>/src/tsconfig.json`: The configuration for the actual source code of the package
-- `<package>/specs/tsconfig.json`: The configuration for the specs (unit tests) of the package
-  - This refers to the `src` configuration file as a "dependency"
-
-The reason for separating the `tsconfig.json` file for the `src` and the `specs` is to have different build output directories for them, to make sure that `src` cannot not import anything from `specs`, and the final, distributed package can contain only the build output of `src`. (NOTE: Right now, it contains both. This is not critical, but the `specs` build output might be omitted from the packages in the future).
-
-The root-level `tsconfig` file refers to the `tsconfig.json` file of the `src`- and `specs` folders:
-```
-  "references": [
-    { "path": "./packages/base/src/tsconfig.json" },
-    { "path": "./packages/base/specs/tsconfig.json" },
-    ...
-  ]
-```
-
-They are listed there in the order in which they are built:
-
-- Build all `src` part for each package
-- Build the `spec-helpers` (which depends on some of the `src` outputs)
-- Build the `specs` part for each package (which often depends on the `spec-helpers`)
+The source code folder contains the sources in a form that is organized so that each subdirectory can easily become a "workspace"/"package" in a monorepo. This is the result of https://github.com/CesiumGS/3d-tiles-tools/pull/64 , even though the current state does not use workspaces yet.
+
+The subdirectories are 
+
+- `base` - Basic utility classes shared by nearly all other packages
+- `structure` - Typescript types for the elements of a 3D Tiles tileset JSON
+- `ktx` - A convenience wrapper around the BinomialLLC basis (KTX) encoder WASM module
+- `gltf-extensions` - Implementations of the Cesium glTF extensions based on glTF-Transform
+- `metadata` - Basic classes for the implementation of the 3D Metadata Specification
+- `tilesets` - Classes for handling 3D Tiles tileset data (including tile content and tileset packages)
+- `tools` - The main classes implementing the 3D Tiles Tools functionalities
+- `cli` - The main command line application for the 3D Tiles tools
+- `spec-helpers` - Internal utility classes for running the specs (unit tests)
+
 
 ### Tests
 
 Running the tests with Jasmine eventually looks simple: Jasmine has to be started with
 
 `npx ts-node node_modules/jasmine/bin/jasmine.js ...`
 
-> Anecdotal note: With the initial ESM approach, the call would have been
->
-> `ts-node --esm node_modules/jasmine/bin/jasmine.js ...`
->
-> but this breaks with certain Node.js versions - see https://github.com/TypeStrong/ts-node/issues/2094 .
->
-> To work around this, the call had to be 
-> 
-> `node --loader ts-node/esm node_modules/jasmine/bin/jasmine.js ...`
->
-> This emitted `ExperimentalWarning` messages, but worked.
->
-> With CommonJS, all this does not matter.
-
-One caveat is:
-
-- The test data is stored in `./specs/data` (because parts of it is shared by multiple packages)
-- It should be possible to run _all_ tests from the _root_ directory
-- It should be possible to run the tests of a _single_ package from the directory of that package
-
-So in order to resolve the test data in both cases:
-- The `jasmine.json` config files in the packages refer to a `helper` that sets `process.env.SPECS_DATA_BASE_DIRECTORY = "../../specs/data";` (whereas the default in the top-level case is just `"./specs/data"`)
-- This environment variable is picked up by the `/spec-helpers/SpecHelpers` class and returned as the "base" directory for resolving data
+The test data is stored in `./specs/data`.
 
 ### Coverage
 
 The coverage is now computed with `c8` from https://github.com/bcoe/c8 
 
-> Anecdotal note: 
-> 
-> The coverage originally had been checked with `nyc`, but apparently, ESM modules are not supported by `nyc` (see https://github.com/istanbuljs/nyc/issues/1287 ). 
-> So `c8` was chosen as a solution that also worked with ESM. It is a "drop-in-replacement" of `nyc`, so there is no reason to go back to `nyc` for now (even though the tools are now packaged as CommonJS modules).
-
-### Even More Internal Notes:
-
-- There are places where the `/// <reference path=" ... " />` syntax is used, in order to point TypeScript to the right type information (see [TypeScript: Triple-Slash Directives](https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html)). This appears to be necessary for `gltf-pipeline` and `gltfpack` dependencies, which do not have associated type information. This is strongly discouraged, and should instead be solved by specifying proper `typeRoots` in the `compilerOptions` of the respective `tsconfig.json`. Maybe there is a way to tweak this so that it actually _works_ ...
-- There seem to be a few differences btween _compiling_ code (with `tsc`) and _executing_ code (with `npx ts-node`) when it comes to ~"module and type resolution". Sometimes types are not found here and there. There are rumours in hundreds of issues related to that. Sometimes the [`ts-node` `--files` argument](https://typestrong.org/ts-node/docs/options/#files) (which is completely unrelated to the `files` in `tsconfig.json`, although it also refers to this property) seemed to help. Sometimes the `tsconfig-paths` package from https://www.npmjs.com/package/tsconfig-paths seemed to help. Maybe some of these approaches will have to be investigated when a specific problem comes up.
-
 
 ## API Definition
 
@@ -128,7 +42,7 @@ Generating the documentation consists of two steps (which are subcommands of the
 - extracting the API definitions from the build output
 - generating the markdown from the API definitions.
 
-The first step is performed by running `api-extractor` for each package individually. This happens from the top-level package JSON file, using the `--workspaces` parameter. The surface API information will be written into `./etc/<package>.md`. These files capture the public API, and changes in the public API will cause a warning to be printed
+The first step is performed by running `api-extractor`. The surface API information will be written into `./etc/3d-tiles-tools.md`. This file captures the public API, and changes in the public API will cause a warning to be printed
 
 > Warning: You have changed the public API signature for this project.
 

README.md

@@ -359,7 +359,7 @@ When the tools are not installed as a package from NPM, but supposed to be used
 
 After this, the tools can be executed using the same command line options as described above - for example:
 ```
-npx ts-node .\packages\cli\src\main.ts gzip -i ./specs/data/TilesetOfTilesets/ -o ./output/TilesetOfTilesets-gzipped/
+npx ts-node .\src\cli\main.ts gzip -i ./specs/data/TilesetOfTilesets/ -o ./output/TilesetOfTilesets-gzipped/
 ```
 
 See the [implementation notes](IMPLEMENTATION.md) for details about the project structure.

ThirdParty.json

@@ -4,23 +4,23 @@
     "license": [
       "MIT"
     ],
-    "version": "3.9.0",
+    "version": "3.10.0",
     "url": "https://www.npmjs.com/package/@gltf-transform/core"
   },
   {
     "name": "@gltf-transform/extensions",
     "license": [
       "MIT"
     ],
-    "version": "3.9.0",
+    "version": "3.10.0",
     "url": "https://www.npmjs.com/package/@gltf-transform/extensions"
   },
   {
     "name": "@gltf-transform/functions",
     "license": [
       "MIT"
     ],
-    "version": "3.9.0",
+    "version": "3.10.0",
     "url": "https://www.npmjs.com/package/@gltf-transform/functions"
   },
   {
@@ -55,6 +55,14 @@
     "version": "1.5.7",
     "url": "https://www.npmjs.com/package/draco3d"
   },
+  {
+    "name": "draco3dgltf",
+    "license": [
+      "Apache-2.0"
+    ],
+    "version": "1.5.7",
+    "url": "https://www.npmjs.com/package/draco3dgltf"
+  },
   {
     "name": "gltf-pipeline",
     "license": [
@@ -71,6 +79,22 @@
     "version": "0.19.1",
     "url": "https://www.npmjs.com/package/gltfpack"
   },
+  {
+    "name": "meshoptimizer",
+    "license": [
+      "MIT"
+    ],
+    "version": "0.19.0",
+    "url": "https://www.npmjs.com/package/meshoptimizer"
+  },
+  {
+    "name": "minimist",
+    "license": [
+      "MIT"
+    ],
+    "version": "1.2.8",
+    "url": "https://www.npmjs.com/package/minimist"
+  },
   {
     "name": "node-stream-zip",
     "license": [
@@ -84,7 +108,7 @@
     "license": [
       "MIT"
     ],
-    "version": "8.18.0",
+    "version": "8.19.0",
     "url": "https://www.npmjs.com/package/pino"
   },
   {
@@ -95,6 +119,14 @@
     "version": "10.3.1",
     "url": "https://www.npmjs.com/package/pino-pretty"
   },
+  {
+    "name": "seedrandom",
+    "license": [
+      "MIT"
+    ],
+    "version": "3.0.5",
+    "url": "https://www.npmjs.com/package/seedrandom"
+  },
   {
     "name": "sharp",
     "license": [

api-extractor.jsonc

@@ -15,7 +15,7 @@
    *
    * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
    */
-  "mainEntryPointFilePath": "packages/<unscopedPackageName>/build/src/index.d.ts",
+  "mainEntryPointFilePath": "build/src/index.d.ts",
 
   /**
    * Configures how the API report file (*.api.md) will be generated.
@@ -39,7 +39,7 @@
      * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
      * DEFAULT VALUE: "<projectFolder>/temp/"
      */
-    "reportTempFolder": "<projectFolder>/../../build/api-extractor",
+    "reportTempFolder": "<projectFolder>/temp/api-extractor",
 
     /**
      * Specifies the folder where the API report file is written.  The file name portion is determined by
@@ -54,7 +54,7 @@
      * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
      * DEFAULT VALUE: "<projectFolder>/etc/"
      */
-     "reportFolder": "<projectFolder>/../../etc/"
+     "reportFolder": "<projectFolder>/etc/"
   },
 
   /**
@@ -75,7 +75,7 @@
      * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
      * DEFAULT VALUE: "<projectFolder>/temp/<unscopedPackageName>.api.json"
      */
-     "apiJsonFilePath": "<projectFolder>/../../build/api-extractor/<unscopedPackageName>.api.json"
+     "apiJsonFilePath": "<projectFolder>/build/api-extractor/<unscopedPackageName>.api.json"
   },
 
   /**
@@ -113,7 +113,7 @@
      * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
      * DEFAULT VALUE: ""
      */
-     "publicTrimmedFilePath": "<projectFolder>/../../dist/<unscopedPackageName>.d.ts"    
+     "publicTrimmedFilePath": ""
   },
 
   "messages": {

bin/cli.mjs

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import * as cli from "./cli/main.js";

demos/README.md

@@ -1,10 +1,20 @@
 ## 3D Tiles Tools Demos
 
-This project declares all 3D Tiles tools packages as (local) dependencies. The demos show how to use various parts of the API. This is intended as an internal preview for developers. The functionality is not yet exposed as a public API.
+This project declares the 3D Tiles tools build output as (local) dependency. The demos show how to use various parts of the API. This is intended as an internal preview for developers. The functionality is not yet exposed as a public API.
 
-After installing the dependencies by running
-`npm install`
-in the `./demos` subdirectory, each of these demos can be started (from the root directory of the 3D Tiles Tools!) with
+In the root directory of the 3D Tiles tools:
+
+- Install the 3D Tiles Tools dependencies:
+  `npm install`
+- Create the build output of the 3D Tiles tools:
+  `npm run build`
+
+In the `/demos/` subdirectory:
+
+- Install the 3D Tiles Tools build output as a dependency:
+  `npm install`
+
+Then, each of these demos can be started (from the root directory of the 3D Tiles Tools!) with
 
 `npx ts-node ./demos/`_`<PackageName>`_`/`_`<DemoName>`_`.ts`