jamespot-user-api 1.0.119 → 1.0.121

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

@@ -1,10 +1,18 @@
 import { JBaseApi } from '../base';
-import { ApiWrapper, CreateFaqCategory, EditFaqCategory, FaqCategoryView, FaqHookProperties, FaqTaxonomy, jArticleLittle } from '../../types';
+import { ApiWrapper, CreateFaqCategory, CreateFaqTheme, EditFaqCategory, ExtendedFaqCategory, FaqAccess, FaqList, FaqView, FaqHookProperties, FaqItemList, FaqTaxonomy, jArticleLittle, Orders, PagingResults, DeleteFaqTheme, EditFaqTheme, ApiDefaultWrapper, Format } from '../../types';
 export declare class JFaqApi extends JBaseApi {
-    createCategory<T extends jArticleLittle = FaqCategoryView>(params: Omit<CreateFaqCategory, 'type'>, format?: string): Promise<ApiWrapper<Array<T>>>;
-    updateCategory<T extends jArticleLittle = FaqCategoryView>(params: Omit<EditFaqCategory, 'type'>, format?: string): Promise<ApiWrapper<T>>;
-    getCategory<T extends jArticleLittle = FaqCategoryView>(id: number, format?: string): Promise<ApiWrapper<T>>;
+    getCategoriesList<T extends ExtendedFaqCategory<FaqList> = ExtendedFaqCategory<FaqList>>(format?: Format, orders?: Orders): Promise<ApiWrapper<PagingResults<T>>>;
+    createCategory<T extends jArticleLittle = FaqView>(params: Omit<CreateFaqCategory, 'type'>, format?: Format): Promise<ApiWrapper<Array<T>>>;
+    updateCategory<T extends jArticleLittle = FaqView>(params: Omit<EditFaqCategory, 'type'>, format?: Format): Promise<ApiWrapper<T>>;
+    getCategory<T extends jArticleLittle = FaqView>(id: number, format?: Format): Promise<ApiWrapper<T>>;
     deleteCategory(id: number): Promise<ApiWrapper<boolean>>;
+    checkItem<T extends FaqItemList>(query: string, page?: number, format?: Format): Promise<ApiWrapper<PagingResults<T & {
+        _percent: number;
+    }>>>;
     getTaxonomy(): Promise<ApiWrapper<FaqTaxonomy>>;
     getHookProperties(properties?: Array<keyof FaqHookProperties>): Promise<ApiWrapper<FaqHookProperties>>;
+    getAccess(): Promise<ApiWrapper<FaqAccess>>;
+    createTheme<T extends jArticleLittle = FaqView>(params: CreateFaqTheme, format?: Format): Promise<ApiWrapper<T>>;
+    deleteTheme<T extends jArticleLittle = FaqView>(params: DeleteFaqTheme, format?: Format): Promise<ApiWrapper<T>>;
+    editTheme(params: EditFaqTheme, format?: Format): Promise<ApiDefaultWrapper>;
 }

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

@@ -1,7 +1,21 @@
-import { ApiWrapper, FaqCategoryView, FaqHookProperties, FaqTaxonomy } from '../../types';
-export declare const faqCreateCategory: ApiWrapper<FaqCategoryView[]>;
-export declare const faqGetCategory: ApiWrapper<FaqCategoryView>;
-export declare const faqUpdateCategory: ApiWrapper<FaqCategoryView>;
+import { ApiWrapper, ExtendedFaqCategory, FaqAccess, FaqList, FaqView, FaqHookProperties, FaqItemList, FaqTaxonomy, PagingResults, ApiDefaultWrapper } from '../../types';
+export declare const faqCreateCategory: ApiWrapper<(FaqView & {
+    processContext: null;
+})[]>;
+export declare const faqGetCategory: ApiWrapper<FaqView>;
+export declare const faqUpdateCategory: ApiWrapper<FaqView>;
 export declare const faqDeleteCategory: ApiWrapper<boolean>;
 export declare const faqGetTaxonomy: ApiWrapper<FaqTaxonomy>;
 export declare const faqGetHookProperties: ApiWrapper<FaqHookProperties>;
