@kosdev-code/kos-ui-sdk 0.1.0-dev.5053 → 0.1.0-dev.5072

package/core/util/service-response.d.ts

@@ -0,0 +1,110 @@
+import { IKosDataModel } from '../core/kosModel';
+import { ApiPath, HttpMethod } from '../core/decorators/kos-service-request';
+
+/**
+ * Utility functions for accessing cached service responses from ServiceResponseStore
+ *
+ * These functions provide type-safe access to responses stored by @kosServiceRequest
+ * decorated methods, eliminating the need for "magic last parameter" patterns.
+ *
+ * @example
+ * ```typescript
+ * @kosServiceRequest({
+ *   path: PATH_INGREDIENTS,
+ *   method: 'get',
+ *   lifecycle: DependencyLifecycle.LOAD
+ * })
+ * private onIngredientsLoaded(): void {
+ *   const response = getServiceResponse(this, PATH_INGREDIENTS, 'get');
+ *   this.processIngredients(response.data.ingredients);
+ * }
+ * ```
+ */
+/**
+ * Get cached service response by path and method
+ *
+ * Returns the response data cached by @kosServiceRequest decorated methods.
+ * TypeScript will infer types from your OpenAPI schema when using typed path constants.
+ *
+ * For cross-package scenarios where OpenAPI specs differ, you can optionally
+ * provide an explicit type parameter.
+ *
+ * @param model - The KOS model instance
+ * @param path - The API path constant
+ * @param method - The HTTP method (defaults to 'get')
+ * @returns The cached response data, or undefined if not found/expired
+ *
+ * @example Standard usage (types inferred from OpenAPI)
+ * ```typescript
+ * const status = getServiceResponse(this, PATH_DEVICE_STATUS, 'get');
+ * // TypeScript infers the type from PATH_DEVICE_STATUS
+ * ```
+ *
+ * @example Cross-package usage with explicit type (when OpenAPI schemas differ)
+ * ```typescript
+ * // Studio models using different OpenAPI than main SDK
+ * const vms = getServiceResponse<StudioVMResponse>(this, PATH_VMS, 'get');
+ * ```
+ */
+export declare function getServiceResponse<T = any>(model: IKosDataModel, path: ApiPath, method?: HttpMethod): T | undefined;
+/**
+ * Check if a cached response exists for the given path and method
+ *
+ * @param model - The KOS model instance
+ * @param path - The API path constant
+ * @param method - The HTTP method (defaults to 'get')
+ * @returns true if a valid cached response exists
+ *
+ * @example
+ * ```typescript
+ * if (hasCachedResponse(this, PATH_DEVICE_STATUS, 'get')) {
+ *   // Use cached data
+ *   const status = getServiceResponse(this, PATH_DEVICE_STATUS, 'get');
+ * } else {
+ *   // Fetch fresh data
+ *   await this.refreshStatus();
+ * }
+ * ```
+ */
+export declare function hasCachedResponse(model: IKosDataModel, path: ApiPath, method?: HttpMethod): boolean;
+/**
+ * Manually clear a cached service response
+ *
+ * @param model - The KOS model instance
+ * @param path - The API path constant
+ * @param method - The HTTP method (defaults to 'get')
+ *
+ * @example
+ * ```typescript
+ * // Clear cached response to force refresh on next request
+ * clearServiceResponse(this, PATH_TEMP_DATA, 'post');
+ * ```
+ */
+export declare function clearServiceResponse(model: IKosDataModel, path: ApiPath, method?: HttpMethod): void;
+/**
+ * Clear all cached responses for a specific path (all methods)
+ *
+ * @param model - The KOS model instance
+ * @param path - The API path constant
+ *
+ * @example
+ * ```typescript
+ * // Clear all cached responses for this endpoint
+ * clearPath(this, PATH_INGREDIENTS);
+ * // Clears GET, POST, PUT, DELETE responses for this path
+ * ```
+ */
+export declare function clearPath(model: IKosDataModel, path: ApiPath): void;
+/**
+ * Clear all cached service responses in the model
+ *
+ * @param model - The KOS model instance
+ *
+ * @example
+ * ```typescript
+ * // Clear all cached responses (typically during model cleanup)
+ * clearAllServiceResponses(this);
+ * ```
+ */
+export declare function clearAllServiceResponses(model: IKosDataModel): void;
+//# sourceMappingURL=service-response.d.ts.map

package/core/util/service-response.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service-response.d.ts","sourceRoot":"","sources":["../../../../../../packages/sdk/kos-ui-sdk/src/core/util/service-response.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EACP,UAAU,EACX,MAAM,wCAAwC,CAAC;AAChD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEtD;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,GAAG,GAAG,EACxC,KAAK,EAAE,aAAa,EACpB,IAAI,EAAE,OAAO,EACb,MAAM,GAAE,UAAkB,GACzB,CAAC,GAAG,SAAS,CAOf;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,aAAa,EACpB,IAAI,EAAE,OAAO,EACb,MAAM,GAAE,UAAkB,GACzB,OAAO,CAOT;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,aAAa,EACpB,IAAI,EAAE,OAAO,EACb,MAAM,GAAE,UAAkB,GACzB,IAAI,CAON;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,OAAO,GAAG,IAAI,CAOnE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,aAAa,GAAG,IAAI,CAOnE"}