@conduit-client/model 3.9.0 → 3.11.0

package/dist/types/v1/parser/__tests__/test-utils.d.ts

@@ -10,6 +10,7 @@ import { SourcePositionMap } from '../swagger/source-position-map';
 import { SwaggerAPI } from '../swagger/SwaggerAPI';
 import { AmfEndPoint } from '../amf/endpoints/amf-endpoint';
 import { API, Server } from '../../api';
+import type SwaggerParser from '@apidevtools/swagger-parser';
 export type ParserKind = 'amf' | 'swagger';
 type ClassOfConstructor<T> = T extends new () => infer R ? R : never;
 /**
@@ -37,6 +38,7 @@ type TestSwaggerOAS<T extends Record<string, new () => amf.AnyShape>, E extends
     document: OpenAPIV3.Document;
     sourceUrl: URL;
     positionMap: SourcePositionMap;
+    $refs: SwaggerParser.$Refs;
 } & {
     [P in keyof T]: OpenAPIV3.SchemaObject;
 } & {

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

@@ -6,6 +6,7 @@ import type { API, EndPoint, Server } from '../../api';
 import type { ReadOnlyTypeRegistry, TypeRegistry } from '../../types';
 import type { OpenAPIV3 } from 'openapi-types';
 import type { NamedFeatureFlagsService } from '@conduit-client/service-feature-flags/v1';
+import type SwaggerParser from '@apidevtools/swagger-parser';
 export declare const V1_VERSION = "1.0.0";
 export declare const ANONYMOUS_TYPE_NAME = "<anonymous>";
 export declare class SwaggerAPI implements API {
@@ -14,6 +15,7 @@ export declare class SwaggerAPI implements API {
     private services;
     private fileParserLogger;
     private positionMap;
+    private $refs;
     typeRegistry?: TypeRegistry<SwaggerType>;
     _endpoints?: EndPoint[];
     _servers?: Server[];
@@ -25,13 +27,27 @@ export declare class SwaggerAPI implements API {
     private parsedNamespace?;
     private defaultedNamespace;
     serviceOverrides?: ResolvedServiceOverrides;
-    constructor(document: OpenAPIV3.Document, sourceUrl: URL, services: NamedLoggerService & NamedFeatureFlagsService, fileParserLogger: FileParserLogger, positionMap: SourcePositionMap);
+    constructor(document: OpenAPIV3.Document, sourceUrl: URL, services: NamedLoggerService & NamedFeatureFlagsService, fileParserLogger: FileParserLogger, positionMap: SourcePositionMap, $refs: SwaggerParser.$Refs);
     /**
      * Get the source position for a given JSON path in the OpenAPI document.
      * @param jsonPath - The JSON path (e.g., "paths//users/get" or "components/schemas/User")
      * @returns The position if found, undefined otherwise
      */
     getPosition(jsonPath: string): Position | undefined;
+    /**
+     * Find the position of a $ref declaration by its target value.
+     * @param refValue - The $ref target string (e.g., "./schemas/User.yaml#/TypeThatDoesNotExist")
+     * @returns The position where the $ref is declared, if found
+     */
+    getRefPosition(refValue: string): Position | undefined;
+    /**
+     * Resolve a $ref target path with respect to the directory of the source.
+     * This is particularly necessary for relative paths since this.$refs.get() resolves
+     * paths relative to the root file and not the ref source file.
+     * @param refPath - The $ref target path (e.g., "./schemas/User.yaml#/User")
+     * @returns The path from where the $ref is declared (e.g, "file:///path/to/source/./schemas/User.yaml#/User")
+     */
+    resolveRefTargetPath(refTarget: string): any;
     private build;
     private buildEndpoints;
     private buildServers;

package/dist/types/v1/parser/swagger/__tests__/source-position-map.spec.d.ts

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

package/dist/types/v1/parser/swagger/endpoints/swagger-operation.d.ts

