@bagelink/sdk 1.8.32 → 1.8.35

package/README.md

@@ -93,3 +93,20 @@ const { loading, error, data, execute } = useApiRequest(
 )
 ```
 
+## Type Assignment
+
+For assigning single objects to plain types:
+
+```typescript
+import { unwrap } from './.bagelink/api'
+
+const agent = ref<AgentResponse | null>(null)
+agent.value = unwrap(await api.agents.getByAgentId({ agentId }))
+```
+
+Arrays work without `unwrap()`:
+```typescript
+const agents = ref<AgentResponse[]>([])
+agents.value = await api.agents.get()  // Works fine
+```
+

package/dist/index.cjs

@@ -727,7 +727,7 @@ function generateFunctionForOperation(method, path, operation) {
   );
   const allParams = isFileUpload ? "file: File, options?: UploadOptions & { dirPath?: string, tags?: string[] }" : combineAllParams(parameters, requestBodyParam);
   const responseType = generateResponseType(operation.responses);
-  const responseTypeStr = responseType ? `: Promise<AxiosResponse<${responseType}>>` : "";
+  const responseTypeStr = responseType ? `: Promise<ApiResponse<${responseType}>>` : "";
   const functionComment = buildJSDocComment(operation, method, path);
   if (isStream) {
     const eventTypes = extractSSEEventTypes(operation);
@@ -930,6 +930,7 @@ import {
 	formatFieldErrors,
 	useApiRequest,
 	useCancellableRequest,
+	unwrap,
 	${streamImports}
 	type ApiConfig,
 	type ParsedError,
@@ -938,7 +939,8 @@ import {
 	type ResponseMetadata,
 	type ApiRequestState,
 	type RequestInterceptor,
-	type ResponseInterceptor
+	type ResponseInterceptor,
+	type Unwrapped
 } from '@bagelink/sdk';
 import { ref, type Ref } from 'vue';
 
@@ -1092,6 +1094,7 @@ export {
 	formatFieldErrors,
 	useApiRequest,
 	useCancellableRequest,
+	unwrap,
 	ApiResponse,
 	type ApiConfig,
 	type ParsedError,
@@ -1100,7 +1103,8 @@ export {
 	type FastAPIValidationError,
 	type FastAPIErrorResponse,
 	type RequestInterceptor,
-	type ResponseInterceptor
+	type ResponseInterceptor,
+	type Unwrapped
 }
 `;
   return templateCode.replace(/"([^"]+)":/g, "$1:");
@@ -1389,6 +1393,20 @@ const index = async (openApiUrl, baseUrl) => {
   }
 };
 
