jamespot-user-api 1.0.42 → 1.0.46

package/lib/src/apis/index.d.ts

@@ -0,0 +1,17 @@
+export * from './application';
+export * from './article';
+export * from './audience';
+export * from './base';
+export * from './community';
+export * from './concept';
+export * from './file';
+export * from './filebank';
+export * from './group';
+export * from './jamespotUserApi';
+export * from './jland';
+export * from './messenger';
+export * from './search';
+export * from './bookmark';
+export * from './user';
+export * from './diapazone';
+export * from './wedoc';

package/lib/src/apis/jamespotUserApi.d.ts

@@ -0,0 +1,47 @@
+import { JApplicationApi } from './application';
+import { JArticleApi } from './article';
+import { JAseiApi } from './asei';
+import { JAudienceApi } from './audience';
+import { JCommunityApi } from './community';
+import { JConceptApi } from './concept';
+import { JFileApi } from './file';
+import { JFilebankApi } from './filebank';
+import { JGroupApi } from './group';
+import { JLandApi } from './jland';
+import { JMessengerApi } from './messenger';
+import { JSearchApi } from './search';
+import { JBookmarkApi } from './bookmark';
+import { JTaxonomyApi } from './taxonomy';
+import { JUserApi } from './user';
+import { JDiapazoneApi } from './diapazone';
+import { JWedocApi } from './wedoc';
+import { Network } from '../util/network';
+/**
+ * In browser usage, 'window' should be the window object.
+ * In server side usage, 'window' object given must implement the fetch method, used by the Apis.
+ * See tests implementation for a working Node sample.
+ *
+ * Each property (except {@link constants} and {@link window}) is an API providing access to a Jamespot.Pro backend.
+ */
+export declare class JamespotUserApi {
+    version: string;
+    network: Network;
+    application: JApplicationApi;
+    article: JArticleApi;
+    asei: JAseiApi;
+    audience: JAudienceApi;
+    community: JCommunityApi;
+    concept: JConceptApi;
+    file: JFileApi;
+    filebank: JFilebankApi;
+    group: JGroupApi;
+    jland: JLandApi;
+    messenger: JMessengerApi;
+    search: JSearchApi;
+    bookmark: JBookmarkApi;
+    taxonomy: JTaxonomyApi;
+    user: JUserApi;
+    diapazone: JDiapazoneApi;
+    wedoc: JWedocApi;
+    constructor(network: Network);
+}

package/lib/src/apis/jland.d.ts

@@ -0,0 +1,24 @@
+import { JBaseApi } from './base';
+import { ApiWrapper } from '../types';
+export declare type JLandLog = {
+    idLog: number;
+    slug: string;
+    dateCreation: string;
+    map: string;
+    mail: string;
+};
+export declare type JLandStat = {
+    mail: string;
+    cnt: string;
+};
+export declare class JLandApi extends JBaseApi {
+    getLogs({ dateEnd, idLogMax, }: {
+        dateEnd?: string;
+        idLogMax?: number;
+    }): Promise<ApiWrapper<Array<JLandLog>>>;
+    getStats({ map, dateStart, dateEnd, }: {
+        map: string;
+        dateStart?: string;
+        dateEnd?: string;
+    }): Promise<ApiWrapper<Array<JLandStat>>>;
+}

package/lib/src/apis/messenger.d.ts

@@ -0,0 +1,6 @@
+import { ApiWrapper } from '../types';
+import { JBaseApi } from './base';
+export declare class JMessengerApi extends JBaseApi {
+    sendMessage(message: string, idDiscussion: string): Promise<ApiWrapper<Record<string, never>>>;
+    getOrCreateDiscussion(idSender: number, idUserTo: number): Promise<ApiWrapper<Record<string, never>>>;
+}

package/lib/src/apis/search.d.ts

