@xiaou66/picture-types 0.0.1

package/dist/Common.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 通用类型定义
+ */
+/**
+ * 平台类型
+ */
+export type Platform = 'macOS' | 'linux' | 'win32';

package/dist/File.d.ts

@@ -0,0 +1,82 @@
+export type FileUpdateDataType = 'file' | 'filePath' | 'base64';
+export interface FileUploadItem {
+    dataType: FileUpdateDataType;
+    content: File | string;
+}
+export interface FileUpdateInfoItem {
+    id: string;
+    /**
+     * 文件路径
+     */
+    filePath: string;
+    /**
+     * 放 base64 的
+     */
+    content?: string;
+    /**
+     * 文件名称
+     */
+    fileName: string;
+    /**
+     * 文件后缀
+     */
+    fileSuffix: string;
+    /**
+     * 是否临时文件, 即 base64 文件
+     */
+    tempFile?: boolean;
+    /**
+     * 文件大小
+     */
+    fileSize: number;
+    /**
+     * 场景名称
+     */
+    sceneName?: string;
+    /**
+     * 上传方式
+     */
+    uploadWay: string | string[];
+    /**
+     * 上传状态
+     */
+    uploadStatus: 'waiting' | 'uploading' | 'failed';
+    /**
+     * 进度
+     */
+    progress?: number;
+}
+/**
+ * 文件库信息
+ */
+export interface FileLibraryInfo {
+    /**
+     * 文件名称
+     */
+    fileName: string;
+    /**
+     * 文件后缀
+     */
+    fileSuffix: string;
+    /**
+     * 文件大小
+     */
+    fileSize: number;
+}
+/**
+ * 文件上传信息
+ */
+export interface FileUploadInfo {
+    /**
+     * 存储源 id
+     */
+    storageId: string;
+    /**
+     * URL
+     */
+    url: string;
+    /**
+     * 额外数据
+     */
+    extra: any;
+}

package/dist/Flow.d.ts

@@ -0,0 +1,98 @@
+import { AsyncComponentLoader } from 'vue';
+import { PlugInfo } from './Plugin';
+import { FileUpdateInfoItem } from './File';
+import { FileLibraryItem, SceneInfoItem } from './Store';
+/**
+ * 流程节点
+ */
+export interface IFlowNode<T = any> {
+    id: string;
+    nodeCode: string;
+    nodeData: T | Record<string, any>;
+}
+/**
+ * 流程项
+ */
+export interface IFlowItem {
+    id: string;
+    nodeList: IFlowNode[];
+    createAt: number;
+    updateAt: number;
+}
+/**
+ * 保存流程项
+ */
+export type SaveFlowItem = Omit<IFlowItem, 'createAt' | 'updateAt' | 'id' | 'sort'> & {
+    id?: string;
+    createAt?: number;
+    updateAt?: number;
+};
+/**
+ * 流程节点信息
+ */
+export interface IFlowNodeInfo {
+    code: string;
+    title: string;
+    group: '触发' | '通用' | '完成';
+    nodeType: 'trigger' | 'common';
+    end?: boolean;
+    desc?: string;
+}
+/**
+ * 流程节点配置
+ */
+export interface IFlowNodeConfig {
+    info: IFlowNodeInfo;
+    nodeComponent: AsyncComponentLoader;
+}
+/**
+ * 流程提供者
+ */
+export interface FlowProvide {
+    removeNode: (id: string) => void;
+    updateNodeField: (id: string, field: string, value: any) => void;
+    updateNode: (id: string, nodeData: Record<string, any>) => void;
+    createNode: (node: IFlowNodeConfig) => void;
+}
+/**
+ * 流程节点插件信息
+ */
+export interface FlowNodePlugInfo extends PlugInfo {
+    /**
+     * 插件分组
+     */
+    pluginGroup: 'image' | 'music' | 'video' | 'other' | 'trigger' | 'common' | 'finish';
+}
+/**
+ * 流程节点插件
+ */
+export interface FlowNodePlugIn {
+    /**
+     * 无需配置可以直接使用
+     */
+    noConfig?: boolean;
+    pluginInfo: FlowNodePlugInfo;
+    /**
+     * 自定义配置 UI
+     */
+    uiConfigComponent?: AsyncComponentLoader;
+}
+/**
+ * 流程上下文
+ */
+export interface IFlowContext {
+    uploadFile: FileUpdateInfoItem;
+    fileLibrary: FileLibraryItem;
+    sceneInfo: SceneInfoItem;
+    context?: Record<string, any>;
+}
+/**
+ * 流程节点动作
+ */
+export interface IFlowNodeActions<T> {
+    code: string;
+    execute?: (flow: IFlowItem, flowData: IFlowNode<T>, data: IFlowContext) => Promise<void>;
+    onSaveData?: (flow: IFlowItem, flowData: IFlowNode<T>) => void;
+    onDestroy?: (flow: IFlowItem, flowData: IFlowNode<T>) => void;
+    adjustData?: (flow: IFlowItem, flowData: IFlowNode<T>) => Promise<boolean>;
+}

