Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

crawlee-storage-extensions

JJetmar527MIT1.0.11TypeScript support: included

Package for Apify/Crawlee that allows to store encrypted text values into the Storages

web-scraping, apify, crawlee, storage, extensions

readme

Crawlee Storage extensions

Package for Crawlee that brings some extensions to the Storages.

Currently supports:

  • Key-Value Store encryption

Installation

npm install crawlee-storage-extensions

KvStore encryption & decryption example

import { encryptKeyValueStore } from 'crawlee-storage-extensions';
import { KeyValueStore } from 'crawlee';

// Opens Default KvStore
const kvStore = await KeyValueStore.open();

// Secret key is used to encrypt and decrypt the values
const encryptedKvStore = encryptKeyValueStore(kvStore, 'MY_SECRET_KEY');

await encryptedKvStore.setValue('MY_KEY', 'MY_VALUE'); // Stores the value in encrypted form

const encryptedValue = await kvStore.getValue('MY_KEY'); // Loads the value in encrypted form
console.log(encryptedValue); // eyJkYXRhIjoiekRKaEg1VG5HZDRGZFF1aCtDS0VLdz09IiwiaXYiOiJWeVpNUG9VNW81endwOWpGcS9aeE1RPT0ifQ==

const decryptedValue = await encryptedKvStore.getValue('MY_KEY'); // Loads the decrypted value
console.log(decryptedValue); // MY_VALUE

Contribution

New features are added on-the-go as needed, feel free to create pull-request with your own changes.