https://github.com/fossamagna/google-script-dts-generator
Generate TypeScript declaration (.d.ts) file for google.script.run(Client-side API).
https://github.com/fossamagna/google-script-dts-generator
apps-script typescript
Last synced: about 1 year ago
JSON representation
Generate TypeScript declaration (.d.ts) file for google.script.run(Client-side API).
- Host: GitHub
- URL: https://github.com/fossamagna/google-script-dts-generator
- Owner: fossamagna
- Created: 2020-04-06T01:48:21.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-01-03T06:59:03.000Z (about 1 year ago)
- Last Synced: 2025-01-04T14:52:53.541Z (about 1 year ago)
- Topics: apps-script, typescript
- Language: TypeScript
- Size: 876 KB
- Stars: 6
- Watchers: 3
- Forks: 4
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# google-script-dts-generator [![NPM version][npm-image]][npm-url]
Generate TypeScript declaration (.d.ts) file for [google.script.run](https://developers.google.com/apps-script/guides/html/reference/run)(Client-side API).
## About
`google-script-dts-generator` generates a client-side TypeScript declaration (.d.ts) for the Apps Script function from a server-side TypeScript source that matchs the following conditions:
* function assignment expressions to `global` object.
* named export functions (when using `namedExportsFiles` option)
## Example
See [example](./example).
server.ts:
```ts
global.echo = (message: string) => {
return message;
};
```
generate:
```sh
$ google-script-dts-generator --sourcesDir server/ --outputDir client/
```
generated `google-script.d.ts`:
```ts
declare namespace google {
/**
* Methods available to Google Apps Script
*/
namespace script {
interface IRun {
echo(message: string): void;
/**
* Sets a callback function to run if the server-side function throws an exception. Without a failure handler, failures are logged to the JavaScript console. To override this, call withFailureHandler(null) or supply a failure handler that does nothing.
* @param callback a client-side callback function to run if the server-side function throws an exception; the Error object is passed to the function as the first argument, and the user object (if any) is passed as a second argument
*/
withFailureHandler(callback: (error: Error, object?: any)=>void): IRun;
/**
* Sets a callback function to run if the server-side function returns successfully.
* @param callback a client-side callback function to run if the server-side function returns successfully; the server's return value is passed to the function as the first argument, and the user object (if any) is passed as a second argument
*/
withSuccessHandler(callback: (value: any, object?: any)=>void): IRun;
/**
* Sets an object to pass as a second parameter to the success and failure handlers.
* @param {Object} object an object to pass as a second parameter to the success and failure handlers; because user objects are not sent to the server, they are not subject to the restrictions on parameters and return values for server calls. User objects cannot, however, be objects constructed with the new operator
*/
withUserObject(object: object): IRun;
}
const run: IRun;
// omitted below
}
```
## Installation
```sh
$ npm install google-script-dts-generator --save-dev
```
or
```
$ yarn add google-script-dts-generator
```
## Usage
### CLI
```sh
$ google-script-dts-generator --sourcesDir server --outputDir client
```
### Options
* [`--sourcesDir `](#--sourcesDir-sources)
* [`--outputDir `](#--outputDir-outputDir)
* [`--namedExportsFiles `](#--namedExportsFiles-glob)
* [`--endpointsOnly`](#--endpointsOnly)
* [`--nonVoidReturnType`](#--nonVoidReturnType)
#### `--sourcesDir `
Path to TypeScript sources directory.
```sh
$ google-script-dts-generator --outputDir ./example/client --sourcesDir ./example/server
```
#### `--outputDir `
Path to a generated `d.ts` file output directory.
```sh
$ google-script-dts-generator --outputDir ./example/client --sourcesDir ./example/server
```
#### `--namedExportsFiles `
A glob path pattern to generates a client-side TypeScript declaration (.d.ts) from named exports.
**Note**: Glob patterns should always use / as a path separator, even on Windows systems
```sh
$ google-script-dts-generator --outputDir ./example/client --sourcesDir ./example/server --namedExportsFiles './example/server/**/*.ts'
```
#### `--endpointsOnly`
When use [@types/google.script.client-side](https://www.npmjs.com/package/@types/google.script.client-side), User needs define specify functions as PublicEndpoints.
google-script-dts-generator support generate only PublicEndpoint interfaces.
```
yarn google-script-dts-generator -s ./src/server/ -o ./src/client/ --namedExportsFiles "./src/server/**/*.ts" --endpointsOnly
```
Output:
```ts
declare namespace google {
namespace script {
interface PublicEndpoints {
doGet(): void;
myFunction(param1: string, param2: boolean): void;
}
}
}
```
#### `--nonVoidReturnType`
generate return type of server-side function as return type of client-side function.
This option assumed that using in combination with [gas-client](https://www.npmjs.com/package/gas-client).
> Note: Use gas-client@1.0.0-pr.2 or later
```
yarn google-script-dts-generator -s ./src/server/ -o ./src/client/ --namedExportsFiles "./src/server/**/*.ts" --endpointsOnly --nonVoidReturnType
```
Output:
```ts
declare namespace google {
/**
* Methods available to Google Apps Script
*/
namespace script {
interface PublicEndpoints {
helloWorld(): string;
echo(message: string): string;
}
}
}
```
client.ts
```ts
import { GASClient } from 'gas-client';
const { serverFunctions } = new GASClient();
serverFunctions.echo("hello gas")
.then((s) => console.log(s))
.catch(e => console.error(e));
```
[npm-image]: https://badge.fury.io/js/google-script-dts-generator.svg
[npm-url]: https://npmjs.org/package/google-script-dts-generator