@digi-frontend/dgate-api-documentation 1.1.4 → 1.1.5

package/dist/index.css

@@ -0,0 +1,137 @@
+/* node_modules/tippy.js/dist/tippy.css */
+.tippy-box[data-animation=fade][data-state=hidden] {
+  opacity: 0;
+}
+[data-tippy-root] {
+  max-width: calc(100vw - 10px);
+}
+.tippy-box {
+  position: relative;
+  background-color: #333;
+  color: #fff;
+  border-radius: 4px;
+  font-size: 14px;
+  line-height: 1.4;
+  white-space: normal;
+  outline: 0;
+  transition-property:
+    transform,
+    visibility,
+    opacity;
+}
+.tippy-box[data-placement^=top] > .tippy-arrow {
+  bottom: 0;
+}
+.tippy-box[data-placement^=top] > .tippy-arrow:before {
+  bottom: -7px;
+  left: 0;
+  border-width: 8px 8px 0;
+  border-top-color: initial;
+  transform-origin: center top;
+}
+.tippy-box[data-placement^=bottom] > .tippy-arrow {
+  top: 0;
+}
+.tippy-box[data-placement^=bottom] > .tippy-arrow:before {
+  top: -7px;
+  left: 0;
+  border-width: 0 8px 8px;
+  border-bottom-color: initial;
+  transform-origin: center bottom;
+}
+.tippy-box[data-placement^=left] > .tippy-arrow {
+  right: 0;
+}
+.tippy-box[data-placement^=left] > .tippy-arrow:before {
+  border-width: 8px 0 8px 8px;
+  border-left-color: initial;
+  right: -7px;
+  transform-origin: center left;
+}
+.tippy-box[data-placement^=right] > .tippy-arrow {
+  left: 0;
+}
+.tippy-box[data-placement^=right] > .tippy-arrow:before {
+  left: -7px;
+  border-width: 8px 8px 8px 0;
+  border-right-color: initial;
+  transform-origin: center right;
+}
+.tippy-box[data-inertia][data-state=visible] {
+  transition-timing-function: cubic-bezier(.54, 1.5, .38, 1.11);
+}
+.tippy-arrow {
+  width: 16px;
+  height: 16px;
+  color: #333;
+}
+.tippy-arrow:before {
+  content: "";
+  position: absolute;
+  border-color: transparent;
+  border-style: solid;
+}
+.tippy-content {
+  position: relative;
+  padding: 5px 9px;
+  z-index: 1;
+}
+
+/* src/layout/layout.module.css */
+.docsLayout {
+  display: flex;
+  flex-direction: column;
+  overflow: hidden;
+  height: 100vh;
+  max-height: 100%;
+  .apiDocAlert {
+    border-radius: 0;
+    z-index: 3;
+  }
+  .layoutContainer {
+    display: grid;
+    grid-template-columns: 60% 40%;
+    width: 100%;
+    height: 100%;
+    max-width: 100%;
+    max-height: 100%;
+    overflow: hidden;
+    .editorSide {
+      background-color: #fff;
+      padding-bottom: 1.25rem;
+      .editorSectionHead_title {
+        position: sticky;
+        top: 0;
+        z-index: 1399 !important;
+      }
+      .editorSectionHead,
+      .editorSectionHead_title {
+        span {
+          width: 100%;
+        }
+        .editorSectionHead_content {
+          display: flex;
+          justify-content: space-between;
+          align-items: center;
+          button {
+            width: 6.25rem;
+          }
+        }
+      }
+    }
+    .livePreviewSide {
+      background-color: #f8f9fb;
+      padding: 1.25rem 1.875rem;
+    }
+    .docSide {
+      max-height: 100%;
+      overflow-y: overlay;
+      overflow-x: clip;
+      scroll-behavior: smooth;
+    }
+  }
+  :global(.textArea .inputField),
+  :global(.inputContainer .inputWrapper .innerInputContainer .input) {
+    padding-inline-end: 2.5rem;
+  }
+}

package/dist/{types/types/openApi.d.ts → index.d.mts}

