@digi-frontend/dgate-api-documentation 1.1.7 → 1.1.9

package/dist/types/types/openApi.d.ts

@@ -0,0 +1,98 @@
+export interface OpenAPIFile {
+    openapi: string;
+    info: {
+        title: string;
+        description: string;
+        version: string;
+    };
+    servers?: {
+        url: string;
+        description?: string;
+    }[];
+    paths: {
+        [path: string]: Partial<Record<HTTPMethod, {
+            tags: string[];
+            responses: Responses;
+            summary?: string;
+            description?: string;
+            parameters?: Parameter[];
+            requestBody?: RequestBody;
+        }>>;
+    };
+    components?: {
+        schemas?: {
+            [schemaName: string]: Schema;
+        };
+        securitySchemes?: {
+            [schemeName: string]: SecurityScheme;
+        };
+    };
+    security?: {
+        [schemeName: string]: string[];
+    }[];
+    tags?: {
+        name: string;
+        description?: string;
+        externalDocs?: {
+            url: string;
+            description: string;
+        }[];
+    }[];
+}
+export interface Tags {
+    name: string;
+    description?: string;
+    externalDocs?: {
+        url: string;
+        description: string;
+    }[];
+}
+export interface Parameter {
+    name: string;
+    in: 'query' | 'header' | 'path' | 'cookie';
+    description?: string;
+    required: boolean;
+    schema: Schema;
+}
+export interface RequestBody {
+    description?: string;
+    required: boolean;
+    content: {
+        [contentType: string]: {
+            schema: Schema;
+        };
+    };
+}
+export interface Responses {
+    [statusCode: string]: {
+        description: string;
+        headers?: any;
+        content?: {
+            [contentType: string]: {
+                schema: Schema;
+            };
+        };
+    };
+}
+interface Schema {
+    type?: string;
+    format?: string;
+    properties?: {
+        [propertyName: string]: Schema;
+    };
+    items?: Schema;
+    enum?: string[];
+    required?: string[];
+}
+export interface SecurityScheme {
+    type: 'apiKey' | 'http' | 'oauth2' | 'openIdConnect';
+    description?: string;
+    name?: string;
+    in?: 'query' | 'header' | 'cookie';
+    scheme?: string;
+    bearerFormat?: string;
+    flows?: any;
+    openIdConnectUrl?: string;
+}
+export type HTTPMethod = 'get' | 'put' | 'post' | 'delete' | 'options' | 'head' | 'patch' | 'trace';
+export {};

package/dist/types/types/transformedOpenApi.d.ts

@@ -0,0 +1,50 @@
+import { TransformedPathsArray } from "./layout.type";
+export interface TransformedOpenApi {
+    openapi: string;
+    info: {
+        title: string;
+        description?: string;
+        version: string;
+    };
+    servers?: {
+        url: string;
+        description?: string;
+    }[];
+    paths: TransformedPathsArray;
+    components?: {
+        schemas?: {
+            [schemaName: string]: Schema;
+        };
+        securitySchemes?: {
+            [schemeName: string]: SecurityScheme;
+        };
+    };
+    security?: {
+        [schemeName: string]: string[];
+    }[];
+    tags?: {
+        name: string;
+        description?: string;
+    }[];
+}
+interface Schema {
+    type?: string;
+    format?: string;
+    properties?: {
+        [propertyName: string]: Schema;
+    };
+    items?: Schema;
+    enum?: string[];
+    required?: string[];
+}
+interface SecurityScheme {
+    type: "apiKey" | "http" | "oauth2" | "openIdConnect";
+    description?: string;
+    name?: string;
+    in?: "query" | "header" | "cookie";
+    scheme?: string;
+    bearerFormat?: string;
+    flows?: any;
+    openIdConnectUrl?: string;
+}
+export {};

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

@@ -0,0 +1,2 @@
+export declare const copyToClipboard: (text: string) => Promise<unknown>;
+export declare const capitalizeFirstLetter: (text: string) => string;

package/dist/types/validator/form.scheme.d.ts

@@ -0,0 +1,49 @@
+import * as yup from 'yup';
+export declare const schemaValidation: yup.ObjectSchema<{
+    openapi: string;
+    info: {
+        title: string;
+        description: string;
+        version: string;
+    };
+    servers: {
+        description?: string | undefined;
+        url: string;
+    }[] | undefined;
+    paths: {
+        path: string;
+        methods: {
+            type?: string | undefined;
+            description?: string | undefined;
+            tags?: (string | undefined)[] | undefined;
+            requestBody?: {} | undefined;
+            summary: string;
+        }[];
+    }[];
+    components: {
+        securitySchemes?: {} | undefined;
+        schemas?: {} | undefined;
+    } | undefined;
+    security: {
+        schemeName?: (string | undefined)[] | undefined;
+    }[] | undefined;
+    tags: {
+        description?: string | undefined;
+        name: string;
+    }[] | undefined;
+}, yup.AnyObject, {
+    openapi: undefined;
+    info: {
+        title: undefined;
+        description: undefined;
+        version: undefined;
+    };
+    servers: undefined;
+    paths: "";
+    components: {
+        schemas: undefined;
+        securitySchemes: {};
+    };
+    security: undefined;
+    tags: undefined;
+}, "">;

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@digi-frontend/dgate-api-documentation",
-  "version": "1.1.7",
-  "main": "dist/index.js",
-  "module": "dist/index.mjs",
+  "version": "1.1.9",
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.esm.js",
   "types": "dist/index.d.ts",
   "files": [
     "dist",
@@ -10,8 +10,8 @@
   ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "build_old": "tsc --noEmit --skipLibCheck || true && rollup -c || true",
-    "build": "tsup src/index.ts --dts --format esm,cjs --out-dir dist"
+    "build": "tsc --noEmit --skipLibCheck || true && rollup -c || true",
+    "build_old": "tsup src/index.ts --dts --format esm,cjs --out-dir dist"
   },
   "exports": {
     ".": "./src/index.ts"
@@ -31,6 +31,9 @@
     "react-dom": "^18.0.0",
     "react-syntax-highlighter": "^15.6.1",
     "react-toastify": "^11.0.5",
+    "rollup-plugin-dts": "^6.2.3",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
+    "rollup-plugin-scss": "^4.0.1",
     "tslib": "^2.8.1",
     "yup": "^1.6.1"
   },