@@ -1,4 +1,5 @@
 import { type LoggerService, type FileParserLogger } from '@conduit-client/utils';
+import type { Position } from '../source-position-map';
 import type { OpenAPIV3 } from 'openapi-types';
 import type { BaseAuraOperation, AuraOperationWithRequestBody, BaseOperation, HttpMethod, Request, Response, CacheStrategy, ConfigSchemaType, OperationType, ErrorStrategy, Binding, BaseHttpOperation, HttpOperationWithRequestBody, BaseGraphQLOperation } from '../../../api/endpoint';
 import type { SwaggerType, SwaggerTypeFactory } from '../types';
@@ -29,10 +30,7 @@ export declare abstract class SwaggerBaseOperation implements BaseOperation {
     protected operationSchemaBuilder: OperationSchemaBuilder;
     defaults: API['defaults'];
     serviceOverrides: ResolvedOperationServices;
-    position: {
-        line: number;
-        column: number;
-    };
+    position: Position;
     basePath: string;
     abstract readonly type: 'aura' | 'http';
     constructor(operation: OpenAPIV3.OperationObject, methodStr: string, swaggerTypeFactory: SwaggerTypeFactory, typeRegistry: TypeRegistry<SwaggerType>, logger: LoggerService, fileParserLogger: FileParserLogger, endpoint: SwaggerEndPoint, server: Server);

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

@@ -1,3 +1,4 @@
+import SwaggerParser from '@apidevtools/swagger-parser';
 import { SwaggerAPI } from './SwaggerAPI';
 import { SourcePositionMap } from './source-position-map';
 import type { OpenAPIV3 } from 'openapi-types';
@@ -6,6 +7,7 @@ import type { NamedFeatureFlagsService } from '@conduit-client/service-feature-f
 export interface ParsedSwaggerDocument {
     document: OpenAPIV3.Document;
     positionMap: SourcePositionMap;
+    $refs: SwaggerParser.$Refs;
 }
 /**
  * Parse and validate an OpenAPI document using swagger-parser

package/dist/types/v1/parser/swagger/source-position-map.d.ts

@@ -4,18 +4,27 @@
 export interface Position {
     line: number;
     column: number;
+    filePath: string;
 }
 /**
- * Maps JSON paths to their source positions in the YAML file.
+ * Maps JSON paths to their source positions in YAML files.
  * Used to provide accurate line/column information for validation errors.
+ * Supports both single-file and multi-file scenarios.
  */
 export declare class SourcePositionMap {
     private positions;
+    private fileUrls;
+    private refTargets;
     /**
      * Get the position for a given JSON path
      * @param jsonPath - The JSON path (e.g., "paths//users/get" or "components/schemas/User")
      */
     get(jsonPath: string): Position | undefined;
+    /**
+     * Get the position for a given $ref path
+     * @param refPath - The $ref path (e.g., "./schemas/User.yaml#/User")
+     */
+    getRef(refPath: string): Position | undefined;
     /**
      * Set the position for a given JSON path
      */
@@ -28,12 +37,40 @@ export declare class SourcePositionMap {
      * Get all stored paths
      */
     keys(): IterableIterator<string>;
+    /**
+     * Get all entries as [jsonPath, position] pairs
+     */
+    entries(): IterableIterator<[string, Position]>;
+    /**
+     * Get the number of files tracked in this map
+     */
+    get fileCount(): number;
+    /**
+     * Track a $ref target value and its position
+     */
+    setRefTarget(refValue: string, position: Position): void;
+    /**
+     * Find the position of a $ref that targets a file containing the given path,
+     * or an internal ref containing the given token.
+     */
+    findRefPosition(targetPath: string, token?: string): {
+        position: Position;
+        refValue: string;
+    } | undefined;
+    /**
+     * Merge positions from another map, setting filePath on each position.
+     * Used to aggregate positions from multiple files (e.g., external $refs).
+     * @param other - The source position map to merge from
+     * @param fileUrl - The file URL to associate with these positions
+     */
+    merge(other: SourcePositionMap, fileUrl: string): void;
 }
 /**
  * Builds a SourcePositionMap from YAML content by parsing it with the yaml package
  * which preserves source position information.
  *
  * @param yamlContent - The raw YAML content as a string
+ * @param fileUrl - The URL of the file being parsed
  * @returns A SourcePositionMap containing positions for operations and schemas
  */
-export declare function buildSourcePositionMap(yamlContent: string): SourcePositionMap;
+export declare function buildSourcePositionMap(yamlContent: string, fileUrl: string): SourcePositionMap;

package/dist/types/v1/parser/swagger/swagger-utils.d.ts

@@ -6,7 +6,8 @@ export type OpenAPISchema = OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject;
  * Works with any OpenAPI object type that could be a reference
  */
 export declare function isReferenceObject<T>(obj: T | OpenAPIV3.ReferenceObject): obj is OpenAPIV3.ReferenceObject;
-export declare function isSchemaObject(schema: OpenAPISchema): schema is OpenAPIV3.SchemaObject;
+export declare function isSchemaObject(obj: unknown): obj is OpenAPIV3.SchemaObject;
+export declare function isOpenAPISchema(obj: unknown): obj is OpenAPISchema;
 export declare function isArraySchema(schema: OpenAPIV3.SchemaObject): boolean;
 export declare function isObjectSchema(schema: OpenAPIV3.SchemaObject): boolean;
 export declare function isScalarSchema(schema: OpenAPIV3.SchemaObject): boolean;
@@ -23,7 +24,10 @@ export declare function hasDiscriminator(schema: OpenAPIV3.SchemaObject): boolea
 export declare function mapScalarType(schema: OpenAPIV3.SchemaObject): ScalarType['type'];
 /**
  * Extracts the type name from a $ref string
- * e.g., "#/components/schemas/User" -> "User"
+ * Handles both internal refs and external file refs:
+ * - "#/components/schemas/User" -> "User"
+ * - "./schemas/User.yaml#/User" -> "User"
+ * - "../../path/to/File.yaml#TypeName" -> "TypeName"
  */
 export declare function getRefTypeName(ref: string): string;
 /**
@@ -35,3 +39,13 @@ export declare function coerceValueByType(value: unknown, type: ScalarType['type
  * Throws an error if non-scalar values (objects/arrays) are found.
  */
 export declare function getEnumValues(schema: OpenAPIV3.SchemaObject, schemaName?: string): Array<string | number | boolean | null>;
+export declare function isReferencePath(obj: OpenAPIV3.PathItemObject): obj is OpenAPIV3.PathItemObject & {
+    $ref: string;
+};
+/**
+ * Extracts root-level schemas from a file.
+ * External schema files may define schemas at the root level (not under components/schemas).
+ * This function identifies such schemas by excluding known OpenAPI document properties
+ * and checking for schema-specific properties.
+ */
+export declare function extractRootLevelSchemas(file: OpenAPIV3.Document): Record<string, OpenAPISchema>;

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

@@ -1,3 +1,4 @@
+import type { Position } from '../source-position-map';
 import type { SwaggerTypeFactory } from './factory';
 import type { OpenAPIV3 } from 'openapi-types';
 import type { BaseType, Type, TypeExtensions, TypeRegistry } from '../../../types';
@@ -15,10 +16,7 @@ export declare abstract class SwaggerBaseType<T extends Type['type'], S extends
     resolved: boolean;
     abstract type: T;
     parsedExtensions: TypeExtensions;
-    schemaPosition: {
-        line: number;
-        column: number;
-    };
+    schemaPosition: Position;
     constructor(api: SwaggerAPI, schema: S, schemaName: string | undefined, typeRegistry: TypeRegistry<SwaggerType>, factory: SwaggerTypeFactory, logger: LoggerService, fileParserLogger: FileParserLogger, jsonPath?: string);
     resolve(): void;
     typeResolve(): void;