jamespot-user-api 1.0.43 → 1.0.44

package/src/apis/search.ts

@@ -1,85 +0,0 @@
-import { ApiWrapper, SearchConfig, SearchQuery, SearchQueryResult, SearchResultCatProps } from '../types';
-import { JBaseApi } from './base';
-import { OF } from '../util/network';
-
-export class JSearchApi extends JBaseApi {
-    /**
-     * return a completed version of the current config, taking in account platform installed modules
-     */
-    public getConfig(): Promise<ApiWrapper<SearchConfig>> {
-        return this.network.post({ o: 'search', f: 'getConfig' });
-    }
-
-    /**
-     * Return a maximum of 8 results for a given text query, classed upon config categories
-     * @param query string, words can be preceded by + and - for inclusive/exclusive search
-     * @param signal: @AbortSignal to cancel the fetch
-     */
-    public proposition(
-        { query, format }: { query: string; format?: 'list' | 'little' },
-        signal?: AbortSignal,
-    ): Promise<ApiWrapper<SearchResultCatProps[]>> {
-        return this.network.post({ o: 'search', f: 'proposition', query, format: format || 'little' } as OF, signal);
-    }
-
-    /**
-     * Return a page of results based on a text query and various filters.
-     * All parameters are optional
-     * @param query
-     * @param query.keywords string, words can be preceded by + and - for inclusive/exclusive search (default *:*)
-     * @param query.category text id of a category from config,if specified: restrict results to these category
-     * @param query.facetCategories boolean, if true: count by categories are returned
-     * @param query.filters array of @SearchQueryFilterModel @SearchQueryFilterModel.
-     * @param query.page integer. default 1. index of returned page (start by 1)
-     * @param query.limit integer. default 20. number of result by page
-     * @param query.sort @SearchQuerySortModel default score then date
-     * @param query.options @SearchQueryOption. extra possible options for the search
-     * @param signal: @AbortSignal to cancel the fetch
-
-     * // Todo add query.facets (to be specified first)
-     */
-    public searchQuery(query: SearchQuery, signal?: AbortSignal): Promise<ApiWrapper<SearchQueryResult>> {
-        const { keywords, category, facetCategories, filters, page, limit, sort, options } = query;
-        return this.network.post(
-            {
-                o: 'search',
-                f: 'query',
-                keywords,
-                category,
-                facetCategories,
-                filters,
-                page,
-                limit,
-                sort,
-                options,
-            } as OF,
-            signal,
-        );
-    }
-
-    /**
-     * return the five last keywords typed in the searchbar by the user
-     */
-    public getLastQueries(): Promise<ApiWrapper<string[]>> {
-        return this.network.post({ o: 'search', f: 'getLastQueries' });
-    }
-
-    /**
-     * return the current platform json search-config object
-     */
-    // FIXME when doing the search admin
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    public getAdminConfig(): Promise<any> {
-        return this.network.post({ o: 'search', f: 'getAdminConfig' });
-    }
-
-    /**
-     * set the platform search-config to the given json object
-     * @param config object. json search config
-     */
-    // FIXME when doing the search admin
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    public setAdminConfig(config: any): Promise<any> {
-        return this.network.post({ o: 'search', f: 'setAdminConfig', config } as OF);
-    }
-}

package/src/apis/taxonomy.ts

@@ -1,30 +0,0 @@
-import { JBaseApi } from './base';
-import { OF } from '../util/network';
-import { ApiWrapper, BaseMessagesOne, Taxonomy, TaxonomyCreate } from '../types';
-
-export class JTaxonomyApi extends JBaseApi {
-    /**
-     * list all taxonomies (no pagination)
-     */
-    public list(): Promise<Taxonomy[]> {
-        return this.network
-            .post<Taxonomy[]>({
-                o: 'taxonomy',
-                f: 'list',
-            } as OF)
-            .then((res) => {
-                if (Array.isArray(res.result)) {
-                    return res.result;
-                }
-                throw 'Bad response from backend';
-            });
-    }
-
-    public create(taxonomy: TaxonomyCreate): Promise<ApiWrapper<Taxonomy, BaseMessagesOne>> {
-        return this.network.post<Taxonomy, BaseMessagesOne>({
-            o: 'taxonomy',
-            f: 'create',
-            ...taxonomy,
-        } as OF);
-    }
-}

