@vritti/api-sdk 0.2.2 → 0.2.4

package/dist/index.d.cts

@@ -1,11 +1,13 @@
 import * as _nestjs_common from '@nestjs/common';
-import { DynamicModule, CanActivate, ExecutionContext, InjectionToken, OnModuleInit, OnModuleDestroy, Logger, HttpException, HttpStatus, ExceptionFilter, ArgumentsHost, ModuleMetadata, Type, LoggerService as LoggerService$1, NestInterceptor, CallHandler, NestModule, MiddlewareConsumer, NestMiddleware } from '@nestjs/common';
+import { DynamicModule, CanActivate, ExecutionContext, OnModuleInit, OnModuleDestroy, InjectionToken, Logger, HttpException, HttpStatus, ExceptionFilter, ArgumentsHost, ModuleMetadata, Type, LoggerService as LoggerService$1, NestInterceptor, CallHandler, NestModule, MiddlewareConsumer, NestMiddleware } from '@nestjs/common';
 import { ConfigService } from '@nestjs/config';
 import { Reflector } from '@nestjs/core';
 import { JwtService, JwtModuleOptions, JwtSignOptions } from '@nestjs/jwt';
 import { FastifyRequest, FastifyReply } from 'fastify';
 import { NodePgDatabase } from 'drizzle-orm/node-postgres';
-import { InferInsertModel, InferSelectModel, SQL } from 'drizzle-orm';
+import * as drizzle_orm from 'drizzle-orm';
+import { Column, SQL, InferInsertModel, InferSelectModel } from 'drizzle-orm';
+import * as drizzle_orm_pg_core from 'drizzle-orm/pg-core';
 import { PgTable } from 'drizzle-orm/pg-core';
 import { Observable } from 'rxjs';
 import { AsyncLocalStorage } from 'node:async_hooks';
