@quantcdn/quant-client 1.0.0 → 2.0.1

package/dist/types.d.ts

@@ -0,0 +1,60 @@
+/// <reference types="node" />
+import { type Buffer } from 'buffer';
+export interface Config {
+    organization: string;
+    token?: string;
+    project?: string;
+    bearer?: string;
+}
+export interface ProxyPayload {
+    url: string;
+    destination: string;
+    published: boolean;
+}
+export interface MarkupPayload {
+    data: Buffer;
+    url: string;
+    published: boolean;
+    findAttachments?: boolean;
+    skipPurge?: boolean;
+}
+export interface FilePayload {
+    data: Buffer;
+    location: string;
+    skipPurge?: boolean;
+}
+export interface PublishPayload {
+    location: string;
+    revision: number;
+}
+export declare enum RedirectStatus {
+    Permanent = 301,
+    Termporary = 302
+}
+export interface RedirectPayload {
+    url: string;
+    redirect_url: string;
+    redirect_http_code: RedirectStatus;
+    published: boolean;
+}
+export interface URLPayload {
+    url: string;
+}
+export interface WafLogsPayload {
+    project: string;
+}
+export interface SearchIndexPayload {
+    data: Buffer;
+}
+export interface WafLog {
+    timestamp: string;
+    ip_address: string;
+    location: string;
+    type: string;
+    mode: string;
+    rule_id: string;
+    domain: string;
+    url: string;
+    method: string;
+    user_agent: string;
+}

package/dist/types.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedirectStatus = void 0;
+var RedirectStatus;
+(function (RedirectStatus) {
+    RedirectStatus[RedirectStatus["Permanent"] = 301] = "Permanent";
+    RedirectStatus[RedirectStatus["Termporary"] = 302] = "Termporary";
+})(RedirectStatus || (exports.RedirectStatus = RedirectStatus = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quantcdn/quant-client",
-  "version": "1.0.0",
+  "version": "2.0.1",
   "description": "Client library for API connectivity",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -8,11 +8,13 @@
     "/dist"
   ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "tsc",
+    "test": "jest",
+    "lint:src": "eslint --ext .ts ./src"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/quantcdn/quant-client.git"
+    "url": "git+https://github.com/quantcdn/quant-ts-client.git"
   },
   "author": "Stuart Rowlands <stuart.rowlands@quantcdn.io>",
   "license": "ISC",
@@ -21,10 +23,22 @@
   },
   "homepage": "https://github.com/quantcdn/quant-client#readme",
   "dependencies": {
-    "mime-types": "^2.1.27",
-    "request": "^2.88.2"
+    "@cypress/request": "3.0.1",
+    "mime-types": "^2.1.27"
   },
   "devDependencies": {
-    "@types/node": "^18.16.3"
+    "@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"
   }
 }

package/dist/config.d.ts

@@ -1,7 +0,0 @@
-export interface QuantConfig {
-    dir: string;
-    endpoint: "https://api.quantcdn.io/v1";
-    clientid: string;
-    project: string;
-    token: string;
-}

package/dist/helper/quant-url.d.ts

@@ -1,15 +0,0 @@
-/**
- * Prepare URLs for quant.
- */
-export declare class QuantURL {
-    /**
-     * Prepare a URI to work with Quant.
-     *
-     * @param {string} uri
-     *   The URI to prepare.
-     *
-     * @return {string}
-     *   The prepared URI
-     */
-    static prepare(uri: any): any;
-}

package/dist/helper/quant-url.js

@@ -1,29 +0,0 @@
-"use strict";
-/**
- * Prepare URLs for quant.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuantURL = void 0;
-class QuantURL {
-    /**
-     * Prepare a URI to work with Quant.
-     *
-     * @param {string} uri
-     *   The URI to prepare.
-     *
-     * @return {string}
-     *   The prepared URI
-     */
-    static prepare(uri) {
-        uri = uri.startsWith('/') ? uri : `/${uri}`;
-        uri = uri.toLowerCase();
-        uri = uri.replace(/^\/\//, '/');
-        uri = uri.replace(/(\/)index\.html/, '$1');
-        if (uri.length > 1) {
-            return uri.endsWith('/') ? uri.slice(0, -1) : uri;
-        }
-        return uri;
-    }
-}
-exports.QuantURL = QuantURL;
-;

package/dist/quant-client.d.ts

