ng2-rest-swagger-generator 21.0.10 → 21.0.12

package/websql-prod/types/ng2-rest-swagger-generator-websql.d.ts

@@ -0,0 +1,219 @@
+// @ts-nocheck
+import { CoreHelpers } from 'tnp-core/websql-prod';
+
+declare namespace Models {
+    interface PathResource {
+        clean_path?: string;
+        singleModelType?: string;
+        multipleModelType?: string;
+        pathParamsType?: string;
+        queryParamsType?: string;
+        endpoint?: string;
+        model?: string;
+    }
+    interface Param {
+        name: string;
+        type: string;
+        required: boolean;
+        isObject?: boolean;
+    }
+    interface ServiceMethod {
+        summary: string;
+        path_cleand: string;
+        params: {
+            path?: Param[];
+            query?: Param[];
+            body?: Param[];
+        };
+        method: any;
+        isArray: boolean;
+        comment?: string;
+    }
+    namespace Swagger {
+        type DataFormat = 'int32' | 'int64' | 'double' | 'float';
+        type DataType = 'object' | 'array' | 'string' | 'boolean';
+        interface PropertyName {
+            [name: string]: Parameter;
+        }
+        interface SwaggerDef {
+            required: string[];
+            type: DataType;
+            properties: PropertyName;
+        }
+        interface SwaggerDefinition {
+            [name: string]: SwaggerDef;
+        }
+        interface ObjSchema {
+            $ref: string;
+            type: "string" | "number" | "integer" | "boolean" | "array" | "file";
+            items: {
+                $ref: string;
+            };
+        }
+        interface Response {
+            description: string;
+            schema: ObjSchema;
+        }
+        interface SwaggerResponse {
+            [path: string]: Response;
+        }
+        interface Parameter {
+            $ref: string;
+            /**
+             * 	Required. The schema defining the type used for the body parameter.
+             */
+            schema: {
+                $ref: string;
+                items: Parameter;
+                type: "string" | "number" | "integer" | "boolean" | "array" | "file";
+            };
+            /**
+             * Required. The name of the parameter. Parameter names are case sensitive.
+             * If in is "path", the name field MUST correspond to the associated path segment
+             * from the path field in the Paths Object. See Path Templating for further information.
+             * For all other cases, the name corresponds to the parameter name used based on the in property.
+             */
+            name: string;
+            in: 'query' | 'path' | 'body' | 'formData' | 'header';
+            /**
+             * A brief description of the parameter. This could contain examples of use.
+             *  GFM syntax can be used for rich text representation.
+             */
+            description: string;
+            /**
+             * Required if type is "array". Describes the type of items in the array.
+             */
+            items: Parameter;
+            required: boolean;
+            /**
+             * Sets the ability to pass empty-valued parameters. This is valid only
+             * for either query or formData parameters and allows you to send a parameter
+             *  with a name only or an empty value. Default value is false.
+             */
+            allowEmptyValue: boolean;
+            /**
+             * Required. The type of the parameter. Since the parameter is not located
+             * at the request body, it is limited to simple types (that is, not an object).
+             *  The value MUST be one of "string", "number", "integer", "boolean", "array"
+             * or "file". If type is "file", the consumes MUST be either "multipart/form-data",
+             * " application/x-www-form-urlencoded" or both and the parameter MUST be in "formData".
+             */
+            type: "string" | "number" | "integer" | "boolean" | "array" | "file";
+            format: "int32" | "int64" | "float" | "double" | "byte" | "binary" | "date" | "date-time" | "password";
+            /**
+             * Determines the format of the array if type array is used. Possible values are:
+             * csv - comma separated values foo,bar.
+             * ssv - space separated values foo bar.
+             * tsv - tab separated values foo\tbar.
+             * pipes - pipe separated values foo|bar.
+             * Default value is csv.
+             */
+            collectionFormat: 'csv' | 'ssv' | 'tsv' | 'pipes';
+            /**
+             * Declares the value of the item that the server will use if none is provided.
+             * (Note: "default" has no meaning for required items.)
+             * See http://json-schema.org/latest/json-schema-validation.html#anchor101.
+             *  Unlike JSON Schema this value MUST conform to the defined type for the data type.
+             */
+            default: any;
+            /**
+             * The value of this keyword MUST be an array.
+             * This array SHOULD have at least one element.
+             * Elements in the array SHOULD be unique.
+             * Elements in the array MAY be of any type, including null.
+             * An instance validates successfully against this keyword if its value
+             * is equal to one of the elements in this keyword's array value.
+             */
+            enum: any[];
+            maxLength: number;
+            minLength: number;
+            maxItems: number;
+            minItems: number;
+            uniqueItems: boolean;
+            pattern: number;
+            maximum: number;
+            exclusiveMaximum: boolean;
+            minimum: number;
+            exclusiveMinimum: number;
+            multipleOf: boolean;
+        }
+        interface Method {
+            tags: string[];
+            summary: string;
+            operationId: string;
+            consumes: string[];
+            produces: string[];
+            parameters: Parameter[];
+            responses: SwaggerResponse[];
+        }
+        interface SwaggerMethod {
+            [path: string]: Method;
+        }
+        interface SwaggerPath {
+            [path: string]: SwaggerMethod;
+        }
+        interface SwaggerTag {
+            name: string;
+        }
+        interface SwaggerModel {
+            host: string;
+            basePath: string;
+            tags: SwaggerTag[];
+            paths: SwaggerPath;
+            definitions: SwaggerDefinition;
+        }
+    }
+}
+
+declare class HelpersSwagger extends CoreHelpers {
+    static SYMBOL: {
+        INDEX_SWG: symbol;
+        OUTPUT_FOLDER: symbol;
+    };
+    private static output;
+    private static apis;
+    static preparePaths(apis: Models.Swagger.SwaggerModel[], outputBase: string): void;
+    static prepareModel(swg: Models.Swagger.SwaggerModel, indexSwg: number, isHttpsEnable: boolean): void;
+    static get serviceFromTag(): {
+        allClassNames(): any[];
+        className(swg: Models.Swagger.SwaggerModel, tag: Models.Swagger.SwaggerTag): string;
+        absoluteFilePath(swg: Models.Swagger.SwaggerModel, tag: Models.Swagger.SwaggerTag): string;
+    };
+    static get endpoints(): string[];
+    static get absolutePath(): {
+        readonly output: string;
+        readonly PathFile_index_ts: string;
+        readonly PathFile_module_ts: string;
+        readonly PathFolder_services: string;
+        readonly PathFile_services_index_ts: string;
+        PathFolder_services_groupName(swg: Models.Swagger.SwaggerModel): string;
+        PathFile_services_groupName_index_ts(swg: Models.Swagger.SwaggerModel): string;
+        PathFile_services_groupNAme_serviceName_ts(swg: Models.Swagger.SwaggerModel, tag: Models.Swagger.SwaggerTag): string;
+    };
+    static get groupFromJSON(): {
+        readonly allGroupNames: any[];
+        folderName(swg: Models.Swagger.SwaggerModel): string;
+    };
+    static findTags(swg: Models.Swagger.SwaggerModel): any[];
+    /**
+     * To generate get/books/{id} => get_books__id_
+     */
+    static cleanPath(path: string): string;
+    static cleanPathModel(pathModel: string): string;
+    static swaggerTypeToJS(type: "string" | "number" | "integer" | "boolean" | "array" | "file", itemsType?: any): any;
+    static getObjectDefinition(ref: string, swg: Models.Swagger.SwaggerModel, deep?: number): string;
+    /**
+     * private pathes = {
+     *      get_all_companies: new SimpleResource<
+     *          string, A, TA, RP extends Object, QP extends Rest.UrlParams>(endpoint, model),
+     *      get_byid_companies: new SimpleResource<
+     *          string, A, TA, RP extends Object, QP extends Rest.UrlParams>(endpoint, model)
+     * }
+     */
+    static getAngularPrivatePathesByTag(swg: Models.Swagger.SwaggerModel, tag: Models.Swagger.SwaggerTag): string;
+    static getResponseType(o: Models.Swagger.ObjSchema, swg: Models.Swagger.SwaggerModel): string;
+    private static count1;
+    static recreateSummary(summary: string): string;
+}
+
+export { HelpersSwagger };