@spectrum-charts/vega-spec-builder-s2 0.3.1 → 0.4.0

package/dist/@types/src/types/specUtil.types.d.ts

@@ -1,13 +1,19 @@
-import { Spec, SymbolShape } from 'vega';
+import { Config, Spec, SymbolShape } from 'vega';
 import { SpectrumVizColor } from './spectrumVizColor.types';
 export type PartiallyRequired<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
 export interface ScSpec extends Spec {
     usermeta: UserMeta;
 }
+export type InteractiveMark = {
+    name: string;
+    dimension?: string;
+};
 export type UserMeta = {
-    interactiveMarks?: string[];
+    animatedMarks?: string[];
+    interactiveMarks?: InteractiveMark[];
     chartOrientation?: Orientation;
     metricAxisCount?: number;
+    patches?: Partial<Config>[];
 };
 export interface MarkBounds {
     x1: number;
@@ -28,7 +34,7 @@ export type Datum = object & {
     [DatumPredefinedKey.groupData]?: Datum[];
     [key: string]: any;
 };
-export type NumberFormat = 'currency' | 'shortCurrency' | 'shortNumber' | 'standardNumber' | string;
+export type NumberFormat = 'currency' | 'shortCurrency' | 'shortNumber' | 'standardNumber' | 'percentage' | string;
 export type Orientation = 'vertical' | 'horizontal';
 export type Position = 'left' | 'right' | 'top' | 'bottom';
 export type ScaleType = 'linear' | 'point' | 'time' | 'band';

package/dist/@types/src/types/specUtil.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"specUtil.types.d.ts","sourceRoot":"","sources":["../../../../src/types/specUtil.types.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,MAAM,CAAC;AAIzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAE5D,MAAM,MAAM,iBAAiB,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAGxF,MAAM,WAAW,MAAO,SAAQ,IAAI;IAgBlC,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,gBAAgB,CAAC,EAAE,WAAW,CAAC;IAC/B,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,QAAA,MAAM,kBAAkB;;;;;CAKd,CAAC;AAEX,MAAM,MAAM,KAAK,GAAG,MAAM,GAAG;IAC3B,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACpC,CAAC,kBAAkB,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IACtC,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAC,EAAE,MAAM,CAAC;IAC7C,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC;IAEzC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,eAAe,GAAG,aAAa,GAAG,gBAAgB,GAAG,MAAM,CAAC;AACpG,MAAM,MAAM,WAAW,GAAG,UAAU,GAAG,YAAY,CAAC;AACpD,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,QAAQ,CAAC;AAC3D,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;AAC7D,MAAM,MAAM,gBAAgB,GAAG,gBAAgB,GAAG,WAAW,GAAG,MAAM,CAAC;AAEvE;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,SAAS,GAAG,MAAM,EAAE,CAAC;AAEnH;;;;;;;;KAQK;AACL,MAAM,MAAM,SAAS,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,MAAM,CAAC;AAE/D;;;;;;;;KAQK;AACL,MAAM,MAAM,SAAS,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,MAAM,CAAC;AAE/D;;;;;;;;KAQK;AACL,MAAM,MAAM,UAAU,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,MAAM,CAAC;AAEhE,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;IAAE,KAAK,EAAE,CAAC,CAAA;CAAE,CAAC;AAC1C,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;AAElD,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC,gBAAgB,GAAG,MAAM,CAAC,CAAC;AAC7D,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAC/C,MAAM,MAAM,cAAc,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;AACjD,MAAM,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC5C,MAAM,MAAM,cAAc,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;AACjD,MAAM,MAAM,eAAe,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC;AACnD,MAAM,MAAM,gBAAgB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,CAAC;AAE1D,MAAM,MAAM,SAAS,GACjB,OAAO,GACP,aAAa,GACb,UAAU,GACV,WAAW,GACX,SAAS,GACT,aAAa,GACb,YAAY,GACZ,iBAAiB,CAAC;AAEtB,MAAM,MAAM,kBAAkB,GAC1B,gBAAgB,GAChB,mBAAmB,GACnB,oBAAoB,GACpB,kBAAkB,GAClB,sBAAsB,GACtB,qBAAqB,GACrB,0BAA0B,CAAC;AAG/B,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CAAC;IACpC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,GAAG,CAAC,CAAC,EAAE,CAAC"}
+{"version":3,"file":"specUtil.types.d.ts","sourceRoot":"","sources":["../../../../src/types/specUtil.types.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,MAAM,CAAC;AAIjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAE5D,MAAM,MAAM,iBAAiB,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAGxF,MAAM,WAAW,MAAO,SAAQ,IAAI;IAgBlC,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;IACrC,gBAAgB,CAAC,EAAE,WAAW,CAAC;IAC/B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;CAC7B,CAAC;AAEF,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,QAAA,MAAM,kBAAkB;;;;;CAKd,CAAC;AAEX,MAAM,MAAM,KAAK,GAAG,MAAM,GAAG;IAC3B,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACpC,CAAC,kBAAkB,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IACtC,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAC,EAAE,MAAM,CAAC;IAC7C,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC;IAEzC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,eAAe,GAAG,aAAa,GAAG,gBAAgB,GAAG,YAAY,GAAG,MAAM,CAAC;AACnH,MAAM,MAAM,WAAW,GAAG,UAAU,GAAG,YAAY,CAAC;AACpD,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,QAAQ,CAAC;AAC3D,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;AAC7D,MAAM,MAAM,gBAAgB,GAAG,gBAAgB,GAAG,WAAW,GAAG,MAAM,CAAC;AAEvE;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,SAAS,GAAG,MAAM,EAAE,CAAC;AAEnH;;;;;;;;KAQK;AACL,MAAM,MAAM,SAAS,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,MAAM,CAAC;AAE/D;;;;;;;;KAQK;AACL,MAAM,MAAM,SAAS,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,MAAM,CAAC;AAE/D;;;;;;;;KAQK;AACL,MAAM,MAAM,UAAU,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,MAAM,CAAC;AAEhE,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;IAAE,KAAK,EAAE,CAAC,CAAA;CAAE,CAAC;AAC1C,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;AAElD,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC,gBAAgB,GAAG,MAAM,CAAC,CAAC;AAC7D,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAC/C,MAAM,MAAM,cAAc,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;AACjD,MAAM,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC5C,MAAM,MAAM,cAAc,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;AACjD,MAAM,MAAM,eAAe,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC;AACnD,MAAM,MAAM,gBAAgB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,CAAC;AAE1D,MAAM,MAAM,SAAS,GACjB,OAAO,GACP,aAAa,GACb,UAAU,GACV,WAAW,GACX,SAAS,GACT,aAAa,GACb,YAAY,GACZ,iBAAiB,CAAC;AAEtB,MAAM,MAAM,kBAAkB,GAC1B,gBAAgB,GAChB,mBAAmB,GACnB,oBAAoB,GACpB,kBAAkB,GAClB,sBAAsB,GACtB,qBAAqB,GACrB,0BAA0B,CAAC;AAG/B,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CAAC;IACpC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,GAAG,CAAC,CAAC,EAAE,CAAC"}

package/dist/@types/src/vegaEmbedUtils.d.ts

@@ -1,5 +1,13 @@
 import { Config, Locale, NumberLocale, Padding, Renderers, TimeLocale } from 'vega';
 import { LocaleCode, NumberLocaleCode, TimeLocaleCode } from '@spectrum-charts/locales';
+/**
+ * WARNING: This is a last-resort escape hatch for working around gaps in Vega's functionality.
+ * It must NOT be used as a general config customization pattern. Each patch is deep-merged into
+ * the embed config before Vega sees it, bypassing Vega's own mergeConfig (which has known bugs
+ * with nested objects like legend.layout.*). Patches introduce unstructured state that is hard
+ * to trace and reason about — if Vega supports the use case directly, use that instead.
+ */
+export declare const applyUserMetaConfigPatches: (patches: Partial<Config>[] | undefined, config: Config) => Config;
 export declare const getVegaEmbedOptions: ({ locale, height, width, padding, renderer, config, colorScheme, }: {
     locale?: Locale | LocaleCode | {
         number?: NumberLocaleCode | NumberLocale;

package/dist/@types/src/vegaEmbedUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"vegaEmbedUtils.d.ts","sourceRoot":"","sources":["../../../src/vegaEmbedUtils.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAGpF,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,cAAc,EAAa,MAAM,0BAA0B,CAAC;AAKnG,eAAO,MAAM,mBAAmB,uEAQ7B;IACD,MAAM,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG;QAAE,MAAM,CAAC,EAAE,gBAAgB,GAAG,YAAY,CAAC;QAAC,IAAI,CAAC,EAAE,cAAc,GAAG,UAAU,CAAA;KAAE,CAAC;IAChH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;CAChC;;;;;;;;;;;;;;;;;;;;CAkBA,CAAC"}
+{"version":3,"file":"vegaEmbedUtils.d.ts","sourceRoot":"","sources":["../../../src/vegaEmbedUtils.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAGpF,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,cAAc,EAAa,MAAM,0BAA0B,CAAC;AAKnG;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B,YAAa,QAAQ,MAAM,CAAC,EAAE,GAAG,SAAS,UAAU,MAAM,KAAG,MAMnG,CAAC;AAmBF,eAAO,MAAM,mBAAmB,uEAQ7B;IACD,MAAM,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG;QAAE,MAAM,CAAC,EAAE,gBAAgB,GAAG,YAAY,CAAC;QAAC,IAAI,CAAC,EAAE,cAAc,GAAG,UAAU,CAAA;KAAE,CAAC;IAChH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;CAChC;;;;;;;;;;;;;;;;;;;;CAkBA,CAAC"}