custardkit-ts 0.2.1 → 0.2.3

package/README.md

@@ -2,6 +2,12 @@
 
 TypeScript implementation of [CustardKit](https://github.com/azooKey/CustardKit)
 
+## Features
+
+- **Type Safety**: Fully typed with TypeScript, ensuring autocomplete and compile-time error checking.
+- **Runtime Validation**: Validates inputs at runtime to prevent invalid keyboard configurations.
+- **Direct Serialization**: Classes support direct JSON serialization via `JSON.stringify()`.
+
 ## Installation
 
 ```bash
@@ -11,22 +17,11 @@ npm add custardkit-ts
 ## Usage
 
 ```typescript
-import {
-  Action,
-  Custard,
-  CustomKey,
-  GridFitSpecifier,
-  InputStyle,
-  Interface,
-  KeyColor,
-  KeyData,
-  KeyDesign,
-  KeyStyle,
-  Label,
-  Language,
-  Layout,
-  Metadata,
-} from "custardkit-ts";
+import { Custard, Interface, Metadata } from "custardkit-ts/Custard";
+import { CustomKey, KeyDesign } from "custardkit-ts/Keys";
+import { Action } from "custardkit-ts/Actions";
+import { Layout, KeyData, GridFitSpecifier } from "custardkit-ts/Layout";
+import { InputStyle, KeyStyle, Language } from "custardkit-ts";
 
 // Create a simple key using factory methods
 const key = new CustomKey({
@@ -62,18 +57,6 @@ const custard = new Custard({
 await custard.write("my_keyboard.json");
 ```
 
-## Subpath Imports
-
-For direct class access:
-
-```typescript
-import { InputAction, DeleteAction } from "custardkit-ts/Actions";
-import { TextLabel } from "custardkit-ts/Labels";
-import { CustomKey, KeyDesign } from "custardkit-ts/Keys";
-import { GridFitLayout } from "custardkit-ts/Layout";
-import { Custard, Metadata, Interface } from "custardkit-ts/Custard";
-```
-
 ## License
 
 MIT

package/dist/Actions/index.mjs

@@ -1,3 +1,3 @@
-import { _ as DismissKeyboardAction, a as SmartMoveCursorAction, b as CompleteAction, c as SelectCandidateAction, d as PasteAction, f as MoveTabAction, g as EnableResizingModeAction, h as InputAction, i as ToggleCapsLockStateAction, l as ReplaceLastCharactersAction, m as LaunchApplicationAction, n as ToggleTabBarAction, o as SmartDeleteDefaultAction, p as MoveCursorAction, r as ToggleCursorBarAction, s as SmartDeleteAction, t as Action, u as ReplaceDefaultAction, v as DeleteAction, x as BaseAction, y as CompleteCharacterFormAction } from "../Actions-DGz8CoQU.mjs";
+import { _ as DismissKeyboardAction, a as SmartMoveCursorAction, b as CompleteAction, c as SelectCandidateAction, d as PasteAction, f as MoveTabAction, g as EnableResizingModeAction, h as InputAction, i as ToggleCapsLockStateAction, l as ReplaceLastCharactersAction, m as LaunchApplicationAction, n as ToggleTabBarAction, o as SmartDeleteDefaultAction, p as MoveCursorAction, r as ToggleCursorBarAction, s as SmartDeleteAction, t as Action, u as ReplaceDefaultAction, v as DeleteAction, x as BaseAction, y as CompleteCharacterFormAction } from "../Actions-CicRxnRj.mjs";
 
 export { Action, BaseAction, CompleteAction, CompleteCharacterFormAction, DeleteAction, DismissKeyboardAction, EnableResizingModeAction, InputAction, LaunchApplicationAction, MoveCursorAction, MoveTabAction, PasteAction, ReplaceDefaultAction, ReplaceLastCharactersAction, SelectCandidateAction, SmartDeleteAction, SmartDeleteDefaultAction, SmartMoveCursorAction, ToggleCapsLockStateAction, ToggleCursorBarAction, ToggleTabBarAction };

package/dist/{Actions-DGz8CoQU.mjs → Actions-CicRxnRj.mjs}

@@ -20,8 +20,8 @@ var CompleteCharacterFormAction = class extends BaseAction {
 	}
 	toJSON() {
 		return {
-			forms: this.forms,
-			type: this.type
+			type: this.type,
+			forms: this.forms
 		};
 	}
 };
@@ -37,8 +37,8 @@ var DeleteAction = class extends BaseAction {
 	}
 	toJSON() {
 		return {
-			count: this.count,
-			type: this.type
+			type: this.type,
+			count: this.count
 		};
 	}
 };
@@ -72,8 +72,8 @@ var InputAction = class extends BaseAction {
 	}
 	toJSON() {
 		return {
-			text: this.text,
-			type: this.type
+			type: this.type,
+			text: this.text
 		};
 	}
 };
@@ -89,9 +89,9 @@ var LaunchApplicationAction = class extends BaseAction {
 	}
 	toJSON() {
 		return {
+			type: this.type,
 			scheme_type: this.schemeType,
-			target: this.target,
-			type: this.type
+			target: this.target
 		};
 	}
 };
@@ -107,8 +107,8 @@ var MoveCursorAction = class extends BaseAction {
 	}
 	toJSON() {
 		return {
-			count: this.count,
-			type: this.type
+			type: this.type,
+			count: this.count
 		};
 	}
 };
@@ -124,9 +124,9 @@ var MoveTabAction = class extends BaseAction {
 	}
 	toJSON() {
 		return {
-			identifier: this.identifier,
+			type: this.type,
 			tab_type: this.tabType,
-			type: this.type
+			identifier: this.identifier
 		};
 	}
 };
@@ -167,8 +167,8 @@ var ReplaceLastCharactersAction = class extends BaseAction {
 	}
 	toJSON() {
 		return {
-			table: this.table,
-			type: this.type
+			type: this.type,
+			table: this.table
 		};
 	}
 };
@@ -183,8 +183,8 @@ var SelectCandidateAction = class extends BaseAction {
 	}
 	toJSON() {
 		return {
-			selection: this.selection,
-			type: this.type
+			type: this.type,
+			selection: this.selection
 		};
 	}
 };
@@ -200,9 +200,9 @@ var SmartDeleteAction = class extends BaseAction {
 	}
 	toJSON() {
 		return {
+			type: this.type,
 			direction: this.direction,
-			targets: this.targets,
-			type: this.type
+			targets: this.targets
 		};
 	}
 };
@@ -227,9 +227,9 @@ var SmartMoveCursorAction = class extends BaseAction {
 	}
 	toJSON() {
 		return {
+			type: this.type,
 			direction: this.direction,
-			targets: this.targets,
-			type: this.type
+			targets: this.targets
 		};
 	}
 };

package/dist/Keys/index.mjs

@@ -1,3 +1,3 @@
-import { a as VariationDesign, c as FlickVariationData, i as Variation, n as LongpressVariationData, o as LongpressAction, r as CustomKey, s as KeyDesign, t as SystemKey } from "../Keys-HP_Fh_Lv.mjs";
+import { a as VariationDesign, c as FlickVariationData, i as Variation, n as LongpressVariationData, o as LongpressAction, r as CustomKey, s as KeyDesign, t as SystemKey } from "../Keys-0-JGAoj2.mjs";
 
 export { CustomKey, FlickVariationData, KeyDesign, LongpressAction, LongpressVariationData, SystemKey, Variation, VariationDesign };

package/dist/{Keys-HP_Fh_Lv.mjs → Keys-0-JGAoj2.mjs}

@@ -1,6 +1,6 @@
 import { i as KeyColor, n as FlickDirection } from "./enums-BySrsID6.mjs";
-import { t as Label } from "./Labels-D8TEwrN8.mjs";
-import { t as Action } from "./Actions-DGz8CoQU.mjs";
+import { t as Label } from "./Labels-M8b3K2tQ.mjs";
+import { t as Action } from "./Actions-CicRxnRj.mjs";
 
 //#region src/Keys/FlickVariationData.ts
 var FlickVariationData = class {
@@ -12,9 +12,9 @@ var FlickVariationData = class {
 	}
 	toJSON() {
 		return {
+			type: "flick_variation",
 			direction: this.direction,
-			key: this.key.toJSON(),
-			type: "flick_variation"
+			key: this.key.toJSON()
 		};
 	}
 };
@@ -30,8 +30,8 @@ var KeyDesign = class KeyDesign {
 	}
 	toJSON() {
 		return {
-			color: this.color,
-			label: this.label.toJSON()
+			label: this.label.toJSON(),
+			color: this.color
 		};
 	}
 	static create(label, color) {
@@ -98,8 +98,8 @@ var Variation = class Variation {
 	toJSON() {
 		return {
 			design: this.design.toJSON(),
-			longpress_actions: this.longpressActions.toJSON(),
-			press_actions: this.pressActions.map((a) => a.toJSON())
+			press_actions: this.pressActions.map((a) => a.toJSON()),
+			longpress_actions: this.longpressActions.toJSON()
 		};
 	}
 	static simpleInput(text, label) {
@@ -126,8 +126,8 @@ var CustomKey = class CustomKey {
 	toJSON() {
 		return {
 			design: this.design.toJSON(),
-			longpress_actions: this.longpressActions.toJSON(),
 			press_actions: this.pressActions.map((a) => a.toJSON()),
+			longpress_actions: this.longpressActions.toJSON(),
 			variations: this.variations.map((v) => v.toJSON())
 		};
 	}
@@ -200,8 +200,8 @@ var LongpressVariationData = class {
 	}
 	toJSON() {
 		return {
-			key: this.key.toJSON(),
-			type: "longpress_variation"
+			type: "longpress_variation",
+			key: this.key.toJSON()
 		};
 	}
 };

package/dist/Labels/index.mjs

@@ -1,3 +1,3 @@
-import { a as MainAndDirectionsLabel, i as MainAndSubLabel, n as TextLabel, r as SystemImageLabel, t as Label } from "../Labels-D8TEwrN8.mjs";
+import { a as MainAndDirectionsLabel, i as MainAndSubLabel, n as TextLabel, r as SystemImageLabel, t as Label } from "../Labels-M8b3K2tQ.mjs";
 
 export { Label, MainAndDirectionsLabel, MainAndSubLabel, SystemImageLabel, TextLabel };

package/dist/{Labels-D8TEwrN8.mjs → Labels-M8b3K2tQ.mjs}

@@ -6,9 +6,9 @@ var MainAndDirectionsLabel = class {
 	}
 	toJSON() {
 		return {
-			directions: this.directions,
+			type: "main_and_directions",
 			main: this.main,
-			type: "main_and_directions"
+			directions: this.directions
 		};
 	}
 };
@@ -22,9 +22,9 @@ var MainAndSubLabel = class {
 	}
 	toJSON() {
 		return {
+			type: "main_and_sub",
 			main: this.main,
-			sub: this.sub,
-			type: "main_and_sub"
+			sub: this.sub
 		};
 	}
 };

package/dist/Layout/index.mjs

@@ -1,3 +1,3 @@
-import { a as GridFitSpecifier, i as GridScrollLayout, n as KeyData, o as GridFitLayout, r as GridScrollSpecifier, t as Layout } from "../Layout-BYGdAtQk.mjs";
+import { a as GridFitSpecifier, i as GridScrollLayout, n as KeyData, o as GridFitLayout, r as GridScrollSpecifier, t as Layout } from "../Layout-Cb2Aanqv.mjs";
 
 export { GridFitLayout, GridFitSpecifier, GridScrollLayout, GridScrollSpecifier, KeyData, Layout };

package/dist/{Layout-BYGdAtQk.mjs → Layout-Cb2Aanqv.mjs}

@@ -1,5 +1,5 @@
 import { a as InvalidLayoutSizeError } from "./errors-BPMIP-gS.mjs";
-import { r as CustomKey } from "./Keys-HP_Fh_Lv.mjs";
+import { r as CustomKey } from "./Keys-0-JGAoj2.mjs";
 
 //#region src/Layout/GridFitLayout.ts
 var GridFitLayout = class {
@@ -35,9 +35,9 @@ var GridFitLayout = class {
 	}
 	toJSON() {
 		return {
-			column_count: this.columnCount,
+			type: "grid_fit",
 			row_count: this.rowCount,
-			type: "grid_fit"
+			column_count: this.columnCount
 		};
 	}
 };
@@ -61,10 +61,10 @@ var GridFitSpecifier = class {
 	}
 	toJSON() {
 		return {
-			height: this.height,
-			width: this.width,
 			x: this.x,
-			y: this.y
+			y: this.y,
+			width: this.width,
+			height: this.height
 		};
 	}
 	get specifierType() {
@@ -104,10 +104,10 @@ var GridScrollLayout = class {
 	}
 	toJSON() {
 		return {
-			column_count: this.columnCount,
+			type: "grid_scroll",
 			direction: this.direction,
 			row_count: this.rowCount,
-			type: "grid_scroll"
+			column_count: this.columnCount
 		};
 	}
 };

package/dist/index.mjs

@@ -1,6 +1,6 @@
 import { a as KeyStyle, c as ReplaceType, d as SystemKeyType, f as SystemTabType, i as KeyColor, l as ScanDirection, n as FlickDirection, o as Language, r as InputStyle, s as LongpressDuration, t as CharacterForm, u as ScrollDirection } from "./enums-BySrsID6.mjs";
 import { i as InvalidKeyPositionError, n as EmptyDisplayNameError, o as LayoutSpecifierMismatchError, r as InvalidIdentifierError, s as ValidationError, t as CustardKitError } from "./errors-BPMIP-gS.mjs";
-import { a as GridFitSpecifier, i as GridScrollLayout, o as GridFitLayout, r as GridScrollSpecifier } from "./Layout-BYGdAtQk.mjs";
+import { a as GridFitSpecifier, i as GridScrollLayout, o as GridFitLayout, r as GridScrollSpecifier } from "./Layout-Cb2Aanqv.mjs";
 import { writeFile } from "node:fs/promises";
 
 //#region src/Custard/Custard.ts
@@ -22,16 +22,16 @@ var Custard = class {
 	toJSON() {
 		return {
 			identifier: this.identifier,
-			input_style: this.inputStyle,
-			interface: this.interface.toJSON(),
 			language: this.language,
-			metadata: this.metadata.toJSON()
+			input_style: this.inputStyle,
+			metadata: this.metadata.toJSON(),
+			interface: this.interface.toJSON()
 		};
 	}
 	async write(name) {
 		let filename = name;
 		if (!name.endsWith(".json")) filename = `${name}.json`;
-		const content = `${JSON.stringify(this, null, 2)}\n`;
+		const content = `${JSON.stringify(this, null)}\n`;
 		await writeFile(filename, content, { encoding: "utf8" });
 	}
 };
@@ -46,7 +46,7 @@ var CustardList = class {
 	async write(name) {
 		let filename = name;
 		if (!name.endsWith(".json")) filename = `${name}.json`;
-		const content = `${JSON.stringify(this.toJSON(), null, 2)}\n`;
+		const content = `${JSON.stringify(this.toJSON(), null)}\n`;
 		await writeFile(filename, content, { encoding: "utf8" });
 	}
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "custardkit-ts",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "repository": {
     "type": "git",
     "url": "https://github.com/ph0ryn/CustardKitTS.git"