apiuikit 0.3.0 → 1.0.0

package/dist/helpers/resolveDocument.d.ts

@@ -1 +1,9 @@
+/**
+ * Read-only scan for `$ref` nodes only (not cycles). Used to verify a
+ * caller's `kind="resolved"` promise: leftover refs mean their upstream
+ * resolution isn't doing what they think, while object cycles are a normal
+ * property of parser output and no broken promise. Terminates on cyclic
+ * input via the visited set.
+ */
+export declare const containsRefs: (value: unknown, visited?: Set<object>) => boolean;
 export declare function resolveDocument<T>(doc: T): T;

package/dist/helpers/runtimeExpression.d.ts

@@ -0,0 +1,15 @@
+/**
+ * OpenAPI runtime expressions (`$response.body#/id`) appear in response
+ * `links` parameters and in `callbacks` URL keys. They're written with a `$`
+ * sigil and a JSON Pointer (`#/a/b`), which is precise but hard to read mid
+ * sentence, so both places show them as a plain dotted path instead.
+ */
+/** `$response.body#/data/id` reads as `response.body.data.id`. Non-expressions are left alone. */
+export declare function readableExpression(value: unknown): string;
+/**
+ * A callback's key is a URL template that embeds expressions in braces, and
+ * may wrap them in literal URL text: `{$request.body#/callbackUrl}` or
+ * `https://example.com/{$request.body#/id}/events`. Only the embedded
+ * expressions are rewritten; the braces stay, since they mark the placeholder.
+ */
+export declare function readableCallbackUrl(url: string): string;

package/dist/helpers/schemaExample.d.ts

@@ -0,0 +1,9 @@
+export type JsonSchema = Record<string, unknown>;
+export declare function extendExampleSchema(schema: JsonSchema, active?: Set<object>): JsonSchema;
+/**
+ * Generates a synthetic example value from a JSON Schema via json-schema-faker.
+ * Fails soft: circular or otherwise ungenerable schemas resolve to `undefined`
+ * rather than throwing/rejecting, since callers render "no example" instead of
+ * crashing.
+ */
+export declare function generateSchemaExample(schema: JsonSchema): Promise<unknown>;

package/dist/helpers/searchIndex.d.ts

@@ -1,6 +1,6 @@
 import { AsyncAPIDocumentData } from '../types/schema';
