jamespot-user-api 1.0.118 → 1.0.120

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

@@ -1,5 +1,5 @@
 import { JBaseApi } from '../base';
-import { ApiWrapper, BaseMessages, Filters, jArticleList, jArticleLittle, jObjectBase, MaybeWithToken, Orders, PagingResults } from '../../types';
+import { ApiWrapper, BaseMessages, Filters, jArticleList, jArticleLittle, jFileLittle, MaybeWithToken, Orders, PagingResults } from '../../types';
 export type ArticleListConfig = {
     type: string;
     format?: string;
@@ -29,22 +29,14 @@ export type BaseArticle = {
     title: string;
     uri: string;
 };
-export 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>>;
+    get<T extends jArticleLittle = jArticleLittle>(config: ArticleGetConfig): Promise<ApiWrapper<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[]>>;
+    getAttachments(id: number, type: string, format?: string): Promise<ApiWrapper<jFileLittle[]>>;
 }

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

@@ -1,9 +1,9 @@
-import { ApiWrapper, BaseMessages, PagingResults, jArticleList, jArticleLittle, jArticleView } from '../../types';
-import { FileArticle } from './article';
+import { ApiWrapper, BaseMessages, PagingResults, jArticleList, jArticleLittle, jArticleView, jArticleWidgetLittle, jFileLittle } from '../../types';
 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 articleWithWidget: ApiWrapper<jArticleWidgetLittle>;
 export declare const objectListJamespotArticleQueryList: ApiWrapper<PagingResults<jArticleLittle>>;
 export declare const articleDeleteMpArticle: ApiWrapper<boolean, BaseMessages>;
-export declare const articleGetAttachment: ApiWrapper<FileArticle[]>;
+export declare const articleGetAttachment: ApiWrapper<jFileLittle[]>;

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

@@ -1,12 +1,15 @@
 import { JBaseApi } from '../base';
-import { ApiWrapper, CreateFaqCategory, EditFaqCategory, FaqCategoryView, FaqHookProperties, FaqTaxonomy, jArticleLittle } from '../../types';
+import { ApiWrapper, CreateFaqCategory, EditFaqCategory, ExtendedFaqCategory, FaqAccess, FaqCategoryList, FaqCategoryView, FaqHookProperties, FaqItemList, FaqTaxonomy, jArticleLittle, Orders, PagingResults } from '../../types';
 export declare class JFaqApi extends JBaseApi {
+    getCategoriesList<T extends ExtendedFaqCategory<FaqCategoryList> = ExtendedFaqCategory<FaqCategoryList>>(format?: string, orders?: Orders): Promise<ApiWrapper<PagingResults<T>>>;
     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;
-    }>>;
+    getCategory<T extends jArticleLittle = FaqCategoryView>(id: number, format?: string): Promise<ApiWrapper<T>>;
     deleteCategory(id: number): Promise<ApiWrapper<boolean>>;
+    checkItem<T extends FaqItemList>(query: string, page?: number, format?: string): Promise<ApiWrapper<PagingResults<T & {
+        _percent: number;
+    }>>>;
     getTaxonomy(): Promise<ApiWrapper<FaqTaxonomy>>;
     getHookProperties(properties?: Array<keyof FaqHookProperties>): Promise<ApiWrapper<FaqHookProperties>>;
+    getAccess(): Promise<ApiWrapper<FaqAccess>>;
 }

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

@@ -1,7 +1,12 @@
-import { ApiWrapper, FaqCategoryView, FaqHookProperties, FaqTaxonomy } from '../../types';
+import { ApiWrapper, ExtendedFaqCategory, FaqAccess, FaqCategoryList, FaqCategoryView, FaqHookProperties, FaqItemList, FaqTaxonomy, PagingResults } 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>;
+export declare const faqGetAccess: ApiWrapper<FaqAccess>;
+export declare const faqGetCategoriesList: ApiWrapper<PagingResults<ExtendedFaqCategory<FaqCategoryList>>>;
+export declare const faqCheckItem: ApiWrapper<PagingResults<FaqItemList & {
+    _percent: number;
+}>>;

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

