molstar 4.3.0 → 4.4.1

package/lib/commonjs/mol-plugin-state/objects.d.ts

@@ -36,16 +36,16 @@ export declare namespace PluginStateObject {
     export const Create: <D = {}>(type: TypeInfo) => {
         new (data: D, props?: {
             label: string;
-            description?: string | undefined;
+            description?: string;
         } | undefined): {
             id: import("../mol-util").UUID;
             type: TypeInfo;
             label: string;
-            description?: string | undefined;
+            description?: string;
             data: D;
         };
         type: TypeInfo;
-        is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<D, TypeInfo>;
+        is(obj?: StateObject): obj is StateObject<D, TypeInfo>;
     };
     export function isRepresentation3D(o?: Any): o is StateObject<Representation3DData<Representation.Any>, TypeInfo>;
     export function isBehavior(o?: Any): o is StateObject<PluginBehavior, TypeInfo>;
@@ -58,62 +58,62 @@ export declare namespace PluginStateObject {
     }): {
         new (data: Representation3DData<T, S>, props?: {
             label: string;
-            description?: string | undefined;
+            description?: string;
         } | undefined): {
             id: import("../mol-util").UUID;
             type: TypeInfo;
             label: string;
-            description?: string | undefined;
+            description?: string;
             data: Representation3DData<T, S>;
         };
         type: TypeInfo;
-        is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<Representation3DData<T, S>, TypeInfo>;
+        is(obj?: StateObject): obj is StateObject<Representation3DData<T, S>, TypeInfo>;
     };
     export function CreateBehavior<T extends PluginBehavior>(type: {
         name: string;
     }): {
         new (data: T, props?: {
             label: string;
-            description?: string | undefined;
+            description?: string;
         } | undefined): {
             id: import("../mol-util").UUID;
             type: TypeInfo;
             label: string;
-            description?: string | undefined;
+            description?: string;
             data: T;
         };
         type: TypeInfo;
-        is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<T, TypeInfo>;
+        is(obj?: StateObject): obj is StateObject<T, TypeInfo>;
     };
     const Root_base: {
         new (data: {}, props?: {
             label: string;
-            description?: string | undefined;
+            description?: string;
         } | undefined): {
             id: import("../mol-util").UUID;
             type: TypeInfo;
             label: string;
-            description?: string | undefined;
+            description?: string;
             data: {};
         };
         type: TypeInfo;
-        is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<{}, TypeInfo>;
+        is(obj?: StateObject): obj is StateObject<{}, TypeInfo>;
     };
     export class Root extends Root_base {
     }
     const Group_base: {
         new (data: {}, props?: {
             label: string;
-            description?: string | undefined;
+            description?: string;
         } | undefined): {
             id: import("../mol-util").UUID;
             type: TypeInfo;
             label: string;
-            description?: string | undefined;
+            description?: string;
             data: {};
         };
         type: TypeInfo;
-        is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<{}, TypeInfo>;
+        is(obj?: StateObject): obj is StateObject<{}, TypeInfo>;
     };
     export class Group extends Group_base {
     }
