@choiceopen/automation-plugin-cli 0.2.0 → 0.2.3

package/dist/templates/common/LICENSE.md.eta

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) <%= props.year %> <%= props.author %>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/templates/common/PRIVACY.md.eta

@@ -0,0 +1,47 @@
+# Privacy Policy
+
+**Last Updated: <%= props.date %>**
+
+## Overview
+
+<%= props.name %> ("the Plugin") is committed to protecting your privacy. This policy explains how data is handled when you use the Plugin within the Choiceform Atomemo Platform.
+
+## Data Collection
+
+The Plugin may collect and process the following types of data:
+
+- **Usage Data**: Information about how you interact with the Plugin
+- **Configuration Data**: Settings and preferences you configure within the Plugin
+- **Input Data**: Data you provide to the Plugin for processing
+
+## Data Usage
+
+Collected data is used solely for:
+
+- Providing and improving Plugin functionality
+- Debugging and error resolution
+- Analytics and performance optimization
+
+## Data Storage
+
+- All data is processed in accordance with the Choiceform Atomemo Platform's data handling policies
+- No personal data is stored beyond what is necessary for Plugin operation
+- Data is not shared with third parties unless required by law
+
+## Your Rights
+
+You have the right to:
+
+- Access your data
+- Request data deletion
+- Opt out of non-essential data collection
+
+## Contact
+
+For privacy-related inquiries, please contact:
+
+<%= props.author %><% if (props.email) { %> (<%= props.email %>)<% } %>
+
+## Changes to This Policy
+
+We may update this privacy policy from time to time. Any changes will be reflected by updating the "Last Updated" date above.

package/dist/templates/typescript/.editorconfig

@@ -0,0 +1,15 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

package/dist/templates/typescript/.typesafe-i18n.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://unpkg.com/typesafe-i18n@5.26.2/schema/typesafe-i18n.json",
+  "adapter": "node",
+  "baseLocale": "en-US",
+  "esmImports": true,
+  "generateOnlyTypes": true,
+  "runAfterGenerator": "bun biome format ./src/i18n --write"
+}

package/dist/templates/typescript/README.md.eta

@@ -0,0 +1,21 @@
+# Atomemo Plugin - <%= props.name %>
+
+## Development
+
+- Install dependencies:
+
+```bash
+bun install
+```
+
+- Run the unit tests:
+
+```bash
+bun run test
+```
+
+- Build the library:
+
+```bash
+bun run build
+```

package/dist/templates/typescript/biome.json.eta

@@ -0,0 +1,32 @@
+{
+  "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "useIgnoreFile": true
+  },
+  "assist": {
+    "enabled": true,
+    "actions": {
+      "recommended": true
+    },
+    "includes": ["**", "!src/i18n"]
+  },
+  "formatter": {
+    "enabled": true,
+    "includes": ["**"],
+    "indentStyle": "space"
+  },
+  "linter": {
+    "enabled": true,
+    "includes": ["**", "!src/i18n"],
+    "rules": {
+      "recommended": true
+    }
+  },
+  "javascript": {
+    "formatter": {
+      "semicolons": "asNeeded"
+    }
+  }
+}

package/dist/templates/typescript/package.json.eta

@@ -0,0 +1,57 @@
+{
+  "name": "<%= props.name %>",
+  "type": "module",
+  "version": "<%= props.version %>",
+  "description": "<%= props.description %>",
+  "author": "<%= props.author %> <<%= props.email %>>",
+  "license": "MIT",
+  "homepage": "https://github.com/<%= props.author %>/<%= props.name %>#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/<%= props.author %>/<%= props.name %>.git"
+  },
+  "bugs": {
+    "url": "https://github.com/<%= props.author %>/<%= props.name %>/issues"
+  },
+  "exports": {
+    ".": {
+      "development": "./src/index.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsdown",
+    "dev": "concurrently -c=cyan.bold,blue.bold --names=DEV,I18N --pad-prefix \"tsdown --watch\" \"typesafe-i18n\"",
+    "test": "vitest",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "bun run build"
+  },
+  "dependencies": {
+    "@choiceopen/automation-plugin-sdk-js": "@choiceopen/automation-plugin-sdk-js",
+    "dotenv": "^17.2.3",
+    "zod": "^4.3.5"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.3.11",
+    "@types/bun": "^1.3.6",
+    "bumpp": "^10.4.0",
+    "concurrently": "9.2.1",
+    "tsdown": "^0.19.0",
+    "typesafe-i18n": "^5.26.2",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.17"
+  },
+  "publishConfig": {
+    "exports": {
+      ".": "./dist/index.js",
+      "./package.json": "./package.json"
+    }
+  }
+}

