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

package/core/query/query.js

@@ -1,221 +0,0 @@
-import { syncInCache } from '../cache';
-import { isPaged } from './paging';
-/**
- * Type guard to check and cast that a given async function is has the ".locally" property
- *
- * @param func any SDK APi function
- * @returns success boolean if the function has a 'locally' twin
- *
- * @hidden
- */
-export const isFetcher = (func) => ('locally' in func);
-/**
- * Type guard to check and cast that a given async function is has the ".optimistically" property
- *
- * @param func any SDK APi function
- * @returns success boolean if the function has an 'optimistically' twin
- *
- * @hidden
- */
-export const isMutator = (func) => ('optimistically' in func);
-/**
- * Type guard to check and cast that a given async function is has
- * the ".locally" or ".optimistically" property
- *
- * @param func any SDK APi function
- * @returns success boolean if the function has an offline twin
- *
- * @hidden
- */
-export const isOffline = (func) => isFetcher(func) || isMutator(func);
-/**
- * Type guard to check and cast that a given object has the "syncedAt" property
- *
- * @param model any object to check on
- * @returns success boolean if the object has property "syncedAt"
- *
- * @hidden
- */
-export const isSyncable = (model) => (model === null || model === void 0 ? void 0 : model.hasOwnProperty('syncedAt'));
-/**
- * Checks if a model is considered local (syncedAt === -1)
- *
- * @param model any syncable object to check
- * @returns success boolean if the object is marked as local
- *
- * @hidden
- */
-export const isLocal = (model) => {
-    return isSyncable(model) && (model === null || model === void 0 ? void 0 : model.syncedAt) === -1;
-};
-/**
- * Checks if a model is considered fresh
- *
- * @param model any syncable object to check
- * @param lifeSpan the supposedly duration for which the object is considered synced
- * @returns success boolean if the object is below the given lifespan
- *
- * @hidden
- */
-export const isFresh = (model, lifeSpan = 0) => {
-    var _a;
-    return Date.now() - ((_a = model === null || model === void 0 ? void 0 : model.syncedAt) !== null && _a !== void 0 ? _a : 0) <= lifeSpan;
-};
-/**
- * Checks if a model is considered synced
- *
- * @param model any syncable object to check
- * @param lifeSpan the supposedly duration for which the object is considered synced
- * @returns success boolean if the object is local or below the given lifespan
- *
- * @hidden
- */
-export const isSynced = (model, lifeSpan = 0) => {
-    return isLocal(model) || isFresh(model, lifeSpan);
-};
-/**
- * ```js
- * import { createQuery, getUser } from '@amityco/ts-sdk'
- * const query = createQuery(getUser, 'foobar')
- * ```
- *
- * Creates a wrapper for the API call you wish to call.
- * This wrapper is necessary to create for optimistically calls
- *
- *
- * @param fn A compatible API function from the ts sdk
- * @param args The arguments to pass to the function passed as `fn`
- * @returns A wrapper containing both the function and its future arguments
- *
- * @category Query
- */
-export const createQuery = (func, ...args) => ({ func, args });
-/**
- * ```js
- * import { queryOptions } from '@amityco/ts-sdk'
- * const options = queryOptions('no_fetch', lifeSpan)
- * ```
- *
- * Creates a query options object based on the query policy passed
- *
- * @param policy The policy to apply to a query
- * @returns A properly set query options object
- *
- * @category Query
- */
-export const queryOptions = (policy, lifeSpan = 2 * 60 * 1000) => {
-    if (policy === 'cache_only')
-        return { lifeSpan: Infinity };
-    else if (policy === 'server_only')
-        return { lifeSpan: 0 };
-    return { lifeSpan };
-};
-/**
- * Checks if an unknown shaped payload is considered empty or not.
- * Since the payload can be wrapped around [] or {} (query or get many),
- * we need a smarter definition of what's considered "empty".
- *
- * @param local the unknown object to check for emptiness
- * @returns true if the mixed-shape "local" content is considered empty
- *
- * @hidden
- */
-const isEmpty = (local) => {
-    // if it's supposed to be a single object, it'd be undefined
-    if (!local)
-        return true;
-    // it's a paged query, the 1st cell of the array would be empty
-    else if (isPaged(local) && isEmpty(local.data)) {
-        return true;
-    }
-    // if it's a item collection, it'd have no keys
-    else if (!Object.keys(local).length)
-        return true;
-    return false;
-};
-/**
- * Checks if an unknown shaped payload is considered synced or not.
- * The object will first be identified by 3 types of shapes:
- *
- * 1. Amity.Paged<Amity.Syncable>
- * 2. Amity.Syncable
- * 3. Record<string, Amity.Syncable>
- *
- * then the "Syncable" component will be extracted and evaluated against
- * the query options' lifeSpan value.
- *
- * @param local the unknown object to check for freshness
- * @param options query options (for lifeSpan checking)
- * @returns true if the mixed-shape "local" content is considered fresh
- *
- * @hidden
- */
-const shouldAbort = (local, options) => {
-    // it's a paged query
-    if (isPaged(local) && shouldAbort(local.data, options)) {
-        return true;
-    }
-    // if it's object let's try to see if it's Amity.Syncable first
-    else if (isSynced(local, options.lifeSpan)) {
-        return true;
-    }
-    // otherwise consider as Record<string, Amity.Syncable>
-    else if (Object.values(local).length > 0 &&
-        Object.values(local).every(item => isSynced(item, options.lifeSpan))) {
-        return true;
-    }
-    return false;
-};
-/**
- * ```js
- * import { createQuery, getUser, runQuery } from '@amityco/ts-sdk'
- * const query = createQuery(getUser, client, 'foobar')
- * runQuery(query,  user => console.log(user))
- * ```
- *
- * Calls an API function wrapped around a Amity.Query, and executes the callback whenever
- * a value is available. The value can be picked either from the local cache and/or
- * from the server afterwards depending on the query options passed
- *
- * @param query A query object wrapping the call to be made
- * @param callback A function to execute when a value is available
- * @param options the query options
- *
- * @category Query
- */
-export const runQuery = ({ func, args }, callback, options = queryOptions('cache_then_server')) => {
-    if (!isOffline(func) || options.lifeSpan === 0) {
-        callback === null || callback === void 0 ? void 0 : callback(wrap(undefined, { loading: true }));
-        func(...args)
-            .then(fresh => callback === null || callback === void 0 ? void 0 : callback(wrap(fresh)))
-            .catch(error => callback === null || callback === void 0 ? void 0 : callback(wrap(undefined, { error })));
-        return;
-    }
-    const local = isMutator(func)
-        ? func.optimistically(...args)
-        : func.locally(...args);
-    !isEmpty(local) && (callback === null || callback === void 0 ? void 0 : callback(wrap(local)));
-    if (local && isFetcher(func) && shouldAbort(local, options))
-        return;
-    callback === null || callback === void 0 ? void 0 : callback(wrap(local, { loading: true }));
-    func(...args)
-        .then(fresh => {
-        // @ts-ignore i know.
-        isLocal(local) && syncInCache(local, fresh);
-        callback === null || callback === void 0 ? void 0 : callback(wrap(fresh));
-    })
-        .catch(error => {
-        callback === null || callback === void 0 ? void 0 : callback(wrap(local, { error }));
-    });
-};
-/**
- *
- * @param data
- * @param meta
- * @returns
- */
-const wrap = (data, meta = {}) => {
-    if (isPaged(data))
-        return Object.assign(Object.assign({}, data), meta);
-    return Object.assign({ data }, meta);
-};

