@praha/byethrow 0.4.1 → 0.5.0

package/dist/cjs/exports.cjs

@@ -42,6 +42,9 @@ var __webpack_modules__ = {
     "./functions/or-else": function(module) {
         module.exports = require("./functions/or-else.cjs");
     },
+    "./functions/parse": function(module) {
+        module.exports = require("./functions/parse.cjs");
+    },
     "./functions/pipe": function(module) {
         module.exports = require("./functions/pipe.cjs");
     },
@@ -194,34 +197,40 @@ var __webpack_exports__ = {};
         return _functions_or_else__WEBPACK_IMPORTED_MODULE_14__[key];
     }).bind(0, __WEBPACK_IMPORT_KEY__);
     __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
-    var _functions_pipe__WEBPACK_IMPORTED_MODULE_15__ = __webpack_require__("./functions/pipe");
+    var _functions_parse__WEBPACK_IMPORTED_MODULE_15__ = __webpack_require__("./functions/parse");
+    var __WEBPACK_REEXPORT_OBJECT__ = {};
+    for(var __WEBPACK_IMPORT_KEY__ in _functions_parse__WEBPACK_IMPORTED_MODULE_15__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
+        return _functions_parse__WEBPACK_IMPORTED_MODULE_15__[key];
+    }).bind(0, __WEBPACK_IMPORT_KEY__);
+    __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
+    var _functions_pipe__WEBPACK_IMPORTED_MODULE_16__ = __webpack_require__("./functions/pipe");
     var __WEBPACK_REEXPORT_OBJECT__ = {};
-    for(var __WEBPACK_IMPORT_KEY__ in _functions_pipe__WEBPACK_IMPORTED_MODULE_15__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
-        return _functions_pipe__WEBPACK_IMPORTED_MODULE_15__[key];
+    for(var __WEBPACK_IMPORT_KEY__ in _functions_pipe__WEBPACK_IMPORTED_MODULE_16__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
+        return _functions_pipe__WEBPACK_IMPORTED_MODULE_16__[key];
     }).bind(0, __WEBPACK_IMPORT_KEY__);
     __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
-    var _functions_succeed__WEBPACK_IMPORTED_MODULE_16__ = __webpack_require__("./functions/succeed");
+    var _functions_succeed__WEBPACK_IMPORTED_MODULE_17__ = __webpack_require__("./functions/succeed");
     var __WEBPACK_REEXPORT_OBJECT__ = {};
-    for(var __WEBPACK_IMPORT_KEY__ in _functions_succeed__WEBPACK_IMPORTED_MODULE_16__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
-        return _functions_succeed__WEBPACK_IMPORTED_MODULE_16__[key];
+    for(var __WEBPACK_IMPORT_KEY__ in _functions_succeed__WEBPACK_IMPORTED_MODULE_17__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
+        return _functions_succeed__WEBPACK_IMPORTED_MODULE_17__[key];
     }).bind(0, __WEBPACK_IMPORT_KEY__);
     __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
-    var _functions_try__WEBPACK_IMPORTED_MODULE_17__ = __webpack_require__("./functions/try");
+    var _functions_try__WEBPACK_IMPORTED_MODULE_18__ = __webpack_require__("./functions/try");
     var __WEBPACK_REEXPORT_OBJECT__ = {};
-    for(var __WEBPACK_IMPORT_KEY__ in _functions_try__WEBPACK_IMPORTED_MODULE_17__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
-        return _functions_try__WEBPACK_IMPORTED_MODULE_17__[key];
+    for(var __WEBPACK_IMPORT_KEY__ in _functions_try__WEBPACK_IMPORTED_MODULE_18__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
+        return _functions_try__WEBPACK_IMPORTED_MODULE_18__[key];
     }).bind(0, __WEBPACK_IMPORT_KEY__);
     __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
-    var _functions_unwrap__WEBPACK_IMPORTED_MODULE_18__ = __webpack_require__("./functions/unwrap");
+    var _functions_unwrap__WEBPACK_IMPORTED_MODULE_19__ = __webpack_require__("./functions/unwrap");
     var __WEBPACK_REEXPORT_OBJECT__ = {};
-    for(var __WEBPACK_IMPORT_KEY__ in _functions_unwrap__WEBPACK_IMPORTED_MODULE_18__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
-        return _functions_unwrap__WEBPACK_IMPORTED_MODULE_18__[key];
+    for(var __WEBPACK_IMPORT_KEY__ in _functions_unwrap__WEBPACK_IMPORTED_MODULE_19__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
+        return _functions_unwrap__WEBPACK_IMPORTED_MODULE_19__[key];
     }).bind(0, __WEBPACK_IMPORT_KEY__);
     __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