package/src/apis/user.ts

@@ -1,53 +0,0 @@
-import { JBaseApi } from './base';
-import { JUser } from '../classes';
-import { OF } from '../util/network';
-import { ApiWrapper, Little } from '../types';
-
-export interface TmpUser {
-    idUser: string;
-    type: string;
-    id: string;
-}
-
-export class JUserApi extends JBaseApi {
-    /**
-     * autocomplete return a list or JUser
-     * @param query <string>
-     */
-    public autocomplete(query: string): Promise<Array<JUser>> {
-        return this.network
-            .post<Array<TmpUser>>({ o: 'autocomplete', f: 'user', q: query, idToUri: false } as OF)
-            .then((res) => {
-                if (Array.isArray(res.result)) {
-                    return res.result.map((user) => {
-                        const jUser = new JUser(user.idUser, user.type);
-                        jUser.hydrate(user);
-                        return jUser;
-                    });
-                }
-                throw 'Bad response from backend';
-            });
-    }
-
-    /**
-     * Get a user
-     * @param uri uri
-     * @param format little by default. If another format is provided, the generic types should be defined
-     */
-    public get<T extends Little = Little>(uri: string, format = 'little'): Promise<ApiWrapper<T>> {
-        return this.network.post<T>({ o: 'user', f: 'get', uri, format } as OF);
-    }
-
-    /**
-     * signIn function returns a Promise of JUser.
-     * @param mail Mail or username
-     * @param pwd Password to be validated
-     */
-    public signIn(mail: string, pwd: string): Promise<JUser> {
-        return this.network.post<TmpUser>({ o: 'user', f: 'signIn', mail, password: pwd } as OF).then((res) => {
-            const jUser = new JUser(res.result.id, res.result.type);
-            jUser.hydrate(res.result);
-            return jUser;
-        });
-    }
-}

package/src/apis/wedoc.ts

@@ -1,77 +0,0 @@
-import { ApiWrapper } from '../types';
-import { JBaseApi } from './base';
-import { OF } from '../util/network';
-import { ListWrapper } from '../types/listWrapper';
-import { jFile } from '../classes/JFile';
-
-type File = Record<string, object>;
-
-type FiletList = {
-    page: number;
-    cnt: number;
-    limit: number;
-    data: File[];
-};
-
-import { Orders, Filters } from '../types';
-
-export class JWedocApi extends JBaseApi {
-    public getFiles(
-        page: number,
-        query: string,
-        filters: Filters,
-        orders: Orders,
-        limit: number,
-    ): Promise<ListWrapper<jFile>> {
-        return this.network
-            .post<FiletList>({ o: 'onlyOffice', f: 'getFiles', page, query, filters, orders, limit } as OF)
-            .then((res) => {
-                const result = res.result;
-                if (Array.isArray(result.data)) {
-                    const data: jFile[] = result.data.map((entry) => jFile.createFromObject(entry));
-                    return { page: result.page, cnt: result.cnt, limit: result.limit, data };
-                }
-
-                throw {
-                    error: res.error,
-                    messages: res.messages,
-                };
-            });
-    }
-
-    public getTemplates(): Promise<ApiWrapper<boolean, { code: number; msg: string }>> {
-        return this.network.post({ o: 'onlyOffice', f: 'getTemplates' } as OF);
-    }
-
-    public duplicateFile(
-        idFile: number,
-        title: string,
-        publishTo: Array<any>,
-    ): Promise<ApiWrapper<boolean, { code: number; msg: string }>> {
-        return this.network.post({ o: 'onlyOffice', f: 'duplicateFile', idFile, title, publishTo } as OF);
-    }
-
-    public deleteFile(idFile: number): Promise<ApiWrapper<boolean, { code: number; msg: string }>> {
-        return this.network.post({ o: 'onlyOffice', f: 'deleteFile', idFile } as OF);
-    }
-
-    public createFile(
-        title: string,
-        type: string,
-        publishTo: Array<any>,
-    ): Promise<ApiWrapper<boolean, { code: number; msg: string }>> {
-        return this.network.post({ o: 'onlyOffice', f: 'createFile', title, type, publishTo } as OF);
-    }
-
-    public updateFile(
-        idFile: number,
-        title: string,
-        publishTo: Array<string>,
-    ): Promise<ApiWrapper<boolean, { code: number; msg: string }>> {
-        return this.network.post({ o: 'onlyOffice', f: 'updateFile', idFile, title, publishTo } as OF);
-    }
-
-    public getFileInfo(idFile: number, mode: string): Promise<ApiWrapper<boolean, { code: number; msg: string }>> {
-        return this.network.post({ o: 'onlyOffice', f: 'GetFileInfo', idFile, mode } as OF);
-    }
-}

