@digi-frontend/dgate-api-documentation 1.0.0 → 1.0.1

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

@@ -4,3 +4,21 @@ export { default as CloseIcon } from './CloseIcon.svg';
 export { default as CheckMarkSquare } from './CheckMarkSquare.svg';
 export { default as DeleteIcon } from './DeleteIcon.svg';
 export { default as EditIcon } from './EditIcon.svg';
+export { default as AddRow } from './AddRow.svg';
+export { default as CopySticker } from './CopySticker.svg';
+export { default as arrowDownGray } from './arrowDownGray.svg';
+export { default as arrowRightGray } from './arrowRightGray.svg';
+export { default as document } from './document.svg';
+export { default as eye } from './eye.svg';
+export { default as DeleteOutlinedIcon } from './DeleteOutlinedIcon.svg';
+export { default as ApiIcon } from './ApiIcon.svg';
+export { default as FilterIcon } from './FilterIcon.svg';
+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';
+export { default as ArrowBack } from './ArrowBack.svg';

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

@@ -1,2 +1,4 @@
-declare const InfoForm: () => import("react/jsx-runtime").JSX.Element;
+declare const InfoForm: ({ readOnly }: {
+    readOnly?: boolean;
+}) => import("react/jsx-runtime").JSX.Element;
 export default InfoForm;

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

@@ -0,0 +1,14 @@
+declare const JsonInput: ({ placeholder, label, value, onValidation, onChange, dataId, className, errorMessage, acceptType, fieldIsDisabled, withFooter, }: {
+    placeholder: any;
+    label: any;
+    value: any;
+    onValidation: any;
+    onChange: any;
+    dataId: any;
+    className?: string;
+    errorMessage: any;
+    acceptType?: string;
+    fieldIsDisabled: any;
+    withFooter?: boolean;
+}) => import("react/jsx-runtime").JSX.Element;
+export default JsonInput;

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

@@ -0,0 +1,8 @@
+import React from 'react';
+import { TransformedOpenApi } from '../../types/transformedOpenApi';
+interface LivePreviewProps {
+    transformedData?: TransformedOpenApi;
+    openApiErrors?: any[];
+}
+declare const LivePreview: React.FC<LivePreviewProps>;
+export default LivePreview;

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

@@ -1,2 +1,13 @@
-declare const MethodsAccordion: () => import("react/jsx-runtime").JSX.Element;
+import { TransformedMethod } from '../../types/layout.type';
+import { Tags } from '@entities/openApi';
+declare const MethodsAccordion: ({ method, path, setFieldValue, readOnly, tags, isOpen, setIsOpen, errors, }: {
+    method: TransformedMethod;
+    path: string;
+    setFieldValue?: (key: string, value: string | string[]) => void;
+    readOnly?: boolean;
+    tags: Tags[];
+    isOpen: boolean;
+    setIsOpen: (open: boolean) => void;
+    errors?: string;
+}) => import("react/jsx-runtime").JSX.Element;
 export default MethodsAccordion;

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

@@ -0,0 +1,11 @@
+import React from 'react';
+import './style.scss';
+type SimpleLabelValueProps = {
+    label?: string | JSX.Element;
+    value?: string | number | JSX.Element | JSX.Element[];
+    color?: string;
+    className?: string;
+    dataId?: string;
+};
+declare const SimpleLabelValue: React.FC<SimpleLabelValueProps>;
+export default SimpleLabelValue;

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

@@ -0,0 +1 @@
+export { default } from './SimpleLabelValue';

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

@@ -0,0 +1,19 @@
+import React, { ReactNode } from 'react';
+import { TippyProps } from '@tippyjs/react';
+import 'tippy.js/dist/tippy.css';
+import './Tooltip.scss';
+interface TooltipProps extends TippyProps {
+    content: ReactNode;
+    success?: boolean;
+    onMouseEnter?: (event: React.MouseEvent<HTMLDivElement>) => void;
+    onMouseLeave?: (event: React.MouseEvent<HTMLDivElement>) => void;
+    visible?: boolean;
+    delay?: [number, number];
+    type?: 'info' | 'function';
+    maxWidth?: number;
+    className?: string;
+    arrowWithBorder?: boolean;
+    disabled?: boolean;
+}
+declare const Tooltip: React.FC<TooltipProps>;
+export default Tooltip;

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

