@baasix/types 1.0.1

package/dist/index.js

@@ -0,0 +1,4 @@
+'use strict';
+
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}

package/dist/index.mjs

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.mjs"}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@baasix/types",
+  "version": "1.0.1",
+  "description": "Shared TypeScript types for Baasix packages",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "baasix",
+    "types",
+    "typescript"
+  ],
+  "author": "Baasix",
+  "license": "MIT",
+  "devDependencies": {
+    "tsup": "^8.0.0",
+    "typescript": "^5.3.0"
+  },
+  "peerDependencies": {},
+  "peerDependenciesMeta": {}
+}

package/src/auth.ts

@@ -0,0 +1,281 @@
+/**
+ * Authentication & Authorization Types
+ * Shared across core, sdk, cli, and app packages
+ */
+
+// ============================================================================
+// User Types
+// ============================================================================
+
+/**
+ * Base user interface
+ */
+export interface User {
+  id: string;
+  email: string;
+  firstName?: string;
+  lastName?: string;
+  avatar?: string;
+  role?: Role;
+  role_Id?: string;
+  tenant_Id?: string;
+  status?: string;
+  createdAt?: string;
+  updatedAt?: string;
+  [key: string]: unknown;
+}
+
+/**
+ * User with password (internal use only)
+ */
+export interface UserWithPassword extends User {
+  password?: string;
+}
+
+/**
+ * User with expanded roles and permissions
+ */
+export interface UserWithRolesAndPermissions {
+  id: string | number;
+  email?: string;
+  roles: string[];
+  permissions: string[];
+  tenantId?: string | number;
+  [key: string]: unknown;
+}
+
+// ============================================================================
+// Role & Permission Types
+// ============================================================================
+
+/**
+ * Role interface
+ */
+export interface Role {
+  id: string;
+  name: string;
+  description?: string;
+  isTenantSpecific?: boolean;
+  [key: string]: unknown;
+}
+
+/**
+ * Permission action types
+ */
+export type PermissionAction = "create" | "read" | "update" | "delete";
+
+/**
+ * Permission interface
+ */
+export interface Permission {
+  id: string;
+  role_Id: string;
+  collection: string;
+  action: PermissionAction;
+  fields?: string[] | null;
+  conditions?: Record<string, unknown>;
+  defaultValues?: Record<string, unknown>;
+  relConditions?: Record<string, unknown>;
+}
+
+/**
+ * Permission data structure (internal to PermissionService)
+ */
+export interface PermissionData {
+  fields: string[] | null;
+  conditions: Record<string, unknown>;
+  relConditions: Record<string, unknown>;
+  defaultValues: Record<string, unknown>;
+}
+
+/**
+ * Data for creating a new permission
+ */
+export interface CreatePermissionData {
+  role_Id: string;
+  collection: string;
+  action: PermissionAction;
+  fields?: string[];
+  conditions?: Record<string, unknown>;
+  defaultValues?: Record<string, unknown>;
+  relConditions?: Record<string, unknown>;
+}
+
+// ============================================================================
+// Tenant Types
+// ============================================================================
+
+/**
+ * Tenant interface
+ */
+export interface Tenant {
+  id: string;
+  name: string;
+  [key: string]: unknown;
+}
+
+// ============================================================================
+// Session & Token Types
+// ============================================================================
+
+/**
+ * Session interface
+ */
+export interface Session {
+  id: string;
+  token: string;
+  user_Id: string;
+  expiresAt: Date | string;
+  ipAddress?: string;
+  userAgent?: string;
+  createdAt?: string;
+  updatedAt?: string;
+}
+
+/**
+ * Auth tokens
+ */
+export interface AuthTokens {
+  accessToken: string;
+  refreshToken?: string;
+  expiresAt?: number;
+  expiresIn?: number;
+}
+
+/**
+ * JWT payload interface
+ */
+export interface JWTPayload {
+  id: string;
+  email: string;
+  role: string;
+  sessionToken: string;
+  tenant_Id?: string | number | null;
+}
+
+// ============================================================================
+// Accountability Types
+// ============================================================================
+
+/**
+ * Accountability object interface - used for permission checking
+ */
+export interface Accountability {
+  user?: { id: string | number; email?: string; isAdmin?: boolean; [key: string]: any };
+  role?: { id: string | number; name?: string; isTenantSpecific?: boolean } | string | number;
+  permissions?: any[];
+  tenant?: string | number;
+  ipaddress?: string;
+}
+
+// ============================================================================
+// Auth Request/Response Types
+// ============================================================================
+
+/**
+ * Login credentials
+ */
+export interface LoginCredentials {
+  email: string;
+  password: string;
+  tenantId?: string;
+}
+
+/**
+ * Registration data
+ */
+export interface RegisterData {
+  email: string;
+  password: string;
+  firstName?: string;
+  lastName?: string;
+  [key: string]: unknown;
+}
+
+/**
+ * Auth response
+ */
+export interface AuthResponse {
+  token: string;
+  refreshToken?: string;
+  user: User;
+  role?: Role;
+  expiresIn?: number;
+}
+
+/**
+ * Auth state events
+ */
+export type AuthStateEvent =
+  | "SIGNED_IN"
+  | "SIGNED_OUT"
+  | "TOKEN_REFRESHED"
+  | "USER_UPDATED"
+  | "TENANT_SWITCHED";
+
+/**
+ * Auth state
+ */
+export interface AuthState {
+  user: User | null;
+  isAuthenticated: boolean;
+  isLoading: boolean;
+  error: Error | null;
+}
+
+/**
+ * Magic link options
+ */
+export interface MagicLinkOptions {
+  email: string;
+  redirectUrl?: string;
+  mode?: "link" | "code";
+}
+
+/**
+ * Password reset options
+ */
+export interface PasswordResetOptions {
+  email: string;
+  redirectUrl?: string;
+}
+
+// ============================================================================
+// Auth Mode Types
+// ============================================================================
+
+/**
+ * Authentication mode for the SDK/app
+ * - 'jwt': Use JWT tokens stored in the configured storage adapter (default)
+ * - 'cookie': Use HTTP-only cookies (server handles token storage)
+ */
+export type AuthMode = "jwt" | "cookie";
+
+// ============================================================================
+// OAuth Types
+// ============================================================================
+
+/**
+ * OAuth2 tokens
+ */
+export interface OAuth2Tokens {
+  accessToken: string;
+  refreshToken?: string;
+  idToken?: string;
+  expiresAt?: Date;
+  tokenType?: string;
+  scope?: string;
+}
+
+/**
+ * OAuth2 user info
+ */
+export interface OAuth2UserInfo {
+  id: string;
+  email: string;
+  name?: string;
+  firstName?: string;
+  lastName?: string;
+  picture?: string;
+  [key: string]: unknown;
+}

