@forge/sql 0.0.1-experimental-9332276

package/README.md

@@ -0,0 +1,8 @@
+Library for Forge environment.
+
+Usage example:
+```typescript
+import sql from "@forge/sql";
+
+await sql.execute(`SELECT * FROM example`);
+```

package/out/__test__/fetch-wrapper.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=fetch-wrapper.test.d.ts.map

package/out/__test__/fetch-wrapper.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-wrapper.test.d.ts","sourceRoot":"","sources":["../../src/__test__/fetch-wrapper.test.ts"],"names":[],"mappings":""}

package/out/__test__/fetch-wrapper.test.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const node_fetch_1 = tslib_1.__importDefault(require("node-fetch"));
+const fetch_wrapper_1 = require("../utils/fetch-wrapper");
+jest.mock('node-fetch');
+const fetchMock = node_fetch_1.default;
+describe('v2', () => {
+    it('chooses the v2 fetch based on runtime', async () => {
+        const fetch = (0, fetch_wrapper_1.runtimeV2FetchWrapper)();
+        fetchMock.mockResolvedValueOnce({
+            headers: {
+                has: jest.isMockFunction
+            },
+            ok: true,
+            json: async () => ({
+                values: []
+            })
+        });
+        await fetch('asdf');
+        expect(fetchMock).toHaveBeenCalled();
+    });
+});

package/out/__test__/sql.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=sql.test.d.ts.map

package/out/__test__/sql.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sql.test.d.ts","sourceRoot":"","sources":["../../src/__test__/sql.test.ts"],"names":[],"mappings":""}

package/out/__test__/sql.test.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const node_fetch_1 = tslib_1.__importDefault(require("node-fetch"));
+const sql_1 = require("../sql");
+const reponse_handler_1 = require("../utils/reponse-handler");
+jest.mock('node-fetch');
+const fetchMock = node_fetch_1.default;
+describe('sql', () => {
+    it('should pass', async () => {
+        fetchMock.mockResolvedValueOnce({
+            headers: {
+                has: jest.isMockFunction
+            },
+            ok: true,
+            text: async () => JSON.stringify({
+                values: []
+            })
+        });
+        await sql_1.sql.execute('asdf');
+        expect(fetchMock).toHaveBeenCalled();
+    });
+});
+describe('SqlClient', () => {
+    function buildSqlClient() {
+        const fetch = jest.fn();
+        const client = new sql_1.SqlClient(fetch);
+        return { client, fetch };
+    }
+    it('handles success', async () => {
+        const { client, fetch } = buildSqlClient();
+        fetch.mockResolvedValueOnce({
+            ok: true,
+            text: async () => JSON.stringify({ response: 'asdfasdf' }),
+            status: 200
+        });
+        const result = await client.execute('SELECT * FROM example');
+        expect(result).toEqual('asdfasdf');
+        expect(fetch.mock.lastCall).toMatchSnapshot();
+    });
+    it('handles success when no value is returned', async () => {
+        const { client, fetch } = buildSqlClient();
+        fetch.mockResolvedValueOnce({ ok: true, text: async () => JSON.stringify({ response: null }), status: 200 });
+        const result = await client.execute(`INSERT INTO x SET y='z'`);
+        expect(result).toBeNull();
+        expect(fetch.mock.lastCall).toMatchSnapshot();
+    });
+    it('handles failure', async () => {
+        const { client, fetch } = buildSqlClient();
+        fetch.mockResolvedValueOnce({
+            ok: false,
+            text: async () => JSON.stringify({ error: { code: 'SQL_SYNTAX_ERROR', title: 'SQL syntax error' } }),
+            status: 400
+        });
+        await expect(client.execute('DELECT * from example')).rejects.toThrow(new reponse_handler_1.ApiError(400, 'SQL_SYNTAX_ERROR', 'SQL syntax error'));
+        expect(fetch.mock.lastCall).toMatchSnapshot();
+    });
+});

package/out/index.d.ts

@@ -0,0 +1,3 @@
+import { sql } from './sql';
+export default sql;
+//# sourceMappingURL=index.d.ts.map

package/out/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAC5B,eAAe,GAAG,CAAC"}

package/out/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const sql_1 = require("./sql");
+exports.default = sql_1.sql;

package/out/sql.d.ts

@@ -0,0 +1,10 @@
+import { RequestInit } from 'node-fetch';
+import { Result, Response } from './utils/types';
+export declare class SqlClient {
+    private client;
+    constructor(client: (path: string, options?: RequestInit) => Promise<Response>);
+    private buildRequest;
+    execute(query: string): Promise<Result>;
+}
+export declare const sql: SqlClient;
+//# sourceMappingURL=sql.d.ts.map

package/out/sql.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sql.d.ts","sourceRoot":"","sources":["../src/sql.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAGzC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAGjD,qBAAa,SAAS;IACR,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC;IAEtF,OAAO,CAAC,YAAY;IAUP,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAKrD;AAED,eAAO,MAAM,GAAG,WAAyC,CAAC"}

package/out/sql.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sql = exports.SqlClient = void 0;
+const fetch_wrapper_1 = require("./utils/fetch-wrapper");
+const reponse_handler_1 = require("./utils/reponse-handler");
+class SqlClient {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    buildRequest(requestBody) {
+        return {
+            method: 'POST',
+            body: JSON.stringify(requestBody),
+            headers: {
+                'Content-Type': 'application/json'
+            }
+        };
+    }
+    async execute(query) {
+        const response = await this.client('sql/execute', this.buildRequest({ query }));
+        return await (0, reponse_handler_1.getResponseBody)(response);
+    }
+}
+exports.SqlClient = SqlClient;
+exports.sql = new SqlClient((0, fetch_wrapper_1.runtimeV2FetchWrapper)());

