@stackone/core 1.52.4 → 1.52.5

package/dist/index.d.ts

@@ -0,0 +1,426 @@
+import { ILogger } from "@stackone/logger";
+import { HttpMethod, IHttpClient } from "@stackone/transport";
+import { ZodTypeAny, z } from "zod";
+
+//#region src/categories/types.d.ts
+type Category = 'hris' | 'crm' | 'ats' | 'lms' | 'marketing' | 'filestorage';
+type CategoryDetails = {
+  title: string;
+  key: Category;
+  description: string;
+};
+//#endregion
+//#region src/categories/index.d.ts
+declare const getCategoryDetails: (category: string) => CategoryDetails | null;
+declare const isValidCategory: (category: string) => boolean;
+//#endregion
+//#region src/compositeIds/types.d.ts
+type SingleIdentifier = {
+  value: string;
+  key: string;
+};
+type MultipleIdentifier = {
+  identifiers: Array<SingleIdentifier>;
+};
+type CompositeIdentifier = MultipleIdentifier | SingleIdentifier;
+type CompositeIdentifierConfig = {
+  version: number;
+  aliases?: Record<string, string>;
+};
+type ComponentConfig = {
+  name: string;
+  alias?: string;
+};
+type ComponentFieldConfig = {
+  targetFieldKey: string;
+  remote?: string;
+  components: ComponentConfig[];
+};
+type CompositeIdentifierConnectorConfig = {
+  enabled: boolean;
+  version?: number;
+  fields?: ComponentFieldConfig[];
+};
+//#endregion
+//#region src/compositeIds/index.d.ts
+declare const encodeCompositeId: (identifier: CompositeIdentifier, compositeIdConfig?: CompositeIdentifierConfig) => string;
+declare const decodeCompositeId: (compositeId: string, compositeIdConfig?: CompositeIdentifierConfig) => Record<string, string>;
+declare const isCompositeId: (value?: string | null) => boolean;
+//#endregion
+//#region src/compositeIds/constants.d.ts
+declare const COMPOSITE_ID_LATEST_VERSION = 1;
+//#endregion
+//#region 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 src/cursor/index.d.ts
+declare const minifyCursor: (cursor: Cursor) => string;
+declare const expandCursor: (minifiedCursor: unknown) => Cursor | null;
+declare const areCursorsEqual: (first: string | Cursor, second: string | Cursor) => boolean;
+declare const isCursorEmpty: ({
+  cursor,
+  ignoreStepIndex
+}: {
+  cursor?: Cursor | null;
+  ignoreStepIndex?: number;
+}) => boolean;
+declare const updateCursor: ({
+  cursor,
+  stepIndex,
+  pageNumber,
+  providerPageCursor,
+  position
+}: {
+  cursor?: Cursor | null;
+  stepIndex: number;
+  pageNumber?: number | null;
+  providerPageCursor?: string | null;
+  position?: number | null;
+}) => Cursor;
+//#endregion
+//#region 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 src/stepFunctions/stepFunctionsList.d.ts
+declare enum StepFunctionName {
+  TYPECAST = "typecast",
+  MAP_FIELDS = "map_fields",
+  GROUP_DATA = "group_data",
+  REQUEST = "request",
+  PAGINATED_REQUEST = "paginated_request",
+}
+//#endregion
+//#region src/stepFunctions/types.d.ts
+type StepFunction = ({
+  block,
+  params
+}: {
+  block: Readonly<Block>;
+  params?: StepFunctionParams;
+}) => Promise<StepFunctionOutput>;
+type StepFunctionParams = {
+  [key: string]: unknown;
+};
+type StepFunctionMeta = {
+  functionName: StepFunctionName;
+  params?: StepFunctionParams;
+  version?: string;
+};
+type StepFunctionInstance = {
+  fn: StepFunction;
+  inputSchema?: ZodTypeAny;
+  outputSchema?: ZodTypeAny;
+};
+type StepFunctionOutput = {
+  block: Block;
+  successful: boolean;
+  errors?: StepError[];
+  output?: {
+    [name: string]: unknown;
+  };
+};
+//#endregion
+//#region src/steps/types.d.ts
+type StepSnapshot = {
+  output?: {
+    [name: string]: unknown;
+  };
+  successful: boolean;
+  skipped?: boolean;
+  message?: string;
+  errors?: StepError[];
+};
+type StepsSnapshots = {
+  [stepId: string]: StepSnapshot;
+};
+type StepError = {
+  [key: string]: unknown;
+};
+type Step = {
+  id: string;
+  description: string;
+  stepFunction: StepFunctionMeta;
+  ignoreError?: boolean;
+  async?: boolean;
+  successCriteria?: string;
+  condition?: string;
+};
+//#endregion
+//#region src/connector/types.d.ts
+type Connector = {
+  title: string;
+  version: string;
+  key: string;
+  description?: string;
+  categories?: Category[];
+  authentication?: Authentication;
+  operations?: {
+    [entrypointUrl: string]: Operation;
+  };
+};
+type OperationType = 'list' | 'get' | 'create' | 'update' | 'delete' | 'custom' | 'unknown';
+type InputLocation = 'body' | 'query' | 'path' | 'headers';
+type Input = {
+  name: string;
+  type: string;
+  required: boolean;
+  description: string;
+  in: InputLocation;
+};
+type Operation = {
+  id: string;
+  categories: Category[];
+  description: string;
+  schema?: Schema;
+  operationType: OperationType;
+  entrypointUrl: string;
+  entrypointHttpMethod: HttpMethod;
+  inputs?: Input[];
+  steps: {
+    [stepId: string]: Step;
+  };
+  result?: string | Record<string, unknown>;
+  responses: {
+    success: OperationResponse;
+    errors: Record<number, OperationResponse>;
+  };
+  cursor: {
+    enabled: boolean;
+    pageSize: number;
+  };
+  compositeIdentifiers: CompositeIdentifierConnectorConfig;
+  scheduledJobs?: ScheduledJobConfig[];
+};
+type ScheduledJobConfig = {
+  enabled: boolean;
+  type: ScheduledJobType;
+  schedule: string;
+  description: string;
+  requestParams?: ScheduledJobRequestParams;
+  syncFilter?: SyncFilterConfig;
+};
+type ScheduledJobRequestParams = {
+  fields?: string[];
+  expand?: string[];
+  filter?: Record<string, string>;
+};
+type ScheduledJobType = 'data_sync';
+type SyncFilterName = 'updated_after' | 'created_after';
+type SyncFilterConfig = {
+  name: SyncFilterName;
+  initialLoopbackPeriod: string;
+  incrementalLoopbackPeriod: string;
+};
+type OperationResponse = {
+  statusCode: number;
+  description?: string;
+};
+type AuthenticationField = {
+  key: string;
+  label: string;
+  type: 'text' | 'password' | 'select';
+  options?: {
+    value: string;
+    label: string;
+  }[];
+  required: boolean;
+  secret: boolean;
+  readOnly: boolean;
+  placeholder?: string;
+  description?: string;
+  tooltip?: string;
+};
+type SupportConfig = {
+  link: string;
+  description?: string;
+};
+type AuthenticationConfig = {
+  envKey: string;
+  envName: string;
+  type: 'custom' | 'oauth2' | 'oidc';
+  label: string;
+  authorization: {
+    type: 'basic' | 'bearer';
+    [authParam: string]: unknown;
+  };
+  support?: SupportConfig;
+  configFields?: AuthenticationField[];
+  setupFields?: AuthenticationField[];
+  testOperationsIds?: string[];
+};
+type Authentication = {
+  [authType: string]: {
+    production: AuthenticationConfig;
+    [envKey: string]: AuthenticationConfig;
+  };
+};
+//#endregion
+//#region src/blocks/types.d.ts
+type Block = {
+  inputs?: {
+    [key: string]: unknown;
+  };
+  connector?: Connector;
+  context: BlockContext;
+  debug?: DebugParams;
+  steps?: StepsSnapshots;
+  httpClient?: IHttpClient;
+  logger?: ILogger;
+  operation?: Operation;
+  credentials?: Credentials;
+  outputs?: unknown;
+  nextCursor?: Cursor | null;
+  response?: {
+    statusCode: number;
+    successful: boolean;
+    message?: string;
+  };
+  fieldConfigs?: FieldConfig[];
+  result?: BlockIndexedRecord[] | BlockIndexedRecord;
+};
+type BlockContext = {
+  projectSecureId: string;
+  accountSecureId: string;
+  connectorKey: string;
+  connectorVersion: string;
+  category: Category;
+  schema?: string;
+  operationType: OperationType;
+  authenticationType: string;
+  environment: string;
+  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;
+  targetFieldKey: string;
+  alias?: string;
+  type: string;
+  custom: boolean;
+  hidden: boolean;
+  enumMapper?: {
+    matcher: string | EnumMatcherExpression[];
+  };
+};
+type DebugParams = {
+  custom_mappings?: 'disabled' | 'enabled';
+};
+type Credentials = Record<string, unknown>;
+//#endregion
+//#region src/errors/coreError.d.ts
+declare class CoreError extends Error {
+  readonly type: string;
+  readonly category: string;
+  readonly context?: BlockContext;
+  constructor({
+    category,
+    name,
+    type,
+    context,
+    message
+  }: {
+    category: string;
+    name: string;
+    type: string;
+    context?: BlockContext;
+    message?: string;
+  });
+  toString(): string;
+}
+//#endregion
+//#region src/errors/typeguards.d.ts
+declare const isCoreError: (error: unknown) => error is CoreError;
+//#endregion
+//#region src/stepFunctions/factory.d.ts
+declare const StepFunctionsFactory: {
+  build({
+    functionName,
+    version,
+    validateSchemas,
+    stepFunctionsList
+  }: {
+    functionName: StepFunctionName;
+    version?: string;
+    validateSchemas?: boolean;
+    stepFunctionsList?: Record<string, Record<string, StepFunctionInstance>>;
+  }): StepFunctionInstance;
+};
+//#endregion
+//#region src/stepFunctions/request/schemas.d.ts
+declare const AUTHENTICATION_SCHEMA: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+  type: z.ZodLiteral<"basic">;
+  username: z.ZodOptional<z.ZodString>;
+  password: z.ZodOptional<z.ZodString>;
+  encoding: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+  type: "basic";
+  username?: string | undefined;
+  password?: string | undefined;
+  encoding?: string | undefined;
+}, {
+  type: "basic";
+  username?: string | undefined;
+  password?: string | undefined;
+  encoding?: string | undefined;
+}>, z.ZodObject<{
+  type: z.ZodLiteral<"bearer">;
+  token: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+  type: "bearer";
+  token: string;
+}, {
+  type: "bearer";
+  token: string;
+}>]>;
+//#endregion
+//#region src/accounts/types.d.ts
+type Account = {
+  providerKey: string;
+  providerVersion: string;
+  authConfigKey: string;
+  environment: string;
+  organizationId: number;
+  secureId: string;
+  credentials?: Record<string, unknown>;
+  projectSecureId: string;
+};
+//#endregion
+export { AUTHENTICATION_SCHEMA, Account, Authentication, AuthenticationConfig, AuthenticationField, Block, BlockContext, BlockIndexedRecord, COMPOSITE_ID_LATEST_VERSION, Category, CompositeIdentifier, CompositeIdentifierConfig, CompositeIdentifierConnectorConfig, Connector, CoreError, Cursor, FieldConfig, Input, InputLocation, Operation, OperationResponse, OperationType, Schema, SchemaField, Step, StepFunction, StepFunctionName, StepFunctionOutput, StepFunctionParams, StepFunctionsFactory, StepsSnapshots, SupportConfig, areCursorsEqual, decodeCompositeId, encodeCompositeId, expandCursor, getCategoryDetails, isCompositeId, isCoreError, isCursorEmpty, isValidCategory, minifyCursor, updateCursor };