@oasiz/sdk 1.0.2 → 1.2.0

package/README.md

@@ -260,10 +260,12 @@ offLeave();
 
 ## Multiplayer
 
-### `oasiz.shareRoomCode(code: string | null)`
+### `oasiz.shareRoomCode(code: string | null, options?: { inviteOverride?: boolean })`
 
 Notify the platform of the active multiplayer room so friends can join via the invite system. Pass `null` when leaving a room.
 
+Set `inviteOverride: true` when your game wants to hide the platform invite pill and render its own invite button/UI. The platform still tracks the room code, but your game owns the invite entry point.
+
 ```ts
 import { insertCoin, getRoomCode } from "playroomkit";
 import { oasiz } from "@oasiz/sdk";
@@ -275,6 +277,23 @@ oasiz.shareRoomCode(getRoomCode());
 oasiz.shareRoomCode(null);
 ```
 
+```ts
+// Game-owned invite UI: hide the platform pill, keep room tracking
+oasiz.shareRoomCode(getRoomCode(), { inviteOverride: true });
+```
+
+If you still want to use the platform invite sheet from your own in-game button, combine it with `openInviteModal()`:
+
+```ts
+import { openInviteModal, shareRoomCode } from "@oasiz/sdk";
+
+shareRoomCode("ABCD", { inviteOverride: true });
+
+inviteButton.addEventListener("click", () => {
+  openInviteModal();
+});
+```
+
 ### Read-only injected values
 
 These are populated by the platform before the game loads. Always check for `undefined` before using.

package/dist/index.cjs

