feat: add typescript template integration (#614)

* feat: add typescript template integration

Author: neilcampbell

README.md

@@ -47,6 +47,7 @@ AlgoKit helps you develop Algorand solutions:
   - **AlgoKit Utils** ([Python](https://github.com/algorandfoundation/algokit-utils-py#readme) | [TypeScript](https://github.com/algorandfoundation/algokit-utils-ts#readme)): A set of utility libraries so you can develop, test, build and deploy Algorand solutions quickly and easily
     - [algosdk](https://developer.algorand.org/docs/sdks/) ([Python](https://github.com/algorand/py-algorand-sdk#readme) | [TypeScript](https://github.com/algorand/js-algorand-sdk#readme)) - The core Algorand SDK providing Algorand protocol API calls, which AlgoKit Utils wraps, but still exposes for advanced scenarios
   - [**Algorand Python**](https://github.com/algorandfoundation/puya): A semantically and syntactically compatible, typed Python language that works with standard Python tooling and allows you to express smart contracts (apps) and smart signatures (logic signatures) for deployment on the Algorand Virtual Machine (AVM).
+  - [**Algorand TypeScript (Beta)**](https://github.com/algorandfoundation/puya-ts): A semantically and syntactically compatible, typed TypeScript language that works with standard TypeScript tooling and allows you to express smart contracts (apps) and smart signatures (logic signatures) for deployment on the Algorand Virtual Machine (AVM). This language is currently in beta.
   - [**TEALScript**](https://github.com/algorandfoundation/TEALScript): A subset of TypeScript that can be used to express smart contracts (apps) and smart signatures (logic signatures) for deployment on the Algorand Virtual Machine (AVM).
   - [**AlgoKit LocalNet**](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/localnet.md): A local isolated Algorand network so you can simulate real transactions and workloads on your computer
 
@@ -61,7 +62,7 @@ AlgoKit comes with out-of-the-box [Continuous Integration / Continuous Deploymen
 The set of capabilities supported by AlgoKit will evolve over time, but currently includes:
 
 - Quickly run, explore and interact with an isolated local Algorand network (LocalNet)
-- Building, testing, deploying and calling [Algorand Python](https://github.com/algorandfoundation/puya) / [TEALScript](https://github.com/algorandfoundation/TEALScript) smart contracts
+- Building, testing, deploying and calling [Algorand Python](https://github.com/algorandfoundation/puya) / [Algorand TypeScript (Beta)](https://github.com/algorandfoundation/puya-ts) / [TEALScript](https://github.com/algorandfoundation/TEALScript) smart contracts
 
 For a user guide and guidance on how to use AlgoKit, please refer to the [docs](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/algokit.md).
 
@@ -91,7 +92,7 @@ The key required dependency is Python 3.10+, but some of the installation option
 
 - **Git**: Essential for creating and updating projects from templates. Installation guide available at [Git Installation](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
 - **Docker**: Necessary for running the AlgoKit LocalNet environment. Docker Compose version 2.5.0 or higher is required. See [Docker Installation](https://docs.docker.com/get-docker/).
-- **Node.js**: For those working on frontend templates or building contracts using TEALScript. **Minimum required versions are Node.js `v18` and npm `v9`**. Instructions can be found at [Node.js Installation](https://nodejs.org/en/download/).
+- **Node.js**: For those working on frontend templates or building contracts using TypeScript or TEALScript. **Minimum required versions are Node.js `v22` and npm `v10`**. Instructions can be found at [Node.js Installation](https://nodejs.org/en/download/).
 
 > **Note**
 > If you have previously installed AlgoKit using `pipx` and would like to switch to a different installation method, please ensure that

docs/cli/index.md

@@ -675,7 +675,7 @@ Name of an official template to use. To choose interactively, run this command w
 
 * **Options**
 
-    tealscript | python | react | fullstack | base
+    tealscript | typescript | python | react | fullstack | base
 
 
 

docs/features/init.md

@@ -20,7 +20,7 @@ $ ~ algokit init
 ? Name of project / directory to create the project in:  my-cool-app
 ```
 
-Once above 2 questions are answered, the `cli` will start instantiating the project and will start asking questions specific to the template you are instantiating. By default official templates such as `python`, `fullstack`, `react`, `python` include a notion of a `preset`. If you want to skip all questions and let the tool preset the answers tailored for a starter project you can pick `Starter`, for a more advanced project that includes unit tests, CI automation and other advanced features, pick `Production`. Lastly, if you prefer to modify the experience and tailor the template to your needs, pick the `Custom` preset.
+Once above 2 questions are answered, the `cli` will start instantiating the project and will start asking questions specific to the template you are instantiating. By default official templates such as `python`, `typescript`, `fullstack`, `react`, `python` include a notion of a `preset`. If you want to skip all questions and let the tool preset the answers tailored for a starter project you can pick `Starter`, for a more advanced project that includes unit tests, CI automation and other advanced features, pick `Production`. Lastly, if you prefer to modify the experience and tailor the template to your needs, pick the `Custom` preset.
 
 If you want to accept the default for each option simply hit [enter] or alternatively to speed things up you can run `algokit init --defaults` and they will be auto-accepted.
 

src/algokit/cli/init.py

@@ -81,6 +81,7 @@ class TemplateKey(str, Enum):
 
     BASE = "base"
     PYTHON = "python"
+    TYPESCRIPT = "typescript"
     TEALSCRIPT = "tealscript"
     FULLSTACK = "fullstack"
     REACT = "react"
@@ -113,7 +114,7 @@ def __eq__(self, other: object) -> bool:
 
 LANGUAGE_TO_TEMPLATE_MAP = {
     ContractLanguage.PYTHON: TemplateKey.PYTHON,
-    ContractLanguage.TYPESCRIPT: TemplateKey.TEALSCRIPT,
+    ContractLanguage.TYPESCRIPT: TemplateKey.TYPESCRIPT,
 }
 
 
@@ -124,6 +125,10 @@ def _get_blessed_templates() -> dict[TemplateKey, BlessedTemplateSource]:
             url="gh:algorand-devrel/tealscript-algokit-template",
             description="Official starter template for TEALScript applications.",
         ),
+        TemplateKey.TYPESCRIPT: BlessedTemplateSource(
+            url="gh:algorandfoundation/algokit-typescript-template",
+            description="Official starter template for Algorand TypeScript (Beta) applications",
+        ),
         TemplateKey.PYTHON: BlessedTemplateSource(
             url="gh:algorandfoundation/algokit-python-template",
             description="Official starter template for Algorand Python applications",
@@ -649,7 +654,7 @@ def _get_template_interactive() -> TemplateSource:
         raise click.ClickException("No template selected. Please try again.")
 
     # Map the template string directly to the TemplateSource
-    # This is needed to be able to reuse fullstack to work with python and tealscript templates
+    # This is needed to be able to reuse fullstack to work with python and typescript templates
     blessed_templates = _get_blessed_templates()
     if template in blessed_templates:
         selected_template_source = blessed_templates[template]

tests/init/test_init.py

@@ -86,6 +86,7 @@ class ExtendedTemplateKey(str, Enum):
     # Include all keys from TemplateKey and add new ones
     BASE = "base"
     PYTHON = "python"
+    TYPESCRIPT = "typescript"
     TEALSCRIPT = "tealscript"
     FULLSTACK = "fullstack"
     REACT = "react"