diff --git a/README.md b/README.md index e43a4fc..1177e6b 100644 --- a/README.md +++ b/README.md @@ -38,12 +38,12 @@ yarn test ## Packages -- `cb-cookie-manager`: Package that helps with managing first party client side cookies to adhere to CCPA and GDPR Cookie regulations. More information [here](./packages/cb-cookie-manager/README.md) +- `@coinbase/cookie-manager`: Package that helps with managing first party client side cookies to adhere to CCPA and GDPR Cookie regulations. More information [here](./packages/cookie-manager/README.md) -- `cb-cookie-banner`: Banner and modal to allow users to choose their cookie preferences. - More information [here](./packages/cb-cookie-banner/README.md) +- `@coinbase/cookie-banner`: Banner and modal to allow users to choose their cookie preferences. + More information [here](./packages/cookie-banner/README.md) -- `example`: Example app built using NextJS which uses both `cb-cookie-manager` and `cb-cookie-banner`. Code [here](./apps/example/) +- `example`: Example app built using NextJS which uses both `@coinbase/cookie-manager` and `@coinbase/cookie-banner`. Code [here](./apps/example/) ## Contributing diff --git a/apps/example/README.md b/apps/example/README.md index da7e70b..54c8e77 100644 --- a/apps/example/README.md +++ b/apps/example/README.md @@ -1,6 +1,6 @@ # Example -This is an example [Next.js](https://nextjs.org/) project which uses both `cb-cookie-banner` and `cb-cookie-manager` +This is an example [Next.js](https://nextjs.org/) project which uses both `@coinbase/cookie-banner` and `@coinbase/cookie-manager` ## Getting Started diff --git a/apps/example/hooks/useTranslations.ts b/apps/example/hooks/useTranslations.ts index 6682d12..bac1295 100644 --- a/apps/example/hooks/useTranslations.ts +++ b/apps/example/hooks/useTranslations.ts @@ -1,4 +1,4 @@ -import { useTrackingManager } from 'cb-cookie-manager'; +import { useTrackingManager } from '@coinbase/cookie-manager'; import { useCallback, useEffect, useRef, useState } from 'react'; type TranslationsType = Record; diff --git a/apps/example/package.json b/apps/example/package.json index f53b9cf..196ada9 100644 --- a/apps/example/package.json +++ b/apps/example/package.json @@ -11,8 +11,8 @@ "test": "jest --passWithNoTests" }, "dependencies": { - "cb-cookie-banner": "1.0.0", - "cb-cookie-manager": "1.0.0", + "@coinbase/cookie-banner": "1.0.0", + "@coinbase/cookie-manager": "1.0.0", "next": "14.0.0", "react": "^18", "react-dom": "^18" diff --git a/apps/example/pages/_app.tsx b/apps/example/pages/_app.tsx index 9ab40f0..77c3edc 100644 --- a/apps/example/pages/_app.tsx +++ b/apps/example/pages/_app.tsx @@ -1,7 +1,7 @@ 'use client'; import '@/styles/globals.css'; -import { Provider, Region, TrackingCategory, TrackingPreference } from 'cb-cookie-manager'; +import { Provider, Region, TrackingCategory, TrackingPreference } from '@coinbase/cookie-manager'; import type { AppProps } from 'next/app'; import { useCallback, useEffect, useRef, useState } from 'react'; diff --git a/apps/example/pages/index.tsx b/apps/example/pages/index.tsx index 20946f4..beacb59 100644 --- a/apps/example/pages/index.tsx +++ b/apps/example/pages/index.tsx @@ -1,4 +1,4 @@ -import { CookieBanner } from 'cb-cookie-banner'; +import { CookieBanner } from '@coinbase/cookie-banner'; import { Inter } from 'next/font/google'; import useTranslations from '@/hooks/useTranslations'; diff --git a/apps/example/utils/cookieManagerConfig.ts b/apps/example/utils/cookieManagerConfig.ts index fa53ca6..f96f976 100644 --- a/apps/example/utils/cookieManagerConfig.ts +++ b/apps/example/utils/cookieManagerConfig.ts @@ -1,4 +1,4 @@ -import { Framework, Region, TrackerType, TrackingCategory } from 'cb-cookie-manager'; +import { Framework, Region, TrackerType, TrackingCategory } from '@coinbase/cookie-manager'; export const cookieManagerConfig = { categories: [ diff --git a/package.json b/package.json index 1d852a3..4fb2e25 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "@coinbase/cookie-manager", + "name": "cb-cookie-manager", "version": "1.0.0", "description": "Cookie Manager", "author": "Sneh Koul ", @@ -11,8 +11,7 @@ "test": "yarn workspaces run test" }, "workspaces": [ - "packages/cb-cookie-manager", - "packages/cb-cookie-banner", + "packages/*", "apps/example" ], "devDependencies": { diff --git a/packages/cb-cookie-banner/.eslintignore b/packages/cookie-banner/.eslintignore similarity index 100% rename from packages/cb-cookie-banner/.eslintignore rename to packages/cookie-banner/.eslintignore diff --git a/packages/cb-cookie-banner/LICENSE.md b/packages/cookie-banner/LICENSE.md similarity index 100% rename from packages/cb-cookie-banner/LICENSE.md rename to packages/cookie-banner/LICENSE.md diff --git a/packages/cb-cookie-banner/README.md b/packages/cookie-banner/README.md similarity index 92% rename from packages/cb-cookie-banner/README.md rename to packages/cookie-banner/README.md index c15f5e1..67bb160 100644 --- a/packages/cb-cookie-banner/README.md +++ b/packages/cookie-banner/README.md @@ -20,18 +20,18 @@ Install the package as follows: **Note: This package requires react and react-dom as peer dependencies** ```shell -yarn add cb-cookie-manager cb-cookie-banner +yarn add @coinbase/cookie-manager @coinbase/cookie-banner -npm install cb-cookie-manager cb-cookie-banner +npm install @coinbase/cookie-manager @coinbase/cookie-banner -pnpm install cb-cookie-manager cb-cookie-banner +pnpm install @coinbase/cookie-manager @coinbase/cookie-banner ``` ## UI ### Cookie Banner -This banner must be a child of `cb-cookie-manager` provider. It takes an optional theme prop (see [theme section](#theme)). Otherwise, it will default to the Coinbase theme. +This banner must be a child of `@coinbase/cookie-manager` provider. It takes an optional theme prop (see [theme section](#theme)). Otherwise, it will default to the Coinbase theme. It takes the following props: @@ -41,7 +41,7 @@ It takes the following props: Example usage: ```typescript -import { CookieBanner } from 'cb-cookie-banner'; +import { CookieBanner } from '@coinbase/cookie-banner'; const SomeComponent = () => { return ( @@ -57,7 +57,7 @@ const SomeComponent = () => { Modal to allow user's to choose their cookie preferences. -This modal must be a child of `cb-cookie-manager` Provider. It takes the following props: +This modal must be a child of `@coinbase/cookie-manager` Provider. It takes the following props: ```typescript onClose: () => void: Callback to close the modal @@ -71,7 +71,7 @@ Usage: ```typescript -import { CookiePreferencesModal } from 'cb-cookie-banner'; +import { CookiePreferencesModal } from '@coinbase/cookie-banner'; const CookiePreferences = () => { const [isOpen, setIsOpen] = useState(false); @@ -102,7 +102,7 @@ It is used to determine if the user has already chosen their cookie preferences If the user deletes this cookie or if `cm_default_preferences`/`cm_eu_preferences` expires (expiry of 1 year), it returns true. ```typescript -import { CookieBanner } from 'cb-cookie-banner'; +import { CookieBanner } from '@coinbase/cookie-banner'; const SomeComponent = () => { const visible = useIsBannerVisible(); diff --git a/packages/cb-cookie-banner/jest.config.ts b/packages/cookie-banner/jest.config.ts similarity index 100% rename from packages/cb-cookie-banner/jest.config.ts rename to packages/cookie-banner/jest.config.ts diff --git a/packages/cb-cookie-banner/package.json b/packages/cookie-banner/package.json similarity index 90% rename from packages/cb-cookie-banner/package.json rename to packages/cookie-banner/package.json index 71e35ad..b2c3ff0 100644 --- a/packages/cb-cookie-banner/package.json +++ b/packages/cookie-banner/package.json @@ -1,5 +1,5 @@ { - "name": "cb-cookie-banner", + "name": "@coinbase/cookie-banner", "version": "1.0.0", "main": "dist/index.js", "license": "Apache-2.0", @@ -25,7 +25,7 @@ "react-dom": "^18.1.0" }, "dependencies": { - "cb-cookie-manager": "1.0.0", + "@coinbase/cookie-manager": "1.0.0", "react-intl": "^6.5.1", "styled-components": "^5.3.6" } diff --git a/packages/cb-cookie-banner/src/components/Button.tsx b/packages/cookie-banner/src/components/Button.tsx similarity index 100% rename from packages/cb-cookie-banner/src/components/Button.tsx rename to packages/cookie-banner/src/components/Button.tsx diff --git a/packages/cb-cookie-banner/src/components/CategoryLabel.tsx b/packages/cookie-banner/src/components/CategoryLabel.tsx similarity index 93% rename from packages/cb-cookie-banner/src/components/CategoryLabel.tsx rename to packages/cookie-banner/src/components/CategoryLabel.tsx index 6325270..d762879 100644 --- a/packages/cb-cookie-banner/src/components/CategoryLabel.tsx +++ b/packages/cookie-banner/src/components/CategoryLabel.tsx @@ -1,4 +1,4 @@ -import { TrackingCategory } from 'cb-cookie-manager'; +import { TrackingCategory } from '@coinbase/cookie-manager'; import React, { memo } from 'react'; import { useIntl } from 'react-intl'; diff --git a/packages/cb-cookie-banner/src/components/CheckBox.tsx b/packages/cookie-banner/src/components/CheckBox.tsx similarity index 100% rename from packages/cb-cookie-banner/src/components/CheckBox.tsx rename to packages/cookie-banner/src/components/CheckBox.tsx diff --git a/packages/cb-cookie-banner/src/components/CheckIcon.tsx b/packages/cookie-banner/src/components/CheckIcon.tsx similarity index 100% rename from packages/cb-cookie-banner/src/components/CheckIcon.tsx rename to packages/cookie-banner/src/components/CheckIcon.tsx diff --git a/packages/cb-cookie-banner/src/components/CloseIcon.tsx b/packages/cookie-banner/src/components/CloseIcon.tsx similarity index 100% rename from packages/cb-cookie-banner/src/components/CloseIcon.tsx rename to packages/cookie-banner/src/components/CloseIcon.tsx diff --git a/packages/cb-cookie-banner/src/components/CookieBanner.test.tsx b/packages/cookie-banner/src/components/CookieBanner.test.tsx similarity index 96% rename from packages/cb-cookie-banner/src/components/CookieBanner.test.tsx rename to packages/cookie-banner/src/components/CookieBanner.test.tsx index 768e727..e84c2bd 100644 --- a/packages/cb-cookie-banner/src/components/CookieBanner.test.tsx +++ b/packages/cookie-banner/src/components/CookieBanner.test.tsx @@ -1,18 +1,18 @@ -import { act, renderHook } from '@testing-library/react'; import { Provider, Region, TrackingCategory, TrackingPreference, useSavedTrackingPreference, -} from 'cb-cookie-manager'; +} from '@coinbase/cookie-manager'; +import { act, renderHook } from '@testing-library/react'; import React from 'react'; import config from '../examples/config'; import { useBanner } from './CookieBanner'; -jest.mock('cb-cookie-manager', () => { - const originalModule = jest.requireActual('cb-cookie-manager'); +jest.mock('@coinbase/cookie-manager', () => { + const originalModule = jest.requireActual('@coinbase/cookie-manager'); return { __esModule: true, diff --git a/packages/cb-cookie-banner/src/components/CookieBanner.tsx b/packages/cookie-banner/src/components/CookieBanner.tsx similarity index 99% rename from packages/cb-cookie-banner/src/components/CookieBanner.tsx rename to packages/cookie-banner/src/components/CookieBanner.tsx index e137acc..d30b620 100644 --- a/packages/cb-cookie-banner/src/components/CookieBanner.tsx +++ b/packages/cookie-banner/src/components/CookieBanner.tsx @@ -9,7 +9,7 @@ import { useSavedTrackingPreferenceFromMobileApp, useSetTrackingPreference, useTrackingManager, -} from 'cb-cookie-manager'; +} from '@coinbase/cookie-manager'; import React, { memo, useCallback, useEffect, useState } from 'react'; import { EXPIRATION_DAYS } from '../constants'; diff --git a/packages/cb-cookie-banner/src/components/CookieBannerContent.tsx b/packages/cookie-banner/src/components/CookieBannerContent.tsx similarity index 98% rename from packages/cb-cookie-banner/src/components/CookieBannerContent.tsx rename to packages/cookie-banner/src/components/CookieBannerContent.tsx index c8643a9..95cd319 100644 --- a/packages/cb-cookie-banner/src/components/CookieBannerContent.tsx +++ b/packages/cookie-banner/src/components/CookieBannerContent.tsx @@ -1,4 +1,4 @@ -import { useTrackingManager } from 'cb-cookie-manager'; +import { useTrackingManager } from '@coinbase/cookie-manager'; import React, { memo, useCallback, useEffect } from 'react'; import { useIntl } from 'react-intl'; import styled, { css } from 'styled-components'; diff --git a/packages/cb-cookie-banner/src/components/CookiePreferencesModal.tsx b/packages/cookie-banner/src/components/CookiePreferencesModal.tsx similarity index 99% rename from packages/cb-cookie-banner/src/components/CookiePreferencesModal.tsx rename to packages/cookie-banner/src/components/CookiePreferencesModal.tsx index 423f487..a8a2a93 100644 --- a/packages/cb-cookie-banner/src/components/CookiePreferencesModal.tsx +++ b/packages/cookie-banner/src/components/CookiePreferencesModal.tsx @@ -6,7 +6,7 @@ import { useSetTrackingPreference, useTrackingManager, useTrackingPreference, -} from 'cb-cookie-manager'; +} from '@coinbase/cookie-manager'; import React, { memo, useCallback, useEffect, useReducer } from 'react'; import { useIntl } from 'react-intl'; import styled from 'styled-components'; diff --git a/packages/cb-cookie-banner/src/components/InfoIcon.tsx b/packages/cookie-banner/src/components/InfoIcon.tsx similarity index 100% rename from packages/cb-cookie-banner/src/components/InfoIcon.tsx rename to packages/cookie-banner/src/components/InfoIcon.tsx diff --git a/packages/cb-cookie-banner/src/components/Modal.tsx b/packages/cookie-banner/src/components/Modal.tsx similarity index 100% rename from packages/cb-cookie-banner/src/components/Modal.tsx rename to packages/cookie-banner/src/components/Modal.tsx diff --git a/packages/cb-cookie-banner/src/components/Palette.ts b/packages/cookie-banner/src/components/Palette.ts similarity index 100% rename from packages/cb-cookie-banner/src/components/Palette.ts rename to packages/cookie-banner/src/components/Palette.ts diff --git a/packages/cb-cookie-banner/src/components/PrivacyLink.tsx b/packages/cookie-banner/src/components/PrivacyLink.tsx similarity index 100% rename from packages/cb-cookie-banner/src/components/PrivacyLink.tsx rename to packages/cookie-banner/src/components/PrivacyLink.tsx diff --git a/packages/cb-cookie-banner/src/components/Spacer.tsx b/packages/cookie-banner/src/components/Spacer.tsx similarity index 100% rename from packages/cb-cookie-banner/src/components/Spacer.tsx rename to packages/cookie-banner/src/components/Spacer.tsx diff --git a/packages/cb-cookie-banner/src/components/Spacing.ts b/packages/cookie-banner/src/components/Spacing.ts similarity index 100% rename from packages/cb-cookie-banner/src/components/Spacing.ts rename to packages/cookie-banner/src/components/Spacing.ts diff --git a/packages/cb-cookie-banner/src/components/Text.tsx b/packages/cookie-banner/src/components/Text.tsx similarity index 100% rename from packages/cb-cookie-banner/src/components/Text.tsx rename to packages/cookie-banner/src/components/Text.tsx diff --git a/packages/cb-cookie-banner/src/components/Tooltip.tsx b/packages/cookie-banner/src/components/Tooltip.tsx similarity index 100% rename from packages/cb-cookie-banner/src/components/Tooltip.tsx rename to packages/cookie-banner/src/components/Tooltip.tsx diff --git a/packages/cb-cookie-banner/src/components/TooltipContent.tsx b/packages/cookie-banner/src/components/TooltipContent.tsx similarity index 100% rename from packages/cb-cookie-banner/src/components/TooltipContent.tsx rename to packages/cookie-banner/src/components/TooltipContent.tsx diff --git a/packages/cb-cookie-banner/src/components/UIProviders.tsx b/packages/cookie-banner/src/components/UIProviders.tsx similarity index 92% rename from packages/cb-cookie-banner/src/components/UIProviders.tsx rename to packages/cookie-banner/src/components/UIProviders.tsx index e61c199..d400d01 100644 --- a/packages/cb-cookie-banner/src/components/UIProviders.tsx +++ b/packages/cookie-banner/src/components/UIProviders.tsx @@ -1,4 +1,4 @@ -import { useTrackingManager } from 'cb-cookie-manager'; +import { useTrackingManager } from '@coinbase/cookie-manager'; import React from 'react'; import { IntlProvider } from 'react-intl'; import { ThemeProvider } from 'styled-components'; diff --git a/packages/cb-cookie-banner/src/components/types.ts b/packages/cookie-banner/src/components/types.ts similarity index 100% rename from packages/cb-cookie-banner/src/components/types.ts rename to packages/cookie-banner/src/components/types.ts diff --git a/packages/cb-cookie-banner/src/constants.ts b/packages/cookie-banner/src/constants.ts similarity index 100% rename from packages/cb-cookie-banner/src/constants.ts rename to packages/cookie-banner/src/constants.ts diff --git a/packages/cb-cookie-banner/src/examples/config.ts b/packages/cookie-banner/src/examples/config.ts similarity index 98% rename from packages/cb-cookie-banner/src/examples/config.ts rename to packages/cookie-banner/src/examples/config.ts index efbbec6..364ea29 100644 --- a/packages/cb-cookie-banner/src/examples/config.ts +++ b/packages/cookie-banner/src/examples/config.ts @@ -1,4 +1,4 @@ -import { Framework, Region, TrackerType, TrackingCategory } from 'cb-cookie-manager'; +import { Framework, Region, TrackerType, TrackingCategory } from '@coinbase/cookie-manager'; export default { categories: [ diff --git a/packages/cb-cookie-banner/src/hooks/useIsBannerVisible.test.tsx b/packages/cookie-banner/src/hooks/useIsBannerVisible.test.tsx similarity index 90% rename from packages/cb-cookie-banner/src/hooks/useIsBannerVisible.test.tsx rename to packages/cookie-banner/src/hooks/useIsBannerVisible.test.tsx index e761009..8ea6ac1 100644 --- a/packages/cb-cookie-banner/src/hooks/useIsBannerVisible.test.tsx +++ b/packages/cookie-banner/src/hooks/useIsBannerVisible.test.tsx @@ -1,15 +1,15 @@ -import { renderHook } from '@testing-library/react'; import { Region, TrackingCategory, TrackingPreference, useSavedTrackingPreference, -} from 'cb-cookie-manager'; +} from '@coinbase/cookie-manager'; +import { renderHook } from '@testing-library/react'; import useIsBannerVisible from './useIsBannerVisible'; -jest.mock('cb-cookie-manager', () => { - const originalModule = jest.requireActual('cb-cookie-manager'); +jest.mock('@coinbase/cookie-manager', () => { + const originalModule = jest.requireActual('@coinbase/cookie-manager'); return { __esModule: true, diff --git a/packages/cb-cookie-banner/src/hooks/useIsBannerVisible.ts b/packages/cookie-banner/src/hooks/useIsBannerVisible.ts similarity index 55% rename from packages/cb-cookie-banner/src/hooks/useIsBannerVisible.ts rename to packages/cookie-banner/src/hooks/useIsBannerVisible.ts index ea5be24..65d2b33 100644 --- a/packages/cb-cookie-banner/src/hooks/useIsBannerVisible.ts +++ b/packages/cookie-banner/src/hooks/useIsBannerVisible.ts @@ -1,4 +1,4 @@ -import { useSavedTrackingPreference } from 'cb-cookie-manager'; +import { useSavedTrackingPreference } from '@coinbase/cookie-manager'; export default function useIsBannerVisible() { return !useSavedTrackingPreference(); diff --git a/packages/cb-cookie-banner/src/hooks/useIsVisibleWithTransition.test.tsx b/packages/cookie-banner/src/hooks/useIsVisibleWithTransition.test.tsx similarity index 100% rename from packages/cb-cookie-banner/src/hooks/useIsVisibleWithTransition.test.tsx rename to packages/cookie-banner/src/hooks/useIsVisibleWithTransition.test.tsx diff --git a/packages/cb-cookie-banner/src/hooks/useIsVisibleWithTransition.ts b/packages/cookie-banner/src/hooks/useIsVisibleWithTransition.ts similarity index 100% rename from packages/cb-cookie-banner/src/hooks/useIsVisibleWithTransition.ts rename to packages/cookie-banner/src/hooks/useIsVisibleWithTransition.ts diff --git a/packages/cb-cookie-banner/src/hooks/useMessages.test.tsx b/packages/cookie-banner/src/hooks/useMessages.test.tsx similarity index 94% rename from packages/cb-cookie-banner/src/hooks/useMessages.test.tsx rename to packages/cookie-banner/src/hooks/useMessages.test.tsx index ee1db2e..06dd0e8 100644 --- a/packages/cb-cookie-banner/src/hooks/useMessages.test.tsx +++ b/packages/cookie-banner/src/hooks/useMessages.test.tsx @@ -1,5 +1,5 @@ +import { Provider, Region } from '@coinbase/cookie-manager'; import { renderHook } from '@testing-library/react'; -import { Provider, Region } from 'cb-cookie-manager'; import React from 'react'; import config from '../examples/config'; diff --git a/packages/cb-cookie-banner/src/hooks/useMessages.ts b/packages/cookie-banner/src/hooks/useMessages.ts similarity index 78% rename from packages/cb-cookie-banner/src/hooks/useMessages.ts rename to packages/cookie-banner/src/hooks/useMessages.ts index cfbbe09..922c6db 100644 --- a/packages/cb-cookie-banner/src/hooks/useMessages.ts +++ b/packages/cookie-banner/src/hooks/useMessages.ts @@ -1,4 +1,4 @@ -import { useTrackingManager } from 'cb-cookie-manager'; +import { useTrackingManager } from '@coinbase/cookie-manager'; import messages from '../utils/messages'; diff --git a/packages/cb-cookie-banner/src/index.ts b/packages/cookie-banner/src/index.ts similarity index 100% rename from packages/cb-cookie-banner/src/index.ts rename to packages/cookie-banner/src/index.ts diff --git a/packages/cb-cookie-banner/src/styles/fonts.css b/packages/cookie-banner/src/styles/fonts.css similarity index 100% rename from packages/cb-cookie-banner/src/styles/fonts.css rename to packages/cookie-banner/src/styles/fonts.css diff --git a/packages/cb-cookie-banner/src/styles/icon-font.css b/packages/cookie-banner/src/styles/icon-font.css similarity index 100% rename from packages/cb-cookie-banner/src/styles/icon-font.css rename to packages/cookie-banner/src/styles/icon-font.css diff --git a/packages/cb-cookie-banner/src/utils/borderRadius.ts b/packages/cookie-banner/src/utils/borderRadius.ts similarity index 100% rename from packages/cb-cookie-banner/src/utils/borderRadius.ts rename to packages/cookie-banner/src/utils/borderRadius.ts diff --git a/packages/cb-cookie-banner/src/utils/borderWidth.ts b/packages/cookie-banner/src/utils/borderWidth.ts similarity index 100% rename from packages/cb-cookie-banner/src/utils/borderWidth.ts rename to packages/cookie-banner/src/utils/borderWidth.ts diff --git a/packages/cb-cookie-banner/src/utils/defaultTheme.ts b/packages/cookie-banner/src/utils/defaultTheme.ts similarity index 100% rename from packages/cb-cookie-banner/src/utils/defaultTheme.ts rename to packages/cookie-banner/src/utils/defaultTheme.ts diff --git a/packages/cb-cookie-banner/src/utils/globalStyles.ts b/packages/cookie-banner/src/utils/globalStyles.ts similarity index 100% rename from packages/cb-cookie-banner/src/utils/globalStyles.ts rename to packages/cookie-banner/src/utils/globalStyles.ts diff --git a/packages/cb-cookie-banner/src/utils/messages.ts b/packages/cookie-banner/src/utils/messages.ts similarity index 100% rename from packages/cb-cookie-banner/src/utils/messages.ts rename to packages/cookie-banner/src/utils/messages.ts diff --git a/packages/cb-cookie-banner/src/utils/tokens.ts b/packages/cookie-banner/src/utils/tokens.ts similarity index 100% rename from packages/cb-cookie-banner/src/utils/tokens.ts rename to packages/cookie-banner/src/utils/tokens.ts diff --git a/packages/cb-cookie-banner/tsconfig.json b/packages/cookie-banner/tsconfig.json similarity index 100% rename from packages/cb-cookie-banner/tsconfig.json rename to packages/cookie-banner/tsconfig.json diff --git a/packages/cb-cookie-banner/yarn.lock b/packages/cookie-banner/yarn.lock similarity index 100% rename from packages/cb-cookie-banner/yarn.lock rename to packages/cookie-banner/yarn.lock diff --git a/packages/cb-cookie-manager/.eslintignore b/packages/cookie-manager/.eslintignore similarity index 100% rename from packages/cb-cookie-manager/.eslintignore rename to packages/cookie-manager/.eslintignore diff --git a/packages/cb-cookie-manager/LICENSE.md b/packages/cookie-manager/LICENSE.md similarity index 100% rename from packages/cb-cookie-manager/LICENSE.md rename to packages/cookie-manager/LICENSE.md diff --git a/packages/cb-cookie-manager/README.md b/packages/cookie-manager/README.md similarity index 92% rename from packages/cb-cookie-manager/README.md rename to packages/cookie-manager/README.md index 221d3c0..06bf0d6 100644 --- a/packages/cb-cookie-manager/README.md +++ b/packages/cookie-manager/README.md @@ -22,7 +22,7 @@ ## Introduction -`cb-cookie-manager` helps manage the following first party client side cookie categories: +`@coinbase/cookie-manager` helps manage the following first party client side cookie categories: - `Necessary Cookies`: Cookies that are necessary for the site to the function - `Performance Cookies`: Cookies that impact site performance and help mesaure performance @@ -50,7 +50,7 @@ import { Region, TrackerType, TrackingCategory, -} from 'cb-cookie-manager'; +} from '@coinbase/cookie-manager'; export default { categories: [ @@ -138,11 +138,11 @@ In this example: `id_ac7a5c3da45e3612b44543a702e42b01` will also be allowed Install the package as follows: ```shell -yarn add cb-cookie-manager +yarn add @coinbase/cookie-manager -npm install cb-cookie-manager +npm install @coinbase/cookie-manager -pnpm install cb-cookie-manager +pnpm install @coinbase/cookie-manager ``` ## Methods @@ -170,7 +170,7 @@ The provider must wrap the entire application and only be instantiated once. On Example usage: ```typescript -import { Provider, Region, TrackingCategory, TrackingPreference } from 'cb-cookie-manager'; +import { Provider, Region, TrackingCategory, TrackingPreference } from '@coinbase/cookie-manager'; { This is a hook for programmatically determining if a tracker (e.g. cookie) has been consented to by the user. ```typescript -import { useHasConsent } from 'cb-cookie-manager'; +import { useHasConsent } from '@coinbase/cookie-manager'; const SomeComponent = () => { const hasConsent = useHasConsent('cookie'); @@ -289,7 +289,7 @@ This hook is used to determine which category of cookies is required. Example Usage: ```typescript -import { useRequiredCategories, TRACKER_CATEGORIES } from 'cb-cookie-manager'; +import { useRequiredCategories, TRACKER_CATEGORIES } from '@coinbase/cookie-manager'; const SomeComponent = () => { const requiredCategories = useRequiredCategories(); @@ -320,7 +320,7 @@ This hook is used to retrieve the saved cookie preference in cache Example Usage: ```typescript -import { useSavedTrackingPreference } from 'cb-cookie-manager'; +import { useSavedTrackingPreference } from '@coinbase/cookie-manager'; const SomeComponent = () => { const preference = useSavedTrackingPreference(); @@ -340,7 +340,7 @@ This hook is used to set the saved cookie preference in cache Example Usage: ```typescript -import { useSetTrackingPreference, Region, TrackingCategory } from 'cb-cookie-manager'; +import { useSetTrackingPreference, Region, TrackingCategory } from '@coinbase/cookie-manager'; const SomeComponent = () => { const setTrackingPreference = useSetTrackingPreference(); @@ -370,7 +370,7 @@ This hook returns the cached preference and if no preference is cached, it retur Example Usage: ```typescript -import { useTrackingPreference } from 'cb-cookie-manager'; +import { useTrackingPreference } from '@coinbase/cookie-manager'; const SomeComponent = () => { const initialTrackingPreference = useTrackingPreference(); @@ -391,7 +391,7 @@ Example usage: ```typescript -import { areCookiesEnabled } from 'cb-cookie-manager'; +import { areCookiesEnabled } from '@coinbase/cookie-manager'; const SomeComponent = () => { @@ -412,7 +412,7 @@ This hook is used to retrieve the default tracking preference for a given user b Example usage: ```typescript -import { getDefaultTrackingPreference } from 'cb-cookie-manager'; +import { getDefaultTrackingPreference } from '@coinbase/cookie-manager'; const SomeComponent = () => { const preference = getDefaultTrackingPreference(); @@ -432,7 +432,7 @@ This hook is used to return `TrackingManagerDependencies` which includes all the Example usage: ```typescript -import { isOptOut, useTrackingManager } from 'cb-cookie-manager'; +import { isOptOut, useTrackingManager } from '@coinbase/cookie-manager'; const SomeComponent = () => { const { region } = useTrackingManager(); @@ -460,7 +460,7 @@ It follows the following logic in order: Example usage: ```typescript -import { isOptOut, useTrackingManager } from 'cb-cookie-manager'; +import { isOptOut, useTrackingManager } from '@coinbase/cookie-manager'; const SomeComponent = () => { const { region } = useTrackingManager(); diff --git a/packages/cb-cookie-manager/jest.config.ts b/packages/cookie-manager/jest.config.ts similarity index 100% rename from packages/cb-cookie-manager/jest.config.ts rename to packages/cookie-manager/jest.config.ts diff --git a/packages/cb-cookie-manager/package.json b/packages/cookie-manager/package.json similarity index 94% rename from packages/cb-cookie-manager/package.json rename to packages/cookie-manager/package.json index 986c150..39d6453 100644 --- a/packages/cb-cookie-manager/package.json +++ b/packages/cookie-manager/package.json @@ -1,5 +1,5 @@ { - "name": "cb-cookie-manager", + "name": "@coinbase/cookie-manager", "version": "1.0.0", "description": "Coinbase Cookie Manager", "main": "dist/index.js", diff --git a/packages/cb-cookie-manager/src/CookieContext.test.tsx b/packages/cookie-manager/src/CookieContext.test.tsx similarity index 100% rename from packages/cb-cookie-manager/src/CookieContext.test.tsx rename to packages/cookie-manager/src/CookieContext.test.tsx diff --git a/packages/cb-cookie-manager/src/CookieContext.tsx b/packages/cookie-manager/src/CookieContext.tsx similarity index 100% rename from packages/cb-cookie-manager/src/CookieContext.tsx rename to packages/cookie-manager/src/CookieContext.tsx diff --git a/packages/cb-cookie-manager/src/TrackingManagerContext.tsx b/packages/cookie-manager/src/TrackingManagerContext.tsx similarity index 100% rename from packages/cb-cookie-manager/src/TrackingManagerContext.tsx rename to packages/cookie-manager/src/TrackingManagerContext.tsx diff --git a/packages/cb-cookie-manager/src/constants.ts b/packages/cookie-manager/src/constants.ts similarity index 100% rename from packages/cb-cookie-manager/src/constants.ts rename to packages/cookie-manager/src/constants.ts diff --git a/packages/cb-cookie-manager/src/examples/config.ts b/packages/cookie-manager/src/examples/config.ts similarity index 100% rename from packages/cb-cookie-manager/src/examples/config.ts rename to packages/cookie-manager/src/examples/config.ts diff --git a/packages/cb-cookie-manager/src/global.d.ts b/packages/cookie-manager/src/global.d.ts similarity index 100% rename from packages/cb-cookie-manager/src/global.d.ts rename to packages/cookie-manager/src/global.d.ts diff --git a/packages/cb-cookie-manager/src/hooks/useHasConsent.ts b/packages/cookie-manager/src/hooks/useHasConsent.ts similarity index 100% rename from packages/cb-cookie-manager/src/hooks/useHasConsent.ts rename to packages/cookie-manager/src/hooks/useHasConsent.ts diff --git a/packages/cb-cookie-manager/src/hooks/useRequiredCaregories.test.tsx b/packages/cookie-manager/src/hooks/useRequiredCaregories.test.tsx similarity index 100% rename from packages/cb-cookie-manager/src/hooks/useRequiredCaregories.test.tsx rename to packages/cookie-manager/src/hooks/useRequiredCaregories.test.tsx diff --git a/packages/cb-cookie-manager/src/hooks/useRequiredCategories.ts b/packages/cookie-manager/src/hooks/useRequiredCategories.ts similarity index 100% rename from packages/cb-cookie-manager/src/hooks/useRequiredCategories.ts rename to packages/cookie-manager/src/hooks/useRequiredCategories.ts diff --git a/packages/cb-cookie-manager/src/hooks/useSavedTrackingPreference.ts b/packages/cookie-manager/src/hooks/useSavedTrackingPreference.ts similarity index 100% rename from packages/cb-cookie-manager/src/hooks/useSavedTrackingPreference.ts rename to packages/cookie-manager/src/hooks/useSavedTrackingPreference.ts diff --git a/packages/cb-cookie-manager/src/hooks/useSetTrackingPreference.test.tsx b/packages/cookie-manager/src/hooks/useSetTrackingPreference.test.tsx similarity index 100% rename from packages/cb-cookie-manager/src/hooks/useSetTrackingPreference.test.tsx rename to packages/cookie-manager/src/hooks/useSetTrackingPreference.test.tsx diff --git a/packages/cb-cookie-manager/src/hooks/useSetTrackingPreference.ts b/packages/cookie-manager/src/hooks/useSetTrackingPreference.ts similarity index 100% rename from packages/cb-cookie-manager/src/hooks/useSetTrackingPreference.ts rename to packages/cookie-manager/src/hooks/useSetTrackingPreference.ts diff --git a/packages/cb-cookie-manager/src/hooks/useTrackingPreference.ts b/packages/cookie-manager/src/hooks/useTrackingPreference.ts similarity index 100% rename from packages/cb-cookie-manager/src/hooks/useTrackingPreference.ts rename to packages/cookie-manager/src/hooks/useTrackingPreference.ts diff --git a/packages/cb-cookie-manager/src/index.ts b/packages/cookie-manager/src/index.ts similarity index 100% rename from packages/cb-cookie-manager/src/index.ts rename to packages/cookie-manager/src/index.ts diff --git a/packages/cb-cookie-manager/src/types.ts b/packages/cookie-manager/src/types.ts similarity index 100% rename from packages/cb-cookie-manager/src/types.ts rename to packages/cookie-manager/src/types.ts diff --git a/packages/cb-cookie-manager/src/utils/areCookiesEnabled.ts b/packages/cookie-manager/src/utils/areCookiesEnabled.ts similarity index 100% rename from packages/cb-cookie-manager/src/utils/areCookiesEnabled.ts rename to packages/cookie-manager/src/utils/areCookiesEnabled.ts diff --git a/packages/cb-cookie-manager/src/utils/getAllCookies.test.ts b/packages/cookie-manager/src/utils/getAllCookies.test.ts similarity index 100% rename from packages/cb-cookie-manager/src/utils/getAllCookies.test.ts rename to packages/cookie-manager/src/utils/getAllCookies.test.ts diff --git a/packages/cb-cookie-manager/src/utils/getAllCookies.ts b/packages/cookie-manager/src/utils/getAllCookies.ts similarity index 100% rename from packages/cb-cookie-manager/src/utils/getAllCookies.ts rename to packages/cookie-manager/src/utils/getAllCookies.ts diff --git a/packages/cb-cookie-manager/src/utils/getDefaultTrackingPreference.test.ts b/packages/cookie-manager/src/utils/getDefaultTrackingPreference.test.ts similarity index 100% rename from packages/cb-cookie-manager/src/utils/getDefaultTrackingPreference.test.ts rename to packages/cookie-manager/src/utils/getDefaultTrackingPreference.test.ts diff --git a/packages/cb-cookie-manager/src/utils/getDefaultTrackingPreference.ts b/packages/cookie-manager/src/utils/getDefaultTrackingPreference.ts similarity index 100% rename from packages/cb-cookie-manager/src/utils/getDefaultTrackingPreference.ts rename to packages/cookie-manager/src/utils/getDefaultTrackingPreference.ts diff --git a/packages/cb-cookie-manager/src/utils/getDomain.test.ts b/packages/cookie-manager/src/utils/getDomain.test.ts similarity index 100% rename from packages/cb-cookie-manager/src/utils/getDomain.test.ts rename to packages/cookie-manager/src/utils/getDomain.test.ts diff --git a/packages/cb-cookie-manager/src/utils/getDomain.ts b/packages/cookie-manager/src/utils/getDomain.ts similarity index 100% rename from packages/cb-cookie-manager/src/utils/getDomain.ts rename to packages/cookie-manager/src/utils/getDomain.ts diff --git a/packages/cb-cookie-manager/src/utils/getTrackerCategory.test.ts b/packages/cookie-manager/src/utils/getTrackerCategory.test.ts similarity index 100% rename from packages/cb-cookie-manager/src/utils/getTrackerCategory.test.ts rename to packages/cookie-manager/src/utils/getTrackerCategory.test.ts diff --git a/packages/cb-cookie-manager/src/utils/getTrackerCategory.ts b/packages/cookie-manager/src/utils/getTrackerCategory.ts similarity index 100% rename from packages/cb-cookie-manager/src/utils/getTrackerCategory.ts rename to packages/cookie-manager/src/utils/getTrackerCategory.ts diff --git a/packages/cb-cookie-manager/src/utils/getTrackerInfo.test.ts b/packages/cookie-manager/src/utils/getTrackerInfo.test.ts similarity index 100% rename from packages/cb-cookie-manager/src/utils/getTrackerInfo.test.ts rename to packages/cookie-manager/src/utils/getTrackerInfo.test.ts diff --git a/packages/cb-cookie-manager/src/utils/getTrackerInfo.ts b/packages/cookie-manager/src/utils/getTrackerInfo.ts similarity index 100% rename from packages/cb-cookie-manager/src/utils/getTrackerInfo.ts rename to packages/cookie-manager/src/utils/getTrackerInfo.ts diff --git a/packages/cb-cookie-manager/src/utils/hasConsent.test.ts b/packages/cookie-manager/src/utils/hasConsent.test.ts similarity index 100% rename from packages/cb-cookie-manager/src/utils/hasConsent.test.ts rename to packages/cookie-manager/src/utils/hasConsent.test.ts diff --git a/packages/cb-cookie-manager/src/utils/hasConsent.ts b/packages/cookie-manager/src/utils/hasConsent.ts similarity index 100% rename from packages/cb-cookie-manager/src/utils/hasConsent.ts rename to packages/cookie-manager/src/utils/hasConsent.ts diff --git a/packages/cb-cookie-manager/src/utils/isMaxKBSize.test.ts b/packages/cookie-manager/src/utils/isMaxKBSize.test.ts similarity index 100% rename from packages/cb-cookie-manager/src/utils/isMaxKBSize.test.ts rename to packages/cookie-manager/src/utils/isMaxKBSize.test.ts diff --git a/packages/cb-cookie-manager/src/utils/isMaxKBSize.ts b/packages/cookie-manager/src/utils/isMaxKBSize.ts similarity index 100% rename from packages/cb-cookie-manager/src/utils/isMaxKBSize.ts rename to packages/cookie-manager/src/utils/isMaxKBSize.ts diff --git a/packages/cb-cookie-manager/src/utils/isOptOut.test.ts b/packages/cookie-manager/src/utils/isOptOut.test.ts similarity index 100% rename from packages/cb-cookie-manager/src/utils/isOptOut.test.ts rename to packages/cookie-manager/src/utils/isOptOut.test.ts diff --git a/packages/cb-cookie-manager/src/utils/isOptOut.ts b/packages/cookie-manager/src/utils/isOptOut.ts similarity index 100% rename from packages/cb-cookie-manager/src/utils/isOptOut.ts rename to packages/cookie-manager/src/utils/isOptOut.ts diff --git a/packages/cb-cookie-manager/src/utils/persistMobileAppPreferences.ts b/packages/cookie-manager/src/utils/persistMobileAppPreferences.ts similarity index 100% rename from packages/cb-cookie-manager/src/utils/persistMobileAppPreferences.ts rename to packages/cookie-manager/src/utils/persistMobileAppPreferences.ts diff --git a/packages/cb-cookie-manager/src/utils/setGTMVariables.test.ts b/packages/cookie-manager/src/utils/setGTMVariables.test.ts similarity index 100% rename from packages/cb-cookie-manager/src/utils/setGTMVariables.test.ts rename to packages/cookie-manager/src/utils/setGTMVariables.test.ts diff --git a/packages/cb-cookie-manager/src/utils/setGTMVariables.ts b/packages/cookie-manager/src/utils/setGTMVariables.ts similarity index 100% rename from packages/cb-cookie-manager/src/utils/setGTMVariables.ts rename to packages/cookie-manager/src/utils/setGTMVariables.ts diff --git a/packages/cb-cookie-manager/src/utils/setTrackingPreference.ts b/packages/cookie-manager/src/utils/setTrackingPreference.ts similarity index 100% rename from packages/cb-cookie-manager/src/utils/setTrackingPreference.ts rename to packages/cookie-manager/src/utils/setTrackingPreference.ts diff --git a/packages/cb-cookie-manager/src/utils/trackerMatches.test.ts b/packages/cookie-manager/src/utils/trackerMatches.test.ts similarity index 100% rename from packages/cb-cookie-manager/src/utils/trackerMatches.test.ts rename to packages/cookie-manager/src/utils/trackerMatches.test.ts diff --git a/packages/cb-cookie-manager/src/utils/trackerMatches.ts b/packages/cookie-manager/src/utils/trackerMatches.ts similarity index 100% rename from packages/cb-cookie-manager/src/utils/trackerMatches.ts rename to packages/cookie-manager/src/utils/trackerMatches.ts diff --git a/packages/cb-cookie-manager/tsconfig.json b/packages/cookie-manager/tsconfig.json similarity index 100% rename from packages/cb-cookie-manager/tsconfig.json rename to packages/cookie-manager/tsconfig.json diff --git a/packages/cb-cookie-manager/yarn.lock b/packages/cookie-manager/yarn.lock similarity index 100% rename from packages/cb-cookie-manager/yarn.lock rename to packages/cookie-manager/yarn.lock diff --git a/yarn.lock b/yarn.lock index b6503c9..49a9546 100644 --- a/yarn.lock +++ b/yarn.lock @@ -6693,6 +6693,7 @@ which@^2.0.1: isexe "^2.0.0" "wrap-ansi-cjs@npm:wrap-ansi@^7.0.0", wrap-ansi@^7.0.0: + name wrap-ansi-cjs version "7.0.0" resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43" integrity sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==