shelving 1.150.15 → 1.152.0

package/util/item.js

@@ -1,16 +1,17 @@
-/** Get the ID from item data. */
-export function getItemID({ id }) {
+/** Get the identifier from an item object. */
+export function getIdentifier({ id }) {
     return id;
 }
-/** Get the IDs of an iterable set item data. */
-export function* getItemIDs(entities) {
+/** Get the identifiers from an iterable set item objects. */
+export function* getIdentifiers(entities) {
     for (const { id } of entities)
         yield id;
 }
+/** Does a data object or data item object. */
+export function hasIdentifier(item, id) {
+    return item.id === id;
+}
 /** Merge an ID into a set of data to make an `ItemData` */
 export function getItem(id, data) {
-    return data.id === id ? data : { ...data, id };
-}
-export function getItemQuery(id) {
-    return { id, $limit: 1 };
+    return hasIdentifier(data, id) ? data : { ...data, id };
 }

package/util/query.d.ts

@@ -1,5 +1,6 @@
 import type { ImmutableArray } from "./array.js";
 import type { Data, LeafData, LeafKey } from "./data.js";
+import type { Item } from "./item.js";
 /** Query that can be applied to a list of data objects. */
 export type Query<T extends Data> = {
     readonly [K in LeafKey<T> as `${K}` | `!${K}`]?: LeafData<T>[K] | ImmutableArray<LeafData<T>[K]> | undefined;
@@ -11,6 +12,8 @@ export type Query<T extends Data> = {
     readonly $order?: `${LeafKey<T>}` | `!${LeafKey<T>}` | undefined | ImmutableArray<`${LeafKey<T>}` | `!${LeafKey<T>}` | undefined>;
     readonly $limit?: number | undefined;
 };
+/** A set of query constraints for item data. */
+export type ItemQuery<I extends string | number, T extends Data> = Query<Item<I, T>>;
 /** A single filter that can be applied to a list of data objects. */
 export type Filter = {
     key: string;

package/util/random.d.ts

@@ -13,4 +13,4 @@ export declare function getRandomKey(length?: number): string;
 /** Get a random character from a string. */
 export declare function getRandomCharacter(str: string): string;
 /** Get a random item from an array or random character from a string string. */
-export declare function getRandomItem<T>(arr: ImmutableArray<T>): T;
+export declare function getRandomItem<I, T>(arr: ImmutableArray<T>): T;

package/util/set.d.ts

@@ -16,11 +16,11 @@ export declare function getSet<T>(value: PossibleSet<T>): ImmutableSet;
 /** Apply a limit to a set. */
 export declare function limitSet<T>(set: ImmutableSet<T>, limit: number): ImmutableSet<T>;
 /** Is an unknown value an item in a set? */
-export declare function isSetItem<T>(set: ImmutableSet<T>, item: unknown): item is T;
+export declare function isSetItem<I, T>(set: ImmutableSet<T>, item: unknown): item is T;
 /** Assert that an unknown value is an item in a set. */
-export declare function assertSetItem<T>(set: ImmutableSet<T>, item: unknown, caller?: AnyCaller): asserts item is T;
+export declare function assertSetItem<I, T>(set: ImmutableSet<T>, item: unknown, caller?: AnyCaller): asserts item is T;
 /** Add an item to a set (by reference) and return the set item. */
-export declare function addSetItem<T>(set: MutableSet<T>, item: T): T;
+export declare function addSetItem<I, T>(set: MutableSet<T>, item: T): T;
 /** Add multiple items to a set (by reference). */
 export declare function addSetItems<T>(set: MutableSet<T>, ...items: T[]): void;
 /** Remove multiple items from a set (by reference). */

package/schema/TextSchema.d.ts

@@ -1,40 +0,0 @@
-import { type Sanitizer, StringSchema, type StringSchemaOptions } from "./StringSchema.js";
-/** `type=""` prop for HTML `<input />` tags that are relevant for strings. */
-export type TextSchemaType = "text" | "password" | "color" | "date" | "email" | "number" | "tel" | "search" | "url";
-/** Options for `TextSchema` */
-export interface TextSchemaOptions extends StringSchemaOptions {
-    readonly type?: TextSchemaType | undefined;
-    readonly match?: RegExp | undefined;
-    readonly multiline?: boolean | undefined;
-}
-/**
- * Schema that defines a valid text string.
- *
- * Ensures value is string and optionally enforces min/max length, whether to trim whitespace, and regex match format.
- * Doesn't allow `null` to mean no value — empty string is the equivalent for StringSchema (because it means we'll never accidentally get `"null"` by converting the `null` to string).
- *
- * Defaults to a single line text string (newlines are stripped). Use `multiline=true` to allow newlines.
- */
-export declare class TextSchema extends StringSchema {
-    readonly type: TextSchemaType;
-    readonly match: RegExp | undefined;
-    readonly sanitizer: Sanitizer | undefined;
-    readonly multiline: boolean;
-    constructor({ type, match, multiline, ...options }: TextSchemaOptions);
-    validate(unsafeValue?: unknown): string;
-    sanitize(str: string): string;
-}
-/** Valid text, e.g. `Hello there!` */
-export declare const TEXT: TextSchema;
-/** Valid text, `Hello there!`, with more than one character. */
-export declare const REQUIRED_TEXT: TextSchema;
-/** Title string, e.g. `Title of something` */
-export declare const TITLE: TextSchema;
-/** Optional name string, e.g. `Title of something` or `null` */
-export declare const NULLABLE_TITLE: import("./NullableSchema.js").NullableSchema<string>;
-/** Name string, e.g. `Name of Something` */
-export declare const NAME: TextSchema;
-/** Optional name string, e.g. `Name of Something` or `null` */
-export declare const NULLABLE_NAME: import("./NullableSchema.js").NullableSchema<string>;
-/** Password string. */
-export declare const PASSWORD: TextSchema;

package/schema/TextSchema.js

@@ -1,47 +0,0 @@
-import { ValueFeedback } from "../feedback/Feedback.js";
-import { sanitizeMultilineText, sanitizeText } from "../util/string.js";
-import { NULLABLE } from "./NullableSchema.js";
-import { StringSchema } from "./StringSchema.js";
-/**
- * Schema that defines a valid text string.
- *
- * Ensures value is string and optionally enforces min/max length, whether to trim whitespace, and regex match format.
- * Doesn't allow `null` to mean no value — empty string is the equivalent for StringSchema (because it means we'll never accidentally get `"null"` by converting the `null` to string).
- *
- * Defaults to a single line text string (newlines are stripped). Use `multiline=true` to allow newlines.
- */
-export class TextSchema extends StringSchema {
-    type;
-    match;
-    sanitizer;
-    multiline;
-    constructor({ type = "text", match, multiline = false, ...options }) {
-        super(options);
-        this.type = type;
-        this.match = match;
-        this.multiline = multiline;
-    }
-    validate(unsafeValue = this.value) {
-        const str = super.validate(unsafeValue);
-        if (this.match && !this.match.test(str))
-            throw new ValueFeedback(str ? "Invalid format" : "Required", str);
-        return str;
-    }
-    sanitize(str) {
-        return this.multiline ? sanitizeMultilineText(str) : sanitizeText(str);
-    }
-}
-/** Valid text, e.g. `Hello there!` */
-export const TEXT = new TextSchema({ title: "Text" });
-/** Valid text, `Hello there!`, with more than one character. */
-export const REQUIRED_TEXT = new TextSchema({ min: 1 });
-/** Title string, e.g. `Title of something` */
-export const TITLE = new TextSchema({ title: "Title", min: 1, max: 100 });
-/** Optional name string, e.g. `Title of something` or `null` */
-export const NULLABLE_TITLE = NULLABLE(TITLE);
-/** Name string, e.g. `Name of Something` */
-export const NAME = new TextSchema({ title: "Name", min: 1, max: 100 });
-/** Optional name string, e.g. `Name of Something` or `null` */
-export const NULLABLE_NAME = NULLABLE(NAME);
-/** Password string. */
-export const PASSWORD = new TextSchema({ title: "Password", min: 6, type: "password" });