@integry/sdk 4.7.39 → 4.7.40

package/src/interfaces/index.ts

@@ -1,938 +0,0 @@
-// eslint-disable-next-line import/no-cycle
-import { FlowCardProps } from '@/features/templates/Template';
-import {
-  Authorization,
-  AuthorizationTypes,
-  TemplateFormRenderModes,
-  MarketplaceRenderModes,
-} from '@/types';
-import { VNode } from 'preact';
-import {
-  array,
-  boolean,
-  date,
-  Describe,
-  nullable,
-  number,
-  object,
-  optional,
-  size,
-  string,
-} from 'superstruct';
-
-export interface NestedObject {
-  [key: string]: string | number | NestedObject;
-}
-export interface UserConfig {
-  availableFlowsLabel?: string;
-  myFlowsLabel?: string;
-  hideWebhookUrlScreen?: boolean;
-  hideAppConnectionModal?: boolean;
-  customComponents?: {
-    flowCard?: (props: FlowCardProps) => VNode;
-  };
-  autoRedirectToMyFlows?: boolean;
-  isReadOnly?: boolean;
-  marketplaceModalTitle?: string;
-  buttonLabelToSaveIntegration?: string;
-  objects?: NestedObject;
-  tags?: string[];
-  hideExistingIntegrations?: boolean;
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  [other: string]: any;
-}
-
-export type SDKOptions = UserConfig; // rename user config to options for better understanding
-export interface SDKConfig {
-  baseUrl?: string;
-  debug?: boolean;
-  integrationId?: number;
-  xIntegryConfig?: {
-    isAnonymous?: boolean;
-    appAuth?: {
-      apiKey?: string;
-      authId?: string;
-      extras?: Record<string, string | number>;
-    };
-  };
-  userConfig?: UserConfig;
-  options?: SDKOptions;
-  payloads?: NestedObject;
-  user?: NestedObject;
-}
-
-export interface ConfigWithObject extends SDKConfig {
-  appKey: string;
-  hash: string;
-  userId: string;
-  deploymentId?: string;
-  marketplaceId?: string;
-  appId?: number;
-  showApps?: boolean;
-  showTemplates?: boolean;
-}
-
-export interface ConfigWithUrlParams extends SDKConfig {
-  useUrlParams?: boolean;
-}
-
-export interface APIConfig {
-  baseUrl: string;
-  baseUrlv2: string;
-  endpointsUrl: string;
-  appKey: string;
-  hash: string;
-  userId: string;
-  oauthVerifyPath: string;
-  apiKey?: string;
-  authId?: string;
-  extras?: Record<string, string | number>;
-  defaultIntegrationStatus?: boolean;
-  baseAPIUrl: string;
-}
-
-export interface Template {
-  id: number;
-  name: string;
-  description: string;
-  can_add_integration: boolean;
-  integration_count: number;
-  app: {
-    icon_url: string;
-    category: string[];
-    tags: string;
-  };
-  branding_app: {
-    id: string;
-    name: string;
-    icon_url: string;
-    category: string[];
-    tags: string;
-  };
-  is_manual?: boolean;
-  version_number?: number | null;
-}
-
-export interface Integration {
-  name: string;
-  branding_app: {
-    id: string;
-    name: string;
-    icon_url: string;
-    category: string[];
-    tags: string;
-  };
-  id: number;
-  runs_count: number;
-  bundle_instance: number;
-  created: Date;
-  delete_link: string;
-  disable_link: string;
-  edit_link: string;
-  enable_link: string;
-  icon_url: string;
-  is_visible: number;
-  last_modified: Date;
-  status: string;
-  template: number;
-  template_detail: {
-    id: number;
-    name: string;
-    description: string;
-  };
-  task_execution: {
-    integration_created_at: Date;
-    last_execution_at: {
-      date: Date;
-      timezone: string;
-      timezone_type: number;
-    } | null;
-    status: string | null;
-  };
-  loading: boolean;
-}
-
-export interface IntegrationSaveResponse {
-  id: number;
-  connected_account_id: number;
-  is_visible: number | boolean;
-  name: string;
-  bundle_name: string;
-  bundle_instance_id: number;
-  status: string;
-  template: number;
-  steps: {
-    id: number;
-    template_step: number;
-    returned_data: string | null;
-    activity_id: number;
-    step_name: string;
-  }[];
-}
-
-export interface AppsForAuthConnection {
-  id: number;
-  name: string;
-  description: string;
-  icon_url: string;
-  color: string;
-  status: 0 | 1;
-  system_app: boolean;
-  publishing_status: string;
-  is_workspace: boolean;
-  account_id: number;
-  authorization_type: {
-    id: number;
-    type: AuthorizationTypes;
-    provider: string;
-    app_id: number;
-  }[];
-}
-
-export interface AppsForAuthConnectionResponse {
-  has_next: boolean;
-  next_page_number: number;
-  apps: AppsForAuthConnection[];
-}
-export interface BundleResponse {
-  meta: {
-    status: number;
-  };
-  templates: Template[];
-  integrations: Integration[];
-}
-
-type SaveIntegrationRequestStep = {
-  id: number;
-  authorization: number;
-  template_step: number;
-  app_user_data: {
-    id: number;
-    value: string;
-    template_field: number;
-  }[];
-};
-
-export interface SaveOrUpdateIntegrationBody {
-  isAnonymous: boolean;
-  id?: number;
-  name: string;
-  notification_email: string;
-  template: number;
-  bundle_id: number;
-  bundle_instance_id?: number;
-  steps: SaveIntegrationRequestStep[];
-}
-
-export interface GetAppsForAuthConnectionBody {
-  deploymentId?: number;
-}
-
-export type App = {
-  id: number;
-  name: string;
-  description: string;
-  icon_url: string;
-  color: string;
-  publishing_status: string;
-  category: string[];
-  app_type?: string;
-  action_url?: string | null;
-  created_at?: Date;
-  tags: string;
-};
-
-type Activity = {
-  id: number;
-  name: string;
-  type: string;
-  endpoint: string;
-  auth_required: boolean;
-  total_fields: number;
-  app: App;
-  activity_output: string | null;
-  activity_output_url: string | null;
-  dynamic_field_data_endpoint: string | null;
-};
-
-export type AuthorizationType = {
-  id: number;
-  type: string;
-  authorizations: Authorization[];
-  provider: string;
-  is_sandbox_enabled: boolean;
-  is_userinfo_required?: boolean;
-  authorization_url_sandbox: string;
-  app: {
-    icon_url: string;
-    id: number;
-    name: string;
-  };
-};
-
-export type IntegryStep = {
-  id: number;
-  weight: number;
-  title: string;
-  is_visible: boolean;
-  activity: Activity;
-  hide_authorization: boolean;
-  source_steps: any;
-};
-
-export interface TemplateResponse {
-  id: number;
-  name: string;
-  description: string;
-  app: App;
-  branding_app: App;
-  button_text: string | null;
-  is_wizard: boolean;
-  steps: IntegryStep[];
-  publishing_status: string;
-  level?: number;
-  parent_id?: number;
-  execution_type?: 'ON_DEMAND' | 'AUTOMATIC';
-  execution_behaviour?: 'SAVE_ONLY' | 'SAVE_AND_EXECUTE';
-  parameters?: Record<string, any>;
-}
-
-export interface UiFieldDataSource {
-  body: Record<string, unknown>;
-  headers: Record<string, string>;
-  method: string;
-  url: string;
-}
-
-export interface UiField {
-  is_multiselect: boolean;
-  option_key_path: string;
-  type: string;
-  value_key_path: string;
-  data_source: UiFieldDataSource;
-  type_key_path?: string;
-  title_key_path?: string;
-  id_key_path?: string;
-  is_required_key_path?: string;
-}
-
-export interface TemplateField {
-  id: number;
-  is_required: boolean;
-  is_hidden: boolean;
-  default_value: string | null;
-  weight: number;
-  description: string;
-  summary: string | null;
-  activity_field: {
-    is_editable?: boolean;
-    id: number;
-    machine_name: string;
-    type: string;
-    title: string;
-    description: string;
-    weight: number;
-    is_required: boolean;
-    child_fields: string | null;
-    placeholder: string | null;
-    is_dynamic: boolean;
-    data_src: string | null;
-    data_src_endpoint: number | null;
-    parent_fields: string | null;
-    dynamic_field_src: string | null;
-    default_value: string | null;
-    auto_machine_name: string;
-    dynamic_field_src_endpoint: number | null;
-    regex: string | null;
-    regex_error_message?: string | null;
-    is_searchable: boolean;
-    conditional_fields?: string | null;
-  } | null;
-  title: string | null;
-  type: string;
-  placeholder: string | null;
-  // manual_template: unknown | null;
-  child_field: string | null;
-  child_field_value: string | null;
-  // template_fields: unknown[];
-  button_text: string | null;
-  // field_actions: unknown[];
-  icon_url: string | null;
-  long_description: string | null;
-  regex: string | null;
-  regex_msg: string | null;
-  is_visible: boolean;
-  app_user_data?: {
-    app_user: number;
-    id: number;
-    value: string | number;
-    is_changed: boolean;
-    changed_dynamic_fields: string;
-  }[];
-  added_in_mapping?: boolean;
-  field_mapping_source?: string;
-  is_mappable: boolean;
-  is_editable: boolean;
-  allow_tags_in_text: boolean;
-  is_default_value_auto_mapped?: boolean;
-  source_flow_integration_invocation_url?: string;
-  is_multiselect?: boolean;
-  template_fields?: any[];
-  ui_field?: UiField;
-  is_button_enabled?: boolean;
-  on_button_click_script?: string;
-  button_script_requires_auth_token?: boolean;
-  data_type?: string;
-}
-
-export interface DynamicField {
-  id: number;
-  is_required: boolean;
-  is_hidden: boolean;
-  default_value: string | null;
-  weight: number;
-  description: string;
-  summary: string | null;
-  title: string | null;
-  type: string;
-  placeholder: string | null;
-  // manual_template: unknown | null;
-  child_field: string | null;
-  child_field_value: string | null;
-  // template_fields: unknown[];
-  button_text: string | null;
-  // field_actions: unknown[];
-  icon_url: string | null;
-  long_description: string | null;
-  regex: string | null;
-  regex_msg: string | null;
-  is_visible: boolean;
-  app_user_data?: {
-    app_user: number;
-    id: number;
-    value: string | number;
-    is_changed: boolean;
-    changed_dynamic_fields: string;
-  }[];
-  added_in_mapping?: boolean;
-  field_mapping_source?: string;
-  is_mappable: boolean;
-  is_editable: boolean;
-  allow_tags_in_text: boolean;
-  is_default_value_auto_mapped?: boolean;
-  source_flow_integration_invocation_url?: string;
-  is_multiselect?: boolean;
-  template_fields?: any[];
-}
-
-export interface ConditionalFields {
-  value: string;
-  field_array: string;
-}
-export interface TemplateStep {
-  id: number;
-  weight: number;
-  title: string;
-  description?: string;
-  is_visible: boolean;
-  activity: Activity;
-  authorization_type: AuthorizationType;
-  template_fields: TemplateField[];
-  step_instance?: number | null;
-  allow_multiple_authorizations: boolean;
-  step_authorization: number | null;
-  button_text: string | null;
-  is_self_step: boolean;
-  summary: string | null;
-  is_workspace_app_step: boolean;
-  auth_description: string | null;
-  hide_authorization: boolean;
-  // step_condition: unknown | null;
-  machine_name: string | null;
-  is_custom_machine_name: boolean;
-  source_steps: any;
-}
-
-export interface InitConfig {
-  containerId: string;
-  templateContainerId?: string;
-  renderMode: TemplateFormRenderModes;
-  renderFlowsMode?: TemplateFormRenderModes;
-  renderFlowSetupMode?: TemplateFormRenderModes;
-  renderAppsPageMode?: TemplateFormRenderModes;
-  renderAppPageMode?: TemplateFormRenderModes;
-  appId?: number;
-  showApps?: boolean;
-  showTemplates?: boolean;
-  skipOnDemand?: boolean;
-  skipAccountConnectionOnLoad?: boolean;
-  deploymentIdFromConfig?: number;
-  testMultipurpose?: boolean;
-  viewStyle?: string;
-  flowId?: number;
-  integrationId?: number;
-}
-
-export interface MarketplaceConfig {
-  containerId: string;
-  renderMode: MarketplaceRenderModes;
-  apps?: any;
-}
-
-export interface AppFlowConfig {
-  containerId: string;
-  renderMode: MarketplaceRenderModes;
-  appId: number;
-}
-export interface IntegrationResponse {
-  id: number;
-  guid: string;
-  name: string;
-  notification_email: string;
-  bundle_name: string;
-  template: number;
-  template_detail: {
-    id: number;
-    name: string;
-    description: string;
-  };
-  steps: {
-    id: number;
-    endpoint: string | null;
-    authorization: string | number | null;
-    app_user_data: {
-      id: number;
-      value: string;
-      template_field: number;
-    }[];
-    template_step: number;
-    returned_data: null | string;
-    verb?: string | null;
-  }[];
-  is_visible: number;
-  parent_integration: number | null;
-  status: string;
-  is_test_integration: boolean;
-  task_execution: {
-    last_execution_at: string | null;
-    status: string | null;
-    integration_created_at: string;
-  };
-  created: string;
-  last_modified: string;
-}
-
-export interface ActivityCustomField {
-  value: string;
-  tag: string;
-  text: string;
-  sample_data: string;
-}
-
-export interface TemplatePreviewData {
-  id: number;
-  name: string;
-  description: string;
-  app: App;
-  branding_app: App;
-  button_text: string | null;
-  is_wizard: boolean;
-  publishing_status: string;
-  level?: number;
-  parent_id?: number;
-  steps: TemplateStep[];
-}
-
-export const TemplatePreviewDataType: any = object({
-  id: number(),
-  name: string(),
-  description: string(),
-  app: object({
-    id: number(),
-    name: string(),
-    description: string(),
-    icon_url: string(),
-    color: string(),
-    publishing_status: string(),
-    category: array(string()),
-    app_type: optional(string()),
-    action_url: nullable(optional(string())),
-    created_at: optional(date()),
-    tags: string(),
-  }),
-  branding_app: object({
-    id: number(),
-    name: string(),
-    description: string(),
-    icon_url: string(),
-    color: string(),
-    publishing_status: string(),
-    category: array(string()),
-    app_type: optional(string()),
-    action_url: nullable(optional(string())),
-    created_at: optional(date()),
-    tags: string(),
-  }),
-  button_text: nullable(string()),
-  is_wizard: boolean(),
-  publishing_status: string(),
-  steps: size(
-    array(
-      object({
-        id: number(),
-        weight: number(),
-        title: string(),
-        is_visible: boolean(),
-        is_workspace_app_step: boolean(),
-        activity: object({
-          id: number(),
-          name: string(),
-          type: string(),
-          endpoint: string(),
-          auth_required: boolean(),
-          total_fields: number(),
-          app: object({
-            id: number(),
-            name: string(),
-            description: string(),
-            icon_url: string(),
-            color: string(),
-            publishing_status: string(),
-            category: array(string()),
-            app_type: optional(string()),
-            action_url: nullable(optional(string())),
-            created_at: optional(date()),
-            tags: string(),
-          }),
-          activity_output: nullable(string()),
-          activity_output_url: nullable(string()),
-          dynamic_field_data_endpoint: nullable(string()),
-        }),
-        authorization_type: object({
-          id: number(),
-          type: string(),
-          authorizations: array(
-            object({
-              id: number(),
-              authorization_type: string(),
-              app_user: optional(number()),
-              app_user_id: optional(number()),
-              disable_link: optional(string()),
-              integration_count: optional(number()),
-              user_identity: string(),
-            }),
-          ),
-          provider: string(),
-          is_sandbox_enabled: boolean(),
-          is_userinfo_required: optional(boolean()),
-          authorization_url_sandbox: string(),
-          app: object({
-            id: number(),
-            name: string(),
-            icon_url: string(),
-          }),
-        }),
-        template_fields: array(
-          object({
-            id: number(),
-            is_required: boolean(),
-            is_hidden: boolean(),
-            default_value: nullable(string()),
-            weight: number(),
-            description: string(),
-            summary: nullable(string()),
-            placeholder: nullable(string()),
-            added_in_mapping: optional(boolean()),
-            field_mapping_source: optional(string()),
-            activity_field: nullable(
-              object({
-                id: number(),
-                machine_name: string(),
-                type: string(),
-                title: string(),
-                description: string(),
-                weight: number(),
-                placeholder: nullable(string()),
-                is_required: boolean(),
-                child_fields: nullable(string()),
-                is_dynamic: boolean(),
-                data_src: nullable(string()),
-                data_src_endpoint: nullable(number()),
-                parent_fields: nullable(string()),
-                dynamic_field_src: nullable(string()),
-                default_value: nullable(string()),
-                auto_machine_name: string(),
-                dynamic_field_src_endpoint: nullable(number()),
-                regex: nullable(string()),
-                is_searchable: boolean(),
-                conditional_fields: nullable(optional(string())),
-              }),
-            ),
-            title: nullable(string()),
-            type: string(),
-            // manual_template: unknown | null;
-            child_field: nullable(string()),
-            child_field_value: nullable(string()),
-            // template_fields: unknown[];
-            button_text: nullable(string()),
-            // field_actions: unknown[];
-            icon_url: nullable(string()),
-            long_description: nullable(string()),
-            regex: nullable(string()),
-            regex_msg: nullable(string()),
-            is_visible: boolean(),
-          }),
-        ),
-        // step_instance: unknown | null;
-        allow_multiple_authorizations: boolean(),
-        step_authorization: nullable(number()),
-        button_text: nullable(string()),
-        is_self_step: boolean(),
-        summary: nullable(string()),
-        auth_description: nullable(string()),
-        hide_authorization: boolean(),
-        // step_condition: unknown | null;
-        machine_name: nullable(string()),
-        step_instance: optional(nullable(number())),
-        is_custom_machine_name: boolean(),
-      }),
-    ),
-    0,
-    Number.POSITIVE_INFINITY,
-  ),
-});
-
-export interface PreviewMetadata {
-  stepId: number | null;
-  type: 'AUTH' | 'CONFIGURATION' | 'CONFIRMATION' | 'SECTION';
-}
-
-export interface PreviewPayload {
-  templateData: TemplatePreviewData;
-  metadata: PreviewMetadata;
-  previewContainerId: string;
-}
-
-export enum AppConnectionStatus {
-  VERIFYING = 'VERIFYING',
-  CONNECTED = 'CONNECTED',
-  ERROR = 'ERROR',
-  NONE = '',
-}
-
-export enum IntegrationStatus {
-  PUBLISHED = 'PUBLISHED',
-  DRAFT = 'DRAFT',
-  ARCHIVED = 'ARCHIVED',
-}
-
-export enum MediaType {
-  IMAGE = 'IMAGE',
-  VIDEO = 'VIDEO',
-}
-
-export interface MarketplaceDetail {
-  accept_app_requests: boolean;
-  name: string;
-  templates?: { description: string; id: number; name: string }[];
-}
-export interface MarketplaceAppAuthorizationType {
-  id: number;
-  type: string;
-  default_authorization: number;
-  provider: string;
-  is_sandbox_enabled: boolean;
-  authorization_url_sandbox: string;
-  authorizations: Authorization[];
-}
-
-export interface ConnectedAccount {
-  id: string;
-  display_name: string;
-  modified_at: string;
-}
-
-export interface MarketplaceApp {
-  id: number;
-  name: string;
-  title: string;
-  connected_accounts?: ConnectedAccount[];
-  description: string;
-  icon_url: string;
-  color: string;
-  publishing_status: string;
-  category: string[];
-  app_type: string;
-  authorization_type: MarketplaceAppAuthorizationType;
-  docs_url: string;
-}
-
-export interface MarketplaceAppIntegration {
-  id: number;
-  name: string;
-  description: string;
-  status: IntegrationStatus;
-  version: number;
-  meta?: {
-    created: string;
-    has_runs: boolean;
-    integration_id: number;
-    integration_name: string;
-    is_deleted: boolean;
-    last_run_end_time: string;
-    last_run_start_time: string;
-    last_run_status: string;
-    status: string;
-  };
-}
-
-export interface MediaObject {
-  id: number;
-  url: string;
-  type: MediaType;
-  index?: number;
-}
-
-export interface UploadFileObj {
-  id?: number;
-  url: string;
-  type: MediaType;
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  file?: any;
-  uploading?: boolean;
-  index?: number;
-}
-export interface MarketplaceAppBundle {
-  id: number;
-  created: Date;
-  modified: Date;
-  app: MarketplaceApp;
-  integrations?: MarketplaceAppIntegration[];
-  connectionStatus?: AppConnectionStatus;
-  long_description?: string;
-  media?: MediaObject[];
-}
-export interface AppRequestFormData {
-  app: string;
-  description: string;
-}
-
-export interface FileUploadFormData {
-  file: File;
-}
-
-// interface for app flows
-export interface Instance {
-  status: string;
-  last_run_status: string;
-  id: number;
-  last_run_start_time: string;
-  name: string;
-  error_app_name: string;
-  error_code: number;
-  first_error_received_at: string;
-  usage_limit_reached_at: string;
-  is_test_integration: boolean;
-}
-
-export interface BrandingAppAuthorizationType {
-  id: number;
-  type: string;
-  authorizations: { id: number; user_identity: string }[];
-}
-
-export interface BrandingApp {
-  id: number;
-  name: string;
-  icon_url: string;
-  authorization_type: BrandingAppAuthorizationType;
-  default_bundle_id: number;
-}
-export interface Flow {
-  id: number;
-  name: string;
-  description: null;
-  execution_type: 'ON_DEMAND' | 'AUTOMATIC';
-  allow_multiple_instances: boolean;
-  instances: Instance[];
-  execution_behaviour: 'SAVE_ONLY' | 'SAVE_AND_EXECUTE';
-  button_text: string;
-  branding_app?: BrandingApp;
-  version_number?: number | null;
-  integration_creation_in_progress?: boolean;
-}
-
-export interface AppFlowsResponse {
-  count: number;
-  total_pages: number;
-  results: Flow[];
-}
-
-// Flow execution response:
-export interface ExecuteFlowResponse {
-  status: string;
-  response: {
-    status_code: string;
-    status_code_description: string;
-    body: string;
-    headers: string;
-  };
-  request: {
-    method: string;
-    url: string;
-    body: string;
-    headers: string;
-  };
-}
-
-export interface IncomingWebhookObject {
-  payload: string;
-  name: string;
-  id: number;
-}
-
-export interface IncomingWebhookPayload {
-  [fieldId: string]: string | Record<string, string>;
-}
-
-export interface MultipurposeFieldType {
-  activityOutputData: NestedObject;
-  activityOutputDataRaw?: NestedObject;
-  title: string;
-  description: string;
-  placeholder: string;
-  value?: string;
-  regex?: string | null;
-  regexErrorMessage?: string | null;
-  isRequired?: boolean;
-  showStepValidation?: boolean;
-  onChange?: (val: string, passesRegexTest?: boolean) => void;
-  isReadOnly?: boolean;
-  isChanged?: boolean;
-  className?: string;
-  containerClass: string;
-  type: string;
-  key: string;
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  apiHandler?: any;
-  isSearchable: boolean;
-  endpointUrl: string;
-  isDynamic: boolean;
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  endpointData?: any;
-  skipOptionFetch: boolean;
-  isMappable?: boolean;
-  accountConnected?: boolean;
-  isEditable?: boolean;
-  allowTagsInText?: boolean;
-  hideTabs?: boolean;
-  fieldId?: string;
-  enableTagify?: boolean;
-}
-
-export interface FunctionFieldType {
-  onChange?: (val: any) => void;
-  isReadOnly?: boolean;
-  field: TemplateField;
-  tagsTree?: any;
-}