npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@artmuseo/topimaton

v0.1.8

Published

The Artmuseo Web Primitives design package.

Downloads

160

Readme

topimaton

Topimaton is an opinionated framework for designing RPCs. Developed at Artmuseo to promote a specific set of RPC design patterns and the automatic generation of their clients, it is NOT an alternative to IDL-based cross-language frameworks such as gRPC and Thrift.

STOP 🛑

Before using this software, consider the following.

Topimaton is...

:white_check_mark: An opinionated framework for RPC development.

:white_check_mark: An experimental solution to the last mile problem in RPC development.

:white_check_mark: A tool for extending the patterns of @artmuseo/makette to services.

:white_check_mark: A semantically empowered service definition framework.

Topimaton is NOT...

:x: An alternative to Interface Definition Language frameworks such as gRPC and Thrifty. In fact, Artmuseo uses gRPC internally for the layers immediately below our Topimaton target.

:x: A production-ready tool for RPC development. Though Artmuseo uses Topimaton for its application, we do not endorse its usage in production externally.

:x: A sure fire means to improve RPC performance.

You should consider using Topimaton if...

:white_check_mark: You do not want to use gRPC and Envoy to provide the last mile connection between your RPC services and your web application.

:white_check_mark: You want to write service definitions in the language in which they are implemented. (Or, not write them at all!)

:white_check_mark: You like the RPC design principles Topimaton enshrines.

:white_check_mark: You have been using @artmuseo/makette.

:white_check_mark: You want to experiment with the benefits of Topimaton's semantic system.

Quick Start

In version 0.x.x, Topimaton only supports Typescript.

Install

yarn add @artmuseo/topimaton

Implement

import { makette } from @artmuseo/makette;
import { topimaton } from @artmuseo/topimaton;

// create the add body
const add = async (args : {a : number, b : number}, c : any)=>{
    return args.a + args.b;
};

// create a model around the add body
const addModel =makette.method.models.Model({
    body : add,
    defaultContext : {}
});

// create a controller around the add model
const addController = topimaton.methods.controllers.ServerController({
    model : addModel
});

// create the view
const addView = topimaton.methods.views.ServerView({
    controller : addController
});

const arithTopic = topimaton.topics.Topic({
    views : {
        add : addView
    }
});

const mathGenre = topimaton.genres.Genre({
    topics : {
        arith : arithTopic
    }
});

const mathMachine = topimaton.topimata.Topimaton({
    genres : {
        math  : mathGenre
    }
});

Serve

const app = topimaton.methods.views.TopimatonServer(mathMachine);
await new Promise((resolve)=>app.listen(8080, ()=>resolve(true)));

Generate

const mathMachineClient = topimaton.clients.Client(mathMachine);
const res = await mathMachineClient.math.arith.add({ a : 2, b : 2 }); // 4

Translate

import { topimatonStone } from "@artmuseo/topimaton-stone";

// write a Swift package
topimatonStone.swift.packageSwift(mathMachine);

v1.x.x Roadmap

Support ProtoBuf

Protocol Buffers are used by gRPC to reduce message size and increase serialization and deserialization speed. Topimaton will seek to add ProtoBuf tranfers as an additional optional way to get objects from the server.

Support CapnProto

CapnProto can outperform Protocol Buffers due to removing encoding and decoding steps in the data interchange process. Topimaton will seek to add CapnProto as its preferred high-performance binary communication protocol.

Support Python Topimata

Topimaton services currently can only be defined in Typescript. We will seek to add support for building them in Python as well.

Additional Translation for @artmuseo/topimaton-stone

Currently, @artmuseo/topimaton-stone supports translation from TypeScript to...

  • Swift
  • Kotlin

We will additional seek to add translation from TypeScript to...

  • Python

And, tranlsation from Python to...

  • TypeScript
  • Swift
  • Kotlin

Smart RPC and SDK Generation

Topimaton Stone's semantic engine will enable the experimental automatic generation of SDKs from Topimata. These SDKs will be layered on top of the generated clients provided suggested optimal means to perform common tasks which are predicted from the structure of the RPC.