@dereekb/zoho 12.6.21 → 12.7.0

package/src/lib/zoho.error.api.d.ts

@@ -1,7 +1,36 @@
 import { type Maybe, type UnixDateTimeNumber } from '@dereekb/util';
 import { type ConfiguredFetch, type FetchJsonInterceptJsonResponseFunction, type FetchRequestFactoryError, FetchResponseError } from '@dereekb/util/fetch';
 import { BaseError } from 'make-error';
+/**
+ * Returned by Zoho CRM.
+ *
+ * The data array contains the list of possible success
+ */
+export interface ZohoServerErrorResponseDataArrayRef {
+    readonly data: ZohoServerErrorResponseDataArrayElement[];
+}
+/**
+ * Array of response elements that may contain either a success or error.
+ */
+export type ZohoServerErrorResponseDataArrayElement = ZohoServerErrorData | ZohoServerSuccessData;
+/**
+ * Default place-holder used by the ZohoServerFetchResponseDataArrayError class.
+ */
+export declare const ZOHO_DATA_ARRAY_BLANK_ERROR_CODE = "__internal_data_array_blank_error";
+/**
+ * Returns true if the input value is a ZohoServerErrorResponseDataArrayRef.
+ *
+ * @param value
+ * @returns
+ */
+export declare function isZohoServerErrorResponseDataArrayRef(value: unknown): value is ZohoServerErrorResponseDataArrayRef;
+/**
+ * Returned by Zoho Recruit.
+ */
 export type ZohoServerErrorResponseDataError = ZohoServerErrorData | ZohoServerErrorCode;
+/**
+ * Returned by Zoho Recruit.
+ */
 export interface ZohoServerErrorResponseData {
     readonly error: ZohoServerErrorResponseDataError;
 }
@@ -35,6 +64,14 @@ export interface ZohoServerErrorData<T = unknown> {
      */
     readonly status?: ZohoServerErrorStatus;
 }
+/**
+ * Zoho Server Success Data
+ *
+ * Always contains a code and message. Details and status are optional.
+ */
+export type ZohoServerSuccessData<T = unknown> = Omit<ZohoServerErrorData<T>, 'code'> & {
+    readonly code: ZohoServerSuccessCode;
+};
 /**
  * Contains details and a status
  */
@@ -53,17 +90,37 @@ export declare class ZohoServerError<D extends ZohoServerErrorData = ZohoServerE
  */
 export declare class ZohoServerFetchResponseError<D extends ZohoServerErrorData = ZohoServerErrorData> extends ZohoServerError<D> {
     readonly data: D;
+    readonly errorResponseData: ZohoServerErrorResponseData | ZohoServerErrorResponseDataArrayRef;
     readonly responseError: FetchResponseError;
-    constructor(data: D, responseError: FetchResponseError);
+    constructor(data: D, errorResponseData: ZohoServerErrorResponseData | ZohoServerErrorResponseDataArrayRef, responseError: FetchResponseError);
+}
+/**
+ * Used as a transient error for situations where there are potentially multiple errors within the data array returned.
+ *
+ * Zoho CRM returns a non-200 error as a result, but generally there is a partial success that can occur, with both
+ * the successful and errored results returned within the data.
+ */
+export declare class ZohoServerFetchResponseDataArrayError extends ZohoServerFetchResponseError<ZohoServerErrorData> {
+    constructor(errorResponseData: ZohoServerErrorResponseDataArrayRef, responseError: FetchResponseError);
+    get errorDataArray(): ZohoServerErrorResponseDataArrayElement[];
 }
 export type LogZohoServerErrorFunction = (error: FetchRequestFactoryError | ZohoServerError | ZohoServerFetchResponseError) => void;
+/**
+ * Config for logZohoServerErrorFunction.
+ */
+export interface LogZohoServerErrorFunctionConfig {
+    /**
+     * If true, will log errors that are ZohoServerFetchResponseDataArrayError.
+     */
+    readonly logDataArrayErrors?: boolean;
+}
 /**
  * Creates a logZohoServerErrorFunction that logs the error to console.
  *
  * @param zohoApiNamePrefix Prefix to use when logging. I.E. ZohoRecruitError, etc.
  * @returns
  */
-export declare function logZohoServerErrorFunction(zohoApiNamePrefix: string): LogZohoServerErrorFunction;
+export declare function logZohoServerErrorFunction(zohoApiNamePrefix: string, options?: LogZohoServerErrorFunctionConfig): LogZohoServerErrorFunction;
 /**
  * Wraps a ConfiguredFetch to support handling errors returned by fetch.
  *
@@ -183,14 +240,15 @@ export declare class ZohoTooManyRequestsError extends ZohoServerFetchResponseErr
  * @param responseError
  * @returns
  */
-export declare function parseZohoServerErrorResponseData(errorResponseData: ZohoServerErrorResponseData, responseError: FetchResponseError): ZohoServerFetchResponseError | undefined;
+export declare function parseZohoServerErrorResponseData(errorResponseData: ZohoServerErrorResponseData | ZohoServerErrorResponseDataArrayRef, responseError: FetchResponseError): ZohoServerFetchResponseError | undefined;
 /**
  * Attempts to retrieve an ZohoServerErrorResponseDataError from the input.
  *
  * Non-200 errors returned by the Zoho API are returned as the object directly instead of as an ZohoServerErrorResponseData directly.
+ * Zoho CRM returns a ZohoServerErrorResponseDataArrayRef value for errors.
  *
  * @param errorResponseData
  * @param responseError
  * @returns
  */
-export declare function tryFindZohoServerErrorData(errorResponseData: ZohoServerErrorResponseData | ZohoServerErrorResponseDataError, responseError: FetchResponseError): Maybe<ZohoServerErrorResponseDataError>;
+export declare function tryFindZohoServerErrorData(errorResponseData: ZohoServerErrorResponseDataArrayRef | ZohoServerErrorResponseData | ZohoServerErrorResponseDataError, responseError: FetchResponseError): Maybe<ZohoServerErrorResponseDataError>;

package/src/lib/recruit/recruit.criteria.util.d.ts

@@ -1,10 +0,0 @@
-import { type ArrayOrValue, type EmailAddress, type PrimativeKey } from '@dereekb/util';
-import { type ZohoRecruitSearchRecordsCriteriaEntryArray } from './recruit.criteria';
-/**
- * Creates a ZohoRecruitSearchRecordsCriteriaEntryArray from an array of emails.
- *
- * @param emails Email or array of emails to search for.
- * @param field Optional field name to use. Defaults to 'Email'.
- * @returns Array of ZohoRecruitSearchRecordsCriteriaEntry
- */
-export declare function zohoRecruitSearchRecordsCriteriaEntriesForEmails<T = any>(emails: ArrayOrValue<EmailAddress>, field?: keyof T extends PrimativeKey ? PrimativeKey & keyof T : PrimativeKey): ZohoRecruitSearchRecordsCriteriaEntryArray<T>;