feat(archive-reader): expose the scheme a value announces by its syntax - #331
Merged
Conversation
Resolution gives an untyped identifier a scheme from its own syntax — an absolute link is a `URL`, a Bookland number an `ISBN`, another barcode a `GTIN`. That belief was private to the OPF resolver. A consumer holding the container itself has to share it: an untyped `<dc:identifier>` holding a Bookland number is an `ISBN` in `identifiers`, so a writer reading it as untagged builds a second element beside the one the reader reported rather than editing it. Moved to `utils/inferIdentifierScheme.ts` and exported, alongside the scheme vocabulary the same consumers already read from here. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: c0c82c6986
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
…ring Inference only ever answers with four of the known schemes, but the public declaration said `string` — so a caller could not assign the result to a scheme field and got no exhaustive narrowing from it. `InferredIdentifierScheme` names those four, drawn out of `KnownMetadataIdentifierScheme` with `Extract` rather than restated, so renaming one there fails to compile here. Caught by Codex on the first version of this export. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Resolution gives an identifier that announces no scheme one from its own syntax — an absolute http(s) link is a
URL, a Bookland number anISBN, another well-formed barcode aGTIN, anything elseUnknown. That belief was private tometadata/opf/resolve.ts.A consumer holding the package document itself needs the same reading, for the same reason it needs the scheme attributes and the ONIX crosswalk from #329 and #330. Concretely, in oboku's OPF writer:
identifiersreports that as{ value: "9783161484100", scheme: "ISBN" }. The writer, reading the element as untagged, does not match it against the patch'sISBNentry — so it builds a replacement and deletes the original, losing itsidand the refinement pointing at it. Verified against that exact document.What changed
inferredIdentifierSchememoves fromresolve.tstoutils/inferIdentifierScheme.tsasinferIdentifierScheme, and is exported.resolve.tsimports it; its behaviour is unchanged.Read-side vocabulary, like the others — nothing about writing is exported.
Testing
urn:isbn:-prefixed), non-Bookland barcodes asGTIN, and everything else asUnknownidentifiersDocs
gitbook/archive-reader/identifiers.mdgains it next to the two vocabularies from #330, with the reason a container editor needs it.🤖 Generated with Claude Code