update types

Author: acoreyj

src/@types/persisters/persister-durable-object-sql-storage/docs.js

@@ -16,6 +16,111 @@
  * @since v6.2.0
  */
 /// persister-durable-object-sql-storage
+
+/**
+ * The DpcKeyValue type represents the configuration for key-value persistence mode
+ * in a DurableObjectSqlStoragePersister.
+ *
+ * This mode stores each table, row, cell, and value as separate database rows,
+ * avoiding Cloudflare's 2MB row limit that can be hit with large stores in JSON mode.
+ * While this creates more database writes, it provides better scalability for
+ * larger datasets.
+ *
+ * @example
+ * This example shows how to configure a DurableObjectSqlStoragePersister to use
+ * key-value mode with a custom storage prefix:
+ *
+ * ```js
+ * const config = {
+ *   mode: 'key-value',
+ *   storagePrefix: 'my_app_'
+ * };
+ *
+ * const persister = createDurableObjectSqlStoragePersister(
+ *   store,
+ *   ctx.storage.sql,
+ *   config
+ * );
+ * ```
+ *
+ * @category Configuration
+ * @since v6.2.0
+ */
+/// DpcKeyValue
+{
+  /**
+   * The mode property must be set to 'key-value' to enable key-value persistence mode.
+   * @since v6.2.0
+   */
+  /// DpcKeyValue.mode
+  /**
+   * The storagePrefix property lets you specify an optional prefix for the database
+   * table names used in key-value mode.
+   *
+   * This is useful when you have multiple stores or applications sharing the same
+   * Durable Object SQL storage and want to avoid table name conflicts.
+   *
+   * The prefix will be sanitized to only include alphanumeric characters and underscores.
+   * For example, a prefix of 'my-app!' becomes 'my_app_'.
+   *
+   * @example
+   * This example shows how the storagePrefix affects table names:
+   *
+   * ```js
+   * // With storagePrefix: 'user_data_'
+   * // Creates tables: user_data_tinybase_tables, user_data_tinybase_values
+   *
+   * const config = {
+   *   mode: 'key-value',
+   *   storagePrefix: 'user_data_'
+   * };
+   * ```
+   *
+   * @since v6.2.0
+   */
+  /// DpcKeyValue.storagePrefix
+}
+
+/**
+ * The DurableObjectSqlDatabasePersisterConfig type represents the union of all
+ * possible configuration types for a DurableObjectSqlStoragePersister.
+ *
+ * This allows the persister to support multiple persistence modes:
+ * - JSON mode (via DpcJson): Stores the entire Store as JSON in a single row
+ * - Key-value mode (via DpcKeyValue): Stores each piece of data as separate rows
+ * - Tabular mode (via DpcTabular): Maps TinyBase tables to database tables
+ *
+ * @example
+ * This example shows the different configuration options:
+ *
+ * ```js
+ * // JSON mode (default)
+ * const jsonConfig = {
+ *   mode: 'json',
+ *   storeTableName: 'my_store'
+ * };
+ *
+ * // Key-value mode
+ * const kvConfig = {
+ *   mode: 'key-value',
+ *   storagePrefix: 'app_'
+ * };
+ *
+ * // Tabular mode
+ * const tabularConfig = {
+ *   mode: 'tabular',
+ *   tables: {
+ *     load: {pets: 'pets_table'},
+ *     save: {pets: 'pets_table'}
+ *   }
+ * };
+ * ```
+ *
+ * @category Configuration
+ * @since v6.2.0
+ */
+/// DurableObjectSqlDatabasePersisterConfig
+
 /**
  * The DurableObjectSqlStoragePersister interface represents a Persister that lets
  * you save and load Store data to and from Cloudflare Durable Object SQL storage.

src/@types/persisters/persister-durable-object-sql-storage/index.d.ts

@@ -1,6 +1,17 @@
 /// persister-durable-object-sql-storage
 import type {MergeableStore} from '../../mergeable-store/index.d.ts';
-import type {DatabasePersisterConfig, Persister, Persists} from '../index.d.ts';
+import type {DpcJson, Persister, Persists} from '../index.d.ts';
+
+/// DpcKeyValue
+export type DpcKeyValue = {
+  /// DpcKeyValue.mode
+  mode: 'key-value';
+  /// DpcKeyValue.storagePrefix
+  storagePrefix?: string;
+};
+
+/// DurableObjectSqlDatabasePersisterConfig
+export type DurableObjectSqlDatabasePersisterConfig = DpcJson | DpcKeyValue;
 
 /// DurableObjectSqlStoragePersister
 export interface DurableObjectSqlStoragePersister
@@ -13,7 +24,7 @@ export interface DurableObjectSqlStoragePersister
 export function createDurableObjectSqlStoragePersister(
   store: MergeableStore,
   sqlStorage: SqlStorage,
-  configOrStoreTableName?: DatabasePersisterConfig | string,
+  configOrStoreTableName?: DurableObjectSqlDatabasePersisterConfig | string,
   onSqlCommand?: (sql: string, params?: any[]) => void,
   onIgnoredError?: (error: any) => void,
 ): DurableObjectSqlStoragePersister;

src/@types/persisters/persister-durable-object-sql-storage/with-schemas/index.d.ts

@@ -10,6 +10,19 @@ import type {
   Persists,
 } from '../../with-schemas/index.d.ts';
 
+/// DpcKeyValue
+export type DpcKeyValue = {
+  /// DpcKeyValue.mode
+  mode: 'key-value';
+  /// DpcKeyValue.storagePrefix
+  storagePrefix?: string;
+};
+
+/// DurableObjectSqlDatabasePersisterConfig
+export type DurableObjectSqlDatabasePersisterConfig<
+  Schemas extends OptionalSchemas,
+> = DatabasePersisterConfig<Schemas> | DpcKeyValue;
+
 /// DurableObjectSqlStoragePersister
 export interface DurableObjectSqlStoragePersister<
   Schemas extends OptionalSchemas,
@@ -24,7 +37,9 @@ export function createDurableObjectSqlStoragePersister<
 >(
   store: Store<Schemas> | MergeableStore<Schemas>,
   sqlStorage: SqlStorage,
-  configOrStoreTableName?: DatabasePersisterConfig<Schemas> | string,
+  configOrStoreTableName?:
+    | DurableObjectSqlDatabasePersisterConfig<Schemas>
+    | string,
   onSqlCommand?: (sql: string, params?: any[]) => void,
   onIgnoredError?: (error: any) => void,
 ): DurableObjectSqlStoragePersister<Schemas>;