create-halo-plugin-template 1.0.0 → 1.0.2

package/ui/src/api/__tests__/normalizers.spec.ts

@@ -0,0 +1,65 @@
+import { describe, expect, it } from 'vitest'
+import { normalizeOverview, type RawTemplateOverview } from '@/api/normalizers'
+
+describe('normalizeOverview', () => {
+  it('fills defaults for sparse backend payloads', () => {
+    const normalized = normalizeOverview({} as RawTemplateOverview)
+
+    expect(normalized.pluginName).toBe('halo-plugin-template')
+    expect(normalized.consolePath).toBe('/halo-plugin-template')
+    expect(normalized.enableConsoleDashboard).toBe(true)
+    expect(normalized.enableUcDashboard).toBe(true)
+    expect(normalized.enableAttachmentProvider).toBe(true)
+    expect(normalized.accentColor).toBe('#2457F5')
+    expect(normalized.density).toBe('balanced')
+    expect(normalized.stats).toEqual([])
+    expect(normalized.features).toEqual([])
+    expect(normalized.checklist).toEqual([])
+  })
+
+  it('normalizes nested collections into stable UI models', () => {
+    const normalized = normalizeOverview({
+      pluginName: 'hello-world',
+      displayName: 'Hello World',
+      audience: 'uc',
+      audienceLabel: 'User Center',
+      consolePath: '/hello-world',
+      ucPath: '/hello-world',
+      settingName: 'hello-world-settings',
+      configMapName: 'hello-world-configmap',
+      generatedClientPath: 'ui/src/api/generated',
+      generatedAt: '2026-04-07T12:00:00Z',
+      enableConsoleDashboard: false,
+      enableUcDashboard: true,
+      enableAttachmentProvider: false,
+      accentColor: '#102030',
+      density: 'compact',
+      supportLink: 'https://example.com/help',
+      stats: [{ label: 'Routes', value: '2' }],
+      features: [{ title: 'UC 页面', enabled: false }],
+      checklist: [{ title: '生成 API', status: 'done' }],
+    } as RawTemplateOverview)
+
+    expect(normalized.pluginName).toBe('hello-world')
+    expect(normalized.enableConsoleDashboard).toBe(false)
+    expect(normalized.enableAttachmentProvider).toBe(false)
+    expect(normalized.stats[0]).toMatchObject({
+      key: 'stat-0',
+      label: 'Routes',
+      value: '2',
+      tone: 'info',
+    })
+    expect(normalized.features[0]).toMatchObject({
+      key: 'feature-0',
+      title: 'UC 页面',
+      area: 'General',
+      enabled: false,
+    })
+    expect(normalized.checklist[0]).toMatchObject({
+      key: 'checklist-0',
+      title: '生成 API',
+      audience: 'all',
+      status: 'done',
+    })
+  })
+})

package/ui/src/api/generated/.openapi-generator/FILES

@@ -0,0 +1,23 @@
+.gitignore
+.npmignore
+.openapi-generator-ignore
+api.ts
+api/plugin-template-console-api.ts
+api/plugin-template-uc-api.ts
+base.ts
+common.ts
+configuration.ts
+git_push.sh
+index.ts
+models/add-operation.ts
+models/copy-operation.ts
+models/index.ts
+models/json-patch-inner.ts
+models/move-operation.ts
+models/plugin-template-checklist-item.ts
+models/plugin-template-feature-item.ts
+models/plugin-template-overview.ts
+models/plugin-template-stat-item.ts
+models/remove-operation.ts
+models/replace-operation.ts
+models/test-operation.ts

package/ui/src/api/generated/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.7.0

package/ui/src/api/generated/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

package/ui/src/api/generated/api/plugin-template-console-api.ts

