@dxos/plugin-chess 0.8.4-main.fffef41 → 0.9.0

package/LICENSE

@@ -1,8 +1,105 @@
-MIT License 
-Copyright (c) 2022 DXOS
+# Functional Source License, Version 1.1, ALv2 Future License
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+## Abbreviation
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+FSL-1.1-Apache-2.0
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+## Notice
+
+Copyright 2026 DXOS
+
+## Terms and Conditions
+
+### Licensor ("We")
+
+The party offering the Software under these Terms and Conditions.
+
+### The Software
+
+The "Software" is each version of the software that we make available under
+these Terms and Conditions, as indicated by our inclusion of these Terms and
+Conditions with the Software.
+
+### License Grant
+
+Subject to your compliance with this License Grant and the Patents,
+Redistribution and Trademark clauses below, we hereby grant you the right to
+use, copy, modify, create derivative works, publicly perform, publicly display
+and redistribute the Software for any Permitted Purpose identified below.
+
+### Permitted Purpose
+
+A Permitted Purpose is any purpose other than a Competing Use. A Competing Use
+means making the Software available to others in a commercial product or
+service that:
+
+1. substitutes for the Software;
+
+2. substitutes for any other product or service we offer using the Software
+   that exists as of the date we make the Software available; or
+
+3. offers the same or substantially similar functionality as the Software.
+
+Permitted Purposes specifically include using the Software:
+
+1. for your internal use and access;
+
+2. for non-commercial education;
+
+3. for non-commercial research; and
+
+4. in connection with professional services that you provide to a licensee
+   using the Software in accordance with these Terms and Conditions.
+
+### Patents
+
+To the extent your use for a Permitted Purpose would necessarily infringe our
+patents, the license grant above includes a license under our patents. If you
+make a claim against any party that the Software infringes or contributes to
+the infringement of any patent, then your patent license to the Software ends
+immediately.
+
+### Redistribution
+
+The Terms and Conditions apply to all copies, modifications and derivatives of
+the Software.
+
+If you redistribute any copies, modifications or derivatives of the Software,
+you must include a copy of or a link to these Terms and Conditions and not
+remove any copyright notices provided in or with the Software.
+
+### Disclaimer
+
+THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR
+PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
+
+IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE
+SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES,
+EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
+
+### Trademarks
+
+Except for displaying the License Details and identifying us as the origin of
+the Software, you have no right under these Terms and Conditions to use our
+trademarks, trade names, service marks or product names.
+
+## Grant of Future License
+
+We hereby irrevocably grant you an additional license to use the Software under
+the Apache License, Version 2.0 that is effective on the second anniversary of
+the date we make the Software available. On or after that date, you may use the
+Software under the Apache License, Version 2.0, in which case the following
+will apply:
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this file except in compliance with the License.
+
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed
+under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.

package/PLUGIN.mdl

