@jentic/arazzo-resolver 1.0.0-alpha.10

package/types/arazzo-resolver.d.ts

@@ -0,0 +1,217 @@
+import { ApiDOMError } from '@speclynx/apidom-error';
+import { ApiDOMErrorOptions } from '@speclynx/apidom-error';
+import type { ApiDOMReferenceOptions } from '@speclynx/apidom-reference/configuration/empty';
+import { Element as Element_2 } from '@speclynx/apidom-datamodel';
+import { ParseResultElement } from '@speclynx/apidom-datamodel';
+import type { PartialDeep } from 'type-fest';
+
+/**
+ * Default reference options for dereferencing Arazzo Documents.
+ * @public
+ */
+export declare const defaultDereferenceArazzoOptions: DereferenceArazzoOptions;
+
+/**
+ * Default reference options for dereferencing OpenAPI Documents.
+ * @public
+ */
+export declare const defaultDereferenceOpenAPIOptions: DereferenceOpenAPIOptions;
+
+/**
+ * Dereferences an Arazzo Document from a file system path or HTTP(S) URL.
+ *
+ * This function resolves all JSON References ($ref) and Reusable Object references
+ * ($components.*) in the Arazzo Document.
+ *
+ * Source descriptions can optionally be dereferenced using strategy options:
+ * - `sourceDescriptions`: `true` (all) or `['name1', 'name2']` (specific names only)
+ * - `sourceDescriptionsMaxDepth`: Maximum recursion depth for nested Arazzo source descriptions (default: `+Infinity`)
+ *
+ * Options can be passed globally via `strategyOpts` or strategy-specific via `strategyOpts['arazzo-1']`.
+ *
+ * @param uri - A file system path or HTTP(S) URL to the Arazzo Document
+ * @param options - Reference options (uses defaultOptions when not provided)
+ * @returns A promise that resolves to the dereferenced Arazzo Document as ApiDOM element
+ * @throws DereferenceError - When dereferencing fails or document is not an Arazzo specification. The original error is available via the `cause` property.
+ *
+ * @example
+ * // Dereference from file
+ * const result = await dereferenceArazzo('/path/to/arazzo.json');
+ *
+ * @example
+ * // Dereference from URL
+ * const result = await dereferenceArazzo('https://example.com/arazzo.yaml');
+ *
+ * @example
+ * // Dereference with source descriptions
+ * const result = await dereferenceArazzo('/path/to/arazzo.json', {
+ *   dereference: { strategyOpts: { sourceDescriptions: true } },
+ * });
+ *
+ * @example
+ * // Dereference with custom options
+ * const result = await dereferenceArazzo('/path/to/arazzo.json', customReferenceOptions);
+ * @public
+ */
+export declare function dereferenceArazzo(uri: string, options?: DereferenceArazzoOptions): Promise<ParseResultElement>;
+
+/**
+ * Dereferences an ApiDOM element representing an Arazzo Document.
+ *
+ * This function resolves all JSON References ($ref) and Reusable Object references
+ * ($components.*) in the Arazzo Document element.
+ *
+ * Supported scenarios:
+ * - ParseResultElement with retrievalURI metadata: baseURI derived automatically
+ * - ParseResultElement without retrievalURI: requires `options.resolve.baseURI`
+ * - Child element (e.g., WorkflowElement) with parseResult in strategyOpts:
+ *   requires `options.dereference.strategyOpts.parseResult` for component resolution,
+ *   and `options.resolve.baseURI` if parseResult lacks retrievalURI metadata
+ *
+ * Source descriptions can optionally be dereferenced using strategy options:
+ * - `sourceDescriptions`: `true` (all) or `['name1', 'name2']` (specific names only)
+ * - `sourceDescriptionsMaxDepth`: Maximum recursion depth for nested Arazzo source descriptions (default: `+Infinity`)
+ *
+ * Options can be passed globally via `strategyOpts` or strategy-specific via `strategyOpts['arazzo-1']`.
+ *
+ * @param element - An ApiDOM element (ParseResultElement or child element like WorkflowElement)
+ * @param options - Reference options (uses defaultOptions when not provided)
+ * @returns A promise that resolves to the dereferenced element
+ * @throws DereferenceError - When baseURI is required but not provided, or when dereferencing fails
+ *
+ * @example
+ * Dereference ParseResultElement with retrievalURI (from file parsing)
+ * ```typescript
+ * import { parseArazzo } from '@jentic/arazzo-parser';
+ *
+ * const parseResult = await parseArazzo('/path/to/arazzo.json');
+ * const dereferenced = await dereferenceArazzoElement(parseResult);
+ * ```
+ *
+ * @example
+ * Dereference ParseResultElement without retrievalURI (from inline parsing)
+ * ```typescript
+ * const parseResult = await parseArazzo({ arazzo: '1.0.1', ... });
+ * const dereferenced = await dereferenceArazzoElement(parseResult, {
+ *   resolve: { baseURI: 'https://example.com/arazzo.json' },
+ * });
+ * ```
+ *
+ * @example
+ * Dereference child element (e.g., WorkflowElement)
+ * ```typescript
+ * const parseResult = await parseArazzo('/path/to/arazzo.json');
+ * const workflow = parseResult.api.workflows.get(0);
+ * const dereferenced = await dereferenceArazzoElement(workflow, {
+ *   dereference: { strategyOpts: { parseResult } },
+ * });
+ * ```
+ *
+ * @example
+ * Dereference with source descriptions
+ * ```typescript
+ * const parseResult = await parseArazzo('/path/to/arazzo.json');
+ * const dereferenced = await dereferenceArazzoElement(parseResult, {
+ *   dereference: { strategyOpts: { sourceDescriptions: true } },
+ * });
+ * ```
+ * @public
+ */
+export declare function dereferenceArazzoElement<T extends Element_2>(element: T, options?: DereferenceArazzoOptions): Promise<T>;
+
+/**
+ * Options for dereferencing Arazzo Documents.
+ * @public
+ */
+export declare type DereferenceArazzoOptions = PartialDeep<ApiDOMReferenceOptions>;
+
+/**
+ * Error thrown when dereferencing an Arazzo document or element fails.
+ * @public
+ */
+export declare class DereferenceError extends ApiDOMError {
+    constructor(message?: string, options?: ApiDOMErrorOptions);
+}
+
+/**
+ * Dereferences an OpenAPI Document from a file system path or HTTP(S) URL.
+ *
+ * This function resolves all JSON References ($ref) in the OpenAPI Document.
+ *
+ * Supports OpenAPI 2.0 (Swagger), OpenAPI 3.0.x, and OpenAPI 3.1.x.
+ *
+ * @param uri - A file system path or HTTP(S) URL to the OpenAPI Document
+ * @param options - Reference options (uses defaultOptions when not provided)
+ * @returns A promise that resolves to the dereferenced OpenAPI Document as ApiDOM element
+ * @throws DereferenceError - When dereferencing fails or document is not an OpenAPI specification. The original error is available via the `cause` property.
+ *
+ * @example
+ * // Dereference from file
+ * const result = await dereferenceOpenAPI('/path/to/openapi.json');
+ *
+ * @example
+ * // Dereference from URL
+ * const result = await dereferenceOpenAPI('https://example.com/openapi.yaml');
+ *
+ * @example
+ * // Dereference with custom options
+ * const result = await dereferenceOpenAPI('/path/to/openapi.json', customReferenceOptions);
+ * @public
+ */
+export declare function dereferenceOpenAPI(uri: string, options?: DereferenceOpenAPIOptions): Promise<ParseResultElement>;
+
+/**
+ * Dereferences an ApiDOM element representing an OpenAPI Document.
+ *
+ * This function resolves all JSON References ($ref) in the OpenAPI Document element.
+ *
+ * Supported scenarios:
+ * - ParseResultElement with retrievalURI metadata: baseURI derived automatically
+ * - ParseResultElement without retrievalURI: requires `options.resolve.baseURI`
+ * - Child element (e.g., PathItemElement) with parseResult in strategyOpts:
+ *   requires `options.dereference.strategyOpts.parseResult` for component resolution,
+ *   and `options.resolve.baseURI` if parseResult lacks retrievalURI metadata
+ *
+ * @param element - An ApiDOM element (ParseResultElement or child element like PathItemElement)
+ * @param options - Reference options (uses defaultOptions when not provided)
+ * @returns A promise that resolves to the dereferenced element
+ * @throws DereferenceError - When baseURI is required but not provided, or when dereferencing fails
+ *
+ * @example
+ * Dereference ParseResultElement with retrievalURI (from file parsing)
+ * ```typescript
+ * import { parseOpenAPI } from '@jentic/arazzo-parser';
+ *
+ * const parseResult = await parseOpenAPI('/path/to/openapi.json');
+ * const dereferenced = await dereferenceOpenAPIElement(parseResult);
+ * ```
+ *
+ * @example
+ * Dereference ParseResultElement without retrievalURI (from inline parsing)
+ * ```typescript
+ * const parseResult = await parseOpenAPI({ openapi: '3.1.0', ... });
+ * const dereferenced = await dereferenceOpenAPIElement(parseResult, {
+ *   resolve: { baseURI: 'https://example.com/openapi.json' },
+ * });
+ * ```
+ *
+ * @example
+ * Dereference child element (e.g., PathItemElement)
+ * ```typescript
+ * const parseResult = await parseOpenAPI('/path/to/openapi.json');
+ * const pathItem = parseResult.api.paths.get('/users');
+ * const dereferenced = await dereferenceOpenAPIElement(pathItem, {
+ *   dereference: { strategyOpts: { parseResult } },
+ * });
+ * ```
+ * @public
+ */
+export declare function dereferenceOpenAPIElement<T extends Element_2>(element: T, options?: DereferenceOpenAPIOptions): Promise<T>;
+
+/**
+ * Options for dereferencing OpenAPI Documents.
+ * @public
+ */
+export declare type DereferenceOpenAPIOptions = PartialDeep<ApiDOMReferenceOptions>;
+
+export { }