@ones-open/cli 0.0.8

package/template/legacy/backend/src/index.ts

@@ -0,0 +1,139 @@
+import { Logger } from '@ones-op/node-logger'
+import { env } from '@ones-op/sdk/backend'
+import type { PluginRequest, PluginResponse } from '@ones-op/node-types'
+
+// Method called when the team level plugin is being installed.
+export async function Install() {
+  Logger.info('[Plugin] Install')
+}
+
+// Method called when the team level plugin is being launched.
+export async function Enable() {
+  Logger.info('[Plugin] Enable')
+}
+
+// Method called when the team level plugin is being suspended.
+export function Disable() {
+  Logger.info('[Plugin] Disable')
+}
+
+// Method called when the team level plugin is being uninstalled.
+export function UnInstall() {
+  Logger.info('[Plugin] UnInstall')
+}
+
+// Method called when the team level plugin is being upgraded.
+export function Upgrade(oldPluginInfo: any) {
+  const oldVersion = oldPluginInfo.version
+  Logger.info('[Plugin] Upgrade', 'old version:', oldVersion)
+}
+
+/*
+    Method called when the organization level plugin is being installed.
+
+    Request parameter description:
+    request:
+      request.parsedHeaders state multi-language, for example,when the request user context is chinese,
+      the parameter will be {"Accept-Language":["zh"]}, there are other cases like {"Accept-Language":["en"]},
+      {"Accept-Language":["ja"]}.
+    teamUUIDList:
+      The uuid list with the team which installed by this time.
+    firstInstall:
+      True if plugin has never been installed.
+ */
+export async function OrgInstall(
+  request: PluginRequest,
+  teamUUIDList: string[],
+  firstInstall: boolean,
+) {
+  Logger.info('[Plugin] OrgInstall')
+}
+
+/*
+    Method called when the organization level plugin is being launched.
+
+    Request parameters description:
+    request:
+      request.parsedHeaders state multi-language, for example,when the request user context is chinese,
+      the parameter will be {"Accept-Language":["zh"]}, there are other cases like {"Accept-Language":["en"]},
+      {"Accept-Language":["ja"]}.
+    teamUUIDList:
+      The uuid list with the team which launched by this time.
+
+    Response parameters description:
+      Return the failed team uuid list.
+ */
+export function OrgEnable(
+  request: PluginRequest,
+  teamUUIDList: string[],
+): void | string[] | Promise<string[]> {
+  Logger.info('[Plugin] OrgEnable')
+  return []
+}
+
+/*
+    Method called when the organization level plugin is being suspended.
+
+    Request parameters description:
+    request:
+      request.parsedHeaders state multi-language, for example,when the request user context is chinese,
+      the parameter will be {"Accept-Language":["zh"]}, there are other cases like {"Accept-Language":["en"]},
+      {"Accept-Language":["ja"]}.
+    teamUUIDList:
+      The uuid list with the team which suspended by this time.
+
+    Response parameters description:
+      Return the failed team uuid list.
+ */
+export function OrgDisable(
+  request: PluginRequest,
+  teamUUIDList: string[],
+): void | string[] | Promise<string[]> {
+  Logger.info('[Plugin] OrgDisable')
+  return []
+}
+
+/*
+    Method called when the organization level plugin is being uninstalled.
+
+    Request parameters description:
+    request:
+      request.parsedHeaders state multi-language, for example,when the request user context is chinese,
+      the parameter will be {"Accept-Language":["zh"]}, there are other cases like {"Accept-Language":["en"]},
+      {"Accept-Language":["ja"]}.
+    teamUUIDList:
+      The uuid list with the team which uninstalled by this time.
+ */
+export function OrgUnInstall(request: PluginRequest, teamUUIDList: string[]) {
+  Logger.info('[Plugin] OrgUnInstall')
+}
+
+/*
+    Method called when the organization level plugin is being upgraded.
+
+    Request parameters description:
+    request:
+      request.parsedHeaders state multi-language, for example,when the request user context is chinese,
+      the parameter will be {"Accept-Language":["zh"]}, there are other cases like {"Accept-Language":["en"]},
+      {"Accept-Language":["ja"]}.
+    teamUUIDList:
+      The uuid list with the team which upgraded by this time.
+ */
+export function OrgUpgrade(oldPluginInfo: any, request: PluginRequest, teamUUIDList: string[]) {
+  const oldVersion = oldPluginInfo.version
+  Logger.info('[Plugin] OrgUpgrade', 'old version:', oldVersion)
+}
+
+// example function
+export async function hello(request: PluginRequest): Promise<PluginResponse> {
+  const body = request.body || {}
+  Logger.info('[Plugin] hello ======= 请求成功')
+  return {
+    body: {
+      res: 'hello world',
+      orgId: await env.getOrgId(),
+      teamID: await env.getTeamID(),
+      requestBody: body,
+    },
+  }
+}

package/template/legacy/backend/src/ones.d.ts

@@ -0,0 +1,6 @@
+/* eslint-disable no-var */
+/**
+ * @see https://developer.ones.cn/docs/guide/advanced/storage
+ * @summary ones.d.ts is generated by `op format` cli commands.
+ * DO NOT MODIFY MANUALLY
+ */

package/template/legacy/config/ci-deploy.yaml

@@ -0,0 +1,11 @@
+# Configuration example:
+
+# default:
+#   host: ''
+#   username: ''
+#   password: ''
+#   ones-check-id: ''
+#   ones-check-point: ''
+#   ones-plugin-id: ''
+#   organization_uuid: ''
+#   team_uuid: ''

package/template/legacy/config/local.yaml

@@ -0,0 +1,30 @@
+platform:
+  address: ''
+  baseURL: ''
+  username: ''
+plugin:
+  app_id: ''
+  scope: 0
+local:
+  id: '4085451291'
+  language: nodejs
+  debug_mode: false
+  timeout_sec: 30
+  organization_uuid: ''
+  team_uuid: ''
+  web_service_port: '3000'
+  web_service_ip: 127.0.0.1
+  server_port: 3001
+  user_uuid: ''
+  log_in_local: false
+  log_level: info
+  file_in_local: false
+  mysql_in_local: false
+  mysql_user_name: ''
+  mysql_user_password: ''
+  mysql_database_name: ''
+  mysql_host: ''
+  mysql_port: ''
+  instance_uuid: ''
+  dangerously_accept_unauthorized_https: false
+  host_dist_tag: ''

package/template/legacy/config/plugin.yaml

@@ -0,0 +1,25 @@
+service:
+  app_id: plugin
+  name: plugin
+  version: 1.0.0
+  description: plugin
+  mode: org
+  logo: null
+  language: nodejs
+  language_version: 16.13.0
+  host_version: 1.0.4
+  host_sub_version: 1.0.0
+  min_system_version: 3.5.0
+  auth: null
+  config: null
+  scope: 1
+  policy:
+    policy: simple
+    target: ''
+apis:
+  - type: addition
+    methods:
+      - POST
+    url: /hello
+    function: hello
+modules: []

package/template/legacy/config/upgrade.yaml

@@ -0,0 +1,8 @@
+#Indicates the processing rules for plugin workspace file conflicts. Enumeration value [save_new, save_old]:
+#   save_old, save the old file when the old file conflicts with the new file；
+#   save_new，which contrary to the save_old.
+workspace:
+  rule: save_new
+  #Array of regular expressions, expressing files that are not in default rules.
+  exclude:
+#  - example.txt

package/template/legacy/op.config.mjs

@@ -0,0 +1,4 @@
+/** @type { import("@ones-op/rc-cli").OpConfigSchema } */
+export default {
+  scan: {},
+};