Added yeoman template generator to help people get started

Author: daniel-chambers

.github/workflows/generator-hasura-ndc-nodejs-lambda.yaml

@@ -0,0 +1,59 @@
+name: "generator-hasura-ndc-nodejs-lambda npm package"
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - 'main'
+    tags:
+      - v**
+
+defaults:
+  run:
+    working-directory: ./yeoman-generator
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: .nvmrc
+          registry-url: https://registry.npmjs.org
+          cache: npm
+          cache-dependency-path: ./yeoman-generator/package-lock.json
+      - run: npm ci
+      - run: npm run build
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    if: ${{ startsWith(github.ref, 'refs/tags/v') }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: .nvmrc
+          registry-url: https://registry.npmjs.org
+          cache: npm
+          cache-dependency-path: ./yeoman-generator/package-lock.json
+      - run: |
+          PACKAGE_VERSION=`npm version | sed -rn "2 s/.*: '([^']*)'.*/\1/g; 2 p"`
+          TAG=`echo "$GITHUB_REF"| sed -r "s#.*/##g"`
+          echo '$TAG' = "$TAG"
+          echo '$GITHUB_REF' = "$GITHUB_REF"
+          echo '$PACKAGE_VERSION' = "$PACKAGE_VERSION"
+          if [ "$TAG" = "v$PACKAGE_VERSION" ]
+          then
+            echo "Success! Versions match."
+          else
+            echo "Package version (v$PACKAGE_VERSION) must match tag (GITHUB_REF: $GITHUB_REF) in order to publish" 1>&2
+            exit 1
+          fi
+      - run: npm ci
+      - run: npm run build
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

@@ -3,33 +3,14 @@
 The NodeJS Lambda connector allows you to expose TypeScript functions as NDC functions/procedures for use in your Hasura DDN subgraphs.
 
 # How to Use
-First create a `functions.ts` that contains your functions, for example:
-```typescript
-/**
- * @pure Exposes the function as an NDC function (the function should only query data without making modifications)
- */
-export function hello(name?: string) {
-  return `hello ${name ?? "world"}`;
-}
-```
-Then add a `configuration.json` file that simply contains an empty configuration object:
-```json
-{}
-```
+First, ensure you have NodeJS v18+ installed. Then, create a directory into which you will create your functions using the `hasura-ndc-nodejs-lambda` Yeoman template.
 
-Now add a `package.json` file that depends on the `ndc-lambda-sdk` like so:
-```json
-{
-  "private": true,
-  "scripts": {
-    "start": "ndc-lambda-sdk host -f functions.ts serve --configuration configuration.json",
-    "watch": "ndc-lambda-sdk host -f functions.ts --watch serve --configuration configuration.json"
-  },
-  "dependencies": {
-    "@hasura/ndc-lambda-sdk": "0.2.0"
-  }
-}
+```bash
+mkdir my-functions
+cd my-functions
+npx yo hasura-ndc-nodejs-lambda
 ```
-Now run `npm install` to install all the packages.
 
-Notice the `start` and `watch` scripts in the `package.config`. These use the SDK to host your `functions.ts` file. You can start your connector with `npm start`, or if you'd like it to automatically restart as you change your code, use `npm run watch`.
+This creates a `functions.ts` file in which you will write your functions, and a `package.json` with the `ndc-lambda-sdk` installed into it.
+
+The `package.config` has been created with `start` and `watch` scripts. These use the SDK to host your `functions.ts` file. You can start your connector with `npm start`, or if you'd like it to automatically restart as you change your code, use `npm run watch`.

yeoman-generator/.gitignore

@@ -0,0 +1 @@
+generators/