@@ -0,0 +1,68 @@
+import { ApiWrapper, FileCropConfig, UploadConfig, jFileLittle, jFileLittleCrop } 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<{
+        response: ApiWrapper<{
+            uri: string;
+            id: number;
+            mainType: string;
+            type: string;
+            dateCreation: string;
+            title: string;
+            _url: string;
+            dateModified: string | null;
+            mimetype: string;
+            path?: string;
+        }, import("../../types").BaseMessages>;
+        token: string;
+    }>;
+    /**
+     * 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<{
+        response: ApiWrapper<{
+            uri: string;
+            id: number;
+            mainType: string;
+            type: string;
+            dateCreation: string;
+            title: string;
+            _url: string;
+            dateModified: string | null;
+            mimetype: string;
+            path?: string;
+        }, import("../../types").BaseMessages>;
+        token: string;
+    }[]>;
+    get<T extends jFileLittle>(idFile: number, format?: string): Promise<ApiWrapper<T>>;
+    /**
+     * Crop an image
+     * @param config crop configuration
+     * @returns
+     */
+    update(idFile: number | string, type: string, config: FileCropConfig): Promise<ApiWrapper<jFileLittleCrop, import("../../types").BaseMessages>>;
+    /**
+     * delete file. This action is not automatic. You need to update the content associated with the deleted image with the same token
+     * @param idFile file id
+     * @param attrName attribute name
+     * @param token token
+     * @returns
+     */
+    deleteFile(idFile: number | string, attrName: string, token: string, signal?: AbortSignal): Promise<ApiWrapper<boolean, 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<ApiWrapper<{
+        id: number;
+    }, import("../../types").BaseMessages>>;
+}

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

@@ -0,0 +1,8 @@
+import { ApiWrapper, jFileLittle, jFileLittleCrop } from '../../types';
+export declare const fileCreateRawLittle: ApiWrapper<jFileLittle>;
+export declare const fileUpdateRawLittle: ApiWrapper<jFileLittleCrop>;
+export declare const fileDeleteDefault: ApiWrapper<boolean>;
+export declare const fileDeleteImageDefault: ApiWrapper<{
+    id: number;
+}>;
+export declare const fileGetDefault: ApiWrapper<jFileLittle>;

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

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

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

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

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

@@ -7,7 +7,7 @@ import { JAudienceApi } from './audience/audience';
 import { JCommunityApi } from './community';
 import { JDiapazoneApi } from './diapazone/diapazone';
 import { JDriveApi } from './drive/drive';
-import { JFileApi } from './file';
+import { JFileApi } from './file/file';
 import { JFilebankApi } from './filebank';
 import { JGroupApi } from './group/group';
 import { JMediaLibraryApi } from './mediaLibrary/mediaLibrary';

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

@@ -1,15 +1,31 @@
-import { jArticleView, MaybeWithToken } from './utils';
+import { jArticleList, jArticleView, MaybeWithToken } from './utils';
 import { ArticleCreation, AutoCompleteConcept } from '../apis';
 import { ImageSize } from './file';
 import { AudienceAutocomplete } from './autocomplete';
 export type FaqCategoryView = jArticleView & {
     faqColor?: string;
     _audience: AudienceAutocomplete[];
-    image?: ImageSize | null;
+    image?: ImageSize;
     tags?: AutoCompleteConcept[];
     type: 'faq';
     isWeb: boolean;
 };
+export type FaqCategoryList = jArticleList & {
+    faqColor?: string;
+    image?: ImageSize;
+};
+export type ExtendedFaqCategory<T extends FaqCategoryList> = 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;
@@ -26,5 +42,10 @@ export type FaqTaxonomy = {
     id: string;
 };
 export type FaqHookProperties = {
-    _web: '0' | '1' | '';
+    _web?: '0' | '1' | '';
+    appImage?: string;
+    appImageText?: string;
+};
+export type FaqAccess = {
+    createCategory: boolean;
 };

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

