@condenast/cna-st-codec
TypeScript icon, indicating that this package has built-in type declarations

0.1.9 • Public • Published

@condenast/cna-st-codec

Standalone library to service all cna.st encoding requests. Below are the services provided by the library:

  • Encode affilate links
  • Encode product embeds
  • Decode affiliate links

Installation

    npm install @condenast/cna-st-codec

Usage

Documentation: Click here

Input params

Query Parameter Type Required Example Description
origin string yes 60d5a8e87a19ee043b25fb5b Origin of this link (ex: Copilot page id, newsletter id, etc)
locale string no UK Used for localised links.
brand string yes 4gKgcF5Myw5MXdcFAvDQL5L1iAGH Id of the source’s brand
channel string no newsletter, website, instagram The channel where the click originated
campaign string no summersale Custom Campaign parameter
product string no 30d5a8eKa919ee043b25fP9IK ID of product
component string no PLP-Carousel_4 Name to identify which component is generating revenue (including the position)
bucket string no Br1639018827824exx A+B test cell bucket ID
actionId string no 123456 Unique ID to reference a click back to a conversion with GA
offerUrl string yes Retailer product/offer URL
referrer string no Origin URL where click happened
source string no verso source name eg: verso, amp

To generate encoded text

const cnaStCodec = require('@condenast/cna-st-codec');

const params = {
    brand: "4gKgcEs3YBmxYhgNxdHg8VnbgTnc",
    offerUrl: "http://www.amazon.com/",
    origin: "60d5a8e87a19ee043b25fb5b"
};

let encodedText = cnaStCodec.encodeAffiliateParams(params);
console.log(encodedText);

// Output: 4jjCSCMwBgMHssUvJ6jQbjEfYZMoqQmMUyrkXyfPygqXC4jXjS8nfaa7CwiuVicTz35jocCjuWUSzdvRi6RpqSkKB7ybSrg4KShpeGTbBdLesvvhbgo

To update existing params or add new value to an encoded text

const cnaStCodec = require('@condenast/cna-st-codec');

let encodedText = "4jjCSCMwBgMHssUvJ6jQbjEfYZMoqQmMUyrkXyfPygqXC4jXjS8nfaa7CwiuVicTz35jocCjuWUSzdvRi6RpqSkKB7ybSrg4KShpeGTbBdLesvvhbgo";
const params = {
    offerUrl: "http://go.skimlinks.com/",
    campaign: "test"
};

encodedText = cnaStCodec.encodeAffiliateParams(encodedText, params);
console.log(encodedText);

// Output: RTBwSQLjveX2mJoa9QBGwjuqBsCuZwtP3mdimfraBSaLWCnYkwWyZL85Nvj1ML5qYfokBdnhojbDXLW4mWjBPvotMHwFYNCg4YLYAaSRCYB4eaT79vayNPto

To decode the encoded text

const cnaStCodec = require('@condenast/cna-st-codec');

let encodedText = "4jjCSCMwBgMHssUvJ6jQbjEfYZMoqQmMUyrkXyfPygqXC4jXjS8nfaa7CwiuVicTz35jocCjuWUSzdvRi6RpqSkKB7ybSrg4KShpeGTbBdLesvvhbgo";
let decoded = cnaStCodec.decodeAffiliateParams(encodedText);
console.log(decoded);

// Output: {
//   referrer: '',
//   actionId: '',
//   bucket: '',
//   component: '',
//   campaign: 'test',
//   channel: '',
//   locale: '',
//   origin: '60d5a8e87a19ee043b25fb5b',
//   product: '',
//   offerUrl: 'https://go.skimlinks.com',
//   brand: '4gKgcEs3YBmxYhgNxdHg8VnbgTnc'
// }

Readme

Keywords

none

Package Sidebar

Install

npm i @condenast/cna-st-codec

Weekly Downloads

1,915

Version

0.1.9

License

ISC

Unpacked Size

17.3 kB

Total Files

6

Last publish

