index.tsβ’12.6 kB
import {
AuthenticationType,
HttpMethod,
HttpRequest,
httpClient,
} from '@activepieces/pieces-common';
import { DynamicPropsValue, Property } from '@activepieces/pieces-framework';
import Airtable from 'airtable';
import {
AirtableBase,
AirtableEnterpriseFields,
AirtableField,
AirtableFieldMapping,
AirtableRecord,
AirtableTable,
AirtableView,
} from './models';
import { isNil } from '@activepieces/shared';
export const airtableCommon = {
base: Property.Dropdown({
displayName: 'Base',
required: true,
refreshers: [],
options: async ({ auth }) => {
if (!auth) {
return {
disabled: true,
options: [],
placeholder: 'Please connect your account',
};
}
try {
const response = await httpClient.sendRequest<{
bases: AirtableBase[];
}>({
method: HttpMethod.GET,
url: 'https://api.airtable.com/v0/meta/bases',
authentication: {
type: AuthenticationType.BEARER_TOKEN,
token: auth as string,
},
});
if (response.status === 200) {
return {
disabled: false,
options: response.body.bases.map((base) => {
return { value: base.id, label: base.name };
}),
};
}
} catch (e) {
console.debug(e);
return {
disabled: true,
options: [],
placeholder: 'Please check your permission scope',
};
}
return {
disabled: true,
options: [],
};
},
}),
tableId: Property.Dropdown<string>({
displayName: 'Table',
required: true,
refreshers: ['base'],
options: async ({ auth, base }) => {
if (!auth) {
return {
disabled: true,
options: [],
placeholder: 'Please connect your account',
};
}
if (!base) {
return {
disabled: true,
options: [],
placeholder: 'Please select a base first',
};
}
try {
const tables: AirtableTable[] = await airtableCommon.fetchTableList({
token: auth as string,
baseId: base as string,
});
if (tables) {
return {
disabled: false,
options: tables.map((table) => ({
value: table.id,
label: table.name,
})),
};
}
} catch (e) {
console.debug(e);
return {
disabled: true,
options: [],
placeholder: 'Please check your permission scope',
};
}
return {
disabled: true,
options: [],
};
},
}),
views: Property.Dropdown<string>({
displayName: 'View',
required: false,
refreshers: ['base', 'tableId'],
options: async ({ auth, base, tableId }) => {
if (!auth) {
return {
disabled: true,
options: [],
placeholder: 'Please connect your account',
};
}
if (!base) {
return {
disabled: true,
options: [],
placeholder: 'Please select a base first',
};
}
if (!tableId) {
return {
disabled: true,
options: [],
placeholder: 'Please select a table first',
};
}
const views: AirtableView[] = await airtableCommon.fetchViews({
token: auth as string,
baseId: base as string,
tableId: tableId as string,
});
if (views) {
return {
disabled: false,
options: views.map((view) => ({
value: view.id,
label: view.name,
})),
};
}
return {
disabled: true,
options: [],
};
},
}),
recordId: Property.ShortText({
displayName: 'Record ID',
required: true,
description:
'The ID of the record you want to update. You can find the record ID by clicking on the record and then clicking on the share button. The ID will be in the URL.',
}),
fields: Property.DynamicProperties({
displayName: 'Table',
required: true,
refreshers: ['base', 'tableId'],
props: async ({ auth, base, tableId }) => {
if (!auth) return {};
if (!base) return {};
if (!tableId) return {};
const airtable: AirtableTable = await airtableCommon.fetchTable({
token: auth as unknown as string,
baseId: base as unknown as string,
tableId: tableId as unknown as string,
});
const fields = airtable.fields.reduce((acc, field) => {
if (!AirtableEnterpriseFields.includes(field.type)) {
const params = {
displayName: field.name,
description: ['date', 'dateTime'].includes(field.type)
? `${
field.description ? field.description : ''
}Expected format: mmmm d,yyyy`
: field.description,
required: false,
};
if (isNil(AirtableFieldMapping[field.type])) {
acc[field.id] = Property.ShortText({
...params,
});
} else if (
field.type === 'singleSelect' ||
field.type === 'multipleSelects'
) {
const options = field.options?.choices.map(
(option: { id: string; name: string }) => ({
value: option.id,
label: option.name,
})
);
acc[field.id] = AirtableFieldMapping[field.type]({
...params,
options: {
options: options ?? [],
},
});
} else {
acc[field.id] = AirtableFieldMapping[field.type](params);
}
}
return acc;
}, {} as DynamicPropsValue);
return fields;
},
}),
fieldNames: Property.Dropdown({
displayName: 'Search Field',
required: true,
refreshers: ['base', 'tableId'],
options: async ({ auth, base, tableId }) => {
if (!auth) {
return {
disabled: true,
options: [],
placeholder: 'Please connect your account',
};
}
if (!base) {
return {
disabled: true,
options: [],
placeholder: 'Please select a base first',
};
}
if (!tableId) {
return {
disabled: true,
options: [],
placeholder: 'Please select a table first',
};
}
const airtable: AirtableTable = await airtableCommon.fetchTable({
token: auth as unknown as string,
baseId: base as unknown as string,
tableId: tableId as unknown as string,
});
return {
disabled: false,
options: airtable.fields.map((field: AirtableField) => ({
label: field.name,
value: field.name,
})),
};
},
}),
async createNewFields(
auth: string,
base: string,
tableId: string,
fields: Record<string, unknown>
) {
if (!auth) return fields;
if (!base) return fields;
if (!tableId) return fields;
const newFields: Record<string, unknown> = {};
const airtable: AirtableTable = await airtableCommon.fetchTable({
token: auth,
baseId: base,
tableId: tableId,
});
airtable.fields.forEach((field) => {
if (!AirtableEnterpriseFields.includes(field.type)) {
const key = field.id;
if (field.type === 'multipleAttachments' && fields[key]) {
newFields[key] = [
{
url: fields[key] as string,
},
];
} else if (
['multipleRecordLinks', 'multipleSelects'].includes(field.type)
) {
if (Array.isArray(fields[key]) && (fields[key] as any[]).length > 0) {
newFields[key] = fields[key];
}
} else {
newFields[key] = fields[key];
}
}
});
return newFields;
},
async getTableSnapshot(params: Params) {
Airtable.configure({
apiKey: params.personalToken,
});
const airtable = new Airtable();
const currentTableSnapshot = (
await airtable
.base(params.baseId)
.table(params.tableId)
.select(params.limitToView ? { view: params.limitToView } : {})
.all()
)
.map((r) => r._rawJson)
.sort(
(x, y) =>
new Date(x.createdTime).getTime() - new Date(y.createdTime).getTime()
);
return currentTableSnapshot;
},
async fetchTableList({
token,
baseId,
}: {
token: string;
baseId: string;
}): Promise<AirtableTable[]> {
const response = await httpClient.sendRequest<{ tables: AirtableTable[] }>({
method: HttpMethod.GET,
url: `https://api.airtable.com/v0/meta/bases/${baseId}/tables`,
authentication: {
type: AuthenticationType.BEARER_TOKEN,
token,
},
});
if (response.status === 200) {
return response.body.tables;
}
return [];
},
async fetchTable({
token,
baseId,
tableId,
}: {
token: string;
baseId: string;
tableId: string;
}) {
const response = await airtableCommon.fetchTableList({ token, baseId });
return response.find((t) => t.id === tableId)!;
},
async fetchViews({
token,
baseId,
tableId,
}: {
token: string;
baseId: string;
tableId: string;
}) {
const response = await httpClient.sendRequest<{ tables: AirtableTable[] }>({
method: HttpMethod.GET,
url: `https://api.airtable.com/v0/meta/bases/${baseId}/tables`,
authentication: {
type: AuthenticationType.BEARER_TOKEN,
token,
},
});
const table = response.body.tables.find((table) => table.id === tableId);
if (table) {
return table.views;
}
return [];
},
async createRecord({
personalToken: token,
fields,
tableId,
baseId,
}: Params) {
const request: HttpRequest = {
method: HttpMethod.POST,
url: `https://api.airtable.com/v0/${baseId}/${tableId}`,
authentication: {
type: AuthenticationType.BEARER_TOKEN,
token,
},
body: {
fields,
typecast: true,
},
};
const response = await httpClient.sendRequest<AirtableRecord>(request);
if (response.status === 200) {
return response.body;
}
return response;
},
async findRecord({
personalToken: token,
searchField,
searchValue,
tableId,
baseId,
limitToView,
}: Params) {
const request: HttpRequest = {
method: HttpMethod.GET,
url: `https://api.airtable.com/v0/${baseId}/${tableId}`,
authentication: {
type: AuthenticationType.BEARER_TOKEN,
token,
},
queryParams: {
filterByFormula: `FIND("${searchValue}",{${searchField}})`,
view: limitToView ?? '',
},
};
const response = await httpClient.sendRequest<{
records: AirtableRecord[];
}>(request);
if (response.status === 200) {
return response.body.records;
}
return [];
},
async updateRecord({
personalToken: token,
fields,
recordId,
tableId,
baseId,
}: Params) {
const request: HttpRequest = {
method: HttpMethod.PATCH,
url: `https://api.airtable.com/v0/${baseId}/${tableId}/${recordId}`,
authentication: {
type: AuthenticationType.BEARER_TOKEN,
token,
},
body: {
fields,
},
};
const response = await httpClient.sendRequest<AirtableRecord>(request);
if (response.status === 200) {
return response.body;
}
return response;
},
async deleteRecord({
personalToken: token,
recordId,
tableId,
baseId,
}: Params) {
const request: HttpRequest = {
method: HttpMethod.DELETE,
url: `https://api.airtable.com/v0/${baseId}/${tableId}/${recordId}`,
authentication: {
type: AuthenticationType.BEARER_TOKEN,
token,
},
};
const response = await httpClient.sendRequest<AirtableRecord>(request);
if (response.status === 200) {
return response.body;
}
return response;
},
};
interface Params {
personalToken: string;
baseId: string;
tableId: string;
fields?: Record<string, unknown>;
recordId?: string;
searchValue?: string;
searchField?: string;
fieldNames?: string[];
limitToView?: string;
sortField?: string;
}