feat: [sf,hs] batch gets (#133)

* feat: [sf,hs] batch gets

* updating version and adding missing cursor logic piece

Author: manas-vessel

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vesselapi/integrations",
-  "version": "0.0.98",
+  "version": "0.0.99",
   "description": "Vessel integrations",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

src/platforms/hubspot/client.ts

@@ -173,16 +173,24 @@ const makeClient = () => {
     schema: z.ZodSchema,
     properties?: string[],
   ): requestFunctionType<BatchReadObjectInput, TOutput> =>
-    request(({ ids }: BatchReadObjectInput) => ({
-      url: `/crm/${API_VERSION}/${module}/batch/read`,
-      method: 'POST',
-      json: {
-        properties: properties ?? null,
-        inputs: ids.map((id) => ({ id })),
-        propertiesWithHistory: null,
-      },
-      schema,
-    }));
+    request(
+      ({
+        ids,
+        after,
+        limit = HUBSPOT_MAX_PAGE_SIZE,
+      }: BatchReadObjectInput) => ({
+        url: `/crm/${API_VERSION}/${module}/batch/read`,
+        method: 'POST',
+        json: {
+          properties: properties ?? null,
+          inputs: ids.map((id) => ({ id })),
+          propertiesWithHistory: null,
+          limit,
+          after,
+        },
+        schema,
+      }),
+    );
 
   const crud = <
     TCreate extends Record<string, unknown>,
@@ -220,6 +228,10 @@ const makeClient = () => {
         'owners',
         listResponseSchema(hubspotOwnerSchema),
       ),
+      batchRead: batchReadObject<ListOutput<HubspotOwner>>(
+        'owners',
+        listResponseSchema(hubspotOwnerSchema),
+      ),
     },
     contacts: crud<HubspotContactCreate, HubspotContactUpdate, HubspotContact>(
       'objects/contacts',

src/platforms/hubspot/schemas.ts

@@ -24,7 +24,7 @@ export type ListObjectInput = {
 };
 export type BatchReadObjectInput = {
   ids: string[];
-};
+} & ListObjectInput;
 export type ListOutput<T> = {
   results?: T[];
   paging?: {

src/platforms/salesforce/actions/query-builder.ts

@@ -84,6 +84,27 @@ export const salesforceQueryBuilder: Record<
       LIMIT ${limit}
     `);
   },
+  batchRead: ({
+    ids,
+    objectType,
+    relationalSelect,
+    associations,
+  }: {
+    ids: string[];
+    objectType: SalesforceSupportedObjectType;
+    relationalSelect?: Partial<Record<SalesforceSupportedObjectType, string>>;
+    associations?: SalesforceSupportedObjectType[];
+  }) => {
+    const selectClauses = sift([
+      'SELECT FIELDS(ALL)',
+      buildRelationalSelectClause(relationalSelect, associations),
+    ]);
+    return formatQuery(`
+      ${selectClauses.join(', ')}
+      FROM ${objectType}
+      WHERE Id IN ('${ids.join("','")}')
+    `);
+  },
   listListView: ({
     objectType,
     cursor,

src/platforms/salesforce/client.ts

@@ -144,6 +144,35 @@ const query = {
         }),
       }),
     ),
+  batchRead: <T extends z.ZodType>({
+    schema,
+    objectType,
+    relationalSelect,
+  }: {
+    schema: T;
+    objectType: SalesforceSupportedObjectType;
+    relationalSelect?: Partial<Record<SalesforceSupportedObjectType, string>>;
+  }) =>
+    request(
+      ({
+        Ids,
+        associations,
+      }: {
+        Ids: string[];
+        associations?: SalesforceSupportedObjectType[];
+      }) => ({
+        url: `/query/?q=${salesforceQueryBuilder.batchRead({
+          ids: Ids,
+          objectType,
+          relationalSelect,
+          associations,
+        })}`,
+        method: 'GET',
+        schema: z.object({
+          records: z.array(schema),
+        }),
+      }),
+    ),
 };
 
 export const client = {
@@ -166,7 +195,11 @@ export const client = {
       method: 'GET',
       schema: salesforceUser,
     })),
-    list: query.list({
+    list: query.list<typeof salesforceUser>({
+      objectType: 'User',
+      schema: salesforceUser,
+    }),
+    batchRead: query.batchRead<typeof salesforceUser>({
       objectType: 'User',
       schema: salesforceUser,
     }),
@@ -180,6 +213,10 @@ export const client = {
       objectType: 'Contact',
       schema: salesforceContact,
     }),
+    batchRead: query.batchRead<typeof salesforceContact>({
+      objectType: 'Contact',
+      schema: salesforceContact,
+    }),
     create: request(({ Contact }: SalesforceContactCreate) => ({
       url: `/sobjects/Contact`,
       method: 'POST',
@@ -255,6 +292,11 @@ export const client = {
       schema: salesforceAccount,
       relationalSelect: salesforceAccountRelationalSelect,
     }),
+    batchRead: query.batchRead<typeof salesforceAccount>({
+      objectType: 'Account',
+      schema: salesforceAccount,
+      relationalSelect: salesforceAccountRelationalSelect,
+    }),
     create: request(({ Account }: SalesforceAccountCreate) => ({
       url: `/sobjects/Account`,
       method: 'POST',
@@ -282,6 +324,10 @@ export const client = {
       objectType: 'Opportunity',
       schema: salesforceOpportunity,
     }),
+    batchRead: query.batchRead({
+      objectType: 'Opportunity',
+      schema: salesforceOpportunity,
+    }),
     create: request(({ Opportunity }: SalesforceOpportunityCreate) => ({
       url: `/sobjects/Opportunity`,
       method: 'POST',
@@ -309,6 +355,10 @@ export const client = {
       objectType: 'Lead',
       schema: salesforceLead,
     }),
+    batchRead: query.batchRead<typeof salesforceLead>({
+      objectType: 'Lead',
+      schema: salesforceLead,
+    }),
     create: request(({ Lead }: SalesforceLeadCreate) => ({
       url: `/sobjects/Lead`,
       method: 'POST',
@@ -338,6 +388,11 @@ export const client = {
       schema: salesforceNote,
       relationalSelect: salesforceNoteRelationalSelect,
     }),
+    batchRead: query.batchRead<typeof salesforceNote>({
+      objectType: 'Note',
+      schema: salesforceNote,
+      relationalSelect: salesforceNoteRelationalSelect,
+    }),
     create: request(({ Note }: SalesforceNoteCreate) => ({
       url: `/sobjects/Note`,
       method: 'POST',
@@ -367,6 +422,11 @@ export const client = {
       schema: salesforceContentNote,
       relationalSelect: salesforceContentNoteRelationalSelect,
     }),
+    batchRead: query.batchRead<typeof salesforceContentNote>({
+      objectType: 'ContentNote',
+      schema: salesforceContentNote,
+      relationalSelect: salesforceContentNoteRelationalSelect,
+    }),
     create: request(({ ContentNote }: SalesforceContentNoteCreate) => ({
       url: `/sobjects/ContentNote`,
       method: 'POST',
@@ -411,6 +471,11 @@ export const client = {
       schema: salesforceTask,
       relationalSelect: salesforceTaskRelationalSelect,
     }),
+    batchRead: query.batchRead<typeof salesforceTask>({
+      objectType: 'Task',
+      schema: salesforceTask,
+      relationalSelect: salesforceTaskRelationalSelect,
+    }),
     create: request(({ Task }: SalesforceTaskCreate) => ({
       url: `/sobjects/Task`,
       method: 'POST',
@@ -440,6 +505,11 @@ export const client = {
       schema: salesforceEvent,
       relationalSelect: salesforceEventRelationalSelect,
     }),
+    batchRead: query.batchRead<typeof salesforceEvent>({
+      objectType: 'Event',
+      schema: salesforceEvent,
+      relationalSelect: salesforceEventRelationalSelect,
+    }),
     create: request(({ Event }: SalesforceEventCreate) => ({
       url: `/sobjects/Event`,
       method: 'POST',
@@ -467,6 +537,10 @@ export const client = {
       objectType: 'EventRelation',
       schema: salesforceEventRelation,
     }),
+    batchRead: query.batchRead<typeof salesforceEventRelation>({
+      objectType: 'EventRelation',
+      schema: salesforceEventRelation,
+    }),
     create: request(({ EventRelation }: SalesforceEventRelationCreate) => ({
       url: `/sobjects/EventRelation`,
       method: 'POST',
@@ -496,6 +570,11 @@ export const client = {
       schema: salesforceEmailMessage,
       relationalSelect: salesforceEmailMessageRelationalSelect,
     }),
+    batchRead: query.batchRead<typeof salesforceEmailMessage>({
+      objectType: 'EmailMessage',
+      schema: salesforceEmailMessage,
+      relationalSelect: salesforceEmailMessageRelationalSelect,
+    }),
     create: request(({ EmailMessage }: SalesforceEmailMessageCreate) => ({
       url: `/sobjects/EmailMessage`,
       method: 'POST',
@@ -523,6 +602,10 @@ export const client = {
       objectType: 'EmailMessageRelation',
       schema: salesforceEmailMessageRelation,
     }),
+    batchRead: query.batchRead<typeof salesforceEmailMessageRelation>({
+      objectType: 'EmailMessageRelation',
+      schema: salesforceEmailMessageRelation,
+    }),
     create: request(
       ({ EmailMessageRelation }: SalesforceEmailMessageRelationCreate) => ({
         url: `/sobjects/EmailMessageRelation`,