@mnbroatch/boardgame.io 0.0.1

package/src/core/action-creators.ts

@@ -0,0 +1,159 @@
+/*
+ * Copyright 2017 The boardgame.io Authors
+ *
+ * Use of this source code is governed by a MIT-style
+ * license that can be found in the LICENSE file or at
+ * https://opensource.org/licenses/MIT.
+ */
+
+import * as Actions from './action-types';
+import type { SyncInfo, State, LogEntry } from '../types';
+import type { Operation } from 'rfc6902';
+
+/**
+ * Generate a move to be dispatched to the game move reducer.
+ *
+ * @param {string} type - The move type.
+ * @param {Array}  args - Additional arguments.
+ * @param {string}  playerID - The ID of the player making this action.
+ * @param {string}  credentials - (optional) The credentials for the player making this action.
+ */
+export const makeMove = (
+  type: string,
+  args?: any,
+  playerID?: string | null,
+  credentials?: string
+) => ({
+  type: Actions.MAKE_MOVE as typeof Actions.MAKE_MOVE,
+  payload: { type, args, playerID, credentials },
+});
+
+/**
+ * Generate a game event to be dispatched to the flow reducer.
+ *
+ * @param {string} type - The event type.
+ * @param {Array}  args - Additional arguments.
+ * @param {string}  playerID - The ID of the player making this action.
+ * @param {string}  credentials - (optional) The credentials for the player making this action.
+ */
+export const gameEvent = (
+  type: string,
+  args?: any,
+  playerID?: string | null,
+  credentials?: string
+) => ({
+  type: Actions.GAME_EVENT as typeof Actions.GAME_EVENT,
+  payload: { type, args, playerID, credentials },
+});
+
+/**
+ * Generate an automatic game event that is a side-effect of a move.
+ * @param {string} type - The event type.
+ * @param {Array}  args - Additional arguments.
+ * @param {string}  playerID - The ID of the player making this action.
+ * @param {string}  credentials - (optional) The credentials for the player making this action.
+ */
+export const automaticGameEvent = (
+  type: string,
+  args: any,
+  playerID?: string | null,
+  credentials?: string
+) => ({
+  type: Actions.GAME_EVENT as typeof Actions.GAME_EVENT,
+  payload: { type, args, playerID, credentials },
+  automatic: true,
+});
+
+export const sync = (info: SyncInfo) => ({
+  type: Actions.SYNC as typeof Actions.SYNC,
+  state: info.state,
+  log: info.log,
+  initialState: info.initialState,
+  clientOnly: true as const,
+});
+
+/**
+ * Used to update the Redux store's state with patch in response to
+ * an action coming from another player.
+ * @param prevStateID previous stateID
+ * @param stateID stateID after this patch
+ * @param {Operation[]} patch - The patch to apply.
+ * @param {LogEntry[]} deltalog - A log delta.
+ */
+export const patch = (
+  prevStateID: number,
+  stateID: number,
+  patch: Operation[],
+  deltalog: LogEntry[]
+) => ({
+  type: Actions.PATCH as typeof Actions.PATCH,
+  prevStateID,
+  stateID,
+  patch,
+  deltalog,
+  clientOnly: true as const,
+});
+
+/**
+ * Used to update the Redux store's state in response to
+ * an action coming from another player.
+ * @param {object} state - The state to restore.
+ * @param {Array} deltalog - A log delta.
+ */
+export const update = (state: State, deltalog: LogEntry[]) => ({
+  type: Actions.UPDATE as typeof Actions.UPDATE,
+  state,
+  deltalog,
+  clientOnly: true as const,
+});
+
+/**
+ * Used to reset the game state.
+ * @param {object} state - The initial state.
+ */
+export const reset = (state: State) => ({
+  type: Actions.RESET as typeof Actions.RESET,
+  state,
+  clientOnly: true as const,
+});
+
+/**
+ * Used to undo the last move.
+ * @param {string}  playerID - The ID of the player making this action.
+ * @param {string}  credentials - (optional) The credentials for the player making this action.
+ */
+export const undo = (playerID?: string | null, credentials?: string) => ({
+  type: Actions.UNDO as typeof Actions.UNDO,
+  payload: { type: null, args: null, playerID, credentials },
+});
+
+/**
+ * Used to redo the last undone move.
+ * @param {string}  playerID - The ID of the player making this action.
+ * @param {string}  credentials - (optional) The credentials for the player making this action.
+ */
+export const redo = (playerID?: string | null, credentials?: string) => ({
+  type: Actions.REDO as typeof Actions.REDO,
+  payload: { type: null, args: null, playerID, credentials },
+});
+
+/**
+ * Allows plugins to define their own actions and intercept them.
+ */
+export const plugin = (
+  type: string,
+  args?: any,
+  playerID?: string | null,
+  credentials?: string
+) => ({
+  type: Actions.PLUGIN as typeof Actions.PLUGIN,
+  payload: { type, args, playerID, credentials },
+});
+
+/**
+ * Private action used to strip transient metadata (e.g. errors) from the game
+ * state.
+ */
+export const stripTransients = () => ({
+  type: Actions.STRIP_TRANSIENTS as typeof Actions.STRIP_TRANSIENTS,
+});

