Skip to content

Upgrade dependencies + lock file #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
leonardocustodio merged 2 commits into from
Sep 17, 2026
Merged

Upgrade dependencies + lock file #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9d127d7
Upgrade deps
leonardocustodio Sep 17, 2026
8ca12cb
Add lockfile
leonardocustodio Sep 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ jobs:
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5
with:
path: docs/api
path: docs

deploy:
name: Deploy to GitHub Pages
Expand Down
23 changes: 2 additions & 21 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,10 @@ node_modules
# Build artifacts
dist
coverage
/docs/api
# Generated TypeDoc output; retain handwritten architecture notes.
/docs/*
*.tsbuildinfo

# Benchmark output
bench/results.json
bench/results-parallel.json

# Editor
.vscode/*
!.vscode/extensions.json
Expand All @@ -28,22 +25,6 @@ bench/results-parallel.json
.env
.env.*

# Frozen pre-refactor build for local A/B benchmarking (regenerate via git)
bench/baseline.index.mjs

# Chart intermediates (PNGs are committed; HTML is regenerable)
bench/charts/*.html

# Rust cross-validation harness build artifacts
tests/rust-validation/target

# Lockfile: intentionally absent until @blockchaincommons/dcbor-pattern
# publishes the surface this package uses (`bool`, `notMatching`,
# `parsePatternPartial`, `tryParsePatternPartial`, `PatternPartial`). Every
# other dependency is on npm, but the registry still serves dcbor-pattern
# 1.0.0-beta.1 without those, so a lockfile resolved from the registry gives
# a red CI; a local install resolves that dependency through the workspace
# link, which would bake an unpublishable path into the lockfile. Once
# dcbor-pattern publishes, raise its range here, commit a real lockfile and
# switch the workflows to `bun install --frozen-lockfile`.
bun.lock
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ We love your input! We want to make contributing to this project as easy and tra
## We Develop with Github
We use GitHub to host code, to track issues and feature requests, and to accept Pull Requests.

## Report Bugs using Github's [issues](https://github.com/briandk/transcriptase-atom/issues)
## Report Bugs using Github's [issues](https://github.com/BlockchainCommons/bc-denvelope-pattern-ts/issues)

If you find bugs, mistakes, or inconsistencies in this project's code or documents, please let us know by [opening a new issue](./issues), but consider searching through existing issues first to check and see if the problem has already been reported. If it has, it never hurts to add a quick "+1" or "I have this problem too". This helps prioritize the most common problems and requests.

Expand Down
39 changes: 0 additions & 39 deletions MIGRATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,42 +163,3 @@ thin re-export of this package, so nothing breaks the moment you update.
+ "@blockchaincommons/envelope-pattern": "^1.0.0-beta.1"
}
```

### 2. Version numbering restarts

`@bcts/envelope-pattern` versions moved in lockstep with every other package in the
monorepo, which is why it reached `1.0.0-beta.6`. Each extracted package now
versions independently and starts again at `1.0.0-beta.1`. A lower version
number here does **not** mean older code.

### 3. Node and TypeScript floors moved up

| | `@bcts/envelope-pattern` | `@blockchaincommons/envelope-pattern` |
| ---------------------- | ------------------------ | ------------------------------------- |
| Node | `>= 18` | `>= 22.12` |
| TypeScript (consumers) | 6.x | `>= 5.7` |

### 4. The IIFE / global-script build is gone

`@bcts/envelope-pattern` shipped an additional IIFE bundle exposed through the `browser`
field. That build is dropped: IIFE entry points cannot share chunks, which forks
module-level singletons across entry points. Use the ESM entry (`import`) or the
CJS entry (`require`); both are declared in `exports` and validated in CI by
`publint` and `@arethetypeswrong/cli`.

### 5. Peer packages renamed too

Every sibling library moved from the `@bcts` scope to `@blockchaincommons`. If
you depend on more than one, rename them together so a single copy of each
shared type is resolved:

| Old | New |
| -------------- | --------------------------- |
| `@bcts/dcbor` | `@blockchaincommons/dcbor` |
| `@bcts/<name>` | `@blockchaincommons/<name>` |

### 6. What did not change

- The public API: every exported name, signature and type is identical.
- The wire format. Encodings produced by `@bcts/envelope-pattern` decode here, and the reverse.
- Parity with the Rust reference implementation. See [`RUST_DIVERGENCES.md`](./RUST_DIVERGENCES.md).
Loading