xydata-tools-uniapp 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,452 @@
+/**
+ * uni-app 专用组件类型定义
+ * @module uniapp
+ */
+
+import { DefineComponent } from "vue";
+
+/**
+ * 媒体文件对象
+ */
+export interface MediaFile {
+  /** 文件名（包含扩展名） */
+  name: string;
+  /** 文件URL（完整访问路径） */
+  url: string;
+  /** 服务器存储的文件名 */
+  fileName?: string;
+  /** 文件大小（字节） */
+  size?: number;
+  /** 文件 MIME 类型，如 'image/jpeg', 'video/mp4' */
+  type?: string;
+  /** 缩略图URL（视频） */
+  thumb?: string;
+}
+
+/**
+ * 上传来源类型
+ */
+export type SourceType = "album" | "camera";
+
+/**
+ * 按钮位置类型
+ */
+export type ButtonPosition = "vertical" | "horizontal";
+
+/**
+ * 对齐方式类型
+ */
+export type AlignType = "left" | "right";
+
+/**
+ * 上传类型
+ */
+export type UploadType = "image" | "video" | "both";
+
+/**
+ * MediaPicker 组件属性
+ */
+export interface MediaPickerProps {
+  // ==================== 通用配置 ====================
+  /**
+   * 上传类型（必填）
+   * @type {'image' | 'video' | 'both'}
+   * @description
+   * - 'image': 仅支持图片上传
+   * - 'video': 仅支持视频上传
+   * - 'both': 同时支持图片和视频上传
+   */
+  uploadType: UploadType;
+
+  /**
+   * 上传地址
+   * @description 如果不传，会自动从 getApp().globalData.uploadUrl 获取
+   */
+  uploadUrl?: string;
+
+  /**
+   * 只读模式
+   * @default false
+   * @description 开启后不显示上传按钮和删除按钮，仅展示媒体列表
+   */
+  readonly?: boolean;
+
+  /**
+   * 上传按钮位置
+   * @type {'vertical' | 'horizontal'}
+   * @default 'vertical'
+   * @description
+   * - 'vertical': 垂直布局，按钮在媒体列表下方
+   * - 'horizontal': 水平布局，按钮和媒体在同一行（仅单一媒体类型时有效）
+   */
+  buttonPosition?: ButtonPosition;
+
+  /**
+   * 媒体列数
+   * @default 3
+   * @description 每行显示的媒体数量，如果设置了 itemWidth 则此项无效
+   */
+  cols?: number;
+
+  /**
+   * 媒体项固定宽度（单位：rpx）
+   * @description 设置后 cols 属性将失效，适用于需要固定媒体项尺寸的场景
+   */
+  itemWidth?: number;
+
+  /**
+   * 媒体项圆角大小（单位：rpx）
+   * @default 8
+   */
+  itemBorderRadius?: number;
+
+  /**
+   * 只读模式下最多显示的媒体数量
+   * @description 超过此数量则显示 +N，点击可查看全部
+   */
+  maxShowCount?: number;
+
+  /**
+   * 对齐方式
+   * @type {'left' | 'right'}
+   * @default 'left'
+   * @description
+   * - 'left': 从左往右排列
+   * - 'right': 从右往左排列
+   * - 仅在 buttonPosition 为 'horizontal' 时有效
+   */
+  align?: AlignType;
+
+  /**
+   * 弹窗标题
+   * @description 查看全部媒体时的弹窗标题文字
+   */
+  popupTitle?: string;
+
+  /**
+   * 是否可以拖拽排序
+   * @default false
+   * @description 仅在编辑模式（非 readonly）下有效
+   */
+  draggable?: boolean;
+
+  /**
+   * 是否展示文件列表
+   * @default false
+   * @description 是否在媒体下方显示文件名列表
+   */
+  showFileList?: boolean;
+
+  // ==================== 图片配置 ====================
+  /**
+   * 图片文件列表
+   * @default []
+   */
+  imageFiles?: MediaFile[];
+
+  /**
+   * 图片最大上传数量限制
+   * @default 9
+   */
+  imageLimit?: number;
+
+  /**
+   * 图片上传按钮图标
+   * @description 图标图片的 URL 地址
+   */
+  imageButtonIcon?: string;
+
+  /**
+   * 图片上传按钮文字
+   * @default '上传图片'
+   */
+  imageButtonTitle?: string;
+
+  /**
+   * 图片选择来源
+   * @type {Array<'album' | 'camera'>}
+   * @default ['album', 'camera']
+   * @description
+   * - 'album': 从相册选择
+   * - 'camera': 使用相机拍摄
+   */
+  imageSourceType?: SourceType[];
+
+  /**
+   * 图片最大大小限制（单位：MB）
+   * @default 10
+   * @description 设置为 0 表示不限制
+   */
+  imageMaxSize?: number;
+
+  // ==================== 视频配置 ====================
+  /**
+   * 视频文件列表
+   * @default []
+   */
+  videoFiles?: MediaFile[];
+
+  /**
+   * 视频最大上传数量限制
+   * @default 1
+   */
+  videoLimit?: number;
+
+  /**
+   * 视频上传按钮图标
+   * @description 图标图片的 URL 地址
+   */
+  videoButtonIcon?: string;
+
+  /**
+   * 视频上传按钮文字
+   * @default '上传视频'
+   */
+  videoButtonTitle?: string;
+
+  /**
+   * 视频选择来源
+   * @type {Array<'album' | 'camera'>}
+   * @default ['album', 'camera']
+   * @description
+   * - 'album': 从相册选择
+   * - 'camera': 使用相机拍摄
+   */
+  videoSourceType?: SourceType[];
+
+  /**
+   * 视频最大时长限制（单位：秒）
+   * @default 60
+   * @description 设置为 0 表示不限制
+   */
+  videoMaxDuration?: number;
+}
+
+/**
+ * 上传进度信息
+ */
+export interface UploadProgress {
+  /** 上传进度百分比（0-100） */
+  progress: number;
+  /** 已上传字节数 */
+  totalBytesSent: number;
+  /** 预期需要上传的数据总长度 */
+  totalBytesExpectedToSend: number;
+  /** 媒体类型 */
+  stage: "image" | "video";
+}
+
+/**
+ * 上传错误信息
+ */
+export interface UploadError {
+  /** 错误消息 */
+  message: string;
+  /** 错误代码 */
+  code?: string | number;
+  /** 媒体类型 */
+  stage?: "image" | "video";
+  /** 原始错误对象 */
+  raw?: any;
+}
+
+/**
+ * 常用文件类型预设
+ */
+export const FileTypePresets = {
+  /** 文档类型 */
+  DOCUMENT: ["doc", "docx", "xls", "xlsx", "ppt", "pptx", "pdf"],
+  /** 压缩包类型 */
+  ARCHIVE: ["zip", "rar", "7z", "tar", "gz"],
+  /** 文本类型 */
+  TEXT: ["txt", "md", "csv", "json", "xml"],
+  /** 所有常用类型 */
+  ALL: [
+    "doc",
+    "docx",
+    "xls",
+    "xlsx",
+    "ppt",
+    "pptx",
+    "pdf",
+    "txt",
+    "zip",
+    "rar",
+  ],
+} as const;
+
+/**
+ * FilePicker 组件属性
+ */
+export interface FilePickerProps {
+  /**
+   * 上传地址
+   * @description 如果不传，会自动从 getApp().globalData.uploadUrl 获取
+   */
+  uploadUrl?: string;
+
+  /**
+   * 只读模式
+   * @default false
+   * @description 开启后不显示上传按钮和删除按钮，仅展示文件列表
+   */
+  readonly?: boolean;
+
+  /**
+   * 文件列表
+   * @default []
+   */
+  files?: MediaFile[];
+
+  /**
+   * 最大上传数量
+   * @default 10
+   */
+  limit?: number;
+
+  /**
+   * 允许的文件扩展名
+   * @default ['doc', 'xls', 'ppt', 'pdf', 'docx', 'xlsx', 'pptx']
+   * @description
+   * 可以使用 FileTypePresets 中的预设值，例如：
+   * - FileTypePresets.DOCUMENT（文档类型）
+   * - FileTypePresets.ARCHIVE（压缩包类型）
+   * @example
+   * accept={['pdf', 'doc', 'docx']}
+   */
+  accept?: string[];
+
+  /**
+   * 文件大小限制（单位：MB）
+   * @default 20
+   * @description 设置为 0 表示不限制
+   */
+  maxSize?: number;
+
+  /**
+   * 上传按钮文字
+   * @default '上传附件'
+   * @description 自定义上传按钮显示的文字
+   */
+  buttonTitle?: string;
+}
+
+/**
+ * MediaPicker 组件实例方法
+ */
+export interface MediaPickerMethods {
+  /**
+   * 获取图片列表
+   * @returns {MediaFile[]} 图片文件列表
+   */
+  getImageList(): MediaFile[];
+
+  /**
+   * 获取视频列表
+   * @returns {MediaFile[]} 视频文件列表
+   */
+  getVideoList(): MediaFile[];
+
+  /**
+   * 获取图片参数（不包含 url 字段）
+   * @returns {string} JSON 字符串
+   */
+  getImageParams(): string;
+
+  /**
+   * 获取视频参数（不包含 url 字段）
+   * @returns {string} JSON 字符串
+   */
+  getVideoParams(): string;
+}
+
+/**
+ * FilePicker 组件实例方法
+ */
+export interface FilePickerMethods {
+  /**
+   * 获取文件列表
+   * @returns {MediaFile[]} 文件列表
+   */
+  getFileList(): MediaFile[];
+
+  /**
+   * 获取参数（不包含 url 字段）
+   * @returns {string} JSON 字符串
+   */
+  getParams(): string;
+}
+
+/**
+ * MediaPicker - uni-app 媒体（图片/视频）选择上传组件
+ * @example
+ * ```vue
+ * <template>
+ *   <MediaPicker
+ *     ref="mediaPicker"
+ *     uploadType="image"
+ *     :imageFiles="imageList"
+ *     :imageLimit="9"
+ *     @image-change="handleImageChange"
+ *   />
+ * </template>
+ *
+ * <script setup lang="ts">
+ * import { ref } from 'vue'
+ * import { MediaPicker, type MediaFile } from 'xydata-tools/uniapp'
+ *
+ * const mediaPicker = ref<InstanceType<typeof MediaPicker>>()
+ * const imageList = ref<MediaFile[]>([])
+ *
+ * const handleImageChange = (files: MediaFile[]) => {
+ *   imageList.value = files
+ * }
+ *
+ * // 获取图片列表
+ * const getImages = () => {
+ *   return mediaPicker.value?.getImageList()
+ * }
+ * </script>
+ * ```
+ */
+export declare const MediaPicker: DefineComponent<
+  MediaPickerProps,
+  MediaPickerMethods
+>;
+
+/**
+ * FilePicker - uni-app 文件选择上传组件
+ * @example
+ * ```vue
+ * <template>
+ *   <FilePicker
+ *     ref="filePicker"
+ *     :files="fileList"
+ *     :limit="5"
+ *     :accept="['pdf', 'doc', 'docx']"
+ *     @change="handleFileChange"
+ *   />
+ * </template>
+ *
+ * <script setup lang="ts">
+ * import { ref } from 'vue'
+ * import { FilePicker, type MediaFile } from 'xydata-tools/uniapp'
+ *
+ * const filePicker = ref<InstanceType<typeof FilePicker>>()
+ * const fileList = ref<MediaFile[]>([])
+ *
+ * const handleFileChange = (files: MediaFile[]) => {
+ *   fileList.value = files
+ * }
+ *
+ * // 获取文件列表
+ * const getFiles = () => {
+ *   return filePicker.value?.getFileList()
+ * }
+ * </script>
+ * ```
+ */
+export declare const FilePicker: DefineComponent<
+  FilePickerProps,
+  FilePickerMethods
+>;

