airtable-ts-codegen 1.3.0 → 2.0.1

package/dist/__fixture__/tablesMeta.json.d.ts

@@ -0,0 +1,362 @@
+/**
+ * Dump of an airtable table containing all field types.
+ */
+export declare const tablesMeta: {
+    tables: {
+        id: string;
+        name: string;
+        primaryFieldId: string;
+        fields: ({
+            type: string;
+            id: string;
+            name: string;
+            options?: never;
+            description?: never;
+        } | {
+            type: string;
+            options: {
+                choices: {
+                    id: string;
+                    name: string;
+                    color: string;
+                }[];
+                isReversed?: never;
+                referencedFieldIds?: never;
+                prompt?: never;
+                icon?: never;
+                color?: never;
+                dateFormat?: never;
+                timeFormat?: never;
+                timeZone?: never;
+                precision?: never;
+                symbol?: never;
+                durationFormat?: never;
+                max?: never;
+                isValid?: never;
+                formula?: never;
+                result?: never;
+            };
+            id: string;
+            name: string;
+            description?: never;
+        } | {
+            type: string;
+            options: {
+                isReversed: boolean;
+                choices?: never;
+                referencedFieldIds?: never;
+                prompt?: never;
+                icon?: never;
+                color?: never;
+                dateFormat?: never;
+                timeFormat?: never;
+                timeZone?: never;
+                precision?: never;
+                symbol?: never;
+                durationFormat?: never;
+                max?: never;
+                isValid?: never;
+                formula?: never;
+                result?: never;
+            };
+            id: string;
+            name: string;
+            description?: never;
+        } | {
+            type: string;
+            options: {
+                referencedFieldIds: string[];
+                prompt: (string | {
+                    field: {
+                        fieldId: string;
+                    };
+                })[];
+                choices?: never;
+                isReversed?: never;
+                icon?: never;
+                color?: never;
+                dateFormat?: never;
+                timeFormat?: never;
+                timeZone?: never;
+                precision?: never;
+                symbol?: never;
+                durationFormat?: never;
+                max?: never;
+                isValid?: never;
+                formula?: never;
+                result?: never;
+            };
+            id: string;
+            name: string;
+            description: string;
+        } | {
+            type: string;
+            options: {
+                icon: string;
+                color: string;
+                choices?: never;
+                isReversed?: never;
+                referencedFieldIds?: never;
+                prompt?: never;
+                dateFormat?: never;
+                timeFormat?: never;
+                timeZone?: never;
+                precision?: never;
+                symbol?: never;
+                durationFormat?: never;
+                max?: never;
+                isValid?: never;
+                formula?: never;
+                result?: never;
+            };
+            id: string;
+            name: string;
+            description?: never;
+        } | {
+            type: string;
+            options: {
+                dateFormat: {
+                    name: string;
+                    format: string;
+                };
+                choices?: never;
+                isReversed?: never;
+                referencedFieldIds?: never;
+                prompt?: never;
+                icon?: never;
+                color?: never;
+                timeFormat?: never;
+                timeZone?: never;
+                precision?: never;
+                symbol?: never;
+                durationFormat?: never;
+                max?: never;
+                isValid?: never;
+                formula?: never;
+                result?: never;
+            };
+            id: string;
+            name: string;
+            description?: never;
+        } | {
+            type: string;
+            options: {
+                dateFormat: {
+                    name: string;
+                    format: string;
+                };
+                timeFormat: {
+                    name: string;
+                    format: string;
+                };
+                timeZone: string;
+                choices?: never;
+                isReversed?: never;
+                referencedFieldIds?: never;
+                prompt?: never;
+                icon?: never;
+                color?: never;
+                precision?: never;
+                symbol?: never;
+                durationFormat?: never;
+                max?: never;
+                isValid?: never;
+                formula?: never;
+                result?: never;
+            };
+            id: string;
+            name: string;
+            description?: never;
+        } | {
+            type: string;
+            options: {
+                precision: number;
+                choices?: never;
+                isReversed?: never;
+                referencedFieldIds?: never;
+                prompt?: never;
+                icon?: never;
+                color?: never;
+                dateFormat?: never;
+                timeFormat?: never;
+                timeZone?: never;
+                symbol?: never;
+                durationFormat?: never;
+                max?: never;
+                isValid?: never;
+                formula?: never;
+                result?: never;
+            };
+            id: string;
+            name: string;
+            description?: never;
+        } | {
+            type: string;
+            options: {
+                precision: number;
+                symbol: string;
+                choices?: never;
+                isReversed?: never;
+                referencedFieldIds?: never;
+                prompt?: never;
+                icon?: never;
+                color?: never;
+                dateFormat?: never;
+                timeFormat?: never;
+                timeZone?: never;
+                durationFormat?: never;
+                max?: never;
+                isValid?: never;
+                formula?: never;
+                result?: never;
+            };
+            id: string;
+            name: string;
+            description?: never;
+        } | {
+            type: string;
+            options: {
+                durationFormat: string;
+                choices?: never;
+                isReversed?: never;
+                referencedFieldIds?: never;
+                prompt?: never;
+                icon?: never;
+                color?: never;
+                dateFormat?: never;
+                timeFormat?: never;
+                timeZone?: never;
+                precision?: never;
+                symbol?: never;
+                max?: never;
+                isValid?: never;
+                formula?: never;
+                result?: never;
+            };
+            id: string;
+            name: string;
+            description?: never;
+        } | {
+            type: string;
+            options: {
+                icon: string;
+                max: number;
+                color: string;
+                choices?: never;
+                isReversed?: never;
+                referencedFieldIds?: never;
+                prompt?: never;
+                dateFormat?: never;
+                timeFormat?: never;
+                timeZone?: never;
+                precision?: never;
+                symbol?: never;
+                durationFormat?: never;
+                isValid?: never;
+                formula?: never;
+                result?: never;
+            };
+            id: string;
+            name: string;
+            description?: never;
+        } | {
+            type: string;
+            options: {
+                isValid: boolean;
+                formula: string;
+                referencedFieldIds: string[];
+                result: {
+                    type: string;
+                    options?: never;
+                };
+                choices?: never;
+                isReversed?: never;
+                prompt?: never;
+                icon?: never;
+                color?: never;
+                dateFormat?: never;
+                timeFormat?: never;
+                timeZone?: never;
+                precision?: never;
+                symbol?: never;
+                durationFormat?: never;
+                max?: never;
+            };
+            id: string;
+            name: string;
+            description?: never;
+        } | {
+            type: string;
+            options: {
+                result: {
+                    type: string;
+                    options: {
+                        dateFormat: {
+                            name: string;
+                            format: string;
+                        };
+                        timeFormat: {
+                            name: string;
+                            format: string;
+                        };
+                        timeZone: string;
+                    };
+                };
+                choices?: never;
+                isReversed?: never;
+                referencedFieldIds?: never;
+                prompt?: never;
+                icon?: never;
+                color?: never;
+                dateFormat?: never;
+                timeFormat?: never;
+                timeZone?: never;
+                precision?: never;
+                symbol?: never;
+                durationFormat?: never;
+                max?: never;
+                isValid?: never;
+                formula?: never;
+            };
+            id: string;
+            name: string;
+            description?: never;
+        } | {
+            type: string;
+            options: {
+                isValid: boolean;
+                referencedFieldIds: never[];
+                result: {
+                    type: string;
+                    options: {
+                        dateFormat: {
+                            name: string;
+                            format: string;
+                        };
+                        timeFormat: {
+                            name: string;
+                            format: string;
+                        };
+                        timeZone: string;
+                    };
+                };
+                choices?: never;
+                isReversed?: never;
+                prompt?: never;
+                icon?: never;
+                color?: never;
+                dateFormat?: never;
+                timeFormat?: never;
+                timeZone?: never;
+                precision?: never;
+                symbol?: never;
+                durationFormat?: never;
+                max?: never;
+                formula?: never;
+            };
+            id: string;
+            name: string;
+            description?: never;
+        })[];
+    }[];
+};

