feat(project): add subpath pattern to package.json to restrict internal imports (#3186)

* feat(project): add subpath pattern to package.json to restrict internal imports

* refactor(project): move useOverflow to internal/hooks

* docs(adrs): update adopted status for adr

* chore: add changeset

* Update generated/components.json

---------

Co-authored-by: Josh Black <[email protected]>

Author: joshblack

.changeset/chilled-crabs-bow.md

@@ -0,0 +1,5 @@
+---
+'@primer/react': minor
+---
+
+Modules under an internal export pattern are not able to be imported from outside @primer/react

contributor-docs/adrs/adr-016-internal-modules.md

@@ -5,25 +5,25 @@
 | Stage    | Status |
 | -------- | ------ |
 | Approved | ✅     |
-| Adopted  | 🚧     |
+| Adopted  | ✅     |
 
 ## Context
 
 Currently all files live under the `src` directory. In the `npm` package for `@primer/react`, we specify the following export pattern:
 
 ```json5
 {
-  "exports": {
+  exports: {
     // ...
-    "./lib-esm/*": {
-      "import": [
+    './lib-esm/*': {
+      import: [
         // ...
       ],
-      "require": [
+      require: [
         // ...
-      ]
-    }
-  }
+      ],
+    },
+  },
 }
 ```
 
@@ -37,10 +37,10 @@ In the `"exports"` field of our `npm` package, we can then add the following pat
 
 ```json5
 {
-  "exports": {
+  exports: {
     // ...
-    "./lib-esm/internal/*": null
-  }
+    './lib-esm/internal/*': null,
+  },
 }
 ```
 
@@ -57,7 +57,6 @@ This pattern would remove any files and folders within `src/internal` from the p
 }
 ```
 
-
 ### Impact
 
 - Update the `"exports"` field in `package.json` to exclude `./lib-esm/internal` from usage

generated/components.json

@@ -243,6 +243,7 @@
         {
           "name": "direction",
           "type": "'n' | 'ne' | 'e' | 'se' | 's' | 'sw' | 'w' | 'nw'",
+          "defaultValue": "n",
           "description": "Sets where the tooltip renders in relation to the target."
         },
         {

package.json

@@ -26,7 +26,8 @@
         "./lib/*.js",
         "./lib/*/index.js"
       ]
-    }
+    },
+    "./lib-esm/internal/*": null
   },
   "typings": "lib/index.d.ts",
   "sideEffects": false,

src/DataTable/Table.tsx

@@ -11,7 +11,7 @@ import {Column, CellAlignment} from './column'
 import {UniqueRow} from './row'
 import {SortDirection} from './sorting'
 import {useTableLayout} from './useTable'
-import {useOverflow} from '../hooks/useOverflow'
+import {useOverflow} from '../internal/hooks/useOverflow'
 
 // ----------------------------------------------------------------------------
 // Table

src/PageLayout/PageLayout.tsx

@@ -8,7 +8,7 @@ import {useSlots} from '../hooks/useSlots'
 import {BetterSystemStyleObject, merge, SxProp} from '../sx'
 import {Theme} from '../ThemeProvider'
 import {canUseDOM} from '../utils/environment'
-import {useOverflow} from '../utils/useOverflow'
+import {useOverflow} from '../internal/hooks/useOverflow'
 import {warning} from '../utils/warning'
 import VisuallyHidden from '../_VisuallyHidden'
 import {useStickyPaneHeight} from './useStickyPaneHeight'