swiftbase-admin-sdk 1.0.0

package/dist/index.d.cts

@@ -0,0 +1,360 @@
+declare class Token {
+    #private;
+    constructor(token: string, type: string, expiration?: number);
+    private decodeExpiration;
+    /**
+     * Getter for the raw token
+     *
+     * @returns {string} The token
+     */
+    value(): string;
+    /**
+     * Checks if the token is valid
+     *
+     * @returns {boolean} True if the API key is valid, false otherwise
+     */
+    isValid(): boolean;
+    /**
+     * Checks if the API key is a secret key
+     *
+     * @returns {boolean} True if the API key is a secret key, false otherwise
+     */
+    isAccessToken(): boolean;
+    /**
+     * Checks if the API key is a public key
+     *
+     * @returns {boolean} True if the API key is a public key, false otherwise
+     */
+    isRefreshToken(): boolean;
+}
+
+interface SwiftbaseApp {
+    projectId: string;
+    baseUrl: string;
+    accessToken: Token | null;
+    serviceId?: string;
+    serviceKey?: string;
+    debounceTimeout: number;
+    cacheArticles: boolean;
+    searchCacheEnabled: boolean;
+    searchCacheCapacity: number;
+}
+interface initializeSdkOptions {
+    baseUrl: string;
+    serviceId?: string;
+    serviceKey?: string;
+    debounceTimeout?: number;
+    cacheArticles?: boolean;
+    searchCacheEnabled?: boolean;
+    searchCacheCapacity?: number;
+}
+declare const app: SwiftbaseApp;
+declare const initializeSdk: (projectId: string, options: initializeSdkOptions) => void;
+declare const setAccessToken: (token: string, expiration?: number) => void;
+declare const isLoggedIn: () => boolean;
+declare const logout: () => 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>;
+}
+
+/**
+ * Login as a service
+ *
+ * @param {string} serviceId The service ID
+ * @param {string} secretKey The service secret key
+ *
+ * @returns {Promise<void>}
+ */
+declare const login: (serviceId: string, secretKey: string) => Promise<void>;
+
+/**
+ * Get a valid access token.
+ * If the current token is missing or expired, it will attempt to login again
+ * using the stored serviceId and serviceKey.
+ *
+ * @returns {Promise<string | null>} The access token
+ */
+declare const getAccessToken: () => Promise<string | null>;
+
+interface User$1 {
+    id: string;
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    avatar?: string;
+    projectId?: string;
+    roles?: string[];
+    approved?: boolean;
+    attributes?: Record<string, any>;
+}
+
+/**
+ * Verify a user's access token
+ *
+ * @param {string} token The access token to verify
+ *
+ * @returns {Promise<User>} The user associated with the token
+ */
+declare const verifyToken: (token: string) => Promise<User$1>;
+
+interface Role {
+    id: string;
+    name: string;
+    permissions: string[];
+    projectId: string;
+}
+interface RoleInput {
+    name: string;
+    permissions: string[];
+    projectId: string;
+}
+interface RoleUpdateInput {
+    id: string;
+    name?: string;
+    permissions?: string[];
+}
+interface Service {
+    id: string;
+    name: string;
+    description?: string;
+    projectId: string;
+    scope?: string[];
+}
+interface ServiceInput {
+    name: string;
+    description?: string;
+    projectId: string;
+    secretKey: string;
+    scope?: string[];
+}
+interface ServiceUpdateInput {
+    id: string;
+    name?: string;
+    description?: string;
+}
+interface User {
+    id: string;
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    avatar?: string;
+    projectId?: string;
+    roles?: string[];
+    approved?: boolean;
+    attributes?: any;
+}
+
+/**
+ * Verify a service's access token
+ *
+ * @param {string} token The access token to verify
+ * @param {string} [scope] Optional scope to verify
+ *
+ * @returns {Promise<Service>} The service associated with the token
+ */
+declare const verifyServiceToken: (token: string, scope?: string) => Promise<Service>;
+
+/**
+ * Roles Management
+ */
+declare const getRoles: (projectId: string) => Promise<Role[]>;
+declare const createRole: (input: RoleInput) => Promise<Role>;
+declare const updateRole: (input: RoleUpdateInput) => Promise<Role>;
+declare const deleteRole: (id: string) => Promise<string>;
+/**
+ * Services Management
+ */
+declare const getServices: (projectId: string) => Promise<Service[]>;
+declare const createService: (input: ServiceInput) => Promise<Service>;
+declare const updateService: (input: ServiceUpdateInput) => Promise<Service>;
+declare const deleteService: (id: string) => Promise<string>;
+/**
+ * User Management
+ */
+declare const getUsers: (projectId: string) => Promise<User[]>;
+declare const assignRole: (userId: string, roleName: string) => Promise<User>;
+declare const unassignRole: (userId: string, roleName: string) => Promise<User>;
+
+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;
+}
+
+/**
+ * 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 profile
+ */
+declare const updateProfile: (input: ProfileInput) => Promise<Profile>;
+
+/**
+ * Update a user by ID
+ *
+ * @param {string} id The user ID
+ * @param {ProfileInput} input The user data to update
+ * @returns {Promise<Profile>} The updated user
+ */
+declare const updateUser: (id: string, input: ProfileInput) => Promise<Profile>;
+
+/**
+ * Change the current user password
+ *
+ * @param {ChangePasswordInput} input The password data
+ * @returns {Promise<void>}
+ */
+declare const changePassword: (input: ChangePasswordInput) => Promise<void>;
+
+interface Configuration {
+    id: string;
+    project_id: string;
+    allow_registration: boolean;
+    allow_password_reset: boolean;
+    mfa_required: boolean;
+    access_expiry: string;
+    refresh_expiry: string;
+    google_enabled: boolean;
+    microsoft_enabled: boolean;
+    github_enabled: boolean;
+    facebook_enabled: boolean;
+    apple_enabled: boolean;
+    totp_enabled: boolean;
+    totp_required: boolean;
+    passkeys_enabled: boolean;
+    universal_login_enabled: boolean;
+    request_beta_access: boolean;
+    beta_access_button_text: string;
+    brand_name: string;
+    brand_logo_url?: string;
+    primary_color: string;
+    created_at: string;
+    updated_at: string;
+}
+type ConfigurationInput = Partial<Omit<Configuration, "id" | "project_id" | "created_at" | "updated_at">>;
+
+declare const getConfiguration: (projectId: string) => Promise<Configuration>;
+declare const updateConfiguration: (projectId: string, data: ConfigurationInput) => Promise<Configuration>;
+
+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 BucketInfo, type ChangePasswordInput, type Configuration, type ConfigurationInput, type User as IdentityUser, type ListObjectsResult, PaginatedResponse, type Profile, type ProfileInput, type Role, type RoleInput, type RoleUpdateInput, type S3Object, type Service, type ServiceInput, type ServiceUpdateInput, Storage, type StorageOptions, type User$1 as User, app, assignRole, changePassword, createRole, createService, db, deleteRole, deleteService, getAccessToken, getConfiguration, getProfile, getRoles, getServices, getUsers, initializeSdk, isLoggedIn, login, logout, setAccessToken, unassignRole, updateConfiguration, updateProfile, updateRole, updateService, updateUser, verifyServiceToken, verifyToken };

