jamespot-user-api 1.0.180 → 1.0.182

package/lib/jest.config.d.ts

@@ -14,7 +14,6 @@ declare const Config: {
             functions: number;
         };
     };
-    coveragePathIgnorePatterns: string[];
     moduleNameMapper: {
         '^@phpunitMock/(.*)$': string;
     };

package/lib/jest.config.vm.d.ts

@@ -17,6 +17,5 @@ declare const ConfigVM: {
             functions: number;
         };
     };
-    coveragePathIgnorePatterns: string[];
 };
 export default ConfigVM;

package/lib/src/apis/admin/utils.d.ts

@@ -12,9 +12,9 @@ export declare class AdminUtilsApi extends JBaseApi {
         url?: string | undefined;
         state?: string | undefined;
         tabs?: {
-            idDiv: string;
             label: string;
             icon: string;
+            idDiv: string;
             href?: string | undefined;
             sref?: string | undefined;
             licenseMode?: "classic" | undefined;

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

@@ -15,7 +15,9 @@ export declare class JArticleApi extends JBaseApi {
     create<R extends jArticleLittle = jArticleLittle, P extends ArticleCreation = ArticleCreation>(article: MaybeWithToken<P>, format?: FormatList): Promise<ApiWrapper<Array<R>, BaseMessages>>;
     update<T extends {
         uri: string;
-    }, U extends jArticleLittle = jArticleList>(article: T): Promise<ApiWrapper<U, BaseMessages>>;
+    }, U extends jArticleLittle = jArticleList>(article: T, options?: {
+        format?: FormatList;
+    }): Promise<ApiWrapper<U, BaseMessages>>;
     delete(id: number): Promise<ApiWrapper<boolean, BaseMessages>>;
     count(type: string): Promise<ApiWrapper<number>>;
     getAttachments(id: number, type: string, format?: FormatList): Promise<ApiWrapper<jFileLittle[]>>;

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

@@ -1,4 +1,4 @@
-import { ApiWrapper, FileCropConfig, UploadConfig, jObjectLittle, jArticleLittle, jFileLittle, UserDownload, FormatList, FileCopyParams } from '../../types';
+import { ApiWrapper, FileCropConfig, UploadConfig, jObjectLittle, jFileLittle, UserDownload, FormatList, FileCopyParams } from '../../types';
 import { JBaseApi } from '../base';
 export declare class JFileApi extends JBaseApi {
     /**
@@ -44,7 +44,7 @@ export declare class JFileApi extends JBaseApi {
         token: string;
     }[]>;
     get<T extends jFileLittle>(idFile: number, format?: FormatList): Promise<ApiWrapper<T>>;
-    getParent<T extends jArticleLittle>(idFile: number, format?: FormatList): Promise<ApiWrapper<T>>;
+    getParent<T extends jObjectLittle>(idFile: number, format?: FormatList): Promise<ApiWrapper<T>>;
     getWithHash<T extends jFileLittle>(idFile: number, hash: string, format?: FormatList): Promise<ApiWrapper<T>>;
     duplicate(idFile: number, title: string, publishTo?: string[]): Promise<ApiWrapper<{
         idFile: number;

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

@@ -3,7 +3,7 @@ import { jObjectLittle } from '../../types/objectBase';
 import { Rights } from '../../types/common';
 import { jArticleLittle, jArticleView, jFolderList } from '../../types/article';
 import { ApiPagingResults, ApiWrapper, FormatList } from '../../types/utils';
-import { jGroupList } from '../../types/group';
+import { jGroupLittle } from '../../types/group';
 import { jObjectList } from '../../types/object';
 export interface RootFolderProps {
     id: number;
@@ -24,7 +24,7 @@ export interface SpotProps {
 export interface FileBankProps {
     recents: jObjectList[];
     rootFolder: jFolderList;
-    spot: jGroupList;
+    spot: jGroupLittle;
 }
 export interface FolderProps extends jObjectLittle {
     mainType: string;

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

@@ -1,4 +1,4 @@
-import { Category, CreateGroup, GroupList, GroupListConfig, GroupProperties, GroupUserLevel, GroupView, GroupWidget, ResetNotificationConfiguration, UpdateGroup, UserLevelAndRight } from '../../types/group';
+import { CreateGroup, jGroupList, GroupListConfig, GroupUserLevel, ResetNotificationConfiguration, UpdateGroup, UserLevelAndRight } from '../../types/group';
 import { JBaseApi } from '../base';
 import { ApiReturn, ApiWrapper, BaseMessages, FormatList, jObjectLittle, jUserLittle, PagingResults } from '../../types';
 export declare class JGroupApi extends JBaseApi {
@@ -13,11 +13,11 @@ export declare class JGroupApi extends JBaseApi {
         uri: string;
         title: string;
         name: string;
+        class: string;
         label: string;
         shortUri: string;
         cssClass: string;
         cssColor: string;
-        class: string;
         idspot: string;
     }[]>;
     /**
@@ -26,36 +26,245 @@ export declare class JGroupApi extends JBaseApi {
      * @param format return format
      * @returns
      */
-    create<T extends FormatList = undefined>(group: CreateGroup, format?: T): Promise<ApiWrapper<ApiReturn<T, jObjectLittle, GroupList, GroupView, jObjectLittle>, BaseMessages>>;
+    create<T extends FormatList = undefined>(group: CreateGroup, format?: T): Promise<ApiWrapper<ApiReturn<T, jObjectLittle, {
+        type: string;
+        id: number;
+        mainType: string;
+        uri: string;
+        dateCreation: string;
+        dateModified: string;
+        title: string;
+        _url: string;
+        description: string;
+        language: string;
+        privacy: number;
+        edito: string | null;
+        category: number;
+    }, {
+        type: string;
+        id: number;
+        mainType: string;
+        uri: string;
+        dateCreation: string;
+        dateModified: string;
+        title: string;
+        _url: string;
+        description: string;
+        language: string;
+        privacy: number;
+        edito: string | null;
+        category: number;
+        image?: string | null | undefined;
+        idCommunity?: string | undefined;
+        useTeaser?: "" | "0" | "1" | null | undefined;
+        spotBanner?: never[] | Record<string, {
+            id: string;
+            size: string;
+            name: string;
+        }> | undefined;
+    }, jObjectLittle>, BaseMessages>>;
     /**
      * Update a group
      * @param group group to update. The uri is mandatory and identify the group to update
      * @param format return format
      * @returns
      */
-    update<T extends FormatList = undefined>(group: UpdateGroup, format?: T): Promise<ApiWrapper<ApiReturn<T, jObjectLittle, GroupList, GroupView, string>, BaseMessages>>;
+    update<T extends FormatList = undefined>(group: UpdateGroup, format?: T): Promise<ApiWrapper<ApiReturn<T, jObjectLittle, {
+        type: string;
+        id: number;
+        mainType: string;
+        uri: string;
+        dateCreation: string;
+        dateModified: string;
+        title: string;
+        _url: string;
+        description: string;
+        language: string;
+        privacy: number;
+        edito: string | null;
+        category: number;
+    }, {
+        type: string;
+        id: number;
+        mainType: string;
+        uri: string;
+        dateCreation: string;
+        dateModified: string;
+        title: string;
+        _url: string;
+        description: string;
+        language: string;
+        privacy: number;
+        edito: string | null;
+        category: number;
+        image?: string | null | undefined;
+        idCommunity?: string | undefined;
+        useTeaser?: "" | "0" | "1" | null | undefined;
+        spotBanner?: never[] | Record<string, {
+            id: string;
+            size: string;
+            name: string;
+        }> | undefined;
+    }, string>, BaseMessages>>;
     /**
      * Get a spot
      * @param idSpot
      * @param format
      * @returns
      */
-    getSpot<T extends FormatList = undefined>(idSpot: number | string, format?: T): Promise<ApiWrapper<ApiReturn<T, jObjectLittle, GroupList, GroupView, string>, BaseMessages>>;
+    getSpot<T extends FormatList = undefined>(idSpot: number | string, format?: T): Promise<ApiWrapper<ApiReturn<T, jObjectLittle, {
+        type: string;
+        id: number;
+        mainType: string;
+        uri: string;
+        dateCreation: string;
+        dateModified: string;
+        title: string;
+        _url: string;
+        description: string;
+        language: string;
+        privacy: number;
+        edito: string | null;
+        category: number;
+    }, {
+        type: string;
+        id: number;
+        mainType: string;
+        uri: string;
+        dateCreation: string;
+        dateModified: string;
+        title: string;
+        _url: string;
+        description: string;
+        language: string;
+        privacy: number;
+        edito: string | null;
+        category: number;
+        image?: string | null | undefined;
+        idCommunity?: string | undefined;
+        useTeaser?: "" | "0" | "1" | null | undefined;
+        spotBanner?: never[] | Record<string, {
+            id: string;
+            size: string;
+            name: string;
+        }> | undefined;
+    }, string>, BaseMessages>>;
     /**
      * Get the properties of a group that are not within the model
      * @param idSpot
      * @returns
      */
-    getProperties(idSpot: number | string): Promise<ApiWrapper<GroupProperties, BaseMessages>>;
+    getProperties(idSpot: number | string): Promise<ApiWrapper<{
+        edit_access: "" | "author";
+        commentLevel: "1" | "-1" | "2" | "3";
+        displayType: string;
+        user_level_signup: "" | "1" | "2" | "3";
+        spot_right_user: string;
+        useTeaser: "" | "0" | "1" | null;
+        spotDefaultPublishType: string;
+        mail_frequency: string;
+        widgets: string[];
+        fileSyncVersioningType: "overwrite" | "author-change";
+        nounsubscribe: "0" | "1";
+        rss_feed: {
+            url: string;
+            idUser: number;
+            date?: string | undefined;
+            send?: boolean | undefined;
+            _user?: jUserLittle | undefined;
+            error?: string | undefined;
+        }[] | null;
+        mail_comment: "" | "1";
+        mail_spotit: "" | "1";
+        mail_subscriber: "" | "1";
+        lock_mail: "" | "1";
+        activity: "0" | "1";
+        publishFolder: "0" | "1";
+        notifyFolder: "0" | "1";
+        rss_access: "0" | "1";
+        rss_key: string;
+        fileSyncEnabled: "0" | "1";
+        fileBankQuota: string;
+        _options: {
+            edit_access: ({
+                value: string | number;
+                label: string;
+            } & {
+                description: string;
+            })[];
+            commentLevel: ({
+                value: string | number;
+                label: string;
+            } & {
+                selected?: boolean | undefined;
+            })[];
+            displayType: {
+                value: string | number;
+                label: string;
+            }[];
+            user_level_signup: ({
+                value: string | number;
+                label: string;
+            } & {
+                selected?: boolean | undefined;
+            })[];
+            spot_right_user: ({
+                value: string | number;
+                label: string;
+            } & {
+                selected?: boolean | undefined;
+            })[];
+            useTeaser: {
+                value: string | number;
+                label: string;
+            }[];
+            spotDefaultPublishType: string[];
+            mail_frequency: {
+                value: string | number;
+                label: string;
+            }[];
+            widgets: {
+                id: string;
+                title: string;
+            }[];
+            custom_widgets: never[] | Record<string, {
+                type: string;
+                title: string;
+                url: string;
+                idSpot: string;
+                idOrder: string;
+                idWidget: string;
+                visible: string;
+            }>;
+            isArchive: number;
+            fileSyncVersioningType: {
+                value: string | number;
+                label: string;
+            }[];
+        };
+        _errors: [];
+        lastRssExecution?: Record<string, string> | undefined;
+    }, BaseMessages>>;
     /**
      * Get the available applications that can be added to a group
      */
-    getApplications(): Promise<ApiWrapper<Record<string, GroupWidget>, BaseMessages>>;
+    getApplications(): Promise<ApiWrapper<Record<string, {
+        type: string;
+        title: string;
+        url: string;
+        description: string;
+        idWidget: string;
+        icon: string;
+    }>, BaseMessages>>;
     /**
      * Get the available group categories
      * @returns
      */
-    getCategories(): Promise<ApiWrapper<Category[], BaseMessages>>;
+    getCategories(): Promise<ApiWrapper<{
+        id: string;
+        label: string;
+        idorder: number;
+    }[], BaseMessages>>;
     /**
      * Get the members of a group
      * @param idSpot spot id
@@ -68,7 +277,7 @@ export declare class JGroupApi extends JBaseApi {
         level: GroupUserLevel;
         user: jUserLittle;
     }>, BaseMessages>>;
-    list<T extends GroupList = GroupList>(config: GroupListConfig): Promise<ApiWrapper<PagingResults<T>>>;
+    list<T extends jGroupList = jGroupList>(config: GroupListConfig): Promise<ApiWrapper<PagingResults<T>>>;
     /**
      * Reset the notifications configuration for all users of the group
      * @param config configuration

package/lib/src/apis/group/group.mock.d.ts

@@ -1,10 +1,10 @@
-import { ApiDefaultWrapper, ApiPagingResults, ApiWrapper, jSpotAutocomplete, UserLevelAndRight } from '../../types';
-import { Category, GroupMemberLevel, GroupProperties, GroupView, GroupWidget, jGroupList } from '../../types/group';
-export declare const spot: ApiWrapper<GroupView>;
+import { ApiDefaultWrapper, ApiPagingResults, ApiWrapper, jGroupLittle, jGroupView, jSpotAutocomplete, UserLevelAndRight } from '../../types';
+import { Category, GroupMemberLevel, GroupProperties, GroupWidget } from '../../types/group';
+export declare const spot: ApiWrapper<jGroupView>;
 export declare const properties: ApiWrapper<GroupProperties>;
 export declare const groupAutocompleteA: ApiWrapper<jSpotAutocomplete[]>;
-export declare const groupCreate: ApiWrapper<GroupView>;
-export declare const groupUpdate: ApiWrapper<GroupView>;
+export declare const groupCreate: ApiWrapper<jGroupView>;
+export declare const groupUpdate: ApiWrapper<jGroupView>;
 export declare const groupGetAvailableWidget: ApiWrapper<Record<string, GroupWidget>>;
 export declare const groupGetCategories: ApiWrapper<Category[]>;
 export declare const groupGetUserLevelAndRight: ApiWrapper<UserLevelAndRight>;
@@ -15,7 +15,7 @@ export declare const groupAddToFavoriteSuccess: ApiWrapper<boolean>;
 export declare const groupAddToFavoriteForbidden: ApiDefaultWrapper;
 export declare const groupAddToFavoriteBad: ApiDefaultWrapper;
 export declare const groupObjectListJamespotSpotMembers: ApiPagingResults<GroupMemberLevel>;
-export declare const groupList: ApiPagingResults<jGroupList>;
+export declare const groupList: ApiPagingResults<jGroupLittle>;
 export declare const groupResetNotification: ApiWrapper<{
     members: number;
     msg: string;

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

@@ -1,34 +1,5 @@
 import { JBaseApi } from '../base';
-import { ApiWrapper, jArticleList, License, MaybeWithToken, PagingResults } from '../../types';
-import { ArticleCreation } from '../../types/article';
-export type JLandLog = {
-    idLog: number;
-    slug: string;
-    dateCreation: string;
-    map: string;
-    mail: string;
-    action: string;
-    mode: string;
-};
-export type JLandStat = {
-    mail: string;
-    cnt: string;
-};
-export type JLandMapFlavor = string;
-export type JLandMapKind = string;
-export type JLandMap = jArticleList & {
-    jlandMapFlavor: JLandMapFlavor;
-    jlandMapKind: JLandMapKind;
-    waMapUrl?: string;
-    limit?: number;
-    _extend: {
-        licenses: Array<License>;
-    };
-};
-export type JLandMapCreation = ArticleCreation & {
-    jlandMapAggregated: string;
-    type: 'jlandmap';
-};
+import { ApiWrapper, JLandLog, JLandMap, JLandMapCreation, JLandMapList, JLandMapLittle, JLandMapView, JLandStat, MaybeWithToken, PagingResults } from '../../types';
 export declare class JLandApi extends JBaseApi {
     getLogs({ dateEnd, idLogMax, }: {
         dateEnd?: string;
@@ -40,5 +11,5 @@ export declare class JLandApi extends JBaseApi {
         dateEnd?: string;
     }): Promise<ApiWrapper<Array<JLandStat>>>;
     getAllMapsAsAdmin(format?: string): Promise<ApiWrapper<PagingResults<JLandMap>>>;
-    createMap(map: MaybeWithToken<JLandMapCreation>, format?: string): Promise<ApiWrapper<unknown, import("../../types").BaseMessages>>;
+    createMap<T extends JLandMapLittle | JLandMapList | JLandMapView = JLandMapList>(map: MaybeWithToken<JLandMapCreation>, format?: string): Promise<ApiWrapper<T[]>>;
 }

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

@@ -1,5 +1,6 @@
-import { ApiWrapper } from '../../types';
-import { JLandLog, JLandStat } from './jland';
+import { ApiWrapper, JLandLog, JLandMap, JLandMapList, JLandStat, PagingResults } from '../../types';
 export declare const jLandAdminLogsEmpty: ApiWrapper<Array<JLandLog>>;
 export declare const jLandAdminLogsFull: ApiWrapper<Array<JLandLog>>;
 export declare const jLandAdminStatsEmpty: ApiWrapper<Array<JLandStat>>;
+export declare const jLandGetAllMapsAsAdmin: ApiWrapper<PagingResults<JLandMap>>;
+export declare const jLandCreateMap: ApiWrapper<JLandMapList[]>;

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

@@ -19,11 +19,11 @@ export declare class JTaxonomyApi extends JBaseApi {
         uri: string;
         title: string;
         name: string;
+        class: string;
         label: string;
         shortUri: string;
         cssClass: string;
         cssColor: string;
-        class: string;
     }[], import("../../types").BaseMessages>>;
     autocompleteList<T = jObjectAutocomplete>({ format, ...payload }: AutoCompleteList): Promise<ApiWrapper<PagingResults<T>, import("../../types").BaseMessages>>;
     autocompleteHierarchy(payload: AutocompleteHierarchy): Promise<ApiWrapper<PagingResults<{
@@ -33,10 +33,10 @@ export declare class JTaxonomyApi extends JBaseApi {
         uri: string;
         title: string;
         name: string;
+        class: string;
         label: string;
         shortUri: string;
         cssClass: string;
         cssColor: string;
-        class: string;
     }>, import("../../types").BaseMessages>>;
 }