jamespot-user-api 1.0.101 → 1.0.103

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

@@ -1,4 +1,4 @@
-import { ApiReturn, Category, CreateGroup, Format, GroupList, GroupProperties, GroupView, GroupWidget, jObjectLittle, PagingResults, UpdateGroup } from '../types';
+import { ApiReturn, Category, CreateGroup, Format, GroupList, GroupProperties, GroupView, GroupWidget, PagingResults, UpdateGroup } from '../types';
 import { JBaseApi } from './base';
 export declare class JGroupApi extends JBaseApi {
     /**
@@ -7,21 +7,57 @@ export declare class JGroupApi extends JBaseApi {
      * @param format return format
      * @returns
      */
-    create<T extends Format = undefined>(group: CreateGroup, format?: T): Promise<import("../types").ApiWrapper<ApiReturn<T, jObjectLittle, GroupList, GroupView, jObjectLittle>, import("../types").BaseMessages>>;
+    create<T extends Format = undefined>(group: CreateGroup, format?: T): Promise<import("../types").ApiWrapper<ApiReturn<T, {
+        id: number;
+        mainType: string;
+        type: string;
+        uri: string;
+        dateCreation?: string;
+        dateModified?: string;
+        title: string;
+        _url: string;
+    }, GroupList, GroupView, {
+        id: number;
+        mainType: string;
+        type: string;
+        uri: string;
+        dateCreation?: string;
+        dateModified?: string;
+        title: string;
+        _url: string;
+    }>, 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<import("../types").ApiWrapper<ApiReturn<T, jObjectLittle, GroupList, GroupView, string>, import("../types").BaseMessages>>;
+    update<T extends Format = undefined>(group: UpdateGroup, format?: T): Promise<import("../types").ApiWrapper<ApiReturn<T, {
+        id: number;
+        mainType: string;
+        type: string;
+        uri: string;
+        dateCreation?: string;
+        dateModified?: string;
+        title: string;
+        _url: string;
+    }, 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<import("../types").ApiWrapper<ApiReturn<T, jObjectLittle, GroupList, GroupView, string>, import("../types").BaseMessages>>;
+    getSpot<T extends Format = undefined>(idSpot: number | string, format?: T): Promise<import("../types").ApiWrapper<ApiReturn<T, {
+        id: number;
+        mainType: string;
+        type: string;
+        uri: string;
+        dateCreation?: string;
+        dateModified?: string;
+        title: string;
+        _url: string;
+    }, GroupList, GroupView, string>, import("../types").BaseMessages>>;
     /**
      * Get the properties of a group that are not within the model
      * @param idSpot
@@ -45,5 +81,14 @@ export declare class JGroupApi extends JBaseApi {
      * @param page page number
      * @return array of User
      */
-    getObjectListJamespotSpotMembers(idSpot: number | string, query?: string, limit?: number, page?: number): Promise<import("../types").ApiWrapper<PagingResults<jObjectLittle>, import("../types").BaseMessages>>;
+    getObjectListJamespotSpotMembers(idSpot: number | string, query?: string, limit?: number, page?: number): Promise<import("../types").ApiWrapper<PagingResults<{
+        id: number;
+        mainType: string;
+        type: string;
+        uri: string;
+        dateCreation?: string;
+        dateModified?: string;
+        title: string;
+        _url: string;
+    }>, import("../types").BaseMessages>>;
 }

package/lib/src/index.d.ts

@@ -12,6 +12,7 @@ export default JamespotUserApiInstance;
 export * from './apis';
 export * from './types';
 export * from './util/network';
+export * from './util/file';
 export * from './util/ensure';
 export * from './window';
 export declare const api: typeof JamespotUserApi;

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

@@ -9,6 +9,7 @@ export * from './mediaLibrary';
 export * from './model';
 export * from './search';
 export * from './share';
+export * from './tvDisplay';
 export * from './user';
 export * from './utils';
 export * from './wedoc';

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

@@ -0,0 +1,5 @@
+import { jObjectLittle } from './utils';
+export declare type jSpotLittle = jObjectLittle & {
+    privacy: number;
+    idCategory: number;
+};

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