package/dist/templates/typescript/src/README.md.eta

@@ -0,0 +1,24 @@
+# src
+
+源代码主目录，包含插件的所有核心模块。
+
+## 目录结构
+
+- `tools/` - [工具定义模块](./tools/README.md)
+- `i18n/` - [国际化模块](./i18n/README.md)
+- `index.ts` - 插件入口文件
+
+## 入口文件
+
+`index.ts` 是插件的入口点，负责：
+1. 加载所有国际化语言包
+2. 创建插件实例
+3. 注册工具
+4. 启动插件
+
+## 架构
+
+插件基于 `@choiceopen/automation-plugin-sdk-js` SDK 构建，采用模块化设计：
+- 工具独立定义
+- 通过统一的国际化系统提供多语言支持
+- 所有组件通过插件实例统一注册和管理

package/dist/templates/typescript/src/i18n/README.md

@@ -0,0 +1,29 @@
+# i18n
+
+国际化模块，基于 typesafe-i18n 实现类型安全的国际化支持。
+
+## 目录结构
+
+- `en-US/` - 英文翻译
+- `zh-Hans/` - 简体中文翻译
+
+## 核心文件
+
+- `i18n-node.ts` - 国际化入口，提供 `t()` 函数用于获取翻译文本
+- `i18n-util.ts` - 国际化工具函数和类型定义（基础配置）
+- `i18n-util.sync.ts` - 同步加载所有语言包
+- `i18n-util.async.ts` - 异步加载语言包（用于动态导入）
+- `i18n-types.ts` - 自动生成的类型定义（包含所有翻译键的类型）
+- `formatters.ts` - 格式化函数配置（当前为空）
+
+## 功能
+
+- 支持英文（en-US）和简体中文（zh-Hans）两种语言
+- 类型安全的翻译键，编译时检查
+- 同步和异步两种加载方式
+- 自动生成类型定义
+
+## 关系
+
+- 被所有需要国际化的模块导入（tools、index）
+- 在 `src/index.ts` 中通过 `loadAllLocalesAsync()` 异步加载所有语言包

package/dist/templates/typescript/src/i18n/en-US/README.md

@@ -0,0 +1,12 @@
+# en-US
+
+英文翻译文件目录。
+
+## 文件
+
+- `index.ts` - 英文翻译内容，包含插件、工具等所有 UI 文本的英文版本
+
+## 关系
+
+- 被 `src/i18n/i18n-util.sync.ts` 和 `src/i18n/i18n-util.async.ts` 导入
+- 与 `src/i18n/zh-Hans/` 目录对应，提供多语言支持

package/dist/templates/typescript/src/i18n/en-US/index.ts.eta

@@ -0,0 +1,13 @@
+import type { BaseTranslation } from "../i18n-types"
+
+const en_US = {
+  PLUGIN_DISPLAY_NAME: "Testing Plugin",
+  PLUGIN_DESCRIPTION: "A plugin for testing the plugin",
+  DEMO_TOOL_DISPLAY_NAME: "Demo Tool",
+  DEMO_TOOL_DESCRIPTION: "A tool for testing the plugin",
+  LOCATION_DISPLAY_NAME: "Location",
+  LOCATION_HINT: "The location to test",
+  LOCATION_PLACEHOLDER: "Enter the location to test",
+} satisfies BaseTranslation
+
+export default en_US

package/dist/templates/typescript/src/i18n/formatters.ts.eta

@@ -0,0 +1,12 @@
+import type { FormattersInitializer } from "typesafe-i18n"
+import type { Locales, Formatters } from "./i18n-types.js"
+
+export const initFormatters: FormattersInitializer<Locales, Formatters> = (
+  locale: Locales,
+) => {
+  const formatters: Formatters = {
+    // add your formatter functions here
+  }
+
+  return formatters
+}

package/dist/templates/typescript/src/i18n/i18n-node.ts.eta

