superso-js-sdk 1.0.1

package/dist/core/client.js

@@ -0,0 +1,15 @@
+export class SupersoClient {
+    constructor(config) {
+        this.projectId =
+            config.projectId;
+        this.apiKey =
+            config.apiKey;
+        this.baseUrl =
+            config.baseUrl ||
+                "http://localhost:8080";
+    }
+}
+// initialize sdk
+export function createClient(config) {
+    return new SupersoClient(config);
+}

package/dist/database/database.d.ts

@@ -0,0 +1,53 @@
+import { SupersoClient } from "../core/client";
+export interface QueryOptions {
+    limit?: number;
+    offset?: number;
+    sort?: string;
+    order?: "asc" | "desc";
+    filters?: Record<string, any>;
+}
+export interface AdvancedQuery {
+    where?: Record<string, any>;
+    orderBy?: {
+        field: string;
+        dir: "asc" | "desc";
+    }[];
+    limit?: number;
+    offset?: number;
+    search?: string;
+    cursor?: string;
+    after?: string;
+}
+export declare function createDocument(client: SupersoClient, collection: string, data: any, auth?: boolean): Promise<any>;
+export declare function getDocuments(client: SupersoClient, collection: string, query?: QueryOptions, auth?: boolean): Promise<any>;
+export declare function getDocument(client: SupersoClient, collection: string, documentId: string, auth?: boolean): Promise<any>;
+export declare function updateDocument(client: SupersoClient, collection: string, documentId: string, data: any, auth?: boolean): Promise<any>;
+export declare function replaceDocument(client: SupersoClient, collection: string, documentId: string, data: any, auth?: boolean): Promise<any>;
+export declare function deleteDocument(client: SupersoClient, collection: string, documentId: string, auth?: boolean): Promise<any>;
+export declare function restoreDocument(client: SupersoClient, collection: string, documentId: string, auth?: boolean): Promise<any>;
+export declare function purgeDocument(client: SupersoClient, collection: string, documentId: string, auth?: boolean): Promise<any>;
+export declare function upsertDocument(client: SupersoClient, collection: string, documentId: string, data: any, auth?: boolean): Promise<any>;
+export declare function existsDocument(client: SupersoClient, collection: string, documentId: string, auth?: boolean): Promise<boolean>;
+export declare function countDocuments(client: SupersoClient, collection: string, query?: QueryOptions, auth?: boolean): Promise<any>;
+export declare function queryDocuments(client: SupersoClient, collection: string, query: AdvancedQuery, auth?: boolean): Promise<any>;
+export declare function searchDocuments(client: SupersoClient, collection: string, search: string, auth?: boolean): Promise<any>;
+export declare function paginateDocuments(client: SupersoClient, collection: string, query: AdvancedQuery, auth?: boolean): Promise<any>;
+export declare function infiniteScroll(client: SupersoClient, collection: string, cursor: string, limit?: number, auth?: boolean): Promise<any>;
+export declare function aggregateDocuments(client: SupersoClient, collection: string, payload: any, auth?: boolean): Promise<any>;
+export declare function distinctValues(client: SupersoClient, collection: string, field: string, auth?: boolean): Promise<any>;
+export declare function getCollectionStats(client: SupersoClient, collection: string, auth?: boolean): Promise<any>;
+export declare function getDeletedDocuments(client: SupersoClient, collection: string, auth?: boolean): Promise<any>;
+export declare function getFieldVisibility(client: SupersoClient, collection: string, auth?: boolean): Promise<any>;
+export declare function setFieldVisibility(client: SupersoClient, collection: string, rules: any, auth?: boolean): Promise<any>;
+export declare function bulkCreate(client: SupersoClient, collection: string, documents: any[], auth?: boolean): Promise<any>;
+export declare function bulkUpdate(client: SupersoClient, collection: string, updates: any[], auth?: boolean): Promise<any>;
+export declare function bulkDelete(client: SupersoClient, collection: string, ids: string[], auth?: boolean): Promise<any>;
+export declare function transaction(client: SupersoClient, operations: any[], auth?: boolean): Promise<any>;
+export declare class WriteBatch {
+    private operations;
+    create(collection: string, data: any): this;
+    update(collection: string, documentId: string, data: any): this;
+    delete(collection: string, documentId: string): this;
+    commit(client: SupersoClient): Promise<any>;
+}
+export declare function batch(): WriteBatch;