package/dist/__fixture__/tablesMeta.json.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tablesMeta = void 0;
+/**
+ * Dump of an airtable table containing all field types.
+ */
+exports.tablesMeta = {
+    tables: [{
+            id: 'tbluntrYUZ5bTz7YP', name: 'Table 1', primaryFieldId: 'fld7fNzf6ElsnsiXP', fields: [{ type: 'singleLineText', id: 'fld7fNzf6ElsnsiXP', name: 'Single Line Text' },
+                { type: 'singleCollaborator', id: 'fldzS7AY8z7fnPA2k', name: 'User' },
+                {
+                    type: 'singleSelect', options: { choices: [{ id: 'sel8rlr1irDiJymSd', name: 'Todo', color: 'redLight2' }, { id: 'sel7fRrgENSSM1Kwx', name: 'In progress', color: 'yellowLight2' }, { id: 'selMu3Gxu6YDW89st', name: 'Done', color: 'greenLight2' }] }, id: 'fldtZ94euYOEgLIKx', name: 'Single Select',
+                },
+                {
+                    type: 'multipleAttachments', options: { isReversed: false }, id: 'fldZXvZHFB1kQ8aO4', name: 'Attachments',
+                },
+                {
+                    type: 'aiText', options: { referencedFieldIds: ['fldZXvZHFB1kQ8aO4'], prompt: ['', { field: { fieldId: 'fldZXvZHFB1kQ8aO4' } }] }, id: 'fldIs4nyExgOYguEi', name: 'AI Text', description: '',
+                },
+                { type: 'multilineText', id: 'fldFtEQouCSxqW6sL', name: 'Long Text' },
+                {
+                    type: 'checkbox', options: { icon: 'check', color: 'greenBright' }, id: 'flddE4RG6Mlugqo8X', name: 'Checkbox',
+                },
+                {
+                    type: 'multipleSelects', options: { choices: [{ id: 'selcufYWsGwXvoe5K', name: 'A', color: 'blueLight2' }, { id: 'seldJM3V2vfY1MwId', name: 'B', color: 'cyanLight2' }] }, id: 'fldFWelqOO9koF8fM', name: 'Multiple Select',
+                },
+                {
+                    type: 'date', options: { dateFormat: { name: 'local', format: 'l' } }, id: 'fldAUPoAJ67TUwaVS', name: 'Date',
+                },
+                {
+                    type: 'dateTime', options: { dateFormat: { name: 'local', format: 'l' }, timeFormat: { name: '12hour', format: 'h:mma' }, timeZone: 'client' }, id: 'fldXCnBVRZ4HO4KIh', name: 'Datetime',
+                },
+                { type: 'phoneNumber', id: 'fldo5kOL07o835nyt', name: 'Phone Number' },
+                { type: 'email', id: 'fldkmeNd7ZAGTS0nA', name: 'Email' },
+                { type: 'url', id: 'fldAyWIcU6mOwCZl2', name: 'URL' },
+                {
+                    type: 'number', options: { precision: 1 }, id: 'fldN9DNkpCQ6IXH5C', name: 'Number',
+                },
+                {
+                    type: 'currency', options: { precision: 2, symbol: '$' }, id: 'fldcaKq3Hq6Rr1R53', name: 'Currency',
+                },
+                {
+                    type: 'percent', options: { precision: 0 }, id: 'fldsKAqUJjKv5hlH1', name: 'Percent',
+                },
+                {
+                    type: 'duration', options: { durationFormat: 'h:mm' }, id: 'fldMH1inCgmp6KD8q', name: 'Duration',
+                },
+                {
+                    type: 'rating', options: { icon: 'star', max: 5, color: 'yellowBright' }, id: 'fldFZtTmcTm1Fxu4B', name: 'Rating',
+                },
+                {
+                    type: 'formula', options: {
+                        isValid: true, formula: '{fld7fNzf6ElsnsiXP}', referencedFieldIds: ['fld7fNzf6ElsnsiXP'], result: { type: 'singleLineText' },
+                    }, id: 'fldmYyrXlqiUpBu0C', name: 'Formula',
+                },
+                {
+                    type: 'createdTime', options: { result: { type: 'dateTime', options: { dateFormat: { name: 'local', format: 'l' }, timeFormat: { name: '12hour', format: 'h:mma' }, timeZone: 'client' } } }, id: 'fldOJHvKq8rrIYV90', name: 'Created',
+                },
+                {
+                    type: 'lastModifiedTime', options: { isValid: true, referencedFieldIds: [], result: { type: 'dateTime', options: { dateFormat: { name: 'local', format: 'l' }, timeFormat: { name: '12hour', format: 'h:mma' }, timeZone: 'client' } } }, id: 'fldH5xY5CV0Q4g5fY', name: 'Last Modified',
+                },
+                { type: 'lastModifiedBy', id: 'fld6W3h7dnVJhIni9', name: 'Last Modified By' },
+                { type: 'createdBy', id: 'fldDcRoVGJXIhVSAi', name: 'Created By' },
+                { type: 'autoNumber', id: 'fldGM8wIYk3G8WMiE', name: 'ID' },
+                { type: 'barcode', id: 'fldMPs1eLH8X5bWeS', name: 'Barcode' },
+                { type: 'button', id: 'fldAG3LTbJRwQVEvS', name: 'Button' }],
+        }],
+};

