pgsql-deparser 17.12.2 → 17.13.0

package/esm/kwlist.js

@@ -0,0 +1,531 @@
+/* eslint-disable */
+/**
+ * Generated from PostgreSQL kwlist.h
+ * DO NOT EDIT BY HAND.
+ */
+export const kwlist = {
+    UNRESERVED_KEYWORD: [
+        "abort",
+        "absent",
+        "absolute",
+        "access",
+        "action",
+        "add",
+        "admin",
+        "after",
+        "aggregate",
+        "also",
+        "alter",
+        "always",
+        "asensitive",
+        "assertion",
+        "assignment",
+        "at",
+        "atomic",
+        "attach",
+        "attribute",
+        "backward",
+        "before",
+        "begin",
+        "breadth",
+        "by",
+        "cache",
+        "call",
+        "called",
+        "cascade",
+        "cascaded",
+        "catalog",
+        "chain",
+        "characteristics",
+        "checkpoint",
+        "class",
+        "close",
+        "cluster",
+        "columns",
+        "comment",
+        "comments",
+        "commit",
+        "committed",
+        "compression",
+        "conditional",
+        "configuration",
+        "conflict",
+        "connection",
+        "constraints",
+        "content",
+        "continue",
+        "conversion",
+        "copy",
+        "cost",
+        "csv",
+        "cube",
+        "current",
+        "cursor",
+        "cycle",
+        "data",
+        "database",
+        "day",
+        "deallocate",
+        "declare",
+        "defaults",
+        "deferred",
+        "definer",
+        "delete",
+        "delimiter",
+        "delimiters",
+        "depends",
+        "depth",
+        "detach",
+        "dictionary",
+        "disable",
+        "discard",
+        "document",
+        "domain",
+        "double",
+        "drop",
+        "each",
+        "empty",
+        "enable",
+        "encoding",
+        "encrypted",
+        "enforced",
+        "enum",
+        "error",
+        "escape",
+        "event",
+        "exclude",
+        "excluding",
+        "exclusive",
+        "execute",
+        "explain",
+        "expression",
+        "extension",
+        "external",
+        "family",
+        "filter",
+        "finalize",
+        "first",
+        "following",
+        "force",
+        "format",
+        "forward",
+        "function",
+        "functions",
+        "generated",
+        "global",
+        "granted",
+        "groups",
+        "handler",
+        "header",
+        "hold",
+        "hour",
+        "identity",
+        "if",
+        "ignore",
+        "immediate",
+        "immutable",
+        "implicit",
+        "import",
+        "include",
+        "including",
+        "increment",
+        "indent",
+        "index",
+        "indexes",
+        "inherit",
+        "inherits",
+        "inline",
+        "input",
+        "insensitive",
+        "insert",
+        "instead",
+        "invoker",
+        "isolation",
+        "keep",
+        "key",
+        "keys",
+        "label",
+        "language",
+        "large",
+        "last",
+        "leakproof",
+        "level",
+        "listen",
+        "load",
+        "local",
+        "location",
+        "lock",
+        "locked",
+        "logged",
+        "lsn",
+        "mapping",
+        "match",
+        "matched",
+        "materialized",
+        "maxvalue",
+        "merge",
+        "method",
+        "minute",
+        "minvalue",
+        "mode",
+        "month",
+        "move",
+        "name",
+        "names",
+        "nested",
+        "new",
+        "next",
+        "nfc",
+        "nfd",
+        "nfkc",
+        "nfkd",
+        "no",
+        "normalized",
+        "nothing",
+        "notify",
+        "nowait",
+        "nulls",
+        "object",
+        "objects",
+        "of",
+        "off",
+        "oids",
+        "old",
+        "omit",
+        "operator",
+        "option",
+        "options",
+        "ordinality",
+        "others",
+        "over",
+        "overriding",
+        "owned",
+        "owner",
+        "parallel",
+        "parameter",
+        "parser",
+        "partial",
+        "partition",
+        "partitions",
+        "passing",
+        "password",
+        "path",
+        "period",
+        "plan",
+        "plans",
+        "policy",
+        "preceding",
+        "prepare",
+        "prepared",
+        "preserve",
+        "prior",
+        "privileges",
+        "procedural",
+        "procedure",
+        "procedures",
+        "program",
+        "publication",
+        "quote",
+        "quotes",
+        "range",
+        "read",
+        "reassign",
+        "recursive",
+        "ref",
+        "referencing",
+        "refresh",
+        "reindex",
+        "relative",
+        "release",
+        "rename",
+        "repeatable",
+        "replace",
+        "replica",
+        "reset",
+        "respect",
+        "restart",
+        "restrict",
+        "return",
+        "returns",
+        "revoke",
+        "role",
+        "rollback",
+        "rollup",
+        "routine",
+        "routines",
+        "rows",
+        "rule",
+        "savepoint",
+        "scalar",
+        "schema",
+        "schemas",
+        "scroll",
+        "search",
+        "second",
+        "security",
+        "sequence",
+        "sequences",
+        "serializable",
+        "server",
+        "session",
+        "set",
+        "sets",
+        "share",
+        "show",
+        "simple",
+        "skip",
+        "snapshot",
+        "source",
+        "split",
+        "sql",
+        "stable",
+        "standalone",
+        "start",
+        "statement",
+        "statistics",
+        "stdin",
+        "stdout",
+        "storage",
+        "stored",
+        "strict",
+        "string",
+        "strip",
+        "subscription",
+        "support",
+        "sysid",
+        "system",
+        "tables",
+        "tablespace",
+        "target",
+        "temp",
+        "template",
+        "temporary",
+        "text",
+        "ties",
+        "transaction",
+        "transform",
+        "trigger",
+        "truncate",
+        "trusted",
+        "type",
+        "types",
+        "uescape",
+        "unbounded",
+        "uncommitted",
+        "unconditional",
+        "unencrypted",
+        "unknown",
+        "unlisten",
+        "unlogged",
+        "until",
+        "update",
+        "vacuum",
+        "valid",
+        "validate",
+        "validator",
+        "value",
+        "varying",
+        "version",
+        "view",
+        "views",
+        "virtual",
+        "volatile",
+        "wait",
+        "whitespace",
+        "within",
+        "without",
+        "work",
+        "wrapper",
+        "write",
+        "xml",
+        "year",
+        "yes",
+        "zone"
+    ],
+    RESERVED_KEYWORD: [
+        "all",
+        "analyse",
+        "analyze",
+        "and",
+        "any",
+        "array",
+        "as",
+        "asc",
+        "asymmetric",
+        "both",
+        "case",
+        "cast",
+        "check",
+        "collate",
+        "column",
+        "constraint",
+        "create",
+        "current_catalog",
+        "current_date",
+        "current_role",
+        "current_time",
+        "current_timestamp",
+        "current_user",
+        "default",
+        "deferrable",
+        "desc",
+        "distinct",
+        "do",
+        "else",
+        "end",
+        "except",
+        "false",
+        "fetch",
+        "for",
+        "foreign",
+        "from",
+        "grant",
+        "group",
+        "having",
+        "in",
+        "initially",
+        "intersect",
+        "into",
+        "lateral",
+        "leading",
+        "limit",
+        "localtime",
+        "localtimestamp",
+        "not",
+        "null",
+        "offset",
+        "on",
+        "only",
+        "or",
+        "order",
+        "placing",
+        "primary",
+        "references",
+        "returning",
+        "select",
+        "session_user",
+        "some",
+        "symmetric",
+        "system_user",
+        "table",
+        "then",
+        "to",
+        "trailing",
+        "true",
+        "union",
+        "unique",
+        "user",
+        "using",
+        "variadic",
+        "when",
+        "where",
+        "window",
+        "with"
+    ],
+    TYPE_FUNC_NAME_KEYWORD: [
+        "authorization",
+        "binary",
+        "collation",
+        "concurrently",
+        "cross",
+        "current_schema",
+        "freeze",
+        "full",
+        "ilike",
+        "inner",
+        "is",
+        "isnull",
+        "join",
+        "left",
+        "like",
+        "natural",
+        "notnull",
+        "outer",
+        "overlaps",
+        "right",
+        "similar",
+        "tablesample",
+        "verbose"
+    ],
+    COL_NAME_KEYWORD: [
+        "between",
+        "bigint",
+        "bit",
+        "boolean",
+        "char",
+        "character",
+        "coalesce",
+        "dec",
+        "decimal",
+        "exists",
+        "extract",
+        "float",
+        "greatest",
+        "grouping",
+        "inout",
+        "int",
+        "integer",
+        "interval",
+        "json",
+        "json_array",
+        "json_arrayagg",
+        "json_exists",
+        "json_object",
+        "json_objectagg",
+        "json_query",
+        "json_scalar",
+        "json_serialize",
+        "json_table",
+        "json_value",
+        "least",
+        "merge_action",
+        "national",
+        "nchar",
+        "none",
+        "normalize",
+        "nullif",
+        "numeric",
+        "out",
+        "overlay",
+        "position",
+        "precision",
+        "real",
+        "row",
+        "setof",
+        "smallint",
+        "substring",
+        "time",
+        "timestamp",
+        "treat",
+        "trim",
+        "values",
+        "varchar",
+        "xmlattributes",
+        "xmlconcat",
+        "xmlelement",
+        "xmlexists",
+        "xmlforest",
+        "xmlnamespaces",
+        "xmlparse",
+        "xmlpi",
+        "xmlroot",
+        "xmlserialize",
+        "xmltable"
+    ]
+};
+export const RESERVED_KEYWORDS = new Set(kwlist.RESERVED_KEYWORD ?? []);
+export const UNRESERVED_KEYWORDS = new Set(kwlist.UNRESERVED_KEYWORD ?? []);
+export const COL_NAME_KEYWORDS = new Set(kwlist.COL_NAME_KEYWORD ?? []);
+export const TYPE_FUNC_NAME_KEYWORDS = new Set(kwlist.TYPE_FUNC_NAME_KEYWORD ?? []);
+export function keywordKindOf(word) {
+    const w = word.toLowerCase();
+    if (RESERVED_KEYWORDS.has(w))
+        return "RESERVED_KEYWORD";
+    if (TYPE_FUNC_NAME_KEYWORDS.has(w))
+        return "TYPE_FUNC_NAME_KEYWORD";
+    if (COL_NAME_KEYWORDS.has(w))
+        return "COL_NAME_KEYWORD";
+    if (UNRESERVED_KEYWORDS.has(w))
+        return "UNRESERVED_KEYWORD";
+    return "NO_KEYWORD";
+}