@@ -0,0 +1,32 @@
+import { jSpotLittle } from './spot';
+import { Readable, jArticleList, jArticleLittle } from './utils';
+declare type TVChannelCustomListDynamic = {
+    tvChannelType: 'DYNAMIC';
+    tvChannelBackgroundColor: string;
+    tvChannelGroupTarget?: jSpotLittle;
+    tvChannelConfig: {
+        contents: Array<{
+            uri: string;
+            dateEnd: Date;
+        }>;
+    };
+    tvChannelNumImages: 0;
+};
+declare type TVChannelCustomListSlideshow = {
+    tvChannelType: 'SLIDESHOW';
+    tvChannelBackgroundColor: string;
+    tvChannelNumImages: number;
+    tvChannelConfig: {
+        contents: Array<{
+            uri: string;
+            dateEnd: Date;
+        }>;
+    };
+};
+export declare type TVChannelLittle = Readable<jArticleLittle>;
+export declare type TVChannelList = Readable<jArticleList & (TVChannelCustomListDynamic | TVChannelCustomListSlideshow)>;
+export declare type TVChannelCreatePayload = {
+    tvChannelGroupTarget?: Array<string>;
+    tvChannelNumImages?: never;
+};
+export {};

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

@@ -1,4 +1,25 @@
 import { jUserLittle } from './user';
