@redocly/openapi-core 1.0.0-beta.100

package/src/__tests__/fixtures/refs/examples.yaml

@@ -0,0 +1,8 @@
+param-a:
+  first:
+    value: a1
+  second:
+    value: a2
+path-param:
+  first:
+    value: b1

package/src/__tests__/fixtures/refs/external-request-body.yaml

@@ -0,0 +1,13 @@
+openapi: 3.0.0
+paths:
+  /pet:
+    post:
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: ./requestBody.yaml
+components:
+  schemas:
+    requestBody:
+      $ref: ./requestBody.yaml

package/src/__tests__/fixtures/refs/externalref.yaml

@@ -0,0 +1,35 @@
+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: ./vendor.schema.yaml
+components:
+  schemas:
+    vendor:
+      $ref: ./vendor.schema.yaml
+    myvendor:
+      $ref: ./vendor.schema.yaml
+    simple:
+      $ref: ./simple.yaml
+    A:
+      $ref: ./definitions.yaml#/$defs/A
+    test:
+      $ref: ./rename.yaml
+    rename:
+      type: string
+    rename-2:
+      $ref: ./rename.yaml

package/src/__tests__/fixtures/refs/hosted.yaml

@@ -0,0 +1,35 @@
+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: "https://someexternal.schema"

package/src/__tests__/fixtures/refs/openapi-with-external-refs-conflicting-names.yaml

@@ -0,0 +1,21 @@
+openapi: 3.0.0
+paths:
+  /pet:
+    parameters:
+      - $ref: '#/components/parameters/path-param'
+    put:
+      parameters:
+        - $ref: '#/components/parameters/param-b'
+        - $ref: ./param-b.yaml
+    get:
+      parameters:
+        - $ref: '#/components/parameters/param-a'
+        - $ref: ./param-c.yaml
+components:
+  parameters:
+    param-a:
+      name: test
+    param-b:
+      name: param_b_alt
+    path-param:
+      name: path_param

package/src/__tests__/fixtures/refs/openapi-with-external-refs.yaml

@@ -0,0 +1,33 @@
+openapi: 3.0.0
+paths:
+  /pet:
+    parameters:
+      - $ref: '#/components/parameters/path-param'
+    put:
+      parameters:
+        - $ref: '#/components/parameters/param-a'
+        - $ref: ./param-b.yaml
+        - name: test
+    get:
+      parameters:
+        - $ref: '#/components/parameters/param-a'
+        - $ref: ./param-c.yaml
+    post:
+      parameters:
+        - $ref: '#/paths/~1pet/put/parameters/2'
+components:
+  parameters:
+    param-a:
+      name: param_a
+      schema:
+        $ref: ./schema-a.yaml
+      examples:
+        first:
+          $ref: ./examples.yaml#/param-a/first
+        second:
+          $ref: ./examples.yaml#/param-a/second
+    path-param:
+      name: path_param
+      examples:
+        first:
+          $ref: ./examples.yaml#/path-param/first

package/src/__tests__/fixtures/refs/openapi-with-url-refs.yaml

@@ -0,0 +1,18 @@
+openapi: 3.0.0
+paths:
+  /pet:
+    parameters:
+      - $ref: '#/components/parameters/path-param'
+    put:
+      parameters:
+        - $ref: 'https://someexternal.schema'
+        - $ref: ./param-b.yaml
+        - name: test
+    get:
+      parameters:
+        - $ref: 'http://someexternal.schema'
+        - $ref: ./param-c.yaml
+components:
+  parameters:
+    path-param:
+      name: path_param

package/src/__tests__/fixtures/refs/param-b.yaml

@@ -0,0 +1 @@
+name: param_b

package/src/__tests__/fixtures/refs/param-c.yaml

@@ -0,0 +1 @@
+name: param_c

package/src/__tests__/fixtures/refs/rename.yaml

@@ -0,0 +1 @@
+type: number

package/src/__tests__/fixtures/refs/requestBody.yaml

@@ -0,0 +1,9 @@
+content: 
+  application/json: 
+    schema: 
+      type: object
+      properties: 
+        a:
+          type: string
+        b:
+          type: number

package/src/__tests__/fixtures/refs/schema-a.yaml

@@ -0,0 +1 @@
+type: string

package/src/__tests__/fixtures/refs/simple.yaml

@@ -0,0 +1 @@
+type: string

package/src/__tests__/fixtures/refs/vendor.schema.yaml

@@ -0,0 +1,20 @@
+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

package/src/__tests__/fixtures/resolve/External.yaml

@@ -0,0 +1,10 @@
+type: object
+properties:
+  string:
+    type: string
+  number:
+    type: number
+  external:
+    $ref: ./External2.yaml
+  unknown:
+    type: string

package/src/__tests__/fixtures/resolve/External2.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  circularParent:
+    $ref: ./External.yaml#/properties

package/src/__tests__/fixtures/resolve/description.md

@@ -0,0 +1,3 @@
+# Hello World
+
+Lorem ipsum

package/src/__tests__/fixtures/resolve/externalInfo.yaml

