@redocly/openapi-core 1.34.4 → 2.0.0-next.1

package/lib/redocly/redocly-client-types.d.ts

@@ -1,8 +0,0 @@
-import type { Region } from '../config/types';
-export interface RegionalToken {
-    region: Region;
-    token: string;
-}
-export interface RegionalTokenWithValidity extends RegionalToken {
-    valid: boolean;
-}

package/lib/redocly/redocly-client-types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/redocly/registry-api-types.d.ts

@@ -1,29 +0,0 @@
-interface VersionParams {
-    organizationId: string;
-    name: string;
-    version: string;
-}
-export interface PrepareFileuploadParams extends VersionParams {
-    filesHash: string;
-    filename: string;
-    isUpsert?: boolean;
-}
-export interface PushApiParams extends VersionParams {
-    rootFilePath: string;
-    filePaths: string[];
-    branch?: string;
-    isUpsert?: boolean;
-    isPublic?: boolean;
-    batchId?: string;
-    batchSize?: number;
-}
-export interface PrepareFileuploadOKResponse {
-    filePath: string;
-    signedUploadUrl: string;
-}
-export interface NotFoundProblemResponse {
-    status: 404;
-    title: 'Not Found';
-    code: 'ORGANIZATION_NOT_FOUND' | 'API_VERSION_NOT_FOUND';
-}
-export {};

package/lib/redocly/registry-api-types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/redocly/registry-api.d.ts

@@ -1,17 +0,0 @@
-import type { PrepareFileuploadOKResponse, PrepareFileuploadParams, PushApiParams } from './registry-api-types';
-import type { AccessTokens, Region } from '../config/types';
-export declare class RegistryApi {
-    private accessTokens;
-    private region;
-    constructor(accessTokens: AccessTokens, region: Region);
-    get accessToken(): string | false | undefined;
-    getBaseUrl(): string;
-    setAccessTokens(accessTokens: AccessTokens): this;
-    private request;
-    authStatus(accessToken: string, verbose?: boolean): Promise<{
-        viewerId: string;
-        organizations: string[];
-    }>;
-    prepareFileUpload({ organizationId, name, version, filesHash, filename, isUpsert, }: PrepareFileuploadParams): Promise<PrepareFileuploadOKResponse>;
-    pushApi({ organizationId, name, version, rootFilePath, filePaths, branch, isUpsert, isPublic, batchId, batchSize, }: PushApiParams): Promise<void>;
-}

package/lib/redocly/registry-api.js

@@ -1,100 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RegistryApi = void 0;
-const utils_1 = require("../utils");
-const domains_1 = require("./domains");
-const version = require('../../package.json').version;
-class RegistryApi {
-    constructor(accessTokens, region) {
-        this.accessTokens = accessTokens;
-        this.region = region;
-    }
-    get accessToken() {
-        return (0, utils_1.isNotEmptyObject)(this.accessTokens) && this.accessTokens[this.region];
-    }
-    getBaseUrl() {
-        return `https://api.${(0, domains_1.getRedoclyDomain)()}/registry`;
-    }
-    setAccessTokens(accessTokens) {
-        this.accessTokens = accessTokens;
-        return this;
-    }
-    async request(path = '', options = {}) {
-        const currentCommand = typeof process !== 'undefined' ? process.env?.REDOCLY_CLI_COMMAND || '' : '';
-        const redoclyEnv = typeof process !== 'undefined' ? process.env?.REDOCLY_ENVIRONMENT || '' : '';
-        const headers = Object.assign({}, options.headers || {}, {
-            'x-redocly-cli-version': version,
-            'user-agent': `redocly-cli / ${version} ${currentCommand} ${redoclyEnv}`,
-        });
-        if (!headers.hasOwnProperty('authorization')) {
-            throw new Error('Unauthorized');
-        }
-        const requestOptions = {
-            ...options,
-            headers,
-            agent: (0, utils_1.getProxyAgent)(),
-        };
-        const response = await fetch(`${this.getBaseUrl()}${path}`, requestOptions);
-        if (response.status === 401) {
-            throw new Error('Unauthorized');
-        }
-        if (response.status === 404) {
-            const body = await response.json();
-            throw new Error(body.code);
-        }
-        return response;
-    }
-    async authStatus(accessToken, verbose = false) {
-        try {
-            const response = await this.request('', { headers: { authorization: accessToken } });
-            return await response.json();
-        }
-        catch (error) {
-            if (verbose) {
-                console.log(error);
-            }
-            throw error;
-        }
-    }
-    async prepareFileUpload({ organizationId, name, version, filesHash, filename, isUpsert, }) {
-        const response = await this.request(`/${organizationId}/${name}/${version}/prepare-file-upload`, {
-            method: 'POST',
-            headers: {
-                'content-type': 'application/json',
-                authorization: this.accessToken,
-            },
-            body: JSON.stringify({
-                filesHash,
-                filename,
-                isUpsert,
-            }),
-        });
-        if (response.ok) {
-            return response.json();
-        }
-        throw new Error('Could not prepare file upload');
-    }
-    async pushApi({ organizationId, name, version, rootFilePath, filePaths, branch, isUpsert, isPublic, batchId, batchSize, }) {
-        const response = await this.request(`/${organizationId}/${name}/${version}`, {
-            method: 'PUT',
-            headers: {
-                'content-type': 'application/json',
-                authorization: this.accessToken,
-            },
-            body: JSON.stringify({
-                rootFilePath,
-                filePaths,
-                branch,
-                isUpsert,
-                isPublic,
-                batchId,
-                batchSize,
-            }),
-        });
-        if (response.ok) {
-            return;
-        }
-        throw new Error('Could not push api');
-    }
-}
-exports.RegistryApi = RegistryApi;

