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

@flatfile/util-response-rejection

v1.6.0

Published

This plugin handles response rejections returned from an external source.

Downloads

4,012

Readme

The @flatfile/util-response-rejection utility is built to handle response rejections from an external source. It is designed to be used as a rejection response handler in an egress listener.

Response Rejection

Usage

The purpose of @flatfile/util-response-rejection utility is to handle cases where some Records were rejected during an egress process. The responseRejectionHandler function is designed to consume a set of sheets containing rejected Records, and then process the rejected Records by marking the offending Record fields with the returned rejection message indicating why they were rejected. If the response value of deleteSubmitted is true, the successfully submitted values will be deleted from the Sheet. If deleteSubmitted is false or not provided, a Submission Status field is added to the Sheet and each Record is set to either "Submitted" or "Rejected". In the end, it returns a total count of all rejected Records across all sheets that can be used in a Job completion message.

npm i @flatfile/util-response-rejection
import {
  responseRejectionHandler,
  RejectionResponse,
} from "@flatfile/util-response-rejection";

Response Rejection Handler Function

  • The responseRejectionHandler function is the main entry point of the utility. It takes one parameter:
    • responseRejection: An object containing the rejection data. This object's structure is defined by the RejectionResponse interface.
  • The responseRejectionHandler function returns a Promise that resolves to a number representing the total number of rejected Records across all sheets.
listener.on(
  "job:ready",
  { job: "workbook:submitActionFg" },
  async ({ context: { jobId } }) => {
    // ...
    const response = await axios.post("https://webhook.site/...", data, {
      headers: {
        "Content-Type": "application/json",
      },
    });

    const rejections: RejectionResponse = response.data.rejections;
    if (rejections) {
      return await responseRejectionHandler(rejections);
    }
    // ...
  }
);

RejectionResponse Interface

The RejectionResponse interface defines the structure of the responseRejection parameter object that is passed into the responseRejectionHandler function. This RejectionResponse's structure is as follows:

{ // RejectionResponse interface
  id: string; // The Workbook ID
  message: "Success! All records are valid.", // Optional
  deleteSubmitted: true, // Optional
  sheets: [
    { // SheetRejections interface
      sheetId: string; // The Sheet ID
      rejectedRecords: [
        { // RecordRejections interface
          id: string; // The Record ID
          values: [
            {
              field: string; // The field key
              message: string;
            }
          ];
        }
        // other rejected records...
      ];
    }
    // other sheets...
  ];
}

The message property is optional. If provided, this message will be displayed to the user. This message should be set for either a successful submission or a rejection submission. The deleteSubmitted property is optional. If true, the successfully submitted values will be deleted from the Sheet. If false or not provided, a Submission Status field is added to the Sheet and each Record is set to either "Submitted" or "Rejected".

Helper Functions

  • The code includes a helper functions to assist in the Flatfile Sheet update process:
    • updateSheet: Updates a Flatfile Sheet by adding the returned rejection messages as error messages on the Records.

Type Definitions

  • The code defines three interfaces: RejectionResponse, SheetRejections and RecordRejections. These interfaces represent the structure expected by the responseRejectionHandler().