@dereekb/zoho 11.0.10 → 11.0.12

package/index.esm.js

@@ -3175,6 +3175,9 @@ function insertRecord(context) {
 }
 
 // MARK: Upsert Record
+/**
+ * Upsert function that can do either an insert or and update ased on the input.
+ */
 
 /**
  * Updates or inserts one or more records in Recruit.

package/nestjs/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [11.0.12](https://github.com/dereekb/dbx-components/compare/v11.0.11-dev...v11.0.12) (2024-11-24)
+
+
+
 ## [11.0.10](https://github.com/dereekb/dbx-components/compare/v11.0.9-dev...v11.0.10) (2024-11-24)
 
 

package/nestjs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/zoho/nestjs",
-  "version": "11.0.10",
+  "version": "11.0.12",
   "type": "commonjs",
   "main": "./src/index.js"
 }

package/nestjs/src/lib/recruit/recruit.api.d.ts

@@ -8,7 +8,7 @@ export declare class ZohoRecruitApi {
     get recruitContext(): ZohoRecruitContext;
     constructor(config: ZohoRecruitServiceConfig, zohoAccountsApi: ZohoAccountsApi);
     get insertRecord(): import("@dereekb/zoho").ZohoRecruitCreateRecordLikeFunction;
-    get upsertRecord(): import("@dereekb/zoho").ZohoRecruitUpsertRecordFunction;
+    get upsertRecord(): import("@dereekb/zoho").ZohoRecruitUpsertRecordLikeFunction;
     get updateRecord(): import("@dereekb/zoho").ZohoRecruitUpdateRecordLikeFunction;
     get getRecordById(): import("@dereekb/zoho").ZohoRecruitGetRecordByIdFunction;
     get getRecords(): import("@dereekb/zoho").ZohoRecruitGetRecordsFunction;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/zoho",
-  "version": "11.0.10",
+  "version": "11.0.12",
   "exports": {
     ".": {
       "types": "./src/index.d.ts",

package/src/lib/recruit/recruit.api.d.ts

@@ -1,32 +1,42 @@
 import { ZohoDataArrayResultRef, ZohoPageFilter, ZohoPageResult } from './../zoho.api.page';
 import { FetchJsonBody, FetchJsonInput, FetchPage, FetchPageFactory, FetchPageFactoryOptions, makeUrlSearchParams } from '@dereekb/util/fetch';
 import { ZohoRecruitContext } from './recruit.config';
-import { NewZohoRecruitNoteData, ZohoRecruitCommaSeparateFieldNames, ZohoRecruitCustomViewId, ZohoRecruitDraftOrSaveState, ZohoRecruitFieldName, ZohoRecruitModuleNameRef, ZohoRecruitChangeObjectDetails, ZohoRecruitRecord, ZohoRecruitRecordFieldsData, ZohoRecruitRecordId, ZohoRecruitRecordNote, ZohoRecruitSearchRecordsCriteriaTreeElement, ZohoRecruitTerritoryId, ZohoRecruitTrueFalseBoth, ZohoRecruitNoteId } from './recruit';
+import { NewZohoRecruitNoteData, ZohoRecruitCommaSeparateFieldNames, ZohoRecruitCustomViewId, ZohoRecruitDraftOrSaveState, ZohoRecruitFieldName, ZohoRecruitModuleNameRef, ZohoRecruitChangeObjectDetails, ZohoRecruitRecord, ZohoRecruitRecordId, ZohoRecruitRecordNote, ZohoRecruitSearchRecordsCriteriaTreeElement, ZohoRecruitTerritoryId, ZohoRecruitTrueFalseBoth, ZohoRecruitNoteId } from './recruit';
 import { ArrayOrValue, EmailAddress, Maybe, PhoneNumber, SortingOrder, UniqueModelWithId } from '@dereekb/util';
 import { ZohoServerErrorDataWithDetails, ZohoServerErrorStatus, ZohoServerSuccessCode, ZohoServerSuccessStatus } from '../zoho.error.api';
-export type ZohoRecruitUpdateRecordResult<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> = ZohoRecruitMultiRecordResult<RECORD_INPUT_TYPE, ZohoRecruitChangeObjectResponseSuccessEntry, ZohoRecruitChangeObjectResponseErrorEntry>;
+export type ZohoRecruitUpdateRecordResult<T> = ZohoRecruitMultiRecordResult<T, ZohoRecruitChangeObjectResponseSuccessEntry, ZohoRecruitChangeObjectResponseErrorEntry>;
 export type ZohoRecruitUpdateRecordResponse = ZohoRecruitChangeObjectResponse;
-export type ZohoRecruitCreateRecordInput<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> = ZohoRecruitCreateSingleRecordInput<RECORD_INPUT_TYPE> | ZohoRecruitCreateMultiRecordInput<RECORD_INPUT_TYPE>;
-export interface ZohoRecruitCreateSingleRecordInput<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> extends ZohoRecruitModuleNameRef {
-    readonly data: RECORD_INPUT_TYPE;
+export type ZohoRecruitCreateRecordData<T> = Omit<T, 'id'>;
+export interface ZohoRecruitCreateSingleRecordInput<T> extends ZohoRecruitModuleNameRef {
+    readonly data: ZohoRecruitCreateRecordData<T>;
 }
-export interface ZohoRecruitCreateMultiRecordInput<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> extends ZohoRecruitModuleNameRef {
-    readonly data: RECORD_INPUT_TYPE[];
+export interface ZohoRecruitCreateMultiRecordInput<T> extends ZohoRecruitModuleNameRef {
+    readonly data: ZohoRecruitCreateRecordData<T>[];
 }
 export type ZohoRecruitCreateRecordLikeFunction = ZohoRecruitCreateMultiRecordFunction & ZohoRecruitCreateSingleRecordFunction;
-export type ZohoRecruitCreateSingleRecordFunction = <RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData>(input: ZohoRecruitCreateSingleRecordInput<RECORD_INPUT_TYPE>) => Promise<ZohoRecruitChangeObjectDetails>;
-export type ZohoRecruitCreateMultiRecordFunction = <RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData>(input: ZohoRecruitCreateMultiRecordInput<RECORD_INPUT_TYPE>) => Promise<ZohoRecruitUpdateRecordResult<RECORD_INPUT_TYPE>>;
-export type ZohoRecruitUpdateRecordInput<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> = ZohoRecruitUpdateSingleRecordInput<RECORD_INPUT_TYPE> | ZohoRecruitUpdateMultiRecordInput<RECORD_INPUT_TYPE>;
-export type ZohoRecruitUpdateRecordData<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> = UniqueModelWithId & Partial<RECORD_INPUT_TYPE>;
-export interface ZohoRecruitUpdateSingleRecordInput<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> extends ZohoRecruitModuleNameRef {
-    readonly data: ZohoRecruitUpdateRecordData<RECORD_INPUT_TYPE>;
+export type ZohoRecruitCreateSingleRecordFunction = <T>(input: ZohoRecruitCreateSingleRecordInput<T>) => Promise<ZohoRecruitChangeObjectDetails>;
+export type ZohoRecruitCreateMultiRecordFunction = <T>(input: ZohoRecruitCreateMultiRecordInput<T>) => Promise<ZohoRecruitUpdateRecordResult<T>>;
+export type ZohoRecruitUpdateRecordInput<T> = ZohoRecruitUpdateSingleRecordInput<T> | ZohoRecruitUpdateMultiRecordInput<T>;
+export type ZohoRecruitUpdateRecordData<T> = UniqueModelWithId & Partial<T>;
+export interface ZohoRecruitUpdateSingleRecordInput<T> extends ZohoRecruitModuleNameRef {
+    readonly data: ZohoRecruitUpdateRecordData<T>;
 }
-export interface ZohoRecruitUpdateMultiRecordInput<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> extends ZohoRecruitModuleNameRef {
-    readonly data: ZohoRecruitUpdateRecordData<RECORD_INPUT_TYPE>[];
+export interface ZohoRecruitUpdateMultiRecordInput<T> extends ZohoRecruitModuleNameRef {
+    readonly data: ZohoRecruitUpdateRecordData<T>[];
 }
 export type ZohoRecruitUpdateRecordLikeFunction = ZohoRecruitUpdateMultiRecordFunction & ZohoRecruitUpdateSingleRecordFunction;
-export type ZohoRecruitUpdateMultiRecordFunction = <RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData>(input: ZohoRecruitUpdateMultiRecordInput<RECORD_INPUT_TYPE>) => Promise<ZohoRecruitUpdateRecordResult<RECORD_INPUT_TYPE>>;
-export type ZohoRecruitUpdateSingleRecordFunction = <RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData>(input: ZohoRecruitUpdateSingleRecordInput<RECORD_INPUT_TYPE>) => Promise<ZohoRecruitChangeObjectDetails>;
+export type ZohoRecruitUpdateMultiRecordFunction = <T>(input: ZohoRecruitUpdateMultiRecordInput<T>) => Promise<ZohoRecruitUpdateRecordResult<T>>;
+export type ZohoRecruitUpdateSingleRecordFunction = <T>(input: ZohoRecruitUpdateSingleRecordInput<T>) => Promise<ZohoRecruitChangeObjectDetails>;
+export type ZohoRecruitUpsertRecordData<T> = ZohoRecruitCreateRecordData<T> | ZohoRecruitUpdateRecordData<T>;
+export interface ZohoRecruitUpsertSingleRecordInput<T> extends ZohoRecruitModuleNameRef {
+    readonly data: ZohoRecruitUpsertRecordData<T>;
+}
+export interface ZohoRecruitUpsertMultiRecordInput<T> extends ZohoRecruitModuleNameRef {
+    readonly data: ZohoRecruitUpsertRecordData<T>[];
+}
+export type ZohoRecruitUpsertRecordLikeFunction = ZohoRecruitUpsertMultiRecordFunction & ZohoRecruitUpsertSingleRecordFunction;
+export type ZohoRecruitUpsertMultiRecordFunction = <T>(input: ZohoRecruitUpsertMultiRecordInput<T>) => Promise<ZohoRecruitUpdateRecordResult<T>>;
+export type ZohoRecruitUpsertSingleRecordFunction = <T>(input: ZohoRecruitUpsertSingleRecordInput<T>) => Promise<ZohoRecruitChangeObjectDetails>;
 export type ZohoRecruitInsertRecordFunction = ZohoRecruitCreateRecordLikeFunction;
 /**
  * Inserts one or more records into Recruit.
@@ -37,7 +47,10 @@ export type ZohoRecruitInsertRecordFunction = ZohoRecruitCreateRecordLikeFunctio
  * @returns
  */
 export declare function insertRecord(context: ZohoRecruitContext): ZohoRecruitInsertRecordFunction;
