create-ones-app 0.0.7 → 0.0.9

package/template/example/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/template/example/README.md

@@ -1,84 +1 @@
-# 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/]
+# README

package/template/example/_eslint.config.mjs_

@@ -0,0 +1,39 @@
+// @ts-check
+import eslint from '@eslint/js';
+import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  {
+    ignores: ['eslint.config.mjs', 'postcss.config.js', 'node_modules/', 'dist/', 'build/', 'coverage/', '*.min.js'],
+  },
+  eslint.configs.recommended,
+  ...tseslint.configs.recommendedTypeChecked,
+  eslintPluginPrettierRecommended,
+  {
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globals.jest,
+      },
+      sourceType: 'commonjs',
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  },
+  {
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-floating-promises': 'off',
+      '@typescript-eslint/no-unsafe-argument': 'warn',
+      'prettier/prettier': ['error', { endOfLine: 'auto' }],
+      '@typescript-eslint/no-unsafe-call': 'warn',
+      '@typescript-eslint/no-unsafe-assignment': 'off',
+      '@typescript-eslint/no-unsafe-member-access': 'off',
+      '@typescript-eslint/no-misused-promises': 'off',
+    },
+  },
+);

package/template/example/_gitignore

@@ -0,0 +1,23 @@
+# Node/JS
+node_modules/
+dist/
+build/
+.vite/
+*.log
+.env*
+
+# Tooling
+coverage/
+.vscode/
+.idea/
+
+# OS
+.DS_Store
+Thumbs.db
+*.tmp
+*.swp
+.codex
+
+.specify/
+specs/
+*.opkx

package/template/example/_husky_pre-commit

@@ -0,0 +1 @@
+npx lint-staged

package/template/example/_prettierignore

@@ -0,0 +1,11 @@
+.husky/
+dist/
+node_modules/
+*.png
+*.svg
+.gitignore
+.npmrc
+.prettierignore
+.eslintignore
+LICENSE
+package*.json

package/template/example/_prettierrc

@@ -0,0 +1,6 @@
+{
+  "printWidth": 100,
+  "quoteProps": "consistent",
+  "semi": false,
+  "singleQuote": true
+}

package/template/example/_tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "files": [],
+  "references": [
+    { "path": "./tsconfig.backend.json" },
+    { "path": "./tsconfig.web.json" },
+    { "path": "./tsconfig.vite.json" }
+  ]
+}

package/template/example/backend/app.controller.ts

@@ -0,0 +1,85 @@
+import { Controller, Get, Post, HttpCode, Body, Query, Headers } from '@nestjs/common'
+import { AppService, type InstallCallbackPayload } from './app.service'
+import type { IssueCreatedEvent } from './dto/issue-created-event.dto'
+import type { RecentLimit } from './dto/recent-work-item.dto'
+import { RecentWorkItemsService } from './services/recent-work-items.service'
+import { createWebPageURL } from './utils'
+
+@Controller()
+export class AppController {
+  constructor(
+    private readonly appService: AppService,
+    private readonly recentWorkItemsService: RecentWorkItemsService,
+  ) {}
+
+  @Get('/health_check')
+  healthCheck() {
+    return this.appService.healthCheck()
+  }
+
+  @Post('/install_cb')
+  @HttpCode(200)
+  installCallback(@Body() body: InstallCallbackPayload) {
+    return this.appService.installCallback(body)
+  }
+
+  @Post('/app_setting_entries')
+  @HttpCode(200)
+  getCustomEntries() {
+    return this.buildCustomEntries()
+  }
+
+  private buildCustomEntries() {
+    return {
+      entries: [
+        {
+          title: 'Recent Work Items',
+          page_url: createWebPageURL('recent-work-items.html'),
+        },
+      ],
+    }
+  }
+
+  @Post('/events/webhook')
+  @HttpCode(200)
+  async handleEventWebhook(
+    @Body() body: unknown,
+    @Headers('x-ones-event-type') eventType?: string,
+  ) {
+    if (eventType === 'ones:events:health') {
+      return { ok: true, message: 'health check passed' }
+    }
+    return this.handleEvents(body)
+  }
+
+  @Get('/api/recent-work-items')
+  @HttpCode(200)
+  async getRecentWorkItems(@Query() query: Record<string, string>) {
+    const limit = Number(query.limit) as RecentLimit
+    if (![5, 10, 30].includes(limit)) {
+      return { ok: false, error: 'limit must be 5, 10, or 30' }
+    }
+
+    const items = await this.recentWorkItemsService.getRecent({ limit })
+    return { ok: true, items }
+  }
+
+  private async handleEvents(event: unknown) {
+    if (!this.isIssueCreatedEvent(event)) {
+      return { ok: false, error: 'invalid event payload' }
+    }
+
+    await this.recentWorkItemsService.handleIssueCreated(event)
+    return { ok: true, handled: true }
+  }
+
+  private isIssueCreatedEvent(event: unknown): event is IssueCreatedEvent {
+    const candidate = event as Partial<IssueCreatedEvent> | null | undefined
+    return (
+      !!candidate &&
+      candidate.eventType === 'ones:project:issue:created' &&
+      typeof candidate.eventData?.issueID === 'string' &&
+      typeof candidate.eventData?.basicInfoChanges?.createTime?.toTime === 'number'
+    )
+  }
+}

package/template/example/backend/app.module.ts

