@superblocksteam/shared 0.9598.1 → 0.9599.0

package/src/plugins/templates/postgres.ts

@@ -6,7 +6,8 @@ import {
   InputDataType,
   Plugin,
   PluginResponseType,
-  PluginType
+  PluginType,
+  PostgresAuthType
 } from '../../types/index.js';
 import { PARAMETERIZED_SQL_DESCRIPTION, PUBLIC_INTEGRATIONS_LOGO_URL, DOCS_BASE_URL } from './constants.js';
 import { CONNECTION_METHODS_AND_DISPLAY_NAMES, makeDropdownItem } from './shared/db.js';
@@ -20,7 +21,8 @@ const PostgresPluginVersions = {
   V9: '0.0.9',
   V10: '0.0.10',
   V11: '0.0.11',
-  V12: '0.0.12'
+  V12: '0.0.12',
+  V13: '0.0.13'
 };
 
 const BASE_HOST = {
@@ -191,45 +193,207 @@ export const PostgresPlugin: Plugin = {
           {
             ...BASE_DATABASE_NAME,
             startVersion: PostgresPluginVersions.V11,
+            endVersion: PostgresPluginVersions.V12,
             display: {
               show: {
                 connectionType: ['fields']
               }
             }
           } as FormItem,
+          {
+            label: 'Database name',
+            name: 'authentication.custom.databaseName.value',
+            startVersion: PostgresPluginVersions.V13,
+            componentType: FormComponentType.INPUT_TEXT,
+            display: {
+              show: {
+                'authentication.authType': ['', 'undefined', PostgresAuthType.PASSWORD],
+                connectionType: ['fields']
+              }
+            }
+          },
+          {
+            label: 'Database name',
+            name: 'authentication.custom.databaseName.value',
+            startVersion: PostgresPluginVersions.V13,
+            componentType: FormComponentType.INPUT_TEXT,
+            rules: [{ required: true, message: 'Database name is required' }],
+            display: {
+              show: {
+                'authentication.authType': [PostgresAuthType.AWS_IAM_ROLE],
+                connectionType: ['fields']
+              }
+            }
+          },
+          {
+            label: 'Authentication method',
+            name: 'authentication.authType',
+            startVersion: PostgresPluginVersions.V13,
+            componentType: FormComponentType.DROPDOWN,
+            initialValue: PostgresAuthType.PASSWORD,
+            options: [
+              {
+                displayName: 'Username & password',
+                key: PostgresAuthType.PASSWORD,
+                value: PostgresAuthType.PASSWORD
+              },
+              {
+                displayName: 'AWS IAM Role',
+                key: PostgresAuthType.AWS_IAM_ROLE,
+                value: PostgresAuthType.AWS_IAM_ROLE
+              }
+            ],
+            display: {
+              show: {
+                connectionType: ['fields']
+              }
+            }
+          },
+          {
+            label: 'Role ARN',
+            name: 'authentication.custom.iamRoleArn.value',
+            startVersion: PostgresPluginVersions.V13,
+            componentType: FormComponentType.INPUT_TEXT,
+            placeholder: 'arn:aws:iam::<account-id>:role/<role-name>',
+            rules: [{ required: true, message: 'Role ARN is required' }],
+            display: {
+              show: {
+                'authentication.authType': [PostgresAuthType.AWS_IAM_ROLE],
+                connectionType: ['fields']
+              }
+            }
+          },
+          {
+            label: 'Region',
+            name: 'authentication.custom.region.value',
+            startVersion: PostgresPluginVersions.V13,
+            componentType: FormComponentType.INPUT_TEXT,
+            placeholder: 'us-east-1',
+            rules: [{ required: true, message: 'Region is required' }],
+            display: {
+              show: {
+                'authentication.authType': [PostgresAuthType.AWS_IAM_ROLE],
+                connectionType: ['fields']
+              }
+            }
+          },
+          {
+            label: 'Session policy JSON (optional)',
+            name: 'authentication.custom.sessionPolicy.value',
+            startVersion: PostgresPluginVersions.V13,
+            componentType: FormComponentType.CODE_EDITOR,
+            language: EditorLanguage.JSON,
+            rules: [{ required: false }],
+            display: {
+              show: {
+                'authentication.authType': [PostgresAuthType.AWS_IAM_ROLE],
+                connectionType: ['fields']
+              }
+            }
+          },
           // DATABASE USERNAME
           { ...BASE_DATABASE_USERNAME, startVersion: PostgresPluginVersions.V1, endVersion: PostgresPluginVersions.V10 } as FormItem,
           {
             ...BASE_DATABASE_USERNAME,
             startVersion: PostgresPluginVersions.V11,
+            endVersion: PostgresPluginVersions.V12,
             display: {
               show: {
                 connectionType: ['fields']
               }
             }
           } as FormItem,
+          {
+            label: 'Database username',
+            name: 'authentication.username',
+            startVersion: PostgresPluginVersions.V13,
+            componentType: FormComponentType.INPUT_TEXT,
+            display: {
+              show: {
+                'authentication.authType': ['', 'undefined', PostgresAuthType.PASSWORD],
+                connectionType: ['fields']
+              }
+            }
+          },
+          {
+            label: 'Database username',
+            name: 'authentication.username',
+            startVersion: PostgresPluginVersions.V13,
+            componentType: FormComponentType.INPUT_TEXT,
+            rules: [{ required: true, message: 'Database username is required' }],
+            display: {
+              show: {
+                'authentication.authType': [PostgresAuthType.AWS_IAM_ROLE],
+                connectionType: ['fields']
+              }
+            }
+          },
           // DATABASE PASSWORD
           { ...BASE_DATABASE_PASSWORD, startVersion: PostgresPluginVersions.V1, endVersion: PostgresPluginVersions.V10 } as FormItem,
           {
             ...BASE_DATABASE_PASSWORD,
             startVersion: PostgresPluginVersions.V11,
+            endVersion: PostgresPluginVersions.V12,
             display: {
               show: {
                 connectionType: ['fields']
               }
             }
           } as FormItem,
+          {
+            label: 'Database password',
+            name: 'authentication.password',
+            startVersion: PostgresPluginVersions.V13,
+            componentType: FormComponentType.INPUT_TEXT,
+            dataType: InputDataType.PASSWORD,
+            display: {
+              show: {
+                'authentication.authType': ['', 'undefined', PostgresAuthType.PASSWORD],
+                connectionType: ['fields']
+              }
+            }
+          },
           // ENABLE SSL
           { ...BASE_ENABLE_SSL, startVersion: PostgresPluginVersions.V1, endVersion: PostgresPluginVersions.V10 } as FormItem,
           {
             ...BASE_ENABLE_SSL,
             startVersion: PostgresPluginVersions.V11,
+            endVersion: PostgresPluginVersions.V12,
             display: {
               show: {
                 connectionType: ['fields']
               }
             }
           } as FormItem,
+          {
+            label: 'Enable SSL',
+            name: 'connection.useSsl',
+            startVersion: PostgresPluginVersions.V13,
+            componentType: FormComponentType.CHECKBOX,
+            initialValue: true,
+            disabled: false,
+            display: {
+              show: {
+                'authentication.authType': ['', 'undefined', PostgresAuthType.PASSWORD],
+                connectionType: ['fields']
+              }
+            }
+          },
+          {
+            label: 'Enable SSL',
+            name: 'connection.useSsl',
+            startVersion: PostgresPluginVersions.V13,
+            componentType: FormComponentType.CHECKBOX,
+            initialValue: true,
+            disabled: true,
+            rules: [{ enum: [true], message: 'SSL is required for AWS IAM role authentication' }],
+            display: {
+              show: {
+                'authentication.authType': [PostgresAuthType.AWS_IAM_ROLE],
+                connectionType: ['fields']
+              }
+            }
+          },
           // USE SELF-SIGNED SSL
           { ...BASE_SELFSIGNED_SSL, startVersion: PostgresPluginVersions.V1, endVersion: PostgresPluginVersions.V10 } as FormItem,
           {

package/src/types/datasource/auth.ts

@@ -173,6 +173,11 @@ export enum AWSAuthType {
   EC2_INSTANCE_METADATA = 'ec2-instance-metadata'
 }
 
+export enum PostgresAuthType {
+  AWS_IAM_ROLE = 'aws_iam_role',
+  PASSWORD = 'password'
+}
+
 const awsAuthTypeDisplayName = new Map([
   [AWSAuthType.ACCESS_KEY, 'Access Key'],
   [AWSAuthType.TOKEN_FILE, 'Token File'],

package/src/types/datasource/index.ts

@@ -17,7 +17,7 @@ import { SecretsV1 as Secrets } from '@superblocksteam/types';
 import { Property } from '../common/property.js';
 import { Plugin, PluginMetadata } from '../plugin/index.js';
 import { CreatorDto } from '../rbac/index.js';
-import { AWSAuthType, AuthConfig, AuthId, AuthType, IntegrationAuthType, getAuthId } from './auth.js';
+import { AWSAuthType, AuthConfig, AuthId, AuthType, IntegrationAuthType, PostgresAuthType, getAuthId } from './auth.js';
 export { PluginCommonV1 as PluginCommon } from '@superblocksteam/types';
 
 // The DTO for the full datasource (ie all fields). This should only be visible
@@ -304,7 +304,79 @@ type MySQLDatasourceConfiguration = DBDatasourceConfiguration &
 // 2. Our schema generator requires a named type for unions like this
 type FakeBoolean = boolean | string;
 
-export type PostgresDatasourceConfiguration = DBDatasourceConfiguration &
+// These types are self-contained because ts-json-schema-generator drops value
+// annotations when the field is composed through a Property intersection.
+type PostgresDatabaseNameProperty = {
+  key?: string;
+  /** @minLength 1 */
+  value: string;
+  editable?: boolean;
+  internal?: boolean;
+  system?: boolean;
+  description?: string;
+  mandatory?: boolean;
+  type?: string;
+  defaultValue?: string;
+  minRange?: string;
+  maxRange?: string;
+  valueOptions?: string[];
+};
+
+type PostgresIamRoleArnProperty = {
+  key?: string;
+  /**
+   * Validates stable IAM role ARN wire syntax. Role authorization and allowlist
+   * checks remain runtime concerns. The 510-character ARN interior accounts
+   * for the path's leading and trailing slashes within IAM's 512-character max.
+   * @minLength 1
+   * @pattern ^arn:[a-z0-9-]+:iam::[0-9]{12}:role/(?:[!-~]{1,510}/)?[A-Za-z0-9_+=,.@-]{1,64}$
+   */
+  value: string;
+  editable?: boolean;
+  internal?: boolean;
+  system?: boolean;
+  description?: string;
+  mandatory?: boolean;
+  type?: string;
+  defaultValue?: string;
+  minRange?: string;
+  maxRange?: string;
+  valueOptions?: string[];
+};
+
+type PostgresIamRegionProperty = {
+  key?: string;
+  /**
+   * Validates region identifier syntax without freezing the set of AWS regions.
+   * Region existence and availability remain runtime concerns.
+   * @minLength 1
+   * @pattern ^[a-z]{2,}(?:-[a-z0-9]+)+-[0-9]+$
+   */
+  value: string;
+  editable?: boolean;
+  internal?: boolean;
+  system?: boolean;
+  description?: string;
+  mandatory?: boolean;
+  type?: string;
+  defaultValue?: string;
+  minRange?: string;
+  maxRange?: string;
+  valueOptions?: string[];
+};
+
+type PostgresIamEndpoint = {
+  /** @minLength 1 */
+  host: string;
+  /**
+   * @type integer
+   * @minimum 1
+   * @maximum 65535
+   */
+  port: number;
+};
+
+type CockroachDBDatasourceConfiguration = DBDatasourceConfiguration &
   DBConnection &
   DBAuthentication &
   SSHTunnel & {
@@ -312,7 +384,47 @@ export type PostgresDatasourceConfiguration = DBDatasourceConfiguration &
     connectionUrl?: string;
   };
 
-type CockroachDBDatasourceConfiguration = PostgresDatasourceConfiguration;
+type PostgresPasswordDatasourceConfiguration = DBDatasourceConfiguration &
+  DBConnection &
+  SSHTunnel & {
+    authentication?: {
+      authType?: PostgresAuthType.PASSWORD;
+      custom?: {
+        databaseName?: Property;
+      };
+      password?: string;
+      username?: string;
+    };
+    connectionType?: 'fields' | 'url';
+    connectionUrl?: string;
+  };
+
+type PostgresIamRoleDatasourceConfiguration = BaseDatasourceConfiguration &
+  SSHTunnel & {
+    authentication: {
+      authType: PostgresAuthType.AWS_IAM_ROLE;
+      custom: {
+        databaseName: PostgresDatabaseNameProperty;
+        iamRoleArn: PostgresIamRoleArnProperty;
+        region: PostgresIamRegionProperty;
+        sessionPolicy?: Property;
+      };
+      /** @minLength 1 */
+      username: string;
+    };
+    connection: {
+      useSsl: true;
+      useSelfSignedSsl?: FakeBoolean;
+      ca?: string;
+      key?: string;
+      cert?: string;
+      mode?: 0;
+    };
+    connectionType: 'fields';
+    endpoint: PostgresIamEndpoint;
+  };
+
+export type PostgresDatasourceConfiguration = PostgresPasswordDatasourceConfiguration | PostgresIamRoleDatasourceConfiguration;
 
 type PythonDatasourceConfiguration = LanguageDatasourceConfiguration;
 

package/src/types/deployment/deployQueueStatus.ts

@@ -2,7 +2,9 @@ export enum DeployQueueStatus {
   QUEUED = 'QUEUED',
   DEPLOYING = 'DEPLOYING',
   DEPLOYED = 'DEPLOYED',
-  FAILED = 'FAILED'
+  FAILED = 'FAILED',
+  /** Build + gates done, advisory-only findings present, waiting for explicit "Publish anyway". */
+  AWAITING_ACK = 'AWAITING_ACK'
 }
 
 /** Status returned by the deploy-status polling endpoint. "none" means no queue entry exists. */