jamespot-user-api 1.0.208 → 1.0.209

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

@@ -226,6 +226,104 @@ export declare class JGroupApi extends JBaseApi {
             widgets: {
                 id: string;
                 title: string;
+                enabled?: boolean | undefined;
+            }[];
+            custom_widgets: never[] | Record<string, {
+                type: string;
+                title: string;
+                url: string;
+                idSpot: string;
+                idOrder: string;
+                idWidget: string;
+                visible: string;
+            }>;
+            isArchive: number;
+            fileSyncVersioningType: {
+                value: string | number;
+                label: string;
+            }[];
+        };
+        _errors: [];
+        lastRssExecution?: Record<string, string> | undefined;
+    }, BaseMessages>>;
+    /**
+     * Get the widgets of a group
+     * @param idSpot
+     * @returns
+     */
+    getWidgets(idSpot: number | string): Promise<ApiWrapper<{
+        edit_access: "" | "author";
+        commentLevel: "1" | "-1" | "2" | "3";
+        displayType: string;
+        user_level_signup: "" | "1" | "2" | "3";
+        spot_right_user: string;
+        useTeaser: "" | "0" | "1" | null;
+        spotDefaultPublishType: string;
+        mail_frequency: string;
+        widgets: string[];
+        fileSyncVersioningType: "overwrite" | "author-change";
+        nounsubscribe: "0" | "1";
+        rss_feed: {
+            url: string;
+            idUser: number;
+            date?: string | undefined;
+            send?: boolean | undefined;
+            _user?: jUserLittle | undefined;
+            error?: string | undefined;
+        }[] | null;
+        mail_comment: "" | "1";
+        mail_spotit: "" | "1";
+        mail_subscriber: "" | "1";
+        lock_mail: "" | "1";
+        activity: "0" | "1";
+        publishFolder: "0" | "1";
+        notifyFolder: "0" | "1";
+        rss_access: "0" | "1";
+        rss_key: string;
+        fileSyncEnabled: "0" | "1";
+        fileBankQuota: string;
+        _options: {
+            edit_access: ({
+                value: string | number;
+                label: string;
+            } & {
+                description: string;
+            })[];
+            commentLevel: ({
+                value: string | number;
+                label: string;
+            } & {
+                selected?: boolean | undefined;
+            })[];
+            displayType: {
+                value: string | number;
+                label: string;
+            }[];
+            user_level_signup: ({
+                value: string | number;
+                label: string;
+            } & {
+                selected?: boolean | undefined;
+            })[];
+            spot_right_user: ({
+                value: string | number;
+                label: string;
+            } & {
+                selected?: boolean | undefined;
+            })[];
+            useTeaser: {
+                value: string | number;
+                label: string;
+            }[];
+            spotDefaultPublishType: string[];
+            mail_frequency: {
+                value: string | number;
+                label: string;
+            }[];
+            widgets: {
+                id: string;
+                title: string;
+                enabled?: boolean | undefined;
             }[];
             custom_widgets: never[] | Record<string, {
                 type: string;

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

@@ -1,7 +1,8 @@
 import { ApiDefaultWrapper, ApiPagingResults, ApiWrapper, jArticleList, jGroupLittle, jGroupView, jSpotAutocomplete, PagingResults, UserLevelAndRight } from '../../types';
-import { Category, GroupMemberLevel, GroupProperties, GroupWidget } from '../../types/group';
+import { Category, GroupMemberLevel, GroupProperties, GroupWidget, GroupWidgets } from '../../types/group';
 export declare const spot: ApiWrapper<jGroupView>;
 export declare const properties: ApiWrapper<GroupProperties>;
+export declare const widgets: ApiWrapper<GroupWidgets>;
 export declare const groupAutocompleteA: ApiWrapper<jSpotAutocomplete[]>;
 export declare const groupCreate: ApiWrapper<jGroupView>;
 export declare const groupUpdate: ApiWrapper<jGroupView>;

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

@@ -225,12 +225,15 @@ export type ValueLabel = z.infer<typeof valueLabelSchema>;
 export declare const groupWidgetLittleSchema: z.ZodObject<{
     id: z.ZodString;
     title: z.ZodString;
+    enabled: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     id: string;
     title: string;
+    enabled?: boolean | undefined;
 }, {
     id: string;
     title: string;
+    enabled?: boolean | undefined;
 }>;
 export type GroupWidgetLittle = z.infer<typeof groupWidgetLittleSchema>;
 export declare const groupCustomWidgetSchema: z.ZodObject<{
@@ -358,12 +361,15 @@ export declare const groupPropertiesOptionsSchema: z.ZodObject<{
     widgets: z.ZodArray<z.ZodObject<{
         id: z.ZodString;
         title: z.ZodString;
+        enabled: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
         id: string;
         title: string;
+        enabled?: boolean | undefined;
     }, {
         id: string;
         title: string;
+        enabled?: boolean | undefined;
     }>, "many">;
     custom_widgets: z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodObject<{
         idSpot: z.ZodString;
@@ -442,6 +448,7 @@ export declare const groupPropertiesOptionsSchema: z.ZodObject<{
     widgets: {
         id: string;
         title: string;
+        enabled?: boolean | undefined;
     }[];
     custom_widgets: never[] | Record<string, {
         type: string;
@@ -498,6 +505,7 @@ export declare const groupPropertiesOptionsSchema: z.ZodObject<{
     widgets: {
         id: string;
         title: string;
+        enabled?: boolean | undefined;
     }[];
     custom_widgets: never[] | Record<string, {
         type: string;
@@ -718,12 +726,15 @@ export declare const groupPropertiesSchema: z.ZodObject<{
         widgets: z.ZodArray<z.ZodObject<{
             id: z.ZodString;
             title: z.ZodString;
+            enabled: z.ZodOptional<z.ZodBoolean>;
         }, "strip", z.ZodTypeAny, {
             id: string;
             title: string;
+            enabled?: boolean | undefined;
         }, {
             id: string;
             title: string;
+            enabled?: boolean | undefined;
         }>, "many">;
         custom_widgets: z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodObject<{
             idSpot: z.ZodString;
@@ -802,6 +813,7 @@ export declare const groupPropertiesSchema: z.ZodObject<{
         widgets: {
             id: string;
             title: string;
+            enabled?: boolean | undefined;
         }[];
         custom_widgets: never[] | Record<string, {
             type: string;
@@ -858,6 +870,7 @@ export declare const groupPropertiesSchema: z.ZodObject<{
         widgets: {
             id: string;
             title: string;
+            enabled?: boolean | undefined;
         }[];
         custom_widgets: never[] | Record<string, {
             type: string;
@@ -948,6 +961,7 @@ export declare const groupPropertiesSchema: z.ZodObject<{
         widgets: {
             id: string;
             title: string;
+            enabled?: boolean | undefined;
         }[];
         custom_widgets: never[] | Record<string, {
             type: string;
@@ -1038,6 +1052,7 @@ export declare const groupPropertiesSchema: z.ZodObject<{
         widgets: {
             id: string;
             title: string;
+            enabled?: boolean | undefined;
         }[];
         custom_widgets: never[] | Record<string, {
             type: string;
@@ -1058,6 +1073,20 @@ export declare const groupPropertiesSchema: z.ZodObject<{
     lastRssExecution?: Record<string, string> | undefined;
 }>;
 export type GroupProperties = z.infer<typeof groupPropertiesSchema>;
+export declare const groupWidgetsSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodString;
+    title: z.ZodString;
+    enabled: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    title: string;
+    enabled?: boolean | undefined;
+}, {
+    id: string;
+    title: string;
+    enabled?: boolean | undefined;
+}>, "many">;
+export type GroupWidgets = z.infer<typeof groupWidgetsSchema>;
 export declare const updateGroupSchema: z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
     type: z.ZodString;
     title: z.ZodString;
@@ -1207,12 +1236,15 @@ export declare const updateGroupSchema: z.ZodIntersection<z.ZodIntersection<z.Zo
         widgets: z.ZodArray<z.ZodObject<{
             id: z.ZodString;
             title: z.ZodString;
+            enabled: z.ZodOptional<z.ZodBoolean>;
         }, "strip", z.ZodTypeAny, {
             id: string;
             title: string;
+            enabled?: boolean | undefined;
         }, {
             id: string;
             title: string;
+            enabled?: boolean | undefined;
         }>, "many">;
         custom_widgets: z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodObject<{
             idSpot: z.ZodString;
@@ -1291,6 +1323,7 @@ export declare const updateGroupSchema: z.ZodIntersection<z.ZodIntersection<z.Zo
         widgets: {
             id: string;
             title: string;
+            enabled?: boolean | undefined;
         }[];
         custom_widgets: never[] | Record<string, {
             type: string;
@@ -1347,6 +1380,7 @@ export declare const updateGroupSchema: z.ZodIntersection<z.ZodIntersection<z.Zo
         widgets: {
             id: string;
             title: string;
+            enabled?: boolean | undefined;
         }[];
         custom_widgets: never[] | Record<string, {
             type: string;
@@ -1429,6 +1463,7 @@ export declare const updateGroupSchema: z.ZodIntersection<z.ZodIntersection<z.Zo
         widgets: {
             id: string;
             title: string;
+            enabled?: boolean | undefined;
         }[];
         custom_widgets: never[] | Record<string, {
             type: string;
@@ -1511,6 +1546,7 @@ export declare const updateGroupSchema: z.ZodIntersection<z.ZodIntersection<z.Zo
         widgets: {
             id: string;
             title: string;
+            enabled?: boolean | undefined;
         }[];
         custom_widgets: never[] | Record<string, {
             type: string;

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

@@ -73,6 +73,7 @@ export declare const checkProperties: (group: jGroupView & GroupProperties, upda
         widgets: {
             id: string;
             title: string;
+            enabled?: boolean | undefined;
         }[];
         custom_widgets: never[] | Record<string, {
             type: string;

package/package.json

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

package/phpunitMock/spotGetWidgets-default.json

@@ -0,0 +1,10 @@
+{
+    "o": "spot",
+    "f": "getWidgets",
+    "error": 0,
+    "messages": [],
+    "result": [
+        { "id": "fbank_box", "title": "Banque documentaire", "enabled": false },
+        { "id": "spot_tags_box", "title": "Tags", "enabled": false }
+    ]
+}