@gbraver-burst-network/browser-sdk 1.8.1 → 1.9.0

package/lib/src/browser-sdk/battle-sdk.d.ts

@@ -1,6 +1,6 @@
-import type { Battle } from "@gbraver-burst-network/browser-core";
 import type { Command, GameState, Player } from "gbraver-burst-core";
 import { Observable } from "rxjs";
+import { Battle } from "./battle";
 /** コンストラクタのパラメータ */
 type Param = {
     /** プレイヤー情報 */

package/lib/src/browser-sdk/battle.d.ts

@@ -0,0 +1,27 @@
+import type { Command, GameState, Player } from "gbraver-burst-core";
+import { Observable } from "rxjs";
+/**
+ * バトル
+ * 本操作はログイン後に実行することを想定している
+ */
+export interface Battle {
+    /** プレイヤーの情報 */
+    player: Player;
+    /** 対戦相手の情報 */
+    enemy: Player;
+    /** ゲームの初期状態 */
+    initialState: GameState[];
+    /**
+     * バトルを進行させる
+     *
+     * @param command プレイヤーが入力するコマンド
+     * @return ゲーム結果
+     */
+    progress(command: Command): Promise<GameState[]>;
+    /**
+     * バトル強制終了の通知ストリーム
+     *
+     * @return 通知ストリーム
+     */
+    suddenlyBattleNotifier(): Observable<unknown>;
+}

package/lib/src/browser-sdk/battle.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/src/browser-sdk/browser-sdk.d.ts

@@ -1,4 +1,9 @@
-import type { CasualMatch, LoggedInUserDelete, LoginCheck, Logout, MailVerify, Ping, PrivateMatchCreate, PrivateMatchRoomEnter, UniversalLogin, UserMailGet, UserNameGet, UserPictureGet, WebsocketDisconnect, WebsocketErrorNotifier } from "@gbraver-burst-network/browser-core";
+import { CasualMatch } from "./casual-match";
+import { LoginCheck, Logout, UniversalLogin } from "./login";
+import { Ping } from "./ping";
+import { PrivateMatchCreate, PrivateMatchRoomEnter } from "./private-match";
+import { LoggedInUserDelete, MailVerify, UserMailGet, UserNameGet, UserPictureGet } from "./user";
+import { WebsocketDisconnect, WebsocketErrorNotifier } from "./websocket";
 /** ブラウザSDK */
 export interface BrowserSDK extends UniversalLogin, LoginCheck, Logout, Ping, CasualMatch, UserNameGet, UserPictureGet, UserMailGet, MailVerify, LoggedInUserDelete, WebsocketDisconnect, WebsocketErrorNotifier, PrivateMatchCreate, PrivateMatchRoomEnter {
 }

package/lib/src/browser-sdk/casual-match.d.ts

@@ -0,0 +1,16 @@
+import type { ArmDozerId, PilotId } from "gbraver-burst-core";
+import type { Battle } from "./battle";
+/**
+ * カジュアルマッチ
+ * 本操作はログイン後に実行することを想定している
+ */
+export interface CasualMatch {
+    /**
+     * カジュアルマッチをスタートさせる
+     *
+     * @param armdozerId 選択したアームドーザID
+     * @param pilotId 選択したパイロットID
+     * @return バトル
+     */
+    startCasualMatch(armdozerId: ArmDozerId, pilotId: PilotId): Promise<Battle>;
+}

package/lib/src/browser-sdk/casual-match.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/src/browser-sdk/login.d.ts

@@ -0,0 +1,39 @@
+/** ユニバーサルログイン */
+export interface UniversalLogin {
+    /**
+     * ログイン成功時のリダイレクトか否かを判定する
+     *
+     * @return 判定結果、trueでログイン成功時のリダイレクトである
+     */
+    isLoginSuccessRedirect(): boolean;
+    /**
+     * ログイン成功後の処理
+     *
+     * @return 処理完了後に発火するPromise
+     */
+    afterLoginSuccess(): Promise<void>;
+    /**
+     * ログインページに遷移する
+     *
+     * @return ログインページ遷移後に発火するPromise
+     */
+    gotoLoginPage(): Promise<void>;
+}
+/** ログインチェック */
+export interface LoginCheck {
+    /**
+     * ログインしているかをチェックする
+     *
+     * @return ログインしている場合trueを返す
+     */
+    isLogin(): Promise<boolean>;
+}
+/** ログアウト */
+export interface Logout {
+    /**
+     * ログアウトする
+     *
+     * @return ログアウト成功したら発火するPromise
+     */
+    logout(): Promise<void>;
+}

package/lib/src/browser-sdk/login.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/src/browser-sdk/ping.d.ts

@@ -0,0 +1,8 @@
+export interface Ping {
+    /**
+     * APIサーバと疎通確認を行う
+     *
+     * @return APIサーバから返されたメッセージ
+     */
+    ping(): Promise<string>;
+}

package/lib/src/browser-sdk/ping.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/src/browser-sdk/private-match-room-sdk.d.ts

@@ -1,4 +1,5 @@
-import { Battle, PrivateMatchRoom, PrivateMatchRoomID } from "@gbraver-burst-network/browser-core";
+import { Battle } from "./battle";
+import { PrivateMatchRoom, PrivateMatchRoomID } from "./private-match";
 /** プライベートマッチSDK */
 export declare class PrivateMatchRoomSDK implements PrivateMatchRoom {
     #private;

package/lib/src/browser-sdk/private-match.d.ts

@@ -0,0 +1,36 @@
+import { ArmDozerId, PilotId } from "gbraver-burst-core";
+import { Battle } from "./battle";
+/** プライベートマッチルーム生成 */
+export interface PrivateMatchCreate {
+    /**
+     * プライベートマッチルームを生成する
+     * @param armdozerId 選択したアームドーザのID
+     * @param pilotId 選択したパイロットのID
+     * @return 生成したプライベートマッチルームのID
+     */
+    createPrivateMatchRoom(armdozerId: ArmDozerId, pilotId: PilotId): Promise<PrivateMatchRoom>;
+}
+/** プライベートマッチルームID */
+export type PrivateMatchRoomID = string;
+/** プライベートマッチルーム */
+export interface PrivateMatchRoom {
+    /** ルームID、本プロパティを招待するユーザに共有する */
+    roomID: PrivateMatchRoomID;
+    /**
+     * マッチングが成立するまで待機する
+     * @return バトル
+     */
+    waitUntilMatching(): Promise<Battle>;
+}
+/** プライベートマッチルーム入室 */
+export interface PrivateMatchRoomEnter {
+    /**
+     * プライベートマッチルームに入室する
+     * マッチングに選ばれた場合はBattleを返すが、選ばれなかった場合はnullを返す
+     * @param private 入室するルームのID
+     * @param armdozerId 選択したアームドーザ
+     * @param pilotId 選択したパイロット
+     * @return マッチング結果
+     */
+    enterPrivateMatchRoom(roomID: PrivateMatchRoomID, armdozerId: ArmDozerId, pilotId: PilotId): Promise<Battle | null>;
+}

package/lib/src/browser-sdk/private-match.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/src/browser-sdk/user.d.ts

@@ -0,0 +1,45 @@
+/** ユーザ名取得 */
+export interface UserNameGet {
+    /**
+     * ユーザ名を取得する
+     *
+     * @return ユーザ名
+     */
+    getUserName(): Promise<string>;
+}
+/** ユーザ画像取得 */
+export interface UserPictureGet {
+    /**
+     * ユーザ画像URLを取得する
+     *
+     * @return ユーザ画像URL
+     */
+    getUserPictureURL(): Promise<string>;
+}
+/** ユーザメールアドレス取得 */
+export interface UserMailGet {
+    /**
+     * メールアドレスを取得する
+     *
+     * @return メールアドレス
+     */
+    getMail(): Promise<string>;
+}
+/** メール認証完了 */
+export interface MailVerify {
+    /**
+     * メール認証が完了しているか否か
+     *
+     * @return 判定結果、trueでメール認証が完了している
+     */
+    isMailVerified(): Promise<boolean>;
+}
+/** ユーザ削除削除 */
+export interface LoggedInUserDelete {
+    /**
+     * 現在ログインしているユーザを削除する
+     *
+     * @return 処理が完了したら発火するPromise
+     */
+    deleteLoggedInUser(): Promise<void>;
+}

package/lib/src/browser-sdk/user.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/src/browser-sdk/websocket.d.ts

@@ -0,0 +1,19 @@
+import { Observable } from "rxjs";
+/** Websocket切断 */
+export interface WebsocketDisconnect {
+    /**
+     * 内部的に保有するWebsocketコネクションを切断する
+     *
+     * @return 処理が完了したら発火するPromise
+     */
+    disconnectWebsocket(): Promise<unknown>;
+}
+/** Websocket エラー通知 */
+export interface WebsocketErrorNotifier {
+    /**
+     * WebSocketのエラーを通知する
+     *
+     * @return 通知ストリーム
+     */
+    websocketErrorNotifier(): Observable<unknown>;
+}

package/lib/src/browser-sdk/websocket.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/src/index.d.ts

@@ -1,2 +1,9 @@
+export type { Battle } from "./browser-sdk/battle";
 export type { BrowserSDK } from "./browser-sdk/browser-sdk";
 export { createBrowserSDK } from "./browser-sdk/browser-sdk";
+export type { CasualMatch } from "./browser-sdk/casual-match";
+export type { LoginCheck, Logout, UniversalLogin } from "./browser-sdk/login";
+export type { Ping } from "./browser-sdk/ping";
+export type { PrivateMatchCreate, PrivateMatchRoom, PrivateMatchRoomEnter, PrivateMatchRoomID, } from "./browser-sdk/private-match";
+export type { LoggedInUserDelete, MailVerify, UserMailGet, UserNameGet, UserPictureGet, } from "./browser-sdk/user";
+export type { WebsocketDisconnect, WebsocketErrorNotifier, } from "./browser-sdk/websocket";

package/lib/src/request/enter-private-match-room.d.ts

@@ -1,5 +1,5 @@
-import { PrivateMatchRoomID } from "@gbraver-burst-network/browser-core";
 import { ArmDozerId, PilotId } from "gbraver-burst-core";
+import { PrivateMatchRoomID } from "../browser-sdk/private-match";
 /** プライベートマッチルームエントリ */
 export type EnterPrivateMatchRoom = {
     action: "enter-private-match-room";

package/lib/src/request/private-match-make-polling.d.ts

@@ -1,5 +1,5 @@
-import { PrivateMatchRoomID } from "@gbraver-burst-network/browser-core";
 /** プライベートルームマッチポーリング */
+import { PrivateMatchRoomID } from "../browser-sdk/private-match";
 export type PrivateMatchMakePolling = {
     action: "private-match-make-polling";
     /** ルームID */

package/lib/src/websocket/enter-private-match-room.d.ts

@@ -1,5 +1,5 @@
-import { PrivateMatchRoomID } from "@gbraver-burst-network/browser-core";
 import { ArmDozerId, PilotId } from "gbraver-burst-core";
+import { PrivateMatchRoomID } from "../browser-sdk/private-match";
 import { BattleStart } from "../response/battle-start";
 import { RejectPrivateMatchEntry } from "../response/reject-private-match-entry";
 /**

package/lib/src/websocket/private-match-make-polling.d.ts

@@ -1,4 +1,4 @@
-import { PrivateMatchRoomID } from "@gbraver-burst-network/browser-core";
+import { PrivateMatchRoomID } from "../browser-sdk/private-match";
 import { BattleStart } from "../response/battle-start";
 /**
  * プライベートマッチングポーリング

package/package.json

@@ -1,39 +1,38 @@
 {
   "name": "@gbraver-burst-network/browser-sdk",
   "description": "gbraver burst browser sdk",
-  "version": "1.8.1",
+  "version": "1.9.0",
   "author": "Y.Takeuchi",
   "bugs": {
     "url": "https://github.com/kaidouji85/gbraver-burst-network/issues",
     "email": "kaidouji85@gmail.com"
   },
   "dependencies": {
-    "@auth0/auth0-spa-js": "^2.0.2",
-    "@gbraver-burst-network/browser-core": "^1.8.1",
+    "@auth0/auth0-spa-js": "^2.0.4",
     "gbraver-burst-core": "^1.16.4",
     "rxjs": "^7.8.0"
   },
   "devDependencies": {
     "@types/jest": "^29.4.0",
-    "@typescript-eslint/eslint-plugin": "^5.49.0",
-    "@typescript-eslint/parser": "^5.49.0",
+    "@typescript-eslint/eslint-plugin": "^5.53.0",
+    "@typescript-eslint/parser": "^5.53.0",
     "codehawk-cli": "^10.1.0",
-    "eslint": "^8.33.0",
+    "eslint": "^8.34.0",
     "eslint-plugin-jest": "^27.2.1",
     "eslint-plugin-simple-import-sort": "^10.0.0",
-    "jest": "^29.4.1",
+    "jest": "^29.4.3",
     "npm-run-all": "^4.1.5",
-    "prettier": "2.8.3",
+    "prettier": "2.8.4",
     "rimraf": "^4.1.2",
     "ts-jest": "^29.0.5",
-    "typescript": "^4.9.4",
+    "typescript": "^4.9.5",
     "webpack": "^5.75.0",
     "webpack-cli": "^5.0.1"
   },
   "files": [
     "lib"
   ],
-  "gitHead": "3ac3152242f02a6373680fceb87bb3b2e2c373a5",
+  "gitHead": "ab2f3ddfb2860d73404111c0986c9277f843e558",
   "homepage": "https://github.com/kaidouji85/gbraver-burst-network/tree/develop/packages/browser-sdk#readme",
   "keywords": [
     "browser",