@steedos/client 2.2.52 → 2.2.53-beta.2

package/lib/client4.d.ts

@@ -0,0 +1,99 @@
+import { Options, ClientResponse } from './types/client4';
+import { UserProfile } from './types/users';
+import { ServerError } from './types/errors';
+import { Space } from './types/spaces';
+import Graphql from './graphql';
+export declare const HEADER_X_VERSION_ID = "X-Version-Id";
+export declare const DEFAULT_LIMIT_BEFORE = 30;
+export declare const DEFAULT_LIMIT_AFTER = 30;
+export default class SteedosClient {
+    LOGIN_TOKEN_KEY: string;
+    LOGIN_TOKEN_EXPIRES_KEY: string;
+    USER_ID_KEY: string;
+    logToConsole: boolean;
+    _lastLoginTokenWhenPolled: null;
+    loginExpirationInDays: null;
+    serverVersion: string;
+    clusterId: string;
+    token: string;
+    spaceId: string;
+    authToken: string;
+    csrf: string;
+    url: string;
+    urlVersion: string;
+    userAgent: string | null;
+    enableLogging: boolean;
+    defaultHeaders: {
+        [x: string]: string;
+    };
+    userId: string;
+    diagnosticId: string;
+    includeCookies: boolean;
+    isRudderKeySet: boolean;
+    translations: {
+        connectionError: string;
+        unknownError: string;
+    };
+    userRoles?: string;
+    sobjects: {};
+    graphql: Graphql;
+    getUrl(): string;
+    getAbsoluteUrl(baseUrl: string): string;
+    setUrl(url: string): void;
+    setUserAgent(userAgent: string): void;
+    getToken(): string;
+    setToken(token: string): void;
+    getSpaceId(): string;
+    setSpaceId(spaceId: any): void;
+    getAuthToken(): string;
+    setCSRF(csrfToken: string): void;
+    setAcceptLanguage(locale: string): void;
+    setEnableLogging(enable: boolean): void;
+    setIncludeCookies(include: boolean): void;
+    setUserId(userId: string): void;
+    setUserRoles(roles: string): void;
+    setDiagnosticId(diagnosticId: string): void;
+    enableRudderEvents(): void;
+    getServerVersion(): string;
+    getUrlVersion(): string;
+    getBaseRoute(): string;
+    getAccountsRoute(): string;
+    getCSRFFromCookie(): string;
+    getOptions(options: Options): {
+        headers: {
+            [x: string]: string;
+        };
+        method?: string | undefined;
+        url?: string | undefined;
+        credentials?: "omit" | "same-origin" | "include" | undefined;
+        body?: any;
+    };
+    getTranslations: (url: string) => Promise<Record<string, string>>;
+    logClientError: (message: string, level?: string) => void;
+    login: (user: string | object, password: string, token?: string, deviceId?: string) => Promise<UserProfile>;
+    createUser: (user: UserProfile, token: string, inviteId: string, redirect: string) => any;
+    createSpace: (name: string) => any;
+    sendVerificationToken: (user: string) => Promise<UserProfile>;
+    getSettings: () => Promise<UserProfile>;
+    getMe: () => Promise<UserProfile>;
+    getMySpaces: () => Promise<Space[]>;
+    logout: () => Promise<Response>;
+    doFetch: <T>(url: string, options: Options) => Promise<T>;
+    doFetchWithResponse: <T>(url: string, options: Options) => Promise<ClientResponse<T>>;
+    trackEvent(category: string, event: string, props?: any): void;
+    changePassword: (oldPassword: string, newPassword: string) => Promise<UserProfile>;
+    verifyEmail: (email: string, code: string) => Promise<UserProfile>;
+    verifyMobile: (mobile: string, code: string) => Promise<UserProfile>;
+    sobject: (objectName: any) => any;
+}
+export declare class ClientError extends Error implements ServerError {
+    url?: string;
+    intl?: {
+        id: string;
+        defaultMessage: string;
+        values?: any;
+    };
+    server_error_id?: string;
+    status_code?: number;
+    constructor(baseUrl: string, data: ServerError);
+}

package/lib/fetch_etag.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (url?: any, options?: any) => any;
+export default _default;

package/lib/graphql.d.ts

