@vitessce/plugins 3.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.js

@@ -0,0 +1,59 @@
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class PluginViewType {
+  constructor(name, component, coordinationTypes) {
+    __publicField(this, "name");
+    __publicField(this, "component");
+    __publicField(this, "coordinationTypes");
+    this.name = name;
+    this.component = component;
+    this.coordinationTypes = coordinationTypes;
+  }
+}
+class PluginFileType {
+  constructor(name, dataType, dataLoaderClass, dataSourceClass, optionsSchema) {
+    __publicField(this, "name");
+    __publicField(this, "dataType");
+    __publicField(this, "dataLoaderClass");
+    __publicField(this, "dataSourceClass");
+    __publicField(this, "optionsSchema");
+    this.name = name;
+    this.dataType = dataType;
+    this.dataLoaderClass = dataLoaderClass;
+    this.dataSourceClass = dataSourceClass;
+    this.optionsSchema = optionsSchema;
+  }
+  getSourceAndLoader() {
+    return [this.dataSourceClass, this.dataLoaderClass];
+  }
+}
+class PluginJointFileType {
+  constructor(name, expandFunction, optionsSchema) {
+    __publicField(this, "name");
+    __publicField(this, "expandFunction");
+    __publicField(this, "optionsSchema");
+    this.name = name;
+    this.expandFunction = expandFunction;
+    this.optionsSchema = optionsSchema;
+  }
+}
+class PluginCoordinationType {
+  constructor(name, defaultValue, valueSchema) {
+    __publicField(this, "name");
+    __publicField(this, "defaultValue");
+    __publicField(this, "valueSchema");
+    this.name = name;
+    this.defaultValue = defaultValue;
+    this.valueSchema = valueSchema;
+  }
+}
+export {
+  PluginCoordinationType,
+  PluginFileType,
+  PluginJointFileType,
+  PluginViewType
+};

package/dist-tsc/index.d.ts

@@ -0,0 +1,37 @@
+import type { ComponentType } from 'react';
+import { z } from 'zod';
+export declare class PluginViewType {
+    name: string;
+    component: ComponentType;
+    coordinationTypes: string[];
+    constructor(name: string, component: ComponentType, coordinationTypes: string[]);
+}
+export interface DataLoader {
+    load: () => Promise<any>;
+}
+export interface DataSource {
+}
+export declare class PluginFileType<T1 extends DataLoader, T2 extends DataSource, T3 extends z.ZodTypeAny> {
+    name: string;
+    dataType: string;
+    dataLoaderClass: DataLoader;
+    dataSourceClass: DataSource;
+    optionsSchema: T3;
+    constructor(name: string, dataType: string, dataLoaderClass: T1, dataSourceClass: T2, optionsSchema: T3);
+    getSourceAndLoader(): [DataSource, DataLoader];
+}
+declare type ExpandFunction = (a: any) => Array<any>;
+export declare class PluginJointFileType<T1 extends z.ZodTypeAny> {
+    name: string;
+    expandFunction: ExpandFunction;
+    optionsSchema: T1;
+    constructor(name: string, expandFunction: ExpandFunction, optionsSchema: T1);
+}
+export declare class PluginCoordinationType<T1 extends z.ZodTypeAny> {
+    name: string;
+    defaultValue: z.infer<T1>;
+    valueSchema: T1;
+    constructor(name: string, defaultValue: z.infer<T1>, valueSchema: T1);
+}
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist-tsc/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAC3C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,qBAAa,cAAc;IACzB,IAAI,EAAE,MAAM,CAAC;IAEb,SAAS,EAAE,aAAa,CAAC;IAEzB,iBAAiB,EAAE,MAAM,EAAE,CAAC;gBAEhB,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,EAAE;CAKhF;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC;CAC1B;AAGD,MAAM,WAAW,UAAU;CAE1B;AAED,qBAAa,cAAc,CACzB,EAAE,SAAS,UAAU,EAAE,EAAE,SAAS,UAAU,EAAE,EAAE,SAAS,CAAC,CAAC,UAAU;IAErE,IAAI,EAAE,MAAM,CAAC;IAEb,QAAQ,EAAE,MAAM,CAAC;IAEjB,eAAe,EAAE,UAAU,CAAC;IAE5B,eAAe,EAAE,UAAU,CAAC;IAE5B,aAAa,EAAE,EAAE,CAAC;gBAGhB,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,aAAa,EAAE,EAAE;IAS7F,kBAAkB,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC;CAG/C;AAKD,aAAK,cAAc,GAAG,CAAC,CAAC,EAAE,GAAG,KAAK,KAAK,CAAC,GAAG,CAAC,CAAC;AAE7C,qBAAa,mBAAmB,CAAC,EAAE,SAAS,CAAC,CAAC,UAAU;IACtD,IAAI,EAAE,MAAM,CAAC;IAEb,cAAc,EAAE,cAAc,CAAC;IAE/B,aAAa,EAAE,EAAE,CAAC;gBAEN,IAAI,EAAE,MAAM,EAAE,cAAc,EAAE,cAAc,EAAE,aAAa,EAAE,EAAE;CAK5E;AAED,qBAAa,sBAAsB,CAAC,EAAE,SAAS,CAAC,CAAC,UAAU;IACzD,IAAI,EAAE,MAAM,CAAC;IAEb,YAAY,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAE1B,WAAW,EAAE,EAAE,CAAC;gBAEJ,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,WAAW,EAAE,EAAE;CAKrE"}