package/dist/escape/escapeIdentifier.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Reset the internal state - useful for testing
+ */
+export declare function resetIdentifierState(): void;
 /**
  * Used for identifiers:
  * - If the name is already a valid JS identifier, return it unmodified.
@@ -5,6 +9,7 @@
  *   - Remove invalid characters.
  *   - Convert to PascalCase.
  *   - If the result starts with a digit, prefix with `_`.
+ *   - If duplicate, add a number suffix.
  * - Returns a default identifier if the identifier cannot be salvaged.
  */
 export declare function escapeIdentifier(name: string): string;

package/dist/escape/escapeIdentifier.js

@@ -1,9 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.resetIdentifierState = resetIdentifierState;
 exports.escapeIdentifier = escapeIdentifier;
 const diacritics_1 = require("diacritics");
 let invalidIdentifierCount = 0;
 const DEFAULT_IDENTIFIER = 'invalidIdentifier';
+// Track used identifiers to avoid duplicates
+const usedIdentifiers = new Set();
+/**
+ * Reset the internal state - useful for testing
+ */
+function resetIdentifierState() {
+    usedIdentifiers.clear();
+    invalidIdentifierCount = 0;
+}
 /**
  * Checks if 'str' is already a valid JavaScript identifier.
  * If yes, returns true. Otherwise false.
@@ -46,6 +56,7 @@ function toPascalCase(str) {
  *   - Remove invalid characters.
  *   - Convert to PascalCase.
  *   - If the result starts with a digit, prefix with `_`.
+ *   - If duplicate, add a number suffix.
  * - Returns a default identifier if the identifier cannot be salvaged.
  */
 function escapeIdentifier(name) {
@@ -92,5 +103,13 @@ function escapeIdentifier(name) {
             return `${DEFAULT_IDENTIFIER}${invalidIdentifierCount}`;
         }
     }
