@quantcdn/quant-client 2.0.2 → 2.0.4

package/dist/{client.js → src/client.js}

@@ -99,6 +99,8 @@ class QuantClient {
              *   The response object.
              */
             ping: () => __awaiter(this, void 0, void 0, function* () {
+                console.log('ping');
+                console.log(this._project);
                 return yield this._project.get('ping');
             }),
             /**
@@ -138,7 +140,7 @@ class QuantClient {
                     headers['Quant-Skip-Purge'] = true;
                 }
                 if (typeof payload.findAttachments !== 'undefined') {
-                    body.find_attachments = true;
+                    body.find_attachments = payload.findAttachments;
                 }
                 return yield this._project.post('markup', body, headers);
             }),
@@ -153,14 +155,21 @@ class QuantClient {
              */
             file: (payload) => __awaiter(this, void 0, void 0, function* () {
                 const headers = {
-                    'Content-Type': 'multipart/form-data',
-                    'Quant-File-Url': payload.location
+                    'Quant-File-Url': payload.url
                 };
-                const formData = { data: payload.data };
                 if (typeof payload.skipPurge !== 'undefined') {
                     headers['Quant-Skip-Purge'] = 'true';
                 }
-                return yield this._project.post('file', {}, headers, formData);
+                const formData = {
+                    file: {
+                        value: payload.data,
+                        options: {
+                            filename: 'file',
+                            contentType: 'application/octet-stream'
+                        }
+                    }
+                };
+                return yield this._project.post('file', undefined, headers, formData);
             }),
             /**
              * Publish a revision.

package/dist/src/index.js

@@ -0,0 +1,42 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.types = void 0;
+// export { QuantClient } from './quant-client'
+__exportStar(require("./client"), exports);
+exports.types = __importStar(require("./types"));

package/dist/{types.d.ts → src/types.d.ts}

@@ -19,7 +19,7 @@ export interface MarkupPayload {
 }
 export interface FilePayload {
     data: Buffer;
-    location: string;
+    url: string;
     skipPurge?: boolean;
 }
 export interface PublishPayload {

package/dist/tests/client.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/client.test.js

@@ -0,0 +1,191 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const src_1 = require("../src");
+const buffer_1 = require("buffer");
+const chai_1 = require("chai");
+class TestClient {
+    constructor(baseUrl, headers) {
+        this.reject = false;
+        this.baseUrl = baseUrl;
+        this.headers = headers;
+        this.reject = false;
+    }
+    do(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield Promise.resolve('okay!');
+        });
+    }
+    get(path, qs, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield Promise.resolve({});
+        });
+    }
+    post(path, body, headers, formData, qs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield Promise.resolve({});
+        });
+    }
+    delete(path, body, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield Promise.resolve({});
+        });
+    }
+    patch(path, body, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield Promise.resolve({});
+        });
+    }
+}
+// Create a singleton mock client that all tests will use
+const mockClient = new TestClient('https://api.quantcdn.io/v1', {});
+// Create a constructor function that returns our singleton
+function MockClientConstructor(baseUrl, headers) {
+    return mockClient;
+}
+describe('file()', () => {
+    beforeEach(() => {
+        // Reset the mock client's post method before each test
+        mockClient.post = () => __awaiter(void 0, void 0, void 0, function* () { return ({}); });
+    });
+    it('should successfully upload a file', () => __awaiter(void 0, void 0, void 0, function* () {
+        const testData = buffer_1.Buffer.from('test file content');
+        const payload = {
+            data: testData,
+            url: '/test/file.txt'
+        };
+        mockClient.post = () => __awaiter(void 0, void 0, void 0, function* () { return ({ status: 'success' }); });
+        const client = new src_1.QuantClient({
+            organization: 'test-org',
+            project: 'test-project',
+            token: 'test-token'
+        }, MockClientConstructor);
+        const response = yield client.project.file(payload);
+        (0, chai_1.expect)(response.status).to.equal('success');
+    }));
+    it('should handle file upload with skipPurge option', () => __awaiter(void 0, void 0, void 0, function* () {
+        const testData = buffer_1.Buffer.from('test file content');
+        const payload = {
+            data: testData,
+            url: '/test/file.txt',
+            skipPurge: true
+        };
+        mockClient.post = (path_1, body_1, ...args_1) => __awaiter(void 0, [path_1, body_1, ...args_1], void 0, function* (path, body, headers = {}) {
+            (0, chai_1.expect)(headers['Quant-Skip-Purge']).to.equal('true');
+            return { status: 'success' };
+        });
+        const client = new src_1.QuantClient({
+            organization: 'test-org',
+            project: 'test-project',
+            token: 'test-token'
+        }, MockClientConstructor);
+        const response = yield client.project.file(payload);
+        (0, chai_1.expect)(response.status).to.equal('success');
+    }));
+    it('should handle API errors appropriately', () => __awaiter(void 0, void 0, void 0, function* () {
+        const testData = buffer_1.Buffer.from('test file content');
+        const payload = {
+            data: testData,
+            url: '/test/file.txt'
+        };
+        mockClient.post = () => __awaiter(void 0, void 0, void 0, function* () {
+            throw new Error('Invalid file format');
+        });
+        const client = new src_1.QuantClient({
+            organization: 'test-org',
+            project: 'test-project',
+            token: 'test-token'
+        }, MockClientConstructor);
+        try {
+            yield client.project.file(payload);
+            chai_1.expect.fail('Should have thrown an error');
+        }
+        catch (error) {
+            (0, chai_1.expect)(error.message).to.equal('Invalid file format');
+        }
+    }));
+    it('should handle large files correctly', () => __awaiter(void 0, void 0, void 0, function* () {
+        const testData = buffer_1.Buffer.alloc(1024 * 1024, 'x');
+        const payload = {
+            data: testData,
+            url: '/test/large-file.txt'
+        };
+        mockClient.post = () => __awaiter(void 0, void 0, void 0, function* () { return ({ status: 'success' }); });
+        const client = new src_1.QuantClient({
+            organization: 'test-org',
+            project: 'test-project',
+            token: 'test-token'
+        }, MockClientConstructor);
+        const response = yield client.project.file(payload);
+        (0, chai_1.expect)(response.status).to.equal('success');
+    }));
+});
+describe('markup', () => {
+    beforeEach(() => {
+        mockClient.post = () => __awaiter(void 0, void 0, void 0, function* () { return ({}); });
+    });
+    it('should respect findAttachments when false', () => __awaiter(void 0, void 0, void 0, function* () {
+        const testData = buffer_1.Buffer.from('test content');
+        const payload = {
+            data: testData,
+            url: '/test/markup',
+            published: true,
+            findAttachments: false
+        };
+        mockClient.post = (path, body) => __awaiter(void 0, void 0, void 0, function* () {
+            (0, chai_1.expect)(body.find_attachments).to.equal(false);
+            return { status: 'success' };
+        });
+        const client = new src_1.QuantClient({
+            organization: 'test-org',
+            project: 'test-project',
+            token: 'test-token'
+        }, MockClientConstructor);
+        yield client.project.markup(payload);
+    }));
+    it('should respect findAttachments when true', () => __awaiter(void 0, void 0, void 0, function* () {
+        const testData = buffer_1.Buffer.from('test content');
+        const payload = {
+            data: testData,
+            url: '/test/markup',
+            published: true,
+            findAttachments: true
+        };
+        mockClient.post = (path, body) => __awaiter(void 0, void 0, void 0, function* () {
+            (0, chai_1.expect)(body.find_attachments).to.equal(true);
+            return { status: 'success' };
+        });
+        const client = new src_1.QuantClient({
+            organization: 'test-org',
+            project: 'test-project',
+            token: 'test-token'
+        }, MockClientConstructor);
+        yield client.project.markup(payload);
+    }));
+    it('should default findAttachments to false when not specified', () => __awaiter(void 0, void 0, void 0, function* () {
+        const testData = buffer_1.Buffer.from('test content');
+        const payload = {
+            data: testData,
+            url: '/test/markup',
+            published: true
+        };
+        mockClient.post = (path, body) => __awaiter(void 0, void 0, void 0, function* () {
+            (0, chai_1.expect)(body.find_attachments).to.equal(false);
+            return { status: 'success' };
+        });
+        const client = new src_1.QuantClient({
+            organization: 'test-org',
+            project: 'test-project',
+            token: 'test-token'
+        }, MockClientConstructor);
+        yield client.project.markup(payload);
+    }));
+});

package/dist/tests/response.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/response.test.js

@@ -0,0 +1,133 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const response_1 = require("../src/response");
+const chai_1 = require("chai");
+class TestClient {
+    constructor(baseUrl, headers, testData) {
+        this.baseUrl = baseUrl;
+        this.headers = headers;
+        this.testData = testData || {
+            data: [1, 2, 3],
+            pagination: {
+                current_page: 1,
+                from: 1,
+                total_pages: 1,
+                per_page: 3,
+                to: 3,
+                total: 3
+            }
+        };
+    }
+    do(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield Promise.resolve(this.testData);
+        });
+    }
+    get(path, qs, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield Promise.resolve({});
+        });
+    }
+    post(path, body, headers, formData, qs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield Promise.resolve({});
+        });
+    }
+    delete(path, body, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield Promise.resolve({});
+        });
+    }
+    patch(path, body, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield Promise.resolve({});
+        });
+    }
+}
+describe('PaginatedResponse', () => {
+    const client = new TestClient('https://api.quantcdn.io/v1', {});
+    const options = {
+        url: 'https://api.quantcdn.io/v1/test',
+        method: 'GET'
+    };
+    it('should paginate through results', () => __awaiter(void 0, void 0, void 0, function* () {
+        var _a, e_1, _b, _c;
+        const response = new response_1.PaginatedResponse(client, options);
+        let results = [];
+        try {
+            for (var _d = true, response_2 = __asyncValues(response), response_2_1; response_2_1 = yield response_2.next(), _a = response_2_1.done, !_a; _d = true) {
+                _c = response_2_1.value;
+                _d = false;
+                const items = _c;
+                if (Array.isArray(items)) {
+                    results = results.concat(items);
+                }
+                else {
+                    results.push(items);
+                }
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (!_d && !_a && (_b = response_2.return)) yield _b.call(response_2);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        (0, chai_1.expect)(results).to.deep.equal([1, 2, 3]);
+    }));
+    it('should handle empty responses', () => __awaiter(void 0, void 0, void 0, function* () {
+        var _a, e_2, _b, _c;
+        const emptyData = {
+            data: [],
+            pagination: {
+                current_page: 1,
+                from: null,
+                total_pages: 1,
+                per_page: 10,
+                to: null,
+                total: 0
+            }
+        };
+        const emptyClient = new TestClient('https://api.quantcdn.io/v1', {}, emptyData);
+        const response = new response_1.PaginatedResponse(emptyClient, options);
+        let results = [];
+        try {
+            for (var _d = true, response_3 = __asyncValues(response), response_3_1; response_3_1 = yield response_3.next(), _a = response_3_1.done, !_a; _d = true) {
+                _c = response_3_1.value;
+                _d = false;
+                const items = _c;
+                if (Array.isArray(items)) {
+                    results = results.concat(items);
+                }
+                else {
+                    results.push(items);
+                }
+            }
+        }
+        catch (e_2_1) { e_2 = { error: e_2_1 }; }
+        finally {
+            try {
+                if (!_d && !_a && (_b = response_3.return)) yield _b.call(response_3);
+            }
+            finally { if (e_2) throw e_2.error; }
+        }
+        (0, chai_1.expect)(results).to.deep.equal([]);
+    }));
+});

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@quantcdn/quant-client",
-  "version": "2.0.2",
+  "version": "2.0.4",
   "description": "Client library for API connectivity",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
   "files": [
     "/dist"
   ],
   "scripts": {
     "build": "tsc",
-    "test": "jest",
+    "test": "mocha --require ts-node/register --require source-map-support/register --recursive 'tests/**/*.test.ts'",
     "lint:src": "eslint --ext .ts ./src"
   },
   "repository": {
@@ -39,6 +39,12 @@
     "eslint-plugin-promise": "^6.1.1",
     "jest": "^29.5.0",
     "ts-jest": "^29.1.0",
-    "typescript": "^5.2.2"
+    "typescript": "^5.2.2",
+    "chai": "^4.3.7",
+    "mocha": "^10.2.0",
+    "nock": "^13.3.1",
+    "ts-node": "^10.9.1",
+    "@types/mocha": "^10.0.1",
+    "@types/chai": "^4.3.5"
   }
 }

package/dist/index.js

@@ -1,20 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.types = void 0;
-// export { QuantClient } from './quant-client'
-__exportStar(require("./client"), exports);
-exports.types = require("./types");