@@ -0,0 +1,47 @@
+import { JSX } from 'react';
+export type DialogStatus = 'error' | 'info' | 'warning';
+export type DialogSize = 'xs' | 'sm' | 'md' | 'lg' | 'xl';
+export type ButtonType = 'text' | 'submit' | 'reset';
+export type ButtonVariant = 'outlined' | 'contained' | 'text' | 'link';
+export type ButtonColor = 'inherit' | 'primary' | 'secondary' | 'success' | 'error' | 'info' | 'warning' | 'action' | 'normal';
+export type ButtonSize = 'small' | 'medium' | 'large';
+export interface BaseActionButtonProps {
+    text: string;
+    color?: ButtonColor;
+    variant?: ButtonVariant;
+    type?: ButtonType;
+    size?: ButtonSize;
+    id?: string;
+    className?: string;
+    disabled?: boolean;
+    startIcon?: JSX.Element;
+    endIcon?: JSX.Element;
+    dataId?: string;
+    loading?: boolean;
+    fullWidth?: boolean;
+    active?: boolean;
+    onKeyDown?: () => void;
+}
+export interface SubmitButtonProps extends BaseActionButtonProps {
+    onClick: () => void;
+}
+export interface CancelButtonProps extends BaseActionButtonProps {
+    onClick?: () => void;
+}
+export interface CommonDialogProps {
+    status?: DialogStatus;
+    content?: React.ReactElement;
+    onSubmit?: SubmitButtonProps;
+    onCancel?: CancelButtonProps;
+    onClose: () => void;
+    open?: boolean;
+    icon?: JSX.Element | boolean;
+    size?: DialogSize;
+    children?: React.ReactElement;
+    statusTitle?: boolean;
+    isSubmitDisabled?: boolean;
+    submitBtnComponent?: JSX.Element | null;
+    withClose?: boolean;
+    noActions?: boolean;
+    closeIcon?: JSX.Element;
+}

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

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

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

@@ -0,0 +1,12 @@
+import './style.scss';
+declare const ParamterTable: ({ id, headCells, data, isFormOpen, setIsFormOpen, saveNewRow, readOnly, isRequest, }: {
+    id: any;
+    headCells: any;
+    data: any;
+    isFormOpen: any;
+    setIsFormOpen: any;
+    saveNewRow: any;
+    readOnly: any;
+    isRequest?: boolean;
+}) => import("react/jsx-runtime").JSX.Element;
+export default ParamterTable;

package/dist/types/components/table/tags-table.d.ts

@@ -0,0 +1,11 @@
+import './style.scss';
+declare const TagsTable: ({ id, headCells, data, isFormOpen, setIsFormOpen, saveNewRow, readOnly }: {
+    id: any;
+    headCells: any;
+    data: any;
+    isFormOpen: any;
+    setIsFormOpen: any;
+    saveNewRow: any;
+    readOnly: any;
+}) => import("react/jsx-runtime").JSX.Element;
+export default TagsTable;

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

