Modular core type (#2462)

* generic network module types * export alias * common changelog * Update packages/types-core/src/project/modulars/types.ts Co-authored-by: Scott Twiname <[email protected]> * fix ds type * apply export type check --------- Co-authored-by: Scott Twiname <[email protected]>
subquery · Jun 23, 2024 · 3c4dd4b · 3c4dd4b
1 parent 9af0971
commit 3c4dd4b
Show file tree

Hide file tree

Showing 7 changed files with 38 additions and 0 deletions.
diff --git a/packages/common-substrate/CHANGELOG.md b/packages/common-substrate/CHANGELOG.md
@@ -6,6 +6,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+- Add alias `parseProjectManifest`, also follow type of `INetworkCommonModule` (#2462)
+
 ## [3.8.1] - 2024-06-21
 ### Fixed
 - Fix `EventFilter` incorrectly extend `BlockFilter`, lead dictionary error (#2463)

diff --git a/packages/common-substrate/src/index.ts b/packages/common-substrate/src/index.ts
@@ -2,3 +2,13 @@
 // SPDX-License-Identifier: GPL-3.0
 
 export * from './project';
+
+import {SubstrateCustomDatasource, SubstrateDatasource, SubstrateRuntimeDatasource} from '@subql/types';
+import {INetworkCommonModule} from '@subql/types-core';
+import * as p from './project';
+
+// This provides a compiled time check to ensure that the correct exports are provided
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+const _ = {
+  ...p,
+} satisfies INetworkCommonModule<SubstrateDatasource, SubstrateRuntimeDatasource, SubstrateCustomDatasource>;
diff --git a/packages/common-substrate/src/project/index.ts b/packages/common-substrate/src/project/index.ts
@@ -6,3 +6,6 @@ export * from './models';
 export * from './types';
 export * from './utils';
 export * from './versioned';
+
+import {parseSubstrateProjectManifest} from './load';
+export {parseSubstrateProjectManifest as parseProjectManifest};
diff --git a/packages/types-core/CHANGELOG.md b/packages/types-core/CHANGELOG.md
@@ -6,6 +6,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+- Add generic network module types (#2462)
+
 ## [0.8.0] - 2024-06-21
 ### Changed
 - Reader interface not returning undefined

diff --git a/packages/types-core/src/project/index.ts b/packages/types-core/src/project/index.ts
@@ -5,3 +5,4 @@ export * from './types';
 export * from './versioned';
 export * from './readers';
 export * from './datasourceProcessors';
+export * from './modulars';
diff --git a/packages/types-core/src/project/modulars/index.ts b/packages/types-core/src/project/modulars/index.ts
@@ -0,0 +1,4 @@
+// Copyright 2020-2024 SubQuery Pte Ltd authors & contributors
+// SPDX-License-Identifier: GPL-3.0
+
+export * from './types';
diff --git a/packages/types-core/src/project/modulars/types.ts b/packages/types-core/src/project/modulars/types.ts
@@ -0,0 +1,14 @@
+// Copyright 2020-2024 SubQuery Pte Ltd authors & contributors
+// SPDX-License-Identifier: GPL-3.0
+
+import {BaseCustomDataSource, BaseDataSource, IProjectManifest} from '../index';
+
+export interface INetworkCommonModule<
+  D extends BaseCustomDataSource | BaseDataSource = BaseDataSource,
+  RDS extends D = D,
+  CDS extends D = D,
+> {
+  parseProjectManifest(raw: unknown): IProjectManifest<D>;
+  isRuntimeDs(ds: D): ds is RDS;
+  isCustomDs(ds: D): ds is CDS;
+}