jamespot-user-api 1.0.102 → 1.0.104

package/lib/src/apis/{adminStore.d.ts → admin/store.d.ts}

@@ -1,6 +1,5 @@
-import { ApiWrapper } from '../types';
-import { JBaseApi } from './base';
-import { StoreItem, StoreFinalize } from '../types/adminStore';
+import { ApiWrapper, StoreItem, StoreFinalize } from '../../types';
+import { JBaseApi } from '../base';
 export declare class AdminStoreApi extends JBaseApi {
     getItem(uri: string): Promise<ApiWrapper<StoreItem>>;
     checkoutBilling(uri: string): Promise<ApiWrapper<boolean>>;

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

@@ -0,0 +1,8 @@
+import { AdminApps } from '../../types';
+import { JBaseApi } from '../base';
+export declare class AdminUtilsApi extends JBaseApi {
+    /**
+     * Request the admin applications and sub applications for the admin panel
+     */
+    getApps(): Promise<import("../../types").ApiWrapper<AdminApps, import("../../types").BaseMessages>>;
+}

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/apis/index.d.ts

@@ -1,4 +1,4 @@
-export * from './adminStore';
+export * from './admin';
 export * from './application';
 export * from './article/article';
 export * from './assetReservation';
@@ -12,7 +12,6 @@ export * from './filebank';
 export * from './group';
 export * from './jamespotUserApi';
 export * from './jland/jland';
-export * from './Licenses/licenses';
 export * from './messenger';
 export * from './search/search';
 export * from './share';

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

@@ -1,4 +1,4 @@
-import { AdminStoreApi } from './adminStore';
+import { AdminLicenseApi, AdminUtilsApi, AdminStoreApi } from './admin';
 import { JApplicationApi } from './application';
 import { JArticleApi } from './article/article';
 import { JAseiApi } from './asei';
@@ -19,7 +19,6 @@ import { JDiapazoneApi } from './diapazone';
 import { JWedocApi } from './wedoc';
 import { Network } from '../util/network';
 import { JShareApi } from './share';
-import { JLicenseApi } from './Licenses/licenses';
 /**
  * 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.
@@ -31,7 +30,9 @@ export declare class JamespotUserApi {
     version: string;
     network: Network;
     admin: {
+        license: AdminLicenseApi;
         store: AdminStoreApi;
+        utils: AdminUtilsApi;
     };
     application: JApplicationApi;
     article: JArticleApi;
@@ -45,7 +46,6 @@ export declare class JamespotUserApi {
     filebank: JFilebankApi;
     group: JGroupApi;
     jland: JLandApi;
-    license: JLicenseApi;
     mediaLibrary: JMediaLibraryApi;
     messenger: JMessengerApi;
     search: JSearchApi;

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

@@ -1,7 +1,6 @@
 import { JBaseApi } from '../base';
-import { ApiWrapper, jArticleList, MaybeWithToken, PagingResults } from '../../types';
+import { ApiWrapper, jArticleList, License, MaybeWithToken, PagingResults } from '../../types';
 import { ArticleCreation } from '../article/article';
-import { JLicense } from '../Licenses/licenses';
 export declare type JLandLog = {
     idLog: number;
     slug: string;
@@ -23,7 +22,7 @@ export declare type JLandMap = jArticleList & {
     waMapUrl?: string;
     limit?: number;
     _extend: {
-        licenses: Array<JLicense>;
+        licenses: Array<License>;
     };
 };
 export declare type JLandMapCreation = ArticleCreation & {

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

@@ -17,7 +17,6 @@ export interface ObjectListProps {
     facets?: {}[];
     filters?: Filters;
     query?: string;
-    queryFields?: Array<string>;
     limit?: number;
     page?: number;
     orders?: Orders;

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

@@ -0,0 +1,43 @@
+import { ObjectListProps } from '../apis';
+import { jUserList } from './user';
+export declare type AdminLicenseUserStats = {
+    countActiveUsersWithoutLicense: number;
+    countLicensesAssigned: number;
+    countLicensesNotAssigned: number;
+};
+export declare type ObjectWithoutLicenseFilter = {
+    name: string;
+    operator: string;
+    value: number;
+};
+export declare type AdminLicensesNotAssigned = {
+    [key: string]: number;
+};
+export declare type AdminLicensesAssigned = {
+    id: number;
+    kind: string;
+    dateCreation: string;
+    idFeature: number;
+    uri: string;
+    contentId: number;
+    contentType: string;
+    status: number;
+};
+export declare type License = {
+    id: number;
+    kind: string;
+    dateCreation: string;
+    idFeature: number;
+    uri: string;
+    contentId: number;
+    contentType: string;
+    status: number;
+};
+export declare type JAdminLicenseUserList = jUserList & {
+    _extend: {
+        licenses: Array<License>;
+    };
+};
+export interface AdminLicenseUser extends ObjectListProps {
+    data: JAdminLicenseUserList[];
+}

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

@@ -0,0 +1,18 @@
+export declare type AdminAppTab = {
+    sref?: string;
+    href?: string;
+    idDiv: string;
+    label: string;
+    icon: string;
+};
+export declare type AdminApp = {
+    name: string;
+    label: string;
+    icon: string;
+    color: [string, string, string];
+    state?: string;
+    access: boolean;
+    url?: string;
+    tabs?: AdminAppTab[];
+};
+export declare type AdminApps = AdminApp[];

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

@@ -1,4 +1,6 @@
+export * from './adminLicence';
 export * from './adminStore';
+export * from './adminUtils';
 export * from './asei';
 export * from './assetReservation';
 export * from './autocomplete';
@@ -9,6 +11,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/model.d.ts

@@ -27,6 +27,7 @@ export declare type WidgetDatePicker = {
     type: 'datePicker';
 };
 export declare type WidgetDatePickerValue = string | null;
+export declare type WidgetActiveValue = number;
 export declare type WidgetMultiattribute = {
     type: 'multiattribute';
 };
@@ -71,6 +72,7 @@ export declare type WidgetTaxonomy = {
     type: 'taxonomy';
     params: {
         idTaxonomy: string;
+        type?: string;
     };
 };
 export declare type WidgetOrientedlinks = {
@@ -90,7 +92,7 @@ export declare type WidgetUri = {
     };
 };
 export declare type Widget = WidgetText | WidgetTextarea | WidgetNumber | WidgetDate | WidgetDatetime | WidgetDatePicker | WidgetSelect | WidgetEmail | WidgetUrl | WidgetRefUser | WidgetRadio | WidgetCheckbox | WidgetOrientedlinks | WidgetTaxonomy | WidgetUri | WidgetTransient | WidgetMultiattribute | WidgetFile;
-export declare type WidgetsValue = WidgetDatePickerValue | WidgetDatetimeValue | WidgetDateValue | WidgetEmailValue | WidgetNumberValue | WidgetTextareaValue | WidgetTextValue | WidgetUrlValue;
+export declare type WidgetsValue = WidgetActiveValue | WidgetDatePickerValue | WidgetDatetimeValue | WidgetDateValue | WidgetEmailValue | WidgetNumberValue | WidgetTextareaValue | WidgetTextValue | WidgetUrlValue;
 export declare type FieldConfiguration<T extends string = string> = {
     label: string;
     description?: string;

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/user.d.ts

@@ -1,8 +1,12 @@
 import { WidgetsValue } from './model';
 import { jObjectLittle } from './utils';
+/**
+ * @deprecated Use jUserList instead
+ */
 export declare type UserModel = jObjectLittle & {
     firstname: string;
     lastname: string;
+    active: number;
     mail?: string;
 };
 export declare type UserMapModel = {

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,12 +67,13 @@ 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;
+    active: number;
     _user: jUserLittle;
     _right: Rights;
 };
@@ -89,7 +111,7 @@ export declare type Order = {
     sort: 'ASC' | 'DESC';
 };
 export declare type Orders = Array<Order>;
-export declare type FilterValue = boolean | string | string[] | {
+export declare type FilterValue = boolean | string | number | string[] | {
     srcId: number | string;
     srcType: string;
 } | {
@@ -118,3 +140,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,29 @@
 import { JamespotUserApi } from '../apis';
-import { ApiDefaultWrapper, PagingResults, jArticleLittle, jObjectAutocomplete, jObjectLittle } from '../types';
+import { ApiDefaultWrapper, PagingResults, jArticleLittle, jObjectAutocomplete, jObjectList } 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 validateObjectIsFormatList: <T extends jObjectList = jObjectList>(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.104",
     "scripts": {
         "build": "npx webpack --env NODE_ENV=production",
         "build-dev-vm": "npx webpack --env NODE_ENV=development --env NODE_BUILD=VM",

package/phpunitMock/objectListJamespotUserQueryList-rawList.json

@@ -21,7 +21,8 @@
                 "firstname": "Admin",
                 "lastname": "Jenkins",
                 "company": "",
-                "mail": "admin.jenkins@jamespot.com"
+                "mail": "admin.jenkins@jamespot.com",
+                "active": 1
             },
             {
                 "id": 2,
@@ -36,7 +37,8 @@
                 "firstname": "Browser",
                 "lastname": "Stack",
                 "company": "",
-                "mail": "browserstack@jamespot.com"
+                "mail": "browserstack@jamespot.com",
+                "active": 1
             },
             {
                 "id": 4,
@@ -44,14 +46,15 @@
                 "type": "user",
                 "uri": "user/4",
                 "dateCreation": "2019-07-09 15:48:26",
-                "dateModified": "2023-04-13 14:54:05",
+                "dateModified": "2019-07-09 15:51:24",
                 "title": "Admin1",
                 "_url": "/user/4",
                 "level": 9,
                 "firstname": "Un",
                 "lastname": "Admin",
-                "company": "Jamespot 0.17199300 1681390422",
-                "mail": "admin1@jamespot.com"
+                "company": "",
+                "mail": "admin1@jamespot.com",
+                "active": 1
             },
             {
                 "id": 5,
@@ -59,14 +62,15 @@
                 "type": "user",
                 "uri": "user/5",
                 "dateCreation": "2019-07-09 15:48:45",
-                "dateModified": "2023-04-13 14:53:47",
+                "dateModified": "2019-07-09 15:51:16",
                 "title": "Admin2",
                 "_url": "/user/5",
                 "level": 9,
                 "firstname": "Deux",
                 "lastname": "Admin",
                 "company": "",
-                "mail": "admin2@jamespot.com"
+                "mail": "admin2@jamespot.com",
+                "active": 1
             },
             {
                 "id": 6,
@@ -81,7 +85,8 @@
                 "firstname": "Un",
                 "lastname": "User",
                 "company": "",
-                "mail": "user1@jamespot.com"
+                "mail": "user1@jamespot.com",
+                "active": 1
             },
             {
                 "id": 7,
@@ -96,7 +101,8 @@
                 "firstname": "Deux",
                 "lastname": "User",
                 "company": "",
-                "mail": "user2@jamespot.com"
+                "mail": "user2@jamespot.com",
+                "active": 1
             },
             {
                 "id": 8,
@@ -111,7 +117,8 @@
                 "firstname": "Un",
                 "lastname": "Limited",
                 "company": "",
-                "mail": "limited1@jamespot.com"
+                "mail": "limited1@jamespot.com",
+                "active": 1
             },
             {
                 "id": 9,
@@ -126,7 +133,8 @@
                 "firstname": "Deux",
                 "lastname": "Limited",
                 "company": "",
-                "mail": "limited2@jamespot.com"
+                "mail": "limited2@jamespot.com",
+                "active": 1
             },
             {
                 "id": 10,
@@ -141,7 +149,8 @@
                 "firstname": "Un",
                 "lastname": "InactiveAdmin",
                 "company": "",
-                "mail": "inactiveAdmin1@jamespot.com"
+                "mail": "inactiveAdmin1@jamespot.com",
+                "active": 0
             },
             {
                 "id": 11,
@@ -156,7 +165,8 @@
                 "firstname": "InactiveUser",
                 "lastname": "Un",
                 "company": "",
-                "mail": "inactiveUser1@jamespot.com"
+                "mail": "inactiveUser1@jamespot.com",
+                "active": 0
             },
             {
                 "id": 12,
@@ -171,7 +181,8 @@
                 "firstname": "InactiveLimited",
                 "lastname": "Un",
                 "company": "",
-                "mail": "inactiveLimited1@jamespot.com"
+                "mail": "inactiveLimited1@jamespot.com",
+                "active": 0
             }
         ],
         "facets": null