feat: complete mock API layer implementation

.changeset/mock-api-layer.md

@@ -0,0 +1,13 @@
+---
+"@elixir-cloud/cloud-registry": minor
+"@elixir-cloud/design": minor
+"@elixir-cloud/drs": minor
+"@elixir-cloud/drs-filer": minor
+"@elixir-cloud/service-registry": minor
+"@elixir-cloud/tes": minor
+"@elixir-cloud/trs": minor
+"@elixir-cloud/trs-filer": minor
+"@elixir-cloud/wes": minor
+---
+
+feat: complete mock API layer implementation

.gitignore

@@ -36,4 +36,6 @@ yarn-error.log*
 # vercel
 .vercel
 
-.idea
+.idea
+
+apps/documentation/public/mocks

apps/documentation/pages/docs/_meta.json

@@ -2,6 +2,7 @@
   "introduction": "Introduction",
   "installation": "Installation",
   "customization": "Customization",
+  "mocking": "Mock APIs",
   "providers": "Providers",
   "-- Supported Services": {
     "type": "separator",

apps/documentation/pages/docs/mocking.mdx

@@ -0,0 +1,32 @@
+# Mock APIs
+
+ELIXIR Cloud Components provides a built-in mock API layer to allow reliable testing, offline development, and demonstration without relying on live services.
+
+Our documentation and demo pages are configured to use these mock responses to ensure consistent behavior.
+
+## Enabling Mock APIs
+
+The mock API layer is controlled via environment variables. By default, components will attempt to use live API routes provided via the `baseUrl` property. If you want to intercept these requests and serve mock data instead, set the appropriate environment variable:
+
+- **For Vite / standard web environments:** `VITE_USE_MOCK_API=true`
+- **For Next.js environments:** `NEXT_PUBLIC_USE_MOCK_API=true`
+
+Once enabled, API calls (e.g., fetching a GA4GH WES run or an ELIXIR Service Registry listing) will automatically be intercepted and resolved using local JSON files.
+
+## How it works
+
+The components use a centralized `fetcher` utility from `@elixir-cloud/design` under the hood. When the mock environment variable is detected, `fetcher` substitutes the HTTP request with a local fetch to the `/mocks/` directory.
+
+> **Note:** If a mock file doesn't exist for a particular endpoint, the library will gracefully fall back to the live API to ensure development isn't blocked.
+
+## Writing or Updating Mocks
+
+Mock files are standard JSON files stored in the `mocks/` directory at the root of the repository. When setting up a new application or documentation site, ensure that this folder is publicly served (e.g., via a symlink to `public/mocks/` in Next.js).
+
+If you want to modify a mock response, simply edit the corresponding JSON file. For example, to change the mocked response of a specific TRS tool, you would modify:
+
+```text
+/mocks/ga4gh-trs/tools/id.json
+```
+
+No rebuild of the components is necessary when updating mock JSON files—they are resolved at runtime by the browser. 

apps/ssr-test/next-env.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+import "./.next/types/routes.d.ts";
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/app/api-reference/config/typescript for more information.

mocks/elixir-cloud-registry/service-info-post.json

@@ -0,0 +1 @@
+{}

mocks/elixir-cloud-registry/service-info.json

@@ -0,0 +1,14 @@
+{
+    "id": "mock-registry-info-001",
+    "name": "Mock ELIXIR Registry Info",
+    "type": {
+        "group": "org.elixir",
+        "artifact": "registry-info",
+        "version": "1.0.0"
+    },
+    "organization": {
+        "name": "ELIXIR Mock",
+        "url": "https://example.com"
+    },
+    "version": "1.0.0"
+}

mocks/elixir-cloud-registry/services/delete.json

@@ -0,0 +1,3 @@
+{
+    "id": "mock-elixir-cr-deleted"
+}

mocks/elixir-cloud-registry/services/get.json

@@ -0,0 +1,17 @@
+[
+    {
+        "id": "mock-elixir-cr-001",
+        "name": "Mock ELIXIR Cloud Registry Service",
+        "type": {
+            "group": "org.elixir",
+            "artifact": "cloud-registry",
+            "version": "1.0.0"
+        },
+        "organization": {
+            "name": "ELIXIR Mock",
+            "url": "https://example.com"
+        },
+        "version": "1.0.0",
+        "url": "https://example.com/cr/v1"
+    }
+]

mocks/elixir-cloud-registry/services/id.json

@@ -0,0 +1,15 @@
+{
+    "id": "mock-elixir-cr-001",
+    "name": "Mock ELIXIR Cloud Registry Service",
+    "type": {
+        "group": "org.elixir",
+        "artifact": "cloud-registry",
+        "version": "1.0.0"
+    },
+    "organization": {
+        "name": "ELIXIR Mock",
+        "url": "https://example.com"
+    },
+    "version": "1.0.0",
+    "url": "https://example.com/cr/v1"
+}

mocks/elixir-cloud-registry/services/post.json

@@ -0,0 +1,3 @@
+{
+    "id": "mock-elixir-cr-new-post"
+}

mocks/elixir-cloud-registry/services/put.json

@@ -0,0 +1,3 @@
+{
+    "id": "mock-elixir-cr-put"
+}

mocks/elixir-cloud-registry/services/types.json

@@ -0,0 +1,7 @@
+[
+    {
+        "group": "org.elixir",
+        "artifact": "cloud-registry",
+        "version": "1.0.0"
+    }
+]

mocks/elixir-drs-filer/objects/access.json

@@ -0,0 +1,4 @@
+{
+    "url": "https://example.com/mock-drs-file.txt",
+    "headers": []
+}

mocks/elixir-drs-filer/objects/access/delete.json

@@ -0,0 +1 @@
+{}

mocks/elixir-drs-filer/objects/delete.json

@@ -0,0 +1 @@
+{}

mocks/elixir-drs-filer/objects/get.json

@@ -0,0 +1,24 @@
+{
+    "objects": [
+        {
+            "id": "mock-drs-001",
+            "name": "Mock DRS Object 1",
+            "size": 1024,
+            "created_time": "2023-01-01T00:00:00Z",
+            "updated_time": "2023-01-01T00:00:00Z",
+            "version": "1.0",
+            "mime_type": "text/plain",
+            "checksums": [
+                {
+                    "type": "md5",
+                    "checksum": "d41d8cd98f00b204e9800998ecf8427e"
+                }
+            ]
+        }
+    ],
+    "pagination": {
+        "offset": 0,
+        "limit": 10,
+        "total": 1
+    }
+}

mocks/elixir-drs-filer/objects/id.json

@@ -0,0 +1,22 @@
+{
+    "id": "mock-drs-001",
+    "name": "Mock DRS Object 1",
+    "size": 1024,
+    "created_time": "2023-01-01T00:00:00Z",
+    "updated_time": "2023-01-01T00:00:00Z",
+    "version": "1.0",
+    "mime_type": "text/plain",
+    "checksums": [
+        {
+            "type": "md5",
+            "checksum": "d41d8cd98f00b204e9800998ecf8427e"
+        }
+    ],
+    "access_methods": [
+        {
+            "access_id": "access-001",
+            "type": "s3",
+            "region": "us-east-1"
+        }
+    ]
+}

mocks/elixir-drs-filer/objects/post.json

@@ -0,0 +1,3 @@
+{
+    "id": "mock-drs-newly-created"
+}

mocks/elixir-drs-filer/objects/put.json

@@ -0,0 +1,3 @@
+{
+    "id": "mock-drs-updated"
+}

mocks/elixir-drs-filer/service-info-post.json

@@ -0,0 +1 @@
+{}

mocks/elixir-drs-filer/service-info.json

@@ -0,0 +1,14 @@
+{
+    "id": "mock-drs-service",
+    "name": "Mock DRS Service",
+    "type": {
+        "group": "org.ga4gh",
+        "artifact": "drs",
+        "version": "1.1.0"
+    },
+    "organization": {
+        "name": "Mock Org",
+        "url": "https://example.com"
+    },
+    "version": "1.1.0"
+}

mocks/elixir-trs-filer/toolClasses/get.json

@@ -0,0 +1 @@
+[{"id": "mock-class", "name": "Mock Class", "description": "Mock class description"}]

mocks/elixir-trs-filer/toolClasses/post.json

@@ -0,0 +1 @@
+{"id": "mock-toolclass-post"}

mocks/elixir-trs-filer/toolClasses/put.json

@@ -0,0 +1 @@
+{"id": "mock-toolclass-put"}

mocks/elixir-trs-filer/tools/containerfile.json

@@ -0,0 +1 @@
+[{"content": "FROM ubuntu:latest\nRUN echo mock", "url": "https://example.com/containerfile"}]

mocks/elixir-trs-filer/tools/descriptor-path.json

@@ -0,0 +1 @@
+{"content": "mock descriptor by path", "url": "https://example.com/descriptor"}

mocks/elixir-trs-filer/tools/descriptor.json

@@ -0,0 +1 @@
+{"content": "mock descriptor content", "url": "https://example.com/descriptor"}

mocks/elixir-trs-filer/tools/files.json

@@ -0,0 +1 @@
+[{"path": "/mock/file.txt", "file_type": "TEST_FILE"}]

mocks/elixir-trs-filer/tools/get.json

@@ -0,0 +1 @@
+[{"id": "mock-tool-001", "name": "Mock Tool", "organization": "Mock Org"}]

mocks/elixir-trs-filer/tools/id.json

@@ -0,0 +1 @@
+{"id": "mock-tool-001", "name": "Mock Tool", "organization": "Mock Org", "description": "A mocked tool"}

mocks/elixir-trs-filer/tools/post.json

@@ -0,0 +1 @@
+{"id": "mock-tool-new-post"}

mocks/elixir-trs-filer/tools/put.json

@@ -0,0 +1 @@
+{"id": "mock-tool-put-updated"}

mocks/elixir-trs-filer/tools/tests.json

@@ -0,0 +1 @@
+[{"content": "mock test content", "url": "https://example.com/test"}]

mocks/elixir-trs-filer/tools/version-id.json

@@ -0,0 +1 @@
+{"id": "v1", "name": "Version 1.0", "author": ["Mock Author"], "is_production": true}

mocks/elixir-trs-filer/tools/versions-post.json

@@ -0,0 +1 @@
+{"id": "mock-version-post"}

mocks/elixir-trs-filer/tools/versions-put.json

@@ -0,0 +1 @@
+{"id": "mock-version-put"}

mocks/elixir-trs-filer/tools/versions.json

@@ -0,0 +1 @@
+[{"id": "v1", "name": "Version 1.0", "author": ["Mock Author"]}]

mocks/ga4gh-drs/objects/access.json

@@ -0,0 +1,4 @@
+{
+  "url": "https://example.com/mock-drs-file.txt",
+  "headers": []
+}

mocks/ga4gh-drs/objects/get.json

@@ -0,0 +1,24 @@
+{
+  "objects": [
+    {
+      "id": "mock-drs-001",
+      "name": "Mock DRS Object 1",
+      "size": 1024,
+      "created_time": "2023-01-01T00:00:00Z",
+      "updated_time": "2023-01-01T00:00:00Z",
+      "version": "1.0",
+      "mime_type": "text/plain",
+      "checksums": [
+        {
+          "type": "md5",
+          "checksum": "d41d8cd98f00b204e9800998ecf8427e"
+        }
+      ]
+    }
+  ],
+  "pagination": {
+    "offset": 0,
+    "limit": 10,
+    "total": 1
+  }
+}

mocks/ga4gh-drs/objects/id.json

@@ -0,0 +1,22 @@
+{
+  "id": "mock-drs-001",
+  "name": "Mock DRS Object 1",
+  "size": 1024,
+  "created_time": "2023-01-01T00:00:00Z",
+  "updated_time": "2023-01-01T00:00:00Z",
+  "version": "1.0",
+  "mime_type": "text/plain",
+  "checksums": [
+    {
+      "type": "md5",
+      "checksum": "d41d8cd98f00b204e9800998ecf8427e"
+    }
+  ],
+  "access_methods": [
+    {
+      "access_id": "access-001",
+      "type": "s3",
+      "region": "us-east-1"
+    }
+  ]
+}

mocks/ga4gh-drs/service-info.json

@@ -0,0 +1,14 @@
+{
+  "id": "mock-ga4gh-drs-service",
+  "name": "Mock GA4GH DRS Service",
+  "type": {
+    "group": "org.ga4gh",
+    "artifact": "drs",
+    "version": "1.1.0"
+  },
+  "organization": {
+    "name": "Mock Org",
+    "url": "https://example.com"
+  },
+  "version": "1.1.0"
+}

mocks/ga4gh-service-registry/service-info.json

@@ -0,0 +1,14 @@
+{
+    "id": "mock-registry-001",
+    "name": "Mock Service Registry",
+    "type": {
+        "group": "org.ga4gh",
+        "artifact": "service-registry",
+        "version": "1.0.0"
+    },
+    "organization": {
+        "name": "ELIXIR Mock",
+        "url": "https://example.com"
+    },
+    "version": "1.0.0"
+}

mocks/ga4gh-service-registry/services/get.json

@@ -0,0 +1,17 @@
+[
+    {
+        "id": "mock-service-001",
+        "name": "Mock Service 1",
+        "type": {
+            "group": "org.ga4gh",
+            "artifact": "tes",
+            "version": "1.0.0"
+        },
+        "organization": {
+            "name": "ELIXIR Mock",
+            "url": "https://example.com"
+        },
+        "version": "1.0.0",
+        "url": "https://example.com/tes/v1"
+    }
+]