@sebspark/openapi-core 1.2.0 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/index.d.mts +8 -3
  2. package/dist/index.d.ts +8 -3
  3. package/package.json +1 -1
package/dist/index.d.mts CHANGED
@@ -1,4 +1,5 @@
1
1
  import { AxiosError } from 'axios';
2
+ import { OutgoingHttpHeaders } from 'http';
2
3
  import { RetrySettings } from '@sebspark/retry';
3
4
  import { Request, Response, NextFunction } from 'express';
4
5
 
@@ -181,9 +182,13 @@ type PayloadRequestArgs = RequestArgs & {
181
182
  body?: Record<string, string>;
182
183
  };
183
184
  type RequestOptions = {
184
- retry: RetrySettings;
185
+ retry?: RetrySettings;
186
+ headers?: OutgoingHttpHeaders & Record<string, string>;
187
+ };
188
+ type ArrayFormat = 'indices' | 'brackets' | 'repeat' | 'comma';
189
+ type ClientOptions = RequestOptions & {
190
+ arrayFormat?: ArrayFormat;
185
191
  };
186
- type ClientOptions = RequestOptions & {};
187
192
  type BaseClient = {
188
193
  get: <U extends string, A extends RequestArgs | never, R extends APIResponse<unknown | undefined, Record<string, string> | undefined>>(url: U, args?: A, opts?: RequestOptions) => Promise<R>;
189
194
  post: <U extends string, A extends PayloadRequestArgs | never, R extends APIResponse<unknown | undefined, Record<string, string> | undefined>>(url: U, args?: A, opts?: RequestOptions) => Promise<R>;
@@ -712,4 +717,4 @@ type LinkObject = {
712
717
  type CallbackObject = Record<string, PathItemObject | ReferenceObject>;
713
718
  type SecurityRequirementObject = Record<string, string[]>;
714
719
 
715
- export { type APIResponse, type APIServerDefinition, type APIServerOptions, type AsyncApiComponentsObject, type AsyncApiDocument, type AsyncOperationObject, type AvroArray, type AvroEnum, type AvroField, type AvroMap, type AvroPrimitive, type AvroRecord, type AvroSchema, type AvroUnion, BadGatewayError, BadRequestError, type BaseClient, type CallbackObject, type ChannelItemObject, type ClientErrorCode, type ClientOptions, type ComponentsObject, ConflictError, type ContactObject, type CorrelationIdObject, type DefaultValue, type DiscriminatorObject, type EncodingObject, type ErrorCode, type Example, type ExampleObject, ExpectationFailedError, type ExternalDocumentationObject, FailedDependencyError, ForbiddenError, GatewayTimeoutError, type GenericRouteHandler, GoneError, HTTPVersionNotSupportedError, type HeaderObject, type HeaderStyle, HttpError, type HttpMethod, IMATeapotError, type InfoObject, InsufficientStorageError, InternalServerError, LengthRequiredError, type LicenseObject, type LinkObject, LockedError, LoopDetectedError, type LowerCaseHeaders, type MediaTypeObject, type MessageObject, type MessageTraitObject, MethodNotAllowedError, MisdirectedRequestError, NetworkAuthenticationRequiredError, NotAcceptableError, NotExtendedError, NotFoundError, NotImplementedError, type OAuthFlowObject, type OAuthFlowsObject, type OpenApiDocument, type OperationObject, type OperationTraitObject, type ParameterIn, type ParameterObject, type ParameterStyle, type PartiallySerialized, type PathItemObject, type PayloadRequestArgs, PayloadTooLargeError, PaymentRequiredError, PreconditionFailedError, PreconditionRequiredError, ProxyAuthenticationRequiredError, RangeNotSatisfiableError, type ReferenceObject, type RequestArgs, type RequestBodyObject, RequestHeaderFieldsTooLargeError, type RequestOptions, RequestTimeoutError, type ResponseObject, type ResponsesObject, type Route, type RouteHandler, type SchemaEnum, type SchemaObject, type SchemaType, type SecurityRequirementObject, type SecuritySchemeObject, type SecuritySchemeType, type Serialized, type ServerErrorCode, type ServerObject, type ServerVariableObject, ServiceUnavailableError, type TagObject, TooEarlyError, TooManyRequestsError, URITooLongError, UnauthorizedError, UnavailableForLegalReasonsError, UnprocessableEntityError, UnsupportedMediaTypeError, UpgradeRequiredError, VariantAlsoNegotiatesError, type Verb, type XMLObject, createHttpError, fromAxiosError };
720
+ export { type APIResponse, type APIServerDefinition, type APIServerOptions, type ArrayFormat, type AsyncApiComponentsObject, type AsyncApiDocument, type AsyncOperationObject, type AvroArray, type AvroEnum, type AvroField, type AvroMap, type AvroPrimitive, type AvroRecord, type AvroSchema, type AvroUnion, BadGatewayError, BadRequestError, type BaseClient, type CallbackObject, type ChannelItemObject, type ClientErrorCode, type ClientOptions, type ComponentsObject, ConflictError, type ContactObject, type CorrelationIdObject, type DefaultValue, type DiscriminatorObject, type EncodingObject, type ErrorCode, type Example, type ExampleObject, ExpectationFailedError, type ExternalDocumentationObject, FailedDependencyError, ForbiddenError, GatewayTimeoutError, type GenericRouteHandler, GoneError, HTTPVersionNotSupportedError, type HeaderObject, type HeaderStyle, HttpError, type HttpMethod, IMATeapotError, type InfoObject, InsufficientStorageError, InternalServerError, LengthRequiredError, type LicenseObject, type LinkObject, LockedError, LoopDetectedError, type LowerCaseHeaders, type MediaTypeObject, type MessageObject, type MessageTraitObject, MethodNotAllowedError, MisdirectedRequestError, NetworkAuthenticationRequiredError, NotAcceptableError, NotExtendedError, NotFoundError, NotImplementedError, type OAuthFlowObject, type OAuthFlowsObject, type OpenApiDocument, type OperationObject, type OperationTraitObject, type ParameterIn, type ParameterObject, type ParameterStyle, type PartiallySerialized, type PathItemObject, type PayloadRequestArgs, PayloadTooLargeError, PaymentRequiredError, PreconditionFailedError, PreconditionRequiredError, ProxyAuthenticationRequiredError, RangeNotSatisfiableError, type ReferenceObject, type RequestArgs, type RequestBodyObject, RequestHeaderFieldsTooLargeError, type RequestOptions, RequestTimeoutError, type ResponseObject, type ResponsesObject, type Route, type RouteHandler, type SchemaEnum, type SchemaObject, type SchemaType, type SecurityRequirementObject, type SecuritySchemeObject, type SecuritySchemeType, type Serialized, type ServerErrorCode, type ServerObject, type ServerVariableObject, ServiceUnavailableError, type TagObject, TooEarlyError, TooManyRequestsError, URITooLongError, UnauthorizedError, UnavailableForLegalReasonsError, UnprocessableEntityError, UnsupportedMediaTypeError, UpgradeRequiredError, VariantAlsoNegotiatesError, type Verb, type XMLObject, createHttpError, fromAxiosError };
package/dist/index.d.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  import { AxiosError } from 'axios';
2
+ import { OutgoingHttpHeaders } from 'http';
2
3
  import { RetrySettings } from '@sebspark/retry';
3
4
  import { Request, Response, NextFunction } from 'express';
4
5
 
@@ -181,9 +182,13 @@ type PayloadRequestArgs = RequestArgs & {
181
182
  body?: Record<string, string>;
182
183
  };
183
184
  type RequestOptions = {
184
- retry: RetrySettings;
185
+ retry?: RetrySettings;
186
+ headers?: OutgoingHttpHeaders & Record<string, string>;
187
+ };
188
+ type ArrayFormat = 'indices' | 'brackets' | 'repeat' | 'comma';
189
+ type ClientOptions = RequestOptions & {
190
+ arrayFormat?: ArrayFormat;
185
191
  };
186
- type ClientOptions = RequestOptions & {};
187
192
  type BaseClient = {
188
193
  get: <U extends string, A extends RequestArgs | never, R extends APIResponse<unknown | undefined, Record<string, string> | undefined>>(url: U, args?: A, opts?: RequestOptions) => Promise<R>;
189
194
  post: <U extends string, A extends PayloadRequestArgs | never, R extends APIResponse<unknown | undefined, Record<string, string> | undefined>>(url: U, args?: A, opts?: RequestOptions) => Promise<R>;
@@ -712,4 +717,4 @@ type LinkObject = {
712
717
  type CallbackObject = Record<string, PathItemObject | ReferenceObject>;
713
718
  type SecurityRequirementObject = Record<string, string[]>;
714
719
 
715
- export { type APIResponse, type APIServerDefinition, type APIServerOptions, type AsyncApiComponentsObject, type AsyncApiDocument, type AsyncOperationObject, type AvroArray, type AvroEnum, type AvroField, type AvroMap, type AvroPrimitive, type AvroRecord, type AvroSchema, type AvroUnion, BadGatewayError, BadRequestError, type BaseClient, type CallbackObject, type ChannelItemObject, type ClientErrorCode, type ClientOptions, type ComponentsObject, ConflictError, type ContactObject, type CorrelationIdObject, type DefaultValue, type DiscriminatorObject, type EncodingObject, type ErrorCode, type Example, type ExampleObject, ExpectationFailedError, type ExternalDocumentationObject, FailedDependencyError, ForbiddenError, GatewayTimeoutError, type GenericRouteHandler, GoneError, HTTPVersionNotSupportedError, type HeaderObject, type HeaderStyle, HttpError, type HttpMethod, IMATeapotError, type InfoObject, InsufficientStorageError, InternalServerError, LengthRequiredError, type LicenseObject, type LinkObject, LockedError, LoopDetectedError, type LowerCaseHeaders, type MediaTypeObject, type MessageObject, type MessageTraitObject, MethodNotAllowedError, MisdirectedRequestError, NetworkAuthenticationRequiredError, NotAcceptableError, NotExtendedError, NotFoundError, NotImplementedError, type OAuthFlowObject, type OAuthFlowsObject, type OpenApiDocument, type OperationObject, type OperationTraitObject, type ParameterIn, type ParameterObject, type ParameterStyle, type PartiallySerialized, type PathItemObject, type PayloadRequestArgs, PayloadTooLargeError, PaymentRequiredError, PreconditionFailedError, PreconditionRequiredError, ProxyAuthenticationRequiredError, RangeNotSatisfiableError, type ReferenceObject, type RequestArgs, type RequestBodyObject, RequestHeaderFieldsTooLargeError, type RequestOptions, RequestTimeoutError, type ResponseObject, type ResponsesObject, type Route, type RouteHandler, type SchemaEnum, type SchemaObject, type SchemaType, type SecurityRequirementObject, type SecuritySchemeObject, type SecuritySchemeType, type Serialized, type ServerErrorCode, type ServerObject, type ServerVariableObject, ServiceUnavailableError, type TagObject, TooEarlyError, TooManyRequestsError, URITooLongError, UnauthorizedError, UnavailableForLegalReasonsError, UnprocessableEntityError, UnsupportedMediaTypeError, UpgradeRequiredError, VariantAlsoNegotiatesError, type Verb, type XMLObject, createHttpError, fromAxiosError };
720
+ export { type APIResponse, type APIServerDefinition, type APIServerOptions, type ArrayFormat, type AsyncApiComponentsObject, type AsyncApiDocument, type AsyncOperationObject, type AvroArray, type AvroEnum, type AvroField, type AvroMap, type AvroPrimitive, type AvroRecord, type AvroSchema, type AvroUnion, BadGatewayError, BadRequestError, type BaseClient, type CallbackObject, type ChannelItemObject, type ClientErrorCode, type ClientOptions, type ComponentsObject, ConflictError, type ContactObject, type CorrelationIdObject, type DefaultValue, type DiscriminatorObject, type EncodingObject, type ErrorCode, type Example, type ExampleObject, ExpectationFailedError, type ExternalDocumentationObject, FailedDependencyError, ForbiddenError, GatewayTimeoutError, type GenericRouteHandler, GoneError, HTTPVersionNotSupportedError, type HeaderObject, type HeaderStyle, HttpError, type HttpMethod, IMATeapotError, type InfoObject, InsufficientStorageError, InternalServerError, LengthRequiredError, type LicenseObject, type LinkObject, LockedError, LoopDetectedError, type LowerCaseHeaders, type MediaTypeObject, type MessageObject, type MessageTraitObject, MethodNotAllowedError, MisdirectedRequestError, NetworkAuthenticationRequiredError, NotAcceptableError, NotExtendedError, NotFoundError, NotImplementedError, type OAuthFlowObject, type OAuthFlowsObject, type OpenApiDocument, type OperationObject, type OperationTraitObject, type ParameterIn, type ParameterObject, type ParameterStyle, type PartiallySerialized, type PathItemObject, type PayloadRequestArgs, PayloadTooLargeError, PaymentRequiredError, PreconditionFailedError, PreconditionRequiredError, ProxyAuthenticationRequiredError, RangeNotSatisfiableError, type ReferenceObject, type RequestArgs, type RequestBodyObject, RequestHeaderFieldsTooLargeError, type RequestOptions, RequestTimeoutError, type ResponseObject, type ResponsesObject, type Route, type RouteHandler, type SchemaEnum, type SchemaObject, type SchemaType, type SecurityRequirementObject, type SecuritySchemeObject, type SecuritySchemeType, type Serialized, type ServerErrorCode, type ServerObject, type ServerVariableObject, ServiceUnavailableError, type TagObject, TooEarlyError, TooManyRequestsError, URITooLongError, UnauthorizedError, UnavailableForLegalReasonsError, UnprocessableEntityError, UnsupportedMediaTypeError, UpgradeRequiredError, VariantAlsoNegotiatesError, type Verb, type XMLObject, createHttpError, fromAxiosError };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sebspark/openapi-core",
3
- "version": "1.2.0",
3
+ "version": "1.4.0",
4
4
  "license": "Apache-2.0",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",