package/src/core/action-types.ts

@@ -0,0 +1,18 @@
+/*
+ * Copyright 2017 The boardgame.io Authors
+ *
+ * Use of this source code is governed by a MIT-style
+ * license that can be found in the LICENSE file or at
+ * https://opensource.org/licenses/MIT.
+ */
+
+export const MAKE_MOVE = 'MAKE_MOVE';
+export const GAME_EVENT = 'GAME_EVENT';
+export const REDO = 'REDO';
+export const RESET = 'RESET';
+export const SYNC = 'SYNC';
+export const UNDO = 'UNDO';
+export const UPDATE = 'UPDATE';
+export const PATCH = 'PATCH';
+export const PLUGIN = 'PLUGIN';
+export const STRIP_TRANSIENTS = 'STRIP_TRANSIENTS';

package/src/core/backwards-compatibility.ts

@@ -0,0 +1,23 @@
+type MoveLimitOptions = {
+  minMoves?: number;
+  maxMoves?: number;
+  moveLimit?: number;
+};
+
+/**
+ * Adjust the given options to use the new minMoves/maxMoves if a legacy moveLimit was given
+ * @param options The options object to apply backwards compatibility to
+ * @param enforceMinMoves Use moveLimit to set both minMoves and maxMoves
+ */
+export function supportDeprecatedMoveLimit(
+  options: MoveLimitOptions,
+  enforceMinMoves = false
+) {
+  if (options.moveLimit) {
+    if (enforceMinMoves) {
+      options.minMoves = options.moveLimit;
+    }
+    options.maxMoves = options.moveLimit;
+    delete options.moveLimit;
+  }
+}

package/src/core/constants.ts

@@ -0,0 +1,6 @@
+/**
+ * Moves can return this when they want to indicate
+ * that the combination of arguments is illegal and
+ * the move ought to be discarded.
+ */
+export const INVALID_MOVE = 'INVALID_MOVE';

package/src/core/errors.ts

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2017 The boardgame.io Authors
+ *
+ * Use of this source code is governed by a MIT-style
+ * license that can be found in the LICENSE file or at
+ * https://opensource.org/licenses/MIT.
+ */
+
+export enum UpdateErrorType {
+  // The action’s credentials were missing or invalid
+  UnauthorizedAction = 'update/unauthorized_action',
+  // The action’s matchID was not found
+  MatchNotFound = 'update/match_not_found',
+  // Could not apply Patch operation (rfc6902).
+  PatchFailed = 'update/patch_failed',
+}
+
+export enum ActionErrorType {
+  // The action contained a stale state ID
+  StaleStateId = 'action/stale_state_id',
+  // The requested move is unknown or not currently available
+  UnavailableMove = 'action/unavailable_move',
+  // The move declared it was invalid (INVALID_MOVE constant)
+  InvalidMove = 'action/invalid_move',
+  // The player making the action is not currently active
+  InactivePlayer = 'action/inactive_player',
+  // The game has finished
+  GameOver = 'action/gameover',
+  // The requested action is disabled (e.g. undo/redo, events)
+  ActionDisabled = 'action/action_disabled',
+  // The requested action is not currently possible
+  ActionInvalid = 'action/action_invalid',
+  // The requested action was declared invalid by a plugin
+  PluginActionInvalid = 'action/plugin_invalid',
+}