Merge pull request #1198 from joshunrau/interactive-features

updates to handle tmb tasks without touching their code

Author: joshunrau

.husky/commit-msg

@@ -0,0 +1,5 @@
+<div style="display: flex; justify-content: center; align-items: center; flex-direction: column">
+  <h1>Instrument</h1>
+  <img src="/smiley.png" />
+  <button type="button" id="submit-btn">Submit</button>
+</div>

apps/playground/src/instruments/examples/interactive/Interactive-With-Static-Assets/fragment.html

@@ -0,0 +1,42 @@
+/* eslint-disable perfectionist/sort-objects */
+
+import { defineInstrument } from '/runtime/v1/@opendatacapture/runtime-core';
+import { z } from '/runtime/v1/[email protected]';
+
+import html from './fragment.html';
+import smiley from './smiley.png';
+
+export default defineInstrument({
+  kind: 'INTERACTIVE',
+  language: 'en',
+  internal: {
+    edition: 1,
+    name: 'INTERACTIVE_WITH_STATIC_ASSETS'
+  },
+  tags: [],
+  content: {
+    render(done) {
+      const button = document.getElementById('submit-btn')!;
+      button.addEventListener('click', () => {
+        done({ message });
+      });
+    },
+    html,
+    staticAssets: {
+      '/smiley.png': smiley
+    }
+  },
+  clientDetails: {
+    estimatedDuration: 1,
+    instructions: ['Please complete the task.']
+  },
+  details: {
+    description: 'This is an example of an instrument with static assets intercepted using a service worker.',
+    license: 'Apache-2.0',
+    title: 'Interactive Instrument with Static Assets'
+  },
+  measures: {},
+  validationSchema: z.object({
+    message: z.string()
+  })
+});

apps/playground/src/instruments/examples/interactive/Interactive-With-Static-Assets/index.ts

@@ -34,9 +34,6 @@
     "ws": "./scripts/workspace.sh $@"
   },
   "devDependencies": {
-    "@commitlint/cli": "^19.6.1",
-    "@commitlint/config-conventional": "^19.6.0",
-    "@commitlint/types": "^19.5.0",
     "@douglasneuroinformatics/eslint-config": "^5.3.1",
     "@douglasneuroinformatics/prettier-config": "^0.0.2",
     "@douglasneuroinformatics/tsconfig": "^1.0.3",
@@ -75,11 +72,6 @@
     "x64",
     "arm64"
   ],
-  "commitlint": {
-    "extends": [
-      "@commitlint/config-conventional"
-    ]
-  },
   "pnpm": {
     "overrides": {
       "@types/react": "-",

apps/playground/src/instruments/examples/interactive/Interactive-With-Static-Assets/smiley.png

@@ -1,7 +1,7 @@
 {
   "name": "@opendatacapture/instrument-bundler",
   "type": "module",
-  "version": "0.0.1",
+  "version": "0.0.0",
   "license": "Apache-2.0",
   "exports": {
     ".": "./src/index.ts"

package.json

@@ -3,4 +3,4 @@ export { InstrumentBundlerError } from './error.js';
 export { resolveIndexInput, resolveInput } from './resolve.js';
 export type { BundleOptions, BundlerInput } from './schemas.js';
 export type * from './types.js';
-export { extractInputFileExtension } from './utils.js';
+export { BUNDLER_FILE_EXT_REGEX, extractInputFileExtension, inferLoader } from './utils.js';

packages/instrument-bundler/package.json

@@ -9,7 +9,7 @@ export const plugin = (options: { inputs: BundlerInput[] }): Plugin => {
     name: 'instrument-bundler-plugin',
     setup(build) {
       const namespaces = { bundle: 'bundle' };
-      const legacyScripts: string[] = [];
+      const legacyScripts = new Map<string, string>();
       build.onResolve({ filter: /.*/ }, (args) => {
         // css @import statement
         if (args.kind === 'import-rule') {
@@ -56,7 +56,7 @@ export const plugin = (options: { inputs: BundlerInput[] }): Plugin => {
             ]
           };
         }
-        legacyScripts.push(input.content as string);
+        legacyScripts.set(args.path, input.content as string);
         return { contents: input.content, loader: 'empty' };
       });
       build.onLoad({ filter: /^\/runtime\/v1\/.*.css$/, namespace: namespaces.bundle }, (args) => {
@@ -84,7 +84,14 @@ export const plugin = (options: { inputs: BundlerInput[] }): Plugin => {
         return { contents, loader };
       });
       build.onEnd((result) => {
-        result.legacyScripts = legacyScripts;
+        result.legacyScripts = [];
+        Object.keys(result.metafile!.inputs).forEach((path) => {
+          const script = legacyScripts.get(path.replace('bundle:', ''));
+          if (!script) {
+            return;
+          }
+          result.legacyScripts!.push(script);
+        });
       });
     }
   };

packages/instrument-bundler/src/index.ts

@@ -5,8 +5,10 @@ import { InstrumentBundlerError } from './error.js';
 import type { BundlerInputFileExtension } from './types.js';
 import type { Loader } from './vendor/esbuild.js';
 
+export const BUNDLER_FILE_EXT_REGEX = /\.(css|html|jpeg|jpg|js|jsx|json|mp3|mp4|png|svg|ts|tsx|webp)$/i;
+
 export function extractInputFileExtension(filename: string) {
-  const ext = /\.(css|html|jpeg|jpg|js|jsx|json|mp3|mp4|png|svg|ts|tsx|webp)$/i.exec(filename)?.[0];
+  const ext = BUNDLER_FILE_EXT_REGEX.exec(filename)?.[0];
   return (ext ?? null) as BundlerInputFileExtension | null;
 }
 

packages/instrument-bundler/src/plugin.ts

@@ -11,8 +11,8 @@
     "lint": "tsc && eslint --fix src"
   },
   "dependencies": {
-    "@opendatacapture/evaluate-instrument": "workspace:*",
     "@opendatacapture/runtime-core": "workspace:*",
+    "@opendatacapture/runtime-internal": "workspace:*",
     "@opendatacapture/schemas": "workspace:*"
   },
   "devDependencies": {