@ankhorage/zora 21.1.3 → 22.0.0

package/src/features/plugin/ZORA_CORE_PLUGIN_METADATA.ts

@@ -1,49 +0,0 @@
-import type { UiComponentMetaRegistry } from '@ankhorage/contracts';
-
-import type { ZoraComponentMetaRegistry } from '../../types/authoring';
-import type { ZoraPluginMetadata } from '../../types/plugin';
-import { ZORA_BINDABLE_COMPONENT_META } from '../authoring/bindableComponentMeta';
-import { ZORA_COMPONENT_META } from '../authoring/componentMeta';
-
-const CORE_EXTENSION_HOSTS = [
-  'Card',
-  'Grid',
-  'MessageBubble',
-  'PostCard',
-  'Screen',
-  'ScreenSection',
-  'View',
-] as const;
-
-export const ZORA_CORE_PLUGIN_METADATA: ZoraPluginMetadata = {
-  packageName: '@ankhorage/zora',
-  displayName: 'ZORA',
-  componentMeta: mergeBindableMeta(ZORA_COMPONENT_META, ZORA_BINDABLE_COMPONENT_META),
-  extensionHosts: CORE_EXTENSION_HOSTS,
-};
-
-function mergeBindableMeta(
-  componentMeta: ZoraComponentMetaRegistry,
-  bindableMeta: UiComponentMetaRegistry,
-): ZoraComponentMetaRegistry {
-  const bindingsByComponent = new Map(
-    Object.entries(bindableMeta).map(([componentName, meta]) => [componentName, meta.bindings]),
-  );
-  return Object.fromEntries(
-    Object.entries(componentMeta).map(([componentName, meta]) => [
-      componentName,
-      bindingsByComponent.get(componentName)
-        ? {
-            ...meta,
-            bindings: {
-              props: { ...bindingsByComponent.get(componentName)?.props, ...meta.bindings?.props },
-              events: {
-                ...bindingsByComponent.get(componentName)?.events,
-                ...meta.bindings?.events,
-              },
-            },
-          }
-        : meta,
-    ]),
-  );
-}

package/src/features/plugin/application/use-cases/composeZoraPluginMetadata.ts

