@compact-design/core 0.1.0

package/dist/lint.d.ts

@@ -0,0 +1,10 @@
+import type { InternalDocument } from "./types";
+export interface RepairIssue {
+    severity: "ERROR" | "WARNING" | "INFO";
+    code: string;
+    path: string;
+    message: string;
+    suggestion?: string;
+}
+export declare function lintDocument(document: InternalDocument): RepairIssue[];
+export declare function validationIssues(errors: string[]): RepairIssue[];

package/dist/normalize.d.ts

@@ -0,0 +1,4 @@
+import type { InternalDocument, InternalPatchDocument } from "./types";
+export declare function normalizeDocument(value: unknown): InternalDocument;
+export declare function isPatchDocument(value: unknown): boolean;
+export declare function normalizePatchDocument(value: unknown): InternalPatchDocument;

package/dist/parser.d.ts

@@ -0,0 +1 @@
+export declare function parseDocument(source: string): unknown;

package/dist/patch.d.ts

@@ -0,0 +1,6 @@
+import type { InternalDocument, InternalPatchDocument } from "./types";
+export interface PatchResult {
+    document: InternalDocument;
+    affectedIds: string[];
+}
+export declare function applyDocumentPatch(document: InternalDocument, patch: InternalPatchDocument): PatchResult;

package/dist/references.d.ts

@@ -0,0 +1,6 @@
+import type { InternalDocument, InternalNode } from "./types";
+export interface DocumentIndex {
+    nodes: ReadonlyMap<string, InternalNode>;
+    components: ReadonlyMap<string, InternalNode>;
+}
+export declare function indexDocument(document: InternalDocument): DocumentIndex;

package/dist/schema-validation.d.ts

@@ -0,0 +1,2 @@
+import type { RepairIssue } from "./lint";
+export declare function validateSchema(value: unknown): RepairIssue[];

package/dist/schema.d.ts

@@ -0,0 +1 @@
+export declare const schema: Readonly<Record<string, unknown>>;

package/dist/types.d.ts

