jamespot-user-api 1.0.106 → 1.0.107

package/lib/src/apis/{group.d.ts → group/group.d.ts}

@@ -1,5 +1,6 @@
-import { ApiReturn, Category, CreateGroup, Format, GroupList, GroupProperties, GroupView, GroupWidget, PagingResults, UpdateGroup } from '../types';
-import { JBaseApi } from './base';
+import { Category, CreateGroup, GroupList, GroupProperties, GroupView, GroupWidget, ResetNotificationConfiguration, UpdateGroup } from './group.types';
+import { JBaseApi } from '../base';
+import { ApiReturn, Format, PagingResults } from '../../types';
 export declare class JGroupApi extends JBaseApi {
     /**
      * Create a group from scratch
@@ -7,7 +8,7 @@ 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, {
+    create<T extends Format = undefined>(group: CreateGroup, format?: T): Promise<import("../../types").ApiWrapper<ApiReturn<T, {
         id: number;
         mainType: string;
         type: string;
@@ -25,14 +26,14 @@ export declare class JGroupApi extends JBaseApi {
         dateModified?: string;
         title: string;
         _url: string;
-    }>, import("../types").BaseMessages>>;
+    }>, 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, {
+    update<T extends Format = undefined>(group: UpdateGroup, format?: T): Promise<import("../../types").ApiWrapper<ApiReturn<T, {
         id: number;
         mainType: string;
         type: string;
@@ -41,14 +42,14 @@ export declare class JGroupApi extends JBaseApi {
         dateModified?: string;
         title: string;
         _url: string;
-    }, GroupList, GroupView, string>, import("../types").BaseMessages>>;
+    }, 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, {
+    getSpot<T extends Format = undefined>(idSpot: number | string, format?: T): Promise<import("../../types").ApiWrapper<ApiReturn<T, {
         id: number;
         mainType: string;
         type: string;
@@ -57,22 +58,22 @@ export declare class JGroupApi extends JBaseApi {
         dateModified?: string;
         title: string;
         _url: string;
-    }, GroupList, GroupView, string>, import("../types").BaseMessages>>;
+    }, 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<import("../../types").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<import("../../types").ApiWrapper<Record<string, GroupWidget>, import("../../types").BaseMessages>>;
     /**
      * Get the available group categories
      * @returns
      */
-    getCategories(): Promise<import("../types").ApiWrapper<Category[], import("../types").BaseMessages>>;
+    getCategories(): Promise<import("../../types").ApiWrapper<Category[], import("../../types").BaseMessages>>;
     /**
      * Get the members of a group
      * @param idSpot spot id
@@ -81,7 +82,7 @@ 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<import("../../types").ApiWrapper<PagingResults<{
         id: number;
         mainType: string;
         type: string;
@@ -90,5 +91,14 @@ export declare class JGroupApi extends JBaseApi {
         dateModified?: string;
         title: string;
         _url: string;
-    }>, import("../types").BaseMessages>>;
+    }>, import("../../types").BaseMessages>>;
+    /**
+     * Reset the notifications configuration for all users of the group
+     * @param config configuration
+     * @returns
+     */
+    resetNotifications(config: ResetNotificationConfiguration): Promise<import("../../types").ApiWrapper<{
+        members: number;
+        msg: string;
+    }, import("../../types").BaseMessages>>;
 }

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