@@ -1,4 +1,6 @@
-export interface OpenAPIFile {
+import React, { JSX } from 'react';
+
+interface OpenAPIFile {
     openapi: string;
     info: {
         title: string;
@@ -39,22 +41,14 @@ export interface OpenAPIFile {
         }[];
     }[];
 }
-export interface Tags {
-    name: string;
-    description?: string;
-    externalDocs?: {
-        url: string;
-        description: string;
-    }[];
-}
-export interface Parameter {
+interface Parameter {
     name: string;
     in: 'query' | 'header' | 'path' | 'cookie';
     description?: string;
     required: boolean;
     schema: Schema;
 }
-export interface RequestBody {
+interface RequestBody {
     description?: string;
     required: boolean;
     content: {
@@ -63,7 +57,7 @@ export interface RequestBody {
         };
     };
 }
-export interface Responses {
+interface Responses {
     [statusCode: string]: {
         description: string;
         headers?: any;
@@ -84,7 +78,7 @@ interface Schema {
     enum?: string[];
     required?: string[];
 }
-export interface SecurityScheme {
+interface SecurityScheme {
     type: 'apiKey' | 'http' | 'oauth2' | 'openIdConnect';
     description?: string;
     name?: string;
@@ -94,5 +88,48 @@ export interface SecurityScheme {
     flows?: any;
     openIdConnectUrl?: string;
 }
-export type HTTPMethod = 'get' | 'put' | 'post' | 'delete' | 'options' | 'head' | 'patch' | 'trace';
-export {};
+type HTTPMethod = 'get' | 'put' | 'post' | 'delete' | 'options' | 'head' | 'patch' | 'trace';
+
+interface ILayoutProps$1 {
+    openApiJson?: OpenAPIFile;
+    handleSave?: (values: unknown) => unknown;
+    setIsFormDirty?: any;
+    openApiErrors?: any;
+}
+declare const Layout: ({ openApiJson, handleSave, setIsFormDirty, openApiErrors, }: ILayoutProps$1) => JSX.Element;
+
+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;
+    };
+}
+
+interface ILayoutProps {
+    apis?: ApiSpecModel[];
+    activeApiId?: string;
+    onProductNavigate?: (productId: number) => void;
+}
+declare const _default: React.MemoExoticComponent<({ apis, activeApiId, onProductNavigate }: ILayoutProps) => JSX.Element>;
+
+export { _default as DocsLayout, Layout };

package/dist/index.d.ts

@@ -0,0 +1,135 @@
+import React, { JSX } from 'react';
+
+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;
+        }[];
+    }[];
+}
+interface Parameter {
+    name: string;
+    in: 'query' | 'header' | 'path' | 'cookie';
+    description?: string;
+    required: boolean;
+    schema: Schema;
+}
+interface RequestBody {
+    description?: string;
+    required: boolean;
+    content: {
+        [contentType: string]: {
+            schema: Schema;
+        };
+    };
+}
+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[];
+}
+interface SecurityScheme {
+    type: 'apiKey' | 'http' | 'oauth2' | 'openIdConnect';
+    description?: string;
+    name?: string;
+    in?: 'query' | 'header' | 'cookie';
+    scheme?: string;
+    bearerFormat?: string;
+    flows?: any;
+    openIdConnectUrl?: string;
+}
+type HTTPMethod = 'get' | 'put' | 'post' | 'delete' | 'options' | 'head' | 'patch' | 'trace';
+
+interface ILayoutProps$1 {
+    openApiJson?: OpenAPIFile;
+    handleSave?: (values: unknown) => unknown;
+    setIsFormDirty?: any;
+    openApiErrors?: any;
+}
+declare const Layout: ({ openApiJson, handleSave, setIsFormDirty, openApiErrors, }: ILayoutProps$1) => JSX.Element;
+
+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;
+    };
+}
+
+interface ILayoutProps {
+    apis?: ApiSpecModel[];
+    activeApiId?: string;
+    onProductNavigate?: (productId: number) => void;
+}
+declare const _default: React.MemoExoticComponent<({ apis, activeApiId, onProductNavigate }: ILayoutProps) => JSX.Element>;
+
+export { _default as DocsLayout, Layout };