package/dist/database/database.js

@@ -0,0 +1,285 @@
+// ================================
+// TOKEN
+// ================================
+const ACCESS_TOKEN_KEY = "superso_access_token";
+// ================================
+// REQUEST
+// ================================
+async function request(client, endpoint, method = "GET", body = null, auth = false) {
+    const headers = {
+        "Content-Type": "application/json",
+        "X-Superso-Project-Key": client.apiKey,
+    };
+    // auth token
+    const token = localStorage.getItem(ACCESS_TOKEN_KEY);
+    if (auth && token) {
+        headers["Authorization"] =
+            `Bearer ${token}`;
+    }
+    const response = await fetch(`${client.baseUrl}/api/project/${client.projectId}${endpoint}`, {
+        method,
+        headers,
+        body: body
+            ? JSON.stringify(body)
+            : undefined,
+    });
+    let data = {};
+    try {
+        data =
+            await response.json();
+    }
+    catch (_a) {
+        data = {};
+    }
+    if (!response.ok) {
+        throw new Error((data === null || data === void 0 ? void 0 : data.message) ||
+            "Database request failed");
+    }
+    return data;
+}
+// ================================
+// QUERY BUILDER
+// ================================
+function buildQuery(query) {
+    if (!query)
+        return "";
+    const params = new URLSearchParams();
+    if (query.limit !==
+        undefined) {
+        params.append("limit", String(query.limit));
+    }
+    if (query.offset !==
+        undefined) {
+        params.append("offset", String(query.offset));
+    }
+    if (query.sort) {
+        params.append("sort", query.sort);
+    }
+    if (query.order) {
+        params.append("order", query.order);
+    }
+    // filters
+    if (query.filters) {
+        Object.entries(query.filters).forEach(([key, value]) => {
+            params.append(key, String(value));
+        });
+    }
+    const qs = params.toString();
+    return qs
+        ? `?${qs}`
+        : "";
+}
+// ================================
+// CREATE
+// ================================
+export async function createDocument(client, collection, data, auth = false) {
+    return await request(client, `/db/${collection}`, "POST", data, auth);
+}
+// ================================
+// LIST
+// ================================
+export async function getDocuments(client, collection, query, auth = false) {
+    return await request(client, `/db/${collection}${buildQuery(query)}`, "GET", null, auth);
+}
+// ================================
+// GET SINGLE
+// ================================
+export async function getDocument(client, collection, documentId, auth = false) {
+    return await request(client, `/db/${collection}/${documentId}`, "GET", null, auth);
+}
+// ================================
+// UPDATE
+// ================================
+export async function updateDocument(client, collection, documentId, data, auth = false) {
+    return await request(client, `/db/${collection}/${documentId}`, "PATCH", data, auth);
+}
+// ================================
+// REPLACE
+// ================================
+export async function replaceDocument(client, collection, documentId, data, auth = false) {
+    return await request(client, `/db/${collection}/${documentId}`, "PUT", data, auth);
+}
+// ================================
+// DELETE
+// ================================
+export async function deleteDocument(client, collection, documentId, auth = false) {
+    return await request(client, `/db/${collection}/${documentId}`, "DELETE", null, auth);
+}
+// ================================
+// RESTORE
+// ================================
+export async function restoreDocument(client, collection, documentId, auth = false) {
+    return await request(client, `/db/${collection}/${documentId}/restore`, "POST", null, auth);
+}
+// ================================
+// PURGE
+// ================================
+export async function purgeDocument(client, collection, documentId, auth = false) {
+    return await request(client, `/db/${collection}/${documentId}/purge`, "DELETE", null, auth);
+}
+// ================================
+// UPSERT
+// ================================
+export async function upsertDocument(client, collection, documentId, data, auth = false) {
+    return await request(client, `/db/${collection}/upsert/${documentId}`, "PUT", data, auth);
+}
+// ================================
+// EXISTS
+// ================================
+export async function existsDocument(client, collection, documentId, auth = false) {
+    const headers = {
+        "X-Superso-Project-Key": client.apiKey,
+    };
+    const token = localStorage.getItem(ACCESS_TOKEN_KEY);
+    if (auth && token) {
+        headers["Authorization"] =
+            `Bearer ${token}`;
+    }
+    const response = await fetch(`${client.baseUrl}/api/project/${client.projectId}/db/${collection}/${documentId}/exists`, {
+        method: "HEAD",
+        headers,
+    });
+    return response.ok;
+}
+// ================================
+// COUNT
+// ================================
+export async function countDocuments(client, collection, query, auth = false) {
+    return await request(client, `/db/${collection}/count${buildQuery(query)}`, "GET", null, auth);
+}
+// ================================
+// ADVANCED QUERY
+// ================================
+export async function queryDocuments(client, collection, query, auth = false) {
+    return await request(client, `/db/${collection}/query`, "POST", query, auth);
+}
+// ================================
+// SEARCH
+// ================================
+export async function searchDocuments(client, collection, search, auth = false) {
+    return await queryDocuments(client, collection, {
+        search,
+    }, auth);
+}
+// ================================
+// CURSOR PAGINATION
+// ================================
+export async function paginateDocuments(client, collection, query, auth = false) {
+    return await queryDocuments(client, collection, query, auth);
+}
+// ================================
+// INFINITE SCROLL
+// ================================
+export async function infiniteScroll(client, collection, cursor, limit = 20, auth = false) {
+    return await queryDocuments(client, collection, {
+        cursor,
+        limit,
+    }, auth);
+}
+// ================================
+// AGGREGATION
+// ================================
+export async function aggregateDocuments(client, collection, payload, auth = false) {
+    return await request(client, `/db/${collection}/aggregation`, "POST", payload, auth);
+}
+// ================================
+// DISTINCT
+// ================================
+export async function distinctValues(client, collection, field, auth = false) {
+    return await request(client, `/db/${collection}/distinct?field=${field}`, "GET", null, auth);
+}
+// ================================
+// COLLECTION STATS
+// ================================
+export async function getCollectionStats(client, collection, auth = false) {
+    return await request(client, `/db/${collection}/stats`, "GET", null, auth);
+}
+// ================================
+// DELETED DOCUMENTS
+// ================================
+export async function getDeletedDocuments(client, collection, auth = false) {
+    return await request(client, `/db/${collection}/deleted`, "GET", null, auth);
+}
+// ================================
+// FIELD VISIBILITY
+// ================================
+export async function getFieldVisibility(client, collection, auth = false) {
+    return await request(client, `/db/${collection}/field-visibility`, "GET", null, auth);
+}
+export async function setFieldVisibility(client, collection, rules, auth = false) {
+    return await request(client, `/db/${collection}/field-visibility`, "PUT", rules, auth);
+}
+// ================================
+// BULK CREATE
+// ================================
+export async function bulkCreate(client, collection, documents, auth = false) {
+    return await request(client, `/db/${collection}/bulk-insert`, "POST", {
+        documents,
+    }, auth);
+}
+// ================================
+// BULK UPDATE
+// ================================
+export async function bulkUpdate(client, collection, updates, auth = false) {
+    return await request(client, `/db/${collection}/bulk-update`, "PUT", {
+        updates,
+    }, auth);
+}
+// ================================
+// BULK DELETE
+// ================================
+export async function bulkDelete(client, collection, ids, auth = false) {
+    return await request(client, `/db/${collection}/bulk-delete`, "DELETE", {
+        ids,
+    }, auth);
+}
+// ================================
+// TRANSACTIONS
+// ================================
+export async function transaction(client, operations, auth = true) {
+    return await request(client, `/transactions`, "POST", {
+        operations,
+    }, auth);
+}
+// ================================
+// WRITE BATCH
+// ================================
+export class WriteBatch {
+    constructor() {
+        this.operations = [];
+    }
+    create(collection, data) {
+        this.operations.push({
+            type: "create",
+            collection,
+            data,
+        });
+        return this;
+    }
+    update(collection, documentId, data) {
+        this.operations.push({
+            type: "update",
+            collection,
+            documentId,
+            data,
+        });
+        return this;
+    }
+    delete(collection, documentId) {
+        this.operations.push({
+            type: "delete",
+            collection,
+            documentId,
+        });
+        return this;
+    }
+    async commit(client) {
+        return await transaction(client, this.operations, true);
+    }
+}
+// ================================
+// CREATE BATCH
+// ================================
+export function batch() {
+    return new WriteBatch();
+}

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./core/client";
+export * from "./auth/auth";
+export * from "./database/database";
+export * from "./realtime/realtime";
+export * from "./notifications/notifications";
+export * from "./storage/storage";