package/esm/utils/quote-utils.js

@@ -1,50 +1,5 @@
-const RESERVED_WORDS = new Set([
-    'all', 'analyse', 'analyze', 'and', 'any', 'array', 'as', 'asc', 'asymmetric',
-    'authorization', 'binary', 'both', 'case', 'cast', 'check', 'collate', 'collation',
-    'column', 'concurrently', 'constraint', 'create', 'cross', 'current_catalog',
-    'current_date', 'current_role', 'current_schema', 'current_time', 'current_timestamp',
-    'current_user', 'default', 'deferrable', 'desc', 'distinct', 'do', 'else', 'end',
-    'except', 'false', 'fetch', 'for', 'foreign', 'freeze', 'from', 'full', 'grant',
-    'group', 'having', 'ilike', 'in', 'initially', 'inner', 'intersect', 'into', 'is',
-    'isnull', 'join', 'lateral', 'leading', 'left', 'like', 'limit', 'localtime',
-    'localtimestamp', 'natural', 'not', 'notnull', 'null', 'offset', 'on', 'only',
-    'or', 'order', 'outer', 'overlaps', 'placing', 'primary', 'references', 'returning',
-    'right', 'select', 'session_user', 'similar', 'some', 'symmetric', 'table', 'tablesample',
-    'then', 'to', 'trailing', 'true', 'union', 'unique', 'user', 'using', 'variadic',
-    'verbose', 'when', 'where', 'window', 'with'
-]);
+import { keywordKindOf } from '../kwlist';
 export class QuoteUtils {
-    static needsQuotes(value) {
-        if (!value || typeof value !== 'string') {
-            return false;
-        }
-        const lowerValue = value.toLowerCase();
-        if (RESERVED_WORDS.has(lowerValue)) {
-            return true;
-        }
-        if (!/^[a-z_][a-z0-9_$]*$/i.test(value)) {
-            return true;
-        }
-        if (value !== value.toLowerCase()) {
-            return true;
-        }
-        return false;
-    }
-    static quote(value) {
-        if (value == null) {
-            return null;
-        }
-        if (Array.isArray(value)) {
-            return value.map(v => this.quote(v));
-        }
-        if (typeof value !== 'string') {
-            return value;
-        }
-        if (this.needsQuotes(value)) {
-            return `"${value}"`;
-        }
-        return value;
-    }
     static escape(literal) {
         return `'${literal.replace(/'/g, "''")}'`;
     }
@@ -78,4 +33,80 @@ export class QuoteUtils {
         // unless it's a raw \x... bytea-style literal.
         return !/^\\x[0-9a-fA-F]+$/i.test(value) && value.includes('\\');
     }
+    /**
+     * Quote an identifier only if needed
+     *
+     * This is a TypeScript port of PostgreSQL's quote_identifier() function from ruleutils.c
+     * https://github.com/postgres/postgres/blob/fab5cd3dd1323f9e66efeb676c4bb212ff340204/src/backend/utils/adt/ruleutils.c#L13055-L13137
+     *
+     * Can avoid quoting if ident starts with a lowercase letter or underscore
+     * and contains only lowercase letters, digits, and underscores, *and* is
+     * not any SQL keyword. Otherwise, supply quotes.
+     *
+     * When quotes are needed, embedded double quotes are properly escaped as "".
+     */
+    static quoteIdentifier(ident) {
+        if (!ident)
+            return ident;
+        let nquotes = 0;
+        let safe = true;
+        // Check first character: must be lowercase letter or underscore
+        const firstChar = ident[0];
+        if (!((firstChar >= 'a' && firstChar <= 'z') || firstChar === '_')) {
+            safe = false;
+        }
+        // Check all characters
+        for (let i = 0; i < ident.length; i++) {
+            const ch = ident[i];
+            if ((ch >= 'a' && ch <= 'z') ||
+                (ch >= '0' && ch <= '9') ||
+                (ch === '_')) {
+                // okay
+            }
+            else {
+                safe = false;
+                if (ch === '"') {
+                    nquotes++;
+                }
+            }
+        }
+        if (safe) {
+            // Check for keyword. We quote keywords except for unreserved ones.
+            // (In some cases we could avoid quoting a col_name or type_func_name
+            // keyword, but it seems much harder than it's worth to tell that.)
+            const kwKind = keywordKindOf(ident);
+            if (kwKind !== 'NO_KEYWORD' && kwKind !== 'UNRESERVED_KEYWORD') {
+                safe = false;
+            }
+        }
+        if (safe) {
+            return ident; // no change needed
+        }
+        // Build quoted identifier with escaped embedded quotes
+        let result = '"';
+        for (let i = 0; i < ident.length; i++) {
+            const ch = ident[i];
+            if (ch === '"') {
+                result += '"'; // escape " as ""
+            }
+            result += ch;
+        }
+        result += '"';
+        return result;
+    }
+    /**
+     * Quote a possibly-qualified identifier
+     *
+     * This is a TypeScript port of PostgreSQL's quote_qualified_identifier() function from ruleutils.c
+     * https://github.com/postgres/postgres/blob/fab5cd3dd1323f9e66efeb676c4bb212ff340204/src/backend/utils/adt/ruleutils.c#L13139-L13156
+     *
+     * Return a name of the form qualifier.ident, or just ident if qualifier
+     * is null/undefined, quoting each component if necessary.
+     */
+    static quoteQualifiedIdentifier(qualifier, ident) {
+        if (qualifier) {
+            return `${QuoteUtils.quoteIdentifier(qualifier)}.${QuoteUtils.quoteIdentifier(ident)}`;
+        }
+        return QuoteUtils.quoteIdentifier(ident);
+    }
 }