@@ -0,0 +1,47 @@
+import { ApiWrapper, SearchConfig, SearchQuery, SearchQueryResult, SearchResultCatProps, SearchLastQuery } from '../types';
+import { JBaseApi } from './base';
+export declare class JSearchApi extends JBaseApi {
+    /**
+     * return a completed version of the current config, taking in account platform installed modules
+     */
+    getConfig(): Promise<ApiWrapper<SearchConfig>>;
+    /**
+     * 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
+     */
+    proposition({ query, format }: {
+        query: string;
+        format?: 'list' | 'little';
+    }, signal?: AbortSignal): Promise<ApiWrapper<SearchResultCatProps[]>>;
+    /**
+     * 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)
+     */
+    searchQuery(query: SearchQuery, signal?: AbortSignal): Promise<ApiWrapper<SearchQueryResult>>;
+    /**
+     * return the five last keywords typed in the searchbar by the user
+     */
+    getLastQueries(): Promise<ApiWrapper<SearchLastQuery[]>>;
+    /**
+     * return the current platform json search-config object
+     */
+    getAdminConfig(): Promise<any>;
+    /**
+     * set the platform search-config to the given json object
+     * @param config object. json search config
+     */
+    setAdminConfig(config: any): Promise<any>;
+}

package/lib/src/apis/taxonomy.d.ts

@@ -0,0 +1,9 @@
+import { JBaseApi } from './base';
+import { ApiWrapper, BaseMessagesOne, Taxonomy, TaxonomyCreate } from '../types';
+export declare class JTaxonomyApi extends JBaseApi {
+    /**
+     * list all taxonomies (no pagination)
+     */
+    list(): Promise<Taxonomy[]>;
+    create(taxonomy: TaxonomyCreate): Promise<ApiWrapper<Taxonomy, BaseMessagesOne>>;
+}

package/lib/src/apis/user.d.ts

@@ -0,0 +1,27 @@
+import { JBaseApi } from './base';
+import { JUser } from '../classes';
+import { ApiWrapper, Little } from '../types';
+export interface TmpUser {
+    idUser: string;
+    type: string;
+    id: string;
+}
+export declare class JUserApi extends JBaseApi {
+    /**
+     * autocomplete return a list or JUser
+     * @param query <string>
+     */
+    autocomplete(query: string): Promise<Array<JUser>>;
+    /**
+     * Get a user
+     * @param uri uri
+     * @param format little by default. If another format is provided, the generic types should be defined
+     */
+    get<T extends Little = Little>(uri: string, format?: string): Promise<ApiWrapper<T>>;
+    /**
+     * signIn function returns a Promise of JUser.
+     * @param mail Mail or username
+     * @param pwd Password to be validated
+     */
+    signIn(mail: string, pwd: string): Promise<JUser>;
+}

package/lib/src/apis/wedoc.d.ts

@@ -0,0 +1,32 @@
+import { ApiWrapper } from '../types';
+import { JBaseApi } from './base';
+import { ListWrapper } from '../types/listWrapper';
+import { jFile } from '../classes/JFile';
+import { Orders, Filters } from '../types';
+export declare class JWedocApi extends JBaseApi {
+    getFiles(page: number, query: string, filters: Filters, orders: Orders, limit: number): Promise<ListWrapper<jFile>>;
+    getTemplates(): Promise<ApiWrapper<boolean, {
+        code: number;
+        msg: string;
+    }>>;
+    duplicateFile(idFile: number, title: string, publishTo: Array<any>): Promise<ApiWrapper<boolean, {
+        code: number;
+        msg: string;
+    }>>;
+    deleteFile(idFile: number): Promise<ApiWrapper<boolean, {
+        code: number;
+        msg: string;
+    }>>;
+    createFile(title: string, type: string, publishTo: Array<any>): Promise<ApiWrapper<boolean, {
+        code: number;
+        msg: string;
+    }>>;
+    updateFile(idFile: number, title: string, publishTo: Array<string>): Promise<ApiWrapper<boolean, {
+        code: number;
+        msg: string;
+    }>>;
+    getFileInfo(idFile: number, mode: string): Promise<ApiWrapper<boolean, {
+        code: number;
+        msg: string;
+    }>>;
+}

package/lib/src/classes/JApplication.d.ts

