@bucketco/react-sdk - npm Package Compare versions

Comparing version 3.0.0-alpha.6 to 3.0.0-alpha.8

dist/src/index.d.ts

@@ -40,3 +40,3 @@ import { default as React, ReactNode } from 'react';
 };
-type Feature<TKey extends FeatureKey> = {
+export type Feature<TKey extends FeatureKey> = {
     isEnabled: boolean;
@@ -154,3 +154,16 @@ isLoading: boolean;
 }) => Promise<void> | undefined;
+/**
+ * Returns the current `BucketClient` used by the `BucketProvider`.
+ *
+ * This is useful if you need to access the `BucketClient` outside of the `BucketProvider`.
+ *
+ * ```ts
+ * const client = useClient();
+ * client.on("configCheck", () => {
+ *   console.log("configCheck hook called");
+ * });
+ * ```
+ */
+export declare function useClient(): BucketClient | undefined;
 export {};
 //# sourceMappingURL=index.d.ts.map

package.json

 {
   "name": "@bucketco/react-sdk",
-  "version": "3.0.0-alpha.6",
+  "version": "3.0.0-alpha.8",
   "license": "MIT",
@@ -37,3 +37,3 @@ "repository": {
   "dependencies": {
-    "@bucketco/browser-sdk": "3.0.0-alpha.4",
+    "@bucketco/browser-sdk": "3.0.0-alpha.5",
     "canonical-json": "^0.0.4",
@@ -47,4 +47,4 @@ "rollup": "^4.2.0"
   "devDependencies": {
-    "@bucketco/eslint-config": "workspace:^",
-    "@bucketco/tsconfig": "workspace:^",
+    "@bucketco/eslint-config": "^0.0.2",
+    "@bucketco/tsconfig": "^0.0.2",
     "@testing-library/react": "^15.0.7",
@@ -70,3 +70,4 @@ "@types/jsdom": "^21.1.6",
     "webpack-cli": "^5.1.4"
-  }
+  },
+  "gitHead": "62b55a86472f60a4a99e08a66e26c5d318aad525"
 }

README.md

@@ -399,2 +399,23 @@ # Bucket React SDK
 
+### `useClient()`
+
+Returns the `BucketClient` used by the `BucketProvider`. The client offers more functionality that
+is not directly accessible thorough the other hooks.
+
+```tsx
+import { useClient } from "@bucketco/react-sdk";
+
+function LoggingWrapper({ children }: { children: ReactNode }) {
+  const client = useClient();
+
+  useEffect(() => {
+    client.on("enabledCheck", (evt) => {
+      console.log(`The feature ${evt.key} is ${evt.value} for user.`);
+    });
+  }, [client]);
+
+  return children;
+}
+```
+
 ## Content Security Policy (CSP)
@@ -401,0 +422,0 @@

New alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Fixed alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

884699

13.93%

Number of package files

11

22.22%

Lines of code

4962

10.1%

Number of lines in readme file

429

5.15%

Worsened metrics

Number of low quality alerts

4

33.33%

Number of low supply chain risk alerts

21

50%

Number of medium supply chain risk alerts

12

50%

Dependency changes

• + Added

  @bucketco/browser-sdk@3.0.0-alpha.5
  (transitive)

• - Removed

  @bucketco/browser-sdk@3.0.0-alpha.4
  (transitive)

• Updated

  @bucketco/browser-sdk@3.0.0-alpha.5