@omnibase/core-js 0.1.5 → 0.1.7

package/dist/database/index.d.ts

@@ -1,56 +1,105 @@
-import * as _supabase_postgrest_js from '@supabase/postgrest-js';
 import { PostgrestClient } from '@supabase/postgrest-js';
 
-declare type GenericRelationship = {
-    foreignKeyName: string;
-    columns: string[];
-    isOneToOne?: boolean;
-    referencedRelation: string;
-    referencedColumns: string[];
-};
-declare type GenericTable = {
-    Row: Record<string, unknown>;
-    Insert: Record<string, unknown>;
-    Update: Record<string, unknown>;
-    Relationships: GenericRelationship[];
-};
-declare type GenericUpdatableView = {
-    Row: Record<string, unknown>;
-    Insert: Record<string, unknown>;
-    Update: Record<string, unknown>;
-    Relationships: GenericRelationship[];
-};
-declare type GenericNonUpdatableView = {
-    Row: Record<string, unknown>;
-    Relationships: GenericRelationship[];
-};
-declare type GenericView = GenericUpdatableView | GenericNonUpdatableView;
-declare type GenericFunction = {
-    Args: Record<string, unknown>;
-    Returns: unknown;
-};
-declare type GenericSchema = {
-    Tables: Record<string, GenericTable>;
-    Views: Record<string, GenericView>;
-    Functions: Record<string, GenericFunction>;
-};
-
 /**
- * PostgREST client.
+ * Creates a PostgREST client for database operations
+ *
+ * This function creates a configured PostgREST client that handles authentication
+ * through JWT tokens. It supports both cookie-based authentication (for server-side
+ * usage) and fallback to anonymous keys. The client provides a type-safe interface
+ * for database operations when used with generated TypeScript types.
+ *
+ * The client automatically handles authentication headers and provides access to
+ * all PostgREST functionality including queries, mutations, and real-time subscriptions.
+ *
+ * @template T - Database schema types for type-safe operations. Should be generated
+ *               from your database schema using a tool like Supabase CLI or Omnibase CLI
+ *
+ * @param url - The PostgREST API endpoint URL (e.g., 'https://api.example.com/rest/v1')
+ * @param anonKey - Anonymous/public API key used as fallback when no JWT token is available
+ * @param getCookie - Function to retrieve cookies by name, typically used to get JWT tokens
+ *
+ * @returns A configured PostgREST client instance with authentication headers set
+ *
+ * @example
+ * Browser usage with cookie authentication:
+ * ```typescript
+ * import { createClient } from '@omnibase/core-js/database';
+ *
+ * interface DatabaseTypes {
+ *   users: {
+ *     Row: { id: string; email: string; name: string };
+ *     Insert: { email: string; name: string };
+ *     Update: { email?: string; name?: string };
+ *   };
+ * }
+ *
+ * const client = createClient<DatabaseTypes>(
+ *   'https://api.example.com/rest/v1',
+ *   'your-anon-key',
+ *   (name) => document.cookie
+ *     .split('; ')
+ *     .find(row => row.startsWith(`${name}=`))
+ *     ?.split('=')[1] || ''
+ * );
+ *
+ * // Type-safe query
+ * const { data, error } = await client
+ *   .from('users')
+ *   .select('id, email, name')
+ *   .eq('email', 'user@example.com');
+ * ```
+ *
+ * @example
+ * Node.js usage with custom JWT retrieval:
+ * ```typescript
+ * import { createClient } from '@omnibase/core-js/database';
+ *
+ * const client = createClient(
+ *   process.env.POSTGREST_URL!,
+ *   process.env.POSTGREST_ANON_KEY!,
+ *   (name) => {
+ *     // Custom logic to retrieve JWT from request headers, session, etc.
+ *     return getJwtFromSession(name) || '';
+ *   }
+ * );
+ *
+ * // Insert new record
+ * const { data, error } = await client
+ *   .from('users')
+ *   .insert({ email: 'new@example.com', name: 'New User' })
+ *   .select();
+ * ```
+ *
+ * @example
+ * Advanced usage with error handling:
+ * ```typescript
+ * const client = createClient<DatabaseTypes>(
+ *   'https://api.example.com/rest/v1',
+ *   'your-anon-key',
+ *   (name) => getCookieValue(name)
+ * );
+ *
+ * try {
+ *   const { data, error } = await client
+ *     .from('users')
+ *     .select('*')
+ *     .order('created_at', { ascending: false })
+ *     .limit(10);
  *
- * @typeParam
- * Database - Types for the schema from the type generator
+ *   if (error) {
+ *     console.error('Database error:', error.message);
+ *     return;
+ *   }
  *
- * @typeParam
- * SchemaName - Postgres schema to switch to. Must be a string literal, the same one passed to the constructor. If the schema is not "public", this must be supplied manually.
+ *   console.log('Users:', data);
+ * } catch (err) {
+ *   console.error('Network error:', err);
+ * }
+ * ```
  *
- * @param url - Your Postgres RESTapi url
- * @param anonKey - Your Postgres RESTapi anon JWT key
- * @param getCookie - Custom callback to get cookie by name
- * @returns
+ * @since 1.0.0
+ * @public
  */
-declare const createClient: <T = any>(url: string, anonKey: string, getCookie: (cookie: string) => string) => PostgrestClient<T, T extends {
-    __InternalSupabase: infer I extends _supabase_postgrest_js.PostgrestClientOptions;
-} ? I : {}, "public" extends Exclude<keyof T, "__InternalSupabase"> ? Exclude<keyof T, "__InternalSupabase"> & "public" : string & Exclude<keyof T, "__InternalSupabase">, Omit<T, "__InternalSupabase">["public" extends Exclude<keyof T, "__InternalSupabase"> ? Exclude<keyof T, "__InternalSupabase"> & "public" : string & Exclude<keyof T, "__InternalSupabase">] extends GenericSchema ? Omit<T, "__InternalSupabase">["public" extends Exclude<keyof T, "__InternalSupabase"> ? Exclude<keyof T, "__InternalSupabase"> & "public" : string & Exclude<keyof T, "__InternalSupabase">] : any>;
+declare const createClient: <T = any>(url: string, anonKey: string, getCookie: (cookie: string) => string) => PostgrestClient<T>;
 
 export { createClient };

package/dist/index.d.ts

@@ -1,10 +1,3 @@
-/**
- * Base API Response structure for API
- */
-type ApiResponse<T> = {
-    data?: T;
-    status: number;
-    error?: string;
-};
-
-export type { ApiResponse };
+export * from "./auth/index";
+export * from "./database/index";
+export * from "./tenants/index";

package/dist/tenants/index.cjs

@@ -34,6 +34,9 @@ async function switchActiveTenant(tenantId) {
   if (!baseUrl) {
     throw new Error("OMNIBASE_API_URL is not configured");
   }
+  if (!tenantId) {
+    throw new Error("Tenant ID is required");
+  }
   const requestBody = {
     tenant_id: tenantId
   };