@hybridly/vue 0.10.0-beta.25 → 0.10.0-beta.26

package/dist/index.d.mts

@@ -1,6 +1,7 @@
 import { FormDataConvertible, Path, PathValue, RequestData, SearchableObject } from "@hybridly/utils";
 import * as vue from "vue";
 import { App, Component, ComputedRef, DeepReadonly, DefineComponent, MaybeRefOrGetter, Plugin, PropType, Ref, SlotsType, h } from "vue";
+import * as _hybridly_core0 from "@hybridly/core";
 import { Errors, GlobalHybridlyProperties, HttpClient, HybridRequestOptions, Method, NavigationResponse, Plugin as Plugin$1, Progress, RequestMode, RouteName, RouteParameters, RouterContext, RouterContextOptions, UrlResolvable, Validation, registerHook as registerHook$1, route, router } from "@hybridly/core";
 import { Path as Path$1, SearchableObject as SearchableObject$1 } from "@clickbar/dot-diver";
 
@@ -291,7 +292,7 @@ declare const WhenVisible: vue.DefineComponent<vue.ExtractPropTypes<{
 }>> & Readonly<{
   onLoading?: ((_state: LoadStateSlotProps) => any) | undefined;
 }>, {
-  options: Omit<HybridRequestOptions, "data" | "method" | "url">;
+  options: Omit<HybridRequestOptions, "method" | "url" | "data">;
   as: string;
   buffer: number;
   root: string | Element | null;
@@ -1049,19 +1050,17 @@ declare function useRefinements<T extends Refinements>(input: MaybeRefOrGetter<T
 declare const registerHook: typeof registerHook$1;
 //#endregion
 //#region src/composables/table.d.ts
-declare global {
-  interface Table<T extends Record<string, any> = any, PaginatorKind extends 'cursor' | 'length-aware' | 'simple' = 'length-aware'> {
-    id: string;
-    keyName: string;
-    scope?: string;
-    columns: Column<T>[];
-    inlineActions: InlineAction[];
-    bulkActions: BulkAction[];
-    records: Array<T>;
-    paginator: Omit<PaginatorKind extends 'cursor' ? CursorPaginator<T> : (PaginatorKind extends 'simple' ? SimplePaginator<T> : Paginator<T>), 'data'>;
-    refinements: Refinements;
-    endpoint: string;
-  }
+interface Table<T extends Record<string, any> = any, PaginatorKind extends 'cursor' | 'length-aware' | 'simple' = 'length-aware'> {
+  id: string;
+  keyName: string;
+  scope?: string;
+  columns: Column<T>[];
+  inlineActions: InlineAction[];
+  bulkActions: BulkAction[];
+  records: Array<T>;
+  paginator: Omit<PaginatorKind extends 'cursor' ? CursorPaginator<T> : (PaginatorKind extends 'simple' ? SimplePaginator<T> : Paginator<T>), 'data'>;
+  refinements: Refinements;
+  endpoint: string;
 }
 interface Column<T extends object = never> {
   /** The name of this column. */
@@ -1093,9 +1092,6 @@ interface BulkActionOptions extends Omit<HybridRequestOptions, 'url'> {
   /** Force deselecting all records after action. */
   deselect?: boolean;
 }
-interface InlineActionOptions<T> extends Omit<HybridRequestOptions, 'url'> {
-  record: T;
-}
 interface InlineAction extends Action {}
 type RecordIdentifier = string | number;
 type AsRecordTypeWithExtra<T extends Record<string, any>> = { [K in keyof T]: {
@@ -1113,98 +1109,122 @@ interface TableDefaultOptions extends AvailableHybridRequestOptions {
    */
   data?: Record<string, FormDataConvertible> | FormDataConvertible;
 }
-/**
- * Provides utilities for working with tables.
- */
-declare function useTable<T extends Table<any, any>, RecordType extends Record<string, any> = (T extends Table<infer R, any> ? R : any), PaginatorKind extends 'cursor' | 'length-aware' | 'simple' = (T extends Table<any, infer P> ? P : 'length-aware'), RecordTypeWithExtra extends Record<string, any> = AsRecordTypeWithExtra<RecordType>>(input: MaybeRefOrGetter<T>, defaultOptions?: TableDefaultOptions): {
-  bindFilter: <T_1 = string | number>(name: string, options?: BindFilterOptions<T_1>) => vue.Ref<string>;
-  filters: BoundFilterRefinement[];
-  sorts: BoundSortRefinement[];
-  filtersKey: string;
-  sortsKey: string;
-  getFilter: (name: string) => BoundFilterRefinement | undefined;
-  getSort: (name: string) => BoundSortRefinement | undefined;
-  reset: (options?: AvailableHybridRequestOptions) => Promise<index_d_exports.NavigationResponse>;
-  toggleSort: (name: string, options?: ToggleSortOptions) => Promise<index_d_exports.NavigationResponse | undefined>;
-  isSorting: (name?: string, direction?: SortDirection) => boolean;
-  isFiltering: (name?: string) => boolean;
-  currentSorts: () => Array<SortRefinement>;
-  currentFilters: () => Array<FilterRefinement>;
-  clearFilter: (filter: string, options?: AvailableHybridRequestOptions) => Promise<index_d_exports.NavigationResponse>;
-  clearSorts: (options?: AvailableHybridRequestOptions) => Promise<index_d_exports.NavigationResponse>;
-  clearFilters: (options?: AvailableHybridRequestOptions) => Promise<index_d_exports.NavigationResponse>;
-  applyFilter: (name: string, value: any, options?: AvailableHybridRequestOptionsForFilters) => Promise<index_d_exports.NavigationResponse | undefined>;
+type UseTableNavigationResponse = Promise<_hybridly_core0.NavigationResponse | undefined>;
+type ExtractRefValue<T> = T extends {
+  value: infer Value;
+} ? Value : T;
+interface UseTableInlineActionItem<RecordType extends Record<string, any>, RecordTypeWithExtra extends Record<string, any>> extends InlineAction {
+  /** Executes the action. */
+  execute: (record: RecordTypeWithExtra | RecordIdentifier | RecordType) => UseTableNavigationResponse;
+}
+interface UseTableBulkActionItem extends BulkAction {
+  /** Executes the action. */
+  execute: (options?: BulkActionOptions) => UseTableNavigationResponse;
+}
+interface UseTableColumn<RecordTypeWithExtra extends Record<string, any>> extends Column<RecordTypeWithExtra> {
+  /** Toggles sorting for this column. */
+  toggleSort: (options?: ToggleSortOptions) => UseTableNavigationResponse;
+  /** Checks whether the column is being sorted. */
+  isSorting: (direction?: SortDirection) => boolean;
+  /** Applies the filter for this column. */
+  applyFilter: (value: any, options?: AvailableHybridRequestOptions) => UseTableNavigationResponse;
+  /** Clears the filter for this column. */
+  clearFilter: (options?: AvailableHybridRequestOptions) => UseTableNavigationResponse;
+  /** Checks whether the column is sortable. */
+  isSortable: boolean;
+  /** Checks whether the column is filterable. */
+  isFilterable: boolean;
+}
+interface UseTableRecordItem<RecordType extends Record<string, any>, RecordTypeWithExtra extends Record<string, any>> {
+  /** The actual record. */
+  record: RecordType;
+  /** The key of the record. Use this instead of `id`. */
+  key: RecordIdentifier;
+  /** Executes the given inline action. */
+  execute: (action: string | InlineAction) => UseTableNavigationResponse;
+  /** Gets the available inline actions. */
+  actions: Array<InlineAction & {
+    execute: () => UseTableNavigationResponse;
+  }>;
+  /** Selects this record. */
+  select: () => void;
+  /** Deselects this record. */
+  deselect: () => void;
+  /** Toggles the selection for this record. */
+  toggle: (force?: boolean) => void;
+  /** Checks whether this record is selected. */
+  selected: boolean;
+  /** Gets the value of the record for the specified column. */
+  value: (column: string | Column<RecordTypeWithExtra>) => any;
+  /** Gets the extra object of the record for the specified column. */
+  extra: (column: string | Column<RecordTypeWithExtra>, path: string) => any;
+}
+interface UseTableReturn<T extends Table<any, any>, RecordType extends Record<string, any> = (T extends Table<infer R, any> ? R : any), PaginatorKind extends 'cursor' | 'length-aware' | 'simple' = (T extends Table<any, infer P> ? P : 'length-aware'), RecordTypeWithExtra extends Record<string, any> = AsRecordTypeWithExtra<RecordType>> extends Omit<UseRefinements, 'filters' | 'sorts' | 'filtersKey' | 'sortsKey'> {
+  /** Selects all records. */
   selectAll: () => void;
+  /** Deselects all records. */
   deselectAll: () => void;
+  /** Selects records on the current page. */
   selectPage: () => void;
+  /** Deselects records on the current page. */
   deselectPage: () => void;
+  /** Whether all records on the current page are selected. */
   isPageSelected: boolean;
+  /** Checks if the given record is selected. */
   isSelected: (record: RecordTypeWithExtra | RecordType) => boolean;
+  /** Whether all records are selected. */
   allSelected: boolean;
+  /** Whether any records are selected. */
   anySelected: boolean;
+  /** The current record selection. */
   selection: BulkSelection<RecordIdentifier>;
+  /** Binds a checkbox to its selection state. */
   bindCheckbox: (key: RecordIdentifier) => {
     onChange: (event: Event) => void;
     checked: boolean;
     value: RecordIdentifier;
   };
+  /** Toggles selection for the given record. */
   toggle: (record: RecordTypeWithExtra | RecordType, force?: boolean) => void;
+  /** Toggles selection for all records. */
   toggleAll: (force?: boolean) => void;
+  /** Selects selection for the given record. */
   select: (record: RecordTypeWithExtra | RecordType) => void;
+  /** Deselects selection for the given record. */
   deselect: (record: RecordTypeWithExtra | RecordType) => void;
-  inlineActions: {
-    /** The name of this action. */name: string; /** The label of this action. */
-    label: string; /** The type of this action. */
-    type: string; /** Custom metadata for this action. */
-    metadata: any; /** A user-defined URL to which to post the action. */
-    url?: string; /** Executes the action. */
-    execute: (record: RecordTypeWithExtra | RecordIdentifier | RecordType) => Promise<index_d_exports.NavigationResponse | undefined>;
-  }[];
-  bulkActions: {
-    /** Should deselect all records after action. */deselect: boolean; /** The name of this action. */
-    name: string; /** The label of this action. */
-    label: string; /** The type of this action. */
-    type: string; /** Custom metadata for this action. */
-    metadata: any; /** A user-defined URL to which to post the action. */
-    url?: string; /** Executes the action. */
-    execute: (options?: BulkActionOptions) => Promise<index_d_exports.NavigationResponse | undefined>;
-  }[];
-  executeInlineAction: (action: InlineAction | string, options: InlineActionOptions<RecordTypeWithExtra | RecordIdentifier | RecordType>) => Promise<index_d_exports.NavigationResponse | undefined>;
-  executeBulkAction: (action: BulkAction | string, options?: BulkActionOptions) => Promise<index_d_exports.NavigationResponse | undefined>;
-  columns: {
-    /** Toggles sorting for this column. */toggleSort: (options?: ToggleSortOptions) => Promise<index_d_exports.NavigationResponse | undefined>; /** Checks whether the column is being sorted. */
-    isSorting: (direction?: SortDirection) => boolean; /** Applies the filer for this column. */
-    applyFilter: (value: any, options?: AvailableHybridRequestOptions) => Promise<index_d_exports.NavigationResponse | undefined>; /** Clears the filter for this column. */
-    clearFilter: (options?: AvailableHybridRequestOptions) => Promise<index_d_exports.NavigationResponse>; /** Checks whether the column is sortable. */
-    isSortable: boolean; /** Checks whether the column is filterable. */
-    isFilterable: boolean; /** The name of this column. */
-    name: keyof RecordTypeWithExtra; /** The label of this column. */
-    label: string; /** The type of this column. */
-    type: string; /** Metadata of this column. */
-    metadata: Record<string, any>;
-  }[];
+  /** List of inline actions for this table. */
+  inlineActions: Array<UseTableInlineActionItem<RecordType, RecordTypeWithExtra>>;
+  /** List of bulk actions for this table. */
+  bulkActions: Array<UseTableBulkActionItem>;
+  /** Executes the given inline action for the given record. */
+  executeInlineAction: (action: InlineAction | string, options: {
+    record: RecordTypeWithExtra | RecordIdentifier | RecordType;
+  } & Omit<HybridRequestOptions, 'url'>) => UseTableNavigationResponse;
+  /** Executes the given bulk action. */
+  executeBulkAction: (action: BulkAction | string, options?: Omit<HybridRequestOptions, 'url'> & {
+    deselect?: boolean;
+  }) => UseTableNavigationResponse;
+  /** List of columns for this table. */
+  columns: Array<UseTableColumn<RecordTypeWithExtra>>;
+  /** List of records for this table. */
   data: RecordType[];
-  records: {
-    /** The actual record. */record: RecordType; /** The key of the record. Use this instead of `id`. */
-    key: RecordIdentifier; /** Executes the given inline action. */
-    execute: (action: string | InlineAction) => Promise<index_d_exports.NavigationResponse | undefined>; /** Gets the available inline actions. */
-    actions: {
-      /** Executes the action. */execute: () => Promise<index_d_exports.NavigationResponse | undefined>; /** The name of this action. */
-      name: string; /** The label of this action. */
-      label: string; /** The type of this action. */
-      type: string; /** Custom metadata for this action. */
-      metadata: any; /** A user-defined URL to which to post the action. */
-      url?: string;
-    }[]; /** Selects this record. */
-    select: () => void; /** Deselects this record. */
-    deselect: () => void; /** Toggles the selection for this record. */
-    toggle: (force?: boolean) => void; /** Checks whether this record is selected. */
-    selected: boolean; /** Gets the value of the record for the specified column. */
-    value: (column: string | Column<RecordTypeWithExtra>) => any; /** Gets the extra object of the record for the specified column. */
-    extra: (column: string | Column<RecordTypeWithExtra>, path: string) => any;
-  }[];
-  paginator: PaginatorResult<unknown, Omit<PaginatorKind extends "cursor" ? CursorPaginator<RecordTypeWithExtra> : PaginatorKind extends "simple" ? SimplePaginator<RecordTypeWithExtra> : Paginator<RecordTypeWithExtra>, "data">>;
-};
+  /** List of records for this table. */
+  records: Array<UseTableRecordItem<RecordType, RecordTypeWithExtra>>;
+  /** Paginated meta and links. */
+  paginator: PaginatorResult<RecordTypeWithExtra, Table<RecordTypeWithExtra, PaginatorKind>['paginator']>;
+  /** Available filters. */
+  filters: ExtractRefValue<UseRefinements['filters']>;
+  /** Available sorts. */
+  sorts: ExtractRefValue<UseRefinements['sorts']>;
+  /** The key for the filters. */
+  filtersKey: ExtractRefValue<UseRefinements['filtersKey']>;
+  /** The key for the sorts. */
+  sortsKey: ExtractRefValue<UseRefinements['sortsKey']>;
+}
+/**
+ * Provides utilities for working with tables.
+ */
+declare function useTable<T extends Table<any, any>, RecordType extends Record<string, any> = (T extends Table<infer R, any> ? R : any), PaginatorKind extends 'cursor' | 'length-aware' | 'simple' = (T extends Table<any, infer P> ? P : 'length-aware'), RecordTypeWithExtra extends Record<string, any> = AsRecordTypeWithExtra<RecordType>>(input: MaybeRefOrGetter<T>, defaultOptions?: TableDefaultOptions): UseTableReturn<T, RecordType, PaginatorKind, RecordTypeWithExtra>;
 //#endregion
 //#region src/composables/validation.d.ts
 /** Accesses all validation errors grouped by bag name. */
@@ -1302,4 +1322,4 @@ interface SetupArguments {
   payload: Record<string, any>;
 }
 //#endregion
-export { Action, AvailableHybridRequestOptions, AvailableHybridRequestOptionsForFilters, BaseFilterRefinement, BindFilterOptions, BooleanFilterRefinement, BoundBooleanFilterRefinement, BoundCallbackFilterRefinement, BoundDateFilterRefinement, BoundFilterRefinement, BoundSelectFilterRefinement, BoundSortRefinement, BoundTernaryFilterRefinement, BoundTextFilterRefinement, BoundTrashedFilterRefinement, BulkAction, BulkSelection, CallbackFilterRefinement, Column, DateFilterRefinement, DefaultFormOptions, Deferred, FilterOperator, FilterRefinement, Form, type FormProps, FormReturn, type FormSlotProps, type FormSubmitOptions, type InitializeOptions, InlineAction, InternalProperties, MaybeWithData, NumericFilterRefinement, PaginatorResult, RecordIdentifier, Refinements, RouterLink, SelectFilterRefinement, SortDirection, SortRefinement, TableDefaultOptions, TernaryFilterRefinement, TextFilterRefinement, TimeSuggestion, TimeframeSuggestion, ToggleSortOptions, TrashedFilterRefinement, UseRefinements, WhenVisible, 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, useValidation, useValidationBag };
+export { Action, AvailableHybridRequestOptions, AvailableHybridRequestOptionsForFilters, BaseFilterRefinement, BindFilterOptions, BooleanFilterRefinement, BoundBooleanFilterRefinement, BoundCallbackFilterRefinement, BoundDateFilterRefinement, BoundFilterRefinement, BoundSelectFilterRefinement, BoundSortRefinement, BoundTernaryFilterRefinement, BoundTextFilterRefinement, BoundTrashedFilterRefinement, BulkAction, BulkSelection, CallbackFilterRefinement, Column, DateFilterRefinement, DefaultFormOptions, Deferred, FilterOperator, FilterRefinement, Form, type FormProps, FormReturn, type FormSlotProps, type FormSubmitOptions, type InitializeOptions, InlineAction, InternalProperties, MaybeWithData, NumericFilterRefinement, PaginatorResult, RecordIdentifier, Refinements, RouterLink, SelectFilterRefinement, SortDirection, SortRefinement, Table, TableDefaultOptions, TernaryFilterRefinement, TextFilterRefinement, TimeSuggestion, TimeframeSuggestion, ToggleSortOptions, TrashedFilterRefinement, UseRefinements, UseTableBulkActionItem, UseTableColumn, UseTableInlineActionItem, UseTableRecordItem, UseTableReturn, WhenVisible, 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, useValidation, useValidationBag };

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@hybridly/vue",
 	"type": "module",
-	"version": "0.10.0-beta.25",
+	"version": "0.10.0-beta.26",
 	"description": "Vue adapter for Hybridly",
 	"author": "Enzo Innocenzi <enzo@innocenzi.dev>",
 	"license": "MIT",
@@ -47,8 +47,8 @@
 	"dependencies": {
 		"@clickbar/dot-diver": "^1.0.7",
 		"es-toolkit": "^1.45.1",
-		"@hybridly/core": "0.10.0-beta.25",
-		"@hybridly/utils": "0.10.0-beta.25",
+		"@hybridly/core": "0.10.0-beta.26",
+		"@hybridly/utils": "0.10.0-beta.26",
 		"@vue/devtools-api": "^8.1.0",
 		"defu": "^6.1.4",
 		"nprogress": "^0.2.0"