@@ -0,0 +1,4 @@
+info:
+  contact: {}
+  license:
+    $ref: ./externalLicense.yaml

package/src/__tests__/fixtures/resolve/externalLicense.yaml

@@ -0,0 +1 @@
+name: MIT

package/src/__tests__/fixtures/resolve/openapi-with-back.yaml

@@ -0,0 +1,13 @@
+openapi: "3.0.1"
+info:
+  title: Open API
+  description: Open API
+  version: v0
+  contact:
+    email: some@body.com
+components:
+  schemas:
+    TypeA:
+      $ref: ./schemas/type-a.yaml#/
+    TypeB:
+      $ref: ./schemas/type-b.yaml#/

package/src/__tests__/fixtures/resolve/openapi-with-md-description.yaml

@@ -0,0 +1,5 @@
+openapi: 3.0.0
+info:
+  description:
+    $ref: ./description.md
+paths: {}

package/src/__tests__/fixtures/resolve/openapi.yaml

@@ -0,0 +1,28 @@
+openapi: 3.0.0
+paths:
+  /pet:
+    put:
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                local:
+                  $ref: '#/components/schemas/Local'
+                localTransitive:
+                  $ref: '#/components/schemas/Local/properties/string'
+                externalWithPointer:
+                  $ref: ./External.yaml#/properties/string
+                external:
+                  $ref: ./External.yaml
+components:
+  schemas:
+    Local:
+      properties:
+        number:
+          type: number
+        string:
+          type: string
+        localCircular:
+          $ref: '#/components/schemas/Local'

package/src/__tests__/fixtures/resolve/schemas/type-a.yaml

@@ -0,0 +1,10 @@
+allOf:
+  - type: object
+    required:
+      - name
+      - integration_type
+    properties:
+      integration_type:
+        $ref: "../openapi-with-back.yaml#/components/schemas/TypeB"
+      name:
+        type: string

package/src/__tests__/fixtures/resolve/schemas/type-b.yaml

@@ -0,0 +1,6 @@
+type: string
+enum:
+  - webhook
+  - api_key
+  - sftp
+  - netsuite

package/src/__tests__/fixtures/resolve/transitive/a.yaml

@@ -0,0 +1 @@
+type: string

package/src/__tests__/fixtures/resolve/transitive/components.yaml

@@ -0,0 +1,5 @@
+components:
+  schemas:
+    $ref: ./schemas.yaml#/schemas
+  shouldNotCrash:
+    $ref: ./schemas.yaml#invalid-hash-fragment

package/src/__tests__/fixtures/resolve/transitive/schemas.yaml

@@ -0,0 +1,3 @@
+schemas:
+  a:
+    $ref: a.yaml

package/src/__tests__/js-yaml.test.ts

@@ -0,0 +1,71 @@
+import { outdent } from 'outdent';
+import { parseYaml, stringifyYaml } from '../js-yaml';
+
+const yaml = `
+  emptyValue:
+  spaces in keys: spaces in keys
+  numberString: '0123456789'
+  number: 1000
+  decimal: 12.34
+  boolean: true
+  dateWithoutQuotes: 2020-01-01
+  dateWithQuotes: '2020-01-01'
+  array:
+    - 1
+    - 2
+  object:
+    key1: 1
+    key2: 2
+`;
+
+const yamlToDump = outdent`
+  date: '2022-01-21T11:29:56.694Z'
+  dateWithoutQuotes: 2020-01-01
+  dateWithQuotes: '2020-01-01'
+  dateImplicit: !!str 2020-01-01
+  string: test
+  stringWithQuotes: 'test'
+  stringWithDoubleQuotes: "test"
+`;
+
+const jsObject = {
+  emptyValue: null,
+  'spaces in keys': 'spaces in keys',
+  numberString: '0123456789',
+  number: 1000,
+  decimal: 12.34,
+  boolean: true,
+  dateWithoutQuotes: '2020-01-01',
+  dateWithQuotes: '2020-01-01',
+  array: [1, 2],
+  object: { key1: 1, key2: 2 },
+};
+
+describe('js-yaml', () => {
+  test('parseYaml', () => {
+    expect(parseYaml(yaml)).toEqual(jsObject);
+  });
+
+  test('should correctly dump date and string', () => {
+    expect(stringifyYaml(parseYaml(yamlToDump))).toMatchInlineSnapshot(
+    `
+    "date: '2022-01-21T11:29:56.694Z'
+    dateWithoutQuotes: '2020-01-01'
+    dateWithQuotes: '2020-01-01'
+    dateImplicit: '2020-01-01'
+    string: test
+    stringWithQuotes: test
+    stringWithDoubleQuotes: test
+    "
+    `);
+  });
+
+  test('parse and stringify', () => {
+    expect(parseYaml(stringifyYaml(jsObject))).toEqual(jsObject);
+  });
+
+  test('should throw an error for unsupported types', () => {
+    expect(() => stringifyYaml({ foo: () => {} }))
+      .toThrow('unacceptable kind of an object to dump [object Function]');
+  });
+});

package/src/__tests__/lint.test.ts

