TS attachment required fields

[MalkovVladimir]

Airtable documentation:

When creating an attachment, url is required, and filename is optional.

Attachment interface:

export interface Attachment {
    id: string;
    url: string;
    filename: string;
    size: number;
    type: string;
    thumbnails?: {
        small: Thumbnail;
        large: Thumbnail;
        full: Thumbnail;
    };
}

filename, size, type etc. not so optional.

Please do props optional or split type for different actions (create/update/delete).

[albreyb]

Hey @MalkovVladimir, thank you for the suggestion. Our team will review and get back to you when we've decided how to move forward.

[tresorama]

It will be great to have this bug fixed.
This bug occurs both when using AirtableTable.create() and when using AirtableTable.update().

Until the bug is fixed, i managed this bug like this:

//
const AiirtableClient = new Airtable({ apiKey: AIRTABLE_API_KEY });
const AirtableBase = AirtableClient.base(AIRTABLE_BASE_ID);
const TableBooks = AirtableBase(AIRTABLE_TABLE_ID_BOOKS);

const createNewRecord = () => {
  return {
    fields: {
    pic: [{ url: 'http://my-fancy-image.com/imageeeeee.jpg' }],
    title: "My Superb Book",
    year: "2001",
  }
};

/* ============================================== */
//  before - this trigger TS error
/* ============================================== */
const newRecord = createNewRecord();
const createdRecords = await TableBooks.create([newRecord]); // TS-Error ...
const createdRecord = createdRecords[0]; // TS-Error ...

/* ============================================== */
// after - this illude TS and suppress error
/* ============================================== */

// TODO: there is a bug in the Airtable code, and an open issue
// https://github.com/Airtable/airtable.js/issues/277
// When the bug is resolved update the use of next line

const newRecord_tsErrorSolutionHack = createNewRecord() as unknown as { fields: Airtable.FieldSet };
const createdRecords = await TableBooks.create([newRecord_tsErrorSolutionHack]);
const createdRecord = createdRecords[0];

Happy coding.

[naclcaleb]

@albreyb still having this issue in 2023