Change package to start with @coinbase (#4)

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
 

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
 

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<string, string>;

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"

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';
 

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';

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: [

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@coinbase/cookie-manager",
+  "name": "cb-cookie-manager",
   "version": "1.0.0",
   "description": "Cookie Manager",
   "author": "Sneh Koul <[email protected]>",
@@ -11,8 +11,7 @@
     "test": "yarn workspaces run test"
   },
   "workspaces": [
-    "packages/cb-cookie-manager",
-    "packages/cb-cookie-banner",
+    "packages/*",
     "apps/example"
   ],
   "devDependencies": {

packages/cb-cookie-banner/README.md → 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();

packages/cb-cookie-banner/package.json → 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"
   }

packages/cb-cookie-banner/src/components/CategoryLabel.tsx → 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';
 

packages/cb-cookie-banner/src/components/CookieBanner.test.tsx → 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,

packages/cb-cookie-banner/src/components/CookieBanner.tsx → 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';

packages/cb-cookie-banner/src/components/CookieBannerContent.tsx → 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';

packages/cb-cookie-banner/src/components/CookiePreferencesModal.tsx → 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';

packages/cb-cookie-banner/src/components/UIProviders.tsx → 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';

packages/cb-cookie-banner/src/examples/config.ts → 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: [

packages/cb-cookie-banner/src/hooks/useIsBannerVisible.test.tsx → 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,

packages/cb-cookie-banner/src/hooks/useIsBannerVisible.ts → 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();

packages/cb-cookie-banner/src/hooks/useMessages.test.tsx → 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';

packages/cb-cookie-banner/src/hooks/useMessages.ts → 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';
 

packages/cb-cookie-manager/README.md → 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';
 
 <Provider
   onError={notifyError}
@@ -270,7 +270,7 @@ const SomeComponent = () => {
 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();

packages/cb-cookie-manager/package.json → 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",

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==