package/dist-tsc/index.js

@@ -0,0 +1,47 @@
+export class PluginViewType {
+    name;
+    component;
+    coordinationTypes;
+    constructor(name, component, coordinationTypes) {
+        this.name = name;
+        this.component = component;
+        this.coordinationTypes = coordinationTypes;
+    }
+}
+export class PluginFileType {
+    name;
+    dataType;
+    dataLoaderClass;
+    dataSourceClass;
+    optionsSchema;
+    constructor(name, dataType, dataLoaderClass, dataSourceClass, optionsSchema) {
+        this.name = name;
+        this.dataType = dataType;
+        this.dataLoaderClass = dataLoaderClass;
+        this.dataSourceClass = dataSourceClass;
+        this.optionsSchema = optionsSchema;
+    }
+    getSourceAndLoader() {
+        return [this.dataSourceClass, this.dataLoaderClass];
+    }
+}
+export class PluginJointFileType {
+    name;
+    expandFunction;
+    optionsSchema;
+    constructor(name, expandFunction, optionsSchema) {
+        this.name = name;
+        this.expandFunction = expandFunction;
+        this.optionsSchema = optionsSchema;
+    }
+}
+export class PluginCoordinationType {
+    name;
+    defaultValue;
+    valueSchema;
+    constructor(name, defaultValue, valueSchema) {
+        this.name = name;
+        this.defaultValue = defaultValue;
+        this.valueSchema = valueSchema;
+    }
+}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@vitessce/plugins",
+  "version": "3.0.0",
+  "author": "Gehlenborg Lab",
+  "homepage": "http://vitessce.io",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vitessce/vitessce.git"
+  },
+  "license": "MIT",
+  "type": "module",
+  "main": "dist/index.js",
+  "files": [
+    "src",
+    "dist",
+    "dist-tsc"
+  ],
+  "dependencies": {
+    "zod": "^3.21.4"
+  },
+  "devDependencies": {
+    "@types/react": "^18.0.28",
+    "vite": "^4.3.0",
+    "vitest": "^0.23.4"
+  },
+  "scripts": {
+    "bundle": "pnpm exec vite build -c ../../scripts/vite.config.js",
+    "test": "pnpm exec vitest --run -r ../../ --dir ."
+  },
+  "module": "dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist-tsc/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1,87 @@
+import type { ComponentType } from 'react';
+import { z } from 'zod';
+
+
+export class PluginViewType {
+  name: string;
+
+  component: ComponentType;
+
+  coordinationTypes: string[];
+
+  constructor(name: string, component: ComponentType, coordinationTypes: string[]) {
+    this.name = name;
+    this.component = component;
+    this.coordinationTypes = coordinationTypes;
+  }
+}
+
+export interface DataLoader {
+  load: () => Promise<any>;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface DataSource {
+
+}
+
+export class PluginFileType<
+  T1 extends DataLoader, T2 extends DataSource, T3 extends z.ZodTypeAny,
+> {
+  name: string;
+
+  dataType: string;
+
+  dataLoaderClass: DataLoader;
+
+  dataSourceClass: DataSource;
+
+  optionsSchema: T3;
+
+  constructor(
+    name: string, dataType: string, dataLoaderClass: T1, dataSourceClass: T2, optionsSchema: T3,
+  ) {
+    this.name = name;
+    this.dataType = dataType;
+    this.dataLoaderClass = dataLoaderClass;
+    this.dataSourceClass = dataSourceClass;
+    this.optionsSchema = optionsSchema;
+  }
+
+  getSourceAndLoader(): [DataSource, DataLoader] {
+    return [this.dataSourceClass, this.dataLoaderClass];
+  }
+}
+
+// TODO: cleaning up any type requires refactoring
+// latestFileDefSchema out of @vitessce/schemas to avoid circular dependency
+// eslint-disable-next-line no-unused-vars
+type ExpandFunction = (a: any) => Array<any>;
+
+export class PluginJointFileType<T1 extends z.ZodTypeAny> {
+  name: string;
+
+  expandFunction: ExpandFunction;
+
+  optionsSchema: T1;
+
+  constructor(name: string, expandFunction: ExpandFunction, optionsSchema: T1) {
+    this.name = name;
+    this.expandFunction = expandFunction;
+    this.optionsSchema = optionsSchema;
+  }
+}
+
+export class PluginCoordinationType<T1 extends z.ZodTypeAny> {
+  name: string;
+
+  defaultValue: z.infer<T1>;
+
+  valueSchema: T1;
+
+  constructor(name: string, defaultValue: z.infer<T1>, valueSchema: T1) {
+    this.name = name;
+    this.defaultValue = defaultValue;
+    this.valueSchema = valueSchema;
+  }
+}