@apollo-annotation/common 0.1.18 → 0.1.20

package/dist/ApolloPlugin.d.ts

@@ -0,0 +1,9 @@
+import Plugin from '@jbrowse/core/Plugin';
+import PluginManager from '@jbrowse/core/PluginManager';
+export type ApolloPluginConstructor = new (...args: unknown[]) => ApolloPlugin;
+export interface ApolloPluginManager {
+    addToExtensionPoint: PluginManager['addToExtensionPoint'];
+}
+export declare abstract class ApolloPlugin extends Plugin {
+    apolloInstall(_pluginManager: ApolloPluginManager): void;
+}

package/dist/ApolloPlugin.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApolloPlugin = void 0;
+const tslib_1 = require("tslib");
+const Plugin_1 = tslib_1.__importDefault(require("@jbrowse/core/Plugin"));
+class ApolloPlugin extends Plugin_1.default {
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    apolloInstall(_pluginManager) { }
+}
+exports.ApolloPlugin = ApolloPlugin;
+//# sourceMappingURL=ApolloPlugin.js.map

package/dist/ApolloPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApolloPlugin.js","sourceRoot":"","sources":["../src/ApolloPlugin.ts"],"names":[],"mappings":";;;;AAAA,0EAAyC;AASzC,MAAsB,YAAa,SAAQ,gBAAM;IAC/C,gEAAgE;IAChE,aAAa,CAAC,cAAmC,IAAS,CAAC;CAC5D;AAHD,oCAGC"}

package/dist/AssemblySpecificChange.d.ts

@@ -0,0 +1,9 @@
+import { Change, ChangeOptions, SerializedChange } from './Change';
+export interface SerializedAssemblySpecificChange extends SerializedChange {
+    assembly: string;
+}
+export declare function isAssemblySpecificChange(thing: any): thing is AssemblySpecificChange;
+export declare abstract class AssemblySpecificChange extends Change {
+    assembly: string;
+    constructor(json: SerializedAssemblySpecificChange, options?: ChangeOptions);
+}

package/dist/AssemblySpecificChange.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AssemblySpecificChange = void 0;
+exports.isAssemblySpecificChange = isAssemblySpecificChange;
+/* eslint-disable @typescript-eslint/no-unnecessary-condition */
+const Change_1 = require("./Change");
+function isAssemblySpecificChange(
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+thing) {
+    return ((0, Change_1.isChange)(thing) && thing.assembly !== undefined);
+}
+class AssemblySpecificChange extends Change_1.Change {
+    constructor(json, options) {
+        super(json, options);
+        this.assembly = json.assembly;
+    }
+}
+exports.AssemblySpecificChange = AssemblySpecificChange;
+//# sourceMappingURL=AssemblySpecificChange.js.map

package/dist/AssemblySpecificChange.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AssemblySpecificChange.js","sourceRoot":"","sources":["../src/AssemblySpecificChange.ts"],"names":[],"mappings":";;;AAOA,4DAOC;AAdD,gEAAgE;AAChE,qCAA4E;AAM5E,SAAgB,wBAAwB;AACtC,8DAA8D;AAC9D,KAAU;IAEV,OAAO,CACL,IAAA,iBAAQ,EAAC,KAAK,CAAC,IAAK,KAAgC,CAAC,QAAQ,KAAK,SAAS,CAC5E,CAAA;AACH,CAAC;AAED,MAAsB,sBAAuB,SAAQ,eAAM;IAGzD,YAAY,IAAsC,EAAE,OAAuB;QACzE,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QACpB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAA;IAC/B,CAAC;CACF;AAPD,wDAOC"}

package/dist/Change.d.ts