Collaborators

  • deepak_mohan
  • gshankar-in
  • pradeep_nayak
  • yarramanohar
  • somsekhardash
  • sabarni-condenast
  • dev-anand-94
  • anubalakrishnan
  • naveen1601
  • ganavi_j
  • sheetalparsa
  • vishnusimvisfear
  • vgoel
  • zeeshan-wani
  • vinayashreeram
  • mitchellstewart
  • nhrqz
  • ronjr_owlbear
  • snehak
  • raveena-ram
  • ankitkumar02
  • swati_verso
  • noman-cn
  • saahithisri
  • prasil1107
  • aditijhacn
  • imran-conde
  • saniyashk
  • mithunsathyanmits
  • sanjana_s
  • jyoti_3009
  • rajashreearvikar19
  • mala-shanbhag
  • ac432
  • ssingh417
  • nvillato
  • ricardofbarros
  • vmehrotr
  • speluri
  • jakir-coder
  • pranjal_sharma306500
  • tdscondenast
  • omsun22
  • midhunmurali001
  • saicharan7766
  • surabhidesai
  • suhitrathi-condenast
  • dkorenblyum
  • bbui
  • tejasvi-bg
  • vnallasa
  • vikas-sc
  • skumar7
  • cyrilpanicker-condenast
  • boygao1992
  • saikat_conde
  • imleodc
  • jasonmarlin
  • arunconde
  • roberlander
  • nprabhu-cn
  • juliendevlin
  • unviradiya
  • vinitha_thiagarajan
  • areadman
  • samruddhidube24
  • gapurdev
  • akshayjain10
  • utkarsh24
  • suma_k
  • piyush_das
  • cnmanju
  • cn-rahul-tiwari
  • dhanashri027
  • bharathikarunanithi
  • cn_priyanka14
  • prashant_singhparihar
  • m-mallikarjuna
  • smantriconde
  • machelslackatcondenast
  • karthik_cn
  • muthuprakashvelumani
  • issanjana
  • a-rena
  • colin-alexa
  • ramkun
  • namansingh_bhandari
  • cnarkhede
  • hebsibal_selvaraj
  • akeshavamurthy
  • priyanka_jha
  • klnarayanan
  • spoorthi.chandrashekar
  • erikveland
  • asinghconde
  • eunianina
  • raxs
  • vivekans
  • conde_jode
  • jordi.escude
  • nnasirov
  • unnatik
  • psundar
  • arhovale
  • rashmicn
  • siddhu-23
  • atp-engineering
  • danj-cn
  • maila-labib
  • anilc93
  • lavishgambhir
  • ksriniva2
  • andregcab
  • tchathur
  • kangkanbora
  • vinay-pr
  • josephrussell-cn
  • anaedzm
  • cn-connorbrannigan
  • prajwal_keshav
  • babincondenast
  • edistel
  • balar20
  • cn_jenkins
  • frandevinney
  • renovate
  • condenastadmin
  • copilot-robot
  • fennen529
  • fmadrie
  • gmedina
  • bigzed
  • biku
  • joshcondenast
  • rashmi-rao
  • imakshath
  • nishkalaadiga
  • niharanil
  • katiasfihivogue
  • alokreddycn
  • prakashn37
  • andi.anderson522
  • davidkofahl
  • tollmanz
  • amalamchtal
  • tdshap
  • sayeedcn
  • pitchfork-dev
  • danhaller
  • rajasinghcondenast
  • derrickatcn
  • tce
  • cnid_engineering
  • lilyhealey
  • prajaktak
  • manthanbhosle
  • psharma2
  • bhumikakhatri
  • igostu
  • cwoldt
  • mtzhang
  • manthanraut
  • drosenbaum
  • aswani_gupta
  • garryyao
  • yakshita
  • kalyanikasar
  • shreyapa
  • natelawscn
  • leahzxxz
  • katemont
  • eddleston
  • rtt
  • eshno
  • anwaukoni
  • eduardoveras
  • mrgentax
  • cl4m
  • spollini
  • fedeava
  • guidop91
  • nithya10
  • abigaild45
  • mb_dev
  • emilyatk
  • luis_gomez
  • karmenn
  • khiaraortiz
  • dmitriy_komarov-cn
  • jmcamacho
  • ishita_tiwari
  • hariprasath_cn
  • iamsuneeth
  • srikanthns
  • pushp-1992
  • sudiptacondenast
  • utkarsh_sanjivan-conde
  • mallica
  • shobith
  • agururajan
  • upenpanging
  • rjain198
  • ashwini_uppar
  • pmasade
  • jbergdol
  • suresharam
  • dhanraj_cn
  • pratik-gupta
  • ilankumaran
  • samtiffin
  • adityaanand534
  • chandan-condenast
  • vijayalakshmi-sunagar
  • namankumarsinha
  • sumitmaurya21
  • pashoka
  • nidhiarya-condenast
  • smita2022
  • ankushvijay93
  • likhita
  • priyankanandi
  • soumyagundu
  • cnrahulrkr
  • ramya-cn
  • dikshita_khandke
  • ambay_chaurasia
  • manikandancn
  • rghvndr99
  • mulla2