feat(core): Define types for performBulk

[kola-er]

No description provided.

[kola-er]

@eliangcs Is this the test you referred to in the ticket or a manual one?

[kola-er]

Also, the Bundle and the new BulkBundle are mixed up in the failing tests in this file. I'm confused about this.

[eliangcs]

@kola-er sorry for the confusion! A manual test should be enough: Manually create a TypeScript integration project, add a create with performBulk, and use the new index.d.ts to see it's working as expected.

[kola-er]

Thank you.

[eliangcs]

I tested the new index.d.ts with this example:

import {
  ZObject,
  BulkBundle,
  PerformBulkResult,
} from 'zapier-platform-core';

const performBulk = async (
  z: ZObject,
  bundle: BulkBundle<{ title: string; year: number }>
): Promise<PerformBulkResult> => {
  const movies = bundle.bulk.map((b) => {
    return {
      _idempotencyKey: b.meta.id,
      title: b.inputData.title,
      year: b.inputData.year,
    };
  });
  const response = await z.request({
    method: 'POST',
    url: 'https://example.com/api/movies/',
    body: {
      objects: movies,
    },
  });
  return movies.reduce(
    (result: PerformBulkResult, movie: { [x: string]: any }) => {
      result[movie._idempotencyKey] = {
        outputData: {
          title: movie.title,
          year: movie.year,
        },
      };
      return result;
    },
    {}
  );
};

export default {
  key: 'movie',
  noun: 'Movie',

  display: {
    label: 'Create Movie',
    description: 'Creates a new movie.',
  },

  operation: {
    performBulk,
    inputFields: [
      { key: 'title', required: true },
      { key: 'year', type: 'integer' },
    ],
    sample: {
      id: '1',
      title: 'example',
    },
  },
};

It works great! It was able to detect type issues. For example, when I replaced outputData with outputData2, my IDE would show:

'outputData2' does not exist in type 'PerformBulkResult`

which is good 👍

Remove the new code you added in example-apps/typescript and then I think this is good to merge. Thanks!

[eliangcs]

To be consistent with #785, only one of outputData or error is required. Maybe we could do this with two interfaces?

export interface PerformBulkSuccessItem {
  outputData: { [x: string]: any };
}

export interface PreformBulkErrorItem {
  error: string;
}

export type PerformBulkItem = PerformBulkSuccessItem | PerformBulkErrorItem;

[kola-er]

I think these are the possible cases (outputData and error) or (outputData) or (error) for the and/or ;

export interface PerformBulkSuccessItem {
  outputData: { [x: string]: any };
  error?: string;
}

export interface PreformBulkErrorItem {
  outputData?: { [x: string]: any };
  error: string;
}

export type PerformBulkItem = PerformBulkSuccessItem | PerformBulkErrorItem;

What do you think?

[eliangcs]

So outputData and error can coexist. That makes sense!