@baasix/sdk 0.1.0 → 0.1.2

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { H as HttpClient, e as PaginatedResponse, N as Notification, o as SendNotificationData, p as Permission, C as CreatePermissionData, q as Role$1, r as Settings, s as ReportConfig, t as ReportResult, u as Aggregate, F as Filter, W as Workflow, v as WorkflowExecution, B as BaseItem, w as BaasixConfig, A as AuthMode } from './client-VT7NckyI.cjs';
-export { V as AggregateConfig, O as AggregateFunction, k as AssetTransformOptions, b as AuthResponse, d as AuthState, a as AuthStateEvent, c as AuthTokens, a4 as BaasixError, a3 as BaasixErrorDetails, f as BulkResponse, a6 as CollectionItem, a5 as DeepPartial, Y as DefaultValueType, D as DeleteResponse, Z as FieldDefinition, X as FieldType, j as FileMetadata, G as FilterCondition, z as FilterOperator, E as FilterValue, y as HttpClientConfig, I as IndexDefinition, J as LogicalFilter, L as LoginCredentials, M as MagicLinkOptions, g as MutationResponse, P as PasswordResetOptions, $ as PermissionAction, Q as QueryParams, R as RegisterData, n as RelationshipDefinition, _ as RelationshipType, x as RequestOptions, m as SchemaDefinition, l as SchemaInfo, h as SingleResponse, S as Sort, K as SortDirection, T as Tenant, i as UploadOptions, U as User, a2 as WorkflowEdge, a1 as WorkflowNode, a0 as WorkflowTrigger } from './client-VT7NckyI.cjs';
+import { H as HttpClient } from './client-BHbM3KOy.cjs';
+export { a as HttpClientConfig, R as RequestOptions } from './client-BHbM3KOy.cjs';
 import { S as StorageAdapter } from './types-BdjsGANq.cjs';
 export { a as STORAGE_KEYS, b as StorageKey } from './types-BdjsGANq.cjs';
 import { AuthModule } from './modules/auth.cjs';
@@ -8,8 +8,104 @@ import { ItemsModule } from './modules/items.cjs';
 export { ImportResult, QueryBuilder } from './modules/items.cjs';
 import { FilesModule } from './modules/files.cjs';
 import { SchemasModule } from './modules/schemas.cjs';
+import { AuthMode, AuthStateEvent, User as User$1, PaginatedResponse, Notification, SendNotificationData, Permission, CreatePermissionData, Role as Role$1, Settings, ReportConfig, ReportResult, Aggregate, Filter, Workflow, WorkflowExecution, BaseItem } from '@baasix/types';
+export { Accountability, Aggregate, AggregateConfig, AggregateFunction, AnyRecord, AssetQuery, AssetTransformOptions, AssociationDefinition, AssociationType, AuthMode, AuthResponse, AuthState, AuthStateEvent, AuthTokens, BackgroundTask, BaseItem, BulkResponse, CacheConfig, CacheStrategy, CollectionItem, CreatePermissionData, DatePart, DateTruncPrecision, DeepPartial, DefaultValueType, DeleteResponse, ErrorResponse, ExportOptions, ExportResult, FieldDefinition, FieldInfo, FieldType, FieldValidation, FieldValidationRules, FieldValues, FileData, FileMetadata, Filter, FilterCondition, FilterObject, FilterOperator, FilterValue, FlattenedField, GeoJSONGeometry, GeoJSONLineString, GeoJSONPoint, GeoJSONPolygon, Hook, HookContext, HookEvent, HookHandler, HttpMethod, ImportOptions, IncludeConfig, IndexDefinition, InternalUploadedFile, JWTPayload, KeysOfType, LogicalFilter, LoginCredentials, MagicLinkOptions, MailOptions, MutationResponse, Notification, NotificationOptions, NotificationType, OAuth2Tokens, OAuth2UserInfo, PaginatedResponse, PaginationMetadata, PaginationOptions, PasswordResetOptions, Permission, PermissionAction, PermissionData, ProcessedImage, ProcessedInclude, QueryContext, QueryOptions, QueryParams, ReadResult, RegisterData, RelationshipDefinition, RelationshipType, ReportConfig, ReportResult, SchemaDefinition, SchemaInfo, SchemaValidation, SeedData, SeedResult, SendNotificationData, SenderConfig, Session, Settings, SingleResponse, SoftDeletableItem, Sort, SortDirection, SortItem, SortObject, StorageProvider, Tenant, TenantSettings, TimestampedItem, UploadOptions, UploadedFile, User, UserWithPassword, UserWithRolesAndPermissions, ValidationResult, WithOptional, WithRequired, Workflow, WorkflowEdge, WorkflowExecution, WorkflowExecutionLog, WorkflowExecutionStatus, WorkflowFlowData, WorkflowNode, WorkflowNodeData, WorkflowStatus, WorkflowTrigger, WorkflowTriggerType } from '@baasix/types';
 export { AsyncStorageAdapter, LocalStorageAdapter, MemoryStorageAdapter } from './storage/index.cjs';
 
