gasrun.ts v0.1.0

gasrun

Minimalist wrapper for google.script.run with native TypeScript support.

This package promisifies google.script.run, a client-side API of Google Apps Script (GAS) to call server-side GAS functions from HTML-service pages. Wrapped GAS functions are typed in TypeScript with the promisified types of the corresponding GAS functions.

This enables type checks and enhances IDE assists.

Installation

How to use

In the server-side code, export functions to be called from the client-side.

// gas-functions.ts: GAS server-side code

export function hello(str: string) {
  return `Hello ${str}!`;
}

export function concat(prop: { a: string; b: unknown }) {
  return { result: prop.a + prop.b };
}

export function throwError() {
  throw new Error("Error in GAS!");
}

Wrap exported GAS functions in the client-side.

// Frontend code bundled into GAS HTML-service pages
import { wrapGASFunctions } from "gasrun";

// Wrap the all functions exported from a module.
import * as GASFuncs from "./gas-functions";
const gasrun = wrapGASFunctions(GASFuncs);

// Wrap specified functions of a module.
import { hello } from "./gas-functions";
const gasrun = wrapGASFunctions({ hello });

Then, use the wrapped functions with proper types.

// Case of using then & catch
gasrun
  .hello("world") // hello: (str: string) => Promise<string>
  .then((result) => {
    console.log(result);
  });
gasrun.throwError().catch((error) => {
  console.error(error);
});

// Case of using async & await
(async () => {
  const { result } =
    // concat: (prop: { a: string, b: unknown }) => Promise<{ result: string }>
    await gasrun.concat({ a: "string", b: 123 });
  console.log(result);
  try {
    await gasrun.throwError();
  } catch (error) {
    console.error(error);
  }
})();

You can use this package as an ES module in JavaScript also, like below in a GAS HTML-service page.

<script type="module">
  import { wrapGASFuntions } from "https://unpkg.com/gasrun";

  // Wrap all functions available within google.script.run
  const gasrun = wrapGASFuntions();
  // Or you can specify wrapping functions as
  const gasrun = wrapGASFuntions({ hello: null, concat: null });

  (async () => {
    const { result } = await gasrun.concat(await gasrun.hello("world"), 123);
    document.body.textContent = result;
  })();
</script>