@schematichq/schematic-react 1.3.0 → 1.4.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023-2025 Schematic, Inc.
+Copyright (c) 2023-2026 Schematic, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -136,6 +136,45 @@ const MyComponent = () => {
 
 *Note: `useSchematicIsPending` is checking if entitlement data has been loaded, typically via `identify`. It should, therefore, be used to wrap flag and entitlement checks, but never the initial call to `identify`.*
 
+### Company plan information
+
+To access the current company's plan and trial status, you can use the `useSchematicPlan` hook:
+
+```tsx
+import { useSchematicPlan } from "@schematichq/schematic-react";
+
+const MyComponent = () => {
+    const plan = useSchematicPlan();
+
+    if (!plan) {
+        return <div>No plan assigned</div>;
+    }
+
+    return (
+        <div>
+            <p>Current plan: {plan.name}</p>
+
+            {plan.trialStatus === "active" && (
+                <p>Trial ends: {plan.trialEndDate?.toLocaleDateString()}</p>
+            )}
+
+            {plan.trialStatus === "expired" && (
+                <p>Your trial has ended. <a href="/upgrade">Upgrade now</a></p>
+            )}
+        </div>
+    );
+};
+```
+
+The hook returns an object with the following properties:
+
+| Property | Type | Description |
+| --- | --- | --- |
+| `id` | `string` | The plan ID |
+| `name` | `string` | The plan name |
+| `trialEndDate` | `Date \| undefined` | The trial end date, if the company has or had a trial |
+| `trialStatus` | `"active" \| "expired" \| "converted" \| undefined` | The company's trial status: `active` if the trial is ongoing, `expired` if the trial ended without conversion, `converted` if the company converted to a paid plan, or `undefined` if the company has never trialed |
+
 ## Fallback Behavior
 
 The SDK includes built-in fallback behavior you can use to ensure your application continues to function even when unable to reach Schematic (e.g., during service disruptions or network issues).

package/dist/schematic-react.cjs.js

@@ -33,6 +33,7 @@ __export(index_exports, {
   RuleType: () => RuleType,
   Schematic: () => Schematic,
   SchematicProvider: () => SchematicProvider,
+  TrialStatus: () => TrialStatus,
   UsagePeriod: () => UsagePeriod,
   useSchematic: () => useSchematic,
   useSchematicContext: () => useSchematicContext,
@@ -719,6 +720,17 @@ function CheckFlagResponseFromJSONTyped(json, ignoreDiscriminator) {
     params: json["params"]
   };
 }
+var TrialStatus = {
+  Active: "active",
+  Converted: "converted",
+  Expired: "expired"
+};
+function TrialStatusFromJSON(json) {
+  return TrialStatusFromJSONTyped(json, false);
+}
+function TrialStatusFromJSONTyped(json, ignoreDiscriminator) {
+  return json;
+}
 function DatastreamCompanyPlanFromJSON(json) {
   return DatastreamCompanyPlanFromJSONTyped(json, false);
 }
@@ -729,7 +741,8 @@ function DatastreamCompanyPlanFromJSONTyped(json, ignoreDiscriminator) {
   return {
     id: json["id"],
     name: json["name"],
-    trialEndDate: json["trial_end_date"] == null ? void 0 : new Date(json["trial_end_date"])
+    trialEndDate: json["trial_end_date"] == null ? void 0 : new Date(json["trial_end_date"]),
+    trialStatus: json["trial_status"] == null ? void 0 : TrialStatusFromJSON(json["trial_status"])
   };
 }
 function CheckFlagsResponseDataFromJSON(json) {
@@ -796,6 +809,7 @@ var UsagePeriod = /* @__PURE__ */ ((UsagePeriod2) => {
 var CheckFlagReturnFromJSON = (json) => {
   const {
     companyId,
+    entitlement,
     error,
     featureAllocation,
     featureUsage,
@@ -813,30 +827,38 @@ var CheckFlagReturnFromJSON = (json) => {
   const featureUsageExceeded = !value && // if flag is not false, then we haven't exceeded usage
   (ruleType == "company_override_usage_exceeded" || // if the rule type is one of these, then we have exceeded usage
   ruleType == "plan_entitlement_usage_exceeded");
+  const resolvedAllocation = entitlement?.allocation ?? featureAllocation;
+  const resolvedUsage = entitlement?.usage ?? featureUsage;
+  const resolvedEvent = entitlement?.eventName ?? featureUsageEvent;
+  const resolvedPeriod = entitlement?.metricPeriod ?? featureUsagePeriod;
+  const resolvedResetAt = entitlement?.metricResetAt ?? featureUsageResetAt;
   return {
     featureUsageExceeded,
     companyId: companyId == null ? void 0 : companyId,
+    creditRemaining: entitlement?.creditRemaining == null ? void 0 : entitlement.creditRemaining,
     error: error == null ? void 0 : error,
-    featureAllocation: featureAllocation == null ? void 0 : featureAllocation,
-    featureUsage: featureUsage == null ? void 0 : featureUsage,
-    featureUsageEvent: featureUsageEvent === null ? void 0 : featureUsageEvent,
-    featureUsagePeriod: featureUsagePeriod == null ? void 0 : featureUsagePeriod,
-    featureUsageResetAt: featureUsageResetAt == null ? void 0 : featureUsageResetAt,
+    featureAllocation: resolvedAllocation == null ? void 0 : resolvedAllocation,
+    featureUsage: resolvedUsage == null ? void 0 : resolvedUsage,
+    featureUsageEvent: resolvedEvent == null ? void 0 : resolvedEvent,
+    featureUsagePeriod: resolvedPeriod == null ? void 0 : resolvedPeriod,
+    featureUsageResetAt: resolvedResetAt == null ? void 0 : resolvedResetAt,
     flag,
     flagId: flagId == null ? void 0 : flagId,
     reason,
     ruleId: ruleId == null ? void 0 : ruleId,
     ruleType: ruleType == null ? void 0 : ruleType,
+    softLimit: entitlement?.softLimit == null ? void 0 : entitlement.softLimit,
     userId: userId == null ? void 0 : userId,
     value
   };
 };
 var CheckPlanReturnFromJSON = (json) => {
-  const { id, name, trialEndDate } = DatastreamCompanyPlanFromJSON(json);
+  const { id, name, trialEndDate, trialStatus } = DatastreamCompanyPlanFromJSON(json);
   return {
     id,
     name,
-    trialEndDate: trialEndDate == null ? void 0 : trialEndDate
+    trialEndDate: trialEndDate == null ? void 0 : trialEndDate,
+    trialStatus: trialStatus == null ? void 0 : trialStatus
   };
 };
 function contextString(context) {
@@ -853,7 +875,7 @@ function contextString(context) {
   }, {});
   return JSON.stringify(sortedContext);
 }
-var version = "1.3.0";
+var version = "1.4.0";
 var anonymousIdKey = "schematicId";
 var Schematic = class {
   additionalHeaders = {};
@@ -2290,7 +2312,7 @@ var notifyPlanListener = (listener, value) => {
 var import_react = __toESM(require("react"));
 
 // src/version.ts
-var version2 = "1.3.0";
+var version2 = "1.4.0";
 
 // src/context/schematic.tsx
 var import_jsx_runtime = require("react/jsx-runtime");
@@ -2416,7 +2438,12 @@ var useSchematicPlan = (opts) => {
   const fallback = opts?.fallback;
   const fallbackPlan = (0, import_react2.useMemo)(
     () => fallback,
-    [fallback?.id, fallback?.name, fallback?.trialEndDate?.getTime()]
+    [
+      fallback?.id,
+      fallback?.name,
+      fallback?.trialEndDate?.getTime(),
+      fallback?.trialStatus
+    ]
   );
   const subscribe = (0, import_react2.useCallback)(
     (callback) => client.addPlanListener(callback),

package/dist/schematic-react.d.ts

@@ -14,6 +14,7 @@ import * as SchematicJS from '@schematichq/schematic-js';
 import { SchematicOptions } from '@schematichq/schematic-js';
 import { StoragePersister } from '@schematichq/schematic-js';
 import { Traits } from '@schematichq/schematic-js';
+import { TrialStatus } from '@schematichq/schematic-js';
 import { UsagePeriod } from '@schematichq/schematic-js';
 
 declare type BaseSchematicProviderProps = Omit<SchematicJS.SchematicOptions, "client" | "publishableKey" | "useWebSocket"> & {
@@ -70,6 +71,8 @@ export { StoragePersister }
 
 export { Traits }
 
+export { TrialStatus }
+
 export { UsagePeriod }
 
 export declare const useSchematic: () => SchematicContextProps;

package/dist/schematic-react.esm.js

@@ -673,6 +673,17 @@ function CheckFlagResponseFromJSONTyped(json, ignoreDiscriminator) {
     params: json["params"]
   };
 }
+var TrialStatus = {
+  Active: "active",
+  Converted: "converted",
+  Expired: "expired"
+};
+function TrialStatusFromJSON(json) {
+  return TrialStatusFromJSONTyped(json, false);
+}
+function TrialStatusFromJSONTyped(json, ignoreDiscriminator) {
+  return json;
+}
 function DatastreamCompanyPlanFromJSON(json) {
   return DatastreamCompanyPlanFromJSONTyped(json, false);
 }
@@ -683,7 +694,8 @@ function DatastreamCompanyPlanFromJSONTyped(json, ignoreDiscriminator) {
   return {
     id: json["id"],
     name: json["name"],
-    trialEndDate: json["trial_end_date"] == null ? void 0 : new Date(json["trial_end_date"])
+    trialEndDate: json["trial_end_date"] == null ? void 0 : new Date(json["trial_end_date"]),
+    trialStatus: json["trial_status"] == null ? void 0 : TrialStatusFromJSON(json["trial_status"])
   };
 }
 function CheckFlagsResponseDataFromJSON(json) {
@@ -750,6 +762,7 @@ var UsagePeriod = /* @__PURE__ */ ((UsagePeriod2) => {
 var CheckFlagReturnFromJSON = (json) => {
   const {
     companyId,
+    entitlement,
     error,
     featureAllocation,
     featureUsage,
@@ -767,30 +780,38 @@ var CheckFlagReturnFromJSON = (json) => {
   const featureUsageExceeded = !value && // if flag is not false, then we haven't exceeded usage
   (ruleType == "company_override_usage_exceeded" || // if the rule type is one of these, then we have exceeded usage
   ruleType == "plan_entitlement_usage_exceeded");
+  const resolvedAllocation = entitlement?.allocation ?? featureAllocation;
+  const resolvedUsage = entitlement?.usage ?? featureUsage;
+  const resolvedEvent = entitlement?.eventName ?? featureUsageEvent;
+  const resolvedPeriod = entitlement?.metricPeriod ?? featureUsagePeriod;
+  const resolvedResetAt = entitlement?.metricResetAt ?? featureUsageResetAt;
   return {
     featureUsageExceeded,
     companyId: companyId == null ? void 0 : companyId,
+    creditRemaining: entitlement?.creditRemaining == null ? void 0 : entitlement.creditRemaining,
     error: error == null ? void 0 : error,
-    featureAllocation: featureAllocation == null ? void 0 : featureAllocation,
-    featureUsage: featureUsage == null ? void 0 : featureUsage,
-    featureUsageEvent: featureUsageEvent === null ? void 0 : featureUsageEvent,
-    featureUsagePeriod: featureUsagePeriod == null ? void 0 : featureUsagePeriod,
-    featureUsageResetAt: featureUsageResetAt == null ? void 0 : featureUsageResetAt,
+    featureAllocation: resolvedAllocation == null ? void 0 : resolvedAllocation,
+    featureUsage: resolvedUsage == null ? void 0 : resolvedUsage,
+    featureUsageEvent: resolvedEvent == null ? void 0 : resolvedEvent,
+    featureUsagePeriod: resolvedPeriod == null ? void 0 : resolvedPeriod,
+    featureUsageResetAt: resolvedResetAt == null ? void 0 : resolvedResetAt,
     flag,
     flagId: flagId == null ? void 0 : flagId,
     reason,
     ruleId: ruleId == null ? void 0 : ruleId,
     ruleType: ruleType == null ? void 0 : ruleType,
+    softLimit: entitlement?.softLimit == null ? void 0 : entitlement.softLimit,
     userId: userId == null ? void 0 : userId,
     value
   };
 };
 var CheckPlanReturnFromJSON = (json) => {
-  const { id, name, trialEndDate } = DatastreamCompanyPlanFromJSON(json);
+  const { id, name, trialEndDate, trialStatus } = DatastreamCompanyPlanFromJSON(json);
   return {
     id,
     name,
-    trialEndDate: trialEndDate == null ? void 0 : trialEndDate
+    trialEndDate: trialEndDate == null ? void 0 : trialEndDate,
+    trialStatus: trialStatus == null ? void 0 : trialStatus
   };
 };
 function contextString(context) {
@@ -807,7 +828,7 @@ function contextString(context) {
   }, {});
   return JSON.stringify(sortedContext);
 }
-var version = "1.3.0";
+var version = "1.4.0";
 var anonymousIdKey = "schematicId";
 var Schematic = class {
   additionalHeaders = {};
@@ -2244,7 +2265,7 @@ var notifyPlanListener = (listener, value) => {
 import React, { createContext, useEffect, useMemo, useRef } from "react";
 
 // src/version.ts
-var version2 = "1.3.0";
+var version2 = "1.4.0";
 
 // src/context/schematic.tsx
 import { jsx } from "react/jsx-runtime";
@@ -2370,7 +2391,12 @@ var useSchematicPlan = (opts) => {
   const fallback = opts?.fallback;
   const fallbackPlan = useMemo2(
     () => fallback,
-    [fallback?.id, fallback?.name, fallback?.trialEndDate?.getTime()]
+    [
+      fallback?.id,
+      fallback?.name,
+      fallback?.trialEndDate?.getTime(),
+      fallback?.trialStatus
+    ]
   );
   const subscribe = useCallback(
     (callback) => client.addPlanListener(callback),
@@ -2395,6 +2421,7 @@ export {
   RuleType,
   Schematic,
   SchematicProvider,
+  TrialStatus,
   UsagePeriod,
   useSchematic,
   useSchematicContext,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@schematichq/schematic-react",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "main": "dist/schematic-react.cjs.js",
   "module": "dist/schematic-react.esm.js",
   "types": "dist/schematic-react.d.ts",
@@ -30,31 +30,29 @@
     "tsc": "npx tsc",
     "prepare": "husky"
   },
-  "dependencies": {
-    "@schematichq/schematic-js": "^1.3.0"
-  },
   "devDependencies": {
     "@eslint/js": "^10.0.1",
-    "@microsoft/api-extractor": "^7.57.7",
+    "@microsoft/api-extractor": "^7.58.2",
+    "@schematichq/schematic-js": "^1.4.0",
     "@testing-library/dom": "^10.4.1",
     "@testing-library/jest-dom": "^6.9.1",
     "@testing-library/react": "^16.3.2",
     "@types/react": "^19.2.14",
     "@vitest/browser": "^4.0.18",
-    "esbuild": "^0.27.4",
-    "eslint": "^10.0.3",
+    "esbuild": "^0.28.0",
+    "eslint": "^10.2.0",
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-react": "^7.37.5",
-    "eslint-plugin-react-hooks": "^7.0.1",
-    "globals": "^17.4.0",
-    "happy-dom": "^20.8.4",
+    "eslint-plugin-react-hooks": "^7.1.0",
+    "globals": "^17.5.0",
+    "happy-dom": "^20.9.0",
     "husky": "^9.1.7",
-    "jsdom": "^29.0.0",
-    "prettier": "^3.8.1",
-    "react": "^19.2.4",
-    "react-dom": "^19.2.4",
-    "typescript": "^5.9.3",
-    "typescript-eslint": "^8.57.1",
+    "jsdom": "^29.0.2",
+    "prettier": "^3.8.3",
+    "react": "^19.2.5",
+    "react-dom": "^19.2.5",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.58.2",
     "vitest": "^4.0.18"
   },
   "peerDependencies": {