@@ -33,6 +33,7 @@ __export(index_exports, {
   onLeaveGame: () => onLeaveGame,
   onPause: () => onPause,
   onResume: () => onResume,
+  openInviteModal: () => openInviteModal,
   saveGameState: () => saveGameState,
   shareRoomCode: () => shareRoomCode,
   submitScore: () => submitScore,
@@ -75,10 +76,10 @@ function getBridgeWindow2() {
   }
   return window;
 }
-function shareRoomCode(roomCode) {
+function shareRoomCode(roomCode, options) {
   const bridge = getBridgeWindow2();
   if (typeof bridge?.shareRoomCode === "function") {
-    bridge.shareRoomCode(roomCode);
+    bridge.shareRoomCode(roomCode, options);
     return;
   }
   if (isDevelopment2()) {
@@ -87,6 +88,18 @@ function shareRoomCode(roomCode) {
     );
   }
 }
+function openInviteModal() {
+  const bridge = getBridgeWindow2();
+  if (typeof bridge?.openInviteModal === "function") {
+    bridge.openInviteModal();
+    return;
+  }
+  if (isDevelopment2()) {
+    console.warn(
+      "[oasiz/sdk] openInviteModal bridge is unavailable. This is expected in local development."
+    );
+  }
+}
 function getGameId() {
   const bridge = getBridgeWindow2();
   return bridge?.__GAME_ID__;
@@ -315,6 +328,7 @@ var oasiz = {
   saveGameState,
   flushGameState,
   shareRoomCode,
+  openInviteModal,
   onPause,
   onResume,
   onBackButton,
@@ -348,6 +362,7 @@ var oasiz = {
   onLeaveGame,
   onPause,
   onResume,
+  openInviteModal,
   saveGameState,
   shareRoomCode,
   submitScore,

package/dist/index.d.cts

@@ -10,7 +10,21 @@ type GameState = Record<string, unknown>;
 
 declare function triggerHaptic(type: HapticType): void;
 
-declare function shareRoomCode(roomCode: string | null): void;
+interface ShareRoomCodeOptions {
+    inviteOverride?: boolean;
+}
+/**
+ * Notify the platform of the active multiplayer room so friends can join.
+ * Pass `{ inviteOverride: true }` when the game wants to hide the platform
+ * invite pill and own the invite UI itself.
+ */
+declare function shareRoomCode(roomCode: string | null, options?: ShareRoomCodeOptions): void;
+/**
+ * Ask the platform to open the invite-friends modal for the current game room.
+ * Only has effect when the platform has a room code (game has called shareRoomCode).
+ * No-op when the bridge is unavailable (e.g. local development).
+ */
+declare function openInviteModal(): void;
 declare function getGameId(): string | undefined;
 declare function getRoomCode(): string | undefined;
 declare function getPlayerName(): string | undefined;
@@ -39,6 +53,7 @@ declare const oasiz: {
     saveGameState: typeof saveGameState;
     flushGameState: typeof flushGameState;
     shareRoomCode: typeof shareRoomCode;
+    openInviteModal: typeof openInviteModal;
     onPause: typeof onPause;
     onResume: typeof onResume;
     onBackButton: typeof onBackButton;
@@ -50,4 +65,4 @@ declare const oasiz: {
     readonly playerAvatar: string | undefined;
 };
 
-export { type GameState, type HapticType, type ScoreAnchor, type ScoreConfig, type Unsubscribe, emitScoreConfig, flushGameState, getGameId, getPlayerAvatar, getPlayerName, getRoomCode, leaveGame, loadGameState, oasiz, onBackButton, onLeaveGame, onPause, onResume, saveGameState, shareRoomCode, submitScore, triggerHaptic };
+export { type GameState, type HapticType, type ScoreAnchor, type ScoreConfig, type ShareRoomCodeOptions, type Unsubscribe, emitScoreConfig, flushGameState, getGameId, getPlayerAvatar, getPlayerName, getRoomCode, leaveGame, loadGameState, oasiz, onBackButton, onLeaveGame, onPause, onResume, openInviteModal, saveGameState, shareRoomCode, submitScore, triggerHaptic };

package/dist/index.d.ts

@@ -10,7 +10,21 @@ type GameState = Record<string, unknown>;
 
 declare function triggerHaptic(type: HapticType): void;
 
-declare function shareRoomCode(roomCode: string | null): void;
+interface ShareRoomCodeOptions {
+    inviteOverride?: boolean;
+}
+/**
+ * Notify the platform of the active multiplayer room so friends can join.
+ * Pass `{ inviteOverride: true }` when the game wants to hide the platform
+ * invite pill and own the invite UI itself.
+ */
+declare function shareRoomCode(roomCode: string | null, options?: ShareRoomCodeOptions): void;
+/**
+ * Ask the platform to open the invite-friends modal for the current game room.
+ * Only has effect when the platform has a room code (game has called shareRoomCode).
+ * No-op when the bridge is unavailable (e.g. local development).
+ */
+declare function openInviteModal(): void;
 declare function getGameId(): string | undefined;
 declare function getRoomCode(): string | undefined;
 declare function getPlayerName(): string | undefined;
@@ -39,6 +53,7 @@ declare const oasiz: {
     saveGameState: typeof saveGameState;
     flushGameState: typeof flushGameState;
     shareRoomCode: typeof shareRoomCode;
+    openInviteModal: typeof openInviteModal;
     onPause: typeof onPause;
     onResume: typeof onResume;
     onBackButton: typeof onBackButton;
@@ -50,4 +65,4 @@ declare const oasiz: {
     readonly playerAvatar: string | undefined;
 };
 
-export { type GameState, type HapticType, type ScoreAnchor, type ScoreConfig, type Unsubscribe, emitScoreConfig, flushGameState, getGameId, getPlayerAvatar, getPlayerName, getRoomCode, leaveGame, loadGameState, oasiz, onBackButton, onLeaveGame, onPause, onResume, saveGameState, shareRoomCode, submitScore, triggerHaptic };
+export { type GameState, type HapticType, type ScoreAnchor, type ScoreConfig, type ShareRoomCodeOptions, type Unsubscribe, emitScoreConfig, flushGameState, getGameId, getPlayerAvatar, getPlayerName, getRoomCode, leaveGame, loadGameState, oasiz, onBackButton, onLeaveGame, onPause, onResume, openInviteModal, saveGameState, shareRoomCode, submitScore, triggerHaptic };

package/dist/index.js

@@ -33,10 +33,10 @@ function getBridgeWindow2() {
   }
   return window;
 }
-function shareRoomCode(roomCode) {
+function shareRoomCode(roomCode, options) {
   const bridge = getBridgeWindow2();
   if (typeof bridge?.shareRoomCode === "function") {
-    bridge.shareRoomCode(roomCode);
+    bridge.shareRoomCode(roomCode, options);
     return;
   }
   if (isDevelopment2()) {
@@ -45,6 +45,18 @@ function shareRoomCode(roomCode) {
     );
   }
 }
+function openInviteModal() {
+  const bridge = getBridgeWindow2();
+  if (typeof bridge?.openInviteModal === "function") {
+    bridge.openInviteModal();
+    return;
+  }
+  if (isDevelopment2()) {
+    console.warn(
+      "[oasiz/sdk] openInviteModal bridge is unavailable. This is expected in local development."
+    );
+  }
+}
 function getGameId() {
   const bridge = getBridgeWindow2();
   return bridge?.__GAME_ID__;
@@ -273,6 +285,7 @@ var oasiz = {
   saveGameState,
   flushGameState,
   shareRoomCode,
+  openInviteModal,
   onPause,
   onResume,
   onBackButton,
@@ -305,6 +318,7 @@ export {
   onLeaveGame,
   onPause,
   onResume,
+  openInviteModal,
   saveGameState,
   shareRoomCode,
   submitScore,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oasiz/sdk",
-  "version": "1.0.2",
+  "version": "1.2.0",
   "description": "Typed SDK for Oasiz game platform bridge APIs.",
   "type": "module",
   "main": "./dist/index.cjs",