@amityco/ts-sdk 0.0.1-beta.2 → 0.0.1-c58e50d.0

package/community/events/onCommunityUpdated.d.ts

@@ -1,17 +0,0 @@
-/**
- * ```js
- * import { onCommunityUpdated } from '@amityco/ts-sdk'
- * const dispose = onCommunityUpdated(channel => {
- *   // ...
- * })
- * ```
- *
- * Fired when any {@link Amity.Community} have been updated
- *
- * @param callback The function to call when the event was fired
- * @returns an {@link Amity.Unsubscriber} function to stop listening
- *
- * @category Community Events
- */
-export declare const onCommunityUpdated: (callback: Amity.Listener<Amity.Community>) => Amity.Unsubscriber;
-//# sourceMappingURL=onCommunityUpdated.d.ts.map

package/community/events/onCommunityUpdated.js

@@ -1,28 +0,0 @@
-import { getActiveClient } from '../../client/api';
-import { createEventSubscriber } from '../../core/events';
-import { decoratePayload } from '../../core/query';
-import { ingestInCache } from '../../core/cache';
-/**
- * ```js
- * import { onCommunityUpdated } from '@amityco/ts-sdk'
- * const dispose = onCommunityUpdated(channel => {
- *   // ...
- * })
- * ```
- *
- * Fired when any {@link Amity.Community} have been updated
- *
- * @param callback The function to call when the event was fired
- * @returns an {@link Amity.Unsubscriber} function to stop listening
- *
- * @category Community Events
- */
-export const onCommunityUpdated = (callback) => {
-    const client = getActiveClient();
-    const filter = (payload) => {
-        decoratePayload(payload);
-        ingestInCache(payload);
-        callback(payload.communities[0]);
-    };
-    return createEventSubscriber(client, 'onCommunityUpdated', 'v3.community.didUpdate', filter);
-};

package/community/observers/index.d.ts

@@ -1,2 +0,0 @@
-export * from './observeCommunity';
-//# sourceMappingURL=index.d.ts.map

package/community/observers/index.js

@@ -1 +0,0 @@
-export * from './observeCommunity';

package/community/observers/observeCommunity.d.ts

@@ -1,20 +0,0 @@
-/**
- * ```js
- * import { observeCommunity } from '@amityco/ts-sdk'
- *
- * let community = {}
- * const dispose = observeCommunity(communityId, updated => community = updated)
- * ```
- *
- * Observe all mutation on a given {@link Amity.Community}
- *
- * @param communityId the ID of the community to observe
- * @param callback the function to call when new data are available
- * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the community
- *
- * @category Community Observer
- */
-export declare const observeCommunity: <Events extends ["onFetch", "onUpdate", "onDelete", "onJoin", "onLeft"]>(communityId: string, callback: Amity.ObjectListener<{
-    data?: Amity.Community | undefined;
-} & Amity.QueryMetadata, Events>) => Amity.Unsubscriber;
-//# sourceMappingURL=observeCommunity.d.ts.map

package/community/observers/observeCommunity.js

