@stackone/connect-sdk 2.60.0 → 2.62.0

package/dist/index.d.mts

@@ -4,26 +4,6 @@ import https from "node:https";
 import { Readable } from "node:stream";
 import http from "node:http";
 
-//#region ../core/src/categories/types.d.ts
-type Category = 'hris' | 'crm' | 'ats' | 'lms' | 'marketing' | 'filestorage' | 'internal' | 'action';
-//#endregion
-//#region ../core/src/compositeIds/types.d.ts
-
-type ComponentConfig = {
-  name: string;
-  alias?: string;
-};
-type ComponentFieldConfig = {
-  targetFieldKey: string;
-  remote?: string;
-  components: ComponentConfig[];
-};
-type CompositeIdentifierConnectorConfig = {
-  enabled: boolean;
-  version?: number;
-  fields?: ComponentFieldConfig[];
-};
-//#endregion
 //#region ../logger/src/types.d.ts
 interface ILogger {
   debug({
@@ -298,40 +278,6 @@ type HmacSigningOptions = {
 };
 type SigningOptions = Aws4SigningOptions | HmacSigningOptions;
 //#endregion
-//#region ../core/src/schema/types.d.ts
-type Schema = {
-  name: string;
-  key: string;
-  version: string;
-  description?: string;
-  category: Category;
-  fields: {
-    [name: string]: SchemaField;
-  };
-};
-type SchemaField = {
-  name: string;
-  type: string;
-  required: boolean;
-  description?: string;
-};
-//#endregion
-//#region ../core/src/stepFunctions/stepFunctionsList.d.ts
-declare enum StepFunctionName {
-  TYPECAST = "typecast",
-  MAP_FIELDS = "map_fields",
-  GROUP_DATA = "group_data",
-  REQUEST = "request",
-  PAGINATED_REQUEST = "paginated_request",
-  SOAP_REQUEST = "soap_request",
-  SOAP_PAGINATED_REQUEST = "soap_paginated_request",
-  STATIC_VALUES = "static_values",
-  UPLOAD_FILE = "upload_file",
-  UPLOAD_BINARY = "upload_binary",
-  DOWNLOAD_FILE = "download_file",
-  EMIT_EVENT = "emit_event",
-}
-//#endregion
 //#region ../olap/src/olap/olapOptions.d.ts
 type OlapOptions = {
   logs?: LogsOptions;
@@ -848,168 +794,108 @@ type ProviderLog = ILog & {
   duration?: number;
 };
 //#endregion
-//#region ../core/src/cursor/types.d.ts
-type Position = {
-  pageNumber?: number | null;
-  providerPageCursor?: string | null;
-  position?: number | null;
-};
-type Cursor = {
-  remote: Record<number, Position>;
-  version: number;
-  timestamp: number;
-};
+//#region ../core/src/categories/types.d.ts
+type Category = 'hris' | 'crm' | 'ats' | 'lms' | 'marketing' | 'filestorage' | 'internal' | 'action';
 //#endregion
-//#region ../core/src/settings/types.d.ts
-type Settings = {
-  olap: OlapSettings;
-  defender?: DefenderSettings;
+//#region ../core/src/compositeIds/types.d.ts
+type ComponentConfig = {
+  name: string;
+  alias?: string;
 };
-type OlapSettings = {
-  logs?: {
-    enabled: boolean;
-  };
-  advanced?: {
-    enabled?: boolean;
-    ttl?: number;
-    errorsOnly?: boolean;
-    includeBackground?: boolean;
-  };
+type ComponentFieldConfig = {
+  targetFieldKey: string;
+  remote?: string;
+  components: ComponentConfig[];
 };
-type DefenderSettings = {
+type CompositeIdentifierConnectorConfig = {
   enabled: boolean;
-  blockHighRisk?: boolean;
-  highRiskThreshold?: number;
-  mediumRiskThreshold?: number;
-  useTier1Classification?: boolean;
-  useTier2Classification?: boolean;
-  largeResponseBehavior?: 'skip' | 'block' | 'scan_anyway';
-  maxResponseSize?: number;
-  maxResponseWords?: number;
-  tier2Fields?: string[];
-  useSfe?: boolean;
-  annotateBoundary?: boolean;
+  version?: number;
+  fields?: ComponentFieldConfig[];
 };
 //#endregion
-//#region ../core/src/source/types.d.ts
-type Source = {
-  sourceType?: string;
-  sourceId?: string;
-  sourceValue?: string;
-};
+//#region ../core/src/exhaustivePagination/basePaginationConfig.d.ts
+type IteratorLocation = 'query' | 'body' | 'headers';
+interface BasePaginationConfig {
+  type: string;
+  response: {
+    dataKey: string;
+  };
+  stopCondition?: string;
+}
 //#endregion
-//#region ../core/src/blocks/types.d.ts
-type Block = {
-  inputs?: {
-    [key: string]: unknown;
+//#region ../core/src/exhaustivePagination/cursorPaginationConfig.d.ts
+interface CursorPaginationConfig extends BasePaginationConfig {
+  type: 'cursor';
+  response: {
+    dataKey: string;
+    nextKey: string;
   };
-  connector?: Connector;
-  context: BlockContext;
-  debug?: DebugParams;
-  steps?: StepsSnapshots;
-  intermediateSteps?: IntermediateStepsSnapshots;
-  httpClient?: IHttpClient;
-  olapClient?: IOlapClient;
-  emitEvent?: (event: EventToEmit) => Promise<void>;
-  settings?: Settings;
-  logger?: ILogger;
-  action?: Action;
-  credentials?: Credentials;
-  scopes?: string[];
-  outputs?: unknown;
-  streamOutput?: StreamOutputData;
-  nextCursor?: Cursor | null;
-  response?: {
-    statusCode: number;
-    successful: boolean;
-    message?: string;
+  iterator: {
+    key: string;
+    in: IteratorLocation;
   };
-  statistics?: BlockStatistics;
-  defenderMetadata?: DefenderMetadata;
-  iterator?: {
-    item: unknown;
-    index: number;
-    current?: unknown;
+}
+//#endregion
+//#region ../core/src/exhaustivePagination/offsetPaginationConfig.d.ts
+interface OffsetPaginationConfig extends BasePaginationConfig {
+  type: 'offset';
+  iterator: {
+    offsetKey: string;
+    limitKey: string;
+    in: IteratorLocation;
+    defaultLimit?: number;
   };
-  fieldConfigs?: FieldConfig[];
-  result?: BlockIndexedRecord[] | BlockIndexedRecord;
-};
-type BlockContext = {
-  organizationId?: string;
-  projectSecureId: string;
-  accountSecureId: string;
-  connectorKey: string;
-  connectorVersion: string;
-  connectorOwner?: string;
+}
+//#endregion
+//#region ../core/src/exhaustivePagination/pagePaginationConfig.d.ts
+interface PagePaginationConfig extends BasePaginationConfig {
+  type: 'page';
+  iterator: {
+    pageKey: string;
+    pageSizeKey?: string;
+    in: IteratorLocation;
+    startPage?: number;
+    defaultPageSize?: number;
+  };
+}
+//#endregion
+//#region ../core/src/exhaustivePagination/index.d.ts
+type PaginationConfig = CursorPaginationConfig | OffsetPaginationConfig | PagePaginationConfig;
+//#endregion
+//#region ../core/src/schema/types.d.ts
+type Schema = {
+  name: string;
+  key: string;
+  version: string;
+  description?: string;
   category: Category;
-  schema?: string;
-  actionType: ActionType;
-  authenticationType: string;
-  environment: string;
-  actionRunId?: string;
-  originOwnerId?: string;
-  originOwnerName?: string;
-  source?: Source;
-  service: string;
-  resource: string;
-  subResource?: string;
-  childResource?: string;
-};
-type BlockIndexedRecord = {
-  id: string;
-  remote_id?: string;
-  [key: string]: unknown;
-  unified_custom_fields?: {
-    [key: string]: unknown;
+  fields: {
+    [name: string]: SchemaField;
   };
 };
-type EnumMatcherExpression = {
-  matchExpression: string;
-  value: string;
-};
-type FieldConfig = {
-  expression?: string;
-  values?: unknown;
-  targetFieldKey: string;
-  alias?: string;
+type SchemaField = {
+  name: string;
   type: string;
-  custom: boolean;
-  hidden: boolean;
-  array: boolean;
-  enumMapper?: {
-    matcher: string | EnumMatcherExpression[];
-  };
-  properties?: FieldConfig[];
-  requiredScopes?: string[];
-};
-type DebugParams = {
-  custom_mappings?: 'disabled' | 'enabled';
-};
-type Credentials = Record<string, unknown>;
-type BlockStatistics = {
-  startTime?: Date;
-  endTime?: Date;
-};
-type DefenderMetadata = {
-  applied: boolean;
-  result?: {
-    allowed: boolean;
-    riskLevel: 'low' | 'medium' | 'high' | 'critical';
-    fieldsSanitized: string[];
-    patternsByField: Record<string, string[]>;
-    detections: string[];
-    tier2Score?: number;
-    tier2SkipReason?: string;
-    latencyMs: number;
-  };
-  skipped?: {
-    reason: 'streaming' | 'size_limit' | 'disabled' | 'error';
-    estimatedSize?: number;
-    threshold?: number;
-    error?: string;
-  };
+  required: boolean;
+  description?: string;
 };
 //#endregion
+//#region ../core/src/stepFunctions/stepFunctionsList.d.ts
+declare enum StepFunctionName {
+  TYPECAST = "typecast",
+  MAP_FIELDS = "map_fields",
+  GROUP_DATA = "group_data",
+  REQUEST = "request",
+  PAGINATED_REQUEST = "paginated_request",
+  SOAP_REQUEST = "soap_request",
+  SOAP_PAGINATED_REQUEST = "soap_paginated_request",
+  STATIC_VALUES = "static_values",
+  UPLOAD_FILE = "upload_file",
+  UPLOAD_BINARY = "upload_binary",
+  DOWNLOAD_FILE = "download_file",
+  EMIT_EVENT = "emit_event",
+}
+//#endregion
 //#region ../core/src/stepFunctions/types.d.ts
 type StepFunction = ({
   block,
@@ -1268,6 +1154,7 @@ type Action = {
 type DataSyncConfig = {
   allowed: boolean;
   indexField: string | string[];
+  pagination?: PaginationConfig;
 };
 type ActionResponse = {
   statusCode: number;
@@ -1367,6 +1254,170 @@ type Authentication = {
   };
 };
 //#endregion
+//#region ../core/src/cursor/types.d.ts
+type Position = {
+  pageNumber?: number | null;
+  providerPageCursor?: string | null;
+  position?: number | null;
+};
+type Cursor = {
+  remote: Record<number, Position>;
+  version: number;
+  timestamp: number;
+};
+//#endregion
+//#region ../core/src/settings/types.d.ts
+type Settings = {
+  olap: OlapSettings;
+  defender?: DefenderSettings;
+};
+type OlapSettings = {
+  logs?: {
+    enabled: boolean;
+  };
+  advanced?: {
+    enabled?: boolean;
+    ttl?: number;
+    errorsOnly?: boolean;
+    includeBackground?: boolean;
+  };
+};
+type DefenderSettings = {
+  enabled: boolean;
+  blockHighRisk?: boolean;
+  highRiskThreshold?: number;
+  mediumRiskThreshold?: number;
+  useTier1Classification?: boolean;
+  useTier2Classification?: boolean;
+  largeResponseBehavior?: 'skip' | 'block' | 'scan_anyway';
+  maxResponseSize?: number;
+  maxResponseWords?: number;
+  tier2Fields?: string[];
+  useSfe?: boolean;
+  annotateBoundary?: boolean;
+};
+//#endregion
+//#region ../core/src/source/types.d.ts
+type Source = {
+  sourceType?: string;
+  sourceId?: string;
+  sourceValue?: string;
+};
+//#endregion
+//#region ../core/src/blocks/types.d.ts
+type Block = {
+  inputs?: {
+    [key: string]: unknown;
+  };
+  connector?: Connector;
+  context: BlockContext;
+  debug?: DebugParams;
+  steps?: StepsSnapshots;
+  intermediateSteps?: IntermediateStepsSnapshots;
+  httpClient?: IHttpClient;
+  olapClient?: IOlapClient;
+  emitEvent?: (event: EventToEmit) => Promise<void>;
+  settings?: Settings;
+  logger?: ILogger;
+  action?: Action;
+  credentials?: Credentials;
+  scopes?: string[];
+  outputs?: unknown;
+  streamOutput?: StreamOutputData;
+  nextCursor?: Cursor | null;
+  response?: {
+    statusCode: number;
+    successful: boolean;
+    message?: string;
+  };
+  statistics?: BlockStatistics;
+  defenderMetadata?: DefenderMetadata;
+  iterator?: {
+    item: unknown;
+    index: number;
+    current?: unknown;
+  };
+  fieldConfigs?: FieldConfig[];
+  result?: BlockIndexedRecord[] | BlockIndexedRecord;
+};
+type FlowType = 'action' | 'refresh_authentication' | 'test_action';
+type BlockContext = {
+  organizationId?: string;
+  projectSecureId: string;
+  accountSecureId: string;
+  connectorKey: string;
+  connectorVersion: string;
+  connectorOwner?: string;
+  category: Category;
+  schema?: string;
+  actionType: ActionType;
+  authenticationType: string;
+  environment: string;
+  actionRunId?: string;
+  originOwnerId?: string;
+  originOwnerName?: string;
+  source?: Source;
+  flowType?: FlowType;
+  service: string;
+  resource: string;
+  subResource?: string;
+  childResource?: string;
+};
+type BlockIndexedRecord = {
+  id: string;
+  remote_id?: string;
+  [key: string]: unknown;
+  unified_custom_fields?: {
+    [key: string]: unknown;
+  };
+};
+type EnumMatcherExpression = {
+  matchExpression: string;
+  value: string;
+};
+type FieldConfig = {
+  expression?: string;
+  values?: unknown;
+  targetFieldKey: string;
+  alias?: string;
+  type: string;
+  custom: boolean;
+  hidden: boolean;
+  array: boolean;
+  enumMapper?: {
+    matcher: string | EnumMatcherExpression[];
+  };
+  properties?: FieldConfig[];
+  requiredScopes?: string[];
+};
+type DebugParams = {
+  custom_mappings?: 'disabled' | 'enabled';
+};
+type Credentials = Record<string, unknown>;
+type BlockStatistics = {
+  startTime?: Date;
+  endTime?: Date;
+};
+type DefenderMetadata = {
+  applied: boolean;
+  result?: {
+    allowed: boolean;
+    riskLevel: 'low' | 'medium' | 'high' | 'critical';
+    fieldsSanitized: string[];
+    patternsByField: Record<string, string[]>;
+    detections: string[];
+    tier2Score?: number;
+    tier2SkipReason?: string;
+    latencyMs: number;
+  };
+  skipped?: {
+    reason: 'streaming' | 'size_limit' | 'disabled' | 'error';
+    estimatedSize?: number;
+    threshold?: number;
+    error?: string;
+  };
+};
+//#endregion
 //#region ../core/src/stepFunctions/factory.d.ts
 declare const StepFunctionsFactory: {
   build({
@@ -1617,7 +1668,8 @@ declare const createBlockContext: ({
   originOwnerName,
   sourceType,
   sourceId,
-  sourceValue
+  sourceValue,
+  flowType
 }: {
   category: Category;
   connectorKey: string;
@@ -1634,6 +1686,7 @@ declare const createBlockContext: ({
   sourceType?: string;
   sourceId?: string;
   sourceValue?: string;
+  flowType?: FlowType;
 }) => BlockContext;
 //#endregion
 //#region src/connectors/testActions.d.ts