@conduit-client/model 3.7.1 → 3.9.0

package/dist/types/v1/parser/swagger/types/SwaggerScalarTypes.d.ts

@@ -0,0 +1,46 @@
+import { SwaggerBaseType } from './SwaggerBaseType';
+import type { OpenAPIV3 } from 'openapi-types';
+import type { SwaggerTypeProps, SwaggerType, SwaggerTypeFactory } from '.';
+import type { BooleanType, DateTimeOnlyType, DateTimeType, DateType, DoubleType, IntegerType, NumberType, ScalarType, StringType, TimeType } from '../../../types';
+import type { TypeRegistry } from '../../../types';
+import type { FileParserLogger, LoggerService } from '@conduit-client/utils';
+import type { SwaggerAPI } from '../SwaggerAPI';
+export type SwaggerBooleanType = SwaggerTypeProps & BooleanType;
+export type SwaggerDoubleType = SwaggerTypeProps & DoubleType;
+export type SwaggerIntegerType = SwaggerTypeProps & IntegerType;
+export type SwaggerNumberType = SwaggerTypeProps & NumberType;
+export type SwaggerStringType = SwaggerTypeProps & StringType;
+export type SwaggerDateType = SwaggerTypeProps & DateType;
+export type SwaggerTimeType = SwaggerTypeProps & TimeType;
+export type SwaggerDateTimeOnlyType = SwaggerTypeProps & DateTimeOnlyType;
+export type SwaggerDateTimeType = SwaggerTypeProps & DateTimeType;
+export declare abstract class SwaggerEnumerableScalarType<T extends string | number | boolean | null, S extends ScalarType['type']> extends SwaggerBaseType<S> {
+    values?: Array<T>;
+    typeResolve(): void;
+}
+export declare class SwaggerBooleanTypeImpl extends SwaggerEnumerableScalarType<boolean, 'boolean'> implements SwaggerBooleanType {
+    type: "boolean";
+}
+export declare class SwaggerDoubleTypeImpl extends SwaggerEnumerableScalarType<number, 'double'> implements SwaggerDoubleType {
+    type: "double";
+}
+export declare class SwaggerIntegerTypeImpl extends SwaggerEnumerableScalarType<number, 'integer'> implements SwaggerIntegerType {
+    type: "integer";
+}
+export declare class SwaggerNumberTypeImpl extends SwaggerEnumerableScalarType<number, 'number'> implements SwaggerNumberType {
+    type: "number";
+}
+export declare class SwaggerStringTypeImpl extends SwaggerEnumerableScalarType<string, 'string'> implements SwaggerStringType {
+    type: "string";
+}
+export declare class SwaggerDateTypeImpl extends SwaggerEnumerableScalarType<string, 'date'> implements SwaggerDateType {
+    type: "date";
+}
+declare const DATE = "date";
+declare const DATE_TIME = "date-time";
+export declare class SwaggerDateTimeImpl extends SwaggerEnumerableScalarType<string, 'datetime'> implements SwaggerDateTimeType {
+    type: "datetime";
+    format: typeof DATE | typeof DATE_TIME;
+    constructor(api: SwaggerAPI, schema: OpenAPIV3.SchemaObject, schemaName: string | undefined, typeRegistry: TypeRegistry<SwaggerType>, factory: SwaggerTypeFactory, logger: LoggerService, fileParserLogger: FileParserLogger);
+}
+export {};

package/dist/types/v1/parser/swagger/types/__tests__/SwaggerAnyType.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/v1/parser/swagger/types/__tests__/SwaggerArrayType.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/v1/parser/swagger/types/__tests__/SwaggerBaseType.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/v1/parser/swagger/types/__tests__/SwaggerDiscriminatedObjectType.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/v1/parser/swagger/types/__tests__/SwaggerEnumType.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/v1/parser/swagger/types/__tests__/SwaggerNilType.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/v1/parser/swagger/types/__tests__/SwaggerNotType.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/v1/parser/swagger/types/__tests__/SwaggerObjectType.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/v1/parser/swagger/types/__tests__/SwaggerOneOfType.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/v1/parser/swagger/types/__tests__/SwaggerScalarType.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/v1/parser/swagger/types/factory.d.ts

