Rename alias exists > name exists (#1100)

Author: mishushakov

.changeset/neat-tips-stick.md

@@ -0,0 +1,6 @@
+---
+'@e2b/python-sdk': patch
+'e2b': patch
+---
+
+deprecate aliasexists and add exists

packages/js-sdk/src/template/index.ts

@@ -20,7 +20,6 @@ import { parseDockerfile } from './dockerfileParser'
 import { LogEntry, LogEntryEnd, LogEntryStart } from './logger'
 import { ReadyCmd, waitForFile } from './readycmd'
 import {
-  AliasExistsOptions,
   BuildInfo,
   BuildOptions,
   CopyItem,
@@ -268,13 +267,36 @@ export class TemplateBase
     })
   }
 
+  /**
+   * Check if a template with the given name exists.
+   *
+   * @param name Template name to check
+   * @param options Authentication options
+   * @returns True if the name exists, false otherwise
+   *
+   * @example
+   * ```ts
+   * const exists = await Template.exists('my-python-env')
+   * if (exists) {
+   *   console.log('Template exists!')
+   * }
+   * ```
+   */
+  static async exists(
+    name: string,
+    options?: ConnectionOpts
+  ): Promise<boolean> {
+    return TemplateBase.aliasExists(name, options)
+  }
+
   /**
    * Check if a template with the given alias exists.
    *
    * @param alias Template alias to check
    * @param options Authentication options
    * @returns True if the alias exists, false otherwise
    *
+   * @deprecated Use `exists` instead.
    * @example
    * ```ts
    * const exists = await Template.aliasExists('my-python-env')
@@ -285,7 +307,7 @@ export class TemplateBase
    */
   static async aliasExists(
     alias: string,
-    options?: AliasExistsOptions
+    options?: ConnectionOpts
   ): Promise<boolean> {
     const config = new ConnectionConfig(options)
     const client = new ApiClient(config)
@@ -1223,14 +1245,14 @@ export function Template(options?: TemplateOptions): TemplateFromImage {
 Template.build = TemplateBase.build
 Template.buildInBackground = TemplateBase.buildInBackground
 Template.getBuildStatus = TemplateBase.getBuildStatus
+Template.exists = TemplateBase.exists
 Template.aliasExists = TemplateBase.aliasExists
 Template.assignTags = TemplateBase.assignTags
 Template.removeTags = TemplateBase.removeTags
 Template.toJSON = TemplateBase.toJSON
 Template.toDockerfile = TemplateBase.toDockerfile
 
 export type {
-  AliasExistsOptions,
   BuildInfo,
   BuildOptions,
   BuildStatusReason,

packages/js-sdk/src/template/types.ts

@@ -158,11 +158,6 @@ export type TemplateTagInfo = {
   tags: string[]
 }
 
-/**
- * Options for checking if a template alias exists.
- */
-export type AliasExistsOptions = ConnectionOpts
-
 /**
  * Types of instructions that can be used in a template.
  */

packages/js-sdk/tests/template/aliasExists.test.ts

@@ -0,0 +1,14 @@
+import { randomUUID } from 'node:crypto'
+import { expect, test } from 'vitest'
+import { Template } from '../../src'
+
+test('check if base template name exists', async () => {
+  const exists = await Template.exists('base')
+  expect(exists).toBe(true)
+})
+
+test('check non existing name', async () => {
+  const nonExistingName = `nonexistent-${randomUUID()}`
+  const exists = await Template.exists(nonExistingName)
+  expect(exists).toBe(false)
+})

packages/js-sdk/tests/template/exists.test.ts

@@ -376,6 +376,29 @@ async def get_build_status(
             logs_offset,
         )
 
+    @staticmethod
+    async def exists(
+        name: str,
+        **opts: Unpack[ApiParams],
+    ) -> bool:
+        """
+        Check if a template with the given name exists.
+
+        :param name: Template name to check
+        :return: True if the name exists, False otherwise
+
+        Example
+        ```python
+        from e2b import AsyncTemplate
+
+        exists = await AsyncTemplate.exists('my-python-env')
+        if exists:
+            print('Template exists!')
+        ```
+        """
+
+        return await AsyncTemplate.alias_exists(name, **opts)
+
     @staticmethod
     async def alias_exists(
         alias: str,
@@ -384,14 +407,16 @@ async def alias_exists(
         """
         Check if a template with the given alias exists.
 
+        Deprecated Use `exists` instead.
+
         :param alias: Template alias to check
         :return: True if the alias exists, False otherwise
 
         Example
         ```python
         from e2b import AsyncTemplate
 
-        exists = await AsyncTemplate.alias_exists('base')
+        exists = await AsyncTemplate.alias_exists('my-python-env')
         if exists:
             print('Template exists!')
         ```

packages/python-sdk/e2b/template_async/main.py

@@ -377,6 +377,29 @@ def get_build_status(
             logs_offset,
         )
 
+    @staticmethod
+    def exists(
+        name: str,
+        **opts: Unpack[ApiParams],
+    ) -> bool:
+        """
+        Check if a template with the given name exists.
+
+        :param name: Template name to check
+        :return: True if the name exists, False otherwise
+
+        Example
+        ```python
+        from e2b import Template
+
+        exists = Template.exists('my-python-env')
+        if exists:
+            print('Template exists!')
+        ```
+        """
+
+        return Template.alias_exists(name, **opts)
+
     @staticmethod
     def alias_exists(
         alias: str,
@@ -385,14 +408,16 @@ def alias_exists(
         """
         Check if a template with the given alias exists.
 
+        Deprecated Use `exists` instead.
+
         :param alias: Template alias to check
         :return: True if the alias exists, False otherwise
 
         Example
         ```python
         from e2b import Template
 
-        exists = Template.alias_exists('base')
+        exists = Template.alias_exists('my-python-env')
         if exists:
             print('Template exists!')
         ```

packages/python-sdk/e2b/template_sync/main.py

@@ -0,0 +1,20 @@
+import uuid
+
+import pytest
+
+from e2b import AsyncTemplate
+
+
+@pytest.mark.skip_debug()
+async def test_check_base_template_name_exists():
+    """Test that the base template name exists."""
+    exists = await AsyncTemplate.exists("base")
+    assert exists is True
+
+
+@pytest.mark.skip_debug()
+async def test_check_non_existing_name():
+    """Test that a non-existing name returns False."""
+    non_existing_name = f"nonexistent-{uuid.uuid4()}"
+    exists = await AsyncTemplate.exists(non_existing_name)
+    assert exists is False