@@ -1,44 +0,0 @@
-import { createQuery, runQuery } from '../../core/query/query';
-import { getActiveClient } from '../../client/api';
-import { getCommunity } from '../api';
-import { onCommunityUpdated, onCommunityDeleted, onCommunityJoined, onCommunityLeft, } from '../events';
-/**
- * ```js
- * import { observeCommunity } from '@amityco/ts-sdk'
- *
- * let community = {}
- * const dispose = observeCommunity(communityId, updated => community = updated)
- * ```
- *
- * Observe all mutation on a given {@link Amity.Community}
- *
- * @param communityId the ID of the community to observe
- * @param callback the function to call when new data are available
- * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the community
- *
- * @category Community Observer
- */
-export const observeCommunity = (communityId, callback) => {
-    const { log } = getActiveClient();
-    const timestamp = Date.now();
-    log(`observeCommunity(tmpid: ${timestamp}) > listen`);
-    // wrapper function to make sure
-    const router = (result, action) => {
-        var _a, _b, _c;
-        // filter function
-        if (((_a = result.data) === null || _a === void 0 ? void 0 : _a.communityId) !== communityId)
-            return;
-        if (callback instanceof Function)
-            return callback(result);
-        if (action !== 'onFetch')
-            (_b = callback.onEvent) === null || _b === void 0 ? void 0 : _b.call(callback, action, result);
-        (_c = callback[action]) === null || _c === void 0 ? void 0 : _c.call(callback, result);
-    };
-    const disposers = [];
-    disposers.push(onCommunityUpdated(data => router({ data }, 'onUpdate')), onCommunityDeleted(data => router({ data }, 'onDelete')), onCommunityJoined(data => router({ data }, 'onJoin')), onCommunityLeft(data => router({ data }, 'onLeft')));
-    runQuery(createQuery(getCommunity, communityId), result => result.data && router(result, 'onFetch'));
-    return () => {
-        log(`observeCommunity(tmpid: ${timestamp}) > dispose`);
-        disposers.forEach(fn => fn());
-    };
-};

package/core/cache/drop.d.ts

@@ -1,11 +0,0 @@
-/**
- * Pull objects from the cache layer
- *
- * @param name The name of the store to query
- * @param keys A collection of unique keys for the store
- * @returns The collection of objects matching the keys. Keys which don't match object will be omitted
- *
- * @category Cache
- */
-export declare const dropFromCache: <T extends keyof Amity.Model>(name: T, partial: Amity.Minimal[T] & Partial<Amity.Model[T]>) => never[] | undefined;
-//# sourceMappingURL=drop.d.ts.map

package/core/cache/drop.js

@@ -1,21 +0,0 @@
-import { getActiveClient } from '../../client/api';
-import { getResolver } from '../model/idResolvers';
-/**
- * Pull objects from the cache layer
- *
- * @param name The name of the store to query
- * @param keys A collection of unique keys for the store
- * @returns The collection of objects matching the keys. Keys which don't match object will be omitted
- *
- * @category Cache
- */
-export const dropFromCache = (name, partial) => {
-    const { cache } = getActiveClient();
-    const store = cache === null || cache === void 0 ? void 0 : cache[name];
-    if (!cache || !store)
-        return [];
-    const modelId = getResolver(name)(partial);
-    const localId = cache.lookup[`${name}#${modelId}`];
-    delete cache.lookup[`${name}#${modelId}`];
-    store.erase(localId);
-};

package/core/cache/index.d.ts

@@ -1,19 +0,0 @@
-export * from './pull';
-export * from './push';
-export * from './drop';
-export * from './sync';
-export * from './ingest';
-export * from './mutate';
-export * from './merge';
-/**
- * Creates a cache instance. The cache instance will handle stores
- * given to it as input, and will be used as the first source of cached data
- * in the SDK.
- *
- * @param stores A partial collection of stores
- * @returns A cache instance
- *
- * @category Cache
- */
-export declare const createCache: (stores: Partial<Amity.StoreCollection<Amity.Domain[]>>) => Amity.Cache;
-//# sourceMappingURL=index.d.ts.map

package/core/cache/index.js

@@ -1,21 +0,0 @@
-export * from './pull';
-export * from './push';
-export * from './drop';
-export * from './sync';
-export * from './ingest';
-export * from './mutate';
-export * from './merge';
-/**
- * Creates a cache instance. The cache instance will handle stores
- * given to it as input, and will be used as the first source of cached data
- * in the SDK.
- *
- * @param stores A partial collection of stores
- * @returns A cache instance
- *
- * @category Cache
- */
-export const createCache = (stores) => {
-    const lookup = {};
-    return Object.assign({ lookup }, stores);
-};

package/core/cache/ingest.d.ts

