FabricFabricAirlift
Reference

Source registry API

Resolve source packs, variants, archetypes, adapter contracts, deterministic plans, and certification manifests from TypeScript.

Source registry API

Import the static, versioned registry from @fabricorg/airlift. It contains no credentials, network clients, or client state.

Main exports

ExportPurpose
SOURCE_SYSTEM_PROFILEScanonical profile record keyed by source ID
SOURCE_MIGRATION_AREASten mandatory migration areas
SOURCE_SUPPORT_LEVELSordered evidence claim vocabulary
resolveSourceSystemProfile(value)resolve a canonical ID or alias
resolveSourceVariant(profile, value)validate a variant belongs to its source
createSourceMigrationPlan(value, options)compile the current archetype-aware plan
sourcePackCertificationManifestSchemavalidate immutable live-run input
evaluateSourcePackCertification(input)fail closed on missing evidence for a requested level

Resolve and plan

import {
  createSourceMigrationPlan,
  resolveSourceSystemProfile,
  resolveSourceVariant,
} from '@fabricorg/airlift';

const profile = resolveSourceSystemProfile('confluent');
const variant = resolveSourceVariant(profile, 'confluent_cloud');
const plan = createSourceMigrationPlan(profile.id, { variant: variant.id });

profile.archetype;             // streaming
profile.implementationRoutingLevel; // cataloged; static implementation routing only
profile.adapter.movementOptions;
plan.schemaVersion;            // 3
plan.steps[2]?.id;             // parallel_run

Unknown sources and mismatched variants throw. Do not substitute a generic profile.

Plan-v3 shape

Every plan includes the canonical source and variant, archetype, non-evidentiary implementation routing, program track, ten common areas, adapter contract, steps, external evidence gates, and source-specific surfaces. Implementation routing is never achieved proof. Every step includes:

  • goal;
  • areas;
  • specialistCommands;
  • exact governed airliftActions;
  • outputs;
  • exitCriteria.

The compiler is deterministic and performs no I/O.

Evaluate a certification manifest

const result = evaluateSourcePackCertification({
  schemaVersion: 1,
  sourceSystem: 'sap',
  sourceVariant: 'sap_s4hana',
  requestedLevel: 'executable',
  buildRef: 'builds/airlift-release',
  datasetRef: 'datasets/sap-representative',
  inventoryRun,
  transferRun,
  validationRun,
});

if (!result.eligible) throw new Error(`Missing: ${result.missing.join(', ')}`);

Each run carries an immutable reference, SHA-256 digest, tool version, and completion time. Passing this check is evidence for review; it does not update the registry or mint a migration certificate.

On this page