@flaks/onerecord 0.1.2

package/CHANGELOG.md

@@ -0,0 +1,305 @@
+# Changelog
+
+All notable changes are documented here. Format follows
+[Keep a Changelog](https://keepachangelog.com/), versioning follows
+[SemVer](https://semver.org/) per the policy in `MIGRATING.md`.
+
+## [0.1.1] - 2026-04-27 (install fix + open-sourcing pass)
+
+First public release. v0.1.0 was tagged but unconsumable via git URL
+(see "Critical install fix" below); v0.1.1 is the first version Tracks
+B and C should pin to.
+
+### Critical install fix
+
+- Add `prepare` lifecycle script to `package.json` so
+  `bun add git+https://github.com/tjo099/onerecord-mapper#v0.1.1`
+  builds `dist/` on install. v0.1.0 published `exports` pointing at
+  `./dist/...` but had no `prepare` script and `dist/` is gitignored,
+  so consumers got an unimportable package: "Cannot find module
+  '@flaks/onerecord'". The `prepare` script runs
+  `tsc -p tsconfig.build.json` at install time (Bun and npm both run
+  `prepare` for git-URL packages by default).
+
+  **Note for consumers with `ignore-scripts=true`** (security-hardened
+  npm/bun config): `prepare` will not run automatically. Either
+  temporarily allow scripts when installing this package, run
+  `bun run build` manually inside `node_modules/@flaks/onerecord/`
+  post-install, or wait for v0.2.0, which publishes `@flaks/onerecord`
+  to npm with prebuilt `dist/` in the registry tarball (no `prepare`
+  needed).
+
+### Release pipeline corrections
+
+- Remove the "Verify built dist matches committed dist" step from
+  `release.yml`. It was incompatible with `.gitignore` excluding
+  `dist/`; the gate would always fail on a real release run. Build
+  artefact integrity is now provided by the `prepare` script on
+  consumer machines and (in v0.2.0) by the npm registry tarball.
+- Disable (comment) the NE:ONE contract gate step in `release.yml`.
+  The `test/contract/docker-compose.neone.yml` file referenced by the
+  step does not exist; the contract test was deferred to v0.2 Phase 14
+  (Tasks 68-71). The step is restored when Phase 14 lands.
+
+### Open-sourcing pass — completed
+
+- Maintainer GPG signing key generated: `ed25519/55BABA8EED158AD1`
+  (fingerprint `8033 2600 17B9 BAE5 BAD9 CA15 55BA BA8E ED15 8AD1`),
+  UID `tjo099 <tjo099@gmail.com>`, expires 2028-04-26. Public key
+  served at `https://github.com/tjo099.gpg`.
+- Local git config: `commit.gpgsign=true`, `tag.gpgsign=true`,
+  `user.signingkey` set globally. Signing verified end-to-end via
+  `gpg --clearsign` and via signed commits landing on `main`.
+- `MAINTAINER_GPG_PUBLIC_KEY` repository secret set on
+  `tjo099/onerecord-mapper` with the ASCII-armored public key.
+- `release.yml` imports the maintainer GPG public key from
+  `secrets.MAINTAINER_GPG_PUBLIC_KEY` before the `git tag -v`
+  verification gate. Closes the cold-runner failure mode flagged in
+  v0.1.0 "Known gaps" item #2.
+- `SECURITY.md`: GPG fingerprint placeholder filled with the real
+  fingerprint and updated to point at `https://github.com/tjo099.gpg`
+  as the canonical public-key source. Placeholder `security@flaks.io`
+  (no MX record) replaced with GitHub Private Vulnerability Reporting
+  URL. Closes v0.1.0 "Known gaps" item #5.
+- Public-OSS hygiene scaffolding added: `CONTRIBUTING.md`,
+  `CODE_OF_CONDUCT.md` (adopts Contributor Covenant 2.1 by reference),
+  `.github/ISSUE_TEMPLATE/{bug_report,feature_request,config}`,
+  `.github/PULL_REQUEST_TEMPLATE.md`, `.github/CODEOWNERS`.
+- README + MIGRATING rewritten for public consumers (drop "internal
+  use only" framing, drop `GITHUB_TOKEN` requirement). Added "Why use
+  this library?" section.
+- New `docs/spec-deviations.md`: consumer-focused documentation of
+  five deliberate divergences from canonical IATA OneRecord behavior
+  in v0.1.x. Source of truth for deviations.
+- Repository visibility flipped PRIVATE → PUBLIC. First signed commits
+  landed on `main` and verified by GitHub.
+
+### Carry-forward to v0.2.0
+
+- npm publish workflow for `@flaks/onerecord` as a public scoped
+  package — removes the `prepare`-script dependency on consumer
+  toolchain and closes the `ignore-scripts=true` fragility.
+- Maintainer must back up the auto-generated revocation certificate at
+  `~/.gnupg/openpgp-revocs.d/8033260017B9BAE5BAD9CA1555BABA8EED158AD1.rev`
+  to offline storage (user-action; not code-shippable).
+
+## [0.2.0] - planned (open-sourcing pass + ecosystem hardening)
+
+Internal consumption from Tracks B+C plus selective external publication. Goal:
+make the mapper safe to flip the repo public and accept community contributions
+without retroactive scrubbing.
+
+### Open-sourcing prep
+
+- Re-enable commit signing (GPG or SSH) — `git config commit.gpgsign true` +
+  `tag.gpgsign true`. All v0.1.x commits remain unsigned; v0.2 commits will be
+  signed.
+- Wire `gpg --import` step into `release.yml` before the `git tag -v`
+  verification gate. Public key sourced from `secrets.MAINTAINER_GPG_PUBLIC_KEY`.
+- Replace `security@flaks.io` placeholder in `SECURITY.md` with either a
+  maintained address or the GitHub Private Vulnerability Reporting URL.
+- Flip GitHub repo from private to public.
+- npm publish workflow (`@flaks/onerecord` scoped public) — alternative to
+  git-URL distribution.
+
+### Phase 14 — NE:ONE Docker contract test (deferred from v0.1)
+
+- Tasks 68-71: docker-compose for NE:ONE Server reference impl, contract test
+  against a running server (`bun run test:contract`), nightly CI job, release
+  gate exercises the contract test before tagging.
+
+### Ecosystem hardening
+
+- Property-based round-trip tests extended beyond Waybill (Shipment, Piece,
+  Address, Party, ...) — same pattern as `test/property/waybill-roundtrip.property.test.ts`.
+- SBOM via `syft` + SLSA provenance docs (T70).
+- Bundle-size assertion in `release.yml` — keeps tree-shake claims honest
+  (T82 step 4b).
+
+### API additions under consideration
+
+- Graph-walk validation: emit `duplicate_id_in_graph`, `missing_id`,
+  `wrong_type_for_endpoint`, `missing_type` from a higher-level dispatch
+  layer (currently these kinds exist in the union but no per-class deserializer
+  emits them).
+- Reconcile `acceptBookingOption` divergence — either implement the
+  spec §5.4 BookingOptionRequest intermediate, or formalize the v0.1
+  shortcut with a spec amendment PR to IATA.
+- Zod 4 migration if upstream stabilizes.
+
+### Plan deviations from v3 spec to revisit
+
+- Replace hand-pinned T37a fixture (`pinnedSha: manually-pinned-v0.1.0`) with
+  a real upstream xlsx SHA via `scripts/convert-iata-xlsx.ts --only fsu`.
+- Re-enable T48a Phase 9+ catalogue assertions: `forbidden-state-transition`,
+  `operation-field-not-allowed`, `prototype-key-injection` (the applyChange
+  variants), `change_partial_failure` in `zod-shape.test.ts`. Currently
+  placeholder-skipped.
+
+---
+
+## [0.1.0] - 2026-04-27 (internal-only)
+
+First minor release for internal consumption by Tracks B+C SaaS products. Not
+published to public npm; not flagged for external distribution. All open-source
+prep (commit signing, public repo flip, GPG release-tag verification) deferred
+to v0.2.
+
+### Library surface
+
+- 32 OneRecord cargo data model 3.2 classes with full round-trip codec, Zod schema,
+  JsonLd<T> brand, and snapshot test coverage:
+  - Ring 1: Waybill, Shipment, Piece
+  - Ring 2: Address, Person, Organization, Party, AccountNumber
+  - Ring 3: TransportMovement, LogisticsEvent, MovementTime, Location
+  - Ring 4: Subscription, SubscriptionRequest, Notification, ChangeRequest, Change,
+    Operation, AccessDelegation, AccessDelegationRequest, Verification (with
+    UnverifiedVerification brand per spec §3.1), VerificationRequest, ServerInformation
+  - Ring 5: HandlingService
+  - Booking: Booking, BookingRequest, BookingOption, BookingOptionRequest,
+    BookingPreferences, BookingSegment, BookingShipment, BookingTimes
+- `createMapper({ limits, iriStrategy, allowedSchemes })` — bound-methods factory
+  with deep-frozen options at creation time
+- `onerecord.{deserialize,serialize}.<Class>` — namespaced facade with no bound
+  state, suitable for one-off operations
+- `applyChange(codec, obj, change)` JSON-Patch-style mutation per spec §6.5 with
+  invalid_pointer for traversal failures
+- `validateOperation(op, allowedFields: ReadonlyArray<JsonPointer | RegExp>)` with
+  locked type per spec §13
+- Booking state machine: deep-frozen `STATE_DIAGRAM`, `canTransition` predicate,
+  typed transition wrappers (acceptBookingRequest, acceptBookingOption,
+  rejectBookingOption, revokeBookingOption)
+- 22-variant `ParseError` discriminated union including v3 `invalid_pointer` for
+  JSON-pointer traversal failures
+- `SerializationError` class with `code: 'invalid_application_object' |
+  'iri_construction_failed'`
+- `formatError(e)` + `redactError(e)` helpers — exhaustive switch over all 22
+  ParseError kinds
+- 26-code FSU event-code map per spec acceptance #2
+- Safety: pre-Zod sanity pass (depth/nodes/string/array/payload limits, prototype-
+  pollution defense, JS-level circular reference detection)
+- Branded `SafeIri` (https-only by default) + `safeIri()` Zod helper that lifts
+  IRI failures into kind: 'invalid_iri' before the generic zod_validation envelope
+- `Codec` subpath export `@flaks/onerecord/codecs` for tree-shake-optimized
+  consumers
+- Type-only barrel `@flaks/onerecord/types` for zero-runtime imports
+
+### Test coverage
+
+- 518 passing + 10 skipped = 528 total tests across 119 test files
+- Property-based round-trip tests via fast-check (Waybill — extensible to other classes)
+- Per-error-kind negative deserialize catalogue (15 files, manifest-verified via
+  PARSE_ERROR_KIND_TO_FILE rename map)
+- Class-completeness introspection (asserts all 32 classes have schema + tests +
+  snapshots)
+- Public API surface lock via snapshot test
+
+### Internal-only release notes
+
+- v0.1.0 ships as a private GitHub repo. Consumers (Tracks B+C) install via
+  `bun install git+https://github.com/tjo099/onerecord-mapper#v0.1.0` with
+  GitHub token auth.
+- Commit signing remains suspended; release.yml's signed-tag verification gate
+  is bypassed for v0.1.0. Both will be re-enabled before any public release.
+- `security@flaks.io` placeholder in SECURITY.md remains (no MX record); replace
+  before flipping the repo public.
+
+---
+
+## [Unreleased] (0.0.x prerelease scaffold — content promoted to [0.1.0] above)
+
+### Build / dev environment changes (vs locked plan)
+- Bun pin: `engines.bun` set to `1.3.x` (plan was `1.1.x`); CI `bun-version: '1.3.11'`. Reason: local toolchain is 1.3.11.
+- `xlsx` devDep pinned to `^0.18.5` (plan was `^0.20.0`). Reason: 0.20.x is SheetJS Pro CDN-only, not public npm.
+- `dependabot.yml` adds `ignore: [{ dependency-name: "*", update-types: ["version-update:semver-major"] }]` for both `github-actions` and `npm` ecosystems. Reason: locked plan pins specific majors (Biome 1.x, Vitest 2.x, fast-check 3.x, attw 0.16, types/node 20.x); without this rule Dependabot opens unwanted major-bump PRs every week. The first 5 such PRs (#1–#5) were closed manually.
+- GHA workflow YAML: quoted `${{ }}` template expressions inside flow-style `with: { ... }` mappings in `ci.yml` (line 54: `node-version`) and `release.yml` (line 48: `artifact-name`). Reason: YAML's flow-mapping tokenizer collides with the `${` + `{` of the template delimiter, causing both workflows to fail GHA validation in 0s. The locked plan's verbatim YAML was invalid.
+
+### Plan deviations
+- **v3 plan correction (Phase 5 Task 25 onwards)**: per-class `deserialize.ts`
+  runs `findFirstEmptyArray` BEFORE Zod (was post-Zod in the v3 template).
+  Reason: harness `emptyArrayField` invocation expects `cardinality_violation`
+  for `[]` injected into a single-IRI field whose schema is `safeIri().optional()`.
+  Post-Zod placement is unreachable because Zod emits `zod_validation` first.
+  Pre-Zod placement matches the spec's "reject empty arrays on the wire" intent
+  and works regardless of the field's declared schema type.
+- **T37a fixture hand-pinned**: `test/fixtures/iata/xfsu-status-codes.json` was
+  written directly from the v2 plan's authoritative 26-code listing rather than
+  being generated by `scripts/convert-iata-xlsx.ts --only fsu` (the xlsx-fetch
+  script — full implementation deferred to T77). The 26 codes match the IATA
+  Cargo XFSU-Status-Codes.xlsx working draft as of the v2 plan authoring date.
+  Field `pinnedSha` is set to the placeholder `manually-pinned-v0.1.0`; T77
+  will replace it with the upstream xlsx SHA.
+- **T48a manifest assertion**: v3 plan said `expect(fileSet.size).toBe(16)`. The
+  actual unique-file count from `PARSE_ERROR_KIND_TO_FILE` (in src/result.ts) is
+  15 — `cardinality.test.ts` and `empty-array-on-wire.test.ts` are different
+  files but only `cardinality.test.ts` is in the rename map (the empty-array
+  regression file is referenced by T48b prose, not by the manifest). Adjusted
+  the assertion to `toBe(15)`. The 16th file `empty-array-on-wire.test.ts`
+  exists in `test/deserialize-errors/` but is NOT in the manifest map (it's a
+  regression test for nested-empty-array detection per T48b).
+- **Phase 9+ catalogue stubs**: `forbidden-state-transition.test.ts`,
+  `operation-field-not-allowed.test.ts`, `prototype-key-injection.test.ts`
+  (for prototype_pollution_attempt + invalid_pointer kinds), and
+  `zod-shape.test.ts` (for change_partial_failure) contain `it.skip`
+  placeholders for assertions that require Phase 9-10 machinery (applyChange,
+  validateOperation, STATE_DIAGRAM). The manifest test still passes because
+  these files exist and the placeholder tests are skipped (vitest counts
+  skipped tests as neither passed nor failed).
+- **`missing_type`, `wrong_type_for_endpoint`, `missing_id`,
+  `duplicate_id_in_graph`, `mixed_context`**: per-class deserializers
+  currently don't emit these kinds (Zod fires first for shape errors;
+  graph-walk validation isn't implemented in v0.1.0). Their files exist
+  with `it.skip` placeholders documenting "reserved for higher-level
+  dispatch / facade" or similar. The kinds remain in the union for forward
+  compatibility. (Exception: `mixed_context` IS emitted by `assertContextAllowed`
+  for array `@context` with mixed allowed/unallowed members — its test file
+  uses a real assertion, not a skip.)
+- **T48a circular-reference test**: `circular_reference` kind is architecturally
+  unreachable via a simple self-referential object (`wb.self = wb`) because
+  `preValidate` step 2 (depth/node walk) recurses into the cycle and emits
+  `depth_limit_exceeded` before step 4 (`detectCycle`) runs. The test covers
+  both accepted kinds (`circular_reference` or `depth_limit_exceeded`) for the
+  self-referential case, and separately verifies that `detectCycle` correctly
+  accepts diamond (shared reference) patterns without false positive.
+- **Phase 9-12 dispatched in 4 parallel worktrees**: To maximise throughput,
+  Phase 9 (Tasks 49-53), Phase 10 (Tasks 54-63), Phase 11 (Task 64), and
+  Phase 12 (Tasks 65-66) were implemented by 4 isolated subagents with
+  `isolation: "worktree"`. Each agent committed to its own branch; Phase 9
+  and Phase 11 were based on current main (clean fast-forward merges).
+  Phase 10 and Phase 12 were based on the pre-Phase-4 main (stale worktree
+  init), so their branches were cherry-picked file-by-file rather than
+  merged: only the new `src/booking-flow/`, 8 booking class directories,
+  their tests/factories, plus the `synthetic-fwb-1.expected.json` fixture
+  and `synthetic-fwb.test.ts` integration test are taken. Phase 12's
+  worktree-local Waybill re-creation was discarded (main already has the
+  canonical Waybill from c8a7af0).
+- **`toPreValidateOpts` + `toContextOpts` helpers (Phase 10)**: Phase 10's
+  worktree introduced two helper functions in `src/classes/shared/parse-utils.ts`
+  that encapsulate the conditional-spread pattern for
+  `exactOptionalPropertyTypes`. Existing per-class deserialize.ts files
+  (Phases 5-8) inline the conditional-spread; new booking deserialize.ts
+  files (Phase 10) use the helpers. Both styles work — the helpers are
+  the recommended pattern for new code.
+- **`acceptBookingOption` deliberate divergence**: The typed transition
+  wrapper (`src/booking-flow/transitions.ts`) skips the
+  `BookingOptionRequest` intermediate state and returns a `Booking`
+  directly. This contradicts spec §5.4 STATE_DIAGRAM (which routes
+  `BookingOption.accept -> BookingOptionRequest`) but matches spec §5.2
+  signature. v0.1.0 ships this divergence; v0.2 will reconcile.
+
+### Known gaps to resolve before v0.1.0 release tag
+- Commit signing (`git commit -S`) currently suspended (Tasks 1–8 commits are unsigned). Re-enable: configure SSH or GPG signing key + `git config commit.gpgsign true` + `tag.gpgsign true`. `release.yml` signed-tag verify is the release gate.
+- `release.yml` step `Verify signed tag` (`git tag -v`) requires the maintainer GPG public key in the runner keyring. No `gpg --import` step is wired in yet — first release run will fail at tag verification on a cold runner. Add a `gpg --import` step that pulls the public key from a GitHub secret (`secrets.MAINTAINER_GPG_PUBLIC_KEY`) before `git tag -v`. Pair with the signing-key setup above.
+- Repository visibility: PRIVATE. Flip to PUBLIC before v0.1.0 tag for Bun git-URL install by consumers (Tracks B + C). Apache 2.0 + git-URL distribution model.
+- `SECURITY.md` "Supply chain" section currently flags signing as suspended; revert to unconditional once signing resumes. Same applies to the qualifier in the "Maintainer signing key" section.
+- `SECURITY.md` `security@flaks.io` disclosure address is a placeholder — the `flaks.io` domain has no verified MX record at scaffold time. Before flipping the repo public, replace with either a maintained address or a GitHub Private Vulnerability Reporting URL (`https://github.com/tjo099/onerecord-mapper/security/advisories/new`).
+
+### Feature changes
+(To be filled in during Phase 17.)
+
+---
+
+## Ontology version pins
+
+- Cargo data model: **3.2** (2025-07 endorsed standard)
+- API spec: **2.2.0**

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/MIGRATING.md

@@ -0,0 +1,43 @@
+# Migrating between versions
+
+This file documents one entry per minor release.
+
+## Migrating to v0.1.0
+
+v0.1.0 is the first minor release. There is no prior version to migrate from.
+
+### Install
+
+```bash
+bun add git+https://github.com/tjo099/onerecord-mapper#v0.1.0
+```
+
+Pin to a specific tag in production. A future v0.2.0 release will
+additionally publish to npm as the public scoped package
+`@flaks/onerecord`; installing via git URL works today.
+
+### Recommended import patterns
+
+Standard imports:
+
+```typescript
+import { WaybillCodec, createMapper } from '@flaks/onerecord'
+```
+
+Tree-shake-optimized:
+
+```typescript
+import { WaybillCodec } from '@flaks/onerecord/codecs'
+```
+
+Type-only (zero runtime):
+
+```typescript
+import type { Waybill, ParseError } from '@flaks/onerecord/types'
+```
+
+### v0.x → v0.x+1 stability
+
+Per `MIGRATING.md` policy: minor versions (0.1.x → 0.2.x) MAY introduce
+breaking changes documented in the CHANGELOG; patch versions (0.1.0 → 0.1.x)
+WILL NOT. Pin to a specific minor in CI.

package/NOTICE

@@ -0,0 +1,14 @@
+@flaks/onerecord
+Copyright 2026 tjo099 and @flaks/onerecord contributors
+
+This product implements the IATA OneRecord cargo data model v3.2 and
+ONE Record API specification v2.2.0. The OneRecord standards are
+published by IATA at https://github.com/IATA-Cargo/ONE-Record under
+their respective licenses. See https://iata-cargo.github.io/ONE-Record/
+for canonical documentation.
+
+Class names, IRI shapes, and ontology terms reproduced in source code
+are interface elements and not copyrighted material.
+
+Test fixtures derived from IATA-published xlsx mappings retain their
+upstream attribution; see test/fixtures/iata/README.md.