@inweb/client 25.3.12 → 25.3.15

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (C) 2002-2021, Open Design Alliance (the "Alliance").
+Copyright (C) 2002-2024, Open Design Alliance (the "Alliance").
 All rights reserved.
 
 This software and its documentation and related materials are owned by
@@ -13,7 +13,7 @@ with their copyright notices:
 
   This application incorporates Open Design Alliance software pursuant to a
   license agreement with Open Design Alliance.
-  Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
+  Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance.
   All rights reserved.
 
 By use of this software, its documentation or related materials, you

package/README.md

@@ -1,70 +1,55 @@
 # Client.js
 
-`Client.js` is a [JavaScript](https://developer.mozilla.org/docs/Web/JavaScript) library for implementing cross-browser BIM Project management applications. `Client.js` provides the following benefits:
+`Client.js` is a JavaScript library implementing the REST API client for [Open Cloud Server](https://cloud.opendesign.com/docs/index.html#/opencloud_server).
 
-- easy access to the server resources like Projects, Files, Issues etc
-- integration of the [VisualizeJS](https://cloud.opendesign.com/docs/index.html#/visualizejs) library with the [Open Cloud Server](https://cloud.opendesign.com/docs/index.html#/opencloud_server)
-- convenient API to open BIM files from the server for rendering and data management
-- optimizations and improvements of the quality of rendering BIM files
+This library enables you to integrate the [inWEB Open Cloud](https://www.opendesign.com/products/open-cloud) collaboration tools into your BIM Project management applications, including managing CAD and BIM drawings, creating Projects, Issues etc.
 
-## Table of contents
+## Installation
 
-- [Installation](#installation)
-- [Example](#example)
-- [Copyright and license](#copyright-and-license)
+### CDN or static hosting
 
-## Installation
+For CDN, you can use [unpkg](https://unpkg.com/) or [jsDelivr](https://www.jsdelivr.com/) (replace `25.3` with a version you need):
+
+```html
+<script src="https://unpkg.com/@inweb/client@25.3/dist/client.js"></script>
+```
+
+The global namespace for `Client.js` is `ODA.Api`.
 
 ### Install via [npm](https://npmjs.org)
 
 Open a terminal in your project folder and run:
 
 ```sh
-npm install open-cloud-cllient
+npm install @inweb/client
 ```
 
-The `Client.js` package will be downloaded and installed. Then you're ready to import it in your code, see [example](#example) below.
-
-### CDN or static hosting
-
-Declare your script, and then use `ODA` object as shown below.
+The `Client.js` package will be downloaded and installed. Then you're ready to import it in your code:
 
 ```javascript
-<script src="https://opencloud.azureedge.net/libs/clientjs/24.12/client.min.js"></script>
-
-<script>
-  const client = new ODA.Client();
-
-  // place your code here (see example below)
-</script>
+import { Client } from "@inweb/client";
 ```
 
 ## Example
 
-Download and render a drawing file from the `Open Cloud Server`:
-
-```javascript
-// create instance of the Client class for working with server
-const client = new ODA.Client({ serverUrl: "https://cloud.opendesign.com/api" });
+Login to the `Open Cloud Server` and get the file list from the server:
 
-// create instance of Viewer class for rendering drawing files
-const viewer = new ODA.Viewer(client);
+```html
+<script src="https://unpkg.com/@inweb/client@25.3/dist/client.js"></script>
 
-// initialize Viewer it with the specified <canvas> element
-await viewer.initialize(canvas);
-
-// login to the server
-await client.signInWithEmail("email", "password");
-
-// get file list from the server
-const files = await client.getFiles();
+<script>
+  const client = new ODA.Api.Client({ serverUrl: "https://cloud.opendesign.com/api" });
 
-// open the first file in the list
-await viewer.open(files.result[0]);
+  client
+    .signInWithEmail("email", "password")
+    .then(() => client.getFiles())
+    .then((files) => files.result.map((file) => file.name))
+    .then((names) => console.log(names));
+</script>
 ```
 
 To learn more, see [First application guide](https://cloud.opendesign.com/docs/index.html#/guide).
 
 ## Copyright and license
 
-Code and documentation copyright 2002-2023 the [Open Design Alliance](https://opendesign.com). Code is distributed under a proprietary license, see `LICENSE` for more information.
+Code and documentation copyright 2002-2024 the [Open Design Alliance](https://opendesign.com). Code is distributed under a proprietary license, see [LICENSE](./LICENSE) for more information.