@elixir-cloud/service-registry 2.0.0-alpha.28

package/dist/providers/rest-sr-provider.d.ts

@@ -0,0 +1,30 @@
+import { ServiceRegistryProvider, ExternalService, Service, ServiceType } from "./sr-provider.js";
+/**
+ * Implementation of the ServiceRegistryProvider interface using direct REST API calls
+ * This class combines the functionality of ServiceRegistryAPI and RestServiceRegistryProvider
+ */
+export declare class RestServiceRegistryProvider implements ServiceRegistryProvider {
+    readonly baseUrl: string;
+    constructor(baseUrl: string);
+    /**
+     * Fetch list of services from the registry
+     * @returns Promise resolving to array of services
+     */
+    getServices(): Promise<ExternalService[]>;
+    /**
+     * Fetch a specific service by ID
+     * @param serviceId ID of the service to fetch
+     * @returns Promise resolving to service details
+     */
+    getServiceById(serviceId: string): Promise<ExternalService>;
+    /**
+     * Fetch types of services exposed by the registry
+     * @returns Promise resolving to array of service types
+     */
+    getServiceTypes(): Promise<ServiceType[]>;
+    /**
+     * Fetch information about the registry
+     * @returns Promise resolving to service information
+     */
+    getServiceInfo(): Promise<Service>;
+}

package/dist/providers/rest-sr-provider.js

@@ -0,0 +1,2 @@
+export { RestServiceRegistryProvider } from '../chunks/chunk.L4ERSGP3.js';
+import '../chunks/chunk.WHWUXFA2.js';

package/dist/providers/sr-provider.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Types for the GA4GH Service Registry API based on OpenAPI specification v1.0.0
+ */
+/**
+ * ServiceType interface matching the Service Registry API schema
+ */
+export interface ServiceType {
+    group: string;
+    artifact: string;
+    version: string;
+}
+/**
+ * Organization interface matching the Service Registry API schema
+ */
+export interface Organization {
+    name: string;
+    url: string;
+}
+/**
+ * Service interface matching the Service Registry API schema
+ */
+export interface Service {
+    id: string;
+    name: string;
+    type: ServiceType;
+    description?: string;
+    organization: Organization;
+    contactUrl?: string;
+    documentationUrl?: string;
+    createdAt?: string;
+    updatedAt?: string;
+    environment?: string;
+    version: string;
+}
+/**
+ * ExternalService interface extending Service with a URL
+ */
+export interface ExternalService extends Service {
+    url: string;
+}
+/**
+ * Error interface for API errors
+ */
+export interface Error {
+    status: number;
+    title: string;
+    detail?: string;
+}
+/**
+ * Interface defining the operations required for Service Registry data providers
+ * Implementations could use REST API, GraphQL, or any other data source
+ */
+export interface ServiceRegistryProvider {
+    getServices(): Promise<ExternalService[]>;
+    getServiceById(id: string): Promise<ExternalService>;
+    getServiceTypes(): Promise<ServiceType[]>;
+    getServiceInfo(): Promise<Service>;
+}

package/dist/providers/sr-provider.js

@@ -0,0 +1 @@
+import '../chunks/chunk.P4Y7MKRA.js';

package/dist/react/index.d.ts

@@ -0,0 +1,2 @@
+export { default as ECCClientGa4ghServiceRegistryService } from './service/index.js';
+export { default as ECCClientGa4ghServiceRegistryServices } from './services/index.js';

package/dist/react/index.js

@@ -0,0 +1,9 @@
+export { service_default as ECCClientGa4ghServiceRegistryService } from '../chunks/chunk.5EYXDARO.js';
+export { services_default as ECCClientGa4ghServiceRegistryServices } from '../chunks/chunk.G7EXF7Y5.js';
+import '../chunks/chunk.422CUO5Q.js';
+import '../chunks/chunk.2GTT6OBC.js';
+import '../chunks/chunk.KXF7UXMG.js';
+import '../chunks/chunk.TWJOFBJX.js';
+import '../chunks/chunk.SWMR6FP7.js';
+import '../chunks/chunk.L4ERSGP3.js';
+import '../chunks/chunk.WHWUXFA2.js';

package/dist/react/service/index.d.ts

@@ -0,0 +1,18 @@
+import { ECCClientGa4ghServiceRegistryService as Component } from "../../components/service/service.js";
+import type { EventName } from "@lit/react";
+import type { EccServiceChangedEvent } from "../../events/index.js";
+export type { EccServiceChangedEvent } from "../../events/index.js";
+/**
+ * @summary This component is used to display details for a single service from Service Registry API.
+ * @since 1.0.0
+ *
+ * @property {string} baseUrl - Base URL of the Service Registry instance
+ * @property {string} serviceId - ID of the service to display
+ * @property {ServiceRegistryProvider} provider - Custom data provider (optional, overrides baseUrl)
+ *
+ * @fires ecc-service-changed - Fired when service data changes
+ */
+declare const reactWrapper: import("@lit/react").ReactWebComponent<Component, {
+    onEccServiceChanged: EventName<EccServiceChangedEvent>;
+}>;
+export default reactWrapper;

