@apiboost/omnispec 1.0.0

package/LICENSE.md

@@ -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/README.md

@@ -0,0 +1,166 @@
+# @apiboost/omnispec
+
+[![npm](https://img.shields.io/npm/v/@apiboost/omnispec)](https://www.npmjs.com/package/@apiboost/omnispec)
+[![CI](https://github.com/apiboost/omnispec/actions/workflows/ci.yml/badge.svg)](https://github.com/apiboost/omnispec/actions/workflows/ci.yml)
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](./LICENSE.md)
+[![Docs](https://img.shields.io/badge/docs-live-023E8A.svg)](https://apiboost.github.io/omnispec/)
+
+**Apiboost OmniSpec** is the open-source React renderer for **OpenAPI** and
+**AsyncAPI** documentation, with Try-It request execution, authentication,
+theming, code samples, an optional backend proxy, and a framework-agnostic Web
+Component.
+
+This is the **open-source core** (Apache-2.0). GraphQL, SOAP/WSDL, and gRPC
+renderers plus other premium features live in the commercial **Pro** edition. See [Free vs Pro](#free-vs-pro).
+
+📖 **[Full documentation & guides](https://apiboost.github.io/omnispec/)** · ▶️ **[Live demo](https://apiboost.github.io/omnispec/demo)**
+
+## Supported specifications
+
+| Spec | Component | Versions | Edition |
+|------|-----------|----------|---------|
+| OpenAPI / Swagger | `<OpenApiSpec>` | 2.0, 3.0.x, 3.1 | **Free** |
+| AsyncAPI | `<AsyncApiSpec>` | 2.x, 3.x | **Free** |
+| GraphQL | `<GraphqlSpec>` | SDL + Introspection | Pro |
+| SOAP / WSDL | `<SoapSpec>` | WSDL 1.1 | Pro |
+| gRPC / Protobuf | `<GrpcSpec>` | proto2, proto3 | Pro |
+
+A unified `<OmniSpecRenderer>` auto-detects the spec type and renders the correct
+viewer. With only the free package installed it renders OpenAPI and AsyncAPI; for
+other spec types it shows an upgrade prompt until
+[Pro](https://apiboost.com/omnispec?utm_source=omnispec&utm_medium=readme&utm_campaign=pro)
+is added.
+
+## Installation
+
+```bash
+npm install @apiboost/omnispec
+# or: pnpm add @apiboost/omnispec
+```
+
+Requires **React 18 or 19** (`react`, `react-dom`) as peer dependencies.
+Everything else, including `@emotion/css` for styling, is bundled, so there is
+nothing else to install. (If you use the backend proxy, also add `express` and
+`express-rate-limit`.)
+
+## Quick start
+
+```tsx
+import { OmniSpecRenderer } from '@apiboost/omnispec'
+
+function Docs() {
+  return (
+    <OmniSpecRenderer
+      spec="https://petstore3.swagger.io/api/v3/openapi.json"
+      theme={{ base: 'auto' }}
+    />
+  )
+}
+```
+
+`<OmniSpecRenderer>` auto-detects the spec type. You can also import a specific
+renderer or the Express proxy middleware directly:
+
+```tsx
+import { OpenApiSpec } from '@apiboost/omnispec/openapi'
+import { AsyncApiSpec } from '@apiboost/omnispec/asyncapi'
+import { createProxyRouter } from '@apiboost/omnispec/server'
+```
+
+See the [Getting Started guide](https://apiboost.github.io/omnispec/docs/getting-started)
+for framework setup (Vite, Next.js, Web Component, SSR) and every configuration option.
+
+## Features
+
+- **OpenAPI (2.0 / 3.0 / 3.1) and AsyncAPI (2 / 3)** rendering, YAML or JSON, auto-detected
+- **Try-It**: send requests directly from the browser or through an optional backend proxy
+- **Authentication**: API key, Basic, Bearer, and OAuth 2.0 flow details with manual token entry
+- **Code samples** in 6 languages
+- **Vendor extensions**: `x-logo`, `x-badges`, `x-codeSamples`, `x-tagGroups`, `x-displayName`, `x-internal`, `x-enumDescriptions`
+- **Light / dark / auto themes** with 80+ customizable `--omnispec-*` CSS design tokens
+- **Configurable layouts**: sidebar (left/right), stacked, and docked or inline Try-It
+- **Sidebar navigation, slots, and display modes** for embedding in your own portal
+- **Framework-agnostic Web Component** (`<omnispec-renderer>`) for Vue, Angular, Svelte, or vanilla HTML
+- **Zero Node.js dependencies** in the browser (no polyfills needed)
+
+Full prop and configuration reference:
+[API Reference](https://apiboost.github.io/omnispec/docs/api-reference) ·
+[Configuration](https://apiboost.github.io/omnispec/docs/configuration) ·
+[Theming](https://apiboost.github.io/omnispec/docs/theming).
+
+> **Pro** adds GraphQL, SOAP/WSDL, and gRPC renderers; full white-label theming
+> (`theme.overrides` across 80+ tokens); the `table`/`card` schema styles; and the
+> interactive OAuth 2.0 Authorization Code + PKCE "Get Token" flow with OpenID
+> Connect discovery. See [Free vs Pro](#free-vs-pro).
+
+## Web Component
+
+A framework-agnostic Web Component (`<omnispec-renderer>`) ships in the same
+package. It mounts the React renderer internally and isolates styles in an open
+shadow root, so it works in Vue, Angular, Svelte, or vanilla HTML. Zero-build
+usage:
+
+```html
+<script src="https://unpkg.com/@apiboost/omnispec@latest/dist/wc/standalone.js"></script>
+<omnispec-renderer
+  spec-url="https://petstore3.swagger.io/api/v3/openapi.json"
+  theme-base="auto"
+></omnispec-renderer>
+```
+
+See the [Web Component guide](https://apiboost.github.io/omnispec/docs/web-component)
+for the full attribute/property/event API and framework recipes.
+
+## Documentation
+
+Everything is at **[apiboost.github.io/omnispec](https://apiboost.github.io/omnispec/)**:
+
+- [Getting Started](https://apiboost.github.io/omnispec/docs/getting-started): install, quick start, framework setup
+- [Configuration](https://apiboost.github.io/omnispec/docs/configuration): layouts, Try-It modes, slots, callbacks
+- [Theming](https://apiboost.github.io/omnispec/docs/theming): design tokens and custom themes
+- [API Reference](https://apiboost.github.io/omnispec/docs/api-reference): props for every component
+- [Backend Integration](https://apiboost.github.io/omnispec/docs/backend-integration): proxy setup, serving specs
+- [Try-It](https://apiboost.github.io/omnispec/docs/try-it): direct vs proxy mode, endpoint contract
+- [Web Component](https://apiboost.github.io/omnispec/docs/web-component): Web Component API and framework recipes
+- [Troubleshooting](https://apiboost.github.io/omnispec/docs/troubleshooting): common issues and FAQ
+
+## Free vs Pro
+
+`@apiboost/omnispec` (this package) is the fully functional, Apache-2.0
+open-source core. Apiboost also offers a commercial **Pro** edition that builds
+on this core and adds:
+
+- **GraphQL, SOAP/WSDL, and gRPC** renderers
+- **Full white-label theming** (`theme.overrides`, 80+ tokens) and the `table`/`card` schema styles
+- **Interactive OAuth 2.0** (Authorization Code + PKCE "Get Token") and **OpenID Connect** discovery
+
+The documentation vendor extensions (`x-logo`, `x-badges`, `x-codeSamples`,
+`x-tagGroups`, `x-displayName`, `x-internal`, `x-enumDescriptions`) are supported
+in the **free** core.
+
+Using the open-source core never requires Pro. See [LICENSING.md](./LICENSING.md)
+and [apiboost.com/omnispec](https://apiboost.com/omnispec?utm_source=omnispec&utm_medium=readme&utm_campaign=pro).
+
+## Development
+
+Requires Node.js (see [`.nvmrc`](./.nvmrc)) and pnpm.
+
+```bash
+pnpm install
+pnpm run dev          # Storybook at http://localhost:6006
+pnpm run test
+pnpm run build
+pnpm run lint
+pnpm run typecheck
+```
+
+Contributions are welcome under the Apache License 2.0 with a Developer
+Certificate of Origin sign-off (`git commit -s`). See
+[CONTRIBUTING.md](./CONTRIBUTING.md).
+
+## License
+
+Apache License 2.0. See [LICENSE.md](./LICENSE.md) for the full text and
+[LICENSING.md](./LICENSING.md) for how the open-source core relates to the
+commercial Pro edition. "Apiboost" and "Apiboost OmniSpec" are trademarks of
+Apiboost, Inc. See [TRADEMARKS.md](./TRADEMARKS.md).

package/core/package.json

@@ -0,0 +1,5 @@
+{
+  "main": "../dist/cjs/core/public.js",
+  "module": "../dist/esm/core/public.js",
+  "types": "../dist/types/core/public.d.ts"
+}

package/dist/cjs/asyncapi/index.js

@@ -0,0 +1,17 @@
+'use strict';
+
+var AsyncApiSpec = require('../chunks/AsyncApiSpec-TBlyRxTP.js');
+require('react/jsx-runtime');
+require('react');
+require('@emotion/css');
+require('../chunks/useSpecFetcher-BKz1jHTV.js');
+require('../chunks/Collapsible-BHAHk_Ep.js');
+require('@emotion/styled');
+require('../chunks/ErrorBoundary-c1piU8da.js');
+require('../chunks/ref-resolver-DWu6Q6E5.js');
+require('../chunks/ssrf-guard-B6T2A7Ho.js');
+
+
+
+exports.AsyncApiSpec = AsyncApiSpec.AsyncApiSpec;
+//# sourceMappingURL=index.js.map

package/dist/cjs/asyncapi/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;"}