@@ -9,39 +9,28 @@ export type ImageSize = {
     width: number;
     height: number;
 };
-export type FileResponse = {
-    id: string;
-    name: string;
-    type: string;
-    token?: string;
-    crop?: FileCropConfig;
-    size: string;
-    mediaKey: string;
-    imagesize: ImageSize;
-};
 export type FileCropConfig = {
     x: number;
     y: number;
-    width: number;
-    height: number;
+    w: number;
+    h: number;
     rotation: number;
     killSize?: boolean;
 };
-export type FileCropReturnType = Omit<FileResponse, 'token'> & {
-    crop: FileCropConfig;
-};
 export type jFileLittle = Readable<Omit<jObjectLittle, 'dateModified'> & {
     dateCreation: string;
     dateModified: string | null;
+    mimetype: string;
+    path?: string;
 }>;
+export type jFileLittleCrop = jFileLittle & {
+    _extend: {
+        crop: FileCropConfig;
+    };
+};
 export type jFileRendition = {
     name: string;
     filename: string;
     dateModified: string;
     mimetype: string;
 };
-export type JFileExtended = jFileLittle & {
-    meta?: string;
-    _renditions: string[];
-    _renditionsData: Record<string, jFileRendition>;
-};

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

@@ -1,14 +1,10 @@
-import { AudienceAutocomplete, jArticleList, jArticleLittle, jObjectBase } from '../types';
-export type MediaLibraryAttachment = jObjectBase & {
-    title: string;
-    size: string;
-};
+import { AudienceAutocomplete, jArticleList, jArticleLittle, jFileLittle } from '../types';
 export type MediaLibraryLittle = jArticleLittle & {
-    attachment: MediaLibraryAttachment;
+    attachment: jFileLittle;
     description: string;
 };
 export type MediaLibraryList = jArticleList & {
     description: string;
-    attachment: MediaLibraryAttachment;
+    attachment: jFileLittle;
     _audience: Array<AudienceAutocomplete>;
 };

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;
 }

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

@@ -1,5 +1,9 @@
 import { AudienceAutocomplete } from './autocomplete';
+import { jFileLittle } from './file';
 import { jArticleLittle } from './utils';