@@ -1,10 +0,0 @@
-/**
- * Ingest a payload (v3) into the cache
- *
- * @param payload a "backend v3" payload object
- * @param order the order of the keys to process (in case of need)
- *
- * @category Cache
- */
-export declare const ingestInCache: (payload?: Record<string, any[]>, order?: string[]) => void;
-//# sourceMappingURL=ingest.d.ts.map

package/core/cache/ingest.js

@@ -1,19 +0,0 @@
-import { pushToCache } from './push';
-import { storeInterests } from '../model/idResolvers';
-/**
- * Ingest a payload (v3) into the cache
- *
- * @param payload a "backend v3" payload object
- * @param order the order of the keys to process (in case of need)
- *
- * @category Cache
- */
-export const ingestInCache = (payload = {}, order = Object.keys(payload)) => {
-    order
-        .forEach(key => {
-        const name = storeInterests[key];
-        if (!name)
-            return;
-        pushToCache(name, ...payload[key]);
-    });
-};

package/core/cache/merge.d.ts

@@ -1,10 +0,0 @@
-/**
- * Apply partial mutation to objects in the cache
- *
- * @param name The name of the store to query
- * @param mutation A partial view of the object to update
- *
- * @category Cache
- */
-export declare const mergeInCache: <T extends keyof Amity.Model>(name: T, mutation: Amity.Minimal[T] & Partial<Amity.Model[T]>) => void;
-//# sourceMappingURL=merge.d.ts.map

package/core/cache/merge.js

@@ -1,14 +0,0 @@
-import { getResolver } from '../model/idResolvers';
-import { mutateCache } from './mutate';
-/**
- * Apply partial mutation to objects in the cache
- *
- * @param name The name of the store to query
- * @param mutation A partial view of the object to update
- *
- * @category Cache
- */
-export const mergeInCache = (name, mutation) => {
-    const key = getResolver(name)(mutation);
-    mutateCache(name, key, model => (Object.assign(Object.assign({}, model), mutation)));
-};

package/core/cache/mutate.d.ts

@@ -1,10 +0,0 @@
-/**
- * Apply partial mutation to objects in the cache
- *
- * @param name The name of the store to query
- * @param mutation A partial view of the object to update
- *
- * @category Cache
- */
-export declare const mutateCache: <T extends keyof Amity.Model>(name: T, key: string, mutator: (model: Amity.Model[T]) => Amity.Model[T] | undefined) => Amity.Model[T] | undefined;
-//# sourceMappingURL=mutate.d.ts.map

package/core/cache/mutate.js

@@ -1,19 +0,0 @@
-import { pullFromCache } from './pull';
-import { pushToCache } from './push';
-/**
- * Apply partial mutation to objects in the cache
- *
- * @param name The name of the store to query
- * @param mutation A partial view of the object to update
- *
- * @category Cache
- */
-export const mutateCache = (name, key, mutator) => {
-    var _a;
-    const [model] = (_a = pullFromCache(name, key)) !== null && _a !== void 0 ? _a : [];
-    if (!model)
-        return;
-    const mutation = mutator(model);
-    mutation && pushToCache(name, Object.assign(Object.assign({}, model), mutation));
-    return mutation;
-};

package/core/cache/pull.d.ts

@@ -1,11 +0,0 @@
-/**
- * Pull objects from the cache layer
- *
- * @param name The name of the store to query
- * @param keys A collection of unique keys for the store
- * @returns The collection of objects matching the keys. Keys which don't match object will be omitted
- *
- * @category Cache
- */
-export declare const pullFromCache: <K extends keyof Amity.Model>(name: K, ...keys: string[]) => Amity.Model[K][] | undefined;
-//# sourceMappingURL=pull.d.ts.map

package/core/cache/pull.js

