vue-context-storage 0.1.9 → 0.1.10

package/package.json

@@ -1,83 +1,73 @@
-{
-  "name": "vue-context-storage",
-  "version": "0.1.9",
-  "description": "Vue 3 context storage system with URL query synchronization support",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/lviobio/vue-context-storage.git"
-  },
-  "type": "module",
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
-    },
-    "./components": {
-      "import": "./src/components.ts"
-    },
-    "./plugin": {
-      "import": "./src/plugin.ts"
-    }
-  },
-  "files": [
-    "dist",
-    "src",
-    "README.md"
-  ],
-  "scripts": {
-    "build": "tsdown",
-    "dev": "tsdown --watch",
-    "check": "npm run ts:check && npm run lint:check && npm run format:check && npm run dependency-cruiser:check",
-    "ts:check": "tsc --noEmit",
-    "format": "prettier --write src/",
-    "format:check": "prettier --check src/",
-    "lint": "eslint . --fix",
-    "lint:check": "eslint .",
-    "dependency-cruiser:check": "depcruise --config .dependency-cruiser.cjs src",
-    "prepublishOnly": "npm run check && npm run build"
-  },
-  "keywords": [
-    "vue",
-    "vue3",
-    "context",
-    "storage",
-    "state-management",
-    "query-sync"
-  ],
-  "author": "",
-  "license": "MIT",
-  "peerDependencies": {
-    "vue": "^3.5.0",
-    "vue-router": "^4.0.0"
-  },
-  "dependencies": {
-    "lodash": "^4.17.21"
-  },
-  "devDependencies": {
-    "@eslint/js": "^9.39.2",
-    "@types/lodash": "^4.17.15",
-    "@types/node": "^20.0.0",
-    "@vue/eslint-config-typescript": "^14.6.0",
-    "dependency-cruiser": "^17.3.6",
-    "eslint": "^9.39.2",
-    "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-vue": "^10.6.2",
-    "prettier": "^3.7.4",
-    "tsdown": "^0.3.0",
-    "typescript": "^5.9.0",
-    "typescript-eslint": "^8.51.0",
-    "unplugin-vue": "^7.1.0",
-    "vue": "^3.5.26",
-    "vue-router": "^4.6.4",
-    "vue-tsc": "^3.2.1"
-  }
-}
+{
+  "name": "vue-context-storage",
+  "type": "module",
+  "version": "0.1.10",
+  "description": "Vue 3 context storage system with URL query synchronization support",
+  "author": "",
+  "license": "MIT",
+  "homepage": "https://github.com/lviobio/vue-context-storage#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lviobio/vue-context-storage.git"
+  },
+  "bugs": {
+    "url": "https://github.com/lviobio/vue-context-storage/issues"
+  },
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "check": "npm run ts:check && npm run lint:check && npm run format:check && npm run dependency-cruiser:check",
+    "ts:check": "vue-tsc --noEmit",
+    "format": "prettier --write src/",
+    "format:check": "prettier --check src/",
+    "lint": "eslint . --fix",
+    "lint:check": "eslint .",
+    "dependency-cruiser:check": "depcruise --config .dependency-cruiser.cjs src",
+    "play": "vite",
+    "test": "vitest",
+    "release": "bumpp && npm publish",
+    "prepublishOnly": "npm run check && npm run build"
+  },
+  "peerDependencies": {
+    "vue": "^3.0.0",
+    "vue-router": "^4.0.0"
+  },
+  "devDependencies": {
+    "@types/lodash": "^4.17.21",
+    "@types/node": "^25.0.3",
+    "@vitejs/plugin-vue": "^6.0.3",
+    "@vitest/browser-playwright": "^4.0.16",
+    "@vue/eslint-config-typescript": "^14.6.0",
+    "bumpp": "^10.3.2",
+    "dependency-cruiser": "^17.3.6",
+    "eslint": "^9.39.2",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-vue": "^10.6.2",
+    "playwright": "^1.57.0",
+    "prettier": "^3.7.4",
+    "tsdown": "^0.18.4",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.51.0",
+    "vite": "^7.3.0",
+    "vitest": "^4.0.16",
+    "vitest-browser-vue": "^2.0.1",
+    "vue": "^3.5.26",
+    "vue-tsc": "^3.2.1"
+  },
+  "dependencies": {
+    "lodash": "^4.17.21"
+  }
+}

