@ankhorage/zora 26.1.6 → 27.0.0

package/src/features/web-component-artifact/application/use-cases/synchronizeWebComponentArtifactsAsync.test.ts

@@ -1,128 +0,0 @@
-import { mkdir, mkdtemp, readdir, readFile, readlink, rm, writeFile } from 'node:fs/promises';
-import { tmpdir } from 'node:os';
-import { dirname, join } from 'node:path';
-
-import { expect, test } from 'bun:test';
-
-import { createNodeWebComponentArtifactFileSystem } from '../../adapters/outbound/node/createNodeWebComponentArtifactFileSystem';
-import { synchronizeWebComponentArtifactsAsync } from './synchronizeWebComponentArtifactsAsync';
-
-test('syncs one shared provider graph, prunes removed components, and preserves output on failure', async () => {
-  const sandbox = await mkdtemp(join(tmpdir(), 'zora-web-sync-'));
-  const packageRoot = join(sandbox, 'owner');
-  const outputDirectory = join(sandbox, 'project', '.ankh', 'zora', 'web');
-  const entries = {
-    'runtime/ZoraProvider.js': "export { runtime } from '../chunks/shared.js';\n",
-    'runtime/ZoraProvider.d.ts': 'export declare const ZoraProvider: unknown;\n',
-    'components/select/Select.js': "export { select } from '../../chunks/shared.js';\n",
-    'components/select/Select.d.ts': 'export declare const Select: unknown;\n',
-    'components/button/Button.js': "export { button } from '../../chunks/shared.js';\n",
-    'components/button/Button.d.ts': 'export declare const Button: unknown;\n',
-    'chunks/shared.js': 'export const runtime = 1, select = 2, button = 3;\n',
-  } as const;
-  try {
-    await Promise.all(
-      Object.entries(entries).map(async ([file, source]) => {
-        const path = join(packageRoot, 'web-dist', file);
-        await mkdir(dirname(path), { recursive: true });
-        await writeFile(path, source);
-      }),
-    );
-    await writeFile(
-      join(packageRoot, 'web-dist', 'manifest.json'),
-      JSON.stringify({
-        schemaVersion: 2,
-        runtime: {
-          entry: 'runtime/ZoraProvider.js',
-          files: ['runtime/ZoraProvider.js', 'runtime/ZoraProvider.d.ts', 'chunks/shared.js'],
-        },
-        artifacts: [
-          {
-            component: 'select',
-            files: [
-              'components/select/Select.js',
-              'components/select/Select.d.ts',
-              'chunks/shared.js',
-            ],
-          },
-          {
-            component: 'button',
-            files: [
-              'components/button/Button.js',
-              'components/button/Button.d.ts',
-              'chunks/shared.js',
-            ],
-          },
-        ],
-      }),
-    );
-    const fileSystem = createNodeWebComponentArtifactFileSystem();
-    const base = { outputDirectory, packageRoot, packageVersion: '1.2.3' };
-    const first = await synchronizeWebComponentArtifactsAsync(
-      { ...base, components: ['select', 'button'] },
-      fileSystem,
-    );
-    const evidence = JSON.parse(
-      await readFile(join(outputDirectory, 'materialization.json'), 'utf8'),
-    ) as { readonly components: readonly string[]; readonly files: readonly string[] };
-    expect(evidence.components).toEqual(['button', 'select']);
-    expect(evidence.files.filter((file) => file === 'chunks/shared.js')).toHaveLength(1);
-    expect(first.files).toEqual(evidence.files);
-
-    const firstGeneration = await readlink(outputDirectory);
-    const second = await synchronizeWebComponentArtifactsAsync(
-      { ...base, components: ['button'] },
-      fileSystem,
-    );
-    expect(second.files).not.toContain('components/select/Select.js');
-    expect(await readlink(outputDirectory)).not.toBe(firstGeneration);
-    expect(await readdir(join(outputDirectory, 'components'))).toEqual(['button']);
-    expect(await readdir(dirname(outputDirectory))).toHaveLength(2);
-
-    await synchronizeWebComponentArtifactsAsync(
-      { ...base, packageVersion: '1.2.4', components: ['button'] },
-      fileSystem,
-    );
-    expect(await readFile(join(outputDirectory, 'runtime/ZoraProvider.js'), 'utf8')).toContain(
-      'Generated by @ankhorage/zora v1.2.4',
-    );
-    expect(await readFile(join(outputDirectory, 'components/button/Button.js'), 'utf8')).toContain(
-      'Generated by @ankhorage/zora v1.2.4',
-    );
-
-    await rm(join(packageRoot, 'web-dist', 'components/button/Button.js'));
-    const validGeneration = await readlink(outputDirectory);
-    const failed = await synchronizeWebComponentArtifactsAsync(
-      { ...base, components: ['button'] },
-      fileSystem,
-    ).then(
-      () => false,
-      () => true,
-    );
-    expect(failed).toBe(true);
-    expect(await readlink(outputDirectory)).toBe(validGeneration);
-    expect(await readFile(join(outputDirectory, 'components/button/Button.js'), 'utf8')).toContain(
-      'Generated by @ankhorage/zora v1.2.4',
-    );
-  } finally {
-    await rm(sandbox, { force: true, recursive: true });
-  }
-});
-
-test('swaps Windows-style junction generations without leaving stale output', async () => {
-  const sandbox = await mkdtemp(join(tmpdir(), 'zora-web-windows-swap-'));
-  const outputDirectory = join(sandbox, 'web');
-  const fileSystem = createNodeWebComponentArtifactFileSystem('win32');
-  try {
-    const first = await fileSystem.createStageDirectoryAsync(outputDirectory);
-    await writeFile(join(first, 'version.txt'), 'first');
-    await fileSystem.commitStageDirectoryAsync(first, outputDirectory);
-    const second = await fileSystem.createStageDirectoryAsync(outputDirectory);
-    await writeFile(join(second, 'version.txt'), 'second');
-    await fileSystem.commitStageDirectoryAsync(second, outputDirectory);
-    expect(await readFile(join(outputDirectory, 'version.txt'), 'utf8')).toBe('second');
-    expect(await readdir(sandbox)).toHaveLength(2);
-  } finally {
-    await rm(sandbox, { force: true, recursive: true });
-  }
-});

