bimplus-websdk 1.0.64 → 1.0.65

package/.github/instructions/typescript-declarations.instructions.md

@@ -0,0 +1,116 @@
+---
+applyTo: "websdk/types/bimplus-websdk.d.ts"
+---
+
+# Bimplus WebSDK — TypeScript Declarations
+
+## File Structure
+
+All declarations live inside a single module augmentation — never add top-level exports outside it:
+
+```ts
+declare module 'bimplus-websdk' {
+  // all types here
+}
+```
+
+---
+
+## Base Type Aliases
+
+These are already defined — use them for parameter and return types instead of plain `string`:
+
+```ts
+Guid                // string UUID
+ProjectId           // Guid
+ModelId             // Guid
+LayerId             // Guid
+DivisionTopologyId  // Guid
+RevisionId          // string
+TeamSlug            // string
+AccessToken         // string
+AccessTokenType     // string
+HTML                // string
+```
+
+---
+
+## Pattern for a New Resource Module
+
+For each new `src/Api/MyResource.js`, add three things:
+
+### 1. A data interface
+
+```ts
+export interface MyResourceData {
+    id: Guid;
+    name: string;
+    // match field names from the REST API response exactly
+}
+```
+
+### 2. A class declaration
+
+```ts
+export class MyResource {
+    constructor(api: Api);
+    get(id?: Guid): Promise<MyResourceData | MyResourceData[]>;
+    post(data: string): Promise<MyResourceData>;
+    put(id: Guid, data: string): Promise<MyResourceData>;
+    delete(id: Guid): Promise<void>;
+}
+```
+
+### 3. A property on the `Api` class
+
+Add to the existing `Api` class body, matching the exact property name from `src/Api/Api.js`:
+
+```ts
+// In src/Api/Api.js: this.myResource = new MyResource(this)
+myResource: MyResource;
+```
+
+---
+
+## Conventions
+
+- All async methods return `Promise<T>` — never use jQuery types (`JQuery.Promise`, `$.Deferred`) in declarations
+- For optional parameters use `?`: `get(id?: Guid)`
+- For methods that return a single item or an array: `Promise<T | T[]>`
+- `data` parameters passed as `JSON.stringify(...)` in the source are typed as `string`
+- Keep parameter names consistent with the JSDoc `@param` names in the corresponding source file
+- For complex `data` shapes that are always structured objects (not stringified), define a dedicated interface and use it: `post(data: MyResourceData): Promise<MyResourceData>`
+- For query-param-only options (e.g. `additionalParams`), use a typed object or the existing `AdditionalParams` alias:
+  ```ts
+  type AdditionalParams = { [key: string]: string };
+  ```
+
+---
+
+## Api Class Declaration
+
+The `Api` class in this file is the single source of truth for TypeScript consumers. Every namespace instantiated in `src/Api/Api.js` must appear as a property:
+
+```ts
+export class Api {
+    constructor(config?: ApiConfig);
+    setAccessToken(token: AccessToken): void;
+    setTokenType(tokenType: AccessTokenType): void;
+    setAccessTokenAndType(token: AccessToken, tokenType: AccessTokenType): void;
+    getAccessToken(): AccessToken;
+    getTokenType(): AccessTokenType;
+    getAccessTokenAndType(): { token: AccessToken; tokenType: AccessTokenType };
+    setTeamSlug(slug: TeamSlug): void;
+    getTeamSlug(): TeamSlug;
+    getApiUrl(): string;
+    getApiTeamUrl(): string;
+
+    // resource namespaces
+    authorize: Authorize;
+    projects: Projects;
+    models: Models;
+    // ... one line per namespace
+}
+```
+
+When adding a new module, append its property in the same order it appears in the `Api` constructor in `src/Api/Api.js`.

package/README.md

