API Documentation

Source

api/stuff/StuffCollection.js

  1. import { Meteor } from 'meteor/meteor';
  2. import SimpleSchema from 'simpl-schema';
  3. import { check } from 'meteor/check';
  4. import { _ } from 'lodash';
  5. import { Roles } from 'meteor/alanning:roles';
  6. import BaseCollection from '../base/BaseCollection';
  8. /**
  9.  * **deprecated**
  10.  *  @namespace api/stuff
  11.  */
  13. /**
  14.  * The different conditions for stuff.
  15.  * @type {string[]}
  16.  * @memberOf api/stuff
  17.  */
  18. export const stuffConditions = ['excellent', 'good', 'fair', 'poor'];
  20. /**
  21.  * The publication names for the StuffCollection.
  22.  * @type {{stuffAdmin: string, stuff: string}}
  23.  * @memberOf api/stuff
  24.  */
  25. export const stuffPublications = {
  26.   stuff: 'Stuff',
  27.   stuffAdmin: 'StuffAdmin',
  28. };
  30. /**
  31.  * The StuffCollection **deprecated**.
  32.  * @memberOf api/stuff
  33.  * @extends api/base.BaseCollection
  34.  */
  35. class StuffCollection extends BaseCollection {
  36.   constructor() {
  37.     super('Stuffs', new SimpleSchema({
  38.       name: String,
  39.       quantity: Number,
  40.       owner: String,
  41.       condition: {
  42.         type: String,
  43.         allowedValues: stuffConditions,
  44.         defaultValue: 'good',
  45.       },
  46.     }));
  47.   }
  49.   /**
  50.    * Defines a new Stuff item.
  51.    * @param name the name of the item.
  52.    * @param quantity how many.
  53.    * @param owner the owner of the item.
  54.    * @param condition the condition of the item.
  55.    * @return {String} the docID of the new document.
  56.    */
  57.   define({ name, quantity, owner, condition }) {
  58.     const docID = this._collection.insert({
  59.       name,
  60.       quantity,
  61.       owner,
  62.       condition,
  63.     });
  64.     return docID;
  65.   }
  67.   /**
  68.    * Updates the given document.
  69.    * @param docID the id of the document to update.
  70.    * @param name the new name (optional).
  71.    * @param quantity the new quantity (optional).
  72.    * @param condition the new condition (optional).
  73.    */
  74.   update(docID, { name, quantity, condition }) {
  75.     const updateData = {};
  76.     if (name) {
  77.       updateData.name = name;
  78.     }
  79.     // if (quantity) { NOTE: 0 is falsy so we need to check if the quantity is a number.
  80.     if (_.isNumber(quantity)) {
  81.       updateData.quantity = quantity;
  82.     }
  83.     if (condition) {
  84.       updateData.condition = condition;
  85.     }
  86.     this._collection.update(docID, { $set: updateData });
  87.   }
  89.   /**
  90.    * A stricter form of remove that throws an error if the document or docID could not be found in this collection.
  91.    * @param { String | Object } name A document or docID in this collection.
  92.    * @returns true
  93.    */
  94.   removeIt(name) {
  95.     const doc = this.findDoc(name);
  96.     check(doc, Object);
  97.     this._collection.remove(doc._id);
  98.     return true;
  99.   }
  101.   /**
  102.    * Default publication method for entities.
  103.    * It publishes the entire collection for admin and just the stuff associated to an owner.
  104.    */
  105.   publish() {
  106.     if (Meteor.isServer) {
  107.       // get the StuffCollection instance.
  108.       const instance = this;
  109.       /** This subscription publishes only the documents associated with the logged in user */
  110.       Meteor.publish(stuffPublications.stuff, function publish() {
  111.         if (this.userId) {
  112.           const username = Meteor.users.findOne(this.userId).username;
  113.           return instance._collection.find({ owner: username });
  114.         }
  115.         return this.ready();
  116.       });
  118.       /** This subscription publishes all documents regardless of user, but only if the logged in user is the Admin. */
  119.       Meteor.publish(stuffPublications.stuffAdmin, function publish() {
  120.         if (this.userId && Roles.userIsInRole(this.userId, 'admin')) {
  121.           return instance._collection.find();
  122.         }
  123.         return this.ready();
  124.       });
  125.     }
  126.   }
  128.   /**
  129.    * Subscription method for stuff owned by the current user.
  130.    */
  131.   subscribeStuff() {
  132.     if (Meteor.isClient) {
  133.       return Meteor.subscribe(stuffPublications.stuff);
  134.     }
  135.     return null;
  136.   }
  138.   /**
  139.    * Subscription method for admin users.
  140.    * It subscribes to the entire collection.
  141.    */
  142.   subscribeStuffAdmin() {
  143.     if (Meteor.isClient) {
  144.       return Meteor.subscribe(stuffPublications.stuffAdmin);
  145.     }
  146.     return null;
  147.   }
  149. }
  151. /**
  152.  * Singleton instance of the StuffCollection, **deprecated**.
  153.  * @type {api/stuff.StuffCollection}
  154.  * @memberOf api/stuff
  155.  */
  156. export const Stuffs = new StuffCollection();