@oasiz/sdk 1.8.2 → 1.8.3

package/README.md

@@ -134,6 +134,36 @@ Supported `device` presets:
 | `iphone-17e` | `390 × 844` |
 | `iphone-air` | `420 × 912` |
 
+### Player character animations
+
+Use the Jibble animation constants when wiring a player character atlas so you can reference known animation IDs during local development instead of publishing first and reading logs.
+
+```ts
+import { JIBBLE_ANIMATION, getJibbleAnimationId, oasiz } from "@oasiz/sdk";
+
+const character = await oasiz.getPlayerCharacter();
+if (!character) return;
+
+const atlas = character.textureAtlas;
+const walkBack = getJibbleAnimationId("walk", "back"); // "walk_n"
+const walkBackAnimation = atlas.animations.find((anim) => anim.animationId === walkBack);
+const idleFrontAnimation = atlas.animations.find(
+  (anim) => anim.animationId === JIBBLE_ANIMATION.Idle.South,
+);
+```
+
+Supported directional IDs use compass codes: `n`, `ne`, `e`, `se`, `s`, `sw`, `w`, `nw`. The helper accepts gameplay-facing aliases too: `front` -> `s`, `back` -> `n`, `left` -> `w`, `right` -> `e`.
+
+Unity exposes the same IDs:
+
+```csharp
+var walkBack = JibbleAnimations.GetId(
+  JibbleAnimationAction.Walk,
+  JibbleDirection.Back);
+
+var idleFront = JibbleAnimations.Idle.South;
+```
+
 ### Score
 
 #### `oasiz.submitScore(score: number)`

package/dist/index.cjs

@@ -20,6 +20,9 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  JIBBLE_ANIMATION: () => JIBBLE_ANIMATION,
+  JIBBLE_ANIMATION_IDS: () => JIBBLE_ANIMATION_IDS,
+  JIBBLE_DIRECTIONS: () => JIBBLE_DIRECTIONS,
   addScore: () => addScore,
   enableAppSimulator: () => enableAppSimulator,
   enableBackButtonTesting: () => enableBackButtonTesting,
