jamespot-user-api 1.0.62 → 1.0.65

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

@@ -1,47 +0,0 @@
-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/share.d.ts

@@ -1,17 +0,0 @@
-import { ApiWrapper } from '../types';
-import { JBaseApi } from './base';
-import { ShareAccessObject, ShareAccessProps, ShareAccessRequestProps } from '../types/share';
-export declare class JShareApi extends JBaseApi {
-    setObjectAccessRequest(uri: string, idUser: number, requestAccessValue: 'accept' | 'deny', requestResponseMessage?: string): Promise<ApiWrapper<boolean, {
-        code: number;
-        msg: string;
-    }>>;
-    getObjectAccessRequest(uri: string, idUser?: number): Promise<ShareAccessRequestProps[]>;
-    getObject(uri: string): Promise<ShareAccessObject>;
-    askObjectAccess(uri: string, askAccess: 'read' | 'write', askMessage?: string): Promise<boolean>;
-    setObjectAccess(uri: string, access: {
-        read: string[];
-        write: string[];
-    }, message: string, generalAccessRule: string): Promise<boolean>;
-    getObjectAccess(uri: string): Promise<ShareAccessProps>;
-}

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

@@ -1,9 +0,0 @@
-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

@@ -1,29 +0,0 @@
-import { JBaseApi } from './base';
-import { ApiWrapper, Little } from '../types';
-export interface User {
-    idUser: string;
-    type: string;
-    id: string;
-    _values: {
-        mail: string;
-    };
-}
-export declare class JUserApi extends JBaseApi {
-    /**
-     * autocomplete return a list users
-     * @param query <string>
-     */
-    autocomplete(query: string): Promise<User[]>;
-    /**
-     * 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 users.
-     * @param mail Mail or username
-     * @param pwd Password to be validated
-     */
-    signIn(mail: string, pwd: string): Promise<ApiWrapper<User, string[]>>;
-}

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

@@ -1,26 +0,0 @@
-import { ApiWrapper, WedocFileType, WedocQueryResults, WedocQueryType, WedocTemplate } from '../types';
-import { JBaseApi } from './base';
-export declare class JWedocApi extends JBaseApi {
-    getFiles(query: WedocQueryType): Promise<WedocQueryResults>;
-    getFile(idFile: number, hash?: string): Promise<WedocFileType>;
-    getTemplates(): Promise<WedocTemplate[]>;
-    duplicateFile(idFile: number, title: string, publishTo: string[]): Promise<ApiWrapper<boolean, {
-        code: number;
-        msg: string;
-    }>>;
-    deleteFile(idFile: number): Promise<ApiWrapper<boolean, {
-        code: number;
-        msg: string;
-    }>>;
-    createFile(title: string, type: string, publishTo: string[]): Promise<{
-        idFile: number;
-    }>;
-    updateFile(idFile: number, title: string): Promise<ApiWrapper<boolean, {
-        code: number;
-        msg: string;
-    }>>;
-    getFileInfo(idFile: number, mode: string): Promise<ApiWrapper<boolean, {
-        code: number;
-        msg: string;
-    }>>;
-}

package/lib/src/index.d.ts

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

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

@@ -1,28 +0,0 @@
-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

@@ -1,16 +0,0 @@
-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/bookmark.d.ts

@@ -1,14 +0,0 @@
-export declare type Bookmark = {
-    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;
-};

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

@@ -1,12 +0,0 @@
-export declare type FileResponse = {
-    id: string;
-    name: string;
-    type: 'fileTmp';
-    token: string;
-    size: string;
-    mediaKey: string;
-    imagesize: {
-        width: number;
-        height: number;
-    };
-};

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

@@ -1,22 +0,0 @@
-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

@@ -1,11 +0,0 @@
-export * from './asei';
-export * from './autocomplete';
-export * from './bookmark';
-export * from './file';
-export * from './group';
-export * from './search';
-export * from './share';
-export * from './utils';
-export * from './taxonomy';
-export * from './user';
-export * from './wedoc';

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

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

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

@@ -1,99 +0,0 @@
-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/share.d.ts

@@ -1,37 +0,0 @@
-import { Rights } from './utils';
-export declare type ShareAccessObjectAudience = {
-    id: number;
-    uri: string;
-    title: string;
-    type: string;
-};
-export declare type ShareOptionObject = {
-    id: number;
-    title: string;
-    uri: string;
-    idUser: number;
-    _right: Rights;
-};
-export declare type ShareAccessObject = {
-    id: number;
-    type: string;
-    uri: string;
-    title: string;
-    generalAccessRule: 'link' | 'invitation';
-    generalAccessHash: string;
-    idUser: number;
-    _audience: ShareAccessObjectAudience[];
-    _right: Rights;
-    _user: ShareAccessObjectAudience;
-};
-export declare type ShareAccessProps = {
-    audience: ShareAccessObjectAudience[];
-    read: string[];
-    write: string[];
-};
-export declare type ShareAccessRequestProps = {
-    id: number;
-    uri: string;
-    title: string;
-    type: string;
-};

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