-export type ZohoRecruitUpsertRecordFunction = ZohoRecruitCreateRecordLikeFunction & ZohoRecruitUpdateRecordLikeFunction;
+/**
+ * Upsert function that can do either an insert or and update ased on the input.
+ */
+export type ZohoRecruitUpsertRecordFunction = ZohoRecruitUpsertRecordLikeFunction;
 /**
  * Updates or inserts one or more records in Recruit.
  *
@@ -60,9 +73,9 @@ export declare function updateRecord(context: ZohoRecruitContext): ZohoRecruitUp
 export interface ZohoRecruitGetRecordByIdInput extends ZohoRecruitModuleNameRef {
     readonly id: ZohoRecruitRecordId;
 }
-export type ZohoRecruitGetRecordByIdResponse<T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecord> = ZohoDataArrayResultRef<T>;
-export type ZohoRecruitGetRecordByIdResult<T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecord> = T;
-export type ZohoRecruitGetRecordByIdFunction = <T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecord>(input: ZohoRecruitGetRecordByIdInput) => Promise<ZohoRecruitGetRecordByIdResult<T>>;
+export type ZohoRecruitGetRecordByIdResponse<T = ZohoRecruitRecord> = ZohoDataArrayResultRef<T>;
+export type ZohoRecruitGetRecordByIdResult<T = ZohoRecruitRecord> = T;
+export type ZohoRecruitGetRecordByIdFunction = <T = ZohoRecruitRecord>(input: ZohoRecruitGetRecordByIdInput) => Promise<ZohoRecruitGetRecordByIdResult<T>>;
 /**
  * Retrieves a specific record from the given module.
  *
@@ -85,8 +98,8 @@ export interface ZohoRecruitGetRecordsInput extends ZohoRecruitModuleNameRef, Zo
     readonly include_child?: boolean;
     readonly $state?: ZohoRecruitDraftOrSaveState;
 }
-export type ZohoRecruitGetRecordsResponse<T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecord> = ZohoPageResult<T>;
-export type ZohoRecruitGetRecordsFunction = <T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecord>(input: ZohoRecruitGetRecordsInput) => Promise<ZohoRecruitGetRecordsResponse<T>>;
+export type ZohoRecruitGetRecordsResponse<T = ZohoRecruitRecord> = ZohoPageResult<T>;
+export type ZohoRecruitGetRecordsFunction = <T = ZohoRecruitRecord>(input: ZohoRecruitGetRecordsInput) => Promise<ZohoRecruitGetRecordsResponse<T>>;
 /**
  * Retrieves records from the given module. Used for paginating across all records.
  *
@@ -101,14 +114,14 @@ export declare function getRecords(context: ZohoRecruitContext): ZohoRecruitGetR
  *
  * Only criteria, email, phone, or word will be used at a single time.
  */