@@ -0,0 +1,16 @@
+import { JBaseObject } from './JBaseObject';
+export declare enum JApplicationStatus {
+    local = "local",
+    installed = "installed",
+    autosaved = "autosaved",
+    saved = "saved"
+}
+export declare class JApplication extends JBaseObject {
+    private status?;
+    constructor(id?: string, type?: string, status?: JApplicationStatus);
+    get(prop: string): any;
+    set(prop: string, val: any): void;
+    setStatus(status: JApplicationStatus): void;
+    getStatus(): JApplicationStatus | undefined;
+    updateUsing(newerJApplication: JApplication): JApplication;
+}

package/lib/src/classes/JBaseObject.d.ts

@@ -0,0 +1,15 @@
+/** 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 declare class JBaseObject {
+    protected type?: string;
+    protected id?: string;
+    protected record: Record<string, any>;
+    constructor(id?: string, type?: string);
+    hydrate(data?: any): void;
+    getType(): string | undefined;
+    getId(): string | undefined;
+    getUri(): string;
+    get(prop: string): any;
+    set(prop: string, val: any): void;
+}

package/lib/src/classes/JBookmark.d.ts

@@ -0,0 +1,16 @@
+export declare class JBookmark {
+    id?: number;
+    type?: string;
+    targetId?: number;
+    targetType?: string;
+    bookmarkUrl?: string;
+    bookmarkOrder?: number;
+    bookmarkLabel?: string;
+    bookmarkMeta?: string;
+    _cssClass?: string;
+    _cssColor?: string;
+    _values?: Record<string, string>;
+    url?: string;
+    private static fields;
+    static createFromObject(o: Record<string, object>): JBookmark;
+}

package/lib/src/classes/JConcept.d.ts

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

package/lib/src/classes/JDiapazone.d.ts

@@ -0,0 +1,16 @@
+export declare class JDiapazone {
+    id: number;
+    title: string;
+    type: string;
+    _user?: Record<string, string>;
+    _audience?: Record<string, string>;
+    _audienceLeft?: number;
+    _right?: Record<string, string>;
+    _cssClass?: string;
+    _cssColor?: string;
+    _values?: Record<string, string>;
+    _extend?: Record<string, string>;
+    _url?: string;
+    private static fields;
+    static createFromObject(o: Record<string, object>): JDiapazone;
+}

package/lib/src/classes/JFile.d.ts

@@ -0,0 +1,13 @@
+export declare class jFile {
+    id: number;
+    title: string;
+    type: string;
+    dateCreation: string;
+    mimetype: string;
+    _extend: any;
+    _user: any;
+    _right: any;
+    _audience: any;
+    private static fields;
+    static createFromObject(o: Record<string, object>): jFile;
+}

package/lib/src/classes/JUser.d.ts

@@ -0,0 +1,4 @@
+import { JBaseObject } from './JBaseObject';
+export declare class JUser extends JBaseObject {
+    getMail(): string;
+}

package/lib/src/classes/index.d.ts

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

package/lib/src/index.d.ts

@@ -0,0 +1,13 @@
+import { JamespotUserApi } from './apis/jamespotUserApi';
+declare const JamespotUserApiInstance: JamespotUserApi;
+declare global {
+    interface Window {
+        JamespotUserApi: JamespotUserApi;
+    }
+}
+export { JamespotUserApiInstance };
+export default JamespotUserApiInstance;
+export * from './apis';
+export * from './types';
+export * from './classes';
+export * from './util/network';

package/lib/src/indexMock.d.ts

@@ -0,0 +1,9 @@
+import { JamespotUserApi } from './apis';
+declare const JamespotUserApiInstance: JamespotUserApi;
+declare global {
+    interface Window {
+        JamespotUserApi: JamespotUserApi;
+    }
+}
+export { JamespotUserApiInstance };
+export default JamespotUserApiInstance;

package/lib/src/mock/windowMock.d.ts

@@ -0,0 +1,9 @@
+export declare class WindowMock {
+    private readonly data;
+    location: {
+        protocol: string;
+        host: string;
+    };
+    constructor();
+    fetch(url: string, requestInit: RequestInit): Promise<Response>;
+}

package/lib/src/types/asei.d.ts

@@ -0,0 +1,28 @@
+import { Little, Rights } from './utils';
+export declare type AseiTicketStatus = 'created' | 'validated' | 'handled';
+export interface AseiTicket extends Little {
+    _right: Rights;
+    _user: Little;
+    aseiClearanceTicketValidator: Little[];
+    aseiClearanceTicketInstitution: Little[];
+    processContext: null;
+    aseiClearanceTicketType: string;
+    aseiClearanceTicketNatureOfDemand: null;
+    aseiClearanceTicketLastName: string;
+    aseiClearanceTicketFirstName: string;
+    aseiClearanceTicketStatus: AseiTicketStatus;
+}
+export interface AseiInstitution extends Little {
+    _right: Rights;
+    _user: Little;
+    aseiInstitutionValidator: Little[];
+    processContext: null;
+}
+export interface AseiGroups {
+    dsi: number;
+    gestionnaireApplicatif: number;
+}
+export interface AseiRights {
+    accessWriter: boolean;
+    accessApp: boolean;
+}

package/lib/src/types/autocomplete.d.ts

@@ -0,0 +1,16 @@
+export interface BaseAutocomplete {
+    value: string;
+    uri: string;
+    shortUri: string;
+    title: string;
+    name: string;
+    mainType: string;
+    type: string;
+    label: string;
+    cssClass: string;
+    cssColor: string;
+    class: string;
+    Pseudo: string;
+}
+export declare type AudienceAutocomplete = BaseAutocomplete;
+export declare type CommunityAutocomplete = BaseAutocomplete;

package/lib/src/types/group.d.ts

@@ -0,0 +1,22 @@
+export interface CreateGroup {
+    title: string;
+    description: string;
+    privacy: string;
+    idCategory?: string;
+    type: string;
+    uriCommunity?: string;
+    widgets: Array<string>;
+}
+export declare type GroupWidgets = Record<string, {
+    idWidget: string;
+    title: string;
+    url: string;
+    type: string;
+    icon: string;
+    description: string;
+}>;
+export interface Category {
+    id: string;
+    idorder: number;
+    label: string;
+}

package/lib/src/types/index.d.ts

@@ -0,0 +1,7 @@
+export * from './asei';
+export * from './autocomplete';
+export * from './group';
+export * from './search';
+export * from './utils';
+export * from './taxonomy';
+export * from './user';

package/lib/src/types/listWrapper.d.ts

@@ -0,0 +1,6 @@
+export interface ListWrapper<T> {
+    page?: number;
+    limit?: number;
+    cnt?: number;
+    data: T[];
+}

package/lib/src/types/search.d.ts

@@ -0,0 +1,99 @@
+export interface SearchCategoryModel {
+    id: string;
+    mainType: string;
+    type?: string;
+    title: string;
+    cssclass?: string;
+    active?: boolean;
+    count?: number;
+    typesExcluded: string[];
+    facets: SearchFacetModel[];
+}
+export interface SearchFacetModel {
+    facetType: string;
+    facetOptions: any;
+    field: string;
+    title: string;
+    category?: SearchCategoryModel['id'];
+}
+export interface SearchFacetValueModel {
+    count: number;
+    value: string;
+    title: string;
+}
+/** *
+ * Used in search query to specify a filter
+ * field : name/id of the filter category (ie skills)
+ * value : id of the field (ie react)
+ * exclude : boolean to include or exclude the filter
+ */
+export interface SearchQueryFilterModel {
+    field: string;
+    value: string;
+    exclude: boolean;
+}
+/**
+ * Used in search query to specify a filter
+ * field : name/id of the field to sort
+ * order : desc' | 'asc'
+ */
+export interface SearchQuerySortModel {
+    field: string;
+    order: 'desc' | 'asc';
+}
+/**
+ * facetLimit : max number of facets (default 25)
+ * skipEmptyFacets : remove empty facets (with 0 results)
+ */
+export interface SearchQueryOption {
+    facetLimit: number;
+    skipEmptyFacets: boolean;
+}
+export interface SearchConfig {
+    home: {
+        mode: 'result' | 'category';
+        facets: SearchFacetModel[];
+    };
+    categories: SearchCategoryModel[];
+    viewcard?: Record<string, {
+        name: string;
+        title: string;
+    }[]>;
+}
+export interface SearchResultCatProps {
+    title: string;
+    id: string;
+    showAll?: boolean;
+    results: SearchResultProps[];
+}
+export interface SearchResultProps {
+    title: string;
+    picture: string;
+    uri: string;
+}
+export interface SearchQuery {
+    keywords?: string;
+    category?: string;
+    facetCategories?: boolean;
+    filters?: SearchQueryFilterModel[];
+    page?: number;
+    limit?: number;
+    sort?: SearchQuerySortModel;
+    options?: SearchQueryOption;
+}
+export interface Result {
+    id: number;
+    type: string;
+    uri: string;
+    title: string;
+    mainType: string;
+    _url: string;
+}
+export interface SearchQueryResult {
+    results: Result[];
+    facets: SearchFacetModel[];
+    categories: SearchCategoryModel[];
+}
+export declare type SearchLastQuery = {
+    keywords: string;
+};

