github
/
halo-admin
mirror of https://github.com/halo-dev/halo-admin
1
0
Fork 0
Code Issues Releases Wiki Activity

feat: create labels and annotations enumeration types 

Signed-off-by: Ryan Wang <i@ryanc.cc>
pull/590/head
Ryan Wang 2022-07-20 22:47:10 +08:00
parent e64c7e6baa
commit 99c6caa788
10 changed files with 106 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/constants/annotations.ts Normal file
View File

@ -0,0 +1,12 @@
// plugin
export enum pluginAnnotations {
DISPLAY_NAME = "plugin.halo.run/display-name",
}
// rbac
export enum rbacAnnotations {
MODULE = "rbac.authorization.halo.run/module",
ROLE_NAMES = "rbac.authorization.halo.run/role-names",
DISPLAY_NAME = "rbac.authorization.halo.run/display-name",
DEPENDENCIES = "rbac.authorization.halo.run/dependencies",
}

9
src/constants/labels.ts Normal file
View File

@ -0,0 +1,9 @@
// plugin
export enum pluginLabels {
NAME = "plugin.halo.run/plugin-name",
}
// role
export enum roleLabels {
TEMPLATE = "halo.run/role-template",
}

18
src/modules/interface/themes/ThemeDetail.vue
View File

@ -354,16 +354,18 @@ onMounted(handleFetchThemes);
</div> </div>
</div> </div>
<div v-if="themeActiveId === 'settings'"> <div v-if="themeActiveId === 'settings'" class="p-4 sm:px-6">
<FormKit id="theme-setting-form" :actions="false" type="form"> <div class="w-1/3">
<FormKit label="侧边栏宽度" type="text"></FormKit> <FormKit id="theme-setting-form" :actions="false" type="form">
<FormKit label="侧边栏背景图" type="text"></FormKit> <FormKit label="侧边栏宽度" type="text"></FormKit>
<FormKit label="右上角图标" type="text"></FormKit> <FormKit label="侧边栏背景图" type="text"></FormKit>
<FormKit label="文章代码高亮语言" type="text"></FormKit> <FormKit label="右上角图标" type="text"></FormKit>
</FormKit> <FormKit label="文章代码高亮语言" type="text"></FormKit>
</FormKit>
</div>
<div class="pt-5"> <div class="pt-5">
<div class="flex justify-start p-4"> <div class="flex justify-start">
<VButton type="secondary"> 保存</VButton> <VButton type="secondary"> 保存</VButton>
</div> </div>
</div> </div>

21
src/modules/system/plugins/PluginDetail.vue
View File

