jamespot-user-api 1.0.149 → 1.0.151

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

@@ -10,7 +10,40 @@ export interface ListFilterSpec {
 export declare class JBookmarkApi extends JBaseApi {
     getFormattedList<T extends keyof BookmarkTypes>(filterSpecs: ListFilterSpec, format: T): Promise<ApiWrapper<PagingResults<BookmarkTypes[T]>, import("../../types").BaseMessages>>;
     addFormattedLink<T extends keyof BookmarkTypes>(targetId: number, targetType: string, format: T): Promise<ApiWrapper<BookmarkTypes[T], import("../../types").BaseMessages>>;
-    addBookmark(bookmark: Pick<BookmarkTypes[keyof BookmarkTypes], 'bookmarkLabel' | 'bookmarkMeta' | 'bookmarkUrl'>, format?: keyof BookmarkTypes): Promise<ApiWrapper<import("../../types").BookmarkList<import("../../types").jObjectLittle> | import("../../types").BookmarkRawList<import("../../types").jObjectLittle | import("../../types").jUserLittle>, BaseMessagesOne>>;
+    addBookmark(bookmark: Pick<BookmarkTypes[keyof BookmarkTypes], 'bookmarkLabel' | 'bookmarkMeta' | 'bookmarkUrl'>, format?: keyof BookmarkTypes): Promise<ApiWrapper<import("../../types").BookmarkList<{
+        type: string;
+        id: number;
+        mainType: string;
+        uri: string;
+        title: string;
+        _url: string;
+        dateCreation?: string | undefined;
+        dateModified?: string | null | undefined;
+    }> | import("../../types").BookmarkRawList<{
+        type: string;
+        id: number;
+        mainType: string;
+        uri: string;
+        title: string;
+        _url: string;
+        dateCreation?: string | undefined;
+        dateModified?: string | null | undefined;
+    } | import("zod").objectOutputType<{
+        type: import("zod").ZodString;
+        id: import("zod").ZodNumber;
+        mainType: import("zod").ZodString;
+        uri: import("zod").ZodString;
+        title: import("zod").ZodString;
+        _url: import("zod").ZodString;
+        level: import("zod").ZodNativeEnum<{
+            readonly ADMIN: 9;
+            readonly USER: 5;
+            readonly EXTERNAL: 3;
+            readonly GUEST: 0;
+        }>;
+        dateCreation: import("zod").ZodString;
+        dateModified: import("zod").ZodString;
+    }, import("zod").ZodUnion<[import("zod").ZodNumber, import("zod").ZodNullable<import("zod").ZodString>, import("zod").ZodNullable<import("zod").ZodString>, import("zod").ZodNullable<import("zod").ZodString>, import("zod").ZodString, import("zod").ZodNumber, import("zod").ZodNullable<import("zod").ZodString>, import("zod").ZodString, import("zod").ZodString]>, "strip">>, BaseMessagesOne>>;
     delete(bookmarkId: number): Promise<ApiWrapper<null, BaseMessagesOne>>;
     rename(bookmarkID: number, bookmarkLabel: string, bookmarkUrl?: string): Promise<ApiWrapper<null, BaseMessagesOne>>;
     move(bookmarkID: number, bookmarkReference: number, position: 'before' | 'after'): Promise<ApiWrapper<null, BaseMessagesOne>>;

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

@@ -1,7 +1,43 @@
-import { ApiReturn, CommunityAutocomplete, Format, jObjectLittle } from '../types';
+import { ApiReturn, CommunityAutocomplete, Format } from '../types';
 import { JBaseApi } from './base';
 export declare class JCommunityApi extends JBaseApi {
-    get<T extends Format = undefined>(idCommunity: string | number, format?: T): Promise<import("../types").ApiWrapper<ApiReturn<T, jObjectLittle, jObjectLittle, jObjectLittle, jObjectLittle>, import("../types").BaseMessages>>;
+    get<T extends Format = undefined>(idCommunity: string | number, format?: T): Promise<import("../types").ApiWrapper<ApiReturn<T, {
+        type: string;
+        id: number;
+        mainType: string;
+        uri: string;
+        title: string;
+        _url: string;
+        dateCreation?: string | undefined;
+        dateModified?: string | null | undefined;
+    }, {
+        type: string;
+        id: number;
+        mainType: string;
+        uri: string;
+        title: string;
+        _url: string;
+        dateCreation?: string | undefined;
+        dateModified?: string | null | undefined;
+    }, {
+        type: string;
+        id: number;
+        mainType: string;
+        uri: string;
+        title: string;
+        _url: string;
+        dateCreation?: string | undefined;
+        dateModified?: string | null | undefined;
+    }, {
+        type: string;
+        id: number;
+        mainType: string;
+        uri: string;
+        title: string;
+        _url: string;
+        dateCreation?: string | undefined;
+        dateModified?: string | null | undefined;
+    }>, import("../types").BaseMessages>>;
     sendRequest(message: string, idUserTo: number): Promise<import("../types").ApiWrapper<boolean, {
         code: number;
         msg: string;

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

@@ -7,16 +7,17 @@ export declare class JFileApi extends JBaseApi {
      */
     upload(config: UploadConfig): Promise<{
         response: ApiWrapper<{
-            uri: string;
+            type: string;
             id: number;
             mainType: string;
-            type: string;
+            uri: string;
             dateCreation: string;
             title: string;
             _url: string;
             dateModified: string | null;
             mimetype: string;
             path?: string;
+            size: number;
         }, import("../../types").BaseMessages>;
         token: string;
     }>;
@@ -28,16 +29,17 @@ export declare class JFileApi extends JBaseApi {
      */
     uploadMany(configArray: Array<UploadConfig>): Promise<{
         response: ApiWrapper<{
-            uri: string;
+            type: string;
             id: number;
             mainType: string;
-            type: string;
+            uri: string;
             dateCreation: string;
             title: string;
             _url: string;
             dateModified: string | null;
             mimetype: string;
             path?: string;
+            size: number;
         }, import("../../types").BaseMessages>;
         token: string;
     }[]>;

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 { JBaseApi } from '../base';
-import { ApiReturn, ApiWrapper, Format, PagingResults, jObjectLittle, jSpotAutocomplete, jUserLittle } from '../../types';
+import { ApiReturn, ApiWrapper, Format, PagingResults, jSpotAutocomplete, jUserLittle } from '../../types';
 export declare class JGroupApi extends JBaseApi {
     /**
      * autocomplete return a list of groups
@@ -13,21 +13,57 @@ export declare class JGroupApi extends JBaseApi {
      * @param format return format
      * @returns
      */
-    create<T extends Format = undefined>(group: CreateGroup, format?: T): Promise<ApiWrapper<ApiReturn<T, jObjectLittle, GroupList, GroupView, jObjectLittle>, import("../../types").BaseMessages>>;
+    create<T extends Format = undefined>(group: CreateGroup, format?: T): Promise<ApiWrapper<ApiReturn<T, {
+        type: string;
+        id: number;
+        mainType: string;
+        uri: string;
+        title: string;
+        _url: string;
+        dateCreation?: string | undefined;
+        dateModified?: string | null | undefined;
+    }, GroupList, GroupView, {
+        type: string;
+        id: number;
+        mainType: string;
+        uri: string;
+        title: string;
+        _url: string;
+        dateCreation?: string | undefined;
+        dateModified?: string | null | undefined;
+    }>, 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<ApiWrapper<ApiReturn<T, jObjectLittle, GroupList, GroupView, string>, import("../../types").BaseMessages>>;
+    update<T extends Format = undefined>(group: UpdateGroup, format?: T): Promise<ApiWrapper<ApiReturn<T, {
+        type: string;
+        id: number;
+        mainType: string;
+        uri: string;
+        title: string;
+        _url: string;
+        dateCreation?: string | undefined;
+        dateModified?: string | null | undefined;
+    }, 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<ApiWrapper<ApiReturn<T, jObjectLittle, GroupList, GroupView, string>, import("../../types").BaseMessages>>;
+    getSpot<T extends Format = undefined>(idSpot: number | string, format?: T): Promise<ApiWrapper<ApiReturn<T, {
+        type: string;
+        id: number;
+        mainType: string;
+        uri: string;
+        title: string;
+        _url: string;
+        dateCreation?: string | undefined;
+        dateModified?: string | null | undefined;
+    }, GroupList, GroupView, string>, import("../../types").BaseMessages>>;
     /**
      * Get the properties of a group that are not within the model
      * @param idSpot

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

@@ -1,6 +1,6 @@
 import { JBaseApi } from '../base';
-import { ApiWrapper, Little, jObjectLittle, UserModel, UserMapModel, jUserAutocomplete, ApiPagingResults, ApiDefaultWrapper, jUserLittle, Readable, jUserValues, UserFieldsConfigurationType, UserFieldsType, UserField } from '../../types';
-export type User = Little & {
+import { ApiWrapper, jObjectLittle, UserModel, UserMapModel, jUserAutocomplete, ApiPagingResults, ApiDefaultWrapper, jUserLittle, Readable, jUserValues, UserFieldsConfigurationType, UserFieldsType, UserField } from '../../types';
+export type User = jObjectLittle & {
     id: string;
     shortUri: string;
     name: string;

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

@@ -1,5 +1,7 @@
 import { jUserLittle } from './user';
-import { jArticleLittle, jArticleView, jObjectLittle, Rights } from './utils';
+import { jArticleLittle, jArticleView } from './utils';
+import { jObjectLittle } from './object';
+import { Rights } from './common';
 export type AseiTicketStatus = 'created' | 'validated' | 'handled';
 export type AseiTicket = jArticleView & {
     aseiClearanceTicketValidator: jUserLittle[];

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

@@ -1,4 +1,4 @@
-import { jObjectLittle } from './utils';
+import { jObjectLittle } from './object';
 export interface BaseAutocomplete {
     id: string;
     uri: string;

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

@@ -1,5 +1,6 @@
 import { jUserLittle } from './user';
-import { jLinkList, jObjectBase, jObjectLittle } from './utils';
+import { jLinkList } from './utils';
+import { jObjectBase, jObjectLittle } from './object';
 export type BookmarkRawList<T extends jObjectBase = jObjectLittle | jUserLittle> = jLinkList<T> & {
     bookmarkUrl?: string | null;
     bookmarkOrder?: number;

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

@@ -1,7 +1,9 @@
 import { jUserLittle } from './user';
-import { Readable, Rights, jObjectBase } from './utils';
+import { Readable } from './utils';
 import { jFileLittle } from './file';
 import { SocialAction } from './global';
+import { jObjectBase } from './object';
+import { Rights } from './common';
 export type jCommentLittle = Readable<Omit<jObjectBase, 'dateModified'> & {
     dateCreation: string;
     dateModified: string | null;

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

@@ -0,0 +1,31 @@
+import { z } from 'zod';
+export declare const rightsSchema: z.ZodObject<{
+    create: z.ZodBoolean;
+    read: z.ZodBoolean;
+    publish: z.ZodBoolean;
+    administrate: z.ZodBoolean;
+    update: z.ZodBoolean;
+    delete: z.ZodBoolean;
+    comment: z.ZodBoolean;
+    member: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    create: boolean;
+    read: boolean;
+    publish: boolean;
+    administrate: boolean;
+    update: boolean;
+    delete: boolean;
+    comment: boolean;
+    member: boolean;
+}, {
+    create: boolean;
+    read: boolean;
+    publish: boolean;
+    administrate: boolean;
+    update: boolean;
+    delete: boolean;
+    comment: boolean;
+    member: boolean;
+}>;
+export type Rights = z.infer<typeof rightsSchema>;
+export declare const validateIsFormatRights: (object: object) => boolean;

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

@@ -1,4 +1,5 @@
-import { Audience, jObjectList } from './utils';
+import { Audience } from './utils';
+import { jObjectList } from './object';
 export type jDiapazoneList = jObjectList & {
     dateStart: string;
     animatedMeetingContent: Record<string, unknown>;

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

@@ -1,5 +1,5 @@
 import { Format, jArticleList, jArticleLittle, MaybeWithToken } from './utils';
-import { ImageSize } from './file';
+import { ImageSize, jFileLittle } from './file';
 import { AudienceAutocomplete, jObjectAutocomplete } from './autocomplete';
 import { ArticleCreation } from './article';
 export type FaqView = FaqList & {
@@ -11,6 +11,7 @@ export type FaqView = FaqList & {
         id?: string;
         items: string[];
     }[];
+    _attachedFiles: jFileLittle[];
 };
 export type FaqList = jArticleList & {
     faqColor?: string;
@@ -28,6 +29,7 @@ export type FaqItemView = Omit<FaqItemList, 'hierarchy'> & {
     uriCategory: jArticleLittle[];
     themeId: string;
     _nbAttachedFiles?: number;
+    _attachedFiles: jFileLittle[];
     uiObjectLink: unknown;
 };
 export type FaqItemList = jArticleList & {

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

@@ -1,4 +1,5 @@
-import { Readable, jObjectLittle } from './utils';
+import { Readable } from './utils';
+import { jObjectLittle } from './object';
 export type UploadConfig = {
     attrName: string;
     token: string;
@@ -22,6 +23,7 @@ export type jFileLittle = Readable<Omit<jObjectLittle, 'dateModified'> & {
     dateModified: string | null;
     mimetype: string;
     path?: string;
+    size: number;
 }>;
 export type jFileLittleCrop = jFileLittle & {
     _extend: {

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

@@ -1,5 +1,6 @@
 import { jUserLittle } from './user';
-import { Filters, Orders, jObjectBase, jObjectLittle } from './utils';
+import { Filters, Orders } from './utils';
+import { jObjectBase, jObjectLittle } from './object';
 export type CreateGroup = {
     type: string;
     title: string;

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

@@ -7,6 +7,7 @@ export * from './asei';
 export * from './assetReservation';
 export * from './autocomplete';
 export * from './bookmark';
+export * from './common';
 export * from './diapazone';
 export * from './drive';
 export * from './faq';
@@ -14,6 +15,7 @@ export * from './file';
 export * from './mediaLibrary';
 export * from './model';
 export * from './network';
+export * from './object';
 export * from './search';
 export * from './share';
 export * from './socialAction';

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

@@ -1,7 +1,8 @@
+import { z } from 'zod';
 export type WidgetText = {
     type: 'text';
 };
-export type WidgetTextValue = string;
+export declare const widgetTextValueSchema: z.ZodString;
 export type WidgetTextarea = {
     type: 'textarea';
     params?: {
@@ -9,11 +10,11 @@ export type WidgetTextarea = {
         mention: '1';
     };
 };
-export type WidgetTextareaValue = string | null;
+export declare const widgetTextareaValueSchema: z.ZodNullable<z.ZodString>;
 export type WidgetNumber = {
     type: 'number';
 };
-export type WidgetNumberValue = number;
+export declare const widgetNumberValueSchema: z.ZodNumber;
 export type WidgetColor = {
     type: 'color';
     options: {
@@ -25,16 +26,16 @@ export type WidgetDate = {
     type: 'date';
     format: string;
 };
-export type WidgetDateValue = string | null;
+export declare const widgetDateValueSchema: z.ZodNullable<z.ZodString>;
 export type WidgetDatetime = {
     type: 'datetime';
 };
-export type WidgetDatetimeValue = string | null;
+export declare const widgetDatetimeValueSchema: z.ZodNullable<z.ZodString>;
 export type WidgetDatePicker = {
     type: 'datePicker';
 };
-export type WidgetDatePickerValue = string | null;
-export type WidgetActiveValue = number;
+export declare const widgetDatePickerValueSchema: z.ZodNullable<z.ZodString>;
+export declare const widgetActiveValueSchema: z.ZodNumber;
 export type WidgetLink = {
     type: 'link';
 };
@@ -53,17 +54,20 @@ export type WidgetSelect<U extends string = string> = {
         explain?: 1;
     };
 };
+export type WidgetEmbed = {
+    type: 'embed';
+};
 export type WidgetEmail = {
     type: 'email';
 };
-export type WidgetEmailValue = string;
+export declare const widgetEmailValueSchema: z.ZodString;
 export type WidgetUrl = {
     type: 'url';
     params: {
         target?: '_blank';
     };
 };
-export type WidgetUrlValue = string;
+export declare const widgetUrlValueSchema: z.ZodString;
 export type WidgetPlace = {
     type: 'place';
     options: Record<string, string>;
@@ -108,8 +112,8 @@ export type WidgetUri = {
         type: string;
     };
 };
-export type Widget = WidgetText | WidgetTextarea | WidgetNumber | WidgetDate | WidgetDatetime | WidgetDatePicker | WidgetSelect | WidgetEmail | WidgetUrl | WidgetRefUser | WidgetRadio | WidgetCheckbox | WidgetOrientedlinks | WidgetTaxonomy | WidgetUri | WidgetTransient | WidgetMultiattribute | WidgetTel | WidgetPlace | WidgetColor | WidgetLink | WidgetFile;
-export type WidgetsValue = WidgetActiveValue | WidgetDatePickerValue | WidgetDatetimeValue | WidgetDateValue | WidgetEmailValue | WidgetNumberValue | WidgetTextareaValue | WidgetTextValue | WidgetUrlValue;
+export type Widget = WidgetText | WidgetTextarea | WidgetNumber | WidgetDate | WidgetDatetime | WidgetDatePicker | WidgetSelect | WidgetEmbed | WidgetEmail | WidgetUrl | WidgetRefUser | WidgetRadio | WidgetCheckbox | WidgetOrientedlinks | WidgetTaxonomy | WidgetUri | WidgetTransient | WidgetMultiattribute | WidgetTel | WidgetPlace | WidgetColor | WidgetLink | WidgetFile;
+export declare const widgetsValueSchema: z.ZodUnion<[z.ZodNumber, z.ZodNullable<z.ZodString>, z.ZodNullable<z.ZodString>, z.ZodNullable<z.ZodString>, z.ZodString, z.ZodNumber, z.ZodNullable<z.ZodString>, z.ZodString, z.ZodString]>;
 export type FieldConfiguration<T extends string = string> = {
     label: string;
     description?: string;