@@ -0,0 +1,232 @@
+import { outdent } from 'outdent';
+
+import { lintFromString, lintConfig, lintDocument } from '../lint';
+import { BaseResolver } from '../resolve';
+import { loadConfig } from '../config/load';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../__tests__/utils';
+import { detectOpenAPI } from '../oas-types';
+
+describe('lint', () => {
+  it('lintFromString should work', async () => {
+    const results = await lintFromString({
+      absoluteRef: '/test/spec.yaml',
+      source: outdent`
+      openapi: 3.0.0
+      info:
+        title: Test API
+        version: "1.0"
+        description: Test
+        license: Fail
+
+      servers:
+        - url: http://example.com
+      paths: {}
+    `,
+      config: await loadConfig(),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/info/license",
+              "reportOnKey": false,
+              "source": "/test/spec.yaml",
+            },
+          ],
+          "message": "Expected type \`License\` (object) but got \`string\`",
+          "ruleId": "spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
+      ]
+    `);
+  });
+
+  it('lintConfig should work', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+      apis: error string
+      lint:
+        plugins:
+          - './local-plugin.js'
+        extends:
+          - recommended
+          - local/all
+        rules:
+          operation-2xx-response: warn
+          no-invalid-media-type-examples: error
+          path-http-verbs-order: error
+          boolean-parameter-prefixes: off
+      features.openapi:
+        showConsole: true
+        layout:
+          scope: section
+        routingStrategy: browser
+        theme:
+          rightPanel:
+            backgroundColor: '#263238'
+          links:
+            color: '#6CC496'
+      `,
+      '',
+    );
+    const results = await lintConfig({ document });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/apis",
+              "reportOnKey": false,
+              "source": "",
+            },
+          ],
+          "message": "Expected type \`ConfigApis\` (object) but got \`string\`",
+          "ruleId": "spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/features.openapi/layout",
+              "reportOnKey": false,
+              "source": "",
+            },
+          ],
+          "message": "Expected type \`string\` but got \`object\`.",
+          "ruleId": "spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
+      ]
+    `);
+  });
+
+  it("'plugins' shouldn't be allowed in 'apis' -> 'lint' field", async () => {
+    const document = parseYamlToDocument(
+      outdent`
+      apis: 
+        lint: 
+          plugins: 
+            - './local-plugin.js'
+      lint:
+        plugins:
+          - './local-plugin.js'
+      `,
+      '',
+    );
+    const results = await lintConfig({ document });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/apis/lint/plugins",
+              "reportOnKey": true,
+              "source": "",
+            },
+          ],
+          "message": "Property \`plugins\` is not expected here.",
+          "ruleId": "spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
+      ]
+    `);
+  });
+
+  it("'const' can have any type", async () => {
+    const document = parseYamlToDocument(
+      outdent`
+      openapi: "3.1.0"
+      info:
+        version: 1.0.0
+        title: Swagger Petstore
+        description: Information about Petstore
+        license:
+          name: MIT
+          url: https://opensource.org/licenses/MIT
+      servers:
+        - url: http://petstore.swagger.io/v1
+      paths:
+        /pets:
+          get:
+            summary: List all pets
+            operationId: listPets
+            tags:
+              - pets
+            responses:
+              200:
+                description: An paged array of pets
+                content:
+                  application/json:
+                    schema:
+                      type: string
+                      const: ABC
+        `,
+      'foobar.yaml',
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ spec: 'error' }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+  });
+
+  it('detect OpenAPI should throw an error when version is not string', () => {
+    const testDocument = parseYamlToDocument(
+      outdent`
+      openapi: 3.0
+    `,
+      '',
+    );
+    expect(() => detectOpenAPI(testDocument.parsed)).toThrow(
+      `Invalid OpenAPI version: should be a string but got "number"`,
+    );
+  });
+
+  it("spec rule shouldn't throw an error for named callback", async () => {
+    const document = parseYamlToDocument(
+      outdent`
+      openapi: 3.1.0
+      info:
+        title: Callback test
+        version: 'alpha'
+      components:
+        callbacks:
+          resultCallback:
+            '{$url}':
+              post:
+                requestBody:
+                  description: Callback payload
+                  content:
+                    'application/json':
+                      schema:
+                        type: object
+                        properties:
+                          test:
+                            type: string
+                responses:
+                  '200':
+                    description: callback successfully processed
+    `,
+      'foobar.yaml',
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ spec: 'error' }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+  });
+});

package/src/__tests__/login.test.ts

@@ -0,0 +1,17 @@
+import { RedoclyClient } from '../redocly';
+
+describe.skip('login', () => {
+  it('should call login with setAccessTokens function', async () => {
+    const client = new RedoclyClient();
+    Object.defineProperty(client, 'registryApi', {
+      value: {
+        setAccessTokens: jest.fn(),
+        authStatus: jest.fn(() => true)
+      },
+      writable: true,
+      configurable: true
+    });
+    await client.login('token'); // TODO: bug with rewrite local config file
+    expect(client.registryApi.setAccessTokens).toHaveBeenCalled();
+  });
+});