@@ -0,0 +1,33 @@
+import { AnnotationFeature, AnnotationFeatureSnapshot, ApolloAssemblyI, BackendDriverType, CheckResultI, CheckResultSnapshot } from '@apollo-annotation/mst';
+import { AppRootModel, Region } from '@jbrowse/core/util';
+import { BackendDataStore, Operation, OperationOptions, SerializedOperation } from './Operation';
+export interface ClientDataStore {
+    typeName: 'Client';
+    assemblies: Map<string, ApolloAssemblyI>;
+    checkResults: Map<string, CheckResultI>;
+    internetAccounts: AppRootModel['internetAccounts'];
+    getInternetAccount(assemblyName?: string, internetAccountId?: string): AppRootModel['internetAccounts'][0];
+    loadFeatures(regions: Region[]): void;
+    loadRefSeq(regions: Region[]): void;
+    getFeature(featureId: string): AnnotationFeature | undefined;
+    addFeature(assemblyId: string, feature: AnnotationFeatureSnapshot): void;
+    deleteFeature(featureId: string): void;
+    deleteAssembly(assemblyId: string): void;
+    addCheckResults(checkResults: CheckResultSnapshot[]): void;
+    addAssembly(assemblyId: string, backendDriverType?: BackendDriverType): ApolloAssemblyI;
+}
+export type SerializedChange = SerializedOperation;
+export type ChangeOptions = OperationOptions;
+export type DataStore = BackendDataStore | ClientDataStore;
+export declare function isChange(thing: any): thing is Change;
+export declare abstract class Change extends Operation {
+    /**
+     * If a non-empty string, a snackbar will display in JBrowse with this message
+     * when a successful response is received from the server.
+     */
+    get notification(): string;
+    static fromJSON(json: SerializedOperation, options?: ChangeOptions): Change;
+    execute(backend: DataStore): Promise<unknown>;
+    abstract executeOnClient(backend: ClientDataStore): Promise<void>;
+    abstract getInverse(): Change;
+}

package/dist/Change.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Change = void 0;
+exports.isChange = isChange;
+const ChangeTypeRegistry_1 = require("./ChangeTypeRegistry");
+const Operation_1 = require("./Operation");
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function isChange(thing) {
+    return thing.executeOnClient !== undefined;
+}
+class Change extends Operation_1.Operation {
+    /**
+     * If a non-empty string, a snackbar will display in JBrowse with this message
+     * when a successful response is received from the server.
+     */
+    // eslint-disable-next-line @typescript-eslint/class-literal-property-style
+    get notification() {
+        return '';
+    }
+    static fromJSON(json, options) {
+        const ChangeType = ChangeTypeRegistry_1.changeRegistry.getChangeType(json.typeName);
+        return new ChangeType(json, (options === null || options === void 0 ? void 0 : options.logger) && { logger: options.logger });
+    }
+    async execute(backend) {
+        const backendType = backend.typeName;
+        if (backendType === 'LocalGFF3' || backendType === 'Server') {
+            return super.execute(backend);
+        }
+        if (backendType === 'Client') {
+            return this.executeOnClient(backend);
+        }
+        throw new Error(`no change implementation for backend type '${backendType}'`);
+    }
+}
+exports.Change = Change;
+//# sourceMappingURL=Change.js.map

package/dist/Change.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Change.js","sourceRoot":"","sources":["../src/Change.ts"],"names":[],"mappings":";;;AAgDA,4BAEC;AAtCD,6DAAqD;AACrD,2CAKoB;AA6BpB,8DAA8D;AAC9D,SAAgB,QAAQ,CAAC,KAAU;IACjC,OAAQ,KAAgB,CAAC,eAAe,KAAK,SAAS,CAAA;AACxD,CAAC;AAED,MAAsB,MAAO,SAAQ,qBAAS;IAC5C;;;OAGG;IACH,2EAA2E;IAC3E,IAAI,YAAY;QACd,OAAO,EAAE,CAAA;IACX,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,IAAyB,EAAE,OAAuB;QAChE,MAAM,UAAU,GAAG,mCAAc,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAC9D,OAAO,IAAI,UAAU,CAAC,IAAI,EAAE,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,KAAI,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;IAC5E,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,OAAkB;QAC9B,MAAM,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAA;QACpC,IAAI,WAAW,KAAK,WAAW,IAAI,WAAW,KAAK,QAAQ,EAAE,CAAC;YAC5D,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAC/B,CAAC;QACD,IAAI,WAAW,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAA;QACtC,CAAC;QACD,MAAM,IAAI,KAAK,CACb,8CAA8C,WAAW,GAAG,CAC7D,CAAA;IACH,CAAC;CAKF;AA/BD,wBA+BC"}

package/dist/ChangeTypeRegistry.d.ts