@@ -27,6 +30,7 @@ __export(index_exports, {
   flushGameState: () => flushGameState,
   getGameId: () => getGameId,
   getGraphicsPerformance: () => getGraphicsPerformance,
+  getJibbleAnimationId: () => getJibbleAnimationId,
   getPlayerAvatar: () => getPlayerAvatar,
   getPlayerCharacter: () => getPlayerCharacter,
   getPlayerId: () => getPlayerId,
@@ -36,6 +40,7 @@ __export(index_exports, {
   getViewportInsets: () => getViewportInsets,
   leaveGame: () => leaveGame,
   loadGameState: () => loadGameState,
+  normalizeJibbleDirection: () => normalizeJibbleDirection,
   oasiz: () => oasiz,
   onBackButton: () => onBackButton,
   onLeaveGame: () => onLeaveGame,
@@ -1498,6 +1503,83 @@ function triggerHaptic(type) {
   }
 }
 
+// src/jibble.ts
+var JIBBLE_DIRECTIONS = [
+  "n",
+  "ne",
+  "e",
+  "se",
+  "s",
+  "sw",
+  "w",
+  "nw"
+];
+var JIBBLE_ANIMATION = {
+  Idle: {
+    North: "idle_n",
+    NorthEast: "idle_ne",
+    East: "idle_e",
+    SouthEast: "idle_se",
+    South: "idle_s",
+    SouthWest: "idle_sw",
+    West: "idle_w",
+    NorthWest: "idle_nw"
+  },
+  Walk: {
+    North: "walk_n",
+    NorthEast: "walk_ne",
+    East: "walk_e",
+    SouthEast: "walk_se",
+    South: "walk_s",
+    SouthWest: "walk_sw",
+    West: "walk_w",
+    NorthWest: "walk_nw"
+  },
+  Backflip: "backflip"
+};
+var JIBBLE_ANIMATION_IDS = [
+  JIBBLE_ANIMATION.Idle.North,
+  JIBBLE_ANIMATION.Idle.NorthEast,
+  JIBBLE_ANIMATION.Idle.East,
+  JIBBLE_ANIMATION.Idle.SouthEast,
+  JIBBLE_ANIMATION.Idle.South,
+  JIBBLE_ANIMATION.Idle.SouthWest,
+  JIBBLE_ANIMATION.Idle.West,
+  JIBBLE_ANIMATION.Idle.NorthWest,
+  JIBBLE_ANIMATION.Walk.North,
+  JIBBLE_ANIMATION.Walk.NorthEast,
+  JIBBLE_ANIMATION.Walk.East,
+  JIBBLE_ANIMATION.Walk.SouthEast,
+  JIBBLE_ANIMATION.Walk.South,
+  JIBBLE_ANIMATION.Walk.SouthWest,
+  JIBBLE_ANIMATION.Walk.West,
+  JIBBLE_ANIMATION.Walk.NorthWest,
+  JIBBLE_ANIMATION.Backflip
+];
+var JIBBLE_DIRECTION_ALIASES = {
+  n: "n",
+  ne: "ne",
+  e: "e",
+  se: "se",
+  s: "s",
+  sw: "sw",
+  w: "w",
+  nw: "nw",
+  front: "s",
+  back: "n",
+  left: "w",
+  right: "e"
+};
+function normalizeJibbleDirection(direction) {
+  return JIBBLE_DIRECTION_ALIASES[direction];
+}
+function getJibbleAnimationId(action, direction = "front") {
+  if (action === "backflip") {
+    return JIBBLE_ANIMATION.Backflip;
+  }
+  return `${action}_${normalizeJibbleDirection(direction)}`;
+}
+
 // src/log-overlay.ts
 var CONSOLE_METHODS = [
   "debug",
@@ -3344,6 +3426,10 @@ function getGraphicsPerformance() {
 var oasiz = {
   submitScore,
   enableAppSimulator,
+  getJibbleAnimationId,
+  jibbleAnimations: JIBBLE_ANIMATION,
+  jibbleAnimationIds: JIBBLE_ANIMATION_IDS,
+  jibbleDirections: JIBBLE_DIRECTIONS,
   addScore,
   setScore,
   getPlayerCharacter,
@@ -3392,6 +3478,9 @@ var oasiz = {
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  JIBBLE_ANIMATION,
+  JIBBLE_ANIMATION_IDS,
+  JIBBLE_DIRECTIONS,
   addScore,
   enableAppSimulator,
   enableBackButtonTesting,
@@ -3399,6 +3488,7 @@ var oasiz = {
   flushGameState,
   getGameId,
   getGraphicsPerformance,
+  getJibbleAnimationId,
   getPlayerAvatar,
   getPlayerCharacter,
   getPlayerId,
@@ -3408,6 +3498,7 @@ var oasiz = {
   getViewportInsets,
   leaveGame,
   loadGameState,
+  normalizeJibbleDirection,
   oasiz,
   onBackButton,
   onLeaveGame,

package/dist/index.d.cts

@@ -249,6 +249,38 @@ declare function getPlayerCharacter(): Promise<PlayerCharacter | null>;
 
 declare function triggerHaptic(type: HapticType): void;
 
+declare const JIBBLE_DIRECTIONS: readonly ["n", "ne", "e", "se", "s", "sw", "w", "nw"];
+type JibbleDirectionCode = (typeof JIBBLE_DIRECTIONS)[number];
+type JibbleFacingDirection = JibbleDirectionCode | "front" | "back" | "left" | "right";
+type JibbleAnimationAction = "idle" | "walk" | "backflip";
+declare const JIBBLE_ANIMATION: {
+    readonly Idle: {
+        readonly North: "idle_n";
+        readonly NorthEast: "idle_ne";
+        readonly East: "idle_e";
+        readonly SouthEast: "idle_se";
+        readonly South: "idle_s";
+        readonly SouthWest: "idle_sw";
+        readonly West: "idle_w";
+        readonly NorthWest: "idle_nw";
+    };
+    readonly Walk: {
+        readonly North: "walk_n";
+        readonly NorthEast: "walk_ne";
+        readonly East: "walk_e";
+        readonly SouthEast: "walk_se";
+        readonly South: "walk_s";
+        readonly SouthWest: "walk_sw";
+        readonly West: "walk_w";
+        readonly NorthWest: "walk_nw";
+    };
+    readonly Backflip: "backflip";
+};
+declare const JIBBLE_ANIMATION_IDS: readonly ["idle_n", "idle_ne", "idle_e", "idle_se", "idle_s", "idle_sw", "idle_w", "idle_nw", "walk_n", "walk_ne", "walk_e", "walk_se", "walk_s", "walk_sw", "walk_w", "walk_nw", "backflip"];
+type JibbleAnimationId = (typeof JIBBLE_ANIMATION_IDS)[number];
+declare function normalizeJibbleDirection(direction: JibbleFacingDirection): JibbleDirectionCode;
+declare function getJibbleAnimationId(action: JibbleAnimationAction, direction?: JibbleFacingDirection): JibbleAnimationId;
+
 declare function enableLogOverlay(options?: LogOverlayOptions): LogOverlayHandle;
 
 interface ShareRoomCodeOptions {
@@ -315,6 +347,32 @@ declare function flushGameState(): void;
 declare const oasiz: {
     submitScore: typeof submitScore;
     enableAppSimulator: typeof enableAppSimulator;
+    getJibbleAnimationId: typeof getJibbleAnimationId;
+    jibbleAnimations: {
+        readonly Idle: {
+            readonly North: "idle_n";
+            readonly NorthEast: "idle_ne";
+            readonly East: "idle_e";
+            readonly SouthEast: "idle_se";
+            readonly South: "idle_s";
+            readonly SouthWest: "idle_sw";
+            readonly West: "idle_w";
+            readonly NorthWest: "idle_nw";
+        };
+        readonly Walk: {
+            readonly North: "walk_n";
+            readonly NorthEast: "walk_ne";
+            readonly East: "walk_e";
+            readonly SouthEast: "walk_se";
+            readonly South: "walk_s";
+            readonly SouthWest: "walk_sw";
+            readonly West: "walk_w";
+            readonly NorthWest: "walk_nw";
+        };
+        readonly Backflip: "backflip";
+    };
+    jibbleAnimationIds: readonly ["idle_n", "idle_ne", "idle_e", "idle_se", "idle_s", "idle_sw", "idle_w", "idle_nw", "walk_n", "walk_ne", "walk_e", "walk_se", "walk_s", "walk_sw", "walk_w", "walk_nw", "backflip"];
+    jibbleDirections: readonly ["n", "ne", "e", "se", "s", "sw", "w", "nw"];
     addScore: typeof addScore;
     setScore: typeof setScore;
     getPlayerCharacter: typeof getPlayerCharacter;
@@ -346,4 +404,4 @@ declare const oasiz: {
     readonly graphicsPerformance: GraphicsPerformanceMetric;
 };
 
-export { type AppSimulatorDevice, type AppSimulatorDeviceName, type AppSimulatorHandle, type AppSimulatorOptions, type AppSimulatorOrientation, type BackButtonTestingHandle, type BackButtonTestingOptions, type FacingFrameMap, type GameState, type GraphicsPerformanceMetric, type GraphicsPerformanceTier, type HapticType, type LogOverlayEntry, type LogOverlayHandle, type LogOverlayLevel, type LogOverlayOptions, type PlayerCharacter, type ScoreEditResult, type ShareRequest, type ShareRoomCodeOptions, type TextureAtlas, type TextureAtlasAnimation, type TextureAtlasFrame, type Unsubscribe, type ViewportInsetEdges, type ViewportInsetSide, type ViewportInsets, addScore, enableAppSimulator, enableBackButtonTesting, enableLogOverlay, flushGameState, getGameId, getGraphicsPerformance, getPlayerAvatar, getPlayerCharacter, getPlayerId, getPlayerName, getRoomCode, getSafeAreaTop, getViewportInsets, leaveGame, loadGameState, oasiz, onBackButton, onLeaveGame, onPause, onResume, openInviteModal, saveGameState, setLeaderboardVisible, setScore, share, shareRoomCode, submitScore, triggerHaptic };
+export { type AppSimulatorDevice, type AppSimulatorDeviceName, type AppSimulatorHandle, type AppSimulatorOptions, type AppSimulatorOrientation, type BackButtonTestingHandle, type BackButtonTestingOptions, type FacingFrameMap, type GameState, type GraphicsPerformanceMetric, type GraphicsPerformanceTier, type HapticType, JIBBLE_ANIMATION, JIBBLE_ANIMATION_IDS, JIBBLE_DIRECTIONS, type JibbleAnimationAction, type JibbleAnimationId, type JibbleDirectionCode, type JibbleFacingDirection, type LogOverlayEntry, type LogOverlayHandle, type LogOverlayLevel, type LogOverlayOptions, type PlayerCharacter, type ScoreEditResult, type ShareRequest, type ShareRoomCodeOptions, type TextureAtlas, type TextureAtlasAnimation, type TextureAtlasFrame, type Unsubscribe, type ViewportInsetEdges, type ViewportInsetSide, type ViewportInsets, addScore, enableAppSimulator, enableBackButtonTesting, enableLogOverlay, flushGameState, getGameId, getGraphicsPerformance, getJibbleAnimationId, getPlayerAvatar, getPlayerCharacter, getPlayerId, getPlayerName, getRoomCode, getSafeAreaTop, getViewportInsets, leaveGame, loadGameState, normalizeJibbleDirection, oasiz, onBackButton, onLeaveGame, onPause, onResume, openInviteModal, saveGameState, setLeaderboardVisible, setScore, share, shareRoomCode, submitScore, triggerHaptic };

package/dist/index.d.ts

@@ -249,6 +249,38 @@ declare function getPlayerCharacter(): Promise<PlayerCharacter | null>;
 
 declare function triggerHaptic(type: HapticType): void;
 
+declare const JIBBLE_DIRECTIONS: readonly ["n", "ne", "e", "se", "s", "sw", "w", "nw"];
+type JibbleDirectionCode = (typeof JIBBLE_DIRECTIONS)[number];
+type JibbleFacingDirection = JibbleDirectionCode | "front" | "back" | "left" | "right";
+type JibbleAnimationAction = "idle" | "walk" | "backflip";
+declare const JIBBLE_ANIMATION: {
+    readonly Idle: {
+        readonly North: "idle_n";
+        readonly NorthEast: "idle_ne";
+        readonly East: "idle_e";
+        readonly SouthEast: "idle_se";
+        readonly South: "idle_s";
+        readonly SouthWest: "idle_sw";
+        readonly West: "idle_w";
+        readonly NorthWest: "idle_nw";
+    };
+    readonly Walk: {
+        readonly North: "walk_n";
+        readonly NorthEast: "walk_ne";
+        readonly East: "walk_e";
+        readonly SouthEast: "walk_se";
+        readonly South: "walk_s";
+        readonly SouthWest: "walk_sw";
+        readonly West: "walk_w";
+        readonly NorthWest: "walk_nw";
+    };
+    readonly Backflip: "backflip";
+};
+declare const JIBBLE_ANIMATION_IDS: readonly ["idle_n", "idle_ne", "idle_e", "idle_se", "idle_s", "idle_sw", "idle_w", "idle_nw", "walk_n", "walk_ne", "walk_e", "walk_se", "walk_s", "walk_sw", "walk_w", "walk_nw", "backflip"];
+type JibbleAnimationId = (typeof JIBBLE_ANIMATION_IDS)[number];
+declare function normalizeJibbleDirection(direction: JibbleFacingDirection): JibbleDirectionCode;
+declare function getJibbleAnimationId(action: JibbleAnimationAction, direction?: JibbleFacingDirection): JibbleAnimationId;
+
 declare function enableLogOverlay(options?: LogOverlayOptions): LogOverlayHandle;
 
 interface ShareRoomCodeOptions {
@@ -315,6 +347,32 @@ declare function flushGameState(): void;
 declare const oasiz: {
     submitScore: typeof submitScore;
     enableAppSimulator: typeof enableAppSimulator;
+    getJibbleAnimationId: typeof getJibbleAnimationId;
+    jibbleAnimations: {
+        readonly Idle: {
+            readonly North: "idle_n";
+            readonly NorthEast: "idle_ne";
+            readonly East: "idle_e";
+            readonly SouthEast: "idle_se";
+            readonly South: "idle_s";
+            readonly SouthWest: "idle_sw";
+            readonly West: "idle_w";
+            readonly NorthWest: "idle_nw";
+        };
+        readonly Walk: {
+            readonly North: "walk_n";
+            readonly NorthEast: "walk_ne";
+            readonly East: "walk_e";
+            readonly SouthEast: "walk_se";
+            readonly South: "walk_s";
+            readonly SouthWest: "walk_sw";
+            readonly West: "walk_w";
+            readonly NorthWest: "walk_nw";
+        };
+        readonly Backflip: "backflip";
+    };
+    jibbleAnimationIds: readonly ["idle_n", "idle_ne", "idle_e", "idle_se", "idle_s", "idle_sw", "idle_w", "idle_nw", "walk_n", "walk_ne", "walk_e", "walk_se", "walk_s", "walk_sw", "walk_w", "walk_nw", "backflip"];
+    jibbleDirections: readonly ["n", "ne", "e", "se", "s", "sw", "w", "nw"];
     addScore: typeof addScore;
     setScore: typeof setScore;
     getPlayerCharacter: typeof getPlayerCharacter;
@@ -346,4 +404,4 @@ declare const oasiz: {
     readonly graphicsPerformance: GraphicsPerformanceMetric;
 };
 
-export { type AppSimulatorDevice, type AppSimulatorDeviceName, type AppSimulatorHandle, type AppSimulatorOptions, type AppSimulatorOrientation, type BackButtonTestingHandle, type BackButtonTestingOptions, type FacingFrameMap, type GameState, type GraphicsPerformanceMetric, type GraphicsPerformanceTier, type HapticType, type LogOverlayEntry, type LogOverlayHandle, type LogOverlayLevel, type LogOverlayOptions, type PlayerCharacter, type ScoreEditResult, type ShareRequest, type ShareRoomCodeOptions, type TextureAtlas, type TextureAtlasAnimation, type TextureAtlasFrame, type Unsubscribe, type ViewportInsetEdges, type ViewportInsetSide, type ViewportInsets, addScore, enableAppSimulator, enableBackButtonTesting, enableLogOverlay, flushGameState, getGameId, getGraphicsPerformance, getPlayerAvatar, getPlayerCharacter, getPlayerId, getPlayerName, getRoomCode, getSafeAreaTop, getViewportInsets, leaveGame, loadGameState, oasiz, onBackButton, onLeaveGame, onPause, onResume, openInviteModal, saveGameState, setLeaderboardVisible, setScore, share, shareRoomCode, submitScore, triggerHaptic };
+export { type AppSimulatorDevice, type AppSimulatorDeviceName, type AppSimulatorHandle, type AppSimulatorOptions, type AppSimulatorOrientation, type BackButtonTestingHandle, type BackButtonTestingOptions, type FacingFrameMap, type GameState, type GraphicsPerformanceMetric, type GraphicsPerformanceTier, type HapticType, JIBBLE_ANIMATION, JIBBLE_ANIMATION_IDS, JIBBLE_DIRECTIONS, type JibbleAnimationAction, type JibbleAnimationId, type JibbleDirectionCode, type JibbleFacingDirection, type LogOverlayEntry, type LogOverlayHandle, type LogOverlayLevel, type LogOverlayOptions, type PlayerCharacter, type ScoreEditResult, type ShareRequest, type ShareRoomCodeOptions, type TextureAtlas, type TextureAtlasAnimation, type TextureAtlasFrame, type Unsubscribe, type ViewportInsetEdges, type ViewportInsetSide, type ViewportInsets, addScore, enableAppSimulator, enableBackButtonTesting, enableLogOverlay, flushGameState, getGameId, getGraphicsPerformance, getJibbleAnimationId, getPlayerAvatar, getPlayerCharacter, getPlayerId, getPlayerName, getRoomCode, getSafeAreaTop, getViewportInsets, leaveGame, loadGameState, normalizeJibbleDirection, oasiz, onBackButton, onLeaveGame, onPause, onResume, openInviteModal, saveGameState, setLeaderboardVisible, setScore, share, shareRoomCode, submitScore, triggerHaptic };

package/dist/index.js

@@ -1444,6 +1444,83 @@ function triggerHaptic(type) {
   }
 }
 
+// src/jibble.ts
+var JIBBLE_DIRECTIONS = [
+  "n",
+  "ne",
+  "e",
+  "se",
+  "s",
+  "sw",
+  "w",
+  "nw"
+];
+var JIBBLE_ANIMATION = {
+  Idle: {
+    North: "idle_n",
+    NorthEast: "idle_ne",
+    East: "idle_e",
+    SouthEast: "idle_se",
+    South: "idle_s",
+    SouthWest: "idle_sw",
+    West: "idle_w",
+    NorthWest: "idle_nw"
+  },
+  Walk: {
+    North: "walk_n",
+    NorthEast: "walk_ne",
+    East: "walk_e",
+    SouthEast: "walk_se",
+    South: "walk_s",
+    SouthWest: "walk_sw",
+    West: "walk_w",
+    NorthWest: "walk_nw"
+  },
+  Backflip: "backflip"
+};
+var JIBBLE_ANIMATION_IDS = [
+  JIBBLE_ANIMATION.Idle.North,
+  JIBBLE_ANIMATION.Idle.NorthEast,
+  JIBBLE_ANIMATION.Idle.East,
+  JIBBLE_ANIMATION.Idle.SouthEast,
+  JIBBLE_ANIMATION.Idle.South,
+  JIBBLE_ANIMATION.Idle.SouthWest,
+  JIBBLE_ANIMATION.Idle.West,
+  JIBBLE_ANIMATION.Idle.NorthWest,
+  JIBBLE_ANIMATION.Walk.North,
+  JIBBLE_ANIMATION.Walk.NorthEast,
+  JIBBLE_ANIMATION.Walk.East,
+  JIBBLE_ANIMATION.Walk.SouthEast,
+  JIBBLE_ANIMATION.Walk.South,
+  JIBBLE_ANIMATION.Walk.SouthWest,
+  JIBBLE_ANIMATION.Walk.West,
+  JIBBLE_ANIMATION.Walk.NorthWest,
+  JIBBLE_ANIMATION.Backflip
+];
+var JIBBLE_DIRECTION_ALIASES = {
+  n: "n",
+  ne: "ne",
+  e: "e",
+  se: "se",
+  s: "s",
+  sw: "sw",
+  w: "w",
+  nw: "nw",
+  front: "s",
+  back: "n",
+  left: "w",
+  right: "e"
+};
+function normalizeJibbleDirection(direction) {
+  return JIBBLE_DIRECTION_ALIASES[direction];
+}
+function getJibbleAnimationId(action, direction = "front") {
+  if (action === "backflip") {
+    return JIBBLE_ANIMATION.Backflip;
+  }
+  return `${action}_${normalizeJibbleDirection(direction)}`;
+}
+
 // src/log-overlay.ts
 var CONSOLE_METHODS = [
   "debug",
@@ -3290,6 +3367,10 @@ function getGraphicsPerformance() {
 var oasiz = {
   submitScore,
   enableAppSimulator,
+  getJibbleAnimationId,
+  jibbleAnimations: JIBBLE_ANIMATION,
+  jibbleAnimationIds: JIBBLE_ANIMATION_IDS,
+  jibbleDirections: JIBBLE_DIRECTIONS,
   addScore,
   setScore,
   getPlayerCharacter,
@@ -3337,6 +3418,9 @@ var oasiz = {
   }
 };
 export {
+  JIBBLE_ANIMATION,
+  JIBBLE_ANIMATION_IDS,
+  JIBBLE_DIRECTIONS,
   addScore,
   enableAppSimulator,
   enableBackButtonTesting,
@@ -3344,6 +3428,7 @@ export {
   flushGameState,
   getGameId,
   getGraphicsPerformance,
+  getJibbleAnimationId,
   getPlayerAvatar,
   getPlayerCharacter,
   getPlayerId,
@@ -3353,6 +3438,7 @@ export {
   getViewportInsets,
   leaveGame,
   loadGameState,
+  normalizeJibbleDirection,
   oasiz,
   onBackButton,
   onLeaveGame,

package/package.json

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