@@ -0,0 +1,257 @@
+export type JsonObject = Record<string, unknown>;
+export type JsonPrimitive = string | number | boolean | null;
+export type JsonValue = JsonPrimitive | JsonObject | JsonValue[];
+export type Transform = [[number, number, number], [number, number, number]];
+export interface LineHeight {
+    unit: "AUTO" | "PIXELS" | "PERCENT";
+    value?: number;
+}
+export interface LetterSpacing {
+    unit: "PIXELS" | "PERCENT";
+    value: number;
+}
+export interface VectorPath {
+    windingRule: "NONZERO" | "EVENODD";
+    data: string;
+}
+export interface VariableAlias {
+    type: "VARIABLE_ALIAS";
+    id: string;
+}
+export interface Constraints {
+    horizontal: "MIN" | "CENTER" | "MAX" | "STRETCH" | "SCALE";
+    vertical: "MIN" | "CENTER" | "MAX" | "STRETCH" | "SCALE";
+}
+export type ComponentPropertyType = "BOOLEAN" | "TEXT" | "INSTANCE_SWAP" | "VARIANT";
+export interface ComponentPropertyOptions {
+    preferredValues?: Array<{
+        type: "COMPONENT" | "COMPONENT_SET";
+        key: string;
+    }>;
+}
+export type OverflowDirection = "NONE" | "HORIZONTAL" | "VERTICAL" | "BOTH";
+export type BlendMode = "PASS_THROUGH" | "NORMAL" | "DARKEN" | "MULTIPLY" | "LINEAR_BURN" | "COLOR_BURN" | "LIGHTEN" | "SCREEN" | "LINEAR_DODGE" | "COLOR_DODGE" | "OVERLAY" | "SOFT_LIGHT" | "HARD_LIGHT" | "DIFFERENCE" | "EXCLUSION" | "HUE" | "SATURATION" | "COLOR" | "LUMINOSITY";
+export type StrokeCap = "NONE" | "ROUND" | "SQUARE" | "LINE_ARROW" | "TRIANGLE_ARROW" | "DIAMOND_FILLED" | "CIRCLE_FILLED" | "TRIANGLE_FILLED" | "WASHI_TAPE_1" | "WASHI_TAPE_2" | "WASHI_TAPE_3" | "WASHI_TAPE_4" | "WASHI_TAPE_5" | "WASHI_TAPE_6";
+export type StrokeJoin = "MITER" | "BEVEL" | "ROUND";
+export type TextDecoration = "NONE" | "UNDERLINE" | "STRIKETHROUGH";
+export type TextCase = "ORIGINAL" | "UPPER" | "LOWER" | "TITLE" | "SMALL_CAPS" | "SMALL_CAPS_FORCED";
+export interface DesignColor {
+    r: number;
+    g: number;
+    b: number;
+    a?: number;
+}
+export interface DesignPoint {
+    x: number;
+    y: number;
+}
+export interface DesignSize {
+    width: number;
+    height: number;
+}
+export interface DesignFont {
+    family: string;
+    style: string;
+    size: number;
+}
+export interface DesignPaint {
+    type: string;
+    color?: DesignColor;
+    opacity?: number;
+    src?: string;
+    bytes?: Uint8Array;
+    sourceWidth?: number;
+    sourceHeight?: number;
+    resizedWidth?: number;
+    resizedHeight?: number;
+    scaleMode?: string;
+    imageTransform?: Transform;
+    gradientTransform?: Transform;
+    gradientStops?: Array<{
+        position: number;
+        color: DesignColor;
+    }>;
+}
+export interface DesignEffect {
+    type: string;
+    color?: DesignColor;
+    offset?: DesignPoint;
+    radius?: number;
+    spread?: number;
+    visible?: boolean;
+    blendMode?: string;
+}
+export interface DesignStyles {
+    fills: DesignPaint[];
+    strokes: DesignPaint[];
+    effects: DesignEffect[];
+}
+export interface DesignLayout {
+    direction?: "HORIZONTAL" | "VERTICAL" | "GRID";
+    itemSpacing?: number;
+    counterAxisSpacing?: number;
+    padding?: {
+        left?: number;
+        top?: number;
+        right?: number;
+        bottom?: number;
+    };
+    primaryAxisAlignItems?: string;
+    counterAxisAlignItems?: string;
+    primaryAxisSizingMode?: string;
+    counterAxisSizingMode?: string;
+    wrap?: boolean;
+}
+export interface DesignProperties {
+    position: DesignPoint;
+    size: DesignSize;
+    rotation: number;
+    styles: DesignStyles;
+    text?: string;
+    font?: DesignFont;
+    lineHeight?: LineHeight;
+    alignment?: string;
+    letterSpacing?: LetterSpacing;
+    runs?: JsonObject[];
+    layout?: DesignLayout;
+    prototype?: JsonObject[];
+    bindings?: Record<string, string>;
+    styleRefs?: Record<string, string>;
+    variableModes?: Record<string, string>;
+    breakpoint?: JsonObject;
+    componentId?: string;
+    variantAxes?: Record<string, string[]>;
+    variant?: Record<string, string>;
+    svg?: string;
+    vectorPaths?: VectorPath[];
+    pointCount?: number;
+    innerRadius?: number;
+    startingAngle?: number;
+    endingAngle?: number;
+    innerRadiusRatio?: number;
+    componentProperties?: Array<{
+        name: string;
+        type: ComponentPropertyType;
+        defaultValue: string | boolean;
+        options?: ComponentPropertyOptions;
+    }>;
+    instanceProperties?: Record<string, string | boolean | VariableAlias>;
+    operation?: "UNION" | "SUBTRACT" | "INTERSECT" | "EXCLUDE";
+    overflowDirection?: OverflowDirection;
+    numberOfFixedChildren?: number;
+    layoutGrids?: JsonObject[];
+    cornerRadius?: number;
+    cornerRadii?: number[];
+    opacity?: number;
+    blendMode?: BlendMode;
+    visible?: boolean;
+    locked?: boolean;
+    isMask?: boolean;
+    clipsContent?: boolean;
+    constraints?: Constraints;
+    layoutSizingHorizontal?: "FIXED" | "HUG" | "FILL";
+    layoutSizingVertical?: "FIXED" | "HUG" | "FILL";
+    layoutAlign?: "INHERIT" | "STRETCH";
+    layoutGrow?: number;
+    layoutPositioning?: "AUTO" | "ABSOLUTE";
+    minWidth?: number | null;
+    maxWidth?: number | null;
+    minHeight?: number | null;
+    maxHeight?: number | null;
+    strokeWeight?: number;
+    strokeTopWeight?: number;
+    strokeRightWeight?: number;
+    strokeBottomWeight?: number;
+    strokeLeftWeight?: number;
+    strokeAlign?: "INSIDE" | "OUTSIDE" | "CENTER";
+    strokeCap?: StrokeCap;
+    strokeJoin?: StrokeJoin;
+    dashPattern?: number[];
+    textAutoResize?: "NONE" | "WIDTH_AND_HEIGHT" | "HEIGHT" | "TRUNCATE";
+    textDecoration?: TextDecoration;
+    paragraphSpacing?: number;
+    paragraphIndent?: number;
+    listSpacing?: number;
+    hangingPunctuation?: boolean;
+    hangingList?: boolean;
+    textCase?: TextCase;
+    verticalAlignment?: "TOP" | "CENTER" | "BOTTOM";
+    textTruncation?: "DISABLED" | "ENDING";
+    maxLines?: number | null;
+}
+export interface VariableDefinition {
+    id?: string;
+    name: string;
+    type: "COLOR" | "FLOAT" | "STRING" | "BOOLEAN";
+    value?: JsonValue | DesignColor;
+    values?: Record<string, JsonValue | DesignColor>;
+}
+export interface VariableCollectionDefinition {
+    name: string;
+    modes?: string[];
+    items: VariableDefinition[];
+}
+export interface StyleDefinition {
+    id?: string;
+    name: string;
+    type: "PAINT" | "TEXT";
+    paints?: DesignPaint[];
+    font?: DesignFont;
+    lineHeight?: LineHeight | number;
+    letterSpacing?: LetterSpacing;
+    paragraphSpacing?: number;
+}
+export interface CompactDocument extends JsonObject {
+    canvas?: CompactCanvas;
+    canvases?: CompactCanvas[];
+    nodes?: CompactNode[];
+    styles?: JsonObject[];
+    variables?: JsonObject[];
+}
+export interface CompactCanvas extends JsonObject {
+    id?: string;
+    name?: string;
+    x?: number;
+    y?: number;
+    width: number;
+    height: number;
+    fill?: unknown;
+    nodes?: CompactNode[];
+    breakpoint?: JsonObject;
+}
+export interface CompactNode extends JsonObject {
+    id?: string;
+    name?: string;
+    type?: string;
+    x?: number;
+    y?: number;
+    w?: number;
+    h?: number;
+    children?: CompactNode[];
+}
+export interface InternalNode {
+    id: string;
+    name: string;
+    type: string;
+    properties: DesignProperties;
+    children: InternalNode[];
+}
+export interface InternalDocument {
+    nodes: InternalNode[];
+    styles: StyleDefinition[];
+    variables: VariableCollectionDefinition[];
+}
+export type ImportMode = "CREATE" | "REPLACE" | "UPDATE";
+export interface PatchOperation {
+    op: "SET" | "REMOVE" | "APPEND";
+    id?: string;
+    parent?: string;
+    set?: JsonObject;
+    normalized?: DesignProperties;
+    node?: InternalNode;
+}
+export interface InternalPatchDocument {
+    patch: {
+        operations: PatchOperation[];
+    };
+}

package/dist/validate.d.ts

@@ -0,0 +1,2 @@
+import type { InternalDocument } from "./types";
+export declare function validateDocument(document: InternalDocument): string[];

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@compact-design/core",
+  "version": "0.1.0",
+  "description": "Reusable parser, normalizer, validator, patch engine, and linter for Compact Design JSON.",
+  "license": "MPL-2.0",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Elliot727/compact-design.git",
+    "directory": "packages/core"
+  },
+  "homepage": "https://github.com/Elliot727/compact-design/tree/main/packages/core#readme",
+  "bugs": {
+    "url": "https://github.com/Elliot727/compact-design/issues"
+  },
+  "keywords": [
+    "compact-design",
+    "design",
+    "json",
+    "schema",
+    "linter"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "generate:schema": "node scripts/generate-schema.mjs",
+    "build": "npm run generate:schema && node scripts/build.mjs",
+    "prepack": "npm run build",
+    "test": "npm run generate:schema && node scripts/test.mjs",
+    "typecheck": "npm run generate:schema && tsc -p tsconfig.json --noEmit && tsc -p tsconfig.test.json --noEmit",
+    "lint": "node scripts/lint.mjs"
+  },
+  "dependencies": {
+    "ajv": "^8.20.0"
+  }
+}