@@ -0,0 +1,10 @@
+import { Change } from './Change';
+type ChangeType = new (...args: any[]) => Change;
+declare class ChangeTypeRegistry {
+    changes: Map<string, ChangeType>;
+    registerChange(name: string, changeType: ChangeType): void;
+    getChangeType(name: string): ChangeType;
+}
+/** global singleton of all known types of changes */
+export declare const changeRegistry: ChangeTypeRegistry;
+export {};

package/dist/ChangeTypeRegistry.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.changeRegistry = void 0;
+class ChangeTypeRegistry {
+    constructor() {
+        this.changes = new Map();
+    }
+    registerChange(name, changeType) {
+        if (this.changes.has(name)) {
+            throw new Error(`change type "${name}" has already been registered`);
+        }
+        this.changes.set(name, changeType);
+    }
+    getChangeType(name) {
+        const RegisteredChangeType = this.changes.get(name);
+        if (!RegisteredChangeType) {
+            throw new Error(`No change constructor registered for "${name}"`);
+        }
+        return RegisteredChangeType;
+    }
+}
+/** global singleton of all known types of changes */
+exports.changeRegistry = new ChangeTypeRegistry();
+//# sourceMappingURL=ChangeTypeRegistry.js.map

package/dist/ChangeTypeRegistry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChangeTypeRegistry.js","sourceRoot":"","sources":["../src/ChangeTypeRegistry.ts"],"names":[],"mappings":";;;AAKA,MAAM,kBAAkB;IAAxB;QACE,YAAO,GAAG,IAAI,GAAG,EAAsB,CAAA;IAgBzC,CAAC;IAdC,cAAc,CAAC,IAAY,EAAE,UAAsB;QACjD,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,gBAAgB,IAAI,+BAA+B,CAAC,CAAA;QACtE,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,CAAA;IACpC,CAAC;IAED,aAAa,CAAC,IAAY;QACxB,MAAM,oBAAoB,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QACnD,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,yCAAyC,IAAI,GAAG,CAAC,CAAA;QACnE,CAAC;QACD,OAAO,oBAAoB,CAAA;IAC7B,CAAC;CACF;AAED,qDAAqD;AACxC,QAAA,cAAc,GAAG,IAAI,kBAAkB,EAAE,CAAA"}

package/dist/Check.d.ts

@@ -0,0 +1,6 @@
+import { AnnotationFeatureSnapshot, CheckResultSnapshot } from '@apollo-annotation/mst';
+export declare abstract class Check {
+    abstract name: string;
+    abstract version: number;
+    abstract checkFeature(feature: AnnotationFeatureSnapshot, getSequence: (start: number, end: number) => Promise<string>): Promise<CheckResultSnapshot[]>;
+}

package/dist/Check.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Check = void 0;
+class Check {
+}
+exports.Check = Check;
+//# sourceMappingURL=Check.js.map

package/dist/Check.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Check.js","sourceRoot":"","sources":["../src/Check.ts"],"names":[],"mappings":";;;AAKA,MAAsB,KAAK;CAQ1B;AARD,sBAQC"}

package/dist/CheckRegistry.d.ts

@@ -0,0 +1,10 @@
+import { Check } from './Check';
+declare class CheckRegistry {
+    checks: Map<string, Check>;
+    registerCheck(name: string, check: Check): void;
+    getCheck(name: string): Check;
+    getChecks(): Map<string, Check>;
+}
+/** global singleton of all known checks */
+export declare const checkRegistry: CheckRegistry;
+export {};

package/dist/CheckRegistry.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkRegistry = void 0;
+class CheckRegistry {
+    constructor() {
+        this.checks = new Map();
+    }
+    registerCheck(name, check) {
+        if (this.checks.has(name)) {
+            throw new Error(`check "${name}" has already been registered`);
+        }
+        this.checks.set(name, check);
+    }
+    getCheck(name) {
+        const registeredCheck = this.checks.get(name);
+        if (!registeredCheck) {
+            throw new Error(`No check constructor registered for "${name}"`);
+        }
+        return registeredCheck;
+    }
+    getChecks() {
+        return this.checks;
+    }
+}
+/** global singleton of all known checks */
+exports.checkRegistry = new CheckRegistry();
+//# sourceMappingURL=CheckRegistry.js.map