package/src/features/web-component-artifact/application/use-cases/synchronizeWebComponentArtifactsAsync.ts

@@ -1,133 +0,0 @@
-import { isRecord } from '@ankhorage/utility/object';
-
-import type { WebComponentArtifactFileSystemPort } from '../ports/outbound/WebComponentArtifactFileSystemPort';
-
-export interface SynchronizeWebComponentArtifactsInput {
-  readonly components: readonly string[];
-  readonly outputDirectory: string;
-  readonly packageRoot: string;
-  readonly packageVersion: string;
-}
-
-export interface SynchronizeWebComponentArtifactsResult {
-  readonly components: readonly string[];
-  readonly files: readonly string[];
-  readonly outputDirectory: string;
-}
-
-interface ArtifactDefinition {
-  readonly component: string;
-  readonly files: readonly string[];
-}
-
-interface WebArtifactCatalog {
-  readonly runtime: { readonly files: readonly string[] };
-  readonly artifacts: readonly ArtifactDefinition[];
-}
-
-/*** Reconcile one desired web set from a single published ZORA generation. */
-export async function synchronizeWebComponentArtifactsAsync(
-  input: SynchronizeWebComponentArtifactsInput,
-  fileSystem: WebComponentArtifactFileSystemPort,
-): Promise<SynchronizeWebComponentArtifactsResult> {
-  const catalog = await readArtifactCatalogAsync(input.packageRoot, fileSystem);
-  const components = [...new Set(input.components)].sort();
-  const selected = components.map((component) => {
-    const artifact = catalog.artifacts.find((candidate) => candidate.component === component);
-    if (artifact === undefined) throw new Error(`Unsupported ZORA web component: ${component}`);
-    return artifact;
-  });
-  const files = [
-    ...new Set([...catalog.runtime.files, ...selected.flatMap(({ files }) => files)]),
-  ].sort();
-  const stage = await fileSystem.createStageDirectoryAsync(input.outputDirectory);
-  try {
-    await Promise.all(
-      files.map(async (file) => {
-        const source = await fileSystem.readTextFileAsync(
-          fileSystem.joinPath(input.packageRoot, 'web-dist', file),
-        );
-        const destination = fileSystem.joinPath(stage, file);
-        await fileSystem.ensureDirectoryAsync(fileSystem.joinPath(stage, parentDirectory(file)));
-        await fileSystem.writeTextFileAsync(
-          destination,
-          `// Generated by @ankhorage/zora v${input.packageVersion}. Do not edit manually.\n${source}`,
-        );
-      }),
-    );
-    await fileSystem.writeTextFileAsync(
-      fileSystem.joinPath(stage, 'materialization.json'),
-      `${JSON.stringify(
-        {
-          schemaVersion: 1,
-          owner: '@ankhorage/zora',
-          ownerVersion: input.packageVersion,
-          platform: 'web',
-          components,
-          files: [...files, 'materialization.json'].sort(),
-        },
-        null,
-        2,
-      )}\n`,
-    );
-    await fileSystem.commitStageDirectoryAsync(stage, input.outputDirectory);
-  } catch (error) {
-    await fileSystem.removeStageDirectoryAsync(stage);
-    throw error;
-  }
-  return {
-    components,
-    files: [...files, 'materialization.json'].sort(),
-    outputDirectory: input.outputDirectory,
-  };
-}
-
-/*** Read and validate the packaged catalog before changing consumer output. */
-async function readArtifactCatalogAsync(
-  packageRoot: string,
-  fileSystem: WebComponentArtifactFileSystemPort,
-): Promise<WebArtifactCatalog> {
-  const source = await fileSystem.readTextFileAsync(
-    fileSystem.joinPath(packageRoot, 'web-dist', 'manifest.json'),
-  );
-  const parsed: unknown = JSON.parse(source);
-  if (
-    !isRecord(parsed) ||
-    parsed.schemaVersion !== 2 ||
-    !isRecord(parsed.runtime) ||
-    !isFileList(parsed.runtime.files) ||
-    !Array.isArray(parsed.artifacts)
-  ) {
-    throw new Error('Invalid ZORA web artifact manifest.');
-  }
-  const artifacts = parsed.artifacts.map((artifact: unknown) => {
-    if (
-      !isRecord(artifact) ||
-      typeof artifact.component !== 'string' ||
-      !isFileList(artifact.files)
-    ) {
-      throw new Error('Invalid ZORA web artifact manifest entry.');
-    }
-    return { component: artifact.component, files: artifact.files };
-  });
-  return { runtime: { files: parsed.runtime.files }, artifacts };
-}
-
-/*** Accept only known, relative generated file paths. */
-function isFileList(value: unknown): value is readonly string[] {
-  return (
-    Array.isArray(value) &&
-    value.length > 0 &&
-    value.every(
-      (entry) =>
-        typeof entry === 'string' &&
-        /^(?:runtime|components|chunks|assets)\/[A-Za-z0-9_./-]+$/u.test(entry) &&
-        !entry.split('/').includes('..'),
-    )
-  );
-}
-
-/*** Resolve the parent path inside the generated directory. */
-function parentDirectory(file: string): string {
-  return file.slice(0, file.lastIndexOf('/'));
-}

