bimplus-websdk 1.0.45 → 1.0.47
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 +118 -118
- package/clean +3 -3
- package/eslint.config.mjs +35 -35
- package/install +3 -3
- package/jsinspect +20 -20
- package/package.json +19 -18
- package/reinstall +4 -4
package/README.md
CHANGED
|
@@ -1,118 +1,118 @@
|
|
|
1
|
-
bim+ websdk
|
|
2
|
-
=========
|
|
3
|
-
|
|
4
|
-
bim+ websdk is a javascript wrapper around the bim+ api
|
|
5
|
-
|
|
6
|
-
Quick Links
|
|
7
|
-
-----------
|
|
8
|
-
|
|
9
|
-
https://doc.allplan.com/display/bimpluspublic/Bimplus+Web+SDK+Reference
|
|
10
|
-
|
|
11
|
-
How to build
|
|
12
|
-
------------
|
|
13
|
-
|
|
14
|
-
### Install nodejs
|
|
15
|
-
[http://www.nodejs.org/](http://www.nodejs.org/)
|
|
16
|
-
|
|
17
|
-
### Install local npm modules
|
|
18
|
-
Open up a normal command line (admin is not needed) and go to the websdk folder
|
|
19
|
-
|
|
20
|
-
npm install
|
|
21
|
-
|
|
22
|
-
(whenever package.json has changed, you might to do this again)
|
|
23
|
-
|
|
24
|
-
### Build websdk
|
|
25
|
-
Library building process is using UMD (Universal Module Definition) output format so
|
|
26
|
-
it's compatible with both cjs and amd module formats. The same library can be use in the
|
|
27
|
-
client or on the server. Build process is using babel so it's possible to use new ES2015
|
|
28
|
-
code in source codes.
|
|
29
|
-
|
|
30
|
-
Library can be build in several ways as a dev or prod version.
|
|
31
|
-
To run a dev build with source maps run:
|
|
32
|
-
|
|
33
|
-
npm run build
|
|
34
|
-
|
|
35
|
-
To build a prod version - uglified, minified run:
|
|
36
|
-
|
|
37
|
-
npm run build-prod
|
|
38
|
-
|
|
39
|
-
Pulish new release to npm (Hint: Before doing this npm login needs to be done and the package version adjusted) :
|
|
40
|
-
|
|
41
|
-
npm run npm-publish
|
|
42
|
-
|
|
43
|
-
Check content of npm package (result is bimplus-renderer@(version).tar.gz)
|
|
44
|
-
|
|
45
|
-
npm run npm-pack
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
### Develop/Debug websdk
|
|
49
|
-
goto your websdk folder
|
|
50
|
-
|
|
51
|
-
npm link
|
|
52
|
-
|
|
53
|
-
goto your application folder which uses the websdk
|
|
54
|
-
|
|
55
|
-
npm link bimplus-websdk
|
|
56
|
-
|
|
57
|
-
Do you changes in the websdk and build
|
|
58
|
-
|
|
59
|
-
npm run build
|
|
60
|
-
|
|
61
|
-
or
|
|
62
|
-
|
|
63
|
-
npm run build-prod
|
|
64
|
-
|
|
65
|
-
Your app will automatically get the changes done in the renderer
|
|
66
|
-
|
|
67
|
-
After developing it might be wise to unlink:
|
|
68
|
-
goto your websdk folder
|
|
69
|
-
|
|
70
|
-
npm unlink
|
|
71
|
-
goto your application folder which uses the websdk
|
|
72
|
-
|
|
73
|
-
npm unlink bimplus-websdk
|
|
74
|
-
npm install
|
|
75
|
-
|
|
76
|
-
### Unit testing
|
|
77
|
-
With every build output is copied also to the test folder.
|
|
78
|
-
To run the unit tests go to the test subfolder and run :
|
|
79
|
-
|
|
80
|
-
npm install
|
|
81
|
-
npm run test
|
|
82
|
-
|
|
83
|
-
For more information see README.md inside the test folder
|
|
84
|
-
|
|
85
|
-
### Documentation
|
|
86
|
-
Bimplus WebSDK uses npm documentation plugin for easy documentation generation.
|
|
87
|
-
To generate a documentation please install documentation plugin via npm :
|
|
88
|
-
|
|
89
|
-
npm install -g documentation
|
|
90
|
-
|
|
91
|
-
To create documentation in html format go to your websdk folder and run :
|
|
92
|
-
|
|
93
|
-
npm run build-doc
|
|
94
|
-
|
|
95
|
-
Documentation output will be in websdk/documentation folder
|
|
96
|
-
|
|
97
|
-
To create documentation in markdown format go to your websdk folder and run :
|
|
98
|
-
|
|
99
|
-
npm run build-docMd
|
|
100
|
-
|
|
101
|
-
Documentation output will be in websdk/documentation/Bimplus_WebSDK_doc.md file.
|
|
102
|
-
|
|
103
|
-
To create a markdown suitable for Confluence run script:
|
|
104
|
-
|
|
105
|
-
npm run build-docConf
|
|
106
|
-
|
|
107
|
-
This script will convert generated markdown into Confluence format. See console
|
|
108
|
-
output for converted file name.
|
|
109
|
-
|
|
110
|
-
Content of the confluence file can be inserted into Confluence page :
|
|
111
|
-
- start confluence page editation mode
|
|
112
|
-
- choose Insert more content / {} Markup option from toolbar
|
|
113
|
-
- in popup window choose to Insert Markdown format
|
|
114
|
-
- copy content of the converted confluence markdown file into the field in Confluence
|
|
115
|
-
- save it (Please note that page links doesn't work in page preview mode)
|
|
116
|
-
|
|
117
|
-
### Typescript definitions
|
|
118
|
-
- typescript definition file is located in subfolder 'types'
|
|
1
|
+
bim+ websdk
|
|
2
|
+
=========
|
|
3
|
+
|
|
4
|
+
bim+ websdk is a javascript wrapper around the bim+ api
|
|
5
|
+
|
|
6
|
+
Quick Links
|
|
7
|
+
-----------
|
|
8
|
+
|
|
9
|
+
https://doc.allplan.com/display/bimpluspublic/Bimplus+Web+SDK+Reference
|
|
10
|
+
|
|
11
|
+
How to build
|
|
12
|
+
------------
|
|
13
|
+
|
|
14
|
+
### Install nodejs
|
|
15
|
+
[http://www.nodejs.org/](http://www.nodejs.org/)
|
|
16
|
+
|
|
17
|
+
### Install local npm modules
|
|
18
|
+
Open up a normal command line (admin is not needed) and go to the websdk folder
|
|
19
|
+
|
|
20
|
+
npm install
|
|
21
|
+
|
|
22
|
+
(whenever package.json has changed, you might to do this again)
|
|
23
|
+
|
|
24
|
+
### Build websdk
|
|
25
|
+
Library building process is using UMD (Universal Module Definition) output format so
|
|
26
|
+
it's compatible with both cjs and amd module formats. The same library can be use in the
|
|
27
|
+
client or on the server. Build process is using babel so it's possible to use new ES2015
|
|
28
|
+
code in source codes.
|
|
29
|
+
|
|
30
|
+
Library can be build in several ways as a dev or prod version.
|
|
31
|
+
To run a dev build with source maps run:
|
|
32
|
+
|
|
33
|
+
npm run build
|
|
34
|
+
|
|
35
|
+
To build a prod version - uglified, minified run:
|
|
36
|
+
|
|
37
|
+
npm run build-prod
|
|
38
|
+
|
|
39
|
+
Pulish new release to npm (Hint: Before doing this npm login needs to be done and the package version adjusted) :
|
|
40
|
+
|
|
41
|
+
npm run npm-publish
|
|
42
|
+
|
|
43
|
+
Check content of npm package (result is bimplus-renderer@(version).tar.gz)
|
|
44
|
+
|
|
45
|
+
npm run npm-pack
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
### Develop/Debug websdk
|
|
49
|
+
goto your websdk folder
|
|
50
|
+
|
|
51
|
+
npm link
|
|
52
|
+
|
|
53
|
+
goto your application folder which uses the websdk
|
|
54
|
+
|
|
55
|
+
npm link bimplus-websdk
|
|
56
|
+
|
|
57
|
+
Do you changes in the websdk and build
|
|
58
|
+
|
|
59
|
+
npm run build
|
|
60
|
+
|
|
61
|
+
or
|
|
62
|
+
|
|
63
|
+
npm run build-prod
|
|
64
|
+
|
|
65
|
+
Your app will automatically get the changes done in the renderer
|
|
66
|
+
|
|
67
|
+
After developing it might be wise to unlink:
|
|
68
|
+
goto your websdk folder
|
|
69
|
+
|
|
70
|
+
npm unlink
|
|
71
|
+
goto your application folder which uses the websdk
|
|
72
|
+
|
|
73
|
+
npm unlink bimplus-websdk
|
|
74
|
+
npm install
|
|
75
|
+
|
|
76
|
+
### Unit testing
|
|
77
|
+
With every build output is copied also to the test folder.
|
|
78
|
+
To run the unit tests go to the test subfolder and run :
|
|
79
|
+
|
|
80
|
+
npm install
|
|
81
|
+
npm run test
|
|
82
|
+
|
|
83
|
+
For more information see README.md inside the test folder
|
|
84
|
+
|
|
85
|
+
### Documentation
|
|
86
|
+
Bimplus WebSDK uses npm documentation plugin for easy documentation generation.
|
|
87
|
+
To generate a documentation please install documentation plugin via npm :
|
|
88
|
+
|
|
89
|
+
npm install -g documentation
|
|
90
|
+
|
|
91
|
+
To create documentation in html format go to your websdk folder and run :
|
|
92
|
+
|
|
93
|
+
npm run build-doc
|
|
94
|
+
|
|
95
|
+
Documentation output will be in websdk/documentation folder
|
|
96
|
+
|
|
97
|
+
To create documentation in markdown format go to your websdk folder and run :
|
|
98
|
+
|
|
99
|
+
npm run build-docMd
|
|
100
|
+
|
|
101
|
+
Documentation output will be in websdk/documentation/Bimplus_WebSDK_doc.md file.
|
|
102
|
+
|
|
103
|
+
To create a markdown suitable for Confluence run script:
|
|
104
|
+
|
|
105
|
+
npm run build-docConf
|
|
106
|
+
|
|
107
|
+
This script will convert generated markdown into Confluence format. See console
|
|
108
|
+
output for converted file name.
|
|
109
|
+
|
|
110
|
+
Content of the confluence file can be inserted into Confluence page :
|
|
111
|
+
- start confluence page editation mode
|
|
112
|
+
- choose Insert more content / {} Markup option from toolbar
|
|
113
|
+
- in popup window choose to Insert Markdown format
|
|
114
|
+
- copy content of the converted confluence markdown file into the field in Confluence
|
|
115
|
+
- save it (Please note that page links doesn't work in page preview mode)
|
|
116
|
+
|
|
117
|
+
### Typescript definitions
|
|
118
|
+
- typescript definition file is located in subfolder 'types'
|
package/clean
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
#!/usr/bin/env bash
|
|
2
|
-
|
|
3
|
-
rm -rf ./dist ./node_modules
|
|
1
|
+
#!/usr/bin/env bash
|
|
2
|
+
|
|
3
|
+
rm -rf ./dist ./node_modules
|
package/eslint.config.mjs
CHANGED
|
@@ -1,35 +1,35 @@
|
|
|
1
|
-
import globals from "globals";
|
|
2
|
-
import js from "@eslint/js";
|
|
3
|
-
|
|
4
|
-
export default [
|
|
5
|
-
js.configs.recommended,
|
|
6
|
-
// File-pattern specific overrides
|
|
7
|
-
{
|
|
8
|
-
files: ["src/**/*", "test/**/*"],
|
|
9
|
-
rules: {
|
|
10
|
-
semi: ["warn", "always"] // check for missing semicolons at line ends
|
|
11
|
-
}
|
|
12
|
-
},
|
|
13
|
-
{
|
|
14
|
-
languageOptions: {
|
|
15
|
-
ecmaVersion: 2022,
|
|
16
|
-
sourceType: "module",
|
|
17
|
-
globals: {
|
|
18
|
-
...globals.browser,
|
|
19
|
-
$: true,
|
|
20
|
-
QUnit: true,
|
|
21
|
-
// Uint8Array: true,
|
|
22
|
-
// DataView : true,
|
|
23
|
-
// Promise: true,
|
|
24
|
-
// ArrayBuffer: true,
|
|
25
|
-
// needed for webpack files
|
|
26
|
-
define: true,
|
|
27
|
-
require: true,
|
|
28
|
-
module: true,
|
|
29
|
-
__dirname: true,
|
|
30
|
-
},
|
|
31
|
-
},
|
|
32
|
-
plugins: {},
|
|
33
|
-
rules: {},
|
|
34
|
-
},
|
|
35
|
-
];
|
|
1
|
+
import globals from "globals";
|
|
2
|
+
import js from "@eslint/js";
|
|
3
|
+
|
|
4
|
+
export default [
|
|
5
|
+
js.configs.recommended,
|
|
6
|
+
// File-pattern specific overrides
|
|
7
|
+
{
|
|
8
|
+
files: ["src/**/*", "test/**/*"],
|
|
9
|
+
rules: {
|
|
10
|
+
semi: ["warn", "always"] // check for missing semicolons at line ends
|
|
11
|
+
}
|
|
12
|
+
},
|
|
13
|
+
{
|
|
14
|
+
languageOptions: {
|
|
15
|
+
ecmaVersion: 2022,
|
|
16
|
+
sourceType: "module",
|
|
17
|
+
globals: {
|
|
18
|
+
...globals.browser,
|
|
19
|
+
$: true,
|
|
20
|
+
QUnit: true,
|
|
21
|
+
// Uint8Array: true,
|
|
22
|
+
// DataView : true,
|
|
23
|
+
// Promise: true,
|
|
24
|
+
// ArrayBuffer: true,
|
|
25
|
+
// needed for webpack files
|
|
26
|
+
define: true,
|
|
27
|
+
require: true,
|
|
28
|
+
module: true,
|
|
29
|
+
__dirname: true,
|
|
30
|
+
},
|
|
31
|
+
},
|
|
32
|
+
plugins: {},
|
|
33
|
+
rules: {},
|
|
34
|
+
},
|
|
35
|
+
];
|
package/install
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
#!/usr/bin/env bash
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
#!/usr/bin/env bash
|
|
2
|
+
|
|
3
|
+
npm install
|
package/jsinspect
CHANGED
|
@@ -1,20 +1,20 @@
|
|
|
1
|
-
#!/usr/bin/env bash
|
|
2
|
-
|
|
3
|
-
#install jsinspect
|
|
4
|
-
npm list -g --quiet jsinspect > "/dev/null" 2>&1
|
|
5
|
-
OUT=$?
|
|
6
|
-
if [ ${OUT} != 0 ]
|
|
7
|
-
then
|
|
8
|
-
npm install -g jsinspect
|
|
9
|
-
RET_VAL=$?
|
|
10
|
-
if [ ${RET_VAL} -ne 0 ]
|
|
11
|
-
then
|
|
12
|
-
echo "Error ---> Unable to install \"jsinspect\""
|
|
13
|
-
exit ${RET_VAL}
|
|
14
|
-
fi
|
|
15
|
-
echo "Info ---> \"jsinspect\" has been installed."
|
|
16
|
-
else
|
|
17
|
-
echo "Info ---> \"jsinspect\" already installed."
|
|
18
|
-
fi
|
|
19
|
-
|
|
20
|
-
jsinspect ./src
|
|
1
|
+
#!/usr/bin/env bash
|
|
2
|
+
|
|
3
|
+
#install jsinspect
|
|
4
|
+
npm list -g --quiet jsinspect > "/dev/null" 2>&1
|
|
5
|
+
OUT=$?
|
|
6
|
+
if [ ${OUT} != 0 ]
|
|
7
|
+
then
|
|
8
|
+
npm install -g jsinspect
|
|
9
|
+
RET_VAL=$?
|
|
10
|
+
if [ ${RET_VAL} -ne 0 ]
|
|
11
|
+
then
|
|
12
|
+
echo "Error ---> Unable to install \"jsinspect\""
|
|
13
|
+
exit ${RET_VAL}
|
|
14
|
+
fi
|
|
15
|
+
echo "Info ---> \"jsinspect\" has been installed."
|
|
16
|
+
else
|
|
17
|
+
echo "Info ---> \"jsinspect\" already installed."
|
|
18
|
+
fi
|
|
19
|
+
|
|
20
|
+
jsinspect ./src
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "bimplus-websdk",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.47",
|
|
4
4
|
"description": "bim+ websdk",
|
|
5
5
|
"types": "types/bimplus-websdk.d.ts",
|
|
6
6
|
"keywords": [
|
|
@@ -19,16 +19,17 @@
|
|
|
19
19
|
"eslint": "eslint src/**/*.js test/**/*.js",
|
|
20
20
|
"build": "npm run eslint && webpack --config webpack.dev.js",
|
|
21
21
|
"build-prod": "npm run eslint && webpack --config webpack.prod.js",
|
|
22
|
-
"pub": "
|
|
23
|
-
"
|
|
24
|
-
"yarn-publish-branch": "npm run build-prod && yarn publish --tag",
|
|
22
|
+
"pub": "npm run build-prod && npm publish",
|
|
23
|
+
"pub-tag": "npm run build-prod && npm publish --tag dev",
|
|
25
24
|
"npm-pack": "npm run build-prod && npm pack",
|
|
25
|
+
"bump": "npm run bump:patch",
|
|
26
|
+
"bump:patch": "npm version patch --no-git-tag-version",
|
|
26
27
|
"install-documentation-package": "npm install -g documentation",
|
|
27
28
|
"lint-doc": "documentation lint ./src/Api/*.js",
|
|
28
|
-
"build-doc": "
|
|
29
|
-
"build-docMd": "
|
|
30
|
-
"build-docConf": "
|
|
31
|
-
"build-docAll": "
|
|
29
|
+
"build-doc": "npm run lint-doc && documentation build ./src/Api/*.js --config doc_config.yml -f html -o ./documentation",
|
|
30
|
+
"build-docMd": "npm run lint-doc && documentation build ./src/Api/*.js -f md -o ./documentation/Bimplus_WebSDK_doc.md",
|
|
31
|
+
"build-docConf": "npm run build-docMd && cd ./documentation && python convert_to_confluence_md.py",
|
|
32
|
+
"build-docAll": "npm run build-doc && npm run build-docConf && npm run build-docMd && npm run build-doc",
|
|
32
33
|
"test": "node node_modules/karma/bin/karma start",
|
|
33
34
|
"test-chrome": "npm run test -- --single-run=true --browsers ChromeExt karma.conf.js",
|
|
34
35
|
"test-chrome-headless": "npm run test -- --single-run=true --browsers ChromeHeadless karma.conf.js",
|
|
@@ -37,17 +38,17 @@
|
|
|
37
38
|
"test-watch": "npm run test -- --browsers=ChromeExt --single-run=false --auto-watch"
|
|
38
39
|
},
|
|
39
40
|
"devDependencies": {
|
|
40
|
-
"@babel/core": "^7.26.
|
|
41
|
-
"@babel/plugin-transform-runtime": "^7.
|
|
42
|
-
"@babel/preset-env": "^7.26.
|
|
43
|
-
"@babel/runtime": "^7.26.
|
|
44
|
-
"axios": "^1.
|
|
45
|
-
"babel-loader": "^
|
|
41
|
+
"@babel/core": "^7.26.10",
|
|
42
|
+
"@babel/plugin-transform-runtime": "^7.26.10",
|
|
43
|
+
"@babel/preset-env": "^7.26.9",
|
|
44
|
+
"@babel/runtime": "^7.26.9",
|
|
45
|
+
"axios": "^1.8.4",
|
|
46
|
+
"babel-loader": "^10.0.0",
|
|
46
47
|
"clean-webpack-plugin": "^4.0.0",
|
|
47
48
|
"coverage-istanbul-loader": "^3.0.5",
|
|
48
49
|
"documentation": "^14.0.3",
|
|
49
|
-
"eslint": "^9.
|
|
50
|
-
"globals": "
|
|
50
|
+
"eslint": "^9.24.0",
|
|
51
|
+
"globals": "16.0.0",
|
|
51
52
|
"host-environment": "^2.1.2",
|
|
52
53
|
"karma": "^6.4.4",
|
|
53
54
|
"karma-chrome-launcher": "^3.2.0",
|
|
@@ -58,8 +59,8 @@
|
|
|
58
59
|
"karma-qunit": "^4.2.1",
|
|
59
60
|
"karma-webpack": "^5.0.1",
|
|
60
61
|
"qunit": "^2.24.1",
|
|
61
|
-
"terser-webpack-plugin": "^5.3.
|
|
62
|
-
"webpack": "^5.
|
|
62
|
+
"terser-webpack-plugin": "^5.3.14",
|
|
63
|
+
"webpack": "^5.99.5",
|
|
63
64
|
"webpack-cli": "^6.0.1",
|
|
64
65
|
"webpack-merge": "^6.0.1"
|
|
65
66
|
},
|
package/reinstall
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#!/usr/bin/env bash
|
|
2
|
-
|
|
3
|
-
./clean
|
|
4
|
-
./install
|
|
1
|
+
#!/usr/bin/env bash
|
|
2
|
+
|
|
3
|
+
./clean
|
|
4
|
+
./install
|