package/dist/index.d.ts

@@ -0,0 +1,360 @@
+declare class Token {
+    #private;
+    constructor(token: string, type: string, expiration?: number);
+    private decodeExpiration;
+    /**
+     * Getter for the raw token
+     *
+     * @returns {string} The token
+     */
+    value(): string;
+    /**
+     * Checks if the token is valid
+     *
+     * @returns {boolean} True if the API key is valid, false otherwise
+     */
+    isValid(): boolean;
+    /**
+     * Checks if the API key is a secret key
+     *
+     * @returns {boolean} True if the API key is a secret key, false otherwise
+     */
+    isAccessToken(): boolean;
+    /**
+     * Checks if the API key is a public key
+     *
+     * @returns {boolean} True if the API key is a public key, false otherwise
+     */
+    isRefreshToken(): boolean;
+}
+
+interface SwiftbaseApp {
+    projectId: string;
+    baseUrl: string;
+    accessToken: Token | null;
+    serviceId?: string;
+    serviceKey?: string;
+    debounceTimeout: number;
+    cacheArticles: boolean;
+    searchCacheEnabled: boolean;
+    searchCacheCapacity: number;
+}
+interface initializeSdkOptions {
+    baseUrl: string;
+    serviceId?: string;
+    serviceKey?: string;
+    debounceTimeout?: number;
+    cacheArticles?: boolean;
+    searchCacheEnabled?: boolean;
+    searchCacheCapacity?: number;
+}
+declare const app: SwiftbaseApp;
+declare const initializeSdk: (projectId: string, options: initializeSdkOptions) => void;
+declare const setAccessToken: (token: string, expiration?: number) => void;
+declare const isLoggedIn: () => boolean;
+declare const logout: () => 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>;
+}
+
+/**
+ * Login as a service
+ *
+ * @param {string} serviceId The service ID
+ * @param {string} secretKey The service secret key
+ *
+ * @returns {Promise<void>}
+ */
+declare const login: (serviceId: string, secretKey: string) => Promise<void>;
+
+/**
+ * Get a valid access token.
+ * If the current token is missing or expired, it will attempt to login again
+ * using the stored serviceId and serviceKey.
+ *
+ * @returns {Promise<string | null>} The access token
+ */
+declare const getAccessToken: () => Promise<string | null>;
+
+interface User$1 {
+    id: string;
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    avatar?: string;
+    projectId?: string;
+    roles?: string[];
+    approved?: boolean;
+    attributes?: Record<string, any>;
+}
+
+/**
+ * Verify a user's access token
+ *
+ * @param {string} token The access token to verify
+ *
+ * @returns {Promise<User>} The user associated with the token
+ */
+declare const verifyToken: (token: string) => Promise<User$1>;
+
+interface Role {
+    id: string;
+    name: string;
+    permissions: string[];
+    projectId: string;
+}
+interface RoleInput {
+    name: string;
+    permissions: string[];
+    projectId: string;
+}
+interface RoleUpdateInput {
+    id: string;
+    name?: string;
+    permissions?: string[];
+}
+interface Service {
+    id: string;
+    name: string;
+    description?: string;
+    projectId: string;
+    scope?: string[];
+}
+interface ServiceInput {
+    name: string;
+    description?: string;
+    projectId: string;
+    secretKey: string;
+    scope?: string[];
+}
+interface ServiceUpdateInput {
+    id: string;
+    name?: string;
+    description?: string;
+}
+interface User {
+    id: string;
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    avatar?: string;
+    projectId?: string;
+    roles?: string[];
+    approved?: boolean;
+    attributes?: any;
+}
+
+/**
+ * Verify a service's access token
+ *
+ * @param {string} token The access token to verify
+ * @param {string} [scope] Optional scope to verify
+ *
+ * @returns {Promise<Service>} The service associated with the token
+ */
+declare const verifyServiceToken: (token: string, scope?: string) => Promise<Service>;
+
+/**
+ * Roles Management
+ */
+declare const getRoles: (projectId: string) => Promise<Role[]>;
+declare const createRole: (input: RoleInput) => Promise<Role>;
+declare const updateRole: (input: RoleUpdateInput) => Promise<Role>;
+declare const deleteRole: (id: string) => Promise<string>;
+/**
+ * Services Management
+ */
+declare const getServices: (projectId: string) => Promise<Service[]>;
+declare const createService: (input: ServiceInput) => Promise<Service>;
+declare const updateService: (input: ServiceUpdateInput) => Promise<Service>;
+declare const deleteService: (id: string) => Promise<string>;
+/**
+ * User Management
+ */
+declare const getUsers: (projectId: string) => Promise<User[]>;
+declare const assignRole: (userId: string, roleName: string) => Promise<User>;
+declare const unassignRole: (userId: string, roleName: string) => Promise<User>;
+
+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;
+}
+
+/**
+ * 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 profile
+ */
+declare const updateProfile: (input: ProfileInput) => Promise<Profile>;
+
+/**
+ * Update a user by ID
+ *
+ * @param {string} id The user ID
+ * @param {ProfileInput} input The user data to update
+ * @returns {Promise<Profile>} The updated user
+ */
+declare const updateUser: (id: string, input: ProfileInput) => Promise<Profile>;
+
+/**
+ * Change the current user password
+ *
+ * @param {ChangePasswordInput} input The password data
+ * @returns {Promise<void>}
+ */
+declare const changePassword: (input: ChangePasswordInput) => Promise<void>;
+
+interface Configuration {
+    id: string;
+    project_id: string;
+    allow_registration: boolean;
+    allow_password_reset: boolean;
+    mfa_required: boolean;
+    access_expiry: string;
+    refresh_expiry: string;
+    google_enabled: boolean;
+    microsoft_enabled: boolean;
+    github_enabled: boolean;
+    facebook_enabled: boolean;
+    apple_enabled: boolean;
+    totp_enabled: boolean;
+    totp_required: boolean;
+    passkeys_enabled: boolean;
+    universal_login_enabled: boolean;
+    request_beta_access: boolean;
+    beta_access_button_text: string;
+    brand_name: string;
+    brand_logo_url?: string;
+    primary_color: string;
+    created_at: string;
+    updated_at: string;
+}
+type ConfigurationInput = Partial<Omit<Configuration, "id" | "project_id" | "created_at" | "updated_at">>;
+
+declare const getConfiguration: (projectId: string) => Promise<Configuration>;
+declare const updateConfiguration: (projectId: string, data: ConfigurationInput) => Promise<Configuration>;
+
+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 BucketInfo, type ChangePasswordInput, type Configuration, type ConfigurationInput, type User as IdentityUser, type ListObjectsResult, PaginatedResponse, type Profile, type ProfileInput, type Role, type RoleInput, type RoleUpdateInput, type S3Object, type Service, type ServiceInput, type ServiceUpdateInput, Storage, type StorageOptions, type User$1 as User, app, assignRole, changePassword, createRole, createService, db, deleteRole, deleteService, getAccessToken, getConfiguration, getProfile, getRoles, getServices, getUsers, initializeSdk, isLoggedIn, login, logout, setAccessToken, unassignRole, updateConfiguration, updateProfile, updateRole, updateService, updateUser, verifyServiceToken, verifyToken };