@@ -0,0 +1,4 @@
+import { ApiWrapper } from '../../types';
+import { GroupProperties, GroupView } from './group.types';
+export declare const spot: ApiWrapper<GroupView>;
+export declare const properties: ApiWrapper<GroupProperties>;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,122 @@
+import { jObjectLittle } from '../../types/utils';
+export declare type CreateGroup = {
+    type: string;
+    title: string;
+    description: string;
+    privacy: string | number;
+    edito: string | null;
+    language: string;
+    category: string;
+    idCommunity?: string;
+};
+export declare type SpotBannerImage = {
+    id: string;
+    name: string;
+    size: string;
+};
+export declare type UpdateGroup = CreateGroup & Partial<GroupProperties> & {
+    uri: string;
+    image?: string | null;
+    spotBanner?: [] | Record<string, SpotBannerImage>;
+    token?: string;
+    uriCommunity?: string;
+    custom_widgets?: Record<string, GroupCustomWidget> | [];
+};
+export declare type GroupProperties = {
+    edit_access: '' | 'author';
+    commentLevel: '-1' | '1' | '2' | '3';
+    user_level_signup: '' | '1' | '2' | '3';
+    nounsubscribe: '' | '1';
+    useTeaser: '' | '1' | '2';
+    displayType: string;
+    spot_right_user: string;
+    rss_feed: Array<RssType> | '';
+    spotDefaultPublishType: string;
+    mail_frequency: string;
+    mail_comment: '1' | '';
+    mail_spotit: '1' | '';
+    mail_subscriber: '1' | '';
+    lock_mail: '1' | '';
+    activity: '1' | '0';
+    publishFolder: '1' | '0';
+    notifyFolder: '1' | '0';
+    widgets: Array<string>;
+    rss_access: '1' | '0';
+    rss_key: string;
+    _options: GroupPropertiesOptions;
+    _errors: [];
+    lastRssExecution?: Record<string, string>;
+};
+export declare type GroupPropertiesOptions = {
+    edit_access: Array<ValueLabel & {
+        description: string;
+    }>;
+    commentLevel: Array<ValueLabel & {
+        selected?: boolean;
+    }>;
+    displayType: Array<ValueLabel>;
+    user_level_signup: Array<ValueLabel & {
+        selected?: boolean;
+    }>;
+    spot_right_user: Array<ValueLabel & {
+        selected?: boolean;
+    }>;
+    useTeaser: Array<ValueLabel>;
+    spotDefaultPublishType: Array<string>;
+    mail_frequency: Array<ValueLabel>;
+    widgets: Array<GroupWidget>;
+    custom_widgets: Record<string, GroupCustomWidget> | [];
+};
+export declare type RssType = {
+    url: string;
+    idUser: number;
+    send: boolean | undefined;
+    error?: string;
+};
+export declare type ValueLabel = {
+    value: string | number;
+    label: string;
+};
+export declare type GroupWidget = {
+    id: string;
+    title: string;
+};
+export declare type GroupCustomWidget = {
+    idSpot: string;
+    idOrder: string;
+    idWidget: string;
+    type: string;
+    title: string;
+    url: string;
+    visible: string;
+};
+export interface Category {
+    id: string;
+    idorder: number;
+    label: string;
+}
+export declare type GroupLittle = jObjectLittle & {
+    dateCreation: string;
+    dateModified: string;
+};
+export declare type GroupList = GroupLittle & {
+    description: string;
+    privacy: string | number;
+    edito: string | null;
+    language: string;
+    category: string;
+    idCategory: number;
+};
+export declare type GroupView = GroupList & {
+    image?: string | null;
+    spotBanner?: [] | Record<string, SpotBannerImage>;
+    idCommunity?: string;
+    useTeaser?: string;
+};
+export declare type ResetNotificationConfiguration = {
+    idSpot: string | number;
+    mailFrequency: string | number;
+    mailSpotit: boolean;
+    mailComment: boolean;
+    mailSubscriber: boolean;
+};

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

@@ -0,0 +1,2 @@
+export * from './group';
+export * from './group.types';

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

@@ -8,7 +8,7 @@ import { JCommunityApi } from './community';
 import { JDriveApi } from './drive/drive';
 import { JFileApi } from './file';
 import { JFilebankApi } from './filebank';
-import { JGroupApi } from './group';
+import { JGroupApi } from './group/group';
 import { JMediaLibraryApi } from './mediaLibrary/mediaLibrary';
 import { JLandApi } from './jland/jland';
 import { JMessengerApi } from './messenger';

package/lib/src/index.d.ts

@@ -11,8 +11,6 @@ export { JamespotUserApiInstance };
 export default JamespotUserApiInstance;
 export * from './apis';
 export * from './types';
-export * from './util/network';
-export * from './util/file';
-export * from './util/ensure';
+export * from './util/';
 export * from './window';
 export declare const api: typeof JamespotUserApi;

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

