@digi-frontend/dgate-api-documentation 1.0.31 → 1.0.32

package/src/types/openApi.ts

@@ -1,108 +1,108 @@
-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
-  }[]
-}
-
-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
-    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 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
+  }[]
+}
+
+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
+    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'

package/src/types/transformedOpenApi.ts

@@ -1,52 +1,52 @@
-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;
-}
+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;
+}

package/src/validator/form.scheme.ts

@@ -1,70 +1,70 @@
-import * as yup from 'yup'
-export const schemaValidation = yup.object({
-  openapi: yup.string().required(),
-  info: yup
-    .object({
-      title: yup.string().trim().required('API Name is required.'),
-      description: yup.string().trim().required('API Description is required.'),
-      version: yup.string().required('API Version is required'),
-    })
-    .required(),
-  servers: yup
-    .array(
-      yup.object({
-        url: yup.string().url().required(),
-        description: yup.string().optional(),
-      })
-    )
-    .optional(),
-  paths: yup.mixed().required(), // Assuming TransformedPathsArray is validated elsewhere
-  components: yup
-    .object({
-      schemas: yup
-        .lazy((value) =>
-          yup.object(
-            value
-              ? Object.keys(value).reduce((acc, key) => {
-                  acc[key] = yup.object({
-                    type: yup.string().optional(),
-                    format: yup.string().optional(),
-                    properties: yup
-                      .lazy((props) =>
-                        yup.object(
-                          props
-                            ? Object.keys(props).reduce((acc, propKey) => {
-                                acc[propKey] = yup.mixed()
-                                return acc
-                              }, {})
-                            : {}
-                        )
-                      )
-                      .optional(),
-                    items: yup.mixed().optional(),
-                    enum: yup.array(yup.string()).optional(),
-                    required: yup.array(yup.string()).optional(),
-                  })
-                  return acc
-                }, {})
-              : {}
-          )
-        )
-        .optional(),
-      securitySchemes: yup.object().optional(),
-    })
-    .optional(),
-  security: yup
-    .array(
-      yup.object().shape({
-        schemeName: yup.array(yup.string()).optional(),
-      })
-    )
-    .optional(),
-  tags: yup
-    .array(
-      yup.object({
-        name: yup.string().required(),
-        description: yup.string().optional(),
-      })
-    )
-    .optional(),
-})
+import * as yup from 'yup'
+export const schemaValidation = yup.object({
+  openapi: yup.string().required(),
+  info: yup
+    .object({
+      title: yup.string().trim().required('API Name is required.'),
+      description: yup.string().trim().required('API Description is required.'),
+      version: yup.string().required('API Version is required'),
+    })
+    .required(),
+  servers: yup
+    .array(
+      yup.object({
+        url: yup.string().url().required(),
+        description: yup.string().optional(),
+      })
+    )
+    .optional(),
+  paths: yup.mixed().required(), // Assuming TransformedPathsArray is validated elsewhere
+  components: yup
+    .object({
+      schemas: yup
+        .lazy((value) =>
+          yup.object(
+            value
+              ? Object.keys(value).reduce((acc, key) => {
+                  acc[key] = yup.object({
+                    type: yup.string().optional(),
+                    format: yup.string().optional(),
+                    properties: yup
+                      .lazy((props) =>
+                        yup.object(
+                          props
+                            ? Object.keys(props).reduce((acc, propKey) => {
+                                acc[propKey] = yup.mixed()
+                                return acc
+                              }, {})
+                            : {}
+                        )
+                      )
+                      .optional(),
+                    items: yup.mixed().optional(),
+                    enum: yup.array(yup.string()).optional(),
+                    required: yup.array(yup.string()).optional(),
+                  })
+                  return acc
+                }, {})
+              : {}
+          )
+        )
+        .optional(),
+      securitySchemes: yup.object().optional(),
+    })
+    .optional(),
+  security: yup
+    .array(
+      yup.object().shape({
+        schemeName: yup.array(yup.string()).optional(),
+      })
+    )
+    .optional(),
+  tags: yup
+    .array(
+      yup.object({
+        name: yup.string().required(),
+        description: yup.string().optional(),
+      })
+    )
+    .optional(),
+})

package/tsconfig.json

@@ -1,33 +1,33 @@
-{
-  "compilerOptions": {
-    "outDir": "dist",
-    "module": "ESNext",
-    "target": "ES6",
-    "lib": ["DOM", "DOM.Iterable", "ESNext"],
-    "declaration": true,
-    "declarationDir": "dist/types",
-    "jsx": "react-jsx",
-    "strict": false,
-    "moduleResolution": "node",
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "importHelpers": true,
-    "resolveJsonModule": true,
-    "plugins": [
-      {
-        "name": "typescript-plugin-css-modules"
-      }
-    ],
-    "baseUrl": "./",
-    "paths": {
-      "@components/*": ["src/components/*"],
-      "@icons": ["src/assets/icons"],
-      "@constants/*": ["src/constants/*"],
-      "@entities/*": ["src/types/*"],
-      "@helpers/*": ["src/helpers/*"]
-    }
-  },
-  "include": ["src", "src/global.d.ts"], // Add "src/global.d.ts" here
-  "exclude": ["node_modules", "dist"]
-}
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "module": "ESNext",
+    "target": "ES6",
+    "lib": ["DOM", "DOM.Iterable", "ESNext"],
+    "declaration": true,
+    "declarationDir": "dist/types",
+    "jsx": "react-jsx",
+    "strict": false,
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "importHelpers": true,
+    "resolveJsonModule": true,
+    "plugins": [
+      {
+        "name": "typescript-plugin-css-modules"
+      }
+    ],
+    "baseUrl": "./",
+    "paths": {
+      "@components/*": ["src/components/*"],
+      "@icons": ["src/assets/icons"],
+      "@constants/*": ["src/constants/*"],
+      "@entities/*": ["src/types/*"],
+      "@helpers/*": ["src/helpers/*"]
+    }
+  },
+  "include": ["src", "src/global.d.ts"], // Add "src/global.d.ts" here
+  "exclude": ["node_modules", "dist"]
+}