@apiboost/omnispec 1.0.0

package/dist/types/wc/attribute-bridge.d.ts

@@ -0,0 +1,96 @@
+/**
+ * This source file is part of the Apiboost(R) OmniSpec Core.
+ *
+ * Copyright (c) Apiboost, Inc.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * See LICENSE.md and LICENSING.md in the project root for license information.
+ */
+/**
+ * Attribute bridge — converts HTML attribute strings to typed React props.
+ *
+ * Strings are coerced into their expected runtime types (boolean, JSON-parsed
+ * object) with safe error handling. Parse failures log a console error and
+ * return undefined so the React component falls back to its default behavior.
+ */
+import type { OmniSpecRendererProps } from '../unified/OmniSpecRenderer';
+import type { ThemeConfig } from '../core/types/theme.types';
+import type { SidebarNavConfig } from '../core/types/sidebar-nav.types';
+/**
+ * Coerces a string attribute to a boolean. Treats `'false'`, `'0'`, and `'off'`
+ * (case-insensitive) as `false`; everything else (including the empty string
+ * for a bare attribute) is `true`. Returns `undefined` if the attribute is null.
+ */
+export declare function parseBooleanAttr(value: string | null): boolean | undefined;
+/**
+ * Parses an attribute string as JSON. Returns `undefined` on null input or on
+ * parse failure (with a console.error so consumers can debug).
+ */
+export declare function parseJsonAttr<T>(value: string | null, attrName: string): T | undefined;
+/**
+ * Reads a string attribute. Returns `undefined` for null so React treats it as
+ * "prop not set" and uses its own default.
+ */
+export declare function readStringAttr(value: string | null): string | undefined;
+/**
+ * Validates a string against an allow-list. Returns undefined if the value is
+ * null or not in the list, otherwise the value itself.
+ */
+export declare function readEnumAttr<T extends string>(value: string | null, allowed: readonly T[]): T | undefined;
+/**
+ * Reads `theme-base` plus the imperative `theme` property and merges them.
+ * The imperative property always wins for fields it specifies; the attribute
+ * acts as a shorthand for `{ base: 'auto' | 'light' | 'dark' }`.
+ */
+export declare function resolveTheme(themeProp: ThemeConfig | undefined, themeBaseAttr: string | null, themeToggleAttr: string | null): ThemeConfig | undefined;
+export interface RawAttributes {
+    /** URL or raw spec content. */
+    specUrl: string | null;
+    /** Imperative property: parsed spec object, string, or undefined. */
+    specProp: OmniSpecRendererProps['spec'] | undefined;
+    /** Imperative property: theme config object. */
+    themeProp: ThemeConfig | undefined;
+    /** `theme-base` attribute: `'light' | 'dark' | 'auto'`. */
+    themeBase: string | null;
+    /** `theme-toggle` attribute. */
+    themeToggle: string | null;
+    /** Imperative property: sidebar nav config. */
+    sidebarNavProp: SidebarNavConfig | undefined;
+    /** `display-mode` attribute: `'compact' | 'reference'`. */
+    displayMode: string | null;
+    /** `navigation-mode` attribute: `'grouped' | 'segmented'`. */
+    navigationMode: string | null;
+    /** `layout` attribute: `'sidebar' | 'stacked'`. */
+    layout: string | null;
+    /** `sidebar-position` attribute: `'left' | 'right'`. */
+    sidebarPosition: string | null;
+    /** `try-it-layout` attribute: `'inline' | 'panel'`. */
+    tryItLayout: string | null;
+    /** `schema-style` attribute: `'lines' | 'tokens' | 'chain' | 'table' | 'card'`. */
+    schemaStyle: string | null;
+    /** `allow-try-it` attribute. */
+    allowTryIt: string | null;
+    /** `interactive-oauth` attribute — opt out of the Pro interactive OAuth flow. */
+    interactiveOAuth: string | null;
+    /** `default-expand-operations` attribute. */
+    defaultExpandOperations: string | null;
+    /** `proxy-url` attribute. */
+    proxyUrl: string | null;
+    /** `download-link` attribute — boolean string or URL. */
+    downloadLink: string | null;
+    /** `docs-url` attribute. */
+    docsUrl: string | null;
+    /** `upgrade-url` attribute. */
+    upgradeUrl: string | null;
+    /** `server-url` attribute — forces a single server/base URL at render time. */
+    serverUrl: string | null;
+    /** `try-it-persist-ttl` attribute — max age (seconds) for persisted Try-It inputs; 0 disables. */
+    tryItPersistTtl: string | null;
+}
+/**
+ * Builds a final `OmniSpecRendererProps` object from raw attribute values and any
+ * imperative property assignments. Imperative properties take precedence.
+ */
+export declare function buildRendererProps(raw: RawAttributes): OmniSpecRendererProps | null;
+//# sourceMappingURL=attribute-bridge.d.ts.map

