@artmuseo/makette v0.1.0

makette

Makette is a framework for MVC development created by Artmuseo. Makette is intended to be used for the composition of high-level complex methods wherein the overhead of additional function calls is not critical.

The goal of Makette is to enable semantically empowered, information-rich, and control signal-modifiable programs to drive maintainability, exploration, and code generation. The original use case for Makette was to describe Artmuseo's RPC target layer.

Model

The lowest member in the Makette family of callables is the Model. Model should describe the procedure at its highest level of abstraction and primarily rely on context to achieve the desired outcome.

const loginUser = Model({
  body : async (
    args : { username : string, password: string },
    context : {
       getUserId : async (username : string, password : string) => Promise<string>,
       getTokenForId : (userId : string) => Promise<string>,
       dispatchLoginAnalytics : async (userId : string) => void
    }) : Promise<string> => {
        
        // get the user id
        const userId = await context.getUserId(args.username, args.password);
        
        // get the token for the id
        const tok = await context.getTokenForId(userId);
        
        // dispatch login analytics against the token
        context.dispatchLoginAnalytics(userId);
        
        return tok;
        
    },
    defaultContext : {
      getUserId : async (username : string, password : string) => "mock"
      getTokenForId : (userId : string) => "notok",
      dispatchLoginAnalytics : async (userId : string) =>{}
    }
});

const tok = await loginUser({username : "lmonninger", password : "notapassword"}); // "notok"

OsModel

Makette installs all prodecures in WeakMaps referred to as Allocation Contexts. A special implementation of one of these Allocation Contexts enables the creation of OsModels, models which cannot be called except via trap. This is intended as a development feature to prevent the unintended exposure of unsafe methods to the end user.

OsModels can also be configured with additional runtime security features when added to the VmRpc via installOsModel.

const loginUser = OSModel({
  body : // ...
  defaultContext : //...
});

const tok = await loginUser({username : "lmonninger", password : "notapassword"}); // "Error"

const osTok = await trap(loginUser, {username : "lmonninger", password : "notapassword"}); // "No Tok"

Controller

Controllers wrap models to provide context.

const loginUserController = Controller({
   model : loginUser,
   context : {
      getUserId : //...
   }
});

const tok = loginUserController({username : "lmonninger", password : "notapassword"}); // maybe something different

OsController

OsControllers can be used to wrap OsModels, taking car of the trapping for you.

const loginUserController = OsController({
   model : loginUser, // where loginUser is an OsModel
   context : {
      getUserId : //...
   }
});

const tok = loginUserController({username : "lmonninger", password : "notapassword"}); // maybe something different

View

Views are the desired end product of a Model wrapped by a Controller. They may vary tremendously in their implementation. The Makette package itself provides few views.