@@ -1,118 +1,118 @@
-bim+ websdk
-=========
-
-bim+ websdk is a javascript wrapper around the bim+ api
-
-Quick Links
------------
-
-https://nemetschekprime.atlassian.net/wiki/spaces/bimpluspublic/pages/1090127532/Bimplus+Web+SDK+Reference
-
-How to build
-------------
-
-### Install nodejs
-[http://www.nodejs.org/](http://www.nodejs.org/)
-
-### Install local npm modules
-Open up a normal command line (admin is not needed) and go to the websdk folder
-
-    npm install
-
-(whenever package.json has changed, you might to do this again)
-
-### Build websdk
-Library building process is using UMD (Universal Module Definition) output format so
-it's compatible with both cjs and amd module formats. The same library can be use in the
-client or on the server. Build process is using babel so it's possible to use new ES2015
-code in source codes.
-
-Library can be build in several ways as a dev or prod version.
-To run a dev build with source maps run:
-
-    npm run build
-
-To build a prod version - uglified, minified run:
-
-    npm run build-prod
-
-Pulish new release to npm (Hint: Before doing this npm login needs to be done and the package version adjusted) :
-
-    npm run npm-publish
-
-Check content of npm package (result is bimplus-renderer@(version).tar.gz)
-
-    npm run npm-pack
-
-    
-### Develop/Debug websdk
-goto your websdk folder
-
-    npm link
-
-goto your application folder which uses the websdk
-
-    npm link bimplus-websdk
-
-Do you changes in the websdk and build
-
-    npm run build
-
-or
-
-    npm run build-prod
-
-Your app will automatically get the changes done in the renderer
-
-After developing it might be wise to unlink:
-goto your websdk folder
-
-    npm unlink
-goto your application folder which uses the websdk
-
-    npm unlink bimplus-websdk
-    npm install
-
-### Unit testing
-With every build output is copied also to the test folder.
-To run the unit tests go to the test subfolder and run :
-
-    npm install
-    npm run test
-
-For more information see README.md inside the test folder
-
-### Documentation
-Bimplus WebSDK uses npm documentation plugin for easy documentation generation.
-To generate a documentation please install documentation plugin via npm :
-
-    npm install -g documentation
-
-To create documentation in html format go to your websdk folder and run :
-
-    npm run build-doc
-
-Documentation output will be in websdk/documentation folder
-
-To create documentation in markdown format go to your websdk folder and run :
-
-    npm run build-docMd
-
-Documentation output will be in websdk/documentation/Bimplus_WebSDK_doc.md file.
-
-To create a markdown suitable for Confluence run script:
-
-    npm run build-docConf
-
-This script will convert generated markdown into Confluence format. See console
-output for converted file name.
-
-Content of the confluence file can be inserted into Confluence page :
-- start confluence page editation mode
-- choose Insert more content  / {} Markup option from toolbar
-- in popup window choose to Insert Markdown format
-- copy content of the converted confluence markdown file into the field in Confluence
-- save it (Please note that page links doesn't work in page preview mode)
-
-### Typescript definitions
-- typescript definition file is located in subfolder 'types'
+bim+ websdk
+=========
+
+bim+ websdk is a javascript wrapper around the bim+ api
+
+Quick Links
+-----------
+
+https://nemetschekprime.atlassian.net/wiki/spaces/bimpluspublic/pages/1090127532/Bimplus+Web+SDK+Reference
+
+How to build
+------------
+
+### Install nodejs
+[http://www.nodejs.org/](http://www.nodejs.org/)
+
+### Install local npm modules
+Open up a normal command line (admin is not needed) and go to the websdk folder
+
+    npm install
+
+(whenever package.json has changed, you might to do this again)
+
+### Build websdk
+Library building process is using UMD (Universal Module Definition) output format so
+it's compatible with both cjs and amd module formats. The same library can be use in the
+client or on the server. Build process is using babel so it's possible to use new ES2015
+code in source codes.
+
+Library can be build in several ways as a dev or prod version.
+To run a dev build with source maps run:
+
+    npm run build
+
+To build a prod version - uglified, minified run:
+
+    npm run build-prod
+
+Pulish new release to npm (Hint: Before doing this npm login needs to be done and the package version adjusted) :
+
+    npm run npm-publish
+
+Check content of npm package (result is bimplus-renderer@(version).tar.gz)
+
+    npm run npm-pack
+
+    
+### Develop/Debug websdk
+goto your websdk folder
+
+    npm link
+
+goto your application folder which uses the websdk
+
+    npm link bimplus-websdk
+
+Do you changes in the websdk and build
+
+    npm run build
+
+or
+
+    npm run build-prod
+
+Your app will automatically get the changes done in the renderer
+
+After developing it might be wise to unlink:
+goto your websdk folder
+
+    npm unlink
+goto your application folder which uses the websdk
+
+    npm unlink bimplus-websdk
+    npm install
+
+### Unit testing
+With every build output is copied also to the test folder.
+To run the unit tests go to the test subfolder and run :
+
+    npm install
+    npm run test
+
+For more information see README.md inside the test folder
+
+### Documentation
+Bimplus WebSDK uses npm documentation plugin for easy documentation generation.
+To generate a documentation please install documentation plugin via npm :
+
+    npm install -g documentation
+
+To create documentation in html format go to your websdk folder and run :
+
+    npm run build-doc
+
+Documentation output will be in websdk/documentation folder
+
+To create documentation in markdown format go to your websdk folder and run :
+
+    npm run build-docMd
+
+Documentation output will be in websdk/documentation/Bimplus_WebSDK_doc.md file.
+
+To create a markdown suitable for Confluence run script:
+
+    npm run build-docConf
+
+This script will convert generated markdown into Confluence format. See console
+output for converted file name.
+
+Content of the confluence file can be inserted into Confluence page :
+- start confluence page editation mode
+- choose Insert more content  / {} Markup option from toolbar
+- in popup window choose to Insert Markdown format
+- copy content of the converted confluence markdown file into the field in Confluence
+- save it (Please note that page links doesn't work in page preview mode)
+
+### Typescript definitions
+- typescript definition file is located in subfolder 'types'

package/clean

@@ -1,3 +1,3 @@
-#!/usr/bin/env bash
-
-rm -rf ./dist ./node_modules
+#!/usr/bin/env bash
+
+rm -rf ./dist ./node_modules