@ohos-ports/pb33f-openapi-changes 0.2.11-beta.0

package/LICENSE

@@ -0,0 +1,203 @@
+
+                                 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] [Princess Beef Heavy Industries, LLC]
+https://pb33f.io
+
+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/README.md

@@ -0,0 +1,274 @@
+![logo](openapi-changes-logo.webp)
+
+[![discord](https://img.shields.io/discord/923258363540815912)](https://discord.gg/x7VACVuEGP)
+[![GitHub downloads](https://img.shields.io/github/downloads/pb33f/openapi-changes/total?label=github%20downloads&style=flat-square)](https://github.com/pb33f/openapi-changes/releases)
+[![npm](https://img.shields.io/npm/dm/@pb33f/openapi-changes?style=flat-square&label=npm%20downloads)](https://www.npmjs.com/package/@pb33f/openapi-changes)
+[![Docker Pulls](https://img.shields.io/docker/pulls/pb33f/openapi-changes?style=flat-square)](https://hub.docker.com/r/pb33f/openapi-changes)
+
+# OpenAPI Changes
+
+## The world's **_most powerful and complete_** OpenAPI diff tool.
+
+`openapi-changes` lets you inspect what changed in an OpenAPI specification between two files,
+between git revisions of the same file, across local git history, or directly from a GitHub-hosted file URL.
+
+It can render the same semantic change model as:
+
+- an interactive terminal UI
+- a terminal summary
+- a machine-readable JSON report
+- a markdown report
+- a self-contained offline HTML report
+
+It works well for local exploration, CI/CD checks, release notes, and API review workflows.
+
+## How is it the 'most powerful and complete?'?
+
+openapi-changes gives you the power to view all changes between two OpenAPI contracts, and over time in every which
+way you can possibly think of. Graphs, trees, lists, diffs, JSON, mark down.
+
+Has no network dependencies at all. Runs 100% offline, including the HTML report.
+
+---
+
+## Install with Homebrew
+
+```bash
+brew install pb33f/taps/openapi-changes
+```
+
+## Install with npm or yarn
+
+```bash
+npm i -g @pb33f/openapi-changes
+```
+
+If you prefer yarn:
+
+```bash
+yarn global add @pb33f/openapi-changes
+```
+
+## Install with cURL
+
+```bash
+curl -fsSL https://pb33f.io/openapi-changes/install.sh | sh
+```
+
+## Install or run with Docker
+
+```bash
+docker pull pb33f/openapi-changes
+```
+
+Docker images are available for both `linux/amd64` and `linux/arm64`.
+
+The published image configures Git to trust mounted repositories, so local git-history commands work without requiring extra `safe.directory` setup inside the container.
+
+To run a command, mount the current working directory into the container:
+
+```bash
+docker run --rm -v $PWD:/work:rw pb33f/openapi-changes summary . sample-specs/petstorev3.json
+```
+
+To run the interactive `console` through Docker, allocate a TTY with `-it`:
+
+```bash
+docker run --rm -it -v $PWD:/work:rw pb33f/openapi-changes console . path/to/openapi.yaml
+```
+
+## Verify the install
+
+Print the installed version:
+
+```bash
+openapi-changes version
+```
+
+---
+
+### Summary view
+
+![](./.github/assets/summary.gif)
+
+
+### A full terminal UI
+
+Comes in multiple themes! PB33F (Dark), Roger Mode (Light) and Tektronix (Retro Dark)
+
+![](./.github/assets/console.gif)
+
+
+### Powerful HTML report with no rival.
+
+A self-contained, offline HTML report with interactive timeline, change explorer graph, diff views, and more.
+
+#### Timeline overview with change history chart
+
+![](./.github/assets/timeline-overview.png)
+
+#### Interactive explorer graph
+
+![](./.github/assets/timline-explorer.png)
+
+![](./.github/assets/explorer-deletion.png)
+
+#### Change report breakdown
+
+![](./.github/assets/change-report.png)
+
+![](./.github/assets/change-list.png)
+
+#### Side by side, focused, unified or inline diffing
+
+![](./.github/assets/file-diff.png)
+
+![](./.github/assets/focus-diff.png)
+
+#### Roger mode (monochrome light theme)
+
+![](./.github/assets/roger-mode-explorer.png)
+
+![](./.github/assets/roger-mode-items.png)
+
+#### Tektronix mode (green monochrome)
+
+![](./.github/assets/tektronix.png)
+
+---
+
+## Comparing git revisions
+
+Compare a file at different git revisions without checking out branches:
+
+```bash
+openapi-changes summary HEAD~1:openapi.yaml ./openapi.yaml
+openapi-changes html-report main:api/openapi.yaml feature-branch:api/openapi.yaml
+```
+
+The `revision:path` syntax works with any git ref -- branches, tags, `HEAD~N`, commit SHAs.
+The path is relative to the repository root. This works with all commands and supports
+multi-file specs with `$ref` references resolved from the same revision.
+
+---
+
+## Documentation
+
+### [Quick Start Guide 🚀](https://pb33f.io/openapi-changes/quickstart/)
+
+Full docs: https://pb33f.io/openapi-changes/
+
+- [Installing openapi-changes](https://pb33f.io/openapi-changes/installing/)
+- [Configuring breaking changes](https://pb33f.io/openapi-changes/configuring/)
+- [Command arguments](https://pb33f.io/openapi-changes/command-arguments/)
+- Commands:
+  - [`console`](https://pb33f.io/openapi-changes/console/)
+  - [`summary`](https://pb33f.io/openapi-changes/summary/)
+  - [`report`](https://pb33f.io/openapi-changes/report/)
+  - [`markdown-report`](https://pb33f.io/openapi-changes/markdown-report/)
+  - [`html-report`](https://pb33f.io/openapi-changes/html-report/)
+  - [`completion`](https://pb33f.io/openapi-changes/completion/)
+  - [`version`](https://pb33f.io/openapi-changes/version/)
+- [About openapi-changes](https://pb33f.io/openapi-changes/about/)
+
+---
+
+## Build from source
+
+`openapi-changes` currently requires Go `1.25.7+`.
+
+```bash
+git clone https://github.com/pb33f/openapi-changes.git
+cd openapi-changes
+go build -o bin/openapi-changes .
+```
+
+Or use `make`:
+
+```bash
+make
+```
+
+---
+
+## Command overview
+
+The current command surface is:
+
+- `console` for the interactive terminal UI
+- `summary` for fast terminal and CI output
+- `report` for machine-readable JSON
+- `markdown-report` for shareable markdown output
+- `html-report` for the interactive offline browser report
+- `completion` for shell completion scripts
+- `version` for raw build version output
+
+Run `openapi-changes --help` or `openapi-changes <command> --help` for the live CLI surface.
+
+### Terminal themes
+
+The terminal-facing commands support multiple presentation modes:
+
+- `--no-color` for the light Roger monochrome theme
+- `--roger-mode` as an alias for `--no-color`
+- `--tektronix` for the green monochrome terminal theme
+
+See the [command arguments docs](https://pb33f.io/openapi-changes/command-arguments/) for the full shared flag set.
+
+---
+
+## Custom breaking rules configuration
+
+`openapi-changes` supports configurable breaking-change rules via `changes-rules.yaml`.
+
+### Use an explicit config file
+
+```bash
+openapi-changes summary -c my-rules.yaml old.yaml new.yaml
+```
+
+### Or let it auto-discover the default config file
+
+```bash
+openapi-changes summary old.yaml new.yaml
+```
+
+Default lookup locations:
+
+1. `./changes-rules.yaml`
+2. `~/.config/changes-rules.yaml`
+
+### Example
+
+```yaml
+pathItem:
+  get:
+    removed: false
+  post:
+    removed: false
+  put:
+    removed: false
+  delete:
+    removed: false
+
+schema:
+  enum:
+    removed: false
+
+parameter:
+  required:
+    modified: false
+```
+
+Each rule supports:
+
+- `added`
+- `modified`
+- `removed`
+
+For the full rules reference and more examples, see the
+[configuration docs](https://pb33f.io/openapi-changes/configuring/).
+
+---
+
+See the full docs at https://pb33f.io/openapi-changes/

package/bin/openapi-changes.js

@@ -0,0 +1,16 @@
+#!/usr/bin/env node
+import { execFileSync } from "child_process";
+import path from "path";
+import { exit } from "process";
+import { fileURLToPath } from "url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+try {
+    execFileSync(path.resolve(`${__dirname}/openapi-changes`), process.argv.slice(2), {
+        stdio: "inherit",
+    });
+} catch (e) {
+    exit(1)
+}

package/npm-install/config.js

@@ -0,0 +1,15 @@
+export const CONFIG = {
+    name: "openapi-changes",
+    path: "./bin",
+    url: "https://github.com/pb33f/openapi-changes/releases/download/v{{version}}/{{bin_name}}_{{version}}_{{platform}}_{{arch}}.tar.gz",
+};
+export const ARCH_MAPPING = {
+    ia32: "i386",
+    x64: "x86_64",
+    arm64: "arm64",
+};
+export const PLATFORM_MAPPING = {
+    darwin: "darwin",
+    linux: "linux",
+    win32: "windows",
+};

package/npm-install/postinstall.js

@@ -0,0 +1,93 @@
+import { createWriteStream } from "fs";
+import * as fs from "fs/promises";
+import { pipeline } from "stream/promises";
+import { execSync } from "child_process";
+
+// Third-party dependencies (node-fetch, https-proxy-agent, tar) are loaded
+// dynamically below, only on platforms that actually download the binary.
+// This keeps the openharmony path working with zero npm dependencies,
+// since the openapi-changes binary is pre-bundled (locally compiled) there.
+
+// Get proxy URL from environment variables (standard convention)
+function getProxyUrl() {
+    return process.env.HTTPS_PROXY ||
+           process.env.https_proxy ||
+           process.env.HTTP_PROXY ||
+           process.env.http_proxy ||
+           null;
+}
+
+async function install() {
+    if (process.platform === "openharmony") {
+        console.log(
+            "openharmony platform detected: using pre-bundled locally compiled openapi-changes binary (no GitHub download).",
+        );
+        return;
+    }
+
+    const [
+        { default: fetch },
+        { HttpsProxyAgent },
+        tar,
+        { ARCH_MAPPING, CONFIG, PLATFORM_MAPPING },
+    ] = await Promise.all([
+        import("node-fetch"),
+        import("https-proxy-agent"),
+        import("tar"),
+        import("./config.js"),
+    ]);
+
+    if (process.platform === "android") {
+        console.log("Installing, may take a moment...");
+        const cmd =
+            "pkg upgrade && pkg install golang git -y && git clone https://github.com/pb33f/openapi-changes.git && cd cli/ && go build -o $PREFIX/bin/openapi-changes";
+        execSync(cmd, { encoding: "utf-8" });
+        console.log("Installation successful!");
+        return;
+    }
+    const packageJson = await fs.readFile("package.json").then(JSON.parse);
+    let version = packageJson.version;
+
+    if (typeof version !== "string") {
+        throw new Error("Missing version in package.json");
+    }
+
+    if (version[0] === "v") version = version.slice(1);
+
+    let { name: binName, path: binPath, url } = CONFIG;
+
+    url = url.replace(/{{arch}}/g, ARCH_MAPPING[process.arch]);
+    url = url.replace(/{{platform}}/g, PLATFORM_MAPPING[process.platform]);
+    url = url.replace(/{{version}}/g, version);
+    url = url.replace(/{{bin_name}}/g, binName);
+
+    // Configure fetch options with proxy support
+    const fetchOptions = {};
+    const proxyUrl = getProxyUrl();
+    if (proxyUrl) {
+        console.log('Using proxy:', proxyUrl);
+        fetchOptions.agent = new HttpsProxyAgent(proxyUrl);
+    }
+
+    console.log('fetching from URL', url)
+    const response = await fetch(url, fetchOptions);
+    if (!response.ok) {
+        throw new Error("Failed fetching the binary: " + response.statusText);
+    }
+
+    const tarFile = "downloaded.tar.gz";
+
+    await fs.mkdir(binPath, { recursive: true });
+    await pipeline(response.body, createWriteStream(tarFile));
+    await tar.x({ file: tarFile, cwd: binPath });
+    await fs.rm(tarFile);
+}
+
+install()
+    .then(async () => {
+        process.exit(0);
+    })
+    .catch(async (err) => {
+        console.error(err);
+        process.exit(1);
+    });

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@ohos-ports/pb33f-openapi-changes",
+  "version": "0.2.11-beta.0",
+  "description": "The world's sexiest and most detailed OpenAPI diff/changelog tool",
+  "type": "module",
+  "author": "Princess Beef Heavy Industries",
+  "license": "Apache-2.0",
+  "homepage": "https://pb33f.io/openapi-changes/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ohos-ports/ohos-ports.git",
+    "directory": "ports/pb33f-openapi-changes/0.2.11"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "scripts": {
+    "postinstall": "node ./npm-install/postinstall.js"
+  },
+  "bin": {
+    "openapi-changes": "bin/openapi-changes.js"
+  },
+  "files": [
+    "npm-install",
+    "bin"
+  ],
+  "dependencies": {
+    "https-proxy-agent": "^7.0.6",
+    "node-fetch": "^3.3.2",
+    "tar": "^7.5.11"
+  },
+  "bugs": {
+    "url": "https://github.com/ohos-ports/ohos-ports/issues"
+  },
+  "main": "index.js"
+}