Initial commit

.eslintrc.yml

@@ -0,0 +1,28 @@
+extends:
+  - "eslint:recommended"
+  - "plugin:@typescript-eslint/recommended"
+
+parser: "@typescript-eslint/parser"
+
+plugins:
+  - "@typescript-eslint"
+
+env:
+  node: true
+
+rules:
+  "no-async-promise-executor":
+    - off
+
+  "@typescript-eslint/no-explicit-any":
+    - off
+
+  "@typescript-eslint/no-unused-vars":
+    - error
+    - vars: all
+      args: none
+
+  require-yield: 0
+
+parserOptions:
+  project: "./tsconfig.json"

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Report a bug or unexpected behavior with resonate-sdk-ts
+title: ""
+labels: bug
+assignees: ""
+---
+
+## Expected Behavior
+
+## Actual Behavior
+
+## To Reproduce
+
+1.
+2.
+3.
+
+## Specifications
+
+- Version:
+- Platform:
+
+## Additional context

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,2 @@
+blank_issues_enabled: true
+contact_links: []

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,15 @@
+---
+name: Feature request
+about: Suggest an idea for resonate-sdk-ts
+title: ""
+labels: enhancement
+assignees: ""
+---
+
+## Describe the problem you are facing
+
+## Describe the solution you'd like
+
+## Alternatives you've considered
+
+## Additional context

.github/workflows/ci.yaml

@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Run linter
+        run: npm run lint
+
+      - name: Run tests
+        run: npm test

.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+node_modules/
+out/
+.next/
+mydb.sqlite

.prettierignore

@@ -0,0 +1,7 @@
+build
+coverage
+examples
+README.md
+package.json
+package-lock.json
+tsconfig.json

.prettierrc

@@ -0,0 +1,3 @@
+{
+  "printWidth": 120
+}

.vscode/launch.json

@@ -0,0 +1,17 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "example/web",
+      "skipFiles": ["<node_internals>/**"],
+      "program": "${workspaceFolder}/example/web/index.ts",
+      "preLaunchTask": "tsc: build - example/web/tsconfig.json",
+      "outFiles": ["${workspaceFolder}/example/web/out/**/*.js"]
+    }
+  ]
+}

CONTRIBUTING.md

@@ -0,0 +1,103 @@
+# How to Contribute
+
+Welcome to the Resonate project! We appreciate your interest in helping us build reliable
+and scalable distributed systems. To get started, follow these simple steps:
+
+## Initial setup
+
+We follow the fork and branch workflow. There will be three Git repositories involved:
+
+1.  _upstream_ - the [resonate-sdk-ts](https://github.com/resonatehq/resonate-sdk-ts) repository on GitHub.
+2.  _origin_ - your GitHub fork of `upstream`.
+3.  _local_ - your local clone of `origin`.
+
+These steps are only needed once and not for subsequent changes you might want to make:
+
+1. Fork the `resonate-sdk-ts` repository on GitHub to create `origin`.
+   Visit [resonate-sdk-ts](https://github.com/resonatehq/resonate-sdk-ts) GitHub repository and click the `Fork` button.
+
+2. Make a `local` clone of your fork.
+
+   ```shell
+   git clone [email protected]:<your-user-name>/resonate-sdk-ts.git
+   ```
+
+3. Add a remote pointing from `local` to `upstream`.
+
+   ```shell
+   cd resonate
+   git remote add upstream [email protected]:resonatehq/resonate-sdk-ts.git
+   ```
+
+4. Double check the two remotes are referencing the expected url.
+
+   ```shell
+   git remote get-url origin   # [email protected]:<your-user-name>/resonate-sdk-ts.git
+   git remote get-url upstream # [email protected]:resonatehq/resonate-sdk-ts.git
+   ```
+
+## Development workflow
+
+<p align="center">
+   <img height="500"src="./docs/img/contributing.jpg">
+</p>
+
+Here is a outline of the steps needed to make changes to the resonate
+project.
+
+1. Make a local branch in your clone and pull any recent changes into it.
+
+   ```shell
+   git switch -c awesome_branch
+   git pull upstream main
+   ```
+
+2. Make changes and commit to local branch.
+
+   ```shell
+   git add .
+   git commit -m "dead simple"
+   ```
+
+3. Pull any changes that may have been made in the upstream repository
+   main branch.
+
+   ```shell
+   git pull --rebase upstream main # may result in merge conflicts
+   ```
+
+4. Push your branch to the corresponding branch in your fork.
+
+   ```shell
+   git push origin awesome_branch
+   ```
+
+5. Select the branch you are working on in the drop-down menu of branches in
+   your fork. Then hit the `Compare and pull request` button.
+
+6. Once your pull request has been reviewed and approved by a maintainer, select
+   the `Squash and merge` option. Edit the commit message as appropriate for the
+   squashed commit.
+
+7. Delete the branch from `origin`:
+
+   ```
+   git push origin --delete awesome_branch
+   ```
+
+8. Delete the branch from `local`:
+
+   ```
+   git switch main
+   git branch -D awesome_branch
+   ```
+
+## What to contribute to?
+
+Here are some areas where your contributions would be valuable:
+
+- Bug fixes for existing packages.
+- Refactoring efforts to improve code quality.
+- Enhancements to our testing and reliability efforts.
+
+Thank you for your contributions and support in building a better Resonate! 🚀