Merge pull request #1087 from joshunrau/runtime-core-ts

rewrite runtime-core in TypeScript with intermediate build step

Author: joshunrau

.gitignore

@@ -62,3 +62,6 @@ apps/outreach/src/content/docs/en/runtime-core-docs/
 # docker dbs
 mongo/
 sqlite/
+
+# runtime core intermediate build
+packages/runtime-core/lib/

apps/outreach/astro.config.ts

@@ -62,7 +62,7 @@ export default defineConfig({
       },
       plugins: [
         starlightTypeDocPlugin({
-          entryPoints: [path.resolve(runtimeCoreRoot, 'src/index.d.ts')],
+          entryPoints: [path.resolve(runtimeCoreRoot, 'lib/index.d.ts')],
           locale: 'en',
           output: 'runtime-core-docs',
           sidebar: {

packages/instrument-bundler/src/__tests__/repositories/interactive/index.tsx

@@ -2,6 +2,8 @@ import { defineInstrument } from '/runtime/v1/@opendatacapture/runtime-core';
 import { createRoot } from '/runtime/v1/[email protected]/client';
 import { z } from '/runtime/v1/[email protected]';
 
+const { sum } = await import('/runtime/v1/[email protected]');
+
 import './styles.css';
 import '/runtime/v1/[email protected]/normalize.css';
 
@@ -18,7 +20,7 @@ export default defineInstrument({
       root.render(
         <div>
           <h1>Interactive Task</h1>
-          <button onClick={() => done({})}>Done</button>
+          <button onClick={() => done({ value: sum([1, 2, 3]) })}>Done</button>
         </div>
       );
     }

packages/instrument-bundler/src/__tests__/transform.test.ts

@@ -4,24 +4,24 @@ import { transformImports } from '../transform.js';
 
 describe('transformImports', () => {
   it('should transform a default import', () => {
-    expect(transformImports("import React from 'react';")).toBe("const { default: React } = await import('react');");
+    expect(transformImports("import React from 'react';")).toBe("const { default: React } = await __import('react');");
   });
   it('should transform named imports', () => {
     expect(transformImports("import { useEffect, useState } from 'react';")).toBe(
-      "const { useEffect, useState } = await import('react');"
+      "const { useEffect, useState } = await __import('react');"
     );
   });
   it('should transform named and default imports from the same source', () => {
     expect(transformImports("import React, { useState } from 'react';")).toBe(
-      "const { useState, default: React } = await import('react');"
+      "const { useState, default: React } = await __import('react');"
     );
   });
   it('should transform a namespace import', () => {
-    expect(transformImports("import * as React from 'react';")).toBe("const React = await import('react');");
+    expect(transformImports("import * as React from 'react';")).toBe("const React = await __import('react');");
   });
   it('should transform named and default imports from the same source', () => {
     expect(transformImports("import _ from 'lodash'; import { useEffect, useState } from 'react';")).toBe(
-      "const { default: _ } = await import('lodash'); const { useEffect, useState } = await import('react');"
+      "const { default: _ } = await __import('lodash'); const { useEffect, useState } = await __import('react');"
     );
   });
 });

packages/runtime-core/config/api-extractor.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  "mainEntryPointFilePath": "<projectFolder>/src/index.d.ts",
+  "mainEntryPointFilePath": "<projectFolder>/lib/index.d.ts",
   "bundledPackages": ["@douglasneuroinformatics/libui-form-types"],
   "apiReport": {
     "enabled": false

packages/runtime-core/package.json

@@ -12,9 +12,9 @@
     "./package.json": "./package.json"
   },
   "scripts": {
-    "build": "rm -rf dist && pnpm build:js && pnpm build:ts",
-    "build:js": "pnpm exec esbuild --bundle --format=esm --outfile=dist/index.js --platform=browser src/index.js",
-    "build:ts": "api-extractor run -c config/api-extractor.json",
+    "build": "rm -rf dist lib && pnpm build:lib && pnpm build:dist",
+    "build:dist": "pnpm exec esbuild --bundle --format=esm --outfile=dist/index.js --platform=browser lib/index.js && api-extractor run -c config/api-extractor.json",
+    "build:lib": "tsc -b tsconfig.build.json",
     "format": "prettier --write src",
     "lint": "tsc --noEmit && eslint --fix src"
   },

packages/runtime-core/src/__tests__/define.test-d.ts

@@ -3,9 +3,9 @@ import { z } from 'zod';
 
 import { defineInstrument } from '../define.js';
 
-import type { DiscriminatedInstrument } from '../define.d.ts';
-import type { FormInstrument } from '../types/instrument.form.d.ts';
-import type { InteractiveInstrument } from '../types/instrument.interactive.d.ts';
+import type { DiscriminatedInstrument } from '../define.js';
+import type { FormInstrument } from '../types/instrument.form.js';
+import type { InteractiveInstrument } from '../types/instrument.interactive.js';
 
 expectTypeOf<DiscriminatedInstrument<'FORM', 'en', { foo: string }>>().toMatchTypeOf<
   FormInstrument<{ foo: string }, 'en'>

packages/runtime-core/src/define.js

@@ -1,12 +1,12 @@
 import type { z } from 'zod';
 
-import type { InstrumentKind, InstrumentLanguage } from './types/instrument.base.d.ts';
-import type { FormInstrument } from './types/instrument.form.d.ts';
-import type { InteractiveInstrument } from './types/instrument.interactive.d.ts';
+import type { InstrumentKind, InstrumentLanguage } from './types/instrument.base.js';
+import type { FormInstrument } from './types/instrument.form.js';
+import type { InteractiveInstrument } from './types/instrument.interactive.js';
 
 /** @public */
 // prettier-ignore
-type DiscriminatedInstrument<
+export type DiscriminatedInstrument<
   TKind extends InstrumentKind,
   TLanguage extends InstrumentLanguage,
   TData
@@ -21,7 +21,7 @@ type DiscriminatedInstrument<
     : never;
 
 /** @public */
-type InstrumentDef<
+export type InstrumentDef<
   TKind extends InstrumentKind,
   TLanguage extends InstrumentLanguage,
   TSchema extends z.ZodTypeAny
@@ -35,8 +35,12 @@ type InstrumentDef<
 };
 
 /** @public */
-export declare function defineInstrument<
+export function defineInstrument<
   TKind extends InstrumentKind,
   TLanguage extends InstrumentLanguage,
   TSchema extends z.ZodTypeAny
->(def: InstrumentDef<TKind, TLanguage, TSchema>): DiscriminatedInstrument<TKind, TLanguage, z.TypeOf<TSchema>>;
+>(def: InstrumentDef<TKind, TLanguage, TSchema>) {
+  return Object.assign(def, {
+    __runtimeVersion: 1
+  }) as unknown as DiscriminatedInstrument<TKind, TLanguage, z.TypeOf<TSchema>>;
+}