@dcl/sdk 7.20.2-22169778016.commit-030cbfe → 7.20.2-22231111352.commit-d2f6f0a

package/src/server/storage/player.ts

@@ -1,156 +0,0 @@
-import { getStorageServerUrl } from '../storage-url'
-import { assertIsServer, wrapSignedFetch } from '../utils'
-import { GetValuesOptions, GetValuesResult, MODULE_NAME } from './constants'
-
-/**
- * Player-scoped storage interface for key-value pairs from the Server Side Storage service.
- * This is NOT filesystem storage - data is stored in the remote storage service.
- */
-export interface IPlayerStorage {
-  /**
-   * Retrieves a value from a player's storage by key from the Server Side Storage service.
-   * @param address - The player's wallet address
-   * @param key - The key to retrieve
-   * @returns A promise that resolves to the parsed JSON value, or null if not found
-   */
-  get<T = unknown>(address: string, key: string): Promise<T | null>
-
-  /**
-   * Stores a value in a player's storage in the Server Side Storage service.
-   * @param address - The player's wallet address
-   * @param key - The key to store the value under
-   * @param value - The value to store (will be JSON serialized)
-   * @returns A promise that resolves to true if successful, false otherwise
-   */
-  set<T = unknown>(address: string, key: string, value: T): Promise<boolean>
-
-  /**
-   * Deletes a value from a player's storage in the Server Side Storage service.
-   * @param address - The player's wallet address
-   * @param key - The key to delete
-   * @returns A promise that resolves to true if deleted, false if not found
-   */
-  delete(address: string, key: string): Promise<boolean>
-
-  /**
-   * Returns key-value entries from a player's storage, optionally filtered by prefix.
-   * Supports pagination via limit and offset.
-   * @param address - The player's wallet address
-   * @param options - Optional { prefix, limit, offset } for filtering and pagination.
-   * @returns A promise that resolves to { data, pagination: { offset, total } } for pagination UI
-   */
-  getValues(address: string, options?: GetValuesOptions): Promise<GetValuesResult>
-}
-
-/**
- * Creates player-scoped storage that provides methods to interact with
- * player-specific key-value pairs from the Server Side Storage service.
- * This module only works when running on server-side scenes.
- */
-export const createPlayerStorage = (): IPlayerStorage => {
-  return {
-    async get<T = unknown>(address: string, key: string): Promise<T | null> {
-      assertIsServer(MODULE_NAME)
-
-      const baseUrl = await getStorageServerUrl()
-      const url = `${baseUrl}/players/${encodeURIComponent(address)}/values/${encodeURIComponent(key)}`
-
-      const [error, data] = await wrapSignedFetch<{ value: T }>({ url })
-
-      if (error) {
-        console.error(`Failed to get player storage value '${key}' for '${address}': ${error}`)
-        return null
-      }
-
-      return data?.value ?? null
-    },
-
-    async set<T = unknown>(address: string, key: string, value: T): Promise<boolean> {
-      assertIsServer(MODULE_NAME)
-
-      const baseUrl = await getStorageServerUrl()
-      const url = `${baseUrl}/players/${encodeURIComponent(address)}/values/${encodeURIComponent(key)}`
-
-      const [error] = await wrapSignedFetch({
-        url,
-        init: {
-          method: 'PUT',
-          headers: {
-            'content-type': 'application/json'
-          },
-          body: JSON.stringify({ value })
-        }
-      })
-
-      if (error) {
-        console.error(`Failed to set player storage value '${key}' for '${address}': ${error}`)
-        return false
-      }
-
-      return true
-    },
-
-    async delete(address: string, key: string): Promise<boolean> {
-      assertIsServer(MODULE_NAME)
-
-      const baseUrl = await getStorageServerUrl()
-      const url = `${baseUrl}/players/${encodeURIComponent(address)}/values/${encodeURIComponent(key)}`
-
-      const [error] = await wrapSignedFetch({
-        url,
-        init: {
-          method: 'DELETE',
-          headers: {}
-        }
-      })
-
-      if (error) {
-        console.error(`Failed to delete player storage value '${key}' for '${address}': ${error}`)
-        return false
-      }
-
-      return true
-    },
-
-    async getValues(address: string, options?: GetValuesOptions): Promise<GetValuesResult> {
-      assertIsServer(MODULE_NAME)
-
-      const { prefix, limit, offset } = options ?? {}
-      const baseUrl = await getStorageServerUrl()
-      const parts: string[] = []
-
-      if (!!prefix) {
-        parts.push(`prefix=${encodeURIComponent(prefix)}`)
-      }
-
-      if (!!limit) {
-        parts.push(`limit=${limit}`)
-      }
-
-      if (!!offset) {
-        parts.push(`offset=${offset}`)
-      }
-
-      const query = parts.join('&')
-      const url = query
-        ? `${baseUrl}/players/${encodeURIComponent(address)}/values?${query}`
-        : `${baseUrl}/players/${encodeURIComponent(address)}/values`
-
-      const [error, response] = await wrapSignedFetch<GetValuesResult>({ url })
-
-      if (error) {
-        console.error(`Failed to get player storage values for '${address}': ${error}`)
-        return { data: [], pagination: { offset: 0, total: 0 } }
-      }
-
-      const data = response?.data ?? []
-      const requestedOffset = offset ?? 0
-      const pagination = {
-        offset: response?.pagination?.offset ?? requestedOffset,
-        total: response?.pagination?.total ?? data.length
-      }
-
-      return { data, pagination }
-    }
-  }
-}