package/kwlist.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated from PostgreSQL kwlist.h
+ * DO NOT EDIT BY HAND.
+ */
+export type KeywordKind = "NO_KEYWORD" | "UNRESERVED_KEYWORD" | "COL_NAME_KEYWORD" | "TYPE_FUNC_NAME_KEYWORD" | "RESERVED_KEYWORD";
+export declare const kwlist: {
+    readonly UNRESERVED_KEYWORD: readonly ["abort", "absent", "absolute", "access", "action", "add", "admin", "after", "aggregate", "also", "alter", "always", "asensitive", "assertion", "assignment", "at", "atomic", "attach", "attribute", "backward", "before", "begin", "breadth", "by", "cache", "call", "called", "cascade", "cascaded", "catalog", "chain", "characteristics", "checkpoint", "class", "close", "cluster", "columns", "comment", "comments", "commit", "committed", "compression", "conditional", "configuration", "conflict", "connection", "constraints", "content", "continue", "conversion", "copy", "cost", "csv", "cube", "current", "cursor", "cycle", "data", "database", "day", "deallocate", "declare", "defaults", "deferred", "definer", "delete", "delimiter", "delimiters", "depends", "depth", "detach", "dictionary", "disable", "discard", "document", "domain", "double", "drop", "each", "empty", "enable", "encoding", "encrypted", "enforced", "enum", "error", "escape", "event", "exclude", "excluding", "exclusive", "execute", "explain", "expression", "extension", "external", "family", "filter", "finalize", "first", "following", "force", "format", "forward", "function", "functions", "generated", "global", "granted", "groups", "handler", "header", "hold", "hour", "identity", "if", "ignore", "immediate", "immutable", "implicit", "import", "include", "including", "increment", "indent", "index", "indexes", "inherit", "inherits", "inline", "input", "insensitive", "insert", "instead", "invoker", "isolation", "keep", "key", "keys", "label", "language", "large", "last", "leakproof", "level", "listen", "load", "local", "location", "lock", "locked", "logged", "lsn", "mapping", "match", "matched", "materialized", "maxvalue", "merge", "method", "minute", "minvalue", "mode", "month", "move", "name", "names", "nested", "new", "next", "nfc", "nfd", "nfkc", "nfkd", "no", "normalized", "nothing", "notify", "nowait", "nulls", "object", "objects", "of", "off", "oids", "old", "omit", "operator", "option", "options", "ordinality", "others", "over", "overriding", "owned", "owner", "parallel", "parameter", "parser", "partial", "partition", "partitions", "passing", "password", "path", "period", "plan", "plans", "policy", "preceding", "prepare", "prepared", "preserve", "prior", "privileges", "procedural", "procedure", "procedures", "program", "publication", "quote", "quotes", "range", "read", "reassign", "recursive", "ref", "referencing", "refresh", "reindex", "relative", "release", "rename", "repeatable", "replace", "replica", "reset", "respect", "restart", "restrict", "return", "returns", "revoke", "role", "rollback", "rollup", "routine", "routines", "rows", "rule", "savepoint", "scalar", "schema", "schemas", "scroll", "search", "second", "security", "sequence", "sequences", "serializable", "server", "session", "set", "sets", "share", "show", "simple", "skip", "snapshot", "source", "split", "sql", "stable", "standalone", "start", "statement", "statistics", "stdin", "stdout", "storage", "stored", "strict", "string", "strip", "subscription", "support", "sysid", "system", "tables", "tablespace", "target", "temp", "template", "temporary", "text", "ties", "transaction", "transform", "trigger", "truncate", "trusted", "type", "types", "uescape", "unbounded", "uncommitted", "unconditional", "unencrypted", "unknown", "unlisten", "unlogged", "until", "update", "vacuum", "valid", "validate", "validator", "value", "varying", "version", "view", "views", "virtual", "volatile", "wait", "whitespace", "within", "without", "work", "wrapper", "write", "xml", "year", "yes", "zone"];
+    readonly RESERVED_KEYWORD: readonly ["all", "analyse", "analyze", "and", "any", "array", "as", "asc", "asymmetric", "both", "case", "cast", "check", "collate", "column", "constraint", "create", "current_catalog", "current_date", "current_role", "current_time", "current_timestamp", "current_user", "default", "deferrable", "desc", "distinct", "do", "else", "end", "except", "false", "fetch", "for", "foreign", "from", "grant", "group", "having", "in", "initially", "intersect", "into", "lateral", "leading", "limit", "localtime", "localtimestamp", "not", "null", "offset", "on", "only", "or", "order", "placing", "primary", "references", "returning", "select", "session_user", "some", "symmetric", "system_user", "table", "then", "to", "trailing", "true", "union", "unique", "user", "using", "variadic", "when", "where", "window", "with"];
+    readonly TYPE_FUNC_NAME_KEYWORD: readonly ["authorization", "binary", "collation", "concurrently", "cross", "current_schema", "freeze", "full", "ilike", "inner", "is", "isnull", "join", "left", "like", "natural", "notnull", "outer", "overlaps", "right", "similar", "tablesample", "verbose"];
+    readonly COL_NAME_KEYWORD: readonly ["between", "bigint", "bit", "boolean", "char", "character", "coalesce", "dec", "decimal", "exists", "extract", "float", "greatest", "grouping", "inout", "int", "integer", "interval", "json", "json_array", "json_arrayagg", "json_exists", "json_object", "json_objectagg", "json_query", "json_scalar", "json_serialize", "json_table", "json_value", "least", "merge_action", "national", "nchar", "none", "normalize", "nullif", "numeric", "out", "overlay", "position", "precision", "real", "row", "setof", "smallint", "substring", "time", "timestamp", "treat", "trim", "values", "varchar", "xmlattributes", "xmlconcat", "xmlelement", "xmlexists", "xmlforest", "xmlnamespaces", "xmlparse", "xmlpi", "xmlroot", "xmlserialize", "xmltable"];
+};
+export declare const RESERVED_KEYWORDS: Set<string>;
+export declare const UNRESERVED_KEYWORDS: Set<string>;
+export declare const COL_NAME_KEYWORDS: Set<string>;
+export declare const TYPE_FUNC_NAME_KEYWORDS: Set<string>;
+export declare function keywordKindOf(word: string): KeywordKind;