@hybridly/vue 0.10.0-beta.8 → 0.10.0-beta.9

package/dist/index.d.mts

@@ -214,10 +214,10 @@ interface PaginatorMeta {
   prev_page_url?: string;
 }
 type MaybeWithData<T> = T | Omit<T, 'data'>;
-type PaginatorResult<T, P> = P extends MaybeWithData<Paginator<T>> ? P & {
-  to: (page: number) => Promise<index_d_exports.NavigationResponse> | undefined;
+type PaginatorResult<T, P = MaybeWithData<Paginator<T>>> = P extends MaybeWithData<Paginator<T>> ? P & {
+  to: (page: number, options?: Omit<index_d_exports.HybridRequestOptions, 'method' | 'url'>) => Promise<index_d_exports.NavigationResponse> | undefined;
 } : P;
-declare function createPaginator<T, P extends MaybeWithData<Paginator<T> | SimplePaginator<T> | CursorPaginator<T>>>(paginator: P, options?: Omit<index_d_exports.HybridRequestOptions, 'method' | 'url'>): PaginatorResult<T, P>;
+declare function createPaginator<T, P extends MaybeWithData<Paginator<T> | SimplePaginator<T> | CursorPaginator<T>>>(paginator: P, defaultOptions?: Omit<index_d_exports.HybridRequestOptions, 'method' | 'url'>): PaginatorResult<T, P>;
 //#endregion
 //#region src/composables/register-hook.d.ts
 /**
@@ -562,7 +562,7 @@ interface SortRefinement {
    */
   hidden: boolean;
 }
