jamespot-user-api 1.0.158 → 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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jamespot-user-api",
-  "version": "1.0.158",
+  "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
+}