package/dist/Plugin.d.ts

@@ -0,0 +1,54 @@
+/**
+ * 插件核心类型定义
+ */
+/**
+ * 插件类型
+ */
+export type PluginType = 'storage' | 'flowNode';
+/**
+ * 插件信息
+ */
+export interface PlugInfo {
+    /**
+     * 插件 code 全局唯一
+     */
+    pluginCode: string;
+    /**
+     * 插件名称
+     */
+    pluginName: string;
+    /**
+     * 插件版本
+     */
+    pluginVersion: string;
+    /**
+     * 插件作者
+     */
+    pluginAuthor: string;
+    /**
+     * 插件描述
+     */
+    pluginDesc: string;
+    /**
+     * 插件类型
+     */
+    pluginType: PluginType;
+    /**
+     * 插件 logo
+     */
+    pluginLogo: string;
+    /**
+     * 插件分组
+     */
+    pluginGroup: string;
+}
+/**
+ * 插件配置
+ */
+export interface PlugInConfig<T extends PlugInfo = PlugInfo> {
+    /**
+     * 无需配置可以直接使用
+     */
+    noConfig?: boolean;
+    pluginInfo: T;
+}

package/dist/Storage.d.ts

@@ -0,0 +1,128 @@
+import { AsyncComponentLoader, AsyncComponentOptions } from 'vue';
+import { PlugInfo, PlugInConfig } from './Plugin';
+/**
+ * 上传文件结果
+ */
+export interface IUploadFileResult<E = any> {
+    /**
+     * 上传后文件访问地址
+     */
+    url: string;
+    /**
+     * 缩略图地址
+     */
+    thumbnailUrl?: string;
+    /**
+     * 额外数据
+     */
+    extra?: E;
+}
+/**
+ * 上传文件参数
+ */
+export interface IUploadFileParams {
+    /**
+     * 上传 id
+     */
+    readonly id: string;
+    /**
+     * 配置 id
+     */
+    readonly storageId: string;
+    /**
+     * 配置名称
+     */
+    readonly sceneName: string;
+    /**
+     * 文件路径
+     */
+    readonly filePath: string;
+    /**
+     * 全文件名称
+     */
+    readonly allFileName: string;
+    /**
+     * 文件名称
+     */
+    readonly fileName: string;
+    /**
+     * 文件后缀
+     */
+    readonly suffix: string;
+    /**
+     * 文件大小
+     */
+    readonly fileSize: number;
+    /**
+     * 文件
+     */
+    readonly file?: File;
+}
+/**
+ * 删除文件参数
+ */
+export interface IDeleteFileParams<E = any> {
+    storageId: string;
+    /**
+     * 额外数据
+     */
+    extra?: E;
+}
+/**
+ * 上传文件选项
+ */
+export interface UploadFileOptions {
+    onProgress?: (progress: number) => void;
+}
+/**
+ * 存储 UI 表单元素
+ */
+export interface StorageUIFormElement {
+    type: 'input' | 'input-format' | 'radio-group' | 'switch' | 'input-button' | 'select' | 'custom';
+    customComponent?: AsyncComponentLoader | AsyncComponentOptions;
+    formItem: {
+        rules?: Record<string, any>;
+        field: string;
+        label: string;
+        [key: string]: any;
+    };
+    /**
+     * 元素属性值
+     */
+    elementProperty: Record<string, any>;
+    /**
+     * 元素事件
+     */
+    elementEvent?: Record<string, any>;
+}
+/**
+ * 存储 UI 配置
+ */
+export interface StorageUIConfig {
+    /**
+     * 提示
+     */
+    tips: string;
+    /**
+     * 表单
+     */
+    forms: StorageUIFormElement[];
+}
+/**
+ * 存储插件信息
+ */
+export interface StoragePlugInfo extends PlugInfo {
+    /**
+     * 插件分组
+     */
+    pluginGroup: 'cloudVendor' | 'self' | 'other';
+}
+/**
+ * 存储插件配置
+ */
+export interface StoragePlugInConfig extends PlugInConfig<StoragePlugInfo> {
+    /**
+     * 配置 ui
+     */
+    uiConfig?: StorageUIConfig;
+}