package/src/features/web-component-artifact/composition/createWebDesiredStateWithNodeAsync.ts

@@ -1,60 +0,0 @@
-import { randomUUID } from 'node:crypto';
-import { readFile, rename, rm, writeFile } from 'node:fs/promises';
-import { dirname, join, resolve } from 'node:path';
-
-import { readWebDesiredStateWithNodeAsync } from '../adapters/outbound/node/readWebDesiredStateWithNodeAsync';
-import { readWebComponentPackageMetadataAsync } from './readWebComponentPackageMetadataAsync';
-import { synchronizeWebComponentArtifactsWithNodeAsync } from './synchronizeWebComponentArtifactsWithNodeAsync';
-
-/*** Add one requested web component and regenerate the complete declared set. */
-export async function createWebDesiredStateWithNodeAsync(input: {
-  readonly component: string;
-  readonly projectRoot: string;
-}) {
-  const desired = await readWebDesiredStateWithNodeAsync(input.projectRoot, true);
-  const components = [...new Set([...desired.components, input.component])].sort();
-  const { packageRoot, packageVersion } = await readWebComponentPackageMetadataAsync();
-  const desiredPath = resolve(input.projectRoot, 'zora.web.json');
-  const previous = await readFile(desiredPath, 'utf8').catch((error: unknown) => {
-    if (isMissingFile(error)) return undefined;
-    throw error;
-  });
-  const next = `${JSON.stringify({ schemaVersion: 1, components }, null, 2)}\n`;
-  if (next !== previous) await replaceDesiredStateAsync(desiredPath, next);
-  try {
-    return await synchronizeWebComponentArtifactsWithNodeAsync({
-      components,
-      outputDirectory: resolve(input.projectRoot, '.ankh', 'zora', 'web'),
-      packageRoot,
-      packageVersion,
-    });
-  } catch (error) {
-    if (next !== previous) {
-      try {
-        if (previous === undefined) await rm(desiredPath);
-        else await replaceDesiredStateAsync(desiredPath, previous);
-      } catch (rollbackError) {
-        throw new AggregateError([error, rollbackError], 'ZORA create and rollback failed.', {
-          cause: rollbackError,
-        });
-      }
-    }
-    throw error;
-  }
-}
-
-/*** Replace the authoritative project declaration only after its complete contents are staged. */
-async function replaceDesiredStateAsync(path: string, content: string): Promise<void> {
-  const temporaryPath = join(dirname(path), `.zora-web-${randomUUID()}.tmp`);
-  try {
-    await writeFile(temporaryPath, content, 'utf8');
-    await rename(temporaryPath, path);
-  } finally {
-    await rm(temporaryPath, { force: true });
-  }
-}
-
-/*** Recognize only absent desired state, not unrelated filesystem failures. */
-function isMissingFile(error: unknown): boolean {
-  return error instanceof Error && 'code' in error && error.code === 'ENOENT';
-}

