@forge/sql 3.0.4 → 3.0.5-experimental-3ed5db1

package/out/__test__/batch-api.test.d.ts

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

package/out/__test__/batch-api.test.d.ts.map

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

package/out/__test__/batch-api.test.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const batch_api_1 = require("../batch-api");
+const errors_1 = require("../errors");
+describe('SqlBatchOperation', () => {
+    let mockOnExecute;
+    beforeEach(() => {
+        mockOnExecute = jest.fn();
+    });
+    it('should initialize with an empty query list if no queries are provided', () => {
+        const batchOperation = new batch_api_1.SqlBatchOperation([], mockOnExecute);
+        expect(batchOperation['queries']).toEqual([]);
+    });
+    it('should add a single query to the batch', () => {
+        const batchOperation = new batch_api_1.SqlBatchOperation([], mockOnExecute);
+        batchOperation.add('SELECT * FROM users');
+        expect(batchOperation['queries']).toEqual([{ query: 'SELECT * FROM users', params: undefined }]);
+    });
+    it('should add multiple queries to the batch', () => {
+        const batchOperation = new batch_api_1.SqlBatchOperation([], mockOnExecute);
+        batchOperation.add(['SELECT * FROM users', 'SELECT * FROM orders']);
+        expect(batchOperation['queries']).toEqual([{ query: 'SELECT * FROM users' }, { query: 'SELECT * FROM orders' }]);
+    });
+    it('should add a query with parameters to the batch', () => {
+        const batchOperation = new batch_api_1.SqlBatchOperation([], mockOnExecute);
+        batchOperation.add('SELECT * FROM users WHERE id = ?', [1]);
+        expect(batchOperation['queries']).toEqual([{ query: 'SELECT * FROM users WHERE id = ?', params: [1] }]);
+    });
+    it('should throw an error when executing with no queries', async () => {
+        const batchOperation = new batch_api_1.SqlBatchOperation([], mockOnExecute);
+        await expect(batchOperation.execute()).rejects.toThrow(errors_1.ForgeSQLError);
+        await expect(batchOperation.execute()).rejects.toThrow('No queries to execute in batch');
+    });
+    it('should call onExecute with the correct queries when executing', async () => {
+        const batchOperation = new batch_api_1.SqlBatchOperation([{ query: 'INSERT INTO Users John test@email.com' }], mockOnExecute);
+        batchOperation.add('SELECT * FROM users');
+        const mockResponse = {
+            results: [],
+            success: false,
+            dbExecutionTime: 0,
+            metadata: {}
+        };
+        mockOnExecute.mockResolvedValueOnce(mockResponse);
+        const response = await batchOperation.execute();
+        expect(mockOnExecute).toHaveBeenCalledWith([
+            { query: 'INSERT INTO Users John test@email.com' },
+            { query: 'SELECT * FROM users', params: undefined }
+        ]);
+        expect(response).toBe(mockResponse);
+    });
+});

package/out/__test__/sql.test.js

@@ -4,6 +4,7 @@ const api_1 = require("@forge/api");
 const sql_1 = require("../sql");
 const sql_statement_1 = require("../sql-statement");
 const errors_1 = require("../errors");