package/dist/CheckRegistry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CheckRegistry.js","sourceRoot":"","sources":["../src/CheckRegistry.ts"],"names":[],"mappings":";;;AAEA,MAAM,aAAa;IAAnB;QACE,WAAM,GAAG,IAAI,GAAG,EAAiB,CAAA;IAoBnC,CAAC;IAlBC,aAAa,CAAC,IAAY,EAAE,KAAY;QACtC,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,UAAU,IAAI,+BAA+B,CAAC,CAAA;QAChE,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;IAC9B,CAAC;IAED,QAAQ,CAAC,IAAY;QACnB,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QAC7C,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,wCAAwC,IAAI,GAAG,CAAC,CAAA;QAClE,CAAC;QACD,OAAO,eAAe,CAAA;IACxB,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAA;IACpB,CAAC;CACF;AAED,2CAA2C;AAC9B,QAAA,aAAa,GAAG,IAAI,aAAa,EAAE,CAAA"}

package/dist/FeatureChange.d.ts

@@ -0,0 +1,32 @@
+import type { AnnotationFeatureSnapshot } from '@apollo-annotation/mst';
+import { Feature } from '@apollo-annotation/schemas';
+import { AssemblySpecificChange, SerializedAssemblySpecificChange } from './AssemblySpecificChange';
+import { ChangeOptions } from './Change';
+export interface SerializedFeatureChange extends SerializedAssemblySpecificChange {
+    /** The IDs of features that were changed in this operation */
+    changedIds: string[];
+}
+export declare function isFeatureChange(thing: any): thing is FeatureChange;
+export declare abstract class FeatureChange extends AssemblySpecificChange {
+    changedIds: string[];
+    constructor(json: SerializedFeatureChange, options?: ChangeOptions);
+    /**
+     * Get single feature by featureId
+     * @param feature -
+     * @param featureId -
+     * @returns
+     */
+    getFeatureFromId(feature: Feature, featureId: string): Feature | null;
+    /**
+     * Get children's feature ids
+     * @param feature - parent feature
+     * @returns
+     */
+    getChildFeatureIds(feature: Feature | AnnotationFeatureSnapshot): string[];
+    /**
+     * Recursively assign new IDs to a feature
+     * @param feature - Parent feature
+     * @param featureIds -
+     */
+    generateNewIds(feature: Feature | AnnotationFeatureSnapshot, featureIds: string[]): AnnotationFeatureSnapshot;
+}

package/dist/FeatureChange.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FeatureChange = void 0;
+exports.isFeatureChange = isFeatureChange;
+const tslib_1 = require("tslib");
+const bson_objectid_1 = tslib_1.__importDefault(require("bson-objectid"));
+const AssemblySpecificChange_1 = require("./AssemblySpecificChange");
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function isFeatureChange(thing) {
+    return ((0, AssemblySpecificChange_1.isAssemblySpecificChange)(thing) &&
+        thing.changedIds !== undefined);
+}
+class FeatureChange extends AssemblySpecificChange_1.AssemblySpecificChange {
+    constructor(json, options) {
+        super(json, options);
+        this.changedIds = json.changedIds;
+    }
+    /**
+     * Get single feature by featureId
+     * @param feature -
+     * @param featureId -
+     * @returns
+     */
+    getFeatureFromId(feature, featureId) {
+        var _a, _b, _c, _d;
+        const { logger } = this;
+        (_a = logger.verbose) === null || _a === void 0 ? void 0 : _a.call(logger, `Entry=${JSON.stringify(feature)}`);
+        if (feature._id.equals(featureId)) {
+            (_b = logger.debug) === null || _b === void 0 ? void 0 : _b.call(logger, `Top level featureId matches in the object ${JSON.stringify(feature)}`);
+            return feature;
+        }
+        // Check if there is also childFeatures in parent feature and it's not empty
+        // Let's get featureId from recursive method
+        (_c = logger.debug) === null || _c === void 0 ? void 0 : _c.call(logger, 'FeatureId was not found on top level so lets make recursive call...');
+        for (const [, childFeature] of (_d = feature.children) !== null && _d !== void 0 ? _d : new Map()) {
+            const subFeature = this.getFeatureFromId(childFeature, featureId);
+            if (subFeature) {
+                return subFeature;
+            }
+        }
+        return null;
+    }
+    /**
+     * Get children's feature ids
+     * @param feature - parent feature
+     * @returns
+     */
+    getChildFeatureIds(feature) {
+        if (!feature.children) {
+            return [];
+        }
+        const featureIds = [];
+        const children = feature.children instanceof Map
+            ? feature.children
+            : new Map(Object.entries(feature.children));
+        for (const [childFeatureId, childFeature] of children || new Map()) {
+            featureIds.push(childFeatureId, ...this.getChildFeatureIds(childFeature));
+        }
+        return featureIds;
+    }
+    /**
+     * Recursively assign new IDs to a feature
+     * @param feature - Parent feature
+     * @param featureIds -
+     */
+    generateNewIds(feature, featureIds) {
+        const newId = new bson_objectid_1.default().toHexString();
+        featureIds.push(newId);
+        const children = {};
+        if (feature.children) {
+            for (const child of Object.values(feature.children)) {
+                const newChild = this.generateNewIds(child, featureIds);
+                children[newChild._id] = newChild;
+            }
+        }
+        const refSeq = typeof feature.refSeq === 'string'
+            ? feature.refSeq
+            : feature.refSeq.toHexString();
+        return {
+            ...feature,
+            refSeq,
+            children: feature.children && children,
+            _id: newId,
+        };
+    }
+}
+exports.FeatureChange = FeatureChange;
+//# sourceMappingURL=FeatureChange.js.map

