swiftbase-sdk 1.0.1

package/dist/index.d.cts

@@ -0,0 +1,296 @@
+interface initializeSdkOptions {
+    baseUrl: string;
+    debounceTimeout?: number;
+    cacheArticles?: boolean;
+    searchCacheEnabled?: boolean;
+    searchCacheCapacity?: number;
+}
+declare const initializeSdk: (projectId: string, options?: initializeSdkOptions) => void;
+declare const setAccessToken: (token: string, expiration?: number) => void;
+declare const setRefreshToken: (token: string, expiration?: number) => void;
+declare const refreshTokens: () => Promise<void>;
+
+interface RESTPaginatedResponse<T> {
+    data: T[];
+    meta: {
+        total: number;
+        page: number;
+        limit: number;
+        next: string | null;
+        back: string | null;
+    };
+}
+declare class PaginatedResponse<T> {
+    #private;
+    constructor(response: RESTPaginatedResponse<T>);
+    get items(): T[];
+    get total(): number;
+    get page(): number;
+    get limit(): number;
+    get hasNext(): boolean;
+    get hasBack(): boolean;
+    next(): Promise<PaginatedResponse<T> | null>;
+    back(): Promise<PaginatedResponse<T> | null>;
+}
+
+interface Profile {
+    id: string;
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    projectId?: string;
+    roles?: string[];
+    lastLoginAt?: string;
+    failedLoginAttempts?: number;
+    lockedUntilAt?: string;
+    attributes?: Record<string, any>;
+    createdAt?: string;
+    updatedAt?: string;
+}
+interface ProfileInput {
+    firstName?: string;
+    lastName?: string;
+    attributes?: Record<string, any>;
+}
+interface ChangePasswordInput {
+    currentPassword?: string;
+    newPassword?: string;
+}
+
+interface LoginInput {
+    projectId: string;
+    email: string;
+    password?: string;
+}
+interface ResetPasswordInput {
+    projectId: string;
+    email: string;
+}
+interface AuthorizeOptions {
+    redirectUri?: string;
+    state?: string;
+    scope?: string;
+    prompt?: "login" | "none";
+}
+interface TokenResponse {
+    access_token: string;
+    refresh_token?: string;
+    id_token?: string;
+    token_type: string;
+    expires_in: number;
+    scope?: string;
+    user?: Profile;
+}
+
+/**
+ * Login with email and password
+ *
+ * @param {LoginInput} input The login credentials
+ *
+ * @returns {Promise<Profile>} The user profile
+ */
+declare const loginWithPassword: (input: LoginInput) => Promise<Profile>;
+
+/**
+ * Login as a service
+ *
+ * @param {string} projectId The project ID
+ * @param {string} serviceId The service ID
+ * @param {string} secretKey The service secret key
+ *
+ * @returns {Promise<any>} The login response
+ */
+declare const loginService: (projectId: string, serviceId: string, secretKey: string) => Promise<any>;
+
+/**
+ * Redirects the user to the Swiftbase-Auth universal login page
+ *
+ * @param {AuthorizeOptions} options Optional authorization parameters
+ */
+declare const loginWithRedirect: (options?: AuthorizeOptions) => Promise<void>;
+
+/**
+ * Handles the redirect callback from the Swiftbase-Auth service
+ *
+ * @param {string} url Optional URL to parse, defaults to window.location.href
+ *
+ * @returns {Promise<Profile>} The user profile
+ */
+declare const handleRedirectCallback: (url?: string) => Promise<Profile>;
+
+/**
+ * Reset password for email
+ *
+ * @param {ResetPasswordInput} input The reset password input
+ *
+ * @returns {Promise<{ success: boolean }>} The result of the reset password request
+ */
+declare const resetPassword: (input: ResetPasswordInput) => Promise<{
+    success: boolean;
+}>;
+
+/**
+ * Checks if the user is currently logged in (has a valid session)
+ *
+ * @returns {boolean} True if logged in, false otherwise
+ */
+declare const isLoggedIn: () => boolean;
+
+/**
+ * Logs the user out by clearing tokens and redirecting to the logout page
+ */
+declare const logout: () => Promise<void>;
+
+/**
+ * Gets the current access token, refreshing it if necessary
+ *
+ * @param {boolean} forceRefresh If true, the token will be refreshed even if it's not expired
+ *
+ * @returns {Promise<string | null>} The access token, or null if no session exists
+ */
+declare const getAccessToken: (forceRefresh?: boolean) => Promise<string | null>;
+
+/**
+ * Verify a user token
+ *
+ * @param {string} token The token to verify
+ * @param {string} projectId The project ID (optional, defaults to SDK initialized project)
+ *
+ * @returns {Promise<Profile>} The user profile if valid
+ */
+declare const verifyToken: (token: string, projectId?: string) => Promise<Profile>;
+/**
+ * Verify a service token
+ *
+ * @param {string} token The token to verify
+ * @param {string} projectId The project ID (optional, defaults to SDK initialized project)
+ * @param {string} scope The scope to check (optional)
+ *
+ * @returns {Promise<any>} The service info if valid
+ */
+declare const verifyServiceToken: (token: string, projectId?: string, scope?: string) => Promise<any>;
+
+/**
+ * Get the current user profile
+ *
+ * @returns {Promise<Profile>} The user profile
+ */
+declare const getProfile: () => Promise<Profile>;
+
+/**
+ * Update the current user profile
+ *
+ * @param {ProfileInput} input The profile data to update
+ *
+ * @returns {Promise<Profile>} The updated user profile
+ */
+declare const updateProfile: (input: ProfileInput) => Promise<Profile>;
+
+/**
+ * Update any user profile (Admin only)
+ *
+ * @param {string} id The user ID to update
+ * @param {any} input The profile data to update
+ *
+ * @returns {Promise<Profile>} The updated user profile
+ */
+declare const updateUser: (id: string, input: any) => Promise<Profile>;
+
+/**
+ * Change the current user password
+ *
+ * @param {ChangePasswordInput} input The password change input
+ *
+ * @returns {Promise<{ success: boolean }>} The result of the password change request
+ */
+declare const changePassword: (input: ChangePasswordInput) => Promise<{
+    success: boolean;
+}>;
+
+declare const getUsers: (projectId: string) => Promise<any>;
+declare const getRoles: (projectId: string) => Promise<any>;
+declare const getServices: (projectId: string) => Promise<any>;
+declare const createRole: (input: any) => Promise<any>;
+declare const deleteRole: (id: string) => Promise<any>;
+declare const createService: (input: any) => Promise<any>;
+declare const deleteService: (id: string) => Promise<any>;
+declare const assignRole: (userId: string, roleName: string) => Promise<any>;
+declare const unassignRole: (userId: string, roleName: string) => Promise<any>;
+
+declare class QueryBuilder implements PromiseLike<any> {
+    private dbName;
+    private tableName;
+    private payload;
+    constructor(dbName: string, tableName: string);
+    select(...columns: Array<string | string[]>): this;
+    where(column: string, value: any): this;
+    where(column: string, operator: string, value: any): this;
+    where(obj: Record<string, any>): this;
+    limit(value: number): this;
+    offset(value: number): this;
+    insert(data: any): this;
+    update(data: any): this;
+    delete(): this;
+    listen(callback: (change: {
+        event: 'insert' | 'update' | 'delete';
+        data: any;
+    }) => void): () => void;
+    execute(): Promise<{
+        data: any[];
+        columns: string[];
+        count: number;
+    }>;
+    then<TResult1 = any, TResult2 = never>(onfulfilled?: ((value: any) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
+}
+declare function db(dbName: string): (tableName: string) => QueryBuilder;
+
+interface StorageOptions {
+    bucket: string;
+    endpoint?: string;
+    region?: string;
+    accessKeyId?: string;
+    secretAccessKey?: string;
+}
+interface BucketInfo {
+    name: string;
+    creationDate?: string;
+}
+interface S3Object {
+    key: string;
+    lastModified?: string;
+    etag?: string;
+    size: number;
+}
+interface ListObjectsResult {
+    name: string;
+    prefix: string;
+    maxKeys: number;
+    isTruncated: boolean;
+    contents: S3Object[];
+    commonPrefixes: string[];
+}
+declare class Storage {
+    private bucket;
+    private endpoint;
+    private region;
+    private accessKeyId?;
+    private secretAccessKey?;
+    constructor(options: StorageOptions);
+    private getHeaders;
+    listBuckets(): Promise<BucketInfo[]>;
+    listObjects(options?: {
+        prefix?: string;
+        delimiter?: string;
+        maxKeys?: number;
+    }): Promise<ListObjectsResult>;
+    getObject(key: string): Promise<Response>;
+    getObjectAsText(key: string): Promise<string>;
+    getObjectAsJson<T = any>(key: string): Promise<T>;
+    getObjectAsArrayBuffer(key: string): Promise<ArrayBuffer>;
+    putObject(key: string, body: Uint8Array | ArrayBuffer | string | Blob, options?: {
+        contentType?: string;
+    }): Promise<void>;
+    deleteObject(key: string): Promise<void>;
+}
+
+export { type AuthorizeOptions, type BucketInfo, type ChangePasswordInput, type ListObjectsResult, type LoginInput, PaginatedResponse, type Profile, type ProfileInput, type ResetPasswordInput, type S3Object, Storage, type StorageOptions, type TokenResponse, assignRole, changePassword, createRole, createService, db, deleteRole, deleteService, getAccessToken, getProfile, getRoles, getServices, getUsers, handleRedirectCallback, initializeSdk, isLoggedIn, loginService as login, loginService, loginWithPassword, loginWithRedirect, logout, refreshTokens, resetPassword, setAccessToken, setRefreshToken, unassignRole, updateProfile, updateUser, verifyServiceToken, verifyToken };

package/dist/index.d.ts

@@ -0,0 +1,296 @@
+interface initializeSdkOptions {
+    baseUrl: string;
+    debounceTimeout?: number;
+    cacheArticles?: boolean;
+    searchCacheEnabled?: boolean;
+    searchCacheCapacity?: number;
+}
+declare const initializeSdk: (projectId: string, options?: initializeSdkOptions) => void;
+declare const setAccessToken: (token: string, expiration?: number) => void;
+declare const setRefreshToken: (token: string, expiration?: number) => void;
+declare const refreshTokens: () => Promise<void>;
+
+interface RESTPaginatedResponse<T> {
+    data: T[];
+    meta: {
+        total: number;
+        page: number;
+        limit: number;
+        next: string | null;
+        back: string | null;
+    };
+}
+declare class PaginatedResponse<T> {
+    #private;
+    constructor(response: RESTPaginatedResponse<T>);
+    get items(): T[];
+    get total(): number;
+    get page(): number;
+    get limit(): number;
+    get hasNext(): boolean;
+    get hasBack(): boolean;
+    next(): Promise<PaginatedResponse<T> | null>;
+    back(): Promise<PaginatedResponse<T> | null>;
+}
+
+interface Profile {
+    id: string;
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    projectId?: string;
+    roles?: string[];
+    lastLoginAt?: string;
+    failedLoginAttempts?: number;
+    lockedUntilAt?: string;
+    attributes?: Record<string, any>;
+    createdAt?: string;
+    updatedAt?: string;
+}
+interface ProfileInput {
+    firstName?: string;
+    lastName?: string;
+    attributes?: Record<string, any>;
+}
+interface ChangePasswordInput {
+    currentPassword?: string;
+    newPassword?: string;
+}
+
+interface LoginInput {
+    projectId: string;
+    email: string;
+    password?: string;
+}
+interface ResetPasswordInput {
+    projectId: string;
+    email: string;
+}
+interface AuthorizeOptions {
+    redirectUri?: string;
+    state?: string;
+    scope?: string;
+    prompt?: "login" | "none";
+}
+interface TokenResponse {
+    access_token: string;
+    refresh_token?: string;
+    id_token?: string;
+    token_type: string;
+    expires_in: number;
+    scope?: string;
+    user?: Profile;
+}
+
+/**
+ * Login with email and password
+ *
+ * @param {LoginInput} input The login credentials
+ *
+ * @returns {Promise<Profile>} The user profile
+ */
+declare const loginWithPassword: (input: LoginInput) => Promise<Profile>;
+
+/**
+ * Login as a service
+ *
+ * @param {string} projectId The project ID
+ * @param {string} serviceId The service ID
+ * @param {string} secretKey The service secret key
+ *
+ * @returns {Promise<any>} The login response
+ */
+declare const loginService: (projectId: string, serviceId: string, secretKey: string) => Promise<any>;
+
+/**
+ * Redirects the user to the Swiftbase-Auth universal login page
+ *
+ * @param {AuthorizeOptions} options Optional authorization parameters
+ */
+declare const loginWithRedirect: (options?: AuthorizeOptions) => Promise<void>;
+
+/**
+ * Handles the redirect callback from the Swiftbase-Auth service
+ *
+ * @param {string} url Optional URL to parse, defaults to window.location.href
+ *
+ * @returns {Promise<Profile>} The user profile
+ */
+declare const handleRedirectCallback: (url?: string) => Promise<Profile>;
+
+/**
+ * Reset password for email
+ *
+ * @param {ResetPasswordInput} input The reset password input
+ *
+ * @returns {Promise<{ success: boolean }>} The result of the reset password request
+ */
+declare const resetPassword: (input: ResetPasswordInput) => Promise<{
+    success: boolean;
+}>;
+
+/**
+ * Checks if the user is currently logged in (has a valid session)
+ *
+ * @returns {boolean} True if logged in, false otherwise
+ */
+declare const isLoggedIn: () => boolean;
+
+/**
+ * Logs the user out by clearing tokens and redirecting to the logout page
+ */
+declare const logout: () => Promise<void>;
+
+/**
+ * Gets the current access token, refreshing it if necessary
+ *
+ * @param {boolean} forceRefresh If true, the token will be refreshed even if it's not expired
+ *
+ * @returns {Promise<string | null>} The access token, or null if no session exists
+ */
+declare const getAccessToken: (forceRefresh?: boolean) => Promise<string | null>;
+
+/**
+ * Verify a user token
+ *
+ * @param {string} token The token to verify
+ * @param {string} projectId The project ID (optional, defaults to SDK initialized project)
+ *
+ * @returns {Promise<Profile>} The user profile if valid
+ */
+declare const verifyToken: (token: string, projectId?: string) => Promise<Profile>;
+/**
+ * Verify a service token
+ *
+ * @param {string} token The token to verify
+ * @param {string} projectId The project ID (optional, defaults to SDK initialized project)
+ * @param {string} scope The scope to check (optional)
+ *
+ * @returns {Promise<any>} The service info if valid
+ */
+declare const verifyServiceToken: (token: string, projectId?: string, scope?: string) => Promise<any>;
+
+/**
+ * Get the current user profile
+ *
+ * @returns {Promise<Profile>} The user profile
+ */
+declare const getProfile: () => Promise<Profile>;
+
+/**
+ * Update the current user profile
+ *
+ * @param {ProfileInput} input The profile data to update
+ *
+ * @returns {Promise<Profile>} The updated user profile
+ */
+declare const updateProfile: (input: ProfileInput) => Promise<Profile>;
+
+/**
+ * Update any user profile (Admin only)
+ *
+ * @param {string} id The user ID to update
+ * @param {any} input The profile data to update
+ *
+ * @returns {Promise<Profile>} The updated user profile
+ */
+declare const updateUser: (id: string, input: any) => Promise<Profile>;
+
+/**
+ * Change the current user password
+ *
+ * @param {ChangePasswordInput} input The password change input
+ *
+ * @returns {Promise<{ success: boolean }>} The result of the password change request
+ */
+declare const changePassword: (input: ChangePasswordInput) => Promise<{
+    success: boolean;
+}>;
+
+declare const getUsers: (projectId: string) => Promise<any>;
+declare const getRoles: (projectId: string) => Promise<any>;
+declare const getServices: (projectId: string) => Promise<any>;
+declare const createRole: (input: any) => Promise<any>;
+declare const deleteRole: (id: string) => Promise<any>;
+declare const createService: (input: any) => Promise<any>;
+declare const deleteService: (id: string) => Promise<any>;
+declare const assignRole: (userId: string, roleName: string) => Promise<any>;
+declare const unassignRole: (userId: string, roleName: string) => Promise<any>;
+
+declare class QueryBuilder implements PromiseLike<any> {
+    private dbName;
+    private tableName;
+    private payload;
+    constructor(dbName: string, tableName: string);
+    select(...columns: Array<string | string[]>): this;
+    where(column: string, value: any): this;
+    where(column: string, operator: string, value: any): this;
+    where(obj: Record<string, any>): this;
+    limit(value: number): this;
+    offset(value: number): this;
+    insert(data: any): this;
+    update(data: any): this;
+    delete(): this;
+    listen(callback: (change: {
+        event: 'insert' | 'update' | 'delete';
+        data: any;
+    }) => void): () => void;
+    execute(): Promise<{
+        data: any[];
+        columns: string[];
+        count: number;
+    }>;
+    then<TResult1 = any, TResult2 = never>(onfulfilled?: ((value: any) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
+}
+declare function db(dbName: string): (tableName: string) => QueryBuilder;
+
+interface StorageOptions {
+    bucket: string;
+    endpoint?: string;
+    region?: string;
+    accessKeyId?: string;
+    secretAccessKey?: string;
+}
+interface BucketInfo {
+    name: string;
+    creationDate?: string;
+}
+interface S3Object {
+    key: string;
+    lastModified?: string;
+    etag?: string;
+    size: number;
+}
+interface ListObjectsResult {
+    name: string;
+    prefix: string;
+    maxKeys: number;
+    isTruncated: boolean;
+    contents: S3Object[];
+    commonPrefixes: string[];
+}
+declare class Storage {
+    private bucket;
+    private endpoint;
+    private region;
+    private accessKeyId?;
+    private secretAccessKey?;
+    constructor(options: StorageOptions);
+    private getHeaders;
+    listBuckets(): Promise<BucketInfo[]>;
+    listObjects(options?: {
+        prefix?: string;
+        delimiter?: string;
+        maxKeys?: number;
+    }): Promise<ListObjectsResult>;
+    getObject(key: string): Promise<Response>;
+    getObjectAsText(key: string): Promise<string>;
+    getObjectAsJson<T = any>(key: string): Promise<T>;
+    getObjectAsArrayBuffer(key: string): Promise<ArrayBuffer>;
+    putObject(key: string, body: Uint8Array | ArrayBuffer | string | Blob, options?: {
+        contentType?: string;
+    }): Promise<void>;
+    deleteObject(key: string): Promise<void>;
+}
+
+export { type AuthorizeOptions, type BucketInfo, type ChangePasswordInput, type ListObjectsResult, type LoginInput, PaginatedResponse, type Profile, type ProfileInput, type ResetPasswordInput, type S3Object, Storage, type StorageOptions, type TokenResponse, assignRole, changePassword, createRole, createService, db, deleteRole, deleteService, getAccessToken, getProfile, getRoles, getServices, getUsers, handleRedirectCallback, initializeSdk, isLoggedIn, loginService as login, loginService, loginWithPassword, loginWithRedirect, logout, refreshTokens, resetPassword, setAccessToken, setRefreshToken, unassignRole, updateProfile, updateUser, verifyServiceToken, verifyToken };