custardkit-ts 0.1.0 → 0.2.1

package/README.md

@@ -12,32 +12,31 @@ npm add custardkit-ts
 
 ```typescript
 import {
+  Action,
   Custard,
-  Interface,
-  Metadata,
-  GridFitLayout,
+  CustomKey,
   GridFitSpecifier,
+  InputStyle,
+  Interface,
+  KeyColor,
   KeyData,
-  CustomKey,
   KeyDesign,
-  TextLabel,
-  InputAction,
-  Language,
-  InputStyle,
   KeyStyle,
-  KeyColor,
+  Label,
+  Language,
+  Layout,
+  Metadata,
 } from "custardkit-ts";
 
-// Create a simple key
+// Create a simple key using factory methods
 const key = new CustomKey({
-  design: new KeyDesign({
-    label: new TextLabel("あ"),
-    color: KeyColor.Normal,
-  }),
-  pressActions: [new InputAction("あ")],
-  variations: [],
+  design: KeyDesign.text("あ"),
+  pressActions: [Action.input("あ")],
 });
 
+// Create flick-style key
+const flickKey = CustomKey.flickSimpleInputs("あ", ["い", "う", "え", "お"]);
+
 // Create the custard
 const custard = new Custard({
   identifier: "my_keyboard",
@@ -49,7 +48,7 @@ const custard = new Custard({
   }),
   interface: new Interface({
     keyStyle: KeyStyle.TenkeyStyle,
-    keyLayout: new GridFitLayout({ rowCount: 5, columnCount: 4 }),
+    keyLayout: Layout.gridFit({ rowCount: 5, columnCount: 4 }),
     keys: [
       new KeyData({
         specifier: new GridFitSpecifier({ x: 0, y: 0 }),
@@ -63,6 +62,18 @@ 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.d.mts

@@ -0,0 +1,2 @@
+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 "../index-D-6qRoek.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/index.mjs

@@ -0,0 +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";
+
+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

@@ -0,0 +1,289 @@
+//#region src/Actions/BaseAction.ts
+var BaseAction = class {};
+
+//#endregion
+//#region src/Actions/CompleteAction.ts
+var CompleteAction = class extends BaseAction {
+	type = "complete";
+	toJSON() {
+		return { type: this.type };
+	}
+};
+
+//#endregion
+//#region src/Actions/CompleteCharacterFormAction.ts
+var CompleteCharacterFormAction = class extends BaseAction {
+	type = "complete_character_form";
+	constructor(forms) {
+		super();
+		this.forms = forms;
+	}
+	toJSON() {
+		return {
+			forms: this.forms,
+			type: this.type
+		};
+	}
+};
+
+//#endregion
+//#region src/Actions/DeleteAction.ts
+var DeleteAction = class extends BaseAction {
+	type = "delete";
+	constructor(count = 1) {
+		super();
+		this.count = count;
+		if (count < 1) console.warn(`DeleteAction: count (${count}) is less than 1, which is meaningless`);
+	}
+	toJSON() {
+		return {
+			count: this.count,
+			type: this.type
+		};
+	}
+};
+
+//#endregion
+//#region src/Actions/DismissKeyboardAction.ts
+var DismissKeyboardAction = class extends BaseAction {
+	type = "dismiss_keyboard";
+	toJSON() {
+		return { type: this.type };
+	}
+};
+
+//#endregion
+//#region src/Actions/EnableResizingModeAction.ts
+var EnableResizingModeAction = class extends BaseAction {
+	type = "enable_resizing_mode";
+	toJSON() {
+		return { type: this.type };
+	}
+};
+
+//#endregion
+//#region src/Actions/InputAction.ts
+var InputAction = class extends BaseAction {
+	type = "input";
+	constructor(text) {
+		super();
+		this.text = text;
+		if (text === "") console.warn("InputAction: text is empty, which is meaningless");
+	}
+	toJSON() {
+		return {
+			text: this.text,
+			type: this.type
+		};
+	}
+};
+
+//#endregion
+//#region src/Actions/LaunchApplicationAction.ts
+var LaunchApplicationAction = class extends BaseAction {
+	type = "launch_application";
+	constructor(schemeType, target) {
+		super();
+		this.schemeType = schemeType;
+		this.target = target;
+	}
+	toJSON() {
+		return {
+			scheme_type: this.schemeType,
+			target: this.target,
+			type: this.type
+		};
+	}
+};
+
+//#endregion
+//#region src/Actions/MoveCursorAction.ts
+var MoveCursorAction = class extends BaseAction {
+	type = "move_cursor";
+	constructor(count) {
+		super();
+		this.count = count;
+		if (count === 0) console.warn("MoveCursorAction: count is 0, which is meaningless");
+	}
+	toJSON() {
+		return {
+			count: this.count,
+			type: this.type
+		};
+	}
+};
+
+//#endregion
+//#region src/Actions/MoveTabAction.ts
+var MoveTabAction = class extends BaseAction {
+	type = "move_tab";
+	constructor(tabType, identifier) {
+		super();
+		this.tabType = tabType;
+		this.identifier = identifier;
+	}
+	toJSON() {
+		return {
+			identifier: this.identifier,
+			tab_type: this.tabType,
+			type: this.type
+		};
+	}
+};
+
+//#endregion
+//#region src/Actions/PasteAction.ts
+var PasteAction = class extends BaseAction {
+	type = "paste";
+	toJSON() {
+		return { type: this.type };
+	}
+};
+
+//#endregion
+//#region src/Actions/ReplaceDefaultAction.ts
+var ReplaceDefaultAction = class extends BaseAction {
+	type = "replace_default";
+	constructor(replaceType, fallbacks) {
+		super();
+		this.replaceType = replaceType;
+		this.fallbacks = fallbacks;
+	}
+	toJSON() {
+		const json = { type: this.type };
+		if (this.fallbacks !== void 0) json["fallbacks"] = this.fallbacks;
+		if (this.replaceType !== void 0) json["replace_type"] = this.replaceType;
+		return json;
+	}
+};
+
+//#endregion
+//#region src/Actions/ReplaceLastCharactersAction.ts
+var ReplaceLastCharactersAction = class extends BaseAction {
+	type = "replace_last_characters";
+	constructor(table) {
+		super();
+		this.table = table;
+	}
+	toJSON() {
+		return {
+			table: this.table,
+			type: this.type
+		};
+	}
+};
+
+//#endregion
+//#region src/Actions/SelectCandidateAction.ts
+var SelectCandidateAction = class extends BaseAction {
+	type = "select_candidate";
+	constructor(selection) {
+		super();
+		this.selection = selection;
+	}
+	toJSON() {
+		return {
+			selection: this.selection,
+			type: this.type
+		};
+	}
+};
+
+//#endregion
+//#region src/Actions/SmartDeleteAction.ts
+var SmartDeleteAction = class extends BaseAction {
+	type = "smart_delete";
+	constructor(targets, direction) {
+		super();
+		this.targets = targets;
+		this.direction = direction;
+	}
+	toJSON() {
+		return {
+			direction: this.direction,
+			targets: this.targets,
+			type: this.type
+		};
+	}
+};
+
+//#endregion
+//#region src/Actions/SmartDeleteDefaultAction.ts
+var SmartDeleteDefaultAction = class extends BaseAction {
+	type = "smart_delete_default";
+	toJSON() {
+		return { type: this.type };
+	}
+};
+
+//#endregion
+//#region src/Actions/SmartMoveCursorAction.ts
+var SmartMoveCursorAction = class extends BaseAction {
+	type = "smart_move_cursor";
+	constructor(targets, direction) {
+		super();
+		this.targets = targets;
+		this.direction = direction;
+	}
+	toJSON() {
+		return {
+			direction: this.direction,
+			targets: this.targets,
+			type: this.type
+		};
+	}
+};
+
+//#endregion
+//#region src/Actions/ToggleCapsLockStateAction.ts
+var ToggleCapsLockStateAction = class extends BaseAction {
+	type = "toggle_caps_lock_state";
+	toJSON() {
+		return { type: this.type };
+	}
+};
+
+//#endregion
+//#region src/Actions/ToggleCursorBarAction.ts
+var ToggleCursorBarAction = class extends BaseAction {
+	type = "toggle_cursor_bar";
+	toJSON() {
+		return { type: this.type };
+	}
+};
+
+//#endregion
+//#region src/Actions/ToggleTabBarAction.ts
+var ToggleTabBarAction = class extends BaseAction {
+	type = "toggle_tab_bar";
+	toJSON() {
+		return { type: this.type };
+	}
+};
+
+//#endregion
+//#region src/Actions/index.ts
+const Action = {
+	complete: () => new CompleteAction(),
+	completeCharacterForm: (forms) => new CompleteCharacterFormAction(forms),
+	delete: (count = 1) => new DeleteAction(count),
+	dismissKeyboard: () => new DismissKeyboardAction(),
+	enableResizingMode: () => new EnableResizingModeAction(),
+	input: (text) => new InputAction(text),
+	launchApplication: (schemeType, target) => new LaunchApplicationAction(schemeType, target),
+	moveCursor: (count) => new MoveCursorAction(count),
+	moveTab: (tabType, identifier) => new MoveTabAction(tabType, identifier),
+	paste: () => new PasteAction(),
+	replaceDefault: (replaceType, fallbacks) => new ReplaceDefaultAction(replaceType, fallbacks),
+	replaceLastCharacters: (table) => new ReplaceLastCharactersAction(table),
+	selectCandidate: (selection) => new SelectCandidateAction(selection),
+	smartDelete: (targets, direction) => new SmartDeleteAction(targets, direction),
+	smartDeleteDefault: () => new SmartDeleteDefaultAction(),
+	smartMoveCursor: (targets, direction) => new SmartMoveCursorAction(targets, direction),
+	toggleCapsLockState: () => new ToggleCapsLockStateAction(),
+	toggleCursorBar: () => new ToggleCursorBarAction(),
+	toggleTabBar: () => new ToggleTabBarAction()
+};
+
+//#endregion
+export { DismissKeyboardAction as _, SmartMoveCursorAction as a, CompleteAction as b, SelectCandidateAction as c, PasteAction as d, MoveTabAction as f, EnableResizingModeAction as g, InputAction as h, ToggleCapsLockStateAction as i, ReplaceLastCharactersAction as l, LaunchApplicationAction as m, ToggleTabBarAction as n, SmartDeleteDefaultAction as o, MoveCursorAction as p, ToggleCursorBarAction as r, SmartDeleteAction as s, Action as t, ReplaceDefaultAction as u, DeleteAction as v, BaseAction as x, CompleteCharacterFormAction as y };

package/dist/Keys/index.d.mts

@@ -0,0 +1,2 @@
+import { _ as LongpressAction, a as SimpleInputArgument, c as LongpressVariationDataOptions, d as FlickVariationData, f as FlickVariationDataOptions, g as VariationDesignOptions, h as VariationDesign, i as CustomKeyOptions, l as KeyDesign, m as VariationOptions, n as SystemKey, o as VariationData, p as Variation, r as CustomKey, s as LongpressVariationData, t as Key, u as KeyDesignOptions, v as LongpressActionOptions } from "../index-D0RJeudc.mjs";
+export { CustomKey, CustomKeyOptions, FlickVariationData, FlickVariationDataOptions, Key, KeyDesign, KeyDesignOptions, LongpressAction, LongpressActionOptions, LongpressVariationData, LongpressVariationDataOptions, SimpleInputArgument, SystemKey, Variation, VariationData, VariationDesign, VariationDesignOptions, VariationOptions };

package/dist/Keys/index.mjs

@@ -0,0 +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";
+
+export { CustomKey, FlickVariationData, KeyDesign, LongpressAction, LongpressVariationData, SystemKey, Variation, VariationDesign };

package/dist/{keys.mjs → Keys-HP_Fh_Lv.mjs}

@@ -1,27 +1,27 @@
-import { o as InputAction } from "./actions-R4-nSLAB.mjs";
-import { i as KeyColor, n as FlickDirection } from "./enums-BANQq1pN.mjs";
-import { i as TextLabel } from "./labels-B3o-iLQB.mjs";
+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";
 
-//#region src/keys.ts
-var LongpressAction = class {
-	start;
-	repeat;
-	duration;
-	constructor(options = {}) {
-		this.duration = options.duration;
-		this.repeat = options.repeat ?? [];
-		this.start = options.start ?? [];
+//#region src/Keys/FlickVariationData.ts
+var FlickVariationData = class {
+	direction;
+	key;
+	constructor(options) {
+		this.direction = options.direction;
+		this.key = options.key;
 	}
 	toJSON() {
-		const json = {
-			repeat: this.repeat.map((a) => a.toJSON()),
-			start: this.start.map((a) => a.toJSON())
+		return {
+			direction: this.direction,
+			key: this.key.toJSON(),
+			type: "flick_variation"
 		};
-		if (this.duration !== void 0) json["duration"] = this.duration;
-		return json;
 	}
 };
-var KeyDesign = class {
+
+//#endregion
+//#region src/Keys/KeyDesign.ts
+var KeyDesign = class KeyDesign {
 	label;
 	color;
 	constructor(options) {
@@ -34,8 +34,44 @@ var KeyDesign = class {
 			label: this.label.toJSON()
 		};
 	}
+	static create(label, color) {
+		return new KeyDesign({
+			color,
+			label
+		});
+	}
+	static text(text, color) {
+		return new KeyDesign({
+			color,
+			label: Label.text(text)
+		});
+	}
 };
-var VariationDesign = class {
+
+//#endregion
+//#region src/Keys/LongpressAction.ts
+var LongpressAction = class {
+	start;
+	repeat;
+	duration;
+	constructor(options = {}) {
+		this.duration = options.duration;
+		this.repeat = options.repeat ?? [];
+		this.start = options.start ?? [];
+	}
+	toJSON() {
+		const json = {
+			repeat: this.repeat.map((a) => a.toJSON()),
+			start: this.start.map((a) => a.toJSON())
+		};
+		if (this.duration !== void 0) json["duration"] = this.duration;
+		return json;
+	}
+};
+
+//#endregion
+//#region src/Keys/VariationDesign.ts
+var VariationDesign = class VariationDesign {
 	label;
 	constructor(options) {
 		this.label = options.label;
@@ -43,8 +79,14 @@ var VariationDesign = class {
 	toJSON() {
 		return { label: this.label.toJSON() };
 	}
+	static text(text) {
+		return new VariationDesign({ label: Label.text(text) });
+	}
 };
-var Variation = class {
+
+//#endregion
+//#region src/Keys/Variation.ts
+var Variation = class Variation {
 	design;
 	pressActions;
 	longpressActions;
@@ -60,34 +102,16 @@ var Variation = class {
 			press_actions: this.pressActions.map((a) => a.toJSON())
 		};
 	}
-};
-var FlickVariationData = class {
-	direction;
-	key;
-	constructor(options) {
-		this.direction = options.direction;
-		this.key = options.key;
-	}
-	toJSON() {
-		return {
-			direction: this.direction,
-			key: this.key.toJSON(),
-			type: "flick_variation"
-		};
-	}
-};
-var LongpressVariationData = class {
-	key;
-	constructor(options) {
-		this.key = options.key;
-	}
-	toJSON() {
-		return {
-			key: this.key.toJSON(),
-			type: "longpress_variation"
-		};
+	static simpleInput(text, label) {
+		return new Variation({
+			design: VariationDesign.text(label ?? text),
+			pressActions: [Action.input(text)]
+		});
 	}
 };
+
+//#endregion
+//#region src/Keys/CustomKey.ts
 var CustomKey = class CustomKey {
 	design;
 	pressActions;
@@ -107,10 +131,6 @@ var CustomKey = class CustomKey {
 			variations: this.variations.map((v) => v.toJSON())
 		};
 	}
-	/**
-	* Create a flick-style key with center and directional inputs.
-	* Directions are assigned in order: left, top, right, bottom.
-	*/
 	static flickSimpleInputs(center, subs, centerLabel) {
 		const directions = [
 			FlickDirection.Left,
@@ -126,21 +146,17 @@ var CustomKey = class CustomKey {
 			if (sub !== void 0 && direction !== void 0) variations.push(new FlickVariationData({
 				direction,
 				key: new Variation({
-					design: new VariationDesign({ label: new TextLabel(sub) }),
-					pressActions: [new InputAction(sub)]
+					design: new VariationDesign({ label: Label.text(sub) }),
+					pressActions: [Action.input(sub)]
 				})
 			}));
 		}
 		return new CustomKey({
-			design: new KeyDesign({ label: new TextLabel(centerLabel ?? center) }),
-			pressActions: [new InputAction(center)],
+			design: new KeyDesign({ label: Label.text(centerLabel ?? center) }),
+			pressActions: [Action.input(center)],
 			variations
 		});
 	}
-	/**
-	* Create a flick-style key with label and input for each direction.
-	* Each argument can be a string (label=input) or {label, input} object.
-	*/
 	static flickSimpleInputAndLabels(options) {
 		const parseArg = (arg) => {
 			if (typeof arg === "string") return {
@@ -162,18 +178,36 @@ var CustomKey = class CustomKey {
 			variations.push(new FlickVariationData({
 				direction,
 				key: new Variation({
-					design: new VariationDesign({ label: new TextLabel(parsed.label) }),
-					pressActions: [new InputAction(parsed.input)]
+					design: new VariationDesign({ label: Label.text(parsed.label) }),
+					pressActions: [Action.input(parsed.input)]
 				})
 			}));
 		}
 		return new CustomKey({
-			design: new KeyDesign({ label: new TextLabel(centerParsed.label) }),
-			pressActions: [new InputAction(centerParsed.input)],
+			design: new KeyDesign({ label: Label.text(centerParsed.label) }),
+			pressActions: [Action.input(centerParsed.input)],
 			variations
 		});
 	}
 };
+
+//#endregion
+//#region src/Keys/LongpressVariationData.ts
+var LongpressVariationData = class {
+	key;
+	constructor(options) {
+		this.key = options.key;
+	}
+	toJSON() {
+		return {
+			key: this.key.toJSON(),
+			type: "longpress_variation"
+		};
+	}
+};
+
+//#endregion
+//#region src/Keys/SystemKey.ts
 var SystemKey = class {
 	constructor(keyType) {
 		this.keyType = keyType;
@@ -184,4 +218,4 @@ var SystemKey = class {
 };
 
 //#endregion
-export { CustomKey, FlickVariationData, KeyDesign, LongpressAction, LongpressVariationData, SystemKey, Variation, VariationDesign };
+export { VariationDesign as a, FlickVariationData as c, Variation as i, LongpressVariationData as n, LongpressAction as o, CustomKey as r, KeyDesign as s, SystemKey as t };

package/dist/Labels/index.d.mts

@@ -0,0 +1,2 @@
+import { a as DirectionalLabels, i as MainAndSubLabel, n as TextLabel, o as MainAndDirectionsLabel, r as SystemImageLabel, t as Label } from "../index-Dknx6MxA.mjs";
+export { DirectionalLabels, Label, MainAndDirectionsLabel, MainAndSubLabel, SystemImageLabel, TextLabel };

package/dist/Labels/index.mjs

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