rake-db 2.30.6 → 2.30.8

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as pqb from 'pqb';
-import { SearchWeight, RecordOptionalString, AdapterBase, TableData, ColumnsShape, NoPrimaryKeyOption, MaybeArray, Column, RawSqlBase, RecordString, EnumColumn, EmptyObject, DbResult, DefaultColumnTypes, DefaultSchemaConfig, QueryLogObject, TableDataFn, TableDataItem, DbDomainArg, ColumnSchemaConfig, raw, Db, QuerySchema, MaybePromise, QueryLogOptions, QueryLogger, ColumnsByType, DbStructureDomainsMap } from 'pqb';
+import { SearchWeight, RecordOptionalString, DefaultPrivileges, AdapterBase, TableData, ColumnsShape, NoPrimaryKeyOption, MaybeArray, Column, RawSqlBase, RecordString, EnumColumn, EmptyObject, DbResult, DefaultColumnTypes, DefaultSchemaConfig, QueryLogObject, TableDataFn, TableDataItem, DbDomainArg, ColumnSchemaConfig, raw, Db, QuerySchema, MaybePromise, QueryLogOptions, QueryLogger, ColumnsByType, DbStructureDomainsMap } from 'pqb';
 
 declare namespace DbStructure {
     interface TableNameAndSchemaName {
@@ -162,8 +162,23 @@ declare namespace DbStructure {
         bypassRls: boolean;
         config?: RecordOptionalString;
     }
+    interface DefaultPrivilegeConfig {
+        privilege: string;
+        isGrantable: boolean;
+    }
+    interface DefaultPrivilegeObjectConfig {
+        object: DefaultPrivileges.ObjectType;
+        privilegeConfigs: DefaultPrivilegeConfig[];
+    }
+    interface DefaultPrivilege {
+        owner?: string;
+        grantee: string;
+        schema?: string;
+        objectConfigs: DefaultPrivilegeObjectConfig[];
+    }
 }
 interface IntrospectedStructure {
+    version: number;
     schemas: string[];
     tables: DbStructure.Table[];
     views: DbStructure.View[];
@@ -176,18 +191,21 @@ interface IntrospectedStructure {
     domains: DbStructure.Domain[];
     collations: DbStructure.Collation[];
     roles?: DbStructure.Role[];
+    defaultPrivileges?: DbStructure.DefaultPrivilege[];
     managedRolesSql?: string;
 }
 interface IntrospectDbStructureParams {
     roles?: {
         whereSql?: string;
     };
+    loadDefaultPrivileges?: boolean;
 }
+declare function getDbVersion(db: AdapterBase): Promise<number>;
 declare function introspectDbSchema(db: AdapterBase, params?: IntrospectDbStructureParams): Promise<IntrospectedStructure>;
 
-type RakeDbAst = RakeDbAst.Table | RakeDbAst.ChangeTable | RakeDbAst.RenameType | RakeDbAst.Schema | RakeDbAst.RenameSchema | RakeDbAst.Extension | RakeDbAst.Enum | RakeDbAst.EnumValues | RakeDbAst.RenameEnumValues | RakeDbAst.ChangeEnumValues | RakeDbAst.Domain | RakeDbAst.Collation | RakeDbAst.Constraint | RakeDbAst.RenameTableItem | RakeDbAst.View | RakeDbAst.Role | RakeDbAst.RenameRole | RakeDbAst.ChangeRole;
+type RakeDbAst = RakeDbAst.Table | RakeDbAst.ChangeTable | RakeDbAst.RenameType | RakeDbAst.Schema | RakeDbAst.RenameSchema | RakeDbAst.Extension | RakeDbAst.Enum | RakeDbAst.EnumValues | RakeDbAst.RenameEnumValues | RakeDbAst.ChangeEnumValues | RakeDbAst.Domain | RakeDbAst.Collation | RakeDbAst.Constraint | RakeDbAst.RenameTableItem | RakeDbAst.View | RakeDbAst.Role | RakeDbAst.RenameRole | RakeDbAst.ChangeRole | RakeDbAst.DefaultPrivilege;
 declare namespace RakeDbAst {
-    interface Table extends TableData {
+    export interface Table extends TableData {
         type: 'table';
         action: 'create' | 'drop';
         schema?: string;
@@ -199,7 +217,7 @@ declare namespace RakeDbAst {
         dropMode?: DropMode;
         comment?: string;
     }
-    interface ChangeTable {
+    export interface ChangeTable {
         type: 'changeTable';
         schema?: string;
         name: string;
@@ -208,9 +226,9 @@ declare namespace RakeDbAst {
         add: TableData;
         drop: TableData;
     }
-    type ChangeTableShape = Record<string, MaybeArray<ChangeTableItem>>;
-    type ChangeTableItem = ChangeTableItem.Column | ChangeTableItem.Change | ChangeTableItem.Rename;
-    namespace ChangeTableItem {
+    export type ChangeTableShape = Record<string, MaybeArray<ChangeTableItem>>;
+    export type ChangeTableItem = ChangeTableItem.Column | ChangeTableItem.Change | ChangeTableItem.Rename;
+    export namespace ChangeTableItem {
         interface Column {
             type: 'add' | 'drop';
             item: Column;
@@ -232,7 +250,7 @@ declare namespace RakeDbAst {
             name: string;
         }
     }
-    interface ColumnChange {
+    export interface ColumnChange {
         column?: Column;
         type?: string;
         collate?: string;
@@ -247,7 +265,7 @@ declare namespace RakeDbAst {
         excludes?: TableData.ColumnExclude[];
         identity?: TableData.Identity;
     }
-    interface RenameType {
+    export interface RenameType {
         type: 'renameType';
         kind: 'TABLE' | 'TYPE' | 'DOMAIN';
         fromSchema?: string;
@@ -255,29 +273,29 @@ declare namespace RakeDbAst {
         toSchema?: string;
         to: string;
     }
-    interface Schema {
+    export interface Schema {
         type: 'schema';
         action: 'create' | 'drop';
         name: string;
     }
-    interface RenameSchema {
+    export interface RenameSchema {
         type: 'renameSchema';
         from: string;
         to: string;
     }
-    interface ExtensionArg {
+    export interface ExtensionArg {
         version?: string;
         cascade?: boolean;
         createIfNotExists?: boolean;
         dropIfExists?: boolean;
     }
-    interface Extension extends ExtensionArg {
+    export interface Extension extends ExtensionArg {
         type: 'extension';
         action: 'create' | 'drop';
         schema?: string;
         name: string;
     }
-    interface Enum {
+    export interface Enum {
         type: 'enum';
         action: 'create' | 'drop';
         schema?: string;
@@ -286,7 +304,7 @@ declare namespace RakeDbAst {
         cascade?: boolean;
         dropIfExists?: boolean;
     }
-    interface EnumValues {
+    export interface EnumValues {
         type: 'enumValues';
         action: 'add' | 'drop';
         schema?: string;
@@ -296,27 +314,27 @@ declare namespace RakeDbAst {
         relativeTo?: string;
         ifNotExists?: boolean;
     }
-    interface RenameEnumValues {
+    export interface RenameEnumValues {
         type: 'renameEnumValues';
         schema?: string;
         name: string;
         values: RecordString;
     }
-    interface ChangeEnumValues {
+    export interface ChangeEnumValues {
         type: 'changeEnumValues';
         schema?: string;
         name: string;
         fromValues: string[];
         toValues: string[];
     }
-    interface Domain {
+    export interface Domain {
         type: 'domain';
         action: 'create' | 'drop';
         schema?: string;
         name: string;
         baseType: Column;
     }
-    interface Collation {
+    export interface Collation {
         type: 'collation';
         action: 'create' | 'drop';
         schema?: string;
@@ -332,17 +350,17 @@ declare namespace RakeDbAst {
         dropIfExists?: boolean;
         cascade?: boolean;
     }
-    interface EnumOptions {
+    export interface EnumOptions {
         createIfNotExists?: boolean;
         dropIfExists?: boolean;
     }
-    interface Constraint extends TableData.Constraint {
+    export interface Constraint extends TableData.Constraint {
         type: 'constraint';
         action: 'create' | 'drop';
         tableSchema?: string;
         tableName: string;
     }
-    interface RenameTableItem {
+    export interface RenameTableItem {
         type: 'renameTableItem';
         kind: 'INDEX' | 'CONSTRAINT';
         tableSchema?: string;
@@ -350,7 +368,7 @@ declare namespace RakeDbAst {
         from: string;
         to: string;
     }
-    interface View {
+    export interface View {
         type: 'view';
         action: 'create' | 'drop';
         schema?: string;
@@ -363,7 +381,7 @@ declare namespace RakeDbAst {
             name: string;
         }[];
     }
-    interface ViewOptions {
+    export interface ViewOptions {
         createOrReplace?: boolean;
         dropIfExists?: boolean;
         dropMode?: DropMode;
@@ -376,21 +394,42 @@ declare namespace RakeDbAst {
             securityInvoker?: boolean;
         };
     }
-    interface Role extends DbStructure.Role {
+    export interface Role extends DbStructure.Role {
         type: 'role';
         action: 'create' | 'drop';
     }
-    interface RenameRole {
+    export interface RenameRole {
         type: 'renameRole';
         from: string;
         to: string;
     }
-    interface ChangeRole {
+    export interface ChangeRole {
         type: 'changeRole';
         name: string;
         from: Partial<DbStructure.Role>;
         to: Partial<DbStructure.Role>;
     }
+    interface DefaultPrivilegeSetting {
+        privileges?: string[];
+        grantablePrivileges?: string[];
+    }
+    export interface DefaultPrivilegeObjectConfig {
+        tables?: DefaultPrivilegeSetting;
+        sequences?: DefaultPrivilegeSetting;
+        functions?: DefaultPrivilegeSetting;
+        types?: DefaultPrivilegeSetting;
+        schemas?: DefaultPrivilegeSetting;
+        largeObjects?: DefaultPrivilegeSetting;
+    }
+    export interface DefaultPrivilege {
+        type: 'defaultPrivilege';
+        owner?: string;
+        grantee: string;
+        schema?: string;
+        grant?: DefaultPrivilegeObjectConfig;
+        revoke?: DefaultPrivilegeObjectConfig;
+    }
+    export {  };
 }
 
 declare function add(item: Column, options?: {
@@ -468,6 +507,28 @@ declare const tableChangeMethods: {
 type TableChanger<CT> = MigrationColumnTypes<CT> & TableChangeMethods;
 type TableChangeData = Record<string, RakeDbAst.ChangeTableItem.Column | RakeDbAst.ChangeTableItem.Rename | Change | SpecialChange | Column.Pick.Data>;
 
+interface DefaultPrivilegeObjectSetting<T> {
+    privileges?: readonly T[];
+    grantablePrivileges?: readonly T[];
+}
+interface DefaultPrivilegeObjectConfig {
+    all?: boolean;
+    allGrantable?: boolean;
+    tables?: DefaultPrivilegeObjectSetting<DefaultPrivileges.Privilege['Table']>;
+    sequences?: DefaultPrivilegeObjectSetting<DefaultPrivileges.Privilege['Sequence']>;
+    functions?: DefaultPrivilegeObjectSetting<DefaultPrivileges.Privilege['Function']>;
+    types?: DefaultPrivilegeObjectSetting<DefaultPrivileges.Privilege['Type']>;
+    schemas?: DefaultPrivilegeObjectSetting<DefaultPrivileges.Privilege['Schema']>;
+    largeObjects?: DefaultPrivilegeObjectSetting<DefaultPrivileges.Privilege['LargeObject']>;
+}
+interface ChangeDefaultPrivilegesArg {
+    owner?: string;
+    grantee: string;
+    schema?: string;
+    grant?: DefaultPrivilegeObjectConfig;
+    revoke?: DefaultPrivilegeObjectConfig;
+}
+
 type DropMode = 'CASCADE' | 'RESTRICT';
 type TableOptions = {
     createIfNotExists?: boolean;
@@ -1416,6 +1477,7 @@ declare class Migration<CT = unknown> {
         from?: Partial<DbStructure.Role>;
         to: Partial<DbStructure.Role>;
     }): Promise<void>;
+    changeDefaultPrivileges(params: ChangeDefaultPrivilegesArg): Promise<void>;
 }
 interface AddEnumValueOptions {
     ifNotExists?: boolean;
@@ -1891,4 +1953,4 @@ declare const dropTable: (db: DbParam, sql: string) => Promise<'done' | 'already
 declare class RakeDbError extends Error {
 }
 
-export { type ChangeCallback, type DbMigration, DbStructure, type IntrospectedStructure, RakeDbAst, type RakeDbChangeFn, type RakeDbCliConfigInput, type RakeDbConfig, RakeDbError, type RakeDbFn, type SilentQueries, type StructureToAstCtx, type StructureToAstTableData, astToMigration, concatSchemaAndName, createDatabase, createMigrationInterface, createMigrationsSchemaAndTable, createSchema, createTable, dbColumnToAst, dropDatabase, dropSchema, dropTable, encodeColumnDefault, getConstraintName, getDbStructureTableData, getDbTableColumnsChecks, getExcludeName, getIndexName, getMigrationsSchemaAndTable, getSchemaAndTableFromName, incrementIntermediateCaller, instantiateDbColumn, introspectDbSchema, makeDomainsMap, makeFileVersion, makeRakeDbConfig, makeStructureToAstCtx, migrate, migrateAndClose, migrationConfigDefaults, promptSelect, rakeDbCliWithAdapter, rakeDbCommands, redo, rollback, runMigration, saveMigratedVersion, setRakeDbCliRunFn, structureToAst, tableToAst, writeMigrationFile };
+export { type ChangeCallback, type DbMigration, DbStructure, type IntrospectedStructure, RakeDbAst, type RakeDbChangeFn, type RakeDbCliConfigInput, type RakeDbConfig, RakeDbError, type RakeDbFn, type SilentQueries, type StructureToAstCtx, type StructureToAstTableData, astToMigration, concatSchemaAndName, createDatabase, createMigrationInterface, createMigrationsSchemaAndTable, createSchema, createTable, dbColumnToAst, dropDatabase, dropSchema, dropTable, encodeColumnDefault, getConstraintName, getDbStructureTableData, getDbTableColumnsChecks, getDbVersion, getExcludeName, getIndexName, getMigrationsSchemaAndTable, getSchemaAndTableFromName, incrementIntermediateCaller, instantiateDbColumn, introspectDbSchema, makeDomainsMap, makeFileVersion, makeRakeDbConfig, makeStructureToAstCtx, migrate, migrateAndClose, migrationConfigDefaults, promptSelect, rakeDbCliWithAdapter, rakeDbCommands, redo, rollback, runMigration, saveMigratedVersion, setRakeDbCliRunFn, structureToAst, tableToAst, writeMigrationFile };