@lobehub/market-types 1.0.0

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@lobehub/market-types",
+  "version": "1.0.0",
+  "license": "MIT",
+  "sideEffects": false,
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "scripts": {
+    "build": "tsup",
+    "clean": "rimraf .turbo node_modules dist",
+    "dev": "tsup --watch",
+    "format": "prettier --check . --ignore-path ../../.gitignore",
+    "lint": "eslint \"**/*.ts*\"",
+    "prepublishOnly": "npm run build",
+    "release": "npm publish",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "zod": "^3.22.4"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.24",
+    "eslint": "^8.57.0",
+    "prettier": "^3.2.5",
+    "rimraf": "^5.0.5",
+    "tsup": "^8.5.0",
+    "typescript": "^5.3.3"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  }
+}

package/src/agent/index.ts

@@ -0,0 +1,8 @@
+import { MarketItemBase } from '../market';
+
+/**
+ * Agent 类型资源项的定义 (继承基础结构)
+ */
+export interface AgentItem extends MarketItemBase {
+  // Agent 特有的字段可以加在这里
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './plugin';
+export * from './market';

package/src/market.ts

@@ -0,0 +1,29 @@
+/**
+ * 市场列表中单个资源项的基础结构
+ */
+export interface MarketItemBase {
+  /** 全局唯一标识符, 通常包含作者/命名空间和名称 */
+  identifier: string;
+  /** 在市场列表中显示的名称 (已本地化) */
+  name: string;
+  /** 在市场列表中显示的简短描述 (已本地化) */
+  description: string;
+  /** 指向该资源详细 Manifest 文件的 URL */
+  manifestUrl: string;
+  /** 作者或组织名称 */
+  author?: string;
+  /** 资源在市场中创建的日期 (ISO 8601) */
+  createdAt: string;
+  /** 资源在市场中最后更新的日期 (ISO 8601) */
+  updatedAt: string;
+  /** 资源的主页或文档链接 */
+  homepage?: string;
+  /** 图标 URL 或 Emoji */
+  icon?: string;
+  /** 标签列表 (已本地化) */
+  tags?: string[];
+  /** 分类名称 */
+  category?: string;
+  /** 可选：兼容性信息 */
+  compatibility?: Record<string, any>;
+}

package/src/plugin/admin.ts

@@ -0,0 +1,10 @@
+// 管理端插件项 Schema
+import { z } from 'zod';
+
+import { BasePluginItemSchema } from './plugin';
+
+export const AdminPluginItemSchema = BasePluginItemSchema.extend({
+  status: z.enum(['published', 'unpublished', 'archived', 'deprecated'] as const),
+  visibility: z.enum(['public', 'private', 'internal'] as const),
+});
+export type AdminPluginItem = z.infer<typeof AdminPluginItemSchema>;

package/src/plugin/capabilities.ts

@@ -0,0 +1,46 @@
+
+// 插件能力定义
+import { z } from 'zod';
+
+export const PluginCapabilitiesSchema = z.object({
+  tools: z.boolean().default(false),
+  prompts: z.boolean().default(false),
+  resources: z.boolean().default(false),
+});
+
+/**
+ * 工具项定义
+ */
+export interface PluginTool {
+  name: string;
+  description?: string;
+  inputSchema?: Record<string, any>;
+}
+
+/**
+ * 资源项定义
+ */
+export interface PluginResource {
+  uri: string;
+  name?: string;
+  mimeType?: string;
+}
+
+/**
+ * 提示词参数定义
+ */
+export interface PromptArgument {
+  name: string;
+  required?: boolean;
+  description?: string;
+  type?: string;
+}
+
+/**
+ * 提示词项定义
+ */
+export interface PluginPrompt {
+  name: string;
+  description: string;
+  arguments?: PromptArgument[];
+}

package/src/plugin/deploymentOption.ts

@@ -0,0 +1,63 @@
+import { z } from 'zod';
+
+/**
+ * 连接类型
+ */
+export const ConnectionTypeEnum = z.enum(['http', 'stdio']);
+export type ConnectionType = z.infer<typeof ConnectionTypeEnum>;
+
+/**
+ * MCP安装方法
+ */
+export const InstallationMethodEnum = z.enum([
+  'npm',
+  'go',
+  'python',
+  'docker',
+  'git',
+  'binaryUrl',
+  'manual',
+  'none',
+]);
+export type InstallationMethod = z.infer<typeof InstallationMethodEnum>;
+
+/**
+ * 系统依赖项
+ */
+export interface SystemDependency {
+  name: string;
+  type?: string;
+  requiredVersion?: string;
+  checkCommand?: string;
+  installInstructions?: Record<string, string>;
+  versionParsingRequired?: boolean;
+  description?: string;
+}
+
+/**
+ * MCP连接配置
+ */
+export interface ConnectionConfig {
+  type: ConnectionType;
+  command?: string;
+  args?: string[];
+  url?: string;
+}
+
+export interface InstallationDetails {
+  packageName?: string;
+  repositoryUrlToClone?: string;
+  setupSteps?: string[];
+}
+
+/**
+ * MCP部署选项
+ */
+export interface DeploymentOption {
+  installationMethod: string;
+  installationDetails?: InstallationDetails;
+  connection: ConnectionConfig;
+  isRecommended?: boolean;
+  description?: string;
+  systemDependencies?: SystemDependency[];
+}

package/src/plugin/index.ts

@@ -0,0 +1,4 @@
+export * from './plugin';
+export * from './admin';
+export * from './deploymentOption';
+export * from './capabilities';

package/src/plugin/plugin.ts

@@ -0,0 +1,104 @@
+import { z } from 'zod';
+
+import { MarketItemBase } from '../market';
+import {
+  PluginCapabilitiesSchema,
+  PluginPrompt,
+  PluginResource,
+  PluginTool,
+  PromptArgument,
+} from './capabilities';
+import { DeploymentOption } from './deploymentOption';
+
+/**
+ * 兼容性信息
+ */
+export interface PluginCompatibility {
+  platforms?: string[];
+  minAppVersion?: string;
+  maxAppVersion?: string;
+}
+
+// 基础插件项 Schema
+export const BasePluginItemSchema = z.object({
+  identifier: z.string(),
+  name: z.string(),
+  description: z.string(),
+  manifestUrl: z.string(),
+  author: z.string().optional(),
+  createdAt: z.string(),
+  updatedAt: z.string(),
+  homepage: z.string().optional(),
+  icon: z.string().optional(),
+  tags: z.array(z.string()).optional(),
+  category: z.string().optional(),
+  capabilities: PluginCapabilitiesSchema,
+  toolsCount: z.number().optional(),
+  promptsCount: z.number().optional(),
+  resourcesCount: z.number().optional(),
+  isValidated: z.boolean().default(false),
+  installCount: z.number().default(0),
+  ratingAverage: z.number().optional(),
+  ratingCount: z.number().default(0),
+  commentCount: z.number().default(0),
+  isFeatured: z.boolean().default(false),
+});
+
+/**
+ * Plugin (MCP Server) 类型资源项的定义 (继承基础结构)
+ * 注: 这个定义会与现有的 PluginItem 结构进行整合
+ */
+export interface MarketPluginItem extends MarketItemBase {
+  // 能力信息
+  capabilities?: {
+    tools: boolean;
+    prompts: boolean;
+    resources: boolean;
+  };
+  // 数量统计
+  toolsCount?: number;
+  promptsCount?: number;
+  resourcesCount?: number;
+  // 验证状态
+  isValidated?: boolean;
+  // 统计信息
+  installCount?: number;
+  ratingAverage?: number;
+  ratingCount?: number;
+  commentCount?: number;
+}
+
+// 导出类型
+export type BasePluginItem = z.infer<typeof BasePluginItemSchema>;
+
+// 插件清单
+export interface PluginManifest {
+  id: string;
+  name: string;
+  version: string;
+  description: string;
+  category?: string;
+  tags?: string[];
+  author?: {
+    name: string;
+    url?: string;
+  };
+  homepage?: string;
+  icon?: string;
+  capabilities?: {
+    tools?: boolean;
+    prompts?: boolean;
+    resources?: boolean;
+  };
+  deploymentOptions?: DeploymentOption[];
+  compatibility?: PluginCompatibility;
+  // 工具定义
+  tools?: PluginTool[];
+  // 资源定义
+  resources?: PluginResource[];
+  // 提示词定义
+  prompts?: PluginPrompt[];
+  // 验证信息
+  isValidated?: boolean;
+  validatedAt?: string;
+}

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "es2018",
+    "module": "esnext",
+    "moduleResolution": "node",
+    "declaration": true,
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["src/*"]
+    }
+  },
+  "exclude": ["node_modules", "dist"],
+  "include": ["src"]
+}

package/tsup.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from 'tsup';
+
+export default defineConfig({
+  entry: ['src/index.ts'],
+  format: ['esm'],
+  dts: true,
+  splitting: false,
+  sourcemap: true,
+  clean: true,
+});