bruce-models 5.0.5 → 5.0.6

package/dist/lib/bruce-models.js

@@ -103,5 +103,5 @@ __exportStar(require("./plugin/plugin"), exports);
 __exportStar(require("./environment"), exports);
 __exportStar(require("./data-source/data-source"), exports);
 // This is updated with the package.json version on build.
-exports.VERSION = "5.0.5";
+exports.VERSION = "5.0.6";
 //# sourceMappingURL=bruce-models.js.map

package/dist/types/bruce-models.d.ts

@@ -85,4 +85,4 @@ export * from "./internal/uploader";
 export * from "./plugin/plugin";
 export * from "./environment";
 export * from "./data-source/data-source";
-export declare const VERSION = "5.0.5";
+export declare const VERSION = "5.0.6";

package/dist/types/project/project-view-bookmark.d.ts

@@ -14,11 +14,11 @@ import { ProjectViewTile } from "./project-view-tile";
  * A bookmark is a snapshot of what should be displayed and how in a particular project view.
  */
 export declare namespace ProjectViewBookmark {
-    const DEFAULT_DATA_VERSION = 2;
+    export const DEFAULT_DATA_VERSION = 2;
     /**
      * Describes a bookmark record.
      */
-    interface IBookmark {
+    export interface IBookmark {
         ID?: string;
         Title?: string;
         Note?: string;
@@ -33,14 +33,34 @@ export declare namespace ProjectViewBookmark {
         Camera?: Web3d.ICamera | Web2d.ICamera;
         sections?: Section.ISection[];
     }
-    type Settings = ISettings | IWeb3dSettings | IWeb2dSettings;
-    interface ISettings {
+    /**
+     * Describes a bookmark file node.
+     */
+    enum EBookmarkType {
+        BOOKMARK = "bookmark",
+        FOLDER = "folder"
+    }
+    /**
+     * Describes a bookmark file node.
+     */
+    export interface IBookmarkNode {
+        id: number;
+        parent: number;
+        droppable?: boolean;
+        text: string;
+        data?: {
+            bookmarkData?: IBookmark;
+            type?: EBookmarkType;
+        };
+    }
+    export type Settings = ISettings | IWeb3dSettings | IWeb2dSettings;
+    export interface ISettings {
     }
     /**
      * Describes the content of a bookmark.
      * As part of a deal we've been commissioned to create an alternative bookmark type to embed content.
      */
-    enum EContentType {
+    export enum EContentType {
         WEB_3D = "WEB_3D",
         IFRAME = "IFRAME"
     }
@@ -48,7 +68,7 @@ export declare namespace ProjectViewBookmark {
      * These are the base settings expected in any 3D bookmark.
      * The only exception is data-version = 1 which is our deprecated legacy format.
      */
-    interface IWeb3dSettings extends ISettings {
+    export interface IWeb3dSettings extends ISettings {
         contentType?: EContentType;
         iframeUrl?: string;
         menuItemIds?: string[];
@@ -83,7 +103,7 @@ export declare namespace ProjectViewBookmark {
      * This is our WIP graph viewer.
      * @warning as this project is in beta, all updates are subject to breaking changes.
      */
-    interface IWeb2dSettings extends ISettings {
+    export interface IWeb2dSettings extends ISettings {
         background?: Web2d.IBackground;
         camera?: Web2d.ICamera;
         selectedIds?: string[];
@@ -96,7 +116,7 @@ export declare namespace ProjectViewBookmark {
      * @param params
      * @returns
      */
-    function Get(params: {
+    export function Get(params: {
         api?: BruceApi.Api;
         viewId: string;
         bookmarkId: string;
@@ -108,7 +128,7 @@ export declare namespace ProjectViewBookmark {
      * Deletes a bookmark record.
      * @param params
      */
-    function Delete(params: {
+    export function Delete(params: {
         api?: BruceApi.Api;
         viewId: string;
         bookmarkId: string;
@@ -119,7 +139,7 @@ export declare namespace ProjectViewBookmark {
      * @param params
      * @returns
      */
-    function GetList(params: {
+    export function GetList(params: {
         api?: BruceApi.Api;
         viewId: string;
         req?: Api.IReqParams;
@@ -131,7 +151,7 @@ export declare namespace ProjectViewBookmark {
      * @param params
      * @returns
      */
-    function Update(params: {
+    export function Update(params: {
         api?: BruceApi.Api;
         viewId: string;
         bookmark: IBookmark;
@@ -143,7 +163,7 @@ export declare namespace ProjectViewBookmark {
      * Sets the order of bookmarks within a project view.
      * @param params
      */
-    function SetOrder(params: {
+    export function SetOrder(params: {
         api?: BruceApi.Api;
         viewId: string;
         bookmarkIds: string[];
@@ -152,7 +172,7 @@ export declare namespace ProjectViewBookmark {
     /**
      * Interfaces for 3D bookmark settings.
      */
-    namespace Web3d {
+    export namespace Web3d {
         /**
          * Describes the terrain contours overlay.
          */
@@ -221,7 +241,7 @@ export declare namespace ProjectViewBookmark {
      * Interfaces for 2D bookmark settings.
      * @warning as this project is in beta, all updates are subject to breaking changes.
      */
-    namespace Web2d {
+    export namespace Web2d {
         interface ICamera {
             x: number;
             y: number;
@@ -270,7 +290,7 @@ export declare namespace ProjectViewBookmark {
      * @param bookmarkId
      * @returns
      */
-    function GetCacheKey(viewId: string, bookmarkId: string): string;
+    export function GetCacheKey(viewId: string, bookmarkId: string): string;
     /**
      * Returns cache identifier for a list of bookmarks.
      * Example: {
@@ -281,5 +301,6 @@ export declare namespace ProjectViewBookmark {
      * @param viewId
      * @returns
      */
-    function GetListCacheKey(viewId: string): string;
+    export function GetListCacheKey(viewId: string): string;
+    export {};
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "bruce-models",
-    "version": "5.0.5",
+    "version": "5.0.6",
     "description": "",
     "keywords": [],
     "main": "dist/bruce-models.umd.js",