skuse-ui 0.1.0

package/dist/types/openapi.d.ts

@@ -0,0 +1,2 @@
+export * from './unified-openapi-types';
+export type { EnhancedOperationObject, TaggedOperationsMap } from './unified-openapi-types';

package/dist/types/unified-openapi-types.d.ts

@@ -0,0 +1,402 @@
+import { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from 'openapi-types';
+export type OpenAPIInputDocument = OpenAPIV2.Document | OpenAPIV3.Document | OpenAPIV3_1.Document | {
+    openapi: string;
+    [key: string]: any;
+};
+export type HttpMethod = 'GET' | 'PUT' | 'POST' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'PATCH' | 'TRACE';
+export type PathsObject = {
+    [path: string]: PathItemObject;
+};
+export interface UnifiedOpenAPI {
+    openapi?: string;
+    swagger?: string;
+    info: {
+        title: string;
+        description?: string;
+        termsOfService?: string;
+        contact?: {
+            name?: string;
+            url?: string;
+            email?: string;
+        };
+        license?: {
+            name: string;
+            url?: string;
+            identifier?: string;
+        };
+        version: string;
+        summary?: string;
+    };
+    servers?: ServerObject[];
+    paths: {
+        [path: string]: {
+            summary?: string;
+            description?: string;
+            get?: OperationObject;
+            put?: OperationObject;
+            post?: OperationObject;
+            delete?: OperationObject;
+            options?: OperationObject;
+            head?: OperationObject;
+            patch?: OperationObject;
+            trace?: OperationObject;
+            servers?: ServerObject[];
+            parameters?: ParameterObject[];
+        };
+    };
+    components?: {
+        schemas?: {
+            [key: string]: SchemaObject;
+        };
+        responses?: {
+            [key: string]: ResponseObject;
+        };
+        parameters?: {
+            [key: string]: ParameterObject;
+        };
+        examples?: {
+            [key: string]: ExampleObject;
+        };
+        requestBodies?: {
+            [key: string]: RequestBodyObject;
+        };
+        headers?: {
+            [key: string]: HeaderObject;
+        };
+        securitySchemes?: {
+            [key: string]: SecuritySchemeObject;
+        };
+        links?: {
+            [key: string]: LinkObject;
+        };
+        callbacks?: {
+            [key: string]: CallbackObject;
+        };
+        pathItems?: {
+            [key: string]: PathItemObject;
+        };
+    };
+    security?: Array<{
+        [key: string]: string[];
+    }>;
+    tags?: Array<{
+        name: string;
+        description?: string;
+        externalDocs?: {
+            description?: string;
+            url: string;
+        };
+    }>;
+    externalDocs?: {
+        description?: string;
+        url: string;
+    };
+    webhooks?: PathsObject;
+    $defs?: Record<string, SchemaObject>;
+}
+export interface OperationObject {
+    tags?: string[];
+    summary?: string;
+    description?: string;
+    externalDocs?: {
+        description?: string;
+        url: string;
+    };
+    operationId?: string;
+    parameters?: ParameterObject[];
+    requestBody?: RequestBodyObject;
+    responses: {
+        [statusCode: string]: ResponseObject;
+    };
+    callbacks?: {
+        [key: string]: CallbackObject;
+    };
+    deprecated?: boolean;
+    security?: Array<{
+        [key: string]: string[];
+    }>;
+    servers?: ServerObject[];
+}
+export interface ParameterObject {
+    name: string;
+    in: string;
+    description?: string;
+    required?: boolean;
+    deprecated?: boolean;
+    allowEmptyValue?: boolean;
+    style?: string;
+    explode?: boolean;
+    allowReserved?: boolean;
+    schema?: SchemaObject;
+    example?: any;
+    examples?: {
+        [key: string]: ExampleObject;
+    };
+    content?: {
+        [key: string]: MediaTypeObject;
+    };
+}
+export interface SchemaObject {
+    type?: string | string[];
+    ref?: string;
+    refName?: string;
+    items?: SchemaObject;
+    properties?: {
+        [key: string]: SchemaObject;
+    };
+    additionalProperties?: boolean | SchemaObject;
+    description?: string;
+    format?: string;
+    default?: any;
+    title?: string;
+    multipleOf?: number;
+    maximum?: number;
+    exclusiveMaximum?: boolean | number;
+    minimum?: number;
+    exclusiveMinimum?: boolean | number;
+    maxLength?: number;
+    minLength?: number;
+    pattern?: string;
+    maxItems?: number;
+    minItems?: number;
+    uniqueItems?: boolean;
+    maxProperties?: number;
+    minProperties?: number;
+    required?: string[];
+    enum?: any[];
+    allOf?: SchemaObject[];
+    oneOf?: SchemaObject[];
+    anyOf?: SchemaObject[];
+    not?: SchemaObject;
+    nullable?: boolean;
+    discriminator?: {
+        propertyName: string;
+        mapping?: {
+            [key: string]: string;
+        };
+    };
+    readOnly?: boolean;
+    writeOnly?: boolean;
+    xml?: {
+        name?: string;
+        namespace?: string;
+        prefix?: string;
+        attribute?: boolean;
+        wrapped?: boolean;
+    };
+    externalDocs?: {
+        description?: string;
+        url: string;
+    };
+    example?: any;
+    examples?: any[];
+    deprecated?: boolean;
+    const?: any;
+    contentMediaType?: string;
+    contentEncoding?: string;
+    patternProperties?: {
+        [pattern: string]: SchemaObject;
+    };
+    propertyNames?: SchemaObject;
+    prefixItems?: SchemaObject[];
+    if?: SchemaObject;
+    then?: SchemaObject;
+    else?: SchemaObject;
+    contains?: SchemaObject;
+    minContains?: number;
+    maxContains?: number;
+    unevaluatedProperties?: boolean | SchemaObject;
+    unevaluatedItems?: boolean | SchemaObject;
+    $defs?: Record<string, SchemaObject>;
+    $schema?: string;
+}
+export interface ResponseObject {
+    description: string;
+    headers?: {
+        [header: string]: HeaderObject;
+    };
+    content?: {
+        [mediaType: string]: MediaTypeObject;
+    };
+    links?: {
+        [key: string]: LinkObject;
+    };
+}
+export interface RequestBodyObject {
+    description?: string;
+    content: {
+        [mediaType: string]: MediaTypeObject;
+    };
+    required?: boolean;
+}
+export interface MediaTypeObject {
+    schema?: SchemaObject;
+    example?: any;
+    examples?: {
+        [key: string]: ExampleObject;
+    };
+    encoding?: {
+        [key: string]: EncodingObject;
+    };
+}
+export interface HeaderObject {
+    description?: string;
+    type?: string;
+    required?: boolean;
+    deprecated?: boolean;
+    allowEmptyValue?: boolean;
+    style?: string;
+    explode?: boolean;
+    allowReserved?: boolean;
+    schema?: SchemaObject;
+    example?: any;
+    examples?: {
+        [key: string]: ExampleObject;
+    };
+    content?: {
+        [key: string]: MediaTypeObject;
+    };
+}
+export interface ExampleObject {
+    summary?: string;
+    description?: string;
+    value?: any;
+    externalValue?: string;
+}
+export interface LinkObject {
+    operationRef?: string;
+    operationId?: string;
+    parameters?: {
+        [key: string]: any;
+    };
+    requestBody?: any;
+    description?: string;
+    server?: {
+        url: string;
+        description?: string;
+        variables?: {
+            [key: string]: {
+                enum?: string[];
+                default: string;
+                description?: string;
+            };
+        };
+    };
+}
+export interface CallbackObject {
+    [key: string]: PathItemObject;
+}
+export interface PathItemObject {
+    summary?: string;
+    description?: string;
+    get?: OperationObject;
+    put?: OperationObject;
+    post?: OperationObject;
+    delete?: OperationObject;
+    options?: OperationObject;
+    head?: OperationObject;
+    patch?: OperationObject;
+    trace?: OperationObject;
+    servers?: ServerObject[];
+    parameters?: ParameterObject[];
+}
+export interface EncodingObject {
+    contentType?: string;
+    headers?: {
+        [key: string]: HeaderObject;
+    };
+    style?: string;
+    explode?: boolean;
+    allowReserved?: boolean;
+}
+export interface ServerObject {
+    url: string;
+    description?: string;
+    variables?: {
+        [key: string]: ServerVariableObject;
+    };
+}
+export interface ServerVariableObject {
+    enum?: string[];
+    default: string;
+    description?: string;
+}
+export type SecuritySchemeObject = {
+    type: 'http' | 'basic';
+    description?: string;
+    scheme: string;
+    bearerFormat?: string;
+} | {
+    type: 'apiKey';
+    description?: string;
+    name: string;
+    in: string;
+} | {
+    type: 'oauth2';
+    description?: string;
+    flows: {
+        implicit?: {
+            authorizationUrl: string;
+            refreshUrl?: string;
+            scopes: {
+                [scope: string]: string;
+            };
+        };
+        password?: {
+            tokenUrl: string;
+            refreshUrl?: string;
+            scopes: {
+                [scope: string]: string;
+            };
+        };
+        clientCredentials?: {
+            tokenUrl: string;
+            refreshUrl?: string;
+            scopes: {
+                [scope: string]: string;
+            };
+        };
+        authorizationCode?: {
+            authorizationUrl: string;
+            tokenUrl: string;
+            refreshUrl?: string;
+            scopes: {
+                [scope: string]: string;
+            };
+        };
+    };
+} | {
+    type: 'openIdConnect';
+    description?: string;
+    openIdConnectUrl: string;
+};
+export type AuthCredential = {
+    type: 'bearer';
+    token: string;
+} | {
+    type: 'basic';
+    username: string;
+    password: string;
+} | {
+    type: 'apiKey';
+    key: string;
+    in: 'header' | 'query' | 'cookie';
+    name: string;
+} | {
+    type: 'oauth2';
+    accessToken: string;
+    tokenType: string;
+    scope?: string;
+    refreshToken?: string;
+    clientId?: string;
+} | {
+    type: 'openIdConnect';
+    accessToken: string;
+};
+export interface EnhancedOperationObject extends OperationObject {
+    path: string;
+    method: HttpMethod;
+    pathSummary?: string;
+    pathDescription?: string;
+}
+export type TaggedOperationsMap = Record<string, EnhancedOperationObject[]>;

package/dist/utils/openapi.d.ts

@@ -0,0 +1,18 @@
+import { SchemaObject, PathsObject, EnhancedOperationObject, TaggedOperationsMap, HttpMethod, OpenAPIInputDocument, UnifiedOpenAPI } from '../types/openapi';
+type JsonValue = string | number | boolean | null | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+declare const resolveOpenAPIDocument: (document: OpenAPIInputDocument) => UnifiedOpenAPI;
+declare const isNullableSchema: (schema: SchemaObject) => boolean;
+declare const renderSchemaType: (schema: SchemaObject) => string;
+declare const generateExample: (schema: SchemaObject | undefined) => JsonValue;
+declare function isValidHttpMethod(method: string): method is HttpMethod;
+declare function groupEndpointsByTags(paths: PathsObject): TaggedOperationsMap;
+declare function findOperationByOperationIdAndTag(paths: PathsObject, operationId: string, tag: string): EnhancedOperationObject | null;
+declare function groupWebhooksByName(webhooks: PathsObject): TaggedOperationsMap;
+declare function findWebhookOperation(webhooks: PathsObject, webhookName: string, operationId: string): EnhancedOperationObject | null;
+declare function getOperationId(operation: EnhancedOperationObject): string;
+declare function getBadgeColor(httpMethod: string): string;
+declare const flattenSchema: (schema: SchemaObject) => SchemaObject;
+declare const isEmptySchema: (schema: SchemaObject) => boolean;
+export { resolveOpenAPIDocument, groupEndpointsByTags, groupWebhooksByName, findOperationByOperationIdAndTag, findWebhookOperation, getBadgeColor, isValidHttpMethod, isNullableSchema, renderSchemaType, generateExample, flattenSchema, isEmptySchema, getOperationId };

package/dist/utils/pkce.d.ts

@@ -0,0 +1,2 @@
+export declare function generateCodeVerifier(): string;
+export declare function generateCodeChallenge(verifier: string): Promise<string>;

package/package.json

@@ -0,0 +1,94 @@
+{
+  "name": "skuse-ui",
+  "version": "0.1.0",
+  "description": "A modern, beautiful OpenAPI documentation viewer — fully compatible with OpenAPI 3.0 and 3.1",
+  "keywords": ["openapi", "swagger", "api", "documentation", "react", "ui"],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Piairre/skuse-ui.git"
+  },
+  "homepage": "https://github.com/Piairre/skuse-ui",
+  "type": "module",
+  "main": "./dist/skuse-ui.cjs.js",
+  "module": "./dist/skuse-ui.es.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/skuse-ui.es.js",
+      "require": "./dist/skuse-ui.cjs.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./style.css": "./dist/style.css"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc -b && vite build --mode lib",
+    "build:app": "tsc -b && vite build",
+    "lint": "eslint .",
+    "preview": "vite preview"
+  },
+  "peerDependencies": {
+    "react": ">=18",
+    "react-dom": ">=18"
+  },
+  "dependencies": {
+    "@radix-ui/react-accordion": "^1.2.1",
+    "@radix-ui/react-checkbox": "^1.3.5",
+    "@radix-ui/react-collapsible": "^1.1.1",
+    "@radix-ui/react-dialog": "^1.1.2",
+    "@radix-ui/react-dropdown-menu": "^2.1.6",
+    "@radix-ui/react-label": "^2.1.2",
+    "@radix-ui/react-popover": "^1.1.2",
+    "@radix-ui/react-scroll-area": "^1.2.3",
+    "@radix-ui/react-select": "^2.1.6",
+    "@radix-ui/react-slot": "^1.1.0",
+    "@radix-ui/react-switch": "^1.1.2",
+    "@radix-ui/react-tabs": "^1.1.1",
+    "@radix-ui/react-tooltip": "^1.2.10",
+    "@shadcn/ui": "^0.0.4",
+    "@tanstack/react-router": "^1.92.11",
+    "@uiw/react-markdown-preview": "^5.1.3",
+    "class-variance-authority": "^0.7.1",
+    "clsx": "^2.1.1",
+    "cmdk": "1.0.0",
+    "embla-carousel-react": "^8.6.0",
+    "embla-carousel-wheel-gestures": "^8.1.0",
+    "httpsnippet-lite": "^3.0.5",
+    "lucide-react": "^0.461.0",
+    "next-themes": "^0.4.6",
+    "openapi-types": "^12.1.3",
+    "prismjs": "^1.29.0",
+    "rehype-external-links": "^3.0.0",
+    "rehype-sanitize": "^6.0.0",
+    "sonner": "^2.0.7",
+    "tailwind-merge": "^2.5.5",
+    "tailwind-scrollbar": "^3.1.0",
+    "tailwindcss-animate": "^1.0.7"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.16.0",
+    "@hey-api/openapi-ts": "^0.59.0",
+    "@types/node": "^22.10.1",
+    "@types/prismjs": "^1.26.5",
+    "@types/react": "^18.3.12",
+    "@types/react-dom": "^18.3.1",
+    "@types/react-syntax-highlighter": "^15.5.13",
+    "@vitejs/plugin-react": "^4.3.4",
+    "autoprefixer": "^10.4.20",
+    "concurrently": "^9.1.0",
+    "eslint": "^9.16.0",
+    "eslint-plugin-react-hooks": "^5.0.0",
+    "eslint-plugin-react-refresh": "^0.4.14",
+    "globals": "^15.12.0",
+    "postcss": "^8.4.49",
+    "tailwindcss": "^3.4.15",
+    "typescript": "^5.7.2",
+    "typescript-eslint": "^8.16.0",
+    "vite": "^5.4.11",
+    "vite-plugin-dts": "^4.5.4"
+  }
+}