-    var _functions_unwrap_error__WEBPACK_IMPORTED_MODULE_19__ = __webpack_require__("./functions/unwrap-error");
+    var _functions_unwrap_error__WEBPACK_IMPORTED_MODULE_20__ = __webpack_require__("./functions/unwrap-error");
     var __WEBPACK_REEXPORT_OBJECT__ = {};
-    for(var __WEBPACK_IMPORT_KEY__ in _functions_unwrap_error__WEBPACK_IMPORTED_MODULE_19__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
-        return _functions_unwrap_error__WEBPACK_IMPORTED_MODULE_19__[key];
+    for(var __WEBPACK_IMPORT_KEY__ in _functions_unwrap_error__WEBPACK_IMPORTED_MODULE_20__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
+        return _functions_unwrap_error__WEBPACK_IMPORTED_MODULE_20__[key];
     }).bind(0, __WEBPACK_IMPORT_KEY__);
     __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
 })();

package/dist/cjs/exports.d.ts

@@ -13,6 +13,7 @@ export * from './functions/is-success';
 export * from './functions/map';
 export * from './functions/map-error';
 export * from './functions/or-else';
+export * from './functions/parse';
 export * from './functions/pipe';
 export * from './functions/succeed';
 export * from './functions/try';

package/dist/cjs/functions/parse.cjs

@@ -0,0 +1,46 @@
+"use strict";
+var __webpack_require__ = {};
+(()=>{
+    __webpack_require__.d = (exports1, definition)=>{
+        for(var key in definition)if (__webpack_require__.o(definition, key) && !__webpack_require__.o(exports1, key)) Object.defineProperty(exports1, key, {
+            enumerable: true,
+            get: definition[key]
+        });
+    };
+})();
+(()=>{
+    __webpack_require__.o = (obj, prop)=>Object.prototype.hasOwnProperty.call(obj, prop);
+})();
+(()=>{
+    __webpack_require__.r = (exports1)=>{
+        if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+            value: 'Module'
+        });
+        Object.defineProperty(exports1, '__esModule', {
+            value: true
+        });
+    };
+})();
+var __webpack_exports__ = {};
+__webpack_require__.r(__webpack_exports__);
+__webpack_require__.d(__webpack_exports__, {
+    parse: ()=>parse
+});
+const external_fail_cjs_namespaceObject = require("./fail.cjs");
+const external_succeed_cjs_namespaceObject = require("./succeed.cjs");
+const is_promise_cjs_namespaceObject = require("../internals/helpers/is-promise.cjs");
+const parse = (schema, ...args)=>{
+    const apply = (input)=>{
+        const result = schema['~standard']['validate'](input);
+        if ((0, is_promise_cjs_namespaceObject.isPromise)(result)) throw new TypeError('Schema validation must be synchronous');
+        return result.issues ? (0, external_fail_cjs_namespaceObject.fail)(result.issues) : (0, external_succeed_cjs_namespaceObject.succeed)(result.value);
+    };
+    return args.length <= 0 ? apply : apply(args[0]);
+};
+exports.parse = __webpack_exports__.parse;
+for(var __webpack_i__ in __webpack_exports__)if (-1 === [
+    "parse"
+].indexOf(__webpack_i__)) exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/dist/cjs/functions/parse.d.ts

@@ -0,0 +1,37 @@
+import type { Result } from '../result';
+import type { StandardSchemaV1 } from '@standard-schema/spec';
+/**
+ * Parses a value using a {@link https://github.com/standard-schema/standard-schema Standard Schema} compatible schema.
+ * Returns a {@link Result} with the parsed value on success or validation errors on failure.
+ *
+ * @function
+ * @typeParam S - The Standard Schema V1 compatible schema type.
+ * @returns A {@link Result} with the parsed value or validation errors.
+ *
+ * @example Basic Usage
+ * ```ts
+ * import { Result } from '@praha/byethrow';
+ * import { z } from 'zod';
+ *
+ * const schema = z.object({ name: z.string() });
+ * const result = Result.parse(schema, { name: 'John' });
+ * // Result.Result<{ name: string }, ReadonlyArray<StandardSchemaV1.Issue>>
+ * ```
+ *
+ * @example Curried Usage
+ * ```ts
+ * import { Result } from '@praha/byethrow';
+ * import { z } from 'zod';
+ *
+ * const schema = z.object({ name: z.string() });
+ * const parser = Result.parse(schema);
+ * const result = parser({ name: 'John' });
+ * // Result.Result<{ name: string }, ReadonlyArray<StandardSchemaV1.Issue>>
+ * ```
+ *
+ * @category Utilities
+ */
+export declare const parse: {
+    <S extends StandardSchemaV1>(schema: S): (value: unknown) => Result<StandardSchemaV1.InferOutput<S>, ReadonlyArray<StandardSchemaV1.Issue>>;
+    <S extends StandardSchemaV1>(schema: S, value: unknown): Result<StandardSchemaV1.InferOutput<S>, ReadonlyArray<StandardSchemaV1.Issue>>;
+};

