airtable-ts-codegen 1.0.0 → 1.1.0

package/README.md

@@ -70,6 +70,7 @@ Pull requests are welcomed on GitHub! To get started:
 3. Install dependencies with `npm install`
 4. Run `npm run test` to run tests
 5. Build with `npm run build`
+6. Run the local version with `npm start`
 
 ## Releases
 

package/dist/escape/escapeIdentifier.js

@@ -2,26 +2,36 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.escapeIdentifier = void 0;
 const recase_1 = require("@kristiandupont/recase");
+const diacritics_1 = require("diacritics");
 const toPascalCase = (0, recase_1.recase)(null, 'pascal');
 /** Used for identifiers. If the name has symbols or is illegal Typescript, strip out symbols and make it PascalCase. */
 // NB: A wider set of things than are accepted by this function are valid identifiers in TypeScript (see https://stackoverflow.com/a/9337047). However, this works well for our purposes.
 const escapeIdentifier = (name) => {
-    const trimmed = name.trim();
+    const preprocessed = (0, diacritics_1.remove)(name).trim();
     let isLegalIdentifier = true;
-    if (!/^[$A-Z_a-z][\w$]*$/.test(trimmed)) {
+    if (!/^[$A-Z_a-z][\w$]*$/.test(preprocessed)) {
         isLegalIdentifier = false;
     }
     try {
         // eslint-disable-next-line @typescript-eslint/no-implied-eval, no-new
-        new Function(`const ${trimmed} = 1;`);
+        new Function(`const ${preprocessed} = 1;`);
     }
     catch {
         isLegalIdentifier = false;
     }
     if (isLegalIdentifier) {
-        return trimmed;
+        return preprocessed;
     }
-    const snaked = trimmed.replace(/[^$A-Z_a-z]/g, '_').replace(/_+/g, '_');
+    // Remove all characters up to the first valid identifier start character (A-Z, a-z, $), then
+    // replace all invalid characters with underscores, and finally collapse multiple underscores into one.
+    const validIdentifierStartIndex = preprocessed.search(/[$A-Za-z]/);
+    if (validIdentifierStartIndex === -1) {
+        throw new Error(`Invalid and unsalvageable identifier: ${name}`);
+    }
+    const snaked = preprocessed
+        .slice(validIdentifierStartIndex)
+        .replace(/[^$A-Z_a-z\d]/g, '_')
+        .replace(/_+/g, '_');
     const result = toPascalCase(snaked);
     if (result.length === 0) {
         throw new Error(`Invalid and unsalvageable identifier: ${name}`);

package/dist/index.js

@@ -6,14 +6,36 @@ const getBaseSchema_1 = require("./getBaseSchema");
 const escapeString_1 = require("./escape/escapeString");
 const escapeIdentifier_1 = require("./escape/escapeIdentifier");
 const jsTypeForAirtableType_1 = require("./jsTypeForAirtableType");
-// This will output a folder named `app1234` with:
-// - an `index.ts` that exports all the tables
-// - (under the hood?) various `tbl1234.ts` files that contain table definitions
+// This generates a single typescript file containing all table definitions for a given base.
 const main = async (config) => {
     const baseSchema = await (0, getBaseSchema_1.getBaseSchema)(config.baseId, config);
-    return `/* DO NOT EDIT: this file was automatically generated by airtable-ts-codegen */\n/* eslint-disable */\nimport { Item, Table } from 'airtable-ts';\n\n${baseSchema.map((tableSchema) => generateCode(config, tableSchema)).join('\n\n')}`;
+    return [
+        '/* DO NOT EDIT: this file was automatically generated by airtable-ts-codegen */',
+        '/* eslint-disable */',
+        "import type { Item, Table } from 'airtable-ts';",
+        '',
+        baseSchema.map((tableSchema) => generateCode(config, tableSchema)).join('\n\n'),
+    ].join('\n');
 };
 exports.main = main;
+const generateInterfaceEntry = ({ jsName, jsType, name, type }) => {
+    if (jsType == null) {
+        return `\n  // Unsupported field ${name} of type ${type}`;
+    }
+    return `\n  ${jsName}: ${jsType},`;
+};
+const generateMappingEntry = ({ jsName, id, jsType, name }) => {
+    if (jsType == null) {
+        return `\n    // Unsupported field ${name}: ${(0, escapeString_1.escapeString)(id)}`;
+    }
+    return `\n    ${jsName}: '${(0, escapeString_1.escapeString)(id)}',`;
+};
+const generateSchemaEntry = ({ jsName, jsType }) => {
+    if (jsType == null) {
+        return null;
+    }
+    return `\n    ${jsName}: '${(0, escapeString_1.escapeString)(jsType)}',`;
+};
 const generateCode = (config, tableSchema) => {
     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;
@@ -24,16 +46,16 @@ const generateCode = (config, tableSchema) => {
         jsType: (0, jsTypeForAirtableType_1.jsTypeForAirtableType)(f),
     }));
     return `export interface ${itemName} extends Item {
-  id: string,${fields.map((f) => `\n  ${f.jsName}: ${f.jsType},`).join('')}
+  id: string,${fields.map(generateInterfaceEntry).join('')}
 }
 
 export const ${tableName}: Table<${itemName}> = {
   name: '${(0, escapeString_1.escapeString)(tableSchema.name)}',
   baseId: '${(0, escapeString_1.escapeString)(config.baseId)}',
   tableId: '${(0, escapeString_1.escapeString)(tableSchema.id)}',
-  mappings: {${fields.map((f) => `\n    ${f.jsName}: '${(0, escapeString_1.escapeString)(f.id)}',`).join('')}
+  mappings: {${fields.map(generateMappingEntry).join('')}
   },
-  schema: {${fields.map((f) => `\n    ${f.jsName}: '${(0, escapeString_1.escapeString)(f.jsType)}',`).join('')}
+  schema: {${fields.map(generateSchemaEntry).filter(Boolean).join('')}
   },
 };`;
 };

package/dist/jsTypeForAirtableType.d.ts

@@ -1,2 +1,7 @@
 import { FieldSchema } from './getBaseSchema';
-export declare const jsTypeForAirtableType: (field: FieldSchema) => string;
+/**
+ * Returns the corresponding Typescript type for the given Airtable field type.
+ *
+ * Unsupported fields return `null` and will be filtered out by the caller.
+ */
+export declare const jsTypeForAirtableType: (field: FieldSchema) => string | null;

package/dist/jsTypeForAirtableType.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.jsTypeForAirtableType = void 0;
+/**
+ * Returns the corresponding Typescript type for the given Airtable field type.
+ *
+ * Unsupported fields return `null` and will be filtered out by the caller.
+ */
 const jsTypeForAirtableType = (field) => {
     switch (field.type) {
         case 'url':
@@ -38,24 +43,36 @@ const jsTypeForAirtableType = (field) => {
                 && 'result' in field.options
                 && typeof field.options.result === 'object'
                 && field.options.result != null) {
-                return `${(0, exports.jsTypeForAirtableType)(field.options.result)} | null`;
+                const innerType = (0, exports.jsTypeForAirtableType)(field.options.result);
+                if (innerType == null)
+                    return null;
+                return `${innerType} | null`;
             }
             throw new Error(`Invalid ${field.type} field (no options.result): ${field.id}`);
-        // Special cases we don't yet support
+        // Special cases we don't yet support; for now, skip these fields
+        // case 'aiText':
+        //   return 'AiTextObject';
+        // case 'singleCollaborator':
+        // case 'createdBy':
+        // case 'lastModifiedBy':
+        //   return 'CollaboratorObject';
+        // case 'multipleCollaborators':
+        //   return 'CollaboratorObject[]';
+        // case 'multipleAttachments':
+        //   return 'AttachmentObject[]';
+        // case 'barcode':
+        //   return 'BarcodeObject';
+        // case 'button':
+        //   return 'ButtonObject';
         case 'aiText':
-            return 'AiTextObject';
         case 'singleCollaborator':
         case 'createdBy':
         case 'lastModifiedBy':
-            return 'CollaboratorObject';
         case 'multipleCollaborators':
-            return 'CollaboratorObject[]';
         case 'multipleAttachments':
-            return 'AttachmentObject[]';
         case 'barcode':
-            return 'BarcodeObject';
         case 'button':
-            return 'ButtonObject';
+            return null;
         default:
             throw new Error(`Could not convert Airtable type '${field.type}' to a TypeScript type for field ${field.id}`);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "airtable-ts-codegen",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Autogenerate TypeScript definitions for your Airtable base",
   "license": "MIT",
   "author": "Adam Jones (domdomegg)",
@@ -17,6 +17,7 @@
     "dist"
   ],
   "scripts": {
+    "start": "npm run build && node dist/cli.js",
     "test": "vitest run",
     "test:watch": "vitest --watch",
     "lint": "eslint --ext .js,.jsx,.ts,.tsx .",
@@ -26,10 +27,12 @@
   },
   "dependencies": {
     "@kristiandupont/recase": "^1.2.1",
-    "axios": "^1.6.8"
+    "axios": "^1.6.8",
+    "diacritics": "^1.3.0"
   },
   "devDependencies": {
     "@tsconfig/node-lts": "^20.1.3",
+    "@types/diacritics": "^1.3.3",
     "@types/node": "^20.12.8",
     "airtable-ts": "^1.1.0",
     "eslint": "^8.57.0",
@@ -41,6 +44,15 @@
   "eslintConfig": {
     "extends": [
       "eslint-config-domdomegg"
-    ]
+    ],
+    "rules": {
+      "object-curly-newline": [
+        "error",
+        {
+          "multiline": true,
+          "consistent": true
+        }
+      ]
+    }
   }
 }