@hybridly/vue 0.10.0-beta.5 → 0.10.0-beta.7

package/dist/index.d.mts

@@ -456,6 +456,52 @@ interface NumericFilterRefinement extends BaseFilterRefinement {
   type: 'numeric';
   operator?: FilterOperator;
 }
+/**
+ * Time suggestion for single date filters.
+ */
+interface TimeSuggestion {
+  type: 'time';
+  label: string;
+  date: string;
+}
+/**
+ * Timeframe suggestion for date range filters.
+ */
+interface TimeframeSuggestion {
+  type: 'timeframe';
+  label: string;
+  start: string;
+  end: string;
+}
+/**
+ * Date filter refinement.
+ */
+interface DateFilterRefinement extends BaseFilterRefinement {
+  type: 'date';
+  operator?: FilterOperator;
+  metadata: BaseFilterRefinement['metadata'] & {
+    /**
+     * Whether this is a timeframe filter (with start and end columns).
+     */
+    is_timeframe?: boolean;
+    /**
+     * The start column for timeframe filters.
+     */
+    start_column?: string;
+    /**
+     * The end column for timeframe filters.
+     */
+    end_column?: string;
+    /**
+     * Suggested dates or timeframes for this filter.
+     */
+    suggestions?: Array<TimeSuggestion | TimeframeSuggestion>;
+    /**
+     * A description for this filter, suitable for display purposes.
+     */
+    description?: string;
+  };
+}
 /**
  * Trashed filter refinement.
  */