+export type jArticleWidgetLittle = jArticleLittle & {
+    articleWidgets: WidgetWrapperProps[];
+};
 export type WidgetLayer = {
     uniqid: string;
     title: string;
@@ -80,14 +84,10 @@ export type VariantType = 'contained' | 'outlined';
 export type OpeningType = 'link' | 'anchor' | 'popup';
 export type WidgetArticleGalleryContent = {
     gap?: string;
-    columnCount?: string;
-    files?: WidgetFileType[];
-    galleryDisplay?: 'portrait' | 'landscape';
-    heightMode?: 'auto' | 'custom';
-    heightModeValue?: string;
+    column?: string;
+    files?: jFileLittle[];
 };
 export type WidgetArticleTitleContent = {
-    widgets?: WidgetWrapperProps[];
     text?: string;
     textAlign?: CSSTextAlignType;
     heading?: string;
@@ -126,16 +126,15 @@ export type WidgetArticleButtonContent = {
     openingTypePopup?: OpeningTypePopup;
 };
 export type WidgetArticleImageContent = {
-    file?: WidgetFileType;
+    file?: jFileLittle;
     useFilter?: boolean;
     displayAs?: 'image' | 'background';
     backgroundPosition?: CSSBackgroundPosition;
     backgroundSize?: CSSBackgroundSize;
     borderRadius?: string;
-    widgets?: WidgetWrapperProps[];
 };
 export type WidgetArticleAttachmentContent = {
-    files?: WidgetFileType[];
+    files?: jFileLittle[];
     fileDisplay?: 'list' | 'gallery';
 };
 export type CombinedWidgetContent = {
@@ -174,7 +173,7 @@ export type WidgetFileType = {
         height: number;
     };
 };
-export type WidgetDisplayMode = 'edit' | 'view';
+export type WidgetDisplayMode = 'edit' | 'view' | 'preview';
 export type WidgetModalProps = {
     title?: string;
     view?: any;

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

@@ -16,6 +16,29 @@ export declare const validateArticleIsFormatView: <T extends jArticleView = jArt
 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;
+export declare const validateFileIsFormatLittle: <T extends {
+    uri: string;
+    id: number;
+    mainType: string;
+    type: string;
+    dateCreation: string;
+    title: string;
+    _url: string;
+    dateModified: string | null;
+    mimetype: string;
+    path?: string;
+} = {
+    uri: string;
+    id: number;
+    mainType: string;
+    type: string;
+    dateCreation: string;
+    title: string;
+    _url: string;
+    dateModified: string | null;
+    mimetype: string;
+    path?: string;
+}>(object: T) => void;
 export declare const expectToHaveProperties: <T>(props: string[], payload: T[]) => void;
 export declare const expectToBeArray: <T>(arr: T[]) => void;
 export declare const validateRights: (object: Rights) => void;

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

@@ -1,7 +1,23 @@
-import { FileResponse, WidgetFileType } from '../types';
-export declare const allowedFileExtensions: string[];
-export declare const mimetypeMap: Record<string, string>;
-export declare function getExtensionFromName(name: string | undefined): string | undefined;
-export declare function getFileFamily(mime: string): string | undefined;
-export declare function getMimetypeFromExtension(ext: string | undefined): string;
-export declare function apiFileToWidgetFile(fileResponse: FileResponse): WidgetFileType;
+import { jFileLittle } from '../types';
+export declare const mimetypes: readonly ["application/vnd.openxmlformats-officedocument.wordprocessingml.document", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.openxmlformats-officedocument.presentationml.presentation", "application/pdf", "application/zip", "application/illustrator", "application/postscript", "application/vnd.ms-opentype", "application/x-font-ttf", "application/octet-stream", "audio/mp3", "audio/mpeg", "font/ttf", "font/otf", "image/jpeg", "image/jpg", "image/png", "image/gif", "image/vnd.adobe.photoshop", "image/svg+xml", "text/plain", "text/csv", "video/mp4", "video/webm"];
+export type MimetypesType = (typeof mimetypes)[number];
+export type fileExtensionTypes = 'docx' | 'xlsx' | 'csv' | 'pptx' | 'pdf' | 'zip' | 'ai' | 'mp3' | 'mpeg' | 'ttf' | 'otf' | 'jpg' | 'jpeg' | 'png' | 'gif' | 'psd' | 'svg' | 'txt' | 'mp4' | 'odt' | 'webm';
+export declare const extensions: fileExtensionTypes[];
+export type fileFamilyTypes = 'application' | 'gif' | 'image' | 'video' | 'audio' | 'font' | 'text';
+export declare const mimetypeToExt: Record<string, fileExtensionTypes>;
+export declare const getMimetypeFromExtension: (fileExt: fileExtensionTypes) => string | undefined;
+export declare const getFileExtensionFromMimetype: (mimetype: string) => fileExtensionTypes;
+export declare function getExtensionFromName(name: string): fileExtensionTypes;
+/**
+ * This resolve bad/missing (mostly application/octet-stream) mimetype with the file name.
+ * If this doesn't match any extension. Return application/octet-stream to get neutral file display
+ */
+export declare const getMimetypeFromName: (name: string) => string;
+/**
+ * Resolve file path. If undefined show file avatar
+ */
+export declare const resolveFilePath: (file: jFileLittle, size?: string) => string | undefined;
+export declare const getFileFamilyFromName: (name: string) => fileFamilyTypes;
+export declare function getFileFamily(mimetype: string | undefined): fileFamilyTypes;
+export declare const resolveFileMimetype: (file: jFileLittle) => string;
+export declare const resolveFileFamily: (file: jFileLittle) => fileFamilyTypes;