modern-idoc 0.2.13 → 0.3.0

package/dist/index.d.mts

@@ -1,21 +1,42 @@
 type None = 'none';
 
-type AudioSource = string;
-interface AudioDeclaration {
-    src: AudioSource;
+interface GradientFillDeclaration {
+    type: 'gradient';
+    opacity?: number;
+}
+
+interface SolidFillDeclaration {
+    type: 'solid';
+    color: string;
+    opacity?: number;
 }
-type AudioProp = None | AudioSource | AudioDeclaration;
 
-interface ImageFillStretchRect {
+/**
+ * 0    -0.5   0
+ * -0.5        -0.5
+ * 0    -0.5   0
+ */
+interface TextureFillSourceRect {
     left?: number;
     top?: number;
     bottom?: number;
     right?: number;
 }
-interface ImageFillStretch {
-    rect?: ImageFillStretchRect;
+/**
+ * 0    0.5   0
+ * 0.5        0.5
+ * 0    0.5   0
+ */
+interface TextureFillStretchRect {
+    left?: number;
+    top?: number;
+    bottom?: number;
+    right?: number;
+}
+interface TextureFillStretch {
+    rect?: TextureFillStretchRect;
 }
-interface ImageFillTile {
+interface TextureFillTile {
     alignment?: string;
     scaleX?: number;
     scaleY?: number;
@@ -23,30 +44,38 @@ interface ImageFillTile {
     translateY?: number;
     flip?: string;
 }
-interface CommonFillDeclaration {
-    opacity?: number;
-}
-type ImageFillSource = string;
-interface ImageFillDeclaration extends CommonFillDeclaration {
-    type: 'image';
-    image: ImageFillSource;
+type TextureFillSourceURL = string;
+interface TextureFillDeclaration {
+    type: 'texture';
+    src: TextureFillSourceURL;
+    srcRect?: TextureFillSourceRect;
     dpi?: number;
     rotateWithShape?: boolean;
-    stretch?: ImageFillStretch;
-    tile?: ImageFillTile;
+    stretch?: TextureFillStretch;
+    tile?: TextureFillTile;
+    opacity?: number;
 }
-interface ColorFillDeclaration extends CommonFillDeclaration {
-    type: 'color';
-    color: string;
+
+type SingleFillDeclaration = TextureFillDeclaration | SolidFillDeclaration | GradientFillDeclaration;
+type FillDeclaration = SingleFillDeclaration[];
+type FillProperty = None | string | SingleFillDeclaration | FillDeclaration;
+declare function normalizeFill(fill?: FillProperty): FillDeclaration | undefined;
+
+type TextureBackgroundSourceURL = TextureFillSourceURL;
+type TextureBackgroundDeclaration = TextureFillDeclaration;
+interface AudioBackgroundDeclaration {
+    type: 'audio';
+    src: string;
 }
-type FillDeclaration = ImageFillDeclaration | ColorFillDeclaration;
-type FillProp = None | string | FillDeclaration;
+type SingleBackgroundDeclaration = AudioBackgroundDeclaration | TextureBackgroundDeclaration;
+type BackgroundDeclaration = SingleBackgroundDeclaration[];
+type BackgroundProperty = None | TextureBackgroundSourceURL | SingleBackgroundDeclaration | BackgroundDeclaration;
 
 type SVGPathData = string;
 type FillRule = 'nonzero' | 'evenodd';
 type StrokeLinecap = 'butt' | 'round' | 'square';
 type StrokeLinejoin = 'arcs' | 'bevel' | 'miter' | 'miter-clip' | 'round';
-interface Path2DStyle {
+interface GeometryPathStyle {
     [key: string]: any;
     opacity: number;
     visibility: string;
@@ -66,41 +95,28 @@ interface Path2DStyle {
     strokeDasharray: number[];
     strokeDashoffset: number;
 }
-interface Path2DDeclaration extends Partial<Path2DStyle> {
+interface GeometryPathDeclaration extends Partial<GeometryPathStyle> {
     data: SVGPathData;
 }
 interface GeometryDeclaration {
     name?: string;
     svg?: string;
     viewBox?: number[];
-    data?: Path2DDeclaration[];
+    paths?: GeometryPathDeclaration[];
 }
-type GeometryProp = None | SVGPathData | SVGPathData[] | Path2DDeclaration[] | GeometryDeclaration;
+type GeometryProperty = None | SVGPathData | SVGPathData[] | GeometryPathDeclaration[] | GeometryDeclaration;
+declare function normalizeGeometry(geometry?: GeometryProperty): GeometryDeclaration | undefined;
 
-interface MetaProp {
+interface MetaProperty {
     [key: string]: any;
 }
 
 interface IDOCNode {
     name?: string;
     children?: IDOCNode[];
-    meta?: MetaProp;
+    meta?: MetaProperty;
 }
 
-type ImageSource = string;
-interface ImageSourceRect {
-    left?: number;
-    top?: number;
-    bottom?: number;
-    right?: number;
-}
-interface ImageDeclaration {
-    src: ImageSource;
-    srcRect?: ImageSourceRect;
-    opacity?: number;
-}
-type ImageProp = None | ImageSource | ImageDeclaration;
-
 interface OutlineDeclaration {
     width?: number;
     style?: 'dashed' | 'solid' | string;
@@ -108,7 +124,8 @@ interface OutlineDeclaration {
     color?: string;
     opacity?: number;
 }
-type OutlineProp = None | string | Partial<OutlineDeclaration>;
+type OutlineProperty = None | string | Partial<OutlineDeclaration>;
+declare function normalizeOutline(outline?: OutlineProperty): OutlineDeclaration | undefined;
 
 type BoxShadow = None | string;
 interface ShadowDeclaration {
@@ -117,7 +134,7 @@ interface ShadowDeclaration {
     offsetY?: number;
     blur?: number;
 }
-type ShadowProp = None | BoxShadow | ShadowDeclaration;
+type ShadowProperty = None | BoxShadow | ShadowDeclaration;
 interface ShadowStyleDeclaration {
     boxShadow: BoxShadow;
     shadowColor?: string;
@@ -125,6 +142,8 @@ interface ShadowStyleDeclaration {
     shadowOffsetY?: number;
     shadowBlur?: number;
 }
+declare function getDefaultShadowStyle(): ShadowStyleDeclaration;
+declare function normalizeShadow(shadow?: ShadowProperty): ShadowDeclaration | undefined;
 
 type StyleUnit = `${number}%` | number;
 type Display = 'flex' | 'contents';
@@ -205,6 +224,7 @@ interface LayoutStyleDeclaration {
     paddingBottom?: StyleUnit;
     padding?: StyleUnit;
 }
+declare function getDefaultLayoutStyle(): LayoutStyleDeclaration;
 
 interface TransformStyleDeclaration {
     rotate: number;
@@ -217,6 +237,7 @@ interface TransformStyleDeclaration {
     transform: None | string;
     transformOrigin: string;
 }
+declare function getDefaultTransformStyle(): TransformStyleDeclaration;
 
 interface ElementStyleDeclaration extends LayoutStyleDeclaration, TransformStyleDeclaration, ShadowStyleDeclaration {
     backgroundImage?: None | string;
@@ -234,6 +255,7 @@ interface ElementStyleDeclaration extends LayoutStyleDeclaration, TransformStyle
     pointerEvents: PointerEvents;
     maskImage: None | string;
 }
+declare function getDefaultElementStyle(): ElementStyleDeclaration;
 
 interface HighlightDeclaration {
     image: HighlightImage;
@@ -252,6 +274,7 @@ interface HighlightStyleDeclaration {
     highlightSize: HighlightSize;
     highlightThickness: HighlightThickness;
 }
+declare function getDefaultHighlightStyle(): HighlightStyleDeclaration;
 
 interface ListStyleDeclaration {
     type: ListStyleType;
@@ -268,6 +291,7 @@ interface ListStyleStyleDeclaration {
     listStyleSize: ListStyleSize;
     listStylePosition: ListStylePosition;
 }
+declare function getDefaultListStyleStyle(): ListStyleStyleDeclaration;
 
 interface TextInlineStyleDeclaration extends HighlightStyleDeclaration {
     color: string;
@@ -283,6 +307,7 @@ interface TextInlineStyleDeclaration extends HighlightStyleDeclaration {
     textOrientation: TextOrientation;
     textDecoration: TextDecoration;
 }
+declare function getDefaultTextInlineStyle(): TextInlineStyleDeclaration;
 
 interface TextLineStyleDeclaration extends ListStyleStyleDeclaration {
     writingMode: WritingMode;
@@ -291,6 +316,7 @@ interface TextLineStyleDeclaration extends ListStyleStyleDeclaration {
     textIndent: number;
     lineHeight: number;
 }
+declare function getDefaultTextLineStyle(): TextLineStyleDeclaration;
 
 interface TextDrawStyleDeclaration {
     textStrokeWidth: number;
@@ -298,10 +324,12 @@ interface TextDrawStyleDeclaration {
 }
 interface TextStyleDeclaration extends TextLineStyleDeclaration, TextInlineStyleDeclaration, TextDrawStyleDeclaration {
 }
+declare function getDefaultTextStyle(): TextStyleDeclaration;
 
 interface StyleDeclaration extends TextStyleDeclaration, ElementStyleDeclaration {
 }
-type StyleProp = Partial<StyleDeclaration>;
+type StyleProperty = Partial<StyleDeclaration>;
+declare function getDefaultStyle(): StyleDeclaration;
 
 interface FragmentContent extends Partial<StyleDeclaration> {
     content: string;
@@ -318,40 +346,32 @@ interface TextDeclaration {
     measureDom?: any;
     fonts?: any;
 }
-type TextProp = string | TextContent | (TextDeclaration & {
+type TextProperty = string | TextContent | (TextDeclaration & {
     content: TextContent;
 }) | TextDeclaration;
-
-type VideoSource = string;
-interface VideoDeclaration {
-    src: VideoSource;
-    opacity?: number;
-}
-type VideoProp = None | VideoSource | VideoDeclaration;
+declare function normalizeTextContent(content?: TextContent): TextContentDeclaration;
+declare function normalizeText(text?: TextProperty): TextDeclaration | undefined;
 
 interface IDOCElement extends IDOCNode {
-    style?: StyleProp;
-    image?: ImageProp;
-    video?: VideoProp;
-    audio?: AudioProp;
-    text?: TextProp;
-    geometry?: GeometryProp;
-    fill?: FillProp;
-    outline?: OutlineProp;
-    shadow?: ShadowProp;
+    style?: StyleProperty;
+    text?: TextProperty;
+    geometry?: GeometryProperty;
+    fill?: FillProperty;
+    outline?: OutlineProperty;
+    background?: BackgroundProperty;
+    shadow?: ShadowProperty;
     children?: IDOCElement[];
 }
 interface IDOCElementDeclaration extends IDOCElement {
-    image?: ImageDeclaration;
-    video?: VideoDeclaration;
-    audio?: AudioDeclaration;
     text?: TextDeclaration;
     geometry?: GeometryDeclaration;
     fill?: FillDeclaration;
     outline?: OutlineDeclaration;
+    background?: BackgroundDeclaration;
     shadow?: ShadowDeclaration;
     children?: IDOCElementDeclaration[];
 }
+declare function normalizeElement(element: IDOCElement): IDOCElementDeclaration;
 
 interface IDOCDocument extends IDOCElement {
     fonts?: any;
@@ -359,40 +379,8 @@ interface IDOCDocument extends IDOCElement {
 interface IDOCDocumentDeclaration extends IDOCElementDeclaration {
     fonts?: any;
 }
-
-declare function getDefaultElementStyle(): ElementStyleDeclaration;
-
-declare function getDefaultLayoutStyle(): LayoutStyleDeclaration;
-
-declare function getDefaultShadowStyle(): ShadowStyleDeclaration;
-
-declare function getDefaultStyle(): StyleDeclaration;
-
-declare function getDefaultTextStyle(): TextStyleDeclaration;
-
-declare function getDefaultTransformStyle(): TransformStyleDeclaration;
+declare function normalizeDocument(doc: IDOCDocument): IDOCDocumentDeclaration;
 
 declare function clearUndef<T>(obj: T, deep?: boolean): T;
-declare function deepClearUndef<T>(obj: T): T;
-
-declare function normalizeAudio(audio?: AudioProp): AudioDeclaration | undefined;
-
-declare function normalizeElement(element: IDOCElement): IDOCElementDeclaration;
-
-declare function normalizeFill(fill?: FillProp): FillDeclaration | undefined;
-
-declare function normalizeGeometry(geometry?: GeometryProp): GeometryDeclaration | undefined;
-
-declare function normalizeImage(image?: ImageProp): ImageDeclaration | undefined;
-
-declare function normalizeOutline(outline?: OutlineProp): OutlineDeclaration | undefined;
-
-declare function normalizeShadow(shadow?: ShadowProp): ShadowDeclaration | undefined;
-
-declare function normalizeText(text?: TextProp): TextDeclaration | undefined;
-
-declare function normalizeTextContent(content?: TextContent): TextContentDeclaration;
-
-declare function normalizeVideo(video?: VideoProp): VideoDeclaration | undefined;
 
-export { type Align, type AudioDeclaration, type AudioProp, type AudioSource, type BorderStyle, type BoxShadow, type BoxSizing, type ColorFillDeclaration, type CommonFillDeclaration, type Direction, type Display, type ElementStyleDeclaration, type FillDeclaration, type FillProp, type FillRule, type FlexDirection, type FlexWrap, type FontKerning, type FontStyle, type FontWeight, type FragmentContent, type GeometryDeclaration, type GeometryProp, type HighlightColormap, type HighlightDeclaration, type HighlightImage, type HighlightLine, type HighlightReferImage, type HighlightSize, type HighlightStyleDeclaration, type HighlightThickness, type IDOCDocument, type IDOCDocumentDeclaration, type IDOCElement, type IDOCElementDeclaration, type IDOCNode, type ImageDeclaration, type ImageFillDeclaration, type ImageFillSource, type ImageFillStretch, type ImageFillStretchRect, type ImageFillTile, type ImageProp, type ImageSource, type ImageSourceRect, type Justify, type LayoutStyleDeclaration, type ListStyleColormap, type ListStyleDeclaration, type ListStyleImage, type ListStylePosition, type ListStyleSize, type ListStyleStyleDeclaration, type ListStyleType, type MetaProp, type OutlineDeclaration, type OutlineProp, type Overflow, type ParagraphContent, type Path2DDeclaration, type Path2DStyle, type PointerEvents, type Position, type SVGPathData, type ShadowDeclaration, type ShadowProp, type ShadowStyleDeclaration, type StrokeLinecap, type StrokeLinejoin, type StyleDeclaration, type StyleProp, type StyleUnit, type TextAlign, type TextContent, type TextContentDeclaration, type TextContentFlat, type TextDeclaration, type TextDecoration, type TextDrawStyleDeclaration, type TextInlineStyleDeclaration, type TextLineStyleDeclaration, type TextOrientation, type TextProp, type TextStyleDeclaration, type TextTransform, type TextWrap, type TransformStyleDeclaration, type VerticalAlign, type VideoDeclaration, type VideoProp, type VideoSource, type Visibility, type WritingMode, clearUndef, deepClearUndef, getDefaultElementStyle, getDefaultLayoutStyle, getDefaultShadowStyle, getDefaultStyle, getDefaultTextStyle, getDefaultTransformStyle, normalizeAudio, normalizeElement, normalizeFill, normalizeGeometry, normalizeImage, normalizeOutline, normalizeShadow, normalizeText, normalizeTextContent, normalizeVideo };
+export { type Align, type BorderStyle, type BoxShadow, type BoxSizing, type Direction, type Display, type ElementStyleDeclaration, type FillDeclaration, type FillProperty, type FillRule, type FlexDirection, type FlexWrap, type FontKerning, type FontStyle, type FontWeight, type FragmentContent, type GeometryDeclaration, type GeometryPathDeclaration, type GeometryPathStyle, type GeometryProperty, type GradientFillDeclaration, type HighlightColormap, type HighlightDeclaration, type HighlightImage, type HighlightLine, type HighlightReferImage, type HighlightSize, type HighlightStyleDeclaration, type HighlightThickness, type IDOCDocument, type IDOCDocumentDeclaration, type IDOCElement, type IDOCElementDeclaration, type IDOCNode, type Justify, type LayoutStyleDeclaration, type ListStyleColormap, type ListStyleDeclaration, type ListStyleImage, type ListStylePosition, type ListStyleSize, type ListStyleStyleDeclaration, type ListStyleType, type MetaProperty, type None, type OutlineDeclaration, type OutlineProperty, type Overflow, type ParagraphContent, type PointerEvents, type Position, type SVGPathData, type ShadowDeclaration, type ShadowProperty, type ShadowStyleDeclaration, type SingleFillDeclaration, type SolidFillDeclaration, type StrokeLinecap, type StrokeLinejoin, type StyleDeclaration, type StyleProperty, type StyleUnit, type TextAlign, type TextContent, type TextContentDeclaration, type TextContentFlat, type TextDeclaration, type TextDecoration, type TextDrawStyleDeclaration, type TextInlineStyleDeclaration, type TextLineStyleDeclaration, type TextOrientation, type TextProperty, type TextStyleDeclaration, type TextTransform, type TextWrap, type TextureFillDeclaration, type TextureFillSourceRect, type TextureFillSourceURL, type TextureFillStretch, type TextureFillStretchRect, type TextureFillTile, type TransformStyleDeclaration, type VerticalAlign, type Visibility, type WritingMode, clearUndef, getDefaultElementStyle, getDefaultHighlightStyle, getDefaultLayoutStyle, getDefaultListStyleStyle, getDefaultShadowStyle, getDefaultStyle, getDefaultTextInlineStyle, getDefaultTextLineStyle, getDefaultTextStyle, getDefaultTransformStyle, normalizeDocument, normalizeElement, normalizeFill, normalizeGeometry, normalizeOutline, normalizeShadow, normalizeText, normalizeTextContent };