-    return pascal;
+    // Handle duplicates by adding numbers
+    let finalIdentifier = pascal;
+    let counter = 2;
+    while (usedIdentifiers.has(finalIdentifier)) {
+        finalIdentifier = `${pascal}${counter}`;
+        counter += 1;
+    }
+    usedIdentifiers.add(finalIdentifier);
+    return finalIdentifier;
 }

package/dist/getBaseSchema.d.ts

@@ -9,6 +9,7 @@ export type FieldSchema = {
 export type BaseSchema = {
     id: string;
     name: string;
+    primaryFieldId?: string;
     description?: string;
     fields: FieldSchema[];
 }[];

package/dist/index.js

@@ -18,17 +18,19 @@ const main = async (config) => {
     ].join('\n');
 };
 exports.main = main;
-const generateInterfaceEntry = ({ jsName, jsType, name, type }) => {
+const generateInterfaceEntry = ({ jsName, jsType, name, type, originalName }) => {
     if (jsType === null) {
-        return `\n  // Unsupported field ${name} of type ${type}`;
+        return `\n  // Unsupported field "${name}" of type ${type}`;
     }
-    return `\n  ${jsName}: ${jsType},`;
+    const comment = originalName !== jsName ? ` // Original field: "${originalName}"` : '';
+    return `\n  ${jsName}: ${jsType},${comment}`;
 };
-const generateMappingEntry = ({ jsName, id, jsType, name }) => {
+const generateMappingEntry = ({ jsName, id, jsType, name, originalName }) => {
     if (jsType === null) {
-        return `\n    // Unsupported field ${name}: ${(0, escapeString_1.escapeString)(id)}`;
+        return `\n    // Unsupported field "${name}": ${(0, escapeString_1.escapeString)(id)}`;
     }
-    return `\n    ${jsName}: '${(0, escapeString_1.escapeString)(id)}',`;
+    const comment = originalName !== jsName ? ` // Original field: "${originalName}"` : '';
+    return `\n    ${jsName}: '${(0, escapeString_1.escapeString)(id)}',${comment}`;
 };
 const generateSchemaEntry = ({ jsName, jsType }) => {
     if (jsType === null) {
@@ -37,11 +39,13 @@ const generateSchemaEntry = ({ jsName, jsType }) => {
     return `\n    ${jsName}: '${(0, escapeString_1.escapeString)(jsType)}',`;
 };
 const generateCode = (config, tableSchema) => {
+    (0, escapeIdentifier_1.resetIdentifierState)();
     const itemNameRaw = (0, escapeIdentifier_1.escapeIdentifier)((0, recase_1.recase)(null, 'pascal', tableSchema.name));
     const itemName = /.s$/.test(itemNameRaw) ? itemNameRaw.slice(0, itemNameRaw.length - 1) : itemNameRaw;
     const tableName = (0, escapeIdentifier_1.escapeIdentifier)(`${(0, recase_1.recase)(null, 'camel', tableSchema.name)}Table`);
     const fields = tableSchema.fields.map((f) => ({
         ...f,
+        originalName: f.name,
         jsName: (0, escapeIdentifier_1.escapeIdentifier)((0, recase_1.recase)(null, 'camel', (0, escapeIdentifier_1.escapeIdentifier)(f.name))),
         jsType: (0, jsTypeForAirtableType_1.jsTypeForAirtableType)(f),
     }));

package/dist/jsTypeForAirtableType.js

@@ -18,10 +18,11 @@ const jsTypeForAirtableType = (field) => {
         case 'externalSyncSource':
         case 'aiText':
         case 'singleCollaborator':
-        case 'createdBy':
         case 'lastModifiedBy':
         case 'barcode':
         case 'button':
+            return 'string | null';
+        case 'createdBy':
             return 'string';
         case 'multipleAttachments':
         case 'multipleCollaborators':
@@ -33,13 +34,15 @@ const jsTypeForAirtableType = (field) => {
         case 'duration':
         case 'currency':
         case 'percent':
+            return 'number | null';
         case 'count':
         case 'autoNumber':
             return 'number';
         case 'date':
         case 'dateTime':
-        case 'createdTime':
         case 'lastModifiedTime':
+            return 'number | null'; // Unix timestamp in seconds
+        case 'createdTime':
             return 'number'; // Unix timestamp in seconds
         case 'checkbox':
             return 'boolean';
@@ -55,6 +58,9 @@ const jsTypeForAirtableType = (field) => {
                 if (innerType === null) {
                     return null;
                 }
+                if (innerType.includes('null')) {
+                    return innerType;
+                }
                 return `${innerType} | null`;
             }
             throw new Error(`Invalid ${field.type} field (no options.result): ${field.id}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "airtable-ts-codegen",
-  "version": "1.3.0",
+  "version": "2.0.1",
   "description": "Autogenerate TypeScript definitions for your Airtable base",
   "license": "MIT",
   "author": "Adam Jones (domdomegg)",