@ -12,14 +12,16 @@ import { useRoute } from "vue-router";
import { computed, onMounted, ref } from "vue"; import { computed, onMounted, ref } from "vue";
import { apiClient } from "@halo-dev/admin-shared"; import { apiClient } from "@halo-dev/admin-shared";
import type { import type {
Plugin,
ConfigMap, ConfigMap,
Plugin,
Role,
Setting, Setting,
SettingSpec, SettingSpec,
Role,
} from "@halo-dev/api-client"; } from "@halo-dev/api-client";
import cloneDeep from "lodash.clonedeep"; import cloneDeep from "lodash.clonedeep";
import type { FormKitSchemaCondition, FormKitSchemaNode } from "@formkit/core"; import type { FormKitSchemaCondition, FormKitSchemaNode } from "@formkit/core";
import { pluginLabels } from "@/constants/labels";
import { rbacAnnotations } from "@/constants/annotations";
interface FormKitSettingSpec extends Omit<SettingSpec, "formSchema"> { interface FormKitSettingSpec extends Omit<SettingSpec, "formSchema"> {
formSchema: FormKitSchemaCondition | FormKitSchemaNode[]; formSchema: FormKitSchemaCondition | FormKitSchemaNode[];
@ -195,8 +197,7 @@ const handleFetchRoles = async () => {
const pluginRoleTemplates = computed(() => { const pluginRoleTemplates = computed(() => {
return roles.value.filter((item) => { return roles.value.filter((item) => {
return ( return (
item.metadata.labels?.["plugin.halo.run/plugin-name"] === item.metadata.labels?.[pluginLabels.NAME] === plugin.value.metadata.name
plugin.value.metadata.name
); );
}); });
}); });
@ -206,15 +207,13 @@ const pluginRoleTemplateGroups = computed<RoleTemplateGroup[]>(() => {
pluginRoleTemplates.value.forEach((role) => { pluginRoleTemplates.value.forEach((role) => {
const group = groups.find( const group = groups.find(
(group) => (group) =>
group.module === group.module === role.metadata.annotations?.[rbacAnnotations.MODULE]
role.metadata.annotations?.["rbac.authorization.halo.run/module"]
); );
if (group) { if (group) {
group.roles.push(role); group.roles.push(role);
} else { } else {
groups.push({ groups.push({
module: module: role.metadata.annotations?.[rbacAnnotations.MODULE],
role.metadata.annotations?.["rbac.authorization.halo.run/module"],
roles: [role], roles: [role],
}); });
} }
@ -370,14 +369,14 @@ onMounted(() => {
<span class="font-medium text-gray-900"> <span class="font-medium text-gray-900">
{{ {{
role.metadata.annotations?.[ role.metadata.annotations?.[
"rbac.authorization.halo.run/display-name" rbacAnnotations.DISPLAY_NAME
] ]
}} }}
</span> </span>
<span <span
v-if=" v-if="
role.metadata.annotations?.[ role.metadata.annotations?.[
'rbac.authorization.halo.run/dependencies' rbacAnnotations.DEPENDENCIES
] ]
" "
class="text-xs text-gray-400" class="text-xs text-gray-400"
@ -386,7 +385,7 @@ onMounted(() => {
{{ {{
JSON.parse( JSON.parse(
role.metadata.annotations?.[ role.metadata.annotations?.[
"rbac.authorization.halo.run/dependencies" rbacAnnotations.DEPENDENCIES
] ]
).join(", ") ).join(", ")
}} }}

59
src/modules/system/roles/RoleDetail.vue
View File

@ -13,6 +13,8 @@ import { useRoute, useRouter } from "vue-router";
import { computed, onMounted, ref } from "vue"; import { computed, onMounted, ref } from "vue";
import { apiClient } from "@halo-dev/admin-shared"; import { apiClient } from "@halo-dev/admin-shared";
import type { Role, User } from "@halo-dev/api-client"; import type { Role, User } from "@halo-dev/api-client";
import { pluginLabels, roleLabels } from "@/constants/labels";
import { rbacAnnotations } from "@/constants/annotations";
interface RoleTemplateGroup { interface RoleTemplateGroup {
module: string | null | undefined; module: string | null | undefined;
@ -38,8 +40,8 @@ const formState = ref<FormState>({
name: "", name: "",
labels: {}, labels: {},
annotations: { annotations: {
"rbac.authorization.halo.run/dependencies": "", [rbacAnnotations.DEPENDENCIES]: "",
"rbac.authorization.halo.run/display-name": "", [rbacAnnotations.DISPLAY_NAME]: "",
}, },
}, },
rules: [], rules: [],
@ -51,7 +53,7 @@ const formState = ref<FormState>({
const roleTemplates = computed<Role[]>(() => { const roleTemplates = computed<Role[]>(() => {
return roles.value.filter( return roles.value.filter(
(role) => (role) =>
role.metadata.labels?.["halo.run/role-template"] === "true" && role.metadata.labels?.[roleLabels.TEMPLATE] === "true" &&
role.metadata.labels?.["halo.run/hidden"] !== "true" role.metadata.labels?.["halo.run/hidden"] !== "true"
); );
}); });
@ -61,15 +63,13 @@ const roleTemplateGroups = computed<RoleTemplateGroup[]>(() => {
roleTemplates.value.forEach((role) => { roleTemplates.value.forEach((role) => {
const group = groups.find( const group = groups.find(
(group) => (group) =>
group.module === group.module === role.metadata.annotations?.[rbacAnnotations.MODULE]
role.metadata.annotations?.["rbac.authorization.halo.run/module"]
); );
if (group) { if (group) {
group.roles.push(role); group.roles.push(role);
} else { } else {
groups.push({ groups.push({
module: module: role.metadata.annotations?.[rbacAnnotations.MODULE],
role.metadata.annotations?.["rbac.authorization.halo.run/module"],
roles: [role], roles: [role],
}); });
} }
@ -84,9 +84,7 @@ const handleFetchRole = async () => {
); );
formState.value.role = response.data; formState.value.role = response.data;
formState.value.selectedRoleTemplates = JSON.parse( formState.value.selectedRoleTemplates = JSON.parse(
response.data.metadata.annotations?.[ response.data.metadata.annotations?.[rbacAnnotations.DEPENDENCIES] || "[]"
"rbac.authorization.halo.run/dependencies"
] || "[]"
); );
} catch (error) { } catch (error) {
console.error(error); console.error(error);
@ -115,9 +113,8 @@ const handleUpdateRole = async () => {
try { try {
formState.value.saving = true; formState.value.saving = true;
if (formState.value.role.metadata.annotations) { if (formState.value.role.metadata.annotations) {
formState.value.role.metadata.annotations[ formState.value.role.metadata.annotations[rbacAnnotations.DEPENDENCIES] =
"rbac.authorization.halo.run/dependencies" JSON.stringify(formState.value.selectedRoleTemplates);
] = JSON.stringify(formState.value.selectedRoleTemplates);
} }
await apiClient.extension.role.updatev1alpha1Role( await apiClient.extension.role.updatev1alpha1Role(
route.params.name as string, route.params.name as string,
@ -146,7 +143,7 @@ onMounted(() => {
<template> <template>
<VPageHeader <VPageHeader
:title="`角色：${ :title="`角色：${
formState.role?.metadata?.annotations?.['plugin.halo.run/display-name'] || formState.role?.metadata?.annotations?.[rbacAnnotations.DISPLAY_NAME] ||
formState.role?.metadata?.name formState.role?.metadata?.name
}`" }`"
> >
@ -193,7 +190,7 @@ onMounted(() => {
<dd class="mt-1 text-sm text-gray-900 sm:col-span-2 sm:mt-0"> <dd class="mt-1 text-sm text-gray-900 sm:col-span-2 sm:mt-0">
{{ {{
formState.role?.metadata?.annotations?.[ formState.role?.metadata?.annotations?.[
"plugin.halo.run/display-name" rbacAnnotations.DISPLAY_NAME
] || formState.role?.metadata?.name ] || formState.role?.metadata?.name
}} }}
</dd> </dd>
@ -299,7 +296,31 @@ onMounted(() => {
class="bg-white px-4 py-5 hover:bg-gray-50 sm:grid sm:grid-cols-3 sm:gap-4 sm:px-6" class="bg-white px-4 py-5 hover:bg-gray-50 sm:grid sm:grid-cols-3 sm:gap-4 sm:px-6"
> >
<dt class="text-sm font-medium text-gray-900"> <dt class="text-sm font-medium text-gray-900">
{{ group.module }} <div>
{{ group.module }}
</div>
<div
v-if="
group.roles.length &&
group.roles[0].metadata.labels?.[pluginLabels.NAME]
"
class="mt-3 text-xs text-gray-500"
>
由
<RouterLink
:to="{
name: 'PluginDetail',
params: {
pluginName:
group.roles[0].metadata.labels?.[pluginLabels.NAME],
},
}"
class="hover:text-blue-600"
>
{{ group.roles[0].metadata.labels?.[pluginLabels.NAME] }}
</RouterLink>
插件提供
</div>
</dt> </dt>
<dd class="mt-1 text-sm text-gray-900 sm:col-span-2 sm:mt-0"> <dd class="mt-1 text-sm text-gray-900 sm:col-span-2 sm:mt-0">
<ul class="space-y-2"> <ul class="space-y-2">
@ -317,14 +338,14 @@ onMounted(() => {
<span class="font-medium text-gray-900"> <span class="font-medium text-gray-900">
{{ {{
role.metadata.annotations?.[ role.metadata.annotations?.[
"rbac.authorization.halo.run/display-name" rbacAnnotations.DISPLAY_NAME
] ]
}} }}
</span> </span>
<span <span
v-if=" v-if="
role.metadata.annotations?.[ role.metadata.annotations?.[
'rbac.authorization.halo.run/dependencies' rbacAnnotations.DEPENDENCIES
] ]
" "
class="text-xs text-gray-400" class="text-xs text-gray-400"
@ -333,7 +354,7 @@ onMounted(() => {
{{ {{
JSON.parse( JSON.parse(
role.metadata.annotations?.[ role.metadata.annotations?.[
"rbac.authorization.halo.run/dependencies" rbacAnnotations.DEPENDENCIES
] ]
).join(", ") ).join(", ")
}} }}

6
src/modules/system/roles/RoleList.vue
View File

@ -16,13 +16,15 @@ import { useRouter } from "vue-router";
import { computed, onMounted, ref } from "vue"; import { computed, onMounted, ref } from "vue";
import type { Role } from "@halo-dev/api-client"; import type { Role } from "@halo-dev/api-client";
import { apiClient } from "@halo-dev/admin-shared"; import { apiClient } from "@halo-dev/admin-shared";
import { roleLabels } from "@/constants/labels";
import { pluginAnnotations } from "@/constants/annotations";
const createVisible = ref(false); const createVisible = ref(false);
const roles = ref<Role[]>([]); const roles = ref<Role[]>([]);
const basicRoles = computed(() => { const basicRoles = computed(() => {
return roles.value.filter( return roles.value.filter(
(role) => role.metadata?.labels?.["halo.run/role-template"] !== "true" (role) => role.metadata?.labels?.[roleLabels.TEMPLATE] !== "true"
); );
}); });
@ -179,7 +181,7 @@ onMounted(() => {
<span class="mr-2 truncate text-sm font-medium text-gray-900"> <span class="mr-2 truncate text-sm font-medium text-gray-900">
{{ {{
role.metadata.annotations?.[ role.metadata.annotations?.[
"plugin.halo.run/display-name" pluginAnnotations.DISPLAY_NAME
] || role.metadata.name ] || role.metadata.name
}} }}
</span> </span>

24
src/modules/system/roles/components/RoleCreationModal.vue
View File

@ -3,6 +3,8 @@ import { VButton, VModal, VTabItem, VTabs } from "@halo-dev/components";
import { computed, ref, watch } from "vue"; import { computed, ref, watch } from "vue";
import { apiClient } from "@halo-dev/admin-shared"; import { apiClient } from "@halo-dev/admin-shared";
import type { Role } from "@halo-dev/api-client"; import type { Role } from "@halo-dev/api-client";
import { rbacAnnotations } from "@/constants/annotations";
import { roleLabels } from "@/constants/labels";
interface RoleTemplateGroup { interface RoleTemplateGroup {
module: string | null | undefined; module: string | null | undefined;
@ -34,8 +36,8 @@ const creationFormState = ref<CreationFormState>({
name: "", name: "",
labels: {}, labels: {},
annotations: { annotations: {
"rbac.authorization.halo.run/dependencies": "", [rbacAnnotations.DEPENDENCIES]: "",
"rbac.authorization.halo.run/display-name": "", [rbacAnnotations.DISPLAY_NAME]: "",
}!, }!,
}, },
rules: [], rules: [],
@ -47,7 +49,7 @@ const creationFormState = ref<CreationFormState>({
const roleTemplates = computed<Role[]>(() => { const roleTemplates = computed<Role[]>(() => {
return roles.value.filter( return roles.value.filter(
(role) => (role) =>
role.metadata.labels?.["halo.run/role-template"] === "true" && role.metadata.labels?.[roleLabels.TEMPLATE] === "true" &&
role.metadata.labels?.["halo.run/hidden"] !== "true" role.metadata.labels?.["halo.run/hidden"] !== "true"
); );
}); });
@ -57,15 +59,13 @@ const roleTemplateGroups = computed<RoleTemplateGroup[]>(() => {
roleTemplates.value.forEach((role) => { roleTemplates.value.forEach((role) => {
const group = groups.find( const group = groups.find(
(group) => (group) =>
group.module === group.module === role.metadata.annotations?.[rbacAnnotations.MODULE]
role.metadata.annotations?.["rbac.authorization.halo.run/module"]
); );
if (group) { if (group) {
group.roles.push(role); group.roles.push(role);
} else { } else {
groups.push({ groups.push({
module: module: role.metadata.annotations?.[rbacAnnotations.MODULE],
role.metadata.annotations?.["rbac.authorization.halo.run/module"],
roles: [role], roles: [role],
}); });
} }
@ -87,7 +87,7 @@ const handleCreateRole = async () => {
creationFormState.value.saving = true; creationFormState.value.saving = true;
if (creationFormState.value.role.metadata.annotations) { if (creationFormState.value.role.metadata.annotations) {
creationFormState.value.role.metadata.annotations[ creationFormState.value.role.metadata.annotations[
"rbac.authorization.halo.run/dependencies" rbacAnnotations.DEPENDENCIES
] = JSON.stringify(creationFormState.value.selectedRoleTemplates); ] = JSON.stringify(creationFormState.value.selectedRoleTemplates);
} }
await apiClient.extension.role.createv1alpha1Role( await apiClient.extension.role.createv1alpha1Role(
@ -136,7 +136,7 @@ watch(
<FormKit <FormKit
v-model=" v-model="
creationFormState.role.metadata.annotations[ creationFormState.role.metadata.annotations[
'rbac.authorization.halo.run/display-name' rbacAnnotations.DISPLAY_NAME
] ]
" "
label="名称" label="名称"
@ -178,14 +178,14 @@ watch(
<span class="font-medium text-gray-900"> <span class="font-medium text-gray-900">
{{ {{
role.metadata.annotations?.[ role.metadata.annotations?.[
"rbac.authorization.halo.run/display-name" rbacAnnotations.DISPLAY_NAME
] ]
}} }}
</span> </span>
<span <span
v-if=" v-if="
role.metadata.annotations?.[ role.metadata.annotations?.[
'rbac.authorization.halo.run/dependencies' rbacAnnotations.DEPENDENCIES
] ]
" "
class="text-xs text-gray-400" class="text-xs text-gray-400"
@ -194,7 +194,7 @@ watch(
{{ {{
JSON.parse( JSON.parse(
role.metadata.annotations?.[ role.metadata.annotations?.[
"rbac.authorization.halo.run/dependencies" rbacAnnotations.DEPENDENCIES
] ]
).join(", ") ).join(", ")
}} }}

5
src/modules/system/users/UserDetail.vue
View File

@ -4,14 +4,13 @@ import type { Ref } from "vue";
import { computed, inject } from "vue"; import { computed, inject } from "vue";
import { useRouter } from "vue-router"; import { useRouter } from "vue-router";
import type { User } from "@halo-dev/api-client"; import type { User } from "@halo-dev/api-client";
import { rbacAnnotations } from "@/constants/annotations";
const user = inject<Ref<User>>("user"); const user = inject<Ref<User>>("user");
const roles = computed(() => { const roles = computed(() => {
return JSON.parse( return JSON.parse(
user?.value?.metadata?.annotations?.[ user?.value?.metadata?.annotations?.[rbacAnnotations.ROLE_NAMES] || "[]"
"rbac.authorization.halo.run/role-names"
] || "[]"
); );
}); });

7
src/modules/system/users/UserList.vue
View File

@ -16,8 +16,8 @@ import UserEditingModal from "./components/UserEditingModal.vue";
import UserPasswordChangeModal from "./components/UserPasswordChangeModal.vue"; import UserPasswordChangeModal from "./components/UserPasswordChangeModal.vue";
import { onMounted, ref } from "vue"; import { onMounted, ref } from "vue";
import { apiClient } from "@halo-dev/admin-shared"; import { apiClient } from "@halo-dev/admin-shared";
import type { User } from "@halo-dev/api-client"; import type { User, UserList } from "@halo-dev/api-client";
import type { UserList } from "@halo-dev/api-client"; import { rbacAnnotations } from "@/constants/annotations";
const checkAll = ref(false); const checkAll = ref(false);
const editingModal = ref<boolean>(false); const editingModal = ref<boolean>(false);
@ -72,8 +72,7 @@ const handleOpenPasswordChangeModal = (user: User) => {
const getRoles = (user: User) => { const getRoles = (user: User) => {
return JSON.parse( return JSON.parse(
user.metadata.annotations?.["rbac.authorization.halo.run/role-names"] || user.metadata.annotations?.[rbacAnnotations.ROLE_NAMES] || "[]"
"[]"
); );
}; };

6
src/modules/system/users/components/UserEditingModal.vue
View File

@ -5,6 +5,8 @@ import { apiClient } from "@halo-dev/admin-shared";
import type { Role, User } from "@halo-dev/api-client"; import type { Role, User } from "@halo-dev/api-client";
import { IconSave, VButton, VModal } from "@halo-dev/components"; import { IconSave, VButton, VModal } from "@halo-dev/components";
import { v4 as uuid } from "uuid"; import { v4 as uuid } from "uuid";
import { roleLabels } from "@/constants/labels";
import { rbacAnnotations } from "@/constants/annotations";
const props = defineProps({ const props = defineProps({
visible: { visible: {
@ -57,7 +59,7 @@ const creationModalTitle = computed(() => {
const basicRoles = computed(() => { const basicRoles = computed(() => {
return roles.value.filter( return roles.value.filter(
(role) => role.metadata?.labels?.["halo.run/role-template"] !== "true" (role) => role.metadata?.labels?.[roleLabels.TEMPLATE] !== "true"
); );
}); });
@ -150,7 +152,7 @@ onMounted(handleFetchRoles);
:options=" :options="
basicRoles.map((role:Role) => { basicRoles.map((role:Role) => {
return { return {
label: role.metadata?.annotations?.['plugin.halo.run/display-name'] || role.metadata.name, label: role.metadata?.annotations?.[rbacAnnotations.DISPLAY_NAME] || role.metadata.name,
value: role.metadata?.name, value: role.metadata?.name,
}; };
}) })