@flumens/models 0.6.0 → 0.7.0

package/dist/Indicia/Occurrence.js

@@ -1,220 +1 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var tslib = require('tslib');
-var mobx = require('mobx');
-var lodash = require('lodash');
-var Model = require('../Model.js');
-var Media = require('./Media.js');
-var helpers = require('./helpers.js');
-
-var Occurrence = /** @class */ (function (_super) {
-    tslib.__extends(Occurrence, _super);
-    function Occurrence(_a) {
-        if (_a === void 0) { _a = {}; }
-        var _this = this;
-        var _b = _a.metadata, metadata = _b === void 0 ? {} : _b, _c = _a.media, media = _c === void 0 ? [] : _c, options = tslib.__rest(_a, ["metadata", "media"]);
-        _this = _super.call(this, options) || this;
-        _this.debouncedValue = 300;
-        _this.keys = function () {
-            var getRemoteProps = function (attrs) {
-                var extractRemoteIfExists = function (agg, key) {
-                    var _a;
-                    return (tslib.__assign(tslib.__assign({}, agg), (_a = {}, _a[key] = attrs[key].remote || attrs[key], _a)));
-                };
-                return Object.keys(attrs).reduce(extractRemoteIfExists, {});
-            };
-            return tslib.__assign(tslib.__assign({}, Occurrence.keys), getRemoteProps(_this.getSurvey().attrs || {}));
-        };
-        _this.metadata = mobx.observable(metadata);
-        _this.media = mobx.observable(media);
-        // eslint-disable-next-line no-param-reassign, no-return-assign
-        var attachParent = function (model) { return (model.parent = _this); };
-        _this.media.forEach(attachParent);
-        var onAddedSetParentAndUpdateTime = function (change) {
-            var _a;
-            if ((_a = change.added) === null || _a === void 0 ? void 0 : _a.length) {
-                change.added.forEach(attachParent);
-                _this.setUpdatedAtTimestamp(Date.now());
-            }
-            else if (change.removedCount) {
-                _this.setUpdatedAtTimestamp(Date.now());
-            }
-            return change;
-        };
-        mobx.intercept(_this.media, onAddedSetParentAndUpdateTime);
-        return _this;
-    }
-    Occurrence.fromJSON = function (json, MediaClass) {
-        var _a, _b, _c, _d;
-        if (MediaClass === void 0) { MediaClass = Media["default"]; }
-        var occurrence = new this(tslib.__assign(tslib.__assign({}, json), { createdAt: json.createdAt || ((_a = json.metadata) === null || _a === void 0 ? void 0 : _a.createdOn), updatedAt: json.updatedAt || ((_b = json.metadata) === null || _b === void 0 ? void 0 : _b.updatedOn), syncedAt: json.syncedAt || ((_c = json.metadata) === null || _c === void 0 ? void 0 : _c.syncedOn), media: (_d = json.media) === null || _d === void 0 ? void 0 : _d.map(function (mJson) { return MediaClass.fromJSON(mJson); }) }));
-        return occurrence;
-    };
-    Occurrence.prototype.setUpdatedAtTimestamp = function (newUpdatedAt) {
-        var _a;
-        _super.prototype.setUpdatedAtTimestamp.call(this, newUpdatedAt);
-        (_a = this.parent) === null || _a === void 0 ? void 0 : _a.setUpdatedAtTimestamp(newUpdatedAt);
-    };
-    /**
-     * Save the model to the offline store.
-     */
-    Occurrence.prototype.save = function () {
-        return tslib.__awaiter(this, void 0, void 0, function () {
-            return tslib.__generator(this, function (_a) {
-                if (!this.parent) {
-                    throw new Error('Trying to save locally without a parent');
-                }
-                this.parent.save();
-                return [2 /*return*/];
-            });
-        });
-    };
-    /**
-     * Destroy the model and remove from the offline store.
-     */
-    Occurrence.prototype.destroy = function (silent) {
-        return tslib.__awaiter(this, void 0, void 0, function () {
-            return tslib.__generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (!this.parent) {
-                            throw new Error('Trying to destroy locally without a parent');
-                        }
-                        this.parent.occurrences.remove(this);
-                        return [4 /*yield*/, Promise.all(this.media.map(function (media) { return media.destroy(true); }))];
-                    case 1:
-                        _a.sent();
-                        if (silent)
-                            return [2 /*return*/];
-                        return [4 /*yield*/, this.parent.save()];
-                    case 2:
-                        _a.sent();
-                        return [2 /*return*/];
-                }
-            });
-        });
-    };
-    Occurrence.prototype.sync = function () {
-        return tslib.__awaiter(this, void 0, void 0, function () {
-            return tslib.__generator(this, function (_a) {
-                return [2 /*return*/, this.parent ? this.parent.sync() : _super.prototype.sync.call(this)];
-            });
-        });
-    };
-    /**
-     * Returns a clean (no observables) JSON representation of the model.
-     */
-    Occurrence.prototype.toJSON = function () {
-        var _a;
-        var data = _super.prototype.toJSON.call(this);
-        return JSON.parse(JSON.stringify(tslib.__assign(tslib.__assign({}, data), { media: ((_a = this.media) === null || _a === void 0 ? void 0 : _a.map(function (model) { return model.toJSON(); })) || [], metadata: mobx.toJS(this.metadata) || {} })));
-    };
-    Occurrence.prototype.getSurvey = function () {
-        if (!this.parent)
-            return {};
-        var survey = this.parent.getSurvey();
-        return survey.occ || {};
-    };
-    Occurrence.prototype.isUploaded = function () {
-        if (!this.parent) {
-            throw new Error('No occurrence parent to return disabled status.');
-        }
-        return this.parent.isUploaded();
-    };
-    Occurrence.prototype.isDisabled = function () {
-        return this.isUploaded();
-    };
-    /**
-     * Returns an object with attributes and their values
-     * mapped for warehouse submission.
-     */
-    Occurrence.prototype.getSubmission = function (warehouseMediaNames) {
-        var _this = this;
-        if (warehouseMediaNames === void 0) { warehouseMediaNames = {}; }
-        var occKeys = typeof this.keys === 'function' ? this.keys() : this.keys;
-        var keys = tslib.__assign(tslib.__assign({}, Occurrence.keys), occKeys); // warehouse keys/values to transform
-        var submission = {
-            values: {
-                external_key: this.cid,
-            },
-            media: [],
-        };
-        if (this.id) {
-            submission.values.id = this.id;
-        }
-        var mapValue = function (attr, value) {
-            var valuesMapping = keys[attr].values;
-            if (!valuesMapping) {
-                return value;
-            }
-            if (typeof valuesMapping === 'function') {
-                return valuesMapping(value, submission, _this);
-            }
-            if (valuesMapping instanceof Array) {
-                var mapping = valuesMapping.find(function (_a) {
-                    var val = _a.value;
-                    return val === value;
-                });
-                if (!mapping || !mapping.id) {
-                    throw new Error("A \"".concat(attr, "\" attribute \"").concat(value, "\" value could not be mapped to a remote database field."));
-                }
-                return mapping.id;
-            }
-            if (value instanceof Array) {
-                return value.map(function (v) { return valuesMapping[v]; });
-            }
-            return valuesMapping[value];
-        };
-        var getValue = function (attr) {
-            // no need to send attributes with no values
-            var value = _this.attrs[attr];
-            var isEmpty = function (val) { return val === null || val === undefined; };
-            if (isEmpty(value)) {
-                return;
-            }
-            if (!keys[attr]) {
-                attr = attr.includes('occAttr:') ? attr : lodash.snakeCase(attr);
-                submission.values[attr] = value;
-                return;
-            }
-            var warehouseAttr = keys[attr].id || attr;
-            value = mapValue(attr, value);
-            if (isEmpty(value)) {
-                return;
-            }
-            var attrKey = !Number.isNaN(Number(warehouseAttr))
-                ? "occAttr:".concat(warehouseAttr)
-                : warehouseAttr;
-            attrKey = attrKey.includes('occAttr:') ? attrKey : lodash.snakeCase(attrKey);
-            submission.values[attrKey] = value;
-        };
-        Object.keys(this.attrs).forEach(getValue);
-        this.media.forEach(function (model) {
-            var modelSubmission = model.getSubmission(warehouseMediaNames);
-            if (!modelSubmission) {
-                return;
-            }
-            submission.media.push(modelSubmission);
-        });
-        var survey = this.getSurvey();
-        if (survey.modifySubmission) {
-            return survey.modifySubmission(submission, this);
-        }
-        return submission;
-    };
-    /**
-     * Warehouse attributes and their values.
-     */
-    Occurrence.keys = {
-        taxon: { id: 'taxa_taxon_list_id' },
-        training: { id: 'training', values: helpers.boolToWarehouseValue },
-        deleted: { id: 'deleted', values: helpers.boolToWarehouseValue },
-        confidential: { id: 'confidential', values: helpers.boolToWarehouseValue },
-        zeroAbundance: { id: 'zero_abundance', values: helpers.boolToWarehouseValue },
-    };
-    return Occurrence;
-}(Model["default"]));
-
-exports["default"] = Occurrence;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("tslib"),t=require("mobx"),a=require("lodash"),n=require("../Model.js"),i=require("./Media.js"),r=require("./helpers.js"),o=function(n){function o(a){void 0===a&&(a={});var r=this,s=a.metadata,d=void 0===s?{}:s,u=a.media,c=void 0===u?[]:u,l=a.Media,p=void 0===l?i.default:l,v=e.__rest(a,["metadata","media","Media"]);v.createdAt=v.createdAt||(null==d?void 0:d.createdOn),v.updatedAt=v.updatedAt||(null==d?void 0:d.updatedOn),v.syncedAt=v.syncedAt||(null==d?void 0:d.syncedOn),(r=n.call(this,v)||this).debouncedValue=300,r.keys=function(){var t;return e.__assign(e.__assign({},o.keys),(t=r.getSurvey().attrs||{},Object.keys(t).reduce((function(a,n){var i;return e.__assign(e.__assign({},a),((i={})[n]=t[n].remote||t[n],i))}),{})))},r.Media=p,r.metadata=t.observable(d);var m,f,_=c.map((m=r.Media,void 0===f&&(f={}),function(t){return t instanceof m?t:new m(e.__assign(e.__assign({},t),f))}));r.media=t.observable(_);var h=function(e){return e.parent=r};r.media.forEach(h);return t.intercept(r.media,(function(e){var t;return(null===(t=e.added)||void 0===t?void 0:t.length)?(e.added.forEach(h),r.setUpdatedAtTimestamp(Date.now())):e.removedCount&&r.setUpdatedAtTimestamp(Date.now()),e})),r}return e.__extends(o,n),o.parseRemoteJSON=function(t,a,n){var i,o,s,d,u,c,l,p=t.id,v=t.metadata,m=t.event,f=t.occurrence,_=t.taxon,h=new Date(v.created_on).getTime(),y=new Date(v.updated_on).getTime(),b=Date.now(),g=m.parent_event_id?null===(o=null===(i=n.smp)||void 0===i?void 0:i.occ)||void 0===o?void 0:o.attrs:null===(s=n.occ)||void 0===s?void 0:s.attrs;g||(g=(null===(u=null===(d=n.smp)||void 0===d?void 0:d.occ)||void 0===u?void 0:u.attrs)||(null===(c=n.occ)||void 0===c?void 0:c.attrs)||{});var A=r.parseRemoteAttrs(g,f.attributes||[]),w=null===(l=f.media)||void 0===l?void 0:l.map((function(e){var t=e.path;return{id:t,createdAt:h,updatedAt:y,syncedAt:b,data:{data:"".concat(a,"/upload/").concat(t)}}})),N=_.species||_.taxon_name,x=N!==_.taxon_name?_.taxon_name:"";return{id:p,cid:p,createdAt:h,updatedAt:y,syncedAt:b,data:e.__assign(e.__assign({},A),{taxon:{warehouse_id:parseInt(_.taxa_taxon_list_id,10),scientific_name:N,scientificName:N,common_name:x,commonName:x,found_in_name:x?"common_name":"scientific_name",foundInName:x?"commonName":"scientificName"},comment:f.occurrence_remarks}),media:w}},o.prototype.setUpdatedAtTimestamp=function(e){var t;n.prototype.setUpdatedAtTimestamp.call(this,e),null===(t=this.parent)||void 0===t||t.setUpdatedAtTimestamp(e)},o.prototype.save=function(){return e.__awaiter(this,void 0,void 0,(function(){return e.__generator(this,(function(e){if(!this.parent)throw new Error("Trying to save locally without a parent");return this.parent.save(),[2]}))}))},o.prototype.destroy=function(t){return e.__awaiter(this,void 0,void 0,(function(){return e.__generator(this,(function(e){switch(e.label){case 0:if(!this.parent)throw new Error("Trying to destroy locally without a parent");return this.parent.occurrences.remove(this),[4,Promise.all(this.media.map((function(e){return e.destroy(!0)})))];case 1:return e.sent(),t?[2]:[4,this.parent.save()];case 2:return e.sent(),[2]}}))}))},o.prototype.sync=function(){return e.__awaiter(this,void 0,void 0,(function(){return e.__generator(this,(function(e){return[2,this.parent?this.parent.sync():n.prototype.sync.call(this)]}))}))},o.prototype.toJSON=function(){var a,i=n.prototype.toJSON.call(this);return JSON.parse(JSON.stringify(e.__assign(e.__assign({},i),{media:(null===(a=this.media)||void 0===a?void 0:a.map((function(e){return e.toJSON()})))||[],metadata:t.toJS(this.metadata)||{}})))},o.prototype.getSurvey=function(){return this.parent&&this.parent.getSurvey().occ||{}},Object.defineProperty(o.prototype,"isUploaded",{get:function(){if(!this.parent)throw new Error("No occurrence parent to return disabled status.");return this.parent.isUploaded},enumerable:!1,configurable:!0}),Object.defineProperty(o.prototype,"isDisabled",{get:function(){return this.isUploaded},enumerable:!1,configurable:!0}),o.prototype.getSubmission=function(t){var n=this;void 0===t&&(t={});var i="function"==typeof this.keys?this.keys():this.keys,r=e.__assign(e.__assign({},o.keys),i),s={values:{external_key:this.cid},media:[]};this.id&&(s.values.id=this.id);Object.keys(this.data).forEach((function(e){var t=n.data[e],i=function(e){return null==e};if(!i(t)){if(!r[e])return e=e.includes("occAttr:")?e:a.snakeCase(e),void(s.values[e]=t);var o=r[e].id||e;if(t=function(e,t){var a=r[e].values;if(!a)return t;if("function"==typeof a)return a(t,s,n);if(a instanceof Array){var i=a.find((function(e){return e.value===t}));if(!i||!i.id)throw new Error('A "'.concat(e,'" attribute "').concat(t,'" value could not be mapped to a remote database field.'));return i.id}return t instanceof Array?t.map((function(e){return a[e]})):a[t]}(e,t),!i(t)){var d=Number.isNaN(Number(o))?o:"occAttr:".concat(o);d=d.includes("occAttr:")?d:a.snakeCase(d),s.values[d]=t}}})),this.media.forEach((function(e){var a=e.getSubmission(t);a&&s.media.push(a)}));var d=this.getSurvey();return d.modifySubmission?d.modifySubmission(s,this):s},o.keys={taxon:{id:"taxa_taxon_list_id"},training:{id:"training",values:r.boolToWarehouseValue},deleted:{id:"deleted",values:r.boolToWarehouseValue},confidential:{id:"confidential",values:r.boolToWarehouseValue},zeroAbundance:{id:"zero_abundance",values:r.boolToWarehouseValue}},o}(n.default);exports.default=o;

