@mablock/status 0.0.1

package/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notters within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,333 @@
+# @mablock/status
+
+English | [简体中文](./README.zh-CN.md)
+
+A zero-runtime-dependency TypeScript implementation of Abseil-style `Status` and `StatusOr<T>` error handling.
+
+The package follows the central Abseil invariant:
+
+- `Status` contains either `OK` or a canonical error with a message and payloads. It never contains a business value.
+- `StatusOr<T>` contains exactly one value of type `T` or one non-OK `Status`.
+- An OK `Status` without a value cannot be converted into `StatusOr<T>`.
+
+This project is inspired by Abseil but is not affiliated with or maintained by Google.
+
+## Installation
+
+```bash
+npm install @mablock/status
+```
+
+The package includes ESM, CommonJS, and TypeScript declarations and requires Node.js 18 or newer when used in Node.
+
+## Basic usage: propagate errors to the boundary
+
+The main workflow is:
+
+1. A leaf function returns a normal `T` on success and `failure(status)` on error.
+2. Each middle layer calls `yield* ensureOk(ret)`. A failure stops that layer and is returned to its caller.
+3. The error continues upward in the same way until the top-level boundary.
+4. The boundary calls `hasError(ret)` once and handles the error without an `else` branch.
+
+```ts
+import {
+  type StatusOr,
+  statusDo,
+  ensureOk,
+  hasError,
+  failure,
+  NotFoundError,
+} from "@mablock/status";
+
+interface User {
+  id: number;
+  name: string;
+}
+
+interface Profile {
+  user: User;
+  label: string;
+}
+
+function findUser(id: number): User {
+  if (id === 404)
+    return failure(NotFoundError(`User ${id} not found`));
+  return { id, name: "Ada" };
+}
+
+function loadProfile(id: number): StatusOr<Profile> {
+  return statusDo(function* () {
+    var ret = findUser(id);
+    yield* ensureOk(ret);
+
+    return {
+      user: ret,
+      label: `${ret.name}#${ret.id}`,
+    };
+  });
+}
+
+function prepareProfile(id: number): StatusOr<string> {
+  return statusDo(function* () {
+    var ret = loadProfile(id);
+    const profile = yield* ensureOk(ret);
+
+    return `Profile: ${profile.label}`;
+  });
+}
+
+var ret = prepareProfile(404);
+if (hasError(ret)) {
+  console.error(ret.status().toString());
+  return;
+}
+
+console.log(ret.value());
+```
+
+`ensureOk` does not turn a failure into a business value. Inside `statusDo`, it short-circuits the generator and preserves the original status. The next layer can propagate that result with another `ensureOk`, while the top-level boundary handles it with `hasError`.
+
+For a direct-value function, the boundary pattern is even shorter:
+
+```ts
+var ret = findUser(404);
+if (hasError(ret)) {
+  console.error(ret.status().toString());
+  return;
+}
+
+console.log(ret.name);
+```
+
+## Status
+
+Use `Status` for operations that succeed without returning a value:
+
+```ts
+import {
+  type Status,
+  OkStatus,
+  InvalidArgumentError,
+} from "@mablock/status";
+
+function validatePort(port: number): Status {
+  if (!Number.isInteger(port) || port < 1 || port > 65_535)
+    return InvalidArgumentError(`Invalid port: ${port}`);
+  return OkStatus();
+}
+
+const status = validatePort(8080);
+if (!status.ok()) console.error(status.code(), status.message());
+```
+
+The default `Status` constructor and `OkStatus()` both create OK statuses. Constructing an OK status with a message discards the message, matching Abseil semantics.
+
+### Canonical Error Codes
+
+The 16 canonical error codes match gRPC and Abseil:
+
+- `CancelledError(message?, payloads?)`
+- `UnknownError(message?, payloads?)`
+- `InvalidArgumentError(message?, payloads?)`
+- `DeadlineExceededError(message?, payloads?)`
+- `NotFoundError(message?, payloads?)`
+- `AlreadyExistsError(message?, payloads?)`
+- `PermissionDeniedError(message?, payloads?)`
+- `ResourceExhaustedError(message?, payloads?)`
+- `FailedPreconditionError(message?, payloads?)`
+- `AbortedError(message?, payloads?)`
+- `OutOfRangeError(message?, payloads?)`
+- `UnimplementedError(message?, payloads?)`
+- `InternalError(message?, payloads?)`
+- `UnavailableError(message?, payloads?)`
+- `DataLossError(message?, payloads?)`
+- `UnauthenticatedError(message?, payloads?)`
+
+### Payloads
+
+`Status` instances can carry arbitrary binary (`Uint8Array`) or string payloads keyed by a unique URI or type URL:
+
+```ts
+import { NotFoundError } from "@mablock/status";
+
+const status = NotFoundError("User not found");
+status.setPayload(
+  "type.googleapis.com/google.rpc.ErrorInfo",
+  "USER_DISABLED",
+);
+
+if (status.hasPayload("type.googleapis.com/google.rpc.ErrorInfo")) {
+  const payload = status.getPayload(
+    "type.googleapis.com/google.rpc.ErrorInfo",
+  );
+  console.log(payload);
+}
+```
+
+### Updating a Status
+
+`status.update(other)` keeps the first non-OK status, matching `absl::Status::Update`:
+
+```ts
+import {
+  OkStatus,
+  NotFoundError,
+  CancelledError,
+} from "@mablock/status";
+
+const status = OkStatus();
+status.update(NotFoundError("First error"));
+status.update(CancelledError("Second error"));
+
+console.log(status.code()); // StatusCode.NOT_FOUND
+```
+
+## StatusOr<T>
+
+Use `StatusOr<T>` when an operation returns a value on success:
+
+```ts
+import {
+  StatusOr,
+  statusOr,
+  statusOrError,
+  NotFoundError,
+} from "@mablock/status";
+
+interface User {
+  id: number;
+  name: string;
+}
+
+function findUser(id: number): StatusOr<User> {
+  if (id === 404)
+    return statusOrError(NotFoundError(`User ${id} was not found`));
+  return statusOr({ id, name: "Ada" });
+}
+
+const result = findUser(42);
+if (result.ok()) {
+  console.log(result.value().name);
+} else {
+  console.error(result.status().toString());
+}
+```
+
+C++ can implicitly construct `StatusOr<T>` from an error `Status`. TypeScript has no equivalent implicit conversion, so use `statusOrError(error)` or `StatusOr.fromStatus(error)`.
+
+`StatusOr.fromStatus(OkStatus())` throws a `RangeError`, because an OK result must contain a value.
+
+### Transforming results
+
+```ts
+const displayName = findUser(42)
+  .transform((user) => user.name)
+  .valueOr("unknown");
+
+const message = findUser(404).match({
+  ok: (user) => `Found ${user.name}`,
+  err: (status) => `Failed: ${status}`,
+});
+```
+
+Available helpers include:
+
+- `value()`: Returns the contained value or throws `StatusError` if non-OK.
+- `valueOr(defaultValue)`: Returns the contained value or the provided fallback.
+- `valueOrCompute(fn)`: Computes a fallback from the failed `Status`.
+- `transform(fn)`: Maps `T` to `U` on success.
+- `andThen(fn)`: FlatMaps `T` to `StatusOr<U>` on success.
+- `match({ ok, err })`: Pattern matches on success or failure.
+- `StatusOr.all([a, b, c])`: Combines multiple `StatusOr` results into a single tuple.
+
+## Generator pipelines
+
+`statusDo` and `statusDoAsync` provide an `ASSIGN_OR_RETURN`-style flow using standard generators:
+
+```ts
+import {
+  type StatusOr,
+  statusDo,
+  statusOr,
+  statusOrError,
+  InvalidArgumentError,
+  ensureOk,
+} from "@mablock/status";
+
+function parseNumber(input: string): StatusOr<number> {
+  const value = Number(input);
+  if (Number.isNaN(value))
+    return statusOrError(
+      InvalidArgumentError(`Invalid number: ${input}`),
+    );
+  return statusOr(value);
+}
+
+const result = statusDo(function* () {
+  const left = yield* ensureOk(parseNumber("20"));
+
+  const rightOr = parseNumber("22");
+  yield* ensureOk(rightOr);
+  const right = rightOr.value();
+
+  return left + right;
+});
+```
+
+The pipeline stops at the first error and closes the generator, so `finally` cleanup blocks run.
+
+## Failure sentinels
+
+`failure(status)` creates a proxy that carries the original non-OK status while keeping the function's success type as `T`. Reading business properties from an unchecked failure throws `StatusError`; use `ensureOk` in middle layers and `hasError` at boundaries.
+
+### Transparent Proxy Access
+
+Wrap any `StatusOr<T>` with `asProxy` to access properties of `T` directly:
+
+```ts
+import { asProxy, statusOr } from "@mablock/status";
+
+const proxy = asProxy(statusOr({ id: 1, name: "Ada" }));
+console.log(proxy.name); // "Ada"
+console.log(proxy.ok()); // true
+```
+
+## JavaScript Error Interop
+
+Convert native JavaScript exceptions to canonical `Status`:
+
+```ts
+import { fromError, tryCatch, tryCatchAsync } from "@mablock/status";
+
+const status = fromError(new TypeError("Invalid argument"));
+console.log(status.code()); // StatusCode.INVALID_ARGUMENT
+
+const syncResult = tryCatch(() => JSON.parse(rawText));
+
+const asyncResult = await tryCatchAsync(async () => fetchUserData());
+```
+
+## Predicates
+
+Type guard predicates for checking specific error conditions:
+
+```ts
+import {
+  isOk,
+  hasError,
+  isNotFound,
+  isInvalidArgument,
+} from "@mablock/status";
+
+if (isOk(result)) {
+  // result is narrowed
+}
+
+if (isNotFound(statusOr)) {
+  // handle not found
+}
+```
+
+## License
+
+Apache-2.0