Merge pull request InsightSoftwareConsortium#730 from thewtex/compres…

…s-stringify-pipeline-base

Compress stringify pipeline base

package.json

@@ -33,7 +33,8 @@
     "build:workerMinBundles": "rollup -c rollup.worker.min.config.js ./dist/web-workers/pipeline.worker.js && shx cp ./dist/web-workers/min-bundles/pipeline.worker.js ./dist/web-workers/bundles/pipeline.min.worker.js",
     "build:webpack": "webpack --mode production --progress --color && webpack --mode development --progress --color",
     "build:emscripten": "node ./src/build-emscripten.js",
-    "build:emscripten:compress-stringify": "node ./src/itk-wasm-cli.js -s packages/compress-stringify -b emscripten-build build",
+    "build:emscripten:compress-stringify": "node ./src/itk-wasm-cli.js -s packages/compress-stringify -b emscripten-build build ",
+    "build:bindgen:typescript:compress-stringify": "./src/itk-wasm-cli.js -s packages/compress-stringify -b emscripten-build bindgen --package-name itk-compress-stringify --package-description \"Zstandard compression and decompression and base64 encoding and decoding in WebAssembly.\" --repository 'https://github.com/InsightSoftwareConsortium/itk-wasm'",
     "build:wasi": "node ./src/build-wasi.js",
     "build:wasi:compress-stringify": "node ./src/itk-wasm-cli.js -i itkwasm/wasi:latest -s packages/compress-stringify -b wasi-build build",
     "cypress:open": "npx cypress open",
@@ -109,7 +110,7 @@
     "cypress": "^10.10.0",
     "cz-conventional-changelog": "2.1.0",
     "file-api": "^0.10.4",
-    "glob": "^7.1.6",
+    "glob": "^8.1.0",
     "karma": "^6.3.2",
     "karma-chrome-launcher": "^3.1.0",
     "karma-tap": "^4.2.0",

packages/compress-stringify/typescript/README.md

@@ -4,9 +4,9 @@
 
 Zstandard compression and decompression and base64 encoding and decoding in WebAssembly.
 
