@prisma/studio-core 0.2.0 → 0.2.2

package/dist/ui/index.d.cts

@@ -1,13 +1,79 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { A as Adapter } from '../adapter-CKFCHq71.cjs';
+import { A as Adapter, Q as Query, b as AdapterError } from '../query-Q-ZKX_Vr.cjs';
+import { UseQueryStateOptions, UseQueryStateReturn, Options, UseQueryStatesOptions, UseQueryStatesReturn, Parser } from 'nuqs';
+export * from 'nuqs';
+import 'kysely';
 
+type StudioLaunchedEventBase = {
+    name: "studio_launched";
+    payload: {
+        embeddingType?: string;
+        vendorId?: string;
+        tableCount: number;
+    };
+};
+type StudioOperationErrorEventBase = {
+    name: "studio_operation_error";
+    payload: {
+        operation: string;
+        query: Query | undefined;
+        error: AdapterError;
+    };
+};
+type StudioOperationSuccessEventBase = {
+    name: "studio_operation_success";
+    payload: {
+        operation: string;
+        query: Query;
+        error: undefined;
+    };
+};
+type StudioOperationEventBase = StudioOperationSuccessEventBase | StudioOperationErrorEventBase;
+type StudioEventBase = StudioLaunchedEventBase | StudioOperationEventBase;
+type StudioEvent = StudioEventBase & {
+    eventId: string;
+    timestamp: string;
+};
 interface StudioProps {
     adapter: Adapter;
-    onError?: (error: Error) => void;
+    onEvent?: (error: StudioEvent) => void;
 }
 /**
  * Main Studio component that provides database visualization and management
  */
 declare function Studio(props: StudioProps): react_jsx_runtime.JSX.Element;
 
-export { Studio, type StudioProps };
+type StateKey = "pageIndex" | "pageSize" | "table" | "sort" | "schema" | "test" | "filter" | "view";
+type Exact<A, W> = (A extends unknown ? W extends A ? {
+    [K in keyof A]: Exact<A[K], W[K]>;
+} : W : never) | (A extends string | number | bigint | boolean | [] ? A : never);
+declare function keyMap<const Map extends Partial<Record<StateKey, any>>>(keyMap: Exact<Map, Partial<Record<StateKey, any>>>): BrandedKeyMap<Map>;
+declare function urlKeys<const Map extends Partial<Record<StateKey, string>>>(urlKeys: Exact<Map, Partial<Record<StateKey, string>>>): BrandedKeyMap<Map>;
+declare const _BRAND_SYMBOL: unique symbol;
+type BrandedKeyMap<Map> = Map & {
+    [K in typeof _BRAND_SYMBOL]: never;
+};
+/**
+ * @see {@link useQueryStateOriginal}
+ */
+declare function useQueryState<T>(key: StateKey, options: UseQueryStateOptions<T> & {
+    defaultValue: T;
+}): UseQueryStateReturn<NonNullable<ReturnType<typeof options.parse>>, typeof options.defaultValue>;
+declare function useQueryState<T>(key: StateKey, options: UseQueryStateOptions<T>): UseQueryStateReturn<NonNullable<ReturnType<typeof options.parse>>, undefined>;
+declare function useQueryState(key: StateKey, options: Options & {
+    defaultValue: string;
+}): UseQueryStateReturn<string, typeof options.defaultValue>;
+declare function useQueryState(key: StateKey, options: Pick<UseQueryStateOptions<string>, keyof Options>): UseQueryStateReturn<string, undefined>;
+declare function useQueryState(key: StateKey): UseQueryStateReturn<string, undefined>;
+type UseQueryStatesKeysMap<Map extends Partial<Record<StateKey, any>> = Partial<Record<StateKey, any>>> = {
+    [Key in keyof Map]: KeyMapValue<Map[Key]>;
+};
+type KeyMapValue<Type> = Parser<Type> & Options & {
+    defaultValue?: Type;
+};
+/**
+ * @see {@link useQueryStatesOriginal}
+ */
+declare function useQueryStates<KeyMap extends UseQueryStatesKeysMap>(keyMap: BrandedKeyMap<KeyMap>, options?: Partial<UseQueryStatesOptions<KeyMap>>): UseQueryStatesReturn<KeyMap>;
+
+export { type StateKey, Studio, type StudioProps, keyMap, urlKeys, useQueryState, useQueryStates };

