apiuikit 0.3.0 → 1.0.0

package/dist/contexts/useSpec.d.ts

@@ -1,16 +1,40 @@
-type AsyncAPIDocument = Record<string, unknown>;
-interface AsyncAPIContextValue {
-    document: AsyncAPIDocument;
+import { AsyncAPIDocumentData } from '../types/schema';
+import { OpenAPIDocumentData } from '../types/openapi';
+/** Which spec produced the ambient document. The discriminant of DocumentContextValue. */
+export type SpecType = "asyncapi" | "openapi";
+interface DocumentContextBase {
     /** Resolves a JSON Pointer $ref string to the object it references in the document. */
     deref: (ref: string) => unknown;
     portalHost: HTMLElement | null;
-    /** The Layout component's own root element — used to scope viewport-fixed overlays (e.g. SidePanel) to where <AsyncAPI> is actually embedded, rather than the full browser viewport. */
+    /** The Layout component's own root element, used to scope viewport-fixed overlays (e.g. SidePanel) to where the <AsyncAPI> or <OpenAPI> widget is actually embedded, rather than the full browser viewport. */
     rootElement: HTMLElement | null;
     /** Whether schema tree nodes start expanded by default. Defaults to false. */
     defaultSchemaExpanded?: boolean;
     /** Resolved schema tree depth-line colors (config-provided or default), cycled by nesting depth. */
     depthColors: string[];
+    /** Whether to render known x-* spec extensions (see the `x-tensions` catalog). Defaults to true. */
+    showExtensions: boolean;
+    /** OpenAPI only: whether to render per-operation code samples (cURL/JS/Python). Defaults to true. */
+    showCodeSamples: boolean;
 }
-export declare const AsyncAPIDocumentContext: import('react').Context<AsyncAPIContextValue | null>;
-export declare const useAsyncAPIDocument: () => AsyncAPIContextValue;
+export interface AsyncAPIDocumentContextValue extends DocumentContextBase {
+    specType: "asyncapi";
+    document: AsyncAPIDocumentData;
+}
+export interface OpenAPIDocumentContextValue extends DocumentContextBase {
+    specType: "openapi";
+    document: OpenAPIDocumentData;
+}
+/**
+ * Discriminated on `specType`: checking it narrows `document` to the matching
+ * spec's shape, so spec-specific consumers don't need to cast. Spec-agnostic
+ * consumers that only need deref/portalHost/rootElement/depthColors (SidePanel,
+ * SearchPanel, SchemaTree, ExpandToggle, ...) work under any provider without
+ * looking at the discriminant.
+ */
+export type DocumentContextValue = AsyncAPIDocumentContextValue | OpenAPIDocumentContextValue;
+export declare const DocumentContext: import('react').Context<DocumentContextValue | null>;
+export declare const useDocumentContext: () => DocumentContextValue;
+export declare const AsyncAPIDocumentContext: import('react').Context<DocumentContextValue | null>;
+export declare const useAsyncAPIDocument: () => DocumentContextValue;
 export {};

package/dist/crystal-BcGgviMR.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function m(e){const i="(_?[ui](8|16|32|64|128))?",l="(_?f(32|64))?",g="[a-zA-Z_]\\w*[!?=]?",s="[a-zA-Z_]\\w*[!?=]?|[-+~]@|<<|>>|[=!]~|===?|<=>|[<>]=?|\\*\\*|[-/+%^&*~|]|//|//=|&[-+*]=?|&\\*\\*|\\[\\][=?]?",t="[A-Za-z_]\\w*(::\\w+)*(\\?|!)?",c={$pattern:g,keyword:"abstract alias annotation as as? asm begin break case class def do else elsif end ensure enum extend for fun if include instance_sizeof is_a? lib macro module next nil? of out pointerof private protected rescue responds_to? return require select self sizeof struct super then type typeof union uninitialized unless until verbatim when while with yield __DIR__ __END_LINE__ __FILE__ __LINE__",literal:"false nil true"},a={className:"subst",begin:/#\{/,end:/\}/,keywords:c},d={className:"variable",begin:"(\\$\\W)|((\\$|@@?)(\\w+))(?=[^@$?])(?![A-Za-z])(?![@$?'])"},b={className:"template-variable",variants:[{begin:"\\{\\{",end:"\\}\\}"},{begin:"\\{%",end:"%\\}"}],keywords:c};function n(S,A){const r=[{begin:S,end:A}];return r[0].contains=r,r}const _={className:"string",contains:[e.BACKSLASH_ESCAPE,a],variants:[{begin:/'/,end:/'/},{begin:/"/,end:/"/},{begin:/`/,end:/`/},{begin:"%[Qwi]?\\(",end:"\\)",contains:n("\\(","\\)")},{begin:"%[Qwi]?\\[",end:"\\]",contains:n("\\[","\\]")},{begin:"%[Qwi]?\\{",end:/\}/,contains:n(/\{/,/\}/)},{begin:"%[Qwi]?<",end:">",contains:n("<",">")},{begin:"%[Qwi]?\\|",end:"\\|"},{begin:/<<-\w+$/,end:/^\s*\w+$/}],relevance:0},E={className:"string",variants:[{begin:"%q\\(",end:"\\)",contains:n("\\(","\\)")},{begin:"%q\\[",end:"\\]",contains:n("\\[","\\]")},{begin:"%q\\{",end:/\}/,contains:n(/\{/,/\}/)},{begin:"%q<",end:">",contains:n("<",">")},{begin:"%q\\|",end:"\\|"},{begin:/<<-'\w+'$/,end:/^\s*\w+$/}],relevance:0},u={begin:"(?!%\\})("+e.RE_STARTERS_RE+"|\\n|\\b(case|if|select|unless|until|when|while)\\b)\\s*",keywords:"case if select unless until when while",contains:[{className:"regexp",contains:[e.BACKSLASH_ESCAPE,a],variants:[{begin:"//[a-z]*",relevance:0},{begin:"/(?!\\/)",end:"/[a-z]*"}]}],relevance:0},T={className:"regexp",contains:[e.BACKSLASH_ESCAPE,a],variants:[{begin:"%r\\(",end:"\\)",contains:n("\\(","\\)")},{begin:"%r\\[",end:"\\]",contains:n("\\[","\\]")},{begin:"%r\\{",end:/\}/,contains:n(/\{/,/\}/)},{begin:"%r<",end:">",contains:n("<",">")},{begin:"%r\\|",end:"\\|"}],relevance:0},N={className:"meta",begin:"@\\[",end:"\\]",contains:[e.inherit(e.QUOTE_STRING_MODE,{className:"string"})]},o=[b,_,E,T,u,N,d,e.HASH_COMMENT_MODE,{className:"class",beginKeywords:"class module struct",end:"$|;",illegal:/=/,contains:[e.HASH_COMMENT_MODE,e.inherit(e.TITLE_MODE,{begin:t}),{begin:"<"}]},{className:"class",beginKeywords:"lib enum union",end:"$|;",illegal:/=/,contains:[e.HASH_COMMENT_MODE,e.inherit(e.TITLE_MODE,{begin:t})]},{beginKeywords:"annotation",end:"$|;",illegal:/=/,contains:[e.HASH_COMMENT_MODE,e.inherit(e.TITLE_MODE,{begin:t})],relevance:2},{className:"function",beginKeywords:"def",end:/\B\b/,contains:[e.inherit(e.TITLE_MODE,{begin:s,endsParent:!0})]},{className:"function",beginKeywords:"fun macro",end:/\B\b/,contains:[e.inherit(e.TITLE_MODE,{begin:s,endsParent:!0})],relevance:2},{className:"symbol",begin:e.UNDERSCORE_IDENT_RE+"(!|\\?)?:",relevance:0},{className:"symbol",begin:":",contains:[_,{begin:s}],relevance:0},{className:"number",variants:[{begin:"\\b0b([01_]+)"+i},{begin:"\\b0o([0-7_]+)"+i},{begin:"\\b0x([A-Fa-f0-9_]+)"+i},{begin:"\\b([1-9][0-9_]*[0-9]|[0-9])(\\.[0-9][0-9_]*)?([eE]_?[-+]?[0-9_]*)?"+l+"(?!_)"},{begin:"\\b([1-9][0-9_]*|0)"+i}],relevance:0}];return a.contains=o,b.contains=o.slice(1),{name:"Crystal",aliases:["cr"],keywords:c,contains:o}}exports.default=m;

package/dist/crystal-BtD5fR4q.js

@@ -0,0 +1,283 @@
+function S(n) {
+  const i = "(_?[ui](8|16|32|64|128))?", g = "(_?f(32|64))?", l = "[a-zA-Z_]\\w*[!?=]?", s = "[a-zA-Z_]\\w*[!?=]?|[-+~]@|<<|>>|[=!]~|===?|<=>|[<>]=?|\\*\\*|[-/+%^&*~|]|//|//=|&[-+*]=?|&\\*\\*|\\[\\][=?]?", t = "[A-Za-z_]\\w*(::\\w+)*(\\?|!)?", c = {
+    $pattern: l,
+    keyword: "abstract alias annotation as as? asm begin break case class def do else elsif end ensure enum extend for fun if include instance_sizeof is_a? lib macro module next nil? of out pointerof private protected rescue responds_to? return require select self sizeof struct super then type typeof union uninitialized unless until verbatim when while with yield __DIR__ __END_LINE__ __FILE__ __LINE__",
+    literal: "false nil true"
+  }, a = {
+    className: "subst",
+    begin: /#\{/,
+    end: /\}/,
+    keywords: c
+  }, d = {
+    // negative-look forward attemps to prevent false matches like:
+    // @ident@ or $ident$ that might indicate this is not ruby at all
+    className: "variable",
+    begin: "(\\$\\W)|((\\$|@@?)(\\w+))(?=[^@$?])(?![A-Za-z])(?![@$?'])"
+  }, b = {
+    className: "template-variable",
+    variants: [
+      {
+        begin: "\\{\\{",
+        end: "\\}\\}"
+      },
+      {
+        begin: "\\{%",
+        end: "%\\}"
+      }
+    ],
+    keywords: c
+  };
+  function e(A, w) {
+    const r = [
+      {
+        begin: A,
+        end: w
+      }
+    ];
+    return r[0].contains = r, r;
+  }
+  const _ = {
+    className: "string",
+    contains: [
+      n.BACKSLASH_ESCAPE,
+      a
+    ],
+    variants: [
+      {
+        begin: /'/,
+        end: /'/
+      },
+      {
+        begin: /"/,
+        end: /"/
+      },
+      {
+        begin: /`/,
+        end: /`/
+      },
+      {
+        begin: "%[Qwi]?\\(",
+        end: "\\)",
+        contains: e("\\(", "\\)")
+      },
+      {
+        begin: "%[Qwi]?\\[",
+        end: "\\]",
+        contains: e("\\[", "\\]")
+      },
+      {
+        begin: "%[Qwi]?\\{",
+        end: /\}/,
+        contains: e(/\{/, /\}/)
+      },
+      {
+        begin: "%[Qwi]?<",
+        end: ">",
+        contains: e("<", ">")
+      },
+      {
+        begin: "%[Qwi]?\\|",
+        end: "\\|"
+      },
+      {
+        begin: /<<-\w+$/,
+        end: /^\s*\w+$/
+      }
+    ],
+    relevance: 0
+  }, E = {
+    className: "string",
+    variants: [
+      {
+        begin: "%q\\(",
+        end: "\\)",
+        contains: e("\\(", "\\)")
+      },
+      {
+        begin: "%q\\[",
+        end: "\\]",
+        contains: e("\\[", "\\]")
+      },
+      {
+        begin: "%q\\{",
+        end: /\}/,
+        contains: e(/\{/, /\}/)
+      },
+      {
+        begin: "%q<",
+        end: ">",
+        contains: e("<", ">")
+      },
+      {
+        begin: "%q\\|",
+        end: "\\|"
+      },
+      {
+        begin: /<<-'\w+'$/,
+        end: /^\s*\w+$/
+      }
+    ],
+    relevance: 0
+  }, u = {
+    begin: "(?!%\\})(" + n.RE_STARTERS_RE + "|\\n|\\b(case|if|select|unless|until|when|while)\\b)\\s*",
+    keywords: "case if select unless until when while",
+    contains: [
+      {
+        className: "regexp",
+        contains: [
+          n.BACKSLASH_ESCAPE,
+          a
+        ],
+        variants: [
+          {
+            begin: "//[a-z]*",
+            relevance: 0
+          },
+          {
+            begin: "/(?!\\/)",
+            end: "/[a-z]*"
+          }
+        ]
+      }
+    ],
+    relevance: 0
+  }, T = {
+    className: "regexp",
+    contains: [
+      n.BACKSLASH_ESCAPE,
+      a
+    ],
+    variants: [
+      {
+        begin: "%r\\(",
+        end: "\\)",
+        contains: e("\\(", "\\)")
+      },
+      {
+        begin: "%r\\[",
+        end: "\\]",
+        contains: e("\\[", "\\]")
+      },
+      {
+        begin: "%r\\{",
+        end: /\}/,
+        contains: e(/\{/, /\}/)
+      },
+      {
+        begin: "%r<",
+        end: ">",
+        contains: e("<", ">")
+      },
+      {
+        begin: "%r\\|",
+        end: "\\|"
+      }
+    ],
+    relevance: 0
+  }, N = {
+    className: "meta",
+    begin: "@\\[",
+    end: "\\]",
+    contains: [n.inherit(n.QUOTE_STRING_MODE, { className: "string" })]
+  }, o = [
+    b,
+    _,
+    E,
+    T,
+    u,
+    N,
+    d,
+    n.HASH_COMMENT_MODE,
+    {
+      className: "class",
+      beginKeywords: "class module struct",
+      end: "$|;",
+      illegal: /=/,
+      contains: [
+        n.HASH_COMMENT_MODE,
+        n.inherit(n.TITLE_MODE, { begin: t }),
+        {
+          // relevance booster for inheritance
+          begin: "<"
+        }
+      ]
+    },
+    {
+      className: "class",
+      beginKeywords: "lib enum union",
+      end: "$|;",
+      illegal: /=/,
+      contains: [
+        n.HASH_COMMENT_MODE,
+        n.inherit(n.TITLE_MODE, { begin: t })
+      ]
+    },
+    {
+      beginKeywords: "annotation",
+      end: "$|;",
+      illegal: /=/,
+      contains: [
+        n.HASH_COMMENT_MODE,
+        n.inherit(n.TITLE_MODE, { begin: t })
+      ],
+      relevance: 2
+    },
+    {
+      className: "function",
+      beginKeywords: "def",
+      end: /\B\b/,
+      contains: [
+        n.inherit(n.TITLE_MODE, {
+          begin: s,
+          endsParent: !0
+        })
+      ]
+    },
+    {
+      className: "function",
+      beginKeywords: "fun macro",
+      end: /\B\b/,
+      contains: [
+        n.inherit(n.TITLE_MODE, {
+          begin: s,
+          endsParent: !0
+        })
+      ],
+      relevance: 2
+    },
+    {
+      className: "symbol",
+      begin: n.UNDERSCORE_IDENT_RE + "(!|\\?)?:",
+      relevance: 0
+    },
+    {
+      className: "symbol",
+      begin: ":",
+      contains: [
+        _,
+        { begin: s }
+      ],
+      relevance: 0
+    },
+    {
+      className: "number",
+      variants: [
+        { begin: "\\b0b([01_]+)" + i },
+        { begin: "\\b0o([0-7_]+)" + i },
+        { begin: "\\b0x([A-Fa-f0-9_]+)" + i },
+        { begin: "\\b([1-9][0-9_]*[0-9]|[0-9])(\\.[0-9][0-9_]*)?([eE]_?[-+]?[0-9_]*)?" + g + "(?!_)" },
+        { begin: "\\b([1-9][0-9_]*|0)" + i }
+      ],
+      relevance: 0
+    }
+  ];
+  return a.contains = o, b.contains = o.slice(1), {
+    name: "Crystal",
+    aliases: ["cr"],
+    keywords: c,
+    contains: o
+  };
+}
+export {
+  S as default
+};