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

@gooddata/mock-js

v2.24.14

Published

Mock server for GoodData UI applications (Analytical Designer and Dashboards).

Downloads

1,572

Readme

mock-js

Mock server for GoodData UI applications (Analytical Designer and Dashboards).

How to use:

Install mock-js from private repository:

yarn add --dev @gooddata/mock-js

Create your mock-schema.json file:

// mock-schema.json
{
    "project": {
        "title": "My mocked project"
    },
    "groups": [{
        "attributes": [{
            "title": "Account",
            "elements": ["1", "2", "3"]
        }],
        "dateDataSets": [{
            "title": "Activity"
        }, {
            "title": "Opportunity"
        }, {
            "title": "Closed"
        }],
        "metrics": [{
            "title": "# Won"
        }, {
            "title": "# Closed"
        }],
    }, {
        "meta": {
            "type": "csv",
            "identifier": "dataset.1"
        },
        "attributes": [{
            "title": "Attribute A"
        }, {
            "title": "Attribute B"
        }],
        "metrics": [{
            "title": "Metric A"
        }, {
            "title": "Metric B"
        }]
    }],
    // if execution request matches (ignoring localIdentifiers) it responds with saved executionResult
    "afmExecutions": [
        {
            "execution": { ...executeAfmRequestBody },
            "executionResult": { ...executionResultResponseBody }
        }
    ]
}

The execution request, response and result obtained from production or staging server can be converted to mocked afmExecutions record of mock.setup.js schema via web based tool hosted at /mock-builder endpoint. Apart from the execution request, response and result the mocked project ID and index of the mock.setup.js's ISchemaGroup group index must be entered. The project information is used to choose the mock project and one of its groups of measures and attributes that will be used to replace staging measure and attributes URIs in the execution for the mocked ones.

Register mock-js middleware:

// server.js
const register = require('@gooddata/mock-js');
const schema = require('./mock-schema.json');

const config = {
    pollCount: 1
};
module.exports = {
    createMiddleware: function createMiddleware(webpackConfig, webpackOptions) {
        return (app) => {
            return register.default(app, { schema, config });
        };
    }
};

Development

Development

Install Node.js and Yarn

Project setup

yarn install --frozen-lockfile

Building project (with watch)

yarn dev

Deployment

Package publishing is done via Jenkins Job:

https://checklist.intgdc.com/job/client-libs/job/mock-js-release/

Running test suite:

yarn test

Running tslint

yarn validate

Source code formatting

The source code in the repository is formatted by Prettier. The format of the code is validated by our Continuous Integration server and is one of the requirements of successful merge.

Prettier is supported by every major IDE. You can find the list of supported editors and how to configure them here.

In the case, when your editor is not supported or you don't want to setup the integration, you can run the yarn prettier-write command to reformat the code before commit.