create-ones-app 0.0.5 → 0.0.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-ones-app",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "",
   "type": "module",
   "main": "./dist/index.cjs",

package/template/example/AGENTS.md

@@ -1 +1,104 @@
 # AGENTS.md
+
+This is the ONES application code directory
+
+Next, you can deploy the ONES application
+
+Before deployment, you need to:
+
+## 1. Check if netlify cli is installed
+
+Check command:
+
+```bash
+netlify -v
+```
+
+If the command is missing, you can install it with the following command:
+
+```bash
+npm i -g netlify-cli
+```
+
+If you get an `Error: EACCES: permission denied` error
+
+You need to request `sudo` permissions and retry with the following command:
+
+```bash
+sudo npm i -g netlify-cli
+```
+
+If you get other errors
+
+Please check your network and proxy configuration, then retry
+
+If multiple retries fail, prompt the user to install manually
+
+If the check passes, proceed to the next step
+
+## 2. Check if netlify cli is logged in
+
+Check command:
+
+```bash
+netlify status
+```
+
+If the user is not logged in
+
+You can guide the user to register or log in based on the `netlify --help` prompt
+
+If the check passes, proceed to the next step
+
+## 3. Deploy ONES application
+
+Deployment command:
+
+```bash
+netlify deploy --create-site --prod
+```
+
+If deployment fails
+
+Please check your network and proxy configuration, then retry
+
+If multiple retries fail, prompt the user to install manually
+
+If deployment is successful, proceed to the next step
+
+## 4. Return key information
+
+In the previous step, `netlify` will output the application deployment URL in the command line
+
+The application deployment URL will immediately follow the "Deployed to production URL" statement
+
+We extract two key pieces of information to tell the user:
+
+- Application deployment URL: `${url}`
+- Application installation URL: `${url}/api/app_manifest`
+
+The application installation URL is actually concatenated based on the application deployment URL
+
+The concatenated path defaults to `/api/app_manifest`
+
+Corresponding to the `netlify/functions/app_manifest.js` file
+
+If the user has moved this file, please replace it with the actual filename
+
+## 5. Iteration and development
+
+If the user needs secondary development
+
+You can perform secondary development based on the current ONES application code
+
+Regarding ONES application capabilities, you need to understand relevant information from the following documentation:
+
+- events: [https://p8205-k3s-9-submodule-opendocs2.k3s-dev.myones.net/docs/abilities/events/]
+- extensions: [https://p8205-k3s-9-submodule-opendocs2.k3s-dev.myones.net/docs/abilities/extensions/]
+- openapi: [https://p8205-k3s-9-submodule-opendocs2.k3s-dev.myones.net/docs/abilities/openapi/]
+- web-sdk: [https://p8205-k3s-9-submodule-opendocs2.k3s-dev.myones.net/docs/abilities/web-sdk/]
+
+Regarding ONES application description files, you need to understand relevant information from the following documentation:
+
+- app_manifest: [https://p8205-k3s-9-submodule-opendocs2.k3s-dev.myones.net/docs/guide/getting-started/quick-start-guide#build-your-app-manifest]
+- app_schema_validator: [https://p8205-k3s-9-submodule-opendocs2.k3s-dev.myones.net/docs/app_schema_validator/]

package/template/example/README.md

@@ -1 +1,84 @@
 # README.md
+
+这是 ONES 应用代码目录
+
+下一步，你可以部署 ONES 应用
+
+在部署之前你需要：
+
+## 1. 检查 netlify cli 是否已安装
+
+检查命令：
+
+```bash
+netlify -v
+```
+
+如果提示缺少命令，你可以用以下命令安装：
+
+```bash
+npm i -g netlify-cli
+```
+
+如果提示 `Error: EACCES: permission denied` 错误时
+
+你需要申请 `sudo` 权限，用以下命令重试：
+
+```bash
+sudo npm i -g netlify-cli
+```
+
+如果提示其他错误时
+
+请检查网络和代理配置，然后重试
+
+## 2. 检查 netlify cli 是否已登录
+
+检查命令：
+
+```bash
+netlify status
+```
+
+如果你未登录
+
+可以根据 `netlify --help` 的提示进行注册或者登录
+
+## 3. 部署 ONES 应用
+
+部署命令：
+
+```bash
+netlify deploy --create-site --prod
+```
+
+如果部署失败时
+
+请检查网络和代理配置，然后重试
+
+## 4. 获取应用信息
+
+在上一步，`netlify` 会在命令行输出应用的部署地址
+
+应用的部署地址会紧跟在 Deployed to production URL 的声明后面
+
+- 应用的部署地址: `${url}`
+- 应用的安装地址：`${url}/api/app_manifest`
+
+应用的安装地址，其实是根据应用的部署地址拼接的
+
+拼接的路径，默认为 `/api/app_manifest`
+
+对应 `netlify/functions/app_manifest.js` 这个文件
+
+如果移动过这个文件，请替换为实际的文件名
+
+当你拿到应用的安装地址时，可以去 ONES 的应用中心进行安装
+
+## 5. 迭代和开发
+
+当你需要二次开发时，请浏览开发者文档
+
+开发者文档地址如下：
+
+[https://p8205-k3s-9-submodule-opendocs2.k3s-dev.myones.net/]

package/template/example/netlify/functions/app_manifest.js

@@ -1,7 +1,7 @@
 /** @type { import("../../types/app_manifest.d.ts").AppManifest } */
 const example = {
   // Required fields
-  id: 'app_01234567890abcdef',
+  id: 'app_0123456789abcdef',
   name: 'ONES App',
   version: 'v1.0.0',
   base_url: 'https://your-domain',
@@ -41,7 +41,7 @@ const example = {
   },
 }
 
-exports.handler = (req) => {
+exports.handler = async (req) => {
   // Set CORS headers to allow cross-origin requests
   const headers = {
     'Access-Control-Allow-Origin': '*',

package/template/example/netlify/functions/app_setting_pages.js

@@ -8,7 +8,7 @@ const example = {
   ],
 }
 
-exports.handler = (req) => {
+exports.handler = async (req) => {
   // Set CORS headers to allow cross-origin requests
   const headers = {
     'Access-Control-Allow-Origin': '*',

package/template/example/netlify/functions/events.js

@@ -1,4 +1,4 @@
-exports.handler = (req) => {
+exports.handler = async (req) => {
   // Set CORS headers to allow cross-origin requests
   const headers = {
     'Access-Control-Allow-Origin': '*',

package/template/example/netlify/functions/install.js

@@ -1,4 +1,4 @@
-exports.handler = (req) => {
+exports.handler = async (req) => {
   // Set CORS headers to allow cross-origin requests
   const headers = {
     'Access-Control-Allow-Origin': '*',

package/template/example/netlify/functions/metadata.js

@@ -1,4 +1,4 @@
-exports.handler = (req) => {
+exports.handler = async (req) => {
   // Set CORS headers to allow cross-origin requests
   const headers = {
     'Access-Control-Allow-Origin': '*',

package/template/example/netlify.toml

@@ -1,13 +1,18 @@
 [build]
   # Publish directory
   publish = "public"
-  
-  # Functions directory
-  functions = "netlify/functions"
+
+  # Build command
+  command = "echo 'Static site - no build required'"
 
 [build.environment]
   # Node.js version
-  NODE_VERSION = "18"
+  NODE_VERSION = "20"
+
+# Functions
+[functions]
+  directory = "netlify/functions"
+  node_bundler = "esbuild"
 
 # Redirect rules (optional)
 [[redirects]]
@@ -15,7 +20,15 @@
   to = "/.netlify/functions/:splat"
   status = 200
 
-# Header settings
+# CORS headers for all static assets
+[[headers]]
+  for = "/*"
+  [headers.values]
+    Access-Control-Allow-Origin = "*"
+    Access-Control-Allow-Methods = "GET, POST, PUT, DELETE, OPTIONS"
+    Access-Control-Allow-Headers = "Content-Type, Authorization, X-Requested-With"
+
+# Security headers for all files
 [[headers]]
   for = "/*"
   [headers.values]

package/template/example/public/index.html

@@ -3,13 +3,13 @@
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Hello World - Vercel</title>
+    <title>Hello World - Netlify</title>
     <link rel="stylesheet" href="style.css" />
   </head>
   <body>
     <div class="container">
       <h1>Hello World!</h1>
-      <p>欢迎来到Vercel部署的Hello World应用</p>
+      <p>欢迎来到 Netlify 部署的 ONES 应用</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>