jamespot-user-api 1.0.102 → 1.0.103

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

@@ -10,7 +10,25 @@ 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<import("../types").jObjectLittle> | import("../types").BookmarkList<import("../types").jObjectLittle>, BaseMessagesOne>>;
+    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").BookmarkList<{
+        id: number;
+        mainType: string;
+        type: string;
+        uri: string;
+        dateCreation?: string;
+        dateModified?: string;
+        title: string;
+        _url: string;
+    }>, 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/group.d.ts

@@ -1,4 +1,4 @@
-import { ApiReturn, Category, CreateGroup, Format, GroupList, GroupProperties, GroupView, GroupWidget, jObjectLittle, PagingResults, UpdateGroup } from '../types';
+import { ApiReturn, Category, CreateGroup, Format, GroupList, GroupProperties, GroupView, GroupWidget, PagingResults, UpdateGroup } from '../types';
 import { JBaseApi } from './base';
 export declare class JGroupApi extends JBaseApi {
     /**
@@ -7,21 +7,57 @@ export declare class JGroupApi extends JBaseApi {
      * @param format return format
      * @returns
      */
-    create<T extends Format = undefined>(group: CreateGroup, format?: T): Promise<import("../types").ApiWrapper<ApiReturn<T, jObjectLittle, GroupList, GroupView, jObjectLittle>, import("../types").BaseMessages>>;
+    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>>;
     /**
      * 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, jObjectLittle, GroupList, GroupView, string>, import("../types").BaseMessages>>;
+    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>>;
     /**
      * Get a spot
      * @param idSpot
      * @param format
      * @returns
      */
-    getSpot<T extends Format = undefined>(idSpot: number | string, format?: T): Promise<import("../types").ApiWrapper<ApiReturn<T, jObjectLittle, GroupList, GroupView, string>, import("../types").BaseMessages>>;
+    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>>;
     /**
      * Get the properties of a group that are not within the model
      * @param idSpot
@@ -45,5 +81,14 @@ 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<jObjectLittle>, import("../types").BaseMessages>>;
+    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>>;
 }

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

@@ -9,6 +9,7 @@ export * from './mediaLibrary';
 export * from './model';
 export * from './search';
 export * from './share';
+export * from './tvDisplay';
 export * from './user';
 export * from './utils';
 export * from './wedoc';

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

@@ -0,0 +1,5 @@
+import { jObjectLittle } from './utils';
+export declare type jSpotLittle = jObjectLittle & {
+    privacy: number;
+    idCategory: number;
+};

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

@@ -0,0 +1,32 @@
+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;
+    tvChannelNumImages: number;
+    tvChannelConfig: {
+        contents: Array<{
+            uri: string;
+            dateEnd: Date;
+        }>;
+    };
+};
+export declare type TVChannelLittle = Readable<jArticleLittle>;
+export declare type TVChannelList = Readable<jArticleList & (TVChannelCustomListDynamic | TVChannelCustomListSlideshow)>;
+export declare type TVChannelCreatePayload = {
+    tvChannelGroupTarget?: Array<string>;
+    tvChannelNumImages?: never;
+};
+export {};

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

@@ -1,4 +1,25 @@
 import { jUserLittle } from './user';
+/**
+ * Ease usage in IDE by decomposing complex types
+ * Decompose combined types into simple object types
+ * A: {a: string}
+ * B: A & {b: int}
+ * Readable<B> => {a: string, b:int}
+ */
+export declare type Readable<T> = T extends infer U ? {
+    [K in keyof U]: U[K];
+} : never;
+declare type AllKeys<T> = T extends unknown ? keyof T : never;
+declare type _ExclusifyUnion<T, K extends PropertyKey> = T extends unknown ? Readable<T & Partial<Record<Exclude<K, keyof T>, never>>> : never;
+/**
+ * Builds an exclusive union type from a union type
+ * C = ExclusifyUnion<A|B>
+ * toto:C = {a: "tata"} OK
+ * tata:C = {b: 123} OK
+ * tutu: C = {a: "tata", b: 123} KO => Types of property 'a' are incompatible. Type 'string' is not assignable to type 'undefined'.
+ * This is the kind of error shown when you add too many properties with this definition.
+ */
+export declare type ExclusifyUnion<T> = _ExclusifyUnion<T, AllKeys<T>>;
 export interface BaseMessage {
     msg: string;
     code: number;
@@ -46,10 +67,10 @@ export declare type jObjectBase = {
     dateCreation?: string;
     dateModified?: string;
 };
-export declare type jObjectLittle = jObjectBase & {
+export declare type jObjectLittle = Readable<jObjectBase & {
     title: string;
     _url: string;
-};
+}>;
 export declare type jObjectList = jObjectLittle & {
     description?: string;
     _user: jUserLittle;
@@ -118,3 +139,4 @@ export declare type MaybeWithParent<T extends jObjectBase = jObjectBase> = {
 export declare type Format = 'raw-little' | 'raw-list' | 'raw-view' | undefined;
 export declare type ApiReturn<T extends Format, Little, List = Little, View = List, Default = {}> = T extends 'raw-little' ? Little : T extends 'raw-list' ? List : T extends 'raw-view' ? View : Default;
 export declare type ValueOf<T> = T[keyof T];
+export {};

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

@@ -1,10 +1,28 @@
 import { JamespotUserApi } from '../apis';
-import { ApiDefaultWrapper, PagingResults, jArticleLittle, jObjectAutocomplete, jObjectLittle } from '../types';
+import { ApiDefaultWrapper, PagingResults, jArticleLittle, jObjectAutocomplete } from '../types';
 import { Network } from './network';
 export declare const network: Network;
 export declare const jApi: JamespotUserApi;
 export declare const validateJArticle: <T extends jArticleLittle>(received: T, expected: T, _format: 'raw-little' | 'raw-list' | 'raw-view') => 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 jObjectLittle = jObjectLittle>(object: T) => boolean;
+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) => boolean;
 export declare const validateObjectIsFormatAutocomplete: <T extends jObjectAutocomplete = jObjectAutocomplete>(object: T) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "jamespot-user-api",
-    "version": "1.0.102",
+    "version": "1.0.103",
     "scripts": {
         "build": "npx webpack --env NODE_ENV=production",
         "build-dev-vm": "npx webpack --env NODE_ENV=development --env NODE_BUILD=VM",