@cyclomedia/streetsmart-api 23.12.3

package/README.md

@@ -0,0 +1,30 @@
+# Streetsmart API
+
+This Streetsmart api package provides programmatic access to most of the UI components of the Streetsmart Web application [here](https://streetsmart.cyclomedia.com).
+
+---
+
+### Setup
+
+First install the package using npm or yarn.
+
+`npm i @cyclomedia/streetsmart-api`
+
+Then import the package like
+
+`import StreetSmartApi from "@cyclomedia/streetsmart-api";`
+
+Please note that the package only exposes one default export and no named exports.
+
+Hence `import { init } from "@cyclomedia/streetsmart-api"` should not be attempted. 
+
+### Init
+
+The viewer can be initialized by calling. Please see the Typescript docs for more info.
+
+`StreetSmartApi.init({options})`
+
+### Destroy
+
+The viewer can be destroyed by calling
+`StreetSmartApi.destroy(options)`

package/index.d.ts

@@ -0,0 +1,80 @@
+declare module '@cyclomedia/streetsmart-api' {
+    export interface ApiOptions {
+        targetElement: HTMLElement | null;
+        username?: string;
+        password?: string;
+        loginOauth?: boolean;
+        clientId?: string;
+        loginRedirectUri?: string;
+        logoutRedirectUri?: string;
+        tid?: string;
+        apiKey: string;
+        srs: string;
+        locale?: string;
+        overlayDrawDistance?: number;
+        configurationUrl?: string;
+        staticBaseUrl?: string;
+        addressSettings?: {
+            locale: string;
+            database: string;
+        };
+    }
+
+    type OpenViewerQuery =
+        | string
+        | number[]
+        | {
+              coordinates: number[];
+              dateRange?: {
+                  from: string;
+                  to: string;
+              };
+          };
+
+    interface OpenViewerOptions {
+        viewerType: [string] | string;
+        srs: string;
+        panoramaViewer?: any;
+        obliqueViewer?: any;
+        pointcloudViewer?: any;
+        meshviewer?: any;
+    }
+
+    export function init(options: ApiOptions): Promise<any>;
+
+    export function open(query: OpenViewerQuery, options: OpenViewerOptions): Promise<any>;
+
+    export function destroy(options: Pick<ApiOptions, 'targetElement' | 'loginOauth'>): void;
+
+    export function destroy(options: { targetElement: Element; loginOauth: boolean }): Promise<void>;
+
+    export function getApplicationName(): string;
+
+    export function getApplicationVersion(): string;
+
+    export function getPermissions(): string[];
+
+    export function getAddressSettings(): { locale: string; database: string };
+
+    export function setAddressSettings(addressSettings: { locale: string; database: string }): void;
+
+    export function getDebugLogs(): string[];
+
+    export function on(type: string, callback: (event: Event) => void): void;
+
+    export function off(type: string, callback: (event: Event) => void): void;
+
+    export function viewerAdded(viewer: any): void;
+
+    export function viewerRemoved(wid: any): void;
+
+    export function viewerUpdated(wid: any, oldViewer: any): void;
+
+    export function measurementSaved(measurement: any, wid: any): void;
+
+    export function measurementChanged(measurement: any, wid: any): void;
+
+    export function measurementStarted(measurement: any, wid: any): void;
+
+    export function measurementStopped(measurement: any, wid: any): void;
+}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@cyclomedia/streetsmart-api",
+  "version": "23.12.3",
+  "description": "The Streetsmart API wrapped as a npm package",
+  "scripts": {
+    "build": "scripts/build.sh",
+    "rollup": "rollup -c",
+    "docs": "npx typedoc --out docs src --theme minimal",
+    "test": "jest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cyclomedia/streetsmart.git"
+  },
+  "author": "Cyclomedia Technology B.V.",
+  "license": "UNLICENSED",
+  "bugs": {
+    "url": "https://github.com/cyclomedia/streetsmart/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://github.com/cyclomedia/streetsmart#readme",
+  "peerDependencies": {
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^25.0.7",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-replace": "^5.0.5",
+    "@rollup/plugin-typescript": "^11.1.5",
+    "@rollup/rollup-darwin-arm64": "^4.1.4",
+    "@types/jest": "^29.5.7",
+    "jest": "^29.7.0",
+    "rollup": "^4.1.4",
+    "rollup-plugin-dts": "^6.1.0",
+    "ts-jest": "^29.1.1",
+    "typedoc": "^0.25.2",
+    "typescript": "^5.2.2"
+  },
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "files": [
+    "dist",
+    "index.d.ts"
+  ],
+  "types": "index.d.ts"
+}