@adaptabletools/adaptable 15.0.0-canary.4 → 15.0.0-canary.6

package/src/Api/Internal/TeamSharingInternalApi.d.ts

@@ -1,15 +1,14 @@
 import { ApiBase } from '../Implementation/ApiBase';
-import { SharedEntity } from '../../PredefinedConfig/TeamSharingState';
+import { AdaptableSharedEntity } from '../../PredefinedConfig/TeamSharingState';
 export declare class TeamSharingInternalApi extends ApiBase {
     /**
      * Fires the Team Sharing Entity Changed Event
      * @param sharedEntity Entity that has been changed
      */
-    fireTeamSharingEntityChangedEvent(sharedEntity: SharedEntity): void;
+    fireTeamSharingEntityChangedEvent(sharedEntity: AdaptableSharedEntity): void;
     /**
      * Retrieves shared entry dependencies.
      */
-    getSharedEntryDependencies(sharedEntity: SharedEntity): SharedEntity[];
-    getLocalTeamSharingEntities(): SharedEntity[];
+    getSharedEntryDependencies(sharedEntity: AdaptableSharedEntity): AdaptableSharedEntity[];
     waitForTeamSharingImportEnd(): Promise<boolean>;
 }

package/src/Api/Internal/TeamSharingInternalApi.js