package/core/query/sorting.d.ts

@@ -1,33 +0,0 @@
-declare type SortingFunc<T = Object> = (a: T, b: T) => number;
-/**
- * Alphabetic sorting of objects having a displayName
- */
-export declare const sortByDisplayName: SortingFunc<{
-    displayName: string;
-}>;
-/**
- * Sorting a collection by their apparition order (oldest first)
- */
-export declare const sortByChannelSegment: SortingFunc<{
-    channelSegment: number;
-}>;
-/**
- * Sorting a collection by its oldest items
- */
-export declare const sortByFirstCreated: SortingFunc<{
-    createdAt: Date | number | string;
-}>;
-/**
- * Sorting a collection by its newest items
- */
-export declare const sortByLastCreated: SortingFunc<{
-    createdAt: Date | number | string;
-}>;
-/**
- * Sorting a collection by the items with most recent activity
- */
-export declare const sortByLastActivity: SortingFunc<{
-    lastActivity: Date | number | string;
-}>;
-export {};
-//# sourceMappingURL=sorting.d.ts.map

package/core/query/sorting.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"sorting.d.ts","sourceRoot":"","sources":["../../../src/core/query/sorting.ts"],"names":[],"mappings":"AAIA,aAAK,WAAW,CAAC,CAAC,GAAG,MAAM,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,MAAM,CAAA;AAErD;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,WAAW,CAAC;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,CAKlE,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,oBAAoB,EAAE,WAAW,CAAC;IAAE,cAAc,EAAE,MAAM,CAAA;CAAE,CAE/D,CAAA;AAEV;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAAE,WAAW,CAAC;IAAE,SAAS,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,CAAA;CAAE,CAEhC,CAAA;AAElD;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,WAAW,CAAC;IAAE,SAAS,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,CAAA;CAAE,CAE/B,CAAA;AAElD;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAAE,WAAW,CAAC;IAAE,YAAY,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,CAAA;CAAE,CAEnC,CAAA"}