package/dist/react/service/index.js

@@ -0,0 +1,6 @@
+export { service_default as default } from '../../chunks/chunk.5EYXDARO.js';
+import '../../chunks/chunk.KXF7UXMG.js';
+import '../../chunks/chunk.TWJOFBJX.js';
+import '../../chunks/chunk.SWMR6FP7.js';
+import '../../chunks/chunk.L4ERSGP3.js';
+import '../../chunks/chunk.WHWUXFA2.js';

package/dist/react/services/index.d.ts

@@ -0,0 +1,23 @@
+import { ECCClientGa4ghServiceRegistryServices as Component } from "../../components/services/services.js";
+import type { EventName } from "@lit/react";
+import type { EccServicesChangedEvent } from "../../events/index.js";
+import type { EccServiceSelectedEvent } from "../../events/index.js";
+export type { EccServicesChangedEvent } from "../../events/index.js";
+export type { EccServiceSelectedEvent } from "../../events/index.js";
+/**
+ * @summary This component is used to display data from Service Registry API.
+ * @since 1.0.0
+ *
+ * @property {string} baseUrl - Base URL of the Service Registry instance
+ * @property {boolean} filter - Determines if the service filter field should be rendered
+ * @property {boolean} search - Determines if the search field should be rendered
+ * @property {ServiceRegistryProvider} provider - Custom data provider (optional, overrides baseUrl)
+ *
+ * @fires ecc-services-changed - Fired when services data changes
+ * @fires ecc-service-selected - Fired when a service is clicked
+ */
+declare const reactWrapper: import("@lit/react").ReactWebComponent<Component, {
+    onEccServicesChanged: EventName<EccServicesChangedEvent>;
+    onEccServiceSelected: EventName<EccServiceSelectedEvent>;
+}>;
+export default reactWrapper;

package/dist/react/services/index.js

@@ -0,0 +1,6 @@
+export { services_default as default } from '../../chunks/chunk.G7EXF7Y5.js';
+import '../../chunks/chunk.422CUO5Q.js';
+import '../../chunks/chunk.2GTT6OBC.js';
+import '../../chunks/chunk.SWMR6FP7.js';
+import '../../chunks/chunk.L4ERSGP3.js';
+import '../../chunks/chunk.WHWUXFA2.js';

package/dist/vscode.html-custom-data.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "https://raw.githubusercontent.com/microsoft/vscode-html-languageservice/main/docs/customData.schema.json",
+  "version": 1.1,
+  "tags": [
+    {
+      "name": "ecc-client-ga4gh-service-registry-service",
+      "description": "This component is used to display details for a single service from Service Registry API.\n---\n\n\n### **Events:**\n - **ecc-service-changed** - Fired when service data changes",
+      "attributes": [],
+      "references": [
+        {
+          "name": "Documentation",
+          "url": "https://elixir-cloud-components.vercel.app/design/components/ecc-client-ga4gh-service-registry-service.html"
+        }
+      ]
+    },
+    {
+      "name": "ecc-client-ga4gh-service-registry-services",
+      "description": "This component is used to display data from Service Registry API.\n---\n\n\n### **Events:**\n - **ecc-services-changed** - Fired when services data changes\n- **ecc-service-selected** - Fired when a service is clicked",
+      "attributes": [],
+      "references": [
+        {
+          "name": "Documentation",
+          "url": "https://elixir-cloud-components.vercel.app/design/components/ecc-client-ga4gh-service-registry-services.html"
+        }
+      ]
+    }
+  ]
+}

package/dist/web-types.json