package/dist/collection.d.cts

@@ -1,22 +0,0 @@
-import { ContextStorageHandler, ContextStorageHandlerConstructor } from './handlers';
-export type ContextStorageCollectionItem = {
-    key: string;
-    handlers: ContextStorageHandler[];
-};
-interface ItemOptions {
-    key: string;
-}
-export declare class ContextStorageCollection {
-    private handlerConstructors;
-    active?: ContextStorageCollectionItem;
-    private collection;
-    private onActiveChangeCallbacks;
-    constructor(handlerConstructors: ContextStorageHandlerConstructor[]);
-    onActiveChange(callback: (item: ContextStorageCollectionItem) => void): void;
-    first(): ContextStorageCollectionItem | undefined;
-    findItemByKey(key: string): ContextStorageCollectionItem | undefined;
-    add(options: ItemOptions): ContextStorageCollectionItem;
-    remove(removeItem: ContextStorageCollectionItem): void;
-    setActive(activeItem: ContextStorageCollectionItem): void;
-}
-export {};

package/dist/collection.d.ts

@@ -1,22 +0,0 @@
-import { ContextStorageHandler, ContextStorageHandlerConstructor } from './handlers';
-export type ContextStorageCollectionItem = {
-    key: string;
-    handlers: ContextStorageHandler[];
-};
-interface ItemOptions {
-    key: string;
-}
-export declare class ContextStorageCollection {
-    private handlerConstructors;
-    active?: ContextStorageCollectionItem;
-    private collection;
-    private onActiveChangeCallbacks;
-    constructor(handlerConstructors: ContextStorageHandlerConstructor[]);
-    onActiveChange(callback: (item: ContextStorageCollectionItem) => void): void;
-    first(): ContextStorageCollectionItem | undefined;
-    findItemByKey(key: string): ContextStorageCollectionItem | undefined;
-    add(options: ItemOptions): ContextStorageCollectionItem;
-    remove(removeItem: ContextStorageCollectionItem): void;
-    setActive(activeItem: ContextStorageCollectionItem): void;
-}
-export {};

package/dist/handlers/query/helpers.d.cts

@@ -1,45 +0,0 @@
-import { LocationQuery } from 'vue-router';
-export interface SerializeOptions {
-    /**
-     * Custom prefix for serialized keys.
-     * @example
-     * - prefix: 'filters' => 'filters[key]'
-     * - prefix: 'search' => 'search[key]'
-     * - prefix: '' => 'key' (no prefix)
-     */
-    prefix?: string;
-}
-/**
- * Serializes filter parameters into a URL-friendly format.
- *
- * @param params - Raw parameters object to serialize
- * @param options - Serialization options
- * @returns Serialized parameters with prefixed keys
- *
- * @example
- * // With default prefix 'filters'
- * serializeFiltersParams({ status: 'active', tags: ['a', 'b'] })
- * // => { 'filters[status]': 'active', 'filters[tags]': 'a,b' }
- *
- * @example
- * // With custom prefix
- * serializeFiltersParams({ name: 'John', all: true }, { prefix: 'search' })
- * // => { 'search[name]': 'John', 'search[all]': '1' }
- *
- * @example
- * // Without prefix
- * serializeFiltersParams({ page: 1, all: false }, { prefix: '' })
- * // => { 'page': '1', 'all': '0' }
- */
-export declare function serializeParams(params: Record<string, unknown>, options?: SerializeOptions): LocationQuery;
-/**
- * Deserializes query parameters from a URL-friendly format back to an object.
- *
- * @param params - Serialized parameters object
- * @returns Deserialized parameters object
- *
- * @example
- * deserializeParams({ 'filters[status]': 'active', search: 'test' })
- * // => { filters: {status: 'active'}, search: 'test' }
- */
-export declare function deserializeParams(params: Record<string, any>): Record<string, any>;

