@cyberskill/shared 2.0.0 → 2.2.0

package/dist/typescript/common.type.d.ts

@@ -22,17 +22,50 @@ export interface I_Log {
     trace: typeof consola['trace'];
     verbose: typeof consola['verbose'];
 }
-export interface I_ReturnSuccess<T, E = unknown> {
-    success: true;
-    result: T & E;
+/**
+ * Base interface for return types with common properties.
+ */
+export interface I_ReturnBase {
+    success: boolean;
     message?: string;
     code?: number | string;
 }
-export interface I_ReturnFailure {
+/**
+ * Success return type with result data.
+ * @template T - The main result type
+ * @template E - Additional properties to merge with the result (defaults to unknown)
+ */
+export interface I_ReturnSuccess<T, E = unknown> extends I_ReturnBase {
+    success: true;
+    result: T & E;
+}
+/**
+ * Failure return type with error information.
+ */
+export interface I_ReturnFailure extends I_ReturnBase {
     success: false;
     message: string;
     code: number | string;
 }
+/**
+ * Discriminated union type for function return values.
+ * Provides type-safe handling of success and failure cases.
+ *
+ * @template T - The success result type (defaults to void)
+ * @template E - Additional properties to merge with the result (defaults to unknown)
+ *
+ * @example
+ * ```typescript
+ * function fetchUser(id: string): I_Return<User> {
+ *   try {
+ *     const user = await getUser(id);
+ *     return { success: true, result: user };
+ *   } catch (error) {
+ *     return { success: false, message: error.message, code: 'USER_NOT_FOUND' };
+ *   }
+ * }
+ * ```
+ */
 export type I_Return<T = void, E = unknown> = I_ReturnSuccess<T, E> | I_ReturnFailure;
 export declare enum E_Environment {
     PRODUCTION = "production",

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@cyberskill/shared",
     "type": "module",
-    "version": "2.0.0",
+    "version": "2.2.0",
     "description": "CyberSkill Shared",
     "author": "Stephen Cheng",
     "license": "MIT",
@@ -207,12 +207,12 @@
         "test:unit": "tsx src/node/cli/index.ts test:unit"
     },
     "dependencies": {
-        "@antfu/eslint-config": "4.17.0",
+        "@antfu/eslint-config": "5.0.0",
         "@apollo/client": "3.13.8",
         "@apollo/client-integration-nextjs": "0.12.2",
         "@apollo/server": "5.0.0",
         "@as-integrations/express5": "1.1.2",
-        "@dotenvx/dotenvx": "1.48.2",
+        "@dotenvx/dotenvx": "1.48.3",
         "@eddeee888/gcg-typescript-resolver-files": "0.12.1",
         "@eslint-react/eslint-plugin": "1.52.3",
         "@graphql-codegen/cli": "5.0.7",
@@ -248,7 +248,7 @@
         "localforage": "1.10.0",
         "lodash-es": "4.17.21",
         "migrate-mongo": "12.1.3",
-        "mongodb": "6.17.0",
+        "mongodb": "6.18.0",
         "mongoose": "8.16.4",
         "mongoose-aggregate-paginate-v2": "1.1.4",
         "mongoose-paginate-v2": "1.9.1",
@@ -259,11 +259,11 @@
         "react": "19.1.0",
         "react-dom": "19.1.0",
         "react-hot-toast": "2.5.2",
-        "react-i18next": "15.6.0",
+        "react-i18next": "15.6.1",
         "slugify": "1.6.6",
         "unorm": "1.6.0",
         "uuid": "11.1.0",
-        "vite": "7.0.5",
+        "vite": "7.0.6",
         "ws": "8.18.3",
         "yargs": "18.0.0"
     },
@@ -271,7 +271,7 @@
         "@commitlint/cli": "19.8.1",
         "@commitlint/config-conventional": "19.8.1",
         "@eslint/config-inspector": "1.1.0",
-        "@next/eslint-plugin-next": "15.4.2",
+        "@next/eslint-plugin-next": "15.4.4",
         "@testing-library/jest-dom": "6.6.3",
         "@testing-library/react": "16.3.0",
         "@types/apollo-upload-client": "18.0.0",
@@ -287,7 +287,7 @@
         "@types/graphql-upload": "17.0.0",
         "@types/lodash-es": "4.17.12",
         "@types/migrate-mongo": "10.0.5",
-        "@types/node": "24.0.15",
+        "@types/node": "24.1.0",
         "@types/node-persist": "3.1.8",
         "@types/react": "19.1.8",
         "@types/react-dom": "19.1.6",
@@ -297,7 +297,7 @@
         "@types/yargs": "17.0.33",
         "@vitest/browser": "3.2.4",
         "eslint": "9.31.0",
-        "eslint-config-next": "15.4.2",
+        "eslint-config-next": "15.4.4",
         "glob": "11.0.3",
         "lint-staged": "16.1.2",
         "node-modules-inspector": "1.0.0",
@@ -306,7 +306,7 @@
         "simple-git-hooks": "2.13.0",
         "tsx": "4.20.3",
         "typescript": "5.8.3",
-        "vite": "7.0.5",
+        "vite": "7.0.6",
         "vite-plugin-dts": "4.5.4",
         "vitest": "3.2.4"
     },