@@ -43,10 +45,14 @@ declare class AuthConfigModule {
 
 declare const AccessToken: (...dataOrPipes: unknown[]) => ParameterDecorator;
 
+declare const CookieDomain: (...dataOrPipes: unknown[]) => ParameterDecorator;
+
 declare const Onboarding: () => _nestjs_common.CustomDecorator<string>;
 
 declare const Public: () => _nestjs_common.CustomDecorator<string>;
 
+declare const RefreshCookieOptions: (...dataOrPipes: unknown[]) => ParameterDecorator;
+
 declare const RefreshTokenCookie: (...dataOrPipes: unknown[]) => ParameterDecorator;
 
 declare const RESET_KEY = "isReset";
@@ -135,6 +141,44 @@ declare function verifyTokenHash(token: string, expectedHash: string): boolean;
 declare const SKIP_CSRF_KEY = "skipCsrf";
 declare const SkipCsrf: () => _nestjs_common.CustomDecorator<string>;
 
+declare class CacheModule {
+}
+
+interface ICacheProvider {
+    set<T>(key: string, value: T, ttlSeconds: number): Promise<void>;
+    get<T>(key: string): Promise<T | null>;
+    del(...keys: string[]): Promise<void>;
+    scanKeys(pattern: string): Promise<string[]>;
+    getMemoryInfo(): Promise<string>;
+}
+
+declare class CacheService {
+    private readonly provider;
+    private readonly logger;
+    constructor(provider: ICacheProvider);
+    set<T>(key: string, value: T, ttlSeconds: number): Promise<void>;
+    get<T>(key: string): Promise<T | null>;
+    del(...keys: string[]): Promise<void>;
+    scanKeys(pattern: string): Promise<string[]>;
+    getMemoryInfo(): Promise<string>;
+}
+
+declare const CACHE_PROVIDER: unique symbol;
+
+declare class RedisCacheProvider implements ICacheProvider, OnModuleInit, OnModuleDestroy {
+    private readonly configService;
+    private readonly logger;
+    private client;
+    constructor(configService: ConfigService);
+    onModuleInit(): void;
+    onModuleDestroy(): Promise<void>;
+    set<T>(key: string, value: T, ttlSeconds: number): Promise<void>;
+    get<T>(key: string): Promise<T | null>;
+    del(...keys: string[]): Promise<void>;
+    scanKeys(pattern: string): Promise<string[]>;
+    getMemoryInfo(): Promise<string>;
+}
+
 interface CookieConfig {
     refreshCookieName: string;
     refreshCookieMaxAge: number;
@@ -143,6 +187,14 @@ interface CookieConfig {
     refreshCookieSameSite: 'strict' | 'lax' | 'none';
     refreshCookieDomain?: string;
 }
+interface CookieSerializeOptions {
+    httpOnly: boolean;
+    secure: boolean;
+    sameSite: 'strict' | 'lax' | 'none';
+    path: string;
+    maxAge: number;
+    domain: string;
+}
 interface JwtConfig {
     accessTokenExpiry: string;
     refreshTokenExpiry: string;
@@ -167,7 +219,10 @@ declare function defineConfig(config: ApiSdkConfig): ApiSdkConfig;
 declare function configureApiSdk(userConfig: ApiSdkConfig): void;
 declare function getConfig(): FullConfig;
 declare function resetConfig(): void;
-declare function getRefreshCookieOptions(): Record<string, unknown>;
+declare function getRefreshCookieOptions(): Omit<CookieSerializeOptions, 'domain'> & {
+    domain?: string;
+};
+declare function getRefreshCookieOptionsForHost(hostname: string): CookieSerializeOptions;
 declare function getJwtExpiry(): {
     access: string;
     refresh: string;
@@ -220,9 +275,73 @@ declare class SelectOptionsQueryDto {
     excludeIds?: string;
     valueKey?: string;
     labelKey?: string;
+    descriptionKey?: string;
     groupIdKey?: string;
 }
 
+declare class SuccessResponseDto {
+    success: boolean;
+    message: string;
+}
+
+type FilterOperator = 'equals' | 'notEquals' | 'contains' | 'notContains' | 'gt' | 'gte' | 'lt' | 'lte';
+interface FilterCondition {
+    field: string;
+    operator: FilterOperator;
+    value: string | number;
+}
+interface SortCondition {
+    field: string;
+    direction: 'asc' | 'desc';
+}
+type DensityType = 'compact' | 'normal' | 'comfortable';
+interface ColumnPinning {
+    left: string[];
+    right: string[];
+}
+interface SearchState {
+    columnId: string;
+    value: string;
+}
+interface TableViewState {
+    filters: FilterCondition[];
+    sort: SortCondition[];
+    columnVisibility: Record<string, boolean>;
+    columnOrder: string[];
+    columnSizing: Record<string, number>;
+    columnPinning: ColumnPinning;
+    lockedColumnSizing: boolean;
+    density: DensityType;
+    filterOrder: string[];
+    filterVisibility: Record<string, boolean>;
+    search?: SearchState | null;
+    pagination?: {
+        limit: number;
+        offset: number;
+    };
+}
+
+declare class TableResponseDto<T> {
+    result: T[];
+    count: number;
+    state: TableViewState;
+    activeViewId: string | null;
+}
+
+type FieldDefinition = {
+    column: Column;
+    type: 'string' | 'number' | 'boolean';
+} | {
+    expression: (value: string | number) => SQL;
+    type: 'string' | 'number' | 'boolean';
+};
+type FieldMap = Record<string, FieldDefinition>;
+declare class FilterProcessor {
+    static buildWhere(filters: FilterCondition[] | undefined, fieldMap: FieldMap): SQL | undefined;
+    static buildSearch(search: SearchState | null | undefined, fieldMap: FieldMap): SQL | undefined;
+    static buildOrderBy(sort: SortCondition[] | undefined, fieldMap: FieldMap): SQL[];
+}
+
 declare class PrimaryDatabaseService implements OnModuleInit, OnModuleDestroy {
     private readonly options;
     private readonly logger;
@@ -233,8 +352,6 @@ declare class PrimaryDatabaseService implements OnModuleInit, OnModuleDestroy {
     constructor(options: DatabaseModuleOptions);
     onModuleInit(): Promise<void>;
     private initializeDrizzleClient;
-    private buildPrimaryDbUrl;
-    private maskPassword;
     getTenantInfo(tenantIdentifier: string): Promise<TenantInfo | null>;
     private cacheInfo;
     clearTenantCache(tenantIdentifier: string): void;
@@ -248,6 +365,7 @@ declare class PrimaryDatabaseService implements OnModuleInit, OnModuleDestroy {
 interface SelectQueryOption {
     value: string | number | boolean;
     label: string;
+    description?: string;
     groupId?: string | number;
 }
 interface SelectQueryGroup {
@@ -260,9 +378,15 @@ interface SelectQueryResult {
     hasMore: boolean;
     totalCount?: number;
 }
+interface FindForSelectJoin {
+    table: PgTable;
+    on: SQL;
+    type?: 'left' | 'inner';
+}
 interface FindForSelectConfig {
     value: string;
     label: string;
+    description?: string;
     groupId?: string;
     search?: string;
     limit?: number;
@@ -275,6 +399,8 @@ interface FindForSelectConfig {
     groupTable?: PgTable;
     groupLabelKey?: string;
     groupIdKey?: string;
+    joins?: FindForSelectJoin[];
+    conditions?: SQL[];
 }
 
 type RelationsWhereFilter = Record<string, unknown>;
@@ -310,6 +436,21 @@ declare abstract class PrimaryBaseRepository<TTable extends PgTable, TInsert = I
         limit?: number;
         offset?: number;
     }): Promise<TSelect[]>;
+    private buildSelectQuery;
+    findAllAndCount<TResult = TSelect>(options?: {
+        select?: Record<string, unknown>;
+        where?: SQL;
+        orderBy?: SQL[];
+        limit?: number;
+        offset?: number;
+        leftJoin?: {
+            table: PgTable;
+            on: SQL;
+        };
+    }): Promise<{
+        result: TResult[];
+        count: number;
+    }>;
     update(id: string, data: Partial<TInsert>): Promise<TSelect>;
     updateMany(where: SQL, data: Partial<TInsert>): Promise<{
         count: number;
@@ -508,6 +649,8 @@ declare function getHttpStatusTitle(status: number): string;
 declare class HttpExceptionFilter implements ExceptionFilter {
     private readonly logger;
     catch(exception: unknown, host: ArgumentsHost): void;
+    private isHttpException;
+    private isAxiosError;
 }
 
 type LogLevel = 'error' | 'warn' | 'log' | 'debug' | 'verbose';
@@ -630,4 +773,118 @@ declare function normalizePhoneNumber(phone: string): string;
 
 declare function parseExpiryToMs(expiry: string): number;
 
-export { AccessToken, type AccessTokenPayload, type ApiErrorResponse, type ApiSdkConfig, AuthConfigModule, BadGatewayException, BadRequestException, ConflictException, type CookieConfig, type CorrelationContext, CorrelationIdMiddleware, DEFAULT_CORRELATION_HEADER, DatabaseModule, type DatabaseModuleOptions, EmailModule, EmailService, type FieldError, type FindForSelectConfig, ForbiddenException, GoneException, type GuardConfig, HttpExceptionFilter, HttpLoggerInterceptor, type HttpLoggerOptions, HttpProblemException, InternalServerErrorException, JwtAuthService, type JwtConfig, LOGGER_MODULE_OPTIONS, type LogFormat, type LogLevel, type LogMetadata, LoggerModule, type LoggerModuleAsyncOptions, type LoggerModuleOptions, type LoggerOptionsFactory, LoggerService, MethodNotAllowedException, NotAcceptableException, NotFoundException, NotImplementedException, Onboarding, PayloadTooLargeException, PrimaryBaseRepository, PrimaryDatabaseService, type PrimaryDbConfig, type ProblemDetails, type ProblemOptions, Public, RESET_KEY, RefreshTokenCookie, type RefreshTokenPayload, type RegisteredSchema, RequestTimeoutException, Reset, RootModule, SKIP_CSRF_KEY, SelectOptionsQueryDto, type SelectQueryGroup, type SelectQueryOption, type SelectQueryResult, ServiceUnavailableException, SessionData, type SessionInfo, SkipCsrf, Tenant, TenantBaseRepository, TenantContextService, TenantDatabaseService, type TenantInfo, type TokenExpiry, TokenType, TooManyRequestsException, type TypedDrizzleClient, UnauthorizedException, UnprocessableEntityException, UnsupportedMediaTypeException, UserId, ValidationException, VrittiAuthGuard, addCorrelationIdToResponse, configureApiSdk, correlationStorage, defineConfig, extractCountryFromPhone, generateCorrelationId, getConfig, getCorrelationContext, getHttpStatusTitle, getJwtExpiry, getRefreshCookieOptions, getTokenExpiry, hashToken, jwtConfigFactory, normalizePhoneNumber, parseExpiryToMs, resetConfig, runWithCorrelationContext, updateCorrelationContext, verifyTokenHash };
+declare const DATA_TABLE_VIEWS_TABLE: unique symbol;
+
+interface DataTableModuleOptions {
+    tableViews: PgTable;
+}
+declare class DataTableModule {
+    static forRoot(options: DataTableModuleOptions): DynamicModule;
+}
+
+declare function dataTableViewsColumns(): {
+    id: drizzle_orm.HasDefault<drizzle_orm.IsPrimaryKey<drizzle_orm_pg_core.PgUUIDBuilder>>;
+    userId: drizzle_orm.NotNull<drizzle_orm_pg_core.PgUUIDBuilder>;
+    tableSlug: drizzle_orm.NotNull<drizzle_orm_pg_core.PgVarcharBuilder<[string, ...string[]]>>;
+    name: drizzle_orm.NotNull<drizzle_orm_pg_core.PgVarcharBuilder<[string, ...string[]]>>;
+    state: drizzle_orm.$Type<drizzle_orm.NotNull<drizzle_orm_pg_core.PgJsonbBuilder>, TableViewState>;
+    isShared: drizzle_orm.HasDefault<drizzle_orm.NotNull<drizzle_orm_pg_core.PgBooleanBuilder>>;
+    createdAt: drizzle_orm.HasDefault<drizzle_orm.NotNull<drizzle_orm_pg_core.PgTimestampBuilder>>;
+    updatedAt: drizzle_orm.HasDefault<drizzle_orm_pg_core.PgTimestampBuilder>;
+};
+declare function dataTableViewsIndexes(table: any): drizzle_orm_pg_core.IndexBuilder[];
+interface DataTableViewRecord {
+    id: string;
+    userId: string;
+    tableSlug: string;
+    name: string;
+    state: TableViewState;
+    isShared: boolean;
+    createdAt: Date;
+    updatedAt: Date | null | undefined;
+}
+interface NewDataTableViewRecord {
+    userId: string;
+    tableSlug: string;
+    name: string;
+    state: TableViewState;
+    isShared?: boolean;
+}
+
+declare class DataTableViewDto {
+    id: string;
+    name: string | null;
+    tableSlug: string;
+    state: TableViewState;
+    isShared: boolean;
+    isOwn: boolean;
+    createdAt: Date;
+    updatedAt: Date | null;
+    static from(view: DataTableViewRecord, userId: string): DataTableViewDto;
+}
+
+declare class CreateDataTableViewDto {
+    name: string;
+    tableSlug: string;
+    state: TableViewState;
+    isShared?: boolean;
+}
+
+declare class UpdateDataTableViewDto {
+    state: TableViewState;
+}
+
+declare class DataTableViewsRepository extends PrimaryBaseRepository<PgTable, NewDataTableViewRecord, DataTableViewRecord> {
+    constructor(database: PrimaryDatabaseService, table: PgTable);
+    findPersonalViewsBySlug(userId: string, tableSlug: string): Promise<DataTableViewRecord[]>;
+    findSharedViewsBySlug(tableSlug: string): Promise<DataTableViewRecord[]>;
+}
+
+declare class DataTableViewsService {
+    private readonly dataTableViewsRepository;
+    private readonly cacheService;
+    private readonly configService;
+    private readonly logger;
+    constructor(dataTableViewsRepository: DataTableViewsRepository, cacheService: CacheService, configService: ConfigService);
+    private personalViewsKey;
+    private sharedViewsKey;
+    private get viewsTtl();
+    private getOrCachePersonalViews;
+    private getOrCacheSharedViews;
+    private invalidateViewsCache;
+    findViews(userId: string, tableSlug: string): Promise<DataTableViewDto[]>;
+    createView(userId: string, dto: CreateDataTableViewDto): Promise<DataTableViewDto>;
+    updateView(userId: string, id: string, dto: UpdateDataTableViewDto): Promise<DataTableViewDto>;
+    toggleShareView(userId: string, id: string, isShared: boolean): Promise<DataTableViewDto>;
+    renameView(userId: string, id: string, name: string): Promise<DataTableViewDto>;
+    deleteView(userId: string, id: string): Promise<DataTableViewDto>;
+}
+
+declare class UpsertDataTableStateDto {
+    tableSlug: string;
+    state: TableViewState;
+    activeViewId?: string | null;
+}
+
+declare class DataTableStateService {
+    private readonly cacheService;
+    private readonly configService;
+    private readonly logger;
+    constructor(cacheService: CacheService, configService: ConfigService);
+    private get stateTtl();
+    upsertCurrentState(userId: string, dto: UpsertDataTableStateDto): Promise<void>;
+    getCurrentState(userId: string, tableSlug: string): Promise<{
+        state: TableViewState;
+        activeViewId: string | null;
+    }>;
+}
+
+declare class RenameDataTableViewDto {
+    name: string;
+}
+
+declare class ToggleShareDataTableViewDto {
+    isShared: boolean;
+}
+
+export { AccessToken, type AccessTokenPayload, type ApiErrorResponse, type ApiSdkConfig, AuthConfigModule, BadGatewayException, BadRequestException, CACHE_PROVIDER, CacheModule, CacheService, type ColumnPinning, ConflictException, type CookieConfig, CookieDomain, type CookieSerializeOptions, type CorrelationContext, CorrelationIdMiddleware, CreateDataTableViewDto, DATA_TABLE_VIEWS_TABLE, DEFAULT_CORRELATION_HEADER, DataTableModule, type DataTableModuleOptions, DataTableStateService, DataTableViewDto, type DataTableViewRecord, DataTableViewsService, DatabaseModule, type DatabaseModuleOptions, type DensityType, EmailModule, EmailService, type FieldDefinition, type FieldError, type FieldMap, type FilterCondition, type FilterOperator, FilterProcessor, type FindForSelectConfig, type FindForSelectJoin, ForbiddenException, GoneException, type GuardConfig, HttpExceptionFilter, HttpLoggerInterceptor, type HttpLoggerOptions, HttpProblemException, type ICacheProvider, InternalServerErrorException, JwtAuthService, type JwtConfig, LOGGER_MODULE_OPTIONS, type LogFormat, type LogLevel, type LogMetadata, LoggerModule, type LoggerModuleAsyncOptions, type LoggerModuleOptions, type LoggerOptionsFactory, LoggerService, MethodNotAllowedException, type NewDataTableViewRecord, NotAcceptableException, NotFoundException, NotImplementedException, Onboarding, PayloadTooLargeException, PrimaryBaseRepository, PrimaryDatabaseService, type PrimaryDbConfig, type ProblemDetails, type ProblemOptions, Public, RESET_KEY, RedisCacheProvider, RefreshCookieOptions, RefreshTokenCookie, type RefreshTokenPayload, type RegisteredSchema, RenameDataTableViewDto, RequestTimeoutException, Reset, RootModule, SKIP_CSRF_KEY, SelectOptionsQueryDto, type SelectQueryGroup, type SelectQueryOption, type SelectQueryResult, ServiceUnavailableException, SessionData, type SessionInfo, SkipCsrf, type SortCondition, SuccessResponseDto, TableResponseDto, type TableViewState, Tenant, TenantBaseRepository, TenantContextService, TenantDatabaseService, type TenantInfo, ToggleShareDataTableViewDto, type TokenExpiry, TokenType, TooManyRequestsException, type TypedDrizzleClient, UnauthorizedException, UnprocessableEntityException, UnsupportedMediaTypeException, UpdateDataTableViewDto, UpsertDataTableStateDto, UserId, ValidationException, VrittiAuthGuard, addCorrelationIdToResponse, configureApiSdk, correlationStorage, dataTableViewsColumns, dataTableViewsIndexes, defineConfig, extractCountryFromPhone, generateCorrelationId, getConfig, getCorrelationContext, getHttpStatusTitle, getJwtExpiry, getRefreshCookieOptions, getRefreshCookieOptionsForHost, getTokenExpiry, hashToken, jwtConfigFactory, normalizePhoneNumber, parseExpiryToMs, resetConfig, runWithCorrelationContext, updateCorrelationContext, verifyTokenHash };