package/dist/Store.d.ts

@@ -0,0 +1,104 @@
+import { FileLibraryInfo, FileUploadInfo } from './File';
+/**
+ * 文件盒子目录
+ */
+export interface FileBoxCatalog {
+    total: number;
+    docIds: string[];
+}
+/**
+ * 文件盒子信息项
+ */
+export interface FileBoxInfoItem {
+    id: string;
+    /**
+     * 文件盒子名称
+     */
+    fileBoxName: string;
+}
+/**
+ * 场景信息项
+ */
+export interface SceneInfoItem {
+    id: string;
+    /**
+     * 场景名称
+     */
+    sceneName: string;
+    /**
+     * 是否启用
+     */
+    enable: boolean;
+}
+/**
+ * 场景详情项
+ */
+export interface SceneDetailItem {
+    id: string;
+    /**
+     * 收集盒子
+     */
+    fileBoxId: string;
+    /**
+     * 存储源
+     */
+    storageSourceIds: string[];
+}
+/**
+ * 存储源项
+ */
+export interface StorageSourceItem {
+    id: string;
+    storageName: string;
+    /**
+     * 存储插件 code
+     */
+    storagePluginCode: string;
+}
+/**
+ * 文件库项
+ */
+export interface FileLibraryItem {
+    /**
+     * id
+     */
+    id: string;
+    /**
+     * 分组 id
+     */
+    fileBoxId: string;
+    /**
+     * 文件保存实际的 docId
+     */
+    fileFileBoxDocId?: string;
+    /**
+     * 场景 id
+     */
+    sceneId: string;
+    /**
+     * 上传文件信息
+     */
+    fileUploadInfoList: FileUploadInfo[];
+    /**
+     * 文件信息
+     */
+    fileInfo: FileLibraryInfo;
+    /**
+     * 标签分组 id
+     */
+    tags?: string[];
+    /**
+     * 创建时间
+     */
+    createTime: number;
+}
+/**
+ * URL 格式化数据
+ */
+export interface IFormatUrlData {
+    id: string;
+    displayName: string;
+    format: string;
+    enable: boolean;
+    disableDelete?: boolean;
+}

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 类型定义包入口
+ */
+export * from './File';
+export * from './Common';
+export * from './Store';
+export * from './Plugin';
+export * from './Storage';
+export * from './Flow';

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@xiaou66/picture-types",
+  "version": "0.0.1",
+  "description": "Picture bed plugin system",
+  "main": "./dist/index.cjs.js",
+  "module": "./dist/index.es.js",
+  "types": "./dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "vite build",
+    "dev": "vite",
+    "prepare": "npm run build",
+    "publish": "npm publish"
+  },
+  "author": "xiaou",
+  "license": "ISC",
+  "devDependencies": {
+    "typescript": "^5.0.0",
+    "vite": "npm:rolldown-vite@^7.2.11",
+    "vite-plugin-dts": "^4.5.0",
+    "vue": "^3.5.18"
+  },
+  "peerDependencies": {
+    "vue": "^3.0.0"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.es.js",
+      "require": "./dist/index.cjs.js"
+    }
+  }
+}