package/dist/FeatureChange.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FeatureChange.js","sourceRoot":"","sources":["../src/FeatureChange.ts"],"names":[],"mappings":";;;AAqBA,0CAKC;;AAtBD,0EAAoC;AAGpC,qEAIiC;AASjC,8DAA8D;AAC9D,SAAgB,eAAe,CAAC,KAAU;IACxC,OAAO,CACL,IAAA,iDAAwB,EAAC,KAAK,CAAC;QAC9B,KAAuB,CAAC,UAAU,KAAK,SAAS,CAClD,CAAA;AACH,CAAC;AAED,MAAsB,aAAc,SAAQ,+CAAsB;IAGhE,YAAY,IAA6B,EAAE,OAAuB;QAChE,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QACpB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAA;IACnC,CAAC;IAED;;;;;OAKG;IACH,gBAAgB,CAAC,OAAgB,EAAE,SAAiB;;QAClD,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;QACvB,MAAA,MAAM,CAAC,OAAO,uDAAG,SAAS,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QAEpD,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YAClC,MAAA,MAAM,CAAC,KAAK,uDACV,6CAA6C,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CACvE,CAAA;YACD,OAAO,OAAO,CAAA;QAChB,CAAC;QACD,4EAA4E;QAC5E,4CAA4C;QAC5C,MAAA,MAAM,CAAC,KAAK,uDACV,qEAAqE,CACtE,CAAA;QACD,KAAK,MAAM,CAAC,EAAE,YAAY,CAAC,IAAI,MAAA,OAAO,CAAC,QAAQ,mCAAI,IAAI,GAAG,EAAE,EAAE,CAAC;YAC7D,MAAM,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAAE,SAAS,CAAC,CAAA;YACjE,IAAI,UAAU,EAAE,CAAC;gBACf,OAAO,UAAU,CAAA;YACnB,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,OAA4C;QAC7D,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;YACtB,OAAO,EAAE,CAAA;QACX,CAAC;QACD,MAAM,UAAU,GAAG,EAAE,CAAA;QACrB,MAAM,QAAQ,GACZ,OAAO,CAAC,QAAQ,YAAY,GAAG;YAC7B,CAAC,CAAC,OAAO,CAAC,QAAQ;YAClB,CAAC,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAA;QAC/C,KAAK,MAAM,CAAC,cAAc,EAAE,YAAY,CAAC,IAAI,QAAQ,IAAI,IAAI,GAAG,EAAE,EAAE,CAAC;YACnE,UAAU,CAAC,IAAI,CAAC,cAAc,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC,CAAA;QAC3E,CAAC;QACD,OAAO,UAAU,CAAA;IACnB,CAAC;IAED;;;;OAIG;IACH,cAAc,CACZ,OAA4C,EAC5C,UAAoB;QAEpB,MAAM,KAAK,GAAG,IAAI,uBAAQ,EAAE,CAAC,WAAW,EAAE,CAAA;QAC1C,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAEtB,MAAM,QAAQ,GAA8C,EAAE,CAAA;QAC9D,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACrB,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACpD,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,UAAU,CAAC,CAAA;gBACvD,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAA;YACnC,CAAC;QACH,CAAC;QACD,MAAM,MAAM,GACV,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ;YAChC,CAAC,CAAC,OAAO,CAAC,MAAM;YAChB,CAAC,CAAE,OAAO,CAAC,MAAoC,CAAC,WAAW,EAAE,CAAA;QAEjE,OAAO;YACL,GAAG,OAAO;YACV,MAAM;YACN,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,QAAQ;YACtC,GAAG,EAAE,KAAK;SACX,CAAA;IACH,CAAC;CACF;AAzFD,sCAyFC"}

