@inweb/client 25.6.0 → 25.6.2

package/lib/Api/Assembly.d.ts

@@ -132,7 +132,8 @@ export declare class Assembly {
      * @async
      */
     save(): Promise<this>;
-    setPreview(image: BodyInit | null): Promise<this>;
+    setPreview(image?: BodyInit | null): Promise<this>;
+    deletePreview(): Promise<this>;
     /**
      * Returns list of assembly models.
      *

package/lib/Api/Client.d.ts

@@ -465,10 +465,8 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      * @param description - Project description.
      * @param startDate - Project start date.
      * @param endDate - Project end date.
-     * @param avatarUrl - Project preview image URL. Can be
-     *   {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
      */
-    createProject(name: string, description?: string, startDate?: Date | string, endDate?: Date | string, avatarUrl?: string): Promise<Project>;
+    createProject(name: string, description?: string, startDate?: Date | string, endDate?: Date | string): Promise<Project>;
     /**
      * Delete the project from the server.
      *

package/lib/Api/File.d.ts

@@ -99,7 +99,7 @@ export declare class File {
      */
     get owner(): IShortUserDescription;
     /**
-     * File preview image URL. Use {@link File#setPreview | setPreview()} to change preview image.
+     * File preview image URL. Use {@link File.setPreview | setPreview()} to change preview image.
      *
      * @readonly
      */
@@ -200,16 +200,21 @@ export declare class File {
      * Set or remove the file preview.
      *
      * @async
-     * @param image - Preview image. Can be a <a
-     *   href="https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs"
-     *   target="_blank">Data URL</a> string, <a
-     *   href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer"
-     *   target="_blank">ArrayBuffer</a>, <a
-     *   href="https://developer.mozilla.org/docs/Web/API/Blob/Blob" target="_blank">Blob</a> or
-     *   Web API <a href="https://developer.mozilla.org/docs/Web/API/File"
-     *   target="_blank">File</a> object. Setting the `image` to `null` will remove the preview.
+     * @param image - Preview image.Can be a
+     *   {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}
+     *   string,
+     *   {@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer | ArrayBuffer},
+     *   {@link https://developer.mozilla.org/docs/Web/API/Blob/Blob | Blob} or Web API
+     *   {@link https://developer.mozilla.org/docs/Web/API/File | File} object. Setting the
+     *   `image` to `null` will remove the preview.
      */
-    setPreview(image: BodyInit | null): Promise<this>;
+    setPreview(image?: BodyInit | null): Promise<this>;
+    /**
+     * Remove the file preview.
+     *
+     * @async
+     */
+    deletePreview(): Promise<this>;
     /**
      * Returns a list of models of the active version of the file.
      *

package/lib/Api/Project.d.ts

@@ -93,7 +93,7 @@ export declare class Project {
      */
     get owner(): IShortUserDescription;
     /**
-     * Project preview image URL. Use [setPreview()]{@link Project#setPreview} to change preview image.
+     * Project preview image URL. Use {@link Project.setPreview | setPreview()} to change preview image.
      *
      * @readonly
      */
@@ -153,16 +153,21 @@ export declare class Project {
      * Set or remove the project preview.
      *
      * @async
-     * @param image - Preview image. Can be a <a
-     *   href="https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs"
-     *   target="_blank">Data URL</a> string, <a
-     *   href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer"
-     *   target="_blank">ArrayBuffer</a>, <a
-     *   href="https://developer.mozilla.org/docs/Web/API/Blob/Blob" target="_blank">Blob</a> or
-     *   Web API <a href="https://developer.mozilla.org/docs/Web/API/File"
-     *   target="_blank">File</a> object. Setting the `image` to `null` will remove the preview.
-     */
-    setPreview(image: BodyInit | null): Promise<any>;
+     * @param image - Preview image. Can be a
+     *   {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}
+     *   string,
+     *   {@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer | ArrayBuffer},
+     *   {@link https://developer.mozilla.org/docs/Web/API/Blob/Blob | Blob} or Web API
+     *   {@link https://developer.mozilla.org/docs/Web/API/File | File} object. Setting the
+     *   `image` to `null` will remove the preview.
+     */
+    setPreview(image?: BodyInit | null): Promise<any>;
+    /**
+     * Remove the project preview.
+     *
+     * @async
+     */
+    deletePreview(): Promise<this>;
     /**
      * Returns a list of project roles. Project {@link Member | members} have different abilities
      * depending on the role they have in a project.

package/lib/Api/User.d.ts

@@ -11,7 +11,7 @@ export declare class User {
      */
     constructor(data: any, httpClient: IHttpClient);
     /**
-     * User avatar image URL. Use {@link User#setAvatar | setAvatar()} to change avatar image.
+     * User avatar image URL. Use {@link User.setAvatar | setAvatar()} to change avatar image.
      *
      * @readonly
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/client",
-  "version": "25.6.0",
+  "version": "25.6.2",
   "description": "JavaScript REST API client for the Open Cloud Server",
   "homepage": "https://cloud.opendesign.com/docs/index.html",
   "license": "SEE LICENSE IN LICENSE",
@@ -26,6 +26,6 @@
     "ts-docs": "typedoc"
   },
   "dependencies": {
-    "@inweb/eventemitter2": "~25.6.0"
+    "@inweb/eventemitter2": "~25.6.2"
   }
 }

package/src/Api/Assembly.ts

@@ -271,7 +271,12 @@ export class Assembly {
 
   // Reserved for future use
 
-  setPreview(image: BodyInit | null): Promise<this> {
+  setPreview(image?: BodyInit | null): Promise<this> {
+    console.warn("Assembly does not support preview");
+    return Promise.resolve(this);
+  }
+
+  deletePreview(): Promise<this> {
     console.warn("Assembly does not support preview");
     return Promise.resolve(this);
   }

package/src/Api/Client.ts

@@ -888,15 +888,12 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @param description - Project description.
    * @param startDate - Project start date.
    * @param endDate - Project end date.
-   * @param avatarUrl - Project preview image URL. Can be
-   *   {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
    */
   createProject(
     name: string,
     description?: string,
     startDate?: Date | string,
-    endDate?: Date | string,
-    avatarUrl?: string
+    endDate?: Date | string
   ): Promise<Project> {
     return this.httpClient
       .post("/projects", {
@@ -904,7 +901,6 @@ export class Client extends EventEmitter2<ClientEventMap> {
         description,
         startDate: startDate instanceof Date ? startDate.toISOString() : startDate,
         endDate: endDate instanceof Date ? endDate.toISOString() : endDate,
-        avatarUrl,
       })
       .then((response) => response.json())
       .then((data) => new Project(data, this.httpClient));

package/src/Api/File.ts

@@ -213,7 +213,7 @@ export class File {
   }
 
   /**
-   * File preview image URL. Use {@link File#setPreview | setPreview()} to change preview image.
+   * File preview image URL. Use {@link File.setPreview | setPreview()} to change preview image.
    *
    * @readonly
    */
@@ -358,17 +358,31 @@ export class File {
    * Set or remove the file preview.
    *
    * @async
-   * @param image - Preview image. Can be a <a
-   *   href="https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs"
-   *   target="_blank">Data URL</a> string, <a
-   *   href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer"
-   *   target="_blank">ArrayBuffer</a>, <a
-   *   href="https://developer.mozilla.org/docs/Web/API/Blob/Blob" target="_blank">Blob</a> or
-   *   Web API <a href="https://developer.mozilla.org/docs/Web/API/File"
-   *   target="_blank">File</a> object. Setting the `image` to `null` will remove the preview.
+   * @param image - Preview image.Can be a
+   *   {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}
+   *   string,
+   *   {@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer | ArrayBuffer},
+   *   {@link https://developer.mozilla.org/docs/Web/API/Blob/Blob | Blob} or Web API
+   *   {@link https://developer.mozilla.org/docs/Web/API/File | File} object. Setting the
+   *   `image` to `null` will remove the preview.
+   */
+  async setPreview(image?: BodyInit | null): Promise<this> {
+    if (!image) {
+      await this.deletePreview();
+    } else {
+      const response = await this.internalPost("/preview", image);
+      this.data = await response.json();
+    }
+    return this;
+  }
+
+  /**
+   * Remove the file preview.
+   *
+   * @async
    */
-  async setPreview(image: BodyInit | null): Promise<this> {
-    const response = await (image ? this.internalPost("/preview", image) : this.internalDelete("/preview"));
+  async deletePreview(): Promise<this> {
+    const response = await this.internalDelete("/preview");
     this.data = await response.json();
     return this;
   }

package/src/Api/Project.ts

@@ -187,7 +187,7 @@ export class Project {
   }
 
   /**
-   * Project preview image URL. Use [setPreview()]{@link Project#setPreview} to change preview image.
+   * Project preview image URL. Use {@link Project.setPreview | setPreview()} to change preview image.
    *
    * @readonly
    */
@@ -293,18 +293,32 @@ export class Project {
    * Set or remove the project preview.
    *
    * @async
-   * @param image - Preview image. Can be a <a
-   *   href="https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs"
-   *   target="_blank">Data URL</a> string, <a
-   *   href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer"
-   *   target="_blank">ArrayBuffer</a>, <a
-   *   href="https://developer.mozilla.org/docs/Web/API/Blob/Blob" target="_blank">Blob</a> or
-   *   Web API <a href="https://developer.mozilla.org/docs/Web/API/File"
-   *   target="_blank">File</a> object. Setting the `image` to `null` will remove the preview.
-   */
-
-  async setPreview(image: BodyInit | null): Promise<any> {
-    const response = await (image ? this.internalPost("/preview", image) : this.internalDelete("/preview"));
+   * @param image - Preview image. Can be a
+   *   {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}
+   *   string,
+   *   {@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer | ArrayBuffer},
+   *   {@link https://developer.mozilla.org/docs/Web/API/Blob/Blob | Blob} or Web API
+   *   {@link https://developer.mozilla.org/docs/Web/API/File | File} object. Setting the
+   *   `image` to `null` will remove the preview.
+   */
+
+  async setPreview(image?: BodyInit | null): Promise<any> {
+    if (!image) {
+      await this.deletePreview();
+    } else {
+      const response = await this.internalPost("/preview", image);
+      this.data = await response.json();
+    }
+    return this;
+  }
+
+  /**
+   * Remove the project preview.
+   *
+   * @async
+   */
+  async deletePreview(): Promise<this> {
+    const response = await this.internalDelete("/preview");
     this.data = await response.json();
     return this;
   }

package/src/Api/User.ts

@@ -42,7 +42,7 @@ export class User {
   }
 
   /**
-   * User avatar image URL. Use {@link User#setAvatar | setAvatar()} to change avatar image.
+   * User avatar image URL. Use {@link User.setAvatar | setAvatar()} to change avatar image.
    *
    * @readonly
    */