shelving 1.108.0 → 1.108.2

package/change/Change.d.ts

@@ -15,7 +15,7 @@ export interface CollectionChange<T extends Database, K extends DataKey<T>> exte
     readonly query?: ItemQuery<T[K]> | never;
 }
 /** Add an item to a database collection. */
-export interface AddItemChange<T extends Database, K extends DataKey<T>> extends CollectionChange<T, K> {
+export interface ItemAddChange<T extends Database, K extends DataKey<T>> extends CollectionChange<T, K> {
     readonly action: "add";
     readonly id?: never;
     readonly query?: never;
@@ -64,10 +64,12 @@ export type DatabaseItemChange<T extends Database> = ItemSetChange<T, DataKey<T>
 /** Write multiple item in a set of collection. */
 export type DatabaseQueryChange<T extends Database> = QuerySetChange<T, DataKey<T>> | QueryUpdateChange<T, DataKey<T>> | QueryDeleteChange<T, DataKey<T>>;
 /** Write an item or multiple items in a set of collection. */
-export type DatabaseChange<T extends Database> = AddItemChange<T, DataKey<T>> | DatabaseItemChange<T> | DatabaseQueryChange<T>;
+export type DatabaseChange<T extends Database> = ItemAddChange<T, DataKey<T>> | DatabaseItemChange<T> | DatabaseQueryChange<T>;
 /** Write an item or multiple items in a set of collection. */
 export type DatabaseChanges<T extends Database> = ImmutableArray<DatabaseChange<T>>;
 /** Get a set change for an item. */
+export declare function getItemAdd<T extends Database, K extends DataKey<T>>(provider: AbstractProvider<T>, collection: K, id: string, data: T[K]): ItemAddChange<T, K>;
+/** Get a set change for an item. */
 export declare function getItemSet<T extends Database, K extends DataKey<T>>(provider: AbstractProvider<T>, collection: K, id: string, data: T[K]): ItemSetChange<T, K>;
 /** Get an update change an item. */
 export declare function getItemUpdate<T extends Database, K extends DataKey<T>>(provider: AbstractProvider<T>, collection: K, id: string, updates: Updates<T[K]>): ItemUpdateChange<T, K>;

package/change/Change.js

@@ -1,5 +1,9 @@
 import { notOptional } from "../util/optional.js";
 /** Get a set change for an item. */
+export function getItemAdd(provider, collection, id, data) {
+    return { action: "add", collection, data };
+}
+/** Get a set change for an item. */
 export function getItemSet(provider, collection, id, data) {
     return { action: "set", collection, id, data };
 }

package/db/{ChangeProvider.d.ts → ConvenienceProvider.d.ts}

@@ -1,10 +1,14 @@
-import type { DatabaseChange, DatabaseChanges, ItemDeleteChange, ItemSetChange, ItemUpdateChange, QueryDeleteChange, QuerySetChange, QueryUpdateChange } from "../change/Change.js";
+import type { DatabaseChange, DatabaseChanges, ItemAddChange, ItemDeleteChange, ItemSetChange, ItemUpdateChange, QueryDeleteChange, QuerySetChange, QueryUpdateChange } from "../change/Change.js";
 import type { DataKey, Database } from "../util/data.js";
-import type { ItemQuery } from "../util/item.js";
-import type { Optional } from "../util/optional.js";
+import type { Item, ItemQuery, OptionalItem } from "../util/item.js";
 import type { Updates } from "../util/update.js";
+import { type Optional } from "../util/optional.js";
 import { AsyncThroughProvider, ThroughProvider } from "./ThroughProvider.js";
-export declare class ChangeProvider<T extends Database> extends ThroughProvider<T> {
+export declare class ConvenienceProvider<T extends Database> extends ThroughProvider<T> {
+    requireItem<K extends DataKey<T>>(collection: K, id: string): Item<T[K]>;
+    getFirst<K extends DataKey<T>>(collection: K, query: ItemQuery<T[K]>): OptionalItem<T[K]>;
+    requireFirst<K extends DataKey<T>>(collection: K, query: ItemQuery<T[K]>): Item<T[K]>;
+    getItemAdd<K extends DataKey<T>>(collection: K, id: string, data: T[K]): ItemAddChange<T, K>;
     getItemSet<K extends DataKey<T>>(collection: K, id: string, data: T[K]): ItemSetChange<T, K>;
     getItemUpdate<K extends DataKey<T>>(collection: K, id: string, updates: Updates<T[K]>): ItemUpdateChange<T, K>;
     getItemDelete<K extends DataKey<T>>(collection: K, id: string): ItemDeleteChange<T, K>;
@@ -14,7 +18,11 @@ export declare class ChangeProvider<T extends Database> extends ThroughProvider<
     writeChanges(...changes: Optional<DatabaseChange<T>>[]): DatabaseChanges<T>;
     writeChange(change: DatabaseChange<T>): DatabaseChange<T>;
 }
-export declare class AsyncChangeProvider<T extends Database> extends AsyncThroughProvider<T> {
+export declare class AsyncConvenienceProvider<T extends Database> extends AsyncThroughProvider<T> {
+    requireItem<K extends DataKey<T>>(collection: K, id: string): Promise<Item<T[K]>>;
+    getFirst<K extends DataKey<T>>(collection: K, query: ItemQuery<T[K]>): Promise<OptionalItem<T[K]>>;
+    requireFirst<K extends DataKey<T>>(collection: K, query: ItemQuery<T[K]>): Promise<Item<T[K]>>;
+    getItemAdd<K extends DataKey<T>>(collection: K, id: string, data: T[K]): ItemAddChange<T, K>;
     getItemSet<K extends DataKey<T>>(collection: K, id: string, data: T[K]): ItemSetChange<T, K>;
     getItemUpdate<K extends DataKey<T>>(collection: K, id: string, updates: Updates<T[K]>): ItemUpdateChange<T, K>;
     getItemDelete<K extends DataKey<T>>(collection: K, id: string): ItemDeleteChange<T, K>;

package/db/{ChangeProvider.js → ConvenienceProvider.js}

@@ -1,6 +1,20 @@
-import { getItemDelete, getItemSet, getItemUpdate, getQueryDelete, getQuerySet, getQueryUpdate, writeAsyncProviderChange, writeAsyncProviderChanges, writeProviderChange, writeProviderChanges } from "../change/Change.js";
+import { getItemAdd, getItemDelete, getItemSet, getItemUpdate, getQueryDelete, getQuerySet, getQueryUpdate, writeAsyncProviderChange, writeAsyncProviderChanges, writeProviderChange, writeProviderChanges } from "../change/Change.js";
+import { getFirstItem, getOptionalFirstItem } from "../util/array.js";
+import { getRequired } from "../util/optional.js";
 import { AsyncThroughProvider, ThroughProvider } from "./ThroughProvider.js";
-export class ChangeProvider extends ThroughProvider {
+export class ConvenienceProvider extends ThroughProvider {
+    requireItem(collection, id) {
+        return getRequired(this.getItem(collection, id));
+    }
+    getFirst(collection, query) {
+        return getOptionalFirstItem(this.getQuery(collection, { ...query, $limit: 1 }));
+    }
+    requireFirst(collection, query) {
+        return getFirstItem(this.getQuery(collection, { ...query, $limit: 1 }));
+    }
+    getItemAdd(collection, id, data) {
+        return getItemAdd(this, collection, id, data);
+    }
     getItemSet(collection, id, data) {
         return getItemSet(this, collection, id, data);
     }
@@ -26,7 +40,19 @@ export class ChangeProvider extends ThroughProvider {
         return writeProviderChange(this, change);
     }
 }
-export class AsyncChangeProvider extends AsyncThroughProvider {
+export class AsyncConvenienceProvider extends AsyncThroughProvider {
+    async requireItem(collection, id) {
+        return getRequired(await this.getItem(collection, id));
+    }
+    async getFirst(collection, query) {
+        return getOptionalFirstItem(await this.getQuery(collection, { ...query, $limit: 1 }));
+    }
+    async requireFirst(collection, query) {
+        return getFirstItem(await this.getQuery(collection, { ...query, $limit: 1 }));
+    }
+    getItemAdd(collection, id, data) {
+        return getItemAdd(this, collection, id, data);
+    }
     getItemSet(collection, id, data) {
         return getItemSet(this, collection, id, data);
     }

package/db/index.d.ts

@@ -6,4 +6,4 @@ export * from "./MemoryProvider.js";
 export * from "./ValidationProvider.js";
 export * from "./CacheProvider.js";
 export * from "./DebugProvider.js";
-export * from "./ChangeProvider.js";
+export * from "./ConvenienceProvider.js";

package/db/index.js

@@ -8,4 +8,4 @@ export * from "./MemoryProvider.js";
 export * from "./ValidationProvider.js";
 export * from "./CacheProvider.js";
 export * from "./DebugProvider.js";
-export * from "./ChangeProvider.js";
+export * from "./ConvenienceProvider.js";

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.108.0",
+	"version": "1.108.2",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",