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

@fraym/migrations

v0.8.0

Published

nodejs client implementation for our migrations service

Downloads

248

Readme

migrations-nodejs

Client implementation in javascript for the migrations service.

Installation

npm i @fraym/migrations

CLI command

Use the migrations cli command to automatically apply all your Fraym schemas to the corresponding Fraym service.

Your type schemas have to match the glob you specify in the MIGRATIONS_SCHEMA_GLOB env variable (default: ./src/**/*.graphql).

API: You can specify the address (and port) of the migrations service instance you use in the MIGRATIONS_SERVER_ADDRESS env variable (default: ://127.0.0.1), to use secure connections (https / wss) set MIGRATIONS_SECURE to true. You will also need to set the MIGRATIONS_API_TOKEN variable. The value of that token has to match the token configured in the migrations service.

Use the MIGRATIONS_NAMESPACE env variable to restrict all migrations to your namespace. This is useful if multiple apps share the Fraym services. Note: You cannot name your type or namespace by a Fraym prefix. This is a reserved prefix for Fraym apps.

You need to add a file that contains all built-in directives to your type schemas. The latest version of this file can be found here.

Best is to start with a structure like the one presented in our example directory.

Config

Use a .env file or env variables to configure the command:

MIGRATIONS_SERVER_ADDRESS=http://127.0.0.1
MIGRATIONS_API_TOKEN=change-me
MIGRATIONS_SCHEMA_GLOB=./**/*.graphql
MIGRATIONS_NAMESPACE=

Env variable placeholders in migrations

You can use placeholders that match environment variables in argument strings in your schema definitions:

In the following example the {{env.BACKEND_HOSTNAME}} part will be replaced by the value of the BACKEND_HOSTNAME environment variable. Please add your used env variables to the .env file that is used to configure the migration command.

type TestType {
    value: String
        @webhook(
            url: "http://{{env.BACKEND_HOSTNAME}}/event-organizing/contingent/projections/frontend/contingent-management/webhook"
            method: "GET"
            header: [{ key: "Content-Type", value: "'application/json'" }]
            body: [
                { key: "metadata", value: "metadata" }
                { key: "payload", value: "payload" }
                { key: "projection", value: "projection" }
            ]
        )
}

Transformations

  • If a crud type is renamed the transformation has to refer to the last used name, not to the new one