package/dist/Operation.d.ts

@@ -0,0 +1,59 @@
+import type { ReadStream } from 'node:fs';
+import type { FileHandle } from 'node:fs/promises';
+import { AssemblyDocument, FeatureDocument, FileDocument, RefSeqChunkDocument, RefSeqDocument, JBrowseConfigDocument, UserDocument } from '@apollo-annotation/schemas';
+import type { LoggerService } from '@nestjs/common';
+import type { ClientSession, Model } from 'mongoose';
+import { GenericFilehandle } from 'generic-filehandle';
+export interface LocalGFF3DataStore {
+    typeName: 'LocalGFF3';
+    gff3Handle: FileHandle;
+}
+interface CreateFileDto {
+    readonly _id: string;
+    readonly basename: string;
+    readonly checksum: string;
+    readonly type: 'text/x-gff3' | 'text/x-fasta';
+    readonly user: string;
+}
+export interface ServerDataStore {
+    typeName: 'Server';
+    featureModel: Model<FeatureDocument>;
+    assemblyModel: Model<AssemblyDocument>;
+    refSeqModel: Model<RefSeqDocument>;
+    refSeqChunkModel: Model<RefSeqChunkDocument>;
+    fileModel: Model<FileDocument>;
+    userModel: Model<UserDocument>;
+    jbrowseConfigModel: Model<JBrowseConfigDocument>;
+    session: ClientSession;
+    filesService: {
+        getFileStream(file: FileDocument): ReadStream;
+        getFileHandle(file: FileDocument): GenericFilehandle;
+        parseGFF3(stream: ReadStream): ReadStream;
+        create(createFileDto: CreateFileDto): void;
+        remove(id: string): void;
+    };
+    pluginsService: {
+        evaluateExtensionPoint(extensionPointName: string, extendee: unknown, props?: Record<string, unknown>): void;
+    };
+    counterService: {
+        getNextSequenceValue(sequenceName: string): Promise<number>;
+    };
+    user: string;
+}
+export interface SerializedOperation {
+    typeName: string;
+}
+export type BackendDataStore = ServerDataStore | LocalGFF3DataStore;
+export interface OperationOptions {
+    logger: LoggerService;
+}
+export declare abstract class Operation implements SerializedOperation {
+    protected logger: LoggerService;
+    abstract typeName: string;
+    constructor(json: SerializedOperation, options?: OperationOptions);
+    abstract toJSON(): SerializedOperation;
+    execute(backend: BackendDataStore): Promise<unknown>;
+    abstract executeOnServer(backend: ServerDataStore): Promise<unknown>;
+    abstract executeOnLocalGFF3(backend: LocalGFF3DataStore): Promise<unknown>;
+}
+export {};

package/dist/Operation.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Operation = void 0;
+class Operation {
+    constructor(json, options) {
+        var _a;
+        this.logger = (_a = options === null || options === void 0 ? void 0 : options.logger) !== null && _a !== void 0 ? _a : console;
+    }
+    async execute(backend) {
+        const backendType = backend.typeName;
+        if (backendType === 'Server') {
+            const initialResult = this.executeOnServer(backend);
+            return backend.pluginsService.evaluateExtensionPoint(`${this.typeName}-transformResults`, initialResult, { operation: this, backend });
+        }
+        if (backendType === 'LocalGFF3') {
+            return this.executeOnLocalGFF3(backend);
+        }
+        throw new Error(`no operation implementation for backend type '${backendType}'`);
+    }
+}
+exports.Operation = Operation;
+//# sourceMappingURL=Operation.js.map