@@ -0,0 +1,526 @@
+---
+id: org.dxos.plugin.chess
+name: ChessPlugin
+version: 0.1.0
+---
+
+A two-player chess game plugin for `DXOS` Composer.
+
+## Extensions
+
+The following extension dialects are used in this document.
+Each extension is defined in the Appendix or resolved via its URI.
+
+| Term        | URI                            |
+|-------------|--------------------------------|
+| `type`      | `org.dxos.mdl.type@1.0`       |
+| `feat`      | `org.dxos.mdl.feat@1.0`       |
+| `test`      | `org.dxos.mdl.test@1.0`       |
+| `component` | `org.dxos.mdl.component@1.0`  |
+| `op`        | `org.dxos.mdl.op@1.0`         |
+| `service`   | `org.dxos.mdl.service@1.0`    |
+
+## Types
+
+```mdl
+type Color
+  literals: white | black
+```
+
+```mdl
+type PieceKind
+  literals: pawn | rook | knight | bishop | queen | king
+```
+
+```mdl
+type Piece
+  fields:
+    kind: PieceKind
+    color: Color
+```
+
+```mdl
+type Square
+  fields:
+    file: a | b | c | d | e | f | g | h
+    rank: 1..8
+    piece?: Piece
+```
+
+```mdl
+type Move
+  fields:
+    from: Square
+    to: Square
+    promotion?: PieceKind   # only valid for pawn reaching back rank
+```
+
+```mdl
+type Board
+  fields:
+    squares: Square[8][8]
+    turn: Color
+    status: playing | check | checkmate | stalemate
+    moves: Move[]           # full move history
+```
+
+```mdl
+type Player
+  fields:
+    id: string
+    name: string
+    color: Color
+```
+
+```mdl
+type GameStatus
+  literals: waiting | active | finished
+```
+
+```mdl
+type Game
+  fields:
+    id: string
+    players: Player[2]
+    board: Board
+    status: GameStatus
+    winner?: Player
+```
+
+## Components
+
+```mdl
+component Lobby
+  desc: Entry point where players create or join a game.
+  props:
+    playerId: string
+  state:
+    games: Game[]               # list of open/active games
+    selected?: Game
+  slots:
+    header?: ReactNode
+    empty?: ReactNode           # shown when games list is empty
+  actions:
+    createGame() → Game
+    joinGame(game: Game) → Game
+    spectate(game: Game)
+  emits:
+    onJoin(game: Game)
+  layout: |
+    ┌─────────────────────────┐
+    │ [header slot]           │
+    ├─────────────────────────┤
+    │ Game list               │
+    │  ┌───────────────────┐  │
+    │  │ game row          │  │
+    │  └───────────────────┘  │
+    │  [empty slot]           │
+    ├─────────────────────────┤
+    │ [Create Game]           │
+    └─────────────────────────┘
+```
+
+```mdl
+component Gameboard
+  desc: Interactive chess board for an active game.
+  props:
+    game: Game
+    playerId: string            # identifies which side the viewer plays
+  state:
+    selected?: Square           # currently selected square
+    highlights: Square[]        # legal move targets for selected piece
+    perspective: Color          # which side is at the bottom (default: player's color)
+  slots:
+    toolbar?: ReactNode
+    sidebar?: ReactNode
+    overlay?: ReactNode         # e.g. checkmate / promotion dialogs
+  actions:
+    selectSquare(square: Square)
+    submitMove(move: Move)
+    flipBoard()
+  emits:
+    onMove(move: Move)
+    onResign()
+  layout: |
+    ┌─────────────────────────┐
+    │ [toolbar slot]          │
+    ├──────────┬──────────────┤
+    │          │ [sidebar]    │
+    │  8×8     │              │
+    │  board   │ move history │
+    │          │              │
+    ├──────────┴──────────────┤
+    │ [overlay slot]          │
+    └─────────────────────────┘
+```
+
+## Services
+
+```mdl
+service ChessEngine
+  desc: Validates moves and computes game state. May be local (WASM) or remote.
+  loading: lazy
+  ops:
+    validate(board: Board, move: Move) → Move
+    legalMoves(board: Board, square: Square) → Square[]
+    applyMove(board: Board, move: Move) → Board
+  errors:
+    EngineNotReady: engine has not finished loading
+```
+
+```mdl
+service GameStore
+  desc: Persists and replicates Game state via ECHO.
+  ops:
+    create(white: Player, black: Player) → Game
+    load(id: string) → Game
+    save(game: Game) → Game
+    list() → Game[]
+  effects: [echo:write, echo:read]
+```
+
+## Operations
+
+Pure operations (no effects, no service dependencies) — safe to call anywhere.
+
+```mdl
+op getLegalMoves
+  desc: Returns legal target squares for the piece on the given square.
+  input:
+    board: Board
+    square: Square
+  output: Square[]
+  errors:
+    EmptySquare: no piece on square
+    WrongSide: piece does not belong to the active side
+  requires: [ChessEngine]
+```
+
+```mdl
+op validateMove
+  desc: Checks a move against chess rules without mutating state.
+  input:
+    board: Board
+    move: Move
+  output: Move
+  errors:
+    IllegalMove: move violates chess rules
+    WrongTurn: piece does not belong to the active side
+    GameOver: game has already ended
+  requires: [ChessEngine]
+```
+
+```mdl
+op applyMove
+  desc: Applies a validated move and returns the next board state.
+  input:
+    board: Board
+    move: Move                  # must be pre-validated
+  output: Board
+  requires: [ChessEngine]
+  note: does not persist; use submitMove for the full transactional flow
+```
+
+Effectful operations — mutate persistent state.
+
+```mdl
+op startGame
+  desc: Creates a new Game with two players and an initial Board.
+  input:
+    white: Player
+    black: Player
+  output: Game
+  effects: [echo:write]
+  requires: [GameStore]
+```
+
+```mdl
+op submitMove
+  desc: Validates and applies a move, then persists the updated Game.
+  input:
+    game: Game
+    player: Player
+    move: Move
+  output: Game
+  errors:
+    WrongTurn: player is not the active side
+    IllegalMove: move violates chess rules
+    GameOver: game has already ended
+  effects: [echo:write]
+  requires: [ChessEngine, GameStore]
+  note: |
+    Composes validateMove → applyMove → GameStore.save.
+    Atomic: Game is not persisted if validation fails.
+```
+
+```mdl
+op resignGame
+  desc: Player forfeits; opponent wins.
+  input:
+    game: Game
+    player: Player
+  output: Game                  # Game.status === finished, Game.winner set
+  errors:
+    GameOver: game has already ended
+  effects: [echo:write]
+  requires: [GameStore]
+```
+
+## Features
+
+```mdl
+feat F-1: Start Game
+
+  req F-1.1: New Board created with pieces in standard starting positions.
+  req F-1.2: White moves first.
+```
+
+```mdl
+feat F-2: Make Move
+
+  req F-2.1:
+    when: player submits a Move on their turn
+    then: Move validated against chess rules
+    errors: [InvalidMove, WrongTurn, GameOver]
+
+  req F-2.2:
+    when: Move is valid
+    then: Board updated; turn advances to opponent
+
+  req F-2.3:
+    when: resulting position leaves opponent's king in check
+    then: Board.status set to check
+
+  req F-2.4:
+    when: no legal moves remain for the side to move
+    then: Board.status set to checkmate (if in check) or stalemate
+```
+
+```mdl
+feat F-3: Lobby
+
+  req F-3.1: Player sees list of open games on entering the Lobby.
+  req F-3.2:
+    when: player creates a game
+    then: new Game created with status waiting; player assigned white
+
+  req F-3.3:
+    when: second player joins an open game
+    then: Game.status transitions to active; joining player assigned black
+
+  req F-3.4:
+    when: Game.status becomes active
+    then: both players navigated to Gameboard
+```
+
+```mdl
+feat F-4: Gameboard
+
+  req F-4.1:
+    when: player selects a square containing their piece
+    then: legal move targets highlighted on board
+
+  req F-4.2:
+    when: player selects a highlighted target square
+    then: Move submitted via submitMove(); board updated on success
+
+  req F-4.3:
+    when: pawn reaches the back rank
+    then: promotion dialog shown via overlay slot; player selects piece kind
+
+  req F-4.4:
+    when: Game.status is finished
+    then: result overlay shown (winner or draw); further moves disabled
+```
+
+```mdl
+feat F-5: Move Validation
+
+  req F-5.1:
+    when: Gameboard calls submitMove
+    then: op:validateMove runs before any state change
+
+  req F-5.2:
+    when: validation fails
+    then: error returned to caller; Game state unchanged
+
+  req F-5.3:
+    when: square is selected on Gameboard
+    then: op:getLegalMoves called; results drive component:Gameboard.highlights
+```
+
+```mdl
+feat F-6: Game Persistence
+
+  req F-6.1:
+    when: op:startGame completes
+    then: Game written to ECHO and visible in component:Lobby game list
+
+  req F-6.2:
+    when: op:submitMove completes
+    then: updated Game replicated to all peers via ECHO
+
+  req F-6.3:
+    when: peer receives a Game update
+    then: component:Gameboard re-renders with new Board state
+    tags: [collaborative]
+```
+
+## Acceptance
+
+```mdl
+test T-1: New game starting position
+  given: a new game is started
+  then:
+    - Board.turn === white
+    - Board.status === playing
+    - each player has 16 pieces in standard positions
+```
+
+```mdl
+test T-2: Illegal move rejected
+  given: it is white's turn
+  when: white attempts to move a black piece
+  then: WrongTurn error; Board unchanged
+```
+
+```mdl
+test T-3: Create and join game
+  given: two players are in the Lobby
+  when: player A creates a game, player B joins it
+  then:
+    - Game.status === active
+    - Game.players[0].color === white   # creator
+    - Game.players[1].color === black   # joiner
+    - both players see the Gameboard
+```
+
+```mdl
+test T-4: Legal move highlight
+  given: Gameboard is shown, it is white's turn
+  when: white selects the e2 pawn
+  then:
+    - squares e3 and e4 are highlighted
+    - no other squares are highlighted
+```
+
+```mdl
+test T-5: Pawn promotion
+  given: white pawn is on e7, it is white's turn
+  when: white moves pawn to e8
+  then:
+    - promotion overlay appears
+    - after player selects queen, Move recorded with promotion: queen
+    - board shows white queen on e8
+```
+
+```mdl
+test T-6: Submit valid move
+  given: active game, white's turn, white player logged in
+  when: white submits pawn e2→e4
+  then:
+    - op:validateMove returns move without error
+    - Board updated: e4 occupied by white pawn, e2 empty
+    - Game.board.turn === black
+    - Game persisted to ECHO
+```
+
+```mdl
+test T-7: Submit invalid move rejected atomically
+  given: active game, white's turn
+  when: white submits an illegal move (e2→e5)
+  then:
+    - IllegalMove error returned
+    - Game.board unchanged
+    - no ECHO write occurs
+```
+
+```mdl
+test T-8: Legal moves highlighted
+  given: new game, white's turn, Gameboard shown
+  when: player selects e2
+  then:
+    - op:getLegalMoves returns [e3, e4]
+    - Gameboard.highlights === [e3, e4]
+```
+
+---
+
+## Appendix: Extension Definitions
+
+Extension block types used in this document are defined below using
+the core `ext` primitive — the only construct the base language provides.
+
+```mdl
+ext type
+  uri: dxos.spec/ext/type@1.0
+  desc: A named data structure with typed fields and optional literals.
+  fields:
+    desc?: Prose
+    fields?: FieldMap        # name[?]: TypeExpr  (# inline comment)
+    literals?: UnionList     # a | b | c
+    extends?: TypeRef[]
+```
+
+```mdl
+ext feat
+  uri: dxos.spec/ext/feat@1.0
+  desc: A named feature grouping one or more requirements.
+  fields:
+    desc?: Prose
+    req: RequirementList
+  nesting: self              # feat blocks may contain feat blocks
+```
+
+```mdl
+ext test
+  uri: dxos.spec/ext/test@1.0
+  desc: An acceptance scenario expressed as given / when / then steps.
+  fields:
+    given?: Step | Step[]
+    when?: Step | Step[]
+    then: Step | Step[]
+    tags?: TagList
+```
+
+```mdl
+ext component
+  uri: org.dxos.mdl.component@1.0
+  desc: A UI component with props, internal state, slots, actions, and events.
+  fields:
+    desc?: Prose
+    props?: FieldMap            # external inputs (immutable inside component)
+    state?: FieldMap            # internal reactive state
+    slots?: FieldMap            # named ReactNode injection points
+    actions?: ActionMap         # methods the component exposes or handles
+    emits?: EventMap            # events the component raises to its parent
+    layout?: CodeBlock          # ASCII sketch of visual structure (non-normative)
+```
+
+```mdl
+ext op
+  uri: org.dxos.mdl.op@1.0
+  desc: |
+    A named operation with typed inputs, outputs, and declared errors.
+    Pure ops have no effects or requires. Effectful ops declare both.
+  fields:
+    desc?: Prose
+    input?: FieldMap            # named input parameters
+    output?: TypeExpr           # return type
+    errors?: ErrorMap           # name: Prose  (when this error occurs)
+    effects?: EffectList        # echo:read | echo:write | http | fs | ...
+    requires?: ServiceList      # injected service dependencies
+    note?: Prose                # implementation guidance (non-normative)
+```
+
+```mdl
+ext service
+  uri: org.dxos.mdl.service@1.0
+  desc: An external or system-level dependency providing named operations.
+  fields:
+    desc?: Prose
+    loading?: eager | lazy
+    ops?: OpMap                 # name(params) → ReturnType
+    errors?: ErrorMap
+    note?: Prose
+```

package/README.md

@@ -12,4 +12,4 @@ Surface plugin for Stack entities.
 
 Your ideas, issues, and code are most welcome. Please take a look at our [community code of conduct](https://github.com/dxos/dxos/blob/main/CODE_OF_CONDUCT.md), the [issue guide](https://github.com/dxos/dxos/blob/main/CONTRIBUTING.md#submitting-issues), and the [PR contribution guide](https://github.com/dxos/dxos/blob/main/CONTRIBUTING.md#submitting-prs).
 
-License: [MIT](./LICENSE) Copyright 2023 © DXOS
+License: [FSL-1.1-Apache-2.0](./LICENSE) Copyright 2023 © DXOS