@leansdk/leanrc/dist/interfaces/patterns/ResourceInterface.js

LeanRC is a MVC framework for creating graceful applications

(function() {
  // This file is part of LeanRC.

  // LeanRC is free software: you can redistribute it and/or modify
  // it under the terms of the GNU Lesser General Public License as published by
  // the Free Software Foundation, either version 3 of the License, or
  // (at your option) any later version.

  // LeanRC is distributed in the hope that it will be useful,
  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  // GNU Lesser General Public License for more details.

  // You should have received a copy of the GNU Lesser General Public License
  // along with LeanRC.  If not, see <https://www.gnu.org/licenses/>.

  // комманда эквивалентная контролеру в рельсах
  // в зависимости от сингала, будет запускаться нужный ресурс CucumbersResource
  // а в зависимости от типа нотификейшена внутри инстанса ресурса
  // будет выполняться нужный экшен (метод) create, update, detail, list, delete

  // в случае со стрим-сервером заливку и отдачу файла будет реализовывать платформозависимый код медиатора, а ресурсная команда Uploads этим заниматься не будет. (чтобы медиатор напрямую писал в нужный прокси, и считывал поток так же напрямую из прокси.)
  module.exports = function(Module) {
    var AnyT, CollectionInterface, ContextInterface, DictG, EnumG, FuncG, Interface, ListG, MaybeG, ResourceInterface, StructG, TupleG, UnionG;
    ({AnyT, FuncG, UnionG, TupleG, MaybeG, DictG, StructG, EnumG, ListG, CollectionInterface, ContextInterface, Interface} = Module.prototype);
    return ResourceInterface = (function() {
      class ResourceInterface extends Interface {};

      ResourceInterface.inheritProtected();

      ResourceInterface.module(Module);

      // @virtual needsLimitation: Boolean
      // @virtual entityName: String
      // @virtual keyName: String
      // @virtual itemEntityName: String
      // @virtual listEntityName: String
      // @virtual collectionName: String
      // @virtual collection: CollectionInterface

      // @virtual context: MaybeG ContextInterface
      // @virtual listQuery: MaybeG Object
      // @virtual recordId: MaybeG String
      // @virtual recordBody: MaybeG Object
      ResourceInterface.virtual(ResourceInterface.static({
        actions: DictG(String, Object)
      }));

      ResourceInterface.virtual(ResourceInterface.static({
        action: FuncG([UnionG(Object, TupleG(Object, Object))])
      }));

      ResourceInterface.virtual(ResourceInterface.async({
        list: FuncG([], StructG({
          meta: StructG({
            pagination: StructG({
              limit: UnionG(Number, EnumG(['not defined'])),
              offset: UnionG(Number, EnumG(['not defined']))
            })
          }),
          items: ListG(Object)
        }))
      }));

      ResourceInterface.virtual(ResourceInterface.async({
        detail: FuncG([], Object)
      }));

      ResourceInterface.virtual(ResourceInterface.async({
        create: FuncG([], Object)
      }));

      ResourceInterface.virtual(ResourceInterface.async({
        update: FuncG([], Object)
      }));

      ResourceInterface.virtual(ResourceInterface.async({
        delete: Function
      }));

      ResourceInterface.virtual(ResourceInterface.async({
        destroy: Function
      }));

      ResourceInterface.virtual(ResourceInterface.async({
        doAction: FuncG([String, ContextInterface], AnyT)
      }));

      ResourceInterface.virtual(ResourceInterface.async({
        writeTransaction: FuncG([String, ContextInterface], Boolean)
      }));

      ResourceInterface.virtual(ResourceInterface.async({
        saveDelayeds: Function
      }));

      ResourceInterface.initialize();

      return ResourceInterface;

    }).call(this);
  };

}).call(this);