moved caller type

Author: toptobes

src/api/http-client.ts

@@ -14,7 +14,6 @@
 
 import { CLIENT_USER_AGENT, DEFAULT_TIMEOUT } from '@/src/api/constants';
 import {
-  Caller,
   GuaranteedAPIResponse,
   HTTPClientOptions,
   HTTPRequestInfo,
@@ -23,6 +22,7 @@ import {
 import { HTTP1AuthHeaderFactories, HTTP1Strategy } from '@/src/api/http1';
 import { HTTP2Strategy } from '@/src/api/http2';
 import { Mutable } from '@/src/data-api/types/utils';
+import { Caller } from '@/src/client';
 
 export class HttpClient {
   public readonly baseUrl: string;

src/api/types.ts

@@ -13,8 +13,7 @@
 // limitations under the License.
 
 import type { HTTP_METHODS } from '@/src/api/index';
-
-export type Caller = [name: string, version?: string];
+import { Caller } from '@/src/client';
 
 /**
  * @internal

src/client/types.ts

@@ -1,4 +1,34 @@
-import { Caller } from '@/src/api';
+// Copyright DataStax, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/**
+ * The caller information to send with requests, of the form `[name, version?]`, or an array of such.
+ *
+ * **Intended generally for integrations or frameworks that wrap the client.**
+ *
+ * Used to identify the client making requests to the server.
+ *
+ * It will be sent in the headers of the request as such:
+ * ```
+ * User-Agent: ...<name>/<version> astra-db-ts/<version>
+ * ```
+ *
+ * If no caller information is provided, the client will simply be identified as `astra-db-ts/<version>`.
+ *
+ * **NB. If providing an array of callers, they should be ordered from most important to least important.**
+ */
+export type Caller = [name: string, version?: string];
 
 /**
  * The default options for the {@link DataApiClient}. The Data API & DevOps specific options may be overridden
@@ -16,6 +46,8 @@ export interface RootClientOptions {
   /**
    * The caller information to send with requests, of the form `[name, version?]`, or an array of such.
    *
+   * **Intended generally for integrations or frameworks that wrap the client.**
+   *
    * The caller information is used to identify the client making requests to the server.
    *
    * It will be sent in the headers of the request as such:
@@ -26,7 +58,6 @@ export interface RootClientOptions {
    * If no caller information is provided, the client will simply be identified as `astra-db-ts/<version>`.
    *
    * **NB. If providing an array of callers, they should be ordered from most important to least important.**
-   *
    * @example
    * ```typescript
    * // 'my-app/1.0.0 astra-db-ts/1.0.0'