@@ -0,0 +1,128 @@
+/* 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.
+ */
+
+
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
+// @ts-ignore
+import type { PluginTemplateOverview } from '../models';
+/**
+ * PluginTemplateConsoleApi - axios parameter creator
+ * @export
+ */
+export const PluginTemplateConsoleApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * 获取模板在 Console 中的默认能力概览
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        pluginTemplateOverviewForConsole: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/apis/console.halo-plugin-template.halo.run/v1alpha1/template-overview/summary`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication basicAuth required
+            // http basic authentication required
+            setBasicAuthToObject(localVarRequestOptions, configuration)
+
+            // authentication bearerAuth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * PluginTemplateConsoleApi - functional programming interface
+ * @export
+ */
+export const PluginTemplateConsoleApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = PluginTemplateConsoleApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * 获取模板在 Console 中的默认能力概览
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async pluginTemplateOverviewForConsole(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PluginTemplateOverview>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.pluginTemplateOverviewForConsole(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['PluginTemplateConsoleApi.pluginTemplateOverviewForConsole']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * PluginTemplateConsoleApi - factory interface
+ * @export
+ */
+export const PluginTemplateConsoleApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = PluginTemplateConsoleApiFp(configuration)
+    return {
+        /**
+         * 获取模板在 Console 中的默认能力概览
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        pluginTemplateOverviewForConsole(options?: RawAxiosRequestConfig): AxiosPromise<PluginTemplateOverview> {
+            return localVarFp.pluginTemplateOverviewForConsole(options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * PluginTemplateConsoleApi - object-oriented interface
+ * @export
+ * @class PluginTemplateConsoleApi
+ * @extends {BaseAPI}
+ */
+export class PluginTemplateConsoleApi extends BaseAPI {
+    /**
+     * 获取模板在 Console 中的默认能力概览
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PluginTemplateConsoleApi
+     */
+    public pluginTemplateOverviewForConsole(options?: RawAxiosRequestConfig) {
+        return PluginTemplateConsoleApiFp(this.configuration).pluginTemplateOverviewForConsole(options).then((request) => request(this.axios, this.basePath));
+    }
+}
+

package/ui/src/api/generated/api/plugin-template-uc-api.ts

@@ -0,0 +1,128 @@
+/* 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.
+ */
+
+
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
+// @ts-ignore
+import type { PluginTemplateOverview } from '../models';
+/**
+ * PluginTemplateUcApi - axios parameter creator
+ * @export
+ */
+export const PluginTemplateUcApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * 获取模板在 UC 中的默认能力概览
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        pluginTemplateOverviewForUc: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/apis/uc.halo-plugin-template.halo.run/v1alpha1/template-overview/summary`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication basicAuth required
+            // http basic authentication required
+            setBasicAuthToObject(localVarRequestOptions, configuration)
+
+            // authentication bearerAuth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * PluginTemplateUcApi - functional programming interface
+ * @export
+ */
+export const PluginTemplateUcApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = PluginTemplateUcApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * 获取模板在 UC 中的默认能力概览
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async pluginTemplateOverviewForUc(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PluginTemplateOverview>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.pluginTemplateOverviewForUc(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['PluginTemplateUcApi.pluginTemplateOverviewForUc']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * PluginTemplateUcApi - factory interface
+ * @export
+ */
+export const PluginTemplateUcApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = PluginTemplateUcApiFp(configuration)
+    return {
+        /**
+         * 获取模板在 UC 中的默认能力概览
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        pluginTemplateOverviewForUc(options?: RawAxiosRequestConfig): AxiosPromise<PluginTemplateOverview> {
+            return localVarFp.pluginTemplateOverviewForUc(options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * PluginTemplateUcApi - object-oriented interface
+ * @export
+ * @class PluginTemplateUcApi
+ * @extends {BaseAPI}
+ */
+export class PluginTemplateUcApi extends BaseAPI {
+    /**
+     * 获取模板在 UC 中的默认能力概览
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PluginTemplateUcApi
+     */
+    public pluginTemplateOverviewForUc(options?: RawAxiosRequestConfig) {
+        return PluginTemplateUcApiFp(this.configuration).pluginTemplateOverviewForUc(options).then((request) => request(this.axios, this.basePath));
+    }
+}
+

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

@@ -0,0 +1,19 @@
+/* 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/plugin-template-console-api';
+export * from './api/plugin-template-uc-api';
+

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

@@ -0,0 +1,86 @@
+/* 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.
+ */
+
+
+import type { Configuration } from './configuration';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+
+export const BASE_PATH = "http://localhost:46375".replace(/\/+$/, "");
+
+/**
+ *
+ * @export
+ */
+export const COLLECTION_FORMATS = {
+    csv: ",",
+    ssv: " ",
+    tsv: "\t",
+    pipes: "|",
+};
+
+/**
+ *
+ * @export
+ * @interface RequestArgs
+ */
+export interface RequestArgs {
+    url: string;
+    options: RawAxiosRequestConfig;
+}
+
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
+export class BaseAPI {
+    protected configuration: Configuration | undefined;
+
+    constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
+        if (configuration) {
+            this.configuration = configuration;
+            this.basePath = configuration.basePath ?? basePath;
+        }
+    }
+};
+
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
+export class RequiredError extends Error {
+    constructor(public field: string, msg?: string) {
+        super(msg);
+        this.name = "RequiredError"
+    }
+}
+
+interface ServerMap {
+    [key: string]: {
+        url: string,
+        description: string,
+    }[];
+}
+
+/**
+ *
+ * @export
+ */
+export const operationServerMap: ServerMap = {
+}

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

@@ -0,0 +1,150 @@
+/* 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.
+ */
+
+
+import type { Configuration } from "./configuration";
+import type { RequestArgs } from "./base";
+import type { AxiosInstance, AxiosResponse } from 'axios';
+import { RequiredError } from "./base";
+
+/**
+ *
+ * @export
+ */
+export const DUMMY_BASE_URL = 'https://example.com'
+
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) {
+    if (paramValue === null || paramValue === undefined) {
+        throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
+    if (configuration && configuration.apiKey) {
+        const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+            ? await configuration.apiKey(keyParamName)
+            : await configuration.apiKey;
+        object[keyParamName] = localVarApiKeyValue;
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setBasicAuthToObject = function (object: any, configuration?: Configuration) {
+    if (configuration && (configuration.username || configuration.password)) {
+        object["auth"] = { username: configuration.username, password: configuration.password };
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) {
+    if (configuration && configuration.accessToken) {
+        const accessToken = typeof configuration.accessToken === 'function'
+            ? await configuration.accessToken()
+            : await configuration.accessToken;
+        object["Authorization"] = "Bearer " + accessToken;
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) {
+    if (configuration && configuration.accessToken) {
+        const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+            ? await configuration.accessToken(name, scopes)
+            : await configuration.accessToken;
+        object["Authorization"] = "Bearer " + localVarAccessTokenValue;
+    }
+}
+
+function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void {
+    if (parameter == null) return;
+    if (typeof parameter === "object") {
+        if (Array.isArray(parameter)) {
+            (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
+        } 
+        else {
+            Object.keys(parameter).forEach(currentKey => 
+                setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`)
+            );
+        }
+    } 
+    else {
+        if (urlSearchParams.has(key)) {
+            urlSearchParams.append(key, parameter);
+        } 
+        else {
+            urlSearchParams.set(key, parameter);
+        }
+    }
+}
+
+/**
+ *
+ * @export
+ */
+export const setSearchParams = function (url: URL, ...objects: any[]) {
+    const searchParams = new URLSearchParams(url.search);
+    setFlattenedQueryParams(searchParams, objects);
+    url.search = searchParams.toString();
+}
+
+/**
+ *
+ * @export
+ */
+export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) {
+    const nonString = typeof value !== 'string';
+    const needsSerialization = nonString && configuration && configuration.isJsonMime
+        ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
+        : nonString;
+    return needsSerialization
+        ? JSON.stringify(value !== undefined ? value : {})
+        : (value || "");
+}
+
+/**
+ *
+ * @export
+ */
+export const toPathString = function (url: URL) {
+    return url.pathname + url.search + url.hash
+}
+
+/**
+ *
+ * @export
+ */
+export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
+    return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
+        const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url};
+        return axios.request<T, R>(axiosRequestArgs);
+    };
+}