package/core/query/sorting.js

@@ -1,27 +0,0 @@
-// Note:
-// this file should contain a suite of sorting utilities to help the
-// local version of the query functions.
-/**
- * Alphabetic sorting of objects having a displayName
- */
-export const sortByDisplayName = ({ displayName: a }, { displayName: b }) => {
-    if (a === b)
-        return 0;
-    return a < b ? -1 : 1;
-};
-/**
- * Sorting a collection by their apparition order (oldest first)
- */
-export const sortByChannelSegment = ({ channelSegment: a }, { channelSegment: b }) => a - b;
-/**
- * Sorting a collection by its oldest items
- */
-export const sortByFirstCreated = ({ createdAt: a }, { createdAt: b }) => new Date(a).valueOf() - new Date(b).valueOf();
-/**
- * Sorting a collection by its newest items
- */
-export const sortByLastCreated = ({ createdAt: a }, { createdAt: b }) => new Date(b).valueOf() - new Date(a).valueOf();
-/**
- * Sorting a collection by the items with most recent activity
- */
-export const sortByLastActivity = ({ lastActivity: a }, { lastActivity: b }) => new Date(b).valueOf() - new Date(a).valueOf();

package/core/stores/index.d.ts

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

package/core/stores/index.js

@@ -1,2 +0,0 @@
-export * from './memory';
-export * from './persistent';

package/core/stores/memory.d.ts

@@ -1,30 +0,0 @@
-/**
- * Minimal store implementation.
- *
- * Beware, the state is mutable! it is your responsibility
- * handle the state's mutations correctly. We do so in
- * order for users with mutable/observable stacks to be able
- * to decorate the state with their favorite libraries.
- *
- * @param defaultValue the hydration state value of the store
- * @returns A store instance with an "in memory" storage strategy
- *
- * @category Storage
- * @hidden
- */
-export declare const memoryStore: <T extends {}>(defaultValue?: Record<string, T>) => Amity.Store<T>;
-/**
- * ```js
- * import { memoryStores } from '@amityco/core/cache/store/volatile'
- * const stores = imemoryStores('user', 'file')
- * ```
- *
- * Builds a collection of in memory stores based on the available store names
- *
- * @param names collection of store names
- * @returns a dictionary of { storeName: storeInstance } according to the given names
- *
- * @category Storage
- */
-export declare const memoryStores: <T extends (keyof Amity.Model)[]>(...names: T) => Amity.StoreCollection<T>;
-//# sourceMappingURL=memory.d.ts.map