@@ -0,0 +1,34 @@
+import { Module } from '@nestjs/common'
+import { ServeStaticModule } from '@nestjs/serve-static'
+import { AppController } from './app.controller'
+import { AppService } from './app.service'
+import { RecentWorkItemsService } from './services/recent-work-items.service'
+import { WebProxyMiddleware } from './proxy'
+import { getPublicPath, createPublicURL, getWebPath, createWebURL, isProd } from './utils'
+import type { MiddlewareConsumer } from '@nestjs/common'
+
+const imports = [
+  ServeStaticModule.forRoot({
+    rootPath: getPublicPath(),
+    serveRoot: createPublicURL(''),
+  }),
+]
+
+if (isProd()) {
+  imports.push(
+    ServeStaticModule.forRoot({
+      rootPath: getWebPath(),
+      serveRoot: createWebURL(''),
+    }),
+  )
+}
+@Module({
+  imports,
+  controllers: [AppController],
+  providers: [AppService, RecentWorkItemsService],
+})
+export class AppModule {
+  configure(consumer: MiddlewareConsumer) {
+    consumer.apply(WebProxyMiddleware).forRoutes('*')
+  }
+}

package/template/example/backend/app.service.ts

@@ -0,0 +1,46 @@
+import { Injectable, OnApplicationShutdown } from '@nestjs/common'
+import { storage } from '@ones-open/node-sdk'
+
+export type InstallCallbackPayload = {
+  installation_id: string
+  shared_secret: string
+  ones_base_url: string
+}
+
+type InstallationSecretEntity = {
+  installation_id: string
+  shared_secret: string
+  ones_base_url: string
+  updated_at: number
+}
+
+const installationSecretEntity = storage.entity<InstallationSecretEntity>('installation_secret')
+
+@Injectable()
+export class AppService implements OnApplicationShutdown {
+  healthCheck() {
+    return { ok: true }
+  }
+
+  async installCallback(payload: InstallCallbackPayload) {
+    const installationId = payload.installation_id.trim()
+    const row: InstallationSecretEntity = {
+      installation_id: installationId,
+      shared_secret: payload.shared_secret.trim(),
+      ones_base_url: payload.ones_base_url.trim(),
+      updated_at: Date.now(),
+    }
+
+    try {
+      await installationSecretEntity.set(installationId, row)
+      return { ok: true }
+    } catch (error) {
+      console.error('install-callback: failed to save shared_secret', error)
+      return { ok: false, error: 'failed to save install callback data' }
+    }
+  }
+
+  onApplicationShutdown(signal?: string) {
+    console.log('shutdown signal:', signal)
+  }
+}

package/template/example/backend/dto/issue-created-event.dto.ts

@@ -0,0 +1,29 @@
+export interface IssueCreatedEvent {
+  eventID: string
+  eventType: 'ones:project:issue:created'
+  timestamp: number
+  subscriberID: string
+  eventData: {
+    organizationID?: string
+    teamID?: string
+    triggerUserID?: string
+    issueID: string
+    statusID: string
+    scopeID: string
+    basicInfoChanges: {
+      creator: { fromID: string; toID: string }
+      assignee: { fromID: string; toID: string }
+      createTime: { fromTime: number; toTime: number }
+    }
+    properties?: Record<
+      string,
+      {
+        issueID: string
+        fieldID: string
+        propertyType: number
+        oldValue?: { stringValue?: string }
+        newValue?: { stringValue?: string }
+      }
+    >
+  }
+}

package/template/example/backend/dto/recent-work-item.dto.ts

@@ -0,0 +1,11 @@
+export type RecentLimit = 5 | 10 | 30
+
+export interface RecentWorkItem {
+  workItemId: string
+  title: string
+  createdAt: number
+}
+
+export interface GetRecentWorkItemsQuery {
+  limit: RecentLimit
+}

package/template/example/backend/main.ts

@@ -0,0 +1,10 @@
+import { NestFactory } from '@nestjs/core'
+import { AppModule } from './app.module'
+import { getHostedPort } from './utils'
+
+async function bootstrap() {
+  const app = await NestFactory.create(AppModule)
+  app.enableShutdownHooks()
+  await app.listen(getHostedPort())
+}
+bootstrap().catch(console.error)

package/template/example/backend/proxy.ts

@@ -0,0 +1,46 @@
+import { Readable } from 'stream'
+import { isProd, getWebDevPort } from './utils'
+import type { NextFunction, Request, Response } from 'express'
+
+export function WebProxyMiddleware(req: Request, res: Response, next: NextFunction) {
+  if (isProd()) {
+    return next()
+  }
+
+  const { originalUrl, method } = req
+  if (originalUrl.startsWith('/web/pages') && method === 'GET') {
+    const url = originalUrl.replace('/web/pages', `http://localhost:${getWebDevPort()}`)
+    const headers: Record<string, string> = {}
+    for (const [key, value] of Object.entries(req.headers)) {
+      if (key === 'host' || key === 'connection') {
+        continue
+      }
+      if (value !== undefined) {
+        headers[key] = Array.isArray(value) ? value.join(', ') : String(value)
+      }
+    }
+    fetch(url, {
+      method: 'GET',
+      headers,
+    })
+      .then((response) => {
+        res.status(response.status)
+        response.headers.forEach((value, key) => {
+          res.setHeader(key, value)
+        })
+        if (response.body == null) {
+          res.end()
+          return
+        }
+        const nodeReadable = Readable.fromWeb(response.body as any)
+        nodeReadable.pipe(res)
+        nodeReadable.on('error', (err) => next(err))
+      })
+      .catch((error) => {
+        next(error)
+      })
+    return
+  }
+
+  return next()
+}