-[**<p align="center">Example</p>**](https://itk-compress-stringify-app.on.fleek.co/ ':include :type=iframe width=100% height=800px')
+[Example](https://itk-compress-stringify-app.on.fleek.co/ ':include :type=iframe width=100% height=800px')
 
-[**<p align="center">Documentation</p>**](https://itk-compress-stringify-docs.on.fleek.co/)
+[Documentation](https://itk-compress-stringify-docs.on.fleek.co/)
 
 ## Installation
 
@@ -26,6 +26,8 @@ import {
   parseStringDecompress,
   setPipelinesBaseUrl,
   getPipelinesBaseUrl,
+  setPipelineWorkerUrl,
+  getPipelineWorkerUrl,
 } from "itk-compress-stringify"
 ```
 
@@ -109,6 +111,24 @@ function setPipelinesBaseUrl(
 function getPipelinesBaseUrl() : string | URL
 ```
 
+#### setPipelineWorkerUrl
+
+*Set base URL for the itk-wasm pipeline worker script when vendored.*
+
+```ts
+function setPipelineWorkerUrl(
+  baseUrl: string | URL
+) : void
+```
+
+#### getPipelineWorkerUrl
+
+*Get base URL for the itk-wasm pipeline worker script when vendored.*
+
+```ts
+function getPipelineWorkerUrl() : string | URL
+```
+
 ### Node interface
 
 Import:

packages/compress-stringify/typescript/build/vite.config.js

@@ -13,6 +13,7 @@ export default defineConfig({
     viteStaticCopy({
       targets: [
         { src: '../../dist/pipelines/*', dest: 'pipelines' },
+        { src: '../../dist/web-workers/*', dest: 'web-workers' },
       ],
     })
   ],

packages/compress-stringify/typescript/package.json

@@ -1,6 +1,6 @@
 {
   "name": "itk-compress-stringify",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "Zstandard compression and decompression and base64 encoding and decoding in WebAssembly.",
   "type": "module",
   "module": "./dist/bundles/itk-compress-stringify.js",
@@ -38,7 +38,7 @@
   "author": "",
   "license": "Apache-2.0",
   "dependencies": {
-    "itk-wasm": "^1.0.0-b.57"
+    "itk-wasm": "^1.0.0-b.62"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^24.0.0",

packages/compress-stringify/typescript/src/compress-stringify.ts

@@ -11,6 +11,9 @@ import CompressStringifyResult from './compress-stringify-result.js'
 
 import { getPipelinesBaseUrl } from './pipelines-base-url.js'
 
+
+import { getPipelineWorkerUrl } from './pipeline-worker-url.js'
+
 /**
  * Given a binary, compress and optionally base64 encode.
  *
@@ -55,7 +58,7 @@ async function compressStringify(
     returnValue,
     stderr,
     outputs
-  } = await runPipeline(webWorker, pipelinePath, args, desiredOutputs, inputs, getPipelinesBaseUrl())
+  } = await runPipeline(webWorker, pipelinePath, args, desiredOutputs, inputs, getPipelinesBaseUrl(), getPipelineWorkerUrl())
   if (returnValue !== 0) {
     throw new Error(stderr)
   }

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'

packages/compress-stringify/typescript/src/parse-string-decompress.ts

@@ -11,6 +11,9 @@ import ParseStringDecompressResult from './parse-string-decompress-result.js'
 
 import { getPipelinesBaseUrl } from './pipelines-base-url.js'
 
+
+import { getPipelineWorkerUrl } from './pipeline-worker-url.js'
+
 /**
  * Given a binary or string produced with compress-stringify, decompress and optionally base64 decode.
  *
@@ -49,7 +52,7 @@ async function parseStringDecompress(
     returnValue,
     stderr,
     outputs
-  } = await runPipeline(webWorker, pipelinePath, args, desiredOutputs, inputs, getPipelinesBaseUrl())
+  } = await runPipeline(webWorker, pipelinePath, args, desiredOutputs, inputs, getPipelinesBaseUrl(), getPipelineWorkerUrl())
   if (returnValue !== 0) {
     throw new Error(stderr)
   }

packages/compress-stringify/typescript/src/pipeline-worker-url.ts

@@ -0,0 +1,10 @@
+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
+}
+
+export function getPipelineWorkerUrl (): string | URL | null {
+  return pipelineWorkerUrl
+}

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

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) {
@@ -107,7 +113,7 @@ function setupCompressStringify() {
   form.addEventListener('submit', async (event) => {
     event.preventDefault()
 
-    const { webWorker, output } = await itkCompressStringify.compressStringify(null, ...context.inputs, context.options)
+    const { webWorker, output } = await itkCompressStringify.compressStringify(null, context.inputs[0].slice(), context.options)
     webWorker.terminate()
 
     context.outputs.output = output
@@ -161,7 +167,7 @@ function setupParseStringDecompress() {
   form.addEventListener('submit', async (event) => {
     event.preventDefault()
 
-    const { webWorker, output } = await itkCompressStringify.parseStringDecompress(null, ...context.inputs, context.options)
+    const { webWorker, output } = await itkCompressStringify.parseStringDecompress(null, context.inputs[0].slice(), context.options)
     webWorker.terminate()
 
     context.outputs.output = output

src/bindgen/typescript-resources/pipeline-worker-url.ts

@@ -0,0 +1,11 @@
+// @ts-expect-error error TS2732: Cannot find module '../package.json'. Consider using '--resolveJsonModule' to import module with '.json' extension.
+import packageJson from '../package.json'
+let pipelineWorkerUrl: string | URL | null = `https://cdn.jsdelivr.net/npm/<bindgenPackageName>@${packageJson.version as string}/dist/web-workers/pipeline.worker.js`
+
+export function setPipelineWorkerUrl (workerUrl: string | URL | null): void {
+  pipelineWorkerUrl = workerUrl
+}
+
+export function getPipelineWorkerUrl (): string | URL | null {
+  return pipelineWorkerUrl
+}

src/bindgen/typescript-resources/pipelines-base-url.ts

@@ -1,4 +1,6 @@
-let pipelinesBaseUrl: string | URL = new URL('/pipelines', document.location.origin).href
+// @ts-expect-error error TS2732: Cannot find module '../package.json'. Consider using '--resolveJsonModule' to import module with '.json' extension.
+import packageJson from '../package.json'
+let pipelinesBaseUrl: string | URL = `https://cdn.jsdelivr.net/npm/<bindgenPackageName>@${packageJson.version as string}/dist/pipelines`
 
 export function setPipelinesBaseUrl (baseUrl: string | URL): void {
   pipelinesBaseUrl = baseUrl

src/bindgen/typescript-resources/template.package.json

@@ -30,7 +30,7 @@
   "author": "",
   "license": "Apache-2.0",
   "dependencies": {
-    "itk-wasm": "^1.0.0-b.57"
+    "itk-wasm": "^1.0.0-b.62"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^24.0.0",

src/bindgen/typescript-resources/vite.config.js

@@ -13,6 +13,7 @@ export default defineConfig({
     viteStaticCopy({
       targets: [
         { src: '../../dist/pipelines/*', dest: 'pipelines' },
+        { src: '../../dist/web-workers/*', dest: 'web-workers' },
       ],
     })
   ],

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) {
@@ -315,6 +316,7 @@ function typescriptBindings(outputDir, buildDir, wasmBinaries, options, forNode=
       functionContent += "\nimport path from 'path'\n\n"
     } else {
       functionContent += "\nimport { getPipelinesBaseUrl } from './pipelines-base-url.js'\n\n"
+      functionContent += "\nimport { getPipelineWorkerUrl } from './pipeline-worker-url.js'\n\n"
     }
 
     const readmeParametersTable = [['Parameter', 'Type', 'Description'],]
@@ -446,7 +448,7 @@ function typescriptBindings(outputDir, buildDir, wasmBinaries, options, forNode=
       functionContent += `  const {\n    returnValue,\n    stderr,\n    outputs\n  } = await runPipelineNode(pipelinePath, args, desiredOutputs, inputs)\n`
     } else {
       functionContent += `\n  const pipelinePath = '${moduleKebabCase}'\n\n`
-      functionContent += `  const {\n    webWorker: usedWebWorker,\n    returnValue,\n    stderr,\n    outputs\n  } = await runPipeline(webWorker, pipelinePath, args, desiredOutputs, inputs, getPipelinesBaseUrl())\n`
+      functionContent += `  const {\n    webWorker: usedWebWorker,\n    returnValue,\n    stderr,\n    outputs\n  } = await runPipeline(webWorker, pipelinePath, args, desiredOutputs, inputs, getPipelinesBaseUrl(), getPipelineWorkerUrl())\n`
     }
 
     functionContent += '  if (returnValue !== 0) {\n    throw new Error(stderr)\n  }\n\n'
@@ -483,6 +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)) {
+    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')

src/browser/index.ts

@@ -2,6 +2,9 @@
 
 export * from '../core/index.js'
 
+export * from '../core/pipeline-worker-url.js'
+export * from '../core/pipelines-base-url.js'
+
 export { default as ReadImageResult } from '../io/ReadImageResult.js'
 export { default as ReadMeshResult } from '../io/ReadMeshResult.js'
 

src/core/pipeline-worker-url.ts

@@ -0,0 +1,9 @@
+let pipelineWorkerUrl: string | URL | null | undefined
+
+export function setPipelineWorkerUrl (workerUrl: string | URL | null): void {
+  pipelineWorkerUrl = workerUrl
+}
+
+export function getPipelineWorkerUrl (): string | URL | null | undefined {
+  return pipelineWorkerUrl
+}

src/core/pipelines-base-url.ts

@@ -0,0 +1,9 @@
+let pipelinesBaseUrl: string | URL | undefined
+
+export function setPipelinesBaseUrl (baseUrl: string | URL): void {
+  pipelinesBaseUrl = baseUrl
+}
+
+export function getPipelinesBaseUrl (): string | URL | undefined {
+  return pipelinesBaseUrl
+}