feat(compress-stringify): Use assets hosted on jsDelivr by default

Prevent the need to copy and host the Wasm modules, web worker, and configure a project's build to find these assets. The demo uses local assets for local testing and to demonstrate how to configure a build for vendored assets.
InsightSoftwareConsortium · Jan 24, 2023 · 3f86d7f · 3f86d7f
1 parent 52da854
commit 3f86d7f
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 7 deletions.
diff --git a/packages/compress-stringify/typescript/src/index.ts b/packages/compress-stringify/typescript/src/index.ts
@@ -1,5 +1,5 @@
 export * from './pipelines-base-url.js'
-
+export * from './pipeline-worker-url.js'
 
 
 import CompressStringifyResult from './compress-stringify-result.js'

diff --git a/packages/compress-stringify/typescript/src/pipeline-worker-url.ts b/packages/compress-stringify/typescript/src/pipeline-worker-url.ts
@@ -1,4 +1,5 @@
-let pipelineWorkerUrl: string | URL | null = new URL('/web-workers/pipeline.worker.js', document.location.origin).href
+import packageJson from '../package.json'
+let pipelineWorkerUrl: string | URL | null = `https://cdn.jsdelivr.net/npm/itk-compress-stringify@${packageJson.version}/dist/web-workers/pipeline.worker.js`
 
 export function setPipelineWorkerUrl (workerUrl: string | URL | null): void {
   pipelineWorkerUrl = workerUrl

diff --git a/packages/compress-stringify/typescript/src/pipelines-base-url.ts b/packages/compress-stringify/typescript/src/pipelines-base-url.ts
@@ -1,4 +1,5 @@
-let pipelinesBaseUrl: string | URL = new URL('/pipelines', document.location.origin).href
+import packageJson from '../package.json'
+let pipelinesBaseUrl: string | URL = `https://cdn.jsdelivr.net/npm/itk-compress-stringify@${packageJson.version}/dist/pipelines`
 
 export function setPipelinesBaseUrl (baseUrl: string | URL): void {
   pipelinesBaseUrl = baseUrl

diff --git a/packages/compress-stringify/typescript/test/browser/app.ts b/packages/compress-stringify/typescript/test/browser/app.ts
@@ -1,5 +1,11 @@
 import * as itkCompressStringify from '../../dist/bundles/itk-compress-stringify.js'
 
+// Use local, vendored WebAssembly module assets
+const pipelinesBaseUrl: string | URL = new URL('/pipelines', document.location.origin).href
+itkCompressStringify.setPipelinesBaseUrl(pipelinesBaseUrl)
+let pipelineWorkerUrl: string | URL | null = new URL('/web-workers/pipeline.worker.js', document.location.origin).href
+itkCompressStringify.setPipelineWorkerUrl(pipelineWorkerUrl)
+
 
 // promise-file-reader
 function readAsArrayBuffer (file) {

diff --git a/src/bindgen/typescript-resources/pipeline-worker-url.ts b/src/bindgen/typescript-resources/pipeline-worker-url.ts
@@ -1,4 +1,5 @@
-let pipelineWorkerUrl: string | URL | null = new URL('/web-workers/pipeline.worker.js', document.location.origin).href
+import packageJson from '../package.json'
+let pipelineWorkerUrl: string | URL | null = `https://cdn.jsdelivr.net/npm/<bindgenPackageName>@${packageJson.version}/dist/web-workers/pipeline.worker.js`
 
 export function setPipelineWorkerUrl (workerUrl: string | URL | null): void {
   pipelineWorkerUrl = workerUrl

diff --git a/src/bindgen/typescript-resources/pipelines-base-url.ts b/src/bindgen/typescript-resources/pipelines-base-url.ts
@@ -1,4 +1,5 @@
-let pipelinesBaseUrl: string | URL = new URL('/pipelines', document.location.origin).href
+import packageJson from '../package.json'
+let pipelinesBaseUrl: string | URL = `https://cdn.jsdelivr.net/npm/<bindgenPackageName>@${packageJson.version}/dist/pipelines`
 
 export function setPipelinesBaseUrl (baseUrl: string | URL): void {
   pipelinesBaseUrl = baseUrl

diff --git a/src/bindgen/typescript.js b/src/bindgen/typescript.js
@@ -99,7 +99,8 @@ function typescriptBindings(outputDir, buildDir, wasmBinaries, options, forNode=
   }
 
   if (!forNode) {
-    indexContent += "export * from './pipelines-base-url.js'\n\n"
+    indexContent += "export * from './pipelines-base-url.js'\n"
+    indexContent += "export * from './pipeline-worker-url.js'\n"
     try {
       fs.mkdirSync(path.join(outputDir, 'build'), { recursive: true })
     } catch (err) {
@@ -484,10 +485,15 @@ function typescriptBindings(outputDir, buildDir, wasmBinaries, options, forNode=
   const pipelinesBaseUrlPath = path.join(outputDir, 'src', 'pipelines-base-url.ts')
   if (!fs.existsSync(pipelinesBaseUrlPath)) {
     fs.copyFileSync(bindgenResource('pipelines-base-url.ts'), pipelinesBaseUrlPath)
+    let pipelinesBaseUrlPathContent = fs.readFileSync(bindgenResource('pipelines-base-url.ts'), { encoding: 'utf8', flag: 'r' })
+    pipelinesBaseUrlPathContent = pipelinesBaseUrlPathContent.replaceAll('<bindgenPackageName>', packageName)
+    fs.writeFileSync(pipelinesBaseUrlPath, pipelinesBaseUrlPathContent)
   }
   const pipelineWorkerUrlPath = path.join(outputDir, 'src', 'pipeline-worker-url.ts')
   if (!fs.existsSync(pipelineWorkerUrlPath)) {
-    fs.copyFileSync(bindgenResource('pipeline-worker-url.ts'), pipelineWorkerUrlPath)
+    let pipelineWorkerUrlPathContent = fs.readFileSync(bindgenResource('pipeline-worker-url.ts'), { encoding: 'utf8', flag: 'r' })
+    pipelineWorkerUrlPathContent = pipelineWorkerUrlPathContent.replaceAll('<bindgenPackageName>', packageName)
+    fs.writeFileSync(pipelineWorkerUrlPath, pipelineWorkerUrlPathContent)
   }
 
   const itkConfigPath = path.join(outputDir, 'src', 'itkConfig.js')