package/dist/handlers/query/helpers.d.ts

@@ -1,45 +0,0 @@
-import { LocationQuery } from 'vue-router';
-export interface SerializeOptions {
-    /**
-     * Custom prefix for serialized keys.
-     * @example
-     * - prefix: 'filters' => 'filters[key]'
-     * - prefix: 'search' => 'search[key]'
-     * - prefix: '' => 'key' (no prefix)
-     */
-    prefix?: string;
-}
-/**
- * Serializes filter parameters into a URL-friendly format.
- *
- * @param params - Raw parameters object to serialize
- * @param options - Serialization options
- * @returns Serialized parameters with prefixed keys
- *
- * @example
- * // With default prefix 'filters'
- * serializeFiltersParams({ status: 'active', tags: ['a', 'b'] })
- * // => { 'filters[status]': 'active', 'filters[tags]': 'a,b' }
- *
- * @example
- * // With custom prefix
- * serializeFiltersParams({ name: 'John', all: true }, { prefix: 'search' })
- * // => { 'search[name]': 'John', 'search[all]': '1' }
- *
- * @example
- * // Without prefix
- * serializeFiltersParams({ page: 1, all: false }, { prefix: '' })
- * // => { 'page': '1', 'all': '0' }
- */
-export declare function serializeParams(params: Record<string, unknown>, options?: SerializeOptions): LocationQuery;
-/**
- * Deserializes query parameters from a URL-friendly format back to an object.
- *
- * @param params - Serialized parameters object
- * @returns Deserialized parameters object
- *
- * @example
- * deserializeParams({ 'filters[status]': 'active', search: 'test' })
- * // => { filters: {status: 'active'}, search: 'test' }
- */
-export declare function deserializeParams(params: Record<string, any>): Record<string, any>;

package/dist/handlers/query/index.d.cts

@@ -1,31 +0,0 @@
-import { ContextStorageHandlerConstructor } from '../../handlers.ts';
-import { contextStorageQueryHandler } from '../../symbols.ts';
-import { MaybeRefOrGetter } from 'vue';
-import { LocationQuery } from 'vue-router';
-import { ContextStorageQueryRegisteredItem, IContextStorageQueryHandler, QueryHandlerBaseOptions, RegisterQueryHandlerBaseOptions, RegisterQueryHandlerOptions } from './types.ts';
-export declare function useContextStorageQueryHandler<T extends Record<string, unknown>>(data: MaybeRefOrGetter<T>, options?: RegisterQueryHandlerBaseOptions<T>): void;
-export declare class ContextStorageQueryHandler implements IContextStorageQueryHandler {
-    #private;
-    private enabled;
-    private registered;
-    private currentQuery;
-    private readonly route;
-    private router;
-    private initialState?;
-    private hasAnyRegistered;
-    private preventSyncRegisteredToQueryByAfterEachRoute;
-    private preventAfterEachRouteCallsWhileCallingRouter;
-    static customQueryHandlerOptions: QueryHandlerBaseOptions;
-    private readonly options;
-    static configure(options: QueryHandlerBaseOptions): ContextStorageHandlerConstructor;
-    constructor();
-    getInjectionKey(): typeof contextStorageQueryHandler;
-    setInitialState(state: Record<string, unknown> | undefined): void;
-    static getInitialStateResolver(): () => LocationQuery;
-    setEnabled(state: boolean, initial: boolean): void;
-    syncRegisteredToQuery(): Promise<void>;
-    afterEachRoute(): void;
-    syncInitialStateToRegisteredItem<T extends Record<string, unknown>>(item: ContextStorageQueryRegisteredItem<T>): void;
-    syncInitialStateToRegistered(): void;
-    register<T extends Record<string, unknown>>(data: MaybeRefOrGetter<T>, options: RegisterQueryHandlerOptions<T>): () => void;
-}