-export interface ZohoRecruitSearchRecordsInput<T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecord> extends ZohoRecruitModuleNameRef, ZohoRecruitGetRecordsPageFilter {
+export interface ZohoRecruitSearchRecordsInput<T = ZohoRecruitRecord> extends ZohoRecruitModuleNameRef, ZohoRecruitGetRecordsPageFilter {
     readonly criteria?: Maybe<ZohoRecruitSearchRecordsCriteriaTreeElement<T>>;
     readonly email?: Maybe<EmailAddress>;
     readonly phone?: Maybe<PhoneNumber>;
     readonly word?: Maybe<string>;
 }
-export type ZohoRecruitSearchRecordsResponse<T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecord> = ZohoRecruitGetRecordsResponse<T>;
-export type ZohoRecruitSearchRecordsFunction = <T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecord>(input: ZohoRecruitSearchRecordsInput<T>) => Promise<ZohoRecruitSearchRecordsResponse<T>>;
+export type ZohoRecruitSearchRecordsResponse<T = ZohoRecruitRecord> = ZohoRecruitGetRecordsResponse<T>;
+export type ZohoRecruitSearchRecordsFunction = <T = ZohoRecruitRecord>(input: ZohoRecruitSearchRecordsInput<T>) => Promise<ZohoRecruitSearchRecordsResponse<T>>;
 /**
  * Searches records from the given module.
  *
@@ -118,7 +131,7 @@ export type ZohoRecruitSearchRecordsFunction = <T extends ZohoRecruitRecordField
  * @returns
  */
 export declare function searchRecords(context: ZohoRecruitContext): ZohoRecruitSearchRecordsFunction;
-export type SearchRecordsPageFactory = <T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecord>(input: ZohoRecruitSearchRecordsInput<T>, options?: FetchPageFactoryOptions<ZohoRecruitSearchRecordsInput<T>, ZohoRecruitSearchRecordsResponse<T>>) => FetchPage<ZohoRecruitSearchRecordsInput<T>, ZohoRecruitSearchRecordsResponse<T>>;
+export type SearchRecordsPageFactory = <T = ZohoRecruitRecord>(input: ZohoRecruitSearchRecordsInput<T>, options?: Maybe<FetchPageFactoryOptions<ZohoRecruitSearchRecordsInput<T>, ZohoRecruitSearchRecordsResponse<T>>>) => FetchPage<ZohoRecruitSearchRecordsInput<T>, ZohoRecruitSearchRecordsResponse<T>>;
 export declare function searchRecordsPageFactory(context: ZohoRecruitContext): SearchRecordsPageFactory;
 export interface ZohoRecruitCreateNotesRequest {
     readonly data: ZohoRecruitCreateNotesRequestEntry[];

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

@@ -91,7 +91,7 @@ export interface ZohoRecordDraftStateData {
      */
     $state?: ZohoRecruitDraftOrSaveState;
 }
-export type NewZohoRecruitRecordData<T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecordFieldsData> = T & ZohoRecordDraftStateData;
+export type NewZohoRecruitRecordData<T = ZohoRecruitRecordFieldsData> = T & ZohoRecordDraftStateData;
 /**
  * A ZohoRecruit record containing the corresponding record's id.
  */
@@ -119,14 +119,14 @@ export type ZohoRecruitSearchRecordsCriteriaString = string;
  *
  * If the input tree is empty, returns undefined.
  */
-export declare function zohoRecruitSearchRecordsCriteriaString<T extends ZohoRecruitRecordFieldsData = any>(input: Maybe<ZohoRecruitSearchRecordsCriteriaTreeElement<T>>): Maybe<ZohoRecruitSearchRecordsCriteriaString>;
-export declare function zohoRecruitSearchRecordsCriteriaStringForTree<T extends ZohoRecruitRecordFieldsData = any>(tree: ZohoRecruitSearchRecordsCriteriaTree<T>): Maybe<ZohoRecruitSearchRecordsCriteriaString>;
+export declare function zohoRecruitSearchRecordsCriteriaString<T = any>(input: Maybe<ZohoRecruitSearchRecordsCriteriaTreeElement<T>>): Maybe<ZohoRecruitSearchRecordsCriteriaString>;
+export declare function zohoRecruitSearchRecordsCriteriaStringForTree<T = any>(tree: ZohoRecruitSearchRecordsCriteriaTree<T>): Maybe<ZohoRecruitSearchRecordsCriteriaString>;
 /**
  * Tree items
  *
  * If both AND and OR values are provided at the root tree, then the will be merged together with AND.
  */
-export interface ZohoRecruitSearchRecordsCriteriaTree<T extends ZohoRecruitRecordFieldsData = any> {
+export interface ZohoRecruitSearchRecordsCriteriaTree<T = any> {
     /**
      * Items to AND with eachother
      */
@@ -136,10 +136,10 @@ export interface ZohoRecruitSearchRecordsCriteriaTree<T extends ZohoRecruitRecor
      */
     readonly or?: Maybe<ZohoRecruitSearchRecordsCriteriaTreeElement<T>[]>;
 }
-export type ZohoRecruitSearchRecordsCriteriaTreeElement<T extends ZohoRecruitRecordFieldsData = any> = ZohoRecruitSearchRecordsCriteriaEntryArray<T> | ZohoRecruitSearchRecordsCriteriaTree | ZohoRecruitSearchRecordsCriteriaString;
+export type ZohoRecruitSearchRecordsCriteriaTreeElement<T = any> = ZohoRecruitSearchRecordsCriteriaEntryArray<T> | ZohoRecruitSearchRecordsCriteriaTree | ZohoRecruitSearchRecordsCriteriaString;
 export type ZohoRecruitSearchRecordsCriteriaFilterType = 'starts_with' | 'equals' | 'contains';
-export type ZohoRecruitSearchRecordsCriteriaEntryArray<T extends ZohoRecruitRecordFieldsData = any> = ZohoRecruitSearchRecordsCriteriaEntry<T>[];
-export interface ZohoRecruitSearchRecordsCriteriaEntry<T extends ZohoRecruitRecordFieldsData = any> {
+export type ZohoRecruitSearchRecordsCriteriaEntryArray<T = any> = ZohoRecruitSearchRecordsCriteriaEntry<T>[];
+export interface ZohoRecruitSearchRecordsCriteriaEntry<T = any> {
     readonly field: keyof T extends PrimativeKey ? keyof T : PrimativeKey;
     readonly filter: ZohoRecruitSearchRecordsCriteriaFilterType;
     readonly value: string;
@@ -154,7 +154,7 @@ export declare const escapeZohoFieldValueForCriteriaString: import("@dereekb/uti
  * @param entry
  * @returns
  */
-export declare function zohoRecruitSearchRecordsCriteriaEntryToCriteriaString<T extends ZohoRecruitRecordFieldsData = any>(entry: ZohoRecruitSearchRecordsCriteriaEntry<T>): ZohoRecruitSearchRecordsCriteriaString;
+export declare function zohoRecruitSearchRecordsCriteriaEntryToCriteriaString<T = any>(entry: ZohoRecruitSearchRecordsCriteriaEntry<T>): ZohoRecruitSearchRecordsCriteriaString;
 export type ZohoRecruitNoteId = string;
 export interface ZohoRecruitNoteAction {
     $is_system_action: boolean;

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

@@ -1,4 +1,4 @@
-import { PageNumber } from '@dereekb/util';
+import { Maybe, PageNumber } from '@dereekb/util';
 import { FetchPageFactoryConfigDefaults } from '@dereekb/util/fetch';
 /**
  * Base page filter
@@ -57,4 +57,4 @@ export type ZohoFetchPageFetchFunction<I extends ZohoPageFilter, R extends ZohoP
  * @param defaults
  * @returns
  */
-export declare function zohoFetchPageFactory<I extends ZohoPageFilter, R extends ZohoPageResult<any>>(fetch: ZohoFetchPageFetchFunction<I, R>, defaults?: FetchPageFactoryConfigDefaults): import("@dereekb/util/fetch").FetchPageFactory<I, R>;
+export declare function zohoFetchPageFactory<I extends ZohoPageFilter, R extends ZohoPageResult<any>>(fetch: ZohoFetchPageFetchFunction<I, R>, defaults?: Maybe<FetchPageFactoryConfigDefaults>): import("@dereekb/util/fetch").FetchPageFactory<I, R>;