@ciderjs/gasnuki 0.2.0 → 0.2.2

package/README.md

@@ -26,11 +26,22 @@ pnpm add @ciderjs/gasnuki
 npx @ciderjs/gasnuki
 ```
 
+... or, add project's npm-script in `package.json`:
+
+```jsonc
+{
+  // others...
+  "scripts": {
+    "gas": "gasnuki"
+  }
+}
+```
+
 This will generate type definition files in the `types` directory by default.
 
 2. Make sure the generated directory (default: `types`) is included in your `tsconfig.json`:
 
-```json
+```jsonc
 {
   "compilerOptions": {
     // ... your options ...
@@ -65,4 +76,4 @@ Bug reports and pull requests are welcome. Please use the `issues` or `pull requ
 
 ## License
 
-MIT
+MIT

package/dist/cli.cjs

@@ -3,7 +3,7 @@
 
 const path = require('node:path');
 const commander = require('commander');
-const index = require('./shared/gasnuki.Yj84yCWz.cjs');
+const index = require('./shared/gasnuki.D0Jm2dZh.cjs');
 require('chokidar');
 require('consola');
 require('node:fs');
@@ -24,7 +24,7 @@ function _interopNamespaceCompat(e) {
 
 const path__namespace = /*#__PURE__*/_interopNamespaceCompat(path);
 
-const version = "0.2.0";
+const version = "0.2.2";
 
 const parseArgs = async (command) => {
   const cliOpts = command.opts();

package/dist/cli.mjs

@@ -1,14 +1,14 @@
 #! /usr/bin/env  node
 import * as path from 'node:path';
 import { Command } from 'commander';
-import { l as loadConfig, g as generateTypes } from './shared/gasnuki.C-MvXA42.mjs';
+import { l as loadConfig, g as generateTypes } from './shared/gasnuki.DjqKPcXI.mjs';
 import 'chokidar';
 import 'consola';
 import 'node:fs';
 import 'ts-morph';
 import 'jiti';
 
-const version = "0.2.0";
+const version = "0.2.2";
 
 const parseArgs = async (command) => {
   const cliOpts = command.opts();

package/dist/index.cjs

@@ -3,7 +3,7 @@
 require('node:path');
 require('chokidar');
 require('consola');
-const index = require('./shared/gasnuki.Yj84yCWz.cjs');
+const index = require('./shared/gasnuki.D0Jm2dZh.cjs');
 require('node:fs');
 require('ts-morph');
 require('jiti');

package/dist/index.mjs

@@ -1,7 +1,7 @@
 import 'node:path';
 import 'chokidar';
 import 'consola';
-export { d as defineConfig, g as generateTypes } from './shared/gasnuki.C-MvXA42.mjs';
+export { d as defineConfig, g as generateTypes } from './shared/gasnuki.DjqKPcXI.mjs';
 import 'node:fs';
 import 'ts-morph';
 import 'jiti';

package/dist/promise.cjs

@@ -1,7 +1,12 @@
 'use strict';
 
-const ServerScripts = () => {
-  const serverScripts = {};
+const getPromisedServerScripts = (mockupFunctions = {}) => {
+  const serverScripts = {
+    ...mockupFunctions
+  };
+  if (!("google" in globalThis) || !google?.script?.run) {
+    return serverScripts;
+  }
   for (const method of Object.keys(google.script.run)) {
     if (["withSuccessHandler", "withFailureHandler", "withUserObject"].includes(
       String(method)
@@ -15,4 +20,4 @@ const ServerScripts = () => {
   return serverScripts;
 };
 
-exports.ServerScripts = ServerScripts;
+exports.getPromisedServerScripts = getPromisedServerScripts;

package/dist/promise.d.cts

@@ -1,6 +1,8 @@
 type Promised<T> = {
     [K in keyof T]: T[K] extends (...args: infer A) => infer R ? (...args: A) => Promise<R> : T[K];
 };
-declare const ServerScripts: <T extends Record<string, (...args: any[]) => any> = Omit<Omit<Omit<typeof google.script.run, "withSuccessHandler">, "withFailureHandler">, "withUserObject">>() => Promised<T>;
+type PartialScriptType<T> = Partial<Promised<T>>;
+declare const getPromisedServerScripts: <T extends Record<string, (...args: any[]) => any> = Omit<typeof google.script.run, "withSuccessHandler" | "withFailureHandler" | "withUserObject">>(mockupFunctions?: PartialScriptType<T>) => Promised<T>;
 
-export { ServerScripts };
+export { getPromisedServerScripts };
+export type { PartialScriptType, Promised };

package/dist/promise.d.mts

@@ -1,6 +1,8 @@
 type Promised<T> = {
     [K in keyof T]: T[K] extends (...args: infer A) => infer R ? (...args: A) => Promise<R> : T[K];
 };
-declare const ServerScripts: <T extends Record<string, (...args: any[]) => any> = Omit<Omit<Omit<typeof google.script.run, "withSuccessHandler">, "withFailureHandler">, "withUserObject">>() => Promised<T>;
+type PartialScriptType<T> = Partial<Promised<T>>;
+declare const getPromisedServerScripts: <T extends Record<string, (...args: any[]) => any> = Omit<typeof google.script.run, "withSuccessHandler" | "withFailureHandler" | "withUserObject">>(mockupFunctions?: PartialScriptType<T>) => Promised<T>;
 
-export { ServerScripts };
+export { getPromisedServerScripts };
+export type { PartialScriptType, Promised };

package/dist/promise.d.ts

@@ -1,6 +1,8 @@
 type Promised<T> = {
     [K in keyof T]: T[K] extends (...args: infer A) => infer R ? (...args: A) => Promise<R> : T[K];
 };
-declare const ServerScripts: <T extends Record<string, (...args: any[]) => any> = Omit<Omit<Omit<typeof google.script.run, "withSuccessHandler">, "withFailureHandler">, "withUserObject">>() => Promised<T>;
+type PartialScriptType<T> = Partial<Promised<T>>;
+declare const getPromisedServerScripts: <T extends Record<string, (...args: any[]) => any> = Omit<typeof google.script.run, "withSuccessHandler" | "withFailureHandler" | "withUserObject">>(mockupFunctions?: PartialScriptType<T>) => Promised<T>;
 
-export { ServerScripts };
+export { getPromisedServerScripts };
+export type { PartialScriptType, Promised };

package/dist/promise.mjs

@@ -1,5 +1,10 @@
-const ServerScripts = () => {
-  const serverScripts = {};
+const getPromisedServerScripts = (mockupFunctions = {}) => {
+  const serverScripts = {
+    ...mockupFunctions
+  };
+  if (!("google" in globalThis) || !google?.script?.run) {
+    return serverScripts;
+  }
   for (const method of Object.keys(google.script.run)) {
     if (["withSuccessHandler", "withFailureHandler", "withUserObject"].includes(
       String(method)
@@ -13,4 +18,4 @@ const ServerScripts = () => {
   return serverScripts;
 };
 
-export { ServerScripts };
+export { getPromisedServerScripts };

package/dist/shared/{gasnuki.Yj84yCWz.cjs → gasnuki.D0Jm2dZh.cjs}

@@ -23,7 +23,7 @@ const path__namespace = /*#__PURE__*/_interopNamespaceCompat(path);
 const chokidar__namespace = /*#__PURE__*/_interopNamespaceCompat(chokidar);
 const fs__namespace = /*#__PURE__*/_interopNamespaceCompat(fs);
 
-const text = "type RemoveReturnType<T> = {\n  [P in keyof T]: T[P] extends (...args: infer A) => any\n    ? (...args: A) => void\n    : T[P];\n};\n\ntype _AppsScriptRun = RemoveReturnType<ServerScripts> & {\n  [key: string]: (...args: any[]) => any;\n  withSuccessHandler: <T = string | number | boolean | undefined, U = any>(\n    callback: (returnValues: T, userObject?: U) => void,\n  ) => _AppsScriptRun;\n  withFailureHandler: <U = any>(\n    callback: (error: Error, userObject?: U) => void,\n  ) => _AppsScriptRun;\n  withUserObject: <U = any>(userObject: U) => _AppsScriptRun;\n};\n\ntype _AppsScriptHistoryFunction = (\n  stateObject: object,\n  params: object,\n  hash: string,\n) => void;\n\ninterface _WebAppLovacationType {\n  hash: string;\n  parameter: Record<string, string>;\n  parameters: Record<string, string[]>;\n}\n\nexport declare interface GoogleClientSideApi {\n  script: {\n    run: _AppsScriptRun;\n    url: {\n      getLocation: (\n        callback: (location: _WebAppLovacationType) => void,\n      ) => void;\n    };\n    history: {\n      push: _AppsScriptHistoryFunction;\n      replace: _AppsScriptHistoryFunction;\n      setChangeHandler: (\n        callback: (e: {\n          state: object;\n          location: _WebAppLovacationType;\n        }) => void,\n      ) => void;\n    };\n  };\n}\n\ndeclare global {\n  const google: GoogleClientSideApi;\n}\n";
+const text = "export type RemoveReturnType<T> = {\n  [P in keyof T]: T[P] extends (...args: infer A) => any\n    ? (...args: A) => void\n    : T[P];\n};\n\ntype _AppsScriptRun = RemoveReturnType<ServerScripts> & {\n  [key: string]: (...args: any[]) => any;\n  withSuccessHandler: <T = string | number | boolean | undefined, U = any>(\n    callback: (returnValues: T, userObject?: U) => void,\n  ) => _AppsScriptRun;\n  withFailureHandler: <U = any>(\n    callback: (error: Error, userObject?: U) => void,\n  ) => _AppsScriptRun;\n  withUserObject: <U = any>(userObject: U) => _AppsScriptRun;\n};\n\ntype _AppsScriptHistoryFunction = (\n  stateObject: object,\n  params: object,\n  hash: string,\n) => void;\n\ninterface _WebAppLovacationType {\n  hash: string;\n  parameter: Record<string, string>;\n  parameters: Record<string, string[]>;\n}\n\nexport declare interface GoogleClientSideApi {\n  script: {\n    run: _AppsScriptRun;\n    url: {\n      getLocation: (\n        callback: (location: _WebAppLovacationType) => void,\n      ) => void;\n    };\n    history: {\n      push: _AppsScriptHistoryFunction;\n      replace: _AppsScriptHistoryFunction;\n      setChangeHandler: (\n        callback: (e: {\n          state: object;\n          location: _WebAppLovacationType;\n        }) => void,\n      ) => void;\n    };\n  };\n}\n\ndeclare global {\n  const google: GoogleClientSideApi;\n}\n";
 
 const getInterfaceMethodDefinition_ = (name, node) => {
   const typeParameters = node.getTypeParameters?.() ?? [];

package/dist/shared/{gasnuki.C-MvXA42.mjs → gasnuki.DjqKPcXI.mjs}

@@ -5,7 +5,7 @@ import * as fs from 'node:fs';
 import { Project, SyntaxKind } from 'ts-morph';
 import { createJiti } from 'jiti';
 
-const text = "type RemoveReturnType<T> = {\n  [P in keyof T]: T[P] extends (...args: infer A) => any\n    ? (...args: A) => void\n    : T[P];\n};\n\ntype _AppsScriptRun = RemoveReturnType<ServerScripts> & {\n  [key: string]: (...args: any[]) => any;\n  withSuccessHandler: <T = string | number | boolean | undefined, U = any>(\n    callback: (returnValues: T, userObject?: U) => void,\n  ) => _AppsScriptRun;\n  withFailureHandler: <U = any>(\n    callback: (error: Error, userObject?: U) => void,\n  ) => _AppsScriptRun;\n  withUserObject: <U = any>(userObject: U) => _AppsScriptRun;\n};\n\ntype _AppsScriptHistoryFunction = (\n  stateObject: object,\n  params: object,\n  hash: string,\n) => void;\n\ninterface _WebAppLovacationType {\n  hash: string;\n  parameter: Record<string, string>;\n  parameters: Record<string, string[]>;\n}\n\nexport declare interface GoogleClientSideApi {\n  script: {\n    run: _AppsScriptRun;\n    url: {\n      getLocation: (\n        callback: (location: _WebAppLovacationType) => void,\n      ) => void;\n    };\n    history: {\n      push: _AppsScriptHistoryFunction;\n      replace: _AppsScriptHistoryFunction;\n      setChangeHandler: (\n        callback: (e: {\n          state: object;\n          location: _WebAppLovacationType;\n        }) => void,\n      ) => void;\n    };\n  };\n}\n\ndeclare global {\n  const google: GoogleClientSideApi;\n}\n";
+const text = "export type RemoveReturnType<T> = {\n  [P in keyof T]: T[P] extends (...args: infer A) => any\n    ? (...args: A) => void\n    : T[P];\n};\n\ntype _AppsScriptRun = RemoveReturnType<ServerScripts> & {\n  [key: string]: (...args: any[]) => any;\n  withSuccessHandler: <T = string | number | boolean | undefined, U = any>(\n    callback: (returnValues: T, userObject?: U) => void,\n  ) => _AppsScriptRun;\n  withFailureHandler: <U = any>(\n    callback: (error: Error, userObject?: U) => void,\n  ) => _AppsScriptRun;\n  withUserObject: <U = any>(userObject: U) => _AppsScriptRun;\n};\n\ntype _AppsScriptHistoryFunction = (\n  stateObject: object,\n  params: object,\n  hash: string,\n) => void;\n\ninterface _WebAppLovacationType {\n  hash: string;\n  parameter: Record<string, string>;\n  parameters: Record<string, string[]>;\n}\n\nexport declare interface GoogleClientSideApi {\n  script: {\n    run: _AppsScriptRun;\n    url: {\n      getLocation: (\n        callback: (location: _WebAppLovacationType) => void,\n      ) => void;\n    };\n    history: {\n      push: _AppsScriptHistoryFunction;\n      replace: _AppsScriptHistoryFunction;\n      setChangeHandler: (\n        callback: (e: {\n          state: object;\n          location: _WebAppLovacationType;\n        }) => void,\n      ) => void;\n    };\n  };\n}\n\ndeclare global {\n  const google: GoogleClientSideApi;\n}\n";
 
 const getInterfaceMethodDefinition_ = (name, node) => {
   const typeParameters = node.getTypeParameters?.() ?? [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ciderjs/gasnuki",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Type definitions and utilities for Google Apps Script client-side API",
   "main": "dist/index.mjs",
   "types": "dist/index.d.ts",
@@ -20,13 +20,15 @@
     }
   },
   "scripts": {
-    "prebuild": "jiti bin/generate.ts",
-    "dev": "pnpm prebuild && jiti src/cli.ts -p playground/react",
+    "generate": "jiti .bin/generate.ts",
+    "dev": "pnpm prebuild && jiti src/cli.ts -p playground/react -s src/server",
     "start": "node dist/cli.mjs -p playground/react -s src/server",
     "check": "biome check --write",
     "build": "unbuild",
     "test": "vitest run",
-    "prepare": "pnpm run check && pnpm run build"
+    "prepare": "pnpm run generate && pnpm run check && pnpm run test && pnpm run build",
+    "pg:react": "pnpm -C playground/react",
+    "pg:vue": "pnpm -C playground/vue3"
   },
   "keywords": ["google-apps-script", "typescript", "@google/clasp"],
   "author": "ciderjs/luth",
@@ -50,6 +52,7 @@
   "devDependencies": {
     "@biomejs/biome": "^1.9.4",
     "@types/node": "^22.15.29",
+    "@vitest/coverage-v8": "3.2.1",
     "typescript": "^5.8.3",
     "unbuild": "^3.5.0",
     "vitest": "^3.2.1"

package/{bin/typedef/clientside.d.ts → types/appsscript.ts}

@@ -1,10 +1,10 @@
-type RemoveReturnType<T> = {
+export type RemoveReturnType<T> = {
   [P in keyof T]: T[P] extends (...args: infer A) => any
     ? (...args: A) => void
     : T[P];
 };
 
-type _AppsScriptRun = RemoveReturnType<ServerScripts> & {
+type _AppsScriptRun = {
   [key: string]: (...args: any[]) => any;
   withSuccessHandler: <T = string | number | boolean | undefined, U = any>(
     callback: (returnValues: T, userObject?: U) => void,

package/bin/generate.ts

@@ -1,11 +0,0 @@
-import * as fs from 'node:fs/promises';
-
-(async () => {
-  const file = await fs.readFile('./bin/typedef/clientside.d.ts', 'utf-8');
-  await fs.writeFile(
-    './src/modules/clientside.json',
-    JSON.stringify({
-      text: file,
-    }),
-  );
-})();