package/dist/Indicia/Sample.d.ts

@@ -1,5 +1,6 @@
 import { IObservableArray } from 'mobx';
-import Model, { Attrs as AttrsOriginal, Options as OptionsOriginal } from '../Model';
+import Model, { Data as DataOriginal, Options as OptionsOriginal } from '../Model';
+import ElasticSample from './ElasticSample';
 import Media from './Media';
 import Occurrence from './Occurrence';
 import { RemoteConfig, Keys } from './helpers';
@@ -17,8 +18,16 @@ export interface Options<T = any, S = any> extends OptionsOriginal<T> {
     occurrences?: any[];
     samples?: any[];
     media?: any[];
+    Sample?: typeof Sample<any, any>;
+    Occurrence?: typeof Occurrence<any, any>;
+    Media?: typeof Media<any, any>;
+    skipStore?: boolean;
 }
-export interface Attrs extends AttrsOriginal {
+export interface Data extends DataOriginal {
+    /**
+     * Flag whether the Sample was deleted. Global and persistent models might not need this.
+     */
+    deleted?: boolean;
     surveyId?: string | number | null;
     /**
      * Remote website survey edit page path.
@@ -39,7 +48,7 @@ export interface Attrs extends AttrsOriginal {
 export interface Remote {
     synchronising?: boolean;
     url?: string | null;
-    headers?: any;
+    getAccessToken: () => Promise<string>;
     timeout?: number;
     /**
      * @deprecated
@@ -62,9 +71,32 @@ export interface Survey extends BaseSurvey {
     smp?: Survey;
     occ?: BaseSurvey;
 }
-declare class Sample<T extends Attrs = Attrs, S extends Metadata = Metadata> extends Model<T> {
-    static fromJSON(jsonProp: any, OccurrenceClass?: any, Sample?: any, // eslint-disable-line
-    MediaClass?: any): Sample<Attrs, Metadata>;
+declare class Sample<T extends Data = Data, S extends Metadata = Metadata> extends Model<T> {
+    /**
+     * Transform ES document into local structure.
+     */
+    static parseRemoteJSON({ id, event, location, metadata }: ElasticSample, remoteUrl: string, survey?: any): {
+        id: string;
+        cid: string;
+        createdAt: number;
+        updatedAt: number;
+        syncedAt: number;
+        metadata: {
+            saved: boolean;
+        };
+        data: any;
+        media: {
+            id: string;
+            metadata: {
+                updatedOn: Date;
+                createdOn: Date;
+                syncedOn: Date;
+            };
+            data: {
+                data: string;
+            };
+        }[] | undefined;
+    };
     /**
      * Warehouse attributes and their values.
      */
@@ -93,6 +125,9 @@ declare class Sample<T extends Attrs = Attrs, S extends Metadata = Metadata> ext
             values: (val?: boolean | "t" | "f" | null) => "t" | "f";
         };
     };