package/src/__tests__/__snapshots__/bundle.test.ts.snap

@@ -1,461 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`bundle should add to meta ref from redocly registry 1`] = `
-fileDependencies: {}
-rootType:
-  properties:
-    openapi: null
-    info:
-      properties:
-        title:
-          type: string
-        version:
-          type: string
-        description:
-          type: string
-        termsOfService:
-          type: string
-        contact:
-          properties:
-            name:
-              type: string
-            url:
-              type: string
-            email:
-              type: string
-          extensionsPrefix: x-
-          name: Contact
-        license:
-          properties:
-            name:
-              type: string
-            url:
-              type: string
-          required:
-            - name
-          extensionsPrefix: x-
-          name: License
-        x-logo:
-          properties:
-            url:
-              type: string
-            altText:
-              type: string
-            backgroundColor:
-              type: string
-            href:
-              type: string
-          name: Logo
-      required:
-        - title
-        - version
-      extensionsPrefix: x-
-      name: Info
-    servers:
-      name: ServerList
-      properties: {}
-      items:
-        properties:
-          url:
-            type: string
-          description:
-            type: string
-          variables:
-            name: ServerVariablesMap
-            properties: {}
-        required:
-          - url
-        extensionsPrefix: x-
-        name: Server
-    security:
-      name: SecurityRequirementList
-      properties: {}
-      items:
-        properties: {}
-        additionalProperties:
-          type: array
-          items:
-            type: string
-        name: SecurityRequirement
-    tags:
-      name: TagList
-      properties: {}
-      items:
-        properties:
-          name:
-            type: string
-          description:
-            type: string
-          externalDocs:
-            properties:
-              description:
-                type: string
-              url:
-                type: string
-            required:
-              - url
-            extensionsPrefix: x-
-            name: ExternalDocs
-          x-traitTag:
-            type: boolean
-          x-displayName:
-            type: string
-        required:
-          - name
-        extensionsPrefix: x-
-        name: Tag
-    externalDocs:
-      properties:
-        description:
-          type: string
-        url:
-          type: string
-      required:
-        - url
-      extensionsPrefix: x-
-      name: ExternalDocs
-    paths:
-      properties: {}
-      name: Paths
-    components:
-      properties:
-        parameters:
-          name: NamedParameters
-          properties: {}
-        schemas:
-          name: NamedSchemas
-          properties: {}
-        responses:
-          name: NamedResponses
-          properties: {}
-        examples:
-          name: NamedExamples
-          properties: {}
-        requestBodies:
-          name: NamedRequestBodies
-          properties: {}
-        headers:
-          name: NamedHeaders
-          properties: {}
-        securitySchemes:
-          name: NamedSecuritySchemes
-          properties: {}
-        links:
-          name: NamedLinks
-          properties: {}
-        callbacks:
-          name: NamedCallbacks
-          properties: {}
-      extensionsPrefix: x-
-      name: Components
-    x-webhooks:
-      properties: {}
-      name: WebhooksMap
-    x-tagGroups:
-      name: TagGroups
-      properties: {}
-      items:
-        properties:
-          name:
-            type: string
-          tags:
-            type: array
-            items:
-              type: string
-        extensionsPrefix: x-
-        name: TagGroup
-    x-ignoredHeaderParameters:
-      type: array
-      items:
-        type: string
-  required:
-    - openapi
-    - paths
-    - info
-  extensionsPrefix: x-
-  name: Root
-refTypes: {}
-visitorsData:
-  registry-dependencies:
-    links:
-      - https://api.redocly.com/registry/params
-
-`;
-
-exports[`bundle should bundle external refs 1`] = `
-openapi: 3.0.0
-paths:
-  /pet:
-    parameters:
-      - $ref: '#/components/parameters/path-param'
-    put:
-      parameters:
-        - $ref: '#/components/parameters/param-a'
-        - $ref: '#/components/parameters/param-b'
-        - name: test
-    get:
-      parameters:
-        - $ref: '#/components/parameters/param-a'
-        - $ref: '#/components/parameters/param-c'
-    post:
-      parameters:
-        - $ref: '#/paths/~1pet/put/parameters/2'
-components:
-  parameters:
-    param-a:
-      name: param_a
-      schema:
-        $ref: '#/components/schemas/schema-a'
-      examples:
-        first:
-          $ref: '#/components/examples/param-a-first'
-        second:
-          $ref: '#/components/examples/second'
-    path-param:
-      name: path_param
-      examples:
-        first:
-          $ref: '#/components/examples/first'
-    param-c:
-      name: param_c
-    param-b:
-      name: param_b
-  examples:
-    first:
-      value: b1
-    param-a-first:
-      value: a1
-    second:
-      value: a2
-  schemas:
-    schema-a:
-      type: string
-
-`;
-
-exports[`bundle should bundle external refs and warn for conflicting names 1`] = `
-openapi: 3.0.0
-paths:
-  /pet:
-    parameters:
-      - $ref: '#/components/parameters/path-param'
-    put:
-      parameters:
-        - $ref: '#/components/parameters/param-b'
-        - $ref: '#/components/parameters/param-b-2'
-    get:
-      parameters:
-        - $ref: '#/components/parameters/param-a'
-        - $ref: '#/components/parameters/param-c'
-components:
-  parameters:
-    param-a:
-      name: test
-    param-b:
-      name: param_b_alt
-    path-param:
-      name: path_param
-    param-c:
-      name: param_c
-    param-b-2:
-      name: param_b
-
-`;
-
-exports[`bundle should bundle schemas with properties named $ref and externalValues correctly 1`] = `
-openapi: 3.1.0
-info: {}
-paths:
-  /example:
-    get:
-      summary: Get Example
-      description: This endpoint returns an example response.
-      responses:
-        '200':
-          description: Successful response
-          content:
-            application/json:
-              schema:
-                type: object
-                properties:
-                  externalValue:
-                    type: string
-                  $ref:
-                    type: string
-components: {}
-
-`;
-
-exports[`bundle should dereferenced correctly when used with dereference 1`] = `
-openapi: 3.0.0
-paths:
-  /pet:
-    get:
-      operationId: get
-      parameters:
-        - name: shared-a
-        - name: get_b
-    post:
-      operationId: post
-      parameters:
-        - name: shared-a
-components:
-  parameters:
-    shared_a:
-      name: shared-a
-
-`;
-
-exports[`bundle should not bundle url refs if used with keepUrlRefs 1`] = `
-openapi: 3.0.0
-paths:
-  /pet:
-    parameters:
-      - $ref: '#/components/parameters/path-param'
-    put:
-      parameters:
-        - $ref: https://someexternal.schema
-        - $ref: '#/components/parameters/param-b'
-        - name: test
-    get:
-      parameters:
-        - $ref: http://someexternal.schema
-        - $ref: '#/components/parameters/param-c'
-components:
-  parameters:
-    path-param:
-      name: path_param
-    param-c:
-      name: param_c
-    param-b:
-      name: param_b
-
-`;
-
-exports[`bundle should not place referenced schema inline when component in question is not of type "schemas" 1`] = `
-openapi: 3.0.0
-paths:
-  /pet:
-    post:
-      requestBody:
-        content:
-          application/json:
-            schema:
-              $ref: '#/components/schemas/requestBody'
-components:
-  schemas:
-    requestBody:
-      content:
-        application/json:
-          schema:
-            type: object
-            properties:
-              a:
-                type: string
-              b:
-                type: number
-
-`;
-
-exports[`bundle should place referenced schema inline when referenced schema name resolves to original schema name 1`] = `
-openapi: 3.1.0
-info:
-  title: My API
-  description: It ain't so wonderful, but at least it's mine.
-  version: '1.0'
-  contact:
-    email: me@theintenet.com
-    name: me
-paths:
-  /test:
-    get:
-      summary: test
-      responses:
-        '200':
-          description: test
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/vendor.schema'
-components:
-  schemas:
-    vendor:
-      $ref: '#/components/schemas/vendor.schema'
-    myvendor:
-      $ref: '#/components/schemas/vendor.schema'
-    simple:
-      type: string
-    A:
-      type: string
-    test:
-      $ref: '#/components/schemas/rename-2'
-    rename:
-      type: string
-    rename-2:
-      type: number
-    vendor.schema:
-      title: vendor
-      type: object
-      description: Vendors
-      properties:
-        key:
-          type: string
-          description: System-assigned key for the vendor.
-          readOnly: true
-        id:
-          type: string
-          description: >
-            Unique identifier of the vendor.
-
-            You must specify a unique vendor ID when creating a vendor unless
-            document sequencing is configured, in which case the ID is
-            auto-generated.
-        name:
-          type: string
-          description: Name of the vendor.
-        isOneTimeUse:
-          type: boolean
-          description: One-time use
-          default: false
-
-`;
-
-exports[`bundle should pull hosted schema 1`] = `
-openapi: 3.0.3
-info:
-  title: bugtest
-  version: '1.0'
-  description: Demo
-  license:
-    name: DEMO
-    url: https://demo.com
-servers:
-  - url: http://demo.com/api
-paths:
-  /customer:
-    summary: Customer scope
-    get:
-      summary: Get demo no refs
-      operationId: GetCustomer
-      description: Returns Demo No Refs
-      responses:
-        '200':
-          description: Demo No Refs
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Customer'
-components:
-  schemas:
-    Customer:
-      type: object
-      properties:
-        customerName:
-          type: string
-        accounts:
-          type: array
-          items:
-            $ref: '#/components/schemas/someexternal'
-    someexternal: External schema content
-
-`;