@@ -0,0 +1,105 @@
+{
+  "$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
+  "name": "@elixir-cloud/service-registry",
+  "version": "2.0.0-alpha.28",
+  "description-markup": "markdown",
+  "contributions": {
+    "html": {
+      "elements": [
+        {
+          "name": "ecc-client-ga4gh-service-registry-service",
+          "description": "This component is used to display details for a single service from Service Registry API.\n---\n\n\n### **Events:**\n - **ecc-service-changed** - Fired when service data changes",
+          "doc-url": "",
+          "attributes": [],
+          "events": [
+            {
+              "name": "ecc-service-changed",
+              "type": "CustomEvent",
+              "description": "Fired when service data changes"
+            }
+          ],
+          "js": {
+            "properties": [
+              {
+                "name": "baseUrl",
+                "description": "Base URL of the Service Registry instance",
+                "type": "string"
+              },
+              {
+                "name": "serviceId",
+                "description": "ID of the service to display",
+                "type": "string"
+              },
+              {
+                "name": "provider",
+                "description": "Custom data provider (optional, overrides baseUrl)",
+                "type": "ServiceRegistryProvider"
+              }
+            ],
+            "events": [
+              {
+                "name": "ecc-service-changed",
+                "type": "CustomEvent",
+                "description": "Fired when service data changes"
+              }
+            ]
+          }
+        },
+        {
+          "name": "ecc-client-ga4gh-service-registry-services",
+          "description": "This component is used to display data from Service Registry API.\n---\n\n\n### **Events:**\n - **ecc-services-changed** - Fired when services data changes\n- **ecc-service-selected** - Fired when a service is clicked",
+          "doc-url": "",
+          "attributes": [],
+          "events": [
+            {
+              "name": "ecc-services-changed",
+              "type": "CustomEvent",
+              "description": "Fired when services data changes"
+            },
+            {
+              "name": "ecc-service-selected",
+              "type": "CustomEvent",
+              "description": "Fired when a service is clicked"
+            }
+          ],
+          "js": {
+            "properties": [
+              {
+                "name": "baseUrl",
+                "description": "Base URL of the Service Registry instance",
+                "type": "string"
+              },
+              {
+                "name": "filter",
+                "description": "Determines if the service filter field should be rendered",
+                "type": "boolean"
+              },
+              {
+                "name": "search",
+                "description": "Determines if the search field should be rendered",
+                "type": "boolean"
+              },
+              {
+                "name": "provider",
+                "description": "Custom data provider (optional, overrides baseUrl)",
+                "type": "ServiceRegistryProvider"
+              }
+            ],
+            "events": [
+              {
+                "name": "ecc-services-changed",
+                "type": "CustomEvent",
+                "description": "Fired when services data changes"
+              },
+              {
+                "name": "ecc-service-selected",
+                "type": "CustomEvent",
+                "description": "Fired when a service is clicked"
+              }
+            ]
+          }
+        }
+      ]
+    }
+  }
+}

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "@elixir-cloud/service-registry",
+  "description": "Web Component for interacting with GA4GH Service Registry Standard",
+  "license": "Apache-2.0",
+  "version": "2.0.0-alpha.28",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./custom-elements.json": "./dist/custom-elements.json",
+    "./components/*": "./dist/components/*",
+    "./react": "./dist/react/index.js",
+    "./react/*": "./dist/react/*",
+    "./events": "./dist/events/index.js",
+    "./events/*": "./dist/events/*",
+    "./providers": "./dist/providers/index.js",
+    "./providers/*": "./dist/providers/*"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/elixir-cloud-aai/cloud-components.git"
+  },
+  "customElements": "dist/custom-elements.json",
+  "files": [
+    "dist",
+    "README.md",
+    "package.json",
+    "LICENSE"
+  ],
+  "scripts": {
+    "analyze": "cem analyze --litelement",
+    "build:tailwind": "node ../../scripts/tailwind/index.js",
+    "build": "node ../../scripts/tailwind/index.js && node ../../scripts/build.js -p ecc-client-ga4gh-service-registry-",
+    "dev": "concurrently -r \"node ../../scripts/tailwind/index.js --watch\" \"node ../../scripts/build.js -p ecc-client-ga4gh-service-registry- --watch\" \"wds\"",
+    "clean": "rm -rf dist node_modules custom-elements-manifest.config.js src/output.css src/tailwind.ts",
+    "test": "wtr --coverage",
+    "test:watch": "wtr --watch",
+    "lint": "npx eslint .",
+    "lint:fix": "npm run lint -- --fix",
+    "prepublish": "npm run build"
+  },
+  "dependencies": {
+    "@lit/react": "^1.0.2",
+    "@elixir-cloud/design": "2.0.0-alpha.28",
+    "lit": "^2.8.0"
+  },
+  "devDependencies": {
+    "@custom-elements-manifest/analyzer": "^0.4.17",
+    "@elixir-cloud/eslint-config": "*",
+    "@open-wc/eslint-config": "^9.2.1",
+    "@open-wc/testing": "^3.1.6",
+    "@tailwindcss/cli": "4.1.4",
+    "@typescript-eslint/eslint-plugin": "^5.48.0",
+    "@typescript-eslint/parser": "^5.48.0",
+    "@web/dev-server": "^0.1.34",
+    "@web/dev-server-esbuild": "^0.3.0",
+    "@web/test-runner": "^0.19.0",
+    "commander": "*",
+    "concurrently": "^5.3.0",
+    "custom-element-jet-brains-integration": "*",
+    "custom-element-vs-code-integration": "*",
+    "eslint": "^8.31.0",
+    "eslint-config-prettier": "^8.3.0",
+    "react": "*",
+    "tailwindcss": "^4.1.4",
+    "tslib": "^2.3.1",
+    "tsup": "^7.2.0",
+    "tw-animate-css": "^1.2.6",
+    "typescript": "*"
+  }
+}