@kokimoki/app 1.7.2 → 1.8.1

package/dist/kokimoki-client.d.ts

@@ -77,7 +77,7 @@ export declare class KokimokiClient<ClientContextT = any> extends KokimokiClient
     private sendUnsubscribeReq;
     join<T extends S.Generic<unknown>>(store: KokimokiStore<T>): Promise<void>;
     leave<T extends S.Generic<unknown>>(store: KokimokiStore<T>): Promise<void>;
-    transact(handler: (t: KokimokiTransaction) => void | Promise<void>): Promise<void>;
+    transact<ReturnT = void>(handler: (t: KokimokiTransaction) => ReturnT | Promise<ReturnT>): Promise<ReturnT>;
     close(): Promise<void>;
     getRoomHash<T extends S.Generic<unknown>>(store: KokimokiStore<T>): number;
     /** Initializers */
@@ -93,7 +93,7 @@ export declare class KokimokiClient<ClientContextT = any> extends KokimokiClient
      * @param metadata
      * @returns
      */
-    insertLeaderboardEntry<MetadataT, PrivateMetadataT>(leaderboardName: string, sortMethod: "asc" | "desc", score: number, metadata: MetadataT, privateMetadata: PrivateMetadataT): Promise<{
+    insertLeaderboardEntry<MetadataT, PrivateMetadataT>(leaderboardName: string, sortDir: "asc" | "desc", score: number, metadata: MetadataT, privateMetadata: PrivateMetadataT): Promise<{
         rank: number;
     }>;
     /**
@@ -104,7 +104,7 @@ export declare class KokimokiClient<ClientContextT = any> extends KokimokiClient
      * @param privateMetadata Can only be read using the leaderboard API
      * @returns
      */
-    upsertLeaderboardEntry<MetadataT, PrivateMetadataT>(leaderboardName: string, sortMethod: "asc" | "desc", score: number, metadata: MetadataT, privateMetadata: PrivateMetadataT): Promise<{
+    upsertLeaderboardEntry<MetadataT, PrivateMetadataT>(leaderboardName: string, sortDir: "asc" | "desc", score: number, metadata: MetadataT, privateMetadata: PrivateMetadataT): Promise<{
         rank: number;
     }>;
     /**
@@ -114,9 +114,21 @@ export declare class KokimokiClient<ClientContextT = any> extends KokimokiClient
      * @param limit
      * @returns
      */
-    listLeaderboardEntries<MetadataT>(leaderboardName: string, sortMethod: "asc" | "desc", skip?: number, limit?: number): Promise<Paginated<{
+    listLeaderboardEntries<MetadataT>(leaderboardName: string, sortDir: "asc" | "desc", skip?: number, limit?: number): Promise<Paginated<{
+        rank: number;
         score: number;
         metadata: MetadataT;
     }>>;
+    /**
+     * Get best entry in leaderboard for a client, defaults to current client
+     * @param leaderboardName
+     * @param sortDir
+     * @param clientId
+     */
+    getBestLeaderboardEntry<MetadataT>(leaderboardName: string, sortDir: "asc" | "desc", clientId?: string): Promise<{
+        rank: number;
+        score: number;
+        metadata: MetadataT;
+    }>;
 }
 export {};

package/dist/kokimoki-client.js

@@ -481,10 +481,10 @@ export class KokimokiClient extends EventEmitter {
         //   throw new Error("Client not connected");
         // }
         const transaction = new KokimokiTransaction(this);
-        await handler(transaction);
+        const returnValue = await handler(transaction);
         const { updates, consumedMessages } = await transaction.getUpdates();
         if (!updates.length) {
-            return;
+            return returnValue;
         }
         // Construct buffers
         const remoteUpdateWriter = new WsMessageWriter();
@@ -547,6 +547,7 @@ export class KokimokiClient extends EventEmitter {
             const reader = new WsMessageReader(localBuffer);
             this.handleRoomUpdateMessage(reader);
         }
+        return returnValue;
     }
     async close() {
         this._autoReconnect = false;
@@ -615,13 +616,13 @@ export class KokimokiClient extends EventEmitter {
      * @param metadata
      * @returns
      */
-    async insertLeaderboardEntry(leaderboardName, sortMethod, score, metadata, privateMetadata) {
+    async insertLeaderboardEntry(leaderboardName, sortDir, score, metadata, privateMetadata) {
         const res = await fetch(`${this._apiUrl}/leaderboard-entries`, {
             method: "POST",
             headers: this.apiHeaders,
             body: JSON.stringify({
                 leaderboardName,
-                sortMethod,
+                sortDir,
                 score,
                 metadata,
                 privateMetadata,
@@ -638,13 +639,13 @@ export class KokimokiClient extends EventEmitter {
      * @param privateMetadata Can only be read using the leaderboard API
      * @returns
      */
-    async upsertLeaderboardEntry(leaderboardName, sortMethod, score, metadata, privateMetadata) {
+    async upsertLeaderboardEntry(leaderboardName, sortDir, score, metadata, privateMetadata) {
         const res = await fetch(`${this._apiUrl}/leaderboard-entries`, {
             method: "POST",
             headers: this.apiHeaders,
             body: JSON.stringify({
                 leaderboardName,
-                sortMethod,
+                sortDir,
                 score,
                 metadata,
                 privateMetadata,
@@ -660,8 +661,18 @@ export class KokimokiClient extends EventEmitter {
      * @param limit
      * @returns
      */
-    async listLeaderboardEntries(leaderboardName, sortMethod, skip = 0, limit = 100) {
-        const res = await fetch(`${this._apiUrl}/leaderboard-entries?leaderboardName=${leaderboardName}&sortMethod=${sortMethod}&skip=${skip}&limit=${limit}`);
+    async listLeaderboardEntries(leaderboardName, sortDir, skip = 0, limit = 100) {
+        const res = await fetch(`${this._apiUrl}/leaderboard-entries?leaderboardName=${leaderboardName}&sortDir=${sortDir}&skip=${skip}&limit=${limit}`);
+        return await res.json();
+    }
+    /**
+     * Get best entry in leaderboard for a client, defaults to current client
+     * @param leaderboardName
+     * @param sortDir
+     * @param clientId
+     */
+    async getBestLeaderboardEntry(leaderboardName, sortDir, clientId) {
+        const res = await fetch(`${this._apiUrl}/leaderboard-entries/best?leaderboardName=${leaderboardName}&sortDir=${sortDir}&clientId=${clientId || this.id}`);
         return await res.json();
     }
 }

package/dist/kokimoki.min.d.ts

@@ -300,7 +300,7 @@ declare class KokimokiClient<ClientContextT = any> extends KokimokiClient_base {
     private sendUnsubscribeReq;
     join<T extends KokimokiSchema.Generic<unknown>>(store: KokimokiStore<T>): Promise<void>;
     leave<T extends KokimokiSchema.Generic<unknown>>(store: KokimokiStore<T>): Promise<void>;
-    transact(handler: (t: KokimokiTransaction) => void | Promise<void>): Promise<void>;
+    transact<ReturnT = void>(handler: (t: KokimokiTransaction) => ReturnT | Promise<ReturnT>): Promise<ReturnT>;
     close(): Promise<void>;
     getRoomHash<T extends KokimokiSchema.Generic<unknown>>(store: KokimokiStore<T>): number;
     /** Initializers */
@@ -316,7 +316,7 @@ declare class KokimokiClient<ClientContextT = any> extends KokimokiClient_base {
      * @param metadata
      * @returns
      */
-    insertLeaderboardEntry<MetadataT, PrivateMetadataT>(leaderboardName: string, sortMethod: "asc" | "desc", score: number, metadata: MetadataT, privateMetadata: PrivateMetadataT): Promise<{
+    insertLeaderboardEntry<MetadataT, PrivateMetadataT>(leaderboardName: string, sortDir: "asc" | "desc", score: number, metadata: MetadataT, privateMetadata: PrivateMetadataT): Promise<{
         rank: number;
     }>;
     /**
@@ -327,7 +327,7 @@ declare class KokimokiClient<ClientContextT = any> extends KokimokiClient_base {
      * @param privateMetadata Can only be read using the leaderboard API
      * @returns
      */
-    upsertLeaderboardEntry<MetadataT, PrivateMetadataT>(leaderboardName: string, sortMethod: "asc" | "desc", score: number, metadata: MetadataT, privateMetadata: PrivateMetadataT): Promise<{
+    upsertLeaderboardEntry<MetadataT, PrivateMetadataT>(leaderboardName: string, sortDir: "asc" | "desc", score: number, metadata: MetadataT, privateMetadata: PrivateMetadataT): Promise<{
         rank: number;
     }>;
     /**
@@ -337,10 +337,22 @@ declare class KokimokiClient<ClientContextT = any> extends KokimokiClient_base {
      * @param limit
      * @returns
      */
-    listLeaderboardEntries<MetadataT>(leaderboardName: string, sortMethod: "asc" | "desc", skip?: number, limit?: number): Promise<Paginated<{
+    listLeaderboardEntries<MetadataT>(leaderboardName: string, sortDir: "asc" | "desc", skip?: number, limit?: number): Promise<Paginated<{
+        rank: number;
         score: number;
         metadata: MetadataT;
     }>>;
+    /**
+     * Get best entry in leaderboard for a client, defaults to current client
+     * @param leaderboardName
+     * @param sortDir
+     * @param clientId
+     */
+    getBestLeaderboardEntry<MetadataT>(leaderboardName: string, sortDir: "asc" | "desc", clientId?: string): Promise<{
+        rank: number;
+        score: number;
+        metadata: MetadataT;
+    }>;
 }
 
 declare class RoomSubscription {

package/dist/kokimoki.min.js

@@ -486,7 +486,7 @@ function eventTargetAgnosticAddListener(emitter, name, listener, flags) {
 var eventsExports = events.exports;
 var EventEmitter$1 = /*@__PURE__*/getDefaultExportFromCjs(eventsExports);
 
-const KOKIMOKI_APP_VERSION = "1.7.2";
+const KOKIMOKI_APP_VERSION = "1.8.1";
 
 /**
  * Utility module to work with key-value stores.
@@ -15111,10 +15111,10 @@ class KokimokiClient extends EventEmitter$1 {
         //   throw new Error("Client not connected");
         // }
         const transaction = new KokimokiTransaction(this);
-        await handler(transaction);
+        const returnValue = await handler(transaction);
         const { updates, consumedMessages } = await transaction.getUpdates();
         if (!updates.length) {
-            return;
+            return returnValue;
         }
         // Construct buffers
         const remoteUpdateWriter = new WsMessageWriter();
@@ -15177,6 +15177,7 @@ class KokimokiClient extends EventEmitter$1 {
             const reader = new WsMessageReader(localBuffer);
             this.handleRoomUpdateMessage(reader);
         }
+        return returnValue;
     }
     async close() {
         this._autoReconnect = false;
@@ -15245,13 +15246,13 @@ class KokimokiClient extends EventEmitter$1 {
      * @param metadata
      * @returns
      */
-    async insertLeaderboardEntry(leaderboardName, sortMethod, score, metadata, privateMetadata) {
+    async insertLeaderboardEntry(leaderboardName, sortDir, score, metadata, privateMetadata) {
         const res = await fetch(`${this._apiUrl}/leaderboard-entries`, {
             method: "POST",
             headers: this.apiHeaders,
             body: JSON.stringify({
                 leaderboardName,
-                sortMethod,
+                sortDir,
                 score,
                 metadata,
                 privateMetadata,
@@ -15268,13 +15269,13 @@ class KokimokiClient extends EventEmitter$1 {
      * @param privateMetadata Can only be read using the leaderboard API
      * @returns
      */
-    async upsertLeaderboardEntry(leaderboardName, sortMethod, score, metadata, privateMetadata) {
+    async upsertLeaderboardEntry(leaderboardName, sortDir, score, metadata, privateMetadata) {
         const res = await fetch(`${this._apiUrl}/leaderboard-entries`, {
             method: "POST",
             headers: this.apiHeaders,
             body: JSON.stringify({
                 leaderboardName,
-                sortMethod,
+                sortDir,
                 score,
                 metadata,
                 privateMetadata,
@@ -15290,8 +15291,18 @@ class KokimokiClient extends EventEmitter$1 {
      * @param limit
      * @returns
      */
-    async listLeaderboardEntries(leaderboardName, sortMethod, skip = 0, limit = 100) {
-        const res = await fetch(`${this._apiUrl}/leaderboard-entries?leaderboardName=${leaderboardName}&sortMethod=${sortMethod}&skip=${skip}&limit=${limit}`);
+    async listLeaderboardEntries(leaderboardName, sortDir, skip = 0, limit = 100) {
+        const res = await fetch(`${this._apiUrl}/leaderboard-entries?leaderboardName=${leaderboardName}&sortDir=${sortDir}&skip=${skip}&limit=${limit}`);
+        return await res.json();
+    }
+    /**
+     * Get best entry in leaderboard for a client, defaults to current client
+     * @param leaderboardName
+     * @param sortDir
+     * @param clientId
+     */
+    async getBestLeaderboardEntry(leaderboardName, sortDir, clientId) {
+        const res = await fetch(`${this._apiUrl}/leaderboard-entries/best?leaderboardName=${leaderboardName}&sortDir=${sortDir}&clientId=${clientId || this.id}`);
         return await res.json();
     }
 }