package/dist/Operation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Operation.js","sourceRoot":"","sources":["../src/Operation.ts"],"names":[],"mappings":";;;AAuEA,MAAsB,SAAS;IAI7B,YAAY,IAAyB,EAAE,OAA0B;;QAC/D,IAAI,CAAC,MAAM,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,mCAAI,OAAO,CAAA;IAC1C,CAAC;IAID,KAAK,CAAC,OAAO,CAAC,OAAyB;QACrC,MAAM,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAA;QACpC,IAAI,WAAW,KAAK,QAAQ,EAAE,CAAC;YAC7B,MAAM,aAAa,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAA;YACnD,OAAO,OAAO,CAAC,cAAc,CAAC,sBAAsB,CAClD,GAAG,IAAI,CAAC,QAAQ,mBAAmB,EACnC,aAAa,EACb,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,CAC7B,CAAA;QACH,CAAC;QACD,IAAI,WAAW,KAAK,WAAW,EAAE,CAAC;YAChC,OAAO,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAA;QACzC,CAAC;QACD,MAAM,IAAI,KAAK,CACb,iDAAiD,WAAW,GAAG,CAChE,CAAA;IACH,CAAC;CAIF;AA9BD,8BA8BC"}

package/dist/OperationTypeRegistry.d.ts

@@ -0,0 +1,10 @@
+import { Operation } from './Operation';
+type OperationType = new (...args: any[]) => Operation;
+declare class OperationTypeRegistry {
+    operations: Map<string, OperationType>;
+    registerOperation(name: string, operationType: OperationType): void;
+    getOperationType(name: string): OperationType;
+}
+/** global singleton of all known types of operations */
+export declare const operationRegistry: OperationTypeRegistry;
+export {};

package/dist/OperationTypeRegistry.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.operationRegistry = void 0;
+class OperationTypeRegistry {
+    constructor() {
+        this.operations = new Map();
+    }
+    registerOperation(name, operationType) {
+        if (this.operations.has(name)) {
+            throw new Error(`operation type "${name}" has already been registered`);
+        }
+        this.operations.set(name, operationType);
+    }
+    getOperationType(name) {
+        const RegisteredOperationType = this.operations.get(name);
+        if (!RegisteredOperationType) {
+            throw new Error(`No operation constructor registered for "${name}"`);
+        }
+        return RegisteredOperationType;
+    }
+}
+/** global singleton of all known types of operations */
+exports.operationRegistry = new OperationTypeRegistry();
+//# sourceMappingURL=OperationTypeRegistry.js.map

package/dist/OperationTypeRegistry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OperationTypeRegistry.js","sourceRoot":"","sources":["../src/OperationTypeRegistry.ts"],"names":[],"mappings":";;;AAKA,MAAM,qBAAqB;IAA3B;QACE,eAAU,GAAG,IAAI,GAAG,EAAyB,CAAA;IAgB/C,CAAC;IAdC,iBAAiB,CAAC,IAAY,EAAE,aAA4B;QAC1D,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,mBAAmB,IAAI,+BAA+B,CAAC,CAAA;QACzE,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,aAAa,CAAC,CAAA;IAC1C,CAAC;IAED,gBAAgB,CAAC,IAAY;QAC3B,MAAM,uBAAuB,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QACzD,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,4CAA4C,IAAI,GAAG,CAAC,CAAA;QACtE,CAAC;QACD,OAAO,uBAAuB,CAAA;IAChC,CAAC;CACF;AAED,wDAAwD;AAC3C,QAAA,iBAAiB,GAAG,IAAI,qBAAqB,EAAE,CAAA"}

package/dist/Validation.d.ts