+    Sample: typeof Sample<any, any>;
+    Occurrence: typeof Occurrence<any, any>;
+    Media: typeof Media<any, any>;
     /**
      * Model persistent observable metadata.
      */
@@ -107,10 +142,18 @@ declare class Sample<T extends Attrs = Attrs, S extends Metadata = Metadata> ext
     occurrences: IObservableArray<Occurrence>;
     media: IObservableArray<Media>;
     parent?: Sample<T, S>;
-    survey?: Survey;
+    private survey?;
     debouncedValue: number;
-    constructor({ metadata, samples, occurrences, media, attrs, ...options }?: Options);
-    setupdatedAtTimestamp(newUpdatedAt: number): void;
+    constructor({ metadata, samples, occurrences, media, Sample: SampleClass, Occurrence: OccurrenceClass, Media: MediaClass, skipStore, ...options }?: Options);
+    get isStored(): import("..").IStore<{
+        id?: string;
+        cid: string;
+        data: T;
+        createdAt: number;
+        updatedAt: number;
+        syncedAt?: number | null;
+    }> | undefined;
+    setUpdatedAtTimestamp(newUpdatedAt: number): void;
     /**
      * Returns a clean (no observables) JSON representation of the model.
      */
@@ -134,7 +177,7 @@ declare class Sample<T extends Attrs = Attrs, S extends Metadata = Metadata> ext
     private putRemote;
     private uploadMedia;
     getSubmission(warehouseMediaNames?: {}): any;
-    isUploaded(): boolean;
-    isDisabled(): boolean;
+    get isUploaded(): boolean;
+    get isDisabled(): boolean;
 }
 export default Sample;