@vates/types 1.23.0 → 1.25.0

package/dist/index.d.mts

@@ -3,4 +3,5 @@ export * from './xen-api.mjs';
 export * from './xo.mjs';
 export * from './xo-app.mjs';
 export * from './lib/xen-orchestra-xapi.mjs';
+export * from './lib/xen-orchestra-acl.mjs';
 export * from './lib/complex-matcher.mjs';

package/dist/index.mjs

@@ -3,4 +3,5 @@ export * from './xen-api.mjs';
 export * from './xo.mjs';
 export * from './xo-app.mjs';
 export * from './lib/xen-orchestra-xapi.mjs';
+export * from './lib/xen-orchestra-acl.mjs';
 export * from './lib/complex-matcher.mjs';

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

@@ -0,0 +1,54 @@
+import { Branded } from '../common.mjs';
+import type { XoGroup, XoUser } from '../xo.mjs';
+export type XoAclRole = {
+    id: Branded<'acl-v2-role'>;
+    name: string;
+    description?: string;
+} | {
+    id: Branded<'acl-v2-role'>;
+    name: string;
+    description?: string;
+    isTemplate: true;
+    roleTemplateId: number;
+};
+export type XoAclSupportedActionsByResource = {
+    [resource: string]: Record<string, unknown>;
+};
+/**
+ * E.g
+ * vms {
+ *   shutdown: {
+ *    clean: true,
+ *    hard: true,
+ *  }
+ * }
+ *
+ * `shutdown | shutdown:clean | shutdown:hard`
+ */
+export type GetKeysRecursively<T, Prefix extends string = ''> = {
+    [K in keyof T]: T[K] extends object ? K extends string ? `${Prefix}${K}` | GetKeysRecursively<T[K], `${Prefix}${K}:`> : never : K extends string ? `${Prefix}${K}` : never;
+}[keyof T];
+export type XoAclSupportedResource<TActionsByResource extends XoAclSupportedActionsByResource> = keyof TActionsByResource;
+export type XoAclSupportedActions<TActionsByResource extends XoAclSupportedActionsByResource, TResource extends XoAclSupportedResource<TActionsByResource>> = (GetKeysRecursively<TActionsByResource[TResource]> & string) | '*';
+export type XoAclBasePrivilege = {
+    id: Branded<'acl-v2-privilege'>;
+    resource: string;
+    action: string;
+    selector?: string;
+    effect: 'allow' | 'deny';
+    roleId: XoAclRole['id'];
+};
+export type XoAclPrivilege<TActionsByResource extends XoAclSupportedActionsByResource, TResource extends XoAclSupportedResource<TActionsByResource>> = XoAclBasePrivilege & {
+    resource: TResource;
+    action: XoAclSupportedActions<TActionsByResource, TResource>;
+};
+export type XoUserRole = {
+    id: string;
+    roleId: XoAclRole['id'];
+    userId: XoUser['id'];
+};
+export type XoGroupRole = {
+    id: string;
+    roleId: XoAclRole['id'];
+    groupId: XoGroup['id'];
+};

package/dist/lib/xen-orchestra-acl.mjs

@@ -0,0 +1 @@
+export {};

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

@@ -1,7 +1,7 @@
 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 { PassThrough, Readable } from 'node:stream';
