adf-bridge 0.1.0__tar.gz

adf_bridge-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Contributing
+
+Use Python 3.11+ and uv. Keep changes focused on the documented v0.1 profile;
+do not add a profile registry, network integration, or public ADF model layer.
+
+```sh
+uv sync --all-groups
+make check-ci
+```
+
+Before changing the bundled schema, update it and `schema-provenance.json`
+together, retain the Atlassian notice, verify its SHA-256 and local-only
+references, and review resulting validation/profile changes.

adf_bridge-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 adf-bridge contributors
+
+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.

adf_bridge-0.1.0/MANIFEST.in

@@ -0,0 +1,6 @@
+include LICENSE
+include THIRD_PARTY_NOTICES.md
+include CONTRIBUTING.md
+recursive-include docs *.md
+recursive-include src/adf_bridge/data *.json *.md
+include src/adf_bridge/py.typed

adf_bridge-0.1.0/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: adf-bridge
+Version: 0.1.0
+Summary: Focused, pure-Python conversion between Markdown and Jira ADF
+Author: adf-bridge contributors
+License-Expression: MIT
+Project-URL: Documentation, https://github.com/en-ver/adf-bridge#readme
+Project-URL: Repository, https://github.com/en-ver/adf-bridge
+Project-URL: Issues, https://github.com/en-ver/adf-bridge/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Text Processing :: Markup
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: THIRD_PARTY_NOTICES.md
+Requires-Dist: fastjsonschema<2.23,>=2.22.2
+Requires-Dist: mistune<3.4,>=3.3.4
+Dynamic: license-file
+
+# adf-bridge
+
+`adf-bridge` is a small, pure-Python bridge between portable GFM Markdown and
+a focused Jira-oriented subset of Atlassian Document Format (ADF). It returns
+ordinary JSON-compatible dictionaries rather than model classes.
+
+```python
+from adf_bridge import adf_to_markdown, markdown_to_adf
+
+created = markdown_to_adf("Hello [~accountId:557057:User-AbC]")
+assert created.value["type"] == "doc"
+assert adf_to_markdown(created.value).value == "Hello [~accountId:557057:User-AbC]"
+```
+
+## API and behavior
+
+- `markdown_image_urls(markdown, *, strict=False) -> ConversionResult[tuple[str, ...]]`
+- `markdown_to_adf(markdown, *, strict=False, resolved_images=()) -> ConversionResult[AdfDocument]`
+- `adf_to_markdown(document, *, strict=False) -> ConversionResult[str]`
+- `validate_adf(document) -> None`
+- `verify_jira_media_readback(submitted, persisted, *, resolved_images) -> None`
+
+A `ConversionResult` holds `value` and an ordered tuple of structured
+`Diagnostic` values. `strict=True` converts any readable-degradation warning
+into `LossyConversionError` after conversion completes. Invalid ADF, unknown
+constructs, and out-of-profile features always raise project-owned errors.
+
+Blank CommonMark Markdown becomes the canonical sole empty root paragraph.
+Empty ADF documents also render as an empty string. GFM output is canonicalized
+and has no terminal newline; exact source spelling is not round-tripped.
+
+## v0.1 profile
+
+Direct support covers paragraphs, headings, blockquotes, lists, code blocks,
+hard breaks, rules, tables, text, strong/emphasis/strike/code/link marks, and
+canonical Jira account-ID mentions. Mention IDs remain opaque; `&`, `<`, and
+`>` are source-encoded safely. Adjacent marked text uses a local mark stack, so
+shared presentation marks stay open across supported overlaps. Basic table-cell
+paragraphs and hard breaks are flattened through exact lowercase `<br>` with one
+warning per affected cell. Dates, emoji, inline cards, status, expand/panel, and
+unmarked media have readable warning-producing fallbacks. Inline-code line
+endings normalize to spaces with a diagnostic; code-block text canonicalizes to
+LF with one trailing newline when nonempty and warns only when that changes its
+semantic text.
+
+Link, image, and card labels entity-encode their nested literal syntax, so URL
+labels with Markdown punctuation round-trip without retained escape backslashes.
+Inside table cells, nested syntax-owned values including mention IDs and link
+titles entity-encode pipes before GFM table parsing. Form feed is entity-encoded
+losslessly. Bridge-generated direct link, card, and external-media destinations
+are opaque values: a reversible CommonMark entity encoding preserves their exact
+supported characters without URL normalization. Caller-authored Markdown
+autolinks and used reference links instead use CommonMark/Mistune URL
+normalization; their raw source spelling is not an opaque-destination
+preservation contract and produces no diagnostic. Ordinary and readable-fallback
+text containing U+0000 normalizes to U+FFFD with a warning; mention IDs
+containing U+0000 are rejected to preserve their opaque identity. Markdown
+consisting only of reference definitions produces no visible ADF content and
+warns with `markdown.reference_definitions_discarded`. Values containing a character that
+HTML5 character references cannot preserve (such as NUL) are fatal at the
+bridge-generated destination attribute. Presentation marks with an
+unrepresentable Unicode-whitespace boundary (such as VT or NEL) preserve their
+text but are discarded with a warning. Ordinary/root VT and NEL text remains
+exact; at list or table edges a reversible source entity is used when available,
+or `adf.boundary_whitespace_normalized` documents unavoidable loss. Empty link
+titles and titles containing control characters are intentionally omitted with
+an attribute-discard warning.
+
+Block alignment and indentation marks, and every mark on `media`,
+`mediaSingle`, or `mediaGroup`, are fatal because v0.1 has no unambiguous GFM
+placement for them. Linked inline code containing `[` or `]` is also fatal:
+Mistune/CommonMark cannot preserve those code-label characters exactly. A
+nonterminal heading hard break and an ordered list whose generated sequence
+exceeds nine-digit markers are rejected rather than silently changing block
+structure. Every break in a terminal paragraph or heading hard-break run is
+discarded with a warning because portable GFM has no semantic representation for
+it; table-cell breaks retain their `<br>` flattening policy. A heading's literal
+ATX closing-hash candidate is source-encoded to preserve trailing `#` text.
+Only the canonical sole root empty paragraph represents empty visible Markdown;
+other ordinary empty ADF paragraphs are fatal. The exact empty paragraph shapes
+produced by GFM empty list items and table cells render as canonical empty list
+markers and cells. Adjacent same-kind lists use equivalent alternating GFM
+markers to remain distinct. Empty Markdown link labels, linked images, images
+in headings or table cells, and unsupported table-cell shapes are rejected
+rather than silently dropped.
+
+See the [support matrix](https://github.com/en-ver/adf-bridge/blob/main/docs/support-matrix.md)
+and [diagnostics guide](https://github.com/en-ver/adf-bridge/blob/main/docs/diagnostics.md)
+for details. `markdown_image_urls()` uses the same focused parser as conversion
+and returns supported image destinations in source order. Callers can supply
+immutable `ResolvedJiraImage(source_url, media_id, collection)` values to convert
+exact matching image URLs into Jira `file` media; unmapped URLs remain external.
+Mappings are data only: invalid, unused, duplicate-source, or duplicate Jira
+media-identity (`media_id`, `collection`) entries fail, and no URL normalization
+or Jira enrichment is performed. Markdown owns alt text for every occurrence.
+Managed media cannot render back to its original attachment-content URL.
+`verify_jira_media_readback()` narrowly checks persisted managed media at the same
+ADF paths, permitting only known Jira local IDs, sizing, occurrence keys, and
+nonnegative media dimensions. This package does not perform Jira lookups, network
+operations, CLI work, or plugin registration.
+
+## Schema and licenses
+
+The wheel bundles the exact unmodified `@atlaskit/adf-schema` 57.3.4 full JSON
+Schema. It is checksum-verified, requires local-only `$ref` values, and is
+compiled once with defaults disabled using `fastjsonschema`. Project code is
+MIT licensed. The bundled Atlassian schema is Apache-2.0; its attribution and
+full license are in
+[THIRD_PARTY_NOTICES.md](https://github.com/en-ver/adf-bridge/blob/main/THIRD_PARTY_NOTICES.md).
+
+## Development
+
+Use [uv](https://docs.astral.sh/uv/):
+
+```sh
+uv sync --all-groups
+make check-ci
+```
+
+See [CONTRIBUTING.md](https://github.com/en-ver/adf-bridge/blob/main/CONTRIBUTING.md)
+for the focused validation commands.

adf_bridge-0.1.0/README.md

@@ -0,0 +1,121 @@
+# adf-bridge
+
+`adf-bridge` is a small, pure-Python bridge between portable GFM Markdown and
+a focused Jira-oriented subset of Atlassian Document Format (ADF). It returns
+ordinary JSON-compatible dictionaries rather than model classes.
+
+```python
+from adf_bridge import adf_to_markdown, markdown_to_adf
+
+created = markdown_to_adf("Hello [~accountId:557057:User-AbC]")
+assert created.value["type"] == "doc"
+assert adf_to_markdown(created.value).value == "Hello [~accountId:557057:User-AbC]"
+```
+
+## API and behavior
+
+- `markdown_image_urls(markdown, *, strict=False) -> ConversionResult[tuple[str, ...]]`
+- `markdown_to_adf(markdown, *, strict=False, resolved_images=()) -> ConversionResult[AdfDocument]`
+- `adf_to_markdown(document, *, strict=False) -> ConversionResult[str]`
+- `validate_adf(document) -> None`
+- `verify_jira_media_readback(submitted, persisted, *, resolved_images) -> None`
+
+A `ConversionResult` holds `value` and an ordered tuple of structured
+`Diagnostic` values. `strict=True` converts any readable-degradation warning
+into `LossyConversionError` after conversion completes. Invalid ADF, unknown
+constructs, and out-of-profile features always raise project-owned errors.
+
+Blank CommonMark Markdown becomes the canonical sole empty root paragraph.
+Empty ADF documents also render as an empty string. GFM output is canonicalized
+and has no terminal newline; exact source spelling is not round-tripped.
+
+## v0.1 profile
+
+Direct support covers paragraphs, headings, blockquotes, lists, code blocks,
+hard breaks, rules, tables, text, strong/emphasis/strike/code/link marks, and
+canonical Jira account-ID mentions. Mention IDs remain opaque; `&`, `<`, and
+`>` are source-encoded safely. Adjacent marked text uses a local mark stack, so
+shared presentation marks stay open across supported overlaps. Basic table-cell
+paragraphs and hard breaks are flattened through exact lowercase `<br>` with one
+warning per affected cell. Dates, emoji, inline cards, status, expand/panel, and
+unmarked media have readable warning-producing fallbacks. Inline-code line
+endings normalize to spaces with a diagnostic; code-block text canonicalizes to
+LF with one trailing newline when nonempty and warns only when that changes its
+semantic text.
+
+Link, image, and card labels entity-encode their nested literal syntax, so URL
+labels with Markdown punctuation round-trip without retained escape backslashes.
+Inside table cells, nested syntax-owned values including mention IDs and link
+titles entity-encode pipes before GFM table parsing. Form feed is entity-encoded
+losslessly. Bridge-generated direct link, card, and external-media destinations
+are opaque values: a reversible CommonMark entity encoding preserves their exact
+supported characters without URL normalization. Caller-authored Markdown
+autolinks and used reference links instead use CommonMark/Mistune URL
+normalization; their raw source spelling is not an opaque-destination
+preservation contract and produces no diagnostic. Ordinary and readable-fallback
+text containing U+0000 normalizes to U+FFFD with a warning; mention IDs
+containing U+0000 are rejected to preserve their opaque identity. Markdown
+consisting only of reference definitions produces no visible ADF content and
+warns with `markdown.reference_definitions_discarded`. Values containing a character that
+HTML5 character references cannot preserve (such as NUL) are fatal at the
+bridge-generated destination attribute. Presentation marks with an
+unrepresentable Unicode-whitespace boundary (such as VT or NEL) preserve their
+text but are discarded with a warning. Ordinary/root VT and NEL text remains
+exact; at list or table edges a reversible source entity is used when available,
+or `adf.boundary_whitespace_normalized` documents unavoidable loss. Empty link
+titles and titles containing control characters are intentionally omitted with
+an attribute-discard warning.
+
+Block alignment and indentation marks, and every mark on `media`,
+`mediaSingle`, or `mediaGroup`, are fatal because v0.1 has no unambiguous GFM
+placement for them. Linked inline code containing `[` or `]` is also fatal:
+Mistune/CommonMark cannot preserve those code-label characters exactly. A
+nonterminal heading hard break and an ordered list whose generated sequence
+exceeds nine-digit markers are rejected rather than silently changing block
+structure. Every break in a terminal paragraph or heading hard-break run is
+discarded with a warning because portable GFM has no semantic representation for
+it; table-cell breaks retain their `<br>` flattening policy. A heading's literal
+ATX closing-hash candidate is source-encoded to preserve trailing `#` text.
+Only the canonical sole root empty paragraph represents empty visible Markdown;
+other ordinary empty ADF paragraphs are fatal. The exact empty paragraph shapes
+produced by GFM empty list items and table cells render as canonical empty list
+markers and cells. Adjacent same-kind lists use equivalent alternating GFM
+markers to remain distinct. Empty Markdown link labels, linked images, images
+in headings or table cells, and unsupported table-cell shapes are rejected
+rather than silently dropped.
+
+See the [support matrix](https://github.com/en-ver/adf-bridge/blob/main/docs/support-matrix.md)
+and [diagnostics guide](https://github.com/en-ver/adf-bridge/blob/main/docs/diagnostics.md)
+for details. `markdown_image_urls()` uses the same focused parser as conversion
+and returns supported image destinations in source order. Callers can supply
+immutable `ResolvedJiraImage(source_url, media_id, collection)` values to convert
+exact matching image URLs into Jira `file` media; unmapped URLs remain external.
+Mappings are data only: invalid, unused, duplicate-source, or duplicate Jira
+media-identity (`media_id`, `collection`) entries fail, and no URL normalization
+or Jira enrichment is performed. Markdown owns alt text for every occurrence.
+Managed media cannot render back to its original attachment-content URL.
+`verify_jira_media_readback()` narrowly checks persisted managed media at the same
+ADF paths, permitting only known Jira local IDs, sizing, occurrence keys, and
+nonnegative media dimensions. This package does not perform Jira lookups, network
+operations, CLI work, or plugin registration.
+
+## Schema and licenses
+
+The wheel bundles the exact unmodified `@atlaskit/adf-schema` 57.3.4 full JSON
+Schema. It is checksum-verified, requires local-only `$ref` values, and is
+compiled once with defaults disabled using `fastjsonschema`. Project code is
+MIT licensed. The bundled Atlassian schema is Apache-2.0; its attribution and
+full license are in
+[THIRD_PARTY_NOTICES.md](https://github.com/en-ver/adf-bridge/blob/main/THIRD_PARTY_NOTICES.md).
+
+## Development
+
+Use [uv](https://docs.astral.sh/uv/):
+
+```sh
+uv sync --all-groups
+make check-ci
+```
+
+See [CONTRIBUTING.md](https://github.com/en-ver/adf-bridge/blob/main/CONTRIBUTING.md)
+for the focused validation commands.

adf_bridge-0.1.0/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,230 @@
+Third-party notices
+
+===================
+
+
+
+Atlassian Document Format schema
+
+--------------------------------
+
+Unmodified full schema from `@atlaskit/adf-schema` 57.3.4,
+`dist/json-schema/v1/full.json`.
+
+Copyright 2019 Atlassian Pty Ltd
+
+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.
+
+
+
+                                 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.

adf_bridge-0.1.0/docs/api.md

@@ -0,0 +1,55 @@
+# API
+
+```python
+from adf_bridge import (
+    ResolvedJiraImage,
+    adf_to_markdown,
+    markdown_image_urls,
+    markdown_to_adf,
+    validate_adf,
+    verify_jira_media_readback,
+)
+
+image_urls = markdown_image_urls("![diagram](https://jira.test/content/42)").value
+resolution = ResolvedJiraImage(image_urls[0], "media-id", "")
+result = markdown_to_adf("![diagram](https://jira.test/content/42)", resolved_images=(resolution,))
+validate_adf(result.value)
+verify_jira_media_readback(result.value, result.value, resolved_images=(resolution,))
+markdown = adf_to_markdown(result.value).value
+```
+
+`Diagnostic` has stable `code`, `severity`, `path`, `keyword`, and
+`schema_path` fields. Messages are explanatory rather than a text-stability
+contract. Schema failures raise `AdfValidationError`; package-resource or
+trusted-schema failures raise `AdfSchemaError`; profile failures raise
+`AdfConversionError`; strict loss raises `LossyConversionError`.
+
+Mentions map without lookup: `[~accountId:<id>]` becomes a `mention` node with
+only `attrs.id`, and renders back with the canonical `accountId` label. IDs are
+opaque and may contain `&`, `<`, `>`, and `|`; the renderer source-encodes those
+characters as needed (including `|` in table cells) and the parser decodes one
+complete entity-reference layer before validating the ID. IDs containing
+whitespace, backslashes, `]`, or U+0000 cannot be represented and fail;
+identity is never normalized.
+
+`markdown_image_urls()` performs the same parsing and profile validation as
+`markdown_to_adf()` and returns image destinations in source order, including
+repetitions and used reference images. It has the same diagnostics and strict-mode
+behavior. `resolved_images` is a keyword-only sequence of immutable
+`ResolvedJiraImage` values. Its source URLs match parser destinations exactly;
+`source_url` and `media_id` must be nonempty, while `collection` may be empty.
+Duplicate source URLs, duplicate Jira media identities (the same `media_id` and
+`collection`), and unused mappings raise `AdfConversionError`; a non-sequence,
+wrong item type, or wrong field type raises `TypeError`.
+A match produces a `mediaSingle` containing `file` media with only its resolved
+ID, collection, and that Markdown occurrence's nonempty alt text. The bridge does
+not look up URLs or add Jira presentation attributes.
+
+`verify_jira_media_readback()` schema-validates submitted and persisted documents
+then compares only resolved file-media occurrences. It requires the same paths,
+identity, layout, and alt text, rejects extra occurrences and structural changes,
+and permits only Jira local IDs, a complete sizing pair, occurrence keys, and
+nonnegative media dimensions. Resolution mappings must have unique source URLs
+and Jira media identities; invalid mappings raise `AdfConversionError`. Otherwise,
+it raises `JiraMediaVerificationError` with the first failing RFC 6901 path. This
+is persistence verification, not a rendering or whole-document equality assertion.