package/dist/index.js

@@ -0,0 +1,6 @@
+export * from "./core/client.js";
+export * from "./auth/auth.js";
+export * from "./database/database.js";
+export * from "./realtime/realtime.js";
+export * from "./notifications/notifications.js";
+export * from "./storage/storage.js";

package/dist/notifications/notifications.d.ts

@@ -0,0 +1,79 @@
+import { SupersoClient } from "../core/client";
+export type NotificationType = "in_app" | "email" | "push" | "sms";
+export interface SendNotificationData {
+    type?: NotificationType;
+    subject?: string;
+    body?: string;
+    recipient?: string;
+    auth_user_id?: string;
+    user_id?: string;
+    user_ids?: string[];
+    broadcast?: boolean;
+    data?: any;
+    template?: string;
+    template_vars?: any;
+    scheduled_at?: string;
+    image_url?: string;
+    collection?: string;
+    realtime_channel?: string;
+}
+export declare function sendNotification(client: SupersoClient, payload: SendNotificationData): Promise<any>;
+export declare function sendEmail(client: SupersoClient, recipient: string, subject: string, body: string, scheduled_at?: string): Promise<any>;
+export declare function sendSMS(client: SupersoClient, recipient: string, body: string, scheduled_at?: string): Promise<any>;
+export declare function sendPush(client: SupersoClient, user_id: string, subject: string, body: string, options?: {
+    image_url?: string;
+    data?: any;
+    scheduled_at?: string;
+}): Promise<any>;
+export declare function sendInApp(client: SupersoClient, payload: {
+    subject: string;
+    body: string;
+    user_id?: string;
+    user_ids?: string[];
+    broadcast?: boolean;
+    data?: any;
+    image_url?: string;
+    collection: string;
+    realtime_channel: string;
+}): Promise<any>;
+export declare function broadcastNotification(client: SupersoClient, subject: string, body: string, collection: string, realtime_channel: string): Promise<any>;
+export declare function sendTemplateNotification(client: SupersoClient, payload: {
+    type: NotificationType;
+    template: string;
+    recipient?: string;
+    user_id?: string;
+    user_ids?: string[];
+    broadcast?: boolean;
+    template_vars?: any;
+    collection?: string;
+    realtime_channel?: string;
+}): Promise<any>;
+export declare function getNotificationLogs(client: SupersoClient): Promise<any>;
+export declare function getInAppNotifications(client: SupersoClient, collection: string): Promise<any>;
+export declare function getUnreadCount(client: SupersoClient, collection: string): Promise<any>;
+export declare function markNotificationRead(client: SupersoClient, notificationId: string, collection: string, realtime_channel: string): Promise<any>;
+export declare function markAllNotificationsRead(client: SupersoClient, collection: string, realtime_channel: string): Promise<any>;
+export declare function deleteNotification(client: SupersoClient, notificationId: string, collection: string, realtime_channel: string): Promise<any>;
+export interface NotificationPreferences {
+    email_enabled?: boolean;
+    push_enabled?: boolean;
+    sms_enabled?: boolean;
+    in_app_enabled?: boolean;
+    marketing_enabled?: boolean;
+    security_enabled?: boolean;
+}
+export declare function getNotificationPreferences(client: SupersoClient): Promise<any>;
+export declare function updateNotificationPreferences(client: SupersoClient, payload: NotificationPreferences): Promise<any>;
+export interface RegisterDeviceData {
+    platform: "ios" | "android" | "web";
+    token: string;
+    app_version?: string;
+    device_name?: string;
+}
+export declare function registerDevice(client: SupersoClient, payload: RegisterDeviceData): Promise<any>;
+export declare function getDevices(client: SupersoClient): Promise<any>;
+export declare function deleteDevice(client: SupersoClient, tokenId: string): Promise<any>;
+export declare function onNotification(realtime: any, callback: Function): void;
+export declare function onNotificationDelivered(realtime: any, callback: Function): void;
+export declare function onNotificationFailed(realtime: any, callback: Function): void;
+export declare function connectNotificationChannel(client: SupersoClient, channel: string, jwt?: string): WebSocket;