+/**
+ * Ease usage in IDE by decomposing complex types
+ * Decompose combined types into simple object types
+ * A: {a: string}
+ * B: A & {b: int}
+ * Readable<B> => {a: string, b:int}
+ */
+export declare type Readable<T> = T extends infer U ? {
+    [K in keyof U]: U[K];
+} : never;
+declare type AllKeys<T> = T extends unknown ? keyof T : never;
+declare type _ExclusifyUnion<T, K extends PropertyKey> = T extends unknown ? Readable<T & Partial<Record<Exclude<K, keyof T>, never>>> : never;
+/**
+ * Builds an exclusive union type from a union type
+ * C = ExclusifyUnion<A|B>
+ * toto:C = {a: "tata"} OK
+ * tata:C = {b: 123} OK
+ * tutu: C = {a: "tata", b: 123} KO => Types of property 'a' are incompatible. Type 'string' is not assignable to type 'undefined'.
+ * This is the kind of error shown when you add too many properties with this definition.
+ */
+export declare type ExclusifyUnion<T> = _ExclusifyUnion<T, AllKeys<T>>;
 export interface BaseMessage {
     msg: string;
     code: number;
@@ -46,10 +67,10 @@ export declare type jObjectBase = {
     dateCreation?: string;
     dateModified?: string;
 };
-export declare type jObjectLittle = jObjectBase & {
+export declare type jObjectLittle = Readable<jObjectBase & {
     title: string;
     _url: string;
-};
+}>;
 export declare type jObjectList = jObjectLittle & {
     description?: string;
     _user: jUserLittle;
@@ -118,3 +139,4 @@ export declare type MaybeWithParent<T extends jObjectBase = jObjectBase> = {
 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];
+export {};

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

@@ -1,61 +1,92 @@
-export declare type WidgetWrapperProps<T = WidgetTypes> = {
+import { AudienceAutocomplete } from './autocomplete';
+import { jArticleLittle } from './utils';
+export declare type WidgetLayer = {
+    uniqid: string;
     title: string;
-    widget: T;
+    locked: boolean;
+    visible: boolean;
+    widgets: WidgetWrapperProps[];
     position?: WidgetVector;
 };
-export declare type WidgetWrapperExtendedProps = {
-    isMandatory?: boolean;
-    isMainTitle?: boolean;
-    isCover?: boolean;
-    doSomethingAfterIsMounted?: boolean;
+export declare type WidgetWrapperProps<T = CombinedWidgetType> = {
+    title: string;
+    widget: WidgetExtendedType & T;
 };
 export declare type WidgetDefaultProps = {
     width?: number | undefined;
     inplace: boolean;
     isComponentVisible?: boolean;
     mode: WidgetDisplayMode;
-    isMounted?: () => void;
     onClick?: () => void;
-    onChange: (content: CombinedWidgetContent) => void;
+    onChange: (content: CombinedWidgetContent, override?: boolean) => void;
     onStateChange?: (state: WidgetStateProps) => void;
 };
-export declare const widgetRefNames: readonly ["widget-article-button", "widget-article-gallery", "widget-article-title", "widget-article-text", "widget-article-attachment", "widget-article-image"];
-export declare type WidgetType<T = CombinedWidgetContent> = {
-    name: typeof widgetRefNames[number];
-    uniqid: string;
-    content: T;
-};
-export declare type WidgetArticleButtonType = WidgetType<WidgetButtonContent> & {
+export declare type CombinedWidgetType = WidgetTypeKeys[keyof WidgetTypeKeys];
+export declare type WidgetTypeKeys = {
+    'widget-article-button': WidgetArticleButtonType;
+    'widget-article-gallery': WidgetArticleGalleryType;
+    'widget-article-title': WidgetArticleTitleType;
+    'widget-article-text': WidgetArticleTextType;
+    'widget-article-image': WidgetArticleImageType;
+    'widget-article-attachment': WidgetArticleAttachmentType;
+};
+export declare type WidgetContentKeys = {
+    'widget-article-button': WidgetArticleButtonContent;
+    'widget-article-gallery': WidgetArticleGalleryContent;
+    'widget-article-title': WidgetArticleTitleContent;
+    'widget-article-text': WidgetArticleTextContent;
+    'widget-article-image': WidgetArticleImageContent;
+    'widget-article-attachment': WidgetArticleAttachmentContent;
+};
+export declare type WidgetKeys = keyof WidgetTypeKeys;
+export declare type WidgetExtendedType = {
+    layers?: string[];
+};
+export declare type WidgetArticleButtonType = {
     name: 'widget-article-button';
+    uniqid: string;
+    content: WidgetArticleButtonContent;
 };
-export declare type WidgetArticleGalleryType = WidgetType<WidgetArticleGalleryContent> & {
+export declare type WidgetArticleGalleryType = {
     name: 'widget-article-gallery';
+    uniqid: string;
+    content: WidgetArticleGalleryContent;
 };
-export declare type WidgetArticleTitleType = WidgetType<WidgetTitleContent> & {
+export declare type WidgetArticleTitleType = {
     name: 'widget-article-title';
+    uniqid: string;
+    content: WidgetArticleTitleContent;
 };
-export declare type WidgetArticleTextType = WidgetType<WidgetTextContent> & {
+export declare type WidgetArticleTextType = {
     name: 'widget-article-text';
+    uniqid: string;
+    content: WidgetArticleTextContent;
 };
-export declare type WidgetArticleImageType = WidgetType<WidgetImageContent> & {
+export declare type WidgetArticleImageType = {
     name: 'widget-article-image';
+    uniqid: string;
+    content: WidgetArticleImageContent;
 };
-export declare type WidgetArticleAttachmentType = WidgetType<WidgetArticleAttachmentContent> & {
+export declare type WidgetArticleAttachmentType = {
     name: 'widget-article-attachment';
+    uniqid: string;
+    content: WidgetArticleAttachmentContent;
 };
-export declare type WidgetTypes = WidgetArticleButtonType | WidgetArticleGalleryType | WidgetArticleTitleType | WidgetArticleTextType | WidgetArticleAttachmentType | WidgetArticleImageType;
 export declare type CSSTextAlignType = 'left' | 'right' | 'center' | 'justify';
 export declare type CSSBackgroundPosition = 'top' | 'bottom' | 'center' | 'left' | 'right';
 export declare type CSSBackgroundSize = 'auto' | 'contain' | 'cover';
 export declare type VariantSizeType = 'sm' | 'md' | 'lg';
 export declare type VariantType = 'contained' | 'outlined';
+export declare type OpeningType = 'link' | 'anchor' | 'popup';
 export declare type WidgetArticleGalleryContent = {
     gap?: string;
-    horizontalNumber?: string;
-    widgets?: WidgetWrapperProps<WidgetArticleImageType>[];
+    columnCount?: string;
+    files?: WidgetFileType[];
     galleryDisplay?: 'portrait' | 'landscape';
+    heightMode?: 'auto' | 'custom';
+    heightModeValue?: string;
 };
-export declare type WidgetTitleContent = {
+export declare type WidgetArticleTitleContent = {
     widgets?: WidgetWrapperProps[];
     text?: string;
     textAlign?: CSSTextAlignType;
@@ -63,14 +94,25 @@ export declare type WidgetTitleContent = {
     color?: string;
     backgroundColor?: string;
 };
-export declare type WidgetTextContent = {
+export declare type WidgetArticleTextContent = {
     text?: string;
     color?: string;
     fontSize?: string;
     lineHeight?: string;
     linkColor?: string;
 };
-export declare type WidgetButtonContent = {
+export declare type OpeningTypeLink = {
+    url: string;
+    target: string;
+};
+export declare type OpeningTypeAnchor = {
+    uniqid: string;
+};
+export declare type OpeningTypePopup = {
+    title: string;
+    widgets: WidgetWrapperProps[];
+};
+export declare type WidgetArticleButtonContent = {
     text?: string;
     color?: string;
     backgroundColor?: string;
@@ -78,8 +120,12 @@ export declare type WidgetButtonContent = {
     fontSize?: string;
     buttonSize?: VariantSizeType;
     variant?: VariantType;
+    openingType?: OpeningType;
+    openingTypeLink?: OpeningTypeLink;
+    openingTypeAnchor?: OpeningTypeAnchor;
+    openingTypePopup?: OpeningTypePopup;
 };
-export declare type WidgetImageContent = {
+export declare type WidgetArticleImageContent = {
     file?: WidgetFileType;
     useFilter?: boolean;
     displayAs?: 'image' | 'background';
@@ -94,18 +140,18 @@ export declare type WidgetArticleAttachmentContent = {
 };
 export declare type CombinedWidgetContent = {
     widgets?: WidgetWrapperProps[];
-} & (WidgetTextContent | WidgetImageContent | WidgetTitleContent | WidgetButtonContent | WidgetArticleGalleryContent | WidgetArticleAttachmentContent);
-export declare type WidgetContentKeys = keyof CombinedWidgetContent;
+} & (WidgetArticleTextContent | WidgetArticleImageContent | WidgetArticleTitleContent | WidgetArticleButtonContent | WidgetArticleGalleryContent | WidgetArticleAttachmentContent);
 export declare type WidgetStateProps = {
     busy?: boolean | undefined;
     loading?: boolean | undefined;
     initialized?: boolean | undefined;
     mounted?: boolean | undefined;
+    hover?: boolean | undefined;
 };
 export declare type WidgetDefinitionProps = {
     label: string;
     description: string;
-    name: typeof widgetRefNames[number];
+    name: WidgetKeys;
     img: string;
     available: boolean;
     panel: {
@@ -121,6 +167,7 @@ export declare type WidgetVector = {
 export declare type WidgetFileType = {
     id: number;
     filename: string;
+    name?: string;
     mimetype: string;
     dimension: {
         width: number;
@@ -138,6 +185,18 @@ export declare type WidgetsRootState = {
 export declare type WidgetsState = {
     token?: string | undefined;
     ids: Record<string, WidgetWrapperProps>;
+    layers: Record<string, WidgetLayer>;
     states: Record<string, WidgetStateProps>;
     modal: WidgetModalProps | undefined;
+    editableMap: Record<string, {
+        index: number;
+        uniqid: string;
+    }>;
+    currentEditableIndex: number;
+    currentEditableWidgetId: string | undefined;
+};
+export declare type ArticleWidgetType = jArticleLittle & {
+    articleWidgets: WidgetWrapperProps[];
+    articleWidgetsCover: number | undefined;
+    _audience: AudienceAutocomplete[];
 };

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

@@ -1,10 +1,28 @@
 import { JamespotUserApi } from '../apis';
-import { ApiDefaultWrapper, PagingResults, jArticleLittle, jObjectAutocomplete, jObjectLittle } from '../types';
+import { ApiDefaultWrapper, PagingResults, jArticleLittle, jObjectAutocomplete } 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 validateApiWrapper: <T extends ApiDefaultWrapper<import("../types").BaseMessages>>(res: T, o: string, f: string, error?: null) => void;
 export declare const validatePagingResults: <T>(res: PagingResults<T>) => void;
-export declare const validateObjectIsFormatLittle: <T extends jObjectLittle = jObjectLittle>(object: T) => boolean;
+export declare const validateObjectIsFormatLittle: <T extends {
+    id: number;
+    mainType: string;
+    type: string;
+    uri: string;
+    dateCreation?: string;
+    dateModified?: string;
+    title: string;
+    _url: string;
+} = {
+    id: number;
+    mainType: string;
+    type: string;
+    uri: string;
+    dateCreation?: string;
+    dateModified?: string;
+    title: string;
+    _url: string;
+}>(object: T) => boolean;
 export declare const validateObjectIsFormatAutocomplete: <T extends jObjectAutocomplete = jObjectAutocomplete>(object: T) => boolean;

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

@@ -0,0 +1,7 @@
+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;

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

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

package/package.json

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