+const batch_api_1 = require("../batch-api");
 jest.mock('@forge/api');
 describe('SqlClient', () => {
     let sqlClient;
@@ -23,10 +24,10 @@ describe('SqlClient', () => {
     describe('storageApi', () => {
         it('should send a request and return the response body', async () => {
             mockFetchExecute([]);
-            const result = await sqlClient['storageApi']('SELECT * FROM test', [], undefined, sql_1.SQL_API_ENDPOINTS.EXECUTE);
+            const result = await sqlClient['storageApi']({ query: 'SELECT * FROM test', params: [], method: undefined }, sql_1.SQL_API_ENDPOINTS.EXECUTE);
             expect(mockFetch).toHaveBeenCalledWith('/api/v1/execute', {
                 method: 'POST',
-                body: JSON.stringify({ query: 'SELECT * FROM test', params: [], method: 'all' }),
+                body: JSON.stringify({ query: 'SELECT * FROM test', params: [] }),
                 redirect: 'follow',
                 headers: { 'Content-Type': 'application/json' }
             });
@@ -35,7 +36,7 @@ describe('SqlClient', () => {
         it('should send a request with parameters and method', async () => {
             mockFetchExecute([]);
             const params = [1];
-            const result = await sqlClient['storageApi']('SELECT * FROM test WHERE id = ?', params, 'one', sql_1.SQL_API_ENDPOINTS.EXECUTE);
+            const result = await sqlClient['storageApi']({ query: 'SELECT * FROM test WHERE id = ?', params: params, method: 'one' }, sql_1.SQL_API_ENDPOINTS.EXECUTE);
             expect(mockFetch).toHaveBeenCalledWith('/api/v1/execute', {
                 method: 'POST',
                 body: JSON.stringify({ query: 'SELECT * FROM test WHERE id = ?', params, method: 'one' }),
@@ -46,7 +47,11 @@ describe('SqlClient', () => {
         });
         it('should send a request to DDL endpoint with method', async () => {
             mockFetchExecute([]);
-            const result = await sqlClient['storageApi']('CREATE TABLE test (id INT)', [], 'one', sql_1.SQL_API_ENDPOINTS.EXECUTE_DDL);
+            const result = await sqlClient['storageApi']({
+                query: 'CREATE TABLE test (id INT)',
+                params: [],
+                method: 'one'
+            }, sql_1.SQL_API_ENDPOINTS.EXECUTE_DDL);
             expect(mockFetch).toHaveBeenCalledWith('/api/v1/execute/ddl', {
                 method: 'POST',
                 body: JSON.stringify({ query: 'CREATE TABLE test (id INT)', params: [], method: 'one' }),
@@ -59,7 +64,7 @@ describe('SqlClient', () => {
             const responseText = 'Invalid JSON';
             const response = new Response(responseText, { status: 200 });
             mockFetch.mockResolvedValue(response);
-            await expect(sqlClient['storageApi']('SELECT * from strange;', [], 'one', sql_1.SQL_API_ENDPOINTS.EXECUTE)).rejects.toThrow(`Unexpected error. Response was not valid JSON: ${responseText}`);
+            await expect(sqlClient['storageApi']({ query: 'SELECT * from strange;', params: [], method: 'one' }, sql_1.SQL_API_ENDPOINTS.EXECUTE)).rejects.toThrow(`Unexpected error. Response was not valid JSON: ${responseText}`);
         });
         it('should throw ForgeSQLAPIError on API error', async () => {
             const forgeError = { code: 'INVALID_QUERY', message: 'Invalid SQL query' };
@@ -67,7 +72,7 @@ describe('SqlClient', () => {
                 status: 400
             });
             mockFetch.mockResolvedValue(mockResponse);
-            await expect(sqlClient['storageApi']('INVALID SQL QUERY', [], undefined, sql_1.SQL_API_ENDPOINTS.EXECUTE)).rejects.toThrow(new errors_1.ForgeSQLAPIError({ status: mockResponse.status, statusText: mockResponse.statusText }, forgeError));
+            await expect(sqlClient['storageApi']({ query: 'INVALID SQL QUERY', params: [], method: undefined }, sql_1.SQL_API_ENDPOINTS.EXECUTE)).rejects.toThrow(new errors_1.ForgeSQLAPIError({ status: mockResponse.status, statusText: mockResponse.statusText }, forgeError));
         });
     });
     describe('sendRequest', () => {
@@ -170,4 +175,11 @@ describe('SqlClient', () => {
             await expect(sqlClient.executeDDL('INVALID SQL QUERY')).rejects.toThrow(new errors_1.ForgeSQLAPIError(mockResponse, forgeError));
         });
     });
+    describe('batch', () => {
+        it('should create a SqlBatchOperation instance', () => {
+            const mockQuery = { query: 'SELECT * FROM test' };
+            const batch = sqlClient.batch([mockQuery]);
+            expect(batch).toBeInstanceOf(batch_api_1.SqlBatchOperation);
+        });
+    });
 });

package/out/batch-api.d.ts

@@ -0,0 +1,19 @@
+import { SqlParameters } from './sql-statement';
+import { BatchOperationResponse } from './utils/types';
+export interface BatchQueryBody {
+    statements: BatchOperation[];
+}
+export interface BatchOperation {
+    query: string;
+    params?: SqlParameters;
+}
+export declare class SqlBatchOperation<BatchQueryResults extends any[]> {
+    protected queries: BatchOperation[];
+    private readonly onExecute;
+    constructor(queries: BatchOperation[], onExecute: (queries: BatchOperation[]) => Promise<BatchOperationResponse<BatchQueryResults>>);
+    add(query: string, params?: SqlParameters): this;
+    add(queries: string[]): this;
+    execute(): Promise<BatchOperationResponse<BatchQueryResults>>;
+}
+export { BatchOperationResponse };
+//# sourceMappingURL=batch-api.d.ts.map

package/out/batch-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"batch-api.d.ts","sourceRoot":"","sources":["../src/batch-api.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC;AAEvD,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,cAAc,EAAE,CAAC;CAC9B;AACD,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB;AAED,qBAAa,iBAAiB,CAAC,iBAAiB,SAAS,GAAG,EAAE;IAE1D,SAAS,CAAC,OAAO,EAAE,cAAc,EAAE;IACnC,OAAO,CAAC,QAAQ,CAAC,SAAS;gBADhB,OAAO,EAAE,cAAc,EAAE,EAClB,SAAS,EAAE,CAAC,OAAO,EAAE,cAAc,EAAE,KAAK,OAAO,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;IAO/G,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa,GAAG,IAAI;IAChD,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI;IAYtB,OAAO,IAAI,OAAO,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;CAOpE;AACD,OAAO,EAAE,sBAAsB,EAAE,CAAC"}

package/out/batch-api.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SqlBatchOperation = void 0;
+const errors_1 = require("./errors");
+class SqlBatchOperation {
+    queries;
+    onExecute;
+    constructor(queries, onExecute) {
+        this.queries = queries;
+        this.onExecute = onExecute;
+        this.queries = queries;
+    }
+    add(query, params) {
+        if (query instanceof Array) {
+            this.queries.push(...query.map((queryOperation) => ({ query: queryOperation })));
+            return this;
+        }
+        this.queries.push({ query, params });
+        return this;
+    }
+    async execute() {
+        if (this.queries.length === 0) {
+            throw new errors_1.ForgeSQLError('No queries to execute in batch');
+        }
+        return this.onExecute(this.queries);
+    }
+}
+exports.SqlBatchOperation = SqlBatchOperation;

package/out/sql.d.ts

@@ -1,8 +1,10 @@
 import { Result } from './utils/types';
 import { SqlStatement } from './sql-statement';
+import { BatchOperation, SqlBatchOperation } from './batch-api';
 export declare const SQL_API_ENDPOINTS: {
     readonly EXECUTE: "/api/v1/execute";
     readonly EXECUTE_DDL: "/api/v1/execute/ddl";
+    readonly EXECUTE_BATCH: "/api/v1/batch";
 };
 declare type SqlAPIEndPoints = (typeof SQL_API_ENDPOINTS)[keyof typeof SQL_API_ENDPOINTS];
 export declare class SqlClient {
@@ -13,6 +15,7 @@ export declare class SqlClient {
     executeRaw<DataType>(query: string): Promise<Result<DataType>>;
     _provision(): Promise<void>;
     executeDDL<DataType>(query: string): Promise<Result<DataType>>;
+    batch<BatchQueryResults extends any[]>(batchOperation: BatchOperation[]): SqlBatchOperation<BatchQueryResults>;
 }
 export declare const sql: SqlClient;
 export {};

package/out/sql.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sql.d.ts","sourceRoot":"","sources":["../src/sql.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACvC,OAAO,EAAgC,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAI7E,eAAO,MAAM,iBAAiB;;;CAGpB,CAAC;AAEX,aAAK,eAAe,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,OAAO,iBAAiB,CAAC,CAAC;AAElF,qBAAa,SAAS;YACN,WAAW;YAYX,UAAU;YAsBV,qBAAqB;IAYnC,OAAO,CAAC,QAAQ,EACd,KAAK,EAAE,MAAM,EACb,QAAQ,GAAE,eAA2C,GACpD,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAU3B,UAAU,CAAC,QAAQ,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAQ9D,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAY3B,UAAU,CAAC,QAAQ,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;CAGrE;AAED,eAAO,MAAM,GAAG,WAAkB,CAAC"}
+{"version":3,"file":"sql.d.ts","sourceRoot":"","sources":["../src/sql.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACvC,OAAO,EAAgC,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAG7E,OAAO,EAA0C,cAAc,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAExG,eAAO,MAAM,iBAAiB;;;;CAIpB,CAAC;AAEX,aAAK,eAAe,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,OAAO,iBAAiB,CAAC,CAAC;AAElF,qBAAa,SAAS;YACN,WAAW;YAYX,UAAU;YAoBV,qBAAqB;IAenC,OAAO,CAAC,QAAQ,EACd,KAAK,EAAE,MAAM,EACb,QAAQ,GAAE,eAA2C,GACpD,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAU3B,UAAU,CAAC,QAAQ,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAQ9D,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAY3B,UAAU,CAAC,QAAQ,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IASpE,KAAK,CAAC,iBAAiB,SAAS,GAAG,EAAE,EAAE,cAAc,EAAE,cAAc,EAAE,GAAG,iBAAiB,CAAC,iBAAiB,CAAC;CAQ/G;AAED,eAAO,MAAM,GAAG,WAAkB,CAAC"}

package/out/sql.js

@@ -5,9 +5,11 @@ const api_1 = require("@forge/api");
 const sql_statement_1 = require("./sql-statement");
 const error_handling_1 = require("./utils/error-handling");
 const errors_1 = require("./errors");
+const batch_api_1 = require("./batch-api");
 exports.SQL_API_ENDPOINTS = {
     EXECUTE: '/api/v1/execute',
-    EXECUTE_DDL: '/api/v1/execute/ddl'
+    EXECUTE_DDL: '/api/v1/execute/ddl',
+    EXECUTE_BATCH: '/api/v1/batch'
 };
 class SqlClient {
     async sendRequest(path, options) {
@@ -21,10 +23,10 @@ class SqlClient {
         });
         return response;
     }
-    async storageApi(query, params = [], method = 'all', endpoint = exports.SQL_API_ENDPOINTS.EXECUTE) {
+    async storageApi(body, endpoint = exports.SQL_API_ENDPOINTS.EXECUTE) {
         const response = await this.sendRequest(endpoint, {
             method: 'POST',
-            body: JSON.stringify({ query, params, method })
+            body: JSON.stringify(body)
         });
         await (0, error_handling_1.checkResponseError)(response);
         const responseText = await response.text();
@@ -37,7 +39,7 @@ class SqlClient {
     }
     async storageApiWithOptions(query, options = {}) {
         const { endpoint = exports.SQL_API_ENDPOINTS.EXECUTE, params = [], method = 'all' } = options;
-        return await this.storageApi(query, params, method, endpoint);
+        return await this.storageApi({ query, params, method }, endpoint);
     }
     prepare(query, endpoint = exports.SQL_API_ENDPOINTS.EXECUTE) {
         const remoteSqlApi = (query, params, method) => this.storageApiWithOptions(query, { endpoint, params, method });
@@ -52,6 +54,11 @@ class SqlClient {
     async executeDDL(query) {
         return await this.prepare(query, exports.SQL_API_ENDPOINTS.EXECUTE_DDL).execute();
     }
+    batch(batchOperation) {
+        return new batch_api_1.SqlBatchOperation(batchOperation, (queries) => {
+            return this.storageApi({ statements: queries }, exports.SQL_API_ENDPOINTS.EXECUTE_BATCH);
+        });
+    }
 }
 exports.SqlClient = SqlClient;
 exports.sql = new SqlClient();

package/out/utils/types.d.ts

@@ -8,6 +8,15 @@ export interface UpdateQueryResponse {
     serverStatus: number;
     warningStatus: number;
 }
+export declare type BatchResults<DataType extends any[]> = {
+    [K in keyof DataType]: Result<DataType[K]>;
+};
+export interface BatchOperationResponse<BatchQueryResults extends any[]> {
+    success: boolean;
+    dbExecutionTime: number;
+    results: BatchResults<BatchQueryResults>;
+    metadata: Object;
+}
 export interface Result<DataType = any> {
     rows: DataType extends UpdateQueryResponse ? UpdateQueryResponse : DataType[];
     metadata?: Record<string, any>;

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/utils/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,oBAAY,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,GAAG,QAAQ,CAAC,CAAC;AAGnE,MAAM,WAAW,mBAAmB;IAElC,YAAY,EAAE,MAAM,CAAC;IAErB,UAAU,EAAE,MAAM,CAAC;IAEnB,IAAI,EAAE,MAAM,CAAC;IAEb,QAAQ,EAAE,MAAM,CAAC;IAEjB,YAAY,EAAE,MAAM,CAAC;IAErB,aAAa,EAAE,MAAM,CAAC;CACvB;AAWD,MAAM,WAAW,MAAM,CAAC,QAAQ,GAAG,GAAG;IAKpC,IAAI,EAAE,QAAQ,SAAS,mBAAmB,GAAG,mBAAmB,GAAG,QAAQ,EAAE,CAAC;IAO9E,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAChC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/utils/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,oBAAY,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,GAAG,QAAQ,CAAC,CAAC;AAGnE,MAAM,WAAW,mBAAmB;IAElC,YAAY,EAAE,MAAM,CAAC;IAErB,UAAU,EAAE,MAAM,CAAC;IAEnB,IAAI,EAAE,MAAM,CAAC;IAEb,QAAQ,EAAE,MAAM,CAAC;IAEjB,YAAY,EAAE,MAAM,CAAC;IAErB,aAAa,EAAE,MAAM,CAAC;CACvB;AAKD,oBAAY,YAAY,CAAC,QAAQ,SAAS,GAAG,EAAE,IAAI;KAChD,CAAC,IAAI,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;CAC3C,CAAC;AAKF,MAAM,WAAW,sBAAsB,CAAC,iBAAiB,SAAS,GAAG,EAAE;IACrE,OAAO,EAAE,OAAO,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,OAAO,EAAE,YAAY,CAAC,iBAAiB,CAAC,CAAC;IACzC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAWD,MAAM,WAAW,MAAM,CAAC,QAAQ,GAAG,GAAG;IAKpC,IAAI,EAAE,QAAQ,SAAS,mBAAmB,GAAG,mBAAmB,GAAG,QAAQ,EAAE,CAAC;IAO9E,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAChC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/sql",
-  "version": "3.0.4",
+  "version": "3.0.5-experimental-3ed5db1",
   "description": "Forge SQL sdk",
   "author": "Atlassian",
   "license": "SEE LICENSE IN LICENSE.txt",
@@ -20,7 +20,7 @@
     "jest-when": "^3.6.0"
   },
   "dependencies": {
-    "@forge/api": "^6.1.0"
+    "@forge/api": "^6.1.1-experimental-3ed5db1"
   },
   "publishConfig": {
     "registry": "https://packages.atlassian.com/api/npm/npm-public/"