@@ -1,230 +0,0 @@
-/**
- * Quant API client.
- */
-export declare function QuantClient(): {
-    /**
-     * Initialize the client
-     */
-    init: () => void;
-    /**
-     * Ping the quant API.
-     *
-     * @return {object}
-     *   The response object.
-     *
-     * @throws Error.
-     */
-    ping: () => Promise<any>;
-    /**
-     * Access the global meta for the project.
-     *
-     * @param {bool} unfold
-     *   Unfold the record set.
-     * @param {bool} exclude
-     *   Exclude delete objects from the meta result.
-     * @param {object} extend
-     *   Additional query parameters to send.
-     *
-     * @return {object}
-     *   The global meta response object.
-     *
-     * @throws Error.
-     *
-     * @TODO
-     *   - Async iterator for memory 21k items ~ 40mb.
-     */
-    meta: (unfold?: boolean, exclude?: boolean, extend?: {}) => Promise<{
-        total_pages: any;
-        total_records: any;
-        records: any[];
-    }>;
-    /**
-     * Send a file to the server.
-     *
-     * @param {string} file
-     *   The path to the file.
-     * @param {string} location
-     *   The path the location.
-     * @param {bool} published
-     *   The status.
-     * @param {bool} attachments
-     *   Should quant find attachments.
-     * @param {bool} skipPurge
-     *   Skip CDN cache purge.
-     * @param {bool} includeIndex
-     *   Include index.html suffix on HTML assets.
-     * @param {object} extraHeaders
-     *   Additional HTTP headers.
-     * @param {string} encoding
-     *   The encoding type.
-     *
-     * @return {object}
-     *   The API response.
-     */
-    send: (file: any, location: any, published?: boolean, attachments?: boolean, skipPurge?: boolean, includeIndex?: boolean, extraHeaders?: {}, encoding?: string) => Promise<any>;
-    /**
-     * Upload markup.
-     *
-     * @param {string} file
-     *   Filepath on disk.
-     * @param {string} location
-     *   The web accessible destination.
-     * @param {bool} published
-     *   The status.
-     * @param {bool} attachments
-     *   Quant looking for attachments.
-     * @param {object} extraHeaders
-     *   Additional HTTP headers.
-     * @param {string} encoding
-     *   The encoding type.
-     * @param {bool} skipPurge
-     *   Skip CDN cache purge.
-     *
-     * @return {object}
-     *   The API response.
-     */
-    markup: (file: any, location: any, published?: boolean, attachments?: boolean, extraHeaders?: {}, encoding?: string, skipPurge?: boolean) => Promise<any>;
-    /**
-     * Send a file to the Quant API.
-     *
-     * @param {string} local
-     *   File path on disk.
-     * @param {string} location
-     *   Accessible location.
-     * @param {bool} absolute
-     *   If the location is an absolute path.
-     * @param {object} extraHeaders
-     *   Additional HTTP headers.
-     * @param {bool} skipPurge
-     *   Skip CDN cache purge.
-     *
-     * @return {object}
-     *   The successful payload.
-     *
-     * @throws Error
-     */
-    file: (local: any, location: any, absolute?: boolean, extraHeaders?: {}, skipPurge?: boolean) => Promise<any>;
-    /**
-     * Change the status of an asset.
-     *
-     * @param {string} location
-     *   The URL location of the content.
-     * @param {string} revision
-     *   The revision to publish.
-     *
-     * @return {object}
-     *   API payload.
-     *
-     * @throws Error.
-     */
-    publish: (location: any, revision: any) => Promise<any>;
-    /**
-     * Unpublish a URL.
-     *
-     * @param {string} url
-     *   The URL to unpublish.
-     *
-     * @return {object}
-     *
-     * @throws Error.
-     */
-    unpublish: (url: any) => Promise<any>;
-    /**
-     *
-     * @param {string} from
-     *   The URL to redirect form.
-     * @param {string} to
-     *   The URL to redirect to.
-     * @param {string} author
-     *   (Optional) Author.
-     * @param {int} status
-     *   HTTP status code.
-     *
-     * @return {object}
-     *   API payload.
-     *
-     * @throws Error.
-     */
-    redirect: (from: any, to: any, author: any, status?: number) => Promise<any>;
-    /**
-     * Create a proxy with the Quant API.
-     *
-     * @param {string} url
-     *   The relative URL to proxy.
-     * @param {string} destination
-     *   The absolute FQDN/path to proxy to.
-     * @param {bool} published
-     *   If the proxy is published
-     * @param {string} username
-     *   Basic auth user.
-     * @param {string} password
-     *   Basic auth password.
-     *
-     * @return {object}
-     *   The response.
-     *
-     * @throws Error.
-     */
-    proxy: (url: any, destination: any, published: boolean, username: any, password: any) => Promise<any>;
-    /**
-     * Delete a path from Quant.
-     *
-     * @param {string} path
-     *
-     * @return {object}
-     *   The response object.
-     *
-     * @throw Error.
-     */
-    delete: (path: any) => Promise<any>;
-    /**
-     * Get the revision history from Quant.
-     *
-     * @param {string} url
-     *   The URL path to get revisions for.
-     * @param {string|bool} revision
-     *   Retrieve a specific revision.
-     *
-     * @return {object}
-     *   The response.
-     *
-     * @throws Error.
-     */
-    revisions: (url: any, revision?: boolean) => Promise<any>;
-    /**
-     * Purge URL patterns from Quants Varnish.
-     *
-     * @param {string} urlPattern
-     *
-     * @throws Error
-     */
-    purge: (urlPattern: any) => Promise<any>;
-    /**
-      * Add/update items in search index.
-      *
-      * @param {string} filePath
-      *
-      * @throws Error
-      */
-    searchIndex: (filePath: any) => Promise<any>;
-    /**
-      * Remove item from search index.
-      *
-      * @param {string} url
-      *
-      * @throws Error
-      */
-    searchRemove: (url: any) => Promise<any>;
-    /**
-      * Clear search index.
-      *
-      * @throws Error
-      */
-    searchClearIndex: () => Promise<any>;
-    /**
-      * Retrieve search index status.
-      *
-      * @throws Error
-      */
-    searchStatus: () => Promise<any>;
-};