@@ -0,0 +1,8 @@
+export default class Graphql {
+    client: any;
+    constructor(client: any);
+    query(query: string): Promise<any>;
+    insert(objectName: string, data: any): Promise<any>;
+    update(objectName: string, _id: string, data: any): Promise<any>;
+    delete(objectName: string, _id: string): Promise<any>;
+}

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+import SteedosClient, { DEFAULT_LIMIT_AFTER, DEFAULT_LIMIT_BEFORE, HEADER_X_VERSION_ID } from './client4';
+export { SteedosClient, DEFAULT_LIMIT_AFTER, DEFAULT_LIMIT_BEFORE, HEADER_X_VERSION_ID, };

package/lib/sobject.d.ts

@@ -0,0 +1,63 @@
+import { Filters, Fields, Options, Record } from './types/sobject';
+export default class SObject {
+    client: any;
+    objectName: string;
+    constructor(client: any, objectName: any);
+    private getFilter;
+    private getSelect;
+    private getQueryParams;
+    /**
+     * Find and fetch records which matches given conditions
+     *
+     * @param {String|Array} [filters] - filtering records
+     * @param {String|Array} [fields] - Fields to fetch.
+     * @param {Object} [options] - Query options.
+     * @param {Number} [options.$top] - Maximum number of records the query will return.
+     * @param {Number} [options.$skip] - Synonym of options.offset.
+     * @param {String} [options.$orderby] - sorting.
+     * @param {boolean} [options.$count] - count.
+     * @returns {Promise<Array<Record>>}
+     */
+    find(filters: Filters, fields: Fields, options: Options): Promise<any>;
+    /**
+     * TODO 根据条件查询数据，返回1条($top = 1)。
+     * @param filters
+     * @param fields
+     * @param options
+     * @returns {Promise<Record>}
+     */
+    findOne(filters: Filters, fields: Fields, options: Options): Promise<void>;
+    /**
+     * TODO 根据id查询数据。
+     * @param id
+     * @param fields
+     */
+    record(id: string, fields: Fields): Promise<void>;
+    /**
+     * TODO 根据ids查询数据。
+     * @param ids
+     * @param fields
+     */
+    retrieve(ids: Array<string>, fields: Fields): Promise<void>;
+    /**
+     * TODO 写入数据，并返回新记录
+     * @param doc
+     */
+    insert(doc: Record): Promise<void>;
+    /**
+     * TODO 根据id，修改记录，并返回新记录
+     * @param id
+     * @param doc
+     */
+    update(id: string, doc: Record): Promise<void>;
+    /**
+     * TODO 根据id, 删除记录
+     * @param id
+     */
+    delete(id: string): Promise<void>;
+    /**
+     * TODO 返回满足条件的记录数
+     * @param filters
+     */
+    count(filters: Filters): Promise<void>;
+}

package/lib/types/client4.d.ts

@@ -0,0 +1,36 @@
+export declare type logLevel = 'ERROR' | 'WARNING' | 'INFO';
+export declare type ClientResponse<T> = {
+    response: Response;
+    headers: Map<string, string>;
+    data: T;
+};
+declare type ErrorOffline = {
+    message: string;
+    url: string;
+};
+declare type ErrorInvalidResponse = {
+    intl: {
+        id: string;
+        defaultMessage: string;
+    };
+};
+export declare type ErrorApi = {
+    message: string;
+    server_error_id: string;
+    status_code: number;
+    url: string;
+};
+export declare type Client4Error = ErrorOffline | ErrorInvalidResponse | ErrorApi;
+export declare type Options = {
+    headers?: {
+        [x: string]: string;
+    };
+    method?: string;
+    url?: string;
+    credentials?: 'omit' | 'same-origin' | 'include';
+    body?: any;
+};
+export declare type StatusOK = {
+    status: 'OK';
+};
+export {};

package/lib/types/errors.d.ts

@@ -0,0 +1,12 @@
+export declare type ServerError = {
+    server_error_id?: string;
+    stack?: string;
+    intl?: {
+        id: string;
+        defaultMessage: string;
+        values?: any;
+    };
+    message: string;
+    status_code?: number;
+    url?: string;
+};

package/lib/types/json.d.ts

@@ -0,0 +1,24 @@
+declare type Optional<T> = T | undefined;
+export interface Dictionary<T = unknown> {
+    [key: string]: Optional<T>;
+}
+export declare type JsonPrimitive = null | boolean | number | string;
+/**
+ * Any valid JSON collection value.
+ */
+export declare type JsonCollection = JsonMap | JsonArray;
+/**
+ * Any valid JSON value.
+ */
+export declare type AnyJson = JsonPrimitive | JsonCollection;
+/**
+ * Any JSON-compatible object.
+ */
+export interface JsonMap extends Dictionary<AnyJson> {
+}
+/**
+ * Any JSON-compatible array.
+ */
+export interface JsonArray extends Array<AnyJson> {
+}
+export {};

