@mintlify/scraping 4.0.155 → 4.0.157

package/__test__/getAsyncApiDefinition.test.ts

@@ -0,0 +1,155 @@
+import { AsyncAPISchema } from '@mintlify/common/asyncapi';
+import fs from 'fs/promises';
+import yaml from 'js-yaml';
+import { describe, it, expect, beforeEach, vi } from 'vitest';
+
+import { getAsyncApiDefinition } from '../src/asyncapi/getAsyncApiDefinition.js';
+
+vi.mock('fs/promises');
+vi.mock('node-fetch');
+
+const mockAsyncApiDoc: AsyncAPISchema = {
+  asyncapi: '3.0.0',
+  info: {
+    title: 'Test API',
+    version: '1.0.0',
+  },
+  channels: {},
+  components: {},
+};
+
+describe('getAsyncApiDefinition', () => {
+  beforeEach(() => {
+    vi.resetAllMocks();
+  });
+
+  it('should load AsyncAPI doc from a local file path', async () => {
+    const mockYaml = yaml.dump(mockAsyncApiDoc);
+    vi.mocked(fs.readFile).mockResolvedValue(mockYaml);
+
+    const result = await getAsyncApiDefinition('test.yaml');
+
+    expect(fs.readFile).toHaveBeenCalledWith(expect.stringContaining('test.yaml'), 'utf-8');
+    expect(result).toEqual({ document: mockAsyncApiDoc, isUrl: false });
+  });
+
+  it('should accept AsyncAPI document directly', async () => {
+    const result = await getAsyncApiDefinition(mockAsyncApiDoc);
+    expect(result).toEqual({ document: mockAsyncApiDoc, isUrl: false });
+  });
+
+  it('should fetch yaml AsyncAPI doc from URL', async () => {
+    const mockYaml = yaml.dump(mockAsyncApiDoc);
+    global.fetch = vi.fn().mockResolvedValue({
+      ok: true,
+      text: () => Promise.resolve(mockYaml),
+    });
+
+    const url = new URL('https://example.com/asyncapi.yaml');
+    const result = await getAsyncApiDefinition(url);
+
+    expect(fetch).toHaveBeenCalledWith(url);
+    expect(result).toEqual({ document: mockAsyncApiDoc, isUrl: true });
+  });
+
+  it('should fetch and parse valid JSON AsyncAPI doc from URL', async () => {
+    const mockJson = JSON.stringify(mockAsyncApiDoc);
+    global.fetch = vi.fn().mockResolvedValue({
+      ok: true,
+      status: 200,
+      text: () => Promise.resolve(mockJson),
+    });
+
+    const url = new URL('https://example.com/asyncapi.yaml');
+    const result = await getAsyncApiDefinition(url);
+
+    expect(fetch).toHaveBeenCalledWith(url);
+    expect(result).toEqual({ document: mockAsyncApiDoc, isUrl: true });
+  });
+
+  it('should fetch AsyncAPI doc from URL string', async () => {
+    const mockYaml = yaml.dump(mockAsyncApiDoc);
+    global.fetch = vi.fn().mockResolvedValue({
+      ok: true,
+      status: 200,
+      text: () => Promise.resolve(mockYaml),
+    });
+
+    const urlString = 'https://example.com/asyncapi.yaml';
+    const result = await getAsyncApiDefinition(urlString);
+
+    expect(fetch).toHaveBeenCalledWith(new URL(urlString));
+    expect(result).toEqual({ document: mockAsyncApiDoc, isUrl: true });
+  });
+
+  it('should throw error when local file read fails', async () => {
+    vi.mocked(fs.readFile).mockRejectedValue(new Error('File read error'));
+
+    await expect(getAsyncApiDefinition('test.yaml')).rejects.toThrow('File read error');
+  });
+
+  it('should throw error with URL and status code when fetch fails', async () => {
+    global.fetch = vi.fn().mockResolvedValue({
+      ok: false,
+      status: 404,
+      statusText: 'Not Found',
+    });
+
+    const urlString = 'https://mycoolwebsocketschema/asyncapi.doesnotexist';
+
+    await expect(getAsyncApiDefinition(urlString)).rejects.toThrow(
+      `${urlString} - failed to retrieve AsyncAPI file from source - : 404 Not Found`
+    );
+
+    expect(fetch).toHaveBeenCalledWith(new URL(urlString));
+  });
+
+  it('should throw error when HTTP URL is provided', async () => {
+    const httpUrl = new URL('http://example.com/asyncapi.yaml');
+    await expect(getAsyncApiDefinition(httpUrl)).rejects.toThrow(
+      'Only HTTPS URLs are supported. Please provide an HTTPS URL'
+    );
+  });
+
+  it('should throw error when HTTP URL string is provided', async () => {
+    const httpUrlString = 'http://example.com/asyncapi.yaml';
+    await expect(getAsyncApiDefinition(httpUrlString)).rejects.toThrow(
+      'Only HTTPS URLs are supported. Please provide an HTTPS URL'
+    );
+  });
+
+  it('should throw error when non-HTTPS URL string is provided', async () => {
+    const httpUrlString = 'ftp://example.com/asyncapi.yaml';
+    await expect(getAsyncApiDefinition(httpUrlString)).rejects.toThrow(
+      'Only HTTPS URLs are supported. Please provide an HTTPS URL'
+    );
+  });
+
+  it('should throw error when URL response is invalid YAML', async () => {
+    global.fetch = vi.fn().mockResolvedValue({
+      text: () => Promise.resolve('invalid: yaml: content'),
+    });
+
+    await expect(getAsyncApiDefinition('https://example.com/asyncapi.yaml')).rejects.toThrow();
+  });
+
+  it('should throw error when URL response is invalid JSON', async () => {
+    global.fetch = vi.fn().mockResolvedValue({
+      text: () => Promise.resolve('{"invalid": "yaml", "invalid": "content"}'),
+    });
+
+    await expect(getAsyncApiDefinition('https://example.com/asyncapi.json')).rejects.toThrow();
+  });
+
+  it('should throw error when local file contains invalid YAML', async () => {
+    vi.mocked(fs.readFile).mockResolvedValue('invalid: yaml: content');
+
+    await expect(getAsyncApiDefinition('test.yaml')).rejects.toThrow();
+  });
+
+  it('should throw error when local file contains invalid JSON', async () => {
+    vi.mocked(fs.readFile).mockResolvedValue('{"invalid": "yaml", "invalid": "content"}');
+
+    await expect(getAsyncApiDefinition('test.json')).rejects.toThrow();
+  });
+});

