@digi-frontend/dgate-api-documentation 1.0.47 → 1.0.52

package/dist/types/assets/icons/index.d.ts

@@ -17,6 +17,7 @@ export { default as BookIcon } from './BookIcon.svg';
 export { default as Closecircle } from './close-circle.svg';
 export { default as InfoIcon } from './infoIcon.svg';
 export { default as SearchIcon } from './searchIcon.svg';
+export { default as Copy } from './copy.svg';
 export { default as PlusIcon } from './Plus.svg';
 export { default as PlusSquare } from './PlusSquare.svg';
 export { default as RequestOption } from './RequestOption.svg';

package/dist/types/components/dialog/dialog.d.ts

@@ -41,4 +41,5 @@ export interface CommonDialogProps {
     isSubmitDisabled?: boolean;
     submitBtnComponent?: JSX.Element | null;
     withClose?: boolean;
+    noActions?: boolean;
 }

package/dist/types/components/dialog/index.d.ts

@@ -1,4 +1,4 @@
 import './style.scss';
 import { CommonDialogProps } from './dialog';
-declare const CommonDialog: ({ status, content, onSubmit, onCancel, onClose, open, size, icon, }: CommonDialogProps) => import("react/jsx-runtime").JSX.Element;
+declare const CommonDialog: ({ status, content, onSubmit, onCancel, onClose, open, size, icon, noActions, }: CommonDialogProps) => import("react/jsx-runtime").JSX.Element;
 export default CommonDialog;

package/dist/types/helpers/docs.helper.d.ts

@@ -1,3 +1,3 @@
-import { OpenAPIFile } from '@entities/openApi';
+import { ApiSpecModel } from '@entities/index';
 import { OverviewData } from 'src/layout/docsLayout';
-export declare const transformOpenApiToDocs: (openApiJson: OpenAPIFile) => OverviewData;
+export declare const transformOpenApiToDocs: (api: ApiSpecModel) => OverviewData;

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

@@ -0,0 +1,4 @@
+declare const Codebox: ({ code }: {
+    code: string;
+}) => import("react/jsx-runtime").JSX.Element;
+export default Codebox;

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

@@ -1,3 +1,5 @@
-import './style.scss';
-declare const DocsAside: () => import("react/jsx-runtime").JSX.Element;
+import { EndpointData } from 'src/layout/docsLayout';
+declare const DocsAside: ({ data }: {
+    data: EndpointData;
+}) => import("react/jsx-runtime").JSX.Element;
 export default DocsAside;

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

@@ -1,3 +1,7 @@
 import './style.scss';
-declare const DocsContent: () => import("react/jsx-runtime").JSX.Element;
+import { EndpointData, OverviewData } from 'src/layout/docsLayout';
+declare const DocsContent: ({ data, activeType, setActiveItemData, setActiveType, setExpandedSections, }: {
+    data: OverviewData | EndpointData;
+    activeType: "OVERVIEW" | "ENDPOINT";
+}) => import("react/jsx-runtime").JSX.Element;
 export default DocsContent;

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

@@ -1,2 +1,4 @@
 import './style.scss';