@@ -1,21 +1,56 @@
 export declare const methodColorMapping: {
-    GET: {
+    get: {
         label: string;
         color: string;
+        order: number;
     };
-    POST: {
+    post: {
         label: string;
         color: string;
+        order: number;
     };
-    PUT: {
+    put: {
         label: string;
         color: string;
+        order: number;
     };
-    DELETE: {
+    delete: {
         label: string;
         color: string;
+        order: number;
+    };
+    patch: {
+        label: string;
+        color: string;
+        order: number;
+    };
+    options: {
+        label: string;
+        color: string;
+        order: number;
+    };
+    trace: {
+        label: string;
+        color: string;
+        order: number;
+    };
+    head: {
+        label: string;
+        color: string;
+        order: number;
     };
 };
+export declare const tagsTableHeaders: ({
+    id: string;
+    label: string;
+    sortable: boolean;
+    classes: string;
+} | {
+    id: string;
+    label: string;
+    sortable: boolean;
+    classes?: undefined;
+})[];
 export declare const paramsTableHeaders: ({
     id: string;
     label: string;

package/dist/types/constants/methods.constant.d.ts

@@ -0,0 +1,16 @@
+export type MethodOption = {
+    label: string;
+    value: string;
+    color: string;
+};
+export declare const METHOD_OPTIONS: MethodOption[];
+export declare const METHOD_OPTIONS_CONFIG: {
+    list: {
+        labelConfig: {
+            color: string;
+            text: string;
+        };
+        value: string;
+        data: MethodOption;
+    }[];
+}[];

package/dist/types/constants/regex.d.ts

@@ -1,5 +1,7 @@
 declare const regex: {
     basic: RegExp;
     restrictNone: RegExp;
+    ASCII: RegExp;
+    urlRegex: RegExp;
 };
 export default regex;

package/dist/types/context/SectionToggleContext.d.ts

@@ -0,0 +1,37 @@
+import { ReactNode } from 'react';
+export declare enum SectionEnum {
+    OVERVIEW = "overview",
+    RESOURCE = "resource",
+    API_SECTION = "apiSection",
+    TAG_SECTION = "tagSection",
+    ENDPOINTS_SECTION = "endpointsSection"
+}
+type SectionKey = `api_${string}_${SectionEnum}` | `api_${string}_${SectionEnum}_${string | number}` | `api_${string}_${SectionEnum}_${string | number}_${string | number}`;
+type ExpandedSections = Record<SectionKey, boolean>;
+interface SectionToggleContextType {
+    expandedSections: ExpandedSections;
+    toggleSection: (apiId: string, sections: ToggleSectionDescriptor[], options?: ToggleOptions) => void;
+    generateSectionKey: ({ apiId, type, index, id }: GenerateSectionKeyParams) => SectionKey;
+}
+interface SectionToggleProviderProps {
+    children: ReactNode;
+}
+export interface ToggleSectionDescriptor {
+    type: SectionEnum;
+    index?: string | number;
+    setTo?: boolean;
+    id?: string;
+}
+export interface ToggleOptions {
+    resetOthers?: boolean;
+    filterKeys?: SectionEnum[];
+}
+interface GenerateSectionKeyParams {
+    apiId: string;
+    type: SectionEnum;
+    index?: string | number;
+    id?: string | number;
+}
+export declare const useSectionToggle: () => SectionToggleContextType;
+export declare const SectionToggleProvider: ({ children }: SectionToggleProviderProps) => import("react/jsx-runtime").JSX.Element;
+export {};

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

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

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

@@ -0,0 +1,7 @@
+import { TransformedPathsArray } from '@entities/layout.type';
+import { OpenAPIFile } from '@entities/openApi';
+import { TransformedOpenApi } from '@entities/transformedOpenApi';
+export declare const transformOpenApiObject: (openApiJson: OpenAPIFile) => TransformedOpenApi;
+export declare const transformOpenApiObjectToOrigin: (values: TransformedOpenApi) => OpenAPIFile;
+export declare const transformPathsToArray: (paths: OpenAPIFile["paths"]) => TransformedPathsArray | any;
+export declare const transformPathsArrayToOrigin: (paths: TransformedPathsArray) => OpenAPIFile["paths"];

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

@@ -0,0 +1,2 @@
+export declare const handleStatusColor: (code: number) => string;
+export declare const capitalize: (str: any) => any;

package/dist/types/index.d.ts

@@ -1 +1,2 @@
 export { default as Layout } from './layout/layout';
+export { default as DocsLayout } from './layout/docsLayout';

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

@@ -0,0 +1,5 @@
+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

@@ -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[];
+}) => import("react/jsx-runtime").JSX.Element;
+export default DocsContent;

package/dist/types/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-runtime").JSX.Element;

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

@@ -0,0 +1,9 @@
+import './style.scss';
+import { EndpointData, OverviewData } from 'src/layout/docsLayout';
+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[];
+}) => import("react/jsx-runtime").JSX.Element;

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

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

package/dist/types/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>>;
+}) => import("react/jsx-runtime").JSX.Element;
+export default DocsSideMenuTree;

package/dist/types/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/types/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/types/layout/layout.d.ts

@@ -1,3 +1,10 @@
 import { JSX } from 'react';
-declare const Layout: () => JSX.Element;
+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/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/types/index.d.ts

@@ -1,18 +1,27 @@
-export type MethodTypes = 'GET' | 'POST' | 'PUT' | 'DELETE';
-export interface ParameterType {
-    name: string;
-    in: string;
-    schemaType: string;
-    required: boolean;
-}
-export interface MethodAccordionProps {
-    method: MethodTypes;
-    path: string;
-    desc: string;
-    parameters: ParameterType[];
-    request: string;
-    response: {
-        content: string;
-        statusCode: number;
+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

@@ -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/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 {};