package/dist/types/wc/attribute-bridge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"attribute-bridge.d.ts","sourceRoot":"","sources":["../../../src/wc/attribute-bridge.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAA;AACxE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAA;AAC5D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAA;AAEvE;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,GAAG,SAAS,CAK1E;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS,CAatF;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,SAAS,CAEvE;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,MAAM,EAC3C,KAAK,EAAE,MAAM,GAAG,IAAI,EACpB,OAAO,EAAE,SAAS,CAAC,EAAE,GACpB,CAAC,GAAG,SAAS,CAGf;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAC1B,SAAS,EAAE,WAAW,GAAG,SAAS,EAClC,aAAa,EAAE,MAAM,GAAG,IAAI,EAC5B,eAAe,EAAE,MAAM,GAAG,IAAI,GAC7B,WAAW,GAAG,SAAS,CAkBzB;AAED,MAAM,WAAW,aAAa;IAC5B,+BAA+B;IAC/B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,qEAAqE;IACrE,QAAQ,EAAE,qBAAqB,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;IACnD,gDAAgD;IAChD,SAAS,EAAE,WAAW,GAAG,SAAS,CAAA;IAClC,2DAA2D;IAC3D,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,gCAAgC;IAChC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,+CAA+C;IAC/C,cAAc,EAAE,gBAAgB,GAAG,SAAS,CAAA;IAC5C,2DAA2D;IAC3D,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,8DAA8D;IAC9D,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,mDAAmD;IACnD,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,wDAAwD;IACxD,eAAe,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,uDAAuD;IACvD,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,mFAAmF;IACnF,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,gCAAgC;IAChC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,iFAAiF;IACjF,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAA;IAC/B,6CAA6C;IAC7C,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC,6BAA6B;IAC7B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,yDAAyD;IACzD,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,4BAA4B;IAC5B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,+BAA+B;IAC/B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,+EAA+E;IAC/E,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,kGAAkG;IAClG,eAAe,EAAE,MAAM,GAAG,IAAI,CAAA;CAC/B;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,aAAa,GAAG,qBAAqB,GAAG,IAAI,CAyEnF"}

package/dist/types/wc/index.d.ts

@@ -0,0 +1,42 @@
+/**
+ * This source file is part of the Apiboost(R) OmniSpec Core.
+ *
+ * Copyright (c) Apiboost, Inc.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * See LICENSE.md and LICENSING.md in the project root for license information.
+ */
+/**
+ * `@apiboost/omnispec/wc` — Web Component entry point.
+ *
+ * Importing this module registers the `<omnispec-renderer>` custom element
+ * exactly once. Importing it multiple times is safe.
+ *
+ * @example Vanilla HTML
+ * ```html
+ * <script type="module" src="/path/to/omnispec-wc.js"></script>
+ * <omnispec-renderer spec-url="/openapi.json"></omnispec-renderer>
+ * ```
+ *
+ * @example Imperative
+ * ```ts
+ * import { OmniSpecRendererElement, defineOmniSpecRenderer } from '@apiboost/omnispec/wc'
+ * defineOmniSpecRenderer()
+ * const el = document.createElement('omnispec-renderer') as OmniSpecRendererElement
+ * el.spec = parsedSpecObject
+ * el.theme = { base: 'dark' }
+ * document.body.appendChild(el)
+ * ```
+ */
+import { OmniSpecRendererElement, TAG_NAME } from './OmniSpecRendererElement';
+export { OmniSpecRendererElement, TAG_NAME };
+export { buildRendererProps } from './attribute-bridge';
+/**
+ * Registers the `<omnispec-renderer>` custom element if it has not already been
+ * registered. Safe to call multiple times.
+ *
+ * @param tagName Override the element tag (defaults to `'omnispec-renderer'`).
+ */
+export declare function defineOmniSpecRenderer(tagName?: string): void;
+//# sourceMappingURL=index.d.ts.map

package/dist/types/wc/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/wc/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,EAAE,uBAAuB,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAA;AAE7E,OAAO,EAAE,uBAAuB,EAAE,QAAQ,EAAE,CAAA;AAC5C,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAA;AAEvD;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,GAAE,MAAiB,GAAG,IAAI,CAMvE"}

package/dist/types/wc/style-injection.d.ts

@@ -0,0 +1,24 @@
+/**
+ * This source file is part of the Apiboost(R) OmniSpec Core.
+ *
+ * Copyright (c) Apiboost, Inc.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * See LICENSE.md and LICENSING.md in the project root for license information.
+ */
+interface StyleMirrorOptions {
+    /** Shadow root to mirror styles into. */
+    shadow: ShadowRoot;
+}
+/**
+ * Sets up a style mirror that clones emotion-generated styles from
+ * `document.head` into the given shadow root, and keeps the mirror in sync as
+ * new styles are added or existing ones change.
+ *
+ * Returns a teardown function that removes the observer and the mirrored
+ * styles.
+ */
+export declare function attachStyleMirror({ shadow }: StyleMirrorOptions): () => void;
+export {};
+//# sourceMappingURL=style-injection.d.ts.map

package/dist/types/wc/style-injection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"style-injection.d.ts","sourceRoot":"","sources":["../../../src/wc/style-injection.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAmCH,UAAU,kBAAkB;IAC1B,yCAAyC;IACzC,MAAM,EAAE,UAAU,CAAA;CACnB;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,EAAE,MAAM,EAAE,EAAE,kBAAkB,GAAG,MAAM,IAAI,CAyG5E"}