package/src/features/web-component-artifact/composition/readWebComponentPackageMetadataAsync.ts

@@ -1,18 +0,0 @@
-import { readFile } from 'node:fs/promises';
-import { dirname, resolve } from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-/*** Reads the active ZORA package location and version for generated web artifacts. */
-export async function readWebComponentPackageMetadataAsync(): Promise<WebComponentPackageMetadata> {
-  const packageRoot = resolve(dirname(fileURLToPath(import.meta.url)), '../../../..');
-  const packageJson = JSON.parse(await readFile(resolve(packageRoot, 'package.json'), 'utf8')) as {
-    readonly version: string;
-  };
-
-  return { packageRoot, packageVersion: packageJson.version };
-}
-
-interface WebComponentPackageMetadata {
-  readonly packageRoot: string;
-  readonly packageVersion: string;
-}

package/src/features/web-component-artifact/composition/synchronizeDeclaredWebComponentsWithNodeAsync.ts

@@ -1,17 +0,0 @@
-import { resolve } from 'node:path';
-
-import { readWebDesiredStateWithNodeAsync } from '../adapters/outbound/node/readWebDesiredStateWithNodeAsync';
-import { readWebComponentPackageMetadataAsync } from './readWebComponentPackageMetadataAsync';
-import { synchronizeWebComponentArtifactsWithNodeAsync } from './synchronizeWebComponentArtifactsWithNodeAsync';
-
-/*** Load project desired state and sync it from the active ZORA package release. */
-export async function synchronizeDeclaredWebComponentsWithNodeAsync(projectRoot: string) {
-  const desired = await readWebDesiredStateWithNodeAsync(projectRoot, false);
-  const { packageRoot, packageVersion } = await readWebComponentPackageMetadataAsync();
-  return await synchronizeWebComponentArtifactsWithNodeAsync({
-    components: desired.components,
-    outputDirectory: resolve(projectRoot, '.ankh', 'zora', 'web'),
-    packageRoot,
-    packageVersion,
-  });
-}

package/src/features/web-component-artifact/composition/synchronizeWebComponentArtifactsWithNodeAsync.ts

@@ -1,16 +0,0 @@
-import { createNodeWebComponentArtifactFileSystem } from '../adapters/outbound/node/createNodeWebComponentArtifactFileSystem';
-import {
-  synchronizeWebComponentArtifactsAsync,
-  type SynchronizeWebComponentArtifactsInput,
-  type SynchronizeWebComponentArtifactsResult,
-} from '../application/use-cases/synchronizeWebComponentArtifactsAsync';
-
-/*** Wire Node filesystem operations into shared ZORA web reconciliation. */
-export async function synchronizeWebComponentArtifactsWithNodeAsync(
-  input: SynchronizeWebComponentArtifactsInput,
-): Promise<SynchronizeWebComponentArtifactsResult> {
-  return await synchronizeWebComponentArtifactsAsync(
-    input,
-    createNodeWebComponentArtifactFileSystem(),
-  );
-}

package/src/webArtifactRuntime.test.ts

@@ -1,14 +0,0 @@
-import { expect, test } from 'bun:test';
-
-test('materialized components share the generated provider through SSR and interaction', () => {
-  const subprocess = Bun.spawnSync({
-    cmd: [process.execPath, 'scripts/web-artifacts/verifyWebMaterialization.ts'],
-    stderr: 'pipe',
-    stdout: 'pipe',
-  });
-  const output = `${subprocess.stdout.toString()}\n${subprocess.stderr.toString()}`;
-  expect(subprocess.exitCode, output).toBe(0);
-  expect(output).toContain(
-    'Materialized ZORA provider, SSR hydration, and Select interaction passed.',
-  );
-});