bimplus-websdk 1.0.10 → 1.0.12

package/README.md

@@ -113,3 +113,6 @@ Content of the confluence file can be inserted into Confluence page :
 - 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/package.json

@@ -1,7 +1,8 @@
 {
   "name": "bimplus-websdk",
-  "version": "1.0.10",
+  "version": "1.0.12",
   "description": "bim+ websdk",
+  "types": "types/bimplus-websdk.d.ts",
   "keywords": [
     "Allplan",
     "Bimplus",
@@ -35,7 +36,7 @@
     "test-watch": "npm run test -- --browsers=Chrome --single-run=false --auto-watch"
   },
   "devDependencies": {
-    "@babel/core": "^7.24.8",
+    "@babel/core": "^7.24.9",
     "@babel/plugin-transform-runtime": "^7.24.7",
     "@babel/preset-env": "^7.24.8",
     "@babel/runtime": "^7.24.8",
@@ -54,7 +55,7 @@
     "karma-jquery": "^0.2.4",
     "karma-qunit": "^4.2.0",
     "karma-webpack": "^5.0.1",
-    "qunit": "^2.21.0",
+    "qunit": "^2.21.1",
     "terser-webpack-plugin": "^5.3.10",
     "webpack": "^5.93.0",
     "webpack-cli": "^5.1.4",

package/types/bimplus-websdk.d.ts

@@ -0,0 +1,270 @@
+declare module 'bimplus-websdk' {
+
+    export type Guid = string;
+    export type ProjectId = Guid;
+    export type ModelId = Guid;
+    export type LayerId = Guid;
+    export type DivisionTopologyId = Guid;
+    export type RevisionId = string;
+    export type VisualObjectId = string;
+
+    export type TeamSlug = string;
+    export type AccessToken = string;
+    export type AccessTokenType = string;
+
+    export function createDefaultConfig(env?: string): ApiConfig;
+
+    export interface ApiConfig {
+        protocol: string;
+        host: string;
+        version?: string;
+        cache?: boolean;
+    }
+
+    export interface AuthorizeData {
+        access_token: string;
+    }
+    export class Authorize {
+        constructor(api: Api);
+
+        // Define methods and properties of the Teams class here
+
+        post(username: string, password: string, applicationId: string): Promise<AuthorizeData>;
+    }
+
+    export interface TeamData {
+        slug: string;
+        id: string;
+        name: string;
+    }
+
+    export interface Subscription {
+        settingName?: string;
+        expirationDate?: string;
+        id?: string;
+        teamId?: string;
+        value?: string;
+        status?: string;
+    }
+
+    export class Teams {
+        constructor(api: Api);
+
+        slug: string;
+
+        // Define methods and properties of the Teams class here
+
+        get(teamId?: string, filterEmpty?: boolean): Promise<TeamData[]>;
+        getAccountSettings(teamId?: string): Promise<Array<Subscription>>;
+    }
+
+    export interface UserData {
+        id: string;
+        name: string;
+        preferedLanguage: string;
+    }
+    export class User {
+        constructor(api: Api);
+
+        // Define methods and properties of the Teams class here
+
+        get(token: AccessToken | null): Promise<UserData>;
+        put(userdata): Promise<UserData>;
+        getSubscriptions(): Promise<Array<Subscription>>;
+    }
+
+    type AdditionalParams = {
+        [key: string]: string; // This allows key-value pairs as in json string
+    };
+
+    export interface Project {
+        id: ProjectId;
+        name: string;
+        teamSlug: TeamSlug;
+        teamName: string | undefined;
+        rights: object;
+    }
+
+    export class Projects {
+        constructor(api: Api);
+        get(id?: ProjectId, noDisciplines?: boolean, teamSlug?: TeamSlug, alsoRecycleBin?: boolean, additionalParams?: AdditionalParams): Promise<Project | Project[]>;
+    }
+
+    export interface ConnexisData {
+        projectId: ProjectId,
+        modelId: ModelId,
+        elements: Guid[];
+        settings: {
+            connectionMethod: string;
+            createRevision?: boolean;
+            designCode: string;
+            replace: string;
+        };
+    }
+
+    export interface Sds2ConnexisData {
+        SDS2: ConnexisData;
+    }
+    // export interface IdeaStaticaConnexisData {
+    //     IdeaStatica: ConnexisData;
+    // }
+
+    export class Connexis {
+        constructor(api: Api);
+        post(data: Sds2ConnexisData /* | IdeaStaticaConnexisData */);
+    }
+
+    export interface ObjectFilter {
+        id?: string
+        module: string
+        category: string
+        disciplineID: string
+        name: string
+        filterString: string
+        isDefault: boolean
+        disableSortByModels: boolean
+        readableValues?: Record<string, string>
+    }
+
+    export type ObjectFiltersResponse = Array<ObjectFilter>;
+
+    export class ObjectFilters {
+        constructor(api: Api);
+        get(layerId: Guid | undefined, projectId: Guid | undefined): Promise<ObjectFiltersResponse>
+        getSelectionFilteredObjects(selectionId: Guid, filterId: Guid, properties: boolean | undefined, topology: boolean | undefined): Promise<ObjectFilterStructureResponse>
+        post(data: string, projectId: string): Promise<ObjectFilter>;
+        delete(id: string);
+    }
+
+    export interface ObjectsTopologyNode { }
+
+    export interface ObjectTopologyResponse {
+        id: string;
+        children?: ObjectsTopologyNode[];
+        ifcType?: string;
+        ifcId?: string;
+        elementTypeId?: string;
+        isChild?: boolean;
+        parent: string;
+        name: string;
+        type: string;
+        layerid?: string;
+        number: number;
+        level: number;
+    }
+
+    export type ObjectComplexPropertyTopologyResponse = ObjectTopologyResponse;
+
+    export class Objects {
+        constructor(api: Api);
+        get(objectId: string, revision: number | undefined, properties: string | undefined, projectId: string | undefined, shortInfo: boolean | undefined, type: string | undefined);
+        getTopology(objectId: string, revision: number | undefined, hideElements: boolean, shortInfo: boolean, batch: string | undefined): Promise<ObjectTopologyResponse>;
+        getComplexPropertiesTopology(objectId: string, revision: number | undefined): Promise<ObjectComplexPropertyTopologyResponse>;
+    }
+
+    export interface SelectionObjectTopologyNode {
+        id: string;
+        visible: boolean;
+        opaque: boolean;
+        opacity: number;
+    }
+
+    export interface SelectionObjectLayer {
+        revision: number;
+        id: string;
+        name?: string;
+        divisionId: string;
+        divisionName?: string;
+        visible?: boolean;
+        opaque?: boolean;
+        opacity?: number;
+        valid?: boolean;
+    }
+
+    export interface SelectionObjectTopology {
+        topology: SelectionObjectTopologyNode[];
+        layers: SelectionObjectLayer[];
+    }
+
+    export interface SelectionObjectTopologyStructure {
+        layers: SelectionObjectLayer[];
+        structures: string[];
+    }
+
+    export interface SelectionObject {
+        id?: string;
+        projectid: string;
+        divisionid?: string;
+        singleuse: boolean;
+        revisionnr?: string;
+        type: string;
+        elements?: string[];
+        revisionelements?: string[];
+        filter?: string;
+        topology?: SelectionObjectTopology;
+        topologyStructure?: SelectionObjectTopologyStructure
+    }
+
+    export interface ExportObject {
+        description: string;
+        id?: string;
+        name: string;
+        projectId: string;
+        singleUse: boolean;
+        selection: SelectionObject
+    }
+
+    export class ExportService {
+        constructor(api: Api);
+        createExportSelection(projectId: Guid, data: string): Promise<ExportObject>;
+    }
+
+    export interface StructureNode {
+        id: string;
+        parent?: string;
+        name: string;
+        type: string;
+        children?: StructureNode[];
+        lastTopologyId?: string;
+        count: number;
+        level: number;
+        nodeInfo: string;
+        hasGeometry?: boolean;
+    }
+
+    export interface ObjectFilterStructureResponse {
+        structure: StructureNode;
+        structureDepth: number;
+    }
+
+    export interface IDBCache { 
+        clear() : void;
+    }
+
+    export class Api {
+        constructor(config: ApiConfig);
+
+        // Define methods and properties of the Teams class here
+
+        authorize: Authorize;
+        teams: Teams;
+        user: User;
+        projects: Projects;
+        connexis: Connexis;
+        objectFilters: ObjectFilters;
+        objects: Objects;
+        exportService: ExportService;
+
+        setAccessToken(token: AccessToken): void;
+        getAccessToken(): AccessToken | null;
+
+        setTokenType(tokenType: AccessTokenType): void;
+        getTokenType(): AccessTokenType | null;
+
+        setAccessTokenAndType(token: AccessToken, tokenType: AccessTokenType): void;
+        getAccessTokenAndType(): { token: AccessToken | null, tokenType: AccessTokenType | null };
+
+        setTeamSlug(slug: TeamSlug): void;
+        getCache(): IDBCache;
+    }
+}