@consent.software/webclient

The browser client for consent.software: it stores a visitor's accepted cookie levels in IndexedDB and runs the consent tuples configured for a domain. It is the client behind the consentsoftware-cookieconsent element of @consent.software/catalog, and works in any web project, with or without a framework.

Issue Reporting and Security

For reporting bugs, issues, or security vulnerabilities, please visit community.foss.global/. This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a code.foss.global/ account to submit Pull Requests directly.

Install

pnpm add @consent.software/webclient

Usage

import { CsWebclient } from '@consent.software/webclient';

const csWebclient = new CsWebclient();

// after the visitor made a choice
await csWebclient.setCookieLevels(['functional', 'analytics']);

// on later page loads
if (await csWebclient.isCookieLevelStillValid()) {
  await csWebclient.getAndRunConsentTuples();
}

API

CsWebclient keeps its state in a @push.rocks/webstore WebStore (IndexedDB) with the database name consentsoftware and the store name webclient, under the key acceptedCookieLevels. The stored record is an IWebclientSettings from @consent.software/interfaces: { acceptanceTimestamp: number; acceptedCookieLevels: TCookieLevel[] }, where TCookieLevel is 'functional' | 'analytics' | 'marketing' | 'all'.

| Method | Description | |---|---| | setCookieLevels(cookieLevelsArg: TCookieLevel[]): Promise<boolean> | Stores the accepted levels with the current time as acceptanceTimestamp; resolves true. | | getCookieLevels(): Promise<TCookieLevel[]> | Resolves the stored levels, or undefined when no choice is stored. | | isCookieLevelSet(): Promise<boolean> | Resolves whether a choice is stored. | | isCookieLevelStillValid(): Promise<boolean> | Resolves true when a choice is stored and was made within the last three months (getMilliSecondsFromUnits({ months: 3 }) from @push.rocks/smarttime); false otherwise, including when nothing is stored. | | getAndRunConsentTuples(domainArg?: string): Promise<void> | Fetches the domain settings for domainArg (default window.location.hostname) with a getDomainSettings typed request to https://connect.api.global/consentsoftware, then runs every consent tuple whose level is functional or one of the accepted levels, passing it its scriptExecutionDataArg and the accepted levels. Logs and returns without a request when no choice is stored; throws when a tuple script is not a function. |

The webstore property exposes the underlying WebStore, for example to close() it.

License and Legal Information

This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the license file.

Please note: The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.

Trademarks

This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.

Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.

Company Information

Task Venture Capital GmbH
Registered at District Court Bremen HRB 35230 HB, Germany

For any legal inquiries or further information, please contact us via email at [email protected].

By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.