@digi-frontend/dgate-api-documentation 1.4.5 → 1.4.7

package/dist/layout/docsComponents/Codebox/Codebox.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+declare const Codebox: ({ code }: {
+    code: string;
+}) => React.JSX.Element;
+export default Codebox;

package/dist/layout/docsComponents/DocsAside/DocsAside.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+import { EndpointData } from 'src/layout/docsLayout';
+declare const DocsAside: ({ data }: {
+    data: EndpointData;
+}) => React.JSX.Element;
+export default DocsAside;

package/dist/layout/docsComponents/DocsContent/DocsContent.d.ts

@@ -0,0 +1,12 @@
+import React from 'react';
+import './style.scss';
+import { EndpointData, OverviewData } from 'src/layout/docsLayout';
+declare const DocsContent: ({ data, activeType, setActiveItemData, setActiveType, onProductNavigate, apis, }: {
+    data: OverviewData | EndpointData;
+    activeType: "OVERVIEW" | "ENDPOINT";
+    setActiveItemData: React.Dispatch<React.SetStateAction<OverviewData | EndpointData>>;
+    setActiveType: React.Dispatch<React.SetStateAction<"OVERVIEW" | "ENDPOINT">>;
+    onProductNavigate?: (productId: number) => void;
+    apis: OverviewData[];
+}) => React.JSX.Element;
+export default DocsContent;

package/dist/layout/docsComponents/DocsContent/EndpointPage/index.d.ts

@@ -0,0 +1,7 @@
+import { EndpointData, OverviewData } from 'src/layout/docsLayout';
+import './style.scss';
+export declare const EndpointPage: ({ data, setActiveType, setActiveItemData, }: {
+    data: EndpointData;
+    setActiveType: React.Dispatch<React.SetStateAction<"OVERVIEW" | "ENDPOINT">>;
+    setActiveItemData: React.Dispatch<React.SetStateAction<OverviewData | EndpointData>>;
+}) => import("react").JSX.Element;

package/dist/layout/docsComponents/DocsContent/OverviewPage/index.d.ts

@@ -0,0 +1,10 @@
+import './style.scss';
+import { EndpointData, OverviewData } from 'src/layout/docsLayout';
+import React from 'react';
+export declare const OverviewPage: ({ data, setActiveItemData, setActiveType, onProductNavigate, apis, }: {
+    data: OverviewData;
+    setActiveItemData: React.Dispatch<React.SetStateAction<OverviewData | EndpointData>>;
+    setActiveType: React.Dispatch<React.SetStateAction<"OVERVIEW" | "ENDPOINT">>;
+    onProductNavigate?: (productId: number) => void;
+    apis: OverviewData[];
+}) => React.JSX.Element;

package/dist/layout/docsComponents/DocsHeader/DocsHeader.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { OverviewData } from '../../../../src/layout/docsLayout';
+declare const DocsHeader: ({ transformedOpenApis, updateFilteredData, }: {
+    transformedOpenApis: OverviewData[];
+    updateFilteredData: (filteredItems: OverviewData[], isReset?: boolean) => void;
+}) => React.JSX.Element;
+export default DocsHeader;

package/dist/layout/docsComponents/DocsSideMenuTree/DocsSideMenuTree.d.ts

@@ -0,0 +1,18 @@
+import './style.scss';
+import React from 'react';
+import { EndpointData, OverviewData } from 'src/layout/docsLayout';
+declare const DocsSideMenuTree: ({ apis, setActiveItemData, isFirstApiExpanded, setIsFirstApiExpanded, setActiveType, canSelectFirstApi, canFocusSection, setCanFocusSection, activeApiId, setCanSelectFirstApi, }: {
+    apis: OverviewData[];
+    setActiveItemData: React.Dispatch<React.SetStateAction<OverviewData | EndpointData>>;
+    activeItemData: OverviewData | EndpointData;
+    isFirstApiExpanded: boolean;
+    setIsFirstApiExpanded: React.Dispatch<React.SetStateAction<boolean>>;
+    setActiveType: React.Dispatch<React.SetStateAction<"OVERVIEW" | "ENDPOINT">>;
+    activeType: "OVERVIEW" | "ENDPOINT";
+    canSelectFirstApi?: boolean;
+    canFocusSection: boolean;
+    setCanFocusSection: React.Dispatch<React.SetStateAction<boolean>>;
+    activeApiId: string;
+    setCanSelectFirstApi: React.Dispatch<React.SetStateAction<boolean>>;
+}) => React.JSX.Element;
+export default DocsSideMenuTree;