package/src/server/storage/scene.ts

@@ -1,149 +0,0 @@
-import { getStorageServerUrl } from '../storage-url'
-import { assertIsServer, wrapSignedFetch } from '../utils'
-import { GetValuesOptions, GetValuesResult, MODULE_NAME } from './constants'
-
-/**
- * Scene-scoped storage interface for key-value pairs from the Server Side Storage service.
- * This is NOT filesystem storage - data is stored in the remote storage service.
- */
-export interface ISceneStorage {
-  /**
-   * Retrieves a value from scene storage by key from the Server Side Storage service.
-   * @param key - The key to retrieve
-   * @returns A promise that resolves to the parsed JSON value, or null if not found
-   */
-  get<T = unknown>(key: string): Promise<T | null>
-
-  /**
-   * Stores a value in scene storage in the Server Side Storage service.
-   * @param key - The key to store the value under
-   * @param value - The value to store (will be JSON serialized)
-   */
-  set<T = unknown>(key: string, value: T): Promise<boolean>
-
-  /**
-   * Deletes a value from scene storage in the Server Side Storage service.
-   * @param key - The key to delete
-   * @returns A promise that resolves to true if deleted, false if not found
-   */
-  delete(key: string): Promise<boolean>
-
-  /**
-   * Returns key-value entries from scene storage, optionally filtered by prefix.
-   * Supports pagination via limit and offset.
-   * @param options - Optional { prefix, limit, offset } for filtering and pagination.
-   * @returns A promise that resolves to { data, pagination: { offset, total } } for pagination UI
-   */
-  getValues(options?: GetValuesOptions): Promise<GetValuesResult>
-}
-
-/**
- * Creates scene-scoped storage that provides methods to interact with
- * scene-specific key-value pairs from the Server Side Storage service.
- * This module only works when running on server-side scenes.
- */
-export const createSceneStorage = (): ISceneStorage => {
-  return {
-    async get<T = unknown>(key: string): Promise<T | null> {
-      assertIsServer(MODULE_NAME)
-
-      const baseUrl = await getStorageServerUrl()
-      const url = `${baseUrl}/values/${encodeURIComponent(key)}`
-
-      const [error, data] = await wrapSignedFetch<{ value: T }>({ url })
-
-      if (error) {
-        console.error(`Failed to get storage value '${key}': ${error}`)
-        return null
-      }
-
-      return data?.value ?? null
-    },
-
-    async set<T = unknown>(key: string, value: T): Promise<boolean> {
-      assertIsServer(MODULE_NAME)
-
-      const baseUrl = await getStorageServerUrl()
-      const url = `${baseUrl}/values/${encodeURIComponent(key)}`
-
-      const [error] = await wrapSignedFetch({
-        url,
-        init: {
-          method: 'PUT',
-          headers: {
-            'content-type': 'application/json'
-          },
-          body: JSON.stringify({ value })
-        }
-      })
-
-      if (error) {
-        console.error(`Failed to set storage value '${key}': ${error}`)
-        return false
-      }
-
-      return true
-    },
-
-    async delete(key: string): Promise<boolean> {
-      assertIsServer(MODULE_NAME)
-
-      const baseUrl = await getStorageServerUrl()
-      const url = `${baseUrl}/values/${encodeURIComponent(key)}`
-
-      const [error] = await wrapSignedFetch({
-        url,
-        init: {
-          method: 'DELETE',
-          headers: {}
-        }
-      })
-
-      if (error) {
-        console.error(`Failed to delete storage value '${key}': ${error}`)
-        return false
-      }
-
-      return true
-    },
-
-    async getValues(options?: GetValuesOptions): Promise<GetValuesResult> {
-      assertIsServer(MODULE_NAME)
-
-      const { prefix, limit, offset } = options ?? {}
-      const baseUrl = await getStorageServerUrl()
-      const parts: string[] = []
-
-      if (!!prefix) {
-        parts.push(`prefix=${encodeURIComponent(prefix)}`)
-      }
-
-      if (!!limit) {
-        parts.push(`limit=${limit}`)
-      }
-
-      if (!!offset) {
-        parts.push(`offset=${offset}`)
-      }
-
-      const query = parts.join('&')
-      const url = query ? `${baseUrl}/values?${query}` : `${baseUrl}/values`
-
-      const [error, response] = await wrapSignedFetch<GetValuesResult>({ url })
-
-      if (error) {
-        console.error(`Failed to get storage values: ${error}`)
-        return { data: [], pagination: { offset: 0, total: 0 } }
-      }
-
-      const data = response?.data ?? []
-      const requestedOffset = offset ?? 0
-      const pagination = {
-        offset: response?.pagination?.offset ?? requestedOffset,
-        total: response?.pagination?.total ?? data.length
-      }
-
-      return { data, pagination }
-    }
-  }
-}

