{"id":20239731,"url":"https://github.com/opensourcebim/bimserver-javascript-api","last_synced_at":"2025-08-20T18:34:37.519Z","repository":{"id":3337368,"uuid":"49126254","full_name":"opensourceBIM/BIMserver-JavaScript-API","owner":"opensourceBIM","description":"BIMserver JavaScript API","archived":false,"fork":false,"pushed_at":"2024-03-25T18:29:43.000Z","size":1081,"stargazers_count":55,"open_issues_count":21,"forks_count":35,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-04-14T12:16:23.806Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/opensourceBIM.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"license.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-01-06T09:33:55.000Z","updated_at":"2024-06-20T19:08:58.226Z","dependencies_parsed_at":"2024-06-20T19:08:50.629Z","dependency_job_id":"261a37ce-e3ba-4fb7-b477-65a68f52bcc9","html_url":"https://github.com/opensourceBIM/BIMserver-JavaScript-API","commit_stats":null,"previous_names":[],"tags_count":123,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensourceBIM%2FBIMserver-JavaScript-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensourceBIM%2FBIMserver-JavaScript-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensourceBIM%2FBIMserver-JavaScript-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opensourceBIM%2FBIMserver-JavaScript-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/opensourceBIM","download_url":"https://codeload.github.com/opensourceBIM/BIMserver-JavaScript-API/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230445927,"owners_count":18227060,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-14T08:41:08.065Z","updated_at":"2024-12-19T14:08:39.404Z","avatar_url":"https://github.com/opensourceBIM.png","language":"JavaScript","readme":"# BIMserver-JavaScript-API\n\nA JavaScript API for the OpenSource BIMserver.\n\n## Usage\n### Static import\nDownload the [combined minified library](https://raw.githubusercontent.com/opensourceBIM/BIMserver-JavaScript-API/master/build/bimserverapi.js) and include it in your HTML.\n\n```html\n\u003cscript type=\"module\" src=\"bimserverapi.js?_v=%VERSION%\"\u003e\u003c/script\u003e\n```\n\nThe ``?_v=%VERSION%`` addition is there for efficient caching purposes. Any server system serving these files can tell the client to cache these files indefinitely.\n\n### Import as an ES6 module\nIf you are using a transpiler such as [Typescript](https://www.typescriptlang.org/) or [Babel](http://babeljs.io/), or a bundler such as [Webpack](https://webpack.js.org/) or [Rollup](https://rollupjs.org/), you can import the module using the [Import](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import) syntax.\n\nIt is also possible to load the ES6 module directly into the browser, however not all browser support this yet.\n\n```javascript\nimport { BimServerClient } from './js/bimserverclient.js';\nconst api = new BimServerClient(\"../..\");\napi.init((client, version) =\u003e {\n\tconsole.log(version.version);\n});\n```\n\n### Dynamic import\nWhen the location on the API is not known in advance, you can use dynamic loading, in most browsers you'll need to use a \"dev\" version for this to work (Chrome 64 for example).\n\n```javascript\nvar address = \"http://addressofapi\";\nPromise.all([\n\taddress + \"/bimserverclient.js\",\n\taddress + \"/bimserverapipromise.js\"\n].map(x =\u003e import(x)))\n.then(([BimServerClient, BimServerApiPromise]) =\u003e {\n\tvar api = new BimServerClient.BimServerClient(\"../..\");\n\tapi.init((client, version) =\u003e {\n\t\tdocument.getElementById(\"version\").innerHTML = JSON.stringify(version.version, 0, 2);\n\t});\n});\n```\n\n### Version returned from BIMserver instance\nTo do.\n\n## API documentation\nTo do.\n\n## Build the library\n* Install [Node.js](https://nodejs.org/)\n* Clone (or download and unzip) the project to your file system:\n```\ngit clone https://github.com/opensourceBIM/BIMserver-JavaScript-API.git\n```\n* Go to the project directory\n```\ncd BIMserver-JavaScript-API\n```\n* Install build dependencies\n```\nnpm install\n```\n* Run the build script\n```\nnpm run build\n```\nThe compiled file is located at ``build/bimserverapi.js``\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopensourcebim%2Fbimserver-javascript-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopensourcebim%2Fbimserver-javascript-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopensourcebim%2Fbimserver-javascript-api/lists"}