publish runtime packages in JSON format for AI

Author: joshunrau

apps/outreach/package.json

@@ -27,6 +27,7 @@
     "@astrojs/starlight": "^0.34.3",
     "@astrojs/starlight-tailwind": "4.0.1",
     "@opendatacapture/runtime-core": "workspace:*",
+    "@opendatacapture/runtime-meta": "workspace:*",
     "@tailwindcss/typography": "^0.5.16",
     "@tailwindcss/vite": "^4.1.5",
     "astro": "^5.15.9",

apps/outreach/src/pages/resources/runtime/[version].json.ts

@@ -0,0 +1,28 @@
+import * as url from 'node:url';
+
+import { generateMetadata, RUNTIME_VERSIONS } from '@opendatacapture/runtime-meta';
+import type { APIRoute, GetStaticPaths, InferGetStaticParamsType, InferGetStaticPropsType } from 'astro';
+import * as Astro from 'astro:config/server';
+
+type Params = InferGetStaticParamsType<typeof getStaticPaths>;
+
+type Props = InferGetStaticPropsType<typeof getStaticPaths>;
+
+export const getStaticPaths = (async () => {
+  const metadata = await generateMetadata({ rootDir: url.fileURLToPath(Astro.root) });
+  return RUNTIME_VERSIONS.map((version) => {
+    const entry = metadata.get(version);
+    return {
+      params: {
+        version
+      },
+      props: {
+        packages: entry!.packages
+      }
+    };
+  });
+}) satisfies GetStaticPaths;
+
+export const GET: APIRoute<Props, Params> = ({ props }) => {
+  return new Response(JSON.stringify(props, null, 2));
+};

packages/runtime-meta/src/index.d.ts

@@ -1,3 +1,5 @@
+export declare const RUNTIME_VERSIONS: string[];
+
 /** Contains the relative paths of assets for a given runtime version. */
 export type RuntimeManifest = {
   /** Relative paths to TypeScript declaration files (.d.ts). */
@@ -10,16 +12,22 @@ export type RuntimeManifest = {
   styles: string[];
 };
 
+export type RuntimePackageMetadata = {
+  exports: {
+    css: string[];
+    html: string[];
+    js: string[];
+  };
+  name: string;
+  version: string;
+};
+
 /**
  * Metadata for a given runtime version.
  *
  * @example
  * {
  *   baseDir: "/root/OpenDataCapture/runtime/v1/dist",
- *   importPaths: [
- *     "/runtime/v1/@opendatacapture/runtime-core/index.js",
- *     ...
- *   ],
  *   manifest: {
  *     declarations: [
  *       "@opendatacapture/runtime-core/index.d.ts",
@@ -40,10 +48,10 @@ export type RuntimeManifest = {
 export type RuntimeVersionMetadata = {
   /** Absolute path to the root directory where runtime files are located. */
   baseDir: string;
-  /** List of fully-qualified import paths available at runtime. */
-  importPaths: string[];
   /** Manifest containing relative paths to declarations, html, sources, and styles. */
   manifest: RuntimeManifest;
+  /** A list of packages available */
+  packages: RuntimePackageMetadata[];
 };
 
 export type RuntimeMetadataMap = Map<string, RuntimeVersionMetadata>;

packages/runtime-meta/src/index.js

@@ -7,7 +7,7 @@ const isDirectory = async (path) => fs.existsSync(path) && fs.lstatSync(path).is
 
 const RUNTIME_DIST_DIRNAME = 'dist';
 
-const RUNTIME_VERSIONS = [1];
+export const RUNTIME_VERSIONS = ['v1'];
 
 /** @type {import('.').MANIFEST_FILENAME} */
 export const MANIFEST_FILENAME = 'runtime.json';
@@ -37,43 +37,50 @@ export async function generateManifest(baseDir) {
   return results;
 }
 
-// /** @type {import('.').generateMetadataForVersion} */
-// export async function generateMetadataForVersion(version) {
-//   const baseDir = path.resolve(RUNTIME_DIR, version, RUNTIME_DIST_DIRNAME);
-//   if (!(await isDirectory(baseDir))) {
-//     throw new Error(`Not a directory: ${baseDir}`);
-//   }
-//   const { declarations, html, sources, styles } = await generateManifest(baseDir);
-// return {
-//   baseDir,
-//   importPaths: sources.map((filename) => `/runtime/${version}/${filename}`),
-//   manifest: {
-//     declarations,
-//     html,
-//     sources,
-//     styles
-//   }
-// };
-// }
-
 /** @type {import('.').generateMetadata} */
 export async function generateMetadata(options) {
   const require = module.createRequire(options.rootDir);
+
+  /** @type {import('.').RuntimeMetadataMap} */
   const metadata = new Map();
-  for (const version of RUNTIME_VERSIONS) {
-    const packageDir = path.dirname(require.resolve(`@opendatacapture/runtime-v${version}/package.json`));
+
+  for (const v of RUNTIME_VERSIONS) {
+    const packageDir = path.dirname(require.resolve(`@opendatacapture/runtime-${v}/package.json`));
     const baseDir = path.resolve(packageDir, RUNTIME_DIST_DIRNAME);
     const { declarations, html, sources, styles } = await generateManifest(baseDir);
 
-    metadata.set(`v${version}`, {
+    const importPathPattern = /^(@?[^@/]+(?:\/[^@/]+)?)(?:@([^/]+))?/;
+
+    /** @type {Map<string, import('.').RuntimePackageMetadata>} */
+    const packages = new Map();
+
+    /** @param {string} filename @param {'css' | 'html' | 'js'} kind */
+    const addToPackage = (filename, kind) => {
+      const match = filename.match(importPathPattern);
+      if (!match) {
+        throw new Error(`Unexpected import path pattern: ${filename}`);
+      }
+      const [name, version] = /** @type {[string, string]} */ (match.slice(1, 3));
+      const key = name + '$' + version;
+      if (!packages.has(key)) {
+        packages.set(key, { exports: { css: [], html: [], js: [] }, name, version });
+      }
+      packages.get(key)?.exports[kind].push(`/runtime/${v}/${filename}`);
+    };
+
+    sources.forEach((source) => addToPackage(source, 'js'));
+    html.forEach((file) => addToPackage(file, 'html'));
+    styles.forEach((style) => addToPackage(style, 'css'));
+
+    metadata.set(v, {
       baseDir,
-      importPaths: sources.map((filename) => `/runtime/${version}/${filename}`),
       manifest: {
         declarations,
         html,
         sources,
         styles
-      }
+      },
+      packages: [...packages.values()]
     });
   }
   return metadata;

packages/serve-instrument/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@opendatacapture/serve-instrument",
   "type": "module",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "license": "Apache-2.0",
   "bin": {
     "serve-instrument": "./dist/cli.js"

packages/vite-plugin-runtime/src/plugin.js

@@ -23,7 +23,7 @@ export async function plugin(options) {
     },
     config: () => ({
       optimizeDeps: {
-        exclude: Array.from(metadata.values().flatMap((pkg) => pkg.importPaths))
+        exclude: Array.from(metadata.values().flatMap(({ packages }) => packages.flatMap((pkg) => pkg.exports.js)))
       }
     }),
     configureServer: (server) => {