@@ -473,7 +519,7 @@ interface CallbackFilterRefinement extends BaseFilterRefinement {
 /**
  * Represents a filter.
  */
-type FilterRefinement = TextFilterRefinement | SelectFilterRefinement | TernaryFilterRefinement | BooleanFilterRefinement | NumericFilterRefinement | TrashedFilterRefinement | CallbackFilterRefinement;
+type FilterRefinement = TextFilterRefinement | SelectFilterRefinement | TernaryFilterRefinement | BooleanFilterRefinement | NumericFilterRefinement | DateFilterRefinement | TrashedFilterRefinement | CallbackFilterRefinement;
 interface SortRefinement {
   /**
    * Whether this sort is currently active.
@@ -559,6 +605,10 @@ interface BoundFilterRefinementMethods {
    * Searches this filter.
    */
   search: (value?: string | number, options?: AvailableHybridRequestOptions) => Promise<NavigationResponse | undefined>;
+  /**
+   * Whether this filter is a date filter.
+   */
+  isDateFilter: () => boolean;
   /**
    * Whether this filter is a select filter.
    */
@@ -588,6 +638,10 @@ interface BoundFilterRefinementMethods {
  * Checks whether the given filter is a text filter, and narrows its type.
  */
 declare function isTextFilter(filter: FilterRefinement | BoundFilterRefinement): filter is BoundTextFilterRefinement;
+/**
+ * Checks whether the given filter is a date filter, and narrows its type.
+ */
+declare function isDateFilter(filter: FilterRefinement | BoundFilterRefinement): filter is BoundDateFilterRefinement;
 /**
  * Checks whether the given filter is a select filter, and narrows its type.
  */
@@ -612,6 +666,10 @@ declare function isCallbackFilter(filter: FilterRefinement | BoundFilterRefineme
  * Bound text filter refinement with type-specific methods.
  */
 interface BoundTextFilterRefinement extends TextFilterRefinement, BoundFilterRefinementMethods {}
+/**
+ * Bound date filter refinement with type-specific methods.
+ */
+interface BoundDateFilterRefinement extends DateFilterRefinement, BoundFilterRefinementMethods {}
 /**
  * Bound select filter refinement with type-specific methods.
  */
@@ -994,4 +1052,4 @@ interface SetupArguments {
   payload: Record<string, any>;
 }
 //#endregion
-export { Action, AvailableHybridRequestOptions, AvailableHybridRequestOptionsForFilters, BaseFilterRefinement, BindFilterOptions, BooleanFilterRefinement, BoundBooleanFilterRefinement, BoundCallbackFilterRefinement, BoundFilterRefinement, BoundSelectFilterRefinement, BoundSortRefinement, BoundTernaryFilterRefinement, BoundTextFilterRefinement, BoundTrashedFilterRefinement, BulkAction, BulkSelection, CallbackFilterRefinement, Column, DefaultFormOptions, FilterOperator, FilterRefinement, FormReturn, type InitializeOptions, InlineAction, InternalProperties, MaybeWithData, NumericFilterRefinement, PaginatorResult, RecordIdentifier, Refinements$1 as Refinements, RouterLink, SelectFilterRefinement, SortDirection, SortRefinement, TableDefaultOptions, TernaryFilterRefinement, TextFilterRefinement, ToggleSortOptions, TrashedFilterRefinement, UseRefinements, can, createPaginator, initializeHybridly, isBooleanFilter, isCallbackFilter, isSelectFilter, isTernaryFilter, isTextFilter, isTrashedFilter, registerHook, route, router, setProperty, useBackForward, useBulkSelect, useDialog, useForm, useHistoryState, useProperties, useProperty, useQueryParameter, useQueryParameters, useRefinements, useRoute, useTable };
+export { Action, AvailableHybridRequestOptions, AvailableHybridRequestOptionsForFilters, BaseFilterRefinement, BindFilterOptions, BooleanFilterRefinement, BoundBooleanFilterRefinement, BoundCallbackFilterRefinement, BoundDateFilterRefinement, BoundFilterRefinement, BoundSelectFilterRefinement, BoundSortRefinement, BoundTernaryFilterRefinement, BoundTextFilterRefinement, BoundTrashedFilterRefinement, BulkAction, BulkSelection, CallbackFilterRefinement, Column, DateFilterRefinement, DefaultFormOptions, FilterOperator, FilterRefinement, FormReturn, type InitializeOptions, InlineAction, InternalProperties, MaybeWithData, NumericFilterRefinement, PaginatorResult, RecordIdentifier, Refinements$1 as Refinements, RouterLink, SelectFilterRefinement, SortDirection, SortRefinement, TableDefaultOptions, TernaryFilterRefinement, TextFilterRefinement, TimeSuggestion, TimeframeSuggestion, ToggleSortOptions, TrashedFilterRefinement, UseRefinements, can, createPaginator, initializeHybridly, isBooleanFilter, isCallbackFilter, isDateFilter, isSelectFilter, isTernaryFilter, isTextFilter, isTrashedFilter, registerHook, route, router, setProperty, useBackForward, useBulkSelect, useDialog, useForm, useHistoryState, useProperties, useProperty, useQueryParameter, useQueryParameters, useRefinements, useRoute, useTable };

package/dist/index.mjs

@@ -857,6 +857,9 @@ function useDialog() {
 function isTextFilter(filter) {
 	return filter.type === "text";
 }
+function isDateFilter(filter) {
+	return filter.type === "date";
+}
 function isSelectFilter(filter) {
 	return filter.type === "select";
 }
@@ -901,6 +904,7 @@ function useRefinements(input, defaultOptions = {}) {
 			clear: (options) => clearFilter(filter.name, options),
 			search: (query, options) => searchFilter(filter.name, query, options),
 			isSelectFilter: () => isSelectFilter(filter),
+			isDateFilter: () => isDateFilter(filter),
 			isSearchFilter: () => isTextFilter(filter),
 			isTernaryFilter: () => isTernaryFilter(filter),
 			isBooleanFilter: () => isBooleanFilter(filter),
@@ -1286,4 +1290,4 @@ function useTable(input, defaultOptions = {}) {
 		...refinements
 	});
 }
-export { RouterLink, can, createPaginator, initializeHybridly, isBooleanFilter, isCallbackFilter, isSelectFilter, isTernaryFilter, isTextFilter, isTrashedFilter, registerHook, route, router, setProperty, useBackForward, useBulkSelect, useDialog, useForm, useHistoryState, useProperties, useProperty, useQueryParameter, useQueryParameters, useRefinements, useRoute, useTable };
+export { RouterLink, can, createPaginator, initializeHybridly, isBooleanFilter, isCallbackFilter, isDateFilter, isSelectFilter, isTernaryFilter, isTextFilter, isTrashedFilter, registerHook, route, router, setProperty, useBackForward, useBulkSelect, useDialog, useForm, useHistoryState, useProperties, useProperty, useQueryParameter, useQueryParameters, useRefinements, useRoute, useTable };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hybridly/vue",
   "type": "module",
-  "version": "0.10.0-beta.5",
+  "version": "0.10.0-beta.7",
   "description": "Vue adapter for Hybridly",
   "author": "Enzo Innocenzi <enzo@innocenzi.dev>",
   "license": "MIT",
@@ -46,8 +46,8 @@
   },
   "dependencies": {
     "@clickbar/dot-diver": "^1.0.7",
-    "@hybridly/core": "0.10.0-beta.5",
-    "@hybridly/utils": "0.10.0-beta.5",
+    "@hybridly/core": "0.10.0-beta.7",
+    "@hybridly/utils": "0.10.0-beta.7",
     "@vue/devtools-api": "^7.7.6",
     "defu": "^6.1.4",
     "lodash.isequal": "^4.5.0",