openfig-core 0.3.2 → 0.3.5

package/dist/index.d.cts

@@ -2,17 +2,97 @@ interface FigGuid {
     sessionID: number;
     localID: number;
 }
+interface FigColor {
+    r: number;
+    g: number;
+    b: number;
+    a: number;
+}
+interface FigVector {
+    x: number;
+    y: number;
+}
+interface FigTransform {
+    m00: number;
+    m01: number;
+    m02: number;
+    m10: number;
+    m11: number;
+    m12: number;
+}
+interface FigGradientStop {
+    color: FigColor;
+    position: number;
+    colorVar?: any;
+}
 interface FigPaint {
     type: string;
-    color?: {
-        r: number;
-        g: number;
-        b: number;
-        a: number;
-    };
+    color?: FigColor;
     opacity?: number;
     visible?: boolean;
+    blendMode?: string;
+    stops?: FigGradientStop[];
+    stopsVar?: FigGradientStop[];
+    transform?: FigTransform;
+    image?: {
+        hash?: Uint8Array | string;
+        [key: string]: any;
+    };
+    imageThumbnail?: {
+        hash?: Uint8Array | string;
+        [key: string]: any;
+    };
 }
+/**
+ * EffectType enum values from the Kiwi schema.
+ *
+ * | Value | Name              |
+ * |-------|-------------------|
+ * | 0     | INNER_SHADOW      |
+ * | 1     | DROP_SHADOW       |
+ * | 2     | FOREGROUND_BLUR   |
+ * | 3     | BACKGROUND_BLUR   |
+ * | 4     | REPEAT            |
+ * | 5     | SYMMETRY          |
+ * | 6     | GRAIN             |
+ * | 7     | NOISE             |
+ * | 8     | GLASS             |
+ */
+type FigEffectType = "INNER_SHADOW" | "DROP_SHADOW" | "FOREGROUND_BLUR" | "BACKGROUND_BLUR" | "REPEAT" | "SYMMETRY" | "GRAIN" | "NOISE" | "GLASS";
+/**
+ * An effect applied to a node (shadow, blur, etc.).
+ * Maps to the Effect message in the Kiwi schema (42 fields).
+ * Only the most commonly used fields are typed here; the rest
+ * pass through via the catch-all index signature.
+ */
+interface FigEffect {
+    type: FigEffectType;
+    color?: FigColor;
+    offset?: FigVector;
+    /** Blur radius. */
+    radius?: number;
+    /** Spread distance (shadows only). */
+    spread?: number;
+    visible?: boolean;
+    blendMode?: string;
+    /** When true the shadow renders behind the node (not clipped by it). */
+    showShadowBehindNode?: boolean;
+    /** Effect-level opacity (separate from color.a). */
+    opacity?: number;
+    /** Allow additional/future fields from the kiwi schema. */
+    [key: string]: any;
+}
+/** StrokeAlign enum: CENTER (0), INSIDE (1), OUTSIDE (2). */
+type FigStrokeAlign = "CENTER" | "INSIDE" | "OUTSIDE";
+/** StackMode enum: NONE (0), HORIZONTAL (1), VERTICAL (2), GRID (3). */
+type FigStackMode = "NONE" | "HORIZONTAL" | "VERTICAL" | "GRID";
+interface FigFontName {
+    family?: string;
+    style?: string;
+    postScriptName?: string;
+}
+/** TextAlignHorizontal: LEFT (0), CENTER (1), RIGHT (2), JUSTIFIED (3). */
+type FigTextAlign = "LEFT" | "CENTER" | "RIGHT" | "JUSTIFIED";
 interface FigNode {
     guid: FigGuid;
     type: string;
@@ -22,28 +102,34 @@ interface FigNode {
         guid: FigGuid;
         position: string;
     };
-    size?: {
-        x: number;
-        y: number;
-    };
-    transform?: {
-        m00: number;
-        m01: number;
-        m02: number;
-        m10: number;
-        m11: number;
-        m12: number;
-    };
+    size?: FigVector;
+    transform?: FigTransform;
     fillPaints?: FigPaint[];
     strokePaints?: FigPaint[];
     strokeWeight?: number;
+    strokeAlign?: FigStrokeAlign;
     cornerRadius?: number;
+    opacity?: number;
+    effects?: FigEffect[];
     textData?: {
         characters: string;
+        lines?: any[];
     };
     fontSize?: number;
-    opacity?: number;
+    fontName?: FigFontName;
+    textAlignHorizontal?: FigTextAlign;
+    paragraphSpacing?: number;
+    derivedTextData?: any;
     shapeWithTextType?: string;
+    /** True for group-like frames (Figma encodes groups as FRAME + resizeToFit). */
+    resizeToFit?: boolean;
+    /** Frame clips children when frameMaskDisabled is false (default). */
+    frameMaskDisabled?: boolean;
+    /** Auto-layout mode: HORIZONTAL, VERTICAL, GRID, or absent. */
+    stackMode?: FigStackMode;
+    stackPrimarySizing?: string;
+    stackCounterSizing?: string;
+    /** Allow additional fields from the kiwi schema. */
     [key: string]: any;
 }
 interface FigDocument {
@@ -166,4 +252,140 @@ declare function createEmptyFigDoc(): FigDocument;
  */
 declare function nodeId(node: FigNode): string | null;
 
-export { type AssembleCanvasFigInput, type CreateFigZipInput, type EncodedFigParts, type FigDocument, type FigGuid, type FigNode, type FigPaint, assembleCanvasFig, createEmptyFigDoc, createFigZip, encodeFigParts, nodeId, parseFig, parseFigBinary };
+type GradientKind = "linear" | "radial";
+interface GradientFillLike {
+    type: GradientKind;
+    transform: FigTransform;
+}
+interface RenderableGradientFill extends GradientFillLike {
+    opacity: number;
+    stops: FigGradientStop[];
+}
+interface GradientPoint {
+    x: number;
+    y: number;
+}
+interface ResolvedLinearGradientGeometry {
+    type: "linear";
+    start: GradientPoint;
+    end: GradientPoint;
+}
+interface ResolvedRadialGradientGeometry {
+    type: "radial";
+    center: GradientPoint;
+    radiusX: number;
+    radiusY: number;
+    angle: number;
+}
+type ResolvedGradientGeometry = ResolvedLinearGradientGeometry | ResolvedRadialGradientGeometry;
+declare function extractRenderableGradientFill(paints: FigPaint[] | null | undefined): RenderableGradientFill | null;
+declare function resolveGradientGeometry(fill: GradientFillLike, width: number, height: number): ResolvedGradientGeometry | null;
+
+type GeometryRef = {
+    commandsBlob?: number;
+    windingRule?: string;
+    styleID?: number;
+};
+interface ResolvedGeometryPath {
+    blobIndex: number;
+    commandsBlob: Uint8Array;
+    svgPath: string;
+    windingRule?: string;
+    styleID: number;
+    paints?: FigPaint[];
+}
+interface ResolvedVectorNodePaths {
+    fill: ResolvedGeometryPath[];
+    stroke: ResolvedGeometryPath[];
+}
+type VectorPathCommand = {
+    type: "M";
+    x: number;
+    y: number;
+} | {
+    type: "L";
+    x: number;
+    y: number;
+} | {
+    type: "C";
+    c1x: number;
+    c1y: number;
+    c2x: number;
+    c2y: number;
+    x: number;
+    y: number;
+} | {
+    type: "Z";
+};
+interface VectorGeometryInput {
+    svgPath?: string;
+    commands?: readonly VectorPathCommand[];
+    windingRule?: string;
+    styleID?: number;
+}
+interface VectorStyleOverride {
+    styleID: number;
+    fillPaints?: FigPaint[];
+    [key: string]: any;
+}
+interface AppendVectorPayloadInput {
+    width: number;
+    height: number;
+    normalizedWidth?: number;
+    normalizedHeight?: number;
+    fillPaths?: readonly VectorGeometryInput[];
+    /**
+     * Stroke geometry is expected to already be expanded into outline paths.
+     * This helper does not expand SVG strokes into strokeGeometry.
+     */
+    strokePaths?: readonly VectorGeometryInput[];
+    styleOverrideTable?: readonly VectorStyleOverride[];
+}
+interface AuthoredVectorPayload {
+    fillGeometry: GeometryRef[];
+    strokeGeometry: GeometryRef[];
+    vectorData: {
+        vectorNetworkBlob: number;
+        normalizedSize: {
+            x: number;
+            y: number;
+        };
+        styleOverrideTable?: VectorStyleOverride[];
+    };
+}
+declare function getBlobBytes(doc: FigDocument, blobIndex: number | null | undefined): Uint8Array | null;
+declare function geometryBlobToSVGPath(blob: Uint8Array): string;
+declare function parseSVGPathData(svgPath: string): VectorPathCommand[];
+declare function encodeCommandsBlob(commands: readonly VectorPathCommand[], scaleX?: number, scaleY?: number): Uint8Array;
+declare function encodeVectorNetworkBlob(pathCommandsList: readonly (readonly VectorPathCommand[])[]): Uint8Array;
+declare function appendVectorPayloadToDocument(doc: FigDocument, input: AppendVectorPayloadInput): AuthoredVectorPayload;
+declare function resolveVectorNodePaths(doc: FigDocument, node: FigNode): ResolvedVectorNodePaths;
+
+/**
+ * CSS / hex color ↔ Figma normalized RGBA color helpers.
+ *
+ * All functions are isomorphic (no DOM required).
+ * For named CSS colors (e.g. "coral"), pass an optional `resolveNamed`
+ * callback that uses the browser's computed-style machinery.
+ */
+
+declare function hexToFigColor(hex: string): FigColor;
+declare function parseCssRgbColor(value: string): FigColor | null;
+declare function cssColorToFigColor(value: string, resolveNamed?: (name: string) => FigColor | null): FigColor;
+declare function makeSolidPaint(fill: string, resolveNamed?: (name: string) => FigColor | null): FigPaint;
+
+/**
+ * SVG path serialization, transformation, and stroke/cap enum mapping.
+ */
+
+declare function serializeSvgPathData(commands: readonly VectorPathCommand[]): string;
+declare function transformSvgPathData(svgPath: string, { scaleX, scaleY, translateX, translateY, }: {
+    scaleX?: number;
+    scaleY?: number;
+    translateX?: number;
+    translateY?: number;
+}): string;
+declare function mapStrokeJoin(value: string | undefined): string;
+declare function mapStrokeCap(value: string | undefined): string;
+
+export { type AppendVectorPayloadInput, type AssembleCanvasFigInput, type AuthoredVectorPayload, type CreateFigZipInput, type EncodedFigParts, type FigColor, type FigDocument, type FigGradientStop, type FigGuid, type FigNode, type FigPaint, type FigTransform, type GradientFillLike, type GradientKind, type GradientPoint, type RenderableGradientFill, type ResolvedGeometryPath, type ResolvedGradientGeometry, type ResolvedLinearGradientGeometry, type ResolvedRadialGradientGeometry, type ResolvedVectorNodePaths, type VectorGeometryInput, type VectorPathCommand, type VectorStyleOverride, appendVectorPayloadToDocument, assembleCanvasFig, createEmptyFigDoc, createFigZip, cssColorToFigColor, encodeCommandsBlob, encodeFigParts, encodeVectorNetworkBlob, extractRenderableGradientFill, geometryBlobToSVGPath, getBlobBytes, hexToFigColor, makeSolidPaint, mapStrokeCap, mapStrokeJoin, nodeId, parseCssRgbColor, parseFig, parseFigBinary, parseSVGPathData, resolveGradientGeometry, resolveVectorNodePaths, serializeSvgPathData, transformSvgPathData };

package/dist/index.d.ts

@@ -2,17 +2,97 @@ interface FigGuid {
     sessionID: number;
     localID: number;
 }
+interface FigColor {
+    r: number;
+    g: number;
+    b: number;
+    a: number;
+}
+interface FigVector {
+    x: number;
+    y: number;
+}
+interface FigTransform {
+    m00: number;
+    m01: number;
+    m02: number;
+    m10: number;
+    m11: number;
+    m12: number;
+}
+interface FigGradientStop {
+    color: FigColor;
+    position: number;
+    colorVar?: any;
+}
 interface FigPaint {
     type: string;
-    color?: {
-        r: number;
-        g: number;
-        b: number;
-        a: number;
-    };
+    color?: FigColor;
     opacity?: number;
     visible?: boolean;
+    blendMode?: string;
+    stops?: FigGradientStop[];
+    stopsVar?: FigGradientStop[];
+    transform?: FigTransform;
+    image?: {
+        hash?: Uint8Array | string;
+        [key: string]: any;
+    };
+    imageThumbnail?: {
+        hash?: Uint8Array | string;
+        [key: string]: any;
+    };
 }
+/**
+ * EffectType enum values from the Kiwi schema.
+ *
+ * | Value | Name              |
+ * |-------|-------------------|
+ * | 0     | INNER_SHADOW      |
+ * | 1     | DROP_SHADOW       |
+ * | 2     | FOREGROUND_BLUR   |
+ * | 3     | BACKGROUND_BLUR   |
+ * | 4     | REPEAT            |
+ * | 5     | SYMMETRY          |
+ * | 6     | GRAIN             |
+ * | 7     | NOISE             |
+ * | 8     | GLASS             |
+ */
+type FigEffectType = "INNER_SHADOW" | "DROP_SHADOW" | "FOREGROUND_BLUR" | "BACKGROUND_BLUR" | "REPEAT" | "SYMMETRY" | "GRAIN" | "NOISE" | "GLASS";
+/**
+ * An effect applied to a node (shadow, blur, etc.).
+ * Maps to the Effect message in the Kiwi schema (42 fields).
+ * Only the most commonly used fields are typed here; the rest
+ * pass through via the catch-all index signature.
+ */
+interface FigEffect {
+    type: FigEffectType;
+    color?: FigColor;
+    offset?: FigVector;
+    /** Blur radius. */
+    radius?: number;
+    /** Spread distance (shadows only). */
+    spread?: number;
+    visible?: boolean;
+    blendMode?: string;
+    /** When true the shadow renders behind the node (not clipped by it). */
+    showShadowBehindNode?: boolean;
+    /** Effect-level opacity (separate from color.a). */
+    opacity?: number;
+    /** Allow additional/future fields from the kiwi schema. */
+    [key: string]: any;
+}
+/** StrokeAlign enum: CENTER (0), INSIDE (1), OUTSIDE (2). */
+type FigStrokeAlign = "CENTER" | "INSIDE" | "OUTSIDE";
+/** StackMode enum: NONE (0), HORIZONTAL (1), VERTICAL (2), GRID (3). */
+type FigStackMode = "NONE" | "HORIZONTAL" | "VERTICAL" | "GRID";
+interface FigFontName {
+    family?: string;
+    style?: string;
+    postScriptName?: string;
+}
+/** TextAlignHorizontal: LEFT (0), CENTER (1), RIGHT (2), JUSTIFIED (3). */
+type FigTextAlign = "LEFT" | "CENTER" | "RIGHT" | "JUSTIFIED";
 interface FigNode {
     guid: FigGuid;
     type: string;
@@ -22,28 +102,34 @@ interface FigNode {
         guid: FigGuid;
         position: string;
     };
-    size?: {
-        x: number;
-        y: number;
-    };
-    transform?: {
-        m00: number;
-        m01: number;
-        m02: number;
-        m10: number;
-        m11: number;
-        m12: number;
-    };
+    size?: FigVector;
+    transform?: FigTransform;
     fillPaints?: FigPaint[];
     strokePaints?: FigPaint[];
     strokeWeight?: number;
+    strokeAlign?: FigStrokeAlign;
     cornerRadius?: number;
+    opacity?: number;
+    effects?: FigEffect[];
     textData?: {
         characters: string;
+        lines?: any[];
     };
     fontSize?: number;
-    opacity?: number;
+    fontName?: FigFontName;
+    textAlignHorizontal?: FigTextAlign;
+    paragraphSpacing?: number;
+    derivedTextData?: any;
     shapeWithTextType?: string;
+    /** True for group-like frames (Figma encodes groups as FRAME + resizeToFit). */
+    resizeToFit?: boolean;
+    /** Frame clips children when frameMaskDisabled is false (default). */
+    frameMaskDisabled?: boolean;
+    /** Auto-layout mode: HORIZONTAL, VERTICAL, GRID, or absent. */
+    stackMode?: FigStackMode;
+    stackPrimarySizing?: string;
+    stackCounterSizing?: string;
+    /** Allow additional fields from the kiwi schema. */
     [key: string]: any;
 }
 interface FigDocument {
@@ -166,4 +252,140 @@ declare function createEmptyFigDoc(): FigDocument;
  */
 declare function nodeId(node: FigNode): string | null;
 
-export { type AssembleCanvasFigInput, type CreateFigZipInput, type EncodedFigParts, type FigDocument, type FigGuid, type FigNode, type FigPaint, assembleCanvasFig, createEmptyFigDoc, createFigZip, encodeFigParts, nodeId, parseFig, parseFigBinary };
+type GradientKind = "linear" | "radial";
+interface GradientFillLike {
+    type: GradientKind;
+    transform: FigTransform;
+}
+interface RenderableGradientFill extends GradientFillLike {
+    opacity: number;
+    stops: FigGradientStop[];
+}
+interface GradientPoint {
+    x: number;
+    y: number;
+}
+interface ResolvedLinearGradientGeometry {
+    type: "linear";
+    start: GradientPoint;
+    end: GradientPoint;
+}
+interface ResolvedRadialGradientGeometry {
+    type: "radial";
+    center: GradientPoint;
+    radiusX: number;
+    radiusY: number;
+    angle: number;
+}
+type ResolvedGradientGeometry = ResolvedLinearGradientGeometry | ResolvedRadialGradientGeometry;
+declare function extractRenderableGradientFill(paints: FigPaint[] | null | undefined): RenderableGradientFill | null;
+declare function resolveGradientGeometry(fill: GradientFillLike, width: number, height: number): ResolvedGradientGeometry | null;
+
+type GeometryRef = {
+    commandsBlob?: number;
+    windingRule?: string;
+    styleID?: number;
+};
+interface ResolvedGeometryPath {
+    blobIndex: number;
+    commandsBlob: Uint8Array;
+    svgPath: string;
+    windingRule?: string;
+    styleID: number;
+    paints?: FigPaint[];
+}
+interface ResolvedVectorNodePaths {
+    fill: ResolvedGeometryPath[];
+    stroke: ResolvedGeometryPath[];
+}
+type VectorPathCommand = {
+    type: "M";
+    x: number;
+    y: number;
+} | {
+    type: "L";
+    x: number;
+    y: number;
+} | {
+    type: "C";
+    c1x: number;
+    c1y: number;
+    c2x: number;
+    c2y: number;
+    x: number;
+    y: number;
+} | {
+    type: "Z";
+};
+interface VectorGeometryInput {
+    svgPath?: string;
+    commands?: readonly VectorPathCommand[];
+    windingRule?: string;
+    styleID?: number;
+}
+interface VectorStyleOverride {
+    styleID: number;
+    fillPaints?: FigPaint[];
+    [key: string]: any;
+}
+interface AppendVectorPayloadInput {
+    width: number;
+    height: number;
+    normalizedWidth?: number;
+    normalizedHeight?: number;
+    fillPaths?: readonly VectorGeometryInput[];
+    /**
+     * Stroke geometry is expected to already be expanded into outline paths.
+     * This helper does not expand SVG strokes into strokeGeometry.
+     */
+    strokePaths?: readonly VectorGeometryInput[];
+    styleOverrideTable?: readonly VectorStyleOverride[];
+}
+interface AuthoredVectorPayload {
+    fillGeometry: GeometryRef[];
+    strokeGeometry: GeometryRef[];
+    vectorData: {
+        vectorNetworkBlob: number;
+        normalizedSize: {
+            x: number;
+            y: number;
+        };
+        styleOverrideTable?: VectorStyleOverride[];
+    };
+}
+declare function getBlobBytes(doc: FigDocument, blobIndex: number | null | undefined): Uint8Array | null;
+declare function geometryBlobToSVGPath(blob: Uint8Array): string;
+declare function parseSVGPathData(svgPath: string): VectorPathCommand[];
+declare function encodeCommandsBlob(commands: readonly VectorPathCommand[], scaleX?: number, scaleY?: number): Uint8Array;
+declare function encodeVectorNetworkBlob(pathCommandsList: readonly (readonly VectorPathCommand[])[]): Uint8Array;
+declare function appendVectorPayloadToDocument(doc: FigDocument, input: AppendVectorPayloadInput): AuthoredVectorPayload;
+declare function resolveVectorNodePaths(doc: FigDocument, node: FigNode): ResolvedVectorNodePaths;
+
+/**
+ * CSS / hex color ↔ Figma normalized RGBA color helpers.
+ *
+ * All functions are isomorphic (no DOM required).
+ * For named CSS colors (e.g. "coral"), pass an optional `resolveNamed`
+ * callback that uses the browser's computed-style machinery.
+ */
+
+declare function hexToFigColor(hex: string): FigColor;
+declare function parseCssRgbColor(value: string): FigColor | null;
+declare function cssColorToFigColor(value: string, resolveNamed?: (name: string) => FigColor | null): FigColor;
+declare function makeSolidPaint(fill: string, resolveNamed?: (name: string) => FigColor | null): FigPaint;
+
+/**
+ * SVG path serialization, transformation, and stroke/cap enum mapping.
+ */
+
+declare function serializeSvgPathData(commands: readonly VectorPathCommand[]): string;
+declare function transformSvgPathData(svgPath: string, { scaleX, scaleY, translateX, translateY, }: {
+    scaleX?: number;
+    scaleY?: number;
+    translateX?: number;
+    translateY?: number;
+}): string;
+declare function mapStrokeJoin(value: string | undefined): string;
+declare function mapStrokeCap(value: string | undefined): string;
+
+export { type AppendVectorPayloadInput, type AssembleCanvasFigInput, type AuthoredVectorPayload, type CreateFigZipInput, type EncodedFigParts, type FigColor, type FigDocument, type FigGradientStop, type FigGuid, type FigNode, type FigPaint, type FigTransform, type GradientFillLike, type GradientKind, type GradientPoint, type RenderableGradientFill, type ResolvedGeometryPath, type ResolvedGradientGeometry, type ResolvedLinearGradientGeometry, type ResolvedRadialGradientGeometry, type ResolvedVectorNodePaths, type VectorGeometryInput, type VectorPathCommand, type VectorStyleOverride, appendVectorPayloadToDocument, assembleCanvasFig, createEmptyFigDoc, createFigZip, cssColorToFigColor, encodeCommandsBlob, encodeFigParts, encodeVectorNetworkBlob, extractRenderableGradientFill, geometryBlobToSVGPath, getBlobBytes, hexToFigColor, makeSolidPaint, mapStrokeCap, mapStrokeJoin, nodeId, parseCssRgbColor, parseFig, parseFigBinary, parseSVGPathData, resolveGradientGeometry, resolveVectorNodePaths, serializeSvgPathData, transformSvgPathData };