@kokimoki/app 1.6.0 → 1.7.1

package/dist/kokimoki.min.d.ts

@@ -24,102 +24,6 @@ interface Upload {
     tags: string[];
 }
 
-interface FieldOptions {
-    label?: string;
-}
-declare abstract class Field<T> {
-    readonly options: FieldOptions;
-    constructor(options: FieldOptions);
-    abstract get value(): T;
-    abstract get schema(): any;
-}
-declare class BooleanField extends Field<boolean> {
-    value: boolean;
-    constructor(value: boolean, options?: FieldOptions);
-    get schema(): {
-        type: string;
-        default: boolean;
-    };
-}
-declare class ConstField<T extends string> extends Field<string extends T ? never : T> {
-    value: string extends T ? never : T;
-    constructor(value: string extends T ? never : T, options?: FieldOptions);
-    get schema(): {
-        const: string extends T ? never : T;
-    };
-}
-declare class ImageField extends Field<string> {
-    value: string;
-    constructor(value: string, options?: FieldOptions);
-    get schema(): {
-        type: string;
-        default: string;
-    };
-}
-declare class TextField extends Field<string> {
-    value: string;
-    constructor(value: string, options?: FieldOptions);
-    get schema(): {
-        type: string;
-        default: string;
-    };
-}
-declare class EnumField<T extends Record<string, string>> extends Field<keyof T> {
-    enumValues: T;
-    value: keyof T;
-    constructor(enumValues: T, value: keyof T, options?: FieldOptions);
-    get schema(): {
-        enum: string[];
-    };
-}
-declare class IntegerField extends Field<number> {
-    value: number;
-    constructor(value: number, options?: FieldOptions);
-    get schema(): {
-        type: string;
-        default: number;
-    };
-}
-declare class FloatField extends Field<number> {
-    value: number;
-    constructor(value: number, options?: FieldOptions);
-    get schema(): {
-        type: string;
-        default: number;
-    };
-}
-declare class FormGroup<T extends Record<string, Field<any>>, O extends Record<string, Field<any>>> extends Field<{
-    [key in keyof T]: T[key]["value"];
-} & Partial<{
-    [key in keyof O]: O[key]["value"];
-}>> {
-    requiredFields: T;
-    optionalFields: O;
-    constructor(requiredFields: T, optionalFields?: O, options?: FieldOptions);
-    get value(): {
-        [key in keyof T]: T[key]["value"];
-    } & Partial<{
-        [key in keyof O]: O[key]["value"];
-    }>;
-    get schema(): {
-        type: string;
-        properties: any;
-        required: string[];
-    };
-}
-declare class FormArray<T> extends Field<T[]> {
-    private factory;
-    value: Field<T>["value"][];
-    constructor(factory: () => Field<T>, value: Field<T>["value"][], options?: FieldOptions);
-    get schema(): {
-        type: string;
-        items: any;
-        default: T[];
-    };
-}
-declare class Form<R extends Record<string, Field<any>>, O extends Record<string, Field<any>>> extends FormGroup<R, O> {
-}
-
 declare namespace KokimokiSchema {
     abstract class Generic<T> {
         abstract get defaultValue(): T;
@@ -405,6 +309,38 @@ declare class KokimokiClient<ClientContextT = any> extends KokimokiClient_base {
     queue<T extends KokimokiSchema.Generic<unknown>>(name: string, schema: T, mode: RoomSubscriptionMode, autoJoin?: boolean): KokimokiQueue<T>;
     awareness<T extends KokimokiSchema.Generic<unknown>>(name: string, dataSchema: T, initialData?: T["defaultValue"], autoJoin?: boolean): KokimokiAwareness<T>;
     reqRes<Req extends KokimokiSchema.Generic<unknown>, Res extends KokimokiSchema.Generic<unknown>>(serviceName: string, reqSchema: Req, resSchema: Res, handleRequest: (payload: Req["defaultValue"]) => Promise<Res["defaultValue"]>): KokimokiReqRes<Req, Res>;
+    /**
+     * Add a new entry to a leaderboard
+     * @param leaderboardName
+     * @param score
+     * @param metadata
+     * @returns
+     */
+    insertLeaderboardEntry<MetadataT, PrivateMetadataT>(leaderboardName: string, score: number, metadata: MetadataT, privateMetadata: PrivateMetadataT): Promise<{
+        rank: number;
+    }>;
+    /**
+     * Add or update latest entry to a leaderboard
+     * @param leaderboardName
+     * @param score
+     * @param metadata
+     * @param privateMetadata Can only be read using the leaderboard API
+     * @returns
+     */
+    upsertLeaderboardEntry<MetadataT, PrivateMetadataT>(leaderboardName: string, score: number, metadata: MetadataT, privateMetadata: PrivateMetadataT): Promise<{
+        rank: number;
+    }>;
+    /**
+     * List entries in a leaderboard
+     * @param leaderboardName
+     * @param skip
+     * @param limit
+     * @returns
+     */
+    listLeaderboardEntries<MetadataT>(leaderboardName: string, skip?: number, limit?: number): Promise<Paginated<{
+        score: number;
+        metadata: MetadataT;
+    }>>;
 }
 
 declare class RoomSubscription {
@@ -421,4 +357,4 @@ declare class RoomSubscription {
     close(): void;
 }
 
-export { BooleanField, ConstField, EnumField, Field, type FieldOptions, FloatField, Form, FormArray, FormGroup, ImageField, IntegerField, KokimokiAwareness, KokimokiClient, type KokimokiClientEvents, KokimokiQueue, KokimokiSchema, KokimokiStore, type Paginated, RoomSubscription, RoomSubscriptionMode, TextField, type Upload };
+export { KokimokiAwareness, KokimokiClient, type KokimokiClientEvents, KokimokiQueue, KokimokiSchema, KokimokiStore, type Paginated, RoomSubscription, RoomSubscriptionMode, type Upload };

package/dist/kokimoki.min.js

@@ -1,159 +1,6 @@
 import require$$1 from 'path';
 import require$$2 from 'fs';
 
-const defaultFieldOptions = {};
-class Field {
-    options;
-    constructor(options) {
-        this.options = options;
-    }
-}
-class BooleanField extends Field {
-    value;
-    constructor(value, options = defaultFieldOptions) {
-        super(options);
-        this.value = value;
-    }
-    get schema() {
-        return {
-            type: "boolean",
-            default: this.value,
-        };
-    }
-}
-class ConstField extends Field {
-    value;
-    constructor(value, options = defaultFieldOptions) {
-        super(options);
-        this.value = value;
-    }
-    get schema() {
-        return {
-            const: this.value,
-        };
-    }
-}
-class ImageField extends Field {
-    value;
-    constructor(value, options = defaultFieldOptions) {
-        super(options);
-        this.value = value;
-    }
-    get schema() {
-        return {
-            type: "string",
-            default: this.value,
-        };
-    }
-}
-class TextField extends Field {
-    value;
-    constructor(value, options = defaultFieldOptions) {
-        super(options);
-        this.value = value;
-    }
-    get schema() {
-        return {
-            type: "string",
-            default: this.value,
-        };
-    }
-}
-class EnumField extends Field {
-    enumValues;
-    value;
-    constructor(enumValues, value, options = defaultFieldOptions) {
-        super(options);
-        this.enumValues = enumValues;
-        this.value = value;
-    }
-    get schema() {
-        return {
-            enum: Object.keys(this.enumValues),
-        };
-    }
-}
-class IntegerField extends Field {
-    value;
-    constructor(value, options = defaultFieldOptions) {
-        super(options);
-        this.value = value;
-    }
-    get schema() {
-        return {
-            type: "integer",
-            default: this.value,
-        };
-    }
-}
-class FloatField extends Field {
-    value;
-    constructor(value, options = defaultFieldOptions) {
-        super(options);
-        this.value = value;
-    }
-    get schema() {
-        return {
-            type: "number",
-            default: this.value,
-        };
-    }
-}
-class FormGroup extends Field {
-    requiredFields;
-    optionalFields;
-    constructor(requiredFields, optionalFields = {}, options = defaultFieldOptions) {
-        super(options);
-        this.requiredFields = requiredFields;
-        this.optionalFields = optionalFields;
-    }
-    get value() {
-        const value = Object.entries(this.requiredFields).reduce((acc, [key, field]) => {
-            acc[key] = field.value;
-            return acc;
-        }, {});
-        Object.entries(this.optionalFields).forEach(([key, field]) => {
-            if (field.value !== undefined) {
-                value[key] = field.value;
-            }
-        });
-        return value;
-    }
-    get schema() {
-        const properties = {};
-        Object.entries(this.requiredFields).forEach(([key, field]) => {
-            properties[key] = field.schema;
-        });
-        Object.entries(this.optionalFields).forEach(([key, field]) => {
-            properties[key] = field.schema;
-        });
-        return {
-            type: "object",
-            properties,
-            required: Object.keys(this.requiredFields),
-        };
-    }
-}
-class FormArray extends Field {
-    factory;
-    value;
-    constructor(factory, value, options = defaultFieldOptions) {
-        super(options);
-        this.factory = factory;
-        this.value = value;
-    }
-    get schema() {
-        const field = this.factory();
-        return {
-            type: "array",
-            items: field.schema,
-            default: this.value,
-        };
-    }
-}
-class Form extends FormGroup {
-}
-
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
 function getDefaultExportFromCjs (x) {
@@ -639,7 +486,7 @@ function eventTargetAgnosticAddListener(emitter, name, listener, flags) {
 var eventsExports = events.exports;
 var EventEmitter$1 = /*@__PURE__*/getDefaultExportFromCjs(eventsExports);
 
-const KOKIMOKI_APP_VERSION = "1.6.0";
+const KOKIMOKI_APP_VERSION = "1.7.1";
 
 /**
  * Utility module to work with key-value stores.
@@ -15391,7 +15238,61 @@ class KokimokiClient extends EventEmitter$1 {
     reqRes(serviceName, reqSchema, resSchema, handleRequest) {
         return new KokimokiReqRes(this, serviceName, reqSchema, resSchema, handleRequest);
     }
+    /**
+     * Add a new entry to a leaderboard
+     * @param leaderboardName
+     * @param score
+     * @param metadata
+     * @returns
+     */
+    async insertLeaderboardEntry(leaderboardName, score, metadata, privateMetadata) {
+        const res = await fetch(`${this._apiUrl}/leaderboard-entries`, {
+            method: "POST",
+            headers: this.apiHeaders,
+            body: JSON.stringify({
+                leaderboardName,
+                score,
+                metadata,
+                privateMetadata,
+                upsert: false,
+            }),
+        });
+        return await res.json();
+    }
+    /**
+     * Add or update latest entry to a leaderboard
+     * @param leaderboardName
+     * @param score
+     * @param metadata
+     * @param privateMetadata Can only be read using the leaderboard API
+     * @returns
+     */
+    async upsertLeaderboardEntry(leaderboardName, score, metadata, privateMetadata) {
+        const res = await fetch(`${this._apiUrl}/leaderboard-entries`, {
+            method: "POST",
+            headers: this.apiHeaders,
+            body: JSON.stringify({
+                leaderboardName,
+                score,
+                metadata,
+                privateMetadata,
+                upsert: true,
+            }),
+        });
+        return await res.json();
+    }
+    /**
+     * List entries in a leaderboard
+     * @param leaderboardName
+     * @param skip
+     * @param limit
+     * @returns
+     */
+    async listLeaderboardEntries(leaderboardName, skip = 0, limit = 100) {
+        const res = await fetch(`${this._apiUrl}/leaderboard-entries?leaderboardName=${leaderboardName}&skip=${skip}&limit=${limit}`);
+        return await res.json();
+    }
 }
 
-export { BooleanField, ConstField, EnumField, Field, FloatField, Form, FormArray, FormGroup, ImageField, IntegerField, KokimokiAwareness, KokimokiClient, KokimokiQueue, KokimokiSchema, KokimokiStore, RoomSubscription, RoomSubscriptionMode, TextField };
+export { KokimokiAwareness, KokimokiClient, KokimokiQueue, KokimokiSchema, KokimokiStore, RoomSubscription, RoomSubscriptionMode };
 //# sourceMappingURL=kokimoki.min.js.map