apiuikit 0.3.0 → 1.0.0

package/dist/swift-CAnH__EC.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function W(t){return t?typeof t=="string"?t:t.source:null}function m(t){return e("(?=",t,")")}function e(...t){return t.map(A=>W(A)).join("")}function fe(t){const o=t[t.length-1];return typeof o=="object"&&o.constructor===Object?(t.splice(t.length-1,1),o):{}}function s(...t){return"("+(fe(t).capture?"":"?:")+t.map(c=>W(c)).join("|")+")"}const g=t=>e(/\b/,t,/\w$/.test(t)?/\b/:/\B/),he=["Protocol","Type"].map(g),K=["init","self"].map(g),ye=["Any","Self"],C=["actor","any","associatedtype","async","await",/as\?/,/as!/,"as","borrowing","break","case","catch","class","consume","consuming","continue","convenience","copy","default","defer","deinit","didSet","distributed","do","dynamic","each","else","enum","extension","fallthrough",/fileprivate\(set\)/,"fileprivate","final","for","func","get","guard","if","import","indirect","infix",/init\?/,/init!/,"inout",/internal\(set\)/,"internal","in","is","isolated","nonisolated","lazy","let","macro","mutating","nonmutating",/open\(set\)/,"open","operator","optional","override","package","postfix","precedencegroup","prefix",/private\(set\)/,"private","protocol",/public\(set\)/,"public","repeat","required","rethrows","return","set","some","static","struct","subscript","super","switch","throws","throw",/try\?/,/try!/,"try","typealias",/unowned\(safe\)/,/unowned\(unsafe\)/,"unowned","var","weak","where","while","willSet"],G=["false","nil","true"],Ne=["assignment","associativity","higherThan","left","lowerThan","none","right"],Te=["#colorLiteral","#column","#dsohandle","#else","#elseif","#endif","#error","#file","#fileID","#fileLiteral","#filePath","#function","#if","#imageLiteral","#keyPath","#line","#selector","#sourceLocation","#warning"],x=["abs","all","any","assert","assertionFailure","debugPrint","dump","fatalError","getVaList","isKnownUniquelyReferenced","max","min","numericCast","pointwiseMax","pointwiseMin","precondition","preconditionFailure","print","readLine","repeatElement","sequence","stride","swap","swift_unboxFromSwiftValueWithType","transcode","type","unsafeBitCast","unsafeDowncast","withExtendedLifetime","withUnsafeMutablePointer","withUnsafePointer","withVaList","withoutActuallyEscaping","zip"],$=s(/[/=\-+!*%<>&|^~?]/,/[\u00A1-\u00A7]/,/[\u00A9\u00AB]/,/[\u00AC\u00AE]/,/[\u00B0\u00B1]/,/[\u00B6\u00BB\u00BF\u00D7\u00F7]/,/[\u2016-\u2017]/,/[\u2020-\u2027]/,/[\u2030-\u203E]/,/[\u2041-\u2053]/,/[\u2055-\u205E]/,/[\u2190-\u23FF]/,/[\u2500-\u2775]/,/[\u2794-\u2BFF]/,/[\u2E00-\u2E7F]/,/[\u3001-\u3003]/,/[\u3008-\u3020]/,/[\u3030]/),Y=s($,/[\u0300-\u036F]/,/[\u1DC0-\u1DFF]/,/[\u20D0-\u20FF]/,/[\uFE00-\uFE0F]/,/[\uFE20-\uFE2F]/),S=e($,Y,"*"),j=s(/[a-zA-Z_]/,/[\u00A8\u00AA\u00AD\u00AF\u00B2-\u00B5\u00B7-\u00BA]/,/[\u00BC-\u00BE\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u00FF]/,/[\u0100-\u02FF\u0370-\u167F\u1681-\u180D\u180F-\u1DBF]/,/[\u1E00-\u1FFF]/,/[\u200B-\u200D\u202A-\u202E\u203F-\u2040\u2054\u2060-\u206F]/,/[\u2070-\u20CF\u2100-\u218F\u2460-\u24FF\u2776-\u2793]/,/[\u2C00-\u2DFF\u2E80-\u2FFF]/,/[\u3004-\u3007\u3021-\u302F\u3031-\u303F\u3040-\uD7FF]/,/[\uF900-\uFD3D\uFD40-\uFDCF\uFDF0-\uFE1F\uFE30-\uFE44]/,/[\uFE47-\uFEFE\uFF00-\uFFFD]/),T=s(j,/\d/,/[\u0300-\u036F\u1DC0-\u1DFF\u20D0-\u20FF\uFE20-\uFE2F]/),a=e(j,T,"*"),N=e(/[A-Z]/,T,"*"),Re=["attached","autoclosure",e(/convention\(/,s("swift","block","c"),/\)/),"discardableResult","dynamicCallable","dynamicMemberLookup","escaping","freestanding","frozen","GKInspectable","IBAction","IBDesignable","IBInspectable","IBOutlet","IBSegueAction","inlinable","main","nonobjc","NSApplicationMain","NSCopying","NSManaged",e(/objc\(/,a,/\)/),"objc","objcMembers","propertyWrapper","requires_stored_property_inits","resultBuilder","Sendable","testable","UIApplicationMain","unchecked","unknown","usableFromInline","warn_unqualified_access"],_e=["iOS","iOSApplicationExtension","macOS","macOSApplicationExtension","macCatalyst","macCatalystApplicationExtension","watchOS","watchOSApplicationExtension","tvOS","tvOSApplicationExtension","swift"];function we(t){const o={match:/\s+/,relevance:0},A=t.COMMENT("/\\*","\\*/",{contains:["self"]}),c=[t.C_LINE_COMMENT_MODE,A],X={match:[/\./,s(...he,...K)],className:{2:"keyword"}},z={match:e(/\./,s(...C)),relevance:0},H=C.filter(n=>typeof n=="string").concat(["_|0"]),V=C.filter(n=>typeof n!="string").concat(ye).map(g),q={variants:[{className:"keyword",match:s(...V,...K)}]},i={$pattern:s(/\b\w+/,/#\w+/),keyword:H.concat(Te),literal:G},r=[X,z,q],Z={match:e(/\./,s(...x)),relevance:0},J={className:"built_in",match:e(/\b/,s(...x),/(?=\()/)},R=[Z,J],O={match:/->/,relevance:0},Q={className:"operator",relevance:0,variants:[{match:S},{match:`\\.(\\.|${Y})+`}]},E=[O,Q],b="([0-9]_*)+",D="([0-9a-fA-F]_*)+",d={className:"number",relevance:0,variants:[{match:`\\b(${b})(\\.(${b}))?([eE][+-]?(${b}))?\\b`},{match:`\\b0x(${D})(\\.(${D}))?([pP][+-]?(${b}))?\\b`},{match:/\b0o([0-7]_*)+\b/},{match:/\b0b([01]_*)+\b/}]},v=(n="")=>({className:"subst",variants:[{match:e(/\\/,n,/[0\\tnr"']/)},{match:e(/\\/,n,/u\{[0-9a-fA-F]{1,8}\}/)}]}),ee=(n="")=>({className:"subst",match:e(/\\/,n,/[\t ]*(?:[\r\n]|\r\n)/)}),P=(n="")=>({className:"subst",label:"interpol",begin:e(/\\/,n,/\(/),end:/\)/}),F=(n="")=>({begin:e(n,/"""/),end:e(/"""/,n),contains:[v(n),ee(n),P(n)]}),f=(n="")=>({begin:e(n,/"/),end:e(/"/,n),contains:[v(n),P(n)]}),l={className:"string",variants:[F(),F("#"),F("##"),F("###"),f(),f("#"),f("##"),f("###")]},L=[t.BACKSLASH_ESCAPE,{begin:/\[/,end:/\]/,relevance:0,contains:[t.BACKSLASH_ESCAPE]}],ne={begin:/\/[^\s](?=[^/\n]*\/)/,end:/\//,contains:L},_=n=>{const y=e(n,/\//),p=e(/\//,n);return{begin:y,end:p,contains:[...L,{scope:"comment",begin:`#(?!.*${p})`,end:/$/}]}},k={scope:"regexp",variants:[_("###"),_("##"),_("#"),ne]},B={match:e(/`/,a,/`/)},te={className:"variable",match:/\$\d+/},se={className:"variable",match:`\\$${T}+`},w=[B,te,se],ae={match:/(@|#(un)?)available/,scope:"keyword",starts:{contains:[{begin:/\(/,end:/\)/,keywords:_e,contains:[...E,d,l]}]}},oe={scope:"keyword",match:e(/@/,s(...Re),m(s(/\(/,/\s+/)))},ce={scope:"meta",match:e(/@/,a)},h=[ae,oe,ce],u={match:m(/\b[A-Z]/),relevance:0,contains:[{className:"type",match:e(/(AV|CA|CF|CG|CI|CL|CM|CN|CT|MK|MP|MTK|MTL|NS|SCN|SK|UI|WK|XC)/,T,"+")},{className:"type",match:N,relevance:0},{match:/[?!]+/,relevance:0},{match:/\.\.\./,relevance:0},{match:e(/\s+&\s+/,m(N)),relevance:0}]},ie={begin:/</,end:/>/,keywords:i,contains:[...c,...r,...h,O,u]};u.contains.push(ie);const re={match:e(a,/\s*:/),keywords:"_|0",relevance:0},M={begin:/\(/,end:/\)/,relevance:0,keywords:i,contains:["self",re,...c,k,...r,...R,...E,d,l,...w,...h,u]},I={begin:/</,end:/>/,keywords:"repeat each",contains:[...c,u]},ue={begin:s(m(e(a,/\s*:/)),m(e(a,/\s+/,a,/\s*:/))),end:/:/,relevance:0,contains:[{className:"keyword",match:/\b_\b/},{className:"params",match:a}]},U={begin:/\(/,end:/\)/,keywords:i,contains:[ue,...c,...r,...E,d,l,...h,u,M],endsParent:!0,illegal:/["']/},le={match:[/(func|macro)/,/\s+/,s(B.match,a,S)],className:{1:"keyword",3:"title.function"},contains:[I,U,o],illegal:[/\[/,/%/]},Ee={match:[/\b(?:subscript|init[?!]?)/,/\s*(?=[<(])/],className:{1:"keyword"},contains:[I,U,o],illegal:/\[|%/},de={match:[/operator/,/\s+/,S],className:{1:"keyword",3:"title"}},pe={begin:[/precedencegroup/,/\s+/,N],className:{1:"keyword",3:"title"},contains:[u],keywords:[...Ne,...G],end:/}/},me={match:[/class\b/,/\s+/,/func\b/,/\s+/,/\b[A-Za-z_][A-Za-z0-9_]*\b/],scope:{1:"keyword",3:"keyword",5:"title.function"}},Ae={match:[/class\b/,/\s+/,/var\b/],scope:{1:"keyword",3:"keyword"}},be={begin:[/(struct|protocol|class|extension|enum|actor)/,/\s+/,a,/\s*/],beginScope:{1:"keyword",3:"title.class"},keywords:i,contains:[I,...r,{begin:/:/,end:/\{/,keywords:i,contains:[{scope:"title.class.inherited",match:N},...r],relevance:0}]};for(const n of l.variants){const y=n.contains.find(Fe=>Fe.label==="interpol");y.keywords=i;const p=[...r,...R,...E,d,l,...w];y.contains=[...p,{begin:/\(/,end:/\)/,contains:["self",...p]}]}return{name:"Swift",keywords:i,contains:[...c,le,Ee,me,Ae,be,de,pe,{beginKeywords:"import",end:/$/,contains:[...c],relevance:0},k,...r,...R,...E,d,l,...w,...h,u,M]}}exports.default=we;

package/dist/types/openapi.d.ts

@@ -0,0 +1,85 @@
+import { OpenAPIV3, OpenAPIV3_1 } from 'openapi-types';
+import { SchemaNodeData } from './schema';
+export type OpenAPIInfoData = OpenAPIV3.InfoObject | OpenAPIV3_1.InfoObject;
+export type OpenAPIServerData = OpenAPIV3.ServerObject | OpenAPIV3_1.ServerObject;
+export type OpenAPIServerVariableData = OpenAPIV3.ServerVariableObject | OpenAPIV3_1.ServerVariableObject;
+export type OpenAPIParameterData = OpenAPIV3.ParameterObject | OpenAPIV3_1.ParameterObject;
+export type OpenAPIRequestBodyData = OpenAPIV3.RequestBodyObject | OpenAPIV3_1.RequestBodyObject;
+export type OpenAPIResponseData = OpenAPIV3.ResponseObject | OpenAPIV3_1.ResponseObject;
+export type OpenAPIMediaTypeData = OpenAPIV3.MediaTypeObject | OpenAPIV3_1.MediaTypeObject;
+export type OpenAPIHeaderData = OpenAPIV3.HeaderObject | OpenAPIV3_1.HeaderObject;
+export type OpenAPILinkData = OpenAPIV3.LinkObject | OpenAPIV3_1.LinkObject;
+export type OpenAPISecuritySchemeData = OpenAPIV3.SecuritySchemeObject | OpenAPIV3_1.SecuritySchemeObject;
+export type OpenAPITagData = OpenAPIV3.TagObject | OpenAPIV3_1.TagObject;
+export type OpenAPIExternalDocsData = OpenAPIV3.ExternalDocumentationObject | OpenAPIV3_1.ExternalDocumentationObject;
+export declare const HTTP_METHODS: readonly ["get", "put", "post", "delete", "options", "head", "patch", "trace"];
+export type HttpMethod = (typeof HTTP_METHODS)[number];
+export interface OpenAPIOperationData extends Record<string, unknown> {
+    operationId?: string;
+    summary?: string;
+    description?: string;
+    tags?: string[];
+    parameters?: OpenAPIParameterData[];
+    requestBody?: OpenAPIRequestBodyData;
+    responses?: Record<string, OpenAPIResponseData>;
+    security?: Array<Record<string, string[]>>;
+    deprecated?: boolean;
+    externalDocs?: OpenAPIExternalDocsData;
+    /**
+     * Out-of-band requests the API sends *to the caller* after this operation.
+     * Keyed by callback name, then by a URL-template expression naming where the
+     * request goes, whose value is a Path Item Object like any other.
+     */
+    callbacks?: Record<string, OpenAPICallbackData>;
+}
+/** One callback's URL-expression map. Each value is a Path Item Object, so it renders like any other operation. */
+export type OpenAPICallbackData = Record<string, OpenAPIPathItemData>;
+export type OpenAPIPathItemData = Partial<Record<HttpMethod, OpenAPIOperationData>> & {
+    summary?: string;
+    description?: string;
+    parameters?: OpenAPIParameterData[];
+};
+export interface FlatEndpoint {
+    key: string;
+    method: HttpMethod;
+    path: string;
+}
+export declare const endpointKey: (method: string, path: string) => string;
+/**
+ * Parameters shared across every method on a path can be declared once on
+ * the PathItem instead of repeated per operation (e.g. a `{userId}` path
+ * param declared on `/users/{userId}` itself) — merge those in, with the
+ * operation's own parameters overriding a path-item one of the same name+in.
+ */
+export declare function resolveOperationParameters(pathItem: OpenAPIPathItemData | undefined, operation: OpenAPIOperationData | null | undefined): OpenAPIParameterData[];
+/** Flattens `paths` (each holding multiple HTTP methods) into one row per operation, sorted by path. Shared by Paths.tsx (the Endpoints list) and OpenAPINavigation.tsx (the sidebar), which otherwise duplicated this walk. */
+export declare function flattenEndpoints(paths: Record<string, OpenAPIPathItemData | undefined>): FlatEndpoint[];
+/**
+ * Internal document model produced by both entry points (mirrors
+ * AsyncAPIDocumentData). Both the no-parser path and `@scalar/openapi-parser`
+ * output are normalized through `resolveDocument`, so downstream components
+ * always deal with one shape: a plain acyclic object tree where cycle points
+ * are `$ref` nodes resolved lazily via the context's `deref` (see
+ * resolveDocument's contract).
+ */
+export interface OpenAPIDocumentData extends Record<string, unknown> {
+    openapi: string;
+    info: OpenAPIInfoData;
+    servers?: OpenAPIServerData[];
+    paths?: Record<string, OpenAPIPathItemData | undefined>;
+    /**
+     * OpenAPI 3.1's top-level `webhooks`: operations the API sends *out* rather
+     * than ones a client calls. Each value is a Path Item Object exactly like
+     * `paths`', keyed by an event name instead of a URL path, so both render
+     * through the same components.
+     */
+    webhooks?: Record<string, OpenAPIPathItemData | undefined>;
+    components?: {
+        schemas?: Record<string, SchemaNodeData>;
+        securitySchemes?: Record<string, OpenAPISecuritySchemeData>;
+        [key: string]: unknown;
+    };
+    security?: Array<Record<string, string[]>>;
+    tags?: OpenAPITagData[];
+    externalDocs?: OpenAPIExternalDocsData;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apiuikit",
-  "version": "0.3.0",
+  "version": "1.0.0",
   "description": "A React UI library for rendering your API specifications",
   "license": "MIT",
   "repository": {
@@ -8,6 +8,9 @@
     "url": "https://github.com/AceTheCreator/apiuikit"
   },
   "type": "module",
+  "sideEffects": [
+    "*.css"
+  ],
   "main": "./dist/apiuikit.cjs.js",
   "module": "./dist/apiuikit.es.js",
   "types": "./dist/index.d.ts",
@@ -41,6 +44,7 @@
   "dependencies": {
     "@asyncapi/specs": "^6.8.1",
     "@json-schema-tools/reference-resolver": "^1.2.6",
+    "@readme/httpsnippet": "^11.4.0",
     "fuse.js": "^7.5.0",
     "highlight.js": "^11.11.1",
     "isomorphic-dompurify": "^2.24.0",
@@ -48,22 +52,30 @@
     "json-schema-resolver": "^3.0.0",
     "marked": "^15.0.11",
     "marked-highlight": "^2.2.1",
+    "openapi-types": "^12.1.3",
     "protobufjs": "^7.4.0",
     "react-markdown": "^9.0.3",
-    "remark-gfm": "^4.0.1"
+    "remark-gfm": "^4.0.1",
+    "url": "^0.11.4"
   },
   "peerDependencies": {
     "@asyncapi/parser": "^3.6.0",
+    "@scalar/openapi-parser": "^0.28.10",
     "react": ">=18",
     "react-dom": ">=18"
   },
   "peerDependenciesMeta": {
     "@asyncapi/parser": {
       "optional": true
+    },
+    "@scalar/openapi-parser": {
+      "optional": true
     }
   },
   "devDependencies": {
     "@asyncapi/modelina": "^5.10.1",
+    "@asyncapi/parser": "^3.6.0",
+    "@scalar/openapi-parser": "^0.28.10",
     "@chromatic-com/storybook": "^3.2.3",
     "@eslint/js": "^9.17.0",
     "@storybook/addon-a11y": "^8.6.18",
@@ -97,7 +109,8 @@
     "typescript-eslint": "^8.18.2",
     "vite": "^6.0.5",
     "vite-plugin-dts": "^5.0.3",
-    "vitest": "^4.1.10"
+    "vitest": "^4.1.10",
+    "x-tensions": "*"
   },
   "eslintConfig": {
     "extends": [

package/dist/components/Navigation.d.ts

@@ -1,28 +0,0 @@
-import { Operation } from '../types/asyncapi/Operation';
-import { MessageObject } from '../types/asyncapi/MessageObject';
-import { Info } from '../types/asyncapi/Info';
-import { SideBarConfig } from '../config/config';
-export type NavTab = "operations" | "messages" | "schemas";
-export type NavSectionId = NavTab | "servers";
-interface NavigationProps {
-    info: Info;
-    operations?: Record<string, Operation>;
-    messages?: Record<string, MessageObject>;
-    schemas?: Record<string, unknown>;
-    servers?: Record<string, unknown>;
-    /** Which section is currently the user's focus, for header highlighting —
-     * a single authoritative value covering all four sections (including
-     * Servers) so at most one header is ever highlighted at once. Distinct
-     * from `onTabChange`, which only fires for the three switchable tabs. */
-    activeTab: NavSectionId | null;
-    onTabChange: (tab: NavTab) => void;
-    onItemSelect?: (tab: NavTab, key: string) => void;
-    onSelectServer?: (key: string) => void;
-    selectedItem?: {
-        tab: NavSectionId;
-        key: string;
-    } | null;
-    sidebarConfig?: SideBarConfig;
-}
-export default function Navigation({ info, operations, messages, schemas, servers, activeTab, onTabChange, onItemSelect, onSelectServer, selectedItem, sidebarConfig, }: NavigationProps): import("react").JSX.Element;
-export {};

package/dist/icons/SideBar.d.ts

@@ -1,6 +0,0 @@
-import { default as React } from 'react';
-interface SidebarIconProps {
-    isCollapsed: boolean;
-}
-declare const SidebarIcon: React.FC<SidebarIconProps>;
-export default SidebarIcon;