npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@openfn/lexicon

v1.1.0

Published

Central repo of names and type definitions

Downloads

2,566

Readme

The lexicon (aka the OpenFunctionicon) is a central repositoty of key type and word definitions.

It's a types repo and glossary at the same time.

Overview

The OpenFunction stack is built on the concepts of Workflows, Runs, Jobs and Expressions (and more). Some of these terms can be used interchangable, or used differently in certain contexts.

Here are the key concepts

  • An Expression is a string of Javascript (or Javascript-like code) written to be run in the CLI or Lightning.
  • A Job is an expression plus some metadata required to run it - typically an adaptor and credentials. The terms Job and Expression are often used interchangeably.
  • A Workflow is a series of steps to be executed in sequence. Steps are usually Jobs (and so job and step are often used interchangeably), but can be Triggers.
  • An Execution Plan is a Workflow plus some options which inform how it should be executed (ie, start node, timeout).

The term "Execution plan" is mostly used internally and not exposed to users, and is usually interchangeable with Workflow.

You can find formal type definition of these and more in src/core.d.ts.

Lightning also introduces it's own terminolgy as it is standalone application and has features that the runtime itself does not.

In Lightning, a Step can be a Job or a Trigger. Jobs are connected by Paths (also known sometimes as Edges), which may be conditional.

You can find lightning-specific typings in src/lightning.d.ts

Usage

This repo only contains type definitions. It is unlikely to be of use outside the repo - although users are free to import and use it.

To use the core types, simply import what you need:

import { ExecutionPlan } from '@openfn/lexicon

To use the lightning types, use @openfn/lexicon/lightning

import { Run } from '@openfn/lexicon/lightning