v0.0.1

Author: gmaxlev

README.md

@@ -1,11 +1,11 @@
-# vstorage
+# valistorage
 
 A library for efficiently managing data in `localStorage` and `sessionStorage` using **versioning** and **migrations**.
 
 # Installation
 
 ```bash
-npm install vstorage
+npm install valistorage
 ```
 
 ## Creating Storage
@@ -16,7 +16,7 @@ TypeScript allows us to describe the structure of the data we want to store usin
 
 
 ```ts
-import { create } from 'vstorage';
+import { create } from 'valistorage';
 
 interface CatVersion1 {
     name: string;
@@ -36,7 +36,7 @@ Let's look at the two required parameters that we passed:
 
 ## Choosing Storage
 
-By default, vstorage uses `localStorage` to store data.
+By default, valistorage uses `localStorage` to store data.
 You can specify the type of storage by providing `type` parameter in `create` function, which accepts either `localStorage` or `sessionStorage`.
 
 ```ts
@@ -86,7 +86,7 @@ catLocalStorage.remove();
 Imagine that we've decided to add a `color` field to our data structure. Users who have already used the application will only have `name` and `age` stored, so the application won't be able to retrieve `color`.
 
 ```ts
-import { create } from 'vstorage';
+import { create } from 'valistorage';
 
 interface CatVersion1 {
     name: string;
@@ -126,7 +126,7 @@ To ensure the best user experience, we can automatically convert their data to a
 Let's add migrations to our `storage`.
 
 ```ts
-import { create } from 'vstorage';
+import { create } from 'valistorage';
 
 interface CatVersion1 {
     name: string;
@@ -199,7 +199,7 @@ For validating data in storage and migrations, `validate` parameter is used.
 Let's add validation to our previous data structure:
 
 ```ts
-import { create } from 'vstorage';
+import { create } from 'valistorage';
 import * as yup from 'yup';
 
 // Define data structures
@@ -251,7 +251,7 @@ export const catLocalStorage = create<CateSchemaVersion2>({
 To remove all values that are stored by the library, use  `removeAll` method.
 
 ```ts
-import { removeAll } from 'vstorage';
+import { removeAll } from 'valistorage';
 
 removeAll();
 ````
@@ -264,7 +264,7 @@ By default, if no migrations are found for the data or if the data fails validat
 You can change this behavior by using the `autoRemove` parameter, which allows old data to be kept until it is converted to the new format or replaced with new data.
 
 ```ts
-import { create } from 'vstorage';
+import { create } from 'valistorage';
 
 export const catLocalStorage = create({
     key: 'cat',

package.json

@@ -1,7 +1,6 @@
 {
-  "name": "vstorage",
-  "private": true,
-  "version": "0.0.0",
+  "name": "valistorage",
+  "version": "0.0.1",
   "type": "module",
   "scripts": {
     "dev": "vite",
@@ -10,6 +9,23 @@
     "test:watch": "vitest",
     "test": "vitest --no-watch"
   },
+  "author": "Maksym Levytskyi https://github.com/gmaxlev",
+  "license": "MIT",
+  "description": "A library for efficiently managing data in localStorage and sessionStorage using versioning and migrations.",
+  "keywords": [
+    "localStorage",
+    "sessionStorage",
+    "storage",
+    "data",
+    "versioning",
+    "migrations"
+  ],
+  "homepage": "https://github.com/gmaxlev/valistorage",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gmaxlev/valistorage.git"
+  },
+  "bugs": "https://github.com/gmaxlev/valistorage/issues",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [

src/constants.ts

@@ -1 +1 @@
-export const DEFAULT_PREFIX = '__vstorage__'
+export const DEFAULT_PREFIX = '__valistorage__'

src/migrations/migrations.ts

@@ -1,4 +1,4 @@
-import { type Migration, type Version, type VstorageData } from '../types'
+import { type Migration, type Version, type ValistorageData } from '../types'
 import { warn, IS_DEV } from '../utils'
 
 const message = `"migrations" should be an array that includes the following objects:
@@ -146,7 +146,7 @@ function execute (migrations: Migration[], current: unknown): { readonly success
 
 export function migrate (
   migrations: unknown,
-  current: VstorageData,
+  current: ValistorageData,
   to: Version
 ): { readonly success: false, readonly value?: undefined } | { readonly success: true, readonly value: unknown } {
   if (!isValidMigrations(migrations)) {

src/storage/create.ts

@@ -48,7 +48,7 @@ function validateOptions (options: Options): void {
         'You passed invalid options into "create" options. Please see docs.'
       )
     }
-    throw new Error('[vstorage.create] Invalid Options')
+    throw new Error('[valistorage.create] Invalid Options')
   }
 
   if (typeof options !== 'object' || options === null) {
@@ -92,14 +92,14 @@ function validateOptions (options: Options): void {
   }
 }
 
-interface Vstorage <Get, Set> {
+interface Valistorage <Get, Set> {
   get: () => Get | null
   set: (value: Set) => void
   remove: () => void
 }
 
 /**
- * Creates an instance of vstorage value
+ * Creates an instance of valistorage value
  *
  * @param options - Options
  * @param options.key - Key to store value
@@ -111,7 +111,7 @@ interface Vstorage <Get, Set> {
  * @param options.autoRemove - Remove value if it is invalid (optional)
  * @param options.verbose - Show warnings (optional)
  */
-export function create<Set, Get = Set> (options: Options): Vstorage<Get, Set> {
+export function create<Set, Get = Set> (options: Options): Valistorage<Get, Set> {
   validateOptions(options)
 
   const {

src/storage/utils.ts

@@ -1,10 +1,10 @@
-import { type VstorageData } from '../types'
+import { type ValistorageData } from '../types'
 import { IS_DEV, warn } from '../utils'
 
-function isVstorageValue (
+function isValistorageValue (
   value: unknown,
   verbose: boolean
-): value is VstorageData {
+): value is ValistorageData {
   const isValid =
     typeof value === 'object' &&
     value !== null &&
@@ -21,10 +21,10 @@ function isVstorageValue (
   return isValid
 }
 
-export function unpack (value: string, verbose: boolean): VstorageData | null {
+export function unpack (value: string, verbose: boolean): ValistorageData | null {
   try {
     const parsed = JSON.parse(value) as unknown
-    if (!isVstorageValue(parsed, verbose)) {
+    if (!isValistorageValue(parsed, verbose)) {
       return null
     }
     return parsed

src/types.ts

@@ -1,6 +1,6 @@
 export type Version = number
 
-export interface VstorageData {
+export interface ValistorageData {
   version: Version
   value: unknown
 }

src/utils.ts

@@ -1,5 +1,5 @@
 export function warn (message: string): void {
-  console.warn(`[vstorage]\n\n${message}`)
+  console.warn(`[valistorage]\n\n${message}`)
 }
 
 export const IS_DEV = process.env.NODE_ENV !== 'DEVELOPMENT'