package/src/cache.ts

@@ -0,0 +1,66 @@
+/**
+ * Cache Types
+ * Types for caching functionality
+ */
+
+// ============================================================================
+// Cache Configuration Types
+// ============================================================================
+
+/**
+ * Cache configuration (SDK/app level)
+ */
+export interface CacheConfig {
+  enabled?: boolean;
+  ttl?: number;
+  prefix?: string;
+}
+
+/**
+ * Cache set options (Redis-style options for cache.set operations)
+ */
+export interface CacheSetOptions {
+  /** Expiration in seconds */
+  ex?: number;
+  [key: string]: unknown;
+}
+
+/**
+ * Cache strategy
+ */
+export type CacheStrategy = "explicit" | "all";
+
+// ============================================================================
+// Cache Entry Types
+// ============================================================================
+
+/**
+ * Cache entry structure
+ */
+export interface CacheEntry {
+  value: any;
+  expiry: number;
+  tables: string[];
+  tags: string[];
+  tenant?: string | null;
+}
+
+// ============================================================================
+// Cache Adapter Interface
+// ============================================================================
+
+/**
+ * Base interface for all cache adapters
+ * Implement this interface to create custom cache adapters
+ */
+export interface ICacheAdapter {
+  get(key: string): Promise<any | null>;
+  set(key: string, value: any, ttl?: number, metadata?: { tables: string[]; tags: string[]; tenant?: string | null }): Promise<void>;
+  delete(key: string): Promise<void>;
+  clear(): Promise<void>;
+  invalidateByPattern(pattern: string): Promise<void>;
+  invalidateByTables(tables: string[], tenant?: string | null): Promise<void>;
+  invalidateByTags(tags: string[], tenant?: string | null): Promise<void>;
+  getStats(): Promise<{ keys: number; size?: number }>;
+  close(): Promise<void>;
+}

package/src/common.ts