@@ -1,166 +0,0 @@
-import type { ZoraComponentMeta } from '../../../../types/authoring';
-import type {
-  ComposedZoraPluginMetadataCatalog,
-  ZoraPluginCompositionErrorCode,
-  ZoraPluginMetadata,
-  ZoraPluginPlacement,
-} from '../../../../types/plugin';
-import { ZoraPluginCompositionError } from '../../domain/ZoraPluginCompositionError';
-
-/*** Compose a selected ZORA metadata set for authoring tools that must not load React Native runtime modules. */
-export function composeZoraPluginMetadata(
-  plugins: readonly ZoraPluginMetadata[],
-): ComposedZoraPluginMetadataCatalog {
-  const descriptors = sortPlugins(plugins);
-  const packages = new Set<string>();
-  const componentOwners = new Map<string, string>();
-  const componentMeta = new Map<string, ZoraComponentMeta>();
-  const extensionHosts = new Set<string>();
-  const interactionPolicySupportedComponents = new Set<string>();
-
-  for (const descriptor of descriptors) {
-    validateUniquePackage(descriptor, packages);
-    validateMetadata(descriptor);
-    for (const [componentName, meta] of sortedEntries(descriptor.componentMeta)) {
-      claimComponent(componentName, descriptor.packageName, componentOwners);
-      componentMeta.set(componentName, meta);
-    }
-    for (const componentName of descriptor.extensionHosts ?? []) extensionHosts.add(componentName);
-    for (const componentName of descriptor.interactionPolicySupportedComponents ?? []) {
-      interactionPolicySupportedComponents.add(componentName);
-    }
-  }
-
-  for (const descriptor of descriptors) {
-    for (const placement of descriptor.placements ?? []) {
-      applyPlacement({ descriptor, placement, componentMeta, extensionHosts });
-    }
-  }
-
-  return {
-    componentMeta: Object.fromEntries(componentMeta),
-    bindableComponentMeta: Object.fromEntries(componentMeta),
-    packageManifests: descriptors.map(({ packageName, displayName, componentMeta: meta }) => ({
-      packageName,
-      ...(displayName === undefined ? {} : { displayName }),
-      components: meta,
-    })),
-    interactionPolicySupportedComponents: Object.fromEntries(
-      [...interactionPolicySupportedComponents]
-        .sort()
-        .map((componentName) => [componentName, true]),
-    ),
-  };
-}
-
-function validateUniquePackage(descriptor: ZoraPluginMetadata, packages: Set<string>): void {
-  if (packages.has(descriptor.packageName)) {
-    throw compositionError(
-      'duplicate-package',
-      descriptor.packageName,
-      `Duplicate ZORA plugin package '${descriptor.packageName}'.`,
-    );
-  }
-  packages.add(descriptor.packageName);
-}
-
-function validateMetadata(descriptor: ZoraPluginMetadata): void {
-  for (const [componentName, meta] of sortedEntries(descriptor.componentMeta)) {
-    if (meta.name !== componentName) {
-      throw compositionError(
-        'invalid-component-meta',
-        descriptor.packageName,
-        `ZORA plugin '${descriptor.packageName}' metadata key '${componentName}' does not match meta.name '${meta.name}'.`,
-        componentName,
-      );
-    }
-  }
-}
-
-function claimComponent(
-  componentName: string,
-  packageName: string,
-  owners: Map<string, string>,
-): void {
-  const existingOwner = owners.get(componentName);
-  if (existingOwner) {
-    throw compositionError(
-      'duplicate-component',
-      packageName,
-      `ZORA component '${componentName}' is owned by both '${existingOwner}' and '${packageName}'.`,
-      componentName,
-    );
-  }
-  owners.set(componentName, packageName);
-}
-
-function applyPlacement(args: {
-  descriptor: ZoraPluginMetadata;
-  placement: ZoraPluginPlacement;
-  componentMeta: Map<string, ZoraComponentMeta>;
-  extensionHosts: ReadonlySet<string>;
-}): void {
-  const { descriptor, placement, componentMeta, extensionHosts } = args;
-  const childMeta = descriptor.componentMeta[placement.child];
-  if (!childMeta?.directManifestNode) {
-    throw compositionError(
-      'invalid-placement-child',
-      descriptor.packageName,
-      `ZORA plugin '${descriptor.packageName}' placement child '${placement.child}' is not an owned direct manifest node.`,
-      placement.child,
-    );
-  }
-  for (const parentName of [...placement.parents].sort()) {
-    const parentMeta = componentMeta.get(parentName);
-    if (!parentMeta || !extensionHosts.has(parentName)) {
-      throw compositionError(
-        'invalid-placement-parent',
-        descriptor.packageName,
-        `ZORA plugin '${descriptor.packageName}' placement parent '${parentName}' is not a declared extension host.`,
-        placement.child,
-      );
-    }
-    componentMeta.set(parentName, addAllowedChild(parentMeta, placement.child));
-  }
-}
-
-function addAllowedChild(meta: ZoraComponentMeta, child: string): ZoraComponentMeta {
-  const allowedChildren = appendUnique(meta.allowedChildren, child);
-  const childrenSlot = meta.slots?.children;
-  return {
-    ...meta,
-    allowedChildren,
-    ...(childrenSlot
-      ? {
-          slots: {
-            ...meta.slots,
-            children: {
-              ...childrenSlot,
-              allowedChildren: appendUnique(childrenSlot.allowedChildren ?? [], child),
-            },
-          },
-        }
-      : {}),
-  };
-}
-
-function appendUnique(values: readonly string[], value: string): readonly string[] {
-  return values.includes(value) ? values : [...values, value];
-}
-
-function sortedEntries<T>(value: Readonly<Record<string, T>>): [string, T][] {
-  return Object.entries(value).sort(([left], [right]) => left.localeCompare(right));
-}
-
-function sortPlugins<T extends ZoraPluginMetadata>(plugins: readonly T[]): T[] {
-  return [...plugins].sort((left, right) => left.packageName.localeCompare(right.packageName));
-}
-
-function compositionError(
-  code: ZoraPluginCompositionErrorCode,
-  packageName: string,
-  message: string,
-  componentName?: string,
-): ZoraPluginCompositionError {
-  return new ZoraPluginCompositionError({ code, packageName, message, componentName });
-}

