@quantcdn/quant-client 2.0.13 → 3.0.0

package/dist/model/variable.js

@@ -0,0 +1,33 @@
+"use strict";
+/**
+ * QuantCloud API
+ * QuantCloud API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Variable = void 0;
+class Variable {
+    static getAttributeTypeMap() {
+        return Variable.attributeTypeMap;
+    }
+}
+exports.Variable = Variable;
+Variable.discriminator = undefined;
+Variable.attributeTypeMap = [
+    {
+        "name": "key",
+        "baseName": "key",
+        "type": "string"
+    },
+    {
+        "name": "value",
+        "baseName": "value",
+        "type": "string"
+    }
+];

package/dist/model/volume.d.ts

@@ -0,0 +1,32 @@
+/**
+ * QuantCloud API
+ * QuantCloud API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export declare class Volume {
+    'volumeId'?: string;
+    'volumeName'?: string;
+    'description'?: string;
+    'environmentEfsId'?: string;
+    'createdAt'?: string;
+    'rootDirectory'?: string;
+    'accessPointId'?: string;
+    'accessPointArn'?: string;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/dist/model/volume.js

@@ -0,0 +1,63 @@
+"use strict";
+/**
+ * QuantCloud API
+ * QuantCloud API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Volume = void 0;
+class Volume {
+    static getAttributeTypeMap() {
+        return Volume.attributeTypeMap;
+    }
+}
+exports.Volume = Volume;
+Volume.discriminator = undefined;
+Volume.attributeTypeMap = [
+    {
+        "name": "volumeId",
+        "baseName": "volumeId",
+        "type": "string"
+    },
+    {
+        "name": "volumeName",
+        "baseName": "volumeName",
+        "type": "string"
+    },
+    {
+        "name": "description",
+        "baseName": "description",
+        "type": "string"
+    },
+    {
+        "name": "environmentEfsId",
+        "baseName": "environmentEfsId",
+        "type": "string"
+    },
+    {
+        "name": "createdAt",
+        "baseName": "createdAt",
+        "type": "string"
+    },
+    {
+        "name": "rootDirectory",
+        "baseName": "rootDirectory",
+        "type": "string"
+    },
+    {
+        "name": "accessPointId",
+        "baseName": "accessPointId",
+        "type": "string"
+    },
+    {
+        "name": "accessPointArn",
+        "baseName": "accessPointArn",
+        "type": "string"
+    }
+];

package/package.json

@@ -1,50 +1,31 @@
 {
   "name": "@quantcdn/quant-client",
-  "version": "2.0.13",
-  "description": "Client library for API connectivity",
-  "main": "dist/src/index.js",
-  "types": "dist/src/index.d.ts",
+  "version": "3.0.0",
+  "description": "TypeScript client for Quant Cloud API",
+  "main": "dist/api.js",
+  "types": "dist/api.d.ts",
   "files": [
-    "/dist"
+    "dist/**/*"
   ],
   "scripts": {
     "build": "tsc",
-    "test": "mocha --require ts-node/register --require source-map-support/register --recursive 'tests/**/*.test.ts'",
-    "lint:src": "eslint --ext .ts ./src"
+    "prepare": "npm run build"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/quantcdn/quant-ts-client.git"
-  },
-  "author": "Stuart Rowlands <stuart.rowlands@quantcdn.io>",
-  "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/quantcdn/quant-client/issues"
+  "keywords": [
+    "quant",
+    "api",
+    "client",
+    "sdk"
+  ],
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "typescript": "^4.9.5",
+    "@types/node": "^18.14.0",
+    "@types/request": "^2.48.8"
   },
-  "homepage": "https://github.com/quantcdn/quant-client#readme",
   "dependencies": {
-    "@cypress/request": "3.0.9",
-    "mime-types": "^2.1.27"
-  },
-  "devDependencies": {
-    "@types/jest": "^29.5.2",
-    "@types/node": "^18.16.3",
-    "@typescript-eslint/eslint-plugin": "^6.4.1",
-    "@typescript-eslint/parser": "^6.4.1",
-    "@typescript-eslint/typescript-estree": "^6.4.1",
-    "eslint": "^8.48.0",
-    "eslint-config-standard-with-typescript": "^38.0.0",
-    "eslint-plugin-import": "^2.28.1",
-    "eslint-plugin-n": "^16.0.2",
-    "eslint-plugin-promise": "^6.1.1",
-    "jest": "^29.5.0",
-    "ts-jest": "^29.1.0",
-    "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"
+    "axios": "^1.3.4",
+    "request": "^2.88.2"
   }
