shelving 1.29.0 → 1.30.0

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.29.0",
+	"version": "1.30.0",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",
@@ -63,20 +63,20 @@
 		"@types/jest": "^27.0.3",
 		"@types/react": "^17.0.37",
 		"@types/react-dom": "^17.0.11",
-		"@typescript-eslint/eslint-plugin": "^5.5.0",
-		"@typescript-eslint/parser": "^5.5.0",
-		"eslint": "^8.4.0",
+		"@typescript-eslint/eslint-plugin": "^5.6.0",
+		"@typescript-eslint/parser": "^5.6.0",
+		"eslint": "^8.4.1",
 		"eslint-config-prettier": "^8.3.0",
 		"eslint-plugin-import": "^2.25.3",
 		"eslint-plugin-prettier": "^4.0.0",
-		"firebase": "^9.6.0",
-		"jest": "^27.4.3",
+		"firebase": "^9.6.1",
+		"jest": "^27.4.4",
 		"jest-ts-webcompat-resolver": "^1.0.0",
 		"prettier": "^2.5.1",
 		"react": "^17.0.2",
 		"react-dom": "^17.0.2",
-		"ts-jest": "^27.0.7",
-		"typescript": "^4.5.2"
+		"ts-jest": "^27.1.1",
+		"typescript": "^4.5.3"
 	},
 	"peerDependencies": {
 		"@google-cloud/firestore": ">=4.0.0",

package/schema/StringSchema.d.ts

@@ -1,6 +1,8 @@
 import { Schema } from "./Schema.js";
 /** `type=""` prop for HTML `<input />` tags that are relevant for strings. */
 export declare type HtmlInputType = "text" | "password" | "color" | "date" | "email" | "number" | "tel" | "search" | "url";
+/** Function that sanitizes a string. */
+export declare type Sanitizer = (str: string) => string;
 /**
  * Schema that defines a valid string.
  *
@@ -27,14 +29,16 @@ export declare class StringSchema extends Schema<string> {
     readonly min: number;
     readonly max: number | null;
     readonly match: RegExp | null;
+    readonly sanitizer: Sanitizer | null;
     readonly multiline: boolean;
     readonly trim: boolean;
-    constructor({ value, type, min, max, match, multiline, trim, ...rest }: ConstructorParameters<typeof Schema>[0] & {
+    constructor({ value, type, min, max, match, sanitizer, multiline, trim, ...rest }: ConstructorParameters<typeof Schema>[0] & {
         readonly value?: string;
         readonly type?: HtmlInputType;
         readonly min?: number;
         readonly max?: number | null;
         readonly match?: RegExp | null;
+        readonly sanitizer?: Sanitizer | null;
         readonly multiline?: boolean;
         readonly trim?: boolean;
     });

package/schema/StringSchema.js

@@ -22,13 +22,14 @@ import { Schema } from "./Schema.js";
  *  schema.validate('j'); // Throws 'Minimum 3 chaacters'
  */
 export class StringSchema extends Schema {
-    constructor({ value = "", type = "text", min = 0, max = null, match = null, multiline = false, trim = true, ...rest }) {
+    constructor({ value = "", type = "text", min = 0, max = null, match = null, sanitizer = null, multiline = false, trim = true, ...rest }) {
         super(rest);
         this.type = type;
         this.value = value;
         this.min = min;
         this.max = max;
         this.match = match;
+        this.sanitizer = sanitizer;
         this.multiline = multiline;
         this.trim = trim;
     }
@@ -51,7 +52,11 @@ export class StringSchema extends Schema {
      * - Applies `options.sanitizer` too (if it's set).
      */
     sanitize(uncleanString) {
-        return this.multiline ? sanitizeLines(uncleanString, this.trim) : sanitizeString(uncleanString, this.trim);
+        return this.sanitizer
+            ? this.sanitizer(uncleanString)
+            : this.multiline
+                ? sanitizeLines(uncleanString, this.trim)
+                : sanitizeString(uncleanString, this.trim);
     }
 }
 /** Valid string, e.g. `Hello there!` */

package/stream/State.d.ts

@@ -1,5 +1,5 @@
 import { Transformer, LOADING, ObserverType, NOERROR, Observer } from "../util/index.js";
-import { Stream } from "./Stream.js";
+import { AnyStream, Stream } from "./Stream.js";
 /** Any state (useful for `extends AnySubscribable` clauses). */
 export declare type AnyState = State<any>;
 /**
@@ -14,8 +14,11 @@ export declare type AnyState = State<any>;
  * */
 export interface State<T> {
     to(): State<T>;
+    to<O extends AnyStream>(target: O): O;
     derive<TT>(transformer: Transformer<T, TT>): State<TT>;
+    derive<O extends AnyStream>(transformer: Transformer<T, ObserverType<O>>, target: O): O;
     deriveAsync<TT>(transformer: Transformer<T, PromiseLike<TT>>): State<TT>;
+    deriveAsync<O extends AnyStream>(transformer: Transformer<T, Promise<ObserverType<O>>>, target: O): O;
 }
 export declare class State<T> extends Stream<T> {
     static [Symbol.species]: typeof State;

package/util/data.d.ts

@@ -134,3 +134,11 @@ export declare type DeepMutable<T extends Data> = {
 export declare type DeepReadonly<T extends Data> = {
     +readonly [K in keyof T]: T[K] extends Data ? DeepReadonly<T[K]> : T[K];
 };
+/** Pick only the properties of an object that match a type. */
+export declare type PickProps<T, TT> = Pick<T, {
+    [K in keyof T]: T[K] extends TT ? K : never;
+}[keyof T]>;
+/** Omit the properties of an object that match a type. */
+export declare type OmitProps<T, TT> = Omit<T, {
+    [K in keyof T]: T[K] extends TT ? K : never;
+}[keyof T]>;