package/lib/types/sobject.d.ts

@@ -0,0 +1,12 @@
+import { JsonMap } from './json';
+export declare type Filters = string | Array<any>;
+export declare type Fields = string | Array<string>;
+export declare type Options = {
+    $top?: Number;
+    $skip?: Number;
+    $orderby?: Number;
+    $count?: boolean;
+    $filter?: Filters;
+    $select?: Fields;
+};
+export declare type Record = JsonMap;

package/lib/types/spaces.d.ts

@@ -0,0 +1,16 @@
+import { IDMappedObjects } from './utilities';
+export declare type Space = {
+    _id: string;
+    name: string;
+};
+export declare type SpaceUser = {
+    _id: string;
+    space: string;
+    user: string;
+};
+export declare type SpacesState = {
+    currentSpaceId: string;
+    spaces: IDMappedObjects<Space>;
+    mySpaces: IDMappedObjects<Space>;
+    mySpacesCount: number;
+};

package/lib/types/users.d.ts

@@ -0,0 +1,18 @@
+import { IDMappedObjects } from './utilities';
+export declare type UserProfile = {
+    _id: string;
+    create_at: number;
+    update_at: number;
+    delete_at: number;
+    username: string;
+    password: string;
+    email: string;
+    email_verified: boolean;
+    name: string;
+    failed_attempts: number;
+    locale: string;
+};
+export declare type UsersState = {
+    currentUserId: string;
+    users: IDMappedObjects<UserProfile>;
+};

package/lib/types/utilities.d.ts

@@ -0,0 +1,53 @@
+export declare type $ID<E extends {
+    _id: string;
+}> = E['_id'];
+export declare type $UserID<E extends {
+    user_id: string;
+}> = E['user_id'];
+export declare type $Name<E extends {
+    name: string;
+}> = E['name'];
+export declare type $Username<E extends {
+    username: string;
+}> = E['username'];
+export declare type $Email<E extends {
+    email: string;
+}> = E['email'];
+export declare type RelationOneToOne<E extends {
+    _id: string;
+}, T> = {
+    [x in $ID<E>]: T;
+};
+export declare type RelationOneToMany<E1 extends {
+    _id: string;
+}, E2 extends {
+    _id: string;
+}> = {
+    [x in $ID<E1>]: Array<$ID<E2>>;
+};
+export declare type IDMappedObjects<E extends {
+    _id: string;
+}> = RelationOneToOne<E, E>;
+export declare type UserIDMappedObjects<E extends {
+    user_id: string;
+}> = {
+    [x in $UserID<E>]: E;
+};
+export declare type NameMappedObjects<E extends {
+    name: string;
+}> = {
+    [x in $Name<E>]: E;
+};
+export declare type UsernameMappedObjects<E extends {
+    username: string;
+}> = {
+    [x in $Username<E>]: E;
+};
+export declare type EmailMappedObjects<E extends {
+    email: string;
+}> = {
+    [x in $Email<E>]: E;
+};
+export declare type Dictionary<T> = {
+    [key: string]: T;
+};

package/lib/utils/helpers.d.ts

@@ -0,0 +1,2 @@
+import { Dictionary } from '../types/utilities';
+export declare function buildQueryString(parameters: Dictionary<any>): string;

package/lib/utils/sentry.d.ts

@@ -0,0 +1 @@
+export declare function cleanUrlForLogging(baseUrl: any, apiUrl: any): any;

package/package.json

@@ -1,7 +1,7 @@
 {
   "private": false,
   "name": "@steedos/client",
-  "version": "2.2.52",
+  "version": "2.2.53-beta.2",
   "description": "client lib for steedos",
   "main": "lib/index.js",
   "scripts": {
@@ -17,8 +17,8 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@steedos/filters": "2.2.52",
+    "@steedos/filters": "2.2.53-beta.2",
     "node-fetch": "^2.6.7"
   },
-  "gitHead": "1447c9ca4fb57a49233704f50a7d757aff0c5027"
+  "gitHead": "d6d2230d72af49a72fc546093b553463cd2f0e9d"
 }