[DRAFT] Nexus sample

Author: mjameswh

.scripts/copy-shared-files.mjs

@@ -179,7 +179,7 @@ testProjectsNode.value.items = [];
 
 for (const sample of samples) {
   // Don't use require, because it won't work with ESM samples
-  const packageJson = JSON.parse(readFileSync(`../${sample}/package.json`));
+  const packageJson = JSON.parse(readFileSync(`./${sample}/package.json`));
   const hasTestScript = !!packageJson.scripts.test;
 
   if (hasTestScript) {

.scripts/list-of-samples.json

@@ -25,6 +25,7 @@
     "mutex",
     "nestjs-exchange-rates",
     "nextjs-ecommerce-oneclick",
+    "nexus-hello",
     "patching-api",
     "polling",
     "production",

README.md

@@ -112,6 +112,10 @@ and you'll be given the list of sample options.
 - [**Dependency Injection**](./activities-dependency-injection): Share dependencies between activities (for example, when you need to initialize a database connection once and then pass it to multiple activities).
 - [**Worker-Specific Task Queues**](./worker-specific-task-queues): Use a unique task queue per Worker to have certain Activities only run on that specific Worker. For instance for a file processing Workflow, where the first Activity is downloading a file, and subsequent Activities need to operate on that file. (If multiple Workers were on the same queue, subsequent Activities may get run on different machines that don't have the downloaded file.)
 
+#### Nexus APIs
+
+- [**Nexus Hello**](./nexus-hello): Demonstrates how to define a Nexus Service, implement the Operation handlers, and call the Operations from a Workflow.
+
 #### Workflow APIs
 
 - **Timers**:

nexus-hello/.eslintignore

@@ -0,0 +1,3 @@
+node_modules
+lib
+.eslintrc.js

nexus-hello/.eslintrc.js

@@ -0,0 +1,48 @@
+const { builtinModules } = require('module');
+
+const ALLOWED_NODE_BUILTINS = new Set(['assert']);
+
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: './tsconfig.json',
+    tsconfigRootDir: __dirname,
+  },
+  plugins: ['@typescript-eslint', 'deprecation'],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'prettier',
+  ],
+  rules: {
+    // recommended for safety
+    '@typescript-eslint/no-floating-promises': 'error', // forgetting to await Activities and Workflow APIs is bad
+    'deprecation/deprecation': 'warn',
+
+    // code style preference
+    'object-shorthand': ['error', 'always'],
+
+    // relaxed rules, for convenience
+    '@typescript-eslint/no-unused-vars': [
+      'warn',
+      {
+        argsIgnorePattern: '^_',
+        varsIgnorePattern: '^_',
+      },
+    ],
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+  overrides: [
+    {
+      files: ['src/workflows.ts', 'src/workflows-*.ts', 'src/workflows/*.ts'],
+      rules: {
+        'no-restricted-imports': [
+          'error',
+          ...builtinModules.filter((m) => !ALLOWED_NODE_BUILTINS.has(m)).flatMap((m) => [m, `node:${m}`]),
+        ],
+      },
+    },
+  ],
+};

nexus-hello/.gitignore

@@ -0,0 +1,2 @@
+lib
+node_modules

nexus-hello/.npmrc

@@ -0,0 +1 @@
+package-lock=false

nexus-hello/.nvmrc

@@ -0,0 +1 @@
+22

nexus-hello/.post-create

@@ -0,0 +1,18 @@
+To begin development, install the Temporal CLI:
+
+Mac: {cyan brew install temporal}
+Other: Download and extract the latest release from https://github.com/temporalio/cli/releases/latest
+
+Start Temporal Server:
+
+{cyan temporal server start-dev}
+
+Use Node version 18+ (v22.x is recommended):
+
+Mac: {cyan brew install node@22}
+Other: https://nodejs.org/en/download/
+
+Then, in the project directory, using two other shells, run these commands:
+
+{cyan npm run start.watch}
+{cyan npm run workflow}

nexus-hello/.prettierignore

@@ -0,0 +1 @@
+lib