@plyaz/types 1.28.0 → 1.29.0

package/dist/core/frontend/types.d.ts

@@ -741,6 +741,64 @@ export interface CoreBaseFrontendServiceConfig<TData = Record<string, unknown>,
      * @default undefined (no unwrapping, response.data used as-is)
      */
     responseDataKey?: string;
+    /**
+     * Key to extract success status from API response.
+     *
+     * Allows services to work with different API response formats:
+     * - Internal APIs: `'success'` or `'isSuccess'`
+     * - Fetchff: `'ok'`
+     * - Custom APIs: any property name or nested key
+     *
+     * Supports nested keys via dot notation (e.g., `'meta.success'`).
+     *
+     * If not set, falls back to checking common properties in order:
+     * `isSuccess` → `success` → `ok` → HTTP status 200-299
+     *
+     * @example
+     * ```typescript
+     * // Internal API returns: { success: true, data: [...] }
+     * responseSuccessKey: 'success'
+     *
+     * // Fetchff returns: { ok: true, status: 200, data: [...] }
+     * responseSuccessKey: 'ok'
+     *
+     * // Custom API returns: { meta: { succeeded: true }, payload: [...] }
+     * responseSuccessKey: 'meta.succeeded'
+     * ```
+     *
+     * @default undefined (auto-detect from common properties)
+     */
+    responseSuccessKey?: string;
+    /**
+     * Key to extract error from API response.
+     *
+     * Allows services to work with different API error formats:
+     * - Internal APIs: `'error'` or `'errors'`
+     * - Fetchff: `'error'`
+     * - Custom 3rd party APIs: any property name or nested key
+     *
+     * Supports nested keys via dot notation (e.g., `'meta.error'`, `'response.errors'`).
+     *
+     * The extracted error will be transformed through `@plyaz/errors` middleware.
+     *
+     * @example
+     * ```typescript
+     * // Internal API returns: { success: false, error: { code: 'ERR', message: '...' } }
+     * responseErrorKey: 'error'
+     *
+     * // 3rd party API returns: { status: 'failed', errors: [...] }
+     * responseErrorKey: 'errors'
+     *
+     * // Nested format: { meta: { error: { code: '...', details: [...] } } }
+     * responseErrorKey: 'meta.error'
+     *
+     * // GraphQL-style: { data: null, errors: [{ message: '...' }] }
+     * responseErrorKey: 'errors'
+     * ```
+     *
+     * @default undefined (auto-detect from 'error' or 'errors')
+     */
+    responseErrorKey?: string;
     /** Fetcher functions for API operations (replaces direct apiClient usage) */
     fetchers?: CoreServiceFetchers<unknown, unknown, unknown, unknown, unknown, unknown, unknown>;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plyaz/types",
-  "version": "1.28.0",
+  "version": "1.29.0",
   "author": "Redeemer Pace",
   "license": "ISC",
   "description": "Provides shared TypeScript types and schema utilities for validation and parsing in the @playz ecosystem.",