@kokimoki/app 1.17.0 → 2.0.0

package/dist/kokimoki-storage.d.ts

@@ -0,0 +1,156 @@
+import { KokimokiClient } from "./kokimoki-client";
+import { Paginated } from "./types/common";
+import { Upload } from "./types/upload";
+/**
+ * Kokimoki Storage Service
+ *
+ * Provides file upload and management capabilities for game applications. Ideal for media files
+ * (images, videos, audio) and other data not suitable for real-time stores (JSON, text files).
+ *
+ * **Key Features:**
+ * - Upload files to cloud storage with CDN delivery
+ * - Tag-based organization and filtering
+ * - Query uploads by client, MIME type, or tags
+ * - Pagination support for large collections
+ * - Public CDN URLs for direct access
+ *
+ * **Common Use Cases:**
+ * - Player avatars and profile images
+ * - Game screenshots and replays
+ * - User-generated content
+ * - Asset uploads (levels, maps, custom skins)
+ * - JSON configuration files
+ *
+ * Access via `kmClient.storage`
+ *
+ * @example
+ * ```typescript
+ * // Upload an image
+ * const upload = await kmClient.storage.upload('avatar.jpg', imageBlob, ['profile']);
+ *
+ * // Query user's uploads
+ * const myUploads = await kmClient.storage.listUploads({
+ *   clientId: kmClient.id
+ * });
+ *
+ * // Use in store
+ * await kmClient.transact([store], (state) => {
+ *   state.playerAvatar = upload.url;
+ * });
+ * ```
+ */
+export declare class KokimokiStorage {
+    private readonly client;
+    constructor(client: KokimokiClient);
+    private createUpload;
+    private uploadChunks;
+    private completeUpload;
+    /**
+     * Upload a file to cloud storage.
+     *
+     * Uploads a file (Blob) to Kokimoki storage and returns an Upload object with a public CDN URL.
+     * Files are automatically chunked for efficient upload. The returned URL can be used directly
+     * in your application (e.g., in img tags or store state).
+     *
+     * @param name The filename for the upload
+     * @param blob The Blob object containing the file data
+     * @param tags Optional array of tags for organizing and filtering uploads (default: [])
+     * @returns A promise resolving to the Upload object with CDN URL and metadata
+     *
+     * @example
+     * ```typescript
+     * // Upload image with tags
+     * const upload = await kmClient.storage.upload(
+     *   'avatar.jpg',
+     *   imageBlob,
+     *   ['profile', 'avatar']
+     * );
+     *
+     * // Use the CDN URL
+     * console.log(upload.url); // https://cdn.kokimoki.com/...
+     *
+     * // Store in game state
+     * await kmClient.transact([store], (state) => {
+     *   state.players[kmClient.id].avatar = upload.url;
+     * });
+     * ```
+     */
+    upload(name: string, blob: Blob, tags?: string[]): Promise<Upload>;
+    /**
+     * Update metadata for an existing upload.
+     *
+     * Allows you to replace the tags associated with an upload. Useful for reorganizing
+     * or recategorizing uploaded files.
+     *
+     * @param id The upload ID to update
+     * @param update Object containing the new tags array
+     * @returns A promise resolving to the updated Upload object
+     *
+     * @example
+     * ```typescript
+     * // Update tags
+     * const updated = await kmClient.storage.updateUpload(upload.id, {
+     *   tags: ['archived', 'old-profile']
+     * });
+     * ```
+     */
+    updateUpload(id: string, update: {
+        tags?: string[];
+    }): Promise<Upload>;
+    /**
+     * Query uploaded files with filtering and pagination.
+     *
+     * Retrieves a list of uploads matching the specified criteria. Supports filtering by
+     * client (uploader), MIME types, and tags. Use pagination for large collections.
+     *
+     * @param filter Optional filter criteria
+     * @param filter.clientId Filter by uploader's client ID
+     * @param filter.mimeTypes Filter by MIME types (e.g., ['image/jpeg', 'image/png'])
+     * @param filter.tags Filter by tags (all specified tags must match)
+     * @param skip Number of results to skip for pagination (default: 0)
+     * @param limit Maximum number of results to return (default: 100)
+     * @returns A promise resolving to paginated Upload results with total count
+     *
+     * @example
+     * ```typescript
+     * // Get current user's images
+     * const myImages = await kmClient.storage.listUploads({
+     *   clientId: kmClient.id,
+     *   mimeTypes: ['image/jpeg', 'image/png']
+     * });
+     *
+     * // Get all profile avatars
+     * const avatars = await kmClient.storage.listUploads({
+     *   tags: ['profile', 'avatar']
+     * });
+     *
+     * // Pagination
+     * const page2 = await kmClient.storage.listUploads({}, 10, 10);
+     * ```
+     */
+    listUploads(filter?: {
+        clientId?: string;
+        mimeTypes?: string[];
+        tags?: string[];
+    }, skip?: number, limit?: number): Promise<Paginated<Upload>>;
+    /**
+     * Permanently delete an uploaded file.
+     *
+     * Removes the file from cloud storage and the CDN. The URL will no longer be accessible.
+     * This operation cannot be undone.
+     *
+     * @param id The upload ID to delete
+     * @returns A promise resolving to deletion confirmation
+     *
+     * @example
+     * ```typescript
+     * // Delete an upload
+     * const result = await kmClient.storage.deleteUpload(upload.id);
+     * console.log(`Deleted: ${result.deletedCount} file(s)`);
+     * ```
+     */
+    deleteUpload(id: string): Promise<{
+        acknowledged: boolean;
+        deletedCount: number;
+    }>;
+}

