WIP

package.json

@@ -138,5 +138,12 @@
     "tslib": "^2.6.0",
     "winston": "^3.9.0",
     "zod": "^3.21.4"
-  }
+  },
+  "workspaces": [
+    "packages/tailwind-preset",
+    "packages/typescript-utils",
+    "packages/marble-api",
+    "packages/ui-icons",
+    "packages/ui-design-system"
+  ]
 }

packages/marble-api/.eslintrc.json

@@ -0,0 +1,25 @@
+{
+  "extends": ["../../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["src/lib/generated/marble-api.ts"],
+      "rules": {
+        "@typescript-eslint/ban-types": "off", // oazapfts generate {} instead of Record<string,empy>
+        "@typescript-eslint/no-explicit-any": "error" // you should change OAS spec to generate non any types
+      }
+    }
+  ]
+}

packages/marble-api/README.md

@@ -0,0 +1,37 @@
+# api-marble
+
+This library generates Marble API client based on `src/scripts/openapi.yaml`.
+
+## Getting started
+
+The generated code can be found in `src/lib/generated/marble-api.ts`
+
+1. Make sure to have `scripts/openapi.yaml` up to date
+2. Run `npm run generate-api -w marble-api` to generate the client
+3. Review generated code and commit changes
+
+> NB: in case update introduced breaking changes, you may need to resolve TS issues in places the client is used
+
+## Development
+
+### Edit ECMAScript generation process
+
+Change the generation script by editing `scripts/generate.ts`
+
+### Expose some usefull helpers
+
+Change or add files in `src/helpers`
+
+> don't forget to explicitly expose public interface in `src/index.ts`
+
+### Get updated regex to easilly find new operators in backend code
+
+> May be deprcated soon with the new AST based approach
+
+1. Run `npm run operator-regex -w marble-api` to generate the regexp
+2. Copy the regexp
+3. Use the "Find All" VS Code tab from the backend
+
+![regexp-example-backend](./docs/regexp-example.png)
+
+> NB: make sure to check the regexp box in the VS Code UI

packages/marble-api/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "marble-api",
+  "version": "1.0.0",
+  "description": "",
+  "devDependencies": {},
+  "scripts": {
+    "generate-api": "node -r esbuild-register scripts/generate.ts",
+    "operator-regex": "node -r esbuild-register scripts/operator-regexp.ts"
+  },
+  "author": "",
+  "license": "ISC"
+}

packages/marble-api/scripts/config.ts

@@ -0,0 +1,13 @@
+import { type Opts } from 'oazapfts/lib/codegen/index';
+import { join } from 'path';
+
+export const OPENAPI_SPEC = join('scripts', 'openapi.yaml');
+
+export const GENERATED_FOLDER = join('src', 'generated');
+export const GENERATED_API = join(GENERATED_FOLDER, 'marble-api.ts');
+
+export const OPENAPI_OPTIONS: Opts = {
+  optimistic: true,
+  useEnumType: false,
+  unionUndefined: false,
+};

packages/marble-api/scripts/generate.ts

@@ -0,0 +1,38 @@
+import { mkdir, rm, writeFile } from 'fs/promises';
+import { generateSource } from 'oazapfts/lib/codegen/index';
+import ora from 'ora';
+
+import {
+  GENERATED_API,
+  GENERATED_FOLDER,
+  OPENAPI_OPTIONS,
+  OPENAPI_SPEC,
+} from './config';
+
+async function openapiGenerator() {
+  const spinner = ora('Start to generate OpenAPI client...').start();
+  try {
+    const code = await generateSource(OPENAPI_SPEC, OPENAPI_OPTIONS);
+
+    await writeFile(GENERATED_API, code);
+
+    spinner.succeed('Succesfully generated OpenAPI client');
+  } catch (error) {
+    spinner.fail('Failed to generate OpenAPI client');
+    throw error;
+  }
+}
+
+async function main() {
+  try {
+    await rm(GENERATED_FOLDER, { recursive: true, force: true });
+    await mkdir(GENERATED_FOLDER);
+
+    await openapiGenerator();
+  } catch (error) {
+    console.error('\n', error);
+    process.exit(1);
+  }
+}
+
+main();