@@ -121,32 +121,32 @@ export declare namespace PluginStateObject {
         const String_base: {
             new (data: string, props?: {
                 label: string;
-                description?: string | undefined;
+                description?: string;
             } | undefined): {
                 id: import("../mol-util").UUID;
                 type: TypeInfo;
                 label: string;
-                description?: string | undefined;
+                description?: string;
                 data: string;
             };
             type: TypeInfo;
-            is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<string, TypeInfo>;
+            is(obj?: StateObject): obj is StateObject<string, TypeInfo>;
         };
         export class String extends String_base {
         }
         const Binary_base: {
             new (data: Uint8Array, props?: {
                 label: string;
-                description?: string | undefined;
+                description?: string;
             } | undefined): {
                 id: import("../mol-util").UUID;
                 type: TypeInfo;
                 label: string;
-                description?: string | undefined;
+                description?: string;
                 data: Uint8Array;
             };
             type: TypeInfo;
-            is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<Uint8Array, TypeInfo>;
+            is(obj?: StateObject): obj is StateObject<Uint8Array, TypeInfo>;
         };
         export class Binary extends Binary_base {
         }
@@ -163,16 +163,16 @@ export declare namespace PluginStateObject {
         const Blob_base: {
             new (data: BlobData, props?: {
                 label: string;
-                description?: string | undefined;
+                description?: string;
             } | undefined): {
                 id: import("../mol-util").UUID;
                 type: TypeInfo;
                 label: string;
-                description?: string | undefined;
+                description?: string;
                 data: BlobData;
             };
             type: TypeInfo;
-            is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<BlobData, TypeInfo>;
+            is(obj?: StateObject): obj is StateObject<BlobData, TypeInfo>;
         };
         export class Blob extends Blob_base {
         }
@@ -182,160 +182,160 @@ export declare namespace PluginStateObject {
         const Json_base: {
             new (data: any, props?: {
                 label: string;
-                description?: string | undefined;
+                description?: string;
             } | undefined): {
                 id: import("../mol-util").UUID;
                 type: TypeInfo;
                 label: string;
-                description?: string | undefined;
+                description?: string;
                 data: any;
             };
             type: TypeInfo;
-            is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<any, TypeInfo>;
+            is(obj?: StateObject): obj is StateObject<any, TypeInfo>;
         };
         export class Json extends Json_base {
         }
         const Cif_base: {
             new (data: CifFile, props?: {
                 label: string;
-                description?: string | undefined;
+                description?: string;
             } | undefined): {
                 id: import("../mol-util").UUID;
                 type: TypeInfo;
                 label: string;
-                description?: string | undefined;
+                description?: string;
                 data: CifFile;
             };
             type: TypeInfo;
-            is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<CifFile, TypeInfo>;
+            is(obj?: StateObject): obj is StateObject<CifFile, TypeInfo>;
         };
         export class Cif extends Cif_base {
         }
         const Cube_base: {
             new (data: CubeFile, props?: {
                 label: string;
-                description?: string | undefined;
+                description?: string;
             } | undefined): {
                 id: import("../mol-util").UUID;
                 type: TypeInfo;
                 label: string;
-                description?: string | undefined;
+                description?: string;
                 data: CubeFile;
             };
             type: TypeInfo;
-            is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<CubeFile, TypeInfo>;
+            is(obj?: StateObject): obj is StateObject<CubeFile, TypeInfo>;
         };
         export class Cube extends Cube_base {
         }
         const Psf_base: {
             new (data: PsfFile, props?: {
                 label: string;
-                description?: string | undefined;
+                description?: string;
             } | undefined): {
                 id: import("../mol-util").UUID;
                 type: TypeInfo;
                 label: string;
-                description?: string | undefined;
+                description?: string;
                 data: PsfFile;
             };
             type: TypeInfo;
-            is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<PsfFile, TypeInfo>;
+            is(obj?: StateObject): obj is StateObject<PsfFile, TypeInfo>;
         };
         export class Psf extends Psf_base {
         }
         const Prmtop_base: {
             new (data: PrmtopFile, props?: {
                 label: string;
-                description?: string | undefined;
+                description?: string;
             } | undefined): {
                 id: import("../mol-util").UUID;
                 type: TypeInfo;
                 label: string;
-                description?: string | undefined;
+                description?: string;
                 data: PrmtopFile;
             };
             type: TypeInfo;
-            is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<PrmtopFile, TypeInfo>;
+            is(obj?: StateObject): obj is StateObject<PrmtopFile, TypeInfo>;
         };
         export class Prmtop extends Prmtop_base {
         }
         const Top_base: {
             new (data: TopFile, props?: {
                 label: string;
-                description?: string | undefined;
+                description?: string;
             } | undefined): {
                 id: import("../mol-util").UUID;
                 type: TypeInfo;
                 label: string;
-                description?: string | undefined;
+                description?: string;
                 data: TopFile;
             };
             type: TypeInfo;
-            is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<TopFile, TypeInfo>;
+            is(obj?: StateObject): obj is StateObject<TopFile, TypeInfo>;
         };
         export class Top extends Top_base {
         }
         const Ply_base: {
             new (data: PlyFile, props?: {
                 label: string;
-                description?: string | undefined;
+                description?: string;
             } | undefined): {
                 id: import("../mol-util").UUID;
                 type: TypeInfo;
                 label: string;
-                description?: string | undefined;
+                description?: string;
                 data: PlyFile;
             };
             type: TypeInfo;
-            is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<PlyFile, TypeInfo>;
+            is(obj?: StateObject): obj is StateObject<PlyFile, TypeInfo>;
         };
         export class Ply extends Ply_base {
         }
         const Ccp4_base: {
             new (data: Ccp4File, props?: {
                 label: string;
-                description?: string | undefined;
+                description?: string;
             } | undefined): {
                 id: import("../mol-util").UUID;
                 type: TypeInfo;
                 label: string;
-                description?: string | undefined;
+                description?: string;
                 data: Ccp4File;
             };
             type: TypeInfo;
-            is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<Ccp4File, TypeInfo>;
+            is(obj?: StateObject): obj is StateObject<Ccp4File, TypeInfo>;
         };
         export class Ccp4 extends Ccp4_base {
         }
         const Dsn6_base: {
             new (data: Dsn6File, props?: {
                 label: string;
-                description?: string | undefined;
+                description?: string;
             } | undefined): {
                 id: import("../mol-util").UUID;
                 type: TypeInfo;
                 label: string;
-                description?: string | undefined;
+                description?: string;
                 data: Dsn6File;
             };
             type: TypeInfo;
-            is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<Dsn6File, TypeInfo>;
+            is(obj?: StateObject): obj is StateObject<Dsn6File, TypeInfo>;
         };
         export class Dsn6 extends Dsn6_base {
         }
         const Dx_base: {
             new (data: DxFile, props?: {
                 label: string;
-                description?: string | undefined;
+                description?: string;
             } | undefined): {
                 id: import("../mol-util").UUID;
                 type: TypeInfo;
                 label: string;
-                description?: string | undefined;
+                description?: string;
                 data: DxFile;
             };
             type: TypeInfo;
-            is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<DxFile, TypeInfo>;
+            is(obj?: StateObject): obj is StateObject<DxFile, TypeInfo>;
         };
         export class Dx extends Dx_base {
         }
@@ -383,16 +383,16 @@ export declare namespace PluginStateObject {
         const Blob_base_1: {
             new (data: BlobData, props?: {
                 label: string;
-                description?: string | undefined;
+                description?: string;
             } | undefined): {
                 id: import("../mol-util").UUID;
                 type: TypeInfo;
                 label: string;
-                description?: string | undefined;
+                description?: string;
                 data: BlobData;
             };
             type: TypeInfo;
-            is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<BlobData, TypeInfo>;
+            is(obj?: StateObject): obj is StateObject<BlobData, TypeInfo>;
         };
         export class Blob extends Blob_base_1 {
         }
@@ -402,80 +402,80 @@ export declare namespace PluginStateObject {
         const Coordinates_base: {
             new (data: _Coordinates, props?: {
                 label: string;
-                description?: string | undefined;
+                description?: string;
             } | undefined): {
                 id: import("../mol-util").UUID;
                 type: TypeInfo;
                 label: string;
-                description?: string | undefined;
+                description?: string;
                 data: _Coordinates;
             };
             type: TypeInfo;
-            is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<_Coordinates, TypeInfo>;
+            is(obj?: StateObject): obj is StateObject<_Coordinates, TypeInfo>;
         };
         export class Coordinates extends Coordinates_base {
         }
         const Topology_base: {
             new (data: _Topology, props?: {
                 label: string;
-                description?: string | undefined;
+                description?: string;
             } | undefined): {
                 id: import("../mol-util").UUID;
                 type: TypeInfo;
                 label: string;
-                description?: string | undefined;
+                description?: string;
                 data: _Topology;
             };
             type: TypeInfo;
-            is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<_Topology, TypeInfo>;
+            is(obj?: StateObject): obj is StateObject<_Topology, TypeInfo>;
         };
         export class Topology extends Topology_base {
         }
         const Model_base: {
             new (data: _Model, props?: {
                 label: string;
-                description?: string | undefined;
+                description?: string;
             } | undefined): {
                 id: import("../mol-util").UUID;
                 type: TypeInfo;
                 label: string;
-                description?: string | undefined;
+                description?: string;
                 data: _Model;
             };
             type: TypeInfo;
-            is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<_Model, TypeInfo>;
+            is(obj?: StateObject): obj is StateObject<_Model, TypeInfo>;
         };
         export class Model extends Model_base {
         }
         const Trajectory_base: {
             new (data: _Trajectory, props?: {
                 label: string;
-                description?: string | undefined;
+                description?: string;
             } | undefined): {
                 id: import("../mol-util").UUID;
                 type: TypeInfo;
                 label: string;
-                description?: string | undefined;
+                description?: string;
                 data: _Trajectory;
             };
             type: TypeInfo;
-            is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<_Trajectory, TypeInfo>;
+            is(obj?: StateObject): obj is StateObject<_Trajectory, TypeInfo>;
         };
         export class Trajectory extends Trajectory_base {
         }
         const Structure_base: {
             new (data: _Structure, props?: {
                 label: string;
-                description?: string | undefined;
+                description?: string;
             } | undefined): {
                 id: import("../mol-util").UUID;
                 type: TypeInfo;
                 label: string;
-                description?: string | undefined;
+                description?: string;
                 data: _Structure;
             };
             type: TypeInfo;
-            is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<_Structure, TypeInfo>;
+            is(obj?: StateObject): obj is StateObject<_Structure, TypeInfo>;
         };
         export class Structure extends Structure_base {
         }
@@ -483,16 +483,16 @@ export declare namespace PluginStateObject {
             const Representation3D_base: {
                 new (data: Representation3DData<StructureRepresentation<any>, _Structure>, props?: {
                     label: string;
-                    description?: string | undefined;
+                    description?: string;
                 } | undefined): {
                     id: import("../mol-util").UUID;
                     type: TypeInfo;
                     label: string;
-                    description?: string | undefined;
+                    description?: string;
                     data: Representation3DData<StructureRepresentation<any>, _Structure>;
                 };
                 type: TypeInfo;
-                is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<Representation3DData<StructureRepresentation<any>, _Structure>, TypeInfo>;
+                is(obj?: StateObject): obj is StateObject<Representation3DData<StructureRepresentation<any>, _Structure>, TypeInfo>;
             };
             export class Representation3D extends Representation3D_base {
             }
@@ -506,16 +506,16 @@ export declare namespace PluginStateObject {
             const Representation3DState_base: {
                 new (data: Representation3DStateData, props?: {
                     label: string;
-                    description?: string | undefined;
+                    description?: string;
                 } | undefined): {
                     id: import("../mol-util").UUID;
                     type: TypeInfo;
                     label: string;
-                    description?: string | undefined;
+                    description?: string;
                     data: Representation3DStateData;
                 };
                 type: TypeInfo;
-                is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<Representation3DStateData, TypeInfo>;
+                is(obj?: StateObject): obj is StateObject<Representation3DStateData, TypeInfo>;
             };
             export class Representation3DState extends Representation3DState_base {
             }
@@ -527,16 +527,16 @@ export declare namespace PluginStateObject {
             const Selections_base: {
                 new (data: readonly SelectionEntry[], props?: {
                     label: string;
-                    description?: string | undefined;
+                    description?: string;
                 } | undefined): {
                     id: import("../mol-util").UUID;
                     type: TypeInfo;
                     label: string;
-                    description?: string | undefined;
+                    description?: string;
                     data: readonly SelectionEntry[];
                 };
                 type: TypeInfo;
-                is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<readonly SelectionEntry[], TypeInfo>;
+                is(obj?: StateObject): obj is StateObject<readonly SelectionEntry[], TypeInfo>;
             };
             export class Selections extends Selections_base {
             }
@@ -561,48 +561,48 @@ export declare namespace PluginStateObject {
         const Data_base: {
             new (data: _Volume, props?: {
                 label: string;
-                description?: string | undefined;
+                description?: string;
             } | undefined): {
                 id: import("../mol-util").UUID;
                 type: TypeInfo;
                 label: string;
-                description?: string | undefined;
+                description?: string;
                 data: _Volume;
             };
             type: TypeInfo;
-            is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<_Volume, TypeInfo>;
+            is(obj?: StateObject): obj is StateObject<_Volume, TypeInfo>;
         };
         export class Data extends Data_base {
         }
         const Lazy_base: {
             new (data: LazyInfo, props?: {
                 label: string;
-                description?: string | undefined;
+                description?: string;
             } | undefined): {
                 id: import("../mol-util").UUID;
                 type: TypeInfo;
                 label: string;
-                description?: string | undefined;
+                description?: string;
                 data: LazyInfo;
             };
             type: TypeInfo;
-            is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<LazyInfo, TypeInfo>;
+            is(obj?: StateObject): obj is StateObject<LazyInfo, TypeInfo>;
         };
         export class Lazy extends Lazy_base {
         }
         const Representation3D_base_1: {
             new (data: Representation3DData<VolumeRepresentation<any>, _Volume>, props?: {
                 label: string;
-                description?: string | undefined;
+                description?: string;
             } | undefined): {
                 id: import("../mol-util").UUID;
                 type: TypeInfo;
                 label: string;
-                description?: string | undefined;
+                description?: string;
                 data: Representation3DData<VolumeRepresentation<any>, _Volume>;
             };
             type: TypeInfo;
-            is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<Representation3DData<VolumeRepresentation<any>, _Volume>, TypeInfo>;
+            is(obj?: StateObject): obj is StateObject<Representation3DData<VolumeRepresentation<any>, _Volume>, TypeInfo>;
         };
         export class Representation3D extends Representation3D_base_1 {
         }
@@ -612,32 +612,32 @@ export declare namespace PluginStateObject {
         const Provider_base: {
             new (data: ShapeProvider<any, any, any>, props?: {
                 label: string;
-                description?: string | undefined;
+                description?: string;
             } | undefined): {
                 id: import("../mol-util").UUID;
                 type: TypeInfo;
                 label: string;
-                description?: string | undefined;
+                description?: string;
                 data: ShapeProvider<any, any, any>;
             };
             type: TypeInfo;
-            is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<ShapeProvider<any, any, any>, TypeInfo>;
+            is(obj?: StateObject): obj is StateObject<ShapeProvider<any, any, any>, TypeInfo>;
         };
         export class Provider extends Provider_base {
         }
         const Representation3D_base_2: {
             new (data: Representation3DData<ShapeRepresentation<any, any, any>, unknown>, props?: {
                 label: string;
-                description?: string | undefined;
+                description?: string;
             } | undefined): {
                 id: import("../mol-util").UUID;
                 type: TypeInfo;
                 label: string;
-                description?: string | undefined;
+                description?: string;
                 data: Representation3DData<ShapeRepresentation<any, any, any>, unknown>;
             };
             type: TypeInfo;
-            is(obj?: StateObject<any, StateObject.Type<any>> | undefined): obj is StateObject<Representation3DData<ShapeRepresentation<any, any, any>, unknown>, TypeInfo>;
+            is(obj?: StateObject): obj is StateObject<Representation3DData<ShapeRepresentation<any, any, any>, unknown>, TypeInfo>;
         };
         export class Representation3D extends Representation3D_base_2 {
         }
@@ -646,6 +646,6 @@ export declare namespace PluginStateObject {
     export {};
 }
 export declare namespace PluginStateTransform {
-    const CreateBuiltIn: <A extends StateObject<any, StateObject.Type<any>>, B extends StateObject<any, StateObject.Type<any>>, P extends {} = {}>(definition: StateTransformer.Definition<A, B, P>) => StateTransformer<A, B, P>;
+    const CreateBuiltIn: <A extends StateObject, B extends StateObject, P extends {} = {}>(definition: StateTransformer.Definition<A, B, P>) => StateTransformer<A, B, P>;
     const BuiltIn: StateTransformer.Builder.Root;
 }

package/lib/commonjs/mol-plugin-state/transforms/data.d.ts

@@ -1,8 +1,9 @@
 /**
- * Copyright (c) 2018-2020 mol* contributors, licensed under MIT, See LICENSE file for more info.
+ * Copyright (c) 2018-2024 mol* contributors, licensed under MIT, See LICENSE file for more info.
  *
  * @author David Sehnal <david.sehnal@gmail.com>
  * @author Alexander Rose <alexander.rose@weirdbyte.de>
+ * @author Neli Fonseca <neli@ebi.ac.uk>
  */
 import { StateTransformer } from '../../mol-state';
 import { ParamDefinition as PD } from '../../mol-util/param-definition';
@@ -10,6 +11,7 @@ import { PluginStateObject as SO } from '../objects';
 import { Asset } from '../../mol-util/assets';
 export { Download };
 export { DownloadBlob };
+export { DeflateData };
 export { RawData };
 export { ReadFile };
 export { ParseBlob };
@@ -42,6 +44,13 @@ declare const DownloadBlob: StateTransformer<SO.Root, SO.Data.Blob, PD.Normalize
     }>[];
     maxConcurrency: number | undefined;
 }>>;
+type DeflateData = typeof DeflateData;
+declare const DeflateData: StateTransformer<SO.Data.Binary, SO.Data.String | SO.Data.Binary, PD.Normalize<{
+    method: string;
+    isString: boolean;
+    stringEncoding: string | undefined;
+    label: string | undefined;
+}>>;
 type RawData = typeof RawData;
 declare const RawData: StateTransformer<SO.Root, SO.Data.String | SO.Data.Binary, PD.Normalize<{
     data: string | ArrayBuffer | Uint8Array | number[];