+function unwrap(response) {
+  if (!response || typeof response !== "object") {
+    return response;
+  }
+  if (Array.isArray(response)) {
+    return response;
+  }
+  if ("$raw" in response) {
+    const { $raw, $metadata, totalCount, page, perPage, totalPages, rateLimit, rateLimitReset, getHeader, hasPagination, hasNextPage, hasPrevPage, ...data } = response;
+    return data;
+  }
+  return response;
+}
+
 function formatAPIErrorMessage(err) {
   const error = err;
   if (!error || !error.response) {
@@ -1919,6 +1937,7 @@ exports.isSSEStream = isSSEStream;
 exports.isSchemaObject = isSchemaObject;
 exports.openAPI = index;
 exports.parseApiError = parseApiError;
+exports.unwrap = unwrap;
 exports.useApiRequest = useApiRequest;
 exports.useCancellableRequest = useCancellableRequest;
 exports.wrapApiForDirectReturn = wrapApiForDirectReturn;

package/dist/index.d.cts

@@ -532,6 +532,27 @@ interface OpenAPIResponse {
 }
 declare const _default: (openApiUrl: string, baseUrl: string) => Promise<OpenAPIResponse>;
 
+/**
+ * Unwrap utility for ApiResponse
+ *
+ * Use this when you need to assign API responses to plain types
+ */
+
+/**
+ * Unwrap an ApiResponse to get the plain data
+ *
+ * @example
+ * import { unwrap } from '@bagelink/sdk'
+ *
+ * const agent = ref<AgentResponse | null>(null)
+ * agent.value = unwrap(await api.agents.getByAgentId({ agentId }))
+ */
+declare function unwrap<T>(response: ApiResponse<T> | T): T;
+/**
+ * Type helper to unwrap ApiResponse
+ */
+type Unwrapped<T> = T extends ApiResponse<infer U> ? U : T;
+
 declare function formatAPIErrorMessage(err: unknown): string;
 
 /**
@@ -553,6 +574,11 @@ interface ResponseMetadata {
     /** Custom headers */
     [key: string]: any;
 }
+/**
+ * Helper to unwrap ApiResponse type for assignments
+ * Use this when you need to assign to a plain type
+ */
+type Unwrap<T> = T extends ApiResponse<infer U> ? U : T;
 /**
  * Enhanced API response that adds metadata to the response data
  * - For arrays: acts as array with metadata properties
@@ -772,5 +798,5 @@ declare class Bagel {
     uploadFile<T>(file: File, options?: UploadOptions): Promise<T>;
 }
 
-export { ApiResponse, Bagel, StreamController, createSSEStream, createSSEStreamPost, dereference, extractSSEEventInfo, extractSSEEventTypes, formatAPIErrorMessage, formatFieldErrors, getPath, isReferenceObject, isSSEStream, isSchemaObject, _default as openAPI, parseApiError, useApiRequest, useCancellableRequest, wrapApiForDirectReturn };
-export type { ApiConfig, ApiRequestState, BaseParameterObject, CallbackObject, CallbacksObject, ComponentsObject, ContactObject, ContentObject, DiscriminatorObject, EncodingObject, EncodingPropertyObject, ExampleObject, ExamplesObject, ExternalDocumentationObject, FastAPIErrorResponse, FastAPIValidationError, HeaderObject, HeadersObject, InfoObject, LicenseObject, LinkObject, LinkParametersObject, LinksObject, MediaTypeObject, OAuthFlowObject, OAuthFlowsObject, OpenAPIObject, OperationObject, ParameterLocation, ParameterObject, ParameterStyle, ParsedError, PathItemObject, PathsObject, ReferenceObject, RequestBodyObject, RequestInterceptor, ResponseInterceptor, ResponseMetadata, ResponseObject, ResponsesObject, SSEEvent, SSEEventTypeInfo, SSEStreamOptions, SchemaObject, SchemaObjectType, SchemasObject, ScopesObject, SecurityRequirementObject, SecuritySchemeObject, SecuritySchemeType, ServerObject, ServerVariableObject, StreamEventMap, TableToTypeMapping, Tables, TagObject, TypeFormatT, UploadOptions, User, XmlObject };
+export { ApiResponse, Bagel, StreamController, createSSEStream, createSSEStreamPost, dereference, extractSSEEventInfo, extractSSEEventTypes, formatAPIErrorMessage, formatFieldErrors, getPath, isReferenceObject, isSSEStream, isSchemaObject, _default as openAPI, parseApiError, unwrap, useApiRequest, useCancellableRequest, wrapApiForDirectReturn };
+export type { ApiConfig, ApiRequestState, BaseParameterObject, CallbackObject, CallbacksObject, ComponentsObject, ContactObject, ContentObject, DiscriminatorObject, EncodingObject, EncodingPropertyObject, ExampleObject, ExamplesObject, ExternalDocumentationObject, FastAPIErrorResponse, FastAPIValidationError, HeaderObject, HeadersObject, InfoObject, LicenseObject, LinkObject, LinkParametersObject, LinksObject, MediaTypeObject, OAuthFlowObject, OAuthFlowsObject, OpenAPIObject, OperationObject, ParameterLocation, ParameterObject, ParameterStyle, ParsedError, PathItemObject, PathsObject, ReferenceObject, RequestBodyObject, RequestInterceptor, ResponseInterceptor, ResponseMetadata, ResponseObject, ResponsesObject, SSEEvent, SSEEventTypeInfo, SSEStreamOptions, SchemaObject, SchemaObjectType, SchemasObject, ScopesObject, SecurityRequirementObject, SecuritySchemeObject, SecuritySchemeType, ServerObject, ServerVariableObject, StreamEventMap, TableToTypeMapping, Tables, TagObject, TypeFormatT, Unwrap, Unwrapped, UploadOptions, User, XmlObject };

package/dist/index.d.mts

@@ -532,6 +532,27 @@ interface OpenAPIResponse {
 }
 declare const _default: (openApiUrl: string, baseUrl: string) => Promise<OpenAPIResponse>;
 
+/**
+ * Unwrap utility for ApiResponse
+ *
+ * Use this when you need to assign API responses to plain types
+ */
+
+/**
+ * Unwrap an ApiResponse to get the plain data
+ *
+ * @example
+ * import { unwrap } from '@bagelink/sdk'
+ *
+ * const agent = ref<AgentResponse | null>(null)
+ * agent.value = unwrap(await api.agents.getByAgentId({ agentId }))
+ */
+declare function unwrap<T>(response: ApiResponse<T> | T): T;
+/**
+ * Type helper to unwrap ApiResponse
+ */
+type Unwrapped<T> = T extends ApiResponse<infer U> ? U : T;
+
 declare function formatAPIErrorMessage(err: unknown): string;
 
 /**
@@ -553,6 +574,11 @@ interface ResponseMetadata {
     /** Custom headers */
     [key: string]: any;
 }
