feat: policy editor — accordion, what-if dry-eval, view-aware warnings, budget labeling (A1/A5/A3/1.4/3.3) (#933)

Synced from sferarc/pgbeam@7f3c13f

Author: SferaDev

src/generated/index.ts

@@ -43,6 +43,10 @@ export type { DeleteReplicaPathDatabaseId, DeleteReplicaPathReplicaId, DeleteRep
 export type { DeleteWebhookEndpointPathProjectId, DeleteWebhookEndpointPathWebhookId, DeleteWebhookEndpointRequestConfig, DeleteWebhookEndpointResponse, DeleteWebhookEndpointResponses, DeleteWebhookEndpointStatus204, DeleteWebhookEndpointStatus400, DeleteWebhookEndpointStatus401, DeleteWebhookEndpointStatus403, DeleteWebhookEndpointStatus404 } from "./types/DeleteWebhookEndpoint";
 export type { DiscardDatabaseBranchPathBranchId, DiscardDatabaseBranchPathProjectId, DiscardDatabaseBranchRequestConfig, DiscardDatabaseBranchResponse, DiscardDatabaseBranchResponses, DiscardDatabaseBranchStatus204, DiscardDatabaseBranchStatus400, DiscardDatabaseBranchStatus401, DiscardDatabaseBranchStatus403, DiscardDatabaseBranchStatus404 } from "./types/DiscardDatabaseBranch";
 export type { DnsInstructions } from "./types/DnsInstructions";
+export type { DryEvalInput } from "./types/DryEvalInput";
+export type { DryEvalMaskedColumn, DryEvalMaskedColumnKindEnumKey } from "./types/DryEvalMaskedColumn";
+export type { DryEvalPolicyData, DryEvalPolicyPathProjectId, DryEvalPolicyRequestConfig, DryEvalPolicyResponse, DryEvalPolicyResponses, DryEvalPolicyStatus200, DryEvalPolicyStatus400, DryEvalPolicyStatus401, DryEvalPolicyStatus403, DryEvalPolicyStatus404, DryEvalPolicyStatus429 } from "./types/DryEvalPolicy";
+export type { DryEvalResult, DryEvalResultVerdictEnumKey } from "./types/DryEvalResult";
 export type { Error } from "./types/Error";
 export type { ExportAccountDataRequestConfig, ExportAccountDataResponse, ExportAccountDataResponses, ExportAccountDataStatus200, ExportAccountDataStatus401, ExportAccountDataStatus404, ExportAccountDataStatus429 } from "./types/ExportAccountData";
 export type { ExportAuditLogsPathProjectId, ExportAuditLogsQueryCredentialId, ExportAuditLogsQueryDecision, ExportAuditLogsQueryEnd, ExportAuditLogsQueryEvent, ExportAuditLogsQuerySource, ExportAuditLogsQueryStart, ExportAuditLogsRequestConfig, ExportAuditLogsResponse, ExportAuditLogsResponses, ExportAuditLogsStatus200, ExportAuditLogsStatus400, ExportAuditLogsStatus401, ExportAuditLogsStatus403, ExportAuditLogsStatus404, ExportAuditLogsStatus429 } from "./types/ExportAuditLogs";
@@ -57,6 +61,7 @@ export type { GetProjectPathProjectId, GetProjectRequestConfig, GetProjectRespon
 export type { GetProjectInsightsPathProjectId, GetProjectInsightsQueryLimit, GetProjectInsightsQueryRange, GetProjectInsightsRequestConfig, GetProjectInsightsResponse, GetProjectInsightsResponses, GetProjectInsightsStatus200, GetProjectInsightsStatus400, GetProjectInsightsStatus401, GetProjectInsightsStatus404, GetProjectInsightsStatus429 } from "./types/GetProjectInsights";
 export type { GetProjectMetricsPathProjectId, GetProjectMetricsQueryLimit, GetProjectMetricsQueryRegion, GetProjectMetricsRequestConfig, GetProjectMetricsResponse, GetProjectMetricsResponses, GetProjectMetricsStatus200, GetProjectMetricsStatus400, GetProjectMetricsStatus401, GetProjectMetricsStatus404, GetProjectMetricsStatus429 } from "./types/GetProjectMetrics";
 export type { GetProjectUsagePathProjectId, GetProjectUsageQueryEndDate, GetProjectUsageQueryStartDate, GetProjectUsageRequestConfig, GetProjectUsageResponse, GetProjectUsageResponses, GetProjectUsageStatus200, GetProjectUsageStatus400, GetProjectUsageStatus401, GetProjectUsageStatus404, GetProjectUsageStatus429 } from "./types/GetProjectUsage";
+export type { GetSchemaCatalogPathDatabaseId, GetSchemaCatalogPathProjectId, GetSchemaCatalogRequestConfig, GetSchemaCatalogResponse, GetSchemaCatalogResponses, GetSchemaCatalogStatus200, GetSchemaCatalogStatus400, GetSchemaCatalogStatus401, GetSchemaCatalogStatus403, GetSchemaCatalogStatus404, GetSchemaCatalogStatus429 } from "./types/GetSchemaCatalog";
 export type { GetSupportCasePathCaseId, GetSupportCasePathOrgId, GetSupportCaseRequestConfig, GetSupportCaseResponses, GetSupportCaseStatus200, GetSupportCaseStatus400, GetSupportCaseStatus401, GetSupportCaseStatus403, GetSupportCaseStatus404 } from "./types/GetSupportCase";
 export type { GetSupportCaseResponse } from "./types/GetSupportCaseResponse";
 export type { GetWebhookEndpointPathProjectId, GetWebhookEndpointPathWebhookId, GetWebhookEndpointRequestConfig, GetWebhookEndpointResponse, GetWebhookEndpointResponses, GetWebhookEndpointStatus200, GetWebhookEndpointStatus400, GetWebhookEndpointStatus401, GetWebhookEndpointStatus403, GetWebhookEndpointStatus404 } from "./types/GetWebhookEndpoint";
@@ -127,6 +132,9 @@ export type { RowFilter } from "./types/RowFilter";
 export type { SSLModeKey } from "./types/SSLMode";
 export type { ScanDatabaseForPiiPathDatabaseId, ScanDatabaseForPiiPathProjectId, ScanDatabaseForPiiRequestConfig, ScanDatabaseForPiiResponse, ScanDatabaseForPiiResponses, ScanDatabaseForPiiStatus200, ScanDatabaseForPiiStatus400, ScanDatabaseForPiiStatus401, ScanDatabaseForPiiStatus403, ScanDatabaseForPiiStatus404, ScanDatabaseForPiiStatus429 } from "./types/ScanDatabaseForPii";
 export type { ScanPiiResult } from "./types/ScanPiiResult";
+export type { SchemaCatalog } from "./types/SchemaCatalog";
+export type { SchemaCatalogColumn } from "./types/SchemaCatalogColumn";
+export type { SchemaCatalogRelation, SchemaCatalogRelationKindEnumKey } from "./types/SchemaCatalogRelation";
 export type { SlackEventPayload } from "./types/SlackEventPayload";
 export type { StatementRules } from "./types/StatementRules";
 export type { SubmitCancellationFeedbackData, SubmitCancellationFeedbackPathOrgId, SubmitCancellationFeedbackRequestConfig, SubmitCancellationFeedbackResponse, SubmitCancellationFeedbackResponses, SubmitCancellationFeedbackStatus204, SubmitCancellationFeedbackStatus400, SubmitCancellationFeedbackStatus401, SubmitCancellationFeedbackStatus403, SubmitCancellationFeedbackStatus429 } from "./types/SubmitCancellationFeedback";
@@ -172,6 +180,8 @@ export { createAgentCredentialRequestPrincipalTypeEnum } from "./types/CreateAge
 export { createProjectRequestCloudEnum } from "./types/CreateProjectRequest";
 export { databaseBranchStatusEnum } from "./types/DatabaseBranch";
 export { databaseRole } from "./types/DatabaseRole";
+export { dryEvalMaskedColumnKindEnum } from "./types/DryEvalMaskedColumn";
+export { dryEvalResultVerdictEnum } from "./types/DryEvalResult";
 export { healthResponseStatusEnum } from "./types/HealthResponse";
 export { maskingRuleKindEnum } from "./types/MaskingRule";
 export { mcpRequestJsonrpcEnum, mcpRequestMethodEnum } from "./types/McpRequest";
@@ -186,6 +196,7 @@ export { projectCloudEnum } from "./types/Project";
 export { projectStatus } from "./types/ProjectStatus";
 export { regionProviderEnum, regionStatusEnum } from "./types/Region";
 export { SSLMode } from "./types/SSLMode";
+export { schemaCatalogRelationKindEnum } from "./types/SchemaCatalogRelation";
 export { supportCaseStatus } from "./types/SupportCaseStatus";
 export { supportMessageSource } from "./types/SupportMessageSource";
 export { updateAgentCredentialStatusRequestStatusEnum } from "./types/UpdateAgentCredentialStatusRequest";

src/generated/operations-map.gen.ts

@@ -32,6 +32,7 @@ import type { UpdateDatabaseRequestConfig, UpdateDatabaseStatus200 } from "./typ
 import type { DeleteDatabaseRequestConfig } from "./types/DeleteDatabase";
 import type { TestDatabaseConnectionRequestConfig, TestDatabaseConnectionStatus200 } from "./types/TestDatabaseConnection";
 import type { ScanDatabaseForPiiRequestConfig, ScanDatabaseForPiiStatus200 } from "./types/ScanDatabaseForPii";
+import type { GetSchemaCatalogRequestConfig, GetSchemaCatalogStatus200 } from "./types/GetSchemaCatalog";
 import type { ListCustomDomainsRequestConfig, ListCustomDomainsStatus200 } from "./types/ListCustomDomains";
 import type { CreateCustomDomainRequestConfig, CreateCustomDomainStatus201 } from "./types/CreateCustomDomain";
 import type { DeleteCustomDomainRequestConfig } from "./types/DeleteCustomDomain";
@@ -46,6 +47,7 @@ import type { CreatePolicyProfileRequestConfig, CreatePolicyProfileStatus201 } f
 import type { GetPolicyProfileRequestConfig, GetPolicyProfileStatus200 } from "./types/GetPolicyProfile";
 import type { UpdatePolicyProfileRequestConfig, UpdatePolicyProfileStatus200 } from "./types/UpdatePolicyProfile";
 import type { DeletePolicyProfileRequestConfig } from "./types/DeletePolicyProfile";
+import type { DryEvalPolicyRequestConfig, DryEvalPolicyStatus200 } from "./types/DryEvalPolicy";
 import type { ListProjectsRequestConfig, ListProjectsStatus200 } from "./types/ListProjects";
 import type { CreateProjectRequestConfig, CreateProjectStatus201 } from "./types/CreateProject";
 import type { GetProjectRequestConfig, GetProjectStatus200 } from "./types/GetProject";
@@ -134,6 +136,7 @@ export const operationsByTag = {
     deleteDatabase: { method: "DELETE", path: "/v1/projects/{project_id}/databases/{database_id}" },
     testDatabaseConnection: { method: "POST", path: "/v1/projects/{project_id}/databases/{database_id}/test-connection" },
     scanDatabaseForPii: { method: "POST", path: "/v1/projects/{project_id}/databases/{database_id}/scan-pii" },
+    getSchemaCatalog: { method: "GET", path: "/v1/projects/{project_id}/databases/{database_id}/schema-catalog" },
   },
   platform: {
     getHealth: { method: "GET", path: "/v1/health" },
@@ -148,6 +151,7 @@ export const operationsByTag = {
     getPolicyProfile: { method: "GET", path: "/v1/projects/{project_id}/policies/{policy_id}" },
     updatePolicyProfile: { method: "PUT", path: "/v1/projects/{project_id}/policies/{policy_id}" },
     deletePolicyProfile: { method: "DELETE", path: "/v1/projects/{project_id}/policies/{policy_id}" },
+    dryEvalPolicy: { method: "POST", path: "/v1/projects/{project_id}/policy-evaluations" },
   },
   support: {
     listSupportCases: { method: "GET", path: "/v1/organizations/{org_id}/support/cases" },
@@ -199,6 +203,7 @@ export const operationsByPath = {
   "DELETE /v1/projects/{project_id}/databases/{database_id}": { method: "DELETE", path: "/v1/projects/{project_id}/databases/{database_id}", operationId: "deleteDatabase" },
   "POST /v1/projects/{project_id}/databases/{database_id}/test-connection": { method: "POST", path: "/v1/projects/{project_id}/databases/{database_id}/test-connection", operationId: "testDatabaseConnection" },
   "POST /v1/projects/{project_id}/databases/{database_id}/scan-pii": { method: "POST", path: "/v1/projects/{project_id}/databases/{database_id}/scan-pii", operationId: "scanDatabaseForPii" },
+  "GET /v1/projects/{project_id}/databases/{database_id}/schema-catalog": { method: "GET", path: "/v1/projects/{project_id}/databases/{database_id}/schema-catalog", operationId: "getSchemaCatalog" },
   "GET /v1/projects/{project_id}/domains": { method: "GET", path: "/v1/projects/{project_id}/domains", operationId: "listCustomDomains" },
   "POST /v1/projects/{project_id}/domains": { method: "POST", path: "/v1/projects/{project_id}/domains", operationId: "createCustomDomain" },
   "DELETE /v1/projects/{project_id}/domains/{domain_id}": { method: "DELETE", path: "/v1/projects/{project_id}/domains/{domain_id}", operationId: "deleteCustomDomain" },
@@ -213,6 +218,7 @@ export const operationsByPath = {
   "GET /v1/projects/{project_id}/policies/{policy_id}": { method: "GET", path: "/v1/projects/{project_id}/policies/{policy_id}", operationId: "getPolicyProfile" },
   "PUT /v1/projects/{project_id}/policies/{policy_id}": { method: "PUT", path: "/v1/projects/{project_id}/policies/{policy_id}", operationId: "updatePolicyProfile" },
   "DELETE /v1/projects/{project_id}/policies/{policy_id}": { method: "DELETE", path: "/v1/projects/{project_id}/policies/{policy_id}", operationId: "deletePolicyProfile" },
+  "POST /v1/projects/{project_id}/policy-evaluations": { method: "POST", path: "/v1/projects/{project_id}/policy-evaluations", operationId: "dryEvalPolicy" },
   "GET /v1/projects": { method: "GET", path: "/v1/projects", operationId: "listProjects" },
   "POST /v1/projects": { method: "POST", path: "/v1/projects", operationId: "createProject" },
   "GET /v1/projects/{project_id}": { method: "GET", path: "/v1/projects/{project_id}", operationId: "getProject" },
@@ -266,6 +272,7 @@ type UpdateDatabaseParams = { pathParams: NonNullable<UpdateDatabaseRequestConfi
 type DeleteDatabaseParams = { pathParams: NonNullable<DeleteDatabaseRequestConfig["pathParams"]> };
 type TestDatabaseConnectionParams = { pathParams: NonNullable<TestDatabaseConnectionRequestConfig["pathParams"]> };
 type ScanDatabaseForPiiParams = { pathParams: NonNullable<ScanDatabaseForPiiRequestConfig["pathParams"]> };
+type GetSchemaCatalogParams = { pathParams: NonNullable<GetSchemaCatalogRequestConfig["pathParams"]> };
 type ListCustomDomainsParams = { pathParams: NonNullable<ListCustomDomainsRequestConfig["pathParams"]>; queryParams?: NonNullable<ListCustomDomainsRequestConfig["queryParams"]> };
 type CreateCustomDomainParams = { pathParams: NonNullable<CreateCustomDomainRequestConfig["pathParams"]>; body: NonNullable<CreateCustomDomainRequestConfig["data"]> };
 type DeleteCustomDomainParams = { pathParams: NonNullable<DeleteCustomDomainRequestConfig["pathParams"]> };
@@ -279,6 +286,7 @@ type CreatePolicyProfileParams = { pathParams: NonNullable<CreatePolicyProfileRe
 type GetPolicyProfileParams = { pathParams: NonNullable<GetPolicyProfileRequestConfig["pathParams"]> };
 type UpdatePolicyProfileParams = { pathParams: NonNullable<UpdatePolicyProfileRequestConfig["pathParams"]>; body: NonNullable<UpdatePolicyProfileRequestConfig["data"]> };
 type DeletePolicyProfileParams = { pathParams: NonNullable<DeletePolicyProfileRequestConfig["pathParams"]> };
+type DryEvalPolicyParams = { pathParams: NonNullable<DryEvalPolicyRequestConfig["pathParams"]>; body: NonNullable<DryEvalPolicyRequestConfig["data"]> };
 type ListProjectsParams = { queryParams: NonNullable<ListProjectsRequestConfig["queryParams"]> };
 type CreateProjectParams = { body: NonNullable<CreateProjectRequestConfig["data"]> };
 type GetProjectParams = { pathParams: NonNullable<GetProjectRequestConfig["pathParams"]> };
@@ -366,6 +374,7 @@ export interface ApiOperations {
     deleteDatabase(params: DeleteDatabaseParams): Promise<void>;
     testDatabaseConnection(params: TestDatabaseConnectionParams): Promise<TestDatabaseConnectionStatus200>;
     scanDatabaseForPii(params: ScanDatabaseForPiiParams): Promise<ScanDatabaseForPiiStatus200>;
+    getSchemaCatalog(params: GetSchemaCatalogParams): Promise<GetSchemaCatalogStatus200>;
   };
   platform: {
     getHealth(): Promise<GetHealthStatus200>;
@@ -380,6 +389,7 @@ export interface ApiOperations {
     getPolicyProfile(params: GetPolicyProfileParams): Promise<GetPolicyProfileStatus200>;
     updatePolicyProfile(params: UpdatePolicyProfileParams): Promise<UpdatePolicyProfileStatus200>;
     deletePolicyProfile(params: DeletePolicyProfileParams): Promise<void>;
+    dryEvalPolicy(params: DryEvalPolicyParams): Promise<DryEvalPolicyStatus200>;
   };
   support: {
     listSupportCases(params: ListSupportCasesParams): Promise<ListSupportCasesStatus200>;
@@ -431,6 +441,7 @@ export interface RequestMap {
   "DELETE /v1/projects/{project_id}/databases/{database_id}": { params: DeleteDatabaseParams; response: void };
   "POST /v1/projects/{project_id}/databases/{database_id}/test-connection": { params: TestDatabaseConnectionParams; response: TestDatabaseConnectionStatus200 };
   "POST /v1/projects/{project_id}/databases/{database_id}/scan-pii": { params: ScanDatabaseForPiiParams; response: ScanDatabaseForPiiStatus200 };
+  "GET /v1/projects/{project_id}/databases/{database_id}/schema-catalog": { params: GetSchemaCatalogParams; response: GetSchemaCatalogStatus200 };
   "GET /v1/projects/{project_id}/domains": { params: ListCustomDomainsParams; response: ListCustomDomainsStatus200 };
   "POST /v1/projects/{project_id}/domains": { params: CreateCustomDomainParams; response: CreateCustomDomainStatus201 };
   "DELETE /v1/projects/{project_id}/domains/{domain_id}": { params: DeleteCustomDomainParams; response: void };
@@ -445,6 +456,7 @@ export interface RequestMap {
   "GET /v1/projects/{project_id}/policies/{policy_id}": { params: GetPolicyProfileParams; response: GetPolicyProfileStatus200 };
   "PUT /v1/projects/{project_id}/policies/{policy_id}": { params: UpdatePolicyProfileParams; response: UpdatePolicyProfileStatus200 };
   "DELETE /v1/projects/{project_id}/policies/{policy_id}": { params: DeletePolicyProfileParams; response: void };
+  "POST /v1/projects/{project_id}/policy-evaluations": { params: DryEvalPolicyParams; response: DryEvalPolicyStatus200 };
   "GET /v1/projects": { params: ListProjectsParams; response: ListProjectsStatus200 };
   "POST /v1/projects": { params: CreateProjectParams; response: CreateProjectStatus201 };
   "GET /v1/projects/{project_id}": { params: GetProjectParams; response: GetProjectStatus200 };

src/generated/types/DryEvalInput.ts

@@ -0,0 +1,32 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+
+import type { PolicyProfileInput } from "./PolicyProfileInput";
+
+/**
+ * @description A SQL statement to test plus the policy to test it against. Supply exactly one of policy_id (an existing saved policy) or policy (an unsaved draft, e.g. the in-progress editor form).
+ * @type object
+*/
+export type DryEvalInput = {
+    /**
+     * @description The single SQL statement to evaluate.
+     * @minLength 1
+     * @maxLength 100000
+     * @example SELECT email FROM users WHERE id = 1
+     * @type string
+    */
+    sql: string;
+    /**
+     * @description ID of an existing saved policy profile to evaluate against.
+     * @example pol_01h455vb4pex5vsknk084sn02q
+     * @type string | undefined
+    */
+    policy_id?: string;
+    /**
+     * @description Mutable fields of a policy profile (used for create and update).
+     * @type object | undefined
+    */
+    policy?: PolicyProfileInput;
+};

src/generated/types/DryEvalMaskedColumn.ts

@@ -0,0 +1,30 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+
+export const dryEvalMaskedColumnKindEnum = {
+    redact: "redact",
+    null: "null",
+    hash: "hash"
+} as const;
+
+export type DryEvalMaskedColumnKindEnumKey = (typeof dryEvalMaskedColumnKindEnum)[keyof typeof dryEvalMaskedColumnKindEnum];
+
+/**
+ * @description One result column that would be masked, with the mask kind applied.
+ * @type object
+*/
+export type DryEvalMaskedColumn = {
+    /**
+     * @description The output column name (post-alias) the client would see masked.
+     * @example email
+     * @type string
+    */
+    column: string;
+    /**
+     * @description How the column is masked.
+     * @type string
+    */
+    kind: DryEvalMaskedColumnKindEnumKey;
+};