@@ -0,0 +1,22 @@
+import { type OpenAPISchema } from '../swagger-utils';
+import type { SwaggerType } from '.';
+import type { TypeRegistry, Type } from '../../../types';
+import type { SwaggerAPI } from '../SwaggerAPI';
+import type { FileParserLogger, LoggerService } from '@conduit-client/utils';
+/**
+ * Constructs a SwaggerType based on the provided OpenAPI Schema.
+ *
+ * @param api The API
+ * @param schema The OpenAPI Schema for which a SwaggerType is to be created.
+ * @param schemaName Optional name for the schema (for named types)
+ * @param typeRegistry The TypeRegistry is searched for an existing SwaggerType.
+ * @param logger A LoggerService for logging standard operations.
+ * @param fileParserLogger A FileParserLogger for logging file parsing specific operations.
+ * @param resolve Optional boolean flag to determine if the constructed type should resolve references (default: false).
+ * @param allowedTypes Optional set of allowed type categories to limit the types constructed (default: empty set).
+ * @param skipRegistry Optional boolean flag to bypass type registry cache lookup (default: false).
+ * @param jsonPath Optional JSON path for position lookup (e.g., "components/schemas/Foo/properties/bar").
+ * @returns The constructed or retrieved SwaggerType based on the provided schema and conditions.
+ */
+export declare function swaggerTypeFactory(api: SwaggerAPI, schema: OpenAPISchema, schemaName: string | undefined, typeRegistry: TypeRegistry<SwaggerType>, logger: LoggerService, fileParserLogger: FileParserLogger, resolve?: boolean, allowedTypes?: Set<Type['type']> | undefined, skipRegistry?: boolean, jsonPath?: string): SwaggerType;
+export type SwaggerTypeFactory = typeof swaggerTypeFactory;

package/dist/types/v1/parser/swagger/types/index.d.ts

@@ -0,0 +1,21 @@
+import type { OpenAPIV3 } from 'openapi-types';
+import type { Type } from '../../../types';
+export type SwaggerTypeProps = {
+    schema: OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject;
+    schemaName: string | undefined;
+    resolve: () => void;
+    resolved: boolean;
+};
+export type SwaggerType = SwaggerTypeProps & Type;
+export * from './SwaggerAnyType';
+export * from './SwaggerArrayType';
+export * from './SwaggerObjectType';
+export * from './SwaggerNilType';
+export * from './SwaggerScalarTypes';
+export * from './SwaggerOneOfType';
+export * from './SwaggerAllOfType';
+export * from './SwaggerEnumType';
+export * from './SwaggerRefType';
+export * from './SwaggerNotType';
+export * from './SwaggerDiscriminatedObjectType';
+export * from './factory';

package/dist/types/v1/parser/swagger/validation.d.ts

@@ -0,0 +1,11 @@
+import type { FileParserLogger } from '@conduit-client/utils';
+import type { SwaggerAPI } from './SwaggerAPI';
+/**
+ * Validates the @api and logs any information related to validation. Returns
+ * true when the @api model is valid and false otherwise.
+ *
+ * @param api
+ * @param fileParserLogger
+ * @returns true when the @api model is valid, false otherwise.
+ */
+export declare function isValidSwaggerAPI(api: SwaggerAPI, fileParserLogger: FileParserLogger): boolean;

package/dist/types/v1/parser/swagger/version.d.ts

@@ -0,0 +1,6 @@
+import type { OpenAPIV3 } from 'openapi-types';
+import { type Version } from '@conduit-client/utils';
+/**
+ * Extracts the version from the x-onestore extension in the OpenAPI document
+ */
+export declare function getSwaggerAnnotationVersion(document: OpenAPIV3.Document): Version;