jamespot-user-api 1.0.109 → 1.0.111

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

@@ -1,5 +1,5 @@
 import { JBaseApi } from '../base';
-import { ApiWrapper, BaseMessages, Filters, jArticleLittle, jArticleView, MaybeWithToken, Orders, PagingResults } from '../../types';
+import { ApiWrapper, BaseMessages, Filters, jArticleList, jArticleLittle, MaybeWithToken, Orders, PagingResults } from '../../types';
 export declare type ArticleListConfig = {
     type: string;
     format?: string;
@@ -37,7 +37,7 @@ export declare class JArticleApi extends JBaseApi {
     create<T extends jArticleLittle = jArticleLittle>(article: MaybeWithToken<ArticleCreation>, format?: string): Promise<ApiWrapper<Array<T>, BaseMessages>>;
     update<T extends {
         uri: string;
-    }, U extends jArticleView>(article: T): Promise<ApiWrapper<U, BaseMessages>>;
+    }, U extends jArticleLittle = jArticleList>(article: T): Promise<ApiWrapper<U, BaseMessages>>;
     delete(id: number): Promise<ApiWrapper<boolean, BaseMessages>>;
     count(type: string): Promise<ApiWrapper<number>>;
 }

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

@@ -10,25 +10,7 @@ export interface ListFilterSpec {
 export declare class JBookmarkApi extends JBaseApi {
     getFormattedList<T extends keyof BookmarkTypes>(filterSpecs: ListFilterSpec, format: T): Promise<ApiWrapper<PagingResults<BookmarkTypes[T]>, import("../../types").BaseMessages>>;
     addFormattedLink<T extends keyof BookmarkTypes>(targetId: number, targetType: string, format: T): Promise<ApiWrapper<BookmarkTypes[T], import("../../types").BaseMessages>>;
-    addBookmark(bookmark: Pick<BookmarkTypes[keyof BookmarkTypes], 'bookmarkLabel' | 'bookmarkMeta' | 'bookmarkUrl'>, format?: keyof BookmarkTypes): Promise<ApiWrapper<import("../../types").BookmarkRawList<{
-        id: number;
-        mainType: string;
-        type: string;
-        uri: string;
-        dateCreation?: string;
-        dateModified?: string;
-        title: string;
-        _url: string;
-    } | import("../../types").jUserLittle> | import("../../types").BookmarkList<{
-        id: number;
-        mainType: string;
-        type: string;
-        uri: string;
-        dateCreation?: string;
-        dateModified?: string;
-        title: string;
-        _url: string;
-    }>, BaseMessagesOne>>;
+    addBookmark(bookmark: Pick<BookmarkTypes[keyof BookmarkTypes], 'bookmarkLabel' | 'bookmarkMeta' | 'bookmarkUrl'>, format?: keyof BookmarkTypes): Promise<ApiWrapper<import("../../types").BookmarkRawList<import("../../types").jObjectLittle | import("../../types").jUserLittle> | import("../../types").BookmarkList<import("../../types").jObjectLittle>, BaseMessagesOne>>;
     delete(bookmarkId: number): Promise<ApiWrapper<null, BaseMessagesOne>>;
     rename(bookmarkID: number, bookmarkLabel: string, bookmarkUrl?: string): Promise<ApiWrapper<null, BaseMessagesOne>>;
     move(bookmarkID: number, bookmarkReference: number, position: 'before' | 'after'): Promise<ApiWrapper<null, BaseMessagesOne>>;

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

@@ -1,43 +1,7 @@
-import { ApiReturn, CommunityAutocomplete, Format } from '../types';
+import { ApiReturn, CommunityAutocomplete, Format, jObjectLittle } from '../types';
 import { JBaseApi } from './base';
 export declare class JCommunityApi extends JBaseApi {
-    get<T extends Format = undefined>(idCommunity: string | number, format?: T): Promise<import("../types").ApiWrapper<ApiReturn<T, {
-        id: number;
-        mainType: string;
-        type: string;
-        uri: string;
-        dateCreation?: string;
-        dateModified?: string;
-        title: string;
-        _url: string;
-    }, {
-        id: number;
-        mainType: string;
-        type: string;
-        uri: string;
-        dateCreation?: string;
-        dateModified?: string;
-        title: string;
-        _url: string;
-    }, {
-        id: number;
-        mainType: string;
-        type: string;
-        uri: string;
-        dateCreation?: string;
-        dateModified?: string;
-        title: string;
-        _url: string;
-    }, {
-        id: number;
-        mainType: string;
-        type: string;
-        uri: string;
-        dateCreation?: string;
-        dateModified?: string;
-        title: string;
-        _url: string;
-    }>, import("../types").BaseMessages>>;
+    get<T extends Format = undefined>(idCommunity: string | number, format?: T): Promise<import("../types").ApiWrapper<ApiReturn<T, jObjectLittle, jObjectLittle, jObjectLittle, jObjectLittle>, import("../types").BaseMessages>>;
     sendRequest(message: string, idUserTo: number): Promise<import("../types").ApiWrapper<boolean, {
         code: number;
         msg: string;

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

@@ -51,7 +51,7 @@ export declare class JFileApi extends JBaseApi {
      * @param token token
      * @returns
      */
-    deleteFile(idFile: number | string, attrName: string, token: string): Promise<import("../types").ApiWrapper<"", import("../types").BaseMessages>>;
+    deleteFile(idFile: number | string, attrName: string, token: string, signal?: AbortSignal): Promise<import("../types").ApiWrapper<"", import("../types").BaseMessages>>;
     /**
      * delete the image associated with a content. This action is permanent. There is no two step process with a token
      * @param id content id

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

@@ -1,64 +1,33 @@
-import { Category, CreateGroup, GroupList, GroupProperties, GroupView, GroupWidget, ResetNotificationConfiguration, UpdateGroup } from './group.types';
+import { Category, CreateGroup, GroupList, GroupProperties, GroupView, GroupWidget, ResetNotificationConfiguration, UpdateGroup } from '../../types/group';
 import { JBaseApi } from '../base';
-import { ApiReturn, Format, PagingResults } from '../../types';
+import { ApiReturn, Format, PagingResults, jObjectLittle, jSpotAutocomplete } from '../../types';
 export declare class JGroupApi extends JBaseApi {
+    /**
+     * autocomplete return a list of groups
+     * @param query <string>
+     */
+    autocomplete(query: string): Promise<jSpotAutocomplete[]>;
     /**
      * Create a group from scratch
      * @param group
      * @param format return format
      * @returns
      */
-    create<T extends Format = undefined>(group: CreateGroup, format?: T): Promise<import("../../types").ApiWrapper<ApiReturn<T, {
-        id: number;
-        mainType: string;
-        type: string;
-        uri: string;
-        dateCreation?: string;
-        dateModified?: string;
-        title: string;
-        _url: string;
-    }, GroupList, GroupView, {
-        id: number;
-        mainType: string;
-        type: string;
-        uri: string;
-        dateCreation?: string;
-        dateModified?: string;
-        title: string;
-        _url: string;
-    }>, import("../../types").BaseMessages>>;
+    create<T extends Format = undefined>(group: CreateGroup, format?: T): Promise<import("../../types").ApiWrapper<ApiReturn<T, jObjectLittle, GroupList, GroupView, jObjectLittle>, import("../../types").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 Format = undefined>(group: UpdateGroup, format?: T): Promise<import("../../types").ApiWrapper<ApiReturn<T, {
-        id: number;
-        mainType: string;
-        type: string;
-        uri: string;
-        dateCreation?: string;
-        dateModified?: string;
-        title: string;
-        _url: string;
-    }, GroupList, GroupView, string>, import("../../types").BaseMessages>>;
+    update<T extends Format = undefined>(group: UpdateGroup, format?: T): Promise<import("../../types").ApiWrapper<ApiReturn<T, jObjectLittle, GroupList, GroupView, string>, import("../../types").BaseMessages>>;
     /**
      * Get a spot
      * @param idSpot
      * @param format
      * @returns
      */
-    getSpot<T extends Format = undefined>(idSpot: number | string, format?: T): Promise<import("../../types").ApiWrapper<ApiReturn<T, {
-        id: number;
-        mainType: string;
-        type: string;
-        uri: string;
-        dateCreation?: string;
-        dateModified?: string;
-        title: string;
-        _url: string;
-    }, GroupList, GroupView, string>, import("../../types").BaseMessages>>;
+    getSpot<T extends Format = undefined>(idSpot: number | string, format?: T): Promise<import("../../types").ApiWrapper<ApiReturn<T, jObjectLittle, GroupList, GroupView, string>, import("../../types").BaseMessages>>;
     /**
      * Get the properties of a group that are not within the model
      * @param idSpot
@@ -82,16 +51,7 @@ export declare class JGroupApi extends JBaseApi {
      * @param page page number
      * @return array of User
      */
-    getObjectListJamespotSpotMembers(idSpot: number | string, query?: string, limit?: number, page?: number): Promise<import("../../types").ApiWrapper<PagingResults<{
-        id: number;
-        mainType: string;
-        type: string;
-        uri: string;
-        dateCreation?: string;
-        dateModified?: string;
-        title: string;
-        _url: string;
-    }>, import("../../types").BaseMessages>>;
+    getObjectListJamespotSpotMembers(idSpot: number | string, query?: string, limit?: number, page?: number): Promise<import("../../types").ApiWrapper<PagingResults<jObjectLittle>, import("../../types").BaseMessages>>;
     /**
      * Reset the notifications configuration for all users of the group
      * @param config configuration

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

@@ -1,4 +1,5 @@
-import { ApiWrapper } from '../../types';
-import { GroupProperties, GroupView } from './group.types';
+import { ApiWrapper, jSpotAutocomplete } from '../../types';
+import { GroupProperties, GroupView } from '../../types/group';
 export declare const spot: ApiWrapper<GroupView>;
 export declare const properties: ApiWrapper<GroupProperties>;
+export declare const groupAutocompleteA: ApiWrapper<jSpotAutocomplete[]>;

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

@@ -1,2 +1,2 @@
 export * from './group';
-export * from './group.types';
+export * from '../../types/group';

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

@@ -18,4 +18,5 @@ export * from './search/search';
 export * from './share/share';
 export * from './user/user';
 export * from './taxonomy';
+export * from './tvDisplay/tvDisplay';
 export * from './wedoc/wedoc';

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

@@ -19,6 +19,7 @@ import { JTaxonomyApi } from './taxonomy';
 import { JUserApi } from './user/user';
 import { JWedocApi } from './wedoc/wedoc';
 import { Network } from '../util/network';
+import { TVDisplayApi } from './tvDisplay/tvDisplay';
 import { JShareApi } from './share/share';
 /**
  * In browser usage, 'window' should be the window object.
@@ -53,6 +54,7 @@ export declare class JamespotUserApi {
     search: JSearchApi;
     share: JShareApi;
     taxonomy: JTaxonomyApi;
+    tvDisplay: TVDisplayApi;
     user: JUserApi;
     wedoc: JWedocApi;
     constructor(network: Network);

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

@@ -0,0 +1,12 @@
+import { JBaseApi } from '../base';
+import { ApiWrapper, BaseMessages, MaybeWithToken, TVChannelCreation, TVChannelList, TVChannelLittle, TVGetChannelResponse, TVGetConfigureChannelResponse } from '../../types';
+export declare class TVDisplayApi extends JBaseApi {
+    createChannel<R extends TVChannelLittle = TVChannelList>(channel: MaybeWithToken<TVChannelCreation>, format?: string): Promise<ApiWrapper<Array<R>, BaseMessages>>;
+    getChannel(params: {
+        id: number;
+        key: string;
+    }): Promise<ApiWrapper<TVGetChannelResponse, BaseMessages>>;
+    getConfigureChannel(params: {
+        id: number;
+    }): Promise<ApiWrapper<TVGetConfigureChannelResponse, BaseMessages>>;
+}

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

@@ -0,0 +1,7 @@
+import { ApiWrapper, TVChannelList, TVGetChannelResponse, TVGetConfigureChannelResponse } from '../../types';
+export declare const tvDisplayGetChannelDynamic: ApiWrapper<TVGetChannelResponse>;
+export declare const tvDisplayGetChannelSlideshow: ApiWrapper<TVGetChannelResponse>;
+export declare const tvDisplayCreateChannelDynamic: ApiWrapper<TVChannelList[]>;
+export declare const tvDisplayCreateChannelSlideshow: ApiWrapper<TVChannelList[]>;
+export declare const tvDisplayGetConfigureChannelDynamic: ApiWrapper<TVGetConfigureChannelResponse>;
+export declare const tvDisplayGetConfigureChannelSlideshow: ApiWrapper<TVGetConfigureChannelResponse>;

package/lib/src/apis/tvDisplay/tvDisplay.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -1,5 +1,5 @@
 import { JBaseApi } from '../base';
-import { ApiWrapper, Little, jObjectLittle, UserModel, UserMapModel, jUserAutocomplete, ApiPagingResults, ApiDefaultWrapper, jUserLittle } from '../../types';
+import { ApiWrapper, Little, jObjectLittle, UserModel, UserMapModel, jUserAutocomplete, ApiPagingResults, ApiDefaultWrapper, jUserLittle, Readable } from '../../types';
 export declare type User = Little & {
     id: string;
     shortUri: string;
@@ -66,11 +66,14 @@ export declare class JUserApi extends JBaseApi {
      */
     get<T extends jObjectLittle = jObjectLittle>(uri: string, format?: string): Promise<ApiWrapper<T>>;
     configuration(): Promise<ApiWrapper<UserDirectoryConfiguration>>;
+    userList<T extends jObjectLittle = jUserLittle>(payload: ObjectListProps, signal?: AbortSignal): Promise<ApiPagingResults<T>>;
     userQueryList<T extends jObjectLittle = jUserLittle>(payload: ObjectListProps): Promise<ApiPagingResults<T>>;
     userMap(payload: ObjectListProps): Promise<ApiPagingResults<UserMapModel>>;
     userBusinessContactQueryList(query: ObjectListProps): Promise<ApiPagingResults<UserModel>>;
     userCreateBusinessContact(user: BusinessContact): Promise<ApiWrapper<import("../../types").jArticleLittle[], import("../../types").BaseMessages>>;
-    userUpdateBusinessContact(user: BusinessContact): Promise<ApiWrapper<import("../../types").jArticleView, import("../../types").BaseMessages>>;
+    userUpdateBusinessContact(user: Readable<BusinessContact & {
+        uri: string;
+    }>): Promise<ApiWrapper<import("../../types").jArticleList, import("../../types").BaseMessages>>;
     userDeleteBusinessContact(idArticle: number): Promise<ApiWrapper<boolean, import("../../types").BaseMessages>>;
     userAddContact(idUser: number): Promise<ApiDefaultWrapper>;
     userRemoveContact(idUser: number): Promise<ApiDefaultWrapper>;

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

@@ -3,6 +3,7 @@ import { UserDirectoryConfiguration } from './user';
 export declare const userAutocompleteA: ApiWrapper<jUserAutocomplete[]>;
 export declare const userGetUser1: ApiWrapper<jUserView>;
 export declare const userDirectoryConfigurationDefault: ApiWrapper<UserDirectoryConfiguration>;
+export declare const userListRawList: ApiPagingResults<jUserList>;
 export declare const userQueryListRawList: ApiPagingResults<jUserList>;
 export declare const userMapDefault: ApiPagingResults<UserMapModel>;
 export declare const userAddContactDefault: ApiDefaultWrapper;

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

@@ -0,0 +1,11 @@
+import { jUserLittle } from './user';
+import { Readable, Rights, jObjectBase } from './utils';
+export declare type jCommentLittle = Readable<Omit<jObjectBase, 'dateModified'> & {
+    dateCreation: string;
+    dateModified: string | null;
+    description: string | null;
+    _user: jUserLittle;
+}>;
+export declare type jCommentList = jCommentLittle & {
+    _right: Rights;
+};

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

@@ -1,3 +1,4 @@
+import { Readable, jObjectLittle } from './utils';
 export declare type UploadConfig = {
     attrName: string;
     token: string;
@@ -28,3 +29,7 @@ export declare type FileCropConfig = {
 export declare type FileCropReturnType = Omit<FileResponse, 'token'> & {
     crop: FileCropConfig;
 };
+export declare type jFileLittle = Readable<Omit<jObjectLittle, 'dateModified'> & {
+    dateCreation: string;
+    dateModified: string | null;
+}>;

package/lib/src/{apis/group/group.types.d.ts → types/group.d.ts}

@@ -1,4 +1,4 @@
-import { jObjectLittle } from '../../types/utils';
+import { jObjectLittle } from './utils';
 export declare type CreateGroup = {
     type: string;
     title: string;
@@ -99,14 +99,13 @@ export interface Category {
 export declare type GroupLittle = jObjectLittle & {
     dateCreation: string;
     dateModified: string;
+    category: string;
+    privacy: string | number;
 };
 export declare type GroupList = GroupLittle & {
     description: string;
-    privacy: string | number;
     edito: string | null;
     language: string;
-    category: string;
-    idCategory: number;
 };
 export declare type GroupView = GroupList & {
     image?: string | null;

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

@@ -9,7 +9,7 @@ export declare type WidgetTextarea = {
         mention: '1';
     };
 };
-export declare type WidgetTextareaValue = string;
+export declare type WidgetTextareaValue = string | null;
 export declare type WidgetNumber = {
     type: 'number';
 };

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

@@ -1,32 +1,72 @@
-import { jSpotLittle } from './spot';
-import { Readable, jArticleList, jArticleLittle } from './utils';
-declare type TVChannelCustomListDynamic = {
-    tvChannelType: 'DYNAMIC';
-    tvChannelBackgroundColor: string;
-    tvChannelGroupTarget?: jSpotLittle;
-    tvChannelConfig: {
-        contents: Array<{
-            uri: string;
-            dateEnd: Date;
-        }>;
-    };
-    tvChannelNumImages: 0;
-};
-declare type TVChannelCustomListSlideshow = {
-    tvChannelType: 'SLIDESHOW';
-    tvChannelBackgroundColor: string;
+import { ArticleCreation, GroupLittle } from '../apis';
+import { jCommentList } from './comment';
+import { jFileLittle } from './file';
+import { Readable, jArticleList, jArticleLittle, jObjectList } from './utils';
+export declare type TvChannelType = 'DYNAMIC' | 'SLIDESHOW';
+export declare type TVChannelCustom<T extends TvChannelType> = jObjectList & {
+    tvChannelType: T;
+    tvChannelBackgroundColor: string | null;
     tvChannelNumImages: number;
+    tvChannelGroupTarget?: GroupLittle;
     tvChannelConfig: {
-        contents: Array<{
+        backgroundType?: 'color' | 'image';
+        globalShowComment?: boolean;
+        key: string;
+        contents?: Array<{
             uri: string;
-            dateEnd: Date;
+            dateEnd?: string;
+            showComments?: boolean;
+            order?: number;
         }>;
     };
 };
+export declare type TVChannelCustomListDynamic = TVChannelCustom<'DYNAMIC'> & {
+    tvChannelNumImages: 0;
+};
+export declare type TVChannelCustomListSlideshow = TVChannelCustom<'SLIDESHOW'>;
 export declare type TVChannelLittle = Readable<jArticleLittle>;
-export declare type TVChannelList = Readable<jArticleList & (TVChannelCustomListDynamic | TVChannelCustomListSlideshow)>;
+export declare type TVChannelDynamicList = Readable<jArticleList & TVChannelCustomListDynamic>;
+export declare type TVChannelSlideshowList = Readable<jArticleList & TVChannelCustomListSlideshow>;
+export declare type TVChannelCustomList = Readable<(jArticleList & TVChannelCustomListDynamic) | TVChannelCustomListSlideshow>;
+export declare type TVChannelList = TVChannelDynamicList | TVChannelSlideshowList;
+export declare type TVChannelCreation = Readable<ArticleCreation & (Partial<TVChannelCustomListDynamic> | Partial<TVChannelCustomListSlideshow>) & {
+    tvChannelType: 'DYNAMIC' | 'SLIDESHOW';
+}>;
 export declare type TVChannelCreatePayload = {
     tvChannelGroupTarget?: Array<string>;
     tvChannelNumImages?: never;
 };
-export {};
+export declare type TVChannelDynamicComment = Readable<jCommentList & {
+    _extend: {
+        userImageSecureUrl: string;
+        descriptionSecure: string;
+    };
+}>;
+export declare type TVChannelDynamicArticle = Readable<jArticleList & {
+    _extend?: {
+        imageSecureUrl?: string;
+        descriptionSecure: string;
+        comments: TVChannelDynamicComment[];
+    };
+}>;
+export declare type TVGetChannelSlideshowFile = jFileLittle & {
+    _extend: {
+        imageSecureUrl?: string;
+    };
+};
+export declare type TVGetChannelResponse = {
+    interval: number;
+    channel: TVGetConfigureChannelResponse;
+};
+export declare type TVGetConfigureChannelResponse = TVGetConfigureDynamicChannelResponse | TVGetConfigureSlideshowChannelResponse;
+export declare type TVGetConfigureDynamicChannelResponse = TVChannelDynamicList & {
+    _extend: {
+        imageSecureUrl?: string;
+        articles?: TVChannelDynamicArticle[];
+    };
+};
+export declare type TVGetConfigureSlideshowChannelResponse = TVChannelSlideshowList & {
+    _extend: {
+        attachments?: TVGetChannelSlideshowFile[];
+    };
+};

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

@@ -0,0 +1,19 @@
+/**
+ * Type with one of (tuple type - id) and (uri) required. If both are passed, only the uri will be used
+ */
+export declare type UriOrTypeId = Partial<TypeId> & Partial<Uri>;
+/**
+ * Interface representing the parameters used to make a content/record uri
+ * @member type - type of the image (ex: user, fileArticle, spot, diffgroup, etc.)
+ * @member recordId - id of the record
+ */
+export interface TypeId {
+    type: string;
+    recordId: string | number;
+}
+/**
+ * @member uri - uri of the record
+ */
+export interface Uri {
+    uri: string;
+}

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

@@ -4,6 +4,8 @@ import { jObjectLittle } from './utils';
  * @deprecated Use jUserList instead
  */
 export declare type UserModel = jObjectLittle & {
+    dateCreation: string;
+    dateModified: string;
     firstname: string;
     lastname: string;
     active: number;

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

@@ -1,4 +1,4 @@
-import { jSpotLittle } from './spot';
+import { GroupLittle } from './group';
 import { jUserLittle } from './user';
 /**
  * Ease usage in IDE by decomposing complex types
@@ -64,12 +64,12 @@ export declare type jObjectBase = {
     dateCreation?: string;
     dateModified?: string;
 };
-export declare type jObjectLittle = Readable<jObjectBase & {
+export declare type jObjectLittle = jObjectBase & {
     title: string;
     _url: string;
-}>;
+};
 export declare type jObjectList = jObjectLittle & {
-    description?: string;
+    description?: string | null;
     _user: jUserLittle;
     _right: Rights;
 };
@@ -97,7 +97,7 @@ export declare type jArticleLittle = jObjectLittle & {
     dateModified: string;
 };
 export declare type jArticleList = jArticleLittle & {
-    description?: string;
+    description?: string | null;
     _user: jUserLittle;
     _right: Rights;
 };
@@ -106,7 +106,7 @@ export declare type Order = {
     name: string;
     sort: 'ASC' | 'DESC';
 };
-export declare type Audience = jUserLittle | jSpotLittle;
+export declare type Audience = jUserLittle | GroupLittle;
 export declare type Orders = Array<Order>;
 export declare type FilterValue = boolean | string | number | string[] | {
     srcId: number | string;

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

@@ -1,5 +1,6 @@
 import { JamespotUserApi } from '../apis';
-import { ApiDefaultWrapper, PagingResults, jArticleLittle, jObjectAutocomplete, jObjectList, jUserList, Rights } from '../types';
+import { ApiDefaultWrapper, PagingResults, jArticleLittle, jObjectAutocomplete, jObjectLittle, jObjectList, jUserList, Rights } from '../types';
+import { jCommentList } from '../types/comment';
 import { FetchResponseType, WindowBrowser } from '../window';
 import { Network } from './network';
 export declare const windowBrowser: WindowBrowser;
@@ -9,27 +10,10 @@ export declare const fetchMock: <T>(data: T) => jest.Mock<Promise<FetchResponseT
 export declare const validateJArticle: <T extends jArticleLittle>(received: T, expected: T) => void;
 export declare const validateApiWrapper: <T extends ApiDefaultWrapper<import("../types").BaseMessages>>(res: T, o: string, f: string, error?: null) => void;
 export declare const validatePagingResults: <T>(res: PagingResults<T>) => void;
-export declare const validateObjectIsFormatLittle: <T extends {
-    id: number;
-    mainType: string;
-    type: string;
-    uri: string;
-    dateCreation?: string;
-    dateModified?: string;
-    title: string;
-    _url: string;
-} = {
-    id: number;
-    mainType: string;
-    type: string;
-    uri: string;
-    dateCreation?: string;
-    dateModified?: string;
-    title: string;
-    _url: string;
-}>(object: T) => void;
+export declare const validateObjectIsFormatLittle: <T extends jObjectLittle = jObjectLittle>(object: T) => void;
 export declare const validateObjectIsFormatList: <T extends jObjectList = jObjectList>(object: T) => void;
 export declare const validateUserIsFormatList: <T extends jUserList = jUserList>(object: T) => void;
+export declare const validateCommentIsFormatList: <T extends jCommentList = jCommentList>(object: T) => void;
 export declare const validateObjectIsFormatAutocomplete: <T extends jObjectAutocomplete = jObjectAutocomplete>(object: T) => void;
 export declare const expectToHaveProperties: <T>(props: string[], payload: T[]) => void;
 export declare const expectToBeArray: <T>(arr: T[]) => void;

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

@@ -1,4 +1,4 @@
-import { BookmarkCustom, BookmarkLink, BookmarkRawList, jObjectBase } from '../types';
+import { BookmarkCustom, BookmarkLink, BookmarkRawList, TVChannelDynamicList, TVChannelList, TVChannelSlideshowList, jObjectBase } from '../types';
 import { AbortApiError, StandardApiError } from './network';
 declare function ensureIsBookmarkLink(bookmark: BookmarkCustom | BookmarkLink): bookmark is BookmarkLink;
 declare function ensureIsBookmarkCustom(bookmark: BookmarkCustom | BookmarkLink): bookmark is BookmarkCustom;
@@ -7,10 +7,16 @@ declare type jObjectTypes = {
     bookmarkLink: BookmarkRawList;
 };
 declare function ensureObjectIsType<T extends keyof jObjectTypes>(type: T, object: jObjectBase): object is jObjectTypes[T];
+declare type ChannelsTypes = {
+    DYNAMIC: TVChannelDynamicList;
+    SLIDESHOW: TVChannelSlideshowList;
+};
+declare function ensureTVChannelIs<Type extends keyof ChannelsTypes>(channel: TVChannelList, type: Type): channel is ChannelsTypes[Type];
 export declare const jEnsure: {
     isBookmarkLink: typeof ensureIsBookmarkLink;
     isBookmarkCustom: typeof ensureIsBookmarkCustom;
     isBookmarkRawList: typeof ensureIsBookmarkRawList;
+    isTVChannelType: typeof ensureTVChannelIs;
     objectIsType: typeof ensureObjectIsType;
     isStandardApiError: (err: any) => err is StandardApiError<import("../types").BaseMessages>;
     isAbortApiError: (err: any) => err is AbortApiError;

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

@@ -0,0 +1,68 @@
+/**
+ * @see JRCImgProps
+ */
+declare type WidthHeight = {
+    width?: number;
+    height?: number;
+};
+/**
+ * @see JRCImgProps
+ */
+declare type Size = {
+    size?: string;
+};
+/**
+ * @see JRCImgProps
+ */
+declare type Format = {
+    format?: string;
+};
+/**
+ * @see JRCImgProps
+ */
+declare type Timestamp = {
+    timestamp?: string | number;
+};
+declare type Args = Timestamp & {
+    iconColor?: 'white';
+};
+/**
+ * @see JRCImgProps
+ */
+export declare type ImgUrlProps = {
+    url?: string;
+    fallbackUrl?: string;
+    size?: string;
+    width?: number;
+    height?: number;
+    maxWidth?: string;
+    from?: string;
+    uri?: string;
+    recordId?: string | number;
+    type?: string;
+    format?: string;
+    iconColor?: 'white';
+    timestamp?: string | number;
+};
+export declare function getFrom(arg: Pick<ImgUrlProps, 'from'>): string;
+export declare function getTimestamp(arg: Timestamp): string;
+export declare function getArgs(arg: Args): string;
+export declare function getSize(arg: Size & WidthHeight, dpr?: number): string;
+export declare function getFormat(arg: Format): string;
+export declare function getUrl(url: string): URL | undefined;
+/**
+ * Format an img url
+ * If url arg is provided, it is used, in addition with an optional timestamp
+ * If not parsable or not passed, one should provide:
+ *   - optional from
+ *   - size in either size or width/height argument.
+ *     If width & height are provided, the downloaded image take car of the screen resolution
+ *   - uri or type/recordId
+ *   - optional format, default png
+ *   - optional timestamp
+ *   The final url is {from}/{size}/{uri}.{format}?_={timestamp}
+ * @param arg
+ * @param dpr device pixel ratio
+ */
+export declare function formatImgUrl(arg: ImgUrlProps, dpr?: number): string;
+export {};

package/lib/src/util/images.test.d.ts

@@ -0,0 +1 @@
+export {};