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

vineanova-redux-artifacts

v1.119.113

Published

## Overview

Downloads

737

Readme

VineaOpenApiReduxArtifacts

Overview

VineaOpenApiReduxArtifacts is a powerful npm library designed to simplify the integration of Swagger APIs into Redux architecture. By leveraging templates (Mustache files), this library automatically generates Redux ducks, actions, sagas, selectors, and API clients, eliminating the need for repetitive boilerplate code for each API request. This streamlined approach enhances code readability and accelerates development for New Zealand's vineyard and livestock industries.

Example Usage

import {
  VineaNovaActions,
  VineaNovaSelectors,
} from 'vineanova-redux-artifacts';

dispatchAPI(
  VineaNovaActions.api.v1.cropBlockVintage.get.request({
    queryParams: {
      VineyardBlockID: 11111,
      VintageID: 1111,
    },
  }),
);

Generated Ducks Actions

const ducksActions = createActions({
  api: {
    v1: {
      cropBlockVintage: {
        get: {
          // ... (generated actions for GET request)
        },
        post: {
          // ... (generated actions for POST request)
        },
        put: {
          // ... (generated actions for PUT request)
        },
        delete: {
          // ... (generated actions for DELETE request)
        },
      },
    },
  },
});

Generated Saga

export function* getCropBlockVintageSagas(action) {
  const {
    payload = {},
    meta: { reducerName },
  } = action;
  try {
    yield put({
      type: "FETCHING",
      name: reducerName,
    });

    const response = yield call(APIServices.getCropBlockVintage, payload);    
    yield put({
      type: "SUCCESS",
      payload: response,
      name: reducerName,
    });

    const CropBlockVintageSchema = new schema.Entity("byId");
    const CropBlockVintageListSchema = new schema.Array(CropBlockVintageSchema);
    const {entities: {byId}, result: allIds} = normalize(response, CropBlockVintageListSchema);
    yield put({
      type: "MERGE_ALL_IDS",
      payload: {byId, allIds},
      name: reducerName,
    });
    
  } catch (err) {
    logger.error(err);
    /* istanbul ignore next */
    yield put({
      type: "ERROR",
      payload: err,
      name: reducerName,
    });
  }
}

Example Usage Selector

import {
  VineaNovaActions,
  VineaNovaSelectors,
} from 'vineanova-redux-artifacts';

const cropBlockVintageEntityData = useSelector(
  VineaNovaSelectors.getCropBlockVintageEntityData,
);

Generated API Client Used by Sagas

export const getCropBlockVintage = async (payload) => {
  try {
    const { queryParams, postBody, options } = payload || {};
    let apiUrl = '/CropBlockVintage';
    const response = await serviceConfig.request({
      url: apiUrl,
      method: 'get',
      params: {
        ...queryParams,
      },
      headers: {
        'Content-Type': 'application/json',
        Accept: 'application/json',
      },
      ...options,
    });
    return response;
  } catch (err) {
    logger.error(err);
    throw err;
  }
};

Environment Variables

Ensure the following environment variables are set for proper library functionality:

  • SWAGGER_URL: The base URL for the Swagger API.
  • CODE: A code parameter for authenticating the Swagger API.

Installation

To install VineaOpenApiReduxArtifacts, simply run:

npm install vineanova-redux-artifacts

Get Started

There is no documentation , but download the generated code, navigate thru the generated code. These are simple functions and easy to navigate through.

To learn more about integrating this library into your project.Feel free to reach out to our support team at [email protected] for any assistance or inquiries.

Happy coding!