package/lib/src/types/taxonomy.d.ts

@@ -0,0 +1,46 @@
+export interface Taxonomy {
+    id: number;
+    type: string;
+    title: string;
+    dateCreation: string;
+    mainTypes: never[];
+    types: null;
+    mandatory: null;
+    public: null;
+    wallFilter: null;
+    jamespot: string;
+    uri: string;
+    mainType: string;
+    _cssColor: string;
+    _cssClass: string;
+    _right: {
+        create: boolean;
+        read: boolean;
+        publish: boolean;
+        administrate: boolean;
+        update: boolean;
+        delete: boolean;
+        comment: boolean;
+        member: boolean;
+    };
+    _values: {
+        type: string;
+        title: string;
+        dateCreation: string;
+        mainTypes: null;
+        types: null;
+        mandatory: null;
+        public: null;
+        wallFilter: null;
+        jamespot: string;
+    };
+    _timezone: {
+        dateCreation: string;
+    };
+    _url: string;
+}
+export interface TaxonomyCreate {
+    type: 'taxonomyClose' | 'taxonomyOpen';
+    title: string;
+    concepts: Array<string>;
+}

package/lib/src/types/user.d.ts

@@ -0,0 +1,14 @@
+export interface UserModel {
+    id: number;
+    title: string;
+    type: string;
+    uri: string;
+    mainType: string;
+    _cssColor: string;
+    _cssClass: string;
+    url: string;
+    firstname: string;
+    lastname: string;
+    company: string;
+    mail: string;
+}

