Reexport API functions (#474)

marcospassos · web-flow · commit 6c9040746160 · 2024-05-06T10:28:47.000-06:00
diff --git a/README.md b/README.md
@@ -34,6 +34,10 @@ or the [example folder](examples) for full code examples.
 
 The following steps will walk you through installing the library and integrating it into your application.
 
+> [!TIP]
+> If you are using Next.js, head over to the [Plug Next.js](https://github.com/croct-tech/plug-next) library for a more
+> integrated experience.
+
 This guide assumes you're already familiar with some key concepts and tools around Croct, like
 Contextual Query Language (CQL) and the playground. If you're not,
 [this 15-minute quickstart](https://croct.link/plug-js/quick-start) that will give you a hands-on overview of
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -37,8 +37,8 @@
     "react-dom": "^16.8.0  || ^17.0.0 || ^18.0.0"
   },
   "dependencies": {
-    "@croct/plug": "^0.13.4",
-    "@croct/sdk": "^0.14.0"
+    "@croct/plug": "^0.14.0",
+    "@croct/sdk": "^0.15.2"
   },
   "devDependencies": {
     "@babel/core": "^7.20.2",
@@ -61,7 +61,7 @@
     "@typescript-eslint/eslint-plugin": "^7.0.0",
     "@typescript-eslint/parser": "^7.0.0",
     "babel-loader": "^9.1.0",
-    "eslint": "^9.0.0",
+    "eslint": "^8.57.0",
     "jest": "^29.0.0",
     "jest-environment-jsdom": "^29.0.0",
     "jest-environment-node": "^29.0.0",
diff --git a/src/CroctProvider.test.tsx b/src/CroctProvider.test.tsx
@@ -1,4 +1,3 @@
-import '@testing-library/jest-dom/extend-expect';
 import {render} from '@testing-library/react';
 import {Plug} from '@croct/plug';
 import {croct} from './ssr-polyfills';
diff --git a/src/api.ts b/src/api.ts
@@ -0,0 +1 @@
+export * from '@croct/plug/api';
diff --git a/src/api/evaluate.test.ts b/src/api/evaluate.test.ts
diff --git a/src/api/evaluate.ts b/src/api/evaluate.ts
diff --git a/src/api/fetchContent.test.ts b/src/api/fetchContent.test.ts
diff --git a/src/api/fetchContent.ts b/src/api/fetchContent.ts
diff --git a/src/api/index.ts b/src/api/index.ts
diff --git a/src/components/Personalization/index.stories.tsx b/src/components/Personalization/index.stories.tsx
@@ -1,5 +1,5 @@
 import {FunctionComponent, ReactElement, Suspense} from 'react';
-import {Story, Meta} from '@storybook/react/types-6-0';
+import {StoryFn as Story, Meta} from '@storybook/react';
 import {Personalization, PersonalizationProps} from './index';
 
 export default {
diff --git a/src/components/Personalization/index.tsx b/src/components/Personalization/index.tsx
@@ -1,3 +1,5 @@
+'use client';
+
 import {ReactElement, Fragment} from 'react';
 import {JsonValue} from '@croct/plug/sdk/json';
 import {UseEvaluationOptions, useEvaluation} from '../../hooks';
diff --git a/src/components/Slot/index.stories.tsx b/src/components/Slot/index.stories.tsx
@@ -1,5 +1,5 @@
 import {FunctionComponent, ReactElement, Suspense} from 'react';
-import {Story, Meta} from '@storybook/react/types-6-0';
+import {StoryFn as Story, Meta} from '@storybook/react';
 import {Slot, SlotProps} from './index';
 
 export default {
diff --git a/src/components/Slot/index.tsx b/src/components/Slot/index.tsx
@@ -1,3 +1,5 @@
+'use client';
+
 import {Fragment, ReactElement, ReactNode} from 'react';
 import {SlotContent, VersionedSlotId, VersionedSlotMap} from '@croct/plug/slot';
 import {JsonObject} from '@croct/plug/sdk/json';
diff --git a/src/hooks/useContent.stories.tsx b/src/hooks/useContent.stories.tsx
@@ -1,5 +1,5 @@
 import {FunctionComponent, ReactElement, Suspense} from 'react';
-import {Story, Meta} from '@storybook/react/types-6-0';
+import {StoryFn as Story, Meta} from '@storybook/react';
 import {UseContentOptions, useContent} from './useContent';
 
 export default {
diff --git a/src/hooks/useEvaluation.stories.tsx b/src/hooks/useEvaluation.stories.tsx
@@ -1,5 +1,5 @@
 import {FunctionComponent, ReactElement, Suspense} from 'react';
-import {Story, Meta} from '@storybook/react/types-6-0';
+import {StoryFn as Story, Meta} from '@storybook/react';
 import {UseEvaluationOptions, useEvaluation} from './useEvaluation';
 
 export default {
diff --git a/src/hooks/useEvaluation.ts b/src/hooks/useEvaluation.ts
@@ -7,7 +7,7 @@ import {isSsr} from '../ssr-polyfills';
 function cleanEvaluationOptions(options: EvaluationOptions): EvaluationOptions {
     const result: EvaluationOptions = {};
 
-    for (const [key, value] of Object.entries(options)) {
+    for (const [key, value] of Object.entries(options) as Array<[keyof EvaluationOptions, any]>) {
         if (value !== undefined) {
             result[key] = value;
         }
diff --git a/src/ssr-polyfills.ts b/src/ssr-polyfills.ts
@@ -1,6 +1,7 @@
 import csrPlug, {Plug} from '@croct/plug';
 
 export function isSsr(): boolean {
+    // eslint-disable-next-line @typescript-eslint/prefer-optional-chain -- The window can be undefined.
     return typeof window === 'undefined'
         || typeof window.document === 'undefined'
         || typeof window.document.createElement === 'undefined';
diff --git a/tsconfig.json b/tsconfig.json
@@ -16,7 +16,6 @@
     "noImplicitThis": true,
     "noImplicitAny": true,
     "strictNullChecks": true,
-    "suppressImplicitAnyIndexErrors": true,
     "noUnusedLocals": true,
     "noUnusedParameters": true,
     "allowSyntheticDefaultImports": true,

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-import '@testing-library/jest-dom/extend-expect';`
`2`	`1`	`import {render} from '@testing-library/react';`
`3`	`2`	`import {Plug} from '@croct/plug';`
`4`	`3`	`import {croct} from './ssr-polyfills';`