@ciderjs/gasnuki 0.2.2 → 0.2.4

package/README.ja.md

@@ -1,5 +1,10 @@
 # gasnuki
 
+[![Test Coverage](https://img.shields.io/badge/test%20coverage-87.76%25-green)](https://github.com/luthpg/gasnuki)
+[![License](https://img.shields.io/badge/license-ISC-blue.svg)](LICENSE)
+[![npm version](https://img.shields.io/npm/v/@ciderjs/gasnuki.svg)](https://www.npmjs.com/package/@ciderjs/gasnuki)
+[![GitHub issues](https://img.shields.io/github/issues/luthpg/gasnuki.svg)](https://github.com/luthpg/gasnuki/issues)
+
 Google Apps Script クライアントサイドAPIの型定義・ユーティリティ
 
 ## 概要
@@ -27,11 +32,22 @@ pnpm add @ciderjs/gasnuki
 npx @ciderjs/gasnuki
 ```
 
+... または、プロジェクトのnpmスクリプトを `package.json` に追加:
+
+```jsonc
+{
+  // others...
+  "scripts": {
+    "gas": "gasnuki"
+  }
+}
+```
+
 デフォルトでは `types` ディレクトリに型定義ファイルが生成されます。
 
 2. 生成されたディレクトリ（デフォルト: `types`）を `tsconfig.json` の `include` に追加してください:
 
-```json
+```jsonc
 {
   "compilerOptions": {
     // ... your options ...
@@ -56,7 +72,7 @@ google.script.run
   .getContent('Sheet1');
 ```
 
-## 提供機能
+## 機能
 
 - Google Apps Script クライアントAPIの型定義
 - サーバーサイド関数の戻り値型をvoidに変換するユーティリティ型
@@ -68,4 +84,4 @@ google.script.run
 
 ## ライセンス
 
-MIT 
+MIT

package/README.md

@@ -1,4 +1,9 @@
-# gasnuki
+# @ciderjs/gasnuki
+
+[![Test Coverage](https://img.shields.io/badge/test%20coverage-87.76%25-green)](https://github.com/luthpg/gasnuki)
+[![License](https://img.shields.io/badge/license-ISC-blue.svg)](LICENSE)
+[![npm version](https://img.shields.io/npm/v/@ciderjs/gasnuki.svg)](https://www.npmjs.com/package/@ciderjs/gasnuki)
+[![GitHub issues](https://img.shields.io/github/issues/luthpg/gasnuki.svg)](https://github.com/luthpg/gasnuki/issues)
 
 Type definitions and utilities for Google Apps Script client-side API
 
@@ -54,6 +59,7 @@ This will generate type definition files in the `types` directory by default.
 ```
 
 3. Then, you can use `google` with Type Definitions.
+
 ```ts
 // Type-safe access to google.script.run
 // Example: Call the server-side function getContent

package/dist/cli.cjs

@@ -3,7 +3,7 @@
 
 const path = require('node:path');
 const commander = require('commander');
-const index = require('./shared/gasnuki.D0Jm2dZh.cjs');
+const index = require('./shared/gasnuki.CYh0jbl5.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.2";
+const version = "0.2.4";
 
 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.DjqKPcXI.mjs';
+import { l as loadConfig, g as generateTypes } from './shared/gasnuki.DvpVGJ1U.mjs';
 import 'chokidar';
 import 'consola';
 import 'node:fs';
 import 'ts-morph';
 import 'jiti';
 
-const version = "0.2.2";
+const version = "0.2.4";
 
 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.D0Jm2dZh.cjs');
+const index = require('./shared/gasnuki.CYh0jbl5.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.DjqKPcXI.mjs';
+export { d as defineConfig, g as generateTypes } from './shared/gasnuki.DvpVGJ1U.mjs';
 import 'node:fs';
 import 'ts-morph';
 import 'jiti';

package/dist/promise.cjs

@@ -1,23 +1,19 @@
 'use strict';
 
 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)
-    )) {
-      continue;
+  return new Proxy(mockupFunctions, {
+    get(target, method) {
+      if (!("google" in globalThis) || !google?.script?.run) {
+        return target[method];
+      }
+      if (!(method in google.script.run)) {
+        throw Error(`Method ${method} not found in AppsScript.`);
+      }
+      return (...args) => new Promise((resolve, reject) => {
+        google.script.run.withSuccessHandler(resolve).withFailureHandler(reject)[method](...args);
+      });
     }
-    serverScripts[method] = (...args) => new Promise((resolve, reject) => {
-      google.script.run.withSuccessHandler(resolve).withFailureHandler(reject)[method](...args);
-    });
-  }
-  return serverScripts;
+  });
 };
 
 exports.getPromisedServerScripts = getPromisedServerScripts;

package/dist/promise.mjs

@@ -1,21 +1,17 @@
 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)
-    )) {
-      continue;
+  return new Proxy(mockupFunctions, {
+    get(target, method) {
+      if (!("google" in globalThis) || !google?.script?.run) {
+        return target[method];
+      }
+      if (!(method in google.script.run)) {
+        throw Error(`Method ${method} not found in AppsScript.`);
+      }
+      return (...args) => new Promise((resolve, reject) => {
+        google.script.run.withSuccessHandler(resolve).withFailureHandler(reject)[method](...args);
+      });
     }
-    serverScripts[method] = (...args) => new Promise((resolve, reject) => {
-      google.script.run.withSuccessHandler(resolve).withFailureHandler(reject)[method](...args);
-    });
-  }
-  return serverScripts;
+  });
 };
 
 export { getPromisedServerScripts };

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

@@ -74,6 +74,14 @@ const getInterfaceMethodDefinition_ = (name, node) => {
   }
   return `${jsDocString}${name}${typeParamsString}(${parameters}): ${returnType};`;
 };
+const SIMPLE_TRIGGER_FUNCTION_NAMES = [
+  "onOpen",
+  "onEdit",
+  "onInstall",
+  "onSelectionChange",
+  "doGet",
+  "doPost"
+];
 const generateAppsScriptTypes = async ({
   project: projectPath,
   srcDir,
@@ -95,13 +103,44 @@ const generateAppsScriptTypes = async ({
   );
   const methodDefinitions = [];
   const globalTypeDefinitions = [];
+  const importStatements = /* @__PURE__ */ new Set();
   const sourceFiles = project.getSourceFiles();
   consola.consola.info(`Found ${sourceFiles.length} source file(s).`);
   for (const sourceFile of sourceFiles) {
+    const importDeclarations = sourceFile.getImportDeclarations?.();
+    if (importDeclarations != null && importDeclarations.length > 0) {
+      for (const importDeclaration of importDeclarations) {
+        const moduleSpecifier = importDeclaration.getModuleSpecifierSourceFile();
+        if (moduleSpecifier) {
+          const importedFilePath = moduleSpecifier.getFilePath();
+          let relativePath = path__namespace.relative(path__namespace.dirname(absoluteOutputFile), importedFilePath).replace(/\\/g, "/");
+          relativePath = relativePath.replace(/\.(ts|tsx|d\.ts)$/, "");
+          if (!relativePath.startsWith(".") && !relativePath.startsWith("..")) {
+            relativePath = `./${relativePath}`;
+          }
+          const originalText = importDeclaration.getText();
+          const newImportText = originalText.replace(
+            importDeclaration.getModuleSpecifierValue(),
+            relativePath
+          );
+          importStatements.add(newImportText);
+        } else {
+          importStatements.add(importDeclaration.getText());
+        }
+      }
+    }
     for (const iface of sourceFile.getInterfaces()) {
+      const name = iface?.getName?.();
+      if (name == null || name.endsWith("_")) {
+        continue;
+      }
       globalTypeDefinitions.push(iface.getText());
     }
     for (const typeAlias of sourceFile.getTypeAliases()) {
+      const name = typeAlias?.getName?.();
+      if (name == null || name.endsWith("_")) {
+        continue;
+      }
       globalTypeDefinitions.push(typeAlias.getText());
     }
     for (const statement of sourceFile.getStatements()) {
@@ -112,7 +151,7 @@ const generateAppsScriptTypes = async ({
     for (const funcDecl of sourceFile.getFunctions()) {
       if (!funcDecl.isAmbient()) {
         const name = funcDecl.getName();
-        if (name != null && !name.endsWith("_")) {
+        if (name != null && !name.endsWith("_") && !SIMPLE_TRIGGER_FUNCTION_NAMES.includes(name)) {
           methodDefinitions.push(getInterfaceMethodDefinition_(name, funcDecl));
         }
       }
@@ -122,7 +161,7 @@ const generateAppsScriptTypes = async ({
         for (const varDecl of varStmt.getDeclarations()) {
           const initializer = varDecl.getInitializer();
           const varName = varDecl.getName();
-          if (initializer != null && (initializer.getKind() === tsMorph.SyntaxKind.ArrowFunction || initializer.getKind() === tsMorph.SyntaxKind.FunctionExpression) && !varName.endsWith("_")) {
+          if (initializer != null && (initializer.getKind() === tsMorph.SyntaxKind.ArrowFunction || initializer.getKind() === tsMorph.SyntaxKind.FunctionExpression) && !varName.endsWith("_") && !SIMPLE_TRIGGER_FUNCTION_NAMES.includes(varName)) {
             methodDefinitions.push(
               getInterfaceMethodDefinition_(
                 varName,
@@ -142,6 +181,11 @@ const generateAppsScriptTypes = async ({
   let outputContent = `// Auto-generated by ${generatorName}
 // Do NOT edit this file manually.
 `;
+  if (importStatements.size > 0) {
+    outputContent += `${[...importStatements].join("\n")}
+
+`;
+  }
   if (globalTypeDefinitions.length > 0) {
     outputContent += `${globalTypeDefinitions.join("\n\n")}
 
@@ -159,7 +203,7 @@ ${formattedMethods}
       `Interface 'ServerScript' type definitions written to ${absoluteOutputFile} (${methodDefinitions.length} function(s), ${globalTypeDefinitions.length} type(s)).`
     );
   } else {
-    outputContent = "export type ServerScripts = {}\n";
+    outputContent += "export type ServerScripts = {}\n";
     consola.consola.info(
       `Interface 'ServerScript' type definitions written to ${absoluteOutputFile} (no functions found).`
     );

package/dist/shared/{gasnuki.DjqKPcXI.mjs → gasnuki.DvpVGJ1U.mjs}

@@ -56,6 +56,14 @@ const getInterfaceMethodDefinition_ = (name, node) => {
   }
   return `${jsDocString}${name}${typeParamsString}(${parameters}): ${returnType};`;
 };
+const SIMPLE_TRIGGER_FUNCTION_NAMES = [
+  "onOpen",
+  "onEdit",
+  "onInstall",
+  "onSelectionChange",
+  "doGet",
+  "doPost"
+];
 const generateAppsScriptTypes = async ({
   project: projectPath,
   srcDir,
@@ -77,13 +85,44 @@ const generateAppsScriptTypes = async ({
   );
   const methodDefinitions = [];
   const globalTypeDefinitions = [];
+  const importStatements = /* @__PURE__ */ new Set();
   const sourceFiles = project.getSourceFiles();
   consola.info(`Found ${sourceFiles.length} source file(s).`);
   for (const sourceFile of sourceFiles) {
+    const importDeclarations = sourceFile.getImportDeclarations?.();
+    if (importDeclarations != null && importDeclarations.length > 0) {
+      for (const importDeclaration of importDeclarations) {
+        const moduleSpecifier = importDeclaration.getModuleSpecifierSourceFile();
+        if (moduleSpecifier) {
+          const importedFilePath = moduleSpecifier.getFilePath();
+          let relativePath = path.relative(path.dirname(absoluteOutputFile), importedFilePath).replace(/\\/g, "/");
+          relativePath = relativePath.replace(/\.(ts|tsx|d\.ts)$/, "");
+          if (!relativePath.startsWith(".") && !relativePath.startsWith("..")) {
+            relativePath = `./${relativePath}`;
+          }
+          const originalText = importDeclaration.getText();
+          const newImportText = originalText.replace(
+            importDeclaration.getModuleSpecifierValue(),
+            relativePath
+          );
+          importStatements.add(newImportText);
+        } else {
+          importStatements.add(importDeclaration.getText());
+        }
+      }
+    }
     for (const iface of sourceFile.getInterfaces()) {
+      const name = iface?.getName?.();
+      if (name == null || name.endsWith("_")) {
+        continue;
+      }
       globalTypeDefinitions.push(iface.getText());
     }
     for (const typeAlias of sourceFile.getTypeAliases()) {
+      const name = typeAlias?.getName?.();
+      if (name == null || name.endsWith("_")) {
+        continue;
+      }
       globalTypeDefinitions.push(typeAlias.getText());
     }
     for (const statement of sourceFile.getStatements()) {
@@ -94,7 +133,7 @@ const generateAppsScriptTypes = async ({
     for (const funcDecl of sourceFile.getFunctions()) {
       if (!funcDecl.isAmbient()) {
         const name = funcDecl.getName();
-        if (name != null && !name.endsWith("_")) {
+        if (name != null && !name.endsWith("_") && !SIMPLE_TRIGGER_FUNCTION_NAMES.includes(name)) {
           methodDefinitions.push(getInterfaceMethodDefinition_(name, funcDecl));
         }
       }
@@ -104,7 +143,7 @@ const generateAppsScriptTypes = async ({
         for (const varDecl of varStmt.getDeclarations()) {
           const initializer = varDecl.getInitializer();
           const varName = varDecl.getName();
-          if (initializer != null && (initializer.getKind() === SyntaxKind.ArrowFunction || initializer.getKind() === SyntaxKind.FunctionExpression) && !varName.endsWith("_")) {
+          if (initializer != null && (initializer.getKind() === SyntaxKind.ArrowFunction || initializer.getKind() === SyntaxKind.FunctionExpression) && !varName.endsWith("_") && !SIMPLE_TRIGGER_FUNCTION_NAMES.includes(varName)) {
             methodDefinitions.push(
               getInterfaceMethodDefinition_(
                 varName,
@@ -124,6 +163,11 @@ const generateAppsScriptTypes = async ({
   let outputContent = `// Auto-generated by ${generatorName}
 // Do NOT edit this file manually.
 `;
+  if (importStatements.size > 0) {
+    outputContent += `${[...importStatements].join("\n")}
+
+`;
+  }
   if (globalTypeDefinitions.length > 0) {
     outputContent += `${globalTypeDefinitions.join("\n\n")}
 
@@ -141,7 +185,7 @@ ${formattedMethods}
       `Interface 'ServerScript' type definitions written to ${absoluteOutputFile} (${methodDefinitions.length} function(s), ${globalTypeDefinitions.length} type(s)).`
     );
   } else {
-    outputContent = "export type ServerScripts = {}\n";
+    outputContent += "export type ServerScripts = {}\n";
     consola.info(
       `Interface 'ServerScript' type definitions written to ${absoluteOutputFile} (no functions found).`
     );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ciderjs/gasnuki",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "description": "Type definitions and utilities for Google Apps Script client-side API",
   "main": "dist/index.mjs",
   "types": "dist/index.d.ts",
@@ -26,7 +26,10 @@
     "check": "biome check --write",
     "build": "unbuild",
     "test": "vitest run",
-    "prepare": "pnpm run generate && pnpm run check && pnpm run test && pnpm run build",
+    "test:coverage": "vitest run --coverage",
+    "update-coverage-badge": "jiti scripts/update-coverage-badge.ts README.md README.ja.md",
+    "test:coverage:update": "pnpm test:coverage && pnpm update-coverage-badge",
+    "prepare": "pnpm run generate && pnpm run check && pnpm run test:coverage:update && pnpm run build",
     "pg:react": "pnpm -C playground/react",
     "pg:vue": "pnpm -C playground/vue3"
   },

package/types/appsscript.ts

@@ -1,53 +0,0 @@
-export type RemoveReturnType<T> = {
-  [P in keyof T]: T[P] extends (...args: infer A) => any
-    ? (...args: A) => void
-    : T[P];
-};
-
-type _AppsScriptRun = {
-  [key: string]: (...args: any[]) => any;
-  withSuccessHandler: <T = string | number | boolean | undefined, U = any>(
-    callback: (returnValues: T, userObject?: U) => void,
-  ) => _AppsScriptRun;
-  withFailureHandler: <U = any>(
-    callback: (error: Error, userObject?: U) => void,
-  ) => _AppsScriptRun;
-  withUserObject: <U = any>(userObject: U) => _AppsScriptRun;
-};
-
-type _AppsScriptHistoryFunction = (
-  stateObject: object,
-  params: object,
-  hash: string,
-) => void;
-
-interface _WebAppLovacationType {
-  hash: string;
-  parameter: Record<string, string>;
-  parameters: Record<string, string[]>;
-}
-
-export declare interface GoogleClientSideApi {
-  script: {
-    run: _AppsScriptRun;
-    url: {
-      getLocation: (
-        callback: (location: _WebAppLovacationType) => void,
-      ) => void;
-    };
-    history: {
-      push: _AppsScriptHistoryFunction;
-      replace: _AppsScriptHistoryFunction;
-      setChangeHandler: (
-        callback: (e: {
-          state: object;
-          location: _WebAppLovacationType;
-        }) => void,
-      ) => void;
-    };
-  };
-}
-
-declare global {
-  const google: GoogleClientSideApi;
-}