freestyle-sandboxes 0.1.37 → 0.1.39

package/index.cjs

@@ -5947,8 +5947,9 @@ function composeVmTemplates(templates) {
   );
   const mergedWith = {};
   for (const template of templates) {
-    for (const key in template.with) {
-      const builder = template.with[key];
+    const builders = template.with ?? {};
+    for (const key in builders) {
+      const builder = builders[key];
       if (builder) {
         mergedWith[key] = builder;
       }
@@ -5984,8 +5985,9 @@ function composeVmSpecs(specs) {
   const mergedWithDiscriminators = {};
   for (const spec of specs) {
     const builderDiscriminators = spec.getBuilderDiscriminators();
-    for (const key in spec.builders) {
-      const builder = spec.builders[key];
+    const builders = spec.builders ?? {};
+    for (const key in builders) {
+      const builder = builders[key];
       if (builder) {
         mergedWith[key] = builder;
         mergedWithDiscriminators[key] = builderDiscriminators[key];
@@ -6402,7 +6404,9 @@ class VmSpec {
   }
   snapshot() {
     const { snapshot: existingSnapshot, ...currentLayer } = this.raw;
-    const currentBuilders = { ...this.builders };
+    const currentBuilders = {
+      ...this.builders
+    };
     const currentWithDiscriminators = this.getBuilderDiscriminators();
     const innerSnapshot = new VmSpec({
       ...currentLayer,
@@ -6456,6 +6460,14 @@ class VmSpec {
     const existing = this.raw.aptDeps ?? [];
     return this.mergeRaw({ aptDeps: [...existing, ...deps] });
   }
+  users(users) {
+    const existing = this.raw.users ?? [];
+    return this.mergeRaw({ users: [...existing, ...users] });
+  }
+  groups(groups) {
+    const existing = this.raw.groups ?? [];
+    return this.mergeRaw({ groups: [...existing, ...groups] });
+  }
   additionalFiles(files) {
     const existing = this.raw.additionalFiles ?? {};
     this.raw.additionalFiles = {
@@ -6756,7 +6768,11 @@ class VmsNamespace {
       ...rawTemplate ?? {},
       baseImage: serializedBaseImage
     } : rawTemplate;
-    const { baseImage: _baseImage, template: _template, ...requestConfig } = config;
+    const {
+      baseImage: _baseImage,
+      template: _template,
+      ...requestConfig
+    } = config;
     const response = await this.freestyle._apiClient.post("/v1/vms", {
       body: {
         ...requestConfig,

package/index.d.cts

@@ -12125,12 +12125,25 @@ declare class Systemd {
  * This is the instance attached to the VM after creation.
  */
 declare class VmWithInstance {
-    protected vm: Vm;
+    vm: Vm;
     private _init;
 }
-type VmWithDefaultField<B extends VmWith> = B extends VmWith<any, any, infer TDefaultField> ? TDefaultField : string;
-type VmWithDefaultFieldRecord<B extends VmWith> = Record<VmWithDefaultField<B>, B>;
-type VmWithAddedFields<B extends VmWith> = B extends VmWith<any, infer TAddedFields, any> ? TAddedFields : {};
+interface VmWithLike<TInstance = unknown, TAddedFields extends Record<string, VmWithLike<any, any, any>> = {}, TDefaultField extends string = string> {
+    instance: TInstance;
+    readonly defaultField?: TDefaultField;
+    configure?(existingConfig: any): any;
+    configureSpec?(spec: any): any;
+    configureSnapshotSpec?(spec: any): any;
+    configureBaseImage?(image: any): any;
+    configureTemplate?(template: any): any;
+    configureNestedTemplate?(template: any): any;
+    createInstance(): TInstance;
+}
+type VmWithDefaultField<B extends VmWithLike> = B extends {
+    defaultField?: infer TDefaultField;
+} ? Extract<TDefaultField, string> extends never ? string : Extract<TDefaultField, string> : string;
+type VmWithDefaultFieldRecord<B extends VmWithLike> = Record<VmWithDefaultField<B>, B>;
+type VmWithAddedFields<B extends VmWithLike> = B extends VmWith<any, infer TAddedFields, any> ? TAddedFields : {};
 /**
  * Base class for VM configuration builders that act as middleware.
  * Extend this class to create reusable VM components like DevServer, Database, etc.
@@ -12140,7 +12153,7 @@ type VmWithAddedFields<B extends VmWith> = B extends VmWith<any, infer TAddedFie
  * 2. Applies its own configuration
  * 3. Returns merged configuration
  */
-declare abstract class VmWith<TInstance extends VmWithInstance = VmWithInstance, TAddedFields extends Record<string, VmWith> = {}, TDefaultField extends string = string> {
+declare abstract class VmWith<TInstance = VmWithInstance, TAddedFields extends Record<string, VmWithLike<any, any, any>> = {}, TDefaultField extends string = string> {
     instance: TInstance;
     readonly defaultField?: TDefaultField;
     protected readonly _addedFields?: TAddedFields;
@@ -12406,7 +12419,7 @@ type GitOptions = Omit<NonNullable<CreateSnapshotRequest["template"]["git"]>, "c
  * Template options with SystemdServiceInput support and optional git.config
  */
 type TemplateOptions = Omit<CreateSnapshotRequest["template"], "systemd" | "git"> & {
-    template?: VmTemplate<Record<string, VmWith>>;
+    template?: VmTemplate<Record<string, VmWithLike>>;
     baseImage?: VmBaseImage | RawBaseImage | null;
     systemd?: null | {
         services?: SystemdServiceInput[] | null;
@@ -12423,7 +12436,7 @@ declare class VmBaseImage {
     hasFromInstruction(): boolean;
     toRaw(): RawBaseImage;
 }
-declare class VmTemplate<T extends Record<string, VmWith> = {}> {
+declare class VmTemplate<T extends Record<string, VmWithLike> = {}> {
     raw: TemplateOptions;
     readonly with: Partial<T>;
     constructor(template: TemplateOptions & {
@@ -12433,11 +12446,11 @@ declare class VmTemplate<T extends Record<string, VmWith> = {}> {
 type VmSpecOptions = TemplateOptions & {
     snapshot?: VmSpec;
 };
-type VmSpecWithFn<T extends Record<string, VmWith>> = {
-    <K extends string, B extends VmWith>(name: K, builder: B): VmSpec<T & Record<K, B> & VmWithAddedFields<B>>;
-    <B extends VmWith>(builder: B): VmSpec<T & Record<VmWithDefaultField<B>, B> & VmWithAddedFields<B>>;
+type VmSpecWithFn<T extends Record<string, VmWithLike>> = {
+    <K extends string, B extends VmWithLike>(name: K, builder: B): VmSpec<T & Record<K, B> & VmWithAddedFields<B>>;
+    <B extends VmWithLike>(builder: B): VmSpec<T & Record<VmWithDefaultField<B>, B> & VmWithAddedFields<B>>;
 } & Partial<T>;
-declare class VmSpec<T extends Record<string, VmWith> = {}> {
+declare class VmSpec<T extends Record<string, VmWithLike> = {}> {
     raw: VmSpecOptions;
     readonly with: VmSpecWithFn<T>;
     private withDiscriminators;
@@ -12462,6 +12475,8 @@ declare class VmSpec<T extends Record<string, VmWith> = {}> {
     discriminator(value: string): this;
     workdir(path: string): this;
     aptDeps(...deps: string[]): this;
+    users(users: NonNullable<CreateVmOptions["users"]>): this;
+    groups(groups: NonNullable<CreateVmOptions["groups"]>): this;
     additionalFiles(files: NonNullable<CreateVmOptions["additionalFiles"]>): this;
     runCommands(...commands: string[]): this;
     repo(repo: string, path: string): this;
@@ -12476,14 +12491,14 @@ declare class VmsNamespace {
      * @param options Optional VM configuration
      * @returns A VM instance representing the created VM
      */
-    create<T extends Record<string, VmWith>>(spec: VmSpec<T>): Promise<Omit<ResponsePostV1Vms200, "consoleUrl"> & {
+    create<T extends Record<string, VmWithLike>>(spec: VmSpec<T>): Promise<Omit<ResponsePostV1Vms200, "consoleUrl"> & {
         vmId: string;
         vm: Vm & {
             [K in keyof T]: ReturnType<T[K]["createInstance"]>;
         };
         domains: string[];
     }>;
-    create<T extends Record<string, VmWith>>(options: CreateVmOptions & {
+    create<T extends Record<string, VmWithLike>>(options: CreateVmOptions & {
         with?: T;
         template?: VmTemplate<T>;
         spec?: VmSpec<T>;
@@ -12506,7 +12521,7 @@ declare class VmsNamespace {
      * @param spec Optional spec to attach builders to the returned VM
      * @returns The VM instance configured with builders from the spec
      */
-    get<T extends Record<string, VmWith>>({ vmId, spec, }: {
+    get<T extends Record<string, VmWithLike>>({ vmId, spec, }: {
         vmId: string;
         spec?: VmSpec<T>;
     }): Promise<{
@@ -12518,7 +12533,7 @@ declare class VmsNamespace {
     /**
      * Create a VM instance by ID without making an api call.
      */
-    ref<T extends Record<string, VmWith>>({ vmId, spec, }: {
+    ref<T extends Record<string, VmWithLike>>({ vmId, spec, }: {
         vmId: string;
         spec?: VmSpec<T>;
     }): Vm & {
@@ -12531,7 +12546,7 @@ declare class VmsNamespace {
 declare class VmSnapshotsNamespace {
     private apiClient;
     constructor(apiClient: ApiClient);
-    ensure<T extends Record<string, VmWith>>(options: Omit<PostV1VmsSnapshotsRequestBody, "template"> & {
+    ensure<T extends Record<string, VmWithLike>>(options: Omit<PostV1VmsSnapshotsRequestBody, "template"> & {
         template?: VmTemplate<T> | PostV1VmsSnapshotsRequestBody["template"];
         spec?: VmSpec<T>;
         snapshot?: VmSpec<T>;

package/index.d.mts

@@ -12125,12 +12125,25 @@ declare class Systemd {
  * This is the instance attached to the VM after creation.
  */
 declare class VmWithInstance {
-    protected vm: Vm;
+    vm: Vm;
     private _init;
 }
-type VmWithDefaultField<B extends VmWith> = B extends VmWith<any, any, infer TDefaultField> ? TDefaultField : string;
-type VmWithDefaultFieldRecord<B extends VmWith> = Record<VmWithDefaultField<B>, B>;
-type VmWithAddedFields<B extends VmWith> = B extends VmWith<any, infer TAddedFields, any> ? TAddedFields : {};
+interface VmWithLike<TInstance = unknown, TAddedFields extends Record<string, VmWithLike<any, any, any>> = {}, TDefaultField extends string = string> {
+    instance: TInstance;
+    readonly defaultField?: TDefaultField;
+    configure?(existingConfig: any): any;
+    configureSpec?(spec: any): any;
+    configureSnapshotSpec?(spec: any): any;
+    configureBaseImage?(image: any): any;
+    configureTemplate?(template: any): any;
+    configureNestedTemplate?(template: any): any;
+    createInstance(): TInstance;
+}
+type VmWithDefaultField<B extends VmWithLike> = B extends {
+    defaultField?: infer TDefaultField;
+} ? Extract<TDefaultField, string> extends never ? string : Extract<TDefaultField, string> : string;
+type VmWithDefaultFieldRecord<B extends VmWithLike> = Record<VmWithDefaultField<B>, B>;
+type VmWithAddedFields<B extends VmWithLike> = B extends VmWith<any, infer TAddedFields, any> ? TAddedFields : {};
 /**
  * Base class for VM configuration builders that act as middleware.
  * Extend this class to create reusable VM components like DevServer, Database, etc.
@@ -12140,7 +12153,7 @@ type VmWithAddedFields<B extends VmWith> = B extends VmWith<any, infer TAddedFie
  * 2. Applies its own configuration
  * 3. Returns merged configuration
  */
-declare abstract class VmWith<TInstance extends VmWithInstance = VmWithInstance, TAddedFields extends Record<string, VmWith> = {}, TDefaultField extends string = string> {
+declare abstract class VmWith<TInstance = VmWithInstance, TAddedFields extends Record<string, VmWithLike<any, any, any>> = {}, TDefaultField extends string = string> {
     instance: TInstance;
     readonly defaultField?: TDefaultField;
     protected readonly _addedFields?: TAddedFields;
@@ -12406,7 +12419,7 @@ type GitOptions = Omit<NonNullable<CreateSnapshotRequest["template"]["git"]>, "c
  * Template options with SystemdServiceInput support and optional git.config
  */
 type TemplateOptions = Omit<CreateSnapshotRequest["template"], "systemd" | "git"> & {
-    template?: VmTemplate<Record<string, VmWith>>;
+    template?: VmTemplate<Record<string, VmWithLike>>;
     baseImage?: VmBaseImage | RawBaseImage | null;
     systemd?: null | {
         services?: SystemdServiceInput[] | null;
@@ -12423,7 +12436,7 @@ declare class VmBaseImage {
     hasFromInstruction(): boolean;
     toRaw(): RawBaseImage;
 }
-declare class VmTemplate<T extends Record<string, VmWith> = {}> {
+declare class VmTemplate<T extends Record<string, VmWithLike> = {}> {
     raw: TemplateOptions;
     readonly with: Partial<T>;
     constructor(template: TemplateOptions & {
@@ -12433,11 +12446,11 @@ declare class VmTemplate<T extends Record<string, VmWith> = {}> {
 type VmSpecOptions = TemplateOptions & {
     snapshot?: VmSpec;
 };
-type VmSpecWithFn<T extends Record<string, VmWith>> = {
-    <K extends string, B extends VmWith>(name: K, builder: B): VmSpec<T & Record<K, B> & VmWithAddedFields<B>>;
-    <B extends VmWith>(builder: B): VmSpec<T & Record<VmWithDefaultField<B>, B> & VmWithAddedFields<B>>;
+type VmSpecWithFn<T extends Record<string, VmWithLike>> = {
+    <K extends string, B extends VmWithLike>(name: K, builder: B): VmSpec<T & Record<K, B> & VmWithAddedFields<B>>;
+    <B extends VmWithLike>(builder: B): VmSpec<T & Record<VmWithDefaultField<B>, B> & VmWithAddedFields<B>>;
 } & Partial<T>;
-declare class VmSpec<T extends Record<string, VmWith> = {}> {
+declare class VmSpec<T extends Record<string, VmWithLike> = {}> {
     raw: VmSpecOptions;
     readonly with: VmSpecWithFn<T>;
     private withDiscriminators;
@@ -12462,6 +12475,8 @@ declare class VmSpec<T extends Record<string, VmWith> = {}> {
     discriminator(value: string): this;
     workdir(path: string): this;
     aptDeps(...deps: string[]): this;
+    users(users: NonNullable<CreateVmOptions["users"]>): this;
+    groups(groups: NonNullable<CreateVmOptions["groups"]>): this;
     additionalFiles(files: NonNullable<CreateVmOptions["additionalFiles"]>): this;
     runCommands(...commands: string[]): this;
     repo(repo: string, path: string): this;
@@ -12476,14 +12491,14 @@ declare class VmsNamespace {
      * @param options Optional VM configuration
      * @returns A VM instance representing the created VM
      */
-    create<T extends Record<string, VmWith>>(spec: VmSpec<T>): Promise<Omit<ResponsePostV1Vms200, "consoleUrl"> & {
+    create<T extends Record<string, VmWithLike>>(spec: VmSpec<T>): Promise<Omit<ResponsePostV1Vms200, "consoleUrl"> & {
         vmId: string;
         vm: Vm & {
             [K in keyof T]: ReturnType<T[K]["createInstance"]>;
         };
         domains: string[];
     }>;
-    create<T extends Record<string, VmWith>>(options: CreateVmOptions & {
+    create<T extends Record<string, VmWithLike>>(options: CreateVmOptions & {
         with?: T;
         template?: VmTemplate<T>;
         spec?: VmSpec<T>;
@@ -12506,7 +12521,7 @@ declare class VmsNamespace {
      * @param spec Optional spec to attach builders to the returned VM
      * @returns The VM instance configured with builders from the spec
      */
-    get<T extends Record<string, VmWith>>({ vmId, spec, }: {
+    get<T extends Record<string, VmWithLike>>({ vmId, spec, }: {
         vmId: string;
         spec?: VmSpec<T>;
     }): Promise<{
@@ -12518,7 +12533,7 @@ declare class VmsNamespace {
     /**
      * Create a VM instance by ID without making an api call.
      */
-    ref<T extends Record<string, VmWith>>({ vmId, spec, }: {
+    ref<T extends Record<string, VmWithLike>>({ vmId, spec, }: {
         vmId: string;
         spec?: VmSpec<T>;
     }): Vm & {
@@ -12531,7 +12546,7 @@ declare class VmsNamespace {
 declare class VmSnapshotsNamespace {
     private apiClient;
     constructor(apiClient: ApiClient);
-    ensure<T extends Record<string, VmWith>>(options: Omit<PostV1VmsSnapshotsRequestBody, "template"> & {
+    ensure<T extends Record<string, VmWithLike>>(options: Omit<PostV1VmsSnapshotsRequestBody, "template"> & {
         template?: VmTemplate<T> | PostV1VmsSnapshotsRequestBody["template"];
         spec?: VmSpec<T>;
         snapshot?: VmSpec<T>;

package/index.mjs

@@ -5945,8 +5945,9 @@ function composeVmTemplates(templates) {
   );
   const mergedWith = {};
   for (const template of templates) {
-    for (const key in template.with) {
-      const builder = template.with[key];
+    const builders = template.with ?? {};
+    for (const key in builders) {
+      const builder = builders[key];
       if (builder) {
         mergedWith[key] = builder;
       }
@@ -5982,8 +5983,9 @@ function composeVmSpecs(specs) {
   const mergedWithDiscriminators = {};
   for (const spec of specs) {
     const builderDiscriminators = spec.getBuilderDiscriminators();
-    for (const key in spec.builders) {
-      const builder = spec.builders[key];
+    const builders = spec.builders ?? {};
+    for (const key in builders) {
+      const builder = builders[key];
       if (builder) {
         mergedWith[key] = builder;
         mergedWithDiscriminators[key] = builderDiscriminators[key];
@@ -6400,7 +6402,9 @@ class VmSpec {
   }
   snapshot() {
     const { snapshot: existingSnapshot, ...currentLayer } = this.raw;
-    const currentBuilders = { ...this.builders };
+    const currentBuilders = {
+      ...this.builders
+    };
     const currentWithDiscriminators = this.getBuilderDiscriminators();
     const innerSnapshot = new VmSpec({
       ...currentLayer,
@@ -6454,6 +6458,14 @@ class VmSpec {
     const existing = this.raw.aptDeps ?? [];
     return this.mergeRaw({ aptDeps: [...existing, ...deps] });
   }
+  users(users) {
+    const existing = this.raw.users ?? [];
+    return this.mergeRaw({ users: [...existing, ...users] });
+  }
+  groups(groups) {
+    const existing = this.raw.groups ?? [];
+    return this.mergeRaw({ groups: [...existing, ...groups] });
+  }
   additionalFiles(files) {
     const existing = this.raw.additionalFiles ?? {};
     this.raw.additionalFiles = {
@@ -6754,7 +6766,11 @@ class VmsNamespace {
       ...rawTemplate ?? {},
       baseImage: serializedBaseImage
     } : rawTemplate;
-    const { baseImage: _baseImage, template: _template, ...requestConfig } = config;
+    const {
+      baseImage: _baseImage,
+      template: _template,
+      ...requestConfig
+    } = config;
     const response = await this.freestyle._apiClient.post("/v1/vms", {
       body: {
         ...requestConfig,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "freestyle-sandboxes",
-  "version": "0.1.37",
+  "version": "0.1.39",
   "type": "module",
   "exports": {
     "require": {