jamespot-user-api 1.0.157 → 1.0.159

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

@@ -1,6 +1,6 @@
-import { Category, CreateGroup, GroupList, GroupListConfig, GroupProperties, GroupUserLevel, GroupView, GroupWidget, ResetNotificationConfiguration, UpdateGroup } from '../../types/group';
+import { Category, CreateGroup, GroupList, GroupListConfig, GroupProperties, GroupUserLevel, GroupView, GroupWidget, ResetNotificationConfiguration, UpdateGroup, UserLevelAndRight } from '../../types/group';
 import { JBaseApi } from '../base';
-import { ApiReturn, ApiWrapper, Format, PagingResults, jSpotAutocomplete, jUserLittle } from '../../types';
+import { ApiReturn, ApiWrapper, BaseMessages, Format, jSpotAutocomplete, jUserLittle, PagingResults } from '../../types';
 export declare class JGroupApi extends JBaseApi {
     /**
      * autocomplete return a list of groups
@@ -31,7 +31,7 @@ export declare class JGroupApi extends JBaseApi {
         _url: string;
         dateCreation?: string | undefined;
         dateModified?: string | null | undefined;
-    }>, import("../../types").BaseMessages>>;
+    }>, BaseMessages>>;
     /**
      * Update a group
      * @param group group to update. The uri is mandatory and identify the group to update
@@ -47,7 +47,7 @@ export declare class JGroupApi extends JBaseApi {
         _url: string;
         dateCreation?: string | undefined;
         dateModified?: string | null | undefined;
-    }, GroupList, GroupView, string>, import("../../types").BaseMessages>>;
+    }, GroupList, GroupView, string>, BaseMessages>>;
     /**
      * Get a spot
      * @param idSpot
@@ -63,22 +63,22 @@ export declare class JGroupApi extends JBaseApi {
         _url: string;
         dateCreation?: string | undefined;
         dateModified?: string | null | undefined;
-    }, GroupList, GroupView, string>, import("../../types").BaseMessages>>;
+    }, GroupList, GroupView, string>, BaseMessages>>;
     /**
      * Get the properties of a group that are not within the model
      * @param idSpot
      * @returns
      */
-    getProperties(idSpot: number | string): Promise<ApiWrapper<GroupProperties, import("../../types").BaseMessages>>;
+    getProperties(idSpot: number | string): Promise<ApiWrapper<GroupProperties, BaseMessages>>;
     /**
      * Get the available applications that can be added to a group
      */
-    getApplications(): Promise<ApiWrapper<Record<string, GroupWidget>, import("../../types").BaseMessages>>;
+    getApplications(): Promise<ApiWrapper<Record<string, GroupWidget>, BaseMessages>>;
     /**
      * Get the available group categories
      * @returns
      */
-    getCategories(): Promise<ApiWrapper<Category[], import("../../types").BaseMessages>>;
+    getCategories(): Promise<ApiWrapper<Category[], BaseMessages>>;
     /**
      * Get the members of a group
      * @param idSpot spot id
@@ -90,7 +90,7 @@ export declare class JGroupApi extends JBaseApi {
     getObjectListJamespotSpotMembers(idSpot: number | string, query?: string, limit?: number, page?: number): Promise<ApiWrapper<PagingResults<{
         level: GroupUserLevel;
         user: jUserLittle;
-    }>, import("../../types").BaseMessages>>;
+    }>, BaseMessages>>;
     list<T extends GroupList = GroupList>(config: GroupListConfig): Promise<ApiWrapper<PagingResults<T>>>;
     /**
      * Reset the notifications configuration for all users of the group
@@ -100,5 +100,23 @@ export declare class JGroupApi extends JBaseApi {
     resetNotifications(config: ResetNotificationConfiguration): Promise<ApiWrapper<{
         members: number;
         msg: string;
-    }, import("../../types").BaseMessages>>;
+    }, BaseMessages>>;
+    /**
+     * Get a spot
+     * @param idSpot
+     * @returns
+     */
+    getUserLevelAndRight(idSpot: number | string): Promise<ApiWrapper<UserLevelAndRight, BaseMessages>>;
+    /**
+     * Post a request to join a moderated group
+     * @param idSpot
+     * @returns
+     */
+    groupRequest(idSpot: number | string): Promise<ApiWrapper<boolean, BaseMessages>>;
+    /**
+     * Join a public group
+     * @param idSpot
+     * @returns
+     */
+    groupAddToFavorite(idSpot: number | string): Promise<ApiWrapper<boolean, BaseMessages>>;
 }

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

