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

package/README.md

@@ -1,4 +1,4 @@
-## @nexgencloud/hyperstack-sdk-typescript@v1.55.1-alpha
+## @nexgencloud/hyperstack-sdk-typescript@v1.55.4-alpha
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @nexgencloud/hyperstack-sdk-typescript@v1.55.1-alpha --save
+npm install @nexgencloud/hyperstack-sdk-typescript@v1.55.4-alpha --save
 ```
 
 _unPublished (not recommended):_

package/api.ts

@@ -1783,6 +1783,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
@@ -4097,6 +4134,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>}
@@ -4845,6 +4888,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

package/common.ts

@@ -16,7 +16,7 @@
 import type { Configuration } from "./configuration";
 import type { RequestArgs } from "./base";
 import type { AxiosInstance, AxiosResponse } from 'axios';
-import { RequiredError } from "./base";
+import { RequiredError } from "./base"; import { applyHyperstackHeaders } from "./hyperstackHeaders";
 
 /**
  *
@@ -144,7 +144,7 @@ export const toPathString = function (url: URL) {
  */
 export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
     return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH): Promise<R> => {
-        const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url};
+        const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url}; applyHyperstackHeaders(axiosRequestArgs);
         return axios.request<T, R>(axiosRequestArgs) as Promise<R>;
     };
 }

package/dist/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
@@ -4062,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>}
@@ -4810,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

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
@@ -4062,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>}
@@ -4810,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

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;

package/dist/hyperstackHeaders.js

@@ -0,0 +1,72 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyHyperstackHeaders = exports.HYPERSTACK_USER_AGENT = exports.HYPERSTACK_CLIENT = exports.USER_AGENT_HEADER = exports.HYPERSTACK_CLIENT_HEADER = void 0;
+const SDK_NAME = 'hyperstack-typescript-sdk';
+const SDK_VERSION = 'v1.55.4-alpha';
+exports.HYPERSTACK_CLIENT_HEADER = 'Hyperstack-Client';
+exports.USER_AGENT_HEADER = 'User-Agent';
+const FORCED = [exports.HYPERSTACK_CLIENT_HEADER.toLowerCase(), exports.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);
+exports.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.
+ */
+exports.HYPERSTACK_USER_AGENT = isNode
+    ? sanitize(exports.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.
+ */
+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[exports.HYPERSTACK_CLIENT_HEADER] = exports.HYPERSTACK_CLIENT;
+    if (exports.HYPERSTACK_USER_AGENT) {
+        headers[exports.USER_AGENT_HEADER] = exports.HYPERSTACK_USER_AGENT;
+    }
+    args.headers = headers;
+    return args;
+};
+exports.applyHyperstackHeaders = applyHyperstackHeaders;

package/hyperstackHeaders.ts

@@ -0,0 +1,78 @@
+/* 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.
+ */
+
+// Module-scoped declaration: this file has exports, so it shadows the global without
+// a TS2451 redeclaration error whether or not @types/node resolves. The file is
+// type-checked under both the SDK's tsconfig and the repo-root one used by ts-node.
+declare const process: any;
+
+const SDK_NAME: string = 'hyperstack-typescript-sdk';
+const SDK_VERSION: string = 'v1.55.4-alpha';
+
+export const HYPERSTACK_CLIENT_HEADER: string = 'Hyperstack-Client';
+export const USER_AGENT_HEADER: string = 'User-Agent';
+
+const FORCED: string[] = [HYPERSTACK_CLIENT_HEADER.toLowerCase(), USER_AGENT_HEADER.toLowerCase()];
+
+/** Printable ASCII only, capped at 256 chars. */
+const sanitize = (value: string): string =>
+    String(value).replace(/[^\x20-\x7e]/g, '').slice(0, 256);
+
+const normalizeOs = (value: string): string => {
+    const v: string = 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: string): string => {
+    const v: string = 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: any = typeof process !== 'undefined' ? process : undefined;
+const isNode: boolean = !!(proc && proc.versions && proc.versions.node);
+
+export const HYPERSTACK_CLIENT: string = 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: string | undefined = 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 <T extends { headers?: any }>(args: T): T {
+    const headers: any = {};
+    const existing: any = (args && args.headers) || {};
+    Object.keys(existing).forEach((key: string) => {
+        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 as any).headers = headers;
+    return args;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nexgencloud/hyperstack-sdk-typescript",
-  "version": "v1.55.1-alpha",
+  "version": "v1.55.4-alpha",
   "description": "Leverage the Infrahub API and Hyperstack platform to easily create, manage, and scale powerful GPU virtual machines and their associated resources.   Access this SDK to automate the deployment of your workloads and streamline your infrastructure management.  To contribute, please raise an issue with a bug report, feature request, feedback, or general inquiry.",
   "author": "OpenAPI-Generator Contributors",
   "repository": {