@@ -1,28 +0,0 @@
-import { getActiveClient } from '../../client/api';
-/**
- * Pull objects from the cache layer
- *
- * @param name The name of the store to query
- * @param keys A collection of unique keys for the store
- * @returns The collection of objects matching the keys. Keys which don't match object will be omitted
- *
- * @category Cache
- */
-export const pullFromCache = (name, ...keys) => {
-    var _a;
-    const { cache } = getActiveClient();
-    const store = cache === null || cache === void 0 ? void 0 : cache[name];
-    if (!cache || !store)
-        return;
-    const state = (_a = store.read()) !== null && _a !== void 0 ? _a : {};
-    // return all
-    if (!(keys === null || keys === void 0 ? void 0 : keys.length))
-        return Object.values(state);
-    // return some
-    return keys
-        .map(key => {
-        const localId = cache.lookup[`${name}#${key}`];
-        return state[localId];
-    })
-        .filter(Boolean);
-};

package/core/cache/push.d.ts

@@ -1,10 +0,0 @@
-/**
- * Pull objects from the cache layer
- *
- * @param name The name of the store to query
- * @param models A collection of models t store
- *
- * @category Cache
- */
-export declare const pushToCache: <T extends keyof Amity.Model>(name: T, ...models: Amity.Model[T][]) => void;
-//# sourceMappingURL=push.d.ts.map

package/core/cache/push.js

@@ -1,30 +0,0 @@
-import { getActiveClient } from '../../client/api';
-import { getResolver } from '../model/idResolvers';
-/**
- * Pull objects from the cache layer
- *
- * @param name The name of the store to query
- * @param models A collection of models t store
- *
- * @category Cache
- */
-export const pushToCache = (name, ...models) => {
-    const { cache } = getActiveClient();
-    const store = cache === null || cache === void 0 ? void 0 : cache[name];
-    if (!cache || !store)
-        return;
-    const filtered = models.filter(Boolean);
-    if (!filtered.length)
-        return;
-    const synced = Object.fromEntries(filtered.map(model => {
-        var _a;
-        var _b, _c;
-        const modelId = getResolver(name)(model);
-        const localId = ((_a = (_b = cache.lookup)[_c = `${name}#${modelId}`]) !== null && _a !== void 0 ? _a : (_b[_c] = model.localId));
-        // WARNING: shallow immutable
-        return [localId, Object.assign(Object.assign({ 
-                // @ts-ignore: syncedAt is before "...model" so it can be manually overridden
-                syncedAt: Date.now() }, model), { localId })];
-    }));
-    store.write(synced);
-};

package/core/cache/sync.d.ts

@@ -1,10 +0,0 @@
-/**
- * Sync-up local ids of objects in the cache
- *
- * @param original The object holding the localId to keep
- * @param replacement The object holding the localId to discard
- *
- * @category Cache
- */
-export declare const syncInCache: <T extends keyof Amity.Model>(original: Amity.Model[T], replacement: Amity.Model[T]) => void;
-//# sourceMappingURL=sync.d.ts.map

package/core/cache/sync.js

@@ -1,31 +0,0 @@
-import { getActiveClient } from '../../client/api';
-import { identifyModel } from '../model/identifyModel';
-import { dropFromCache } from './drop';
-import { pushToCache } from './push';
-/**
- * Sync-up local ids of objects in the cache
- *
- * @param original The object holding the localId to keep
- * @param replacement The object holding the localId to discard
- *
- * @category Cache
- */
-export const syncInCache = (original, replacement) => {
-    var _a;
-    const { cache, log } = getActiveClient();
-    const name = (_a = identifyModel(original)) !== null && _a !== void 0 ? _a : identifyModel(replacement);
-    if (!name) {
-        log('syncInCache', 'could not identify the models', { original, replacement });
-        return;
-    }
-    const store = cache === null || cache === void 0 ? void 0 : cache[name];
-    if (!cache || !store)
-        return;
-    // remove the object from cache (it's cleaner this way)
-    dropFromCache(name, original);
-    dropFromCache(name, replacement);
-    // glue the localIds together
-    replacement.localId = original.localId;
-    // put back the replacement after (again, it's cleaner this way)
-    pushToCache(name, replacement);
-};