package/dist/notifications/notifications.js

@@ -0,0 +1,202 @@
+// =======================================
+// STORAGE
+// =======================================
+const ACCESS_TOKEN_KEY = "superso_access_token";
+// =======================================
+// REQUEST
+// =======================================
+async function request(client, endpoint, method = "GET", body, auth = false) {
+    const headers = {
+        "Content-Type": "application/json",
+        "X-Superso-Project-Key": client.apiKey,
+    };
+    const token = localStorage.getItem(ACCESS_TOKEN_KEY);
+    if (auth && token) {
+        headers["Authorization"] =
+            `Bearer ${token}`;
+    }
+    const response = await fetch(`${client.baseUrl}/api/project/${client.projectId}${endpoint}`, {
+        method,
+        headers,
+        body: body
+            ? JSON.stringify(body)
+            : undefined,
+    });
+    let data = {};
+    try {
+        data =
+            await response.json();
+    }
+    catch (_a) {
+        data = {};
+    }
+    if (!response.ok) {
+        throw new Error((data === null || data === void 0 ? void 0 : data.message) ||
+            "Notification request failed");
+    }
+    return data;
+}
+// =======================================
+// SEND NOTIFICATION
+// =======================================
+export async function sendNotification(client, payload) {
+    return await request(client, "/notifications/send", "POST", payload);
+}
+// =======================================
+// SEND EMAIL
+// =======================================
+export async function sendEmail(client, recipient, subject, body, scheduled_at) {
+    return await sendNotification(client, {
+        type: "email",
+        recipient,
+        subject,
+        body,
+        scheduled_at,
+    });
+}
+// =======================================
+// SEND SMS
+// =======================================
+export async function sendSMS(client, recipient, body, scheduled_at) {
+    return await sendNotification(client, {
+        type: "sms",
+        recipient,
+        body,
+        scheduled_at,
+    });
+}
+// =======================================
+// SEND PUSH
+// =======================================
+export async function sendPush(client, user_id, subject, body, options) {
+    return await sendNotification(client, {
+        type: "push",
+        user_id,
+        subject,
+        body,
+        image_url: options === null || options === void 0 ? void 0 : options.image_url,
+        data: options === null || options === void 0 ? void 0 : options.data,
+        scheduled_at: options === null || options === void 0 ? void 0 : options.scheduled_at,
+    });
+}
+// =======================================
+// SEND IN APP
+// =======================================
+export async function sendInApp(client, payload) {
+    return await sendNotification(client, Object.assign({ type: "in_app" }, payload));
+}
+// =======================================
+// BROADCAST
+// =======================================
+export async function broadcastNotification(client, subject, body, collection, realtime_channel) {
+    return await sendNotification(client, {
+        type: "in_app",
+        subject,
+        body,
+        broadcast: true,
+        collection,
+        realtime_channel,
+    });
+}
+// =======================================
+// TEMPLATE NOTIFICATION
+// =======================================
+export async function sendTemplateNotification(client, payload) {
+    return await sendNotification(client, payload);
+}
+// =======================================
+// LOGS
+// =======================================
+export async function getNotificationLogs(client) {
+    return await request(client, "/notifications/logs", "GET");
+}
+// =======================================
+// IN APP NOTIFICATIONS
+// =======================================
+export async function getInAppNotifications(client, collection) {
+    return await request(client, `/notifications/in-app?collection=${collection}`, "GET");
+}
+// =======================================
+// UNREAD COUNT
+// =======================================
+export async function getUnreadCount(client, collection) {
+    return await request(client, `/notifications/in-app/unread-count?collection=${collection}`, "GET");
+}
+// =======================================
+// MARK AS READ
+// =======================================
+export async function markNotificationRead(client, notificationId, collection, realtime_channel) {
+    return await request(client, `/notifications/in-app/${notificationId}/read?collection=${collection}&realtime_channel=${realtime_channel}`, "POST");
+}
+// =======================================
+// MARK ALL READ
+// =======================================
+export async function markAllNotificationsRead(client, collection, realtime_channel) {
+    return await request(client, `/notifications/in-app/read-all?collection=${collection}&realtime_channel=${realtime_channel}`, "POST");
+}
+// =======================================
+// DELETE NOTIFICATION
+// =======================================
+export async function deleteNotification(client, notificationId, collection, realtime_channel) {
+    return await request(client, `/notifications/in-app/${notificationId}?collection=${collection}&realtime_channel=${realtime_channel}`, "DELETE");
+}
+// =======================================
+// GET PREFERENCES
+// =======================================
+export async function getNotificationPreferences(client) {
+    return await request(client, "/notifications/preferences", "GET", null, true);
+}
+// =======================================
+// UPDATE PREFERENCES
+// =======================================
+export async function updateNotificationPreferences(client, payload) {
+    return await request(client, "/notifications/preferences", "PUT", payload, true);
+}
+// =======================================
+// REGISTER DEVICE
+// =======================================
+export async function registerDevice(client, payload) {
+    return await request(client, "/notifications/devices", "POST", payload, true);
+}
+// =======================================
+// GET DEVICES
+// =======================================
+export async function getDevices(client) {
+    return await request(client, "/notifications/devices", "GET", null, true);
+}
+// =======================================
+// DELETE DEVICE
+// =======================================
+export async function deleteDevice(client, tokenId) {
+    return await request(client, `/notifications/devices/${tokenId}`, "DELETE", null, true);
+}
+// =======================================
+// REALTIME EVENTS
+// =======================================
+export function onNotification(realtime, callback) {
+    realtime.on("notification.received", callback);
+    realtime.on("notification", callback);
+}
+// =======================================
+// DELIVERED
+// =======================================
+export function onNotificationDelivered(realtime, callback) {
+    realtime.on("notification.delivered", callback);
+}
+// =======================================
+// FAILED
+// =======================================
+export function onNotificationFailed(realtime, callback) {
+    realtime.on("notification.failed", callback);
+}
+// =======================================
+// WEBSOCKET HELPER
+// =======================================
+export function connectNotificationChannel(client, channel, jwt) {
+    const protocol = client.baseUrl.startsWith("https")
+        ? "wss"
+        : "ws";
+    const base = client.baseUrl.replace(/^https?/, protocol);
+    const url = `${base}/ws/project/${client.projectId}/channel/${channel}?key=${client.apiKey}${jwt ? `&token=${jwt}` : ""}`;
+    return new WebSocket(url);
+}