@panomapp/drs

Dependency Resolver — single drs.config.json for local file: vs registry specifiers across consumers.

Quickstart

Write drs.config.json with "defaults": { "mode": "auto" }, then:

# From monorepo root
npx drs build
# or
npm run drs:build

That is the only command you need for day-to-day work: updates consumer package.json files, builds local packages when needed, runs npm install in each consumer, and verifies drift.

What auto does

| Where | auto + layout: sibling | auto + layout: vendored | |-------|-----------------------------|-----------------------------| | Your machine (paths exist) | file:../local-package + build at source | file:./generated_modules/... + sync/build vendored copies | | CI (CI=true) | registry.version from config | vendored local paths (standalone repos) | | Machine, path missing | registry | registry |

No need to set DRS_MODE for the usual local vs CI split when using the default sibling layout.

Vendored layout

Set "defaults": { "layout": "vendored" } (or per-consumer "layout": "vendored") to copy local packages into each consumer's generated_modules/ directory, build them there, and rewrite package.json to file:./generated_modules/....

drs build with vendored layout:

1. Builds source packages at the monorepo root (when needed)
2. Syncs sources into {consumer}/generated_modules/
3. Copies built dist/ artifacts into vendored copies
4. Runs validation/build steps inside vendored packages (prebuilt, missing dist, etc.)
5. Updates consumer package.json files and runs npm install

Package entry fields:

| Field | Purpose | |-------|---------| | to | Consumer slugs that receive vendored/source copies; others get registry.version | | only-source | When a consumer is in to, never fall back to registry | | prebuilt | Source is synced into generated_modules/; dist packages build at source and copy dist/; validation-only packages (pack:check) validate in the vendored copy |

Configure vendoring directory/excludes:

{
  "vendoring": {
    "dir": "generated_modules",
    "exclude": [".git", "node_modules", "dist"]
  }
}

Programmatic vendoring API:

import { loadConfig, getVendoringPlan, syncVendoredModules, buildVendoredModules } from '@panomapp/drs';

const config = loadConfig();
const plan = getVendoringPlan(config, '/path/to/consumer');
syncVendoredModules(config, '/path/to/consumer');
buildVendoredModules(config, '/path/to/consumer');

Incremental dev sync:

drs build --if-stale

Compares source trees against generated_modules/, checks for missing dist/, and skips the full build when everything matches.

Config

{
  "$schema": "./node_modules/@panomapp/drs/schema/drs.config.schema.json",
  "version": 1,
  "root": ".",
  "defaults": { "mode": "auto" },
  "packages": {
    "@panomapp/my-pkg": {
      "local": { "path": "packages/my-pkg", "build": "npm run build" },
      "registry": { "version": "^1.0.0" }
    }
  },
  "consumers": {
    "app": {
      "dir": "apps/my-app",
      "dependencies": ["@panomapp/my-pkg"]
    }
  }
}

Modes

| Mode | Behavior | |------|----------| | local | Always file:<path> (fails if path missing) | | registry | Always registry.version | | auto | CI → registry with sibling layout; vendored layout stays local in CI |

Environment (overrides)

| Variable | Description | |----------|-------------| | DRS_CONFIG | Path to config file | | DRS_MODE | Force global mode (local / registry / auto) | | DRS_PACKAGE_@panomapp__my-pkg | Per-package mode (/ → __) |

Example: everything local except one package from npm:

DRS_MODE=local DRS_PACKAGE_@panomapp__hsm-panom-contract=registry drs build

CLI

drs build [--dry-run] [--skip-install] [--verbose]
drs resolve [--print human|json]
drs apply [--dry-run] [--build] [--install]
drs check
drs init
drs docker

GitHub Actions

- uses: actions/checkout@v4
- run: npm ci && npm run build
  working-directory: panom-drs
- run: npm install
- run: npx drs build

auto detects CI and uses registry specifiers; npm install in consumers pulls from npm.

Programmatic API

import { loadConfig, build } from '@panomapp/drs';

const config = loadConfig();
const result = build(config);

Panom

Root drs.config.json. Primary script:

npm run drs:build

Legacy deps:link-local in frontend → npm run drs:build from repo root.

Publishing

cd panom-drs
npm test && npm run build
npm version minor   # or patch
npm publish --access public