package/src/features/plugin/application/use-cases/composeZoraPlugins.ts

@@ -1,76 +0,0 @@
-import type {
-  ComposedZoraPluginCatalog,
-  ZoraPluginCompositionErrorCode,
-  ZoraPluginDescriptor,
-} from '../../../../types/plugin';
-import type { ZoraComponentRegistry } from '../../../../types/registry';
-import { ZoraPluginCompositionError } from '../../domain/ZoraPluginCompositionError';
-import { composeZoraPluginMetadata } from './composeZoraPluginMetadata';
-
-/*** Compose a selected ZORA core/plugin descriptor set into one validated authoring/runtime catalog. */
-export function composeZoraPlugins(
-  plugins: readonly ZoraPluginDescriptor[],
-): ComposedZoraPluginCatalog {
-  const descriptors = [...plugins].sort((left, right) =>
-    left.packageName.localeCompare(right.packageName),
-  );
-  const componentRegistry = new Map<string, ZoraComponentRegistry[string]>();
-
-  for (const descriptor of descriptors) {
-    validateRuntime(descriptor);
-    for (const [componentName, component] of sortedEntries(descriptor.componentRegistry)) {
-      componentRegistry.set(componentName, component);
-    }
-  }
-  const metadataCatalog = composeZoraPluginMetadata(descriptors);
-
-  return { ...metadataCatalog, componentRegistry: Object.fromEntries(componentRegistry) };
-}
-
-function validateRuntime(descriptor: ZoraPluginDescriptor): void {
-  const componentMetaNames = new Set(Object.keys(descriptor.componentMeta));
-  const runtimeComponentNames = new Set(Object.keys(descriptor.componentRegistry));
-  for (const componentName of Object.keys(descriptor.componentRegistry).sort()) {
-    if (!componentMetaNames.has(componentName)) {
-      throw compositionError(
-        'missing-component-meta',
-        descriptor.packageName,
-        `ZORA plugin '${descriptor.packageName}' registers runtime component '${componentName}' without component metadata.`,
-        componentName,
-      );
-    }
-  }
-  for (const [componentName, meta] of sortedEntries(descriptor.componentMeta)) {
-    if (meta.directManifestNode && !runtimeComponentNames.has(componentName)) {
-      throw compositionError(
-        'missing-runtime-component',
-        descriptor.packageName,
-        `ZORA plugin '${descriptor.packageName}' exposes direct manifest node '${componentName}' without a runtime component.`,
-        componentName,
-      );
-    }
-  }
-  for (const componentName of descriptor.interactionPolicySupportedComponents ?? []) {
-    if (!runtimeComponentNames.has(componentName)) {
-      throw compositionError(
-        'invalid-interaction-policy-component',
-        descriptor.packageName,
-        `ZORA plugin '${descriptor.packageName}' declares interaction-policy support for unregistered component '${componentName}'.`,
-        componentName,
-      );
-    }
-  }
-}
-
-function sortedEntries<T>(value: Readonly<Record<string, T>>): [string, T][] {
-  return Object.entries(value).sort(([left], [right]) => left.localeCompare(right));
-}
-
-function compositionError(
-  code: ZoraPluginCompositionErrorCode,
-  packageName: string,
-  message: string,
-  componentName?: string,
-): ZoraPluginCompositionError {
-  return new ZoraPluginCompositionError({ code, packageName, message, componentName });
-}

package/src/features/plugin/domain/ZoraPluginCompositionError.ts

@@ -1,21 +0,0 @@
-import type { ZoraPluginCompositionErrorCode } from '../../../types/plugin';
-
-/*** Report one deterministic plugin composition contract violation. */
-export class ZoraPluginCompositionError extends Error {
-  readonly code: ZoraPluginCompositionErrorCode;
-  readonly packageName: string;
-  readonly componentName?: string;
-
-  constructor(args: {
-    readonly code: ZoraPluginCompositionErrorCode;
-    readonly packageName: string;
-    readonly message: string;
-    readonly componentName?: string;
-  }) {
-    super(args.message);
-    this.name = 'ZoraPluginCompositionError';
-    this.code = args.code;
-    this.packageName = args.packageName;
-    this.componentName = args.componentName;
-  }
-}

package/src/features/plugin/pluginComposition.test.ts

@@ -1,139 +0,0 @@
-import { describe, expect, test } from 'bun:test';
-
-import type { ZoraComponentMeta } from '../../types/authoring';
-import type { ZoraPluginDescriptor } from '../../types/plugin';
-import { composeZoraPlugins } from './application/use-cases/composeZoraPlugins';
-import { ZoraPluginCompositionError } from './domain/ZoraPluginCompositionError';
-
-const pluginLeafMeta: ZoraComponentMeta = {
-  name: 'PluginLeaf',
-  category: 'component',
-  directManifestNode: true,
-  allowedChildren: [],
-  blueprint: { label: 'Plugin leaf' },
-  bindings: {
-    props: {
-      value: { value: { type: 'string' } },
-    },
-  },
-  props: {
-    value: { type: 'string', category: 'Content', authoring: { authority: 'instance' } },
-  },
-};
-
-const PluginLeaf = () => null;
-
-const Host = () => null;
-
-const core = {
-  packageName: '@example/core',
-  componentRegistry: { Host },
-  componentMeta: {
-    Host: {
-      name: 'Host',
-      category: 'layout',
-      directManifestNode: true,
-      allowedChildren: [],
-      props: {},
-    },
-  },
-  extensionHosts: ['Host'],
-} satisfies ZoraPluginDescriptor;
-
-const plugin = {
-  packageName: '@example/zora-plugin',
-  displayName: 'Example plugin',
-  componentRegistry: { PluginLeaf },
-  componentMeta: { PluginLeaf: pluginLeafMeta },
-  placements: [{ child: 'PluginLeaf', parents: ['Host'] }],
-} satisfies ZoraPluginDescriptor;
-
-describe('composeZoraPlugins', () => {
-  test('composes runtime, authoring, binding, package, and placement projections', () => {
-    const catalog = composeZoraPlugins([core, plugin]);
-
-    expect(catalog.componentRegistry.PluginLeaf).toBe(PluginLeaf);
-    expect(catalog.componentMeta.PluginLeaf).toBe(pluginLeafMeta);
-    expect(catalog.bindableComponentMeta.PluginLeaf?.bindings).toEqual(pluginLeafMeta.bindings);
-    expect(catalog.componentMeta.Host.allowedChildren).toContain('PluginLeaf');
-    expect(catalog.packageManifests.map((entry) => entry.packageName)).toEqual([
-      '@example/core',
-      '@example/zora-plugin',
-    ]);
-  });
-
-  test('is deterministic regardless of plugin input order', () => {
-    const Alpha = () => null;
-    const alpha = createPlugin('@example/alpha', 'Alpha', Alpha);
-    const beta = createPlugin('@example/beta', 'Beta', () => null);
-
-    expect(Object.keys(composeZoraPlugins([core, beta, alpha]).componentMeta)).toEqual(
-      Object.keys(composeZoraPlugins([alpha, core, beta]).componentMeta),
-    );
-  });
-
-  test('rejects duplicate component ownership with a stable diagnostic code', () => {
-    const duplicate = createPlugin('@example/duplicate', 'Host', () => null);
-
-    expect(() => composeZoraPlugins([core, duplicate])).toThrow(ZoraPluginCompositionError);
-    try {
-      composeZoraPlugins([core, duplicate]);
-    } catch (error) {
-      expect(error).toMatchObject({
-        code: 'duplicate-component',
-        packageName: '@example/duplicate',
-        componentName: 'Host',
-      });
-    }
-  });
-
-  test('rejects runtime and metadata mismatches', () => {
-    const invalid = {
-      ...plugin,
-      packageName: '@example/invalid',
-      componentMeta: {},
-    } satisfies ZoraPluginDescriptor;
-
-    expectCompositionError(invalid, 'missing-component-meta');
-  });
-
-  test('rejects placement into components that did not opt in as extension hosts', () => {
-    const invalid = {
-      ...plugin,
-      packageName: '@example/invalid-placement',
-      placements: [{ child: 'PluginLeaf', parents: ['PluginLeaf'] }],
-    } satisfies ZoraPluginDescriptor;
-
-    expectCompositionError(invalid, 'invalid-placement-parent');
-  });
-});
-
-function createPlugin(
-  packageName: string,
-  componentName: string,
-  component: ZoraPluginDescriptor['componentRegistry'][string],
-): ZoraPluginDescriptor {
-  return {
-    packageName,
-    componentRegistry: { [componentName]: component },
-    componentMeta: {
-      [componentName]: {
-        ...pluginLeafMeta,
-        name: componentName,
-      },
-    },
-  };
-}
-
-function expectCompositionError(
-  descriptor: ZoraPluginDescriptor,
-  code: ZoraPluginCompositionError['code'],
-): void {
-  try {
-    composeZoraPlugins([core, descriptor]);
-    throw new Error('Expected plugin composition to fail.');
-  } catch (error) {
-    expect(error).toBeInstanceOf(ZoraPluginCompositionError);
-    expect(error).toMatchObject({ code });
-  }
-}

