@flowgram.ai/utils 0.1.0-alpha.2 → 0.1.0-alpha.20

package/dist/index.d.mts

@@ -1,5 +1,9 @@
 import { interfaces } from 'inversify';
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 declare const PI: number;
 /** Two Pi. */
 declare const PI_2: number;
@@ -21,6 +25,10 @@ declare enum SHAPES {
     RREC = 4
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 declare class Vector2 {
     x: number;
     y: number;
@@ -35,6 +43,10 @@ declare class Vector2 {
     dot(v: Vector2): number;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 /**
  * Common interface for points. Both Point and ObservablePoint implement it
  */
@@ -49,6 +61,10 @@ interface IPoint {
     y: number;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 type SchemaType = 'string' | 'integer' | 'float' | 'boolean' | 'enum' | 'object' | 'range' | 'color' | 'array';
 interface SchemaMixinDefaults {
     [defaultKey: string]: any;
@@ -101,6 +117,11 @@ declare namespace Schema {
     function isBaseType(decoration: SchemaDecoration): boolean;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface PositionSchema {
     x: number;
     y: number;
@@ -165,6 +186,11 @@ declare namespace SizeSchema {
     function empty(): SizeSchema;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 type OpacitySchema = number;
 interface FlipSchema {
     x: boolean;
@@ -207,6 +233,11 @@ declare const ShadowSchemaDecoration: SchemaDecoration<ShadowSchema>;
 declare const TintSchemaDecoration: SchemaDecoration<TintSchema>;
 declare const OpacitySchemaDecoration: SchemaDecoration<OpacitySchema>;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  * Size object, contains width and height
  */
@@ -389,6 +420,11 @@ declare class OBBRect {
     getProjectionRadius(axis: Vector2): number;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  * The Circle object is used to help draw graphics and can also be used to specify a hit area for displayObjects.
  */
@@ -425,6 +461,11 @@ declare class Circle {
     getBounds(): Rectangle;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  * The Point object represents a location in a two-dimensional coordinate system, where x represents
  * the horizontal axis and y represents the vertical axis.
@@ -496,6 +537,11 @@ declare class ObservablePoint<T = any> implements IPoint {
     equals(p: IPoint): boolean;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  * Transform that takes care about its versions
  *
@@ -564,6 +610,11 @@ declare class Transform {
     set rotation(value: number);
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  * The PIXIJS Matrix as a class makes it a lot faster.
  *
@@ -727,6 +778,11 @@ declare class Matrix {
     copyFrom(matrix: Matrix): this;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  * The Point object represents a location in a two-dimensional coordinate system, where x represents
  * the horizontal axis and y represents the vertical axis.
@@ -811,6 +867,11 @@ declare namespace Point {
     function moveDistanceToDirection(current: IPoint, direction: IPoint, distance: number): IPoint;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare namespace Angle {
     /**
      * Wrap an angle.
@@ -838,8 +899,18 @@ declare namespace Angle {
     function betweenPoints(point1: IPoint, point2: IPoint, originPoint?: IPoint): number;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 declare function deepFreeze<T>(obj: T): T;
 declare function notEmpty<T>(arg: T | undefined | null): arg is T;
+/**
+ * filter dangerous key, prevent prototype pollution injection
+ * @param key key to be filtered
+ * @returns filtered key
+ */
+declare const safeKey: (key: string) => string;
 /**
  * `true` if the argument is an empty object. Otherwise, `false`.
  */
@@ -889,6 +960,10 @@ declare const NOOP: () => void;
  */
 declare function isPlainObject(obj: any): boolean;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 interface AsClass<T> {
     new (...args: any[]): T;
 }
@@ -905,7 +980,15 @@ type MaybePromise<T> = T | PromiseLike<T>;
 type RecursivePartial<T> = {
     [P in keyof T]?: T[P] extends Array<infer I> ? Array<RecursivePartial<I>> : RecursivePartial<T[P]>;
 };
+type Without<T, U> = {
+    [P in Exclude<keyof T, keyof U>]?: never;
+};
+type Xor<T, U> = T | U extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 /**
  * An object that performs a cleanup operation when `.dispose()` is called.
  *
@@ -922,25 +1005,11 @@ declare namespace Disposable {
     function create(func: () => void): Disposable;
     const NULL: Readonly<Disposable>;
 }
-declare class DisposableImpl implements Disposable {
-    readonly toDispose: DisposableCollection;
-    dispose(): void;
-    get disposed(): boolean;
-    get onDispose(): Event<void>;
-}
-declare class DisposableCollection implements Disposable {
-    protected readonly disposables: (Disposable & {
-        _origin: Disposable;
-    })[];
-    protected readonly onDisposeEmitter: Emitter<void>;
-    private _disposed;
-    constructor(...toDispose: Disposable[]);
-    get onDispose(): Event<void>;
-    get disposed(): boolean;
-    dispose(): void;
-    push(disposable: Disposable): Disposable;
-    pushAll(disposables: Disposable[]): Disposable[];
-}
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 
 interface EventListener$1<T> {
     (args: T): void;
@@ -962,6 +1031,35 @@ declare class Emitter<T = any> {
     dispose(): void;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+declare class DisposableImpl implements Disposable {
+    readonly toDispose: DisposableCollection;
+    dispose(): void;
+    get disposed(): boolean;
+    get onDispose(): Event<void>;
+}
+declare class DisposableCollection implements Disposable {
+    protected readonly disposables: Disposable[];
+    protected readonly onDisposeEmitter: Emitter<void>;
+    private _disposed;
+    constructor(...toDispose: Disposable[]);
+    get length(): number;
+    get onDispose(): Event<void>;
+    get disposed(): boolean;
+    dispose(): void;
+    push(disposable: Disposable): Disposable;
+    pushAll(disposables: Disposable[]): Disposable[];
+}
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface CancellationToken {
     /**
      * A flag signalling is cancellation has been requested.
@@ -999,6 +1097,11 @@ declare function cancelled(): Error;
 declare function isCancelled(err: Error | undefined): boolean;
 declare function checkCancelled(token?: CancellationToken): void;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  * Simple implementation of the deferred pattern.
  * An object that exposes a promise and functions to resolve and reject it.
@@ -1035,6 +1138,11 @@ declare class PromisePool {
     run<T>(tasks: PromiseTask<T>[], checkIfRetry?: (res: T) => boolean): Promise<T[]>;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface CacheManager<T, ITEM extends CacheOriginItem = CacheOriginItem> extends Disposable {
     get(): T;
     getMore(count: number, autoDelete?: boolean): T[];
@@ -1101,6 +1209,10 @@ declare namespace Cache {
     function createWeakCache(): WeakCache;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 declare namespace Compare {
     /**
      * 比较，默认浅比较
@@ -1120,6 +1232,11 @@ declare namespace Compare {
     function isArrayShallowChanged(arr1: any[], arr2: any[]): boolean;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 type CSSStyle = {
     [P in keyof CSSStyleDeclaration]?: string | number | undefined;
 };
@@ -1153,10 +1270,18 @@ declare namespace domUtils {
     function createDOMCache<T extends DOMCache = DOMCache>(parent: HTMLElement, className: string | (() => HTMLElement), children?: string): CacheManager<T>;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 type LocalId = number;
 declare function generateLocalId(): LocalId;
 declare function _setIdx(idx: number): void;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 declare function iterToArray<T = any>(iter: IterableIterator<T>): T[];
 declare function arrayToSet(arr: any[]): Set<any>;
 /**
@@ -1167,8 +1292,17 @@ declare function arrayToSet(arr: any[]): Set<any>;
  */
 declare function arrayUnion(arr: any[]): any[];
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare function bindContributions(bind: interfaces.Bind, target: any, contribs: any[]): void;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 type RequestFn = (...args: any[]) => Promise<any>;
 /**
  * 请求缓存
@@ -1178,12 +1312,22 @@ declare const RequestCache: Map<any, Promise<any>>;
 declare function clearRequestCache(): void;
 declare function requestWithMemo(req: RequestFn, cacheTime?: number, createCacheKey?: (...args: any[]) => any): RequestFn;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 type FuncMaybePromise<D> = (d: D, ...others: any[]) => MaybePromise<D>;
 type FuncPromise<D> = (d: D, ...others: any[]) => Promise<D>;
 type Func<D> = (d: D, ...others: any[]) => D;
 declare function composeAsync<D>(...fns: FuncMaybePromise<D>[]): FuncPromise<D>;
 declare function compose<D>(...fns: Func<D>[]): Func<D>;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare const ContributionProvider: unique symbol;
 interface ContributionProvider<T extends object> {
     getContributions(): T[];
@@ -1191,10 +1335,19 @@ interface ContributionProvider<T extends object> {
 }
 declare function bindContributionProvider(bind: interfaces.Bind, id: symbol): void;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 type EventListener<K extends keyof HTMLElementEventMap> = (this: HTMLElement, event: HTMLElementEventMap[K]) => any;
 type EventListenerOrEventListenerObject$1<K extends keyof HTMLElementEventMap> = EventListener<K>;
 declare function addEventListener<K extends keyof HTMLElementEventMap>(element: HTMLElement, type: K, listener: EventListenerOrEventListenerObject$1<K>, useCapture?: boolean): Disposable;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 declare class Logger {
     isDevEnv(): boolean;
     info(...props: any): void;
@@ -1204,11 +1357,19 @@ declare class Logger {
 }
 declare const logger: Logger;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 declare function createStyleElement(styleId: string, container?: HTMLElement): HTMLStyleElement;
 declare const DecorationStyle: {
     createStyleElement: typeof createStyleElement;
 };
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 declare function useRefresh(defaultValue?: any): (v?: any) => void;
 
-export { Angle, type AsClass, type CSSStyle, Cache, type CacheManager, type CacheOpts, type CacheOriginItem, CancellationToken, CancellationTokenSource, Circle, Compare, ContributionProvider, CropSchemaDecoration, DEG_TO_RAD, type DOMCache, DecorationStyle, Deferred, Disposable, DisposableCollection, DisposableImpl, Emitter, Event, type EventListener$1 as EventListener, type FlipSchema, FlipSchemaDecoration, type IPoint, type ISize, type LocalId, type MarginSchema, Matrix, type MaybeArray, type MaybePromise, MutableToken, NOOP, OBBRect, type OpacitySchema, OpacitySchemaDecoration, type OriginSchema, OriginSchemaDecoration, PI, PI_2, PaddingSchema, PaddingSchemaDecoration, Point, type PositionSchema, PositionSchemaDecoration, PromiseDeferred, PromisePool, type PromisePoolOpts, type PromiseTask, RAD_TO_DEG, Rectangle, RectangleAlignTitle, RectangleAlignType, type RecursivePartial, RequestCache, type RotationSchema, RotationSchemaDecoration, SHAPES, type ScaleSchema, ScaleSchemaDecoration, Schema, SchemaDecoration, type SchemaType, type ScrollSchema, type ShadowSchema, ShadowSchemaDecoration, type ShortCache, SizeSchema, SizeSchemaDecoration, type SkewSchema, SkewSchemaDecoration, TintSchema, TintSchemaDecoration, Transform, TransformSchema, TransformSchemaDecoration, type WeakCache, _setIdx, addEventListener, arrayToSet, arrayUnion, bindContributionProvider, bindContributions, cancelled, checkCancelled, clearRequestCache, compose, composeAsync, deepFreeze, delay, domUtils, each, filter, generateLocalId, getByKey, getTag, isCancelled, isEmpty, isFunction, isNumber, isObject, isPlainObject, isString, iterToArray, logger, mapKeys, mapValues, notEmpty, omit, pick, reduce, requestWithMemo, retry, setByKey, useRefresh, values };
+export { Angle, type AsClass, type CSSStyle, Cache, type CacheManager, type CacheOpts, type CacheOriginItem, CancellationToken, CancellationTokenSource, Circle, Compare, ContributionProvider, CropSchemaDecoration, DEG_TO_RAD, type DOMCache, DecorationStyle, Deferred, Disposable, DisposableCollection, DisposableImpl, Emitter, Event, type EventListener$1 as EventListener, type FlipSchema, FlipSchemaDecoration, type IPoint, type ISize, type LocalId, type MarginSchema, Matrix, type MaybeArray, type MaybePromise, MutableToken, NOOP, OBBRect, type OpacitySchema, OpacitySchemaDecoration, type OriginSchema, OriginSchemaDecoration, PI, PI_2, PaddingSchema, PaddingSchemaDecoration, Point, type PositionSchema, PositionSchemaDecoration, PromiseDeferred, PromisePool, type PromisePoolOpts, type PromiseTask, RAD_TO_DEG, Rectangle, RectangleAlignTitle, RectangleAlignType, type RecursivePartial, RequestCache, type RotationSchema, RotationSchemaDecoration, SHAPES, type ScaleSchema, ScaleSchemaDecoration, Schema, SchemaDecoration, type SchemaType, type ScrollSchema, type ShadowSchema, ShadowSchemaDecoration, type ShortCache, SizeSchema, SizeSchemaDecoration, type SkewSchema, SkewSchemaDecoration, TintSchema, TintSchemaDecoration, Transform, TransformSchema, TransformSchemaDecoration, type WeakCache, type Xor, _setIdx, addEventListener, arrayToSet, arrayUnion, bindContributionProvider, bindContributions, cancelled, checkCancelled, clearRequestCache, compose, composeAsync, deepFreeze, delay, domUtils, each, filter, generateLocalId, getByKey, getTag, isCancelled, isEmpty, isFunction, isNumber, isObject, isPlainObject, isString, iterToArray, logger, mapKeys, mapValues, notEmpty, omit, pick, reduce, requestWithMemo, retry, safeKey, setByKey, useRefresh, values };