@kudobuzz/reviews-schema v2.3.6

Overview

Exposes apis to:

1. Validate any type of review accepted by Kudobuzz. This includes Yelp, Facebook, and Google+ reviews, etc
2. Transform any type of external review to a Kudobuzz review

Installation

npm install @kudobuzz/reviews-schema

Usage

Validating External Reviews

Supported platforms - facebook, google, yelp, etsy

const {validate} = require('@kudobuzz/reviews-schema')

const reviews = validate(transformedReviews)

Transforming Reviews

Supported platforms - facebook

'use strict'

const {transformToKudobuzzReview} = require('@kudobuzz/reviews-schema')

transformToKudobuzzReview(review)

See [Facebook transformer example]('example/transformers/facebook.js') for Facebook post, comment and rating 
transformation example

(WIP) Review Schema

Below is the general schema that external reviews should conform to before they are saved

{ external_id: String, external_parent_id: String, external_link: url external_unique_id:String, thirdparty_account:{ external_id : String, name: String, platform: String, 'facebook', 'twitter', 'instagram', 'yelp', sub_account:{ external_id: String, name: String, handle: String, } }, platform: String // 'facebook', 'instagram', 'twitter', 'kudobuzz', 'google', 'yelp', 'import’ source:String // 'facebook_post', 'facebook_comment', 'facebook_review', 'instagram_post', 'instagram_comment', 'twitter', 'twitter_favourite', 'twitter_mention', 'custom', 'widget', 'apm', 'sharePage', 'yelp', 'google', 'import', title: String, message: String, rating: Number, images: { thumbnail: String, standard: String, original: String }, reviewer: { external_reviewer_id:String, channel: 'email', 'facebook', 'twitter', 'instagram', 'linkedin', 'yahoo', 'google', 'yelp' display_name:String, first_name:String, last_name:String, email:String, profile_url:String, }, created_at_platform: Date, updated_at_platform: Date }

Validation Terms

Facebook post

Facebook comment

facebook review

yelp

google

Etsy

Amazon