jamespot-user-api 1.0.113 → 1.0.115

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

@@ -1,5 +1,5 @@
 import { JBaseApi } from '../base';
-import { ApiWrapper, BaseMessages, Filters, jArticleList, jArticleLittle, MaybeWithToken, Orders, PagingResults } from '../../types';
+import { ApiWrapper, BaseMessages, Filters, jArticleList, jArticleLittle, jObjectBase, MaybeWithToken, Orders, PagingResults } from '../../types';
 export declare type ArticleListConfig = {
     type: string;
     format?: string;
@@ -16,7 +16,7 @@ export declare type ArticleGetConfig = {
 };
 export declare type ArticleCreation = {
     title?: string;
-    description?: string;
+    description?: string | null;
     type?: string;
     publishTo?: string;
     idSpot?: Array<string>;
@@ -29,15 +29,22 @@ export declare type BaseArticle = {
     title: string;
     uri: string;
 };
+export declare type FileArticle = jObjectBase & {
+    title: string;
+    type: 'fileArticle';
+    mainType: 'fileArticle';
+    _url: string;
+};
 export declare class JArticleApi extends JBaseApi {
     list<T extends jArticleLittle = jArticleLittle>(config: ArticleListConfig): Promise<ApiWrapper<PagingResults<T>>>;
     get<T extends jArticleLittle = jArticleLittle>(config: ArticleGetConfig): Promise<ApiWrapper<T & {
         _nbAttachedFiles: number;
     }, BaseMessages>>;
-    create<T extends jArticleLittle = jArticleLittle>(article: MaybeWithToken<ArticleCreation>, format?: string): Promise<ApiWrapper<Array<T>, BaseMessages>>;
+    create<R extends jArticleLittle = jArticleLittle, P extends ArticleCreation = ArticleCreation>(article: MaybeWithToken<P>, format?: string): Promise<ApiWrapper<Array<R>, BaseMessages>>;
     update<T extends {
         uri: string;
     }, U extends jArticleLittle = jArticleList>(article: T): Promise<ApiWrapper<U, BaseMessages>>;
     delete(id: number): Promise<ApiWrapper<boolean, BaseMessages>>;
     count(type: string): Promise<ApiWrapper<number>>;
+    getAttachments(id: number, type: string, format?: string): Promise<ApiWrapper<FileArticle[]>>;
 }

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

@@ -1,7 +1,9 @@
 import { ApiWrapper, BaseMessages, PagingResults, jArticleList, jArticleLittle, jArticleView } from '../../types';
+import { FileArticle } from './article';
 export declare const articleGetMpArticleList: ApiWrapper<jArticleList, BaseMessages>;
 export declare const articleCreateMpArticleLittle: ApiWrapper<Array<jArticleLittle>, BaseMessages>;
 export declare const articleUpdateMpArticleView: ApiWrapper<jArticleView, BaseMessages>;
 export declare const articleCountMpArticle: ApiWrapper<number>;
 export declare const objectListJamespotArticleQueryList: ApiWrapper<PagingResults<jArticleLittle>>;
 export declare const articleDeleteMpArticle: ApiWrapper<boolean, BaseMessages>;
+export declare const articleGetAttachment: ApiWrapper<FileArticle[]>;

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

@@ -0,0 +1,12 @@
+import { JBaseApi } from '../base';
+import { ApiWrapper, CreateFaqCategory, EditFaqCategory, FaqCategoryView, FaqHookProperties, FaqTaxonomy, jArticleLittle } 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 & {
+        _nbAttachedFiles: number;
+    }>>;
+    deleteCategory(id: number): Promise<ApiWrapper<boolean>>;
+    getTaxonomy(): Promise<ApiWrapper<FaqTaxonomy>>;
+    getHookProperties(properties?: Array<keyof FaqHookProperties>): Promise<ApiWrapper<FaqHookProperties>>;
+}

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

@@ -0,0 +1,7 @@
+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>;
+export declare const faqDeleteCategory: ApiWrapper<boolean>;
+export declare const faqGetTaxonomy: ApiWrapper<FaqTaxonomy>;
+export declare const faqGetHookProperties: ApiWrapper<FaqHookProperties>;

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

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

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

@@ -1,24 +1,25 @@
-import { FileCropConfig, FileResponse, UploadConfig } from '../types';
+import { ApiWrapper, FileCropConfig, FileResponse, JFileExtended, UploadConfig } from '../types';
 import { JBaseApi } from './base';
 export declare class JFileApi extends JBaseApi {
     /**
      * Upload a file to the server. use the same token to link the file to an article
      * @param config configuration object. One of "file" and "url" is mandatory
      */
-    upload(config: UploadConfig): Promise<import("../types").ApiWrapper<FileResponse, import("../types").BaseMessages>>;
+    upload(config: UploadConfig): Promise<ApiWrapper<FileResponse, import("../types").BaseMessages>>;
     /**
      * Upload a list of files to the server. use the same token to link the file to an article
      * @param attrName file name (attachment, image, bannerImage, etc.)
      * @param files files
      * @param token token
      */
-    uploadMany(configArray: Array<UploadConfig>): Promise<import("../types").ApiWrapper<FileResponse, import("../types").BaseMessages>[]>;
+    uploadMany(configArray: Array<UploadConfig>): Promise<ApiWrapper<FileResponse, import("../types").BaseMessages>[]>;
+    get<T extends JFileExtended>(idFile: number, format?: string): Promise<ApiWrapper<T>>;
     /**
      * Crop an image
      * @param config crop configuration
      * @returns
      */
-    update(idFile: number | string, type: string, config: FileCropConfig): Promise<import("../types").ApiWrapper<FileResponse, import("../types").BaseMessages> | {
+    update(idFile: number | string, type: string, config: FileCropConfig): Promise<ApiWrapper<FileResponse, import("../types").BaseMessages> | {
         result: {
             crop: {
                 width: any;
@@ -33,10 +34,7 @@ export declare class JFileApi extends JBaseApi {
             token?: string;
             size: string;
             mediaKey: string;
-            imagesize: {
-                width: number;
-                height: number;
-            };
+            imagesize: import("../types").ImageSize;
         };
         o: string;
         f: string;
@@ -51,14 +49,14 @@ export declare class JFileApi extends JBaseApi {
      * @param token token
      * @returns
      */
-    deleteFile(idFile: number | string, attrName: string, token: string, signal?: AbortSignal): Promise<import("../types").ApiWrapper<"", import("../types").BaseMessages>>;
+    deleteFile(idFile: number | string, attrName: string, token: string, signal?: AbortSignal): Promise<ApiWrapper<"", import("../types").BaseMessages>>;
     /**
      * delete the image associated with a content. This action is permanent. There is no two step process with a token
      * @param id content id
      * @param type content type
      * @returns
      */
-    deleteImage(id: number | string, type: string): Promise<import("../types").ApiWrapper<{
+    deleteImage(id: number | string, type: string): Promise<ApiWrapper<{
         id: number;
     }, import("../types").BaseMessages>>;
 }

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

@@ -7,6 +7,7 @@ export * from './base';
 export * from './bookmark/bookmark';
 export * from './community';
 export * from './diapazone/diapazone';
+export * from './faq/faq';
 export * from './file';
 export * from './filebank';
 export * from './group';

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

@@ -21,6 +21,7 @@ import { JWedocApi } from './wedoc/wedoc';
 import { Network } from '../util/network';
 import { TVDisplayApi } from './tvDisplay/tvDisplay';
 import { JShareApi } from './share/share';
+import { JFaqApi } from './faq/faq';
 /**
  * In browser usage, 'window' should be the window object.
  * In server side usage, 'window' object given must implement the fetch method, used by the Apis.
@@ -45,6 +46,7 @@ export declare class JamespotUserApi {
     community: JCommunityApi;
     diapazone: JDiapazoneApi;
     drive: JDriveApi;
+    faq: JFaqApi;
     file: JFileApi;
     filebank: JFilebankApi;
     group: JGroupApi;

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

@@ -1,6 +1,6 @@
 import { JBaseApi } from '../base';
 import { ApiWrapper, BaseMessagesOne, PagingResults } from '../../types';
-import { AutoCompeteConcept, AutocompleteHierarchy, AutoCompleteList, Concept, Taxonomy, TaxonomyCreate } from './types';
+import { AutoCompleteConcept, AutocompleteHierarchy, AutoCompleteList, Concept, Taxonomy, TaxonomyCreate } from './types';
 export declare class JTaxonomyApi extends JBaseApi {
     /**
      * list all taxonomies (no pagination)
@@ -12,10 +12,7 @@ export declare class JTaxonomyApi extends JBaseApi {
      * @param idTaxonomy taxonomy id
      * @param query search characters
      */
-    autocomplete(idTaxonomy: string, query: string): Promise<ApiWrapper<{
-        id: string;
-        type: string;
-    }[], import("../../types").BaseMessages>>;
+    autocomplete(idTaxonomy: string, query: string): Promise<ApiWrapper<AutoCompleteConcept[], import("../../types").BaseMessages>>;
     autocompleteList(payload: AutoCompleteList): Promise<ApiWrapper<PagingResults<Concept>, import("../../types").BaseMessages>>;
-    autocompleteHierarchy(payload: AutocompleteHierarchy): Promise<ApiWrapper<PagingResults<AutoCompeteConcept>, import("../../types").BaseMessages>>;
+    autocompleteHierarchy(payload: AutocompleteHierarchy): Promise<ApiWrapper<PagingResults<AutoCompleteConcept>, import("../../types").BaseMessages>>;
 }

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

@@ -1,8 +1,8 @@
-import { AutoCompeteConcept, Concept, Taxonomy, TaxonomyCreate } from './types';
+import { AutoCompleteConcept, Concept, Taxonomy, TaxonomyCreate } from './types';
 import { ApiWrapper, BaseMessages, PagingResults } from '../../types';
 export declare const taxonomyList: ApiWrapper<Taxonomy[]>;
 export declare const taxonomyCreateParam: TaxonomyCreate;
 export declare const taxonomyCreateResponse: ApiWrapper<Taxonomy, BaseMessages>;
-export declare const taxonomyAutocomplete: ApiWrapper<AutoCompeteConcept[]>;
+export declare const taxonomyAutocomplete: ApiWrapper<AutoCompleteConcept[]>;
 export declare const conceptAutocomplete: ApiWrapper<PagingResults<Concept>>;
-export declare const conceptTaxonomyHierarchy: ApiWrapper<PagingResults<AutoCompeteConcept>>;
+export declare const conceptTaxonomyHierarchy: ApiWrapper<PagingResults<AutoCompleteConcept>>;

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

@@ -74,7 +74,7 @@ export declare type AutocompleteHierarchy = {
     uriTaxonomy: string;
     uriConcept?: string;
 };
-export declare type AutoCompeteConcept = {
+export declare type AutoCompleteConcept = {
     id: string;
     uri: string;
     shortUri: string;

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

@@ -0,0 +1,30 @@
+import { jArticleView, MaybeWithToken } from './utils';
+import { ArticleCreation, AutoCompleteConcept } from '../apis';
+import { ImageSize } from './file';
+import { AudienceAutocomplete } from './autocomplete';
+export declare type FaqCategoryView = jArticleView & {
+    faqColor?: string;
+    _audience: AudienceAutocomplete[];
+    image?: ImageSize | null;
+    tags?: AutoCompleteConcept[];
+    type: 'faq';
+    isWeb: boolean;
+};
+export declare type CreateFaqCategory = MaybeWithToken<Omit<ArticleCreation, 'idSpot'>> & {
+    image?: ImageSize | null;
+    tags?: string;
+    faqColor?: string;
+    isWeb?: boolean;
+    type: 'faq';
+};
+export declare type EditFaqCategory = CreateFaqCategory & {
+    uri: string;
+    format?: string;
+};
+export declare type FaqTaxonomy = {
+    title: string;
+    id: string;
+};
+export declare type FaqHookProperties = {
+    _web: '0' | '1' | '';
+};

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

@@ -5,6 +5,10 @@ export declare type UploadConfig = {
     file?: File | null;
     url?: string;
 };
+export declare type ImageSize = {
+    width: number;
+    height: number;
+};
 export declare type FileResponse = {
     id: string;
     name: string;
@@ -13,10 +17,7 @@ export declare type FileResponse = {
     crop?: FileCropConfig;
     size: string;
     mediaKey: string;
-    imagesize: {
-        width: number;
-        height: number;
-    };
+    imagesize: ImageSize;
 };
 export declare type FileCropConfig = {
     x: number;
@@ -33,3 +34,14 @@ export declare type jFileLittle = Readable<Omit<jObjectLittle, 'dateModified'> &
     dateCreation: string;
     dateModified: string | null;
 }>;
+export declare type jFileRendition = {
+    name: string;
+    filename: string;
+    dateModified: string;
+    mimetype: string;
+};
+export declare type JFileExtended = jFileLittle & {
+    meta?: string;
+    _renditions: string[];
+    _renditionsData: Record<string, jFileRendition>;
+};

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

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

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

@@ -1,5 +1,5 @@
 import { JamespotUserApi } from '../apis';
-import { ApiDefaultWrapper, PagingResults, jArticleLittle, jObjectAutocomplete, jObjectLittle, jObjectList, jUserList, Rights } from '../types';
+import { ApiDefaultWrapper, PagingResults, jArticleLittle, jObjectAutocomplete, jObjectLittle, jObjectList, jUserList, Rights, jArticleView } from '../types';
 import { jCommentList } from '../types/comment';
 import { FetchResponseType, WindowBrowser } from '../window';
 import { Network } from './network';
@@ -12,6 +12,7 @@ export declare const validateApiWrapper: <T extends ApiDefaultWrapper<import("..
 export declare const validatePagingResults: <T>(res: PagingResults<T>) => void;
 export declare const validateObjectIsFormatLittle: <T extends jObjectLittle = jObjectLittle>(object: T) => void;
 export declare const validateObjectIsFormatList: <T extends jObjectList = jObjectList>(object: T) => void;
+export declare const validateArticleIsFormatView: <T extends jArticleView = jArticleView>(object: T) => void;
 export declare const validateUserIsFormatList: <T extends jUserList = jUserList>(object: T) => void;
 export declare const validateCommentIsFormatList: <T extends jCommentList = jCommentList>(object: T) => void;
 export declare const validateObjectIsFormatAutocomplete: <T extends jObjectAutocomplete = jObjectAutocomplete>(object: T) => void;

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

@@ -1,2 +1,5 @@
 export declare function extractTaxonomiesFromObject(objet: Record<string, unknown>): Record<string, unknown>;
+export declare function extractTaxonomiesFromObjectAndMapProperty(objet: Record<string, unknown>, property: string, format?: (o: any) => any): {
+    [k: string]: any;
+};
 export declare function extractTaxonomiesFromObjectAndMapUri(objet: Record<string, unknown>): Record<string, unknown>;

package/package.json

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

package/phpunitMock/articleCreate-faq-category.json

@@ -0,0 +1,51 @@
+{
+    "o": "article",
+    "f": "create",
+    "error": 0,
+    "messages": [
+        {
+            "code": 200,
+            "msg": "Enregistrement r\u00e9ussi"
+        }
+    ],
+    "result": [
+        {
+            "id": 19,
+            "mainType": "article",
+            "type": "faq",
+            "uri": "faq/19",
+            "dateCreation": "2023-08-03 12:00:15",
+            "dateModified": "2023-08-03 12:00:15",
+            "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
+            },
+            "processContext": null,
+            "faqColor": "#111111",
+            "_audience": [],
+            "image": null,
+            "tags": [],
+            "isWeb": false
+        }
+    ]
+}

package/phpunitMock/articleDelete-faq-category.json

@@ -0,0 +1,12 @@
+{
+    "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-faq-category.json

@@ -0,0 +1,45 @@
+{
+    "o": "article",
+    "f": "get",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "id": 416,
+        "mainType": "article",
+        "type": "faq",
+        "uri": "faq/416",
+        "dateCreation": "2023-09-12 14:39:30",
+        "dateModified": "2023-09-12 14:39:30",
+        "title": "CATEGORY 1",
+        "_url": "/ng/app/faq/c/416",
+        "_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": "2023-09-12 10:59:13",
+            "title": "Admin1",
+            "_url": "/user/4",
+            "level": 9
+        },
+        "processContext": null,
+        "faqColor": "",
+        "_audience": [],
+        "image": null,
+        "tags": [],
+        "isWeb": false,
+        "_nbAttachedFiles": 0
+    }
+}

package/phpunitMock/articleGetAttachment-success.json

@@ -0,0 +1,18 @@
+{
+    "o": "article",
+    "f": "getAttachment",
+    "error": 0,
+    "messages": [],
+    "result": [
+        {
+            "id": 70,
+            "mainType": "fileArticle",
+            "type": "fileArticle",
+            "uri": "fileArticle/70",
+            "dateCreation": "2023-09-11 10:56:53",
+            "dateModified": "2023-09-11 10:56:53",
+            "title": "imgTest.jpg",
+            "_url": "/article/416"
+        }
+    ]
+}

package/phpunitMock/articleUpdate-faq-category.json

@@ -0,0 +1,49 @@
+{
+    "o": "article",
+    "f": "update",
+    "error": 0,
+    "messages": [
+        {
+            "code": 200,
+            "msg": "Enregistrement r\u00e9ussi"
+        }
+    ],
+    "result": {
+        "id": 20,
+        "mainType": "article",
+        "type": "faq",
+        "uri": "faq/20",
+        "dateCreation": "2023-08-03 12:00:16",
+        "dateModified": "2023-08-03 12:00:17",
+        "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
+        },
+        "processContext": null,
+        "faqColor": "#111111",
+        "_audience": [],
+        "image": null,
+        "tags": [],
+        "isWeb": false
+    }
+}

package/phpunitMock/faqGetFaqTaxonomy-success.json

@@ -0,0 +1,10 @@
+{
+    "o": "faq",
+    "f": "getFaqTaxonomy",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "title": "FAQ_Custom_Taxonomy",
+        "id": "3"
+    }
+}

package/phpunitMock/faqGetHookProperties-success.json

@@ -0,0 +1,9 @@
+{
+    "o": "faq",
+    "f": "getHookProperties",
+    "error": 0,
+    "messages": [],
+    "result": {
+        "_web": ""
+    }
+}