+/**
+ * Baasix SDK Types
+ *
+ * This file re-exports shared types from @baasix/types and defines
+ * SDK-specific types that are not shared with other packages.
+ */
+
+/**
+ * SDK Configuration options
+ */
+interface BaasixConfig {
+    /**
+     * The base URL of your Baasix instance
+     * @example 'https://api.example.com' or 'http://localhost:8056'
+     */
+    url: string;
+    /**
+     * Authentication mode
+     * @default 'jwt'
+     */
+    authMode?: AuthMode;
+    /**
+     * Storage adapter for persisting tokens and user data
+     * @default LocalStorageAdapter (web) or MemoryStorageAdapter (SSR)
+     */
+    storage?: StorageAdapter;
+    /**
+     * Static access token (useful for server-side or service accounts)
+     * When provided, this token is used instead of stored tokens
+     */
+    token?: string;
+    /**
+     * Custom headers to include in all requests
+     */
+    headers?: Record<string, string>;
+    /**
+     * Request timeout in milliseconds
+     * @default 30000 (30 seconds)
+     */
+    timeout?: number;
+    /**
+     * Whether to automatically refresh tokens before expiry
+     * @default true
+     */
+    autoRefresh?: boolean;
+    /**
+     * Credentials mode for fetch requests (important for cookies)
+     * @default 'include' for cookie mode, 'same-origin' for jwt mode
+     */
+    credentials?: RequestCredentials;
+    /**
+     * Tenant ID for multi-tenant mode
+     */
+    tenantId?: string;
+    /**
+     * Global error handler
+     */
+    onError?: (error: BaasixError) => void;
+    /**
+     * Called when authentication state changes
+     */
+    onAuthStateChange?: (event: AuthStateEvent, user: User$1 | null) => void;
+    /**
+     * WebSocket server URL for realtime features
+     * @default Same as url
+     */
+    socketUrl?: string;
+    /**
+     * WebSocket path
+     * @default '/socket'
+     */
+    socketPath?: string;
+}
+interface BaasixErrorDetails {
+    code?: string;
+    field?: string;
+    message?: string;
+    [key: string]: unknown;
+}
+declare class BaasixError extends Error {
+    readonly status: number;
+    readonly code?: string;
+    readonly details?: BaasixErrorDetails[];
+    readonly isRetryable: boolean;
+    constructor(message: string, status?: number, code?: string, details?: BaasixErrorDetails[]);
+    toJSON(): {
+        name: string;
+        message: string;
+        status: number;
+        code: string | undefined;
+        details: BaasixErrorDetails[] | undefined;
+    };
+}
+
 interface NotificationsModuleConfig {
     client: HttpClient;
 }