-import type { XoGpuGroup, XoHost, XoNetwork, XoPif, XoSr, XoUser, XoVdi, XoVgpuType, XoVm, XoVmTemplate, XoVif } from '../xo.mjs';
+import type { XapiXoRecord, XoGpuGroup, XoHost, XoNetwork, XoPif, XoSr, XoUser, XoVdi, XoVgpuType, XoVm, XoVmTemplate, XoVif, XoVmSnapshot } from '../xo.mjs';
 export type XcpPatches = {
     changelog?: {
         author: string;
@@ -36,8 +36,11 @@ export interface Xapi {
     barrier<T extends XenApiRecord>(ref: T['$ref']): Promise<Extract<WrappedXenApiRecord, {
         $ref: T['$ref'];
     }>>;
-    getField<T extends XenApiRecord, K extends keyof T>(type: Extract<WrappedXenApiRecord, T>['$type'], ref: T['$ref'], field: K): Promise<T[K]>;
     connectVif(vifId: XoVif['id']): Promise<void>;
+    getField<T extends XenApiRecord, K extends keyof T>(type: Extract<WrappedXenApiRecord, T>['$type'], ref: T['$ref'], field: K): Promise<T[K]>;
+    getObject: <XoRecord extends XapiXoRecord, WrappedRecord extends WrappedXenApiRecord = Extract<WrappedXenApiRecord, {
+        $type: XoRecord['type'];
+    }>>(idOrUuidOrRef: XoRecord['id'] | WrappedRecord['$ref'] | WrappedRecord['uuid'], defaultValue?: WrappedRecord) => WrappedRecord;
     createNetwork(params: {
         name: string;
         description?: string;
@@ -71,6 +74,7 @@ export interface Xapi {
     listMissingPatches(host: XoHost['id']): Promise<XcpPatches[] | XsPatches[]>;
     pool_emergencyShutdown(): Promise<void>;
     resumeVm(id: XoVm['id']): Promise<void>;
+    revertVm(snapshotId: XoVmSnapshot['id']): Promise<void>;
     unpauseVm(id: XoVm['id']): Promise<void>;
     cloneVm(vmId: XoVm['id'], opts?: {
         nameLabel?: string;
@@ -258,4 +262,13 @@ export interface Xapi {
         is_unique?: boolean;
         contents?: string;
     }): Promise<XenApiVtpm['$ref']>;
+    destroySr(id: XoSr['id']): Promise<void>;
+    xostor_delete(ref: XenApiSr['$ref']): Promise<void>;
+    objects: {
+        indexes: {
+            type: {
+                [XenApiRecord in WrappedXenApiRecord as XenApiRecord['$type']]: Record<XenApiRecord['uuid'], XenApiRecord>;
+            };
+        };
+    };
 }

package/dist/xen-api.d.mts

@@ -404,7 +404,9 @@ export interface XenApiDrTask {
     introduced_SRs: XenApiSr['$ref'][];
     uuid: string;
 }
-type XenApiHostCallMethods = TagCallMethods & {};
+type XenApiHostCallMethods = TagCallMethods & {
+    <T>(method: 'call_plugin', plugin: string, fn: string, args: Record<string, string>): Promise<T>;
+};
 export interface XenApiHost {
     $ref: Branded<'host'>;
     address: string;

package/dist/xo-app.d.mts

@@ -1,7 +1,7 @@
 import { EventEmitter } from 'node:stream';
 import type { AnyXoBackupJob, AnyXoJob, AnyXoLog, XapiXoRecord, XoAuthenticationToken, XoBackupRepository, XoConfigBackupArchive, XoGroup, XoHost, XoPool, XoPoolBackupArchive, XoProxy, XoSchedule, XoServer, XoTask, XoUser, XoVm, XoVmBackupArchive } from './xo.mjs';
 import { VatesTask } from './lib/vates-task.mjs';
-import { Xapi, XapiHostStats, XapiPoolStats, XapiStatsGranularity, XapiVmStats, XenApiGpuGroupWrapped, XenApiHostWrapped, XenApiMessageWrapped, XenApiNetworkWrapped, XenApiPbdWrapped, XenApiPciWrapped, XenApiPgpuWrapped, XenApiPifWrapped, XenApiPoolWrapped, XenApiSmWrapped, XenApiSrWrapped, XenApiVbdWrapped, XenApiVdiWrapped, XenApiVgpuTypeWrapped, XenApiVgpuWrapped, XenApiVifWrapped, XenApiVmWrapped, XenApiVtpmWrapped } from './index.mjs';
+import { Xapi, XapiHostStats, XapiPoolStats, XapiStatsGranularity, XapiVmStats, XenApiGpuGroupWrapped, XenApiHostWrapped, XenApiMessageWrapped, XenApiNetworkWrapped, XenApiPbdWrapped, XenApiPciWrapped, XenApiPgpuWrapped, XenApiPifWrapped, XenApiPoolWrapped, XenApiSmWrapped, XenApiSrWrapped, XenApiVbdWrapped, XenApiVdiWrapped, XenApiVgpuTypeWrapped, XenApiVgpuWrapped, XenApiVifWrapped, XenApiVmWrapped, XenApiVtpmWrapped, XoAclBasePrivilege, XoAclRole, XoGroupRole, XoUserRole } from './index.mjs';
 export type XapiConnection = Xapi & {
     status: string;
     pool?: {
@@ -39,7 +39,41 @@ type XapiRecordByXapiXoRecord = {
     'VM-template': XenApiVmWrapped;
     VTPM: XenApiVtpmWrapped;
 };
+type LicenseProductId = 'premium' | 'xcpng-enterprise' | 'xcpng-standard' | 'xo-proxy' | 'xosan.trial' | 'xostor' | 'xostor.trial';
+type LicenseProductType = 'xo' | 'xoproxy' | 'xcpng' | 'xosan' | 'xostor';
+type License = {
+    id: string;
+    type: 'license';
+    created: number;
+    licenseType: 'unit';
+    productId: LicenseProductId;
+    tags: string[];
+    expires?: number;
+    boundObjectId?: string;
+    bindDate?: number;
+    buyer?: {
+        token: string;
+        email: string;
+    };
+    history?: {
+        date: number;
+        boundObjectId: string;
+    }[];
+    rebound?: number;
+    productTypes?: LicenseProductType[];
+    bundleInfo?: {
+        name: string;
+        id: string;
+    };
+};
 export type XoApp = {
+    hooks: EventEmitter;
+    _redis: {
+        get(key: string): Promise<string | null>;
+        mSet(args: string[]): Promise<unknown>;
+        sMembers(key: string): Promise<string[]>;
+        sIsMember(key: string, member: string): Promise<boolean>;
+    };
     config: {
         get<T = string>(path: string): T;
         getOptional(path: string): Record<string, string> | undefined;
@@ -90,7 +124,13 @@ export type XoApp = {
         user?: XoUser;
         permission?: XoUser['permission'] | 'none' | null;
     };
+    addAclV2GroupRole(groupId: XoGroup['id'], roleId: XoAclRole['id']): Promise<XoGroupRole>;
+    addAclV2UserRole(userId: XoUser['id'], roleId: XoAclRole['id']): Promise<XoUserRole>;
     addUserToGroup: (userId: XoUser['id'], groupId: XoGroup['id']) => Promise<void>;
+    addApiMethod: <A extends unknown[], R>(name: string, method: (...args: A) => Promise<R>, info: {
+        resolve?: any;
+        params?: any;
+    }) => () => void;
     authenticateUser: (credentials: {
         token?: string;
         username?: string;
@@ -107,6 +147,17 @@ export type XoApp = {
     }>;
     checkFeatureAuthorization(featureCode: string): Promise<void>;
     connectXenServer(id: XoServer['id']): Promise<void>;
+    createAclV2Privilege(privilege: Omit<XoAclBasePrivilege, 'id'>, options?: {
+        force?: boolean;
+    }): Promise<XoAclBasePrivilege>;
+    copyAclV2Role(id: XoAclRole['id'], params?: {
+        name?: XoAclRole['name'];
+        description?: XoAclRole['description'];
+    }): Promise<XoAclRole['id']>;
+    createAclV2Role(role: {
+        name: XoAclRole['name'];
+        description?: XoAclRole['description'];
+    }): Promise<XoAclRole>;
     createAuthenticationToken(opts: {
         client?: {
             id?: string;
@@ -121,6 +172,13 @@ export type XoApp = {
         password?: string;
         [key: string]: unknown;
     }): Promise<XoUser>;
+    deleteAclV2GroupRole(groupId: XoGroup['id'], roleId: XoAclRole['id']): Promise<boolean>;
+    deleteAclV2Privilege(privilegeId: XoAclBasePrivilege['id'], options?: {
+        force?: boolean;
+    }): Promise<boolean>;
+    deleteAclV2Role(roleId: XoAclRole['id'], options?: {
+        force?: boolean;
+    }): Promise<boolean>;
     deleteGroup(id: XoGroup['id']): Promise<void>;
     deleteUser(id: XoUser['id']): Promise<void>;
     createGroup(params: {
@@ -129,6 +187,13 @@ export type XoApp = {
         providerGroup?: string;
     }): Promise<XoGroup>;
     disconnectXenServer(id: XoServer['id']): Promise<void>;
+    getAclV2Privilege(id: XoAclBasePrivilege['id']): Promise<XoAclBasePrivilege>;
+    getAclV2Privileges(): Promise<XoAclBasePrivilege[]>;
+    getAclV2RolePrivileges(roleId: XoAclRole['id']): Promise<XoAclBasePrivilege[]>;
+    getAclV2Role(id: XoAclRole['id']): Promise<XoAclRole>;
+    deleteAclV2UserRole(userId: XoUser['id'], roleId: XoAclRole['id']): Promise<boolean>;
+    getAclV2Roles(): Promise<XoAclRole[]>;
+    getAclV2UserPrivileges(userId: XoUser['id']): Promise<XoAclBasePrivilege[]>;
     getAllGroups(): Promise<XoGroup[]>;
     getAllProxies(): Promise<XoProxy[]>;
     getAllJobs<T extends AnyXoBackupJob['type']>(type: T): Promise<Extract<AnyXoBackupJob, {
@@ -220,6 +285,13 @@ export type XoApp = {
         permission?: string;
         preferences?: Record<string, string>;
     }): Promise<void>;
+    updateAclV2Privilege(privilegeId: XoAclBasePrivilege['id'], privilege: XoAclBasePrivilege): Promise<XoAclBasePrivilege>;
+    updateAclV2Role(roleId: XoAclRole['id'], role: {
+        name?: XoAclRole['name'];
+        description?: XoAclRole['description'] | null;
+    }, options?: {
+        force?: boolean;
+    }): Promise<XoAclRole>;
     updateGroup(id: XoGroup['id'], updates: {
         name?: string;
     }): void;
@@ -228,5 +300,18 @@ export type XoApp = {
         filter?: Record<string, unknown>;
         limit?: number;
     }): Record<string, XapiXoRecord>;
+    getLicenses(params?: {
+        productType?: LicenseProductType;
+    }): Promise<License[]>;
+    bindLicense(params: {
+        licenseId: string;
+        boundObjectId: string;
+    }): Promise<License>;
+    unbindLicense(params: {
+        productId: LicenseProductId;
+        boundObjectId: string;
+        licenseId: string;
+        data?: Record<string, string>;
+    }): Promise<License>;
 };
 export {};

package/dist/xo.d.mts

@@ -1,5 +1,6 @@
 import type { Branded, DOMAIN_TYPE, HOST_ALLOWED_OPERATIONS, HOST_POWER_STATE, IP_CONFIGURATION_MODE, IPV6_CONFIGURATION_MODE, NETWORK_OPERATIONS, PGPU_DOM0_ACCESS, POOL_ALLOWED_OPERATIONS, PRIMARY_ADDRESS_TYPE, STORAGE_OPERATIONS, VDI_OPERATIONS, VDI_TYPE, VIF_LOCKING_MODE, VM_OPERATIONS, VM_POWER_STATE } from './common.mjs';
 import type * as CMType from './lib/complex-matcher.mjs';
+import { XoAclPrivilege, XoAclRole, XoAclSupportedActionsByResource } from './lib/xen-orchestra-acl.mjs';
 import type { XenApiHost, XenApiPool } from './xen-api.mjs';
 type BaseXapiXo = {
     $pool: XoPool['id'];
@@ -299,6 +300,7 @@ export type XoNetwork = BaseXapiXo & {
     defaultIsLocked: boolean;
     id: Branded<'network'>;
     insecureNbd?: boolean;
+    isBonded: boolean;
     name_description: string;
     name_label: string;
     nbd?: boolean;
@@ -612,14 +614,14 @@ export type XoTask = {
         method?: string;
         name?: string;
         objectId?: string;
-        objectType?: XapiXoRecord['type'] | 'backup' | 'backup-archive' | 'backup-job' | 'backup-log' | 'backup-repository' | 'group' | 'proxy' | 'restore' | 'restore-log' | 'schedule' | 'server' | 'task' | 'user';
+        objectType?: XapiXoRecord['type'] | 'backup' | 'backup-archive' | 'backup-job' | 'backup-log' | 'backup-repository' | 'group' | 'proxy' | 'restore' | 'restore-log' | 'schedule' | 'server' | 'task' | 'user' | 'acl-privilege' | 'acl-role';
         params?: Record<string, unknown>;
         progress?: number;
         type?: string;
         userId?: string;
         [key: string]: unknown | undefined;
     };
-    result: Record<string, unknown>;
+    result?: Record<string, unknown>;
     start: number;
     status: 'failure' | 'interrupted' | 'pending' | 'success';
     tasks?: XoTask[];
@@ -635,7 +637,7 @@ export type XoUser = {
     groups: XoGroup['id'][];
     id: Branded<'user'>;
     name?: string;
-    permission: string;
+    permission: 'none' | 'admin';
     pw_hash?: string;
     preferences: Record<string, string>;
 };
@@ -771,8 +773,8 @@ export type XoVtpm = BaseXapiXo & {
     type: 'VTPM';
 };
 export type XapiXoRecord = XoAlarm | XoGpuGroup | XoHost | XoMessage | XoNetwork | XoPbd | XoPci | XoPgpu | XoPif | XoPool | XoSr | XoVbd | XoVdi | XoVdiSnapshot | XoVdiUnmanaged | XoVgpu | XoVgpuType | XoVif | XoVm | XoVmController | XoVmSnapshot | XoVmTemplate | XoVtpm | XoSm;
-export type NonXapiXoRecord = AnyXoBackupArchive | AnyXoJob | AnyXoLog | XoGroup | XoProxy | XoGroup | XoProxy | XoJob | XoBackupRepository | XoSchedule | XoServer | XoTask | XoUser;
-export type XoRecord = XapiXoRecord | NonXapiXoRecord;
+export type NonXapiXoRecord<TActionsByResource extends XoAclSupportedActionsByResource = never, TResource extends string = never> = AnyXoBackupArchive | AnyXoJob | AnyXoLog | XoGroup | XoProxy | XoGroup | XoProxy | XoJob | XoBackupRepository | XoSchedule | XoServer | XoTask | XoUser | XoAclRole | XoAclPrivilege<TActionsByResource, TResource>;
+export type XoRecord<TActionsByResource extends XoAclSupportedActionsByResource = never, TResource extends string = never> = XapiXoRecord | NonXapiXoRecord<TActionsByResource, TResource>;
 export type AnyXoVm = XoVm | XoVmSnapshot | XoVmTemplate | XoVmController;
 export type AnyXoVdi = XoVdi | XoVdiSnapshot | XoVdiUnmanaged;
 export type AnyXoJob = XoJob | AnyXoBackupJob;

package/package.json

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