+/**
+ * Helper to unwrap ApiResponse type for assignments
+ * Use this when you need to assign to a plain type
+ */
+type Unwrap<T> = T extends ApiResponse<infer U> ? U : T;
 /**
  * Enhanced API response that adds metadata to the response data
  * - For arrays: acts as array with metadata properties
@@ -772,5 +798,5 @@ declare class Bagel {
     uploadFile<T>(file: File, options?: UploadOptions): Promise<T>;
 }
 
-export { ApiResponse, Bagel, StreamController, createSSEStream, createSSEStreamPost, dereference, extractSSEEventInfo, extractSSEEventTypes, formatAPIErrorMessage, formatFieldErrors, getPath, isReferenceObject, isSSEStream, isSchemaObject, _default as openAPI, parseApiError, useApiRequest, useCancellableRequest, wrapApiForDirectReturn };
-export type { ApiConfig, ApiRequestState, BaseParameterObject, CallbackObject, CallbacksObject, ComponentsObject, ContactObject, ContentObject, DiscriminatorObject, EncodingObject, EncodingPropertyObject, ExampleObject, ExamplesObject, ExternalDocumentationObject, FastAPIErrorResponse, FastAPIValidationError, HeaderObject, HeadersObject, InfoObject, LicenseObject, LinkObject, LinkParametersObject, LinksObject, MediaTypeObject, OAuthFlowObject, OAuthFlowsObject, OpenAPIObject, OperationObject, ParameterLocation, ParameterObject, ParameterStyle, ParsedError, PathItemObject, PathsObject, ReferenceObject, RequestBodyObject, RequestInterceptor, ResponseInterceptor, ResponseMetadata, ResponseObject, ResponsesObject, SSEEvent, SSEEventTypeInfo, SSEStreamOptions, SchemaObject, SchemaObjectType, SchemasObject, ScopesObject, SecurityRequirementObject, SecuritySchemeObject, SecuritySchemeType, ServerObject, ServerVariableObject, StreamEventMap, TableToTypeMapping, Tables, TagObject, TypeFormatT, UploadOptions, User, XmlObject };
+export { ApiResponse, Bagel, StreamController, createSSEStream, createSSEStreamPost, dereference, extractSSEEventInfo, extractSSEEventTypes, formatAPIErrorMessage, formatFieldErrors, getPath, isReferenceObject, isSSEStream, isSchemaObject, _default as openAPI, parseApiError, unwrap, useApiRequest, useCancellableRequest, wrapApiForDirectReturn };
+export type { ApiConfig, ApiRequestState, BaseParameterObject, CallbackObject, CallbacksObject, ComponentsObject, ContactObject, ContentObject, DiscriminatorObject, EncodingObject, EncodingPropertyObject, ExampleObject, ExamplesObject, ExternalDocumentationObject, FastAPIErrorResponse, FastAPIValidationError, HeaderObject, HeadersObject, InfoObject, LicenseObject, LinkObject, LinkParametersObject, LinksObject, MediaTypeObject, OAuthFlowObject, OAuthFlowsObject, OpenAPIObject, OperationObject, ParameterLocation, ParameterObject, ParameterStyle, ParsedError, PathItemObject, PathsObject, ReferenceObject, RequestBodyObject, RequestInterceptor, ResponseInterceptor, ResponseMetadata, ResponseObject, ResponsesObject, SSEEvent, SSEEventTypeInfo, SSEStreamOptions, SchemaObject, SchemaObjectType, SchemasObject, ScopesObject, SecurityRequirementObject, SecuritySchemeObject, SecuritySchemeType, ServerObject, ServerVariableObject, StreamEventMap, TableToTypeMapping, Tables, TagObject, TypeFormatT, Unwrap, Unwrapped, UploadOptions, User, XmlObject };

package/dist/index.d.ts

@@ -532,6 +532,27 @@ interface OpenAPIResponse {
 }
 declare const _default: (openApiUrl: string, baseUrl: string) => Promise<OpenAPIResponse>;
 
+/**
+ * Unwrap utility for ApiResponse
+ *
+ * Use this when you need to assign API responses to plain types
+ */
+
+/**
+ * Unwrap an ApiResponse to get the plain data
+ *
+ * @example
+ * import { unwrap } from '@bagelink/sdk'
+ *
+ * const agent = ref<AgentResponse | null>(null)
+ * agent.value = unwrap(await api.agents.getByAgentId({ agentId }))
+ */
+declare function unwrap<T>(response: ApiResponse<T> | T): T;
+/**
+ * Type helper to unwrap ApiResponse
+ */
+type Unwrapped<T> = T extends ApiResponse<infer U> ? U : T;
+
 declare function formatAPIErrorMessage(err: unknown): string;
 
 /**
@@ -553,6 +574,11 @@ interface ResponseMetadata {
     /** Custom headers */
     [key: string]: any;
 }
