Update to NPM version

ProjectSourceCode/node_modules/pg-promise/lib/helpers/table-name.js

@@ -0,0 +1,128 @@
+/*
+ * Copyright (c) 2015-present, Vitaly Tomilov
+ *
+ * See the LICENSE file at the top-level directory of this distribution
+ * for licensing information.
+ *
+ * Removal or modification of this copyright notice is prohibited.
+ */
+
+const {assert} = require(`../assert`);
+
+const npm = {
+    utils: require(`../utils`),
+    format: require(`../formatting`).as // formatting namespace
+};
+
+/**
+ * @class helpers.TableName
+ * @description
+ * Represents a full table name that can be injected into queries directly.
+ *
+ * This is a read-only type that can be used wherever parameter `table` is supported.
+ *
+ * It supports $[Custom Type Formatting], which means you can use the type directly as a formatting
+ * parameter, without specifying any escaping.
+ *
+ * Filter `:alias` is an alternative approach to splitting an SQL name into multiple ones.
+ *
+ * @param {string|object} table
+ * Table name details, depending on the type:
+ *
+ * - table name, if `table` is a string
+ * - object `{table, [schema]}`
+ *
+ * @property {string} name
+ * Formatted/escaped full table name, combining `schema` + `table`.
+ *
+ * @property {string} table
+ * Table name.
+ *
+ * @property {string} schema
+ * Database schema name.
+ *
+ * It is `undefined` when no valid schema was specified.
+ *
+ * @returns {helpers.TableName}
+ *
+ * @see
+ * {@link helpers.TableName#toPostgres toPostgres}
+ *
+ * @example
+ *
+ * const table = new pgp.helpers.TableName({table: 'my-table', schema: 'my-schema'});
+ * console.log(table);
+ * //=> "my-schema"."my-table"
+ *
+ * // Formatting the type directly:
+ * pgp.as.format('SELECT * FROM $1', table);
+ * //=> SELECT * FROM "my-schema"."my-table"
+ *
+ */
+class TableName {
+
+    constructor(table) {
+        if (typeof table === `string`) {
+            this.table = table;
+        } else {
+            const config = assert(table, [`table`, `schema`]);
+            this.table = config.table;
+            if (npm.utils.isText(config.schema)) {
+                this.schema = config.schema;
+            }
+        }
+        if (!npm.utils.isText(this.table)) {
+            throw new TypeError(`Table name must be a non-empty text string.`);
+        }
+        this.name = npm.format.name(this.table);
+        if (this.schema) {
+            this.name = npm.format.name(this.schema) + `.` + this.name;
+        }
+        Object.freeze(this);
+    }
+}
+
+/**
+ * @method helpers.TableName#toPostgres
+ * @description
+ * $[Custom Type Formatting], based on $[Symbolic CTF], i.e. the actual method is available only via {@link external:Symbol Symbol}:
+ *
+ * ```js
+ * const ctf = pgp.as.ctf; // Custom Type Formatting symbols namespace
+ * const fullName = tn[ctf.toPostgres]; // tn = an object of type TableName
+ * ```
+ *
+ * This is a raw formatting type (`rawType = true`), i.e. when used as a query-formatting parameter, type `TableName`
+ * injects full table name as raw text.
+ *
+ * @param {helpers.TableName} [self]
+ * Optional self-reference, for ES6 arrow functions.
+ *
+ * @returns {string}
+ * Escaped full table name that includes optional schema name, if specified.
+ */
+TableName.prototype[npm.format.ctf.toPostgres] = function (self) {
+    self = this instanceof TableName && this || self;
+    return self.name;
+};
+
+TableName.prototype[npm.format.ctf.rawType] = true; // use as pre-formatted
+
+/**
+ * @method helpers.TableName#toString
+ * @description
+ * Creates a well-formatted string that represents the object.
+ *
+ * It is called automatically when writing the object into the console.
+ *
+ * @returns {string}
+ */
+TableName.prototype.toString = function () {
+    return this.name;
+};
+
+npm.utils.addInspection(TableName, function () {
+    return this.toString();
+});
+
+module.exports = {TableName};