@@ -1,3 +1,4 @@
+import { jObjectLittle } from './utils';
 export interface BaseAutocomplete {
     id: string;
     uri: string;
@@ -22,3 +23,14 @@ export declare type jSpotAutocomplete = jObjectAutocomplete & {
 };
 export declare type AudienceAutocomplete = jObjectAutocomplete | jUserAutocomplete | jSpotAutocomplete;
 export declare type CommunityAutocomplete = jObjectAutocomplete;
+export declare type Community = jObjectLittle & {
+    isTechnical: number;
+    status: number;
+    image: string;
+    isMember: boolean;
+    stats: {
+        moderators: number;
+        members: string;
+    };
+    _members: Array<jObjectLittle>;
+};

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

@@ -7,7 +7,6 @@ export * from './autocomplete';
 export * from './bookmark';
 export * from './drive';
 export * from './file';
-export * from './group';
 export * from './mediaLibrary';
 export * from './model';
 export * from './search';

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

@@ -1,25 +1,51 @@
-import { jObjectBase } from './utils';
+import { AllKeys, Readable, jObjectBase } from './utils';
 declare type BookmarksFunctions = 'update' | 'add' | 'delete';
 declare type CustomActionFunctions = 'update' | 'add' | 'remove';
+declare type WSFunctions = 'presence' | 'connection' | 'disconnect';
 export declare type Namespaces = {
     BOOKMARKS: BookmarksFunctions;
     'CUSTOM-ACTION': CustomActionFunctions;
+    ws: WSFunctions;
 };
-export declare type RTMessageHandler<T extends keyof Namespaces = 'CUSTOM-ACTION'> = {
+export declare type AllMessages = {
+    BOOKMARKS: {
+        update: RTMessageObject<'BOOKMARKS', 'update'>;
+        add: RTMessageObject<'BOOKMARKS', 'add'>;
+        delete: RTMessageObject<'BOOKMARKS', 'delete'>;
+    };
+    'CUSTOM-ACTION': {
+        update: RTMessageObject<'CUSTOM-ACTION', 'update'>;
+        add: RTMessageObject<'CUSTOM-ACTION', 'add'>;
+        remove: RTMessageObject<'CUSTOM-ACTION', 'remove'>;
+    };
+    ws: {
+        presence: RTMessageWsPresence;
+        connection: RTMessage<'ws', 'connection'>;
+        disconnect: RTMessage<'ws', 'disconnect'>;
+    };
+};
+declare type NamespacesMessages<T extends keyof AllMessages> = Readable<AllMessages[T] & Record<Exclude<AllKeys<AllMessages[keyof AllMessages]>, keyof AllMessages[T]>, never>>;
+declare type AllMessagesInternal = {
+    [K in keyof AllMessages]: NamespacesMessages<K>;
+};
+export declare type RTMessageHandler<T extends keyof AllMessages, F extends keyof AllMessages[T]> = {
     namespace: T;
-    function: Namespaces[T];
-    handler: (message: RTMessage<T>) => any;
+    function: F;
+    handler: (message: AllMessagesInternal[T][F]) => void;
 };
 export declare type AnyRTHandlerFunction = {
-    [K in keyof Namespaces]: RTMessageHandler<K>['handler'];
+    [K in keyof Namespaces]: RTMessageHandler<K, keyof AllMessages[K]>['handler'];
 }[keyof Namespaces];
-export declare type RTMessage<T extends keyof Namespaces = 'CUSTOM-ACTION', O extends jObjectBase = jObjectBase> = {
+export declare type RTMessage<T extends keyof Namespaces, F extends Namespaces[T]> = {
     namespace: T;
-    function: Namespaces[T];
+    function: F;
+};
+export declare type RTMessageObject<T extends keyof Namespaces, F extends Namespaces[T], O extends jObjectBase = jObjectBase> = RTMessage<T, F> & {
     object: O;
 };
-export declare type AnyRTMessage = {
-    [K in keyof Namespaces]: RTMessage<K>;
-}[keyof Namespaces];
-export declare type RTReceivedMessage<T extends keyof Namespaces> = ['message', RTMessage<T>];
+export declare type RTMessageWsPresence = RTMessage<'ws', 'presence'> & {
+    idUsers: number[];
+};
+export declare type AnyRTMessage = RTMessageObject<'BOOKMARKS', 'update'> | RTMessageObject<'BOOKMARKS', 'add'> | RTMessageObject<'BOOKMARKS', 'delete'> | RTMessageObject<'CUSTOM-ACTION', 'update'> | RTMessageObject<'CUSTOM-ACTION', 'add'> | RTMessageObject<'CUSTOM-ACTION', 'remove'> | RTMessageWsPresence | RTMessage<'ws', 'connection'> | RTMessage<'ws', 'disconnect'>;
+export declare type RTReceivedMessage<T extends keyof Namespaces, F extends Namespaces[T]> = ['message', RTMessage<T, F>];
 export {};

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

@@ -9,7 +9,7 @@ import { jUserLittle } from './user';
 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;
+export 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

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

@@ -0,0 +1,4 @@
+export * from './ensure';
+export * from './file';
+export * from './network';
+export * from './object';

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

@@ -0,0 +1 @@
+export declare function deepEqual(a: any, b: any, ignoreAttributes?: Array<string>): boolean;

package/lib/src/util/object.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

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

package/phpunitMock/spotGet-default.json

@@ -0,0 +1,25 @@
+{
+    "o": "spot",
+    "f": "get",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "id": 2,
+        "mainType": "spot",
+        "type": "spot",
+        "uri": "spot/2",
+        "dateCreation": "2019-07-19 18:36:24",
+        "dateModified": "2023-06-08 09:19:44",
+        "title": "Groupe public",
+        "_url": "/group/2",
+        "privacy": 1,
+        "idCategory": 1,
+        "category": "1",
+        "description": "",
+        "edito": null,
+        "language": "fr",
+        "image": null,
+        "spotBanner": [],
+        "useTeaser": ""
+    }
+}

package/phpunitMock/spotGetProperties-default.json

@@ -0,0 +1,77 @@
+{
+    "o": "spot",
+    "f": "getProperties",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "_options": {
+            "custom_widgets": [],
+            "edit_access": [
+                { "value": "", "label": "Administrateur", "description": "SPOT_Edit_Access_Admin_Description" },
+                {
+                    "value": "author",
+                    "label": "R\u00e9dacteur",
+                    "description": "SPOT_Edit_Access_Contributor_Description"
+                }
+            ],
+            "commentLevel": [
+                { "value": "3", "label": "Member", "selected": true },
+                { "value": "2", "label": "Contributor" },
+                { "value": "1", "label": "Administrator" }
+            ],
+            "user_level_signup": [
+                { "value": "3", "label": "Member" },
+                { "value": "2", "label": "Contributor", "selected": true },
+                { "value": "1", "label": "Administrator" }
+            ],
+            "useTeaser": [
+                { "value": "", "label": "Param\u00e8tres par default" },
+                { "value": 1, "label": "Oui" },
+                { "value": 0, "label": "Non" }
+            ],
+            "displayType": [
+                { "value": "doc", "label": "Documentaire" },
+                { "value": "wall", "label": "Dynamique" }
+            ],
+            "spot_right_user": [
+                { "value": "3", "label": "Member" },
+                { "value": "2", "label": "Contributor", "selected": true },
+                { "value": "1", "label": "Administrator" },
+                { "value": "0", "label": "Creator" }
+            ],
+            "spotDefaultPublishType": ["mpMedia", "mpArticle", "mpSocialFile", "socialQuestion"],
+            "mail_frequency": [
+                { "value": -1, "label": "Fr\u00e9quence par d\u00e9faut (Temps r\u00e9el)" },
+                { "value": 0, "label": "Temps r\u00e9el" },
+                { "value": 1, "label": "Quotidien" },
+                { "value": 2, "label": "Hebdomadaire" },
+                { "value": 10, "label": "Jamais" }
+            ],
+            "widgets": [
+                { "id": "fbank_box", "title": "Banque documentaire" },
+                { "id": "spot_tags_box", "title": "Tags" }
+            ]
+        },
+        "_errors": [],
+        "edit_access": "",
+        "commentLevel": "3",
+        "user_level_signup": "3",
+        "nounsubscribe": "1",
+        "useTeaser": "",
+        "displayType": "wall",
+        "spot_right_user": "2",
+        "rss_access": "0",
+        "rss_key": "",
+        "rss_feed": "",
+        "spotDefaultPublishType": "mpArticle",
+        "mail_frequency": "-1",
+        "mail_comment": "1",
+        "mail_spotit": "1",
+        "mail_subscriber": "",
+        "lock_mail": "",
+        "activity": "1",
+        "publishFolder": "1",
+        "notifyFolder": "1",
+        "widgets": []
+    }
+}

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

@@ -1,58 +0,0 @@
-import { jObjectLittle } from './utils';
-export declare type CreateGroup = {
-    type: string;
-    title: string;
-    description: string;
-    privacy: string;
-    edito: string;
-    language: string;
-    idCategory: string;
-    idCommunity?: string;
-};
-export declare type SpotBannerImage = {
-    id: string;
-    name: string;
-    size: string;
-};
-export declare type UpdateGroup = CreateGroup & GroupProperties & {
-    uri: string;
-    image?: string;
-    spotBanner?: [] | Record<string, SpotBannerImage>;
-    token?: string;
-    uriCommunity?: string;
-};
-export declare type GroupProperties = {
-    edit_access?: '' | 'author';
-    commentLevel?: '-1' | '1' | '2' | '3';
-    user_level_signup?: '' | '1' | '2' | '3';
-    nounsubscribe?: '' | '1';
-};
-export declare type GroupWidget = {
-    idWidget: string;
-    title: string;
-    url: string;
-    type: string;
-    icon: string;
-    description: string;
-};
-export interface Category {
-    id: string;
-    idorder: number;
-    label: string;
-}
-export declare type GroupLittle = jObjectLittle & {
-    dateCreation: string;
-    dateModified: string;
-};
-export declare type GroupList = GroupLittle & {
-    description: string;
-    privacy: string;
-    edito: string;
-    language: string;
-    idCategory: string;
-};
-export declare type GroupView = GroupList & {
-    image?: string;
-    spotBanner?: [] | Record<string, SpotBannerImage>;
-    uriCommunity?: string;
-};