@vates/types 1.25.0 → 1.26.0

package/dist/common.d.mts

@@ -1,4 +1,4 @@
-import type { XoHost } from './xo.mjs';
+import type { XoHost, XoNetwork, XoVif } from './xo.mjs';
 declare const __brand: unique symbol;
 export type Branded<TBrand extends string, TType = string> = TType & {
     [__brand]: TBrand;
@@ -603,4 +603,28 @@ export type XapiVmStats = XapiStatsResponse<XapiVmStatsRaw>;
 export type XapiPoolStats = Record<XoHost['id'], XapiHostStats | {
     error: Record<string, unknown>;
 }>;
+export type TrafficRuleProtocol = (typeof TRAFFIC_RULE_PROTOCOLS)[number];
+export declare const SDN_CONTROLLER_OF_RULES_KEY = "xo:sdn-controller:of-rules";
+export declare const TRAFFIC_RULE_PROTOCOLS: readonly ["ARP", "ICMP", "IP", "TCP", "UDP"];
+export declare const TRAFFIC_RULE_PROTOCOLS_WITH_PORT: readonly TrafficRuleProtocol[];
+export type TrafficRuleTargetType = XoNetwork['type'] | XoVif['type'];
+export type TrafficRuleDirection = 'from' | 'to' | 'from/to';
+export type RawTrafficRule = {
+    allow: boolean;
+    protocol: string;
+    ipRange: string;
+    direction: string;
+    port?: string;
+};
+type BaseTrafficRule = RawTrafficRule & {
+    id: string;
+    networkId: XoNetwork['id'];
+};
+export type TrafficRule = (BaseTrafficRule & {
+    type: XoVif['type'];
+    sourceId: XoVif['id'];
+}) | (BaseTrafficRule & {
+    type: XoNetwork['type'];
+    sourceId: XoNetwork['id'];
+});
 export {};

package/dist/common.mjs

@@ -451,3 +451,6 @@ export const SUPPORTED_VDI_FORMAT = {
     vhd: 'vhd',
     qcow2: 'qcow2',
 };
+export const SDN_CONTROLLER_OF_RULES_KEY = 'xo:sdn-controller:of-rules';
+export const TRAFFIC_RULE_PROTOCOLS = ['ARP', 'ICMP', 'IP', 'TCP', 'UDP'];
+export const TRAFFIC_RULE_PROTOCOLS_WITH_PORT = ['TCP', 'UDP'];

package/dist/lib/xen-orchestra-xapi.d.mts

@@ -1,7 +1,56 @@
 import { WrappedXenApiRecord, XenApiHost, XenApiHostWrapped, XenApiNetwork, XenApiNetworkWrapped, XenApiRecord, XenApiSr, XenApiTask, XenApiVbd, XenApiVdi, XenApiVif, XenApiVm, XenApiVmWrapped, XenApiVtpm } from '../xen-api.mjs';
-import type { BOND_MODE, OPAQUE_REF_NULL, SUPPORTED_VDI_FORMAT, VBD_MODE, VBD_TYPE, VDI_TYPE, VIF_LOCKING_MODE } from '../common.mjs';
+import type { BOND_MODE, OPAQUE_REF_NULL, SUPPORTED_VDI_FORMAT, VBD_MODE, VBD_TYPE, VDI_TYPE, VIF_LOCKING_MODE, VM_OPERATIONS } from '../common.mjs';
 import type { PassThrough, Readable } from 'node:stream';
 import type { XapiXoRecord, XoGpuGroup, XoHost, XoNetwork, XoPif, XoSr, XoUser, XoVdi, XoVgpuType, XoVm, XoVmTemplate, XoVif, XoVmSnapshot } from '../xo.mjs';
+/**
+ * Properties accepted by {@link Xapi.editVm}.
+ *
+ * Field names match the canonical (camelCase) properties defined by the
+ * underlying `_editVm` (via `makeEditObject`). `_editVm` still resolves the
+ * snake_case and legacy aliases, but the canonical names are used here.
+ */
+export interface EditVmProps {
+    affinityHost?: string | null;
+    autoPoweron?: boolean;
+    blockedOperations?: Partial<Record<VM_OPERATIONS, boolean | string | null>>;
+    coresPerSocket?: number | string | null;
+    cpuCap?: number | null;
+    cpuMask?: number[];
+    cpuWeight?: number | null;
+    cpus?: number;
+    cpusStaticMax?: number | string;
+    /**
+     * Update VM creation metadata stored under `other_config.xo:*`. The object is
+     * merged with the existing data.
+     */
+    creation?: {
+        user?: string;
+    };
+    expNestedHvm?: boolean;
+    hasVendorDevice?: boolean;
+    highAvailability?: 'best-effort' | 'restart' | '';
+    hvmBootFirmware?: string | null;
+    memory?: number | string;
+    memoryMax?: number | string;
+    memoryMin?: number | string;
+    memoryStaticMax?: number | string;
+    nameDescription?: string;
+    nameLabel?: string;
+    nestedVirt?: boolean;
+    nicType?: string | null;
+    notes?: string | null;
+    PV_args?: string;
+    secureBoot?: boolean;
+    startDelay?: number;
+    suspendSr?: string | null;
+    tags?: string[];
+    uefiMode?: 'setup' | 'user';
+    vga?: 'std' | 'cirrus';
+    videoram?: 1 | 2 | 4 | 8 | 16;
+    viridian?: boolean;
+    virtualizationMode?: 'pv' | 'hvm';
+    xenStoreData?: Record<string, string | null>;
+}
 export type XcpPatches = {
     changelog?: {
         author: string;
@@ -105,6 +154,7 @@ export interface Xapi {
         xenstore_data?: Record<string, string>;
     }): Promise<XenApiVdi['$ref']>;
     SR_reclaimSpace(ref: XenApiSr['$ref']): Promise<void>;
+    editVm(id: XoVm['id'], props: EditVmProps, checkLimits?: (limits: Record<string, number>, vm: XenApiVmWrapped) => Promise<void>): Promise<void>;
     startVm(id: XoVm['id'], opts?: {
         bypassMacAddressesCheck?: boolean;
         force?: boolean;

package/dist/xo-app.d.mts

@@ -76,7 +76,7 @@ export type XoApp = {
     };
     config: {
         get<T = string>(path: string): T;
-        getOptional(path: string): Record<string, string> | undefined;
+        getOptional<T = unknown>(path: string): T | undefined;
         getOptionalDuration(path: string): number | undefined;
         getGuiRoutes(): Promise<{
             default: {
@@ -269,6 +269,8 @@ export type XoApp = {
         rebootVm?: boolean;
         parentTask?: VatesTask;
     }): Promise<void>;
+    setVmResourceSet(vmId: XoVm['id'], resourceSetId: string | null, force?: boolean): Promise<void>;
+    shareVmResourceSet(vmId: XoVm['id']): Promise<void>;
     removeUserFromGroup(userId: XoUser['id'], id: XoGroup['id']): Promise<void>;
     runJob(job: AnyXoJob, schedule: XoSchedule): void;
     runWithApiContext: (user: XoUser | undefined, fn: () => void) => Promise<unknown>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vates/types",
   "private": false,
-  "version": "1.25.0",
+  "version": "1.26.0",
   "main": "./dist/index.mjs",
   "exports": {
     ".": {