package/dist/index.js

@@ -0,0 +1,9 @@
+/**
+ * PicPicker - uni-app 图片选择上传组件
+ */
+export { default as MediaPicker } from "./components/uni-app/media-picker/media-picker.vue";
+
+/**
+ * FilePicker - uni-app 文件选择上传组件
+ */
+export { default as FilePicker } from "./components/uni-app/file-picker/file-picker.vue";

package/dist/shims-vue.d.ts

@@ -0,0 +1,8 @@
+/**
+ * .vue 单文件组件模块声明，供 tsc 生成类型声明时解析 .vue 导入
+ */
+declare module '*.vue' {
+  import { DefineComponent } from 'vue';
+  const component: DefineComponent<{}, {}, any>;
+  export default component;
+}

package/dist/types/components/uni-app/watermark/index.d.ts

@@ -0,0 +1,2 @@
+export function resolveWatermarkError(error: any, context: any): Promise<any>;
+export function applyImageWatermarkToPath(path: any, watermark: any, options?: {}): Promise<any>;

package/dist/types/utils/watermark-shared.d.ts

@@ -0,0 +1,42 @@
+export namespace DEFAULT_WATERMARK {
+    let enabled: boolean;
+    let margin: number;
+    let items: any[];
+}
+export namespace DEFAULT_WATERMARK_ITEM {
+    let type: string;
+    let position: string;
+    let mode: any;
+    let fontSize: number;
+    let fontScale: any;
+    let minFontSize: any;
+    let maxFontSize: any;
+    let spacing: any;
+    let width: any;
+    let height: any;
+    let aspectRatio: any;
+    let lockAspectRatio: boolean;
+    let color: string;
+    let strokeColor: string;
+    let strokeWidth: number;
+    let fontFamily: string;
+    let opacity: number;
+    let rotate: number;
+}
+export const IMAGE_EXTENSIONS: string[];
+export function getFileExtension(file: any): any;
+export function isImageFile(file: any): any;
+export function normalizeWatermarkConfig(watermark: any): any;
+export function parseInsetCoordinate(value: any, base: any, scale?: number, isAdaptive?: boolean): number;
+export function isFullscreenWatermarkItem(item: any): boolean;
+export function isImageWatermarkItem(item: any): boolean;
+export function resolveSpacing(canvas: any, item: any): number;
+export function resolveTextPosition(canvas: any, item: any, margin: any): any;
+export function resolveImageSize(canvas: any, item: any, image: any): {
+    width: number;
+    height: number;
+};
+export function resolveBoxPosition(canvas: any, item: any, margin: any, boxWidth: any, boxHeight: any): any;
+export function clampNumber(value: any, min: any, max: any): any;
+export function resolveFontSize(canvas: any, item: any): any;
+export function resolveStrokeWidth(item: any, fontSize: any): number;