create-halo-plugin-template 1.0.0 → 1.0.1

package/ui/src/api/generated/configuration.ts

@@ -0,0 +1,110 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Halo
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.23.2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export interface ConfigurationParameters {
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    basePath?: string;
+    serverIndex?: number;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+
+export class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     * @memberof Configuration
+     */
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     * @memberof Configuration
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * override base path
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    basePath?: string;
+    /**
+     * override server index
+     *
+     * @type {number}
+     * @memberof Configuration
+     */
+    serverIndex?: number;
+    /**
+     * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+
+    constructor(param: ConfigurationParameters = {}) {
+        this.apiKey = param.apiKey;
+        this.username = param.username;
+        this.password = param.password;
+        this.accessToken = param.accessToken;
+        this.basePath = param.basePath;
+        this.serverIndex = param.serverIndex;
+        this.baseOptions = param.baseOptions;
+        this.formDataCtor = param.formDataCtor;
+    }
+
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    public isJsonMime(mime: string): boolean {
+        const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
+        return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
+    }
+}

package/ui/src/api/generated/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'

package/ui/src/api/generated/index.ts

@@ -0,0 +1,18 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Halo
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.23.2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export * from "./api";
+export * from "./configuration";
+export * from "./models";

package/ui/src/api/generated/models/add-operation.ts

@@ -0,0 +1,49 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Halo
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.23.2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface AddOperation
+ */
+export interface AddOperation {
+    /**
+     * 
+     * @type {string}
+     * @memberof AddOperation
+     */
+    'op': AddOperationOpEnum;
+    /**
+     * A JSON Pointer path pointing to the location to move/copy from.
+     * @type {string}
+     * @memberof AddOperation
+     */
+    'path': string;
+    /**
+     * Value can be any JSON value
+     * @type {any}
+     * @memberof AddOperation
+     */
+    'value': any;
+}
+
+export const AddOperationOpEnum = {
+    Add: 'add'
+} as const;
+
+export type AddOperationOpEnum = typeof AddOperationOpEnum[keyof typeof AddOperationOpEnum];
+
+

package/ui/src/api/generated/models/copy-operation.ts

@@ -0,0 +1,49 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Halo
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.23.2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface CopyOperation
+ */
+export interface CopyOperation {
+    /**
+     * A JSON Pointer path pointing to the location to move/copy from.
+     * @type {string}
+     * @memberof CopyOperation
+     */
+    'from': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CopyOperation
+     */
+    'op': CopyOperationOpEnum;
+    /**
+     * A JSON Pointer path pointing to the location to move/copy from.
+     * @type {string}
+     * @memberof CopyOperation
+     */
+    'path': string;
+}
+
+export const CopyOperationOpEnum = {
+    Copy: 'copy'
+} as const;
+
+export type CopyOperationOpEnum = typeof CopyOperationOpEnum[keyof typeof CopyOperationOpEnum];
+
+

package/ui/src/api/generated/models/index.ts

@@ -0,0 +1,11 @@
+export * from './add-operation';
+export * from './copy-operation';
+export * from './json-patch-inner';
+export * from './move-operation';
+export * from './plugin-template-checklist-item';
+export * from './plugin-template-feature-item';
+export * from './plugin-template-overview';
+export * from './plugin-template-stat-item';
+export * from './remove-operation';
+export * from './replace-operation';
+export * from './test-operation';

package/ui/src/api/generated/models/json-patch-inner.ts

@@ -0,0 +1,41 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Halo
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.23.2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { AddOperation } from './add-operation';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { CopyOperation } from './copy-operation';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { MoveOperation } from './move-operation';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { RemoveOperation } from './remove-operation';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ReplaceOperation } from './replace-operation';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { TestOperation } from './test-operation';
+
+/**
+ * @type JsonPatchInner
+ * @export
+ */
+export type JsonPatchInner = AddOperation | CopyOperation | MoveOperation | RemoveOperation | ReplaceOperation | TestOperation;
+
+

package/ui/src/api/generated/models/move-operation.ts

@@ -0,0 +1,49 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Halo
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.23.2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface MoveOperation
+ */
+export interface MoveOperation {
+    /**
+     * A JSON Pointer path pointing to the location to move/copy from.
+     * @type {string}
+     * @memberof MoveOperation
+     */
+    'from': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof MoveOperation
+     */
+    'op': MoveOperationOpEnum;
+    /**
+     * A JSON Pointer path pointing to the location to move/copy from.
+     * @type {string}
+     * @memberof MoveOperation
+     */
+    'path': string;
+}
+
+export const MoveOperationOpEnum = {
+    Move: 'move'
+} as const;
+
+export type MoveOperationOpEnum = typeof MoveOperationOpEnum[keyof typeof MoveOperationOpEnum];
+
+

package/ui/src/api/generated/models/plugin-template-checklist-item.ts

@@ -0,0 +1,54 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Halo
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.23.2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 模板初始化检查项
+ * @export
+ * @interface PluginTemplateChecklistItem
+ */
+export interface PluginTemplateChecklistItem {
+    /**
+     * 受众
+     * @type {string}
+     * @memberof PluginTemplateChecklistItem
+     */
+    'audience'?: string;
+    /**
+     * 说明
+     * @type {string}
+     * @memberof PluginTemplateChecklistItem
+     */
+    'description'?: string;
+    /**
+     * 检查项键
+     * @type {string}
+     * @memberof PluginTemplateChecklistItem
+     */
+    'key'?: string;
+    /**
+     * 状态
+     * @type {string}
+     * @memberof PluginTemplateChecklistItem
+     */
+    'status'?: string;
+    /**
+     * 标题
+     * @type {string}
+     * @memberof PluginTemplateChecklistItem
+     */
+    'title'?: string;
+}
+

