@antcde/vue-utils 0.2.32 → 0.2.33-rc.1

package/dist/types/apiErrorMessage.d.ts

@@ -0,0 +1,2 @@
+/** The API's own message (first validation error, then `message`), else the fallback. */
+export declare function apiErrorMessage(error: unknown, fallback: string): string;

package/dist/types/deviceType.d.ts

@@ -0,0 +1,3 @@
+import { DeviceType } from '@antcde/connect-ts';
+/** The MDI icon for a paired device's type; unknown values get the generic one. */
+export declare function deviceTypeIcon(type: DeviceType | string | null | undefined): string;

package/dist/types/index.d.ts

@@ -1,3 +1,5 @@
+export { apiErrorMessage } from './apiErrorMessage';
+export { deviceTypeIcon } from './deviceType';
 export { type DateFormatPreset, formatDate, type FormatDateOptions, formatDateRange, type FormatDateRangeOptions } from './formatDate';
 export { formatRefreshLabel, type RefreshTranslate } from './refreshLabel';
 export { browserZone, buildScheduleRule, defaultScheduleSpec, describeRefresh, parseScheduleRule, type RefreshDescription, SCHEDULE_DAYS, type ScheduleFreq, type ScheduleMonthly, type ScheduleNth, type ScheduleSpec, weekdayOf, } from './refreshSchedule';
@@ -9,7 +11,9 @@ export { useAppQueryParam, type UseAppQueryParamOptions } from './useAppQueryPar
 export { useAppTourMode } from './useAppTourMode';
 export { type UseCommsClient, useCommsClient } from './useCommsClient';
 export { type CommsHostArgs, type UseCommsHost, useCommsHost } from './useCommsHost';
+export { DEVICE_BREAKPOINTS, type DeviceClass, useDeviceClass, type UseDeviceClassReturn } from './useDeviceClass';
 export { useFeature } from './useFeature';
+export { useHostDevice, type UseHostDeviceReturn } from './useHostDevice';
 export { type UsePermissions, usePermissions } from './usePermissions';
 export { useTemplateVersioning, type UseTemplateVersioningReturn } from './useTemplateVersioning';
 export { useTriggerDispatch, type UseTriggerDispatchOptions, type UseTriggerDispatchReturn } from './useTriggerDispatch';

package/dist/types/useCommsHost.d.ts

@@ -1,4 +1,4 @@
-import { AntConnect, AppManifest, FeatureFlags, LabelFilterState, License, Notepad, Notification, ProjectShort, SignalObserverFactory, SignalReceiver, SignalSender, Task, User } from '@antcde/connect-ts';
+import { AntConnect, AppManifest, DeviceContext, FeatureFlags, LabelFilterState, License, Notepad, Notification, ProjectShort, SignalObserverFactory, SignalReceiver, SignalSender, Task, User } from '@antcde/connect-ts';
 import { SubscriptionLike } from 'rxjs';
 import { Ref } from 'vue';
 import { CommsToolbar } from './utils';
@@ -22,6 +22,8 @@ export interface CommsHostArgs {
             code: string;
         }>>;
         darkMode: Ref<Nullable<boolean>>;
+        /** Host device class; optional so an older host still type-checks. */
+        device?: Ref<Nullable<DeviceContext>>;
         selectedLabels: Ref<LabelFilterState>;
         features?: Ref<Nullable<FeatureFlags>>;
     };

package/dist/types/useDeviceClass.d.ts

@@ -0,0 +1,19 @@
+import { ComputedRef, Ref } from 'vue';
+export type DeviceClass = 'phone' | 'tablet' | 'desktop';
+export declare const DEVICE_BREAKPOINTS: {
+    readonly handheld: 768;
+    readonly phone: 1105;
+    readonly tablet: 1280;
+};
+export interface UseDeviceClassReturn {
+    device: ComputedRef<DeviceClass>;
+    isPhone: ComputedRef<boolean>;
+    isTablet: ComputedRef<boolean>;
+    isDesktop: ComputedRef<boolean>;
+    /** Primary pointer is a finger. False on a touch laptop driven by its trackpad. */
+    isCoarsePointer: Ref<boolean>;
+    isPortrait: ComputedRef<boolean>;
+    width: Ref<number>;
+    height: Ref<number>;
+}
+export declare const useDeviceClass: () => UseDeviceClassReturn;

package/dist/types/useHostDevice.d.ts

@@ -0,0 +1,17 @@
+import { Context } from '@antcde/connect-ts';
+import { ComputedRef, Ref } from 'vue';
+import { DeviceClass } from './useDeviceClass';
+export interface UseHostDeviceReturn {
+    device: ComputedRef<DeviceClass>;
+    isPhone: ComputedRef<boolean>;
+    isTablet: ComputedRef<boolean>;
+    isDesktop: ComputedRef<boolean>;
+    /** Primary pointer is a finger. */
+    isTouch: ComputedRef<boolean>;
+}
+/**
+ * The device class the OS shell runs on, read from the comms context. Use it for
+ * shell decisions (phone layout, touch targets), not for pane width: a split pane
+ * on desktop is narrow too. An older OS sends no device; the app's own frame decides then.
+ */
+export declare function useHostDevice(context: Ref<Context>): UseHostDeviceReturn;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@antcde/vue-utils",
   "type": "module",
-  "version": "0.2.32",
+  "version": "0.2.33-rc.1",
   "description": "Helper to use ANT Comms in Vue 3",
   "author": "CollaborAll",
   "exports": {
@@ -33,7 +33,7 @@
     "vue-i18n": "^11.1.12"
   },
   "dependencies": {
-    "@antcde/connect-ts": "0.4.37",
+    "@antcde/connect-ts": "0.4.38-rc.1",
     "rrule": "^2.8.1"
   },
   "devDependencies": {