@hlang-org/ir

The hlang intermediate representation. IGraph is the JSON form of an hlang program. planGraph validates a graph and lowers it to an execution plan. The interpreter and the compiler both start from this plan, so they apply the same rules.

Install

npm install @hlang-org/ir

The same build is published as @hlang-tech/ir. No runtime dependencies. ESM and CommonJS builds with type declarations.

IGraph

import type { IGraph } from '@hlang-org/ir';

const graph: IGraph = {
  nodeList: [
    { nodeId: 'a', code: 'numbers', name: 'Numbers', type: 'R', bizData: { params: { count: 3 } } },
    { nodeId: 'b', code: 'log', name: 'Log', type: 'W' },
  ],
  connections: [
    { Output: { nodeId: 'a', portConf: { id: 'out' } }, Input: { nodeId: 'b', portConf: { id: 'in' } } },
  ],
};

• type is the node kind: 'R' (Readable), 'T' (Transform), or 'W' (Writable).
• code selects the node implementation. A backend maps it to a class or a module.
• bizData is passed to the node constructor as config; parameters are in bizData.params.
• In a connection, Output is the upstream output port and Input is the downstream input port. A missing port id defaults to Output and Input. The legacy spelling portConfig.id is also read.

planGraph

import { planGraph, GraphError } from '@hlang-org/ir';

const plan = planGraph(graph);
// {
//   nodes: [{ nodeId: 'a', code: 'numbers', kind: 'R', config: { params: { count: 3 } } }, ...],
//   connections: [{ source: { nodeId: 'a', portId: 'out' }, target: { nodeId: 'b', portId: 'in' } }],
//   roots: ['a'],
// }

The plan keeps graph order. config is a copy of bizData with params defaulted to {}.

planGraph throws a GraphError with one of these codes:

Transform-to-Transform cycles are valid.

Exports

• Types: IGraph, INodeInfo, IConnection, IConnectionEndpoint, IBizData, IPortInfo, IPackageInfo, ParamBag, ParamValue, IParamObject, NodeKind, ExecutionPlan, PlannedNode, PlannedConnection, PlannedEndpoint, GraphErrorCode.
• Values: planGraph, GraphError, ERROR_PORT_NAME ('@node/error').

Source and documentation: github.com/hlang-tech/hlang.

License

MIT