feat: metadata package scaffold (#52)

packages/metadata/package.json

@@ -0,0 +1,29 @@
+{
+    "name": "@zkchainhub/metadata",
+    "version": "1.0.0",
+    "main": "./dist/src/index.js",
+    "typings": "./dist/src/index.d.ts",
+    "type": "module",
+    "directories": {
+        "src": "src"
+    },
+    "files": [
+        "dist/*",
+        "package.json",
+        "!**/*.tsbuildinfo"
+    ],
+    "scripts": {
+        "build": "tsc -p tsconfig.build.json",
+        "check-types": "tsc --noEmit -p ./tsconfig.json",
+        "clean": "rm -rf dist",
+        "lint": "eslint \"{src,test}/**/*.{js,ts,json}\"",
+        "lint:fix": "pnpm lint --fix",
+        "format": "prettier --check \"{src,test}/**/*.{js,ts,json}\"",
+        "format:fix": "prettier --write \"{src,test}/**/*.{js,ts,json}\"",
+        "test": "vitest run --config vitest.config.ts --passWithNoTests",
+        "test:cov": "vitest run --config vitest.config.ts --coverage"
+    },
+    "dependencies": {
+        "@zkchainhub/shared": "workspace:*"
+    }
+}

packages/metadata/src/external.ts

@@ -0,0 +1,3 @@
+export type { IMetadataService } from "./internal.js";
+
+export { StaticMetadataService, GithubMetadataService } from "./internal.js";

packages/metadata/src/index.ts

@@ -0,0 +1 @@
+export * from "./external.js";

packages/metadata/src/interfaces/index.ts

@@ -0,0 +1 @@
+export * from "./metadata.interface.js";

packages/metadata/src/interfaces/metadata.interface.ts

@@ -0,0 +1,6 @@
+import { Token, TokenType, ZKChainMetadata } from "@zkchainhub/shared";
+
+export interface IMetadataService {
+    getChainsMetadata(): Promise<ZKChainMetadata>;
+    getTokensMetadata(): Promise<Token<TokenType>[]>;
+}

packages/metadata/src/internal.ts

@@ -0,0 +1,2 @@
+export * from "./interfaces/index.js";
+export * from "./services/index.js";

packages/metadata/src/services/githubMetadata.service.ts

@@ -0,0 +1,15 @@
+import { Token, TokenType, ZKChainMetadata } from "@zkchainhub/shared";
+
+import { IMetadataService } from "../interfaces/index.js";
+
+export class GithubMetadataService implements IMetadataService {
+    async getChainsMetadata(): Promise<ZKChainMetadata> {
+        //TODO: Implement this method
+        throw new Error("Method not implemented.");
+    }
+
+    async getTokensMetadata(): Promise<Token<TokenType>[]> {
+        //TODO: Implement this method
+        throw new Error("Method not implemented.");
+    }
+}

packages/metadata/src/services/index.ts

@@ -0,0 +1,2 @@
+export * from "./githubMetadata.service.js";
+export * from "./staticMetadata.service.js";

packages/metadata/src/services/staticMetadata.service.ts

@@ -0,0 +1,12 @@
+import { Token, tokens, TokenType, ZKChainMetadata, zkChainsMetadata } from "@zkchainhub/shared";
+
+import { IMetadataService } from "../interfaces/index.js";
+
+export class StaticMetadataService implements IMetadataService {
+    async getChainsMetadata(): Promise<ZKChainMetadata> {
+        return structuredClone(zkChainsMetadata);
+    }
+    async getTokensMetadata(): Promise<Token<TokenType>[]> {
+        return Array.from(tokens);
+    }
+}

packages/metadata/test/unit/services/githubMetadata.service.spec.ts

@@ -0,0 +1,11 @@
+import { describe, it } from "vitest";
+
+describe("GithubMetadataService", () => {
+    describe("getChainsMetadata", () => {
+        it.skip("returns the ZKChainMetadata");
+    });
+
+    describe("getTokensMetadata", () => {
+        it.skip("return an array of Token objects");
+    });
+});

packages/metadata/test/unit/services/staticMetadata.service.spec.ts

@@ -0,0 +1,30 @@
+import { beforeEach, describe, expect, expectTypeOf, it } from "vitest";
+
+import { Token, TokenType, ZKChainMetadata } from "@zkchainhub/shared";
+
+import { StaticMetadataService } from "../../../src/internal.js";
+
+describe("StaticMetadataService", () => {
+    let metadataService: StaticMetadataService;
+
+    beforeEach(() => {
+        metadataService = new StaticMetadataService();
+    });
+
+    describe("getChainsMetadata", () => {
+        it("should return the ZKChainMetadata", async () => {
+            const result = await metadataService.getChainsMetadata();
+            expect(result).toBeDefined();
+            expectTypeOf(result).toEqualTypeOf<ZKChainMetadata>();
+        });
+    });
+
+    describe("getTokensMetadata", () => {
+        it("should return an array of Token objects", async () => {
+            const result = await metadataService.getTokensMetadata();
+            expect(result).toBeDefined();
+            expect(Array.isArray(result)).toBe(true);
+            expectTypeOf(result).toEqualTypeOf<Token<TokenType>[]>();
+        });
+    });
+});

packages/metadata/tsconfig.build.json

@@ -0,0 +1,11 @@
+{
+    "extends": "../../tsconfig.build.json",
+    "compilerOptions": {
+        "composite": true,
+        "declarationMap": true,
+        "declaration": true,
+        "outDir": "dist"
+    },
+    "include": ["src/**/*"],
+    "exclude": ["node_modules", "dist", "test"]
+}

packages/metadata/tsconfig.json

@@ -0,0 +1,4 @@
+{
+    "extends": "../../tsconfig.json",
+    "include": ["src/**/*"]
+}

packages/metadata/vitest.config.ts

@@ -0,0 +1,22 @@
+import path from "path";
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+    test: {
+        globals: true, // Use Vitest's global API without importing it in each file
+        environment: "node", // Use the Node.js environment
+        include: ["test/**/*.spec.ts"], // Include test files
+        exclude: ["node_modules", "dist"], // Exclude certain directories
+        coverage: {
+            provider: "v8",
+            reporter: ["text", "json", "html"], // Coverage reporters
+            exclude: ["node_modules", "dist"], // Files to exclude from coverage
+        },
+    },
+    resolve: {
+        alias: {
+            // Setup path alias based on tsconfig paths
+            "@": path.resolve(__dirname, "src"),
+        },
+    },
+});