@superblocksteam/shared 0.9561.3 → 0.9562.0

package/src/types/api/execution.ts

@@ -1,35 +1,11 @@
 import { Code } from '@superblocksteam/types';
 import _ from 'lodash';
-import { ApiResourceTiming } from '../common/timing.js';
-import { ApiNotificationConfiguration, Global, PlaceholdersInfo } from '.';
+import { Global, PlaceholdersInfo } from '.';
 
 // TODO(pbardea): Rename "view mode" everywhere to something more descriptive.
-export const UNPUBLISHED_VIEW_MODE = false;
 export const PUBLISHED_VIEW_MODE = true;
 
-export interface ApiExecutionRequest {
-  apiId: string;
-  params: ExecutionParam[];
-  viewMode: boolean;
-  settings?: ApiExecutionSettings;
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  cookies?: Record<string, any>;
-}
-
-export interface ApiExecutionSettings {
-  timeout: number;
-  memoryLimitMB: number;
-}
-
-export interface ApiExecutionResponse {
-  apiId: string;
-  apiName?: string;
-  context: ExecutionContext;
-  notificationConfig?: ApiNotificationConfiguration;
-  timing?: ApiResourceTiming;
-}
-
-export interface KVStore {
+interface KVStore {
   read: (keys: string[]) => Promise<{ data: unknown[] }>;
   write: (key: string, value: string) => Promise<void>;
   writeMany: (kvs: { key: string; value: unknown }[]) => Promise<void>;
@@ -129,14 +105,14 @@ export interface ExecutionParam {
 }
 
 // Log message that includes the level alongside the message that was logged
-export interface StructuredLog {
+interface StructuredLog {
   msg: string;
   level: 'info' | 'warn' | 'error';
 }
 
 // Plugin execution could show the underlying raw request, e.g. curl for RestAPI
 // It's controlled by hasRawRequest of the Plugin
-export type RawRequest = string | undefined;
+type RawRequest = string | undefined;
 
 export class ExecutionOutput {
   error?: string;

package/src/types/api/global.ts

@@ -31,9 +31,3 @@ export class Global {
     return created;
   }
 }
-
-export enum GlobalConstantKey {
-  Global = 'Global',
-  Groups = 'groups',
-  User = 'user'
-}

package/src/types/api/index.ts

@@ -2,7 +2,6 @@ import { Api as ApiPb, Trigger_Job, Trigger_Workflow } from '@superblocksteam/ty
 import { Metadata, UserType as ProtoUserType } from '@superblocksteam/types';
 import { Param } from '../common/param.js';
 import { DatasourceEnvironments } from '../datasource/index.js';
-import { EventEntityType } from '../event/index.js';
 import { IntegrationDto } from '../integration/index.js';
 import { EntityProfileSettings } from '../profile/index.js';
 import { IResourceMetadata } from '../resource/index.js';
@@ -69,7 +68,7 @@ export type ApiLocationContext = {
   pageId?: string; // @deprecated orchestrator no longer uses this field
 };
 
-export type ApiDefinitionMetadata = {
+type ApiDefinitionMetadata = {
   requester: string;
   requesterType?: ProtoUserType;
   organizationName?: string;
@@ -98,17 +97,6 @@ export function apiTriggerTypeQueryToType(trigger: ApiTriggerTypeQuery): ApiTrig
   }
 }
 
-export function apiTriggerToEntity(trigger: ApiTriggerType): EventEntityType {
-  switch (trigger) {
-    case ApiTriggerType.UI:
-      return EventEntityType.API;
-    case ApiTriggerType.WORKFLOW:
-      return EventEntityType.WORKFLOW;
-    case ApiTriggerType.SCHEDULE:
-      return EventEntityType.SCHEDULED_JOB;
-  }
-}
-
 export interface IApiV3Dto {
   id: string;
   name: string;
@@ -176,8 +164,6 @@ export type ExportedApiV3Dto = Omit<IApiV3Dto, 'updated' | 'triggerType' | 'apiP
 
 export type ApiSettings = EntityProfileSettings;
 
-export type ExportedApiSettings = Omit<ApiSettings, 'profiles'>;
-
 export { ViewMode as OrchestratorViewMode } from '@superblocksteam/types';
 export * from './action.js';
 export * from './resolvedActionProp.js';

package/src/types/api/resolvedActionProp.ts

@@ -1,4 +1,4 @@
-export type TokenLocation = { startOffset: number; length: number };
+type TokenLocation = { startOffset: number; length: number };
 
 export interface PlaceholderInfo {
   /** the same placeholder (such as $1) might be used in multiple places so we need an array of locations here */
@@ -8,9 +8,3 @@ export interface PlaceholderInfo {
 }
 
 export type PlaceholdersInfo = Record<string, PlaceholderInfo>;
-
-export interface ResolvedActionConfigurationProperty {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  resolved: string | any[] | Buffer;
-  placeholdersInfo?: PlaceholdersInfo;
-}

package/src/types/application/index.ts

@@ -16,8 +16,7 @@ import {
 } from '..';
 import { ApplicationSignatureTreeSigned, Signature } from '../../signing/index.js';
 import { ResourceMetadata } from '../metadata/index.js';
-import { Organization } from '../organization/index.js';
-import { Dimension, EntityWithBindings6, IPageV2Dto, MultiStepDef, Padding, PageDSL, PageRef, PageSummary } from '../page/index.js';
+import { Dimension, EntityWithBindings6, IPageV2Dto, MultiStepDef, Padding, PageDSL, PageSummary } from '../page/index.js';
 import { EntityProfileSettings } from '../profile/index.js';
 import { IResourceMetadata } from '../resource/index.js';
 
@@ -38,22 +37,7 @@ export interface Application {
   configuration?: ApplicationConfiguration;
 }
 
-export interface NewApplications {
-  organizationApplications: OrganizationApplications[];
-}
-
-export interface OrganizationApplications {
-  organization: Organization;
-  applications: Application[];
-}
-
-export interface ApplicationPages {
-  organizationId: string;
-  pages: PageRef[];
-}
-
 export type GetEditorsForAppIdResponse = ApplicationUserDto[];
-export type SetEditorsForAppIdResponse = { error?: string };
 
 interface PropertiesPanelDisplay {
   controlType: 'text' | 'js-expr' | 'switch';
@@ -383,14 +367,6 @@ export type ApplicationSettingsResponse = ApplicationSettings & {
   prefix?: string;
 };
 
-export type CreateApplicationRequest = {
-  name: string;
-  color: string;
-  environment: DatasourceEnvironments;
-  folderId?: string;
-  isPublic?: boolean;
-};
-
 export interface FullApplicationV2Dto {
   application: IApplicationV2Dto;
   metadata?: ResourceMetadata;
@@ -435,7 +411,7 @@ export type ExportedPage = Omit<IPageV2Dto, 'updated'>;
 export type ExportedPageWithApis = Omit<IPageV2Dto, 'updated' | 'apis'> & {
   apis?: ExportedApiV3Dto[];
 };
-export type ExportedApplicationSettings = Omit<ApplicationSettings, 'profiles'>;
+type ExportedApplicationSettings = Omit<ApplicationSettings, 'profiles'>;
 
 export type ExportedMultiPageApplicationDto = Omit<FullApplicationV2Dto, 'application' | 'page' | 'apis'> & {
   application: ExportedMultiPageApplication;
@@ -567,7 +543,7 @@ export type ModifyEntitiesPayload = {
   signingRequired: boolean;
 };
 
-export type ModifyEntitiesPayloadPage = {
+type ModifyEntitiesPayloadPage = {
   pageId: string;
   dsl: PageDSL;
 };

package/src/types/audit/apiRunDetails.ts

@@ -1,7 +1,7 @@
 import { ApiLocationContext } from '../api/index.js';
 import { AuditLogDetails } from './audit.js';
 
-export interface ApiRunDetails extends AuditLogDetails {
+interface ApiRunDetails extends AuditLogDetails {
   target: string;
   locationContext?: ApiLocationContext;
   endTime?: Date;

package/src/types/audit/audit.ts

@@ -3,10 +3,6 @@ import { ApiLocationContext } from '../api/index.js';
 import { ApiResourceTiming } from '../common/timing.js';
 import { ApiRunStatus } from './apiRunDetails.js';
 
-export enum Source {
-  SCHEDULED_JOB = 'Schedule'
-}
-
 export enum AuditLogEntityType {
   APPLICATION,
   WORKFLOW,
@@ -52,10 +48,6 @@ export enum AuditLogStatusFilter {
 // crashed halfway through) rather than still running.
 export const ABANDONED_EXECUTION_THRESH_MINUTES = 30;
 
-export enum ApiRunEventType {
-  FINISH
-}
-
 export enum AuditLogEventType {
   API_RUN
 }
@@ -88,7 +80,7 @@ export type AuditLogDto = {
   routePath?: string;
 };
 
-export interface StepDetail {
+interface StepDetail {
   name: string;
   id: string;
   pluginId: string;

package/src/types/auth/oauth2.ts

@@ -12,33 +12,3 @@ export type OAuthTokenResponse = {
   issued_at?: number;
   refresh_token?: string;
 };
-
-export enum GrantType {
-  PASSWORD = 'password',
-  AUTHORIZATION_CODE = 'authorization_code',
-  CLIENT_CREDENTIALS = 'client_credentials',
-  REFRESH_TOKEN = 'refresh_token'
-}
-
-export type OAuthBaseTokenRequest = {
-  grant_type: GrantType;
-  client_id?: string;
-  client_secret?: string;
-  audience?: string;
-  refresh_token?: string;
-  redirect_uri?: string;
-  scope?: string;
-};
-
-export type OAuthRefreshTokenRequest = OAuthBaseTokenRequest & {
-  refresh_token?: string;
-};
-
-export type OAuthTokenPasswordRequest = OAuthBaseTokenRequest & {
-  username?: string;
-  password?: string;
-};
-
-export type OAuthTokenAuthorizationCodeRequest = OAuthBaseTokenRequest & {
-  code?: string;
-};

package/src/types/common/file.ts

@@ -13,22 +13,12 @@ export type FileMetadataPrivate = FileMetadata &
     $superblocksId: string;
   }>;
 
-export type ReadableFile = FileMetadata &
-  Readonly<{
-    // only available in the browser, contains image urls like
-    // "blob:http://app.superblockshq.com/uuid-uuid-uuid-uuid"
-    previewUrl: string;
-    readContents: () => string;
-  }>;
-
 type FileConstructorArgs = FileMetadata & {
   // We should consider supporting Blobs & Buffers for streaming file
   // contents
   contents: string;
 };
 
-export type FileConstructor = (fileDef: FileConstructorArgs) => ReadableFile;
-
 // TODO [ro] the encoding seems wrong.
 // The following is an example of readable file from temp location
 // This is the file objects returned by FilePicker.files

package/src/types/common/index.ts

@@ -7,4 +7,3 @@ export * from './observability.js';
 export * from './env.js';
 export * from './region.js';
 export * from './cli.js';
-export * from './secret.js';

package/src/types/common/observability.ts

@@ -1,18 +1,13 @@
 import { AgentStatus, AgentTags } from '../organization/agent.js';
 
-// Most logging drivers (and GELF) prefer snake case naming for fields
-export interface AuditLogMetadata {
-  user_email: string;
-}
-
-export enum AgentMessageType {
+enum AgentMessageType {
   INTEGRATION_ERROR = 'integrationError', // User errors found in plugin execution code
   INTERNAL_ERROR = 'internalError', // Agent operation errors
   UNAUTHORIZED_ERROR = 'unauthorizedError', // Agent->Cloud request authorization errors
   UNCATEGORIZED_ERROR = 'uncategorizedError' // Uncategorized errors, we should categorize them aggressively as they present themselves
 }
 
-export enum UIErrorPriority {
+enum UIErrorPriority {
   P1 = 1, //Critical Error affecting user that we need to fix immediately
   P2 = 2 //Error affecting user, but no immediate action for us
 }
@@ -35,12 +30,12 @@ export const UIErrorPriorityMap = {
   [UIErrorType.SERVER_ERROR_OTHER]: UIErrorPriority.P2
 };
 
-export interface OrgMetadata {
+interface OrgMetadata {
   superblocks_org_id?: string;
   superblocks_org_name?: string;
 }
 
-export interface AgentMetadata extends OrgMetadata {
+interface AgentMetadata extends OrgMetadata {
   superblocks_agent_id?: string;
   superblocks_agent_environment?: string;
   superblocks_agent_url?: string;
@@ -48,12 +43,7 @@ export interface AgentMetadata extends OrgMetadata {
   superblocks_agent_version_external?: string;
 }
 
-export interface WorkerMetadata extends OrgMetadata {
-  superblocks_worker_id?: string;
-  superblocks_worker_version?: string;
-}
-
-export interface DiagnosticMetadataTags {
+interface DiagnosticMetadataTags {
   pluginId?: string;
   actionName?: string;
   actionId?: string;
@@ -67,7 +57,7 @@ export interface DiagnosticMetadataTags {
   configurationId?: string;
 }
 
-export interface DiagnosticMetadata extends DiagnosticMetadataTags {
+interface DiagnosticMetadata extends DiagnosticMetadataTags {
   messageType?: AgentMessageType;
   message?: string;
   type?: string;
@@ -100,13 +90,13 @@ export enum DiagnosticType {
 
 export type AgentDiagnosticMetadata = AgentMetadata & DiagnosticMetadata;
 
-export type AgentError = {
+type AgentError = {
   msg: string;
   ts: number;
   code?: number;
 };
 
-export interface WorkerStatus {
+interface WorkerStatus {
   id: string;
   plugins: string[];
   cordoned: boolean;
@@ -130,7 +120,7 @@ export interface Health {
   tags?: AgentTags;
 }
 
-export interface CommonMetrics {
+interface CommonMetrics {
   cpu?: Record<string, unknown> | number;
   memory?: Record<string, unknown> | number;
   disk?: unknown;
@@ -144,11 +134,6 @@ export interface CommonMetrics {
   version_external?: string;
 }
 
-export interface WorkerMetrics extends CommonMetrics {
-  busyCount?: number;
-  activeControllers?: number;
-}
-
 export interface Metrics extends CommonMetrics {
   apiSuccessCount?: number;
   apiFailureCount?: number;

package/src/types/common/response.ts

@@ -17,14 +17,6 @@ export class ResponseWrapper<T> {
   }
 }
 
-export class ApiV2ResponseWrapper<T> {
-  api: T;
-
-  constructor(api: T) {
-    this.api = api;
-  }
-}
-
 export class ApiV2WithIntegrationsResponseWrapper<T> {
   api: T;
   integrations: Record<string, DatasourceConfiguration>;
@@ -44,14 +36,6 @@ export class ApiV2WithIntegrationsResponseWrapper<T> {
   }
 }
 
-export class ApiV2ListResponseWrapper<T> {
-  apis: T[];
-
-  constructor(apis: T[]) {
-    this.apis = apis;
-  }
-}
-
 export class ResponseMeta {
   status: number;
   message: string;

package/src/types/common/timing.ts

@@ -1,4 +1,4 @@
-export type RequestTiming = {
+type RequestTiming = {
   requestStart?: number;
   requestEnd?: number;
   requestDurationMs?: number;

package/src/types/datasource/auth.ts

@@ -21,7 +21,7 @@ export function getAuthId(
   return `${authType}.${getClientId(authType, authConfig, integrationId, integrationConfigurationId)}`;
 }
 
-export function getClientId(
+function getClientId(
   authType: AuthType | undefined,
   config: AuthConfig | undefined,
   integrationId?: string,
@@ -156,7 +156,7 @@ export enum AWSAuthType {
   EC2_INSTANCE_METADATA = 'ec2-instance-metadata'
 }
 
-export const awsAuthTypeDisplayName = new Map([
+const awsAuthTypeDisplayName = new Map([
   [AWSAuthType.ACCESS_KEY, 'Access Key'],
   [AWSAuthType.TOKEN_FILE, 'Token File'],
   [AWSAuthType.EC2_INSTANCE_METADATA, 'EC2 Instance Metadata']
@@ -167,7 +167,7 @@ export function getAWSAuthTypeDisplayName(authType: AWSAuthType): string {
 }
 
 // generally used with authTypeField='connectionType'
-export enum DatabaseAuthType {
+enum DatabaseAuthType {
   URL = 'url',
   FIELDS = 'fields',
   OKTA = 'okta',
@@ -219,20 +219,21 @@ export function getDisplayName(authType: AuthType): string {
   }
 }
 
-export type PublicFirebaseAuthConfig = {
+type PublicFirebaseAuthConfig = {
   apiKey?: string;
   google?: boolean;
   email?: boolean;
 };
 
-export type FirebaseAuthConfig = PublicFirebaseAuthConfig;
+type FirebaseAuthConfig = PublicFirebaseAuthConfig;
 
-export type PublicOAuthConfig = PublicOAuthPasswordConfig &
+type PublicOAuthConfig = PublicOAuthPasswordConfig &
   PublicOAuthClientCredsConfig &
   PublicOAuthImplicitConfig &
   PublicOAuthCodeConfig &
   PublicOAuthTokenExchangeConfig;
-export type OAuthConfig = OAuthPasswordConfig &
+
+type OAuthConfig = OAuthPasswordConfig &
   OAuthClientCredsConfig &
   OAuthImplicitConfig &
   OAuthCodeConfig &
@@ -245,7 +246,7 @@ type PublicOAuthPasswordConfig = {
   useFixedPasswordCreds?: boolean;
 };
 
-export type OAuthPasswordConfig = PublicOAuthPasswordConfig & {
+type OAuthPasswordConfig = PublicOAuthPasswordConfig & {
   clientSecret?: string;
   // A fixed username and password can be optionally provided.
   username?: string;
@@ -258,7 +259,7 @@ type PublicOAuthClientCredsConfig = {
   scope?: string;
 };
 
-export type OAuthClientCredsConfig = PublicOAuthClientCredsConfig & {
+type OAuthClientCredsConfig = PublicOAuthClientCredsConfig & {
   clientSecret?: string;
   audience?: string;
 };
@@ -269,7 +270,7 @@ type PublicOAuthImplicitConfig = {
   scope?: string;
 };
 
-export type OAuthImplicitConfig = PublicOAuthImplicitConfig & {
+type OAuthImplicitConfig = PublicOAuthImplicitConfig & {
   clientSecret?: string;
 };
 
@@ -301,11 +302,11 @@ type PublicOAuthCodeConfig = {
   revokeTokenUrl?: string;
   authToken?: string;
   hasToken?: boolean; // @deprecated not used anymore
-  userEmail?: string; // @deprecated not used anymore
+  userEmail?: string; // Used by integrations that need user identity (e.g., Lakebase Token Federation)
   sendOAuthState?: boolean;
 };
 
-export type OAuthCodeConfig = PublicOAuthCodeConfig & {
+type OAuthCodeConfig = PublicOAuthCodeConfig & {
   clientSecret?: string;
 };
 
@@ -334,35 +335,31 @@ export type TokenMetadata = {
   email?: string;
 };
 
-export function userAccessibleTokens(): TokenType[] {
-  return [TokenType.USER, TokenType.ACCESS];
-}
-
 type FakeBoolean = boolean | string;
 
-export type BasicAuthConfig = PublicBasicAuthConfig & {
+type BasicAuthConfig = PublicBasicAuthConfig & {
   username?: string;
   password?: string;
 };
 
-export type PublicBasicAuthConfig = {
+type PublicBasicAuthConfig = {
   shareBasicAuthCreds?: FakeBoolean;
 };
 
-export type BearerTokenAuthConfig = {
+type BearerTokenAuthConfig = {
   bearerToken?: string;
 };
 
-export type TokenPrefixedAuthConfig = {
+type TokenPrefixedAuthConfig = {
   prefix?: string;
   token?: string;
 };
 
-export type ApiKeyFormAuthConfig = {
+type ApiKeyFormAuthConfig = {
   apiKeys?: Record<string, { header?: string; token?: string }>;
 };
 
-export type ApiKeyAuthConfig = {
+type ApiKeyAuthConfig = {
   key?: string;
   value?: string;
   method?: ApiKeyMethod;
@@ -442,18 +439,18 @@ type ServiceAccountConfig = {
 
 type PublicRestAuthConfig = PublicBasicAuthConfig & PublicOAuthConfig & PublicFirebaseAuthConfig;
 type PublicGoogleSheetsAuthConfig = PublicOAuthCodeConfig;
-export type PublicAuthConfig = PublicRestAuthConfig & PublicGoogleSheetsAuthConfig;
+type PublicAuthConfig = PublicRestAuthConfig & PublicGoogleSheetsAuthConfig;
 
 // TODO(aayush): Rename RestAuthConfig to something more generic as it is also
 // used for GraphQL.
-export type RestAuthConfig = BasicAuthConfig &
+type RestAuthConfig = BasicAuthConfig &
   OAuthConfig &
   FirebaseAuthConfig &
   BearerTokenAuthConfig &
   TokenPrefixedAuthConfig &
   ApiKeyFormAuthConfig &
   ApiKeyAuthConfig;
-export type GoogleSheetsAuthConfig = OAuthCodeConfig & ServiceAccountConfig;
+type GoogleSheetsAuthConfig = OAuthCodeConfig & ServiceAccountConfig;
 export type AuthConfig = RestAuthConfig & GoogleSheetsAuthConfig;
 
 // TODO: this lives here for now to avoid a cyclic dependency. The utils