package/dist/layout/docsComponents/index.d.ts

@@ -0,0 +1,17 @@
+import React from 'react';
+import DocsHeader from './DocsHeader/DocsHeader';
+import DocsSideMenuTree from './DocsSideMenuTree/DocsSideMenuTree';
+import DocsContent from './DocsContent/DocsContent';
+import DocsAside from './DocsAside/DocsAside';
+import './index.scss';
+type LayoutProps = {
+    children: React.ReactNode;
+};
+type CompoundLayout = React.FC<LayoutProps> & {
+    DocsHeader: typeof DocsHeader;
+    DocsSideMenuTree: typeof DocsSideMenuTree;
+    DocsContent: typeof DocsContent;
+    DocsAside: typeof DocsAside;
+};
+declare const Layout: CompoundLayout;
+export default Layout;

package/dist/layout/docsLayout.d.ts

@@ -0,0 +1,31 @@
+import React, { JSX } from 'react';
+import { HTTPMethod, OpenAPIFile, Parameter, RequestBody, Responses } from '@entities/openApi';
+import { ApiSpecModel } from '@entities/index';
+interface ILayoutProps {
+    apis?: ApiSpecModel[];
+    activeApiId?: string;
+    onProductNavigate?: (productId: number) => void;
+}
+export interface TagData {
+    id: string;
+    method: HTTPMethod;
+    path: string;
+    tags: string[];
+    responses: Responses;
+    summary?: string;
+    description: string;
+    parameters?: Parameter[];
+    requestBody?: RequestBody;
+}
+export interface EndpointData extends TagData {
+    api: OverviewData;
+}
+export interface OverviewData extends Omit<ApiSpecModel, 'metaData'> {
+    description: string;
+    title: string;
+    version: string;
+    tags: Record<string, TagData[]>;
+    servers: OpenAPIFile['servers'];
+}
+declare const _default: React.MemoExoticComponent<({ apis, activeApiId, onProductNavigate }: ILayoutProps) => JSX.Element>;
+export default _default;

package/dist/layout/layout.d.ts

@@ -0,0 +1,10 @@
+import { JSX } from 'react';
+import { OpenAPIFile } from '../types/openApi';
+interface ILayoutProps {
+    openApiJson?: OpenAPIFile;
+    handleSave?: (values: unknown) => unknown;
+    setIsFormDirty?: any;
+    openApiErrors?: any;
+}
+declare const Layout: ({ openApiJson, handleSave, setIsFormDirty, openApiErrors, }: ILayoutProps) => JSX.Element;
+export default Layout;

package/dist/types/docsLayout.type.d.ts

@@ -0,0 +1,7 @@
+export declare enum SectionEnum {
+    OVERVIEW = "overview",
+    RESOURCE = "resource",
+    API_SECTION = "apiSection",
+    TAG_SECTION = "tagSection",
+    ENDPOINTS_SECTION = "endpointsSection"
+}

package/dist/types/index.d.ts

@@ -1,2 +1,27 @@
-export { default as Layout } from './layout/layout';
-export { default as DocsLayout } from './layout/docsLayout';
+import { OpenAPIFile } from './openApi';
+export interface ApiSpecModel {
+    apiSpecId: string;
+    contextPath: string;
+    apiVersions: {
+        addVersionToContextPath: boolean;
+        apiSpecId: string;
+        name: string;
+        metaData: {
+            version: string;
+        };
+    }[];
+    associatedProduct: {
+        availableOnDevPortal: boolean;
+        name: string;
+        premium: boolean;
+        productId: number;
+    };
+    metaData: {
+        version: string;
+        apiVersionOf: string;
+        openApiJson: OpenAPIFile;
+        tags: string[];
+        createdDateTime: string;
+        lastUpdatedDateTime: string;
+    };
+}

