Package Exports

@inweb/client
@inweb/client/dist/client.js
@inweb/client/dist/client.module.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@inweb/client) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Client.js

Client.js is a JavaScript library implementing the REST API client for Open Cloud Server.

Core capabilities:

Register on the server as a new user.
Create new and manage existing user accounts.
Upload and download files from the server.
Manage existing files, upload new version of files.
Convert files from one format to another.
Run validation, clash detection, and custom jobs on the server.
Create and manage assemblies.
Create projects, manage project models and members.
Change server settings.
Manage server plugins.

This library is a part of CDE SDK by Open Design Alliance.

Installation

CDN or static hosting

For CDN, you can use unpkg or jsDelivr (replace 25.3 with a version you need):

<script src="https://unpkg.com/@inweb/client@25.3/dist/client.js"></script>

The Client.js library available through the ODA.Api global variable.

<script>
  const client = new ODA.Api.Client({ serverUrl: "https://cloud.opendesign.com/api" });
</script>

Install via npm

Open a terminal in your project folder and run:

npm install @inweb/client

The Client.js package will be downloaded and installed. Then you're ready to import it in your code:

import { Client } from "@inweb/client";

const client = new Client({ serverUrl: "https://cloud.opendesign.com/api" });

Example

<html>
  <body>
    <script src="https://unpkg.com/@inweb/client@25.3/dist/client.js"></script>
    <script>
      const client = new ODA.Api.Client({ serverUrl: "https://cloud.opendesign.com/api" });
      client
        .signInWithEmail("email", "password")
        .then(() => client.getFiles())
        .then((files) => files.result.map((file) => file.name))
        .then((names) => console.log(names));
    </script>
  </body>
</html>

To learn more, see First application guide.

@inweb/client