quickbase-js 1.1.0-beta.3 → 1.1.0-beta.5

package/CHANGELOG.md

@@ -2,6 +2,37 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [1.1.0-beta.5](https://github.com/DrewBradfordXYZ/quickbase-js/compare/v1.1.0-beta.4...v1.1.0-beta.5) (2025-03-13)
+
+
+### Features
+
+* ESM and UMD build prod ([49513e9](https://github.com/DrewBradfordXYZ/quickbase-js/commit/49513e902e7bf4dd35da3c6508242e96507a91bd))
+* ESM and UMD support and src folder reorganization ([dc0170b](https://github.com/DrewBradfordXYZ/quickbase-js/commit/dc0170b547e6e9e57a117fbcccfdbeb86e48a8c7))
+
+## [1.1.0-beta.4](https://github.com/DrewBradfordXYZ/quickbase-js/compare/v1.1.0-beta.3...v1.1.0-beta.4) (2025-03-12)
+
+
+### Features
+
+* createField and deleteFields tests are passing ([4b47c4d](https://github.com/DrewBradfordXYZ/quickbase-js/commit/4b47c4deb9b3d731e6e7938c12fcebe97830568b))
+* createField mock and integration tests pass ([b227c73](https://github.com/DrewBradfordXYZ/quickbase-js/commit/b227c73b08f7efa5ce5f3d0c2897f82c8976a009))
+* deleteFields spec update ([1f8beca](https://github.com/DrewBradfordXYZ/quickbase-js/commit/1f8becaca0d6b7950648c1b9bc2b0215781fa829))
+* getFeildsUsage.test.ts unit and integration tests pass ([82a4886](https://github.com/DrewBradfordXYZ/quickbase-js/commit/82a488622967ec24a8767cbb19c59ef4ce808749))
+* getField.test.ts unit and integration tests pass ([3e50b70](https://github.com/DrewBradfordXYZ/quickbase-js/commit/3e50b704f0ebea47f2fee3d02d811ea1b43db6c4))
+* getFieldsUsage fix spec ([031faaa](https://github.com/DrewBradfordXYZ/quickbase-js/commit/031faaaeab9597f35fdd1ddcf5157ce5d774390b))
+* getFieldUsage spec and unit test pass ([ac2824b](https://github.com/DrewBradfordXYZ/quickbase-js/commit/ac2824b226140dde99e33cf594d57bd6ffd4dc39))
+* getFieldUsage unit and integration tests pass ([e62b586](https://github.com/DrewBradfordXYZ/quickbase-js/commit/e62b586d534620479a25dda2796ba5dcb8043705))
+* split up fix-spec-paths and fix-spec-definitions into many files ([20d3246](https://github.com/DrewBradfordXYZ/quickbase-js/commit/20d32464e6337028778845fa55fbb19c5543f7eb))
+
+
+### Bug Fixes
+
+* cleanup createField.test.ts logging ([7b1306b](https://github.com/DrewBradfordXYZ/quickbase-js/commit/7b1306bd8eb49e2c932ce267f33457e949e0f74b))
+* createField test syntax update ([043f964](https://github.com/DrewBradfordXYZ/quickbase-js/commit/043f964a47346878440eb73cc10c110dab904ad7))
+* getFieldsUsage type fix ([4c6f271](https://github.com/DrewBradfordXYZ/quickbase-js/commit/4c6f271d123131ae13a236664f28fbbdfde3d564))
+* update deleteFields error type spec ([1788e1c](https://github.com/DrewBradfordXYZ/quickbase-js/commit/1788e1ce6d4d2c8df871ec8b112be908d706f884))
+
 ## [1.1.0-beta.3](https://github.com/DrewBradfordXYZ/quickbase-js/compare/v1.1.0-beta.2...v1.1.0-beta.3) (2025-03-11)
 
 ### Features

package/README.md

@@ -1,14 +1,124 @@
 # quickbase-js
 
+# Installation
+
+```bash
+npm install --save quickbase-js
+```
+
+## Example
+
+```html
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Quickbase Test</title>
+  </head>
+
+  <body>
+    <div>
+      <h1>Quickbase Test</h1>
+      <p id="result">Loading...</p>
+    </div>
+    <script type="module">
+      import { quickbase } from "quickbase-js";
+      // Initalize the QuickBase client
+      const qb = quickbase({
+        realm: "your-realm", // Replace with actual QuickBase realm
+        // ## ------------------------------
+        // ## Authentication Options
+        // ## ----------------------------
+        // ## OPTION 1: User Token Authentication
+        // ## - Use this if you have a QuickBase user token.
+        // ## - Works in Node.js or browsers, ideal for standalone apps or testing outside QuickBase
+        // ## - Uncomment the line below and replace with your token; comment out 'useTempTokens'
+        // userToken: "your-user-token",
+
+        // ## ----------------------------
+        // ## OPTION 2: Temporary Token Authentication
+        // ## - Use this for QuickBase code pages, leveraging the browser’s authenticated session
+        // ## - No user token needed; requires running in a QuickBase browser context
+        // ## - Uncomment the line below and comment out 'userToken' if using this option
+        // useTempTokens: true,
+      });
+
+      // Fetch the app
+      qb.getApp({ appId: "your-app-id" }) // Replace with actual app ID
+        .then((app) => {
+          document.getElementById(
+            "result"
+          ).textContent = `App Name: ${app.name}`;
+        })
+        .catch((err) => {
+          console.error("Error fetching app:", err);
+          document.getElementById("result").textContent =
+            err.message || "Failed to load app";
+        });
+    </script>
+  </body>
+</html>
+```
+
 # Development workflow
 
 ```bash
-npm run fix-spec
-npm run regenerate
-npm run generate-unified
+npm run regenerate:all
 npm run build
-npm run test
-npm run test:pw:qb:all
+npm run test:all
+```
+
+## Usage
+
+### Node.js (ESM - Recommended)
+
+For modern Node.js applications, use ES modules:
+
+```javascript
+// ESM (Node.js) - Recommended
+import { quickbase } from "quickbase-js";
+const qb = quickbase({ realm: "example", userToken: "your-token" });
+
+// Example: Fetching an app
+const app = await qb.getApp({ appId: "your-app-id" });
+console.log(app);
+
+// Example: Creating a record with temporary token
+const qbTemp = quickbase({ realm: "example", useTempTokens: true });
+const record = await qbTemp.upsert({
+  body: {
+    to: "your-table-id",
+    data: [
+      {
+        /* record data */
+      },
+    ],
+  },
+});
+console.log(record);
+```
+
+```javascript
+// Example: TypeScript ESM (Recommended)
+import { quickbase } from "quickbase-js";
+const qbTyped: QuickbaseClient = quickbase({
+  realm: "example",
+  userToken: "your-token",
+});
+const typedApp = await qbTyped.getApp({ appId: "your-app-id" });
+console.log(typedApp);
+```
+
+```javascript
+// Example: UMD via CDN (QuickBase Code Pages)
+// Note: This is HTML, not JavaScript, and should be used in a browser environment
+
+<script src="https://cdn.jsdelivr.net/npm/quickbase-js@1.1.0-beta.4/dist/umd/quickbase.umd.js"></script>
+<script>
+  const qb = new QuickbaseJS({ realm: 'example', useTempTokens: true });
+  // Example: Fetching an app
+  qb.getApp({ appId: 'your-app-id' }).then(app => console.log(app));
+</script>
+
 ```
 
 ## In QuickBase Code Pages (Browser Environment)

package/build.js

@@ -1,66 +1,186 @@
-#!/usr/bin/env node
-const { readFile, writeFile } = require("fs/promises");
-const { execSync } = require("child_process");
-const esbuild = require("esbuild");
-const pkg = require("./package.json");
+import { execSync } from 'child_process';
+import { rollup } from 'rollup';
+import terser from '@rollup/plugin-terser';
+import nodeResolve from '@rollup/plugin-node-resolve';
+import commonjs from '@rollup/plugin-commonjs';
+import dts from 'rollup-plugin-dts';
+import { rimrafSync } from 'rimraf';
+import { copyFileSync, readdirSync, readFileSync, writeFileSync, mkdirSync, statSync } from 'fs';
+import { join } from 'path';
 
-async function build() {
-  try {
-    // Compile TypeScript
-    console.log("Compiling TypeScript...");
-    execSync("npx tsc -b", { stdio: "inherit" });
+// Clean the dist folder
+rimrafSync('dist');
+rimrafSync('dist/temp-src');
 
-    // Format with Prettier
-    console.log("Formatting files with Prettier...");
-    execSync("npx prettier --write src/**/*.ts dist/**/*.js", {
-      stdio: "inherit",
-    });
+// Step 1: Copy runtime-relevant files from src/ to dist/temp-src and remove .ts extensions
+const srcDir = join(process.cwd(), 'src');
+const tempSrcDir = join(process.cwd(), 'dist/temp-src');
+const runtimeDirs = ['generated', 'generated-unified'];
+const runtimeFiles = ['index.ts', 'quickbaseClient.ts', 'tokenCache.ts'];
 
-    // Bundle for Browser
-    console.log("Bundling for Browser...");
-    await esbuild.build({
-      entryPoints: ["dist/QuickBaseClient.js"],
-      bundle: true,
-      minify: true,
+function copyAndRewriteTsExtensions(src, dest) {
+  console.log(`Copying from ${src} to ${dest}`);
+  mkdirSync(dest, { recursive: true });
+  const files = readdirSync(src, { withFileTypes: true });
+  for (const file of files) {
+    const srcPath = join(src, file.name);
+    const destPath = join(dest, file.name);
+    if (file.isDirectory()) {
+      if (runtimeDirs.includes(file.name) || runtimeDirs.some(dir => src.includes(dir))) {
+        copyAndRewriteTsExtensions(srcPath, destPath);
+      } else {
+        console.log(`Skipping non-runtime directory ${srcPath}`);
+      }
+    } else if (file.name.endsWith('.ts')) {
+      if (runtimeFiles.includes(file.name) || src.includes('generated') || src.includes('generated-unified')) {
+        console.log(`Processing ${srcPath} -> ${destPath}`);
+        let content = readFileSync(srcPath, 'utf8');
+        content = content.replace(/(from\s+["']\.[\w\/-]+)\.ts(["'])/g, '$1$2');
+        content = content.replace(/(export\s+\*\s+from\s+["']\.[\w\/-]+)\.ts(["'])/g, '$1$2');
+        writeFileSync(destPath, content, 'utf8');
+      } else {
+        console.log(`Skipping non-runtime file ${srcPath}`);
+      }
+    } else {
+      console.log(`Skipping non-.ts file ${srcPath}`);
+    }
+  }
+}
+copyAndRewriteTsExtensions(srcDir, tempSrcDir);
+
+// Step 2: Compile TypeScript to JavaScript with tsc
+console.log('Running tsc...');
+const tsFiles = readdirSync(tempSrcDir, { recursive: true })
+  .filter(file => file.endsWith('.ts'))
+  .map(file => join(tempSrcDir, file));
+const tscCommand = `npx tsc ${tsFiles.join(' ')} --outDir ${join(process.cwd(), 'dist/temp')} --module ESNext --target ESNext --sourceMap --moduleResolution bundler --baseUrl ${process.cwd()}`;
+console.log(`Command: ${tscCommand}`);
+execSync(tscCommand, { stdio: 'inherit' });
+
+// Step 3: Rollup configuration
+const isProd = process.env.NODE_ENV === 'production';
+const external = [
+  'node:http', 'node:https', 'node:zlib', 'node:stream', 'node:buffer',
+  'node:util', 'node:url', 'node:net', 'node:fs', 'node:path', 'node-fetch',
+];
+const globals = { 'node-fetch': 'fetch' };
+
+// Function to create Rollup bundle
+async function createBundle(input, plugins, format, outputOptions) {
+  const bundle = await rollup({
+    input,
+    external,
+    plugins,
+  });
+  await bundle.write(outputOptions);
+  await bundle.close();
+}
+
+// ESM Builds
+console.log('Building ESM bundles...');
+// Unminified ESM build (always generated)
+await createBundle(
+  'dist/temp/quickbaseClient.js',
+  [
+    nodeResolve({ preferBuiltins: true }),
+    commonjs(),
+  ],
+  'esm',
+  {
+    dir: 'dist/esm',
+    format: 'esm',
+    sourcemap: true,
+    entryFileNames: 'quickbase.js',
+  }
+);
+
+// Minified ESM build (only in production)
+if (isProd) {
+  await createBundle(
+    'dist/temp/quickbaseClient.js',
+    [
+      nodeResolve({ preferBuiltins: true }),
+      commonjs(),
+      terser(),
+    ],
+    'esm',
+    {
+      dir: 'dist/esm',
+      format: 'esm',
       sourcemap: true,
-      target: ["es2015"],
-      outfile: "dist/quickbase-client.browser.min.js",
-    });
+      entryFileNames: 'quickbase.min.js',
+    }
+  );
+}
 
-    // Load Sources
-    console.log("Loading Sources...");
-    const browserSource = await readFile(
-      "dist/quickbase-client.browser.min.js",
-      "utf8"
-    );
-    const cjsSource = await readFile("dist/QuickBaseClient.js", "utf8");
-    const license = await readFile("LICENSE", "utf8");
+// UMD Builds
+console.log('Building UMD bundles...');
+// Unminified UMD build (always generated)
+await createBundle(
+  'dist/temp/quickbaseClient.js',
+  [
+    nodeResolve({ preferBuiltins: true, browser: true }),
+    commonjs(),
+  ],
+  'umd',
+  {
+    file: join(process.cwd(), 'dist/umd', 'quickbase.umd.js'),
+    format: 'umd',
+    name: 'QuickbaseJS',
+    sourcemap: true,
+    globals,
+  }
+);
+
+// Minified UMD build (only in production)
+if (isProd) {
+  await createBundle(
+    'dist/temp/quickbaseClient.js',
+    [
+      nodeResolve({ preferBuiltins: true, browser: true }),
+      commonjs(),
+      terser(),
+    ],
+    'umd',
+    {
+      file: join(process.cwd(), 'dist/umd', 'quickbase.umd.min.js'),
+      format: 'umd',
+      name: 'QuickbaseJS',
+      sourcemap: true,
+      globals,
+    }
+  );
+}
 
-    // Build Header
-    console.log("Adding Metadata...");
-    const header = [
-      "/*! ",
-      ` * ${pkg.name} v${pkg.version}`,
-      ` * ${pkg.description || "A QuickBase API Client"}`,
-      ` * License: ${pkg.license}`,
-      ` * ${license}`,
-      " */",
-    ].join("\n");
+// Declarations
+console.log('Generating declarations...');
+const dtsBundle = await rollup({
+  input: 'src/quickbaseClient.ts',
+  plugins: [dts({ tsconfig: './tsconfig.json', respectExternal: true })],
+});
+await dtsBundle.write({ file: 'dist/esm/quickbase.d.ts', format: 'esm' });
+await dtsBundle.write({ file: 'dist/umd/quickbase.umd.d.ts', format: 'umd' });
+await dtsBundle.close();
 
-    // Write Output Files
-    await Promise.all([
-      writeFile(
-        "dist/quickbase-client.browser.min.js",
-        header + "\n" + browserSource
-      ),
-      writeFile("dist/QuickBaseClient.js", header + "\n" + cjsSource),
-    ]);
+// Clean up
+rimrafSync('dist/temp');
+rimrafSync('dist/temp-src');
 
-    console.log("Build completed successfully.");
-  } catch (error) {
-    console.error("Build failed:", error);
-    process.exit(1);
+// List generated files and their sizes
+console.log('\nGenerated files:');
+function listFilesWithSizes(dir, prefix = '') {
+  const files = readdirSync(dir, { withFileTypes: true });
+  for (const file of files) {
+    const filePath = join(dir, file.name);
+    if (file.isDirectory()) {
+      listFilesWithSizes(filePath, `${prefix}${file.name}/`);
+    } else {
+      const stats = statSync(filePath);
+      const sizeKB = (stats.size / 1024).toFixed(2);
+      console.log(`${prefix}${file.name} - ${sizeKB} KB`);
+    }
   }
 }
+listFilesWithSizes(join(process.cwd(), 'dist'));
 
-build();
+console.log('\nBuild completed successfully');