package/src/classes/JApplication.ts

@@ -1,55 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/* FIXME when working on studio typing */
-
-import { JBaseObject } from './JBaseObject';
-
-export enum JApplicationStatus {
-    local = 'local',
-    installed = 'installed',
-    autosaved = 'autosaved',
-    saved = 'saved',
-}
-export class JApplication extends JBaseObject {
-    private status?: JApplicationStatus;
-
-    public constructor(id?: string, type?: string, status?: JApplicationStatus) {
-        super(id, type);
-        if (status) {
-            this.setStatus(status);
-        } else {
-            this.setStatus(JApplicationStatus.local);
-        }
-    }
-
-    public get(prop: string): any {
-        if (prop === 'status') {
-            return this.getStatus();
-        }
-        return super.get(prop);
-    }
-
-    public set(prop: string, val: any): void {
-        if (prop === 'status') {
-            return this.setStatus(val);
-        }
-        return super.set(prop, val);
-    }
-
-    public setStatus(status: JApplicationStatus): void {
-        this.status = status;
-    }
-    public getStatus(): JApplicationStatus | undefined {
-        return this.status;
-    }
-
-    public updateUsing(newerJApplication: JApplication): JApplication {
-        if (this.getId() === newerJApplication.getId() && this.getType() === newerJApplication.getType()) {
-            Object.keys(newerJApplication.record).forEach((key: string) => {
-                this.set(key, newerJApplication.get(key));
-            });
-        } else {
-            throw new Error('Incompatible update');
-        }
-        return this;
-    }
-}

package/src/classes/JBaseObject.ts

@@ -1,64 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/* FIXME when working on studio typing */
-
-/** Base class to represent objects retreived from or sent to the backend.
- * This JBaseObject is then derived to provide a more understandable result for each API.
- */
-export class JBaseObject {
-    protected type?: string;
-    protected id?: string;
-    protected record: Record<string, any> = {};
-
-    public constructor(id?: string, type?: string) {
-        if (id) {
-            this.set('id', id);
-        }
-        if (type) {
-            this.set('type', type);
-        }
-    }
-
-    public hydrate(data: any = {}): void {
-        Object.keys(data).forEach((key) => {
-            this.set(key, data[key]);
-        });
-    }
-
-    public getType(): string | undefined {
-        return this.type;
-    }
-
-    public getId(): string | undefined {
-        return this.id;
-    }
-
-    public getUri(): string {
-        return `${this.getType()}/${this.getId()}`;
-    }
-
-    public get(prop: string): any {
-        switch (prop) {
-            case 'type':
-                return this.getType();
-            case 'id':
-                return this.getId();
-            case 'uri':
-                return this.getUri();
-            default:
-                return this.record[prop];
-        }
-    }
-
-    public set(prop: string, val: any): void {
-        switch (prop) {
-            case 'type':
-                this.type = val;
-                break;
-            case 'id':
-                this.id = val;
-                break;
-            default:
-                this.record[prop] = val;
-        }
-    }
-}

package/src/classes/JBookmark.ts

@@ -1,44 +0,0 @@
-export class JBookmark {
-    public id?: number;
-    public type?: string;
-    public targetId?: number;
-    public targetType?: string;
-    public bookmarkUrl?: string;
-    public bookmarkOrder?: number;
-    public bookmarkLabel?: string;
-    public bookmarkMeta?: string;
-    public _cssClass?: string;
-    public _cssColor?: string;
-    public _values?: Record<string, string>;
-    public url?: string;
-
-    private static fields: string[] = [
-        'id',
-        'type',
-        'targetId',
-        'targetType',
-        'bookmarkUrl',
-        'bookmarkOrder',
-        'bookmarkLabel',
-        'bookmarkMeta',
-        '_cssClass',
-        '_cssColor',
-        '_values',
-        'url',
-    ];
-
-    public static createFromObject(o: Record<string, object>): JBookmark {
-        const toRet = new JBookmark();
-        const copy: Record<string, object> = {};
-        // Clean unknown elements
-        JBookmark.fields.forEach((p) => {
-            if (o[p] !== undefined) {
-                copy[p] = o[p];
-            }
-        });
-
-        Object.assign(toRet, copy);
-
-        return toRet;
-    }
-}