package/dist/kokimoki-storage.js

@@ -0,0 +1,208 @@
+/**
+ * Kokimoki Storage Service
+ *
+ * Provides file upload and management capabilities for game applications. Ideal for media files
+ * (images, videos, audio) and other data not suitable for real-time stores (JSON, text files).
+ *
+ * **Key Features:**
+ * - Upload files to cloud storage with CDN delivery
+ * - Tag-based organization and filtering
+ * - Query uploads by client, MIME type, or tags
+ * - Pagination support for large collections
+ * - Public CDN URLs for direct access
+ *
+ * **Common Use Cases:**
+ * - Player avatars and profile images
+ * - Game screenshots and replays
+ * - User-generated content
+ * - Asset uploads (levels, maps, custom skins)
+ * - JSON configuration files
+ *
+ * Access via `kmClient.storage`
+ *
+ * @example
+ * ```typescript
+ * // Upload an image
+ * const upload = await kmClient.storage.upload('avatar.jpg', imageBlob, ['profile']);
+ *
+ * // Query user's uploads
+ * const myUploads = await kmClient.storage.listUploads({
+ *   clientId: kmClient.id
+ * });
+ *
+ * // Use in store
+ * await kmClient.transact([store], (state) => {
+ *   state.playerAvatar = upload.url;
+ * });
+ * ```
+ */
+export class KokimokiStorage {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    // Storage
+    async createUpload(name, blob, tags) {
+        const res = await fetch(`${this.client.apiUrl}/uploads`, {
+            method: "POST",
+            headers: this.client.apiHeaders,
+            body: JSON.stringify({
+                name,
+                size: blob.size,
+                mimeType: blob.type,
+                tags,
+            }),
+        });
+        return await res.json();
+    }
+    async uploadChunks(blob, chunkSize, signedUrls) {
+        return await Promise.all(signedUrls.map(async (url, index) => {
+            const start = index * chunkSize;
+            const end = Math.min(start + chunkSize, blob.size);
+            const chunk = blob.slice(start, end);
+            const res = await fetch(url, { method: "PUT", body: chunk });
+            return JSON.parse(res.headers.get("ETag") || '""');
+        }));
+    }
+    async completeUpload(id, etags) {
+        const res = await fetch(`${this.client.apiUrl}/uploads/${id}`, {
+            method: "PUT",
+            headers: this.client.apiHeaders,
+            body: JSON.stringify({ etags }),
+        });
+        return await res.json();
+    }
+    /**
+     * Upload a file to cloud storage.
+     *
+     * Uploads a file (Blob) to Kokimoki storage and returns an Upload object with a public CDN URL.
+     * Files are automatically chunked for efficient upload. The returned URL can be used directly
+     * in your application (e.g., in img tags or store state).
+     *
+     * @param name The filename for the upload
+     * @param blob The Blob object containing the file data
+     * @param tags Optional array of tags for organizing and filtering uploads (default: [])
+     * @returns A promise resolving to the Upload object with CDN URL and metadata
+     *
+     * @example
+     * ```typescript
+     * // Upload image with tags
+     * const upload = await kmClient.storage.upload(
+     *   'avatar.jpg',
+     *   imageBlob,
+     *   ['profile', 'avatar']
+     * );
+     *
+     * // Use the CDN URL
+     * console.log(upload.url); // https://cdn.kokimoki.com/...
+     *
+     * // Store in game state
+     * await kmClient.transact([store], (state) => {
+     *   state.players[kmClient.id].avatar = upload.url;
+     * });
+     * ```
+     */
+    async upload(name, blob, tags = []) {
+        const { id, chunkSize, urls } = await this.createUpload(name, blob, tags);
+        const etags = await this.uploadChunks(blob, chunkSize, urls);
+        return await this.completeUpload(id, etags);
+    }
+    /**
+     * Update metadata for an existing upload.
+     *
+     * Allows you to replace the tags associated with an upload. Useful for reorganizing
+     * or recategorizing uploaded files.
+     *
+     * @param id The upload ID to update
+     * @param update Object containing the new tags array
+     * @returns A promise resolving to the updated Upload object
+     *
+     * @example
+     * ```typescript
+     * // Update tags
+     * const updated = await kmClient.storage.updateUpload(upload.id, {
+     *   tags: ['archived', 'old-profile']
+     * });
+     * ```
+     */
+    async updateUpload(id, update) {
+        const res = await fetch(`${this.client.apiUrl}/uploads/${id}`, {
+            method: "PUT",
+            headers: this.client.apiHeaders,
+            body: JSON.stringify(update),
+        });
+        return await res.json();
+    }
+    /**
+     * Query uploaded files with filtering and pagination.
+     *
+     * Retrieves a list of uploads matching the specified criteria. Supports filtering by
+     * client (uploader), MIME types, and tags. Use pagination for large collections.
+     *
+     * @param filter Optional filter criteria
+     * @param filter.clientId Filter by uploader's client ID
+     * @param filter.mimeTypes Filter by MIME types (e.g., ['image/jpeg', 'image/png'])
+     * @param filter.tags Filter by tags (all specified tags must match)
+     * @param skip Number of results to skip for pagination (default: 0)
+     * @param limit Maximum number of results to return (default: 100)
+     * @returns A promise resolving to paginated Upload results with total count
+     *
+     * @example
+     * ```typescript
+     * // Get current user's images
+     * const myImages = await kmClient.storage.listUploads({
+     *   clientId: kmClient.id,
+     *   mimeTypes: ['image/jpeg', 'image/png']
+     * });
+     *
+     * // Get all profile avatars
+     * const avatars = await kmClient.storage.listUploads({
+     *   tags: ['profile', 'avatar']
+     * });
+     *
+     * // Pagination
+     * const page2 = await kmClient.storage.listUploads({}, 10, 10);
+     * ```
+     */
+    async listUploads(filter = {}, skip = 0, limit = 100) {
+        const url = new URL("/uploads", this.client.apiUrl);
+        url.searchParams.set("skip", skip.toString());
+        url.searchParams.set("limit", limit.toString());
+        if (filter.clientId) {
+            url.searchParams.set("clientId", filter.clientId);
+        }
+        if (filter.mimeTypes) {
+            url.searchParams.set("mimeTypes", filter.mimeTypes.join());
+        }
+        if (filter.tags) {
+            url.searchParams.set("tags", filter.tags.join());
+        }
+        const res = await fetch(url.href, {
+            headers: this.client.apiHeaders,
+        });
+        return await res.json();
+    }
+    /**
+     * Permanently delete an uploaded file.
+     *
+     * Removes the file from cloud storage and the CDN. The URL will no longer be accessible.
+     * This operation cannot be undone.
+     *
+     * @param id The upload ID to delete
+     * @returns A promise resolving to deletion confirmation
+     *
+     * @example
+     * ```typescript
+     * // Delete an upload
+     * const result = await kmClient.storage.deleteUpload(upload.id);
+     * console.log(`Deleted: ${result.deletedCount} file(s)`);
+     * ```
+     */
+    async deleteUpload(id) {
+        const res = await fetch(`${this.client.apiUrl}/uploads/${id}`, {
+            method: "DELETE",
+            headers: this.client.apiHeaders,
+        });
+        return await res.json();
+    }
+}