-export declare const EndpointPage: () => import("react/jsx-runtime").JSX.Element;
+export declare const EndpointPage: ({ data }: {
+    data: any;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/types/layout/docsComponents/DocsContent/TagPage/index.d.ts

@@ -1,2 +1,7 @@
 import './style.scss';
-export declare const TagPage: () => import("react/jsx-runtime").JSX.Element;
+export declare const TagPage: ({ data, setActiveItemData, setActiveType, setExpandedSections }: {
+    data: any;
+    setActiveItemData: any;
+    setActiveType: any;
+    setExpandedSections: any;
+}) => import("react/jsx-runtime").JSX.Element;

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

@@ -1,8 +1,15 @@
 import './style.scss';
-declare const DocsSideMenuTree: ({ apis, setActiveItemData, isFirstApiExpanded, setIsFirstApiExpanded, }: {
-    apis: any;
-    setActiveItemData: any;
-    isFirstApiExpanded: any;
-    setIsFirstApiExpanded: any;
+import React from 'react';
+import { EndpointData, OverviewData } from 'src/layout/docsLayout';
+declare const DocsSideMenuTree: ({ apis, setActiveItemData, activeItemData, activeType, expandedSections, setExpandedSections, isFirstApiExpanded, setIsFirstApiExpanded, setActiveType, }: {
+    apis: OverviewData[];
+    setActiveItemData: React.Dispatch<React.SetStateAction<OverviewData | EndpointData>>;
+    activeItemData: OverviewData | EndpointData;
+    expandedSections: Record<string, boolean>;
+    setExpandedSections: React.Dispatch<React.SetStateAction<Record<string, boolean>>>;
+    isFirstApiExpanded: boolean;
+    setIsFirstApiExpanded: React.Dispatch<React.SetStateAction<boolean>>;
+    setActiveType: React.Dispatch<React.SetStateAction<"OVERVIEW" | "ENDPOINT">>;
+    activeType: "OVERVIEW" | "ENDPOINT";
 }) => import("react/jsx-runtime").JSX.Element;
 export default DocsSideMenuTree;

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

@@ -1,7 +1,8 @@
 import { JSX } from 'react';
 import { HTTPMethod, OpenAPIFile, Parameter, RequestBody, Responses } from '@entities/openApi';
+import { ApiSpecModel } from '@entities/index';
 interface ILayoutProps {
-    openApiJson?: OpenAPIFile[];
+    apis?: ApiSpecModel[];
 }
 export interface TagData {
     id: string;
@@ -22,12 +23,12 @@ export interface EndpointData extends TagData {
         version: string;
     };
 }
-export interface OverviewData {
-    id: string;
+export interface OverviewData extends Omit<ApiSpecModel, 'metaData'> {
     description: string;
     title: string;
     version: string;
     tags: Record<string, TagData[]>;
+    servers: OpenAPIFile['servers'];
 }
-declare const DocsLayout: ({ openApiJson }: ILayoutProps) => JSX.Element;
+declare const DocsLayout: ({ apis }: ILayoutProps) => JSX.Element;
 export default DocsLayout;

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

@@ -6,5 +6,5 @@ interface ILayoutProps {
     setIsFormDirty?: any;
     openApiErrors?: any;
 }
-declare const Layout: ({ openApiJson, handleSave, setIsFormDirty, openApiErrors }: ILayoutProps) => JSX.Element;
+declare const Layout: ({ openApiJson, handleSave, setIsFormDirty, openApiErrors, }: ILayoutProps) => JSX.Element;
 export default Layout;

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

@@ -0,0 +1,27 @@
+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/types/layout.type.d.ts

@@ -19,6 +19,7 @@ export type TransformedMethod = {
             contentType?: string;
             schema?: unknown;
         };
+        headers: any;
     }[];
 };
 export type TransformedPath = {

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

@@ -66,6 +66,7 @@ export interface RequestBody {
 export interface Responses {
     [statusCode: string]: {
         description: string;
+        headers?: any;
         content?: {
             [contentType: string]: {
                 schema: Schema;

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

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

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

@@ -17,6 +17,7 @@ export declare const schemaValidation: yup.ObjectSchema<{
             type?: string;
             description?: string;
             tags?: string[];
+            requestBody?: {};
         }[];
     }[];
     components: {

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@digi-frontend/dgate-api-documentation",
-  "version": "1.0.47",
+  "version": "1.0.52",
   "main": "dist/src/index.js",
   "module": "dist/src/index.js",
   "types": "dist/types/index.d.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "tsc --noEmit --skipLibCheck || true && rollup -c"
+    "build": "tsc --noEmit --skipLibCheck || true && rollup -c || true"
   },
   "exports": {
     ".": "./src/index.ts"
@@ -23,7 +23,7 @@
     "nanoid": "^5.1.5",
     "react": "^18.0.0",
     "react-dom": "^18.0.0",
-    "react-inlinesvg": "^4.2.0",
+    "react-syntax-highlighter": "^15.6.1",
     "tslib": "^2.8.1",
     "yup": "^1.6.1"
   },

package/rollup.config.js

@@ -5,6 +5,7 @@ import postcss from 'rollup-plugin-postcss'
 import { terser } from 'rollup-plugin-terser'
 import url from '@rollup/plugin-url'
 import sass from 'rollup-plugin-sass'
+import json from '@rollup/plugin-json';
 
 export default {
   input: 'src/index.ts',
@@ -30,6 +31,7 @@ export default {
     sass({
       output: 'dist/styles.css',
     }),
+    json()
   ],
   external: ['react', 'react-dom'],
 }

package/src/assets/icons/copy.svg

@@ -0,0 +1,4 @@
+<svg width="12" height="12" viewBox="0 0 12 12" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M8 6.45V8.55C8 10.3 7.3 11 5.55 11H3.45C1.7 11 1 10.3 1 8.55V6.45C1 4.7 1.7 4 3.45 4H5.55C7.3 4 8 4.7 8 6.45Z" stroke="#6B7280" stroke-width="0.6" stroke-linecap="round" stroke-linejoin="round"/>
+<path d="M11 3.45V5.55C11 7.3 10.3 8 8.55 8H8V6.45C8 4.7 7.3 4 5.55 4H4V3.45C4 1.7 4.7 1 6.45 1H8.55C10.3 1 11 1.7 11 3.45Z" stroke="#6B7280" stroke-width="0.6" stroke-linecap="round" stroke-linejoin="round"/>
+</svg>

package/src/assets/icons/index.ts

@@ -17,6 +17,7 @@ export { default as BookIcon } from './BookIcon.svg'
 export { default as Closecircle } from './close-circle.svg'
 export { default as InfoIcon } from './infoIcon.svg'
 export { default as SearchIcon } from './searchIcon.svg'
+export { default as Copy } from './copy.svg'
 export { default as PlusIcon } from './Plus.svg'
 export { default as PlusSquare } from './PlusSquare.svg'
 export { default as RequestOption } from './RequestOption.svg'

package/src/components/MethodAccordion/MethodAccordion.module.scss

@@ -20,6 +20,15 @@
     padding: 0 !important;
   }
 
+  :global(.enumText) {
+    font-family: 'Cairo';
+    font-weight: 400;
+    font-size: 0.875rem;
+    line-height: 1.25rem;
+    max-width: 5.5625rem;
+    white-space: normal;
+  }
+
   .methodSummaryContainer {
     display: flex;
     align-items: center;
@@ -92,7 +101,7 @@
         margin: 0;
         margin-bottom: 1.25rem;
       }
-      .responseHeader{
+      .responseHeader {
         display: flex;
         flex-direction: row;
         justify-content: space-between;
@@ -118,18 +127,18 @@
         }
 
         .statusCodeOptionContainer {
-        display: grid;
-        grid-template-columns: min-content min-content;
-        align-items: center;
-        gap: 0.625rem;
-
-        .statusCodeOptionCircle {
-          width: 0.625rem;
-          aspect-ratio: 1 / 1;
-          border-radius: 100%;
+          display: grid;
+          grid-template-columns: min-content min-content;
+          align-items: center;
+          gap: 0.625rem;
+
+          .statusCodeOptionCircle {
+            width: 0.625rem;
+            aspect-ratio: 1 / 1;
+            border-radius: 100%;
+          }
         }
       }
-      }
       .paramDescContainer {
         display: flex;