@scalar/oas-utils 0.2.32 → 0.2.34

package/dist/types.d.ts

@@ -1,200 +0,0 @@
-import type { ExternalDocumentation } from './entities/workspace/collection/index.js';
-import type { RequestMethod } from './helpers/index.js';
-import type { OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from '@scalar/openapi-parser';
-import type { HarRequest } from 'httpsnippet-lite';
-export type AnyObject = Record<string, any>;
-export type AnyStringOrObject = string | Record<string, any>;
-export type BaseParameter = {
-    name: string;
-    description?: string | null;
-    value: string | number | Record<string, any>;
-    required?: boolean;
-    enabled: boolean;
-};
-type OptionalCharset = string | null;
-export type ContentType = `application/json${OptionalCharset}` | `application/xml${OptionalCharset}` | `text/plain${OptionalCharset}` | `text/html${OptionalCharset}` | `application/octet-stream${OptionalCharset}` | `application/x-www-form-urlencoded${OptionalCharset}` | `multipart/form-data${OptionalCharset}`;
-export type Cookie = {
-    name: string;
-    value: string;
-};
-export type CustomRequestExample = {
-    lang: string;
-    label: string;
-    source: string;
-};
-export type HarRequestWithPath = HarRequest & {
-    path: string;
-};
-export type Header = {
-    name: string;
-    value: string;
-};
-export type Information = {
-    'description'?: string;
-    'operationId'?: string | number;
-    'parameters'?: Parameters[];
-    'responses'?: Record<string, ScalarResponse>;
-    'security'?: OpenAPIV3.SecurityRequirementObject[];
-    'requestBody'?: RequestBody;
-    'summary'?: string;
-    'tags'?: string[];
-    'deprecated'?: boolean;
-    /**
-     * Scalar
-     */
-    'x-custom-examples'?: CustomRequestExample[];
-    /**
-     * Redocly, current
-     */
-    'x-codeSamples'?: CustomRequestExample[];
-    /**
-     * Redocly, deprecated
-     */
-    'x-code-samples'?: CustomRequestExample[];
-};
-export type Operation = {
-    httpVerb: RequestMethod;
-    path: string;
-    operationId?: string;
-    name?: string;
-    description?: string;
-    information?: Information;
-};
-export type Parameters = {
-    name: string;
-    in?: string;
-    description?: string;
-    required?: boolean;
-    deprecated?: boolean;
-    allowEmptyValue?: boolean;
-    style?: 'form' | 'simple';
-    explode?: boolean;
-    allowReserved?: boolean;
-    schema?: Schema;
-    example?: any;
-    examples?: Map<string, any>;
-    content?: RequestBodyMimeTypes;
-};
-export type Query = {
-    name: string;
-    value: string;
-};
-export type RequestBodyMimeTypes = {
-    [K in ContentType]?: {
-        schema?: any;
-        example?: any;
-        examples?: any;
-    };
-};
-export type ScalarResponse = {
-    description: string;
-    content: any;
-};
-export type RequestBody = {
-    description?: string;
-    required?: boolean;
-    content?: RequestBodyMimeTypes;
-};
-/** For providing a OAS spec object or url to be fetched */
-export type SpecConfiguration = {
-    /** URL to a Swagger/OpenAPI file */
-    url?: string;
-    /** Swagger/Open API spec */
-    content?: string | Record<string, any> | (() => Record<string, any>);
-};
-export type Schema = {
-    type: string;
-    name?: string;
-    example?: any;
-    default?: any;
-    format?: string;
-    description?: string;
-    properties?: Record<string, Schema>;
-};
-export type TransformedOperation = Operation & {
-    pathParameters?: Parameters[];
-};
-export type CollapsedSidebarItems = Record<string, boolean>;
-export type AuthenticationState = {
-    customSecurity: boolean;
-    preferredSecurityScheme: string | null;
-    securitySchemes?: OpenAPIV2.SecurityDefinitionsObject | OpenAPIV3.ComponentsObject['securitySchemes'] | OpenAPIV3_1.ComponentsObject['securitySchemes'];
-    http: {
-        basic: {
-            username: string;
-            password: string;
-        };
-        bearer: {
-            token: string;
-        };
-    };
-    apiKey: {
-        token: string;
-    };
-    oAuth2: {
-        clientId: string;
-        scopes: string[];
-        accessToken: string;
-        state: string;
-        username: string;
-        password: string;
-    };
-};
-export type Heading = {
-    depth: number;
-    value: string;
-    slug?: string;
-};
-export type CodeBlockSSRKey = `components-scalar-code-block${number}`;
-export type DescriptionSectionSSRKey = `components-Content-Introduction-Description-sections${number}`;
-export type ExampleRequestSSRKey = `components-Content-Operation-Example-Request${number}`;
-export type ScalarState = {
-    'hash'?: string;
-    'useGlobalStore-authentication'?: AuthenticationState;
-    'useSidebarContent-collapsedSidebarItems'?: CollapsedSidebarItems;
-    [key: CodeBlockSSRKey]: string;
-    [key: DescriptionSectionSSRKey]: {
-        heading: Heading;
-        content: string;
-    }[];
-    [key: ExampleRequestSSRKey]: string;
-};
-export type SSRState = {
-    payload: {
-        data: ScalarState;
-    };
-    url: string;
-};
-export type Tag = {
-    'name': string;
-    'description': string;
-    'operations': TransformedOperation[];
-    'x-displayName'?: string;
-};
-export type TagGroup = {
-    name: string;
-    tags: string[];
-};
-export type SecurityScheme = Record<string, never> | OpenAPIV2.SecuritySchemeObject | OpenAPIV3.SecuritySchemeObject | OpenAPIV3_1.SecuritySchemeObject;
-export type Definitions = OpenAPIV2.DefinitionsObject;
-export type Webhooks = Record<string, Record<OpenAPIV3_1.HttpMethods, TransformedOperation & {
-    'x-internal'?: boolean;
-}>>;
-export type Spec = {
-    'tags'?: Tag[];
-    'info': Partial<OpenAPIV2.Document['info']> | Partial<OpenAPIV3.Document['info']> | Partial<OpenAPIV3_1.Document['info']>;
-    'host'?: OpenAPIV2.Document['host'];
-    'basePath'?: OpenAPIV2.Document['basePath'];
-    'schemes'?: OpenAPIV2.Document['schemes'];
-    'externalDocs'?: ExternalDocumentation;
-    'servers'?: OpenAPIV3.Document['servers'] | OpenAPIV3_1.Document['servers'];
-    'components'?: OpenAPIV3.ComponentsObject | OpenAPIV3_1.ComponentsObject;
-    'webhooks'?: Webhooks;
-    'definitions'?: Definitions;
-    'swagger'?: OpenAPIV2.Document['swagger'];
-    'openapi'?: OpenAPIV3.Document['openapi'] | OpenAPIV3_1.Document['openapi'];
-    'x-tagGroups'?: TagGroup[];
-    'security'?: OpenAPIV3.SecurityRequirementObject[];
-};
-export {};
-//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAA;AAC5E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AAC9C,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AAC/E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAElD,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;AAE3C,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;AAE5D,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC5C,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,KAAK,eAAe,GAAG,MAAM,GAAG,IAAI,CAAA;AAEpC,MAAM,MAAM,WAAW,GACnB,mBAAmB,eAAe,EAAE,GACpC,kBAAkB,eAAe,EAAE,GACnC,aAAa,eAAe,EAAE,GAC9B,YAAY,eAAe,EAAE,GAC7B,2BAA2B,eAAe,EAAE,GAC5C,oCAAoC,eAAe,EAAE,GACrD,sBAAsB,eAAe,EAAE,CAAA;AAE3C,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,UAAU,GAAG;IAC5C,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC/B,YAAY,CAAC,EAAE,UAAU,EAAE,CAAA;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IAC5C,UAAU,CAAC,EAAE,SAAS,CAAC,yBAAyB,EAAE,CAAA;IAClD,aAAa,CAAC,EAAE,WAAW,CAAA;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,oBAAoB,EAAE,CAAA;IAC5C;;OAEG;IACH,eAAe,CAAC,EAAE,oBAAoB,EAAE,CAAA;IACxC;;OAEG;IACH,gBAAgB,CAAC,EAAE,oBAAoB,EAAE,CAAA;CAC1C,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,QAAQ,EAAE,aAAa,CAAA;IACvB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,WAAW,CAAC,EAAE,WAAW,CAAA;CAC1B,CAAA;AACD,MAAM,MAAM,UAAU,GAAG;IAEvB,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,eAAe,CAAC,EAAE,OAAO,CAAA;IAEzB,KAAK,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAA;IACzB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,GAAG,CAAA;IACb,QAAQ,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC3B,OAAO,CAAC,EAAE,oBAAoB,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,KAAK,GAAG;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAGD,MAAM,MAAM,oBAAoB,GAAG;KAChC,CAAC,IAAI,WAAW,CAAC,CAAC,EAAE;QACnB,MAAM,CAAC,EAAE,GAAG,CAAA;QACZ,OAAO,CAAC,EAAE,GAAG,CAAA;QACb,QAAQ,CAAC,EAAE,GAAG,CAAA;KACf;CACF,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,GAAG,CAAA;CACb,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,OAAO,CAAC,EAAE,oBAAoB,CAAA;CAC/B,CAAA;AAED,2DAA2D;AAC3D,MAAM,MAAM,iBAAiB,GAAG;IAC9B,oCAAoC;IACpC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,4BAA4B;IAC5B,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;CACrE,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,GAAG,CAAA;IACb,OAAO,CAAC,EAAE,GAAG,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACpC,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,SAAS,GAAG;IAC7C,cAAc,CAAC,EAAE,UAAU,EAAE,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAE3D,MAAM,MAAM,mBAAmB,GAAG;IAChC,cAAc,EAAE,OAAO,CAAA;IACvB,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC,eAAe,CAAC,EACZ,SAAS,CAAC,yBAAyB,GACnC,SAAS,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,GAC7C,WAAW,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAA;IACnD,IAAI,EAAE;QACJ,KAAK,EAAE;YACL,QAAQ,EAAE,MAAM,CAAA;YAChB,QAAQ,EAAE,MAAM,CAAA;SACjB,CAAA;QACD,MAAM,EAAE;YACN,KAAK,EAAE,MAAM,CAAA;SACd,CAAA;KACF,CAAA;IACD,MAAM,EAAE;QACN,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;IACD,MAAM,EAAE;QACN,QAAQ,EAAE,MAAM,CAAA;QAChB,MAAM,EAAE,MAAM,EAAE,CAAA;QAChB,WAAW,EAAE,MAAM,CAAA;QACnB,KAAK,EAAE,MAAM,CAAA;QACb,QAAQ,EAAE,MAAM,CAAA;QAChB,QAAQ,EAAE,MAAM,CAAA;KACjB,CAAA;CACF,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,+BAA+B,MAAM,EAAE,CAAA;AACrE,MAAM,MAAM,wBAAwB,GAClC,uDAAuD,MAAM,EAAE,CAAA;AACjE,MAAM,MAAM,oBAAoB,GAC9B,+CAA+C,MAAM,EAAE,CAAA;AAEzD,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,+BAA+B,CAAC,EAAE,mBAAmB,CAAA;IACrD,yCAAyC,CAAC,EAAE,qBAAqB,CAAA;IACjE,CAAC,GAAG,EAAE,eAAe,GAAG,MAAM,CAAA;IAC9B,CAAC,GAAG,EAAE,wBAAwB,GAAG;QAC/B,OAAO,EAAE,OAAO,CAAA;QAChB,OAAO,EAAE,MAAM,CAAA;KAChB,EAAE,CAAA;IACH,CAAC,GAAG,EAAE,oBAAoB,GAAG,MAAM,CAAA;CACpC,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,OAAO,EAAE;QACP,IAAI,EAAE,WAAW,CAAA;KAClB,CAAA;IACD,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,GAAG,GAAG;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,aAAa,EAAE,MAAM,CAAA;IACrB,YAAY,EAAE,oBAAoB,EAAE,CAAA;IACpC,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,EAAE,CAAA;CACf,CAAA;AAED,MAAM,MAAM,cAAc,GACtB,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GACrB,SAAS,CAAC,oBAAoB,GAC9B,SAAS,CAAC,oBAAoB,GAC9B,WAAW,CAAC,oBAAoB,CAAA;AAEpC,MAAM,MAAM,WAAW,GAAG,SAAS,CAAC,iBAAiB,CAAA;AAErD,MAAM,MAAM,QAAQ,GAAG,MAAM,CAC3B,MAAM,EACN,MAAM,CACJ,WAAW,CAAC,WAAW,EACvB,oBAAoB,GAAG;IACrB,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CACF,CACF,CAAA;AAED,MAAM,MAAM,IAAI,GAAG;IACjB,MAAM,CAAC,EAAE,GAAG,EAAE,CAAA;IACd,MAAM,EACF,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,GACnC,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,GACnC,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAA;IACzC,MAAM,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;IACnC,UAAU,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;IAC3C,SAAS,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;IACzC,cAAc,CAAC,EAAE,qBAAqB,CAAA;IACtC,SAAS,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;IAC3E,YAAY,CAAC,EAAE,SAAS,CAAC,gBAAgB,GAAG,WAAW,CAAC,gBAAgB,CAAA;IACxE,UAAU,CAAC,EAAE,QAAQ,CAAA;IACrB,aAAa,CAAC,EAAE,WAAW,CAAA;IAC3B,SAAS,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;IACzC,SAAS,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;IAC3E,aAAa,CAAC,EAAE,QAAQ,EAAE,CAAA;IAC1B,UAAU,CAAC,EAAE,SAAS,CAAC,yBAAyB,EAAE,CAAA;CACnD,CAAA"}