jamespot-user-api 1.0.97 → 1.0.99

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

@@ -1,8 +1,15 @@
+export declare type UploadConfig = {
+    attrName: string;
+    token: string;
+    file?: File | null;
+    url?: string;
+};
 export declare type FileResponse = {
     id: string;
     name: string;
-    type: 'fileTmp';
-    token: string;
+    type: string;
+    token?: string;
+    crop?: FileCropConfig;
     size: string;
     mediaKey: string;
     imagesize: {
@@ -10,3 +17,14 @@ export declare type FileResponse = {
         height: number;
     };
 };
+export declare type FileCropConfig = {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    rotation: number;
+    killSize?: boolean;
+};
+export declare type FileCropReturnType = Omit<FileResponse, 'token'> & {
+    crop: FileCropConfig;
+};

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

@@ -1,12 +1,32 @@
-export interface CreateGroup {
+import { jObjectLittle } from './utils';
+export declare type CreateGroup = {
+    type: string;
     title: string;
     description: string;
     privacy: string;
-    idCategory?: string;
-    type: 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;
-    widgets: Array<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;
@@ -20,3 +40,19 @@ export interface Category {
     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;
+};

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

@@ -1,5 +1,4 @@
 export * from './adminStore';
-export * from './application';
 export * from './asei';
 export * from './assetReservation';
 export * from './autocomplete';
@@ -14,3 +13,4 @@ export * from './user';
 export * from './utils';
 export * from './wedoc';
 export * from './widgets';
+export * from './realtime';

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

@@ -1,6 +1,7 @@
 export declare type WidgetText = {
     type: 'text';
 };
+export declare type WidgetTextValue = string;
 export declare type WidgetTextarea = {
     type: 'textarea';
     params?: {
@@ -8,13 +9,16 @@ export declare type WidgetTextarea = {
         mention: '1';
     };
 };
+export declare type WidgetTextareaValue = string;
 export declare type WidgetNumber = {
     type: 'number';
 };
+export declare type WidgetNumberValue = number;
 export declare type WidgetDate = {
     type: 'date';
     format: string;
 };
+export declare type WidgetDateValue = string;
 export declare type WidgetDatetime = {
     type: 'datetime';
 };
@@ -39,12 +43,14 @@ export declare type WidgetSelect<U extends string = string> = {
 export declare type WidgetEmail = {
     type: 'email';
 };
+export declare type WidgetEmailValue = string;
 export declare type WidgetUrl = {
     type: 'url';
     params: {
         target?: '_blank';
     };
 };
+export declare type WidgetUrlValue = string;
 export declare type WidgetRefUser = {
     type: 'refUser';
 };
@@ -82,6 +88,7 @@ export declare type WidgetUri = {
     };
 };
 export declare type Widget = WidgetText | WidgetTextarea | WidgetNumber | WidgetDate | WidgetDatetime | WidgetDatePicker | WidgetSelect | WidgetEmail | WidgetUrl | WidgetRefUser | WidgetRadio | WidgetCheckbox | WidgetOrientedlinks | WidgetTaxonomy | WidgetUri | WidgetTransient | WidgetMultiattribute | WidgetFile;
+export declare type WidgetsValue = WidgetTextValue | WidgetTextareaValue | WidgetNumberValue | WidgetDateValue | WidgetEmailValue | WidgetUrlValue;
 export declare type FieldConfiguration<T extends string = string> = {
     label: string;
     description?: string;

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

@@ -0,0 +1,25 @@
+import { jObjectBase } from './utils';
+declare type BookmarksFunctions = 'update' | 'add' | 'delete';
+declare type CustomActionFunctions = 'update' | 'add' | 'remove';
+export declare type Namespaces = {
+    BOOKMARKS: BookmarksFunctions;
+    'CUSTOM-ACTION': CustomActionFunctions;
+};
+export declare type RTMessageHandler<T extends keyof Namespaces = 'CUSTOM-ACTION'> = {
+    namespace: T;
+    function: Namespaces[T];
+    handler: (message: RTMessage<T>) => any;
+};
+export declare type AnyRTHandlerFunction = {
+    [K in keyof Namespaces]: RTMessageHandler<K>['handler'];
+}[keyof Namespaces];
+export declare type RTMessage<T extends keyof Namespaces = 'CUSTOM-ACTION', O extends jObjectBase = jObjectBase> = {
+    namespace: T;
+    function: Namespaces[T];
+    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 {};

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

@@ -1,3 +1,4 @@
+import { jObjectLittle } from './utils';
 export interface SearchCategoryModel {
     id: string;
     mainType: string;
@@ -9,6 +10,10 @@ export interface SearchCategoryModel {
     typesExcluded: string[];
     facets: SearchFacetModel[];
 }
+export interface SearchCategoryValue {
+    count: number;
+    id: string;
+}
 export interface SearchFacetModel {
     facetType: string;
     facetOptions: any;
@@ -17,10 +22,16 @@ export interface SearchFacetModel {
     category?: SearchCategoryModel['id'];
 }
 export interface SearchFacetValueModel {
+    name: string;
     count: number;
-    value: string;
+    values: SearchFacetValues[];
     title: string;
 }
+export declare type SearchFacetValues = {
+    count: number;
+    value: string;
+    title: string;
+};
 /** *
  * Used in search query to specify a filter
  * field : name/id of the filter category (ie skills)
@@ -30,7 +41,7 @@ export interface SearchFacetValueModel {
 export interface SearchQueryFilterModel {
     field: string;
     value: string;
-    exclude: boolean;
+    exclude?: boolean;
 }
 /**
  * Used in search query to specify a filter
@@ -55,7 +66,7 @@ export interface SearchConfig {
         facets: SearchFacetModel[];
     };
     categories: SearchCategoryModel[];
-    viewcard?: Record<string, {
+    viewcard: Record<string, {
         name: string;
         title: string;
     }[]>;
@@ -66,34 +77,50 @@ export interface SearchResultCatProps {
     showAll?: boolean;
     results: SearchResultProps[];
 }
-export interface SearchResultProps {
+export declare type SearchResultProps = SearchResultPropsApp | SearchResultPropsObject;
+export interface SearchResultPropsApp {
+    name: string;
+    title: string;
+    icon: string;
+    _url: string;
+}
+export interface SearchResultPropsObject {
+    id?: number;
     title: string;
     picture: string;
     uri: string;
+    type?: string;
+    icon?: string;
+    _cssColor?: string;
+    _url?: string;
+    idArticle?: number;
+    _user?: {
+        title: string;
+    };
+    _values?: {
+        dateModified: string;
+    };
 }
 export interface SearchQuery {
     keywords?: string;
     category?: string;
     facetCategories?: boolean;
     filters?: SearchQueryFilterModel[];
+    facets?: SearchFacetModel[];
     page?: number;
     limit?: number;
     sort?: SearchQuerySortModel;
     options?: SearchQueryOption;
+    format?: string;
 }
-export interface Result {
-    id: number;
-    type: string;
-    uri: string;
-    title: string;
-    mainType: string;
-    _url: string;
-}
-export interface SearchQueryResult {
-    results: Result[];
-    facets: SearchFacetModel[];
-    categories: SearchCategoryModel[];
+export interface SearchQueryResult<T extends jObjectLittle = jObjectLittle> {
+    start: number;
+    count: number;
+    results: T[];
+    facets: SearchFacetValueModel[];
+    categories: SearchCategoryValue[];
 }
 export declare type SearchLastQuery = {
     keywords: string;
 };
+export declare type SearchAdminConfig = any;

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

@@ -1,3 +1,4 @@
+import { WidgetsValue } from './model';
 import { jObjectLittle } from './utils';
 export declare type UserModel = jObjectLittle & {
     firstname: string;
@@ -15,21 +16,11 @@ export declare const UserLevel: {
     readonly EXTERNAL: 3;
     readonly GUEST: 0;
 };
-export declare type jUserAutocomplete = {
-    id: string;
-    uri: string;
-    shortUri: string;
-    title: string;
-    name: string;
-    mainType: string;
-    type: string;
-    label: string;
-    cssClass: string;
-    cssColor: string;
-    class: string;
-    Pseudo: string;
-};
 export declare type jUserLittle = jObjectLittle & {
     level: typeof UserLevel[keyof typeof UserLevel];
+    dateCreation: string;
+    dateModified: string;
+};
+export declare type jUserList = jUserLittle & {
+    [key: string]: WidgetsValue;
 };
-export declare type jUserList = jUserLittle & {};

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

@@ -36,37 +36,52 @@ export declare type Rights = {
     comment: boolean;
     member: boolean;
 };
-export declare type Little = {
+export declare type jObjectBase = {
     id: number;
     mainType: string;
     type: string;
     uri: string;
+    dateCreation?: string;
+    dateModified?: string;
+};
+export declare type jObjectLittle = jObjectBase & {
     title: string;
     _url: string;
-    dateCreation: string;
-    dateModified: string;
 };
-export declare type List = Little & {
+export declare type jObjectList = jObjectLittle & {
     description?: string;
-    _user: Little;
+    _user: jUserLittle;
     _right: Rights;
 };
-export declare type jObjectLittle = {
-    id: number;
-    mainType: string;
-    type: string;
-    uri: string;
-    title: string;
-    _url: string;
+/**
+ * @deprecated Use jObjectLittle instead
+ */
+export declare type Little = jObjectLittle;
+/**
+ * @deprecated Use jObjectList instead
+ */
+export declare type List = jObjectList;
+export declare type jLinkLittle = jObjectBase & {
+    srcId: number;
+    srcType: string;
+    targetId: number;
+    targetType: string | null;
+};
+export declare type jLinkList<T extends jObjectBase = jObjectLittle> = jLinkLittle & {
+    value: string | null;
+    _src?: T;
+    _target?: T | undefined;
+};
+export declare type jArticleLittle = jObjectLittle & {
     dateCreation: string;
     dateModified: string;
 };
-export declare type jArticleLittle = jObjectLittle & {};
-export declare type jArticleList = jObjectLittle & {
+export declare type jArticleList = jArticleLittle & {
     description?: string;
     _user: jUserLittle;
     _right: Rights;
 };
+export declare type jArticleView = jArticleList & {};
 export declare type Order = {
     name: string;
     sort: 'ASC' | 'DESC';
@@ -92,3 +107,9 @@ export declare type MaybeWithCsrf<T> = T & {
 export declare type MaybeWithToken<T> = T & {
     token?: string | undefined;
 };
+export declare type MaybeWithParent<T extends jObjectBase = jObjectBase> = {
+    _parent?: T;
+};
+export declare type Format = 'raw-little' | 'raw-list' | 'raw-view' | undefined;
+export declare type ApiReturn<T extends Format, Little, List = Little, View = List, Default = {}> = T extends 'raw-little' ? Little : T extends 'raw-list' ? List : T extends 'raw-view' ? View : Default;
+export declare type ValueOf<T> = T[keyof T];

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

@@ -0,0 +1,9 @@
+import { JamespotUserApi } from '../apis';
+import { PagingResults, jArticleLittle, jObjectAutocomplete, jObjectLittle } from '../types';
+import { Network } from './network';
+export declare const network: Network;
+export declare const jApi: JamespotUserApi;
+export declare const validateJArticle: <T extends jArticleLittle>(received: T, expected: T, _format: 'raw-little' | 'raw-list' | 'raw-view') => void;
+export declare const validatePagingResults: <T>(received: PagingResults<T>, expected: PagingResults<T>) => void;
+export declare const validateObjectIsFormatLittle: <T extends jObjectLittle = jObjectLittle>(object: T) => boolean;
+export declare const validateObjectIsFormatAutocomplete: <T extends jObjectAutocomplete = jObjectAutocomplete>(object: T) => boolean;

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

@@ -0,0 +1,15 @@
+import { BookmarkCustom, BookmarkLink, BookmarkRawList, jObjectBase } from '../types';
+declare function ensureIsBookmarkLink(bookmark: BookmarkCustom | BookmarkLink): bookmark is BookmarkLink;
+declare function ensureIsBookmarkCustom(bookmark: BookmarkCustom | BookmarkLink): bookmark is BookmarkCustom;
+declare function ensureIsBookmarkRawList(bookmark: jObjectBase | BookmarkRawList): bookmark is BookmarkRawList;
+declare type jObjectTypes = {
+    bookmarkLink: BookmarkRawList;
+};
+declare function ensureObjectIsType<T extends keyof jObjectTypes>(type: T, object: jObjectBase): object is jObjectTypes[T];
+export declare const jEnsure: {
+    isBookmarkLink: typeof ensureIsBookmarkLink;
+    isBookmarkCustom: typeof ensureIsBookmarkCustom;
+    isBookmarkRawList: typeof ensureIsBookmarkRawList;
+    objectIsType: typeof ensureObjectIsType;
+};
+export {};

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

@@ -17,7 +17,7 @@ export declare class Network {
     getHostname(): Promise<string>;
     fetch({ o, f, ...body }: OF, signal?: AbortSignal | null): FetchReturnType;
     post<T, U = string[]>(body: OF, signal?: AbortSignal): Promise<ApiWrapper<T, U>>;
-    postFile(body: FormData, token?: string): Promise<FileResponse>;
+    postFile(body: FormData): Promise<ApiWrapper<FileResponse, string[]>>;
     postCSRF<T, U = string[]>(body: OF): Promise<ApiWrapper<T, U>>;
     maybePostCSRF<T, U = string[]>(body: MaybeWithCsrf<OF>): Promise<ApiWrapper<T, U>>;
     postToken<T, U = string[]>(body: OF): Promise<ApiWrapper<T, U>>;

package/lib/src/util/network.mock.d.ts

@@ -0,0 +1,3 @@
+import { ApiWrapper } from '../types';
+export declare const miscToken: ApiWrapper<string>;
+export declare const miscTokenCSRF: ApiWrapper<string>;

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

@@ -1,3 +1,2 @@
 export * from './Window';
 export * from './WindowBrowser';
-export * from './WindowMock';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "jamespot-user-api",
-    "version": "1.0.97",
+    "version": "1.0.99",
     "scripts": {
         "build": "npx webpack --env NODE_ENV=production",
         "build-dev-vm": "npx webpack --env NODE_ENV=development --env NODE_BUILD=VM",
@@ -14,10 +14,8 @@
         "lint:fix": "npx eslint ./src/ --ext .ts,.tsx --fix ",
         "lint:ci": "eslint --output-file eslint_report.json --format json . --ext .ts,.js",
         "doc": "npx typedoc",
-        "testFetch": "jest -c ./jest.fetch.config.ts",
-        "testMock": "jest -c ./jest.mock.config.ts",
-        "test": "npm run testMock",
-        "testJenkinsDev": "jest -c ./jest.fetch.jenkinsdev.config.ts",
+        "test": "jest",
+        "test:mockVM": "jest -c ./jest.config.vm.ts",
         "prepare": "husky install"
     },
     "main": "lib/jamespot-user-api.js",

package/phpunitMock/articleCount-mpArticle.json

@@ -0,0 +1 @@
+{ "o": "article", "f": "count", "error": 0, "messages": [], "result": 13 }

package/phpunitMock/articleCreate-mpArticle-little.json

@@ -0,0 +1,18 @@
+{
+    "o": "article",
+    "f": "create",
+    "error": 0,
+    "messages": [{ "code": 200, "msg": "Enregistrement r\u00e9ussi" }],
+    "result": [
+        {
+            "id": 35,
+            "mainType": "article",
+            "type": "mpArticle",
+            "uri": "mpArticle/35",
+            "title": "Article for testArticleCreate",
+            "_url": "/article/35",
+            "dateCreation": "2023-04-11 14:53:51",
+            "dateModified": "2023-04-11 14:53:51"
+        }
+    ]
+}

package/phpunitMock/articleDelete-mpArticle.json

@@ -0,0 +1,7 @@
+{
+    "o": "article",
+    "f": "delete",
+    "error": 0,
+    "messages": [{ "code": 200, "msg": "L'article a \u00e9t\u00e9 supprim\u00e9 avec succ\u00e8s" }],
+    "result": true
+}

package/phpunitMock/articleGet-mpArticle-list.json

@@ -0,0 +1,39 @@
+{
+    "o": "article",
+    "f": "get",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "id": 2,
+        "mainType": "article",
+        "type": "mpArticle",
+        "uri": "mpArticle/2",
+        "title": "Article groupe public",
+        "_url": "/article/2",
+        "dateCreation": "2019-07-19 09:36:25",
+        "dateModified": "2019-07-19 09:36:25",
+        "_right": {
+            "create": true,
+            "read": true,
+            "publish": false,
+            "administrate": true,
+            "update": true,
+            "delete": true,
+            "comment": true,
+            "member": true
+        },
+        "description": "<div class='content-html'></div>",
+        "_user": {
+            "id": 1,
+            "mainType": "user",
+            "type": "user",
+            "uri": "user/1",
+            "title": "AdminJenkins",
+            "_url": "/user/1",
+            "dateCreation": "2019-03-26 16:29:33",
+            "dateModified": "2019-07-19 09:39:23",
+            "level": 9
+        },
+        "_nbAttachedFiles": 0
+    }
+}

package/phpunitMock/articleUpdate-mpArticleView.json

@@ -0,0 +1,39 @@
+{
+    "o": "article",
+    "f": "update",
+    "error": 0,
+    "messages": [{ "code": 200, "msg": "Enregistrement r\u00e9ussi" }],
+    "result": {
+        "id": 64,
+        "mainType": "article",
+        "type": "mpArticle",
+        "uri": "mpArticle/64",
+        "title": "New Title for testArticleUpdate",
+        "_url": "/article/64",
+        "dateCreation": "2023-04-11 15:34:46",
+        "dateModified": "2023-04-11 15:34:46",
+        "_right": {
+            "create": true,
+            "read": true,
+            "publish": false,
+            "administrate": true,
+            "update": true,
+            "delete": true,
+            "comment": true,
+            "member": true
+        },
+        "description": "<div class='content-html'></div>",
+        "_user": {
+            "id": 4,
+            "mainType": "user",
+            "type": "user",
+            "uri": "user/4",
+            "title": "Admin1",
+            "_url": "/user/4",
+            "dateCreation": "2019-07-09 15:48:26",
+            "dateModified": "2019-07-09 15:51:24",
+            "level": 9
+        },
+        "processContext": null
+    }
+}

package/phpunitMock/assetReservationConfiguration-default.json

@@ -0,0 +1,14 @@
+{
+    "o": "assetReservation",
+    "f": "configuration",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "description": "",
+        "right": { "manage": true },
+        "weekEnd": "0",
+        "bookingOpeningTime": "08:00",
+        "bookingClosingTime": "21:00",
+        "lastBookingSchedule": "20:00"
+    }
+}

package/phpunitMock/assetReservationConfiguration-updated.json

@@ -0,0 +1,14 @@
+{
+    "o": "assetReservation",
+    "f": "configuration",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "description": "",
+        "right": { "manage": true },
+        "weekEnd": "0",
+        "bookingOpeningTime": "07:00",
+        "bookingClosingTime": "20:00",
+        "lastBookingSchedule": "20:00"
+    }
+}

package/phpunitMock/autocompleteAudience-u.json

@@ -0,0 +1,64 @@
+{
+    "o": "autocomplete",
+    "f": "audience",
+    "error": 0,
+    "messages": [],
+    "result": [
+        {
+            "id": "user/6",
+            "uri": "user/6",
+            "shortUri": "u6",
+            "title": "User1",
+            "name": "User1",
+            "mainType": "user",
+            "type": "user",
+            "label": "Utilisateur",
+            "cssClass": "user",
+            "cssColor": "#a4acaf",
+            "class": "user-selector-user",
+            "Pseudo": "User1"
+        },
+        {
+            "id": "user/7",
+            "uri": "user/7",
+            "shortUri": "u7",
+            "title": "User2",
+            "name": "User2",
+            "mainType": "user",
+            "type": "user",
+            "label": "Utilisateur",
+            "cssClass": "user",
+            "cssColor": "#a4acaf",
+            "class": "user-selector-user",
+            "Pseudo": "User2"
+        },
+        {
+            "id": "spot/3",
+            "idspot": "3",
+            "uri": "spot/3",
+            "shortUri": "s3",
+            "title": "Groupe mod\u00e9r\u00e9",
+            "name": "Groupe mod\u00e9r\u00e9",
+            "mainType": "spot",
+            "type": "spot",
+            "label": "Groupe",
+            "cssClass": "group",
+            "cssColor": "#e34d55",
+            "class": "user-selector-spot"
+        },
+        {
+            "id": "spot/1",
+            "idspot": "1",
+            "uri": "spot/1",
+            "shortUri": "s1",
+            "title": "Groupe public",
+            "name": "Groupe public",
+            "mainType": "spot",
+            "type": "spot",
+            "label": "Groupe",
+            "cssClass": "group",
+            "cssColor": "#e34d55",
+            "class": "user-selector-spot"
+        }
+    ]
+}