rake-db 2.34.1 → 2.35.0

package/dist/index.d.ts

@@ -1,13 +1,24 @@
-import { Adapter, Column as Column$1, ColumnSchemaConfig, ColumnsByType, ColumnsShape, DbDomainArg, DbResult, DbStructureDomainsMap, DefaultColumnTypes, DefaultPrivileges, DefaultSchemaConfig, EmptyObject, EnumColumn, MaybeArray, MaybePromise, NoPrimaryKeyOption, NonUniqDataItem, QueryLogObject, QueryLogOptions, QueryLogger, QuerySchema, RawSqlBase, RecordOptionalString, RecordString, SearchWeight, TableData, TableDataFn, TableDataItem, TableDataMethods, raw } from "pqb/internal";
+import { Adapter, Column as Column$1, ColumnSchemaConfig, ColumnsByType, ColumnsShape, DbDomainArg, DbResult, DbStructureDomainsMap, DefaultColumnTypes, DefaultPrivileges, DefaultSchemaConfig, EmptyObject, EnumColumn, Grant, MaybeArray, MaybePromise, NoPrimaryKeyOption, NonUniqDataItem, QueryLogObject, QueryLogOptions, QueryLogger, QuerySchema, RawSqlBase, RecordOptionalString, RecordString, RlsPolicy, SearchWeight, TableData, TableDataFn, TableDataItem, TableDataMethods, raw } from "pqb/internal";
 import { Db } from "pqb";
 declare namespace DbStructure {
   interface TableNameAndSchemaName {
     schemaName: string;
     tableName: string;
   }
+  type RlsPolicyMode = RlsPolicy.PolicyMode;
+  type RlsPolicyCommand = RlsPolicy.PolicyCommand;
+  interface RlsPolicy extends TableNameAndSchemaName {
+    name: string;
+    mode: RlsPolicyMode;
+    command: RlsPolicyCommand;
+    roles: string[];
+    using?: string;
+    withCheck?: string;
+  }
   interface TableRls {
     enable: boolean;
     force: boolean;
+    policies?: RlsPolicy[];
   }
   interface Table {
     schemaName: string;
@@ -180,6 +191,7 @@ declare namespace DbStructure {
     schema?: string;
     objectConfigs: DefaultPrivilegeObjectConfig[];
   }
+  type Grant = Grant.InternalPrivilege;
 }
 interface IntrospectedStructure {
   version: number;
@@ -196,6 +208,7 @@ interface IntrospectedStructure {
   collations: DbStructure.Collation[];
   roles?: DbStructure.Role[];
   defaultPrivileges?: DbStructure.DefaultPrivilege[];
+  grants?: DbStructure.Grant[];
   managedRolesSql?: string;
 }
 interface IntrospectDbStructureParams {
@@ -204,10 +217,11 @@ interface IntrospectDbStructureParams {
     whereSql?: string;
   };
   loadDefaultPrivileges?: boolean;
+  loadGrants?: boolean;
 }
 declare function getDbVersion(db: Adapter): Promise<number>;
 declare function introspectDbSchema(db: Adapter, 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 | RakeDbAst.DefaultPrivilege | RakeDbAst.TableRls;
+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 | RakeDbAst.TableRls | RakeDbAst.Policy | RakeDbAst.PolicyChange | RakeDbAst.Grant;
 declare namespace RakeDbAst {
   export interface Table extends TableData {
     type: 'table';
@@ -440,6 +454,42 @@ declare namespace RakeDbAst {
     schema?: string;
     table: string;
   }
+  export interface PolicyDefinition {
+    as: RlsPolicy.PolicyMode;
+    for?: RlsPolicy.PolicyCommand;
+    to?: string[];
+    using?: string;
+    withCheck?: string;
+  }
+  export interface PolicyChangeDefinition {
+    table?: string;
+    name?: string;
+    as?: RlsPolicy.PolicyMode;
+    for?: RlsPolicy.PolicyCommand;
+    to?: string[];
+    using?: string;
+    withCheck?: string;
+  }
+  export interface Policy extends PolicyDefinition {
+    type: 'policy';
+    action: 'create' | 'drop';
+    schema?: string;
+    table: string;
+    name: string;
+  }
+  export interface PolicyChange {
+    type: 'changePolicy';
+    schema?: string;
+    table: string;
+    name: string;
+    from: PolicyChangeDefinition;
+    to: PolicyChangeDefinition;
+  }
+  export interface Grant extends Grant.InternalPrivilege {
+    type: 'grant';
+    action: 'grant' | 'revoke';
+    revokeMode?: 'CASCADE' | 'RESTRICT';
+  }
   export {};
 }
 interface TableMethods {
@@ -536,6 +586,47 @@ interface ChangeDefaultPrivilegesArg {
   grant?: DefaultPrivilegeObjectConfig$1;
   revoke?: DefaultPrivilegeObjectConfig$1;
 }
+interface RlsPolicyForSelectOrDelete {
+  for: 'SELECT' | 'DELETE';
+  using: RawSqlBase;
+  withCheck?: never;
+}
+interface RlsPolicyForInsert {
+  for: 'INSERT';
+  using?: never;
+  withCheck: RawSqlBase;
+}
+interface RlsPolicyForAllOrUpdate {
+  for?: 'ALL' | 'UPDATE';
+  using: RawSqlBase;
+  withCheck: RawSqlBase;
+}
+type RlsPolicyExpressions = RlsPolicyForSelectOrDelete | RlsPolicyForInsert | RlsPolicyForAllOrUpdate;
+type RlsPolicyDefinition = RlsPolicyExpressions & {
+  as: RlsPolicy.PolicyMode;
+  to?: string | string[];
+};
+interface ChangeRlsPolicyAlterDefinition {
+  name?: string;
+  to?: string | string[];
+  using?: RawSqlBase;
+  withCheck?: RawSqlBase;
+}
+type ChangeRlsPolicyRecreateDefinition = RlsPolicyDefinition & {
+  table?: string;
+  name?: string;
+};
+type ChangeRlsPolicyParams = {
+  from: ChangeRlsPolicyAlterDefinition;
+  to: ChangeRlsPolicyAlterDefinition;
+} | {
+  from: ChangeRlsPolicyRecreateDefinition;
+  to: ChangeRlsPolicyRecreateDefinition;
+};
+type RevokeMode = 'CASCADE' | 'RESTRICT';
+type GrantMigrationArg = Grant.Privilege & {
+  revokeMode?: RevokeMode;
+};
 type DropMode = 'CASCADE' | 'RESTRICT';
 type TableOptions = {
   createIfNotExists?: boolean;
@@ -1496,6 +1587,11 @@ declare class Migration<CT = unknown> {
   disableRls(tableName: string): Promise<void>;
   forceRls(tableName: string): Promise<void>;
   noForceRls(tableName: string): Promise<void>;
+  createPolicy(tableName: string, policyName: string, params: RlsPolicyDefinition): Promise<void>;
+  dropPolicy(tableName: string, policyName: string, params: RlsPolicyDefinition): Promise<void>;
+  changePolicy(tableName: string, policyName: string, params: ChangeRlsPolicyParams): Promise<void>;
+  grant(params: GrantMigrationArg): Promise<void>;
+  revoke(params: GrantMigrationArg): Promise<void>;
 }
 interface AddEnumValueOptions {
   ifNotExists?: boolean;