@@ -21,12 +21,9 @@ class TeamSharingInternalApi extends ApiBase_1.ApiBase {
      */
     getSharedEntryDependencies(sharedEntity) {
         var _a;
-        const allEntities = this.getTeamSharingApi().getLoadedSharedEntities();
+        const allEntities = this.getTeamSharingApi().getLoadedAdaptableSharedEntities();
         return ((_a = sharedEntity === null || sharedEntity === void 0 ? void 0 : sharedEntity.EntityDependencyIds) !== null && _a !== void 0 ? _a : []).map((id) => allEntities.find((entity) => entity.Uuid === id));
     }
-    getLocalTeamSharingEntities() {
-        return this.getAdaptableState().TeamSharing.SharedEntities;
-    }
     waitForTeamSharingImportEnd() {
         // we have no deterministic means to ensure the teamsharing import is finished (because the import actions are opaque and may have side-effects)
         // therefore we will listen for state changes and

package/src/Api/StyledColumnApi.d.ts

@@ -91,6 +91,10 @@ export interface StyledColumnApi {
      * @param column Column to check
      */
     getActiveStyledColumnForColumn(column: AdaptableColumn): StyledColumn | undefined;
+    /**
+     * Open Styled Column section of Settings Panel
+     */
+    openStyledColumnSettingsPanel(): void;
     /**
      * TO BE REMOVED
      */

package/src/Api/TeamSharingApi.d.ts

@@ -1,22 +1,22 @@
 import { AdaptableObject } from '../PredefinedConfig/Common/AdaptableObject';
-import { SharedEntity } from '../PredefinedConfig/TeamSharingState';
-import { AdaptableModule, SharedEntityConfig } from '../types';
+import { AdaptableSharedEntity, CustomSharedEntity, CustomSharedEntityConfig, SharedEntity } from '../PredefinedConfig/TeamSharingState';
+import { AdaptableModule, AdaptableSharedEntityConfig } from '../types';
 /**
  * Provides run-time access to Team Sharing Module and associated state
  */
 export interface TeamSharingApi {
     /**
-     * Retrieves all shared entities which are currently shared. It is an asynchronous operation as it leverages the `TeamSharingOptions.getSharedEntities(...)` method.
+     * Retrieves all currently shared entities; async op leveraging `TeamSharingOptions.loadSharedEntities(...)` method
      */
-    getSharedEntities(): Promise<SharedEntity[]>;
+    loadSharedEntities(): Promise<SharedEntity[]>;
     /**
-     * Sets the shared entities which are currently shared. It is an asynchronous operation as it leverages the `TeamSharingOptions.setSharedEntities(...)` method.
+     * Sets currently shared entities; async op leveraging `TeamSharingOptions.persistSharedEntities(...)` method
      * @param sharedEntities the shared entities
      * @return either TRUE if the shared entities were successfully set or FALSE if the shared entities were not set
      */
-    setSharedEntities(sharedEntities: SharedEntity[]): Promise<boolean>;
+    persistSharedEntities(sharedEntities: SharedEntity[]): Promise<boolean>;
     /**
-     * Whether Team Sharing is Available to use
+     * Whether Team Sharing is available to use
      */
     isTeamSharingAvailable(): boolean;
     /**
@@ -33,14 +33,20 @@ export interface TeamSharingApi {
     checkForUpdates(): void;
     /**
      * Puts an Adaptable Object into Team Share
-     * @param entity entity to Share
+     * @param adaptableObject Adaptable Object to Share
      * @param module module which Shared Entity belongs to
      * @param sharedEntityConfig Config info about the Sharing Actions
      */
-    shareEntity(entity: AdaptableObject, module: AdaptableModule, sharedEntityConfig: SharedEntityConfig): void;
+    shareAdaptableEntity(adaptableObject: AdaptableObject, module: AdaptableModule, sharedEntityConfig: AdaptableSharedEntityConfig): void;
+    /**
+     * Puts an custom Object into Team Share
+     * @param customObject custom object to Share
+     * @param sharedEntityConfig shared entity config
+     */
+    shareCustomEntity(customObject: any, sharedEntityConfig: CustomSharedEntityConfig): void;
     /**
-     * Removes an Adaptable Object from the Team Share.
-     * @param entityId the ID of the AdaptableObject to be removed from Team Share
+     * Removes a Shared Entity from the Team Share.
+     * @param entityId the technical ID (`SharedEntity.Uuid`) of the Shared Entity to be removed from Team Share
      */
     unshareEntity(entityId: string): void;
     /**
@@ -50,9 +56,17 @@ export interface TeamSharingApi {
      */
     importSharedEntry(sharedEntity: SharedEntity): void;
     /**
-     * Retrieves already loaded shared entries.
+     * Retrieves all locally loaded shared entries (`AdaptableSharedEntity` & `CustomSharedEntity`).
      */
     getLoadedSharedEntities(): SharedEntity[];
+    /**
+     * Retrieves locally loaded Adaptable Shared Entries.
+     */
+    getLoadedAdaptableSharedEntities(): AdaptableSharedEntity[];
+    /**
+     * Retrieves locally loaded Custom Shared Entries.
+     */
+    getLoadedCustomSharedEntities(): CustomSharedEntity[];
     /**
      * Refreshes the local TeamSharing state by (re)loading the remote state.
      */
@@ -68,4 +82,16 @@ export interface TeamSharingApi {
      * @deprecated use `refreshTeamSharing()` instead
      */
     triggerLoadingTeamSharingEntries(): void;
+    /**
+     * @deprecated use `loadSharedEntities()` instead ()
+     */
+    getSharedEntities(): Promise<SharedEntity[]>;
+    /**
+     * @deprecated use `persistSharedEntities()` instead
+     */
+    setSharedEntities(sharedEntities: SharedEntity[]): Promise<boolean>;
+    /**
+     * @deprecated use `shareAdaptableEntity()` instead
+     */
+    shareEntity(entity: AdaptableObject, module: AdaptableModule, sharedEntityConfig: AdaptableSharedEntityConfig): void;
 }

package/src/PredefinedConfig/Common/AdaptablePredicate.js

@@ -138,6 +138,9 @@ exports.SystemPredicateDefs = [
             if (typeof value === 'string' && !StringExtensions_1.default.IsNumeric(value)) {
                 return false;
             }
+            if (Helper_1.default.objectNotExists(value)) {
+                return false;
+            }
             return Number(value) === 0;
         },
     },

package/src/PredefinedConfig/Common/AggregationColumns.d.ts

@@ -1,6 +1,15 @@
 export declare const WEIGHTED_AVERAGE_AGG_FN_NAME = "weightedAvg";
+/**
+ * Defines a Weighted Average Agg
+ */
 export interface WeightedAverageAggregation {
+    /**
+     * Type is always 'weightedAverage'
+     */
     type: 'weightedAverage';
+    /**
+     * Column which is weighted
+     */
     weightedColumnId: string;
 }
 export declare type AggregationColumns = Record<string, string | true | WeightedAverageAggregation>;

package/src/PredefinedConfig/Common/RowHighlightInfo.d.ts

@@ -1,4 +1,7 @@
 import { AdaptableStyle } from '../../../types';
+/**
+ * Define how to highlight a Row
+ */
 export interface RowHighlightInfo {
     /**
      * Primary key value for the row to be highlighted

package/src/PredefinedConfig/Common/RowsHighlightInfo.d.ts

@@ -1,4 +1,7 @@
 import { AdaptableStyle } from '../../../types';
+/**
+ * Defines how to highlight a set of Rows
+ */
 export interface RowsHighlightInfo {
     /**
      * Primary key valuse for the rows to be highlighted

package/src/PredefinedConfig/ExportState.d.ts

@@ -23,6 +23,9 @@ export interface ExportState extends ConfigState {
      */
     Reports?: Report[];
 }
+/**
+ * A Report which can export data from AdapTable
+ */
 export interface Report extends AdaptableObject {
     /**
      * Name of Report

package/src/PredefinedConfig/FormatColumnState.d.ts

@@ -56,6 +56,9 @@ export interface FormatColumn extends SuspendableObject {
 export declare type FormatColumnRule = XOR<{
     Predicates: FormatColumnPredicate[];
 }, AdaptableBooleanQuery>;
+/**
+ * Predicate used when creating a Format Column
+ */
 export interface FormatColumnPredicate extends AdaptableColumnPredicate {
     PredicateId: TypeHint<string, SystemFormatColumnPredicateId>;
 }

package/src/PredefinedConfig/TeamSharingState.d.ts

@@ -1,5 +1,5 @@
 import { InternalState } from './InternalState';
-import { AdaptableObject } from './Common/AdaptableObject';
+import { AdaptableObject, AdaptableObjectTag } from './Common/AdaptableObject';
 import { AdaptableModule } from '../types';
 import { TypeUuid } from './Uuid';
 import * as Redux from 'redux';
@@ -15,7 +15,7 @@ export interface TeamSharingState extends InternalState {
      * Mapping of active AdaptableObjects which are shared with the local state.
      * Maps UUIDs of local AdaptableObjects to a snapshot of the latest synchronized SharedEntity
      */
-    ActiveSharedEntityMap: Record<TypeUuid, SharedEntity>;
+    ActiveSharedEntityMap: Record<TypeUuid, AdaptableSharedEntity>;
     /**
      * TRUE if an import is in progress, FALSE otherwise.
      * This is required to skip the TEAMSHARING_UPDATE_ITEM action as a result of the import
@@ -25,7 +25,17 @@ export interface TeamSharingState extends InternalState {
 /**
  * Defines an object used in Team Sharing
  */
-export interface SharedEntity extends AdaptableObject {
+export declare type SharedEntity = AdaptableSharedEntity | CustomSharedEntity;
+export declare const isAdaptableSharedEntity: (entity: SharedEntity) => entity is AdaptableSharedEntity;
+export declare const isCustomSharedEntity: (entity: SharedEntity) => entity is CustomSharedEntity;
+/**
+ * Defines an AdaptableObject shared with Team Sharing
+ */
+export interface AdaptableSharedEntity extends AdaptableObject {
+    /**
+     * Type of shared entity (either Adaptable specific or custom object)
+     */
+    EntityType: 'adaptableEntity';
     /**
      * Actual Adaptable Object being shared
      */
@@ -67,6 +77,51 @@ export interface SharedEntity extends AdaptableObject {
      */
     Type: SharedEntityType;
 }
+/**
+ *
+ */
+export interface CustomSharedEntity {
+    /**
+     * Type of shared entity (either Adaptable specific or custom object)
+     */
+    EntityType: 'customEntity';
+    /**
+     * Unique identifier for the Custom Shared Entity
+     */
+    Uuid: TypeUuid;
+    /**
+     * Name of object being shared
+     */
+    Name: string;
+    /**
+     * Description of object being shared
+     */
+    Description: string;
+    /**
+     * Custom Object being shared
+     */
+    Entity: any;
+    /**
+     * When the object was shared
+     */
+    Timestamp: number;
+    /**
+     * User who shared the object
+     */
+    UserName: string;
+    /**
+     * Last User who changed the object
+     */
+    ChangedBy: string;
+    /**
+     * Last time when the object was changed
+     */
+    ChangedAt: number;
+    /**
+     * List of Tags associated with the Object
+     */
+    Tags?: AdaptableObjectTag[];
+}
 /**
  * Defines Objects which have been imported into Team Sharing
  */
@@ -76,19 +131,43 @@ export interface TeamSharingImportInfo<T extends AdaptableObject> {
     EditAction: (entity: T) => any;
 }
 /**
- * Describes an Object which is being Team Shared
+ * Describes an AdaptableObject which is being Team Shared
  */
-export interface SharedEntityConfig {
+export interface AdaptableSharedEntityConfig {
     description: string;
     type: SharedEntityType;
 }
+/**
+ * Describes a custom Object which is being Team Shared
+ */
+export interface CustomSharedEntityConfig {
+    /**
+     * Optional technical ID; if not provided, it will be auto-generated by Adaptable
+     */
+    Uuid?: string;
+    /**
+     * Name of object being shared
+     */
+    Name: string;
+    /**
+     * Description of object being shared
+     */
+    Description: string;
+    /**
+     * List of Tags associated with the Object
+     */
+    Tags?: AdaptableObjectTag[];
+}
+/**
+ * Type of Shared Entity - Snapshot or Active
+ */
 export declare type SharedEntityType = 'Snapshot' | 'Active';
 export interface TeamSharingImportStep {
-    sharedEntity: SharedEntity;
+    sharedEntity: AdaptableSharedEntity;
     importAction: Redux.Action;
 }
 export declare type SharedEntityActiveStatus = Record<TypeUuid, {
-    sharedEntity: SharedEntity;
+    sharedEntity: AdaptableSharedEntity;
     importedRevision: number;
     sharedRevision: number;
 }>;

package/src/PredefinedConfig/TeamSharingState.js

@@ -1,2 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCustomSharedEntity = exports.isAdaptableSharedEntity = void 0;
+const isAdaptableSharedEntity = (entity) => entity.EntityType === 'adaptableEntity';
+exports.isAdaptableSharedEntity = isAdaptableSharedEntity;
+const isCustomSharedEntity = (entity) => entity.EntityType === 'customEntity';
+exports.isCustomSharedEntity = isCustomSharedEntity;

package/src/Redux/ActionsReducers/TeamSharingRedux.d.ts

@@ -1,10 +1,11 @@
-import { TeamSharingState, SharedEntity, SharedEntityConfig, TeamSharingImportStep } from '../../PredefinedConfig/TeamSharingState';
+import { TeamSharingState, SharedEntity, AdaptableSharedEntityConfig, TeamSharingImportStep, AdaptableSharedEntity, CustomSharedEntityConfig } from '../../PredefinedConfig/TeamSharingState';
 import * as Redux from 'redux';
 import { AdaptableObject } from '../../PredefinedConfig/Common/AdaptableObject';
 import { AdaptableModule } from '../../PredefinedConfig/Common/Types';
 export declare const TEAMSHARING_GET = "TEAMSHARING_GET";
 export declare const TEAMSHARING_SET = "TEAMSHARING_SET";
 export declare const TEAMSHARING_SHARE = "TEAMSHARING_SHARE";
+export declare const TEAMSHARING_SHARE_CUSTOM = "TEAMSHARING_SHARE_CUSTOM";
 export declare const TEAMSHARING_IMPORT_ITEM = "TEAMSHARING_IMPORT_ITEM";
 export declare const TEAMSHARING_PROCESS_IMPORT = "TEAMSHARING_PROCESS_IMPORT";
 export declare const TEAMSHARING_COMMIT_IMPORT = "TEAMSHARING_COMMIT_IMPORT";
@@ -15,13 +16,17 @@ export declare const TEAMSHARING_CHECK_FOR_UPDATES = "TEAMSHARING_CHECK_FOR_UPDA
 export interface TeamSharingShareAction extends Redux.Action {
     Entity: AdaptableObject;
     Module: AdaptableModule;
-    Configuration: SharedEntityConfig;
+    Configuration: AdaptableSharedEntityConfig;
+}
+export interface TeamSharingShareCustomAction extends Redux.Action {
+    Entity: any;
+    Configuration: CustomSharedEntityConfig;
 }
 export interface TeamSharingSetAction extends Redux.Action {
     Entities: SharedEntity[];
 }
 export interface TeamSharingImportItemAction extends Redux.Action {
-    SharedEntity: SharedEntity;
+    SharedEntity: AdaptableSharedEntity;
 }
 export interface TeamSharingProcessImportAction extends Redux.Action {
     ImportSteps: TeamSharingImportStep[];
@@ -36,20 +41,21 @@ export interface TeamSharingUpdateItemAction extends Redux.Action {
     UserName: string;
 }
 export interface TeamSharingLinkItemAction extends Redux.Action {
-    SharedEntities: SharedEntity[];
+    SharedEntities: AdaptableSharedEntity[];
 }
 export interface TeamSharingCommitImportAction extends Redux.Action {
 }
 export interface TeamSharingCheckForUpdatesAction extends Redux.Action {
 }
-export declare const TeamSharingShare: (entity: AdaptableObject, module: AdaptableModule, configuration: SharedEntityConfig) => TeamSharingShareAction;
+export declare const TeamSharingShare: (entity: AdaptableObject, module: AdaptableModule, configuration: AdaptableSharedEntityConfig) => TeamSharingShareAction;
+export declare const TeamSharingShareCustom: (entity: AdaptableObject, configuration: CustomSharedEntityConfig) => TeamSharingShareCustomAction;
 export declare const TeamSharingSet: (Entities: SharedEntity[]) => TeamSharingSetAction;
-export declare const TeamSharingImportItem: (SharedEntity: SharedEntity) => TeamSharingImportItemAction;
+export declare const TeamSharingImportItem: (SharedEntity: AdaptableSharedEntity) => TeamSharingImportItemAction;
 export declare const TeamSharingProcessImport: (ImportSteps: TeamSharingImportStep[]) => TeamSharingProcessImportAction;
 export declare const TeamSharingCommitImport: () => TeamSharingCommitImportAction;
 export declare const TeamSharingRemoveItem: (Uuid: string) => TeamSharingRemoveItemAction;
 export declare const TeamSharingGet: () => TeamSharingGetAction;
-export declare const TeamSharingLinkItem: (...SharedEntities: SharedEntity[]) => TeamSharingLinkItemAction;
+export declare const TeamSharingLinkItem: (...SharedEntities: AdaptableSharedEntity[]) => TeamSharingLinkItemAction;
 export declare const TeamSharingUpdateItem: (ChangedAdaptableObject: AdaptableObject, UserName: string) => TeamSharingUpdateItemAction;
 export declare const TeamSharingCheckForUpdates: () => TeamSharingGetAction;
 export declare const TeamSharingReducer: Redux.Reducer<TeamSharingState>;

package/src/Redux/ActionsReducers/TeamSharingRedux.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TeamSharingReducer = exports.TeamSharingCheckForUpdates = exports.TeamSharingUpdateItem = exports.TeamSharingLinkItem = exports.TeamSharingGet = exports.TeamSharingRemoveItem = exports.TeamSharingCommitImport = exports.TeamSharingProcessImport = exports.TeamSharingImportItem = exports.TeamSharingSet = exports.TeamSharingShare = exports.TEAMSHARING_CHECK_FOR_UPDATES = exports.TEAMSHARING_UPDATE_ITEM = exports.TEAMSHARING_LINK_ITEM = exports.TEAMSHARING_REMOVE_ITEM = exports.TEAMSHARING_COMMIT_IMPORT = exports.TEAMSHARING_PROCESS_IMPORT = exports.TEAMSHARING_IMPORT_ITEM = exports.TEAMSHARING_SHARE = exports.TEAMSHARING_SET = exports.TEAMSHARING_GET = void 0;
+exports.TeamSharingReducer = exports.TeamSharingCheckForUpdates = exports.TeamSharingUpdateItem = exports.TeamSharingLinkItem = exports.TeamSharingGet = exports.TeamSharingRemoveItem = exports.TeamSharingCommitImport = exports.TeamSharingProcessImport = exports.TeamSharingImportItem = exports.TeamSharingSet = exports.TeamSharingShareCustom = exports.TeamSharingShare = exports.TEAMSHARING_CHECK_FOR_UPDATES = exports.TEAMSHARING_UPDATE_ITEM = exports.TEAMSHARING_LINK_ITEM = exports.TEAMSHARING_REMOVE_ITEM = exports.TEAMSHARING_COMMIT_IMPORT = exports.TEAMSHARING_PROCESS_IMPORT = exports.TEAMSHARING_IMPORT_ITEM = exports.TEAMSHARING_SHARE_CUSTOM = exports.TEAMSHARING_SHARE = exports.TEAMSHARING_SET = exports.TEAMSHARING_GET = void 0;
 const GeneralConstants_1 = require("../../Utilities/Constants/GeneralConstants");
 exports.TEAMSHARING_GET = 'TEAMSHARING_GET';
 exports.TEAMSHARING_SET = 'TEAMSHARING_SET';
 exports.TEAMSHARING_SHARE = 'TEAMSHARING_SHARE';
+exports.TEAMSHARING_SHARE_CUSTOM = 'TEAMSHARING_SHARE_CUSTOM';
 exports.TEAMSHARING_IMPORT_ITEM = 'TEAMSHARING_IMPORT_ITEM';
 exports.TEAMSHARING_PROCESS_IMPORT = 'TEAMSHARING_PROCESS_IMPORT';
 exports.TEAMSHARING_COMMIT_IMPORT = 'TEAMSHARING_COMMIT_IMPORT';
@@ -19,6 +20,12 @@ const TeamSharingShare = (entity, module, configuration) => ({
     Configuration: configuration,
 });
 exports.TeamSharingShare = TeamSharingShare;
+const TeamSharingShareCustom = (entity, configuration) => ({
+    type: exports.TEAMSHARING_SHARE_CUSTOM,
+    Entity: entity,
+    Configuration: configuration,
+});
+exports.TeamSharingShareCustom = TeamSharingShareCustom;
 const TeamSharingSet = (Entities) => ({
     type: exports.TEAMSHARING_SET,
     Entities,

package/src/Redux/Store/AdaptableStore.js

@@ -46,6 +46,7 @@ const AdaptableAlert_1 = require("../../PredefinedConfig/Common/AdaptableAlert")
 const AdaptableToaster_1 = require("../../View/Components/Popups/AdaptableToaster");
 const SystemRedux_1 = require("../ActionsReducers/SystemRedux");
 const PopupRedux_1 = require("../ActionsReducers/PopupRedux");
+const TeamSharingState_1 = require("../../PredefinedConfig/TeamSharingState");
 exports.INIT_STATE = 'INIT_STATE';
 exports.LOAD_STATE = 'LOAD_STATE';
 const NON_PERSIST_ACTIONS = {
@@ -1187,7 +1188,7 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                 case TeamSharingRedux.TEAMSHARING_GET: {
                     let returnAction = next(action);
                     adaptable.api.teamSharingApi
-                        .getSharedEntities()
+                        .loadSharedEntities()
                         .then((sharedEntities) => {
                         middlewareAPI.dispatch(TeamSharingRedux.TeamSharingSet(sharedEntities));
                     })
@@ -1202,6 +1203,45 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                     });
                     return returnAction;
                 }
+                case TeamSharingRedux.TEAMSHARING_SHARE_CUSTOM: {
+                    const actionTyped = action;
+                    let returnAction = next(action);
+                    const { Entity, Configuration } = actionTyped;
+                    let shareSuccessful;
+                    // load latest state from TeamSharing server
+                    adaptable.api.teamSharingApi
+                        .loadSharedEntities()
+                        .then((sharedEntities) => {
+                        const customSharedEntity = adaptable.api.internalApi
+                            .getTeamSharingService()
+                            .buildCustomSharedEntity(Entity, Configuration);
+                        let newCustomShare = true;
+                        const updatedSharedEntities = sharedEntities.map((entity) => {
+                            // if it has the same UUID, override it
+                            if ((0, TeamSharingState_1.isCustomSharedEntity)(entity) && entity.Uuid === customSharedEntity.Uuid) {
+                                newCustomShare = false;
+                                return Object.assign(Object.assign({}, customSharedEntity), { ChangedAt: Date.now(), ChangedBy: adaptable.api.optionsApi.getUserName() });
+                            }
+                            return entity;
+                        });
+                        if (newCustomShare) {
+                            updatedSharedEntities.push(customSharedEntity);
+                        }
+                        middlewareAPI.dispatch(TeamSharingRedux.TeamSharingSet(updatedSharedEntities));
+                        // update the server state
+                        shareSuccessful = true;
+                        return adaptable.api.teamSharingApi.persistSharedEntities(updatedSharedEntities);
+                    })
+                        .then(() => {
+                        if (shareSuccessful) {
+                            (0, LoggingHelper_1.LogAdaptableInfo)(`Custom Shared Object '${Configuration.Name}' Shared Successfully`);
+                        }
+                    })
+                        .catch((error) => {
+                        (0, LoggingHelper_1.LogAdaptableError)('TeamSharing share error : ' + error.message, actionTyped.Entity);
+                    });
+                    return returnAction;
+                }
                 // share the given AdaptableObject:
                 // - if it has dependencies, share them as well
                 // - if it's active, ensure that there is not already one present
@@ -1213,7 +1253,7 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                     let shareSuccessful;
                     // load latest state from TeamSharing server
                     adaptable.api.teamSharingApi
-                        .getSharedEntities()
+                        .loadSharedEntities()
                         .then((sharedEntities) => {
                         // check if there is not already one active SharedEntity for this object
                         const existingActiveSharedEntity = Configuration.type === 'Active' &&
@@ -1222,7 +1262,7 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                             middlewareAPI.dispatch(PopupRedux.PopupShowAlert({
                                 alertType: 'generic',
                                 header: 'Team Sharing',
-                                message: `Couldn't share ${adaptable.api.internalApi.getModuleFriendlyName(existingActiveSharedEntity.Module)}, there is already an existing active share for it: ${existingActiveSharedEntity.Description}`,
+                                message: `Couldn't share ${adaptable.api.internalApi.getModuleFriendlyName(Module)}, there is already an existing active share for it: ${existingActiveSharedEntity.Description}`,
                                 alertDefinition: ObjectFactory_1.ObjectFactory.CreateInternalAlertDefinitionForMessages('Error'),
                             }));
                             shareSuccessful = false;
@@ -1238,7 +1278,7 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                         middlewareAPI.dispatch(TeamSharingRedux.TeamSharingSet(sharedEntities));
                         // update the server state
                         shareSuccessful = true;
-                        return adaptable.api.teamSharingApi.setSharedEntities(sharedEntities);
+                        return adaptable.api.teamSharingApi.persistSharedEntities(sharedEntities);
                     })
                         .then(() => {
                         if (shareSuccessful) {
@@ -1266,14 +1306,16 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                 case TeamSharingRedux.TEAMSHARING_REMOVE_ITEM: {
                     let returnAction = next(action);
                     const actionTyped = action;
+                    const removedEntityId = actionTyped.Uuid;
                     // load latest state from TeamSharing server
                     adaptable.api.teamSharingApi
-                        .getSharedEntities()
+                        .loadSharedEntities()
                         .then((sharedEntities) => {
                         // ensure that no other SharedDependencies reference the to-be-deleted entity
+                        const adaptableSharedEntities = sharedEntities.filter(TeamSharingState_1.isAdaptableSharedEntity);
                         const sharedEntityDependants = adaptable.api.internalApi
                             .getTeamSharingService()
-                            .getSharedEntityDependants(actionTyped.Uuid, sharedEntities);
+                            .getSharedEntityDependants(removedEntityId, adaptableSharedEntities);
                         if (sharedEntityDependants.length) {
                             middlewareAPI.dispatch(PopupRedux.PopupShowAlert({
                                 alertType: 'generic',
@@ -1286,10 +1328,10 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                             return;
                         }
                         // remove the deleted SharedEntity from local state
-                        const newSharedEntities = sharedEntities.filter((s) => s.Uuid !== actionTyped.Uuid);
+                        const newSharedEntities = sharedEntities.filter((s) => s.Uuid !== removedEntityId);
                         middlewareAPI.dispatch(TeamSharingRedux.TeamSharingSet(newSharedEntities));
                         // update TeamSharing server
-                        return adaptable.api.teamSharingApi.setSharedEntities(newSharedEntities);
+                        return adaptable.api.teamSharingApi.persistSharedEntities(newSharedEntities);
                     })
                         .catch((error) => {
                         (0, LoggingHelper_1.LogAdaptableError)('TeamSharing remove error : ' + error.message);
@@ -1379,22 +1421,23 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                     }
                     const { ChangedAdaptableObject, UserName } = actionTyped;
                     adaptable.api.teamSharingApi
-                        .getSharedEntities()
+                        .loadSharedEntities()
                         .then((sharedEntities) => {
+                        const adaptableSharedEntities = sharedEntities.filter(TeamSharingState_1.isAdaptableSharedEntity);
                         // check if remote server has a newer revision
                         const [localRevision, remoteRevision] = adaptable.api.internalApi
                             .getTeamSharingService()
-                            .getSharedEntityLocalAndRemoteRevisions(ChangedAdaptableObject.Uuid, sharedEntities);
+                            .getSharedEntityLocalAndRemoteRevisions(ChangedAdaptableObject.Uuid, adaptableSharedEntities);
                         if (remoteRevision > localRevision) {
                             // if remote has a newer version, we will NOT overwrite it
                             return;
                         }
                         const [updatedSharedEntities, newActiveEntities] = adaptable.api.internalApi
                             .getTeamSharingService()
-                            .updateActiveSharedEntity(ChangedAdaptableObject, UserName, sharedEntities);
+                            .updateActiveSharedEntity(ChangedAdaptableObject, UserName, adaptableSharedEntities);
                         middlewareAPI.dispatch(TeamSharingRedux.TeamSharingLinkItem(...newActiveEntities));
                         middlewareAPI.dispatch(TeamSharingRedux.TeamSharingSet(updatedSharedEntities));
-                        return adaptable.api.teamSharingApi.setSharedEntities(updatedSharedEntities);
+                        return adaptable.api.teamSharingApi.persistSharedEntities(updatedSharedEntities);
                     })
                         .catch((error) => {
                         (0, LoggingHelper_1.LogAdaptableError)('TeamSharing update active item error : ' + error.message);
@@ -1410,7 +1453,7 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                 case TeamSharingRedux.TEAMSHARING_CHECK_FOR_UPDATES: {
                     const returnAction = next(action);
                     adaptable.api.teamSharingApi
-                        .getSharedEntities()
+                        .loadSharedEntities()
                         .then((sharedEntities) => {
                         // update local state
                         middlewareAPI.dispatch(TeamSharingRedux.TeamSharingSet(sharedEntities));

package/src/Strategy/TeamSharingModule.d.ts

@@ -1,7 +1,7 @@
 import { AdaptableModuleBase } from './AdaptableModuleBase';
 import { AdaptableModuleView, AdaptableObjectView, IModule } from './Interface/IModule';
 import { AdaptableApi } from '../Api/AdaptableApi';
-import { SharedEntity } from '../../types';
+import { AdaptableSharedEntity } from '../PredefinedConfig/TeamSharingState';
 export declare class TeamSharingModule extends AdaptableModuleBase implements IModule {
     private SKIP_TEAMSHARING_UPDATE_ACTIONS;
     constructor(api: AdaptableApi);
@@ -10,12 +10,12 @@ export declare class TeamSharingModule extends AdaptableModuleBase implements IM
     getPopupMaxWidth(): number | undefined;
     private handleStateChanged;
     private extractAdaptableObjectFromAction;
-    isAdaptableObjectPresentInLocalState(sharedEntity: SharedEntity): boolean;
+    isAdaptableObjectPresentInLocalState(sharedEntity: AdaptableSharedEntity): boolean;
     private isSharedEntityADependency;
     private isStaleAndActive;
     private getDependencies;
     private getStaleDependencies;
-    toView(sharedEntity: SharedEntity): AdaptableObjectView;
+    toView(sharedEntity: AdaptableSharedEntity): AdaptableObjectView;
     toViewAll(): AdaptableObjectView[];
     getViewProperties(): AdaptableModuleView;
 }