package/core/stores/memory.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"memory.d.ts","sourceRoot":"","sources":["../../../src/core/stores/memory.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,WAAW,oEAmBvB,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,YAAY,4EAOxB,CAAA"}

package/core/stores/memory.js

@@ -1,47 +0,0 @@
-/**
- * Minimal store implementation.
- *
- * Beware, the state is mutable! it is your responsibility
- * handle the state's mutations correctly. We do so in
- * order for users with mutable/observable stacks to be able
- * to decorate the state with their favorite libraries.
- *
- * @param defaultValue the hydration state value of the store
- * @returns A store instance with an "in memory" storage strategy
- *
- * @category Storage
- * @hidden
- */
-export const memoryStore = (defaultValue = {}) => {
-    const state = defaultValue;
-    /* default read operation is just to return the state */
-    const read = () => state;
-    /* default write operation is just to mutate the state */
-    const write = (payload) => {
-        Object.assign(state, payload);
-    };
-    /* default write operation is just to mutate the state */
-    const erase = (...keys) => {
-        keys.forEach(key => delete state[key]);
-    };
-    return { read, write, erase };
-};
-/**
- * ```js
- * import { memoryStores } from '@amityco/core/cache/store/volatile'
- * const stores = imemoryStores('user', 'file')
- * ```
- *
- * Builds a collection of in memory stores based on the available store names
- *
- * @param names collection of store names
- * @returns a dictionary of { storeName: storeInstance } according to the given names
- *
- * @category Storage
- */
-export const memoryStores = (...names) => {
-    return names.reduce((acc, name) => {
-        const store = memoryStore();
-        return Object.assign(Object.assign({}, acc), { [name]: store });
-    }, {});
-};

package/core/stores/persistent.d.ts

@@ -1,13 +0,0 @@
-/**
- * Persistent store implementation.
- *
- * @param persistentKey the name of the store in persistent storage
- * @param defaultValue the hydration state value of the store
- * @param debounceTime a delay to avoid spamming the persistent storage while writing,
- * @returns A store instance with an "persistent" storage strategy
- *
- * @category Storage
- * @hidden
- */
-export declare const persistentStore: <T extends {}>(persistentKey: string, defaultValue?: Record<string, T>, debounceTime?: number) => Promise<Amity.Store<T>>;
-//# sourceMappingURL=persistent.d.ts.map

package/core/stores/persistent.js

@@ -1,49 +0,0 @@
-import AsyncStorage from '@react-native-async-storage/async-storage';
-import { memoryStore } from './memory';
-const DEFAULT_DEBOUNCE_TIME = 250;
-/**
- * Persistent store implementation.
- *
- * @param persistentKey the name of the store in persistent storage
- * @param defaultValue the hydration state value of the store
- * @param debounceTime a delay to avoid spamming the persistent storage while writing,
- * @returns A store instance with an "persistent" storage strategy
- *
- * @category Storage
- * @hidden
- */
-export const persistentStore = async (persistentKey, defaultValue = {}, debounceTime = DEFAULT_DEBOUNCE_TIME) => {
-    let initialValue = defaultValue;
-    const serializedBackup = await AsyncStorage.getItem(persistentKey);
-    if (serializedBackup) {
-        try {
-            initialValue = JSON.parse(serializedBackup);
-        }
-        catch (err) { }
-    }
-    // create a store
-    const store = memoryStore(initialValue);
-    let timer;
-    let job = null;
-    const backup = () => {
-        if (job) {
-            job.then(() => backup());
-            return;
-        }
-        clearTimeout(timer);
-        setTimeout(async () => {
-            job = Promise.resolve()
-                .then(() => AsyncStorage.setItem(persistentKey, JSON.stringify(store.read())))
-                .then(() => job = null);
-        }, debounceTime);
-    };
-    const write = (payload) => {
-        store.write(payload);
-        backup();
-    };
-    const erase = (...keys) => {
-        store.erase(...keys);
-        backup();
-    };
-    return { read: store.read, write, erase };
-};

