@schematichq/schematic-vue 0.1.0 → 1.4.0

package/dist/schematic-vue.d.ts

@@ -1,5 +1,6 @@
 import { App } from 'vue';
 import { CheckFlagReturn } from '@schematichq/schematic-js';
+import { CheckPlanReturn } from '@schematichq/schematic-js';
 import { ComputedRef } from 'vue';
 import { Event as Event_2 } from '@schematichq/schematic-js';
 import { EventBody } from '@schematichq/schematic-js';
@@ -21,6 +22,8 @@ declare type BaseSchematicPluginOptions = Omit<SchematicJS.SchematicOptions, "cl
 
 export { CheckFlagReturn }
 
+export { CheckPlanReturn }
+
 export { Event_2 as Event }
 
 export { EventBody }
@@ -142,6 +145,7 @@ export declare const useSchematicEntitlement: (key: string, opts?: UseSchematicF
     check: ComputedRef<    {
     featureUsageExceeded?: boolean | undefined;
     companyId?: string | undefined;
+    creditRemaining?: number | undefined;
     error?: string | undefined;
     featureAllocation?: number | undefined;
     featureUsage?: number | undefined;
@@ -153,6 +157,7 @@ export declare const useSchematicEntitlement: (key: string, opts?: UseSchematicF
     reason: string;
     ruleId?: string | undefined;
     ruleType?: SchematicJS.RuleType | undefined;
+    softLimit?: number | undefined;
     userId?: string | undefined;
     value: boolean;
     }>;
@@ -236,4 +241,25 @@ export declare type UseSchematicFlagOpts = SchematicComposableOpts & {
  */
 export declare const useSchematicIsPending: (opts?: SchematicComposableOpts) => Ref<boolean>;
 
+/**
+ * Get the current plan for the identified company
+ * Returns a reactive ref that updates when the plan changes
+ *
+ * @param opts - Optional configuration including fallback value
+ * @returns Ref<SchematicJS.CheckPlanReturn | undefined> - Reactive plan data
+ *
+ * @example
+ * ```typescript
+ * const plan = useSchematicPlan()
+ *
+ * // In template
+ * <div v-if="plan">Current plan: {{ plan.name }}</div>
+ * ```
+ */
+export declare const useSchematicPlan: (opts?: UseSchematicPlanOpts) => Ref<SchematicJS.CheckPlanReturn | undefined>;
+
+export declare type UseSchematicPlanOpts = SchematicComposableOpts & {
+    fallback?: SchematicJS.CheckPlanReturn;
+};
+
 export { }