package/src/server/storage-url.ts

@@ -1,34 +0,0 @@
-import { getRealm } from '~system/Runtime'
-
-const STORAGE_SERVER_ORG = 'https://storage.decentraland.org'
-const STORAGE_SERVER_ZONE = 'https://storage.decentraland.zone'
-
-/**
- * Determines the correct storage server URL based on the current realm.
- *
- * - If `isPreview` is true, uses the realm's baseUrl (localhost)
- * - If the realm's baseUrl contains `.zone`, uses storage.decentraland.zone
- * - Otherwise, uses storage.decentraland.org (production)
- *
- * @returns The storage server base URL
- */
-export async function getStorageServerUrl(): Promise<string> {
-  const { realmInfo } = await getRealm({})
-
-  if (!realmInfo) {
-    throw new Error('Unable to retrieve realm information')
-  }
-
-  // Local development / preview mode
-  if (realmInfo.isPreview) {
-    return realmInfo.baseUrl
-  }
-
-  // Staging / testing environment
-  if (realmInfo.baseUrl.includes('.zone')) {
-    return STORAGE_SERVER_ZONE
-  }
-
-  // Production environment
-  return STORAGE_SERVER_ORG
-}

package/src/server/utils.ts

@@ -1,73 +0,0 @@
-import { signedFetch, SignedFetchRequest } from '~system/SignedFetch'
-import { isServer } from '../network'
-
-/**
- * Validates that the code is running on a server-side scene.
- * Throws an error if called from a client-side context.
- *
- * @param moduleName - The name of the module for the error message
- * @throws Error if not running on a server-side scene
- */
-export function assertIsServer(moduleName: string): void {
-  if (!isServer()) {
-    throw new Error(`${moduleName} is only available on server-side scenes`)
-  }
-}
-
-/**
- * Result type for operations that can fail.
- * Returns a tuple of [error, null] on failure or [null, data] on success.
- */
-export type Result<T, E = string> = [E, null] | [null, T]
-
-/**
- * Extended result type that includes HTTP status code information.
- */
-export type FetchResult<T> = [string, null, number?] | [null, T, number]
-
-/**
- * Wraps a promise to catch errors and return a Result tuple.
- * This allows for cleaner error handling without try-catch blocks.
- *
- * @param promise - The promise to wrap
- * @returns A tuple of [error, null] on failure or [null, data] on success
- */
-export async function tryCatch<T, E = Error>(promise: Promise<T>): Promise<Result<T, E>> {
-  try {
-    const data = await promise
-    return [null, data]
-  } catch (error) {
-    return [error as E, null]
-  }
-}
-
-/**
- * Wraps signedFetch with automatic error handling and JSON parsing.
- * Returns a FetchResult tuple with parsed JSON data or error message and status code.
- *
- * @param signedFetchBody - The signedFetch request configuration
- * @returns A tuple of [error, null, statusCode?] on failure or [null, data, statusCode] on success
- */
-export async function wrapSignedFetch<T = unknown>(signedFetchBody: SignedFetchRequest): Promise<FetchResult<T>> {
-  const [error, response] = await tryCatch(signedFetch(signedFetchBody))
-
-  if (error) {
-    console.error(`Error in ${signedFetchBody.url} endpoint`, { error })
-    return [error.message, null, undefined]
-  }
-
-  if (!response.ok) {
-    const errorMessage = `${response.status} ${response.statusText}`
-    console.error(`Error in ${signedFetchBody.url} endpoint`, { response })
-    return [errorMessage, null, response.status]
-  }
-
-  const [parseError, body] = await tryCatch<T>(JSON.parse(response.body || '{}'))
-
-  if (parseError) {
-    console.error(`Failed to parse response from ${signedFetchBody.url}`)
-    return ['Failed to parse response', null, response.status]
-  }
-
-  return [null, (body ?? {}) as T, response.status]
-}