@vibesdotdev/storage 0.0.1

package/src/interfaces/key-value.ts

@@ -0,0 +1,112 @@
+/**
+ * Storage Key-Value Interface
+ *
+ * Key-value store for adapters that require pair schemas (key + value).
+ * Examples: Redis, KV stores, caches.
+ */
+
+import type { z } from 'zod/v4';
+
+/**
+ * Key-value store for pair-schema storage
+ *
+ * @example
+ * ```ts
+ * const kv = adapter.keyValueStore('cache', keySchema, valueSchema);
+ * await kv.set('user:123', { name: 'Alice' });
+ * const user = await kv.get('user:123');
+ * ```
+ */
+export interface StorageKeyValueInterface<TKey, TValue> {
+	/**
+	 * Get a value by key
+	 * @param key The key to look up
+	 * @returns The value or null if not found
+	 */
+	get(key: TKey): Promise<TValue | null>;
+
+	/**
+	 * Set a value for a key
+	 * @param key The key
+	 * @param value The value to store
+	 * @param options Optional TTL and other settings
+	 */
+	set(key: TKey, value: TValue, options?: KeyValueSetOptions): Promise<void>;
+
+	/**
+	 * Delete a key
+	 * @param key The key to delete
+	 * @returns true if deleted, false if not found
+	 */
+	delete(key: TKey): Promise<boolean>;
+
+	/**
+	 * Check if a key exists
+	 * @param key The key to check
+	 */
+	has(key: TKey): Promise<boolean>;
+
+	/**
+	 * Get multiple values by keys
+	 * @param keys The keys to look up
+	 * @returns Map of key to value (missing keys omitted)
+	 */
+	getMany(keys: TKey[]): Promise<Map<TKey, TValue>>;
+
+	/**
+	 * Set multiple key-value pairs
+	 * @param entries The entries to set
+	 */
+	setMany(entries: Array<[TKey, TValue]>): Promise<void>;
+
+	/**
+	 * Delete multiple keys
+	 * @param keys The keys to delete
+	 * @returns Number of keys deleted
+	 */
+	deleteMany(keys: TKey[]): Promise<number>;
+
+	/**
+	 * Iterate over all keys
+	 * @param pattern Optional pattern to filter keys (adapter-specific)
+	 */
+	keys(pattern?: string): AsyncIterable<TKey>;
+
+	/**
+	 * Iterate over all entries
+	 * @param pattern Optional pattern to filter keys (adapter-specific)
+	 */
+	entries(pattern?: string): AsyncIterable<[TKey, TValue]>;
+
+	/**
+	 * Count keys
+	 * @param pattern Optional pattern to filter keys
+	 */
+	count(pattern?: string): Promise<number>;
+
+	/**
+	 * Clear all entries in this namespace
+	 */
+	clear(): Promise<void>;
+}
+
+/**
+ * Options for set operations
+ */
+export interface KeyValueSetOptions {
+	/** Time-to-live in milliseconds (for caches) */
+	ttl?: number;
+	/** Only set if key doesn't exist */
+	nx?: boolean;
+	/** Only set if key exists */
+	xx?: boolean;
+}
+
+/**
+ * Factory type for creating key-value stores
+ */
+export type KeyValueStoreFactory<TKey, TValue> = (
+	namespace: string,
+	keySchema: z.ZodType<TKey>,
+	valueSchema: z.ZodType<TValue>
+) => StorageKeyValueInterface<TKey, TValue>;

package/src/interfaces/query-builder.ts

@@ -0,0 +1,31 @@
+/**
+ * Query-builder database interface for Drizzle-ORM-style consumers.
+ *
+ * Feature packages must NOT import concrete storage adapter types.
+ * This structural interface lets them type db parameters without
+ * pulling in adapter-specific dependencies.  Any Drizzle database
+ * instance satisfies it.
+ */
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+export interface QueryBuilderDatabase {
+	select: (...args: any[]) => any;
+	selectDistinct: (...args: any[]) => any;
+	insert: (into: any) => any;
+	update: (table: any) => any;
+	delete: (from: any) => any;
+	run: (query: any) => any;
+	all: <T = unknown>(query: any) => Promise<T[]>;
+	get: <T = unknown>(query: any) => Promise<T | undefined>;
+	values: <T extends unknown[] = unknown[]>(query: any) => Promise<T[]>;
+	transaction: (transaction: (tx: any) => any, config?: any) => any;
+	$count: (source: any, filters?: any) => any;
+	/** Raw SQL execution — present on Postgres-style drivers, optional on SQLite-style. */
+	execute?: (query: any) => any;
+	/** Relational query builder – present when a schema was provided to drizzle(). */
+	query: Record<string, any>;
+	_: { fullSchema: Record<string, any>; schema: any; tableNamesMap: Record<string, string> };
+}
+
+/* eslint-enable @typescript-eslint/no-explicit-any */

package/src/interfaces/record/index.ts

@@ -0,0 +1,58 @@
+/**
+ * Storage Record Interface Exports
+ *
+ * Exports all types and interfaces for storage/record operations.
+ */
+
+export {
+	// Query types
+	type WhereFilter,
+	type OrderBy,
+	type IncludeRelations,
+	type PaginationOptions,
+	type QueryOptions,
+	type QueryResult,
+
+	// Search types
+	type SearchOptions,
+	type SearchResult,
+
+	// Hierarchy types
+	type TreeNode,
+	type HierarchyOptions,
+
+	// Create types
+	type CreateInput,
+	type CreateManyOptions,
+
+	// Update types
+	type UpdateInput,
+	type UpdateOptions,
+	type UpdateResult,
+
+	// Delete types
+	type DeleteOptions,
+	type DeleteResult,
+
+	// Relation types
+	type LoadedRelation,
+	type RecordWithRelations,
+
+	// Transaction types
+	type TransactionContext,
+	type TransactionFn,
+
+	// Aggregation types
+	type AggregationFunction,
+	type AggregationOptions,
+	type AggregationResult,
+
+	// Stream types
+	type StreamOptions,
+
+	// Raw query types
+	type RawQueryOptions,
+
+	// Main interface
+	type StorageRecordInterface
+} from './interface';