@segment/public-api-sdk-typescript 1.0.1 → 1.0.2

package/tests/smoke.test.ts

@@ -0,0 +1,267 @@
+import http from 'http';
+import { SourcesApi } from '../api/apis';
+const TEST_TOKEN = '1ba60ccaae1c1a5230';
+
+// Keep track of the current server to close it before each test
+let server = http.createServer();
+
+async function makeServer(
+    response: any,
+    statusCode = 200
+): Promise<SourcesApi> {
+    return new Promise((resolve, reject) => {
+        server = http.createServer(function (req, res) {
+            expect(req as any).toMatchSnapshot({
+                client: expect.any(Object),
+                socket: expect.any(Object),
+            });
+            res.writeHead(statusCode, { 'Content-Type': 'application/json' });
+            res.end(JSON.stringify(response));
+        });
+
+        server.on('error', reject);
+
+        const port = 52338;
+        server.listen(port, () => {
+            const url = `http://localhost:${port}`;
+            const client = new SourcesApi(url);
+            client.accessToken = TEST_TOKEN;
+            resolve(client);
+        });
+    });
+}
+describe('Smoke tests', () => {
+    afterEach(() => {
+        if (server.listening) {
+            server.close();
+        }
+    });
+
+    it('sends correct request and parses response for create', async () => {
+        const mockedCreate = await makeServer({
+            data: {
+                source: {
+                    id: 'source-id',
+                    slug: 'my-test-source',
+                    name: 'my-test-source',
+                    workspaceId: 'workspace-id',
+                    enabled: true,
+                    writeKeys: ['write-key'],
+                    metadata: {
+                        id: 'IqDTy1TpoU',
+                        slug: 'javascript',
+                        name: 'Javascript',
+                        categories: ['Website'],
+                        description:
+                            'This is our most flexible and powerful tracking system, using analytics.js.  Track and analyze information about your visitors and customers, and every action that they take, in any of our 140 integrations, business intelligence tools, or directly with SQL tools.',
+                        logos: {
+                            default:
+                                'https://cdn.filepicker.io/api/file/aRgo4XJQZausZxD4gZQq',
+                            alt: 'https://cdn.filepicker.io/api/file/aRgo4XJQZausZxD4gZQq',
+                            mark: 'https://cdn.filepicker.io/api/file/kBpmEoSSaakidAvoFmzd',
+                        },
+                        options: [],
+                        isCloudEventSource: false,
+                    },
+                    settings: {},
+                    labels: [],
+                },
+            },
+        });
+
+        const resp = await mockedCreate.createSourceCurrent({
+            enabled: true,
+            metadataId: 'IqDTy1TpoU',
+            slug: 'my-test-source',
+        });
+
+        expect(resp).toMatchSnapshot({
+            response: {
+                headers: {
+                    date: expect.any(String),
+                },
+                request: expect.any(Object),
+            },
+        });
+    });
+
+    it('sends correct request and parses response for read', async () => {
+        const mockedRead = await makeServer({
+            data: {
+                source: {
+                    id: 'source-id',
+                    slug: 'my-test-source',
+                    name: 'my-test-source',
+                    workspaceId: 'workspace-id',
+                    enabled: true,
+                    writeKeys: ['write-key'],
+                    metadata: {
+                        id: 'IqDTy1TpoU',
+                        slug: 'javascript',
+                        name: 'Javascript',
+                        categories: ['Website'],
+                        description:
+                            'This is our most flexible and powerful tracking system, using analytics.js.  Track and analyze information about your visitors and customers, and every action that they take, in any of our 140 integrations, business intelligence tools, or directly with SQL tools.',
+                        logos: {
+                            default:
+                                'https://cdn.filepicker.io/api/file/aRgo4XJQZausZxD4gZQq',
+                            alt: 'https://cdn.filepicker.io/api/file/aRgo4XJQZausZxD4gZQq',
+                            mark: 'https://cdn.filepicker.io/api/file/kBpmEoSSaakidAvoFmzd',
+                        },
+                        options: [],
+                        isCloudEventSource: false,
+                    },
+                    settings: {},
+                    labels: [],
+                },
+            },
+        });
+
+        const resp = await mockedRead.getSourceCurrent('source-id');
+
+        expect(resp).toMatchSnapshot({
+            response: {
+                headers: {
+                    date: expect.any(String),
+                },
+                request: expect.any(Object),
+            },
+        });
+    });
+
+    it('sends correct request and parses response for list', async () => {
+        const mockedList = await makeServer({
+            data: {
+                sources: [
+                    {
+                        id: 'source-id',
+                        slug: 'my-test-source',
+                        name: 'my-test-source',
+                        workspaceId: 'workspace-id',
+                        enabled: true,
+                        writeKeys: ['write-key'],
+                        metadata: {
+                            id: 'IqDTy1TpoU',
+                            slug: 'javascript',
+                            name: 'Javascript',
+                            categories: ['Website'],
+                            description:
+                                'This is our most flexible and powerful tracking system, using analytics.js.  Track and analyze information about your visitors and customers, and every action that they take, in any of our 140 integrations, business intelligence tools, or directly with SQL tools.',
+                            logos: {
+                                default:
+                                    'https://cdn.filepicker.io/api/file/aRgo4XJQZausZxD4gZQq',
+                                alt: 'https://cdn.filepicker.io/api/file/aRgo4XJQZausZxD4gZQq',
+                                mark: 'https://cdn.filepicker.io/api/file/kBpmEoSSaakidAvoFmzd',
+                            },
+                            options: [],
+                            isCloudEventSource: false,
+                        },
+                        settings: {},
+                        labels: [],
+                    },
+                ],
+                pagination: {
+                    current: 'MA==',
+                    next: 'MQ==',
+                    totalEntries: 63,
+                },
+            },
+        });
+
+        const resp = await mockedList.listSourcesCurrent({ count: 1 });
+
+        expect(resp).toMatchSnapshot({
+            response: {
+                headers: {
+                    date: expect.any(String),
+                },
+                request: expect.any(Object),
+            },
+        });
+    });
+
+    it('sends correct request and parses response for update', async () => {
+        const mockedUpdate = await makeServer({
+            data: {
+                source: {
+                    id: 'source-id',
+                    slug: 'my-test-source',
+                    name: 'My updated source',
+                    workspaceId: 'workspace-id',
+                    enabled: false,
+                    writeKeys: ['write-key'],
+                    metadata: {
+                        id: 'IqDTy1TpoU',
+                        slug: 'javascript',
+                        name: 'Javascript',
+                        categories: ['Website'],
+                        description:
+                            'This is our most flexible and powerful tracking system, using analytics.js.  Track and analyze information about your visitors and customers, and every action that they take, in any of our 140 integrations, business intelligence tools, or directly with SQL tools.',
+                        logos: {
+                            default:
+                                'https://cdn.filepicker.io/api/file/aRgo4XJQZausZxD4gZQq',
+                            alt: 'https://cdn.filepicker.io/api/file/aRgo4XJQZausZxD4gZQq',
+                            mark: 'https://cdn.filepicker.io/api/file/kBpmEoSSaakidAvoFmzd',
+                        },
+                        options: [],
+                        isCloudEventSource: false,
+                    },
+                    settings: {},
+                    labels: [],
+                },
+            },
+        });
+
+        const resp = await mockedUpdate.updateSourceCurrent('source-id', {
+            name: 'My updated source',
+            enabled: false,
+        });
+
+        expect(resp).toMatchSnapshot({
+            response: {
+                headers: {
+                    date: expect.any(String),
+                },
+                request: expect.any(Object),
+            },
+        });
+    });
+
+    it('sends correct request and parses response for delete', async () => {
+        const mockedDelete = await makeServer({
+            data: {
+                status: 'SUCCESS',
+            },
+        });
+
+        const resp = await mockedDelete.deleteSourceCurrent('my-source');
+
+        expect(resp).toMatchSnapshot({
+            response: {
+                headers: {
+                    date: expect.any(String),
+                },
+                request: expect.any(Object),
+            },
+        });
+    });
+
+    it('parses errors correctly', async () => {
+        const mockedDelete = await makeServer(
+            {
+                errors: [
+                    {
+                        type: 'not-found',
+                        message: "Source with id '404' not found.",
+                        data: null,
+                    },
+                ],
+            },
+            404
+        );
+
+        const resp = mockedDelete.deleteSourceCurrent('404');
+
+        await expect(resp).rejects.toMatchSnapshot();
+    });
+});

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "noImplicitAny": false,
+        "suppressImplicitAnyIndexErrors": true,
+        "target": "ES5",
+        "allowSyntheticDefaultImports": true,
+        "esModuleInterop": true,
+        "strict": true,
+        "moduleResolution": "node",
+        "removeComments": true,
+        "sourceMap": true,
+        "noLib": false,
+        "declaration": true,
+        "lib": ["dom", "es6", "es5", "dom.iterable", "scripthost"],
+        "outDir": "dist",
+        "typeRoots": ["node_modules/@types"]
+    },
+    "exclude": ["dist", "node_modules"]
+}