@nexgencloud/hyperstack-sdk-typescript 1.54.7-alpha → 1.55.4-alpha

package/dist/api.js

@@ -16466,6 +16466,42 @@ const VirtualMachineApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Enable or disable the Hyperstack VM Agent (Enhanced Metrics) for an existing virtual machine. The agent itself must be installed/removed manually inside the VM — the response includes the install command when enabling.
+         * @summary Enable or disable Enhanced Metrics for a virtual machine
+         * @param {number} vmId
+         * @param {UserEnhancedMetricsPayload} payload
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        toggleEnhancedMetricsForAVM: (vmId_1, payload_1, ...args_1) => __awaiter(this, [vmId_1, payload_1, ...args_1], void 0, function* (vmId, payload, options = {}) {
+            // verify required parameter 'vmId' is not null or undefined
+            (0, common_1.assertParamExists)('toggleEnhancedMetricsForAVM', 'vmId', vmId);
+            // verify required parameter 'payload' is not null or undefined
+            (0, common_1.assertParamExists)('toggleEnhancedMetricsForAVM', 'payload', payload);
+            const localVarPath = `/core/virtual-machines/{vm_id}/enhanced-metrics`
+                .replace(`{${"vm_id"}}`, encodeURIComponent(String(vmId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication apiKey required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "api_key", configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(payload, localVarRequestOptions, configuration);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
     };
 };
 exports.VirtualMachineApiAxiosParamCreator = VirtualMachineApiAxiosParamCreator;
@@ -16815,6 +16851,23 @@ const VirtualMachineApiFp = function (configuration) {
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Enable or disable the Hyperstack VM Agent (Enhanced Metrics) for an existing virtual machine. The agent itself must be installed/removed manually inside the VM — the response includes the install command when enabling.
+         * @summary Enable or disable Enhanced Metrics for a virtual machine
+         * @param {number} vmId
+         * @param {UserEnhancedMetricsPayload} payload
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        toggleEnhancedMetricsForAVM(vmId, payload, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.toggleEnhancedMetricsForAVM(vmId, payload, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['VirtualMachineApi.toggleEnhancedMetricsForAVM']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
     };
 };
 exports.VirtualMachineApiFp = VirtualMachineApiFp;
@@ -17044,6 +17097,17 @@ const VirtualMachineApiFactory = function (configuration, basePath, axios) {
         stopVM(vmId, options) {
             return localVarFp.stopVM(vmId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Enable or disable the Hyperstack VM Agent (Enhanced Metrics) for an existing virtual machine. The agent itself must be installed/removed manually inside the VM — the response includes the install command when enabling.
+         * @summary Enable or disable Enhanced Metrics for a virtual machine
+         * @param {number} vmId
+         * @param {UserEnhancedMetricsPayload} payload
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        toggleEnhancedMetricsForAVM(vmId, payload, options) {
+            return localVarFp.toggleEnhancedMetricsForAVM(vmId, payload, options).then((request) => request(axios, basePath));
+        },
     };
 };
 exports.VirtualMachineApiFactory = VirtualMachineApiFactory;
@@ -17293,6 +17357,18 @@ class VirtualMachineApi extends base_1.BaseAPI {
     stopVM(vmId, options) {
         return (0, exports.VirtualMachineApiFp)(this.configuration).stopVM(vmId, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Enable or disable the Hyperstack VM Agent (Enhanced Metrics) for an existing virtual machine. The agent itself must be installed/removed manually inside the VM — the response includes the install command when enabling.
+     * @summary Enable or disable Enhanced Metrics for a virtual machine
+     * @param {number} vmId
+     * @param {UserEnhancedMetricsPayload} payload
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VirtualMachineApi
+     */
+    toggleEnhancedMetricsForAVM(vmId, payload, options) {
+        return (0, exports.VirtualMachineApiFp)(this.configuration).toggleEnhancedMetricsForAVM(vmId, payload, options).then((request) => request(this.axios, this.basePath));
+    }
 }
 exports.VirtualMachineApi = VirtualMachineApi;
 /**

package/dist/common.js

@@ -24,6 +24,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
 const base_1 = require("./base");
+const hyperstackHeaders_1 = require("./hyperstackHeaders");
 /**
  *
  * @export
@@ -155,6 +156,7 @@ const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, confi
     return (axios = globalAxios, basePath = BASE_PATH) => {
         var _a;
         const axiosRequestArgs = Object.assign(Object.assign({}, axiosArgs.options), { url: (axios.defaults.baseURL ? '' : (_a = configuration === null || configuration === void 0 ? void 0 : configuration.basePath) !== null && _a !== void 0 ? _a : basePath) + axiosArgs.url });
+        (0, hyperstackHeaders_1.applyHyperstackHeaders)(axiosRequestArgs);
         return axios.request(axiosRequestArgs);
     };
 };

package/dist/esm/api.d.ts

@@ -1767,6 +1767,43 @@ export interface CompatibleFlavor {
      */
     'reason'?: string;
 }
+/**
+ *
+ * @export
+ * @interface CompatibleImage
+ */
+export interface CompatibleImage {
+    /**
+     * JSON constraints object
+     * @type {object}
+     * @memberof CompatibleImage
+     */
+    'constraints'?: object;
+    /**
+     *
+     * @type {number}
+     * @memberof CompatibleImage
+     */
+    'image_id'?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof CompatibleImage
+     */
+    'image_name'?: string;
+    /**
+     * Either \'hard\' or \'soft\'
+     * @type {string}
+     * @memberof CompatibleImage
+     */
+    'link_type'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompatibleImage
+     */
+    'reason'?: string;
+}
 /**
  *
  * @export
@@ -2665,6 +2702,12 @@ export interface CreateInstancesPayload {
      * @memberof CreateInstancesPayload
      */
     'enable_port_randomization'?: boolean;
+    /**
+     * When true, the Hyperstack VM Agent is opted in for this VM and metrics ingestion is allowed by the prom-gateway. The agent must still be installed on the VM (typically via user_data cloud-init).
+     * @type {boolean}
+     * @memberof CreateInstancesPayload
+     */
+    'enhanced_monitoring_enabled'?: boolean;
     /**
      * The name of the [environment](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/) in which the virtual machine is to be created.
      * @type {string}
@@ -4056,6 +4099,12 @@ export interface FlavorFields {
      * @memberof FlavorFields
      */
     'id'?: number;
+    /**
+     * Image compatibility restrictions for this flavor (flavor → image links)
+     * @type {ImageRestrictions}
+     * @memberof FlavorFields
+     */
+    'image_restrictions'?: ImageRestrictions;
     /**
      *
      * @type {Array<LableResonse>}
@@ -4804,6 +4853,31 @@ export interface ImageGetResponse {
      */
     'type'?: string;
 }
+/**
+ *
+ * @export
+ * @interface ImageRestrictions
+ */
+export interface ImageRestrictions {
+    /**
+     * List of images this flavor is allowed to launch, with link metadata
+     * @type {Array<CompatibleImage>}
+     * @memberof ImageRestrictions
+     */
+    'compatible_images'?: Array<CompatibleImage>;
+    /**
+     * Whether the flavor is restricted to a set of images
+     * @type {boolean}
+     * @memberof ImageRestrictions
+     */
+    'has_image_restrictions'?: boolean;
+    /**
+     * Either \'hard\', \'soft\', or null if no restrictions
+     * @type {string}
+     * @memberof ImageRestrictions
+     */
+    'restriction_type'?: string;
+}
 /**
  *
  * @export
@@ -4959,6 +5033,19 @@ export interface Instance {
      */
     'status'?: boolean;
 }
+/**
+ *
+ * @export
+ * @interface InstanceEnhancedMetricsFields
+ */
+export interface InstanceEnhancedMetricsFields {
+    /**
+     *
+     * @type {boolean}
+     * @memberof InstanceEnhancedMetricsFields
+     */
+    'enabled'?: boolean;
+}
 /**
  *
  * @export
@@ -5100,6 +5187,12 @@ export interface InstanceFields {
      * @memberof InstanceFields
      */
     'created_at'?: string;
+    /**
+     *
+     * @type {InstanceEnhancedMetricsFields}
+     * @memberof InstanceFields
+     */
+    'enhanced_metrics'?: InstanceEnhancedMetricsFields;
     /**
      *
      * @type {InstanceEnvironmentFields}
@@ -10140,6 +10233,63 @@ export interface UserDefaultChoicesForUserResponse {
      */
     'user_default_choices'?: Array<UserDefaultChoiceForUserFields>;
 }
+/**
+ *
+ * @export
+ * @interface UserEnhancedMetricsPayload
+ */
+export interface UserEnhancedMetricsPayload {
+    /**
+     * Set to true to opt this VM into Enhanced Metrics, false to opt out.
+     * @type {boolean}
+     * @memberof UserEnhancedMetricsPayload
+     */
+    'enabled': boolean;
+}
+/**
+ *
+ * @export
+ * @interface UserEnhancedMetricsResponse
+ */
+export interface UserEnhancedMetricsResponse {
+    /**
+     * One-liner the user can run inside the VM to install the agent when enabling. Omitted when disabling.
+     * @type {string}
+     * @memberof UserEnhancedMetricsResponse
+     */
+    'install_command'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UserEnhancedMetricsResponse
+     */
+    'message'?: string;
+    /**
+     *
+     * @type {UserEnhancedMetricsResponseFields}
+     * @memberof UserEnhancedMetricsResponse
+     */
+    'metrics'?: UserEnhancedMetricsResponseFields;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserEnhancedMetricsResponse
+     */
+    'status'?: boolean;
+}
+/**
+ *
+ * @export
+ * @interface UserEnhancedMetricsResponseFields
+ */
+export interface UserEnhancedMetricsResponseFields {
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserEnhancedMetricsResponseFields
+     */
+    'enabled'?: boolean;
+}
 /**
  *
  * @export
@@ -19085,6 +19235,15 @@ export declare const VirtualMachineApiAxiosParamCreator: (configuration?: Config
      * @throws {RequiredError}
      */
     stopVM: (vmId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Enable or disable the Hyperstack VM Agent (Enhanced Metrics) for an existing virtual machine. The agent itself must be installed/removed manually inside the VM — the response includes the install command when enabling.
+     * @summary Enable or disable Enhanced Metrics for a virtual machine
+     * @param {number} vmId
+     * @param {UserEnhancedMetricsPayload} payload
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    toggleEnhancedMetricsForAVM: (vmId: number, payload: UserEnhancedMetricsPayload, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * VirtualMachineApi - functional programming interface
@@ -19270,6 +19429,15 @@ export declare const VirtualMachineApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     stopVM(vmId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResponseModel>>;
+    /**
+     * Enable or disable the Hyperstack VM Agent (Enhanced Metrics) for an existing virtual machine. The agent itself must be installed/removed manually inside the VM — the response includes the install command when enabling.
+     * @summary Enable or disable Enhanced Metrics for a virtual machine
+     * @param {number} vmId
+     * @param {UserEnhancedMetricsPayload} payload
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    toggleEnhancedMetricsForAVM(vmId: number, payload: UserEnhancedMetricsPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserEnhancedMetricsResponse>>;
 };
 /**
  * VirtualMachineApi - factory interface
@@ -19455,6 +19623,15 @@ export declare const VirtualMachineApiFactory: (configuration?: Configuration, b
      * @throws {RequiredError}
      */
     stopVM(vmId: number, options?: RawAxiosRequestConfig): AxiosPromise<ResponseModel>;
+    /**
+     * Enable or disable the Hyperstack VM Agent (Enhanced Metrics) for an existing virtual machine. The agent itself must be installed/removed manually inside the VM — the response includes the install command when enabling.
+     * @summary Enable or disable Enhanced Metrics for a virtual machine
+     * @param {number} vmId
+     * @param {UserEnhancedMetricsPayload} payload
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    toggleEnhancedMetricsForAVM(vmId: number, payload: UserEnhancedMetricsPayload, options?: RawAxiosRequestConfig): AxiosPromise<UserEnhancedMetricsResponse>;
 };
 /**
  * VirtualMachineApi - object-oriented interface
@@ -19662,6 +19839,16 @@ export declare class VirtualMachineApi extends BaseAPI {
      * @memberof VirtualMachineApi
      */
     stopVM(vmId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ResponseModel, any, {}, any>>;
+    /**
+     * Enable or disable the Hyperstack VM Agent (Enhanced Metrics) for an existing virtual machine. The agent itself must be installed/removed manually inside the VM — the response includes the install command when enabling.
+     * @summary Enable or disable Enhanced Metrics for a virtual machine
+     * @param {number} vmId
+     * @param {UserEnhancedMetricsPayload} payload
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VirtualMachineApi
+     */
+    toggleEnhancedMetricsForAVM(vmId: number, payload: UserEnhancedMetricsPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserEnhancedMetricsResponse, any, {}, any>>;
 }
 /**
  * @export

package/dist/esm/api.js

@@ -16259,6 +16259,42 @@ export const VirtualMachineApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Enable or disable the Hyperstack VM Agent (Enhanced Metrics) for an existing virtual machine. The agent itself must be installed/removed manually inside the VM — the response includes the install command when enabling.
+         * @summary Enable or disable Enhanced Metrics for a virtual machine
+         * @param {number} vmId
+         * @param {UserEnhancedMetricsPayload} payload
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        toggleEnhancedMetricsForAVM: (vmId_1, payload_1, ...args_1) => __awaiter(this, [vmId_1, payload_1, ...args_1], void 0, function* (vmId, payload, options = {}) {
+            // verify required parameter 'vmId' is not null or undefined
+            assertParamExists('toggleEnhancedMetricsForAVM', 'vmId', vmId);
+            // verify required parameter 'payload' is not null or undefined
+            assertParamExists('toggleEnhancedMetricsForAVM', 'payload', payload);
+            const localVarPath = `/core/virtual-machines/{vm_id}/enhanced-metrics`
+                .replace(`{${"vm_id"}}`, encodeURIComponent(String(vmId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication apiKey required
+            yield setApiKeyToObject(localVarHeaderParameter, "api_key", configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(payload, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
     };
 };
 /**
@@ -16607,6 +16643,23 @@ export const VirtualMachineApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Enable or disable the Hyperstack VM Agent (Enhanced Metrics) for an existing virtual machine. The agent itself must be installed/removed manually inside the VM — the response includes the install command when enabling.
+         * @summary Enable or disable Enhanced Metrics for a virtual machine
+         * @param {number} vmId
+         * @param {UserEnhancedMetricsPayload} payload
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        toggleEnhancedMetricsForAVM(vmId, payload, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.toggleEnhancedMetricsForAVM(vmId, payload, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['VirtualMachineApi.toggleEnhancedMetricsForAVM']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
     };
 };
 /**
@@ -16835,6 +16888,17 @@ export const VirtualMachineApiFactory = function (configuration, basePath, axios
         stopVM(vmId, options) {
             return localVarFp.stopVM(vmId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Enable or disable the Hyperstack VM Agent (Enhanced Metrics) for an existing virtual machine. The agent itself must be installed/removed manually inside the VM — the response includes the install command when enabling.
+         * @summary Enable or disable Enhanced Metrics for a virtual machine
+         * @param {number} vmId
+         * @param {UserEnhancedMetricsPayload} payload
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        toggleEnhancedMetricsForAVM(vmId, payload, options) {
+            return localVarFp.toggleEnhancedMetricsForAVM(vmId, payload, options).then((request) => request(axios, basePath));
+        },
     };
 };
 /**
@@ -17083,6 +17147,18 @@ export class VirtualMachineApi extends BaseAPI {
     stopVM(vmId, options) {
         return VirtualMachineApiFp(this.configuration).stopVM(vmId, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Enable or disable the Hyperstack VM Agent (Enhanced Metrics) for an existing virtual machine. The agent itself must be installed/removed manually inside the VM — the response includes the install command when enabling.
+     * @summary Enable or disable Enhanced Metrics for a virtual machine
+     * @param {number} vmId
+     * @param {UserEnhancedMetricsPayload} payload
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VirtualMachineApi
+     */
+    toggleEnhancedMetricsForAVM(vmId, payload, options) {
+        return VirtualMachineApiFp(this.configuration).toggleEnhancedMetricsForAVM(vmId, payload, options).then((request) => request(this.axios, this.basePath));
+    }
 }
 /**
  * @export

package/dist/esm/common.js

@@ -21,6 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { RequiredError } from "./base";
+import { applyHyperstackHeaders } from "./hyperstackHeaders";
 /**
  *
  * @export
@@ -144,6 +145,7 @@ export const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH
     return (axios = globalAxios, basePath = BASE_PATH) => {
         var _a;
         const axiosRequestArgs = Object.assign(Object.assign({}, axiosArgs.options), { url: (axios.defaults.baseURL ? '' : (_a = configuration === null || configuration === void 0 ? void 0 : configuration.basePath) !== null && _a !== void 0 ? _a : basePath) + axiosArgs.url });
+        applyHyperstackHeaders(axiosRequestArgs);
         return axios.request(axiosRequestArgs);
     };
 };

package/dist/esm/hyperstackHeaders.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Forced Hyperstack client identification headers.
+ *
+ * Maintained in sdk-generator (util/typescript/hyperstackHeaders.ts) and copied into
+ * the generated SDK by the `add-hyperstack-headers` task. Do not edit in the SDK repo.
+ */
+export declare const HYPERSTACK_CLIENT_HEADER: string;
+export declare const USER_AGENT_HEADER: string;
+export declare const HYPERSTACK_CLIENT: string;
+/**
+ * User-Agent is a forbidden header name in browsers: XHR and fetch silently drop any
+ * attempt to set it. It is therefore only emitted under Node, and browser traffic is
+ * identified by Hyperstack-Client alone.
+ */
+export declare const HYPERSTACK_USER_AGENT: string | undefined;
+/**
+ * Forces the identification headers onto axios request args.
+ *
+ * Any caller-supplied variant is stripped case-insensitively first. Mutates and
+ * returns the same object so it can wrap the generated axiosRequestArgs expression.
+ */
+export declare const applyHyperstackHeaders: <T extends {
+    headers?: any;
+}>(args: T) => T;

package/dist/esm/hyperstackHeaders.js

@@ -0,0 +1,68 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Forced Hyperstack client identification headers.
+ *
+ * Maintained in sdk-generator (util/typescript/hyperstackHeaders.ts) and copied into
+ * the generated SDK by the `add-hyperstack-headers` task. Do not edit in the SDK repo.
+ */
+const SDK_NAME = 'hyperstack-typescript-sdk';
+const SDK_VERSION = 'v1.55.4-alpha';
+export const HYPERSTACK_CLIENT_HEADER = 'Hyperstack-Client';
+export const USER_AGENT_HEADER = 'User-Agent';
+const FORCED = [HYPERSTACK_CLIENT_HEADER.toLowerCase(), USER_AGENT_HEADER.toLowerCase()];
+/** Printable ASCII only, capped at 256 chars. */
+const sanitize = (value) => String(value).replace(/[^\x20-\x7e]/g, '').slice(0, 256);
+const normalizeOs = (value) => {
+    const v = String(value || '').toLowerCase();
+    if (v.indexOf('darwin') === 0 || v.indexOf('mac') === 0)
+        return 'darwin';
+    if (v.indexOf('win') === 0)
+        return 'windows';
+    if (v.indexOf('linux') === 0)
+        return 'linux';
+    return v.replace(/ /g, '-') || 'unknown';
+};
+const normalizeArch = (value) => {
+    const v = String(value || '').toLowerCase();
+    if (v === 'x64' || v === 'x86_64' || v === 'amd64')
+        return 'x86_64';
+    if (v === 'arm64' || v === 'aarch64')
+        return 'arm64';
+    if (v === 'ia32' || v === 'x86' || v === 'i386')
+        return '386';
+    return v || 'unknown';
+};
+const proc = typeof process !== 'undefined' ? process : undefined;
+const isNode = !!(proc && proc.versions && proc.versions.node);
+export const HYPERSTACK_CLIENT = sanitize(SDK_NAME + '/' + SDK_VERSION);
+/**
+ * User-Agent is a forbidden header name in browsers: XHR and fetch silently drop any
+ * attempt to set it. It is therefore only emitted under Node, and browser traffic is
+ * identified by Hyperstack-Client alone.
+ */
+export const HYPERSTACK_USER_AGENT = isNode
+    ? sanitize(HYPERSTACK_CLIENT + ' (Node.js/' + proc.versions.node + '; '
+        + normalizeOs(proc.platform) + '/' + normalizeArch(proc.arch) + ')')
+    : undefined;
+/**
+ * Forces the identification headers onto axios request args.
+ *
+ * Any caller-supplied variant is stripped case-insensitively first. Mutates and
+ * returns the same object so it can wrap the generated axiosRequestArgs expression.
+ */
+export const applyHyperstackHeaders = function (args) {
+    const headers = {};
+    const existing = (args && args.headers) || {};
+    Object.keys(existing).forEach((key) => {
+        if (FORCED.indexOf(key.toLowerCase()) === -1) {
+            headers[key] = existing[key];
+        }
+    });
+    headers[HYPERSTACK_CLIENT_HEADER] = HYPERSTACK_CLIENT;
+    if (HYPERSTACK_USER_AGENT) {
+        headers[USER_AGENT_HEADER] = HYPERSTACK_USER_AGENT;
+    }
+    args.headers = headers;
+    return args;
+};

package/dist/hyperstackHeaders.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Forced Hyperstack client identification headers.
+ *
+ * Maintained in sdk-generator (util/typescript/hyperstackHeaders.ts) and copied into
+ * the generated SDK by the `add-hyperstack-headers` task. Do not edit in the SDK repo.
+ */
+export declare const HYPERSTACK_CLIENT_HEADER: string;
+export declare const USER_AGENT_HEADER: string;
+export declare const HYPERSTACK_CLIENT: string;
+/**
+ * User-Agent is a forbidden header name in browsers: XHR and fetch silently drop any
+ * attempt to set it. It is therefore only emitted under Node, and browser traffic is
+ * identified by Hyperstack-Client alone.
+ */
+export declare const HYPERSTACK_USER_AGENT: string | undefined;
+/**
+ * Forces the identification headers onto axios request args.
+ *
+ * Any caller-supplied variant is stripped case-insensitively first. Mutates and
+ * returns the same object so it can wrap the generated axiosRequestArgs expression.
+ */
+export declare const applyHyperstackHeaders: <T extends {
+    headers?: any;
+}>(args: T) => T;