package/dist/handlers/query/index.d.ts

@@ -1,31 +0,0 @@
-import { ContextStorageHandlerConstructor } from '../../handlers.ts';
-import { contextStorageQueryHandler } from '../../symbols.ts';
-import { MaybeRefOrGetter } from 'vue';
-import { LocationQuery } from 'vue-router';
-import { ContextStorageQueryRegisteredItem, IContextStorageQueryHandler, QueryHandlerBaseOptions, RegisterQueryHandlerBaseOptions, RegisterQueryHandlerOptions } from './types.ts';
-export declare function useContextStorageQueryHandler<T extends Record<string, unknown>>(data: MaybeRefOrGetter<T>, options?: RegisterQueryHandlerBaseOptions<T>): void;
-export declare class ContextStorageQueryHandler implements IContextStorageQueryHandler {
-    #private;
-    private enabled;
-    private registered;
-    private currentQuery;
-    private readonly route;
-    private router;
-    private initialState?;
-    private hasAnyRegistered;
-    private preventSyncRegisteredToQueryByAfterEachRoute;
-    private preventAfterEachRouteCallsWhileCallingRouter;
-    static customQueryHandlerOptions: QueryHandlerBaseOptions;
-    private readonly options;
-    static configure(options: QueryHandlerBaseOptions): ContextStorageHandlerConstructor;
-    constructor();
-    getInjectionKey(): typeof contextStorageQueryHandler;
-    setInitialState(state: Record<string, unknown> | undefined): void;
-    static getInitialStateResolver(): () => LocationQuery;
-    setEnabled(state: boolean, initial: boolean): void;
-    syncRegisteredToQuery(): Promise<void>;
-    afterEachRoute(): void;
-    syncInitialStateToRegisteredItem<T extends Record<string, unknown>>(item: ContextStorageQueryRegisteredItem<T>): void;
-    syncInitialStateToRegistered(): void;
-    register<T extends Record<string, unknown>>(data: MaybeRefOrGetter<T>, options: RegisterQueryHandlerOptions<T>): () => void;
-}

package/dist/handlers/query/transform-helpers.d.cts