@@ -0,0 +1,31 @@
+// This file was auto-generated by 'typesafe-i18n'. Any manual changes will be overwritten.
+/* eslint-disable */
+
+import { i18n, locales } from "./i18n-util.js"
+import { loadAllLocales } from "./i18n-util.sync.js"
+import type { LocaleTranslationFunctions } from "typesafe-i18n"
+import type {
+  Locales,
+  Translations,
+  TranslationFunctions,
+} from "./i18n-types.js"
+
+loadAllLocales()
+
+export const L: LocaleTranslationFunctions<
+  Locales,
+  Translations,
+  TranslationFunctions
+> = i18n()
+
+export const t = (entry: keyof Translations) => {
+  return locales.reduce<{ en_US: string; [key: string]: string }>(
+    (entries, locale) => {
+      const underscoreLocale = locale.replace("-", "_")
+      return Object.assign(entries, { [underscoreLocale]: L[locale][entry]() })
+    },
+    { en_US: "" },
+  )
+}
+
+export default L

package/dist/templates/typescript/src/i18n/i18n-types.ts.eta

@@ -0,0 +1,79 @@
+// This file was auto-generated by 'typesafe-i18n'. Any manual changes will be overwritten.
+/* eslint-disable */
+import type {
+  BaseTranslation as BaseTranslationType,
+  LocalizedString,
+} from "typesafe-i18n"
+
+export type BaseTranslation = BaseTranslationType
+export type BaseLocale = "en-US"
+
+export type Locales = "en-US" | "zh-Hans"
+
+export type Translation = RootTranslation
+
+export type Translations = RootTranslation
+
+type RootTranslation = {
+  /**
+   * T​e​s​t​i​n​g​ ​P​l​u​g​i​n
+   */
+  PLUGIN_DISPLAY_NAME: string
+  /**
+   * A​ ​p​l​u​g​i​n​ ​f​o​r​ ​t​e​s​t​i​n​g​ ​t​h​e​ ​p​l​u​g​i​n
+   */
+  PLUGIN_DESCRIPTION: string
+  /**
+   * D​e​m​o​ ​T​o​o​l
+   */
+  DEMO_TOOL_DISPLAY_NAME: string
+  /**
+   * A​ ​t​o​o​l​ ​f​o​r​ ​t​e​s​t​i​n​g​ ​t​h​e​ ​p​l​u​g​i​n
+   */
+  DEMO_TOOL_DESCRIPTION: string
+  /**
+   * L​o​c​a​t​i​o​n
+   */
+  LOCATION_DISPLAY_NAME: string
+  /**
+   * T​h​e​ ​l​o​c​a​t​i​o​n​ ​t​o​ ​t​e​s​t
+   */
+  LOCATION_HINT: string
+  /**
+   * E​n​t​e​r​ ​t​h​e​ ​l​o​c​a​t​i​o​n​ ​t​o​ ​t​e​s​t
+   */
+  LOCATION_PLACEHOLDER: string
+}
+
+export type TranslationFunctions = {
+  /**
+   * Testing Plugin
+   */
+  PLUGIN_DISPLAY_NAME: () => LocalizedString
+  /**
+   * A plugin for testing the plugin
+   */
+  PLUGIN_DESCRIPTION: () => LocalizedString
+  /**
+   * Demo Tool
+   */
+  DEMO_TOOL_DISPLAY_NAME: () => LocalizedString
+  /**
+   * A tool for testing the plugin
+   */
+  DEMO_TOOL_DESCRIPTION: () => LocalizedString
+  /**
+   * Location
+   */
+  LOCATION_DISPLAY_NAME: () => LocalizedString
+  /**
+   * The location to test
+   */
+  LOCATION_HINT: () => LocalizedString
+  /**
+   * Enter the location to test
+   */
+  LOCATION_PLACEHOLDER: () => LocalizedString
+}
+
+export type Formatters = {}

package/dist/templates/typescript/src/i18n/i18n-util.async.ts.eta