@@ -0,0 +1,241 @@
+/**
+ * Common/Utility Types
+ * Shared across all packages
+ */
+
+// ============================================================================
+// Base Types
+// ============================================================================
+
+/**
+ * Generic record type with ID
+ */
+export interface BaseItem {
+  id: string;
+  createdAt?: string;
+  updatedAt?: string;
+  deletedAt?: string;
+  [key: string]: unknown;
+}
+
+/**
+ * Timestamped item
+ */
+export interface TimestampedItem {
+  createdAt: string;
+  updatedAt?: string;
+}
+
+/**
+ * Soft deletable item
+ */
+export interface SoftDeletableItem {
+  deletedAt?: string | null;
+}
+
+// ============================================================================
+// Utility Types
+// ============================================================================
+
+/**
+ * Make all properties of T optional recursively
+ */
+export type DeepPartial<T> = {
+  [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+
+/**
+ * Extract the item type from a collection
+ */
+export type CollectionItem<T> = T extends Array<infer U> ? U : T;
+
+/**
+ * Make specific properties required
+ */
+export type WithRequired<T, K extends keyof T> = T & { [P in K]-?: T[P] };
+
+/**
+ * Make specific properties optional
+ */
+export type WithOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+
+/**
+ * Extract keys of T that have values of type V
+ */
+export type KeysOfType<T, V> = { [K in keyof T]: T[K] extends V ? K : never }[keyof T];
+
+/**
+ * Record with string keys and unknown values
+ */
+export type AnyRecord = Record<string, unknown>;
+
+// ============================================================================
+// Settings Types
+// ============================================================================
+
+/**
+ * Generic settings
+ */
+export interface Settings {
+  [key: string]: unknown;
+}
+
+/**
+ * Tenant settings
+ */
+export interface TenantSettings {
+  tenant_Id?: string | number | null;
+  project_name?: string;
+  title?: string;
+  project_url?: string | null;
+  app_url?: string | null;
+  project_color?: string;
+  secondary_color?: string;
+  description?: string;
+  keywords?: string;
+  from_email_name?: string;
+  smtp_enabled?: boolean;
+  smtp_host?: string;
+  smtp_port?: number;
+  smtp_secure?: boolean;
+  smtp_user?: string;
+  smtp_pass?: string;
+  smtp_from_address?: string;
+  timezone?: string;
+  language?: string;
+  date_format?: string;
+  currency?: string;
+  email_signature?: string;
+  email_icon?: any;
+  metadata?: Record<string, any>;
+  modules?: Record<string, any>;
+  [key: string]: any;
+}
+
+// ============================================================================
+// Task Types
+// ============================================================================
+
+/**
+ * Background task
+ */
+export interface BackgroundTask {
+  id: string | number;
+  task_status: string;
+  scheduled_time: Date;
+  [key: string]: unknown;
+}
+
+// ============================================================================
+// Hook Types
+// ============================================================================
+
+/**
+ * Hook events
+ */
+export type HookEvent =
+  | "items.create"
+  | "items.read"
+  | "items.update"
+  | "items.delete"
+  | "auth.login"
+  | "auth.logout"
+  | "auth.register";
+
+/**
+ * Hook handler context
+ */
+export interface HookContext {
+  event: HookEvent;
+  collection?: string;
+  payload?: unknown;
+  keys?: string[];
+  accountability?: {
+    user?: { id: string };
+    role?: { id: string; name: string };
+    tenant?: { id: string };
+  };
+}
+
+/**
+ * Hook handler function
+ */
+export type HookHandler = (context: HookContext) => void | Promise<void>;
+
+/**
+ * Hook definition
+ */
+export interface Hook {
+  event: HookEvent;
+  collection?: string;
+  handler: HookHandler;
+}
+
+// ============================================================================
+// HTTP Types
+// ============================================================================
+
+/**
+ * HTTP methods
+ */
+export type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD";
+
+// ============================================================================
+// Mail Types
+// ============================================================================
+
+/**
+ * Mail options for sending emails
+ */
+export interface MailOptions {
+  to: string | string[];
+  subject: string;
+  html?: string;
+  text?: string;
+  from?: string;
+  cc?: string | string[];
+  bcc?: string | string[];
+  replyTo?: string;
+  attachments?: Array<{
+    filename: string;
+    content?: string | Buffer;
+    path?: string;
+    contentType?: string;
+  }>;
+}
+
+/**
+ * Sender configuration for email
+ */
+export interface SenderConfig {
+  from: string;
+  name?: string;
+  replyTo?: string;
+}
+
+// ============================================================================
+// Seed Types
+// ============================================================================
+
+/**
+ * Seed data configuration
+ */
+export interface SeedData {
+  collection: string;
+  data: Record<string, unknown> | Record<string, unknown>[];
+  /** Whether to clear existing data before seeding */
+  clearBefore?: boolean;
+  /** Whether to skip if data already exists (check by unique fields) */
+  skipDuplicates?: boolean;
+}
+
+/**
+ * Seed operation result
+ */
+export interface SeedResult {
+  collection: string;
+  created: number;
+  skipped: number;
+  errors: number;
+  errorDetails?: Array<{ item: unknown; error: string }>;
+}