package/src/features/plugin/public.ts

@@ -1,3 +0,0 @@
-export { composeZoraPluginMetadata } from './application/use-cases/composeZoraPluginMetadata';
-export { ZoraPluginCompositionError } from './domain/ZoraPluginCompositionError';
-export { ZORA_CORE_PLUGIN_METADATA } from './ZORA_CORE_PLUGIN_METADATA';

package/src/features/plugin/runtime.ts

@@ -1,2 +0,0 @@
-export { composeZoraPlugins } from './application/use-cases/composeZoraPlugins';
-export { ZORA_CORE_PLUGIN } from './ZORA_CORE_PLUGIN';

package/src/types/plugin.ts

@@ -1,43 +0,0 @@
-import type { UiComponentMetaRegistry, UiComponentPackageManifest } from '@ankhorage/contracts';
-
-import type { ZoraComponentMetaRegistry } from './authoring';
-import type { ZoraComponentRegistry } from './registry';
-
-export type ZoraPluginCompositionErrorCode =
-  | 'duplicate-component'
-  | 'duplicate-package'
-  | 'invalid-component-meta'
-  | 'invalid-interaction-policy-component'
-  | 'invalid-placement-child'
-  | 'invalid-placement-parent'
-  | 'missing-component-meta'
-  | 'missing-runtime-component';
-
-export interface ZoraPluginPlacement {
-  readonly child: string;
-  readonly parents: readonly string[];
-}
-
-export interface ZoraPluginMetadata {
-  readonly packageName: string;
-  readonly displayName?: string;
-  readonly componentMeta: ZoraComponentMetaRegistry;
-  readonly extensionHosts?: readonly string[];
-  readonly placements?: readonly ZoraPluginPlacement[];
-  readonly interactionPolicySupportedComponents?: readonly string[];
-}
-
-export interface ZoraPluginDescriptor extends ZoraPluginMetadata {
-  readonly componentRegistry: ZoraComponentRegistry;
-}
-
-export interface ComposedZoraPluginMetadataCatalog {
-  readonly componentMeta: ZoraComponentMetaRegistry;
-  readonly bindableComponentMeta: UiComponentMetaRegistry;
-  readonly packageManifests: readonly UiComponentPackageManifest[];
-  readonly interactionPolicySupportedComponents: Readonly<Record<string, true>>;
-}
-
-export interface ComposedZoraPluginCatalog extends ComposedZoraPluginMetadataCatalog {
-  readonly componentRegistry: ZoraComponentRegistry;
-}