@@ -1,123 +0,0 @@
-import { QueryValue } from './types.ts';
-export declare function asNumber(value: QueryValue | number | undefined): number;
-export declare function asNumber(value: QueryValue | number | undefined, options: {
-    nullable: true;
-    missable: true;
-    fallbackValue?: number;
-}): number | null | undefined;
-export declare function asNumber(value: QueryValue | number | undefined, options: {
-    nullable: true;
-    missable?: false;
-    fallbackValue?: number;
-}): number | null;
-export declare function asNumber(value: QueryValue | number | undefined, options: {
-    nullable?: false;
-    missable: true;
-    fallbackValue?: number;
-}): number | undefined;
-export declare function asNumber(value: QueryValue | number | undefined, options: {
-    nullable?: false;
-    missable?: false;
-    fallbackValue?: number;
-}): number;
-export declare function asString(value: QueryValue | undefined): string;
-export declare function asString<T extends readonly string[]>(value: QueryValue | undefined, options: {
-    nullable: true;
-    missable: true;
-    fallbackValue?: T[number];
-    allowedValues: T;
-}): T[number] | null | undefined;
-export declare function asString<T extends readonly string[]>(value: QueryValue | undefined, options: {
-    nullable: true;
-    missable?: false;
-    fallbackValue?: T[number];
-    allowedValues: T;
-}): T[number] | null;
-export declare function asString<T extends readonly string[]>(value: QueryValue | undefined, options: {
-    nullable?: false;
-    missable: true;
-    fallbackValue?: T[number];
-    allowedValues: T;
-}): T[number] | undefined;
-export declare function asString<T extends readonly string[]>(value: QueryValue | undefined, options: {
-    nullable?: false;
-    missable?: false;
-    fallbackValue?: T[number];
-    allowedValues: T;
-}): T[number];
-export declare function asString(value: QueryValue | undefined, options: {
-    nullable: true;
-    missable: true;
-    fallbackValue?: string;
-}): string | null | undefined;
-export declare function asString(value: QueryValue | undefined, options: {
-    nullable: true;
-    missable?: false;
-    fallbackValue?: string;
-}): string | null;
-export declare function asString(value: QueryValue | undefined, options: {
-    nullable?: false;
-    missable: true;
-    fallbackValue?: string;
-}): string | undefined;
-export declare function asString(value: QueryValue | undefined, options: {
-    nullable?: false;
-    missable?: false;
-    fallbackValue?: string;
-}): string;
-export declare function asNumberArray(value: QueryValue | undefined): number[];
-export declare function asNumberArray(value: QueryValue | undefined, options: {
-    nullable: true;
-}): number[] | null;
-export declare function asNumberArray(value: QueryValue | undefined, options: {
-    nullable?: false;
-}): number[];
-export declare function asArray<T>(value: QueryValue | undefined): T[];
-export declare function asArray<T>(value: QueryValue | undefined, options: {
-    nullable: true;
-    missable: true;
-    transform?: (value: QueryValue) => T;
-}): T[] | null | undefined;
-export declare function asArray<T>(value: QueryValue | undefined, options: {
-    nullable: true;
-    missable?: false;
-    transform?: (value: QueryValue) => T;
-}): T[] | null;
-export declare function asArray<T>(value: QueryValue | undefined, options: {
-    nullable?: false;
-    missable: true;
-    transform?: (value: QueryValue) => T;
-}): T[] | undefined;
-export declare function asArray<T>(value: QueryValue | undefined, options: {
-    nullable?: false;
-    missable?: false;
-    transform?: (value: QueryValue) => T;
-}): T[];
-export declare function asBoolean(value: QueryValue | undefined): boolean;
-export declare function asBoolean(value: QueryValue | undefined, options: {
-    nullable: true;
-    missable: true;
-    fallbackValue?: boolean;
-}): boolean | null | undefined;
-export declare function asBoolean(value: QueryValue | undefined, options: {
-    nullable: true;
-    missable?: false;
-    fallbackValue?: boolean;
-}): boolean | null;
-export declare function asBoolean(value: QueryValue | undefined, options: {
-    nullable?: false;
-    missable: true;
-    fallbackValue?: boolean;
-}): boolean | undefined;
-export declare function asBoolean(value: QueryValue | undefined, options: {
-    nullable?: false;
-    missable?: false;
-    fallbackValue?: boolean;
-}): boolean;
-export declare const transform: {
-    asString: typeof asString;
-    asNumber: typeof asNumber;
-    asArray: typeof asArray;
-    asNumberArray: typeof asNumberArray;
-    asBoolean: typeof asBoolean;
-};

package/dist/handlers/query/transform-helpers.d.ts