package/core/transports.d.ts

@@ -1,49 +0,0 @@
-/// <reference types="socket.io-client" />
-/**
- * Creates a pre-configured axios instance
- *
- * @param endpoint The ASC rest api server's URL
- * @returns A pre-configured axios instance
- *
- * @category Transport
- * @hidden
- */
-export declare const createHttpTransport: (endpoint?: string) => import("axios").AxiosInstance;
-/**
- * Creates a pre-configured socket.io instance
- *
- * @param endpoint The socket.io server's URL
- * @returns A pre-configured (non-connected) socket.io client instance
- *
- * @category Transport
- * @hidden
- */
-export declare const createWebsocketTransport: (endpoint?: string) => SocketIOClient.Socket;
-/**
- * Unwraps v3 server payload (for error handling and type extraction)
- *
- * @param response A typical "v3" response (related to backend's service strategy)
- *
- * @returns The data returned by the backend
- * @throws An error related to backend's rejection
- *
- * @category Transport
- * @hidden
- */
-export declare const unwrapPayload: <T>(response: Amity.Response<T>) => T;
-/**
- * Promisify a websocket event emission - resulting in a synchronous http-like XHR (ws legacy)
- *
- * @param client The current client for which to send the event with
- * @param event The websocket event name
- * @param data The event's payload
- *
- * @returns The data returned by the backend
- * @throws An error related to backend's rejection
- *
- * @category Transport
- * @async
- * @hidden
- */
-export declare const synchronousWSCall: <T>(client: Amity.Client, event: string, data?: Object | undefined) => Promise<T | undefined>;
-//# sourceMappingURL=transports.d.ts.map

package/core/transports.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"transports.d.ts","sourceRoot":"","sources":["../../src/core/transports.ts"],"names":[],"mappings":";AAgCA;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,cAAc,MAAM,kCAyBnD,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,wBAAwB,cAAc,MAAM,0BAmBxD,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,aAAa,uCAWzB,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,iBAAiB,cACpB,MAAM,MAAM,SACb,MAAM,sDAgBd,CAAA"}

package/core/transports.js

