gradiente 2.3.0 → 2.4.0

package/dist/index.d.ts

@@ -181,19 +181,27 @@ type GradientCommonConfig = {
 //#endregion
 //#region src/gradients/GradientBase.d.ts
 type GradientType = string;
+interface GradientLike<TJSON = unknown> {
+  readonly type: GradientType;
+  clone(): this;
+  toString(): string;
+  toJSON(): TJSON & {
+    type: GradientType;
+  };
+}
 interface GradientData<TConfig = unknown> {
   isRepeating: boolean;
   config: TConfig;
   stops: GradientStop[];
 }
-interface IGradientBase<TConfig = unknown> {
+interface IGradientBase<TConfig = unknown> extends GradientLike<GradientData<TConfig>> {
   readonly type: GradientType;
   readonly isRepeating: boolean;
   readonly config: TConfig;
   readonly stops: GradientStop[];
-  clone(): this;
-  toString(): string;
-  toJSON(): GradientData<TConfig>;
+  toJSON(): GradientData<TConfig> & {
+    type: GradientType;
+  };
   addStop(stop: GradientStop): void;
   removeStop(index: number): void;
   equals(other: IGradientBase<TConfig>): boolean;
@@ -289,7 +297,7 @@ type RadialGradientConfig = {
 };
 declare class RadialGradient extends GradientBase<RadialGradientConfig> {
   private static readonly DEFAULT_CONFIG;
-  readonly type = "radial-gradient";
+  readonly type: GradientType;
   constructor(input: Partial<GradientData<RadialGradientConfig>>);
   static fromString(input: string): RadialGradient;
   static fromAbi(abi: GradientAbi): RadialGradient;
@@ -305,11 +313,21 @@ declare class RadialGradient extends GradientBase<RadialGradientConfig> {
   private _isDefaultRadialPosition;
   private _serializePosition;
   private _formatLengthPercentage;
-  private static _parseConfig;
+  protected static _parseConfig(inputs: GradientAbiInput[]): RadialGradientConfig;
   private static _parseLengthPercentage;
   private static _normalizeConfigInterpolation;
 }
 //#endregion
+//#region src/gradients/DiamondGradient.d.ts
+type DiamondGradientConfig = RadialGradientConfig;
+declare class DiamondGradient extends RadialGradient {
+  readonly type: GradientType;
+  constructor(input: Partial<GradientData<DiamondGradientConfig>>);
+  static fromString(input: string): DiamondGradient;
+  static fromAbi(abi: GradientAbi): DiamondGradient;
+  clone(): this;
+}
+//#endregion
 //#region src/gradients/ConicGradient.d.ts
 type ConicGradientConfig = {
   from: GradientAngleValue;
@@ -335,8 +353,96 @@ declare class ConicGradient extends GradientBase<ConicGradientConfig> {
   private static _parseAngle;
 }
 //#endregion
+//#region src/gradients/MeshGradient.d.ts
+type MeshGradientInterpolationMethod = "bilinear" | "bicubic";
+type MeshGradientPatchSide = "top" | "right" | "bottom" | "left";
+type MeshGradientConfig = {
+  rows: number;
+  columns: number;
+  method: MeshGradientInterpolationMethod;
+  interpolation?: GradientInterpolation;
+};
+type MeshGradientVertex = {
+  id: string;
+  x: GradientLengthPercentage;
+  y: GradientLengthPercentage;
+  color: string;
+};
+type MeshGradientHandle = {
+  x: GradientLengthPercentage;
+  y: GradientLengthPercentage;
+};
+type MeshGradientPatch = {
+  id: string;
+  topLeft: string;
+  topRight: string;
+  bottomRight: string;
+  bottomLeft: string;
+  handles?: {
+    top?: {
+      from: MeshGradientHandle;
+      to: MeshGradientHandle;
+    };
+    right?: {
+      from: MeshGradientHandle;
+      to: MeshGradientHandle;
+    };
+    bottom?: {
+      from: MeshGradientHandle;
+      to: MeshGradientHandle;
+    };
+    left?: {
+      from: MeshGradientHandle;
+      to: MeshGradientHandle;
+    };
+  };
+};
+type MeshGradientData = {
+  config: MeshGradientConfig;
+  vertices: MeshGradientVertex[];
+  patches: MeshGradientPatch[];
+};
+declare class MeshGradient implements GradientLike<MeshGradientData> {
+  readonly type = "mesh-gradient";
+  private readonly _config;
+  private readonly _vertices;
+  private readonly _patches;
+  constructor(input: MeshGradientData);
+  get config(): MeshGradientConfig;
+  get vertices(): MeshGradientVertex[];
+  get patches(): MeshGradientPatch[];
+  static fromString(input: string): MeshGradient;
+  static fromAbi(abi: GradientAbi): MeshGradient;
+  clone(): this;
+  toJSON(): MeshGradientData & {
+    type: "mesh-gradient";
+  };
+  toString(): string;
+  getVertex(id: string): MeshGradientVertex | null;
+  private _serializeConfig;
+  private _serializeVertex;
+  private _serializePatch;
+  private _serializeHandles;
+  private _formatLengthPercentage;
+  private _validate;
+  private _validateId;
+  private _validateHandles;
+  private _validateLengthPercentage;
+  private static _parseConfig;
+  private static _parseVertex;
+  private static _parsePatch;
+  private static _parseHandle;
+  private static _attachHandles;
+  private static _parseLengthPercentage;
+  private static _normalizeInterpolation;
+  private static _parseFunction;
+  private static _findOuterClosingParenIndex;
+  private static _splitTopLevelInputs;
+  private static _pushTrimmed;
+}
+//#endregion
 //#region src/gradients/GradientFactory.d.ts
-interface IGradientStatic<TGradient extends GradientBase = GradientBase> {
+interface IGradientStatic<TGradient extends GradientLike = GradientLike> {
   fromAbi(abi: GradientAbi): TGradient;
   fromString(input: string): TGradient;
 }
@@ -346,23 +452,24 @@ declare class GradientFactory {
   static add(type: string, value: IGradientStatic): void;
   static get(functionName: string): IGradientStatic | null;
   static remove(functionName: string): boolean;
-  static create(input: string | GradientAbi): IGradientBase<any>;
+  static create(input: string | GradientAbi): AnyGradient;
   static isValid(input: string): boolean;
   private static _ensureInitialized;
+  private static _getFunctionName;
 }
-type AnyGradient = LinearGradient | RadialGradient | ConicGradient;
+type AnyGradient = LinearGradient | RadialGradient | DiamondGradient | ConicGradient | MeshGradient;
 declare function parse(input: string): AnyGradient;
 declare function isGradient(input: string): boolean;
 declare function format(input: string | AnyGradient): string;
-declare function transformTo(target: string, input: string | GradientBase<any>): unknown;
-declare function transformFrom<TInput = unknown>(target: string, gradientType: string, input: TInput): GradientBase<any>;
+declare function transformTo(target: string, input: string | AnyGradient): unknown;
+declare function transformFrom<TInput = unknown>(target: string, gradientType: string, input: TInput): AnyGradient;
 //#endregion
 //#region src/gradient-transformer/modules/types.d.ts
 interface IGradientTransformerModule<TOutput = unknown> {
   readonly target: string;
   readonly gradientType: string;
-  to(input: GradientBase<any>): TOutput;
-  from?(input: TOutput): GradientBase<any>;
+  to(input: GradientLike): TOutput;
+  from?(input: TOutput): GradientLike;
 }
 interface ICanvasPaintResult {
   draw(ctx: CanvasRenderingContext2D, width: number, height: number): void;
@@ -382,6 +489,13 @@ declare class ModuleTransformerRadialGradientToCss implements IGradientTransform
   to(input: GradientBase<any>): string;
 }
 //#endregion
+//#region src/gradient-transformer/modules/css/ModuleTransformerDiamondGradientToCss.d.ts
+declare class ModuleTransformerDiamondGradientToCss implements IGradientTransformerModule<string> {
+  readonly target = "css";
+  readonly gradientType = "diamond-gradient";
+  to(input: GradientBase<any>): string;
+}
+//#endregion
 //#region src/gradient-transformer/modules/css/ModuleTransformerConicGradientToCss.d.ts
 declare class ModuleTransformerConicGradientToCss implements IGradientTransformerModule<string> {
   readonly target = "css";
@@ -389,6 +503,13 @@ declare class ModuleTransformerConicGradientToCss implements IGradientTransforme
   to(input: GradientBase<any>): string;
 }
 //#endregion
+//#region src/gradient-transformer/modules/css/ModuleTransformerMeshGradientToCss.d.ts
+declare class ModuleTransformerMeshGradientToCss implements IGradientTransformerModule<string> {
+  readonly target = "css";
+  readonly gradientType = "mesh-gradient";
+  to(input: GradientLike): string;
+}
+//#endregion
 //#region src/gradient-transformer/modules/canvas/ModuleTransformerLinearGradientToCanvas.d.ts
 declare class ModuleTransformerLinearGradientToCanvas implements IGradientTransformerModule<ICanvasPaintResult> {
   readonly target = "canvas-2d";
@@ -408,6 +529,18 @@ declare class ModuleTransformerRadialGradientToCanvas implements IGradientTransf
   private _resolve;
 }
 //#endregion
+//#region src/gradient-transformer/modules/canvas/ModuleTransformerDiamondGradientToCanvas.d.ts
+declare class ModuleTransformerDiamondGradientToCanvas implements IGradientTransformerModule<ICanvasPaintResult> {
+  readonly target = "canvas-2d";
+  readonly gradientType = "diamond-gradient";
+  to(input: GradientBase<any>): ICanvasPaintResult;
+  private _resolveCenter;
+  private _resolveKeywordX;
+  private _resolveKeywordY;
+  private _resolveDiamondRadii;
+  private _resolve;
+}
+//#endregion
 //#region src/gradient-transformer/modules/canvas/ModuleTransformerConicGradientToCanvas.d.ts
 declare class ModuleTransformerConicGradientToCanvas implements IGradientTransformerModule<ICanvasPaintResult> {
   readonly target = "canvas-2d";
@@ -425,6 +558,13 @@ declare class ModuleTransformerConicGradientToCanvas implements IGradientTransfo
   private _clamp01;
 }
 //#endregion
+//#region src/gradient-transformer/modules/canvas/ModuleTransformerMeshGradientToCanvas.d.ts
+declare class ModuleTransformerMeshGradientToCanvas implements IGradientTransformerModule<ICanvasPaintResult> {
+  readonly target = "canvas-2d";
+  readonly gradientType = "mesh-gradient";
+  to(input: GradientLike): ICanvasPaintResult;
+}
+//#endregion
 //#region src/gradient-transformer/modules/webgl/types.d.ts
 interface IWebGLPaintResult {
   draw(canvas: HTMLCanvasElement, width: number, height: number): void;
@@ -451,6 +591,20 @@ declare class ModuleTransformerRadialGradientToCanvasWebGL implements IGradientT
   to(input: GradientBase<any>): IWebGLPaintResult;
 }
 //#endregion
+//#region src/gradient-transformer/modules/webgl/ModuleTransformerDiamondGradientToWebgl.d.ts
+declare class ModuleTransformerDiamondGradientToCanvasWebGL implements IGradientTransformerModule<IWebGLPaintResult> {
+  readonly target = "canvas-webgl";
+  readonly gradientType = "diamond-gradient";
+  to(input: GradientBase<any>): IWebGLPaintResult;
+}
+//#endregion
+//#region src/gradient-transformer/modules/webgl/ModuleTransformerMeshGradientToWebgl.d.ts
+declare class ModuleTransformerMeshGradientToCanvasWebGL implements IGradientTransformerModule<IWebGLPaintResult> {
+  readonly target = "canvas-webgl";
+  readonly gradientType = "mesh-gradient";
+  to(input: GradientLike): IWebGLPaintResult;
+}
+//#endregion
 //#region src/gradient-transformer/GradientTransformer.d.ts
 declare class GradientTransformer {
   private static readonly _modules;
@@ -458,10 +612,10 @@ declare class GradientTransformer {
   static add(module: IGradientTransformerModule): void;
   static get(target: string, gradientType: string): IGradientTransformerModule | null;
   static remove(target: string, gradientType: string): boolean;
-  static to<TOutput = unknown>(target: string, input: string | GradientBase<any>): TOutput;
-  static from<TOutput = unknown>(target: string, gradientType: string, input: TOutput): GradientBase<any>;
+  static to<TOutput = unknown>(target: string, input: string | GradientLike): TOutput;
+  static from<TOutput = unknown>(target: string, gradientType: string, input: TOutput): AnyGradient;
   private static _ensureInitialized;
   private static _getKey;
 }
 //#endregion
-export { AbiInputType, AngleUnit, AnyGradient, ConicGradient, ConicGradientConfig, GRADIENT_COLOR_SPACE, GRADIENT_HUE_INTERPOLATIONS, GRADIENT_POLAR_COLOR_SPACES, GradientAbi, GradientAbiInput, GradientAngleUnit, GradientAngleValue, GradientBase, GradientColorHint, GradientColorInterpolation, GradientColorSpace, GradientColorStop, GradientCommonConfig, GradientData, GradientFactory, GradientHueInterpolation, GradientHueInterpolationMethod, GradientInterpolation, GradientLengthPercentage, GradientLengthUnit, GradientLengthValue, GradientNumberValue, GradientPercentValue, GradientPolarColorSpace, GradientPosition, GradientPositionKeywordX, GradientPositionKeywordY, GradientRectangularColorSpace, GradientStop, GradientTransformer, GradientType, ICanvasPaintResult, IGradientBase, IGradientStatic, IGradientTransformerModule, LinearGradient, LinearGradientConfig, ModuleTransformerConicGradientToCanvas, ModuleTransformerConicGradientToCanvasWebGL, ModuleTransformerConicGradientToCss, ModuleTransformerLinearGradientToCanvas, ModuleTransformerLinearGradientToCanvasWebGL, ModuleTransformerLinearGradientToCss, ModuleTransformerRadialGradientToCanvas, ModuleTransformerRadialGradientToCanvasWebGL, ModuleTransformerRadialGradientToCss, PatternTokenKind, RadialGradient, RadialGradientConfig, RadialGradientExtent, RadialGradientShape, RadialGradientSize, angleValueFromString, ceilTo, clamp, degToRad, floorTo, format, fromPercent, gradToRad, isAngle, isAngleUnit, isColorHint, isColorStop, isConfig, isGradient, isGradientColorSpace, isGradientHueInterpolation, isGradientPolarColorSpace, isPatternSyntaxValid, isPatternValid, isValid, matchExpression, normalizeAngleDeg, normalizeAngleRad, parse, parseStringToAbi, radToDeg, roundTo, splitTopLevelByWhitespace, toPercent, tokenizePattern, transformFrom, transformTo, truncTo, turnToRad, validate, validatePattern, validatePatternSemantic, validatePatternStructure, validatePatternSyntax };
+export { AbiInputType, AngleUnit, AnyGradient, ConicGradient, ConicGradientConfig, DiamondGradient, DiamondGradientConfig, GRADIENT_COLOR_SPACE, GRADIENT_HUE_INTERPOLATIONS, GRADIENT_POLAR_COLOR_SPACES, GradientAbi, GradientAbiInput, GradientAngleUnit, GradientAngleValue, GradientBase, GradientColorHint, GradientColorInterpolation, GradientColorSpace, GradientColorStop, GradientCommonConfig, GradientData, GradientFactory, GradientHueInterpolation, GradientHueInterpolationMethod, GradientInterpolation, GradientLengthPercentage, GradientLengthUnit, GradientLengthValue, GradientLike, GradientNumberValue, GradientPercentValue, GradientPolarColorSpace, GradientPosition, GradientPositionKeywordX, GradientPositionKeywordY, GradientRectangularColorSpace, GradientStop, GradientTransformer, GradientType, ICanvasPaintResult, IGradientBase, IGradientStatic, IGradientTransformerModule, LinearGradient, LinearGradientConfig, MeshGradient, MeshGradientConfig, MeshGradientData, MeshGradientHandle, MeshGradientInterpolationMethod, MeshGradientPatch, MeshGradientPatchSide, MeshGradientVertex, ModuleTransformerConicGradientToCanvas, ModuleTransformerConicGradientToCanvasWebGL, ModuleTransformerConicGradientToCss, ModuleTransformerDiamondGradientToCanvas, ModuleTransformerDiamondGradientToCanvasWebGL, ModuleTransformerDiamondGradientToCss, ModuleTransformerLinearGradientToCanvas, ModuleTransformerLinearGradientToCanvasWebGL, ModuleTransformerLinearGradientToCss, ModuleTransformerMeshGradientToCanvas, ModuleTransformerMeshGradientToCanvasWebGL, ModuleTransformerMeshGradientToCss, ModuleTransformerRadialGradientToCanvas, ModuleTransformerRadialGradientToCanvasWebGL, ModuleTransformerRadialGradientToCss, PatternTokenKind, RadialGradient, RadialGradientConfig, RadialGradientExtent, RadialGradientShape, RadialGradientSize, angleValueFromString, ceilTo, clamp, degToRad, floorTo, format, fromPercent, gradToRad, isAngle, isAngleUnit, isColorHint, isColorStop, isConfig, isGradient, isGradientColorSpace, isGradientHueInterpolation, isGradientPolarColorSpace, isPatternSyntaxValid, isPatternValid, isValid, matchExpression, normalizeAngleDeg, normalizeAngleRad, parse, parseStringToAbi, radToDeg, roundTo, splitTopLevelByWhitespace, toPercent, tokenizePattern, transformFrom, transformTo, truncTo, turnToRad, validate, validatePattern, validatePatternSemantic, validatePatternStructure, validatePatternSyntax };