@@ -1,123 +0,0 @@
-import { QueryValue } from './types.ts';
-export declare function asNumber(value: QueryValue | number | undefined): number;
-export declare function asNumber(value: QueryValue | number | undefined, options: {
-    nullable: true;
-    missable: true;
-    fallbackValue?: number;
-}): number | null | undefined;
-export declare function asNumber(value: QueryValue | number | undefined, options: {
-    nullable: true;
-    missable?: false;
-    fallbackValue?: number;
-}): number | null;
-export declare function asNumber(value: QueryValue | number | undefined, options: {
-    nullable?: false;
-    missable: true;
-    fallbackValue?: number;
-}): number | undefined;
-export declare function asNumber(value: QueryValue | number | undefined, options: {
-    nullable?: false;
-    missable?: false;
-    fallbackValue?: number;
-}): number;
-export declare function asString(value: QueryValue | undefined): string;
-export declare function asString<T extends readonly string[]>(value: QueryValue | undefined, options: {
-    nullable: true;
-    missable: true;
-    fallbackValue?: T[number];
-    allowedValues: T;
-}): T[number] | null | undefined;
-export declare function asString<T extends readonly string[]>(value: QueryValue | undefined, options: {
-    nullable: true;
-    missable?: false;
-    fallbackValue?: T[number];
-    allowedValues: T;
-}): T[number] | null;
-export declare function asString<T extends readonly string[]>(value: QueryValue | undefined, options: {
-    nullable?: false;
-    missable: true;
-    fallbackValue?: T[number];
-    allowedValues: T;
-}): T[number] | undefined;
-export declare function asString<T extends readonly string[]>(value: QueryValue | undefined, options: {
-    nullable?: false;
-    missable?: false;
-    fallbackValue?: T[number];
-    allowedValues: T;
-}): T[number];
-export declare function asString(value: QueryValue | undefined, options: {
-    nullable: true;
-    missable: true;
-    fallbackValue?: string;
-}): string | null | undefined;
-export declare function asString(value: QueryValue | undefined, options: {
-    nullable: true;
-    missable?: false;
-    fallbackValue?: string;
-}): string | null;
-export declare function asString(value: QueryValue | undefined, options: {
-    nullable?: false;
-    missable: true;
-    fallbackValue?: string;
-}): string | undefined;
-export declare function asString(value: QueryValue | undefined, options: {
-    nullable?: false;
-    missable?: false;
-    fallbackValue?: string;
-}): string;
-export declare function asNumberArray(value: QueryValue | undefined): number[];
-export declare function asNumberArray(value: QueryValue | undefined, options: {
-    nullable: true;
-}): number[] | null;
-export declare function asNumberArray(value: QueryValue | undefined, options: {
-    nullable?: false;
-}): number[];
-export declare function asArray<T>(value: QueryValue | undefined): T[];
-export declare function asArray<T>(value: QueryValue | undefined, options: {
-    nullable: true;
-    missable: true;
-    transform?: (value: QueryValue) => T;
-}): T[] | null | undefined;
-export declare function asArray<T>(value: QueryValue | undefined, options: {
-    nullable: true;
-    missable?: false;
-    transform?: (value: QueryValue) => T;
-}): T[] | null;
-export declare function asArray<T>(value: QueryValue | undefined, options: {
-    nullable?: false;
-    missable: true;
-    transform?: (value: QueryValue) => T;
-}): T[] | undefined;
-export declare function asArray<T>(value: QueryValue | undefined, options: {
-    nullable?: false;
-    missable?: false;
-    transform?: (value: QueryValue) => T;
-}): T[];
-export declare function asBoolean(value: QueryValue | undefined): boolean;
-export declare function asBoolean(value: QueryValue | undefined, options: {
-    nullable: true;
-    missable: true;
-    fallbackValue?: boolean;
-}): boolean | null | undefined;
-export declare function asBoolean(value: QueryValue | undefined, options: {
-    nullable: true;
-    missable?: false;
-    fallbackValue?: boolean;
-}): boolean | null;
-export declare function asBoolean(value: QueryValue | undefined, options: {
-    nullable?: false;
-    missable: true;
-    fallbackValue?: boolean;
-}): boolean | undefined;
-export declare function asBoolean(value: QueryValue | undefined, options: {
-    nullable?: false;
-    missable?: false;
-    fallbackValue?: boolean;
-}): boolean;
-export declare const transform: {
-    asString: typeof asString;
-    asNumber: typeof asNumber;
-    asArray: typeof asArray;
-    asNumberArray: typeof asNumberArray;
-    asBoolean: typeof asBoolean;
-};