package/core/debug.d.ts

@@ -1,15 +0,0 @@
-import debug from 'debug';
-/**
- * Creates a pre-configured logger instance
- *
- * @param session The name of the debug session
- * @returns A pre-configured logger function
- *
- * @category Debug
- * @hidden
- */
-export declare const createLogger: (session?: string | undefined) => {
-    (topic: string, ...args: any[]): void;
-    __instance__: debug.Debugger;
-};
-//# sourceMappingURL=debug.d.ts.map

package/core/debug.js

@@ -1,20 +0,0 @@
-import debug from 'debug';
-/**
- * Creates a pre-configured logger instance
- *
- * @param session The name of the debug session
- * @returns A pre-configured logger function
- *
- * @category Debug
- * @hidden
- */
-export const createLogger = (session) => {
-    const active = (`${session === null || session === void 0 ? void 0 : session.trim()}`.length > 0
-        && process.env.NODE_ENV !== 'production');
-    const logger = debug(session);
-    const print = (topic, ...args) => {
-        active && logger(topic, args);
-    };
-    print.__instance__ = logger;
-    return print;
-};

package/core/device.d.ts

@@ -1,7 +0,0 @@
-/** @hidden */
-export declare const getDeviceId: () => string;
-/** @hidden */
-export declare const getDeviceModel: () => string;
-/** @hidden */
-export declare const getDeviceInfo: () => Amity.Device['deviceInfo'];
-//# sourceMappingURL=device.d.ts.map

package/core/device.js

@@ -1,32 +0,0 @@
-// TODO: find a way to uniquely identify the device
-// import { getStorage } from './storage'
-/** @hidden */
-const VERSION = '11.0.0';
-/** @hidden */
-export const getDeviceId = () => {
-    // here maybe put some auto detection of the device id based on if it's react or not?
-    // anyhow we let consumer branch out if they want, but it doesn't mean we shouldn't try to be nice
-    // and do things automatically
-    // https://www.npmjs.com/package/react-native-device-info#getuniqueid
-    // how to make sure that the react native package will not be included when build is for web
-    return `ascWebSdk#${Math.random().toString(16)}`;
-};
-/** @hidden */
-export const getDeviceModel = () => {
-    var _a, _b;
-    if ((_a = process === null || process === void 0 ? void 0 : process.versions) === null || _a === void 0 ? void 0 : _a.node)
-        return process.versions.node;
-    if (navigator)
-        return `${navigator.product.toLowerCase()}#${(_b = navigator.userAgent) !== null && _b !== void 0 ? _b : 'unknown_agent'}`;
-    return 'unknown_model';
-};
-/** @hidden */
-export const getDeviceInfo = () => {
-    const model = getDeviceModel();
-    return {
-        version: VERSION,
-        // TODO: replace with: kind: process.versions ? 'node' : 'web', when backend has fixed this
-        kind: 'web',
-        model,
-    };
-};

package/core/errors.d.ts

@@ -1,59 +0,0 @@
-/**
- * Generic ASC error
- * @category Errors
- */
-export declare class ASCError extends Error {
-    readonly code: Amity.ClientError;
-    readonly level: Amity.ErrorLevel;
-    readonly type: string;
-    readonly timestamp: number;
-    /**
-     * @param message A custom error message
-     * @param code A normalized error code
-     * @param level A normalized failure level descriptor
-     */
-    constructor(message: string, code: Amity.ClientError, level: Amity.ErrorLevel);
-}
-/**
- * API level error
- * @category Errors
- */
-export declare class ASCApiError extends ASCError {
-    /**
-     * @param code A normalized error code
-     * @param level A normalized failure level descriptor
-     */
-    constructor(message: string, code: Amity.ClientError, level: Amity.ErrorLevel);
-}
-/**
- * Unexpected error
- * @category Errors
- */
-export declare class ASCUnknownError extends ASCError {
-    /**
-     * @param code A normalized error code
-     * @param level A normalized failure level descriptor
-     */
-    constructor(code?: Amity.ClientError, level?: Amity.ErrorLevel);
-}
-/**
- * Network related error
- * @category Errors
- */
-export declare class ASCConnectionError extends ASCError {
-    /**
-     * @param message A custom error message
-     */
-    constructor(message?: string);
-}
-/**
- * Input sanitization related error
- * @category Errors
- */
-export declare class ASCInvalidParameterError extends ASCError {
-    /**
-     * @param message A custom error message
-     */
-    constructor(message: string);
-}
-//# sourceMappingURL=errors.d.ts.map

