@osdlc/markdown-link 0.0.0-stage → 0.5.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @osdlc/markdown-link
+
+## 0.5.0
+
+### Minor Changes
+
+- 5aecf76: First release. The TypeScript twin of the parsing half of the Rust `markdown-link` crate, with no dependencies: `stripCode` and `stripCodeWith`, the code lexer under CommonMark and skill-export rules; `parseInner` and `targetRange` for one wikilink body; `isVaultLinkUrl` and `mdLinkTarget` for markdown link URLs; `bodyLinksSpanned` and `bodyLinks`, which find every wikilink, embed and relative markdown link in a body, each with its `alias`; `displayText`, which shows each link as a reader sees it; `parseTypedRef` for a whole `[[type/slug|Alias]]` value; and `ATTACHMENT_EXTENSIONS`. Spans and ranges are UTF-16 offsets. Its tests read the crate's `tests/fixtures/conformance.json`, so the two agree on every case in it.

package/CONTRIBUTING.md

@@ -0,0 +1,64 @@
+# Contributing
+
+Thanks for your interest in `@osdlc/markdown-link`.
+
+## Issues
+
+Report bugs and ask for features in the
+[issue tracker](https://github.com/osdlc/osdlc/issues). For a bug, include the
+library version, your runtime and its version, and the note text that
+misbehaves. Report security problems privately. See
+[SECURITY.md](./SECURITY.md).
+
+## Pull requests
+
+This package lives in [osdlc/osdlc](https://github.com/osdlc/osdlc) under
+`packages/ts/markdown-link`. Open pull requests there. They are reviewed and
+merged there.
+
+## Running the tests
+
+The repository is a pnpm workspace. Install from the repository root, then
+work in the package directory. The tests run on [Vitest](https://vitest.dev)
+under Node 22.12 or later.
+
+```sh
+pnpm install
+cd packages/ts/markdown-link
+pnpm test
+```
+
+`pnpm run coverage` reports test coverage. It sets no threshold.
+
+`pnpm run build` compiles the package to `dist/`. `pnpm run smoke` runs
+`tests/smoke.mjs`, a short check of the built package under Node. Build first.
+It is not published.
+
+Other checks:
+
+```sh
+pnpm run typecheck
+pnpm run lint
+pnpm run format:check
+```
+
+## The case file
+
+`packages/rust/markdown-link/tests/fixtures/conformance.json` is read by this
+package's `tests/conformance.test.ts` and by the Rust crate's
+`tests/conformance.rs`. A new case goes into that file, so both suites cover
+it. A change to the parsing behaviour lands in both packages in one pull
+request.
+
+## Code style
+
+- TypeScript, ES modules, and explicit `.ts` import paths.
+- Prettier formats the code and oxlint checks it. Run `pnpm run format` and
+  `pnpm run lint` before you commit.
+- Add a test for each behaviour change or bug fix.
+- A new export gets TSDoc, a use in `examples/`, which imports the package by
+  name, and a mention in the README.
+- For a change users can see, add a changeset: run `pnpm changeset` at the
+  repository root. Start a breaking change's summary with `**Breaking:**`.
+  Do not edit `CHANGELOG.md` or `version` by hand. The release writes them.
+  See [packages/README.md](https://github.com/osdlc/osdlc/blob/main/packages/README.md).

package/LICENSE-APACHE

@@ -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 2026 Sizer LLC
+
+   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/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 sksizer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,114 @@
-# Temporary Holding Version
+# @osdlc/markdown-link
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Wikilink parsing that follows documented link-resolution conventions, with no dependencies. It is
+the TypeScript twin of the parsing half of the Rust
+[`markdown-link`](https://crates.io/crates/markdown-link) crate, which sits beside it in
+[`packages/rust/markdown-link`](https://github.com/osdlc/osdlc/tree/main/packages/rust/markdown-link).
+Each function gives the same answer as its Rust namesake.
+
+Resolution (`LinkIndex`) is not here yet.
+
+## Why
+
+Notes link to each other with `[[Note]]`, `[[Note#Heading|alias]]`,
+`![[image.png]]` and relative markdown links. A tool that builds a link graph,
+indexes a folder of notes or rewrites links on a rename must find every one of
+them, skip the ones inside code, and know exactly where each sits in the text.
+A regular expression gets code spans, escaped pipes and embed sizes wrong.
+
+This package finds them with the same rules as the Rust crate, so a TypeScript
+tool and a Rust tool that read the same notes agree on every link.
+
+## Who it is for
+
+Programs that read or change a folder of notes in TypeScript: link graph
+builders, search indexers, renderers, linters and rename tools.
+
+## When not to use it
+
+- You render markdown with remark or micromark and only want wikilinks turned
+  into links. A remark or micromark wikilink plugin fits the pipeline better.
+- You need a full markdown parser or an editor model. This package only finds
+  links and blanks code.
+- You need to resolve a link to a file. That is the Rust crate's `LinkIndex`,
+  which has no TypeScript twin yet.
+
+## How it compares
+
+- remark and micromark plugins, such as
+  [`@moritzrs/micromark-extension-ofm-wikilink`](https://www.npmjs.com/package/@moritzrs/micromark-extension-ofm-wikilink)
+  and
+  [`@sgawarat/remark-obsidian-wikilink`](https://www.npmjs.com/package/@sgawarat/remark-obsidian-wikilink),
+  parse wikilinks as part of a markdown syntax tree. They need the unified
+  toolchain, and they do not share a case file with a Rust implementation.
+- This package works on the plain text, with no dependencies. It returns spans
+  into the original string, so a caller can rewrite a link in place.
+- The same author's Rust [`markdown-link`](https://crates.io/crates/markdown-link)
+  crate is the reference. Use it from Rust; use this package from TypeScript.
+
+## Install
+
+```sh
+npm install @osdlc/markdown-link
+```
+
+`pnpm add @osdlc/markdown-link` and `yarn add @osdlc/markdown-link` work too.
+
+## Quick start
+
+```ts
+import { bodyLinksSpanned } from '@osdlc/markdown-link'
+
+bodyLinksSpanned('See [[Note#h|alias]] and `[[not a link]]`')
+// [{ kind: 'wikilink', raw: 'Note#h|alias', target: 'Note', alias: 'alias', start: 4, end: 20 }]
+```
+
+## Exports
+
+- Code: `stripCode` blanks fenced and inline code to spaces, keeping every
+  `\n` and the code point count, so links in code are not harvested.
+  `stripCodeWith(text, rules)` takes `'commonmark'` (the default) or
+  `'skill-export'`.
+- One link: `parseInner` splits a wikilink body into target, heading and
+  alias; `targetRange` is where the target sits in it.
+- Markdown link URLs: `isVaultLinkUrl` says whether a URL is a note or an
+  attachment; `mdLinkTarget` percent-decodes it and drops `.md`.
+- A body: `bodyLinksSpanned` finds every wikilink, embed and relative markdown
+  link, with its span; `bodyLinks` is the same scan without spans.
+- Display text: `displayText` replaces each wikilink and embed with what a
+  reader sees, its alias or else its target. An embed's `|300` or `|300x200`
+  is a size, not text, so `![[img.png|300]]` shows `img.png`.
+- Typed references: `parseTypedRef` reads a whole `[[type/slug]]` or
+  `[[type/slug|Alias]]` value into `{ kind, slug, alias }`, or `null`.
+- `ATTACHMENT_EXTENSIONS`: the extensions that count as vault attachments.
+
+Spans and ranges are UTF-16 offsets, so `body.slice(start, end)` is the link.
+The Rust crate reports byte offsets.
+
+## Twin
+
+The Rust crate `markdown-link` has the parsing functions above under their
+snake_case names. It also resolves links (`LinkIndex`), reads links in
+frontmatter and has smaller helpers, which this package does not have yet.
+Both suites read one case file,
+`packages/rust/markdown-link/tests/fixtures/conformance.json` in the
+repository, so they agree on every case in it.
+
+## Stability
+
+This is a 0.x package. Every export is stable in 0.x. No export is
+experimental, beta or alpha, and `tests/stability.test.ts` fails if one is
+tagged so. A breaking change comes only in a new minor version, and the
+CHANGELOG marks it.
+
+## Runtimes and platforms
+
+Node.js 22 or later, ESM only. The built package is tested on Node.js 22 and
+24. The code is ES2022 string handling plus `TextEncoder` and `TextDecoder`,
+with no imports and no DOM, but other runtimes, such as Bun, Deno or a
+browser, are not tested. It has no file system or platform code. Its tests run on Linux
+and macOS.
+
+## Licence
+
+`MIT OR Apache-2.0`, at your option. See [LICENSE-MIT](./LICENSE-MIT) and [LICENSE-APACHE](./LICENSE-APACHE).

package/SECURITY.md

@@ -0,0 +1,23 @@
+# Security policy
+
+## Reporting a vulnerability
+
+Please report vulnerabilities privately. Do not open a public issue.
+
+Use GitHub private vulnerability reporting on the repository: open the
+[Security tab](https://github.com/osdlc/osdlc/security) and choose
+"Report a vulnerability".
+
+Include the version, a short description, and steps to reproduce. A minimal
+code sample helps.
+
+## Supported versions
+
+Only the latest release gets security fixes. While the version is 0.x, that
+is the latest minor release. Upgrade to it.
+
+## What to expect
+
+This is a small project. We aim to reply within a week. We will tell you
+whether we accept the report and keep you updated until a fix is released.
+We will credit you in the release notes if you want that.

package/dist/body-links.d.ts

@@ -0,0 +1,64 @@
+/**
+ * The body link scanner: every link in a body, with its span. A port of the
+ * `markdown-link` crate's `body_links_spanned` and `body_links`.
+ */
+/** What syntax produced a `BodyLink`. */
+export type BodyLinkKind = 'wikilink' | 'embed' | 'markdown';
+/** One outgoing reference found in a body, with its span, before resolution. */
+export interface BodyLink {
+    kind: BodyLinkKind;
+    /**
+     * The reference as written between the delimiters, with any code inside it
+     * blanked to spaces.
+     */
+    raw: string;
+    /**
+     * What resolution runs against. A wikilink's `raw` minus `#heading` /
+     * `^block` / `|alias` and the `\` escaping the pipe; a markdown link's URL
+     * percent-decoded and minus a trailing `.md`.
+     */
+    target: string;
+    /**
+     * A wikilink's or embed's `|alias`: the text after the first `|` outside
+     * code, read from the body so code inside it is kept. `null` when there is
+     * none or it is empty, and for a markdown link.
+     */
+    alias: string | null;
+    /**
+     * UTF-16 offsets of the whole link syntax within the body, so
+     * `body.slice(start, end)` is the link. The Rust crate reports byte offsets.
+     * An embed's `!` is inside the span.
+     */
+    start: number;
+    end: number;
+}
+/** What kind of reference produced a `RawLink`. */
+export type LinkKind = 'wikilink' | 'embed';
+/** A body reference without its span. */
+export interface RawLink {
+    /**
+     * What resolution runs against. A wikilink's text minus `#heading`, `|alias`
+     * and the `\` escaping the pipe; a markdown link's URL percent-decoded and
+     * minus a trailing `.md`.
+     */
+    target: string;
+    kind: LinkKind;
+}
+/**
+ * Every wikilink, embed and relative markdown link in a note body, in the
+ * order they appear. `bodyLinksSpanned` without the spans, so the two cannot
+ * disagree. A markdown link is reported as `'wikilink'`.
+ */
+export declare function bodyLinks(body: string): RawLink[];
+/**
+ * Every wikilink, embed and relative markdown link in a body, in encounter
+ * order, with spans.
+ *
+ * Code is blanked before matching, `[[` never nests, and a markdown link
+ * counts only when `isVaultLinkUrl` accepts its URL and it carries no scheme.
+ *
+ * The scan walks code points. `stripCode` keeps the code point count of its
+ * input, not its UTF-16 length, so a code point index into the stripped text
+ * is one into the body, and a table converts it to a UTF-16 offset.
+ */
+export declare function bodyLinksSpanned(body: string): BodyLink[];