coze-studio/frontend/packages/arch/bot-typings/src/common.ts

56 lines
1.5 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/*
* Copyright 2025 coze-dev Authors
*
* 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.
*/
/** bot详情页来源目前只有bot和explore列表 */
export enum BotPageFromEnum {
Bot = 'bot', //bot列表
Explore = 'explore', //explore列表
Store = 'store',
Template = 'template',
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- 不得不 any
export type Obj = Record<string, any>;
/**
* 展示完整类型
*
* @example
* type Intersection = { a: string } & { b: number };
* type Result = Expand<Intersection>;
* // Result: { a: string; b: number }
*/
export type Expand<T extends Obj> = T extends infer U
? { [K in keyof U]: U[K] }
: never;
/**
* 只对特定字段做 required常用于修正服务端类型声明错误
*
* @example
* interface Agent {
* id?: string;
* name?: string;
* desc?: string
* }
* type Result = PartialRequired<Agent, 'id' | 'name'>;
*/
export type PartialRequired<T extends Obj, K extends keyof T> = Expand<
{
[P in K]-?: T[P];
} & Pick<T, Exclude<keyof T, K>>
>;