@basmilius/common 3.0.2 → 3.1.0

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@basmilius/common",
     "description": "Common code shared in personal projects.",
-    "version": "3.0.2",
+    "version": "3.1.0",
     "type": "module",
     "license": "MIT",
     "funding": "https://github.com/sponsors/basmilius",
@@ -48,8 +48,8 @@
         "./*": "./*"
     },
     "dependencies": {
-        "@basmilius/http-client": "3.0.2",
-        "@basmilius/utils": "3.0.2",
+        "@basmilius/http-client": "3.1.0",
+        "@basmilius/utils": "3.1.0",
         "@flux-ui/components": "^3.0.0-next.26",
         "@flux-ui/internals": "^3.0.0-next.26",
         "pinia": "^3.0.4",
@@ -57,7 +57,7 @@
         "vue-router": "^5.0.3"
     },
     "devDependencies": {
-        "@basmilius/tools": "3.0.2",
+        "@basmilius/tools": "3.1.0",
         "@types/culori": "^4.0.1",
         "@types/lodash-es": "^4.17.12",
         "culori": "^4.0.2",

package/src/composable/index.ts

@@ -2,6 +2,7 @@ export { default as useCopy } from './useCopy';
 export { default as useDebounced } from './useDebounced';
 export { default as useDtoForm } from './useDtoForm';
 export { default as useInterval } from './useInterval';
+export { default as useIsView } from './useIsView';
 export { default as useLoaded } from './useLoaded';
 export { default as useLoadedAction } from './useLoadedAction';
 export { default as useLocalFile } from './useLocalFile';

package/src/composable/useCopy.ts

@@ -1,8 +1,10 @@
 import { type Ref, unref } from 'vue';
 
-export default function (contents: Ref<string>, onSuccess?: Function) {
+export default function (contents: Ref<string>, onSuccess?: Function): UseCopy {
     return async () => {
         await navigator.clipboard.writeText(unref(contents));
         onSuccess?.();
     };
 }
+
+type UseCopy = () => Promise<void>;

package/src/composable/useDtoForm.ts

@@ -1,8 +1,8 @@
 import { cloneDto, markDtoClean } from '@basmilius/http-client';
 import { ref, type Ref, watch } from 'vue';
 
-export default function <T>(dtoRef: Ref<T | null>) {
-    const form = ref<T>();
+export default function <T>(dtoRef: Ref<T | null>): Ref<T> {
+    const form = ref<T>() as Ref<T>;
 
     watch(dtoRef, dto => {
         if (!dto) {

package/src/composable/useIsView.ts

@@ -0,0 +1,12 @@
+import { computed, unref } from 'vue';
+import useRouteNames from './useRouteNames';
+
+export default function (name: string, loose: boolean = false) {
+    const names = useRouteNames();
+
+    if (loose) {
+        return computed(() => unref(names).some(n => n.startsWith(name)));
+    }
+
+    return computed(() => unref(names).some(n => n === name));
+}

package/src/composable/useLocalFile.ts

@@ -1,6 +1,6 @@
-import { ref, watch } from 'vue';
+import { type Ref, ref, watch } from 'vue';
 
-export default function () {
+export default function (): UseLocalFile {
     const file = ref<File | null>(null);
     const url = ref<string | null>(null);
 
@@ -38,3 +38,11 @@ export default function () {
         upload: uploadFile
     };
 }
+
+type UseLocalFile = {
+    readonly file: Ref<File | null>;
+    readonly url: Ref<string | null>;
+
+    delete: () => void;
+    upload: (uploadedFile: File) => void;
+};

package/src/composable/useNamedRoute.ts

@@ -1,7 +1,7 @@
-import { computed, provide, type Ref, unref } from 'vue';
-import { useRoute, viewDepthKey } from 'vue-router';
+import { computed, type ComputedRef, provide, type Ref, unref } from 'vue';
+import { type RouteLocationNormalizedLoadedGeneric, useRoute, viewDepthKey } from 'vue-router';
 
-export default function (nameRef: Ref<string> | string) {
+export default function (nameRef: Ref<string> | string): UseNamedRoute {
     const route = useRoute();
 
     const depth = computed(() => route.matched.findIndex(m => !!m.components && unref(nameRef) in m.components));
@@ -15,3 +15,8 @@ export default function (nameRef: Ref<string> | string) {
         viewKey
     };
 }
+
+type UseNamedRoute = {
+    readonly route: RouteLocationNormalizedLoadedGeneric;
+    readonly viewKey: ComputedRef<string | undefined>;
+};

package/src/composable/useNavigate.ts

@@ -1,10 +1,11 @@
 import { type NavigationFailure, type RouteLocationRaw, useRouter } from 'vue-router';
 
+type Result = NavigationFailure | void | undefined;
 type To = Omit<RouteLocationRaw, 'replace'>;
-type Navigate = (to: To, replace?: boolean) => Promise<NavigationFailure | void | undefined>;
+type Navigate = (to: To, replace?: boolean) => Promise<Result>;
 type Wrap = (fn: Navigate) => Navigate;
 
-export default function (...wrap: Wrap[]) {
+export default function (...wrap: Wrap[]): UseNavigate {
     const router = useRouter();
 
     let navigate = async (to: To, replace: boolean = false) => {
@@ -26,3 +27,9 @@ export default function (...wrap: Wrap[]) {
         replace: (to: To) => navigate(to, true)
     };
 }
+
+type UseNavigate = {
+    navigate(to: To, replace?: boolean): Promise<Result>;
+    push(to: To): Promise<Result>;
+    replace(to: To): Promise<Result>;
+};

package/src/composable/usePagination.ts

@@ -1,10 +1,10 @@
-import { ref } from 'vue';
+import { ref, type Ref } from 'vue';
 
 const DEFAULT_LIMITS = [5, 10, 25, 50, 100];
 const DEFAULT_PAGE = 1;
 const DEFAULT_PER_PAGE = 25;
 
-export default function () {
+export default function (): UsePagination {
     const limits = ref(DEFAULT_LIMITS);
     const page = ref(DEFAULT_PAGE);
     const perPage = ref(DEFAULT_PER_PAGE);
@@ -33,3 +33,14 @@ export default function () {
         setTotal
     };
 };
+
+type UsePagination = {
+    readonly limits: Ref<number[]>;
+    readonly page: Ref<number>;
+    readonly perPage: Ref<number>;
+    readonly total: Ref<number>;
+
+    setPage(num: number): void;
+    setPerPage(num: number): void;
+    setTotal(num: number): void;
+};

package/src/composable/usePasswordStrength.ts

@@ -1,4 +1,4 @@
-import { computed, type Ref, unref } from 'vue';
+import { computed, type ComputedRef, type Ref, unref } from 'vue';
 
 type PasswordRuleType =
     | 'lowercase'
@@ -44,7 +44,7 @@ const rules: PasswordRule[] = [
     {regex: new RegExp('[!"#\$%&\'\(\)\*\+,-\./:;<=>\?@\[\\\\\\]\^_`\{|\}~]'), type: 'symbol'}
 ];
 
-export default function (passwordRef: Ref<string>) {
+export default function (passwordRef: Ref<string>): ComputedRef<Result | null> {
     return computed<Result | null>(() => {
         const password = unref(passwordRef);
 

package/src/composable/useRouteMeta.ts

@@ -2,7 +2,7 @@ import { merge } from 'lodash-es';
 import { computed, type Ref } from 'vue';
 import { useRoute } from 'vue-router';
 
-type RouteMeta = {
+type RouteMeta = Record<string, unknown> & {
     readonly name?: string;
 };
 

package/src/composable/useRouteNames.ts

@@ -1,7 +1,7 @@
-import { computed } from 'vue';
+import { computed, type ComputedRef } from 'vue';
 import { useRoute } from 'vue-router';
 
-export default function () {
+export default function (): ComputedRef<string[]> {
     const route = useRoute();
 
     return computed(() => {