package/dist/esm/exports.d.ts

@@ -13,6 +13,7 @@ export * from './functions/is-success';
 export * from './functions/map';
 export * from './functions/map-error';
 export * from './functions/or-else';
+export * from './functions/parse';
 export * from './functions/pipe';
 export * from './functions/succeed';
 export * from './functions/try';

package/dist/esm/exports.js

@@ -13,6 +13,7 @@ export * from "./functions/is-success.js";
 export * from "./functions/map.js";
 export * from "./functions/map-error.js";
 export * from "./functions/or-else.js";
+export * from "./functions/parse.js";
 export * from "./functions/pipe.js";
 export * from "./functions/succeed.js";
 export * from "./functions/try.js";

package/dist/esm/functions/parse.d.ts

@@ -0,0 +1,37 @@
+import type { Result } from '../result';
+import type { StandardSchemaV1 } from '@standard-schema/spec';
+/**
+ * Parses a value using a {@link https://github.com/standard-schema/standard-schema Standard Schema} compatible schema.
+ * Returns a {@link Result} with the parsed value on success or validation errors on failure.
+ *
+ * @function
+ * @typeParam S - The Standard Schema V1 compatible schema type.
+ * @returns A {@link Result} with the parsed value or validation errors.
+ *
+ * @example Basic Usage
+ * ```ts
+ * import { Result } from '@praha/byethrow';
+ * import { z } from 'zod';
+ *
+ * const schema = z.object({ name: z.string() });
+ * const result = Result.parse(schema, { name: 'John' });
+ * // Result.Result<{ name: string }, ReadonlyArray<StandardSchemaV1.Issue>>
+ * ```
+ *
+ * @example Curried Usage
+ * ```ts
+ * import { Result } from '@praha/byethrow';
+ * import { z } from 'zod';
+ *
+ * const schema = z.object({ name: z.string() });
+ * const parser = Result.parse(schema);
+ * const result = parser({ name: 'John' });
+ * // Result.Result<{ name: string }, ReadonlyArray<StandardSchemaV1.Issue>>
+ * ```
+ *
+ * @category Utilities
+ */
+export declare const parse: {
+    <S extends StandardSchemaV1>(schema: S): (value: unknown) => Result<StandardSchemaV1.InferOutput<S>, ReadonlyArray<StandardSchemaV1.Issue>>;
+    <S extends StandardSchemaV1>(schema: S, value: unknown): Result<StandardSchemaV1.InferOutput<S>, ReadonlyArray<StandardSchemaV1.Issue>>;
+};

package/dist/esm/functions/parse.js

@@ -0,0 +1,12 @@
+import { fail } from "./fail.js";
+import { succeed } from "./succeed.js";
+import { isPromise } from "../internals/helpers/is-promise.js";
+const parse = (schema, ...args)=>{
+    const apply = (input)=>{
+        const result = schema['~standard']['validate'](input);
+        if (isPromise(result)) throw new TypeError('Schema validation must be synchronous');
+        return result.issues ? fail(result.issues) : succeed(result.value);
+    };
+    return args.length <= 0 ? apply : apply(args[0]);
+};
+export { parse };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@praha/byethrow",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "description": "A lightweight, tree-shakable Result type package with a simple, consistent API designed",
   "keywords": [
     "javascript",
@@ -40,6 +40,9 @@
     "LICENSE",
     "README.md"
   ],
+  "dependencies": {
+    "@standard-schema/spec": "^1.0.0"
+  },
   "devDependencies": {
     "@rslib/core": "0.10.4",
     "eslint": "9.30.1",