improve js api

src/lib.rs

@@ -24,55 +24,58 @@ extern "C" {
     fn alert(s: &str);
 }
 
-/// Execute hexchess notation
-#[wasm_bindgen]
-pub fn apply(hexchess: Hexchess, notation: Notation) -> Hexchess {
+/// Execute notation on hexchess object
+#[wasm_bindgen(js_name = applyNotation)]
+pub fn apply_notation(hexchess: Hexchess, notation: Notation) -> Hexchess {
     set_panic_hook();
-
     let mut output = hexchess.clone();
-
     let _ = output.apply(notation);
-
     output
 }
 
-/// Parse algebraic hexchess notation
-#[wasm_bindgen]
-pub fn notation(str: String) -> Notation {
+/// Create empty hexchess object
+#[wasm_bindgen(js_name = createHexchess)]
+pub fn create_hexchess() -> Hexchess {
     set_panic_hook();
-
-    Notation::from(&str).unwrap()
+    Hexchess::new()
 }
 
-/// Parse hexchess FEN string
-#[wasm_bindgen]
-pub fn parse(fen: String) -> Hexchess {
+/// Create hexchess object with initial position
+#[wasm_bindgen(js_name = createHexchessInitial)]
+pub fn create_hexchess_initial() -> Hexchess {
     set_panic_hook();
+    Hexchess::initial()
+}
 
-    let hexchess = Hexchess::from(&fen).unwrap();
+/// Create hexchess object from string
+#[wasm_bindgen(js_name = parseHexchess)]
+pub fn parse_hexchess(fen: String) -> Hexchess {
+    set_panic_hook();
+    Hexchess::from(&fen).unwrap()
+}
 
-    hexchess
+/// Create hexchess notation object from string
+#[wasm_bindgen(js_name = parseNotation)]
+pub fn parse_notation(str: String) -> Notation {
+    set_panic_hook();
+    Notation::from(&str).unwrap()
 }
 
 /// Stringify hexchess object
-#[wasm_bindgen]
-pub fn stringify(hexchess: Hexchess) -> String {
+#[wasm_bindgen(js_name = stringifyHexchess)]
+pub fn stringify_hexchess(hexchess: Hexchess) -> String {
     set_panic_hook();
-
     hexchess.to_string()
 }
 
 /// Find target moves from a position, regardless of turn color
-#[wasm_bindgen(skip_typescript)]
-pub fn targets(hexchess: Hexchess, position: Position) -> JsValue {
+#[wasm_bindgen(js_name = getTargets, skip_typescript)]
+pub fn get_targets(hexchess: Hexchess, position: Position) -> JsValue {
     set_panic_hook();
-
-    let targets = hexchess.targets(position);
-
-    JsValue::from_serde(&targets).unwrap()
+    JsValue::from_serde(&hexchess.targets(position)).unwrap()
 }
 
 #[wasm_bindgen(typescript_custom_section)]
 const TS_APPEND_CONTENT: &'static str = r#"
-export function targets(hexchess: Hexchess, position: Position): Notation[];
+export function getTargets(hexchess: Hexchess, position: Position): Notation[];
 "#;

tests/notation.spec.ts

@@ -0,0 +1,17 @@
+import {
+  applyNotation,
+  parseHexchess,
+  parseNotation,
+} from '@bedard/hexchess'
+
+import { describe, expect, it } from 'vitest'
+
+describe('apply', () => {
+  it('executes turn notation', () => {
+    let hexchess = parseHexchess('b/qbk/n1b1n/r5r/ppppppppp/11/5P5/4P1P4/3P1B1P3/2P2B2P2/1PRNQBKNRP1')
+
+    hexchess = applyNotation(hexchess, parseNotation('g4g5'))
+
+    expect(hexchess.board.g5).toBe('P')
+  })
+})

tests/serialization.spec.ts

@@ -1,13 +1,16 @@
-import { assertType, describe, expect, it } from 'vitest'
-import { Hexchess, Notation, notation, parse, stringify } from '@bedard/hexchess'
+import { describe, expect, it } from 'vitest'
+
+import {
+  parseHexchess,
+  parseNotation,
+  stringifyHexchess,
+} from '@bedard/hexchess'
 
 describe('serialization', () => {
   it('parse / stringify hexchess', () => {
     const str = 'b/qbk/n1b1n/r5r/ppppppppp/11/5P5/4P1P4/3P1B1P3/2P2B2P2/1PRNQBKNRP1 w - 0 1'
 
-    const hexchess = parse(str)
-
-    assertType<Hexchess>(hexchess)
+    const hexchess = parseHexchess(str)
 
     expect(hexchess).toEqual({
       board: {
@@ -109,15 +112,11 @@ describe('serialization', () => {
       turn: 'w'
     })
 
-    expect(stringify(hexchess)).toBe(str)
+    expect(stringifyHexchess(hexchess)).toBe(str)
   })
 
   it('parse notation', () => {
-    const n = notation('g4g5')
-
-    assertType<Notation>(n)
-
-    expect(notation('g4g5')).toEqual({
+    expect(parseNotation('g4g5')).toEqual({
       from: 'g4',
       promotion: null,
       to: 'g5',

tests/targets.spec.ts

@@ -1,11 +1,11 @@
 import { describe, expect, it } from 'vitest'
-import { parse, targets } from '@bedard/hexchess'
+import { getTargets, parseHexchess } from '@bedard/hexchess'
 
 describe('targets', () => {
   it('targets', () => {
-    const hexchess = parse('b/qbk/n1b1n/r5r/ppppppppp/11/5P5/4P1P4/3P1B1P3/2P2B2P2/1PRNQBKNRP1 w - 0 1')
+    const hexchess = parseHexchess('b/qbk/n1b1n/r5r/ppppppppp/11/5P5/4P1P4/3P1B1P3/2P2B2P2/1PRNQBKNRP1 w - 0 1')
 
-    const result = targets(hexchess, 'g4')
+    const result = getTargets(hexchess, 'g4')
 
     expect(result).toEqual([
       { from: 'g4', promotion: null, to: 'g5' },

tests/types.spec-d.ts

@@ -1,12 +1,12 @@
 import { assertType, describe, it } from 'vitest'
-import { Hexchess, Notation, notation, parse } from '@bedard/hexchess'
+import { Hexchess, Notation, parseNotation, parseHexchess } from '@bedard/hexchess'
 
 describe('types', () => {
   it('Hexchess', () => {
-    assertType<Hexchess>(parse('b/qbk/n1b1n/r5r/ppppppppp/11/5P5/4P1P4/3P1B1P3/2P2B2P2/1PRNQBKNRP1'))
+    assertType<Hexchess>(parseHexchess('b/qbk/n1b1n/r5r/ppppppppp/11/5P5/4P1P4/3P1B1P3/2P2B2P2/1PRNQBKNRP1'))
   })
 
   it('Notation', () => {
-    assertType<Notation>(notation('e4e5'))
+    assertType<Notation>(parseNotation('e4e5'))
   })
 })