@@ -1,130 +0,0 @@
-import axios from 'axios';
-import HttpAgent, { HttpsAgent } from 'agentkeepalive';
-import io from 'socket.io-client';
-import { ASCApiError, ASCUnknownError, ASCConnectionError, } from './errors';
-/**
- * Axios param serializer (for querystring)
- * @hidden
- */
-const stringify = (params, prefix) => {
-    return Object.entries(params)
-        .filter(([, value]) => value !== undefined)
-        .map(([name, value]) => {
-        const key = prefix ? `${prefix}[${name}]` : name;
-        if (Array.isArray(value)) {
-            return value.map(item => `${key}[]=${item}`).join('&');
-        }
-        else if (typeof value !== 'object') {
-            return `${key}=${value}`;
-        }
-        return stringify(value, prefix !== null && prefix !== void 0 ? prefix : name);
-    })
-        .join('&');
-};
-/**
- * Creates a pre-configured axios instance
- *
- * @param endpoint The ASC rest api server's URL
- * @returns A pre-configured axios instance
- *
- * @category Transport
- * @hidden
- */
-export const createHttpTransport = (endpoint = 'https://api.amity.co') => {
-    const options = {
-        maxSockets: 100,
-        maxFreeSockets: 10,
-        timeout: 60000,
-        freeSocketTimeout: 30000,
-    };
-    const instance = axios.create({
-        baseURL: endpoint,
-        httpAgent: new HttpAgent(options),
-        httpsAgent: new HttpsAgent(options),
-        paramsSerializer: stringify,
-    });
-    instance.interceptors.response.use((response) => response, (error) => {
-        const { response } = error;
-        console.log(response.data);
-        unwrapPayload(response.data);
-    });
-    return instance;
-};
-/**
- * Creates a pre-configured socket.io instance
- *
- * @param endpoint The socket.io server's URL
- * @returns A pre-configured (non-connected) socket.io client instance
- *
- * @category Transport
- * @hidden
- */
-export const createWebsocketTransport = (endpoint = 'https://api.ekomedia.technology') => {
-    const socket = io(endpoint, {
-        autoConnect: false,
-        reconnectionDelay: 2000,
-        transports: ['websocket'],
-    });
-    socket.on('disconnect', (reason) => {
-        if (reason === 'io server disconnect')
-            socket.connect();
-    });
-    ['error', 'connect_error', 'connect_timeout', 'reconnect_error', 'reconnect_failed'].forEach(event => {
-        socket.on(event, (error) => {
-            throw new ASCConnectionError(`socket.io(${event}): ${error.message}`);
-        });
-    });
-    return socket;
-};
-/**
- * Unwraps v3 server payload (for error handling and type extraction)
- *
- * @param response A typical "v3" response (related to backend's service strategy)
- *
- * @returns The data returned by the backend
- * @throws An error related to backend's rejection
- *
- * @category Transport
- * @hidden
- */
-export const unwrapPayload = (response) => {
-    if (response.status === 'success') {
-        return response.data;
-    }
-    else if (response.status === 'fail') {
-        throw new ASCUnknownError(response.code);
-    }
-    else if (response.status === 'error') {
-        throw new ASCApiError(response.message, response.code, "error" /* ERROR */);
-    }
-    // unjust, but helps force uncast "T | undefined" to allow deconstruction without warnings
-    return undefined;
-};
-/**
- * Promisify a websocket event emission - resulting in a synchronous http-like XHR (ws legacy)
- *
- * @param client The current client for which to send the event with
- * @param event The websocket event name
- * @param data The event's payload
- *
- * @returns The data returned by the backend
- * @throws An error related to backend's rejection
- *
- * @category Transport
- * @async
- * @hidden
- */
-export const synchronousWSCall = async (client, event, data) => {
-    const { ws } = client;
-    const value = await new Promise((resolve, reject) => {
-        ws.emit(event, data, (response) => {
-            try {
-                resolve(unwrapPayload(response));
-            }
-            catch (error) {
-                reject(error);
-            }
-        });
-    });
-    return value;
-};

package/core/uuid.d.ts

@@ -1,2 +0,0 @@
-export declare const uuid: () => string;
-//# sourceMappingURL=uuid.d.ts.map

package/core/uuid.js

@@ -1,2 +0,0 @@
-import nativeIdGenerator from 'react-native-uuid';
-export const uuid = () => nativeIdGenerator.v4().toString();

package/feed/api/index.d.ts

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

package/feed/api/index.js

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

package/feed/api/queryGlobalFeed.d.ts

@@ -1,23 +0,0 @@
-/**
- * ```js
- * import { queryGlobalFeed } from '@amityco/ts-sdk'
- * const posts = await queryGlobalFeed(query)
- * ```
- *
- * Queries a paginable list of {@link Amity.Post} objects
- *
- * @param query The query parameters
- * @returns A page of {@link Amity.Post} objects
- *
- * @category Feed API
- * @async
- **/
-export declare const queryGlobalFeed: (query?: {
-    dataTypes?: ("image" | "file" | "video")[] | undefined;
-    page?: Amity.Page | undefined;
-} | undefined) => Promise<{
-    data: Record<string, Amity.Post<any>>;
-    nextPage: Amity.Page | null;
-    prevPage: Amity.Page | null;
-}>;
-//# sourceMappingURL=queryGlobalFeed.d.ts.map