@@ -0,0 +1,33 @@
+// This file was auto-generated by 'typesafe-i18n'. Any manual changes will be overwritten.
+/* eslint-disable */
+
+import { initFormatters } from "./formatters.js"
+import type { Locales, Translations } from "./i18n-types.js"
+import { loadedFormatters, loadedLocales, locales } from "./i18n-util.js"
+
+const localeTranslationLoaders = {
+  "en-US": () => import("./en-US/index.js"),
+  "zh-Hans": () => import("./zh-Hans/index.js"),
+}
+
+const updateDictionary = (
+  locale: Locales,
+  dictionary: Partial<Translations>,
+): Translations =>
+  (loadedLocales[locale] = { ...loadedLocales[locale], ...dictionary })
+
+export const importLocaleAsync = async (
+  locale: Locales,
+): Promise<Translations> =>
+  (await localeTranslationLoaders[locale]()).default as unknown as Translations
+
+export const loadLocaleAsync = async (locale: Locales): Promise<void> => {
+  updateDictionary(locale, await importLocaleAsync(locale))
+  loadFormatters(locale)
+}
+
+export const loadAllLocalesAsync = (): Promise<void[]> =>
+  Promise.all(locales.map(loadLocaleAsync))
+
+export const loadFormatters = (locale: Locales): void =>
+  void (loadedFormatters[locale] = initFormatters(locale))

package/dist/templates/typescript/src/i18n/i18n-util.sync.ts.eta

@@ -0,0 +1,26 @@
+// This file was auto-generated by 'typesafe-i18n'. Any manual changes will be overwritten.
+/* eslint-disable */
+
+import { initFormatters } from "./formatters.js"
+import type { Locales, Translations } from "./i18n-types.js"
+import { loadedFormatters, loadedLocales, locales } from "./i18n-util.js"
+
+import en_US from "./en-US/index.js"
+import zh_Hans from "./zh-Hans/index.js"
+
+const localeTranslations = {
+  "en-US": en_US,
+  "zh-Hans": zh_Hans,
+}
+
+export const loadLocale = (locale: Locales): void => {
+  if (loadedLocales[locale]) return
+
+  loadedLocales[locale] = localeTranslations[locale] as unknown as Translations
+  loadFormatters(locale)
+}
+
+export const loadAllLocales = (): void => locales.forEach(loadLocale)
+
+export const loadFormatters = (locale: Locales): void =>
+  void (loadedFormatters[locale] = initFormatters(locale))

package/dist/templates/typescript/src/i18n/i18n-util.ts.eta

@@ -0,0 +1,63 @@
+// This file was auto-generated by 'typesafe-i18n'. Any manual changes will be overwritten.
+/* eslint-disable */
+
+import {
+  i18n as initI18n,
+  i18nObject as initI18nObject,
+  i18nString as initI18nString,
+} from "typesafe-i18n"
+import type { LocaleDetector } from "typesafe-i18n/detectors"
+import type {
+  LocaleTranslationFunctions,
+  TranslateByString,
+} from "typesafe-i18n"
+import { detectLocale as detectLocaleFn } from "typesafe-i18n/detectors"
+import { initExtendDictionary } from "typesafe-i18n/utils"
+import type {
+  Formatters,
+  Locales,
+  Translations,
+  TranslationFunctions,
+} from "./i18n-types.js"
+
+export const baseLocale: Locales = "en-US"
+
+export const locales: Locales[] = ["en-US", "zh-Hans"]
+
+export const isLocale = (locale: string): locale is Locales =>
+  locales.includes(locale as Locales)
+
+export const loadedLocales: Record<Locales, Translations> = {} as Record<
+  Locales,
+  Translations
+>
+
+export const loadedFormatters: Record<Locales, Formatters> = {} as Record<
+  Locales,
+  Formatters
+>
+
+export const extendDictionary = initExtendDictionary<Translations>()
+
+export const i18nString = (locale: Locales): TranslateByString =>
+  initI18nString<Locales, Formatters>(locale, loadedFormatters[locale])
+
+export const i18nObject = (locale: Locales): TranslationFunctions =>
+  initI18nObject<Locales, Translations, TranslationFunctions, Formatters>(
+    locale,
+    loadedLocales[locale],
+    loadedFormatters[locale],
+  )
+
+export const i18n = (): LocaleTranslationFunctions<
+  Locales,
+  Translations,
+  TranslationFunctions
+> =>
+  initI18n<Locales, Translations, TranslationFunctions, Formatters>(
+    loadedLocales,
+    loadedFormatters,
+  )
+
+export const detectLocale = (...detectors: LocaleDetector[]): Locales =>
+  detectLocaleFn<Locales>(baseLocale, locales, ...detectors)

package/dist/templates/typescript/src/i18n/zh-Hans/README.md