-}
+} 

package/dist/src/client.d.ts

@@ -1,15 +0,0 @@
-/**
- * Quant API client.
- */
-import type * as types from './types';
-import type * as interfaces from './interfaces';
-export declare class QuantClient {
-    private readonly _project;
-    private readonly _organization;
-    private readonly _search;
-    constructor(config: types.Config, Client?: interfaces.ClientConstructor);
-    getClient(name: string): interfaces.Client;
-    project: interfaces.ProjectApi;
-    organization: interfaces.OrganizationApi;
-    search: interfaces.SearchApi;
-}

package/dist/src/client.js

@@ -1,380 +0,0 @@
-"use strict";
-/**
- * Quant API client.
- */
-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 });
-exports.QuantClient = void 0;
-const request = require("@cypress/request");
-const response_1 = require("./response");
-class HttpClient {
-    constructor(baseUrl, headers) {
-        this.baseUrl = baseUrl;
-        this.headers = headers;
-    }
-    do(options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield new Promise((resolve, reject) => {
-                request(options, (error, response, body) => {
-                    if (error !== null) {
-                        reject(error);
-                    }
-                    else {
-                        resolve(body);
-                    }
-                });
-            });
-        });
-    }
-    get(path, qs, headers) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const options = {
-                url: `${this.baseUrl}/${path}`,
-                method: 'GET',
-                headers: Object.assign(Object.assign({}, this.headers), headers),
-                json: true,
-                qs
-            };
-            const res = new response_1.PaginatedResponse(this, options);
-            return yield new Promise((resolve) => { resolve(res); });
-        });
-    }
-    post(path, body, headers, formData, qs) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const options = {
-                url: `${this.baseUrl}/${path}`,
-                method: 'POST',
-                headers: Object.assign(Object.assign({}, this.headers), headers),
-                json: true,
-                body,
-                formData,
-                qs
-            };
-            const res = new response_1.PaginatedResponse(this, options);
-            return yield new Promise((resolve) => { resolve(res); });
-        });
-    }
-    delete(path, body, headers) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const options = {
-                url: `${this.baseUrl}/${path}`,
-                method: 'DELETE',
-                headers: Object.assign(Object.assign({}, this.headers), headers),
-                json: true,
-                body
-            };
-            const res = new response_1.PaginatedResponse(this, options);
-            return yield new Promise((resolve) => { resolve(res); });
-        });
-    }
-    patch(path, body, headers) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const options = {
-                url: `${this.baseUrl}/${path}`,
-                method: 'PATCH',
-                headers: Object.assign(Object.assign({}, this.headers), headers),
-                json: true,
-                body
-            };
-            const res = new response_1.PaginatedResponse(this, options);
-            return yield new Promise((resolve) => { resolve(res); });
-        });
-    }
-}
-class QuantClient {
-    constructor(config, Client) {
-        var _a, _b;
-        this.project = {
-            /**
-             * Ping and ensure the API credentials are valid.
-             *
-             * @returns Promise<any>
-             *   The response object.
-             */
-            ping: () => __awaiter(this, void 0, void 0, function* () {
-                return yield this._project.get('ping');
-            }),
-            /**
-             * Fetch metadata for all objects stored in Quant.
-             *
-             * @returns Promise<any>
-             *   The repsonse object.
-             */
-            meta: (filters) => __awaiter(this, void 0, void 0, function* () {
-                const qs = {};
-                if ((filters === null || filters === void 0 ? void 0 : filters.sort_direction) != null) {
-                    qs.sort_direction = filters.sort_direction;
-                }
-                if ((filters === null || filters === void 0 ? void 0 : filters.sort_field) != null) {
-                    qs.sort_field = filters.sort_field;
-                }
-                if ((filters === null || filters === void 0 ? void 0 : filters.quant_type) != null) {
-                    qs.quant_type = filters.quant_type;
-                }
-                if ((filters === null || filters === void 0 ? void 0 : filters.page_size) != null) {
-                    // Ensure page_size is between 1 and 100
-                    qs.page_size = Math.min(Math.max(1, filters.page_size), 100);
-                }
-                return yield this._project.get('global-meta', qs);
-            }),
-            /**
-             * Send markup directly to the Quant API.
-             *
-             * @param markup MarkupPayload
-             *   The markup payload data.
-             *
-             * @returns Promise<any>
-             *   The repsonse object.
-             */
-            markup: (payload) => __awaiter(this, void 0, void 0, function* () {
-                const headers = {};
-                const body = {
-                    url: payload.url,
-                    content: payload.data.toString('utf-8'),
-                    published: payload.published,
-                    find_attachments: false
-                };
-                if (typeof payload.skipPurge !== 'undefined') {
-                    headers['Quant-Skip-Purge'] = 'true';
-                }
-                if (typeof payload.findAttachments !== 'undefined') {
-                    body.find_attachments = payload.findAttachments;
-                }
-                return yield this._project.post('markup', body, headers);
-            }),
-            /**
-             * Upload a file asset to Quant.
-             *
-             * @param payload FilePayload
-             *   The file payload data.
-             *
-             * @returns Promise<any>
-             *   The repsonse object.
-             */
-            file: (payload) => __awaiter(this, void 0, void 0, function* () {
-                const headers = {
-                    'Quant-File-Url': payload.url
-                };
-                if (typeof payload.skipPurge !== 'undefined') {
-                    headers['Quant-Skip-Purge'] = 'true';
-                }
-                if (typeof payload.headers !== 'undefined') {
-                    headers['Quant-File-Headers'] = payload.headers;
-                }
-                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.
-             *
-             * @param payload PublishPayload
-             *   The payload object
-             *
-             * @returns Promise<any>
-             *   The response object.
-             */
-            publish: (payload) => __awaiter(this, void 0, void 0, function* () {
-                const response = yield this._project.patch(`publish/${payload.revision}`, {}, {
-                    'Quant-Url': payload.location
-                });
-                return response.first();
-            }),
-            /**
-             * Unpublish the current published revision.
-             *
-             * @param payload PublishPayload
-             *   The payload object.
-             *
-             * @returns Promise<any>
-             *   The response object.
-             */
-            unpublish: (payload) => __awaiter(this, void 0, void 0, function* () {
-                const response = yield this._project.patch('unpublish', {}, {
-                    'Quant-Url': payload.location
-                });
-                return response.first();
-            }),
-            /**
-             * Redirect a URL.
-             *
-             * @param payload RedirectPayload
-             *   The redirect payload.
-             *
-             * @returns Promise<any>
-             *   The repsonse object.
-             */
-            redirect: (payload) => __awaiter(this, void 0, void 0, function* () {
-                const headers = {};
-                const body = {
-                    url: payload.url,
-                    redirect_url: payload.redirect_url,
-                    redirect_http_code: payload.redirect_http_code,
-                    published: payload.published
-                };
-                if (typeof payload.skipPurge !== 'undefined') {
-                    headers['Quant-Skip-Purge'] = 'true';
-                }
-                return yield this._project.post('redirect', body, headers);
-            }),
-            /**
-             * Proxy a URL to a different origin.
-             *
-             * @param payload ProxyPayload
-             *   The proxy API payload.
-             *
-             * @returns Promise<any>
-             *   The repsonse object.
-             */
-            proxy: (payload) => __awaiter(this, void 0, void 0, function* () {
-                return yield this._project.post('proxy', payload);
-            }),
-            /**
-             * Delete a URL from Quant.
-             *
-             * @param payload URLPayload
-             *   The API payload.
-             *
-             * @returns Promise<any>
-             *   The repsonse object.
-             */
-            delete: (payload) => __awaiter(this, void 0, void 0, function* () {
-                const response = yield this._project.delete('delete/all?force_delete=true', {}, {
-                    'Quant-Url': payload.url
-                });
-                return response.first();
-            }),
-            /**
-             * Get a revision from the API.
-             *
-             * @param payload URLPayload
-             *   The URL payload.
-             *
-             * @returns Promise<any>
-             *   The repsonse object.
-             */
-            revisions: (payload) => __awaiter(this, void 0, void 0, function* () {
-                return yield this._project.get('revisions/latest', {}, {
-                    'Quant-Url': payload.url
-                });
-            }),
-            /**
-             * Purge Varnish for a given URL pattern.
-             *
-             * @param payload URLPayload
-             *   The URL payload.
-             *
-             * @returns Promise<any>
-             *   The repsonse object.
-             */
-            purge: (payload) => __awaiter(this, void 0, void 0, function* () {
-                return yield this._project.post('purge', {}, {
-                    'Quant-Url': payload.url
-                });
-            })
-        };
-        this.organization = {
-            /**
-             * Fetch WAF logs from.
-             *
-             * @param payload types.WafLogsPayload
-             *   The API request payload.
-             *
-             * @returns Promise<any>
-             *   The response object.
-             */
-            wafLogs: (payload) => __awaiter(this, void 0, void 0, function* () {
-                const headers = { 'Quant-Project': payload.project };
-                return yield this._organization.get('waf/logs', {}, headers);
-            })
-        };
-        this.search = {
-            /**
-             * Index search data.
-             *
-             * @param payload types.SearchIndexPayload
-             *   The search index paylod.
-             *
-             * @returns Promise<any>
-             *   The response.
-             */
-            index: (payload) => __awaiter(this, void 0, void 0, function* () {
-                return yield this._search.post('search', JSON.parse(payload.data.toString()));
-            }),
-            /**
-             * Remove an item from the search index.
-             *
-             * @param payload types.URLPayload
-             *   The URL payload.
-             *
-             * @returns Promise<any>
-             *   The response obejct.
-             */
-            remove: (payload) => __awaiter(this, void 0, void 0, function* () {
-                return yield this._search.delete('search', {}, {
-                    'Quant-Url': payload.url
-                });
-            }),
-            /**
-             * Clear the search index.
-             *
-             * @returns Promise<any>
-             *   The response object.
-             */
-            clear: () => __awaiter(this, void 0, void 0, function* () {
-                return yield this._search.delete('search/all');
-            }),
-            /**
-             * Get the search index status.
-             *
-             * @returns Promise<any>
-             *   The response object.
-             */
-            status: () => __awaiter(this, void 0, void 0, function* () {
-                return yield this._search.get('search');
-            })
-        };
-        if (typeof Client === 'undefined') {
-            Client = HttpClient;
-        }
-        this._project = new Client((_a = config.endpoint) !== null && _a !== void 0 ? _a : 'https://api.quantcdn.io/v1', {
-            'User-Agent': 'Quant (+http://api.quantcdn.io)',
-            'Quant-Token': config.token,
-            'Quant-Customer': config.organization,
-            'Quant-Project': config.project,
-            'Content-Type': 'application/json'
-        });
-        this._search = new Client((_b = config.endpoint) !== null && _b !== void 0 ? _b : 'https://api.quantcdn.io/v1', {
-            'User-Agent': 'Quant (+http://api.quantcdn.io)',
-            'Quant-Token': config.token,
-            'Quant-Customer': config.organization,
-            'Quant-Project': config.project,
-            'Content-Type': 'application/json'
-        });
-        this._organization = new Client('https://dashboard.quantcdn.io/api/v1', {
-            'User-Agent': 'Quant (+http://api.quantcdn.io)',
-            // @todo: Americanise.
-            'Quant-Organisation': config.organization,
-            Authorization: `Bearer ${config.bearer}`
-        });
-    }
-    getClient(name) {
-        return this[`_${name}`];
-    }
-}
-exports.QuantClient = QuantClient;

package/dist/src/index.d.ts

@@ -1,2 +0,0 @@
-export * from './client';
-export * as types from './types';

package/dist/src/index.js

@@ -1,42 +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 __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/src/interfaces.d.ts

@@ -1,34 +0,0 @@
-import type * as types from './types';
-import type * as request from '@cypress/request';
-export type ClientConstructor = new (baseUrl: string, headers: object) => Client;
-export interface Client {
-    baseUrl: string;
-    headers: object;
-    do: (options: request.Options) => Promise<any>;
-    get: (path: string, qs?: object, headers?: object) => Promise<any>;
-    post: (path: string, body?: any, headers?: object, formData?: object, qs?: object) => Promise<any>;
-    delete: (path: string, body?: any, headers?: object) => Promise<any>;
-    patch: (path: string, body?: any, headers?: object) => Promise<any>;
-}
-export interface ProjectApi {
-    ping: () => Promise<any>;
-    meta: (filter?: types.MetaFilters) => Promise<any>;
-    markup: (payload: types.MarkupPayload) => Promise<any>;
-    file: (payload: types.FilePayload) => Promise<any>;
-    publish: (payload: types.PublishPayload) => Promise<any>;
-    unpublish: (payload: types.PublishPayload) => Promise<any>;
-    redirect: (payload: types.RedirectPayload) => Promise<any>;
-    proxy: (payload: types.ProxyPayload) => Promise<any>;
-    delete: (payload: types.URLPayload) => Promise<any>;
-    revisions: (payload: types.URLPayload) => Promise<any>;
-    purge: (payload: types.URLPayload) => Promise<any>;
-}
-export interface OrganizationApi {
-    wafLogs: (payload: types.WafLogsPayload) => Promise<any>;
-}
-export interface SearchApi {
-    index: (payload: types.SearchIndexPayload) => Promise<any>;
-    remove: (payload: types.URLPayload) => Promise<any>;
-    clear: () => Promise<any>;
-    status: () => Promise<any>;
-}

package/dist/src/interfaces.js

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