The frame's discuss from frame-js

frame's Issues

Bug: initBlueprint called multiple times while queue processes

Add initializing state. Due to the way flows are queued, initBlueprint may be called multiple times even though the blueprint is currently being initialized.

Example:

Called init for Message
Called init for Message
Called init for Message
socket.init config: { host: 'localhost', port: 8082 }
socket.init config: { host: 'localhost', port: 8082 }
socket.init config: { host: 'localhost', port: 8082 }
socket.init config: { host: 'localhost', port: 8082 }
socket.in: something

Code:

'use strict'

const Frame = require('Frame')

// Blueprints
const Message = Frame('Message')
const Console = Frame('Console')
const Socket = Frame('Socket')

// Setup websocket server
const socketConfig = {
  host: 'localhost',
  port: 8082,
}

const socket = Socket(socketConfig)

Message
  .from(socket, 'event')
  .to(Console)

Message
  .from(socket, '!')
  .to(Console)

function addAnother() {
  Message
    .from('something')
    .to(socket, 'another event')
}

addAnother()

Allow multiple blueprints to be initialized using array destructuring

Array destructing allows multiple blueprints to be included with minimal amount of syntax.

const [Mesh, HAM] = Frame(['Mesh', 'HAM'])

And multi-line

const [
  Movie,
  Song,
  HTML,
  React,
] = Frame([
  'Movie',
  'Song',
  'HTML',
  'React',
])

Resources:

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment

Singletons should also be allowed to be instances

Singletons should also be allowed to be instances when it's fitting. Maybe perhaps determined by initializer. For example a Storage adapter may be a singleton for a specific connection/directory, but another singleton for a different directory. This essentially groups flows into singletons deterministically.

Convert ObjectModel Errors to TypeErrors

Enhancement for better TypeError support

Find Creative Commons image/logo for marketing purposes.

If anyone has any suggestions for Creative Commons works of art that would be ideal for Gravatar usage, this issue is open to collaborate on that and other marketing materials.

Bug: Stubbing init somehow ignores ObjectModel schema

Will need to look into why the init function is not being used in the Schema correctly.

Setup:

const Console = Frame('Console')

Testing init:

> Console.init = true
< true
> Console.to(function(){})
Error: Blueprint 'Console' could not initialize.
TypeError: undefined is not a function (near '...blueprint.init.call...')

Testing in:

> Console.in = true
Error: Expecting "in" to be one of "function", got "boolean"

Allow setters to be used for .to and .from methods to allow another alternative syntax.

Example:

// Can be a function
Message.from = function(data, props, cb) {}

// Can be an arrow function
Message.from = (data, _, cb) => cb()

// Can be a Blueprint module
Message.from = Slack

// Can be a primitive value
Message.from = 'Something'

Allow blueprints to be a function.

Allowing blueprints to export themselves as a single function decreases the friction of development.

Use case:

Blueprint = function(...) {
}

Internally:

if (typeof Blueprint === 'function')
  Blueprint = { name: Blueprint.name,  in: Blueprint }

Support nested describe objects.

Example:

  describe: {
    init: {
      config: {
        port: 'Listen Port'
      },
    },
  },

Destructure properties

Using descriptions via the describe syntax on a Blueprint object, hands off parameter destructuring over to Frame for validating proper inputs and types.

Proposal (subject to change; and likely will to be the most flexible but easy to discern):

Blueprint = {
  ...

  describe: {
    init: {
      'Optional Message Format': 'The message format will transform messages of one type to another for blueprint intercompatibility.'
    },

    accepts: 'Any', // Something like IMDB: accepts: [Movie, Show, Actor]

    in: {
      'Message': 'Any',
    },

    out: {
      'Message': 'Any',
    },
  },
}

API Proposal for Iterables. This let's streaming API be used in `for ... of` syntaxes.

Example:

let users = Gun.from(“users”).iterate
for (let user of users) {
   // Do something with user
}

ObjectModel refactor

Overview Progress:

Add additional ObjectModel types
Get rid of unnecessary looping for left-over schema
De-duplicate code by using a protect() function
Restructure code so it is easier to read and maintain
Convert ObjectModel Errors to TypeErrors
Detect getter/setters and copy them appropriately

Add additional ObjectModel types:

Improve ObjectModel with new types

Example:

{
  user: String, // Required
  age: ObjectModel.Optional, // Optional

  gravatar: [Image, Element], // oneOf
}

Added types would be:

Appropriate Error catching

Add blueprint.Frame.canCatch so we can determine whether an appropriate error path is available. Otherwise throw to main application. In addition, add .catch() API for all potential errors without error propagation handlers.

Progress:

blueprint.Frame.canCatch
.catch() API
.or() API

Test issue for Gitter integration

Allow Frame to return final flow result as value

A value getter which resolves a Promise when last flow is complete. Great for one-off flows that aren't meant to be continuous.

Example:

let message = await Movie.from(IMDB).to(ShowTimes).value
console.log(message)

frame-js / frame Goto Github PK

frame's Issues

Recommend Projects

Recommend Topics

Recommend Org

Jobs