+/**
+ * Helper to unwrap ApiResponse type for assignments
+ * Use this when you need to assign to a plain type
+ */
+type Unwrap<T> = T extends ApiResponse<infer U> ? U : T;
 /**
  * Enhanced API response that adds metadata to the response data
  * - For arrays: acts as array with metadata properties
@@ -772,5 +798,5 @@ declare class Bagel {
     uploadFile<T>(file: File, options?: UploadOptions): Promise<T>;
 }
 
-export { ApiResponse, Bagel, StreamController, createSSEStream, createSSEStreamPost, dereference, extractSSEEventInfo, extractSSEEventTypes, formatAPIErrorMessage, formatFieldErrors, getPath, isReferenceObject, isSSEStream, isSchemaObject, _default as openAPI, parseApiError, useApiRequest, useCancellableRequest, wrapApiForDirectReturn };
-export type { ApiConfig, ApiRequestState, BaseParameterObject, CallbackObject, CallbacksObject, ComponentsObject, ContactObject, ContentObject, DiscriminatorObject, EncodingObject, EncodingPropertyObject, ExampleObject, ExamplesObject, ExternalDocumentationObject, FastAPIErrorResponse, FastAPIValidationError, HeaderObject, HeadersObject, InfoObject, LicenseObject, LinkObject, LinkParametersObject, LinksObject, MediaTypeObject, OAuthFlowObject, OAuthFlowsObject, OpenAPIObject, OperationObject, ParameterLocation, ParameterObject, ParameterStyle, ParsedError, PathItemObject, PathsObject, ReferenceObject, RequestBodyObject, RequestInterceptor, ResponseInterceptor, ResponseMetadata, ResponseObject, ResponsesObject, SSEEvent, SSEEventTypeInfo, SSEStreamOptions, SchemaObject, SchemaObjectType, SchemasObject, ScopesObject, SecurityRequirementObject, SecuritySchemeObject, SecuritySchemeType, ServerObject, ServerVariableObject, StreamEventMap, TableToTypeMapping, Tables, TagObject, TypeFormatT, UploadOptions, User, XmlObject };
+export { ApiResponse, Bagel, StreamController, createSSEStream, createSSEStreamPost, dereference, extractSSEEventInfo, extractSSEEventTypes, formatAPIErrorMessage, formatFieldErrors, getPath, isReferenceObject, isSSEStream, isSchemaObject, _default as openAPI, parseApiError, unwrap, useApiRequest, useCancellableRequest, wrapApiForDirectReturn };
+export type { ApiConfig, ApiRequestState, BaseParameterObject, CallbackObject, CallbacksObject, ComponentsObject, ContactObject, ContentObject, DiscriminatorObject, EncodingObject, EncodingPropertyObject, ExampleObject, ExamplesObject, ExternalDocumentationObject, FastAPIErrorResponse, FastAPIValidationError, HeaderObject, HeadersObject, InfoObject, LicenseObject, LinkObject, LinkParametersObject, LinksObject, MediaTypeObject, OAuthFlowObject, OAuthFlowsObject, OpenAPIObject, OperationObject, ParameterLocation, ParameterObject, ParameterStyle, ParsedError, PathItemObject, PathsObject, ReferenceObject, RequestBodyObject, RequestInterceptor, ResponseInterceptor, ResponseMetadata, ResponseObject, ResponsesObject, SSEEvent, SSEEventTypeInfo, SSEStreamOptions, SchemaObject, SchemaObjectType, SchemasObject, ScopesObject, SecurityRequirementObject, SecuritySchemeObject, SecuritySchemeType, ServerObject, ServerVariableObject, StreamEventMap, TableToTypeMapping, Tables, TagObject, TypeFormatT, Unwrap, Unwrapped, UploadOptions, User, XmlObject };

package/dist/index.mjs

@@ -721,7 +721,7 @@ function generateFunctionForOperation(method, path, operation) {
   );
   const allParams = isFileUpload ? "file: File, options?: UploadOptions & { dirPath?: string, tags?: string[] }" : combineAllParams(parameters, requestBodyParam);
   const responseType = generateResponseType(operation.responses);
-  const responseTypeStr = responseType ? `: Promise<AxiosResponse<${responseType}>>` : "";
+  const responseTypeStr = responseType ? `: Promise<ApiResponse<${responseType}>>` : "";
   const functionComment = buildJSDocComment(operation, method, path);
   if (isStream) {
     const eventTypes = extractSSEEventTypes(operation);
@@ -924,6 +924,7 @@ import {
 	formatFieldErrors,
 	useApiRequest,
 	useCancellableRequest,
+	unwrap,
 	${streamImports}
 	type ApiConfig,
 	type ParsedError,
@@ -932,7 +933,8 @@ import {
 	type ResponseMetadata,
 	type ApiRequestState,
 	type RequestInterceptor,
-	type ResponseInterceptor
+	type ResponseInterceptor,
+	type Unwrapped
 } from '@bagelink/sdk';
 import { ref, type Ref } from 'vue';
 
@@ -1086,6 +1088,7 @@ export {
 	formatFieldErrors,
 	useApiRequest,
 	useCancellableRequest,
+	unwrap,
 	ApiResponse,
 	type ApiConfig,
 	type ParsedError,
@@ -1094,7 +1097,8 @@ export {
 	type FastAPIValidationError,
 	type FastAPIErrorResponse,
 	type RequestInterceptor,
-	type ResponseInterceptor
+	type ResponseInterceptor,
+	type Unwrapped
 }
 `;
   return templateCode.replace(/"([^"]+)":/g, "$1:");
@@ -1383,6 +1387,20 @@ const index = async (openApiUrl, baseUrl) => {
   }
 };
 
+function unwrap(response) {
+  if (!response || typeof response !== "object") {
+    return response;
+  }
+  if (Array.isArray(response)) {
+    return response;
+  }
+  if ("$raw" in response) {
+    const { $raw, $metadata, totalCount, page, perPage, totalPages, rateLimit, rateLimitReset, getHeader, hasPagination, hasNextPage, hasPrevPage, ...data } = response;
+    return data;
+  }
+  return response;
+}
+
 function formatAPIErrorMessage(err) {
   const error = err;
   if (!error || !error.response) {
@@ -1897,4 +1915,4 @@ class Bagel {
   }
 }
 
-export { ApiResponse, Bagel, StreamController, createSSEStream, createSSEStreamPost, dereference, extractSSEEventInfo, extractSSEEventTypes, formatAPIErrorMessage, formatFieldErrors, getPath, isReferenceObject, isSSEStream, isSchemaObject, index as openAPI, parseApiError, useApiRequest, useCancellableRequest, wrapApiForDirectReturn };
+export { ApiResponse, Bagel, StreamController, createSSEStream, createSSEStreamPost, dereference, extractSSEEventInfo, extractSSEEventTypes, formatAPIErrorMessage, formatFieldErrors, getPath, isReferenceObject, isSSEStream, isSchemaObject, index as openAPI, parseApiError, unwrap, useApiRequest, useCancellableRequest, wrapApiForDirectReturn };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bagelink/sdk",
   "type": "module",
-  "version": "1.8.32",
+  "version": "1.8.35",
   "description": "Bagel core sdk packages",
   "author": {
     "name": "Bagel Studio",

package/src/index.ts

@@ -13,6 +13,7 @@ export {
 	StreamController,
 	type StreamEventMap
 } from './openAPITools/streamClient'
+export { unwrap, type Unwrapped } from './unwrap'
 
 // ============================================================================
 // Re-export ApiResponse and Utilities (for generated code)
@@ -38,6 +39,12 @@ export interface ResponseMetadata {
 	[key: string]: any
 }
 
+/**
+ * Helper to unwrap ApiResponse type for assignments
+ * Use this when you need to assign to a plain type
+ */
+export type Unwrap<T> = T extends ApiResponse<infer U> ? U : T
+
 /**
  * Enhanced API response that adds metadata to the response data
  * - For arrays: acts as array with metadata properties

package/src/openAPITools/functionGenerator.ts

@@ -629,8 +629,11 @@ function generateFunctionForOperation(
 		: combineAllParams(parameters, requestBodyParam)
 
 	const responseType = generateResponseType(operation.responses)
+
+	// Always use ApiResponse wrapper for type consistency
+	// The create() method will handle single objects vs arrays at runtime
 	const responseTypeStr = responseType
-		? `: Promise<AxiosResponse<${responseType}>>`
+		? `: Promise<ApiResponse<${responseType}>>`
 		: ''
 
 	// Create JSDoc comment with OpenAPI documentation
@@ -940,6 +943,7 @@ import {
 	formatFieldErrors,
 	useApiRequest,
 	useCancellableRequest,
+	unwrap,
 	${streamImports}
 	type ApiConfig,
 	type ParsedError,
@@ -948,7 +952,8 @@ import {
 	type ResponseMetadata,
 	type ApiRequestState,
 	type RequestInterceptor,
-	type ResponseInterceptor
+	type ResponseInterceptor,
+	type Unwrapped
 } from '@bagelink/sdk';
 import { ref, type Ref } from 'vue';
 
@@ -1102,6 +1107,7 @@ export {
 	formatFieldErrors,
 	useApiRequest,
 	useCancellableRequest,
+	unwrap,
 	ApiResponse,
 	type ApiConfig,
 	type ParsedError,
@@ -1110,7 +1116,8 @@ export {
 	type FastAPIValidationError,
 	type FastAPIErrorResponse,
 	type RequestInterceptor,
-	type ResponseInterceptor
+	type ResponseInterceptor,
+	type Unwrapped
 }
 `
 

package/src/unwrap.ts

@@ -0,0 +1,41 @@
+/**
+ * Unwrap utility for ApiResponse
+ *
+ * Use this when you need to assign API responses to plain types
+ */
+
+import type { ApiResponse } from './index'
+
+/**
+ * Unwrap an ApiResponse to get the plain data
+ *
+ * @example
+ * import { unwrap } from '@bagelink/sdk'
+ *
+ * const agent = ref<AgentResponse | null>(null)
+ * agent.value = unwrap(await api.agents.getByAgentId({ agentId }))
+ */
+export function unwrap<T>(response: ApiResponse<T> | T): T {
+	// If it's already unwrapped, return as-is
+	if (!response || typeof response !== 'object') {
+		return response as T
+	}
+
+	// If it's an array (ApiResponse extends Array), return as-is
+	if (Array.isArray(response)) {
+		return response as unknown as T
+	}
+
+	// If it has $raw, it's an enhanced object - return without metadata
+	if ('$raw' in response) {
+		const { $raw, $metadata, totalCount, page, perPage, totalPages, rateLimit, rateLimitReset, getHeader, hasPagination, hasNextPage, hasPrevPage, ...data } = response as any
+		return data as T
+	}
+
+	return response as T
+}
+
+/**
+ * Type helper to unwrap ApiResponse
+ */
+export type Unwrapped<T> = T extends ApiResponse<infer U> ? U : T