@@ -1,4 +1,4 @@
-import { ApiPagingResults, ApiWrapper, jSpotAutocomplete } from '../../types';
+import { ApiDefaultWrapper, ApiPagingResults, ApiWrapper, jSpotAutocomplete, UserLevelAndRight } from '../../types';
 import { Category, GroupMemberLevel, GroupProperties, GroupView, GroupWidget, jGroupList } from '../../types/group';
 export declare const spot: ApiWrapper<GroupView>;
 export declare const properties: ApiWrapper<GroupProperties>;
@@ -7,6 +7,13 @@ export declare const groupCreate: ApiWrapper<GroupView>;
 export declare const groupUpdate: ApiWrapper<GroupView>;
 export declare const groupGetAvailableWidget: ApiWrapper<Record<string, GroupWidget>>;
 export declare const groupGetCategories: ApiWrapper<Category[]>;
+export declare const groupGetUserLevelAndRight: ApiWrapper<UserLevelAndRight>;
+export declare const groupRequestSuccess: ApiWrapper<boolean>;
+export declare const groupRequestForbidden: ApiDefaultWrapper;
+export declare const groupRequestPending: ApiDefaultWrapper;
+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 groupResetNotification: ApiWrapper<{

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

@@ -2,4 +2,16 @@ import { ApiWrapper, jUserLittle } from '../../types';
 import { JBaseApi } from '../base';
 export declare class JWidgetApi extends JBaseApi {
     responseUserList(uri: string, uniqid: string, page: number): Promise<ApiWrapper<jUserLittle[]>>;
+    removeWidget({ id, type, uniqid }: {
+        id: number;
+        type: string;
+        uniqid: string;
+    }): Promise<ApiWrapper<[]>>;
+    checkListRespond({ id, type, idUser, uniqid, index, }: {
+        id: number;
+        type: string;
+        idUser: number;
+        uniqid: string;
+        index: number;
+    }): Promise<ApiWrapper<[]>>;
 }

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

@@ -1,2 +1,3 @@
 import { ApiWrapper, jUserLittle } from '../../types';
 export declare const widgetResponseUserList: ApiWrapper<jUserLittle[]>;
+export declare const widgetResponseRemoveWidget: ApiWrapper<[]>;

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

@@ -1,4 +1,5 @@
 import { Filters, Orders } from './utils';
+import { WidgetWrapperProps } from './widgets';
 export type ArticleListConfig = {
     type?: string;
     format?: string;
@@ -42,11 +43,13 @@ export type AddCommentParams = {
     idArticle: number;
     sendAlert: boolean;
     alertAuthor: boolean;
+    widgets?: WidgetWrapperProps[];
 };
 export type UpdateCommentParams = {
-    token: string;
-    description: string;
+    token?: string;
+    description?: string;
     idComment: number;
+    widgets?: WidgetWrapperProps[];
 };
 export type UserRead = {
     idUser: string;

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

@@ -1,9 +1,10 @@
-import { jUserLittle } from './user';
-import { Readable } from './utils';
+import { Rights } from './common';
 import { jFileLittle } from './file';
 import { SocialAction } from './global';
 import { jObjectBase } from './object';
-import { Rights } from './common';
+import { jUserLittle } from './user';
+import { Readable } from './utils';
+import { WidgetWrapperProps } from './widgets';
 export type jCommentLittle = Readable<Omit<jObjectBase, 'dateModified'> & {
     dateCreation: string;
     dateModified: string | null;
@@ -14,4 +15,5 @@ export type jCommentList = jCommentLittle & {
     _right: Rights;
     _attachedFiles?: jFileLittle[];
     _actions?: Record<string, SocialAction>;
+    _widgets?: WidgetWrapperProps[];
 };

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

@@ -1,6 +1,8 @@
 import { jUserLittle } from './user';
 import { Filters, Orders } from './utils';
 import { jObjectBase, jObjectLittle } from './object';
+import { Rights } from './common';
+import { z } from 'zod';
 export type CreateGroup = {
     type: string;
     title: string;
@@ -21,6 +23,52 @@ export type GroupMemberLevel = {
     level: GroupUserLevel;
     user: jUserLittle;
 };
+export type UserLevelAndRight = {
+    userLevelSpot: UserLevelSpot;
+    spotMinLevelToInvit: number;
+    userRights: Rights;
+    accessRequestStatus?: GroupModerateStatus;
+};
+export declare enum GroupModerateStatus {
+    SPOT_MODERATE_IGNORE = 0,
+    SPOT_MODERATE_ACCEPT = 1,
+    SPOT_MODERATE_PENDING = 2
+}
+export declare const userlevelSpotShema: z.ZodObject<{
+    RF_Constant_levelName: z.ZodString;
+    RF_delete: z.ZodBoolean;
+    RF_editing: z.ZodBoolean;
+    RF_level: z.ZodNumber;
+    RF_levelName: z.ZodString;
+    RF_levelName_Trad: z.ZodString;
+    RF_parameters: z.ZodBoolean;
+    RF_setAdmin: z.ZodBoolean;
+    RF_spotit: z.ZodBoolean;
+    RF_spotit_own: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    RF_Constant_levelName: string;
+    RF_delete: boolean;
+    RF_editing: boolean;
+    RF_level: number;
+    RF_levelName: string;
+    RF_levelName_Trad: string;
+    RF_parameters: boolean;
+    RF_setAdmin: boolean;
+    RF_spotit: boolean;
+    RF_spotit_own: boolean;
+}, {
+    RF_Constant_levelName: string;
+    RF_delete: boolean;
+    RF_editing: boolean;
+    RF_level: number;
+    RF_levelName: string;
+    RF_levelName_Trad: string;
+    RF_parameters: boolean;
+    RF_setAdmin: boolean;
+    RF_spotit: boolean;
+    RF_spotit_own: boolean;
+}>;
+export type UserLevelSpot = z.infer<typeof userlevelSpotShema>;
 export type UpdateGroup = CreateGroup & Partial<Omit<GroupProperties, 'rss_feed'>> & {
     uri: string;
     image?: string | null;
@@ -152,3 +200,15 @@ export type GroupListConfig = {
     orders?: Orders;
     filters?: Filters | undefined;
 };
+export declare const validateIsFormatUserLevelSpot: (object: object) => object is {
+    RF_Constant_levelName: string;
+    RF_delete: boolean;
+    RF_editing: boolean;
+    RF_level: number;
+    RF_levelName: string;
+    RF_levelName_Trad: string;
+    RF_parameters: boolean;
+    RF_setAdmin: boolean;
+    RF_spotit: boolean;
+    RF_spotit_own: boolean;
+};

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

@@ -65,6 +65,23 @@ declare const spotRssFeedSchema: z.ZodIntersection<z.ZodObject<{
     isActive: boolean;
 }>, z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>>;
 export type SpotRssFeed = z.infer<typeof spotRssFeedSchema>;
+declare const widgetHookSchema: z.ZodIntersection<z.ZodObject<{
+    isActive: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    isActive: boolean;
+}, {
+    isActive: boolean;
+}>, z.ZodObject<{
+    create: z.ZodBoolean;
+    autorize: z.ZodArray<z.ZodOptional<z.ZodEnum<["message", "comment", "board", "article"]>>, "many">;
+}, "strip", z.ZodTypeAny, {
+    create: boolean;
+    autorize: ("comment" | "message" | "board" | "article" | undefined)[];
+}, {
+    create: boolean;
+    autorize: ("comment" | "message" | "board" | "article" | undefined)[];
+}>>;
+export type WidgetHook = z.infer<typeof widgetHookSchema>;
 /**
  * HookListType
  */
@@ -118,6 +135,22 @@ declare const hookListTypeSchema: z.ZodObject<{
     }, {
         isActive: boolean;
     }>, z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>>>;
+    WidgetHook: z.ZodOptional<z.ZodIntersection<z.ZodObject<{
+        isActive: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        isActive: boolean;
+    }, {
+        isActive: boolean;
+    }>, z.ZodObject<{
+        create: z.ZodBoolean;
+        autorize: z.ZodArray<z.ZodOptional<z.ZodEnum<["message", "comment", "board", "article"]>>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        create: boolean;
+        autorize: ("comment" | "message" | "board" | "article" | undefined)[];
+    }, {
+        create: boolean;
+        autorize: ("comment" | "message" | "board" | "article" | undefined)[];
+    }>>>;
 }, "strip", z.ZodTypeAny, {
     DriveHook?: ({
         isActive: boolean;
@@ -138,6 +171,12 @@ declare const hookListTypeSchema: z.ZodObject<{
     spotRssFeed?: ({
         isActive: boolean;
     } & {}) | undefined;
+    WidgetHook?: ({
+        isActive: boolean;
+    } & {
+        create: boolean;
+        autorize: ("comment" | "message" | "board" | "article" | undefined)[];
+    }) | undefined;
 }, {
     DriveHook?: ({
         isActive: boolean;
@@ -158,6 +197,12 @@ declare const hookListTypeSchema: z.ZodObject<{
     spotRssFeed?: ({
         isActive: boolean;
     } & {}) | undefined;
+    WidgetHook?: ({
+        isActive: boolean;
+    } & {
+        create: boolean;
+        autorize: ("comment" | "message" | "board" | "article" | undefined)[];
+    }) | undefined;
 }>;
 export type HookListType = z.infer<typeof hookListTypeSchema>;
 export declare const validateIsFormatHookListType: (object: object) => HookListType;

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

@@ -71,6 +71,10 @@ export type jLinkList<T extends jObjectBase = jObjectLittle | jUserLittle> = jLi
     _src?: T;
     _target?: T | undefined;
 };
+export type jHref = {
+    href: string;
+    target: string;
+};
 export type jArticleLittle = jObjectLittle & {
     dateCreation: string;
     dateModified: string;

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

@@ -1,6 +1,7 @@
 import { AudienceAutocomplete } from './autocomplete';
 import { jFileLittle } from './file';
-import { jArticleList, jArticleLittle } from './utils';
+import { jUserLittle } from './user';
+import { jArticleList, jArticleLittle, jHref } from './utils';
 export type jArticleWidgetLittle = jArticleLittle & {
     articleWidgets: WidgetWrapperProps[];
     articleWidgetDisplayMode: null | undefined | string;
@@ -36,6 +37,7 @@ export type WidgetTypeKeys = {
     'widget-article-attachment': WidgetArticleAttachmentType;
     'widget-api': WidgetApiType;
     'widget-article-slider': WidgetArticleSliderType;
+    'widget-check-list': WidgetCheckListType;
 };
 export type WidgetContentKeys = {
     'widget-article-button': WidgetArticleButtonContent;
@@ -46,6 +48,7 @@ export type WidgetContentKeys = {
     'widget-article-attachment': WidgetArticleAttachmentContent;
     'widget-api': WidgetApiContent;
     'widget-article-slider': WidgetArticleSliderContent;
+    'widget-check-list': WidgetCheckListContent;
 };
 export type WidgetKeys = keyof WidgetTypeKeys;
 export type WidgetExtendedType = {
@@ -91,6 +94,18 @@ export type WidgetArticleSliderType = {
     uniqid: string;
     content: WidgetArticleSliderContent;
 };
+export type WidgetCheckListType = {
+    title: string;
+    name: 'widget-check-list';
+    uniqid: string;
+    content: WidgetCheckListContent;
+};
+export type WidgetCheckListTypeForFront = {
+    title: string;
+    name: 'widget-check-list';
+    uniqid: string;
+    content: WidgetCheckListContentForFront;
+};
 export type CSSTextAlignType = 'left' | 'right' | 'center' | 'justify';
 export type CSSBackgroundPosition = 'top' | 'bottom' | 'center' | 'left' | 'right';
 export type CSSBackgroundSize = 'auto' | 'contain' | 'cover';
@@ -176,9 +191,35 @@ export type WidgetArticleSliderContent = {
     useDots?: boolean;
     startAt?: number;
 };
+export type WidgetCheckListContent = {
+    arr?: WidgetCheckListContentArr[];
+};
+export type WidgetCheckListContentForFront = {
+    arr?: WidgetCheckListContentArrForFront[];
+};
+export type WidgetCheckListContentArr = {
+    title: string;
+    value?: boolean;
+    links?: jHref[];
+    id?: number;
+    user?: {
+        id: number;
+        type: 'user';
+        mainType: 'user';
+    };
+};
+export type WidgetCheckListContentArrForFront = {
+    text: string;
+    value?: boolean;
+    links?: jHref[];
+    uri?: string;
+    mimetype?: string;
+    id?: number;
+    user?: jUserLittle;
+};
 export type CombinedWidgetContent = {
     widgets?: WidgetWrapperProps[];
-} & (WidgetArticleTextContent | WidgetArticleImageContent | WidgetArticleTitleContent | WidgetArticleButtonContent | WidgetArticleGalleryContent | WidgetArticleAttachmentContent | WidgetApiContent | WidgetArticleSliderContent);
+} & (WidgetArticleTextContent | WidgetArticleImageContent | WidgetArticleTitleContent | WidgetArticleButtonContent | WidgetArticleGalleryContent | WidgetArticleAttachmentContent | WidgetApiContent | WidgetArticleSliderContent | WidgetCheckListContent);
 export type WidgetStateProps = {
     busy?: boolean | undefined;
     loading?: boolean | undefined;

package/package.json

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

package/phpunitMock/spotAddToFavorite-bad.json

@@ -0,0 +1,7 @@
+{
+    "o": "spot",
+    "f": "addToFavorite",
+    "error": 400,
+    "messages": [],
+    "errorMsg": "Ce groupe est privé. Il vous faut une invitation par un membre du groupe pour en faire partie."
+}

package/phpunitMock/spotAddToFavorite-forbidden.json

@@ -0,0 +1,7 @@
+{
+    "o": "spot",
+    "f": "addToFavorite",
+    "error": 403,
+    "messages": [],
+    "errorMsg": "Vous n'êtes pas autorisé"
+}

package/phpunitMock/spotAddToFavorite-success.json

@@ -0,0 +1,7 @@
+{
+    "o": "spot",
+    "f": "addToFavorite",
+    "error": 0,
+    "messages": "Vous êtes désormais membre de ce groupe",
+    "result": true
+}

package/phpunitMock/spotGetUserLevelAndRight-default.json

@@ -0,0 +1,31 @@
+{
+    "o": "spot",
+    "f": "getUserLevelAndRight",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "userLevelSpot": {
+            "RF_delete": true,
+            "RF_parameters": true,
+            "RF_spotit": true,
+            "RF_spotit_own": true,
+            "RF_editing": true,
+            "RF_setAdmin": true,
+            "RF_Constant_levelName": "Creator",
+            "RF_levelName": "Creator",
+            "RF_level": 0,
+            "RF_levelName_Trad": "Fondateur"
+        },
+        "spotMinLevelToInvit": 2,
+        "userRights": {
+            "create": false,
+            "read": true,
+            "publish": true,
+            "administrate": false,
+            "update": true,
+            "delete": true,
+            "comment": false,
+            "member": true
+        }
+    }
+}

package/phpunitMock/spotRequest-forbidden.json

@@ -0,0 +1,7 @@
+{
+    "o": "spot",
+    "f": "request",
+    "error": 403,
+    "messages": [],
+    "errorMsg": "ERROR_Access_Forbidden"
+}

package/phpunitMock/spotRequest-pending.json

@@ -0,0 +1,7 @@
+{
+    "o": "spot",
+    "f": "request",
+    "error": 400,
+    "messages": [],
+    "errorMsg": "Votre demande est en attente de validation."
+}

package/phpunitMock/spotRequest-success.json

@@ -0,0 +1,7 @@
+{
+    "o": "spot",
+    "f": "request",
+    "error": 0,
+    "messages": [],
+    "result": true
+}