@@ -1,46 +0,0 @@
-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

@@ -1,14 +0,0 @@
-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

@@ -1,56 +0,0 @@
-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>;

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

@@ -1,47 +0,0 @@
-import { Filters, Orders, Rights } from './utils';
-export declare type WedocFileType = {
-    dateCreation: string;
-    dateModified: string;
-    id: string;
-    mimetype: string;
-    title: string;
-    type: string;
-    uri: string;
-    _extend: Record<string, string>;
-    _audience: WedocFileAudienceType[];
-    _right: Rights;
-    _user: WedocFileUserType;
-};
-export declare type WedocFileAudienceType = {
-    id: number;
-    title: string;
-    uri: string;
-    type: string;
-};
-export declare type WedocFileUserType = {
-    id: number;
-    title: string;
-    uri: string;
-    type: string;
-};
-export declare type WedocTemplate = {
-    color: string;
-    description: string;
-    extension: string;
-    icon: string;
-    label: string;
-};
-export declare type WedocQueryResults = {
-    page: number;
-    cnt: number;
-    limit: number;
-    data: WedocFileType[];
-};
-export declare type WedocQueryType = {
-    query: string;
-    filters: Filters;
-    orders: Orders;
-    page: number;
-    limit: number;
-};
-export declare type WedocEmptyType = {};

package/lib/src/util/network.d.ts

@@ -1,23 +0,0 @@
-import { ApiWrapper, FileResponse } from '../types';
-import { FetchReturnType, WindowInterface } from '../window/Window';
-export interface OF {
-    o: string;
-    f: string;
-}
-/**
- * deprecated
- */
-export declare class Network {
-    private readonly action;
-    private readonly window;
-    constructor(window: WindowInterface, action?: string);
-    static _formatPostOptions(body: object): RequestInit;
-    static _formatQueryOptions(options: Record<string, string | boolean | number>): string;
-    getUrl(o: string, f: string): Promise<string>;
-    fetch({ o, f, ...body }: OF, signal?: AbortSignal): FetchReturnType;
-    post<T, U = string[]>(body: OF, signal?: AbortSignal): Promise<ApiWrapper<T, U>>;
-    postFile(body: FormData): Promise<FileResponse>;
-    postCSRF<T, U = string[]>(body: OF): Promise<ApiWrapper<T, U>>;
-    token(): Promise<ApiWrapper<string>>;
-    tokenCSRF(): Promise<ApiWrapper<string>>;
-}

package/lib/src/util/promise.d.ts

@@ -1 +0,0 @@
-export declare function wait<T>(obj: T, timeout?: number): Promise<T>;

package/lib/src/window/Window.d.ts

@@ -1,7 +0,0 @@
-export declare type FetchReturnType = Promise<{
-    json: () => unknown;
-}>;
-export interface WindowInterface {
-    getBackendUrl: () => Promise<string>;
-    fetch: (url: string, init?: RequestInit) => FetchReturnType;
-}

package/lib/src/window/WindowBrowser.d.ts

@@ -1,5 +0,0 @@
-import { WindowInterface } from './Window';
-export declare class WindowBrowser implements WindowInterface {
-    getBackendUrl(): Promise<string>;
-    fetch(url: string, init?: RequestInit): Promise<Response>;
-}

package/lib/src/window/WindowJestFetch.d.ts

@@ -1,6 +0,0 @@
-import { FetchReturnType, WindowInterface } from './Window';
-export declare class WindowJestFetch implements WindowInterface {
-    cookie?: string;
-    getBackendUrl(): Promise<string>;
-    fetch(url: string, init?: RequestInit): FetchReturnType;
-}

package/lib/src/window/WindowMobile.d.ts

@@ -1,9 +0,0 @@
-import { FetchReturnType, WindowInterface } from './Window';
-export declare class WindowMobile implements WindowInterface {
-    private token;
-    private readonly backendUrl;
-    constructor(backUrl: string);
-    getBackendUrl(): Promise<string>;
-    setToken(token: string): void;
-    fetch(url: string, { headers, ...init }?: RequestInit): FetchReturnType;
-}

package/lib/src/window/WindowMock.d.ts

@@ -1,16 +0,0 @@
-import { FetchReturnType, WindowInterface } from './Window';
-export declare class WindowMock implements WindowInterface {
-    /**
-     * The data object is a 2 level record:
-     *   - the first key is the "o" parameter
-     *   - the second level key is the "f" parameter.
-     * The value can be :
-     *   - the direct json value of the api call
-     *   - a method which mimics the api call
-     */
-    private readonly data;
-    constructor();
-    getBackendUrl(): Promise<string>;
-    private static unwrap;
-    fetch(url: string, init?: RequestInit): FetchReturnType;
-}