package/src/classes/JConcept.ts

@@ -1,3 +0,0 @@
-import { JBaseObject } from './JBaseObject';
-
-export class JConcept extends JBaseObject {}

package/src/classes/JDiapazone.ts

@@ -1,42 +0,0 @@
-export class JDiapazone {
-    public id!: number;
-    public title!: string;
-    public type!: string;
-    public _user?: Record<string, string>;
-    public _audience?: Record<string, string>;
-    public _audienceLeft?: number;
-    public _right?: Record<string, string>;
-    public _cssClass?: string;
-    public _cssColor?: string;
-    public _values?: Record<string, string>;
-    public _extend?: Record<string, string>;
-    public _url?: string;
-
-    private static fields: string[] = [
-        'id',
-        'title',
-        'type',
-        '_user',
-        '_audience',
-        '_audienceLeft',
-        '_right',
-        '_cssClass',
-        '_cssColor',
-        '_values',
-        '_extend',
-        '_url',
-    ];
-    public static createFromObject(o: Record<string, object>): JDiapazone {
-        const toRet = new JDiapazone();
-        const copy: Record<string, object> = {};
-        // Clean unknown elements
-        JDiapazone.fields.forEach((p) => {
-            if (o[p] !== undefined) {
-                copy[p] = o[p];
-            }
-        });
-        Object.assign(toRet, copy);
-
-        return toRet;
-    }
-}

package/src/classes/JFile.ts

@@ -1,37 +0,0 @@
-export class jFile {
-    public id!: number;
-    public title!: string;
-    public type!: string;
-    public dateCreation!: string;
-    public mimetype!: string;
-    public _extend: any;
-    public _user: any;
-    public _right: any;
-    public _audience: any;
-
-    private static fields: string[] = [
-        'id',
-        'title',
-        'type',
-        'dateCreation',
-        'dateModified',
-        'mimetype',
-        '_extend',
-        '_user',
-        '_right',
-        '_audience',
-    ];
-    public static createFromObject(o: Record<string, object>): jFile {
-        const toRet = new jFile();
-        const copy: Record<string, object> = {};
-        // Clean unknown elements
-        jFile.fields.forEach((p) => {
-            if (o[p] !== undefined) {
-                copy[p] = o[p];
-            }
-        });
-        Object.assign(toRet, copy);
-
-        return toRet;
-    }
-}

package/src/classes/JUser.ts

@@ -1,7 +0,0 @@
-import { JBaseObject } from './JBaseObject';
-
-export class JUser extends JBaseObject {
-    public getMail(): string {
-        return this.get('_values').mail;
-    }
-}

package/src/classes/index.ts

@@ -1,5 +0,0 @@
-export * from './JApplication';
-export * from './JBaseObject';
-export * from './JConcept';
-export * from './JUser';
-export * from './JBookmark';

package/src/index.ts

@@ -1,21 +0,0 @@
-import { JamespotUserApi } from './apis/jamespotUserApi';
-import { Network } from './util/network';
-
-const network = new Network(window);
-const JamespotUserApiInstance = new JamespotUserApi(network);
-
-declare global {
-    interface Window {
-        JamespotUserApi: JamespotUserApi;
-    }
-}
-
-window.JamespotUserApi = JamespotUserApiInstance;
-
-export { JamespotUserApiInstance };
-export default JamespotUserApiInstance;
-
-export * from './apis';
-export * from './types';
-export * from './classes';
-export * from './util/network';

package/src/indexMock.ts

@@ -1,17 +0,0 @@
-import { JamespotUserApi } from './apis';
-import { Network } from './util/network';
-import { WindowMock } from './mock/windowMock';
-
-const network = new Network(new WindowMock() as unknown as Window);
-const JamespotUserApiInstance = new JamespotUserApi(network);
-
-declare global {
-    interface Window {
-        JamespotUserApi: JamespotUserApi;
-    }
-}
-
-window.JamespotUserApi = JamespotUserApiInstance;
-
-export { JamespotUserApiInstance };
-export default JamespotUserApiInstance;