Upgrade docusaurus and novorender-api to v2 (#39)

* Upgrade docusaurus and novorender-api to v2
- Update typescript (doesn't work with new novorender-api anymore), typedoc, docusaurus
- Update git path to novorender-api
- Update paths to novorender-api v2 files
- Remove View.downloadImports and associated code
- Rename merge-decl-files to extract-web-api and simplify it since we have just one .d.ts now. Also remove dts-bundle - not needed anymore
- Do a hack to preserve links for data-js-api

* Fix body data-theme

* Prevent creating 2 views in playground (which causes blinking)

* Fix opaque clipping planes

* Update some previews and minor playground fix

* - Change /ts to /novorender-api
- Remove some "open source" mentions
- Fix some links and casing

* Fix some broken links

* Fix (or a workaround) for broken links

* Run theme workaround only in browser

* Improve theme workaround

* Minor comment fix

* Update type-definitions/typedoc-custom-root.mjs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Use capital case Namespaces

* Back to lowercase namespaces to not cause broken links

* Update actions/checkout and use SSH path in git submodule

* Use github_token for submodules

* Try to fetch novorender-api separately

* Remove token

* Set ref

* Add token back

* - Set token to secrets.cicd
- Update @novorender

* Simplify repo pull

* Add npm configuration

* Move build outside oryx

* run ci verbose for debugging

* Remove procore artifactory from package-lock

* Rollback

* Configure npm

* Try oryx build again

* Clean up

* Remove irrelevant comment

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: nd-novorender

.github/workflows/azure-static-web-apps-happy-pebble-0a13f1503.yml

@@ -8,17 +8,21 @@ on:
     types: [opened, synchronize, reopened, closed]
     branches:
       - main
-
 jobs:
   build_and_deploy_job:
     if: github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.action != 'closed')
     runs-on: ubuntu-22.04
     name: Build and Deploy Job
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           submodules: true
-      - name: Build And Deploy
+          token: ${{ secrets.cicd }}
+      - name: Configure npm
+        run: |
+          echo "@novorender:registry=https://npm.pkg.github.com" >> .npmrc
+          echo "//npm.pkg.github.com/:_authToken=${{ secrets.GITHUB_TOKEN }}" >> .npmrc
+      - name: Deploy
         id: builddeploy
         uses: Azure/static-web-apps-deploy@v1
         with:

.gitmodules

@@ -1,3 +1,3 @@
 [submodule "@novorender"]
 	path = @novorender
-	url = https://github.com/novorender/ts
+	url = git@github.com:novorender/novorender-api.git

@novorender

@@ -1,4 +1,4 @@
-import { type DeviceProfile, type ViewImports, type ViewImportmap } from "@novorender/api";
+import { type DeviceProfile } from "@novorender/api";
 import type { IPosition } from "monaco-editor";
 
 export interface IModule<R = void, P extends any[] = []> {
@@ -23,31 +23,19 @@ export interface ICanvas {
 export interface IDemoContext<T = any> {
     readonly canvasElements: ICanvas;
     readonly deviceProfile: DeviceProfile;
-    readonly imports: ViewImports;
     reportErrors(...errors: any[]): void;
 }
 
-/** Core imports, you can provide your own to `createDemoContext` if want */
-export let coreImportsPromise: Promise<ViewImports>;
-// for fixing docusaurus build
-if (typeof window !== "undefined" && typeof navigator !== 'undefined') {
+export async function createDemoContext(
+    canvasElements: ICanvas,
+    reportErrors: (...errors: any[]) => void
+): Promise<IDemoContext> {
     // must be imported dynamically to fix SSG build
-    import("@novorender/api").then(({ View }) => {
-        const baseUrl = new URL(".", location.origin);
-        const coreImportsMap: ViewImportmap = { baseUrl };
-        coreImportsPromise = View.downloadImports(coreImportsMap);
-    });
-}
-
-export async function createDemoContext(canvasElements: ICanvas, reportErrors: (...errors: any[]) => void, importsPromise: Promise<ViewImports> = coreImportsPromise): Promise<IDemoContext> {
-
-    // must be imported dynamically to fix SSG build
-    const { getDeviceProfile } = await import("@novorender/api")
+    const { getDeviceProfile } = await import("@novorender/api");
 
     const gpuTier = 2; // laptop with reasonably new/powerful GPU.
     const deviceProfile = getDeviceProfile(gpuTier);
-    const imports = await importsPromise;
-    return { canvasElements, deviceProfile, imports, reportErrors };
+    return { canvasElements, deviceProfile, reportErrors };
 }
 
 export interface IDempProps {

demo-snippets/demo/types.ts

@@ -1,6 +1,9 @@
 import { type RecursivePartial, type RenderStateClipping, ClippingMode } from "@novorender/api";
 
 export function main(centerX: number, centerY: number, centerZ: number): RecursivePartial<RenderStateClipping> {
+    // Set samplesMSAA larger than 1 for the planes to have transparency
+    // view.modifyRenderState({ output: { samplesMSAA: 2 } });
+
     return {
         enabled: true,
         draw: true,

demo-snippets/guides/clipping/visualize.ts

@@ -1,7 +1,11 @@
-import { View, type DeviceProfile, type ViewImports } from "@novorender/api";
+import { View, type DeviceProfile } from "@novorender/api";
 
-export async function main(canvas: HTMLCanvasElement, deviceProfile: DeviceProfile, imports: ViewImports, signal: AbortSignal) {
-    const view = new View(canvas, deviceProfile, imports);
+export async function main(
+    canvas: HTMLCanvasElement,
+    deviceProfile: DeviceProfile,
+    signal: AbortSignal
+) {
+    const view = new View(canvas, deviceProfile);
     view.modifyRenderState({ grid: { enabled: true } });
     await view.run(signal);
     view.dispose();

demo-snippets/guides/interactive_examples/basic.ts

@@ -18,16 +18,17 @@ export async function main(view: View, sceneData: SceneData) {
 
         const searchResult: ObjectData[] = [];
 
-        // Use the first 5 results to keep the properties in the property box relatively short
-        for (let i = 0; i < 5; i++) {
+        // Use the first 10 results to keep the properties in the property box relatively short
+        for (let i = 0; i < 10; i++) {
             const iteratorResult = await iterator.next();
             if (iteratorResult.done) {
                 break;
             }
             // Because we have set the search option "full: true"
             // .loadMetadata() will not result in any more requests being made
             // Try flipping it to false and see the difference in the network request log
-            const objectWithMetadata = await iteratorResult.value.loadMetaData();
+            const objectWithMetadata =
+                await iteratorResult.value.loadMetaData();
             searchResult.push(objectWithMetadata);
         }
 

demo-snippets/guides/object_metadata/metadata_from_search.ts

@@ -1,12 +1,14 @@
-import { getDeviceProfile, View, type GPUTier, type ViewImports } from "@novorender/api";
+import { getDeviceProfile, View, type GPUTier } from "@novorender/api";
 
-export async function main(canvas: HTMLCanvasElement, _: unknown, imports: ViewImports) {
+export async function main(canvas: HTMLCanvasElement, _: unknown) {
     const gpuTier: GPUTier = 2;
     const deviceProfile = getDeviceProfile(gpuTier);
-    const view = new View(canvas, deviceProfile, imports);
+    const view = new View(canvas, deviceProfile);
     view.modifyRenderState({ grid: { enabled: true } });
     const abortController = new AbortController();
-    setTimeout(() => { abortController.abort(); }, 5_000); // exit after 5 seconds.
+    setTimeout(() => {
+        abortController.abort();
+    }, 5_000); // exit after 5 seconds.
     await view.run(abortController.signal);
     view.dispose();
     alert("View disposed!");

demo-snippets/guides/views/creation.ts

@@ -1,7 +1,11 @@
 import { IDemoContext, IDemoHost, IModule } from "../demo";
-import { DeviceProfile, Core3DImports } from "@novorender/api";
+import { DeviceProfile } from "@novorender/api";
 
-type Args = [canvas: HTMLCanvasElement, deviceProfile: DeviceProfile, imports: Core3DImports, signal: AbortSignal];
+type Args = [
+    canvas: HTMLCanvasElement,
+    deviceProfile: DeviceProfile,
+    signal: AbortSignal,
+];
 type Ret = Promise<void>;
 type Module = IModule<Ret, Args>;
 
@@ -24,15 +28,14 @@ export class BareboneDemoHost implements IDemoHost<Module> {
         const {
             canvasElements: { primaryCanvas: canvas },
             deviceProfile,
-            imports,
         } = this.context;
         this.abortController?.abort();
         this.abortController = new AbortController();
         const { signal } = this.abortController;
         let moduleError;
         try {
             await this.mainPromise;
-            this.mainPromise = module.main(canvas, deviceProfile, imports, signal);
+            this.mainPromise = module.main(canvas, deviceProfile, signal);
         } catch (error) {
             moduleError = error;
         } finally {

demo-snippets/hosts/barebone.ts

@@ -11,9 +11,8 @@ export abstract class BaseDemoHost {
         const {
             canvasElements: { primaryCanvas: canvas },
             deviceProfile,
-            imports,
         } = this.context;
-        this.view = new View(canvas, deviceProfile, imports);
+        this.view = new View(canvas, deviceProfile);
     }
 
     async run(cb: (isReady: boolean) => void) {
@@ -37,12 +36,13 @@ export abstract class BaseDemoHost {
     init?(): Promise<void>;
     animate?(time: number): Promise<void>;
 
-    async loadScene(baseUrl: URL, sceneId: string, version: string = "index.json") {
+    async loadScene(
+        baseUrl: URL,
+        sceneId: string,
+        version: string = "index.json"
+    ) {
         const { view } = this;
-        const config = await view.loadScene(
-            baseUrl,
-            sceneId,
-            version);
+        const config = await view.loadScene(baseUrl, sceneId, version);
         const { center, radius } = config.boundingSphere;
         view.activeController.autoFit(center, radius);
         const [cx, cy, cz] = config.center;