package/bin/asyncapi/getAsyncApiDefinition.d.ts

@@ -0,0 +1,5 @@
+import { AsyncAPISchema } from '@mintlify/common/asyncapi';
+export declare const getAsyncApiDefinition: (pathOrDocumentOrUrl: string | AsyncAPISchema | URL) => Promise<{
+    document: AsyncAPISchema;
+    isUrl: boolean;
+}>;

package/bin/asyncapi/getAsyncApiDefinition.js

@@ -0,0 +1,32 @@
+import * as fs from 'fs/promises';
+import yaml from 'js-yaml';
+import * as path from 'path';
+import { fetchAsyncApi } from '../utils/network.js';
+export const getAsyncApiDefinition = async (pathOrDocumentOrUrl) => {
+    if (typeof pathOrDocumentOrUrl === 'string') {
+        if (pathOrDocumentOrUrl.startsWith('http://')) {
+            // This is an invalid location either for a file or a URL
+            throw new Error('Only HTTPS URLs are supported. Please provide an HTTPS URL');
+        }
+        else {
+            try {
+                const url = new URL(pathOrDocumentOrUrl);
+                pathOrDocumentOrUrl = url;
+            }
+            catch {
+                const pathname = path.join(process.cwd(), pathOrDocumentOrUrl.toString());
+                const file = await fs.readFile(pathname, 'utf-8');
+                pathOrDocumentOrUrl = yaml.load(file);
+            }
+        }
+    }
+    const isUrl = pathOrDocumentOrUrl instanceof URL;
+    if (pathOrDocumentOrUrl instanceof URL) {
+        if (pathOrDocumentOrUrl.protocol !== 'https:') {
+            throw new Error('Only HTTPS URLs are supported. Please provide an HTTPS URL');
+        }
+        pathOrDocumentOrUrl = await fetchAsyncApi(pathOrDocumentOrUrl);
+    }
+    return { document: pathOrDocumentOrUrl, isUrl };
+};
+//# sourceMappingURL=getAsyncApiDefinition.js.map

package/bin/asyncapi/getAsyncApiDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getAsyncApiDefinition.js","sourceRoot":"","sources":["../../src/asyncapi/getAsyncApiDefinition.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,aAAa,CAAC;AAClC,OAAO,IAAI,MAAM,SAAS,CAAC;AAC3B,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAE7B,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,MAAM,CAAC,MAAM,qBAAqB,GAAG,KAAK,EACxC,mBAAkD,EACK,EAAE;IACzD,IAAI,OAAO,mBAAmB,KAAK,QAAQ,EAAE,CAAC;QAC5C,IAAI,mBAAmB,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YAC9C,yDAAyD;YACzD,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAChF,CAAC;aAAM,CAAC;YACN,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,mBAAmB,CAAC,CAAC;gBACzC,mBAAmB,GAAG,GAAG,CAAC;YAC5B,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,mBAAmB,CAAC,QAAQ,EAAE,CAAC,CAAC;gBAC1E,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAClD,mBAAmB,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAmB,CAAC;YAC1D,CAAC;QACH,CAAC;IACH,CAAC;IACD,MAAM,KAAK,GAAG,mBAAmB,YAAY,GAAG,CAAC;IACjD,IAAI,mBAAmB,YAAY,GAAG,EAAE,CAAC;QACvC,IAAI,mBAAmB,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC9C,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAChF,CAAC;QACD,mBAAmB,GAAG,MAAM,aAAa,CAAC,mBAAmB,CAAC,CAAC;IACjE,CAAC;IAED,OAAO,EAAE,QAAQ,EAAE,mBAAmB,EAAE,KAAK,EAAE,CAAC;AAClD,CAAC,CAAC"}