package/out/utils/fetch-wrapper.d.ts

@@ -0,0 +1,3 @@
+import { FetchMethod } from '@forge/api';
+export declare function runtimeV2FetchWrapper(): FetchMethod;
+//# sourceMappingURL=fetch-wrapper.d.ts.map

package/out/utils/fetch-wrapper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-wrapper.d.ts","sourceRoot":"","sources":["../../src/utils/fetch-wrapper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAqB,MAAM,YAAY,CAAC;AAI5D,wBAAgB,qBAAqB,IAAI,WAAW,CAoBnD"}

package/out/utils/fetch-wrapper.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runtimeV2FetchWrapper = void 0;
+const tslib_1 = require("tslib");
+const api_1 = require("@forge/api");
+const node_fetch_1 = tslib_1.__importDefault(require("node-fetch"));
+const fetch_1 = require("@forge/api/out/api/fetch");
+function runtimeV2FetchWrapper() {
+    return async (path, init) => {
+        const url = `https://sql/${path}`;
+        init = (0, fetch_1.addMagicAgent)(init);
+        init.redirect = 'follow';
+        init.headers = {
+            ...init.headers,
+            redirect: 'follow',
+            'Content-Type': 'application/json'
+        };
+        const response = await (0, node_fetch_1.default)(url, init);
+        if (response.headers.has('forge-proxy-error')) {
+            throw new api_1.ProxyRequestError(response.status, response.headers.get('forge-proxy-error'));
+        }
+        return response;
+    };
+}
+exports.runtimeV2FetchWrapper = runtimeV2FetchWrapper;

package/out/utils/reponse-handler.d.ts

@@ -0,0 +1,9 @@
+import { Response } from './types';
+export declare class ApiError extends Error {
+    readonly status: number;
+    readonly code: string;
+    readonly data?: any;
+    constructor(status: number, code: string, message: string, data?: any);
+}
+export declare function getResponseBody(response: Response): Promise<any>;
+//# sourceMappingURL=reponse-handler.d.ts.map

package/out/utils/reponse-handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reponse-handler.d.ts","sourceRoot":"","sources":["../../src/utils/reponse-handler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC,qBAAa,QAAS,SAAQ,KAAK;IAE/B,QAAQ,CAAC,MAAM,EAAE,MAAM;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM;IAErB,QAAQ,CAAC,IAAI,CAAC;gBAHL,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACrB,OAAO,EAAE,MAAM,EACN,IAAI,CAAC,KAAK;CAItB;AAED,wBAAsB,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,CA0BtE"}

package/out/utils/reponse-handler.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getResponseBody = exports.ApiError = void 0;
+class ApiError extends Error {
+    status;
+    code;
+    data;
+    constructor(status, code, message, data) {
+        super(message);
+        this.status = status;
+        this.code = code;
+        this.data = data;
+    }
+}
+exports.ApiError = ApiError;
+async function getResponseBody(response) {
+    const responseText = await response.text();
+    if (!response.ok) {
+        try {
+            const parsedError = JSON.parse(responseText);
+            throw new ApiError(response.status, parsedError?.error?.code, parsedError?.error?.title, parsedError?.error?.data);
+        }
+        catch (e) {
+            if (!(e instanceof ApiError)) {
+                throw new ApiError(response.status, 'UNKNOWN_ERROR', `${responseText}`);
+            }
+            else {
+                throw e;
+            }
+        }
+    }
+    try {
+        return JSON.parse(responseText).response;
+    }
+    catch (error) {
+        throw new Error(`Unexpected error. Response was not valid JSON: ${responseText}`);
+    }
+}
+exports.getResponseBody = getResponseBody;

package/out/utils/types.d.ts

@@ -0,0 +1,4 @@
+import { Response as nodeFetchResponse } from 'node-fetch';
+export declare type Response = Pick<nodeFetchResponse, 'text' | 'ok' | 'status'>;
+export declare type Result = any;
+//# sourceMappingURL=types.d.ts.map

package/out/utils/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/utils/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,IAAI,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC3D,oBAAY,QAAQ,GAAG,IAAI,CAAC,iBAAiB,EAAE,MAAM,GAAG,IAAI,GAAG,QAAQ,CAAC,CAAC;AAEzE,oBAAY,MAAM,GAAG,GAAG,CAAC"}

package/out/utils/types.js

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

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@forge/sql",
+  "version": "0.0.1-experimental-9332276",
+  "description": "Forge SQL package",
+  "author": "Atlassian",
+  "license": "UNLICENSED",
+  "main": "out/index.js",
+  "types": "out/index.d.ts",
+  "files": [
+    "out"
+  ],
+  "scripts": {
+    "build": "yarn run clean && yarn run compile",
+    "clean": "rm -rf ./out && rm -f tsconfig.tsbuildinfo",
+    "compile": "tsc -b -v"
+  },
+  "devDependencies": {
+    "@types/node": "14.18.63",
+    "@types/node-fetch": "^2.6.11",
+    "expect-type": "^0.17.3",
+    "node-fetch": "2.7.0"
+  },
+  "dependencies": {
+    "@forge/api": "^3.9.0"
+  }
+}