create-ones-app 0.0.2 → 0.0.3

package/dist/index.cjs

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const commander = require("commander");
-const node_fs = require("node:fs");
+const node_process = require("node:process");
 const node_path = require("node:path");
+const chalk = require("chalk");
+const fsExtra = require("fs-extra");
+const node_fs = require("node:fs");
 const node_url = require("node:url");
 var _documentCurrentScript = typeof document !== "undefined" ? document.currentScript : null;
-const action = (value) => {
-  console.log("value", value);
-};
 const getPackageJSONPath = () => {
   const __dirname = node_path.dirname(node_url.fileURLToPath(typeof document === "undefined" ? require("url").pathToFileURL(__filename).href : _documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === "SCRIPT" && _documentCurrentScript.src || new URL("index.cjs", document.baseURI).href));
   return node_path.join(__dirname, "../package.json");
@@ -34,11 +34,21 @@ const getTemplateChoices = () => {
 const getTemplateDefault = () => {
   return "example";
 };
+const action = async (value) => {
+  console.log(`template-name: ${chalk.green(value)}`);
+  console.log("creating template...");
+  try {
+    await fsExtra.copy(node_path.join(getTemplatePath(), value), node_process.cwd());
+    console.log(chalk.green("Create template successfully!"));
+  } catch (error) {
+    console.error(chalk.red(error));
+  }
+};
 const create = new commander.Command("create");
 create.description("description").addArgument(new commander.Argument("[template-name]", "specify a template for the created project").choices(getTemplateChoices()).default(getTemplateDefault())).action(action);
-async function runCommandCreate() {
+const runCommandCreate = async () => {
   const version = `${getPackageJSON().version}`;
   create.version(version);
   await create.parse();
-}
+};
 exports.runCommandCreate = runCommandCreate;

package/dist/index.js

@@ -1,10 +1,10 @@
 import { Command, Argument } from "commander";
-import { readdirSync, readFileSync } from "node:fs";
+import { cwd } from "node:process";
 import { dirname, join } from "node:path";
+import chalk from "chalk";
+import { copy } from "fs-extra";
+import { readdirSync, readFileSync } from "node:fs";
 import { fileURLToPath } from "node:url";
-const action = (value) => {
-  console.log("value", value);
-};
 const getPackageJSONPath = () => {
   const __dirname = dirname(fileURLToPath(import.meta.url));
   return join(__dirname, "../package.json");
@@ -31,13 +31,23 @@ const getTemplateChoices = () => {
 const getTemplateDefault = () => {
   return "example";
 };
+const action = async (value) => {
+  console.log(`template-name: ${chalk.green(value)}`);
+  console.log("creating template...");
+  try {
+    await copy(join(getTemplatePath(), value), cwd());
+    console.log(chalk.green("Create template successfully!"));
+  } catch (error) {
+    console.error(chalk.red(error));
+  }
+};
 const create = new Command("create");
 create.description("description").addArgument(new Argument("[template-name]", "specify a template for the created project").choices(getTemplateChoices()).default(getTemplateDefault())).action(action);
-async function runCommandCreate() {
+const runCommandCreate = async () => {
   const version = `${getPackageJSON().version}`;
   create.version(version);
   await create.parse();
-}
+};
 export {
   runCommandCreate
 };

package/dist/types/action.d.ts

@@ -1,2 +1,2 @@
-export declare const action: (value: string) => void;
+export declare const action: (value: string) => Promise<void>;
 //# sourceMappingURL=action.d.ts.map

package/dist/types/action.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../src/action.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,MAAM,UAAW,MAAM,SAEnC,CAAA"}
+{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../src/action.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,MAAM,UAAiB,MAAM,kBASzC,CAAA"}

package/dist/types/index.d.ts

@@ -1,2 +1,2 @@
-export declare function runCommandCreate(): Promise<void>;
+export declare const runCommandCreate: () => Promise<void>;
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAeA,wBAAsB,gBAAgB,kBAIrC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAeA,eAAO,MAAM,gBAAgB,qBAI5B,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-ones-app",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -49,7 +49,12 @@
     "registry": "https://registry.npmjs.org",
     "access": "public"
   },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4"
+  },
   "dependencies": {
-    "commander": "~9.4.0"
+    "chalk": "^5.0.1",
+    "commander": "~9.4.0",
+    "fs-extra": "^11.3.0"
   }
 }

package/template/example/.template.json

@@ -0,0 +1,18 @@
+{
+  "name": "example",
+  "version": "0.0.1",
+  "keywords": [
+    "example",
+    "demo",
+    "hello-world"
+  ],
+  "abilities": [
+    "events",
+    "extensions",
+    "openapi",
+    "web-sdk"
+  ],
+  "stack": [
+    "vercel"
+  ]
+}

package/template/example/AGENTS.md

@@ -0,0 +1 @@
+# AGENTS.md

package/template/example/README.md

@@ -0,0 +1 @@
+# README.md

package/template/example/api/app_manifest.d.ts

@@ -0,0 +1,115 @@
+/**
+ * ONES Application Manifest Schema Interface
+ * Defines the structure for application manifest
+ * Documentation: https://p8205-k3s-9-submodule-opendocs2.k3s-dev.myones.net/docs/guide/getting-started/quick-start-guide#build-your-app-manifest
+ */
+export interface AppManifest {
+  /** Application ID, format: app_ + 16 lowercase alphanumeric characters */
+  id: string
+
+  /** Application name, 1-64 characters */
+  name: string
+
+  /** Semantic version number (e.g., v1.0.0) */
+  version: string
+
+  /** Application base URL, must start with http(s):// and not contain ? or # */
+  base_url: string
+
+  /** Authentication configuration */
+  auth: {
+    /** Authentication type (currently only supports 'jwt') */
+    type: 'jwt'
+  }
+
+  /** Lifecycle callback configuration */
+  lifecycle_callback: {
+    /** Install callback endpoint (required) */
+    install: string
+    /** Enable callback endpoint (optional) */
+    enabled?: string
+    /** Disable callback endpoint (optional) */
+    disabled?: string
+    /** Uninstall callback endpoint (optional) */
+    uninstalled?: string
+  }
+
+  /** Application description, maximum 1024 characters (optional) */
+  desc?: string | null
+
+  /** Application Logo URL (optional) */
+  logo?: string | null
+
+  /** Event configuration (optional) */
+  events?: {
+    /** Event callback URL, must start with / and not contain # */
+    url: string
+    /** Event type list */
+    types: Array<{
+      /** ONES defined event type, the application will listen to this event.
+       * Available event types include: ones:project:issue:created, ones:project:issue:updated,
+       * ones:project:project:created, ones:project:project:updated,
+       * ones:project:project-member:added, ones:project:project-member:deleted,
+       * ones:project:project-role:added, ones:project:project-role:deleted
+       * For complete list, see: https://developer.ones.com/docs/abilities/events/ */
+      eventType: string
+    }>
+  } | null
+
+  /** Extension configuration (optional) */
+  extensions?: {
+    /** Application setting page extensions */
+    appSettingPages?: Array<{
+      /** Unique identifier for the extension */
+      key: string
+      /** Extension functionality configuration */
+      funcs: {
+        /** Custom entries endpoint */
+        customEntries: string
+      }
+    }>
+
+    /** Manhour validator extensions */
+    manhourValidator?: Array<{
+      /** Unique identifier for the extension */
+      key: string
+      /** Extension functionality configuration */
+      funcs: {
+        /** Validation endpoint */
+        validate: string
+      }
+    }>
+  } | null
+
+  /** OAuth configuration (optional) */
+  oauth?: {
+    /** OAuth scope permissions list. Available scopes include: read:project:issue,
+     * write:project:issue, read:project:project, write:project:project,
+     * read:project:issueType, read:project:issueStatus, read:project:issueField,
+     * read:project:issueFieldGroup, read:project:issue-attachment,
+     * write:project:issue-attachment, write:project:issue-timeEstimated,
+     * write:project:issue-timeRemaining, read:project:issue-timeSpent,
+     * write:project:issue-timeSpent, write:project:issue-comment,
+     * read:project:issue-comment, write:project:issue-watcher,
+     * read:product:fields, read:project:workLog-timeEstimated,
+     * read:testcase:library, write:testcase:library, read:account:department,
+     * read:account:department-member, read:account:user, write:account:user,
+     * read:appcenter:app, write:appcenter:user, read:wiki:space,
+     * read:wiki:page, read:wiki:resource, write:wiki:page,
+     * read:wiki:template, read:system:info
+     * For complete list, see: https://developer.ones.com/docs/abilities/openapi/scope */
+    scope: string[]
+    /** OAuth type, supports 'app' and 'user' */
+    type?: ('app' | 'user')[] | null
+    /** OAuth redirect URL, must start with / and not contain # (optional) */
+    redirect_url?: string | null
+  } | null
+
+  /** ONES version compatibility (optional) */
+  ones_version?: {
+    /** Minimum compatible ONES version (e.g., v6.42.0) */
+    min?: string
+    /** Maximum compatible ONES version (e.g., v6.88.0) */
+    max?: string
+  } | null
+}

package/template/example/api/app_manifest.js

@@ -0,0 +1,69 @@
+/** @type { import("./app_manifest.d.ts").AppManifest } */
+const example = {
+  // Required fields
+  id: 'app_01234567890abcdef',
+  name: 'ONES App',
+  version: 'v1.0.0',
+  base_url: 'https://your-domain',
+  auth: {
+    type: 'jwt',
+  },
+  lifecycle_callback: {
+    install: '/api/install',
+  },
+
+  // Optional fields
+  desc: 'ONES App example with some features.',
+  logo: 'https://your-domain/logo.png',
+
+  // Event configuration
+  events: {
+    url: '/api/events',
+    types: [{ eventType: 'ones:project:issue:created' }],
+  },
+
+  // Extension configuration
+  extensions: {
+    appSettingPages: [
+      {
+        key: 'myCustomEntries',
+        funcs: {
+          customEntries: '/api/app_setting_pages',
+        },
+      },
+    ],
+  },
+
+  // OAuth configuration
+  oauth: {
+    scope: ['read:project:project'],
+    type: ['app', 'user'],
+  },
+}
+
+export default function handler(req, res) {
+  // Set CORS headers to allow cross-origin requests
+  res.setHeader('Access-Control-Allow-Origin', '*')
+  res.setHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS')
+  res.setHeader('Access-Control-Allow-Headers', 'Content-Type, Authorization')
+
+  // Handle preflight requests
+  if (req.method === 'OPTIONS') {
+    res.status(200).end()
+    return
+  }
+
+  // Get host from request headers
+  const host = req.headers.host
+
+  // Clone data from example
+  const data = JSON.parse(JSON.stringify(example))
+
+  // Update data's base_url field with host
+  data.base_url = `https://${host}`
+
+  // Update data's logo field with logo.svg
+  data.logo = `https://${host}/logo.svg`
+
+  res.status(200).json(data)
+}

package/template/example/api/app_setting_pages.d.ts

@@ -0,0 +1,14 @@
+/**
+ * ONES Application Setting Pages Configuration Interface
+ * Defines the structure for application setting page entries
+ * Documentation: https://p8205-k3s-9-submodule-opendocs2.k3s-dev.myones.net/
+ */
+export interface AppSettingPages {
+  /** Array of setting page entries */
+  entries: Array<{
+    /** URL of the setting page, must start with / and not contain # */
+    page_url: string
+    /** Display title for the setting page entry */
+    title: string
+  }>
+}

package/template/example/api/app_setting_pages.js

@@ -0,0 +1,27 @@
+/** @type { import("./app_setting_pages.d.ts").AppSettingPages } */
+const example = {
+  entries: [
+    {
+      page_url: '/',
+      title: 'Example Page',
+    },
+  ],
+}
+
+export default function handler(req, res) {
+  // Set CORS headers to allow cross-origin requests
+  res.setHeader('Access-Control-Allow-Origin', '*')
+  res.setHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS')
+  res.setHeader('Access-Control-Allow-Headers', 'Content-Type, Authorization')
+
+  // Handle preflight requests
+  if (req.method === 'OPTIONS') {
+    res.status(200).end()
+    return
+  }
+
+  // Clone data from example
+  const data = JSON.parse(JSON.stringify(example))
+
+  res.status(200).json(data)
+}

package/template/example/api/events.js

@@ -0,0 +1,14 @@
+export default function handler(req, res) {
+  // Set CORS headers to allow cross-origin requests
+  res.setHeader('Access-Control-Allow-Origin', '*')
+  res.setHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS')
+  res.setHeader('Access-Control-Allow-Headers', 'Content-Type, Authorization')
+
+  // Handle preflight requests
+  if (req.method === 'OPTIONS') {
+    res.status(200).end()
+    return
+  }
+
+  res.status(200).json({})
+}

package/template/example/api/install.js

@@ -0,0 +1,14 @@
+export default function handler(req, res) {
+  // Set CORS headers to allow cross-origin requests
+  res.setHeader('Access-Control-Allow-Origin', '*')
+  res.setHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS')
+  res.setHeader('Access-Control-Allow-Headers', 'Content-Type, Authorization')
+
+  // Handle preflight requests
+  if (req.method === 'OPTIONS') {
+    res.status(200).end()
+    return
+  }
+
+  res.status(200).json({})
+}

package/template/example/api/metadata.js

@@ -0,0 +1,16 @@
+export default function handler(req, res) {
+  // Set CORS headers to allow cross-origin requests
+  res.setHeader('Access-Control-Allow-Origin', '*')
+  res.setHeader('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE, OPTIONS')
+  res.setHeader('Access-Control-Allow-Headers', 'Content-Type, Authorization')
+
+  // Handle preflight requests
+  if (req.method === 'OPTIONS') {
+    res.status(200).end()
+    return
+  }
+
+  res.status(200).json({
+    metadata: 'example metadata',
+  })
+}

package/template/example/public/index.html

@@ -0,0 +1,20 @@
+<!doctype html>
+<html lang="zh-CN">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Hello World - Vercel</title>
+    <link rel="stylesheet" href="style.css" />
+  </head>
+  <body>
+    <div class="container">
+      <h1>Hello World!</h1>
+      <p>欢迎来到Vercel部署的Hello World应用</p>
+      <button id="app-api-button" class="api-button">调用 App API 接口</button>
+      <button id="open-api-button" class="api-button">使用 Open API 接口</button>
+      <div id="result" class="result" style="display: none"></div>
+    </div>
+    <script src="https://unpkg.com/@ones-open/sdk/dist/index.iife.js"></script>
+    <script src="script.js"></script>
+  </body>
+</html>

package/template/example/public/logo.svg

@@ -0,0 +1,4 @@
+<svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg">
+<rect width="16" height="16" rx="2" fill="#0064FF"/>
+<path fill-rule="evenodd" clip-rule="evenodd" d="M7.43816 2.66672C6.82458 2.66672 6.31279 3.17606 6.31279 3.82228V4.4445C6.31279 4.68996 6.11381 4.88894 5.86835 4.88894H3.55556V6.70091H4.56017C5.68056 6.70091 6.57443 7.62426 6.57443 8.74535C6.57443 9.83706 5.70842 10.8718 4.56017 10.8718H3.55556V12.4445H10.6667V10.4274C10.6667 10.1819 10.8657 9.98296 11.1111 9.98296H12.208C12.7937 9.98296 13.3333 9.42095 13.3333 8.74535C13.3333 8.09914 12.8215 7.5898 12.208 7.5898H11.1111C10.8657 7.5898 10.6667 7.39081 10.6667 7.14535V4.88894H9.00797C8.76251 4.88894 8.56353 4.68996 8.56353 4.4445V3.82228C8.56353 3.17606 8.05174 2.66672 7.43816 2.66672ZM5.4239 3.82228C5.4239 2.70118 6.31778 1.77783 7.43816 1.77783C8.55854 1.77783 9.45242 2.70118 9.45242 3.82228V4.00005H11.1111C11.3566 4.00005 11.5556 4.19904 11.5556 4.4445V6.70091H12.208C13.3284 6.70091 14.2222 7.62426 14.2222 8.74535C14.2222 9.83706 13.3562 10.8718 12.208 10.8718H11.5556V12.8889C11.5556 13.1344 11.3566 13.3334 11.1111 13.3334H3.11112C2.86566 13.3334 2.66667 13.1344 2.66667 12.8889V10.4274C2.66667 10.1819 2.86566 9.98296 3.11112 9.98296H4.56017C5.14589 9.98296 5.68554 9.42095 5.68554 8.74535C5.68554 8.09914 5.17375 7.5898 4.56017 7.5898H3.11112C2.86566 7.5898 2.66667 7.39081 2.66667 7.14535V4.4445C2.66667 4.32662 2.7135 4.21358 2.79685 4.13023C2.8802 4.04688 2.99324 4.00005 3.11112 4.00005H5.4239V3.82228Z" fill="white"/>
+</svg>

package/template/example/public/script.js

@@ -0,0 +1,56 @@
+;(function () {
+  'use strict'
+
+  if (!window.SDK) {
+    console.error('Web SDK not initialized')
+    // see: https://developer.ones.com/docs/abilities/events/
+    return
+  }
+
+  if (!window.SDK.ONES) {
+    console.error('Web SDK is only supported on ONES extension context')
+    // see: https://developer.ones.com/docs/abilities/events/
+    return
+  }
+
+  console.log('Web SDK initialized successfully')
+
+  // Get DOM elements
+  const appApiButton = document.getElementById('app-api-button')
+  const openApiButton = document.getElementById('open-api-button')
+
+  // App API button click handler
+  appApiButton.addEventListener('click', async function () {
+    const resultDiv = document.getElementById('result')
+    resultDiv.style.display = 'block'
+    resultDiv.innerHTML = '<div class="loading">正在调用 App API...</div>'
+
+    try {
+      // see: https://developer.ones.com/docs/abilities/events/
+      const response = await window.SDK.ONES.fetchApp('/api/metadata')
+      const data = await response.json()
+      resultDiv.innerHTML = `App API 响应:\n${JSON.stringify(data, null, 2)}`
+    } catch (error) {
+      resultDiv.innerHTML = `App API 错误: ${error.message}`
+    }
+  })
+
+  // Open API button click handler
+  openApiButton.addEventListener('click', async function () {
+    const resultDiv = document.getElementById('result')
+    resultDiv.style.display = 'block'
+    resultDiv.innerHTML = '<div class="loading">正在调用 Open API...</div>'
+
+    try {
+      // see: https://developer.ones.com/docs/abilities/events/
+      const teamInfo = await window.SDK.ONES.getTeamInfo()
+      const teamUUID = teamInfo.teamUUID
+      // see: https://developer.ones.com/docs/abilities/events/
+      const response = await window.SDK.ONES.fetchOpenAPI(`/v2/project/projects?teamID=${teamUUID}`)
+      const data = await response.json()
+      resultDiv.innerHTML = `Open API 响应:\n${JSON.stringify(data, null, 2)}`
+    } catch (error) {
+      resultDiv.innerHTML = `Open API 错误: ${error.message}`
+    }
+  })
+})()

package/template/example/public/style.css

@@ -0,0 +1,66 @@
+body {
+  font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
+  margin: 0;
+  padding: 0;
+  background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
+  min-height: 100vh;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+}
+
+.container {
+  text-align: center;
+  background: white;
+  padding: 3rem;
+  border-radius: 20px;
+  box-shadow: 0 20px 40px rgba(0, 0, 0, 0.1);
+  max-width: 600px;
+  margin: 2rem;
+}
+
+h1 {
+  color: #333;
+  font-size: 3rem;
+  margin-bottom: 1rem;
+  background: linear-gradient(45deg, #667eea, #764ba2);
+  -webkit-background-clip: text;
+  -webkit-text-fill-color: transparent;
+  background-clip: text;
+}
+
+p {
+  color: #666;
+  font-size: 1.2rem;
+  margin-bottom: 2rem;
+}
+
+.api-button {
+  background: linear-gradient(45deg, #667eea, #764ba2);
+  color: white;
+  border: none;
+  padding: 1rem 2rem;
+  border-radius: 50px;
+  font-size: 1.1rem;
+  cursor: pointer;
+  transition: transform 0.2s;
+  margin: 0.5rem;
+}
+
+.api-button:hover {
+  transform: translateY(-2px);
+}
+
+.result {
+  margin-top: 2rem;
+  padding: 1rem;
+  background: #f8f9fa;
+  border-radius: 10px;
+  text-align: left;
+  font-family: monospace;
+  white-space: pre-wrap;
+}
+
+.loading {
+  color: #667eea;
+}

package/template/example/vercel.json

@@ -0,0 +1,23 @@
+{
+  "version": 2,
+  "builds": [
+    {
+      "src": "api/**/*.js",
+      "use": "@vercel/node"
+    },
+    {
+      "src": "public/**/*",
+      "use": "@vercel/static"
+    }
+  ],
+  "routes": [
+    {
+      "src": "/api/(.*)",
+      "dest": "/api/$1.js"
+    },
+    {
+      "src": "/(.*)",
+      "dest": "/public/$1"
+    }
+  ]
+}

package/template/example/test.json

@@ -1,3 +0,0 @@
-{
-  "test": "test"
-}