package/core/errors.js

@@ -1,70 +0,0 @@
-/**
- * Generic ASC error
- * @category Errors
- */
-export class ASCError extends Error {
-    /**
-     * @param message A custom error message
-     * @param code A normalized error code
-     * @param level A normalized failure level descriptor
-     */
-    constructor(message, code, level) {
-        super(`Amity SDK (${code}): ${message}`);
-        this.code = code;
-        this.level = level;
-        this.type = 'ASC';
-        this.timestamp = Date.now();
-        if (Error.captureStackTrace)
-            Error.captureStackTrace(this, ASCError);
-    }
-}
-/**
- * API level error
- * @category Errors
- */
-export class ASCApiError extends ASCError {
-    /**
-     * @param code A normalized error code
-     * @param level A normalized failure level descriptor
-     */
-    constructor(message, code, level) {
-        super(message, code, level);
-    }
-}
-/**
- * Unexpected error
- * @category Errors
- */
-export class ASCUnknownError extends ASCError {
-    /**
-     * @param code A normalized error code
-     * @param level A normalized failure level descriptor
-     */
-    constructor(code = 800000 /* UNKNOWN_ERROR */, level = "fatal" /* FATAL */) {
-        super('Unexpected error', code, level);
-    }
-}
-/**
- * Network related error
- * @category Errors
- */
-export class ASCConnectionError extends ASCError {
-    /**
-     * @param message A custom error message
-     */
-    constructor(message = 'SDK client is having connection issues') {
-        super(message, 800210 /* CONNECTION_ERROR */, "error" /* ERROR */);
-    }
-}
-/**
- * Input sanitization related error
- * @category Errors
- */
-export class ASCInvalidParameterError extends ASCError {
-    /**
-     * @param message A custom error message
-     */
-    constructor(message) {
-        super(message, 800110 /* INVALID_PARAMETERS */, "error" /* ERROR */);
-    }
-}

package/core/events.d.ts

@@ -1,33 +0,0 @@
-/** @hidden */
-export declare const createEventEmitter: () => import("mitt").Emitter<Amity.Events>;
-/**
- * Wraps the websocket events into the client's event emitter for
- * abstraction of transport.
- *
- * @param ws A websocket connection to listen from
- * @param emitter An event emitter to wire the events to
- *
- * @category Transport
- * @hidden
- */
-export declare const proxyWebsocketEvents: (ws: Amity.Client['ws'], emitter: Amity.Client['emitter']) => void;
-/**
- * Standardize the subscription of SSE through web sockets
- *
- * @param client The current client for which to subscribe the event to
- * @param namespace A unique name for the logger
- * @param event The websocket event name
- * @param fn A wrapper for the callback.
- * @returns A dispose function to unsubscribe to the event
- *
- * @category Transport
- * @hidden
- */
-export declare const createEventSubscriber: <T extends keyof Amity.Events>(client: Amity.Client, namespace: string, event: T, fn: Amity.Listener<Amity.Events[T]>) => Amity.Unsubscriber;
-/**
- * Wrapper around dispatch event
- *
- * @hidden
- */
-export declare const fireEvent: <T extends keyof Amity.Events>(event: T, payload: Amity.Events[T]) => void;
-//# sourceMappingURL=events.d.ts.map