@visactor/vseed 0.0.3 → 0.0.4

package/dist/types/chartType/table/table.d.ts

@@ -1,4 +1,4 @@
-import type { Dataset, Dimensions, Measures } from 'src/types';
+import type { BackgroundColor, Dataset, Dimensions, Measures, Theme } from '../..';
 /**
  * 表格类型定义
  * @description 表格，适用于详细数据展示场景，行列分明，便于查看具体数值
@@ -34,12 +34,27 @@ export interface Table {
      * @type {Dimensions}
      * @example [{id: "name", alias: "名称"}]
      */
-    dimensions: Dimensions;
+    dimensions?: Dimensions;
     /**
      * 指标
      * @description 表格的每个指标会对应一行, 并且天生支持指标组合.
      * @type {Measures}
      * @example [{id: "value", alias: "数值"}]
      */
-    measures: Measures;
+    measures?: Measures;
+    /**
+     * 图表的背景颜色
+     * @default transparent 默认为透明背景
+     * @description 背景颜色可以是颜色字符串, 例如'red', 'blue', 也可以是hex, rgb或rgba'#ff0000', 'rgba(255,0,0,0.5)'
+     */
+    backgroundColor?: BackgroundColor;
+    /**
+     * 图表的主题, 主题是优先级较低的功能配置, 包含所有图表类型共用的通用配置, 与单类图表类型共用的图表配置
+     * @default light 默认为亮色主题
+     * @description 内置light与dark两种主题, 用户可以通过Builder自定义主题
+     * @example 'dark'
+     * @example 'light'
+     * @example 'customThemeName'
+     */
+    theme?: Theme;
 }

package/dist/types/index.d.ts

@@ -2,3 +2,5 @@ export * from './properties';
 export type * from './pipeline';
 export type * from './chartType';
 export type * from './builder';
+export type * from './vseed';
+export type * from './advancedVSeed';

package/dist/types/pipeline/advancedVSeed/advancedVSeed.d.ts

@@ -1,7 +1,10 @@
-import type { AdvancedVSeed, VSeed } from '../../properties';
+import type { AdvancedVSeed } from '../../advancedVSeed';
+import type { VSeed } from '../../chartType';
+import type { CustomTheme } from '../../properties';
 import type { Pipe } from '../pipeline';
 export type AdvancedPipelineContext = {
     vseed: VSeed;
+    customTheme?: CustomTheme;
 };
 export type AdvancedPipe = Pipe<AdvancedVSeed, AdvancedPipelineContext>;
 export type AdvancedPipeline = Pipe<AdvancedVSeed, AdvancedPipelineContext>[];

package/dist/types/pipeline/spec/spec.d.ts

@@ -1,6 +1,7 @@
 import type { ISpec } from '@visactor/vchart';
-import type { AdvancedVSeed, VSeed } from '../../properties';
 import type { Pipe } from '../pipeline';