package/lib/src/types/utils.d.ts

@@ -0,0 +1,56 @@
+export interface ApiWrapper<T, U = string[]> {
+    o: string;
+    f: string;
+    error: number;
+    messages: U;
+    errorMsg?: string;
+    result: T;
+}
+export interface PagingResults<T> {
+    cnt: number;
+    data: Array<T>;
+    facets: Array<{}>;
+    idQuery?: number;
+    limit: number;
+    page: number;
+}
+export interface ApiError<U = string> {
+    error: number;
+    messages: U[];
+}
+export interface BaseMessage {
+    msg: string;
+    code: number;
+}
+export declare type BaseMessages = BaseMessage[];
+export declare type BaseMessagesOne = [BaseMessage];
+export declare type Rights = {
+    create: boolean;
+    read: boolean;
+    publish: boolean;
+    administrate: boolean;
+    update: boolean;
+    delete: boolean;
+    comment: boolean;
+    member: boolean;
+};
+export declare type Little = {
+    id: number;
+    type: string;
+    uri: string;
+    title: string;
+    _url: string;
+    dateCreation: string;
+    dateModified: string;
+};
+export declare type Order = {
+    name: string;
+    sort: 'ASC' | 'DESC';
+};
+export declare type Orders = Array<Order>;
+export declare type Filter = {
+    name: string;
+    value: string;
+    operator?: '<' | '>' | '<=' | '>=' | '!=' | '<>' | 'like' | 'between' | 'is' | 'is not' | 'in' | 'link' | 'match';
+};
+export declare type Filters = Array<Filter>;