@antcde/vue-utils 0.2.0 → 0.2.7

package/dist/types/index.d.ts

@@ -2,4 +2,4 @@ export { useAntColorMode, type UseAntColorModeOptions, type UseAntColorModeRetur
 export { useAntI18n, type UseAntI18nReturn } from './useAntI18n';
 export { type UseCommsClient, useCommsClient } from './useCommsClient';
 export { type CommsHostArgs, type UseCommsHost, useCommsHost } from './useCommsHost';
-export { type AnyUseApiReturn, type CommsToolbar, signalRef, useApi, type UseApiReturn, useCommsInjection, useSingleton, watchSignal, } from './utils';
+export { type AnyUseApiReturn, type CommsToolbar, useApi, type UseApiReturn, useCommsInjection, useSignal, useSingleton, } from './utils';

package/dist/types/useAntColorMode.d.ts

@@ -1,5 +1,5 @@
-import { UseCommsClient } from './useCommsClient';
 import { BasicColorSchema, UseColorModeOptions, UseColorModeReturn } from '@vueuse/core';
+import { UseCommsClient } from './useCommsClient';
 import { Ref } from 'vue';
 
 export type UseAntColorModeOptions = UseColorModeOptions<BasicColorSchema>;

package/dist/types/useAntI18n.d.ts

@@ -1,10 +1,10 @@
-import { UseI18nOptions, useI18n } from 'vue-i18n';
+import { Composer, UseI18nOptions } from 'vue-i18n';
 import { UseCommsClient } from './useCommsClient';
 
-export type UseAntI18nReturn<Options extends UseI18nOptions = UseI18nOptions> = ReturnType<typeof useI18n<Options>>;
+export type UseAntI18nReturn = Composer;
 /**
  * Listens to the changing locale received from comms and translations will automatically refresh due to internal watcher.
  * @param comms
  * @param options
  */
-export declare function useAntI18n<Options extends UseI18nOptions = UseI18nOptions>(comms: UseCommsClient, options?: Options): UseAntI18nReturn<Options>;
+export declare function useAntI18n(comms: UseCommsClient, options?: UseI18nOptions): UseAntI18nReturn;

package/dist/types/useCommsClient.d.ts

@@ -1,13 +1,12 @@
-import { AntConnect, Client, Context, LocaleData, Signal } from '@antcde/connect-ts';
+import { AntConnect, Client, Context, Signal } from '@antcde/connect-ts';
 import { ObservableInput } from 'rxjs';
 import { CommsToolbar } from './utils';
 import { Ref } from 'vue';
 
-export interface UseCommsClient extends Omit<Client, 'context' | 'toolbar' | 'appState' | 'locales'> {
+export interface UseCommsClient extends Omit<Client, 'context' | 'toolbar' | 'appState'> {
     context: Ref<Context>;
     toolbar: CommsToolbar;
     appState: Ref<string>;
-    locales: Ref<LocaleData>;
 }
 type KeyboardShortcutsHook = (signal: Signal) => ObservableInput<Signal>;
 /**

package/dist/types/useCommsHost.d.ts

@@ -1,7 +1,7 @@
 import { AntConnect, License, Notepad, Notification, ProjectShort, SignalReceiver, SignalSender, Task, User } from '@antcde/connect-ts';
+import { CommsToolbar } from './utils';
 import { SubscriptionLike } from 'rxjs';
 import { Ref } from 'vue';
-import { CommsToolbar } from './utils';
 
 type Nullable<T> = NonNullable<T> | null | undefined;
 export interface CommsHostArgs {

package/dist/types/utils.d.ts

@@ -0,0 +1,38 @@
+import { Signal, ToolbarItem } from '@antcde/connect-ts';
+import { UseAsyncStateOptions, UseAsyncStateReturn } from '@vueuse/core';
+import { DeepReadonly, FunctionPlugin, Ref, UnwrapRef, WatchStopHandle } from 'vue';
+import { UseCommsClient } from './useCommsClient';
+
+type RefObject<T> = {
+    [K in keyof T]: T[K];
+};
+export declare function unrefObject<T extends object>(obj: RefObject<T>): UnwrapRef<T>;
+export interface CommsToolbar {
+    title: Ref<string | undefined>;
+    searchEnabled: Ref<boolean>;
+    search: Ref<string>;
+    menu: Ref<ToolbarItem[]>;
+    isLoading: Ref<boolean>;
+}
+interface UseCommsFactoryResult {
+    provideComms: FunctionPlugin;
+    injectComms: () => UseCommsClient;
+}
+export declare function useCommsInjection(name?: string): UseCommsFactoryResult;
+export declare function useSingleton<T extends object>(name: string, factory: () => T, dispose?: (value: T) => void): [provide: FunctionPlugin, inject: () => T];
+export declare function useApi<Data, Params extends any[] = [], Shallow extends boolean = true>(promise: Promise<Data> | ((...args: Params) => Promise<Data>), initialState: Data, options?: UseAsyncStateOptions<Shallow, Data>): UseApiReturn<Data, Params, Shallow>;
+export interface UseApiReturn<Data, Params extends any[], Shallow extends boolean> extends Omit<UseAsyncStateReturn<Data, Params, Shallow>, 'execute'> {
+    execute: (...args: Params) => Promise<Data>;
+    executeDelayed: (delay: number, ...args: Params) => void;
+}
+/**
+ * A shorthand that implies all the generics to be any
+ */
+export type AnyUseApiReturn = UseApiReturn<any, any, any>;
+/**
+ * Retrieves the last emitted signal
+ *
+ * @param comms
+ */
+export declare function useSignal(comms: UseCommsClient): [DeepReadonly<Ref<Signal | undefined>>, WatchStopHandle];
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@antcde/vue-utils",
   "type": "module",
-  "version": "0.2.0",
+  "version": "0.2.7",
   "description": "Helper to use ANT Comms in Vue 3",
   "author": "CollaborAll",
   "repository": {
@@ -28,11 +28,11 @@
   "peerDependencies": {
     "@vueuse/core": "^12.0.0",
     "vue": "^3.5.10",
-    "vue-i18n": "^9.8.0"
+    "vue-i18n": "^10.0.1",
+    "rxjs": "^7.0.0"
   },
   "dependencies": {
-    "rxjs": "^7.8.1",
-    "@antcde/connect-ts": "0.2.0"
+    "@antcde/connect-ts": "0.4.9"
   },
   "devDependencies": {
     "@vitejs/plugin-vue": "^5.0.3",
@@ -43,7 +43,7 @@
     "vue-tsc": "^1.8.27"
   },
   "scripts": {
-    "build": "vite build",
+    "build": "pnpm clean && vite build",
     "type-check": "vue-tsc --noEmit",
     "clean": "pnpm dlx rimraf dist"
   }