@schematichq/schematic-vue 0.1.0 → 1.4.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Schematic
+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
@@ -19,4 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-

package/README.md

@@ -137,6 +137,104 @@ const {
 
 _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` composable:
+
+```vue
+<script setup lang="ts">
+import { useSchematicPlan } from "@schematichq/schematic-vue";
+
+const plan = useSchematicPlan();
+</script>
+
+<template>
+  <div v-if="!plan">No plan assigned</div>
+  <div v-else>
+    <p>Current plan: {{ plan.name }}</p>
+
+    <p v-if="plan.trialStatus === 'active'">
+      Trial ends: {{ plan.trialEndDate?.toLocaleDateString() }}
+    </p>
+
+    <p v-if="plan.trialStatus === 'expired'">
+      Your trial has ended. <a href="/upgrade">Upgrade now</a>
+    </p>
+  </div>
+</template>
+```
+
+The composable 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).
+
+### Flag Check Fallbacks
+
+When flag checks cannot reach Schematic, they use fallback values in the following priority order:
+
+1. Callsite fallback - fallback values can be provided directly in the composable options
+2. Initialization defaults - fallback values configured via `flagCheckDefaults` or `flagValueDefaults` options when initializing the plugin
+3. Default value - Returns `false` if no fallback is configured
+
+```vue
+<script setup lang="ts">
+// Provide a fallback value at the callsite
+import { useSchematicFlag } from "@schematichq/schematic-vue";
+
+const isFeatureEnabled = useSchematicFlag("feature-flag", {
+    fallback: true,  // Used if API request fails
+});
+</script>
+
+<template>
+    <Feature v-if="isFeatureEnabled" />
+    <Fallback v-else />
+</template>
+```
+
+```typescript
+// Or configure defaults at initialization
+import { createApp } from "vue";
+import { SchematicPlugin } from "@schematichq/schematic-vue";
+
+const app = createApp(App);
+app.use(SchematicPlugin, {
+    publishableKey: "your-publishable-key",
+    flagValueDefaults: {
+        "feature-flag": true,  // Used if API request fails and no callsite fallback
+    },
+    flagCheckDefaults: {
+        "another-flag": {
+            flag: "another-flag",
+            value: true,
+            reason: "Default value",
+        },
+    },
+});
+```
+
+### Event Queueing and Retry
+
+When events (track, identify) cannot be sent due to network issues, they are automatically queued and retried:
+
+- Events are queued in memory (up to 100 events by default, configurable via `maxEventQueueSize`)
+- Failed events are retried with exponential backoff (up to 5 attempts by default, configurable via `maxEventRetries`)
+- Events are automatically flushed when the network connection is restored
+- Events queued when the page is hidden are sent when the page becomes visible
+
+### WebSocket Fallback
+
+In WebSocket mode, if the WebSocket connection fails, the SDK will provide the last known value or the configured fallback values as [outlined above](/#flag-check-fallbacks). The WebSocket will also automatically attempt to re-establish it's connection with Schematic using an exponential backoff. 
+
 ## Options API Support
 
 While the primary API uses the Composition API, you can still use these composables in the Options API: