shelving 1.21.0 → 1.22.0

package/api/Resource.d.ts

@@ -6,20 +6,11 @@ import { Validator, Validatable } from "../util/index.js";
  * @param returns The `Validator` the function's returned value must conform to (defaults to `undefined` if not specified).
  */
 export declare class Resource<P = unknown, R = void> implements Validatable<R> {
-    static create<X, Y>(payload: Validator<X>, result: Validator<Y>): Resource<X, Y>;
-    static create<Y>(payload: undefined, result: Y): Resource<undefined, Y>;
-    static create<X>(payload: Validator<X>, result?: undefined): Resource<X, void>;
-    static create(payload?: undefined, result?: undefined): Resource<undefined, void>;
     /** Payload validator. */
     readonly payload: Validator<P>;
     /** Result validator. */
     readonly result: Validator<R>;
-    protected constructor(payload: Validator<P>, result: Validator<R>);
-    /**
-     * Validate a payload for this resource.
-     *
-     */
-    validatePayload(unsafePayload: unknown): P;
+    constructor(payload: Validator<P>, result: Validator<R>);
     /**
      * Validate a result for this resource.
      *
@@ -32,3 +23,11 @@ export declare class Resource<P = unknown, R = void> implements Validatable<R> {
 export declare type PayloadType<X extends Resource> = X extends Resource<infer Y, unknown> ? Y : never;
 /** Extract the result type from a `Resource`. */
 export declare type ResourceType<X extends Resource> = X extends Resource<unknown, infer Y> ? Y : never;
+/**
+ * Shortcut to create a new `Resource` (consistent with `Schema` shortcuts.
+ * - Sets `undefined` as the default type for payload and result.
+ */
+export declare function RESOURCE<X, Y>(payload: Validator<X>, result: Validator<Y>): Resource<X, Y>;
+export declare function RESOURCE<Y>(payload: undefined, result: Y): Resource<undefined, Y>;
+export declare function RESOURCE<X>(payload: Validator<X>, result?: undefined): Resource<X, void>;
+export declare function RESOURCE(payload?: undefined, result?: undefined): Resource<undefined, void>;

package/api/Resource.js

@@ -1,8 +1,6 @@
 import { UNDEFINED, validate } from "../util/index.js";
-import { Feedback, throwFeedback } from "../feedback/index.js";
+import { Feedback } from "../feedback/index.js";
 import { ResourceValidationError } from "./errors.js";
-/** Validator that always returns void/undefined. */
-const UNDEFINED_VALIDATOR = UNDEFINED;
 /**
  * An abstract API resource definition, used to specify types for e.g. serverless functions..
  *
@@ -15,16 +13,6 @@ export class Resource {
         this.payload = payload;
         this.result = result;
     }
-    static create(payload = UNDEFINED_VALIDATOR, result = UNDEFINED_VALIDATOR) {
-        return new Resource(payload, result);
-    }
-    /**
-     * Validate a payload for this resource.
-     *
-     */
-    validatePayload(unsafePayload) {
-        return throwFeedback(validate(unsafePayload, this.payload));
-    }
     /**
      * Validate a result for this resource.
      *
@@ -40,3 +28,6 @@ export class Resource {
         }
     }
 }
+export function RESOURCE(payload = UNDEFINED, result = UNDEFINED) {
+    return new Resource(payload, result);
+}

package/feedback/index.d.ts

@@ -4,4 +4,3 @@ export * from "./WarningFeedback.js";
 export * from "./ErrorFeedback.js";
 export * from "./InvalidFeedback.js";
 export * from "./hydrations.js";
-export * from "./util.js";

package/feedback/index.js

@@ -4,4 +4,3 @@ export * from "./WarningFeedback.js";
 export * from "./ErrorFeedback.js";
 export * from "./InvalidFeedback.js";
 export * from "./hydrations.js";
-export * from "./util.js";

package/package.json

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

package/provider/ValidationProvider.js

@@ -1,6 +1,5 @@
 import { validate, ValidateObserver, callAsync } from "../util/index.js";
 import { Transform, validateTransform } from "../transform/index.js";
-import { throwFeedback } from "../feedback/index.js";
 import { ThroughProvider } from "./ThroughProvider.js";
 /** Validates any values that are read from or written to a source provider. */
 export class ValidationProvider extends ThroughProvider {
@@ -11,7 +10,7 @@ export class ValidationProvider extends ThroughProvider {
         return super.subscribe(ref, new ValidateObserver(ref, observer));
     }
     add(ref, data) {
-        return super.add(ref, throwFeedback(validate(data, ref.validator)));
+        return super.add(ref, validate(data, ref.validator));
     }
     write(ref, value) {
         return super.write(ref, value ? _validateWrite(value, ref.validator) : value);
@@ -28,5 +27,5 @@ export class ValidationProvider extends ThroughProvider {
 }
 /** Validate data or a transform for a path. */
 function _validateWrite(value, validator) {
-    return throwFeedback(value instanceof Transform ? validateTransform(value, validator) : validate(value, validator));
+    return value instanceof Transform ? validateTransform(value, validator) : validate(value, validator);
 }

package/feedback/util.d.ts

@@ -1,3 +0,0 @@
-import { Feedback } from "./Feedback.js";
-/** Throw the value if it's an instance of `Feedback` */
-export declare function throwFeedback<T>(value: T | Feedback): T;

package/feedback/util.js

@@ -1,7 +0,0 @@
-import { Feedback } from "./Feedback.js";
-/** Throw the value if it's an instance of `Feedback` */
-export function throwFeedback(value) {
-    if (value instanceof Feedback)
-        throw value;
-    return value;
-}