Merge pull request #65 from codecrafters-io/CC-1122-ts-support

feat: Add Typescript support using bun runtime.

Author: ryan-gang

compiled_starters/typescript/.gitattributes

@@ -0,0 +1 @@
+* text=auto

compiled_starters/typescript/.gitignore

@@ -0,0 +1 @@
+node_modules/

compiled_starters/typescript/README.md

@@ -0,0 +1,77 @@
+![progress-banner](https://codecrafters.io/landing/images/default_progress_banners/sqlite.png)
+
+This is a starting point for TypeScript solutions to the
+["Build Your Own SQLite" Challenge](https://codecrafters.io/challenges/sqlite).
+
+In this challenge, you'll build a barebones SQLite implementation that supports
+basic SQL queries like `SELECT`. Along the way we'll learn about
+[SQLite's file format](https://www.sqlite.org/fileformat.html), how indexed data
+is
+[stored in B-trees](https://jvns.ca/blog/2014/10/02/how-does-sqlite-work-part-2-btrees/)
+and more.
+
+**Note**: If you're viewing this repo on GitHub, head over to
+[codecrafters.io](https://codecrafters.io) to try the challenge.
+
+# Passing the first stage
+
+The entry point for your SQLite implementation is in `app/main.ts`. Study and
+uncomment the relevant code, and push your changes to pass the first stage:
+
+```sh
+git add .
+git commit -m "pass 1st stage" # any msg
+git push origin master
+```
+
+Time to move on to the next stage!
+
+# Stage 2 & beyond
+
+Note: This section is for stages 2 and beyond.
+
+1. Ensure you have `bun (1.1)` installed locally
+1. Run `./your_sqlite3.sh` to run your program, which is implemented in
+   `app/main.ts`.
+1. Commit your changes and run `git push origin master` to submit your solution
+   to CodeCrafters. Test output will be streamed to your terminal.
+
+# Sample Databases
+
+To make it easy to test queries locally, we've added a sample database in the
+root of this repository: `sample.db`.
+
+This contains two tables: `apples` & `oranges`. You can use this to test your
+implementation for the first 6 stages.
+
+You can explore this database by running queries against it like this:
+
+```sh
+$ sqlite3 sample.db "select id, name from apples"
+1|Granny Smith
+2|Fuji
+3|Honeycrisp
+4|Golden Delicious
+```
+
+There are two other databases that you can use:
+
+1. `superheroes.db`:
+   - This is a small version of the test database used in the table-scan stage.
+   - It contains one table: `superheroes`.
+   - It is ~1MB in size.
+1. `companies.db`:
+   - This is a small version of the test database used in the index-scan stage.
+   - It contains one table: `companies`, and one index: `idx_companies_country`
+   - It is ~7MB in size.
+
+These aren't included in the repository because they're large in size. You can
+download them by running this script:
+
+```sh
+./download_sample_databases.sh
+```
+
+If the script doesn't work for some reason, you can download the databases
+directly from
+[codecrafters-io/sample-sqlite-databases](https://github.com/codecrafters-io/sample-sqlite-databases).

compiled_starters/typescript/app/main.ts

@@ -0,0 +1,23 @@
+import { open } from 'fs/promises';
+import { constants } from 'fs';
+
+const args = process.argv;
+const databaseFilePath: string = args[2]
+const command: string = args[3];
+
+if (command === ".dbinfo") {
+    const databaseFileHandler = await open(databaseFilePath, constants.O_RDONLY);
+    const buffer: Uint8Array = new Uint8Array(100);
+    await databaseFileHandler.read(buffer, 0, buffer.length, 0);
+
+    // You can use print statements as follows for debugging, they'll be visible when running tests.
+    console.log("Logs from your program will appear here!");
+
+    // Uncomment this to pass the first stage    
+    // const pageSize = new DataView(buffer.buffer, 0, buffer.byteLength).getUint16(16);
+    // console.log(`database page size: ${pageSize}`);
+
+    await databaseFileHandler.close();
+} else {
+    throw new Error(`Unknown command ${command}`);
+}

compiled_starters/typescript/bun.lockb

@@ -0,0 +1,11 @@
+# Set this to true if you want debug logs.
+#
+# These can be VERY verbose, so we suggest turning them off
+# unless you really need them.
+debug: false
+
+# Use this to change the TypeScript version used to run your code
+# on Codecrafters.
+#
+# Available versions: bun-1.1
+language_pack: bun-1.1

compiled_starters/typescript/codecrafters.yml

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+echo "Downloading superheroes.db: ~1MB (used in stage 7)"
+curl -Lo superheroes.db https://raw.githubusercontent.com/codecrafters-io/sample-sqlite-databases/master/superheroes.db
+
+echo "Downloading companies.db: ~7MB (used in stage 8)"
+curl -Lo companies.db https://raw.githubusercontent.com/codecrafters-io/sample-sqlite-databases/master/companies.db
+
+echo "Sample databases downloaded."

compiled_starters/typescript/download_sample_databases.sh

@@ -0,0 +1,11 @@
+{
+    "name": "@codecrafters/build-your-own-sqlite",
+    "description": "Build your own SQLite challenge, from CodeCrafters",
+    "type": "module",
+    "scripts": {
+        "dev": "bun run app/main.ts"
+    },
+    "dependencies": {
+        "fs-extra": "^11.2.0"
+    }
+}

compiled_starters/typescript/package.json

@@ -0,0 +1,8 @@
+#!/bin/sh
+#
+# DON'T EDIT THIS!
+#
+# CodeCrafters uses this file to test your code. Don't make any changes here!
+#
+# DON'T EDIT THIS!
+exec bun run ./app/main.ts "$@"