@stackone/core 1.53.1 → 1.54.0

package/dist/index.d.mts

@@ -1,9 +1,9 @@
-import { HttpMethod, IHttpClient } from "@stackone/transport";
-import { ILogger } from "@stackone/logger";
 import { ZodType, z } from "zod/v4";
+import http from "node:http";
+import https from "node:https";
 
 //#region src/categories/types.d.ts
-type Category = 'hris' | 'crm' | 'ats' | 'lms' | 'marketing' | 'filestorage';
+type Category = 'hris' | 'crm' | 'ats' | 'lms' | 'marketing' | 'filestorage' | 'internal';
 type CategoryDetails = {
   title: string;
   key: Category;
@@ -87,6 +87,223 @@ declare const updateCursor: ({
   position?: number | null;
 }) => Cursor;
 //#endregion
+//#region ../logger/src/types.d.ts
+interface ILogger {
+  debug({
+    category,
+    message,
+    traceId,
+    context
+  }: {
+    category?: string;
+    message: string;
+    traceId?: string;
+    context?: Record<string, unknown>;
+  }): void;
+  info({
+    category,
+    message,
+    traceId,
+    context
+  }: {
+    category?: string;
+    message: string;
+    traceId?: string;
+    context?: Record<string, unknown>;
+  }): void;
+  warning({
+    category,
+    message,
+    traceId,
+    error,
+    code,
+    context
+  }: {
+    category?: string;
+    message: string;
+    traceId?: string;
+    error?: LogError;
+    code?: string;
+    context?: Record<string, unknown>;
+  }): void;
+  error({
+    category,
+    message,
+    traceId,
+    error,
+    code,
+    context
+  }: {
+    category?: string;
+    message: string;
+    traceId?: string;
+    error?: LogError;
+    code: string;
+    context?: Record<string, unknown>;
+  }): void;
+}
+type LogError = Error & {
+  response?: {
+    data?: unknown;
+  };
+  context?: Record<string, unknown>;
+  url?: string;
+};
+//#endregion
+//#region ../transport/src/concurrencyManager/types.d.ts
+type ConcurrencySubPoolConfig = {
+  subPoolKey: string;
+  urlPattern: RegExp | string;
+  maxConcurrency: number;
+};
+type ConcurrencyConfig = {
+  mainMaxConcurrency: number;
+  subPools?: ConcurrencySubPoolConfig[];
+};
+//#endregion
+//#region ../transport/src/rateLimitManager/types.d.ts
+type RateLimitSubPoolConfig = {
+  subPoolKey: string;
+  urlPattern: RegExp | string;
+  rateLimit: number;
+};
+type RetryUnit = 'seconds' | 'milliseconds' | 'date';
+type MappedRateLimitErrorConfig = {
+  errorStatus: number;
+  errorMessage: string | RegExp;
+  errorMessagePath?: string;
+  retryAfterPath?: string;
+  retryAfterUnit?: RetryUnit;
+  retryAfterValue?: number;
+};
+type RateLimitConfig = {
+  mainRatelimit: number;
+  subPools?: RateLimitSubPoolConfig[];
+  mappedRateLimitErrors?: MappedRateLimitErrorConfig[];
+};
+//#endregion
+//#region ../transport/src/interceptors/types.d.ts
+type RequestConfig = {
+  rateLimits?: RateLimitConfig;
+  concurrency?: ConcurrencyConfig;
+};
+//#endregion
+//#region ../transport/src/httpClient/types.d.ts
+type HttpHeaders = {
+  [key: string]: string;
+};
+type HttpQueryParams = {
+  [key: string]: string;
+};
+declare const HttpMethods: readonly ["get", "post", "put", "delete", "patch"];
+type HttpMethod = (typeof HttpMethods)[number];
+type HttpResponse<T = any> = {
+  data: T;
+  status: number;
+  headers: HttpHeaders;
+  requestUrl: string;
+  responseType?: string;
+  responseTime?: Date;
+  message?: string;
+};
+interface IHttpClient {
+  request<P, T>({
+    headers,
+    url,
+    method,
+    queryParams,
+    maxRedirects,
+    responseType,
+    cacheTTL,
+    context,
+    payload,
+    httpsAgent,
+    httpAgent,
+    requestConfig,
+    httpsAgentConfig
+  }: {
+    headers?: HttpHeaders;
+    url: string;
+    method?: HttpMethod;
+    queryParams?: HttpQueryParams;
+    maxRedirects?: number;
+    responseType?: 'arraybuffer' | 'blob' | 'document' | 'json' | 'text';
+    cacheTTL?: number;
+    context?: RequestContext;
+    payload?: P;
+    httpsAgent?: https.Agent;
+    httpAgent?: http.Agent;
+    requestConfig?: RequestConfig;
+    httpsAgentConfig?: https.AgentOptions;
+  }): Promise<HttpResponse<T>>;
+  get<T>({
+    headers,
+    url,
+    queryParams,
+    maxRedirects,
+    cacheTTL,
+    context,
+    requestConfig
+  }: {
+    headers?: HttpHeaders;
+    url: string;
+    queryParams?: HttpQueryParams;
+    maxRedirects?: number;
+    cacheTTL?: number;
+    context?: RequestContext;
+    requestConfig?: RequestConfig;
+  }): Promise<HttpResponse<T>>;
+  post<P, T>({
+    headers,
+    url,
+    maxRedirects,
+    cacheTTL,
+    context,
+    payload,
+    requestConfig
+  }: {
+    headers?: HttpHeaders;
+    url: string;
+    maxRedirects?: number;
+    cacheTTL?: number;
+    context?: RequestContext;
+    payload?: P;
+    requestConfig?: RequestConfig;
+  }): Promise<HttpResponse<T>>;
+}
+interface OperationSetting {
+  url?: string;
+  query?: Record<string, string>;
+  config?: Partial<APIConfig>;
+  custom_settings?: Record<string, unknown>;
+}
+type OperationSettings = Record<string, OperationSetting>;
+type AccountSettings = Record<string, string | number | boolean | object>;
+type HttpClientBehaviour = 'CONCURRENCY' | 'RETRY';
+type APIConfig = Record<string, unknown>;
+type RequestContext = {
+  accountSecureId?: string;
+  projectSecureId?: string;
+  organizationId?: number;
+  environment?: string;
+  authConfigKey?: string;
+  provider?: string;
+  service?: string;
+  resource?: string;
+  subResource?: string;
+  childResource?: string;
+  operation?: string;
+  action?: string;
+  mode?: string;
+  testerUniqueToken?: string;
+  externalKey?: string;
+  dataKey?: string;
+  isDataSync?: boolean;
+  operationSettings?: OperationSettings;
+  accountSettings?: AccountSettings;
+  behaviours?: HttpClientBehaviour[];
+};
+//#endregion
 //#region src/schema/types.d.ts
 type Schema = {
   name: string;
@@ -186,7 +403,7 @@ type Connector = {
 type Assets = {
   icon: string;
 };
-type OperationType = 'list' | 'get' | 'create' | 'update' | 'delete' | 'custom' | 'unknown';
+type OperationType = 'list' | 'get' | 'create' | 'update' | 'delete' | 'custom' | 'refresh_token' | 'unknown';
 type InputLocation = 'body' | 'query' | 'path' | 'headers';
 type Input = {
   name: string;
@@ -201,8 +418,8 @@ type Operation = {
   description: string;
   schema?: Schema;
   operationType: OperationType;
-  entrypointUrl: string;
-  entrypointHttpMethod: HttpMethod;
+  entrypointUrl?: string;
+  entrypointHttpMethod?: HttpMethod;
   inputs?: Input[];
   steps: {
     [stepId: string]: Step;
@@ -265,15 +482,19 @@ type SupportConfig = {
 type AuthenticationConfig = {
   envKey: string;
   envName: string;
-  type: 'custom' | 'oauth2' | 'oidc';
+  type: 'custom' | 'oauth2';
   label: string;
   authorization: {
-    type: 'basic' | 'bearer';
+    type: 'basic' | 'bearer' | 'oauth2';
     [authParam: string]: unknown;
   };
   support?: SupportConfig;
   configFields?: AuthenticationField[];
   setupFields?: AuthenticationField[];
+  refreshAuthentication?: {
+    schedule?: string;
+    operation: Operation;
+  };
   testOperationsIds?: string[];
 };
 type Authentication = {
@@ -397,6 +618,17 @@ declare const AUTHENTICATION_SCHEMA: z.ZodDiscriminatedUnion<[z.ZodObject<{
 }, z.core.$strip>, z.ZodObject<{
   type: z.ZodLiteral<"bearer">;
   token: z.ZodString;
+  includeBearer: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, z.core.$strip>, z.ZodObject<{
+  type: z.ZodLiteral<"oauth2">;
+  authorizationUrl: z.ZodOptional<z.ZodString>;
+  authorizationParams: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+  tokenUrl: z.ZodOptional<z.ZodString>;
+  tokenParams: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+  tokenExpiry: z.ZodOptional<z.ZodNumber>;
+  token: z.ZodString;
+  includeBearer: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+  scopes: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>]>;
 //#endregion
 //#region src/accounts/types.d.ts
@@ -411,4 +643,4 @@ type Account = {
   projectSecureId: string;
 };
 //#endregion
-export { AUTHENTICATION_SCHEMA, Account, Assets, 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 };
+export { AUTHENTICATION_SCHEMA, type Account, type Assets, type Authentication, type AuthenticationConfig, type AuthenticationField, type Block, type BlockContext, type BlockIndexedRecord, COMPOSITE_ID_LATEST_VERSION, type Category, type CompositeIdentifier, type CompositeIdentifierConfig, type CompositeIdentifierConnectorConfig, type Connector, CoreError, type Cursor, type FieldConfig, type Input, type InputLocation, type Operation, type OperationResponse, type OperationType, type Schema, type SchemaField, type Step, type StepFunction, StepFunctionName, type StepFunctionOutput, type StepFunctionParams, StepFunctionsFactory, type StepsSnapshots, type SupportConfig, areCursorsEqual, decodeCompositeId, encodeCompositeId, expandCursor, getCategoryDetails, isCompositeId, isCoreError, isCursorEmpty, isValidCategory, minifyCursor, updateCursor };

package/dist/index.d.ts

@@ -1,9 +1,9 @@
-import { ILogger } from "@stackone/logger";
-import { HttpMethod, IHttpClient } from "@stackone/transport";
 import { ZodType, z } from "zod/v4";
+import http from "node:http";
+import https from "node:https";
 
 //#region src/categories/types.d.ts
-type Category = 'hris' | 'crm' | 'ats' | 'lms' | 'marketing' | 'filestorage';
+type Category = 'hris' | 'crm' | 'ats' | 'lms' | 'marketing' | 'filestorage' | 'internal';
 type CategoryDetails = {
   title: string;
   key: Category;
@@ -87,6 +87,223 @@ declare const updateCursor: ({
   position?: number | null;
 }) => Cursor;
 //#endregion
+//#region ../logger/src/types.d.ts
+interface ILogger {
+  debug({
+    category,
+    message,
+    traceId,
+    context
+  }: {
+    category?: string;
+    message: string;
+    traceId?: string;
+    context?: Record<string, unknown>;
+  }): void;
+  info({
+    category,
+    message,
+    traceId,
+    context
+  }: {
+    category?: string;
+    message: string;
+    traceId?: string;
+    context?: Record<string, unknown>;
+  }): void;
+  warning({
+    category,
+    message,
+    traceId,
+    error,
+    code,
+    context
+  }: {
+    category?: string;
+    message: string;
+    traceId?: string;
+    error?: LogError;
+    code?: string;
+    context?: Record<string, unknown>;
+  }): void;
+  error({
+    category,
+    message,
+    traceId,
+    error,
+    code,
+    context
+  }: {
+    category?: string;
+    message: string;
+    traceId?: string;
+    error?: LogError;
+    code: string;
+    context?: Record<string, unknown>;
+  }): void;
+}
+type LogError = Error & {
+  response?: {
+    data?: unknown;
+  };
+  context?: Record<string, unknown>;
+  url?: string;
+};
+//#endregion
+//#region ../transport/src/concurrencyManager/types.d.ts
+type ConcurrencySubPoolConfig = {
+  subPoolKey: string;
+  urlPattern: RegExp | string;
+  maxConcurrency: number;
+};
+type ConcurrencyConfig = {
+  mainMaxConcurrency: number;
+  subPools?: ConcurrencySubPoolConfig[];
+};
+//#endregion
+//#region ../transport/src/rateLimitManager/types.d.ts
+type RateLimitSubPoolConfig = {
+  subPoolKey: string;
+  urlPattern: RegExp | string;
+  rateLimit: number;
+};
+type RetryUnit = 'seconds' | 'milliseconds' | 'date';
+type MappedRateLimitErrorConfig = {
+  errorStatus: number;
+  errorMessage: string | RegExp;
+  errorMessagePath?: string;
+  retryAfterPath?: string;
+  retryAfterUnit?: RetryUnit;
+  retryAfterValue?: number;
+};
+type RateLimitConfig = {
+  mainRatelimit: number;
+  subPools?: RateLimitSubPoolConfig[];
+  mappedRateLimitErrors?: MappedRateLimitErrorConfig[];
+};
+//#endregion
+//#region ../transport/src/interceptors/types.d.ts
+type RequestConfig = {
+  rateLimits?: RateLimitConfig;
+  concurrency?: ConcurrencyConfig;
+};
+//#endregion
+//#region ../transport/src/httpClient/types.d.ts
+type HttpHeaders = {
+  [key: string]: string;
+};
+type HttpQueryParams = {
+  [key: string]: string;
+};
+declare const HttpMethods: readonly ["get", "post", "put", "delete", "patch"];
+type HttpMethod = (typeof HttpMethods)[number];
+type HttpResponse<T = any> = {
+  data: T;
+  status: number;
+  headers: HttpHeaders;
+  requestUrl: string;
+  responseType?: string;
+  responseTime?: Date;
+  message?: string;
+};
+interface IHttpClient {
+  request<P, T>({
+    headers,
+    url,
+    method,
+    queryParams,
+    maxRedirects,
+    responseType,
+    cacheTTL,
+    context,
+    payload,
+    httpsAgent,
+    httpAgent,
+    requestConfig,
+    httpsAgentConfig
+  }: {
+    headers?: HttpHeaders;
+    url: string;
+    method?: HttpMethod;
+    queryParams?: HttpQueryParams;
+    maxRedirects?: number;
+    responseType?: 'arraybuffer' | 'blob' | 'document' | 'json' | 'text';
+    cacheTTL?: number;
+    context?: RequestContext;
+    payload?: P;
+    httpsAgent?: https.Agent;
+    httpAgent?: http.Agent;
+    requestConfig?: RequestConfig;
+    httpsAgentConfig?: https.AgentOptions;
+  }): Promise<HttpResponse<T>>;
+  get<T>({
+    headers,
+    url,
+    queryParams,
+    maxRedirects,
+    cacheTTL,
+    context,
+    requestConfig
+  }: {
+    headers?: HttpHeaders;
+    url: string;
+    queryParams?: HttpQueryParams;
+    maxRedirects?: number;
+    cacheTTL?: number;
+    context?: RequestContext;
+    requestConfig?: RequestConfig;
+  }): Promise<HttpResponse<T>>;
+  post<P, T>({
+    headers,
+    url,
+    maxRedirects,
+    cacheTTL,
+    context,
+    payload,
+    requestConfig
+  }: {
+    headers?: HttpHeaders;
+    url: string;
+    maxRedirects?: number;
+    cacheTTL?: number;
+    context?: RequestContext;
+    payload?: P;
+    requestConfig?: RequestConfig;
+  }): Promise<HttpResponse<T>>;
+}
+interface OperationSetting {
+  url?: string;
+  query?: Record<string, string>;
+  config?: Partial<APIConfig>;
+  custom_settings?: Record<string, unknown>;
+}
+type OperationSettings = Record<string, OperationSetting>;
+type AccountSettings = Record<string, string | number | boolean | object>;
+type HttpClientBehaviour = 'CONCURRENCY' | 'RETRY';
+type APIConfig = Record<string, unknown>;
+type RequestContext = {
+  accountSecureId?: string;
+  projectSecureId?: string;
+  organizationId?: number;
+  environment?: string;
+  authConfigKey?: string;
+  provider?: string;
+  service?: string;
+  resource?: string;
+  subResource?: string;
+  childResource?: string;
+  operation?: string;
+  action?: string;
+  mode?: string;
+  testerUniqueToken?: string;
+  externalKey?: string;
+  dataKey?: string;
+  isDataSync?: boolean;
+  operationSettings?: OperationSettings;
+  accountSettings?: AccountSettings;
+  behaviours?: HttpClientBehaviour[];
+};
+//#endregion
 //#region src/schema/types.d.ts
 type Schema = {
   name: string;
@@ -186,7 +403,7 @@ type Connector = {
 type Assets = {
   icon: string;
 };
-type OperationType = 'list' | 'get' | 'create' | 'update' | 'delete' | 'custom' | 'unknown';
+type OperationType = 'list' | 'get' | 'create' | 'update' | 'delete' | 'custom' | 'refresh_token' | 'unknown';
 type InputLocation = 'body' | 'query' | 'path' | 'headers';
 type Input = {
   name: string;
@@ -201,8 +418,8 @@ type Operation = {
   description: string;
   schema?: Schema;
   operationType: OperationType;
-  entrypointUrl: string;
-  entrypointHttpMethod: HttpMethod;
+  entrypointUrl?: string;
+  entrypointHttpMethod?: HttpMethod;
   inputs?: Input[];
   steps: {
     [stepId: string]: Step;
@@ -265,15 +482,19 @@ type SupportConfig = {
 type AuthenticationConfig = {
   envKey: string;
   envName: string;
-  type: 'custom' | 'oauth2' | 'oidc';
+  type: 'custom' | 'oauth2';
   label: string;
   authorization: {
-    type: 'basic' | 'bearer';
+    type: 'basic' | 'bearer' | 'oauth2';
     [authParam: string]: unknown;
   };
   support?: SupportConfig;
   configFields?: AuthenticationField[];
   setupFields?: AuthenticationField[];
+  refreshAuthentication?: {
+    schedule?: string;
+    operation: Operation;
+  };
   testOperationsIds?: string[];
 };
 type Authentication = {
@@ -397,6 +618,17 @@ declare const AUTHENTICATION_SCHEMA: z.ZodDiscriminatedUnion<[z.ZodObject<{
 }, z.core.$strip>, z.ZodObject<{
   type: z.ZodLiteral<"bearer">;
   token: z.ZodString;
+  includeBearer: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, z.core.$strip>, z.ZodObject<{
+  type: z.ZodLiteral<"oauth2">;
+  authorizationUrl: z.ZodOptional<z.ZodString>;
+  authorizationParams: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+  tokenUrl: z.ZodOptional<z.ZodString>;
+  tokenParams: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+  tokenExpiry: z.ZodOptional<z.ZodNumber>;
+  token: z.ZodString;
+  includeBearer: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+  scopes: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>]>;
 //#endregion
 //#region src/accounts/types.d.ts
@@ -411,4 +643,4 @@ type Account = {
   projectSecureId: string;
 };
 //#endregion
-export { AUTHENTICATION_SCHEMA, Account, Assets, 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 };
+export { AUTHENTICATION_SCHEMA, type Account, type Assets, type Authentication, type AuthenticationConfig, type AuthenticationField, type Block, type BlockContext, type BlockIndexedRecord, COMPOSITE_ID_LATEST_VERSION, type Category, type CompositeIdentifier, type CompositeIdentifierConfig, type CompositeIdentifierConnectorConfig, type Connector, CoreError, type Cursor, type FieldConfig, type Input, type InputLocation, type Operation, type OperationResponse, type OperationType, type Schema, type SchemaField, type Step, type StepFunction, StepFunctionName, type StepFunctionOutput, type StepFunctionParams, StepFunctionsFactory, type StepsSnapshots, type SupportConfig, areCursorsEqual, decodeCompositeId, encodeCompositeId, expandCursor, getCategoryDetails, isCompositeId, isCoreError, isCursorEmpty, isValidCategory, minifyCursor, updateCursor };