Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New view state: PrivacyPolicyNoticeWithCloseButton #126

Merged
merged 2 commits into from
Jan 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"**/.pnp.*": true
},
"editor.codeActionsOnSave": {
"source.fixAll": true
"source.fixAll": "explicit"
},
"cSpell.words": [
"airgap",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"author": "Transcend Inc.",
"name": "@transcend-io/airgap.js-types",
"description": "TypeScript types for airgap.js interoperability with custom consent UIs",
"version": "10.11.3",
"version": "10.12.0",
"homepage": "https://github.com/transcend-io/airgap.js-types",
"repository": {
"type": "git",
Expand Down
49 changes: 27 additions & 22 deletions src/enums/viewState.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,45 +5,50 @@ import { makeEnum } from '@transcend-io/type-utils';
* Consent Manager view state for the Interactive Advertising Bureau
*/
export const IABViewState = makeEnum({
/* Transparency and Consent Framework for Europe */
/** Transparency and Consent Framework for Europe */
TCF_EU: 'TCF_EU',
});

/**
* View States for Transcend's Consent Manager UI
*/
export const InitialTranscendViewState = makeEnum({
/* expanded and showing quick select options */
/** expanded and showing quick select options */
QuickOptions: 'QuickOptions',
/* three option UI: essential, functional/analytics, advertising */
/** three option UI: essential, functional/analytics, advertising */
QuickOptions3: 'QuickOptions3',
/* accept all button call to action, with more options in the banner footer */
/** accept all button call to action, with more options in the banner footer */
AcceptAll: 'AcceptAll',
/* toggle button that toggles on or off all active purposes in the current regime */
/** toggle button that toggles on or off all active purposes in the current regime */
AcceptAllRejectAllToggle: 'AcceptAllRejectAllToggle',
/* accept all or more options, both as calls to action */
/** accept all or more options, both as calls to action */
AcceptAllOrMoreChoices: 'AcceptAllOrMoreChoices',
/* accept all or reject all */
/** accept all or reject all */
AcceptOrRejectAll: 'AcceptOrRejectAll',
/* accept all or reject all or more options */
/** accept all or reject all or more options */
AcceptOrRejectAllOrMoreChoices: 'AcceptOrRejectAllOrMoreChoices',
/* accept or reject the Analytics script tag */
/** accept or reject the Analytics script tag */
AcceptOrRejectAnalytics: 'AcceptOrRejectAnalytics',
/* accept or reject the Advertising script tag */
/** accept or reject the Advertising script tag */
AcceptOrRejectAdvertising: 'AcceptOrRejectAdvertising',
/* data collection notice with do not sell */
/** data collection notice with do not sell */
NoticeAndDoNotSell: 'NoticeAndDoNotSell',
/* open a modal that allows for an explanation of do not sell/share, before opting out */
/** open a modal that allows for an explanation of do not sell/share, before opting out */
DoNotSellExplainer: 'DoNotSellExplainer',
/* open a modal that allows for complete options toggling */
/** open a modal that allows for complete options toggling */
CompleteOptionsToggles: 'CompleteOptionsToggles',
/* open a modal that shows a notice that the privacy policy has changed, without any prompt to change consent */
/** open a modal that shows a notice that the privacy policy has changed, without any prompt to change consent */
PrivacyPolicyNotice: 'PrivacyPolicyNotice',
/* expanded and showing full checkbox options */
/**
* open a modal that shows a notice that the privacy policy has changed, without any prompt to change consent
* and no button to close the modal. instead there is an X in the top right corner of the modal
*/
PrivacyPolicyNoticeWithCloseButton: 'PrivacyPolicyNoticeWithCloseButton',
/** expanded and showing full checkbox options */
CompleteOptions: 'CompleteOptions',
/* complete options, but selecting a checkbox means the user is opted out */
/** complete options, but selecting a checkbox means the user is opted out */
CompleteOptionsInverted: 'CompleteOptionsInverted',
/* hidden */
/** hidden */
Hidden: 'Hidden',
});

Expand Down Expand Up @@ -73,9 +78,9 @@ export type InitialViewState =
* View states that are displayed in response to a user request (e.g. transcend.doNotSell() or )
*/
export const ResponseViewState = makeEnum({
/* notice that do not sell has been acknowledged properly */
/** notice that do not sell has been acknowledged properly */
DoNotSellDisclosure: 'DoNotSellDisclosure',
/* notice of a 1 click opt out for multiple consent purposes */
/** notice of a 1 click opt out for multiple consent purposes */
OptOutDisclosure: 'OptOutDisclosure',
});

Expand All @@ -89,7 +94,7 @@ export type ResponseViewState =
* Consent Manager view states that can be navigated to after initial view state
*/
export const DeepViewState = makeEnum({
/* language options */
/** language options */
LanguageOptions: 'LanguageOptions',
});

Expand All @@ -102,9 +107,9 @@ export type DeepViewState = typeof DeepViewState[keyof typeof DeepViewState];
* Consent Manager view states after it's been dismissed
*/
export const DismissedViewState = makeEnum({
/* showing and collapsed */
/** showing and collapsed */
Collapsed: 'Collapsed',
/* closed */
/** closed */
Closed: 'Closed',
});

Expand Down
Loading