package/dist/ui/index.d.ts

@@ -1,13 +1,79 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { A as Adapter } from '../adapter-CKFCHq71.js';
+import { A as Adapter, Q as Query, b as AdapterError } from '../query-Q-ZKX_Vr.js';
+import { UseQueryStateOptions, UseQueryStateReturn, Options, UseQueryStatesOptions, UseQueryStatesReturn, Parser } from 'nuqs';
+export * from 'nuqs';
+import 'kysely';
 
+type StudioLaunchedEventBase = {
+    name: "studio_launched";
+    payload: {
+        embeddingType?: string;
+        vendorId?: string;
+        tableCount: number;
+    };
+};
+type StudioOperationErrorEventBase = {
+    name: "studio_operation_error";
+    payload: {
+        operation: string;
+        query: Query | undefined;
+        error: AdapterError;
+    };
+};
+type StudioOperationSuccessEventBase = {
+    name: "studio_operation_success";
+    payload: {
+        operation: string;
+        query: Query;
+        error: undefined;
+    };
+};
+type StudioOperationEventBase = StudioOperationSuccessEventBase | StudioOperationErrorEventBase;
+type StudioEventBase = StudioLaunchedEventBase | StudioOperationEventBase;
+type StudioEvent = StudioEventBase & {
+    eventId: string;
+    timestamp: string;
+};
 interface StudioProps {
     adapter: Adapter;
-    onError?: (error: Error) => void;
+    onEvent?: (error: StudioEvent) => void;
 }
 /**
  * Main Studio component that provides database visualization and management
  */
 declare function Studio(props: StudioProps): react_jsx_runtime.JSX.Element;
 
-export { Studio, type StudioProps };
+type StateKey = "pageIndex" | "pageSize" | "table" | "sort" | "schema" | "test" | "filter" | "view";
+type Exact<A, W> = (A extends unknown ? W extends A ? {
+    [K in keyof A]: Exact<A[K], W[K]>;
+} : W : never) | (A extends string | number | bigint | boolean | [] ? A : never);
+declare function keyMap<const Map extends Partial<Record<StateKey, any>>>(keyMap: Exact<Map, Partial<Record<StateKey, any>>>): BrandedKeyMap<Map>;
+declare function urlKeys<const Map extends Partial<Record<StateKey, string>>>(urlKeys: Exact<Map, Partial<Record<StateKey, string>>>): BrandedKeyMap<Map>;
+declare const _BRAND_SYMBOL: unique symbol;
+type BrandedKeyMap<Map> = Map & {
+    [K in typeof _BRAND_SYMBOL]: never;
+};
+/**
+ * @see {@link useQueryStateOriginal}
+ */
+declare function useQueryState<T>(key: StateKey, options: UseQueryStateOptions<T> & {
+    defaultValue: T;
+}): UseQueryStateReturn<NonNullable<ReturnType<typeof options.parse>>, typeof options.defaultValue>;
+declare function useQueryState<T>(key: StateKey, options: UseQueryStateOptions<T>): UseQueryStateReturn<NonNullable<ReturnType<typeof options.parse>>, undefined>;
+declare function useQueryState(key: StateKey, options: Options & {
+    defaultValue: string;
+}): UseQueryStateReturn<string, typeof options.defaultValue>;
+declare function useQueryState(key: StateKey, options: Pick<UseQueryStateOptions<string>, keyof Options>): UseQueryStateReturn<string, undefined>;
+declare function useQueryState(key: StateKey): UseQueryStateReturn<string, undefined>;
+type UseQueryStatesKeysMap<Map extends Partial<Record<StateKey, any>> = Partial<Record<StateKey, any>>> = {
+    [Key in keyof Map]: KeyMapValue<Map[Key]>;
+};
+type KeyMapValue<Type> = Parser<Type> & Options & {
+    defaultValue?: Type;
+};
+/**
+ * @see {@link useQueryStatesOriginal}
+ */
+declare function useQueryStates<KeyMap extends UseQueryStatesKeysMap>(keyMap: BrandedKeyMap<KeyMap>, options?: Partial<UseQueryStatesOptions<KeyMap>>): UseQueryStatesReturn<KeyMap>;
+
+export { type StateKey, Studio, type StudioProps, keyMap, urlKeys, useQueryState, useQueryStates };