New

• custom types ArrayOf and OneOf for schemas

const exampleSchema = new Schema<Prop>('example', {
	id: new SchemaValue(OneOf(String, Number)), // define multiple type options for value
	options: new SchemaValue(ArrayOf(String)), // specify what type of array it is
}, false)

• Allow to override the data via beforeChange return for CREATED, UPDATED, and LOADED events

const unsub = todoStore.beforeChange(async (eventType, data) => {
    switch (eventType) {
        case ClientStore.EventType.CREATED:
            return await todoService.createTodo(data); // <- return the data 
        case ClientStore.EventType.UPDATED:
            return await todoService.updateTodo(data.id, data); // <- return the data 
	case ClientStore.EventType.LOADED:
            return await todoService.getAllByIds(data.map(m => m.id)); // <- return the data 
        default:
    };
    
    return true; // required to flag the store that the action should continue
});

Fixes

• LOADED was not broadcasted when the list provided was empty.
• Schema was removing explicitly defined values which looked like default values when includeDefaultKeys was set to false
• All classes where being set directly in window. Now they are available under CWS object on the client

What's Changed

• Develop by @ECorreia45 in https://github.com/beforesemicolon/client-web-storage/pull/5
• #6 additional custom types by @ECorreia45 in https://github.com/beforesemicolon/client-web-storage/pull/8
• #9 allow override via beforeChange by @ECorreia45 in https://github.com/beforesemicolon/client-web-storage/pull/10
• #11 by @ECorreia45 in https://github.com/beforesemicolon/client-web-storage/pull/12

Full Changelog: https://github.com/beforesemicolon/client-web-storage/compare/1.4.5...1.5.0

• Convert loadItems into its own action so it does not keep triggering create and update events for every item on the list which can cause infinite loops between the api listener and the data creation;

Improvements:

• Calling loadItems no longer leave the store size at its previous state. The size of the store reflects the new items loaded;
• beforeChange is now typed
• Loaded items will now validate all items first before putting them into the store;

What's Changed

• Develop by @ECorreia45 in https://github.com/beforesemicolon/client-web-storage/pull/1
• Develop by @ECorreia45 in https://github.com/beforesemicolon/client-web-storage/pull/2
• Develop by @ECorreia45 in https://github.com/beforesemicolon/client-web-storage/pull/3
• License by @ECorreia45 in https://github.com/beforesemicolon/client-web-storage/pull/4

New Contributors

• @ECorreia45 made their first contribution in https://github.com/beforesemicolon/client-web-storage/pull/1

Full Changelog: https://github.com/beforesemicolon/client-web-storage/commits/1.4.5

Browser storage interface for IndexedDB, WebSQL, LocalStorage, and in-memory- data with basic Schema and data validation.

• Schema : Determines how the data looks like;
• SchemaValue : Creates a single value in the schema;
• ClientStore : Manages the data (CRUD);

// Define schema TS type
import {ClientStore, Schema} from "client-web-storage";

interface ToDo extends Schema.DefaultValue {
    name: string;
    description: string;
    complete: boolean;
}

// create and define schema
const todoShema = new Schema<ToDo>("todo");

todoShema.defineField("name", String, {required: true});
todoShema.defineField("description", String);
todoShema.defineField("complete", Boolean);

// create and use the store
const todoStore = new ClientStore("todos", todoShema);

todoStore.createItem({
    name: "Go to Gym" // only name is required
});

/*  Creates item in the store
{
  id: 3284732894792342, // generated id
  name: "Go to Gym",
  description: "",
  complete: false,
  createdDate: "January, 4th 2022",
  lastUpdatedDate: "January, 4th 2022",
}
*/

What's Changed

• Develop by @ECorreia45 in https://github.com/beforesemicolon/client-web-storage/pull/1

Full Changelog: https://github.com/beforesemicolon/client-web-storage/commits/1.3.0