+import type { VSeed } from '../../chartType';
+import type { AdvancedVSeed } from '../../advancedVSeed';
 export type SpecPipelineContext = {
     vseed: VSeed;
     advancedVSeed: AdvancedVSeed;

package/dist/types/properties/baseConfig/backgroundColor.d.ts

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+export declare const zBackgroundColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+/**
+ * 图表的背景颜色
+ * @default transparent 默认为透明背景
+ * @description 背景颜色可以是颜色字符串, 例如'red', 'blue', 也可以是hex, rgb或rgba'#ff0000', 'rgba(255,0,0,0.5)'
+ */
+export type BackgroundColor = string | undefined;

package/dist/types/properties/baseConfig/baseConfig.d.ts

@@ -0,0 +1,44 @@
+import { z } from 'zod';
+declare const zVChartBaseConfig: z.ZodObject<{
+    backgroundColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+    label: z.ZodOptional<z.ZodObject<{
+        enable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    }, z.core.$strip>>;
+    color: z.ZodOptional<z.ZodObject<{
+        colorScheme: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        colorMapping: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    }, z.core.$strip>>;
+    tooltip: z.ZodOptional<z.ZodObject<{
+        enable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    }, z.core.$strip>>;
+    legend: z.ZodOptional<z.ZodObject<{
+        enable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const zVTableBaseConfig: z.ZodObject<{
+    backgroundColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+}, z.core.$strip>;
+export declare const zBaseConfig: z.ZodObject<{
+    vchart: z.ZodOptional<z.ZodObject<{
+        backgroundColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+        label: z.ZodOptional<z.ZodObject<{
+            enable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        }, z.core.$strip>>;
+        color: z.ZodOptional<z.ZodObject<{
+            colorScheme: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            colorMapping: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        }, z.core.$strip>>;
+        tooltip: z.ZodOptional<z.ZodObject<{
+            enable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        }, z.core.$strip>>;
+        legend: z.ZodOptional<z.ZodObject<{
+            enable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    vtable: z.ZodOptional<z.ZodObject<{
+        backgroundColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type VTableBaseConfig = z.infer<typeof zVTableBaseConfig>;
+export type VChartBaseConfig = z.infer<typeof zVChartBaseConfig>;
+export {};

package/dist/types/properties/baseConfig/color.d.ts

@@ -0,0 +1,23 @@
+import { z } from 'zod';
+export declare const zColor: z.ZodObject<{
+    colorScheme: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    colorMapping: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+}, z.core.$strip>;
+export type Color = {
+    /**
+     * 颜色配色方案
+     * @description 颜色配色方案用于定义图表中不同元素的颜色
+     * @example ['#FFCDD2,#F8BBD0,#E1BEE7,#D1C4E9,#C5CAE9,#BBDEFB,#B3E5FC,#B2EBF2,#B2DFDB,#C8E6C9,#DCEDC8,#F0F4C3,#FFF9C4,#FFECB3,#FFE0B2']
+     */
+    colorScheme: string[];
+    /**
+     * 颜色映射
+     * @description 颜色映射用于将数据值映射到具体的颜色
+     * @example
+     * {
+     *  'profit': 'red',
+     *  'sales': 'blue',
+     * }
+     */
+    colorMapping: Record<string, string>;
+};

package/dist/types/properties/baseConfig/index.d.ts

@@ -0,0 +1,12 @@
+export type { VTableBaseConfig, VChartBaseConfig } from './baseConfig';
+export { zBackgroundColor } from './backgroundColor';
+export type { BackgroundColor } from './backgroundColor';
+export { zBaseConfig } from './baseConfig';
+export type { Color } from './color';
+export { zColor } from './color';
+export type { Label } from './label';
+export { zLabel } from './label';
+export type { Legend } from './legend';
+export { zLegend } from './legend';
+export type { Tooltip } from './tooltip';
+export { zTooltip } from './tooltip';

package/dist/types/properties/baseConfig/label.d.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+export declare const zLabel: z.ZodObject<{
+    enable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+}, z.core.$strip>;
+export type Label = {
+    /**
+     * 标签功能是否开启
+     * @default true
+     */
+    enable: boolean;
+};

package/dist/types/properties/baseConfig/legend.d.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+export declare const zLegend: z.ZodObject<{
+    enable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+}, z.core.$strip>;
+export type Legend = {
+    /**
+     * 图例功能是否开启
+     * @default true
+     */
+    enable: boolean;
+};

package/dist/types/properties/baseConfig/tooltip.d.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+export declare const zTooltip: z.ZodObject<{
+    enable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+}, z.core.$strip>;
+export type Tooltip = {
+    /**
+     * 提示信息功能是否开启
+     * @default true
+     */
+    enable: boolean;
+};

package/dist/types/properties/chartType/zChartType.d.ts

@@ -18,19 +18,19 @@ export declare enum ChartTypeEnum {
     DualAxis = "dualAxis"
 }
 export declare const zChartType: z.ZodEnum<{
-    area: "area";
+    table: "table";
+    pivotTable: "pivotTable";
     line: "line";
-    bar: "bar";
-    pie: "pie";
-    rose: "rose";
     column: "column";
-    areaPercent: "areaPercent";
-    barPercent: "barPercent";
     columnPercent: "columnPercent";
     columnParallel: "columnParallel";
+    bar: "bar";
+    barPercent: "barPercent";
     barParallel: "barParallel";
-    table: "table";
-    pivotTable: "pivotTable";
+    area: "area";
+    areaPercent: "areaPercent";
+    rose: "rose";
+    pie: "pie";
     donut: "donut";
     dualAxis: "dualAxis";
 }>;

package/dist/types/properties/index.d.ts

@@ -2,7 +2,7 @@ export * from './chartType';
 export * from './dataset';
 export * from './dimensions';
 export * from './measures';
-export * from './vseed';
-export * from './advancedVSeed';
 export * from './datasetReshapeInfo';
 export * from './encoding';
+export * from './baseConfig';
+export * from './theme';

package/dist/types/properties/theme/customTheme.d.ts

@@ -0,0 +1,49 @@
+import { z } from 'zod';
+export declare const zCustomThemeConfig: z.ZodObject<{
+    baseConfig: z.ZodOptional<z.ZodObject<{
+        vchart: z.ZodOptional<z.ZodObject<{
+            backgroundColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+            label: z.ZodOptional<z.ZodObject<{
+                enable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+            }, z.core.$strip>>;
+            color: z.ZodOptional<z.ZodObject<{
+                colorScheme: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                colorMapping: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+            }, z.core.$strip>>;
+            tooltip: z.ZodOptional<z.ZodObject<{
+                enable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+            }, z.core.$strip>>;
+            legend: z.ZodOptional<z.ZodObject<{
+                enable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
+        vtable: z.ZodOptional<z.ZodObject<{
+            backgroundColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const zCustomTheme: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+    baseConfig: z.ZodOptional<z.ZodObject<{
+        vchart: z.ZodOptional<z.ZodObject<{
+            backgroundColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+            label: z.ZodOptional<z.ZodObject<{
+                enable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+            }, z.core.$strip>>;
+            color: z.ZodOptional<z.ZodObject<{
+                colorScheme: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                colorMapping: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+            }, z.core.$strip>>;
+            tooltip: z.ZodOptional<z.ZodObject<{
+                enable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+            }, z.core.$strip>>;
+            legend: z.ZodOptional<z.ZodObject<{
+                enable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
+        vtable: z.ZodOptional<z.ZodObject<{
+            backgroundColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>>>;
+export type CustomTheme = z.infer<typeof zCustomTheme>;
+export type CustomThemeConfig = z.infer<typeof zCustomThemeConfig>;

package/dist/types/properties/theme/index.d.ts

@@ -0,0 +1,4 @@
+export type { CustomTheme, CustomThemeConfig } from './customTheme';
+export { zCustomTheme, zCustomThemeConfig } from './customTheme';
+export type { Theme } from './theme';
+export { zTheme } from './theme';

package/dist/types/properties/theme/theme.d.ts

@@ -0,0 +1,15 @@
+import { z } from 'zod';
+export declare const zTheme: z.ZodString;
+type Light = 'light' & {
+    readonly brand: unique symbol;
+};
+type Dark = 'dark' & {
+    readonly brand: unique symbol;
+};
+/**
+ * 主题
+ * @default light
+ * @description 内置 light、dark 两种主题, 新的主题可以通过registerTheme自定义主题.
+ */
+export type Theme = Light | Dark | string;
+export {};

package/dist/types/{properties/vseed.d.ts → vseed.d.ts}

@@ -1,23 +1,35 @@
 import { z } from 'zod';
-import type { ChartType } from './chartType';
-import type { Dataset } from './dataset';
-import type { Dimensions } from './dimensions';
-import type { Measures } from './measures';
+import type { Bar } from './chartType/bar';
+import type { BarParallel } from './chartType/barParallel';
+import type { Column } from './chartType/column';
+import type { ColumnParallel } from './chartType/columnParallel';
+import type { ColumnPercent } from './chartType/columnPercent';
+import type { Line } from './chartType/line';
+import type { Table } from './chartType/table';
+import type { Rose } from './chartType/rose';
+import type { BarPercent } from './chartType/barPercent';
+import type { PivotTable } from './chartType/pivotTable';
+import type { Pie } from './chartType/pie';
+import type { Donut } from './chartType/donut';
+import type { DualAxis } from './chartType/dualAxis';
+import type { Area } from './chartType/area';
+import type { AreaPercent } from './chartType/areaPercent';
+export type VSeed = Table | PivotTable | Line | Column | ColumnParallel | ColumnPercent | Bar | BarParallel | BarPercent | Area | AreaPercent | DualAxis | Rose | Pie | Donut;
 export declare const zVSeed: z.ZodObject<{
     chartType: z.ZodEnum<{
-        area: "area";
+        table: "table";
+        pivotTable: "pivotTable";
         line: "line";
-        bar: "bar";
-        pie: "pie";
-        rose: "rose";
         column: "column";
-        areaPercent: "areaPercent";
-        barPercent: "barPercent";
         columnPercent: "columnPercent";
         columnParallel: "columnParallel";
+        bar: "bar";
+        barPercent: "barPercent";
         barParallel: "barParallel";
-        table: "table";
-        pivotTable: "pivotTable";
+        area: "area";
+        areaPercent: "areaPercent";
+        rose: "rose";
+        pie: "pie";
         donut: "donut";
         dualAxis: "dualAxis";
     }>;
@@ -84,11 +96,6 @@ export declare const zVSeed: z.ZodObject<{
             suffix: z.ZodDefault<z.ZodOptional<z.ZodString>>;
         }, z.core.$strip>>;
     }, z.core.$strip>]>>>;
+    backgroundColor: z.ZodOptional<z.ZodDefault<z.ZodString>>;
 }, z.core.$strip>;
-export type VSeed = {
-    chartType: ChartType;
-    dataset: Dataset;
-    dimensions?: Dimensions;
-    measures?: Measures;
-};
 export declare const VSeedJSONSchema: z.core.JSONSchema.JSONSchema;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@visactor/vseed",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "type": "module",
   "exports": {
     ".": {
@@ -15,6 +15,7 @@
     "dist"
   ],
   "dependencies": {
+    "remeda": "^2.28.0",
     "zod": "4.0.14"
   },
   "peerDependencies": {