-interface Refinements$1 {
+interface Refinements {
   /**
    * The list of available filters.
    */
@@ -778,7 +778,7 @@ interface UseRefinements {
    */
   applyFilter: (name: string, value: any, options?: AvailableHybridRequestOptionsForFilters) => Promise<NavigationResponse | undefined>;
 }
-declare function useRefinements<T extends Refinements$1>(input: MaybeRefOrGetter<T>, defaultOptions?: AvailableHybridRequestOptions): UseRefinements;
+declare function useRefinements<T extends Refinements>(input: MaybeRefOrGetter<T>, defaultOptions?: AvailableHybridRequestOptions): UseRefinements;
 //#endregion
 //#region src/composables/current-route.d.ts
 declare function useRoute(): {
@@ -798,6 +798,8 @@ interface BulkSelection<T = any> {
 }
 declare function useBulkSelect<T = any>(): {
   allSelected: vue.ComputedRef<boolean>;
+  anySelected: vue.ComputedRef<boolean>;
+  toggleAll: (force?: boolean) => void;
   selectAll: () => void;
   deselectAll: () => void;
   select: (...records: T[]) => void;
@@ -846,15 +848,20 @@ interface Action {
   type: string;
   /** Custom metadata for this action. */
   metadata: any;
+  /** A user-defined URL to which to post the action. */
+  url?: string;
 }
 interface BulkAction extends Action {
   /** Should deselect all records after action. */
   deselect: boolean;
 }
-interface BulkActionOptions {
+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]: {
@@ -875,7 +882,7 @@ interface TableDefaultOptions extends AvailableHybridRequestOptions {
 /**
  * Provides utilities for working with tables.
  */
-declare function useTable<T extends Table, RecordType extends (T extends Table<infer R> ? R : never), RecordTypeWithExtra extends AsRecordTypeWithExtra<RecordType>, PaginatorKindName extends (T extends Table<RecordType, infer PaginatorKind> ? PaginatorKind : never), InputTable extends (T extends Table<RecordType, PaginatorKindName> ? Table<RecordType, PaginatorKindName> : never), ResolvedTable extends (T extends Table<RecordType, PaginatorKindName> ? Table<RecordTypeWithExtra, PaginatorKindName> : never)>(input: MaybeRefOrGetter<InputTable>, defaultOptions?: TableDefaultOptions): {
+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<T_1>;
   filters: BoundFilterRefinement[];
   sorts: BoundSortRefinement[];
@@ -898,34 +905,38 @@ declare function useTable<T extends Table, RecordType extends (T extends Table<i
   selectPage: () => void;
   deselectPage: () => void;
   isPageSelected: boolean;
-  isSelected: (record: RecordTypeWithExtra) => boolean;
+  isSelected: (record: RecordTypeWithExtra | RecordType) => boolean;
   allSelected: boolean;
+  anySelected: boolean;
   selection: BulkSelection<RecordIdentifier>;
   bindCheckbox: (key: RecordIdentifier) => {
     onChange: (event: Event) => void;
     checked: boolean;
     value: RecordIdentifier;
   };
-  toggle: (record: RecordTypeWithExtra) => void;
-  select: (record: RecordTypeWithExtra) => void;
-  deselect: (record: RecordTypeWithExtra) => void;
+  toggle: (record: RecordTypeWithExtra | RecordType, force?: boolean) => void;
+  toggleAll: (force?: boolean) => void;
+  select: (record: RecordTypeWithExtra | RecordType) => void;
+  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; /** Executes the action. */
-    execute: (record: RecordTypeWithExtra | RecordIdentifier) => Promise<index_d_exports.NavigationResponse>;
+    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; /** Executes the action. */
-    execute: (options?: BulkActionOptions) => Promise<index_d_exports.NavigationResponse>;
+    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: Action | string, record: RecordTypeWithExtra | RecordIdentifier) => Promise<index_d_exports.NavigationResponse>;
-  executeBulkAction: (action: Action | string, options?: BulkActionOptions) => Promise<index_d_exports.NavigationResponse>;
+  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. */
@@ -940,24 +951,25 @@ declare function useTable<T extends Table, RecordType extends (T extends Table<i
   }[];
   data: RecordType[];
   records: {
-    /** The actual record. */record: any[]; /** The key of the record. Use this instead of `id`. */
+    /** 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>; /** Gets the available inline actions. */
+    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>; /** The name of this action. */
+      /** 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;
+      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>) => RecordType[string] | RecordType[number] | RecordType[symbol]; /** Gets the extra object 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<PaginatorKindName extends "cursor" ? CursorPaginator<RecordTypeWithExtra> : PaginatorKindName extends "simple" ? SimplePaginator<RecordTypeWithExtra> : Paginator<RecordTypeWithExtra>, "data">>;
+  paginator: PaginatorResult<unknown, Omit<PaginatorKind extends "cursor" ? CursorPaginator<RecordTypeWithExtra> : PaginatorKind extends "simple" ? SimplePaginator<RecordTypeWithExtra> : Paginator<RecordTypeWithExtra>, "data">>;
 };
 //#endregion
 //#region src/composables/query-parameters.d.ts
@@ -1052,4 +1064,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, 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 };
+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, 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

@@ -824,15 +824,19 @@ function useBackForward(options) {
 var src_exports = /* @__PURE__ */ __exportAll({});
 import * as import__hybridly_core from "@hybridly/core";
 __reExport(src_exports, import__hybridly_core);
-function createPaginator(paginator, options) {
+function createPaginator(paginator, defaultOptions) {
 	const isPaginator = (p) => {
 		return "links" in p && "meta" in p && "last_page" in p.meta;
 	};
 	if (isPaginator(paginator)) return {
 		...paginator,
-		to: (page) => {
+		to: (page, options) => {
 			const link = paginator.links.find((l) => l.page === page);
-			if (link?.url) return src_exports.router.get(link.url, options);
+			if (link?.url) return src_exports.router.get(link.url, {
+				preserveState: true,
+				...defaultOptions,
+				...options
+			});
 		}
 	};
 	return paginator;
@@ -1086,6 +1090,10 @@ function useBulkSelect() {
 		only: /* @__PURE__ */ new Set(),
 		except: /* @__PURE__ */ new Set()
 	});
+	function toggleAll(force) {
+		if (!selection.value.all || force === true) selectAll();
+		else deselectAll();
+	}
 	function selectAll() {
 		selection.value.all = true;
 		selection.value.only.clear();
@@ -1115,6 +1123,9 @@ function useBulkSelect() {
 	const allSelected = computed(() => {
 		return selection.value.all && selection.value.except.size === 0;
 	});
+	const anySelected = computed(() => {
+		return selection.value.all || selection.value.only.size > 0;
+	});
 	function bindCheckbox(key) {
 		return {
 			onChange: (event) => {
@@ -1128,6 +1139,8 @@ function useBulkSelect() {
 	}
 	return {
 		allSelected,
+		anySelected,
+		toggleAll,
 		selectAll,
 		deselectAll,
 		select,
@@ -1177,36 +1190,61 @@ function useTable(input, defaultOptions = {}) {
 	const table = computed(() => toValue(input));
 	const bulk = useBulkSelect();
 	const refinements = useRefinements(() => toValue(input).refinements, defaultOptions);
-	function getAdditionnalData() {
+	function getAdditionnalData(options) {
 		const data = {};
+		options = {
+			...defaultOptions,
+			...options
+		};
 		if (defaultOptions?.includeQueryParameters !== false) Object.assign(data, structuredClone(toRaw(useQueryParameters())));
-		if (defaultOptions?.data) Object.assign(data, defaultOptions.data);
+		if (options?.data) Object.assign(data, options.data);
 		return data;
 	}
 	function getRecordKey(record) {
 		if (typeof record !== "object") return record;
 		if (Reflect.has(record, "__hybridId")) return Reflect.get(record, "__hybridId");
-		return Reflect.get(record, table.value.keyName).value;
+		if (!table.value.keyName) throw new Error("Record key cannot be fetched because the table has no defined key.");
+		const value = Reflect.get(record, table.value.keyName);
+		if (typeof value === "object" && Reflect.has(value, "value")) return value.value;
+		return value;
+	}
+	function resolveInlineAction(action) {
+		if (typeof action !== "string") return action;
+		return table.value.inlineActions.find(({ name }) => name === action);
+	}
+	function resolveBulkAction(action) {
+		if (typeof action !== "string") return action;
+		return table.value.bulkActions.find(({ name }) => name === action);
 	}
-	function getActionName(action) {
-		return typeof action === "string" ? action : action.name;
+	function getActionUrl(action, table) {
+		if (action.url) return action.url;
+		return route$1(table.endpoint);
 	}
-	async function executeInlineAction(action, record) {
+	async function executeInlineAction(action, options) {
+		const resolvedAction = resolveInlineAction(action);
+		if (!resolvedAction) {
+			console.warn(`Action [${action}] is not defined`);
+			return;
+		}
 		return await router$1.navigate({
 			method: "post",
-			url: route$1(table.value.endpoint),
+			url: getActionUrl(resolvedAction, table.value),
 			preserveState: true,
 			data: {
-				...getAdditionnalData(),
+				...getAdditionnalData(options),
 				type: "action:inline",
-				action: getActionName(action),
+				action: resolvedAction.name,
 				tableId: table.value.id,
-				recordId: getRecordKey(record)
+				recordId: getRecordKey(options.record)
 			}
 		});
 	}
-	async function executeBulkAction(action, options) {
-		const actionName = getActionName(action);
+	async function executeBulkAction(action, options = {}) {
+		const resolvedAction = resolveBulkAction(action);
+		if (!resolvedAction) {
+			console.warn(`Action [${action}] is not defined`);
+			return;
+		}
 		const filterParameters = refinements.currentFilters().reduce((carry, filter) => {
 			return {
 				...carry,
@@ -1215,12 +1253,12 @@ function useTable(input, defaultOptions = {}) {
 		}, {});
 		return await router$1.navigate({
 			method: "post",
-			url: route$1(table.value.endpoint),
+			url: getActionUrl(resolvedAction, table.value),
 			preserveState: true,
 			data: {
-				...getAdditionnalData(),
+				...getAdditionnalData(options),
 				type: "action:bulk",
-				action: actionName,
+				action: resolvedAction.name,
 				tableId: table.value.id,
 				all: bulk.selection.value.all,
 				only: [...bulk.selection.value.only],
@@ -1228,7 +1266,7 @@ function useTable(input, defaultOptions = {}) {
 				[refinements.filtersKey.value]: filterParameters
 			},
 			hooks: { after: () => {
-				if (options?.deselect === true || table.value.bulkActions.find(({ name }) => name === actionName)?.deselect !== false) bulk.deselectAll();
+				if (options?.deselect === true || resolvedAction.deselect !== false) bulk.deselectAll();
 			} }
 		});
 	}
@@ -1240,17 +1278,19 @@ function useTable(input, defaultOptions = {}) {
 		isPageSelected: computed(() => table.value.records.length > 0 && table.value.records.every((record) => bulk.selected(getRecordKey(record)))),
 		isSelected: (record) => bulk.selected(getRecordKey(record)),
 		allSelected: bulk.allSelected,
+		anySelected: bulk.anySelected,
 		selection: bulk.selection,
 		bindCheckbox: (key) => bulk.bindCheckbox(key),
-		toggle: (record) => bulk.toggle(getRecordKey(record)),
+		toggle: (record, force) => bulk.toggle(getRecordKey(record), force),
+		toggleAll: (force) => bulk.toggleAll(force),
 		select: (record) => bulk.select(getRecordKey(record)),
 		deselect: (record) => bulk.deselect(getRecordKey(record)),
 		inlineActions: computed(() => table.value.inlineActions.map((action) => ({
-			execute: (record) => executeInlineAction(action.name, record),
+			execute: (record) => executeInlineAction(action, { record }),
 			...action
 		}))),
 		bulkActions: computed(() => table.value.bulkActions.map((action) => ({
-			execute: (options) => executeBulkAction(action.name, options),
+			execute: (options) => executeBulkAction(action, options),
 			...action
 		}))),
 		executeInlineAction,
@@ -1271,22 +1311,25 @@ function useTable(input, defaultOptions = {}) {
 				return Object.fromEntries(entries);
 			}).filter(Boolean);
 		}),
-		records: computed(() => table.value.records.map((record) => ({
-			record: Object.values(record).map((record) => record.value),
-			key: getRecordKey(record),
-			execute: (action) => executeInlineAction(getActionName(action), getRecordKey(record)),
-			actions: table.value.inlineActions.map((action) => ({
-				...action,
-				execute: () => executeInlineAction(action.name, getRecordKey(record))
-			})),
-			select: () => bulk.select(getRecordKey(record)),
-			deselect: () => bulk.deselect(getRecordKey(record)),
-			toggle: (force) => bulk.toggle(getRecordKey(record), force),
-			selected: bulk.selected(getRecordKey(record)),
-			value: (column) => record[typeof column === "string" ? column : column.name].value,
-			extra: (column, path) => getByPath(record[typeof column === "string" ? column : column.name].extra, path)
-		}))),
-		paginator: computed(() => createPaginator(table.value.paginator)),
+		records: computed(() => table.value.records.map((record) => {
+			const entries = Object.entries(record).map(([key, value]) => [key, value.value]).filter(([key]) => key !== "__hybridId");
+			return {
+				record: entries.length > 0 ? Object.fromEntries(entries) : {},
+				key: getRecordKey(record),
+				execute: (action) => executeInlineAction(action, { record: getRecordKey(record) }),
+				actions: table.value.inlineActions.map((action) => ({
+					...action,
+					execute: () => executeInlineAction(action.name, { record: getRecordKey(record) })
+				})),
+				select: () => bulk.select(getRecordKey(record)),
+				deselect: () => bulk.deselect(getRecordKey(record)),
+				toggle: (force) => bulk.toggle(getRecordKey(record), force),
+				selected: bulk.selected(getRecordKey(record)),
+				value: (column) => record[typeof column === "string" ? column : column.name].value,
+				extra: (column, path) => getByPath(record[typeof column === "string" ? column : column.name].extra, path)
+			};
+		})),
+		paginator: computed(() => createPaginator(table.value.paginator, defaultOptions)),
 		...refinements
 	});
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hybridly/vue",
   "type": "module",
-  "version": "0.10.0-beta.8",
+  "version": "0.10.0-beta.9",
   "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.8",
-    "@hybridly/utils": "0.10.0-beta.8",
+    "@hybridly/core": "0.10.0-beta.9",
+    "@hybridly/utils": "0.10.0-beta.9",
     "@vue/devtools-api": "^7.7.6",
     "defu": "^6.1.4",
     "lodash.isequal": "^4.5.0",