-export type SearchTab = "operations" | "messages" | "schemas" | "info" | "servers";
-export type SearchType = "operation" | "message" | "schema" | "info" | "server";
+export type SearchTab = "operations" | "messages" | "schemas" | "info" | "servers" | "endpoints" | "webhooks";
+export type SearchType = "operation" | "message" | "schema" | "info" | "server" | "endpoint" | "webhook";
 export interface SearchEntry {
     id: string;
     targetId: string;
@@ -15,4 +15,7 @@ export interface SearchEntry {
     focusSection?: string;
     schemaFocusTokens?: string[];
 }
+export declare const normalizeString: (value: unknown) => string;
+/** Walks a single JSON Schema node into flat search entries — spec-agnostic (AsyncAPI and OpenAPI schemas share the same shape), reused by openapiSearchIndex.ts. */
+export declare const addSchemaEntries: (entries: SearchEntry[], schema: unknown, schemaKey: string, schemaName: string) => void;
 export declare function buildSearchIndex(asyncapi: AsyncAPIDocumentData): SearchEntry[];

package/dist/helpers/tests/codeSamples.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/helpers/tests/exampleSchema.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/helpers/tests/openapiSearchIndex.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/helpers/tests/toMarkdown.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/helpers/toMarkdown.d.ts

@@ -0,0 +1,20 @@
+import { AsyncAPIDocumentData } from '../types/schema';
+import { HttpMethod, OpenAPIDocumentData } from '../types/openapi';
+type Deref = (ref: string) => unknown;
+export declare function asyncApiToMarkdown(doc: AsyncAPIDocumentData, deref: Deref): string;
+/** Builds a self-contained Markdown snippet for a single AsyncAPI operation:
+ * doc info + servers, followed by that one operation's section (see
+ * `operationSectionToMarkdown`). Used by the per-operation copy button, as
+ * opposed to `asyncApiToMarkdown`'s whole-document export. */
+export declare function asyncApiOperationToMarkdown(doc: AsyncAPIDocumentData, key: string, deref: Deref): string;
+export declare function openApiToMarkdown(doc: OpenAPIDocumentData, deref: Deref): string;
+/**
+ * Builds a self-contained Markdown snippet for a single OpenAPI endpoint:
+ * doc info + servers (so the snippet stands alone without the rest of the
+ * document) followed by that one endpoint's fully-dereferenced parameters,
+ * request body, and responses. Used by the per-endpoint copy button in the
+ * Endpoints side panel (Paths.tsx), as opposed to `openApiToMarkdown`'s
+ * whole-document export.
+ */
+export declare function openApiEndpointToMarkdown(doc: OpenAPIDocumentData, method: HttpMethod, path: string, deref: Deref): string;
+export {};

package/dist/hooks/useDocumentProviderValue.d.ts

@@ -0,0 +1,27 @@
+import { ConfigInterface } from '../config';
+import { SpecType } from '../contexts';
+/**
+ * Builds the shared DocumentContext value (deref resolver, portal/root refs,
+ * theme-derived settings) plus the CSS custom properties for the theme,
+ * used by both AsyncAPIDocumentProvider and OpenAPIDocumentProvider, which
+ * differ only in the spec type they declare and the portal element's
+ * className. Generic so the returned contextValue keeps the caller's literal
+ * `specType` and document type, and thus lands as the right member of the
+ * DocumentContextValue union.
+ */
+export declare function useDocumentProviderValue<S extends SpecType, D extends object>(specType: S, document: D, config?: ConfigInterface): {
+    contextValue: {
+        specType: S;
+        document: D;
+        deref: (refPath: string) => unknown;
+        portalHost: HTMLDivElement | null;
+        rootElement: HTMLDivElement | null;
+        defaultSchemaExpanded: boolean;
+        depthColors: string[];
+        showExtensions: boolean;
+        showCodeSamples: boolean;
+    };
+    themeVars: Record<string, string>;
+    setPortalHost: import('react').Dispatch<import('react').SetStateAction<HTMLDivElement | null>>;
+    setRootElement: import('react').Dispatch<import('react').SetStateAction<HTMLDivElement | null>>;
+};

package/dist/hooks/useFuseSearch.d.ts

@@ -0,0 +1,14 @@
+import { SearchEntry } from '../helpers/searchIndex';
+export interface UseSpecSearchOptions {
+    threshold?: number;
+    limit?: number;
+    /** Delay before a query change triggers a search, in ms. Defaults to 150. */
+    debounceMs?: number;
+}
+/** Shared debounce + Fuse setup behind useSpecSearch (AsyncAPI) and useOpenAPISearch — only the index-builder differs between specs. */
+export declare function useFuseSearch<T>(document: T, buildIndex: (document: T) => SearchEntry[], options?: UseSpecSearchOptions): {
+    query: string;
+    setQuery: import('react').Dispatch<import('react').SetStateAction<string>>;
+    results: SearchEntry[];
+    searchIndex: SearchEntry[];
+};

package/dist/hooks/useOpenAPISearch.d.ts

@@ -0,0 +1,9 @@
+import { OpenAPIDocumentData } from '../types/openapi';
+import { UseSpecSearchOptions } from './useFuseSearch';
+/** Mirrors useSpecSearch (AsyncAPI), built on buildOpenAPISearchIndex instead. */
+export declare function useOpenAPISearch(openapi: OpenAPIDocumentData, options?: UseSpecSearchOptions): {
+    query: string;
+    setQuery: import('react').Dispatch<import('react').SetStateAction<string>>;
+    results: import('../helpers/searchIndex').SearchEntry[];
+    searchIndex: import('../helpers/searchIndex').SearchEntry[];
+};

package/dist/hooks/useSearchResultFocus.d.ts

@@ -0,0 +1,18 @@
+export interface ActiveHighlight {
+    targetId: string;
+    query: string;
+    highlight: boolean;
+}
+/**
+ * Scrolls to and highlights a search result's target element once it exists
+ * in the DOM, retrying since the target may not be rendered yet (e.g. the tab
+ * holding it just changed). Shared behind both AsyncAPI/Layout.tsx and
+ * OpenAPI/Layout.tsx, which otherwise duplicated this effect verbatim.
+ *
+ * `deps` should list every piece of state that changes which DOM subtree is
+ * currently rendered (active tab, selected item keys, focus targets, ...) —
+ * anything that could change whether `activeHighlight.targetId` already
+ * exists in the DOM. Its length must stay constant across renders for a given
+ * call site, same as any other hook dependency list.
+ */
+export declare function useSearchResultFocus(activeHighlight: ActiveHighlight | null, deps: readonly unknown[]): void;

package/dist/hooks/useSpecLayoutController.d.ts

@@ -0,0 +1,51 @@
+import { ContentTabItem } from '../components/ContentTab';
+import { SearchEntry } from '../helpers/searchIndex';
+export interface SchemaFocusTarget {
+    tokens: string[];
+    id: string;
+}
+export interface LayoutSection<TabKey extends string> {
+    id: TabKey | "servers";
+    /** Config `show` flag for this section: a hidden section reads back a null selection. */
+    visible: boolean;
+}
+export interface SpecLayoutControllerOptions<TabKey extends string> {
+    /** Content tabs currently visible (already filtered by config.show). */
+    tabs: ContentTabItem[];
+    /** Tab to fall back to when no tabs are visible or the stored tab gets hidden. */
+    defaultTab: TabKey;
+    isTabKey: (value: string) => value is TabKey;
+    /**
+     * Selectable sections in nav priority order: the tab keys, then "servers".
+     * Must keep a constant length across renders (it feeds a hook dependency list).
+     */
+    sections: readonly LayoutSection<TabKey>[];
+    /** Current search input, used to tag highlights and clear them when it empties. */
+    searchQuery: string;
+}
+/**
+ * Owns the tab/selection/search-focus state machine shared by the AsyncAPI and
+ * OpenAPI layouts, which previously duplicated it verbatim. Each layout
+ * supplies only its tab definitions, section visibility, and content
+ * renderers; everything about "what is selected where, and what should scroll
+ * into view" lives here.
+ */
+export declare function useSpecLayoutController<TabKey extends string>({ tabs, defaultTab, isTabKey, sections, searchQuery, }: SpecLayoutControllerOptions<TabKey>): {
+    effectiveTab: TabKey;
+    focusTab: (tab: TabKey) => void;
+    /** What the sidebar nav should show as active: the focused section, falling back to the content tab. */
+    navActiveSection: "servers" | TabKey;
+    /** Per-section selections, clamped to visible sections. */
+    selected: Record<"servers" | TabKey, string | null>;
+    setSelectedKey: (section: "servers" | TabKey, key: string | null) => void;
+    selectedNavItem: {
+        tab: "servers" | TabKey;
+        key: NonNullable<Record<"servers" | TabKey, string | null>["servers" | TabKey]>;
+    } | null;
+    handleSearchSelect: (entry: SearchEntry) => void;
+    handleNavItemSelect: (tab: TabKey, key: string) => void;
+    handleNavServerSelect: (key: string) => void;
+    handleContentTabChange: (id: string) => void;
+    focusSection: string | null;
+    schemaFocusTarget: SchemaFocusTarget | null;
+};

package/dist/hooks/useSpecSearch.d.ts

@@ -1,10 +1,6 @@
 import { AsyncAPIDocumentData } from '../types/schema';
-export interface UseSpecSearchOptions {
-    threshold?: number;
-    limit?: number;
-    /** Delay before a query change triggers a search, in ms. Defaults to 150. */
-    debounceMs?: number;
-}
+import { UseSpecSearchOptions } from './useFuseSearch';
+export type { UseSpecSearchOptions };
 export declare function useSpecSearch(asyncapi: AsyncAPIDocumentData, options?: UseSpecSearchOptions): {
     query: string;
     setQuery: import('react').Dispatch<import('react').SetStateAction<string>>;

package/dist/http--XH4hLDt.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function c(n){const s=n.regex,e="HTTP/([32]|1\\.[01])",i=/[A-Za-z][A-Za-z0-9-]*/,t={className:"attribute",begin:s.concat("^",i,"(?=\\:\\s)"),starts:{contains:[{className:"punctuation",begin:/: /,relevance:0,starts:{end:"$",relevance:0}}]}},a=[t,{begin:"\\n\\n",starts:{subLanguage:[],endsWithParent:!0}}];return{name:"HTTP",aliases:["https"],illegal:/\S/,contains:[{begin:"^(?="+e+" \\d{3})",end:/$/,contains:[{className:"meta",begin:e},{className:"number",begin:"\\b\\d{3}\\b"}],starts:{end:/\b\B/,illegal:/\S/,contains:a}},{begin:"(?=^[A-Z]+ (.*?) "+e+"$)",end:/$/,contains:[{className:"string",begin:" ",end:" ",excludeBegin:!0,excludeEnd:!0},{className:"meta",begin:e},{className:"keyword",begin:"[A-Z]+"}],starts:{end:/\b\B/,illegal:/\S/,contains:a}},n.inherit(t,{relevance:0})]}}exports.default=c;

package/dist/http-DKeNlJKS.js

@@ -0,0 +1,85 @@
+function c(n) {
+  const s = n.regex, e = "HTTP/([32]|1\\.[01])", i = /[A-Za-z][A-Za-z0-9-]*/, a = {
+    className: "attribute",
+    begin: s.concat("^", i, "(?=\\:\\s)"),
+    starts: { contains: [
+      {
+        className: "punctuation",
+        begin: /: /,
+        relevance: 0,
+        starts: {
+          end: "$",
+          relevance: 0
+        }
+      }
+    ] }
+  }, t = [
+    a,
+    {
+      begin: "\\n\\n",
+      starts: {
+        subLanguage: [],
+        endsWithParent: !0
+      }
+    }
+  ];
+  return {
+    name: "HTTP",
+    aliases: ["https"],
+    illegal: /\S/,
+    contains: [
+      // response
+      {
+        begin: "^(?=" + e + " \\d{3})",
+        end: /$/,
+        contains: [
+          {
+            className: "meta",
+            begin: e
+          },
+          {
+            className: "number",
+            begin: "\\b\\d{3}\\b"
+          }
+        ],
+        starts: {
+          end: /\b\B/,
+          illegal: /\S/,
+          contains: t
+        }
+      },
+      // request
+      {
+        begin: "(?=^[A-Z]+ (.*?) " + e + "$)",
+        end: /$/,
+        contains: [
+          {
+            className: "string",
+            begin: " ",
+            end: " ",
+            excludeBegin: !0,
+            excludeEnd: !0
+          },
+          {
+            className: "meta",
+            begin: e
+          },
+          {
+            className: "keyword",
+            begin: "[A-Z]+"
+          }
+        ],
+        starts: {
+          end: /\b\B/,
+          illegal: /\S/,
+          contains: t
+        }
+      },
+      // to allow headers to work even without a preamble
+      n.inherit(a, { relevance: 0 })
+    ]
+  };
+}
+export {
+  c as default
+};

package/dist/icons/Copy.d.ts

@@ -0,0 +1,6 @@
+interface IconCopyProps {
+    className?: string;
+}
+/** The two-overlapping-sheets copy glyph, as distinct from Clipboard's clipboard-and-clip. */
+export default function IconCopy({ className }: IconCopyProps): import("react").JSX.Element;
+export {};

package/dist/icons/Info.d.ts

@@ -0,0 +1,5 @@
+interface IconInfoProps {
+    className?: string;
+}
+export default function IconInfo({ className }: IconInfoProps): import("react").JSX.Element;
+export {};

package/dist/icons/Search.d.ts

@@ -0,0 +1,3 @@
+import { default as React } from 'react';
+declare const SearchIcon: React.FC<React.SVGProps<SVGSVGElement>>;
+export default SearchIcon;