@schematichq/schematic-react 1.1.0 → 1.1.1

package/README.md

@@ -14,6 +14,8 @@ pnpm add @schematichq/schematic-react
 
 ## Usage
 
+### SchematicProvider
+
 You can use the `SchematicProvider` to wrap your application and provide the Schematic instance to all components:
 
 ```tsx
@@ -27,6 +29,8 @@ ReactDOM.render(
 );
 ```
 
+### Setting context
+
 To set the user context for events and flag checks, you can use the `identify` function provided by the `useSchematicEvents` hook:
 
 ```tsx
@@ -49,6 +53,8 @@ const MyComponent = () => {
 };
 ```
 
+### Tracking usage
+
 Once you've set the context with `identify`, you can track events:
 
 ```tsx
@@ -65,6 +71,8 @@ const MyComponent = () => {
 };
 ```
 
+### Checking flags
+
 To check a flag, you can use the `useSchematicFlag` hook:
 
 ```tsx
@@ -78,11 +86,13 @@ const MyComponent = () => {
 };
 ```
 
-For flags that are checking company access to a feature based on usage, you can render additional states using the `useSchematicFlagCheck` hook, e.g.:
+### Checking flags
+
+You can check entitlements (i.e., company access to a feature) using a flag check as well, and using the `useSchematicEntitlement` hook you can get additional data to render various feature states:
 
 ```tsx
 import {
-    useSchematicFlagCheck,
+    useSchematicEntitlement,
     useSchematicIsPending,
 } from "@schematichq/schematic-react";
 import { Feature, Loader, NoAccess } from "./components";
@@ -94,7 +104,7 @@ const MyComponent = () => {
         featureUsage,
         featureUsageExceeded,
         value: isFeatureEnabled,
-    } = useSchematicFlagCheck("my-flag-key");
+    } = useSchematicEntitlement("my-flag-key");
 
     // loading state
     if (schematicIsPending) {
@@ -111,7 +121,7 @@ const MyComponent = () => {
         );
     }
 
-    // either feature or "no access" state
+    // either feature state or "no access" state
     return isFeatureEnabled ? <Feature /> : <NoAccess />;
 };
 ```

package/dist/schematic-react.cjs.js

@@ -36,9 +36,9 @@ __export(index_exports, {
   UsagePeriod: () => UsagePeriod,
   useSchematic: () => useSchematic,
   useSchematicContext: () => useSchematicContext,
+  useSchematicEntitlement: () => useSchematicEntitlement,
   useSchematicEvents: () => useSchematicEvents,
   useSchematicFlag: () => useSchematicFlag,
-  useSchematicFlagCheck: () => useSchematicFlagCheck,
   useSchematicIsPending: () => useSchematicIsPending
 });
 module.exports = __toCommonJS(index_exports);
@@ -1299,7 +1299,7 @@ var useSchematicFlag = (key, opts) => {
   }, [client, key, fallback]);
   return (0, import_react2.useSyncExternalStore)(subscribe, getSnapshot);
 };
-var useSchematicFlagCheck = (key, opts) => {
+var useSchematicEntitlement = (key, opts) => {
   const client = useSchematicClient(opts);
   const fallback = opts?.fallback ?? false;
   const fallbackCheck = (0, import_react2.useMemo)(

package/dist/schematic-react.d.ts

@@ -72,6 +72,8 @@ export declare const useSchematicContext: (opts?: SchematicHookOpts) => {
     setContext: (context: SchematicJS.SchematicContext) => Promise<void>;
 };
 
+export declare const useSchematicEntitlement: (key: string, opts?: UseSchematicFlagOpts) => SchematicJS.CheckFlagReturn;
+
 export declare const useSchematicEvents: (opts?: SchematicHookOpts) => {
     track: (body: SchematicJS.EventBodyTrack) => Promise<void>;
     identify: (body: SchematicJS.EventBodyIdentify) => Promise<void>;
@@ -79,8 +81,6 @@ export declare const useSchematicEvents: (opts?: SchematicHookOpts) => {
 
 export declare const useSchematicFlag: (key: string, opts?: UseSchematicFlagOpts) => boolean;
 
-export declare const useSchematicFlagCheck: (key: string, opts?: UseSchematicFlagOpts) => SchematicJS.CheckFlagReturn;
-
 export declare type UseSchematicFlagOpts = SchematicHookOpts & {
     fallback?: boolean;
 };

package/dist/schematic-react.esm.js

@@ -1254,7 +1254,7 @@ var useSchematicFlag = (key, opts) => {
   }, [client, key, fallback]);
   return useSyncExternalStore(subscribe, getSnapshot);
 };
-var useSchematicFlagCheck = (key, opts) => {
+var useSchematicEntitlement = (key, opts) => {
   const client = useSchematicClient(opts);
   const fallback = opts?.fallback ?? false;
   const fallbackCheck = useMemo2(
@@ -1291,9 +1291,9 @@ export {
   UsagePeriod,
   useSchematic,
   useSchematicContext,
+  useSchematicEntitlement,
   useSchematicEvents,
   useSchematicFlag,
-  useSchematicFlagCheck,
   useSchematicIsPending
 };
 /*! Bundled license information:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@schematichq/schematic-react",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "main": "dist/schematic-react.cjs.js",
   "module": "dist/schematic-react.esm.js",
   "types": "dist/schematic-react.d.ts",