pgsql-deparser 17.18.4 → 17.19.0

package/README.md

@@ -69,27 +69,29 @@ console.log(deparse(stmt));
 // Output: SELECT * FROM another_table
 ```
 
-### Latest Version (PostgreSQL 17)
+### Latest Version (PostgreSQL 18)
 
 ```sh
 npm install pgsql-deparser
 ```
 
-### Version-Specific Packages (PostgreSQL 13-16)
+### Version-Specific Packages (PostgreSQL 13-17)
 
-While we highly recommend using PG17, for PostgreSQL versions 13-16, use the version-specific packages:
+We recommend PG18. PG17 remains fully supported; for PostgreSQL versions 13-17, use the version-specific packages:
 
 ```sh
 npm install pgsql-deparser@pg13  # PostgreSQL 13
 npm install pgsql-deparser@pg14  # PostgreSQL 14
 npm install pgsql-deparser@pg15  # PostgreSQL 15
 npm install pgsql-deparser@pg16  # PostgreSQL 16
+npm install pgsql-deparser@pg17  # PostgreSQL 17
 ```
 
 **Version Status:**
-- **PG17**: 🚀 Recommended (stable + modern AST)
-- **PG14-16**: ⚠️ Experimental (modern AST, hardening in progress)
-- **PG13**: Stable (legacy AST format)
+- **PG18**: 🚀 Recommended (stable + modern AST)
+- **PG17**: Stable (modern AST)
+- **PG14-16**: Legacy (modern AST, not actively developed)
+- **PG13**: Legacy (legacy AST format)
 
 ## Options
 
@@ -147,8 +149,6 @@ Built on the excellent work of several contributors:
 * **[Ethan Resnick](https://github.com/ethanresnick)** for the original Node.js N-API bindings
 * **[Zac McCormick](https://github.com/zhm)** for the foundational [node-pg-query-native](https://github.com/zhm/node-pg-query-native) parser
 
----
-
 **🛠 Built by the [Constructive](https://constructive.io) team — creators of modular Postgres tooling for secure, composable backends. If you like our work, contribute on [GitHub](https://github.com/constructive-io).**
 
 ## Related
@@ -170,4 +170,4 @@ Built on the excellent work of several contributors:
 
 AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED "AS IS", AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.
 
-No developer or entity involved in creating Software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the Software code or Software CLI, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.
+No developer or entity involved in creating Software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the Software code or Software CLI, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.

package/deparser/deparser.d.ts

@@ -0,0 +1,311 @@
+/**
+ * Auto-generated file with types stripped for better tree-shaking
+ * DO NOT EDIT - Generated by strip-deparser-types.ts
+ */
+import { DeparserContext, DeparserVisitor } from './visitors/base';
+export interface DeparserOptions {
+    newline?: string;
+    tab?: string;
+    functionDelimiter?: string;
+    functionDelimiterFallback?: string;
+    pretty?: boolean;
+}
+export declare class Deparser implements DeparserVisitor {
+    private tree;
+    private options;
+    constructor(tree: any | any[] | any, opts?: DeparserOptions);
+    /**
+     * Static method to deparse PostgreSQL AST nodes to SQL
+     * @param query - Can be:
+     *   - ParseResult from libpg-query (e.g., { version: 170004, stmts: [...] })
+     *   - Wrapped ParseResult node (e.g., { ParseResult: {...} })
+     *   - Wrapped RawStmt node (e.g., { RawStmt: {...} })
+     *   - Array of Nodes
+     *   - Single Node (e.g., { SelectStmt: {...} })
+     * @param opts - Deparser options for formatting
+     * @returns The deparsed SQL string
+     */
+    static deparse(query: any | any[] | any, opts?: DeparserOptions): string;
+    deparseQuery(): string;
+    /**
+     * Get the appropriate function delimiter based on the body content
+     * @param body The function body to check
+     * @returns The delimiter to use
+     */
+    private getFunctionDelimiter;
+    /**
+     * Maps ObjectType enum values to their corresponding SQL keywords
+     * Used by AlterOwnerStmt, AlterObjectSchemaStmt, and other statements that need object type keywords
+     */
+    private getObjectTypeKeyword;
+    deparse(node: any, context?: DeparserContext): string | null;
+    visit(node: any, context?: DeparserContext): string;
+    getNodeType(node: any): string;
+    getNodeData(node: any): any;
+    ParseResult(node: any, context: DeparserContext): string;
+    RawStmt(node: any, context: DeparserContext): string;
+    SelectStmt(node: any, context: DeparserContext): string;
+    A_Expr(node: any, context: DeparserContext): string;
+    deparseOperatorName(name: any, context: DeparserContext): string;
+    private getOperatorPrecedence;
+    private needsParentheses;
+    private isComplexExpression;
+    private isComplexSelectTarget;
+    visitBetweenRange(rexpr: any, context: DeparserContext): string;
+    InsertStmt(node: any, context: DeparserContext): string;
+    UpdateStmt(node: any, context: DeparserContext): string;
+    formatUpdateAssignments(targets: any[], context: DeparserContext): string;
+    DeleteStmt(node: any, context: DeparserContext): string;
+    WithClause(node: any, context: DeparserContext): string;
+    ResTarget(node: any, context: DeparserContext): string;
+    ATAlterConstraint(node: any, context: DeparserContext): string;
+    deparseKeyAttrs(attrs: any, withPeriod: boolean | undefined, context: DeparserContext): string;
+    ReturningClause(node: any, context: DeparserContext): string;
+    ReturningOption(node: any, context: DeparserContext): string;
+    deparseReturningList(list: any, context: DeparserContext): string;
+    BoolExpr(node: any, context: DeparserContext): string;
+    FuncCall(node: any, context: DeparserContext): string;
+    formatOverClause(over: any, context: DeparserContext): string;
+    FuncExpr(node: any, context: DeparserContext): string;
+    A_Const(node: any, context: DeparserContext): string;
+    ColumnRef(node: any, context: DeparserContext): string;
+    TypeName(node: any, context: DeparserContext): string;
+    Alias(node: any, context: DeparserContext): string;
+    RangeVar(node: any, context: DeparserContext): string;
+    formatIntervalTypeMods(typmods: any, context: DeparserContext): string | null;
+    formatTypeMods(typmods: any, context: DeparserContext): string | null;
+    formatSingleTypeMod(typemod: number, typeName: string): string | null;
+    getPgCatalogTypeName(typeName: string, size: string | null): string;
+    isPgCatalogType(typeName: string): boolean;
+    A_ArrayExpr(node: any, context: DeparserContext): string;
+    A_Indices(node: any, context: DeparserContext): string;
+    A_Indirection(node: any, context: DeparserContext): string;
+    A_Star(node: any, context: DeparserContext): string;
+    CaseExpr(node: any, context: DeparserContext): string;
+    CoalesceExpr(node: any, context: DeparserContext): string;
+    TypeCast(node: any, context: DeparserContext): string;
+    CollateClause(node: any, context: DeparserContext): string;
+    BooleanTest(node: any, context: DeparserContext): string;
+    NullTest(node: any, context: DeparserContext): string;
+    quoteIfNeeded(value: string): string;
+    preserveOperatorDefElemCase(defName: string): string;
+    String(node: any, context: DeparserContext): string;
+    Integer(node: any, context: DeparserContext): string;
+    Float(node: any, context: DeparserContext): string;
+    Boolean(node: any, context: DeparserContext): string;
+    BitString(node: any, context: DeparserContext): string;
+    Null(node: any, context: DeparserContext): string;
+    List(node: any, context: DeparserContext): string;
+    CreateStmt(node: any, context: DeparserContext): string;
+    ColumnDef(node: any, context: DeparserContext): string;
+    Constraint(node: any, context: DeparserContext): string;
+    SubLink(node: any, context: DeparserContext): string;
+    CaseWhen(node: any, context: DeparserContext): string;
+    WindowDef(node: any, context: DeparserContext): string;
+    formatIdentityColumnOptions(def: any, context: DeparserContext): string;
+    needsBExprParens(node: any): boolean;
+    formatWindowFrame(node: any, context: DeparserContext): string | null;
+    SortBy(node: any, context: DeparserContext): string;
+    GroupingSet(node: any, context: DeparserContext): string;
+    CommonTableExpr(node: any, context: DeparserContext): string;
+    formatAexprConst(node: any, context: DeparserContext): string;
+    ParamRef(node: any, context: DeparserContext): string;
+    LockingClause(node: any, context: DeparserContext): string;
+    MinMaxExpr(node: any, context: DeparserContext): string;
+    RowExpr(node: any, context: DeparserContext): string;
+    OpExpr(node: any, context: DeparserContext): string;
+    DistinctExpr(node: any, context: DeparserContext): string;
+    NullIfExpr(node: any, context: DeparserContext): string;
+    ScalarArrayOpExpr(node: any, context: DeparserContext): string;
+    Aggref(node: any, context: DeparserContext): string;
+    WindowFunc(node: any, context: DeparserContext): string;
+    FieldSelect(node: any, context: DeparserContext): string;
+    RelabelType(node: any, context: DeparserContext): string;
+    CoerceViaIO(node: any, context: DeparserContext): string;
+    ArrayCoerceExpr(node: any, context: DeparserContext): string;
+    ConvertRowtypeExpr(node: any, context: DeparserContext): string;
+    NamedArgExpr(node: any, context: DeparserContext): string;
+    ViewStmt(node: any, context: DeparserContext): string;
+    IndexStmt(node: any, context: DeparserContext): string;
+    IndexElem(node: any, context: DeparserContext): string;
+    PartitionElem(node: any, context: DeparserContext): string;
+    PartitionCmd(node: any, context: DeparserContext): string;
+    private getAggFunctionName;
+    private getWindowFunctionName;
+    private getOperatorName;
+    JoinExpr(node: any, context: DeparserContext): string;
+    FromExpr(node: any, context: DeparserContext): string;
+    TransactionStmt(node: any, context: DeparserContext): string;
+    VariableSetStmt(node: any, context: DeparserContext): string;
+    VariableShowStmt(node: any, context: DeparserContext): string;
+    CreateSchemaStmt(node: any, context: DeparserContext): string;
+    RoleSpec(node: any, context: DeparserContext): string;
+    roletype(node: any, context: DeparserContext): string;
+    DropStmt(node: any, context: DeparserContext): string;
+    TruncateStmt(node: any, context: DeparserContext): string;
+    ReturnStmt(node: any, context: DeparserContext): string;
+    PLAssignStmt(node: any, context: DeparserContext): string;
+    CopyStmt(node: any, context: DeparserContext): string;
+    AlterTableStmt(node: any, context: DeparserContext): string;
+    AlterTableCmd(node: any, context: DeparserContext): string;
+    CreateFunctionStmt(node: any, context: DeparserContext): string;
+    FunctionParameter(node: any, context: DeparserContext): string;
+    CreateEnumStmt(node: any, context: DeparserContext): string;
+    CreateDomainStmt(node: any, context: DeparserContext): string;
+    CreateRoleStmt(node: any, context: DeparserContext): string;
+    DefElem(node: any, context: DeparserContext): string;
+    CreateTableSpaceStmt(node: any, context: DeparserContext): string;
+    DropTableSpaceStmt(node: any, context: DeparserContext): string;
+    AlterTableSpaceOptionsStmt(node: any, context: DeparserContext): string;
+    CreateExtensionStmt(node: any, context: DeparserContext): string;
+    AlterExtensionStmt(node: any, context: DeparserContext): string;
+    AlterExtensionContentsStmt(node: any, context: DeparserContext): string;
+    CreateFdwStmt(node: any, context: DeparserContext): string;
+    SetOperationStmt(node: any, context: DeparserContext): string;
+    ReplicaIdentityStmt(node: any, context: DeparserContext): string;
+    AlterCollationStmt(node: any, context: DeparserContext): string;
+    AlterDomainStmt(node: any, context: DeparserContext): string;
+    PrepareStmt(node: any, context: DeparserContext): string;
+    ExecuteStmt(node: any, context: DeparserContext): string;
+    DeallocateStmt(node: any, context: DeparserContext): string;
+    NotifyStmt(node: any, context: DeparserContext): string;
+    ListenStmt(node: any, context: DeparserContext): string;
+    UnlistenStmt(node: any, context: DeparserContext): string;
+    CheckPointStmt(node: any, context: DeparserContext): string;
+    LoadStmt(node: any, context: DeparserContext): string;
+    DiscardStmt(node: any, context: DeparserContext): string;
+    /** `schema.op` for an operator name list: schema parts quoted, the operator symbol as is. */
+    private qualifiedOperatorName;
+    CommentStmt(node: any, context: DeparserContext): string;
+    LockStmt(node: any, context: DeparserContext): string;
+    CreatePolicyStmt(node: any, context: DeparserContext): string;
+    AlterPolicyStmt(node: any, context: DeparserContext): string;
+    CreateUserMappingStmt(node: any, context: DeparserContext): string;
+    CreateStatsStmt(node: any, context: DeparserContext): string;
+    StatsElem(node: any, context: DeparserContext): string;
+    CreatePublicationStmt(node: any, context: DeparserContext): string;
+    CreateSubscriptionStmt(node: any, context: DeparserContext): string;
+    AlterPublicationStmt(node: any, context: DeparserContext): string;
+    AlterSubscriptionStmt(node: any, context: DeparserContext): string;
+    DropSubscriptionStmt(node: any, context: DeparserContext): string;
+    DoStmt(node: any, context: DeparserContext): string;
+    private generateUniqueDollarTag;
+    InlineCodeBlock(node: any, context: DeparserContext): string;
+    CallContext(node: any, context: DeparserContext): string;
+    ConstraintsSetStmt(node: any, context: DeparserContext): string;
+    AlterSystemStmt(node: any, context: DeparserContext): string;
+    VacuumRelation(node: any, context: DeparserContext): string;
+    DropOwnedStmt(node: any, context: DeparserContext): string;
+    ReassignOwnedStmt(node: any, context: DeparserContext): string;
+    AlterTSDictionaryStmt(node: any, context: DeparserContext): string;
+    AlterTSConfigurationStmt(node: any, context: DeparserContext): string;
+    ClosePortalStmt(node: any, context: DeparserContext): string;
+    FetchStmt(node: any, context: DeparserContext): string;
+    AlterStatsStmt(node: any, context: DeparserContext): string;
+    ObjectWithArgs(node: any, context: DeparserContext): string;
+    AlterOperatorStmt(node: any, context: DeparserContext): string;
+    AlterFdwStmt(node: any, context: DeparserContext): string;
+    CreateForeignServerStmt(node: any, context: DeparserContext): string;
+    AlterForeignServerStmt(node: any, context: DeparserContext): string;
+    AlterUserMappingStmt(node: any, context: DeparserContext): string;
+    DropUserMappingStmt(node: any, context: DeparserContext): string;
+    ImportForeignSchemaStmt(node: any, context: DeparserContext): string;
+    ClusterStmt(node: any, context: DeparserContext): string;
+    VacuumStmt(node: any, context: DeparserContext): string;
+    ExplainStmt(node: any, context: DeparserContext): string;
+    ReindexStmt(node: any, context: DeparserContext): string;
+    CallStmt(node: any, context: DeparserContext): string;
+    CreatedbStmt(node: any, context: DeparserContext): string;
+    DropdbStmt(node: any, context: DeparserContext): string;
+    RenameStmt(node: any, context: DeparserContext): string;
+    AlterOwnerStmt(node: any, context: DeparserContext): string;
+    GrantStmt(node: any, context: DeparserContext): string;
+    GrantRoleStmt(node: any, context: DeparserContext): string;
+    SecLabelStmt(node: any, context: DeparserContext): string;
+    AlterDefaultPrivilegesStmt(node: any, context: DeparserContext): string;
+    CreateConversionStmt(node: any, context: DeparserContext): string;
+    CreateCastStmt(node: any, context: DeparserContext): string;
+    CreatePLangStmt(node: any, context: DeparserContext): string;
+    CreateTransformStmt(node: any, context: DeparserContext): string;
+    CreateTrigStmt(node: any, context: DeparserContext): string;
+    TriggerTransition(node: any, context: DeparserContext): string;
+    CreateEventTrigStmt(node: any, context: DeparserContext): string;
+    AlterEventTrigStmt(node: any, context: DeparserContext): string;
+    CreateOpClassStmt(node: any, context: DeparserContext): string;
+    CreateOpFamilyStmt(node: any, context: DeparserContext): string;
+    AlterOpFamilyStmt(node: any, context: DeparserContext): string;
+    MergeStmt(node: any, context: DeparserContext): string;
+    MergeSupportFunc(node: any, context: DeparserContext): string;
+    MergeWhenClause(node: any, context: DeparserContext): string;
+    AlterTableMoveAllStmt(node: any, context: DeparserContext): string;
+    CreateSeqStmt(node: any, context: DeparserContext): string;
+    AlterSeqStmt(node: any, context: DeparserContext): string;
+    CompositeTypeStmt(node: any, context: DeparserContext): string;
+    CreateRangeStmt(node: any, context: DeparserContext): string;
+    AlterEnumStmt(node: any, context: DeparserContext): string;
+    AlterTypeStmt(node: any, context: DeparserContext): string;
+    AlterRoleStmt(node: any, context: DeparserContext): string;
+    DropRoleStmt(node: any, context: DeparserContext): string;
+    targetList(node: any, context: DeparserContext): string;
+    CreateAggregateStmt(node: any, context: DeparserContext): string;
+    CreateTableAsStmt(node: any, context: DeparserContext): string;
+    RefreshMatViewStmt(node: any, context: DeparserContext): string;
+    AccessPriv(node: any, context: DeparserContext): string;
+    aliasname(node: any, context: DeparserContext): string;
+    DefineStmt(node: any, context: DeparserContext): string;
+    AlterDatabaseStmt(node: any, context: DeparserContext): string;
+    AlterDatabaseRefreshCollStmt(node: any, context: DeparserContext): string;
+    AlterDatabaseSetStmt(node: any, context: DeparserContext): string;
+    DeclareCursorStmt(node: any, context: DeparserContext): string;
+    PublicationObjSpec(node: any, context: DeparserContext): string;
+    PublicationTable(node: any, context: DeparserContext): string;
+    CreateAmStmt(node: any, context: DeparserContext): string;
+    IntoClause(node: any, context: DeparserContext): string;
+    OnConflictExpr(node: any, context: DeparserContext): string;
+    ScanToken(node: any, context: DeparserContext): string;
+    CreateOpClassItem(node: any, context: DeparserContext): string;
+    private quoteDefElemArg;
+    private formatOptionValue;
+    Var(node: any, context: DeparserContext): string;
+    TableFunc(node: any, context: DeparserContext): string;
+    RangeTableFunc(node: any, context: DeparserContext): string;
+    private formatXmlTableExpr;
+    RangeTableFuncCol(node: any, context: DeparserContext): string;
+    formatJsonFormat(format: any): string | null;
+    formatJsonOutput(output: any, context: DeparserContext): string | null;
+    formatJsonNullClause(absentOnNull: boolean | undefined): string;
+    formatJsonUniqueClause(unique: boolean | undefined): string | null;
+    JsonValueExpr(node: any, context: DeparserContext): string;
+    JsonKeyValue(node: any, context: DeparserContext): string;
+    JsonObjectConstructor(node: any, context: DeparserContext): string;
+    JsonArrayConstructor(node: any, context: DeparserContext): string;
+    JsonArrayQueryConstructor(node: any, context: DeparserContext): string;
+    formatJsonAggSuffix(ctor: any, context: DeparserContext): string;
+    JsonObjectAgg(node: any, context: DeparserContext): string;
+    JsonArrayAgg(node: any, context: DeparserContext): string;
+    JsonParseExpr(node: any, context: DeparserContext): string;
+    JsonScalarExpr(node: any, context: DeparserContext): string;
+    JsonSerializeExpr(node: any, context: DeparserContext): string;
+    JsonIsPredicate(node: any, context: DeparserContext): string;
+    RangeFunction(node: any, context: DeparserContext): string;
+    XmlExpr(node: any, context: DeparserContext): string;
+    schemaname(node: any, context: DeparserContext): string;
+    RangeTableSample(node: any, context: DeparserContext): string;
+    XmlSerialize(node: any, context: DeparserContext): string;
+    ctes(node: any, context: DeparserContext): string;
+    RuleStmt(node: any, context: DeparserContext): string;
+    RangeSubselect(node: any, context: DeparserContext): string;
+    relname(node: any, context: DeparserContext): string;
+    rel(node: any, context: DeparserContext): string;
+    objname(node: any, context: DeparserContext): string;
+    SQLValueFunction(node: any, context: DeparserContext): string;
+    GroupingFunc(node: any, context: DeparserContext): string;
+    MultiAssignRef(node: any, context: DeparserContext): string;
+    SetToDefault(node: any, context: DeparserContext): string;
+    CurrentOfExpr(node: any, context: DeparserContext): string;
+    TableLikeClause(node: any, context: DeparserContext): string;
+    AlterFunctionStmt(node: any, context: DeparserContext): string;
+    AlterObjectSchemaStmt(node: any, context: DeparserContext): string;
+    AlterRoleSetStmt(node: any, context: DeparserContext): string;
+    CreateForeignTableStmt(node: any, context: DeparserContext): string;
+}