@inovitas/infra3dapi 1.0.0-beta.1 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -5
- package/infra3dapi.d.ts +1 -1
- package/infra3dapi.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,21 +1,28 @@
|
|
|
1
1
|
# Installation
|
|
2
|
+
|
|
2
3
|
### NPM Package
|
|
4
|
+
|
|
3
5
|
The API can be installed as a package using npm. To install it from the npm package repository, simply type:
|
|
6
|
+
|
|
4
7
|
```bash
|
|
5
8
|
npm install @inovitas/infra3dapi
|
|
6
9
|
```
|
|
7
10
|
|
|
8
11
|
### CDN Download
|
|
12
|
+
|
|
9
13
|
Alternatively, you can obtain the API from a CDN. To get the latest version, add the following script to your HTML file:
|
|
14
|
+
|
|
10
15
|
```html
|
|
11
16
|
<script src="https://cdn.jsdelivr.net/npm/@inovitas/infra3dapi@latest/infra3dapi.js"></script>
|
|
12
17
|
```
|
|
18
|
+
|
|
13
19
|
We recommend using a specific version in your project. To get a specific version, use the following script and adjust the version accordingly:
|
|
20
|
+
|
|
14
21
|
```html
|
|
15
|
-
<script src="https://cdn.jsdelivr.net/npm/@inovitas/infra3dapi@0.1
|
|
22
|
+
<script src="https://cdn.jsdelivr.net/npm/@inovitas/infra3dapi@1.0.1/infra3dapi.js"></script>
|
|
16
23
|
```
|
|
17
|
-
**Note**: Please do not name the `<div>` in which the viewer is initialized as "infra3d" as this may cause internal conflicts.
|
|
18
24
|
|
|
25
|
+
**Note**: Please do not name the `<div>` in which the viewer is initialized as "infra3d" as this may cause internal conflicts.
|
|
19
26
|
|
|
20
27
|
# Core Concept
|
|
21
28
|
|
|
@@ -28,9 +35,15 @@ To use the API, you can call the init functions in infra3dapi. After loggin in a
|
|
|
28
35
|
3. Your server-side component fetches the access token using client credentials, which can then be shared with your client app.
|
|
29
36
|
4. Your client app uses this token to authenticate with infra3D for requested services, refreshing it via the server component when expired. Remember to treat the client_secret like a password, avoiding exposure in client-side environments for enhanced security.
|
|
30
37
|
|
|
31
|
-
# Changelog
|
|
38
|
+
# Changelog
|
|
39
|
+
|
|
40
|
+
## 1.0.1 - 23.07.2024
|
|
41
|
+
|
|
42
|
+
### Bugfixes
|
|
43
|
+
|
|
44
|
+
- Fixed a bug in the campaign change event in the viewer.
|
|
32
45
|
|
|
33
|
-
## 1.0.0 -
|
|
46
|
+
## 1.0.0 - 17.05.2024
|
|
34
47
|
|
|
35
48
|
### Bugfixes
|
|
36
49
|
|
|
@@ -102,4 +115,4 @@ To use the API, you can call the init functions in infra3dapi. After loggin in a
|
|
|
102
115
|
### Added
|
|
103
116
|
|
|
104
117
|
- Edit functionality
|
|
105
|
-
|
|
118
|
+
|
package/infra3dapi.d.ts
CHANGED
|
@@ -143,7 +143,7 @@ declare type accessTokenResponseType = {
|
|
|
143
143
|
|
|
144
144
|
export declare function getAccessToken(url: string, client_id: string, client_secret: string): Promise<accessTokenResponseType>;
|
|
145
145
|
|
|
146
|
-
export declare function init(rootId: string, token
|
|
146
|
+
export declare function init(rootId: string, token: string, userContext?: {
|
|
147
147
|
id?: string;
|
|
148
148
|
username?: string;
|
|
149
149
|
email?: string;
|