@cpanel/api/dist/cjs/utils/encoders.js

cPanel API JavaScript and TypeScript interface libraries. This library provides a set of classes for calling cPanel WHM API 1 and UAPI calls. The classes hide much of the complexity of these APIs behind classes the abstract the underlying variances betwee

"use strict";
// MIT License
//
// Copyright 2021 cPanel L.L.C.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
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 __importStar = (this && this.__importStar) || function (mod) {
    if (mod && mod.__esModule) return mod;
    var result = {};
    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
    __setModuleDefault(result, mod);
    return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.JsonArgumentEncoder = exports.WwwFormUrlArgumentEncoder = exports.UrlArgumentEncoder = void 0;
const json = __importStar(require("./json/serializable"));
/**
 * Encode parameters using urlencode.
 */
class UrlArgumentEncoder {
    constructor() {
        this.contentType = "";
        this.separatorStart = "?";
        this.separatorEnd = "";
        this.recordSeparator = "&";
    }
    /**
     * Encode a given value into query-string compatible format.
     *
     * @param name Name of the field, may be empty string.
     * @param value Value to serialize
     * @param last True if this is the last argument being serialized.
     * @return Encoded version of the argument.
     */
    encode(name, value, last) {
        if (!name) {
            throw new Error("Name must have a non-empty value");
        }
        return (`${name}=${encodeURIComponent(value.toString())}` +
            (!last ? this.recordSeparator : ""));
    }
}
exports.UrlArgumentEncoder = UrlArgumentEncoder;
/**
 * Encode parameters using application/x-www-form-urlencoded
 */
class WwwFormUrlArgumentEncoder {
    constructor() {
        this.contentType = "application/x-www-form-urlencoded";
        this.separatorStart = "";
        this.separatorEnd = "";
        this.recordSeparator = "&";
    }
    /**
     * Encode a given value into the application/x-www-form-urlencoded.
     *
     * @param name Name of the field, may be empty string.
     * @param value Value to serialize
     * @param last True if this is the last argument being serialized.
     * @return Encoded version of the argument.
     */
    encode(name, value, last) {
        if (!name) {
            throw new Error("Name must have a non-empty value");
        }
        return (`${name}=${encodeURIComponent(value.toString())}` +
            (!last ? this.recordSeparator : ""));
    }
}
exports.WwwFormUrlArgumentEncoder = WwwFormUrlArgumentEncoder;
/**
 * Encode the parameter into JSON
 */
class JsonArgumentEncoder {
    constructor() {
        this.contentType = "application/json";
        this.separatorStart = "{";
        this.separatorEnd = "}";
        this.recordSeparator = ",";
    }
    /**
     * Encode a given value into the JSON application/json body.
     *
     * @param name Name of the field.
     * @param value Value to serialize
     * @param last True if this is the last argument being serialized.
     * @return {string}        Encoded version of the argument.
     */
    encode(name, value, last) {
        if (!name) {
            throw new Error("Name must have a non-empty value");
        }
        if (!json.isSerializable(value)) {
            throw new Error("The passed in value can not be serialized to JSON");
        }
        return (JSON.stringify(name) +
            ":" +
            JSON.stringify(value) +
            (!last ? this.recordSeparator : ""));
    }
}
exports.JsonArgumentEncoder = JsonArgumentEncoder;
//# sourceMappingURL=encoders.js.map