+export declare const faqGetAccess: ApiWrapper<FaqAccess>;
+export declare const faqGetCategoriesList: ApiWrapper<PagingResults<ExtendedFaqCategory<FaqList>>>;
+export declare const faqCheckItem: ApiWrapper<PagingResults<FaqItemList & {
+    _percent: number;
+}>>;
+export declare const faqCreateTheme: ApiWrapper<FaqView & {
+    processContext: null;
+}>;
+export declare const faqDeleteTheme: ApiWrapper<FaqView & {
+    processContext: null;
+}>;
+export declare const faqEditTheme: ApiDefaultWrapper;

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

@@ -1,10 +1,10 @@
 import { JBaseApi } from './base';
-import { ApiPagingResults, ApiWrapper, jObjectBase, jObjectLittle, Rights } from '../types';
+import { ApiPagingResults, ApiWrapper, jArticleList, jFileLittle, jObjectLittle, Rights } from '../types';
 export interface RootFolderProps {
     id: number;
     title: string;
     uri: string;
-    type: string;
+    type: 'rootFolder';
     mainType: string;
     folderColor?: string;
 }
@@ -31,12 +31,12 @@ export type FolderType = jObjectLittle & {
     mainType: string;
     folderColor?: string;
     parentURI?: string;
+    _nbItems: number;
+    type: 'folder' | 'rootFolder';
 };