package/ui/src/api/generated/models/plugin-template-feature-item.ts

@@ -0,0 +1,54 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Halo
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.23.2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 模板功能项
+ * @export
+ * @interface PluginTemplateFeatureItem
+ */
+export interface PluginTemplateFeatureItem {
+    /**
+     * 区域
+     * @type {string}
+     * @memberof PluginTemplateFeatureItem
+     */
+    'area'?: string;
+    /**
+     * 说明
+     * @type {string}
+     * @memberof PluginTemplateFeatureItem
+     */
+    'description'?: string;
+    /**
+     * 是否默认启用
+     * @type {boolean}
+     * @memberof PluginTemplateFeatureItem
+     */
+    'enabled'?: boolean;
+    /**
+     * 功能键
+     * @type {string}
+     * @memberof PluginTemplateFeatureItem
+     */
+    'key'?: string;
+    /**
+     * 标题
+     * @type {string}
+     * @memberof PluginTemplateFeatureItem
+     */
+    'title'?: string;
+}
+

package/ui/src/api/generated/models/plugin-template-overview.ts

@@ -0,0 +1,147 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Halo
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.23.2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { PluginTemplateChecklistItem } from './plugin-template-checklist-item';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { PluginTemplateFeatureItem } from './plugin-template-feature-item';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { PluginTemplateStatItem } from './plugin-template-stat-item';
+
+/**
+ * 模板概览信息
+ * @export
+ * @interface PluginTemplateOverview
+ */
+export interface PluginTemplateOverview {
+    /**
+     * 主色
+     * @type {string}
+     * @memberof PluginTemplateOverview
+     */
+    'accentColor'?: string;
+    /**
+     * 当前视角
+     * @type {string}
+     * @memberof PluginTemplateOverview
+     */
+    'audience'?: string;
+    /**
+     * 视角标签
+     * @type {string}
+     * @memberof PluginTemplateOverview
+     */
+    'audienceLabel'?: string;
+    /**
+     * 初始化清单
+     * @type {Array<PluginTemplateChecklistItem>}
+     * @memberof PluginTemplateOverview
+     */
+    'checklist'?: Array<PluginTemplateChecklistItem>;
+    /**
+     * ConfigMap 名称
+     * @type {string}
+     * @memberof PluginTemplateOverview
+     */
+    'configMapName'?: string;
+    /**
+     * Console 路由
+     * @type {string}
+     * @memberof PluginTemplateOverview
+     */
+    'consolePath'?: string;
+    /**
+     * 页面密度
+     * @type {string}
+     * @memberof PluginTemplateOverview
+     */
+    'density'?: string;
+    /**
+     * 显示名
+     * @type {string}
+     * @memberof PluginTemplateOverview
+     */
+    'displayName'?: string;
+    /**
+     * 是否启用附件扩展标签页
+     * @type {boolean}
+     * @memberof PluginTemplateOverview
+     */
+    'enableAttachmentProvider'?: boolean;
+    /**
+     * 是否启用 Console 页面
+     * @type {boolean}
+     * @memberof PluginTemplateOverview
+     */
+    'enableConsoleDashboard'?: boolean;
+    /**
+     * 是否启用 UC 页面
+     * @type {boolean}
+     * @memberof PluginTemplateOverview
+     */
+    'enableUcDashboard'?: boolean;
+    /**
+     * 功能矩阵
+     * @type {Array<PluginTemplateFeatureItem>}
+     * @memberof PluginTemplateOverview
+     */
+    'features'?: Array<PluginTemplateFeatureItem>;
+    /**
+     * 生成时间
+     * @type {string}
+     * @memberof PluginTemplateOverview
+     */
+    'generatedAt'?: string;
+    /**
+     * 生成客户端输出目录
+     * @type {string}
+     * @memberof PluginTemplateOverview
+     */
+    'generatedClientPath'?: string;
+    /**
+     * 插件名
+     * @type {string}
+     * @memberof PluginTemplateOverview
+     */
+    'pluginName'?: string;
+    /**
+     * Setting 名称
+     * @type {string}
+     * @memberof PluginTemplateOverview
+     */
+    'settingName'?: string;
+    /**
+     * 统计信息
+     * @type {Array<PluginTemplateStatItem>}
+     * @memberof PluginTemplateOverview
+     */
+    'stats'?: Array<PluginTemplateStatItem>;
+    /**
+     * 支持文档链接
+     * @type {string}
+     * @memberof PluginTemplateOverview
+     */
+    'supportLink'?: string;
+    /**
+     * UC 路由
+     * @type {string}
+     * @memberof PluginTemplateOverview
+     */
+    'ucPath'?: string;
+}
+

package/ui/src/api/generated/models/plugin-template-stat-item.ts

@@ -0,0 +1,54 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Halo
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.23.2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 模板统计卡片
+ * @export
+ * @interface PluginTemplateStatItem
+ */
+export interface PluginTemplateStatItem {
+    /**
+     * 提示
+     * @type {string}
+     * @memberof PluginTemplateStatItem
+     */
+    'helper'?: string;
+    /**
+     * 统计项键
+     * @type {string}
+     * @memberof PluginTemplateStatItem
+     */
+    'key'?: string;
+    /**
+     * 标题
+     * @type {string}
+     * @memberof PluginTemplateStatItem
+     */
+    'label'?: string;
+    /**
+     * 视觉语义
+     * @type {string}
+     * @memberof PluginTemplateStatItem
+     */
+    'tone'?: string;
+    /**
+     * 值
+     * @type {string}
+     * @memberof PluginTemplateStatItem
+     */
+    'value'?: string;
+}
+