@@ -1785,4 +1881,4 @@ declare class Baasix {
  */
 declare function createBaasix(config: BaasixConfig): Baasix;
 
-export { Aggregate, AuthMode, AuthModule, Baasix, BaasixConfig, BaseItem, type CreateMigrationOptions, CreatePermissionData, type CreateRoleData, type CreateUserData, FilesModule, Filter, HttpClient, ItemsModule, type Migration, type MigrationRunOptions, type MigrationRunResult, type MigrationStatus, MigrationsModule, Notification, NotificationsModule, PaginatedResponse, type PendingMigration, Permission, PermissionsModule, RealtimeChannel, type RealtimeConfig, RealtimeModule, ReportConfig, ReportResult, ReportsModule, type Role, RolesModule, type RollbackResult, SchemasModule, SendNotificationData, Settings, SettingsModule, type StatsQuery, type StatsResult, StorageAdapter, type SubscriptionCallback, type SubscriptionEvent, type SubscriptionPayload, type UpdateUserData, type UserQueryOptions, UsersModule, Workflow, WorkflowExecution, type WorkflowExecutionUpdate, WorkflowsModule, createBaasix };
+export { AuthModule, Baasix, type BaasixConfig, BaasixError, type BaasixErrorDetails, type CreateMigrationOptions, type CreateRoleData, type CreateUserData, FilesModule, HttpClient, ItemsModule, type Migration, type MigrationRunOptions, type MigrationRunResult, type MigrationStatus, MigrationsModule, NotificationsModule, type PendingMigration, PermissionsModule, RealtimeChannel, type RealtimeConfig, RealtimeModule, ReportsModule, type Role, RolesModule, type RollbackResult, SchemasModule, SettingsModule, type StatsQuery, type StatsResult, StorageAdapter, type SubscriptionCallback, type SubscriptionEvent, type SubscriptionPayload, type UpdateUserData, type UserQueryOptions, UsersModule, type WorkflowExecutionUpdate, WorkflowsModule, createBaasix };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { H as HttpClient, e as PaginatedResponse, N as Notification, o as SendNotificationData, p as Permission, C as CreatePermissionData, q as Role$1, r as Settings, s as ReportConfig, t as ReportResult, u as Aggregate, F as Filter, W as Workflow, v as WorkflowExecution, B as BaseItem, w as BaasixConfig, A as AuthMode } from './client-DeXa-R9w.js';
-export { V as AggregateConfig, O as AggregateFunction, k as AssetTransformOptions, b as AuthResponse, d as AuthState, a as AuthStateEvent, c as AuthTokens, a4 as BaasixError, a3 as BaasixErrorDetails, f as BulkResponse, a6 as CollectionItem, a5 as DeepPartial, Y as DefaultValueType, D as DeleteResponse, Z as FieldDefinition, X as FieldType, j as FileMetadata, G as FilterCondition, z as FilterOperator, E as FilterValue, y as HttpClientConfig, I as IndexDefinition, J as LogicalFilter, L as LoginCredentials, M as MagicLinkOptions, g as MutationResponse, P as PasswordResetOptions, $ as PermissionAction, Q as QueryParams, R as RegisterData, n as RelationshipDefinition, _ as RelationshipType, x as RequestOptions, m as SchemaDefinition, l as SchemaInfo, h as SingleResponse, S as Sort, K as SortDirection, T as Tenant, i as UploadOptions, U as User, a2 as WorkflowEdge, a1 as WorkflowNode, a0 as WorkflowTrigger } from './client-DeXa-R9w.js';
+import { H as HttpClient } from './client-D67LK80v.js';
+export { a as HttpClientConfig, R as RequestOptions } from './client-D67LK80v.js';
 import { S as StorageAdapter } from './types-BdjsGANq.js';
 export { a as STORAGE_KEYS, b as StorageKey } from './types-BdjsGANq.js';
 import { AuthModule } from './modules/auth.js';
@@ -8,8 +8,104 @@ import { ItemsModule } from './modules/items.js';
 export { ImportResult, QueryBuilder } from './modules/items.js';
 import { FilesModule } from './modules/files.js';
 import { SchemasModule } from './modules/schemas.js';
+import { AuthMode, AuthStateEvent, User as User$1, PaginatedResponse, Notification, SendNotificationData, Permission, CreatePermissionData, Role as Role$1, Settings, ReportConfig, ReportResult, Aggregate, Filter, Workflow, WorkflowExecution, BaseItem } from '@baasix/types';
+export { Accountability, Aggregate, AggregateConfig, AggregateFunction, AnyRecord, AssetQuery, AssetTransformOptions, AssociationDefinition, AssociationType, AuthMode, AuthResponse, AuthState, AuthStateEvent, AuthTokens, BackgroundTask, BaseItem, BulkResponse, CacheConfig, CacheStrategy, CollectionItem, CreatePermissionData, DatePart, DateTruncPrecision, DeepPartial, DefaultValueType, DeleteResponse, ErrorResponse, ExportOptions, ExportResult, FieldDefinition, FieldInfo, FieldType, FieldValidation, FieldValidationRules, FieldValues, FileData, FileMetadata, Filter, FilterCondition, FilterObject, FilterOperator, FilterValue, FlattenedField, GeoJSONGeometry, GeoJSONLineString, GeoJSONPoint, GeoJSONPolygon, Hook, HookContext, HookEvent, HookHandler, HttpMethod, ImportOptions, IncludeConfig, IndexDefinition, InternalUploadedFile, JWTPayload, KeysOfType, LogicalFilter, LoginCredentials, MagicLinkOptions, MailOptions, MutationResponse, Notification, NotificationOptions, NotificationType, OAuth2Tokens, OAuth2UserInfo, PaginatedResponse, PaginationMetadata, PaginationOptions, PasswordResetOptions, Permission, PermissionAction, PermissionData, ProcessedImage, ProcessedInclude, QueryContext, QueryOptions, QueryParams, ReadResult, RegisterData, RelationshipDefinition, RelationshipType, ReportConfig, ReportResult, SchemaDefinition, SchemaInfo, SchemaValidation, SeedData, SeedResult, SendNotificationData, SenderConfig, Session, Settings, SingleResponse, SoftDeletableItem, Sort, SortDirection, SortItem, SortObject, StorageProvider, Tenant, TenantSettings, TimestampedItem, UploadOptions, UploadedFile, User, UserWithPassword, UserWithRolesAndPermissions, ValidationResult, WithOptional, WithRequired, Workflow, WorkflowEdge, WorkflowExecution, WorkflowExecutionLog, WorkflowExecutionStatus, WorkflowFlowData, WorkflowNode, WorkflowNodeData, WorkflowStatus, WorkflowTrigger, WorkflowTriggerType } from '@baasix/types';
 export { AsyncStorageAdapter, LocalStorageAdapter, MemoryStorageAdapter } from './storage/index.js';
 
+/**
+ * Baasix SDK Types
+ *
+ * This file re-exports shared types from @baasix/types and defines
+ * SDK-specific types that are not shared with other packages.
+ */
+
+/**
+ * SDK Configuration options
+ */
+interface BaasixConfig {
+    /**
+     * The base URL of your Baasix instance
+     * @example 'https://api.example.com' or 'http://localhost:8056'
+     */
+    url: string;
+    /**
+     * Authentication mode
+     * @default 'jwt'
+     */
+    authMode?: AuthMode;
+    /**
+     * Storage adapter for persisting tokens and user data
+     * @default LocalStorageAdapter (web) or MemoryStorageAdapter (SSR)
+     */
+    storage?: StorageAdapter;
+    /**
+     * Static access token (useful for server-side or service accounts)
+     * When provided, this token is used instead of stored tokens
+     */
+    token?: string;
+    /**
+     * Custom headers to include in all requests
+     */
+    headers?: Record<string, string>;
+    /**
+     * Request timeout in milliseconds
+     * @default 30000 (30 seconds)
+     */
+    timeout?: number;
+    /**
+     * Whether to automatically refresh tokens before expiry
+     * @default true
+     */
+    autoRefresh?: boolean;
+    /**
+     * Credentials mode for fetch requests (important for cookies)
+     * @default 'include' for cookie mode, 'same-origin' for jwt mode
+     */
+    credentials?: RequestCredentials;
+    /**
+     * Tenant ID for multi-tenant mode
+     */
+    tenantId?: string;
+    /**
+     * Global error handler
+     */
+    onError?: (error: BaasixError) => void;
+    /**
+     * Called when authentication state changes
+     */
+    onAuthStateChange?: (event: AuthStateEvent, user: User$1 | null) => void;
+    /**
+     * WebSocket server URL for realtime features
+     * @default Same as url
+     */
+    socketUrl?: string;
+    /**
+     * WebSocket path
+     * @default '/socket'
+     */
+    socketPath?: string;
+}
+interface BaasixErrorDetails {
+    code?: string;
+    field?: string;
+    message?: string;
+    [key: string]: unknown;
+}
+declare class BaasixError extends Error {
+    readonly status: number;
+    readonly code?: string;
+    readonly details?: BaasixErrorDetails[];
+    readonly isRetryable: boolean;
+    constructor(message: string, status?: number, code?: string, details?: BaasixErrorDetails[]);
+    toJSON(): {
+        name: string;
+        message: string;
+        status: number;
+        code: string | undefined;
+        details: BaasixErrorDetails[] | undefined;
+    };
+}
+
 interface NotificationsModuleConfig {
     client: HttpClient;
 }
@@ -1785,4 +1881,4 @@ declare class Baasix {
  */
 declare function createBaasix(config: BaasixConfig): Baasix;
 
-export { Aggregate, AuthMode, AuthModule, Baasix, BaasixConfig, BaseItem, type CreateMigrationOptions, CreatePermissionData, type CreateRoleData, type CreateUserData, FilesModule, Filter, HttpClient, ItemsModule, type Migration, type MigrationRunOptions, type MigrationRunResult, type MigrationStatus, MigrationsModule, Notification, NotificationsModule, PaginatedResponse, type PendingMigration, Permission, PermissionsModule, RealtimeChannel, type RealtimeConfig, RealtimeModule, ReportConfig, ReportResult, ReportsModule, type Role, RolesModule, type RollbackResult, SchemasModule, SendNotificationData, Settings, SettingsModule, type StatsQuery, type StatsResult, StorageAdapter, type SubscriptionCallback, type SubscriptionEvent, type SubscriptionPayload, type UpdateUserData, type UserQueryOptions, UsersModule, Workflow, WorkflowExecution, type WorkflowExecutionUpdate, WorkflowsModule, createBaasix };
+export { AuthModule, Baasix, type BaasixConfig, BaasixError, type BaasixErrorDetails, type CreateMigrationOptions, type CreateRoleData, type CreateUserData, FilesModule, HttpClient, ItemsModule, type Migration, type MigrationRunOptions, type MigrationRunResult, type MigrationStatus, MigrationsModule, NotificationsModule, type PendingMigration, PermissionsModule, RealtimeChannel, type RealtimeConfig, RealtimeModule, ReportsModule, type Role, RolesModule, type RollbackResult, SchemasModule, SettingsModule, type StatsQuery, type StatsResult, StorageAdapter, type SubscriptionCallback, type SubscriptionEvent, type SubscriptionPayload, type UpdateUserData, type UserQueryOptions, UsersModule, type WorkflowExecutionUpdate, WorkflowsModule, createBaasix };