Sign In

@squawk/procedure-data

Package Overview
Dependencies
Maintainers
1
Versions
19
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install
This package has malicious versions linked to the ongoing "Mini Shai-Hulud" supply chain attack.

Affected versions:

0.7.30.7.40.7.5
+2 more
View campaign page

@squawk/procedure-data

Pre-processed FAA CIFP procedure snapshot (SIDs, STARs, IAPs) for use with @squawk/procedures

latest
Source
npmnpm
Version
0.7.8
Version published
Weekly downloads
19
-29.63%
Maintainers
1
Weekly downloads
 
Created
Source

squawk logo  @squawk/procedure-data

MIT License npm TypeScript

Pre-processed snapshot of US instrument procedure data from the 2026-06-11 FAA CIFP cycle. Covers Standard Instrument Departures (SIDs), Standard Terminal Arrival Routes (STARs), and Instrument Approach Procedures (IAPs) in the unified ARINC 424 leg model. Data only - no query logic, no dependency on @squawk/procedures.

Documentation

Part of the @squawk aviation library suite. See all packages on npm.

Coverage

  • Standard Instrument Departures (SIDs)
  • Standard Terminal Arrival Routes (STARs)
  • Instrument Approach Procedures (IAPs): ILS, LOC, LOC-BC, RNAV, RNAV (RNP), VOR, VOR/DME, NDB, NDB/DME, TACAN, GLS, IGS, LDA, SDF, GPS, FMS, MLS
  • Full ARINC 424 leg model per procedure: path terminators (IF, TF, CF, DF, CA, CI, CR, FA, FC, FD, FM, HA, HF, HM, PI, RF, AF, VA, VD, VI, VM, VR)
  • Altitude constraints (at / at-or-above / at-or-below / between / glide-slope / step-down descriptors) with primary and secondary altitudes
  • Speed constraints with descriptor
  • Recommended navaid, RNP value, turn direction, arc radius, center fix (for RF legs)
  • Approach-role flags: IAF, IF (intermediate), FAF, FACF, MAP, fly-over
  • Named transitions (approach transitions for IAPs, enroute / runway transitions for SIDs and STARs)
  • Missed-approach sequences for IAPs
  • Resolved lat/lon for every fix, navaid, airport, and runway reference

Installation

npm install @squawk/procedure-data

Usage

import { usBundledProcedures } from '@squawk/procedure-data';

// Inspect metadata
console.log(usBundledProcedures.properties.cifpCycleDate); // "2026-05-14"
console.log(usBundledProcedures.properties.recordCount);
console.log(usBundledProcedures.properties.sidCount);
console.log(usBundledProcedures.properties.starCount);
console.log(usBundledProcedures.properties.iapCount);

// Use with @squawk/procedures for zero-config procedure queries
import { createProcedureResolver } from '@squawk/procedures';

const resolver = createProcedureResolver({ data: usBundledProcedures.records });

Consumers who have their own data pipeline can use @squawk/procedures alone and pass any compatible Procedure array at initialization.

Browser / SPA usage

For browsers, edge runtimes (Cloudflare Workers, Deno Deploy), and any other environment without node:fs, import the async loader from the /browser subpath. It fetches and decompresses the bundled .gz using Web Streams (DecompressionStream) and the global fetch.

import { loadUsBundledProcedures } from '@squawk/procedure-data/browser';
import { createProcedureResolver } from '@squawk/procedures/browser';

const dataset = await loadUsBundledProcedures();
const resolver = createProcedureResolver({ data: dataset.records });

The default URL is resolved relative to this module's import.meta.url, which works under any modern ESM bundler when the package is installed normally.

To host the asset on your own CDN, to use a bundler-resolved (hashed) asset URL, or to override the URL for any other reason, pass an explicit url:

import { loadUsBundledProcedures } from '@squawk/procedure-data/browser';

const dataset = await loadUsBundledProcedures({
  url: 'https://your-cdn.example/procedures.json.gz',
});

The loader also accepts a custom fetch implementation, which is useful in tests or in edge environments that need a configured fetcher.

Data format

Each record is a full Procedure object from @squawk/types. Key fields:

PropertyTypeDescription
namestringHuman-readable name (e.g. AALLE4, ILS RWY 04L)
identifierstringCIFP procedure identifier (e.g. AALLE4, I04L)
typeProcedureTypeSID, STAR, or IAP
airportsstring[]Airports served by this procedure
commonRoutesProcedureCommonRoute[]Trunk paths with legs and per-route adapted airports
transitionsProcedureTransition[]Named transitions (approach / enroute / runway depending on type)
approachTypeApproachType | undefinedApproach classification (IAPs only)
runwaystring | undefinedRunway served by the approach (IAPs with a runway-specific approach)
missedApproachMissedApproachSequenceMissed-approach climb-out (IAPs only)

Each ProcedureLeg carries:

PropertyTypeDescription
pathTerminatorProcedureLegPathTerminatorARINC 424 path terminator (e.g. TF, CF, CA)
fixIdentifier, category, lat, lon, icaoRegionCode(see types)Termination fix (absent on pure heading/altitude legs)
altitudeConstraintAltitudeConstraintDescriptor + primary/secondary altitudes in feet
speedConstraintSpeedConstraintDescriptor + speed in knots
courseDeg, courseIsTruenumber / booleanOutbound or intercept course
distanceNm, holdTimeMinnumberDistance or hold time (leg-type dependent)
recommendedNavaid, thetaDeg, rhoNm, rnpNm(see types)Recommended navaid + bearing/distance/RNP reference
turnDirection'L' | 'R'Commanded turn direction
arcRadiusNm, centerFix(see types)Populated on RF constant-radius-arc legs
isInitialApproachFix, isIntermediateFix, isFinalApproachFix, isFinalApproachCourseFix, isMissedApproachPoint, isFlyoverbooleanApproach role flags

Data source

Data is derived from the FAA CIFP (Coded Instrument Flight Procedures) 28-day cycle, which is public domain and published in ARINC 424 v18 format. The build pipeline that produces this dataset lives in tools/build-procedure-data.

A note on Obstacle Departure Procedures (ODPs)

Graphic ODPs are encoded by CIFP as SIDs (PD records) with no distinguishing field, so they are included in this dataset labelled as SID alongside regular Standard Instrument Departures. There is no reliable way to distinguish ODPs from regular SIDs using CIFP data alone - the ODP indicator lives in the d-TPP (Digital Terminal Procedures Publication) chart titles.

Textual ODPs (plain-English climb instructions published in the d-TPP supplement) are not carried by CIFP at all and are therefore not included in this dataset.

Keywords

aviation

FAQs

Package last updated on 14 Jun 2026

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts