jamespot-user-api 1.0.146 → 1.0.147

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

@@ -1,14 +1,10 @@
 import { JBaseApi } from '../base';
-import { ApiWrapper } from '../../types';
-export type AnimationVariant = 'Olympics' | 'Maythefourth' | 'Spring' | 'MusicFestival' | 'EasterEggs' | 'CustomAnimation';
-export type AnimationConfigurationType = {
-    name: AnimationVariant;
-    activeClickEffect: number;
-    activeDecor: number;
-    auto: number;
-    audience: string[];
-};
+import { AnimationConfigurationType, ApiWrapper } from '../../types';
 export declare class JAnimationsApi extends JBaseApi {
-    SaveAnimationConfiguration(animation: Object | null): Promise<ApiWrapper<boolean>>;
-    GetCurrentAnimation(checkAudience?: boolean): Promise<ApiWrapper<AnimationConfigurationType>>;
+    SaveAnimationConfiguration(animation: Object): Promise<ApiWrapper<AnimationConfigurationType>>;
+    DeleteAnimation(): Promise<ApiWrapper<boolean>>;
+    GetCurrentAnimation(): Promise<ApiWrapper<AnimationConfigurationType | null>>;
+    GetCurrentAnimationApp(): Promise<ApiWrapper<AnimationConfigurationType | null>>;
+    ToggleAnimationActive(): Promise<ApiWrapper<boolean>>;
+    GetAnimationActive(): Promise<ApiWrapper<boolean>>;
 }

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

@@ -1,4 +1,9 @@
-import { ApiWrapper } from '../../types';
-import { AnimationConfigurationType } from './animations';
-export declare const animationsSaveConfiguration: ApiWrapper<boolean>;
+import { AnimationConfigurationType, ApiWrapper } from '../../types';
+export declare const animationsSaveConfiguration: ApiWrapper<AnimationConfigurationType>;
 export declare const animationsGetConfiguration: ApiWrapper<AnimationConfigurationType>;
+export declare const animationsGetConfigurationWithoutMe: ApiWrapper<null>;
+export declare const animationsDeleteCurrentAnimations: ApiWrapper<boolean>;
+export declare const animationsGetConfigurationApp: ApiWrapper<AnimationConfigurationType>;
+export declare const animationsGetConfigurationAppWithoutMeIn: ApiWrapper<AnimationConfigurationType>;
+export declare const animationsGetAnimationActive: ApiWrapper<boolean>;
+export declare const animationsToggleAnimationActive: ApiWrapper<boolean>;

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

@@ -10,7 +10,7 @@ export declare class JDriveApi extends JBaseApi {
      * Microsoft graph only
      * @returns
      */
-    groups(): Promise<ApiWrapper<MSGroupEntity[]>>;
+    groups(query?: string, filter?: string): Promise<ApiWrapper<MSGroupEntity[]>>;
     /**
      * Microsoft graph only
      * @returns

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

@@ -1,6 +1,6 @@
-import { Category, CreateGroup, GroupList, GroupProperties, GroupUserLevel, GroupView, GroupWidget, ResetNotificationConfiguration, UpdateGroup } from '../../types/group';
+import { Category, CreateGroup, GroupList, GroupListConfig, GroupProperties, GroupUserLevel, GroupView, GroupWidget, ResetNotificationConfiguration, UpdateGroup } from '../../types/group';
 import { JBaseApi } from '../base';
-import { ApiReturn, Format, PagingResults, jObjectLittle, jSpotAutocomplete, jUserLittle } from '../../types';
+import { ApiReturn, ApiWrapper, Format, PagingResults, jObjectLittle, jSpotAutocomplete, jUserLittle } from '../../types';
 export declare class JGroupApi extends JBaseApi {
     /**
      * autocomplete return a list of groups
@@ -13,36 +13,36 @@ 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<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, jObjectLittle, GroupList, GroupView, string>, import("../../types").BaseMessages>>;
+    update<T extends Format = undefined>(group: UpdateGroup, format?: T): Promise<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, jObjectLittle, GroupList, GroupView, string>, import("../../types").BaseMessages>>;
+    getSpot<T extends Format = undefined>(idSpot: number | string, format?: T): Promise<ApiWrapper<ApiReturn<T, jObjectLittle, GroupList, GroupView, string>, import("../../types").BaseMessages>>;
     /**
      * Get the properties of a group that are not within the model
      * @param idSpot
      * @returns
      */
-    getProperties(idSpot: number | string): Promise<import("../../types").ApiWrapper<GroupProperties, import("../../types").BaseMessages>>;
+    getProperties(idSpot: number | string): Promise<ApiWrapper<GroupProperties, import("../../types").BaseMessages>>;
     /**
      * Get the available applications that can be added to a group
      */
-    getApplications(): Promise<import("../../types").ApiWrapper<Record<string, GroupWidget>, import("../../types").BaseMessages>>;
+    getApplications(): Promise<ApiWrapper<Record<string, GroupWidget>, import("../../types").BaseMessages>>;
     /**
      * Get the available group categories
      * @returns
      */
-    getCategories(): Promise<import("../../types").ApiWrapper<Category[], import("../../types").BaseMessages>>;
+    getCategories(): Promise<ApiWrapper<Category[], import("../../types").BaseMessages>>;
     /**
      * Get the members of a group
      * @param idSpot spot id
@@ -51,16 +51,17 @@ 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<{
+    getObjectListJamespotSpotMembers(idSpot: number | string, query?: string, limit?: number, page?: number): Promise<ApiWrapper<PagingResults<{
         level: GroupUserLevel;
         user: jUserLittle;
     }>, import("../../types").BaseMessages>>;
+    list<T extends GroupList = GroupList>(config: GroupListConfig): Promise<ApiWrapper<PagingResults<T>>>;
     /**
      * Reset the notifications configuration for all users of the group
      * @param config configuration
      * @returns
      */
-    resetNotifications(config: ResetNotificationConfiguration): Promise<import("../../types").ApiWrapper<{
+    resetNotifications(config: ResetNotificationConfiguration): Promise<ApiWrapper<{
         members: number;
         msg: string;
     }, import("../../types").BaseMessages>>;

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

@@ -1,5 +1,5 @@
 import { ApiPagingResults, ApiWrapper, jSpotAutocomplete } from '../../types';
-import { Category, GroupMemberLevel, GroupProperties, GroupView, GroupWidget } from '../../types/group';
+import { Category, GroupMemberLevel, GroupProperties, GroupView, GroupWidget, jGroupList } from '../../types/group';
 export declare const spot: ApiWrapper<GroupView>;
 export declare const properties: ApiWrapper<GroupProperties>;
 export declare const groupAutocompleteA: ApiWrapper<jSpotAutocomplete[]>;
@@ -8,6 +8,7 @@ export declare const groupUpdate: ApiWrapper<GroupView>;
 export declare const groupGetAvailableWidget: ApiWrapper<Record<string, GroupWidget>>;
 export declare const groupGetCategories: ApiWrapper<Category[]>;
 export declare const groupObjectListJamespotSpotMembers: ApiPagingResults<GroupMemberLevel>;
+export declare const groupList: ApiPagingResults<jGroupList>;
 export declare const groupResetNotification: ApiWrapper<{
     members: number;
     msg: string;

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

@@ -0,0 +1,8 @@
+export type AnimationVariant = 'Olympics' | 'Maythefourth' | 'Spring' | 'MusicFestival' | 'EasterEggs' | 'CustomAnimation';
+export type AnimationConfigurationType = {
+    name: AnimationVariant;
+    activeClickEffect: number;
+    activeDecor: number;
+    auto: boolean;
+    audience: string[];
+};

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

@@ -35,4 +35,5 @@ export type DriveDocumentParams = {
     idFolder: string | undefined;
     page: number;
     limit: number;
+    query?: string | null;
 };

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

@@ -1,5 +1,5 @@
 import { jUserLittle } from './user';
-import { jObjectLittle } from './utils';
+import { Filters, Orders, jObjectBase, jObjectLittle } from './utils';
 export type CreateGroup = {
     type: string;
     title: string;
@@ -117,6 +117,7 @@ export interface Category {
     idorder: number;
     label: string;
 }
+export type jGroupList = jObjectBase & GroupLittle;
 export type GroupLittle = jObjectLittle & {
     dateCreation: string;
     dateModified: string;
@@ -141,3 +142,12 @@ export type ResetNotificationConfiguration = {
     mailComment: boolean;
     mailSubscriber: boolean;
 };
+export type GroupListConfig = {
+    type?: string;
+    format?: string;
+    query?: string;
+    limit?: number;
+    page?: number;
+    orders?: Orders;
+    filters?: Filters | undefined;
+};

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

@@ -1,6 +1,7 @@
 export * from './adminLicence';
 export * from './adminStore';
 export * from './adminUtils';
+export * from './animations';
 export * from './article';
 export * from './asei';
 export * from './assetReservation';

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

@@ -1,10 +1,12 @@
 import { AllKeys, Readable, jObjectBase } from './utils';
 type BookmarksFunctions = 'update' | 'add' | 'delete';
+type AnimationsFunctions = 'update' | 'add' | 'delete' | 'toggle' | 'getAnimationActive';
 type CustomActionFunctions = 'update' | 'add' | 'remove';
 type JamespotFunctions = 'comment-create' | 'comment-delete' | 'comment-update';
 type WSFunctions = 'presence' | 'connection' | 'disconnect';
 export type Namespaces = {
     BOOKMARKS: BookmarksFunctions;
+    ANIMATIONS: AnimationsFunctions;
     'CUSTOM-ACTION': CustomActionFunctions;
     JAMESPOT: JamespotFunctions;
     ws: WSFunctions;
@@ -15,6 +17,13 @@ export type AllMessages = {
         add: RTMessageObject<'BOOKMARKS', 'add'>;
         delete: RTMessageObject<'BOOKMARKS', 'delete'>;
     };
+    ANIMATIONS: {
+        update: RTMessage<'ANIMATIONS', 'update'>;
+        add: RTMessage<'ANIMATIONS', 'add'>;
+        delete: RTMessage<'ANIMATIONS', 'delete'>;
+        toggle: RTMessage<'ANIMATIONS', 'toggle'>;
+        getAnimationActive: RTMessage<'ANIMATIONS', 'getAnimationActive'>;
+    };
     'CUSTOM-ACTION': {
         update: RTMessageObject<'CUSTOM-ACTION', 'update'>;
         add: RTMessageObject<'CUSTOM-ACTION', 'add'>;
@@ -53,6 +62,6 @@ export type RTMessageObject<T extends keyof Namespaces, F extends Namespaces[T],
 export type RTMessageWsPresence = RTMessage<'ws', 'presence'> & {
     idUsers: number[];
 };
-export type AnyRTMessage<T = {}> = RTMessageObject<'BOOKMARKS', 'update', T> | RTMessageObject<'BOOKMARKS', 'add', T> | RTMessageObject<'BOOKMARKS', 'delete', T> | RTMessageObject<'CUSTOM-ACTION', 'update', T> | RTMessageObject<'CUSTOM-ACTION', 'add', T> | RTMessageObject<'CUSTOM-ACTION', 'remove', T> | RTMessageObject<'JAMESPOT', 'comment-create', T> | RTMessageObject<'JAMESPOT', 'comment-delete', T> | RTMessageObject<'JAMESPOT', 'comment-update', T> | RTMessageWsPresence | RTMessage<'ws', 'connection'> | RTMessage<'ws', 'disconnect'>;
+export type AnyRTMessage<T = {}> = RTMessageObject<'BOOKMARKS', 'update', T> | RTMessageObject<'BOOKMARKS', 'add', T> | RTMessageObject<'BOOKMARKS', 'delete'> | RTMessage<'ANIMATIONS', 'update'> | RTMessage<'ANIMATIONS', 'add'> | RTMessage<'ANIMATIONS', 'delete'> | RTMessage<'ANIMATIONS', 'toggle'> | RTMessage<'ANIMATIONS', 'getAnimationActive'> | RTMessageObject<'CUSTOM-ACTION', 'update', T> | RTMessageObject<'CUSTOM-ACTION', 'add', T> | RTMessageObject<'CUSTOM-ACTION', 'remove', T> | RTMessageObject<'JAMESPOT', 'comment-create', T> | RTMessageObject<'JAMESPOT', 'comment-delete', T> | RTMessageObject<'JAMESPOT', 'comment-update', T> | RTMessageWsPresence | RTMessage<'ws', 'connection'> | RTMessage<'ws', 'disconnect'>;
 export type RTReceivedMessage<T extends keyof Namespaces, F extends Namespaces[T]> = ['message', RTMessage<T, F>];
 export {};

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

@@ -34,6 +34,7 @@ export type WidgetTypeKeys = {
     'widget-article-text': WidgetArticleTextType;
     'widget-article-image': WidgetArticleImageType;
     'widget-article-attachment': WidgetArticleAttachmentType;
+    'widget-api': WidgetApiType;
     'widget-article-slider': WidgetArticleSliderType;
 };
 export type WidgetContentKeys = {
@@ -43,12 +44,18 @@ export type WidgetContentKeys = {
     'widget-article-text': WidgetArticleTextContent;
     'widget-article-image': WidgetArticleImageContent;
     'widget-article-attachment': WidgetArticleAttachmentContent;
+    'widget-api': WidgetApiContent;
     'widget-article-slider': WidgetArticleSliderContent;
 };
 export type WidgetKeys = keyof WidgetTypeKeys;
 export type WidgetExtendedType = {
     layers?: string[];
 };
+export type WidgetApiType = {
+    name: 'widget-api';
+    uniqid: string;
+    content: WidgetApiContent;
+};
 export type WidgetArticleButtonType = {
     name: 'widget-article-button';
     uniqid: string;
@@ -109,6 +116,12 @@ export type WidgetArticleTextContent = {
     lineHeight?: string;
     linkColor?: string;
 };
+export type WidgetApiContent = {
+    url?: string;
+    keys?: string[];
+    order?: string;
+    orderBy?: string;
+};
 export type OpeningTypeLink = {
     url: string;
     target: string;
@@ -120,7 +133,10 @@ export type OpeningTypePopup = {
     title: string;
     widgets: WidgetWrapperProps[];
 };
-export type WidgetArticleButtonContent = {
+/**
+ * Widget button base properties
+ */
+export type WidgetButtonProps = {
     text?: string;
     color?: string;
     backgroundColor?: string;
@@ -128,6 +144,10 @@ export type WidgetArticleButtonContent = {
     fontSize?: string;
     buttonSize?: VariantSizeType;
     variant?: VariantType;
+    url?: string;
+    target?: string;
+};
+export type WidgetArticleButtonContent = WidgetButtonProps & {
     openingType?: OpeningType;
     openingTypeLink?: OpeningTypeLink;
     openingTypeAnchor?: OpeningTypeAnchor;
@@ -158,7 +178,7 @@ export type WidgetArticleSliderContent = {
 };
 export type CombinedWidgetContent = {
     widgets?: WidgetWrapperProps[];
-} & (WidgetArticleTextContent | WidgetArticleImageContent | WidgetArticleTitleContent | WidgetArticleButtonContent | WidgetArticleGalleryContent | WidgetArticleAttachmentContent | WidgetArticleSliderContent);
+} & (WidgetArticleTextContent | WidgetArticleImageContent | WidgetArticleTitleContent | WidgetArticleButtonContent | WidgetArticleGalleryContent | WidgetArticleAttachmentContent | WidgetApiContent | WidgetArticleSliderContent);
 export type WidgetStateProps = {
     busy?: boolean | undefined;
     loading?: boolean | undefined;

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

@@ -21,5 +21,5 @@ export declare const resolveFilePath: (file: jFileLittle, size?: string) => stri
 export declare const getFileFamilyFromName: (name: string) => fileFamilyTypes;
 export declare function getFileFamily(mimetype: string | undefined): fileFamilyTypes;
 export declare const resolveFileUrl: (idFile: number, hash: string, mode?: 'ng' | 'rr') => string;
-export declare const resolveFileMimetype: (file: jFileLittle) => string;
+export declare const resolveFileMimetype: (file: Pick<jFileLittle, 'mimetype' | 'title'>) => string;
 export declare const resolveFileFamily: (file: jFileLittle) => fileFamilyTypes;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jamespot-user-api",
-  "version": "1.0.146",
+  "version": "1.0.147",
   "main": "lib/jamespot-user-api.js",
   "types": "lib/src/index.d.ts",
   "directories": {

package/phpunitMock/animationsDeleteAnimation-default.json

@@ -0,0 +1 @@
+{ "o": "animations", "f": "deleteAnimation", "error": 0, "messages": [], "result": true }

package/phpunitMock/animationsGetAnimationActive-default.json

@@ -0,0 +1 @@
+{ "o": "animations", "f": "getAnimationActive", "error": 0, "messages": [], "result": true }

package/phpunitMock/animationsGetConfiguration-default.json

@@ -7,7 +7,7 @@
         "name": "MusicFestival",
         "activeClickEffect": 1,
         "activeDecor": 0,
-        "auto": 1,
-        "audience": ["networkPublic\\/1"]
+        "auto": true,
+        "audience": ["networkPublic/1"]
     }
 }

package/phpunitMock/animationsGetConfiguration-get-animation-without-me-in.json

@@ -0,0 +1 @@
+{ "o": "animations", "f": "getConfiguration", "error": 0, "messages": [], "result": null }

package/phpunitMock/animationsGetConfigurationApp-default.json

@@ -0,0 +1,13 @@
+{
+    "o": "animations",
+    "f": "getConfigurationApp",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "name": "MusicFestival",
+        "activeClickEffect": 1,
+        "activeDecor": 0,
+        "auto": true,
+        "audience": ["networkPublic/1"]
+    }
+}

package/phpunitMock/animationsGetConfigurationApp-without-me-in.json

@@ -0,0 +1,13 @@
+{
+    "o": "animations",
+    "f": "getConfigurationApp",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "name": "Maythefourth",
+        "activeClickEffect": 1,
+        "activeDecor": 0,
+        "auto": false,
+        "audience": ["user/5"]
+    }
+}

package/phpunitMock/animationsSaveConfiguration-default.json

@@ -1 +1,13 @@
-{ "o": "animations", "f": "saveConfiguration", "error": 0, "messages": [], "result": true }
+{
+    "o": "animations",
+    "f": "saveConfiguration",
+    "error": 0,
+    "messages": [{ "code": 200, "msg": "Enregistrement r\u00e9ussi" }],
+    "result": {
+        "name": "MusicFestival",
+        "activeClickEffect": 1,
+        "activeDecor": 0,
+        "auto": true,
+        "audience": ["networkPublic/1"]
+    }
+}

package/phpunitMock/animationsToggleAnimationActive-default.json

@@ -0,0 +1,7 @@
+{
+    "o": "animations",
+    "f": "toggleAnimationActive",
+    "error": 0,
+    "messages": [{ "code": 200, "msg": "Enregistrement r\u00e9ussi" }],
+    "result": false
+}

package/phpunitMock/objectListJamespotSpotQueryList-raw-list.json

@@ -0,0 +1,51 @@
+{
+    "o": "objectList",
+    "f": "jamespotSpotQueryList",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "limit": 50,
+        "page": 1,
+        "cnt": 3,
+        "data": [
+            {
+                "id": 1,
+                "mainType": "spot",
+                "type": "spot",
+                "uri": "spot/1",
+                "dateCreation": "2019-07-18 18:36:24",
+                "dateModified": "2024-02-16 11:02:19",
+                "title": "Groupe public",
+                "_url": "/group/1",
+                "privacy": 1,
+                "category": 1
+            },
+            {
+                "id": 2,
+                "mainType": "spot",
+                "type": "spot",
+                "uri": "spot/2",
+                "dateCreation": "2019-07-18 18:36:38",
+                "dateModified": "2024-02-16 11:02:19",
+                "title": "Groupe priv\u00e9",
+                "_url": "/group/2",
+                "privacy": 0,
+                "category": 1
+            },
+            {
+                "id": 3,
+                "mainType": "spot",
+                "type": "spot",
+                "uri": "spot/3",
+                "dateCreation": "2019-07-19 09:35:53",
+                "dateModified": "2024-02-16 11:02:19",
+                "title": "Groupe mod\u00e9r\u00e9",
+                "_url": "/group/3",
+                "privacy": 2,
+                "category": 1
+            }
+        ],
+        "facets": null,
+        "idQuery": null
+    }
+}