package/dist/types/layout.type.d.ts

@@ -0,0 +1,29 @@
+import { HTTPMethod } from './openApi';
+export type TransformedMethod = {
+    type: HTTPMethod;
+    tags: string[];
+    summary?: string;
+    parameters: any;
+    requestBody: {
+        content: {
+            contentType: string;
+            schema: {
+                properties: string;
+                type: string;
+            };
+        };
+    };
+    responses: {
+        code: string;
+        content: {
+            contentType?: string;
+            schema?: unknown;
+        };
+        headers: any;
+    }[];
+};
+export type TransformedPath = {
+    path: string;
+    methods: TransformedMethod[];
+};
+export type TransformedPathsArray = TransformedPath[];

package/dist/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/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/utils/index.d.ts

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

package/dist/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;
+        url?: string;
+    }[];
+    paths: {
+        path?: string;
+        methods?: {
+            summary?: string;
+            type?: string;
+            description?: string;
+            tags?: string[];
+            requestBody?: {};
+        }[];
+    }[];
+    components: {
+        securitySchemes?: {};
+        schemas?: {};
+    };
+    security: {
+        schemeName?: string[];
+    }[];
+    tags: {
+        name?: string;
+        description?: string;
+    }[];
+}, 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,9 +1,10 @@
 {
   "name": "@digi-frontend/dgate-api-documentation",
-  "version": "1.4.5",
-  "main": "dist/src/index.js",
-  "module": "dist/src/index.js",
-  "types": "dist/types/index.d.ts",
+  "version": "1.4.7",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/index.d.ts",
+  "style": "dist/style.css",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "tsc --noEmit --skipLibCheck || true && rollup -c || true"
@@ -30,10 +31,10 @@
     "yup": "^1.6.1"
   },
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^28.0.2",
+    "@rollup/plugin-commonjs": "^28.0.6",
     "@rollup/plugin-json": "^6.1.0",
-    "@rollup/plugin-node-resolve": "^16.0.0",
-    "@rollup/plugin-typescript": "^12.1.2",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rollup/plugin-typescript": "^12.1.4",
     "@rollup/plugin-url": "^8.0.2",
     "@types/react": "^19.0.7",
     "@types/react-dom": "^19.0.3",
@@ -41,7 +42,7 @@
     "rollup-plugin-postcss": "^4.0.2",
     "rollup-plugin-sass": "^1.15.2",
     "rollup-plugin-terser": "^7.0.2",
-    "sass": "^1.83.4",
+    "sass": "^1.90.0",
     "typescript": "^5.7.3",
     "typescript-plugin-css-modules": "^5.1.0"
   }

package/rollup.config.js

@@ -9,29 +9,19 @@ import json from '@rollup/plugin-json'
 
 export default {
   input: 'src/index.ts',
-  output: [
-    {
-      dir: 'dist',
-      format: 'esm',
-      preserveModules: true,
-      sourcemap: true,
-    },
-  ],
+  output: [{ dir: 'dist', format: 'esm', sourcemap: true }],
   plugins: [
     resolve(),
     commonjs(),
-    typescript({ tsconfig: './tsconfig.json' }),
+    typescript({ tsconfig: './tsconfig.json', declaration: true, declarationMap: false }),
     postcss({
       modules: false,
       extract: 'style.css',
-      minimize: true,
       use: ['sass'],
+      minimize: true,
     }),
     terser(),
     url({ limit: 0 }),
-    sass({
-      output: 'dist/styles.css',
-    }),
     json(),
   ],
   external: ['react', 'react-dom'],

package/tsconfig.json

@@ -2,14 +2,15 @@
   "compilerOptions": {
     "outDir": "dist",
     "module": "ESNext",
-    "target": "ES6",
+    "target": "es6",
     "lib": ["DOM", "DOM.Iterable", "ESNext"],
     "declaration": true,
-    "declarationDir": "dist/types",
-    "jsx": "react-jsx",
+    "jsx": "react",
     "strict": false,
     "moduleResolution": "node",
     "esModuleInterop": true,
+    "emitDeclarationOnly": true,
+
     "skipLibCheck": true,
     "forceConsistentCasingInFileNames": true,
     "importHelpers": true,