@@ -0,0 +1,12 @@
+# zh-Hans
+
+简体中文翻译文件目录。
+
+## 文件
+
+- `index.ts` - 简体中文翻译内容，包含插件、工具等所有 UI 文本的中文版本
+
+## 关系
+
+- 被 `src/i18n/i18n-util.sync.ts` 和 `src/i18n/i18n-util.async.ts` 导入
+- 与 `src/i18n/en-US/` 目录对应，提供多语言支持

package/dist/templates/typescript/src/i18n/zh-Hans/index.ts.eta

@@ -0,0 +1,13 @@
+import type { Translation } from "../i18n-types"
+
+const zh_Hans = {
+  PLUGIN_DISPLAY_NAME: "测试插件",
+  PLUGIN_DESCRIPTION: "一个用于测试插件的插件",
+  DEMO_TOOL_DISPLAY_NAME: "演示工具",
+  DEMO_TOOL_DESCRIPTION: "一个用于测试插件的工具",
+  LOCATION_DISPLAY_NAME: "位置",
+  LOCATION_HINT: "要测试的位置",
+  LOCATION_PLACEHOLDER: "输入要测试的位置",
+} satisfies Translation
+
+export default zh_Hans

package/dist/templates/typescript/src/index.ts.eta

@@ -0,0 +1,25 @@
+import { createPlugin } from "@choiceopen/automation-plugin-sdk-js"
+import packageJSON from "../package.json"
+import { t } from "./i18n/i18n-node"
+import { locales } from "./i18n/i18n-util"
+import { loadAllLocalesAsync } from "./i18n/i18n-util.async"
+import { demoTool } from "./tools/demo"
+
+await loadAllLocalesAsync()
+
+const plugin = createPlugin({
+  name: packageJSON.name,
+  display_name: t("PLUGIN_DISPLAY_NAME"),
+  description: t("PLUGIN_DESCRIPTION"),
+  icon: "🎛️",
+  author: "Choiceform",
+  email: "support@choiceform.com",
+  version: packageJSON.version,
+  repo: "https://github.com/choice-open/automation-official-plugins/plugins/testing-plugin",
+  locales,
+  transporterOptions: {},
+})
+
+plugin.addTool(demoTool)
+
+plugin.run()

package/dist/templates/typescript/src/tools/README.md

@@ -0,0 +1,18 @@
+# tools
+
+工具定义模块，用于定义插件提供的可执行工具。
+
+## 文件
+
+- `demo.ts` - 演示工具定义，包含工具参数和执行逻辑
+
+## 功能
+
+定义 `demo-tool` 工具，包含：
+- 参数定义（location 字符串）
+- 执行逻辑（invoke 函数，返回测试消息）
+
+## 关系
+
+- 被 `src/index.ts` 导入并注册到插件
+- 使用 `src/i18n/i18n-node.ts` 获取国际化文本

package/dist/templates/typescript/src/tools/demo.ts.eta

@@ -0,0 +1,29 @@
+import type { ToolDefinition } from "@choiceopen/automation-plugin-sdk-js/types"
+import { t } from "../i18n/i18n-node"
+
+export const demoTool = {
+  name: "demo-tool",
+  display_name: t("DEMO_TOOL_DISPLAY_NAME"),
+  description: t("DEMO_TOOL_DESCRIPTION"),
+  icon: "🧰",
+  parameters: [
+    {
+      name: "location",
+      type: "string",
+      required: true,
+      display_name: t("LOCATION_DISPLAY_NAME"),
+      ui: {
+        component: "input",
+        hint: t("LOCATION_HINT"),
+        placeholder: t("LOCATION_PLACEHOLDER"),
+        support_expression: true,
+        width: "full",
+      },
+    },
+  ],
+  async invoke({ args }: { args: { location: string } }) {
+    return {
+      message: `Testing the plugin with location: ${args.location}`,
+    }
+  },
+} satisfies ToolDefinition

package/dist/templates/typescript/test/README.md

@@ -0,0 +1,15 @@
+# tests
+
+测试文件目录。
+
+## 文件
+
+- `index.test.ts` - 主测试文件
+
+## 测试框架
+
+使用 Vitest 作为测试框架，配置在 `package.json` 中。
+
+## 关系
+
+- 测试 `src/` 目录下的所有模块