-export type jFileBase = jObjectLittle & {
-    mimetype: string;
-};
-export type FileBankDocument = jObjectBase & {
-    _attachedFiles: jFileBase[];
+export type FileBankDocument = jArticleList & {
+    _attachedFiles: jFileLittle[];
+    type: 'document';
 };
 export declare class JFilebankApi extends JBaseApi {
     getBanks(format?: string): Promise<Array<FileBankProps>>;

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

@@ -1,15 +1,29 @@
-import { jArticleView, MaybeWithToken } from './utils';
+import { Format, jArticleList, MaybeWithToken } from './utils';
 import { ArticleCreation, AutoCompleteConcept } from '../apis';
 import { ImageSize } from './file';
 import { AudienceAutocomplete } from './autocomplete';
-export type FaqCategoryView = jArticleView & {
-    faqColor?: string;
+export type FaqView = FaqList & {
     _audience: AudienceAutocomplete[];
-    image?: ImageSize | null;
     tags?: AutoCompleteConcept[];
     type: 'faq';
     isWeb: boolean;
 };
+export type FaqList = jArticleList & {
+    faqColor?: string;
+    image?: ImageSize;
+};
+export type ExtendedFaqCategory<T extends FaqList> = T & {
+    _extend: {
+        itemsCount: number;
+    };
+};
+export type FaqItemList = jArticleList & {
+    type: 'faqItem';
+    hierarchy: {
+        category?: string;
+        theme?: string;
+    };
+};
 export type CreateFaqCategory = MaybeWithToken<Omit<ArticleCreation, 'idSpot'>> & {
     image?: ImageSize | null;
     tags?: string;
@@ -19,12 +33,31 @@ export type CreateFaqCategory = MaybeWithToken<Omit<ArticleCreation, 'idSpot'>>
 };
 export type EditFaqCategory = CreateFaqCategory & {
     uri: string;
-    format?: string;
+    format?: Format;
 };
 export type FaqTaxonomy = {
     title: string;
     id: string;
 };
 export type FaqHookProperties = {
-    _web: '0' | '1' | '';
+    _web?: '0' | '1' | '';
+    appImage?: string;
+    appImageText?: string;
+};
+export type FaqAccess = {
+    createCategory: boolean;
+};
+export type CreateFaqTheme = {
+    idCategory: number;
+    title: string;
+};
+export type DeleteFaqTheme = {
+    idCategory: number;
+    indexTheme: number;
+    deleteEntries?: boolean;
+};
+export type EditFaqTheme = {
+    idCategory: number;
+    indexTheme: number;
+    title: string;
 };

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

@@ -41,7 +41,7 @@ export interface PagingResults<T> {
     cnt: number;
     data: Array<T>;
     facets: null | Array<{}>;
-    idQuery?: number;
+    idQuery?: number | null;
     limit: number;
     page: number;
 }
@@ -134,7 +134,11 @@ export type MaybeWithToken<T> = T & {
 export type MaybeWithParent<T extends jObjectBase = jObjectBase> = {
     _parent?: T;
 };
-export type Format = 'raw-little' | 'raw-list' | 'raw-view' | undefined;
+/**
+ * @deprecated
+ */
+type Format_DEPRECATED = 'user-api';
+export type Format = 'raw-little' | 'raw-list' | 'raw-view' | Format_DEPRECATED | undefined;
 export 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 type ValueOf<T> = T[keyof T];
 export {};

package/package.json

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

package/phpunitMock/articleCreate-faq-category.json

@@ -14,8 +14,8 @@
             "mainType": "article",
             "type": "faq",
             "uri": "faq/19",
-            "dateCreation": "2023-08-03 12:00:15",
-            "dateModified": "2023-08-03 12:00:15",
+            "dateCreation": "2023-09-20 11:03:55",
+            "dateModified": "2023-09-20 11:03:55",
             "title": "FAQ test",
             "_url": "/ng/app/faq/c/19",
             "_right": {
@@ -40,10 +40,9 @@
                 "_url": "/user/4",
                 "level": 9
             },
-            "processContext": null,
             "faqColor": "#111111",
+            "processContext": null,
             "_audience": [],
-            "image": null,
             "tags": [],
             "isWeb": false
         }

package/phpunitMock/articleGet-faq-category.json

@@ -4,14 +4,14 @@
     "error": 0,
     "messages": [],
     "result": {
-        "id": 416,
+        "id": 13,
         "mainType": "article",
         "type": "faq",
-        "uri": "faq/416",
-        "dateCreation": "2023-09-12 14:39:30",
-        "dateModified": "2023-09-12 14:39:30",
+        "uri": "faq/13",
+        "dateCreation": "2023-09-20 11:03:38",
+        "dateModified": "2023-09-20 11:03:38",
         "title": "CATEGORY 1",
-        "_url": "/ng/app/faq/c/416",
+        "_url": "/ng/app/faq/c/13",
         "_right": {
             "create": true,
             "read": true,
@@ -29,7 +29,7 @@
             "type": "user",
             "uri": "user/4",
             "dateCreation": "2019-07-09 15:48:26",
-            "dateModified": "2023-09-12 10:59:13",
+            "dateModified": "2019-07-09 15:51:24",
             "title": "Admin1",
             "_url": "/user/4",
             "level": 9
@@ -37,7 +37,6 @@
         "processContext": null,
         "faqColor": "",
         "_audience": [],
-        "image": null,
         "tags": [],
         "isWeb": false
     }

package/phpunitMock/articleUpdate-faq-category.json

@@ -13,8 +13,8 @@
         "mainType": "article",
         "type": "faq",
         "uri": "faq/20",
-        "dateCreation": "2023-08-03 12:00:16",
-        "dateModified": "2023-08-03 12:00:17",
+        "dateCreation": "2023-09-20 11:03:55",
+        "dateModified": "2023-09-20 11:03:55",
         "title": "New title",
         "_url": "/ng/app/faq/c/20",
         "_right": {
@@ -39,10 +39,9 @@
             "_url": "/user/4",
             "level": 9
         },
-        "processContext": null,
         "faqColor": "#111111",
+        "processContext": null,
         "_audience": [],
-        "image": null,
         "tags": [],
         "isWeb": false
     }

package/phpunitMock/faqAccess-success.json

@@ -0,0 +1,9 @@
+{
+    "o": "faq",
+    "f": "access",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "createCategory": true
+    }
+}

package/phpunitMock/faqAddTheme-success.json

@@ -0,0 +1,48 @@
+{
+    "o": "faq",
+    "f": "addTheme",
+    "error": 0,
+    "messages": [
+        {
+            "code": 200,
+            "msg": "Enregistrement r\u00e9ussi"
+        }
+    ],
+    "result": {
+        "id": 85,
+        "mainType": "article",
+        "type": "faq",
+        "uri": "faq/85",
+        "dateCreation": "2023-10-04 13:59:38",
+        "dateModified": "2023-10-04 14:00:05",
+        "title": "CATEGORY 1",
+        "_url": "/ng/app/faq/c/85",
+        "_right": {
+            "create": true,
+            "read": true,
+            "publish": false,
+            "administrate": true,
+            "update": true,
+            "delete": true,
+            "comment": true,
+            "member": true
+        },
+        "description": "<div class='content-html'>description FAQ FOR TEST categorie 1</div>",
+        "_user": {
+            "id": 4,
+            "mainType": "user",
+            "type": "user",
+            "uri": "user/4",
+            "dateCreation": "2019-07-09 15:48:26",
+            "dateModified": "2019-07-09 15:51:24",
+            "title": "Admin1",
+            "_url": "/user/4",
+            "level": 9
+        },
+        "processContext": null,
+        "faqColor": "",
+        "_audience": [],
+        "tags": [],
+        "isWeb": false
+    }
+}

package/phpunitMock/faqCheckItem-success.json

@@ -0,0 +1,89 @@
+{
+    "o": "faq",
+    "f": "checkItem",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "limit": 300,
+        "page": 1,
+        "cnt": 2,
+        "data": [
+            {
+                "id": 16,
+                "mainType": "article",
+                "type": "faqItem",
+                "uri": "faqItem/16",
+                "dateCreation": "2023-09-20 11:03:39",
+                "dateModified": "2023-09-20 11:03:39",
+                "title": "ORPHAN ENTRY2",
+                "_url": "/ng/app/faq/q/16",
+                "_right": {
+                    "create": true,
+                    "read": true,
+                    "publish": false,
+                    "administrate": true,
+                    "update": true,
+                    "delete": true,
+                    "comment": true,
+                    "member": true
+                },
+                "description": "<div class='content-html'>ORPHAN ENTRY2</div>",
+                "_user": {
+                    "id": 4,
+                    "mainType": "user",
+                    "type": "user",
+                    "uri": "user/4",
+                    "dateCreation": "2019-07-09 15:48:26",
+                    "dateModified": "2019-07-09 15:51:24",
+                    "title": "Admin1",
+                    "_url": "/user/4",
+                    "level": 9
+                },
+                "_percent": 63.1578947368421,
+                "hierarchy": {
+                    "category": "CATEGORY 2",
+                    "theme": "FAQ THEME2"
+                }
+            },
+            {
+                "id": 18,
+                "mainType": "article",
+                "type": "faqItem",
+                "uri": "faqItem/18",
+                "dateCreation": "2023-09-20 11:03:39",
+                "dateModified": "2023-09-20 11:03:39",
+                "title": "ORPHAN ENTRY3",
+                "_url": "/ng/app/faq/q/18",
+                "_right": {
+                    "create": true,
+                    "read": true,
+                    "publish": false,
+                    "administrate": true,
+                    "update": true,
+                    "delete": true,
+                    "comment": true,
+                    "member": true
+                },
+                "description": "<div class='content-html'>ORPHAN ENTRY3</div>",
+                "_user": {
+                    "id": 4,
+                    "mainType": "user",
+                    "type": "user",
+                    "uri": "user/4",
+                    "dateCreation": "2019-07-09 15:48:26",
+                    "dateModified": "2019-07-09 15:51:24",
+                    "title": "Admin1",
+                    "_url": "/user/4",
+                    "level": 9
+                },
+                "_percent": 63.1578947368421,
+                "hierarchy": {
+                    "category": "CATEGORY 3",
+                    "theme": "FAQ THEME3"
+                }
+            }
+        ],
+        "facets": [],
+        "idQuery": 1695200647
+    }
+}

package/phpunitMock/faqDeleteTheme-success.json

@@ -0,0 +1,48 @@
+{
+    "o": "faq",
+    "f": "deleteTheme",
+    "error": 0,
+    "messages": [
+        {
+            "code": 200,
+            "msg": "Enregistrement r\u00e9ussi"
+        }
+    ],
+    "result": {
+        "id": 85,
+        "mainType": "article",
+        "type": "faq",
+        "uri": "faq/85",
+        "dateCreation": "2023-10-04 13:59:38",
+        "dateModified": "2023-10-04 14:00:05",
+        "title": "CATEGORY 1",
+        "_url": "/ng/app/faq/c/85",
+        "_right": {
+            "create": true,
+            "read": true,
+            "publish": false,
+            "administrate": true,
+            "update": true,
+            "delete": true,
+            "comment": true,
+            "member": true
+        },
+        "description": "<div class='content-html'>description FAQ FOR TEST categorie 1</div>",
+        "_user": {
+            "id": 4,
+            "mainType": "user",
+            "type": "user",
+            "uri": "user/4",
+            "dateCreation": "2019-07-09 15:48:26",
+            "dateModified": "2019-07-09 15:51:24",
+            "title": "Admin1",
+            "_url": "/user/4",
+            "level": 9
+        },
+        "processContext": null,
+        "faqColor": "",
+        "_audience": [],
+        "tags": [],
+        "isWeb": false
+    }
+}

package/phpunitMock/faqSetTheme-success.json

@@ -0,0 +1,11 @@
+{
+    "o": "faq",
+    "f": "setTheme",
+    "error": 0,
+    "messages": [
+        {
+            "code": 200,
+            "msg": "Enregistrement r\u00e9ussi"
+        }
+    ]
+}

package/phpunitMock/objectListFaqQueryList-faq-success.json

@@ -0,0 +1,192 @@
+{
+    "o": "objectList",
+    "f": "faqQueryList",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "limit": 100,
+        "page": 1,
+        "cnt": 5,
+        "data": [
+            {
+                "id": 13,
+                "mainType": "article",
+                "type": "faq",
+                "uri": "faq/13",
+                "dateCreation": "2023-09-27 11:25:39",
+                "dateModified": "2023-09-27 11:26:09",
+                "title": "CATEGORY 1",
+                "_url": "/ng/app/faq/c/13",
+                "_right": {
+                    "create": true,
+                    "read": true,
+                    "publish": false,
+                    "administrate": true,
+                    "update": true,
+                    "delete": true,
+                    "comment": true,
+                    "member": true
+                },
+                "description": "<div class='content-html'>description FAQ FOR TEST categorie 1</div>",
+                "_user": {
+                    "id": 4,
+                    "mainType": "user",
+                    "type": "user",
+                    "uri": "user/4",
+                    "dateCreation": "2019-07-09 15:48:26",
+                    "dateModified": "2019-07-09 15:51:24",
+                    "title": "Admin1",
+                    "_url": "/user/4",
+                    "level": 9
+                },
+                "_extend": {
+                    "itemsCount": 0
+                }
+            },
+            {
+                "id": 15,
+                "mainType": "article",
+                "type": "faq",
+                "uri": "faq/15",
+                "dateCreation": "2023-09-27 11:25:40",
+                "dateModified": "2023-09-27 11:26:02",
+                "title": "CATEGORY 2",
+                "_url": "/ng/app/faq/c/15",
+                "_right": {
+                    "create": true,
+                    "read": true,
+                    "publish": false,
+                    "administrate": true,
+                    "update": true,
+                    "delete": true,
+                    "comment": true,
+                    "member": true
+                },
+                "description": "<div class='content-html'>description FAQ FOR TEST categorie 2</div>",
+                "_user": {
+                    "id": 4,
+                    "mainType": "user",
+                    "type": "user",
+                    "uri": "user/4",
+                    "dateCreation": "2019-07-09 15:48:26",
+                    "dateModified": "2019-07-09 15:51:24",
+                    "title": "Admin1",
+                    "_url": "/user/4",
+                    "level": 9
+                },
+                "_extend": {
+                    "itemsCount": 1
+                }
+            },
+            {
+                "id": 17,
+                "mainType": "article",
+                "type": "faq",
+                "uri": "faq/17",
+                "dateCreation": "2023-09-27 11:25:40",
+                "dateModified": "2023-09-27 11:25:40",
+                "title": "CATEGORY 3",
+                "_url": "/ng/app/faq/c/17",
+                "_right": {
+                    "create": true,
+                    "read": true,
+                    "publish": false,
+                    "administrate": true,
+                    "update": true,
+                    "delete": true,
+                    "comment": false,
+                    "member": true
+                },
+                "description": "<div class='content-html'>description FAQ FOR TEST categorie 3</div>",
+                "_user": {
+                    "id": 4,
+                    "mainType": "user",
+                    "type": "user",
+                    "uri": "user/4",
+                    "dateCreation": "2019-07-09 15:48:26",
+                    "dateModified": "2019-07-09 15:51:24",
+                    "title": "Admin1",
+                    "_url": "/user/4",
+                    "level": 9
+                },
+                "_extend": {
+                    "itemsCount": 1
+                }
+            },
+            {
+                "id": 19,
+                "mainType": "article",
+                "type": "faq",
+                "uri": "faq/19",
+                "dateCreation": "2023-09-27 11:25:56",
+                "dateModified": "2023-09-27 11:25:56",
+                "title": "FAQ test",
+                "_url": "/ng/app/faq/c/19",
+                "_right": {
+                    "create": true,
+                    "read": true,
+                    "publish": false,
+                    "administrate": true,
+                    "update": true,
+                    "delete": true,
+                    "comment": false,
+                    "member": true
+                },
+                "description": "<div class='content-html'>FAQ Category description !</div>",
+                "_user": {
+                    "id": 4,
+                    "mainType": "user",
+                    "type": "user",
+                    "uri": "user/4",
+                    "dateCreation": "2019-07-09 15:48:26",
+                    "dateModified": "2019-07-09 15:51:24",
+                    "title": "Admin1",
+                    "_url": "/user/4",
+                    "level": 9
+                },
+                "faqColor": "#111111",
+                "_extend": {
+                    "itemsCount": 0
+                }
+            },
+            {
+                "id": 20,
+                "mainType": "article",
+                "type": "faq",
+                "uri": "faq/20",
+                "dateCreation": "2023-09-27 11:25:57",
+                "dateModified": "2023-09-27 11:25:57",
+                "title": "New title",
+                "_url": "/ng/app/faq/c/20",
+                "_right": {
+                    "create": true,
+                    "read": true,
+                    "publish": false,
+                    "administrate": true,
+                    "update": true,
+                    "delete": true,
+                    "comment": false,
+                    "member": true
+                },
+                "description": "<div class='content-html'>New description</div>",
+                "_user": {
+                    "id": 4,
+                    "mainType": "user",
+                    "type": "user",
+                    "uri": "user/4",
+                    "dateCreation": "2019-07-09 15:48:26",
+                    "dateModified": "2019-07-09 15:51:24",
+                    "title": "Admin1",
+                    "_url": "/user/4",
+                    "level": 9
+                },
+                "faqColor": "#111111",
+                "_extend": {
+                    "itemsCount": 0
+                }
+            }
+        ],
+        "facets": null,
+        "idQuery": null
+    }
+}