@@ -0,0 +1,27 @@
+import { FeatureDocument } from '@apollo-annotation/schemas';
+import type { ExecutionContext } from '@nestjs/common';
+import type { Reflector } from '@nestjs/core';
+import { ClientSession, Model } from 'mongoose';
+import { Change, ClientDataStore } from './Change';
+export interface Context {
+    context: ExecutionContext;
+    reflector: Reflector;
+}
+export declare function isContext(thing: Change | Context): thing is Context;
+export interface ValidationResult {
+    validationName: string;
+    error?: {
+        message: string;
+    };
+}
+export declare abstract class Validation {
+    abstract name: string;
+    frontendPreValidate(_change: Change): Promise<ValidationResult>;
+    frontendPostValidate(_change: Change, _dataStore: ClientDataStore): Promise<ValidationResult>;
+    backendPreValidate(_changeOrContext: Change | Context): Promise<ValidationResult>;
+    backendPostValidate(_change: Change, _context: {
+        session: ClientSession;
+        featureModel: Model<FeatureDocument>;
+    }): Promise<ValidationResult>;
+    possibleValues(_key: string): Promise<unknown[] | undefined>;
+}

package/dist/Validation.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Validation = void 0;
+exports.isContext = isContext;
+function isContext(thing) {
+    return 'context' in thing && 'reflector' in thing;
+}
+class Validation {
+    async frontendPreValidate(_change) {
+        return { validationName: this.name };
+    }
+    async frontendPostValidate(_change, _dataStore) {
+        return { validationName: this.name };
+    }
+    async backendPreValidate(_changeOrContext) {
+        return { validationName: this.name };
+    }
+    async backendPostValidate(_change, _context) {
+        return { validationName: this.name };
+    }
+    async possibleValues(_key) {
+        return undefined;
+    }
+}
+exports.Validation = Validation;
+//# sourceMappingURL=Validation.js.map

package/dist/Validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Validation.js","sourceRoot":"","sources":["../src/Validation.ts"],"names":[],"mappings":";;;AAaA,8BAEC;AAFD,SAAgB,SAAS,CAAC,KAAuB;IAC/C,OAAO,SAAS,IAAI,KAAK,IAAI,WAAW,IAAI,KAAK,CAAA;AACnD,CAAC;AAOD,MAAsB,UAAU;IAE9B,KAAK,CAAC,mBAAmB,CAAC,OAAe;QACvC,OAAO,EAAE,cAAc,EAAE,IAAI,CAAC,IAAI,EAAE,CAAA;IACtC,CAAC;IAED,KAAK,CAAC,oBAAoB,CACxB,OAAe,EACf,UAA2B;QAE3B,OAAO,EAAE,cAAc,EAAE,IAAI,CAAC,IAAI,EAAE,CAAA;IACtC,CAAC;IAED,KAAK,CAAC,kBAAkB,CACtB,gBAAkC;QAElC,OAAO,EAAE,cAAc,EAAE,IAAI,CAAC,IAAI,EAAE,CAAA;IACtC,CAAC;IAED,KAAK,CAAC,mBAAmB,CACvB,OAAe,EACf,QAA0E;QAE1E,OAAO,EAAE,cAAc,EAAE,IAAI,CAAC,IAAI,EAAE,CAAA;IACtC,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,IAAY;QAC/B,OAAO,SAAS,CAAA;IAClB,CAAC;CACF;AA7BD,gCA6BC"}

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+export * from './ApolloPlugin';
+export * from './AssemblySpecificChange';
+export * from './Change';
+export * from './ChangeTypeRegistry';
+export * from './Check';
+export * from './CheckRegistry';
+export * from './FeatureChange';
+export * from './Operation';
+export * from './OperationTypeRegistry';
+export * from './Validation';

package/dist/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./ApolloPlugin"), exports);
+tslib_1.__exportStar(require("./AssemblySpecificChange"), exports);
+tslib_1.__exportStar(require("./Change"), exports);
+tslib_1.__exportStar(require("./ChangeTypeRegistry"), exports);
+tslib_1.__exportStar(require("./Check"), exports);
+tslib_1.__exportStar(require("./CheckRegistry"), exports);
+tslib_1.__exportStar(require("./FeatureChange"), exports);
+tslib_1.__exportStar(require("./Operation"), exports);
+tslib_1.__exportStar(require("./OperationTypeRegistry"), exports);
+tslib_1.__exportStar(require("./Validation"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,yDAA8B;AAC9B,mEAAwC;AACxC,mDAAwB;AACxB,+DAAoC;AACpC,kDAAuB;AACvB,0DAA+B;AAC/B,0DAA+B;AAC/B,sDAA2B;AAC3B,kEAAuC;AACvC,uDAA4B"}