feat/incremental document sync

docs/api/classes/modules_did_didSyncStatus_entity.DidSyncStatusEntity.md

@@ -0,0 +1,46 @@
+# Class: DidSyncStatusEntity
+
+[modules/did/didSyncStatus.entity](../modules/modules_did_didSyncStatus_entity.md).DidSyncStatusEntity
+
+## Table of contents
+
+### Constructors
+
+- [constructor](modules_did_didSyncStatus_entity.DidSyncStatusEntity.md#constructor)
+
+### Properties
+
+- [createdDate](modules_did_didSyncStatus_entity.DidSyncStatusEntity.md#createddate)
+- [document](modules_did_didSyncStatus_entity.DidSyncStatusEntity.md#document)
+- [id](modules_did_didSyncStatus_entity.DidSyncStatusEntity.md#id)
+- [status](modules_did_didSyncStatus_entity.DidSyncStatusEntity.md#status)
+
+## Constructors
+
+### constructor
+
+• **new DidSyncStatusEntity**()
+
+## Properties
+
+### createdDate
+
+• **createdDate**: `Date`
+
+___
+
+### document
+
+• **document**: [`DIDDocumentEntity`](modules_did_did_entity.DIDDocumentEntity.md)
+
+___
+
+### id
+
+• **id**: `number`
+
+___
+
+### status
+
+• **status**: [`DidSyncStatus`](../enums/modules_did_did_types.DidSyncStatus.md)

docs/api/classes/modules_did_did_processor.DIDProcessor.md

@@ -37,13 +37,13 @@
 
 ### OnQueueWaiting
 
-▸ **OnQueueWaiting**(`job`): `Promise`<`void`\>
+▸ **OnQueueWaiting**(`jobId`): `Promise`<`void`\>
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `job` | `Job`<`any`\> |
+| `jobId` | `number` |
 
 #### Returns
 
@@ -59,7 +59,7 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `job` | `Job`<`any`\> |
+| `job` | `Job`<[`UpdateDocumentJobData`](../modules/modules_did_did_types.md#updatedocumentjobdata)\> |
 
 #### Returns
 
@@ -91,7 +91,7 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `job` | `Job`<`any`\> |
+| `job` | `Job`<[`UpdateDocumentJobData`](../modules/modules_did_did_types.md#updatedocumentjobdata)\> |
 
 #### Returns
 
@@ -107,7 +107,7 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `job` | `Job`<`any`\> |
+| `job` | `Job`<[`UpdateDocumentJobData`](../modules/modules_did_did_types.md#updatedocumentjobdata)\> |
 
 #### Returns
 
@@ -123,7 +123,7 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `job` | `Job`<`string`\> |
+| `job` | `Job`<[`UpdateDocumentJobData`](../modules/modules_did_did_types.md#updatedocumentjobdata)\> |
 
 #### Returns
 
@@ -139,7 +139,7 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `job` | `Job`<`string`\> |
+| `job` | `Job`<[`UpdateDocumentJobData`](../modules/modules_did_did_types.md#updatedocumentjobdata)\> |
 
 #### Returns
 

docs/api/classes/modules_did_did_service.DIDService.md

@@ -28,7 +28,7 @@
 
 ### constructor
 
-• **new DIDService**(`config`, `schedulerRegistry`, `httpService`, `didQueue`, `logger`, `didRepository`, `provider`, `sentryTracingService`, `registrySettings`, `ipfsService`)
+• **new DIDService**(`config`, `schedulerRegistry`, `httpService`, `didQueue`, `logger`, `didRepository`, `provider`, `sentryTracingService`, `registrySettings`, `ipfsService`, `latestDidSyncRepository`, `didSyncStatusRepository`, `dataSource`)
 
 #### Parameters
 
@@ -37,13 +37,16 @@
 | `config` | `ConfigService`<`Record`<`string`, `unknown`\>, ``false``\> |
 | `schedulerRegistry` | `SchedulerRegistry` |
 | `httpService` | `HttpService` |
-| `didQueue` | `Queue`<`string`\> |
+| `didQueue` | `Queue`<[`UpdateDocumentJobData`](../modules/modules_did_did_types.md#updatedocumentjobdata)\> |
 | `logger` | [`Logger`](modules_logger_logger_service.Logger.md) |
 | `didRepository` | `Repository`<[`DIDDocumentEntity`](modules_did_did_entity.DIDDocumentEntity.md)\> |
 | `provider` | [`Provider`](common_provider.Provider.md) |
 | `sentryTracingService` | [`SentryTracingService`](modules_sentry_sentry_tracing_service.SentryTracingService.md) |
 | `registrySettings` | `RegistrySettings` |
 | `ipfsService` | [`IPFSService`](modules_ipfs_ipfs_service.IPFSService.md) |
+| `latestDidSyncRepository` | `Repository`<[`LatestDidSync`](modules_did_latestDidSync_entity.LatestDidSync.md)\> |
+| `didSyncStatusRepository` | `Repository`<[`DidSyncStatusEntity`](modules_did_didSyncStatus_entity.DidSyncStatusEntity.md)\> |
+| `dataSource` | `DataSource` |
 
 ## Methods
 

docs/api/classes/modules_did_latestDidSync_entity.LatestDidSync.md

@@ -0,0 +1,32 @@
+# Class: LatestDidSync
+
+[modules/did/latestDidSync.entity](../modules/modules_did_latestDidSync_entity.md).LatestDidSync
+
+## Table of contents
+
+### Constructors
+
+- [constructor](modules_did_latestDidSync_entity.LatestDidSync.md#constructor)
+
+### Properties
+
+- [block](modules_did_latestDidSync_entity.LatestDidSync.md#block)
+- [createdDate](modules_did_latestDidSync_entity.LatestDidSync.md#createddate)
+
+## Constructors
+
+### constructor
+
+• **new LatestDidSync**()
+
+## Properties
+
+### block
+
+• **block**: `number`
+
+___
+
+### createdDate
+
+• **createdDate**: `Date`

docs/api/classes/modules_ipfs_pin_processor.PinProcessor.md

@@ -34,13 +34,13 @@
 
 ### OnQueueWaiting
 
-▸ **OnQueueWaiting**(`job`): `Promise`<`void`\>
+▸ **OnQueueWaiting**(`jobId`): `Promise`<`void`\>
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `job` | `Job`<`any`\> |
+| `jobId` | `number` |
 
 #### Returns
 
@@ -72,7 +72,7 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `job` | `Job`<`any`\> |
+| `job` | `Job`<[`PinClaimData`](../modules/modules_ipfs_ipfs_types.md#pinclaimdata)\> |
 | `err` | `Error` |
 
 #### Returns
@@ -89,7 +89,7 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `job` | `Job`<`any`\> |
+| `job` | `Job`<[`PinClaimData`](../modules/modules_ipfs_ipfs_types.md#pinclaimdata)\> |
 
 #### Returns
 

docs/api/enums/modules_did_did_types.DidSyncStatus.md

@@ -0,0 +1,22 @@
+# Enumeration: DidSyncStatus
+
+[modules/did/did.types](../modules/modules_did_did_types.md).DidSyncStatus
+
+## Table of contents
+
+### Enumeration Members
+
+- [Stale](modules_did_did_types.DidSyncStatus.md#stale)
+- [Synced](modules_did_did_types.DidSyncStatus.md#synced)
+
+## Enumeration Members
+
+### Stale
+
+• **Stale** = ``1``
+
+___
+
+### Synced
+
+• **Synced** = ``0``

docs/api/modules.md

@@ -91,6 +91,8 @@
 - [modules/did/did.resolver](modules/modules_did_did_resolver.md)
 - [modules/did/did.service](modules/modules_did_did_service.md)
 - [modules/did/did.types](modules/modules_did_did_types.md)
+- [modules/did/didSyncStatus.entity](modules/modules_did_didSyncStatus_entity.md)
+- [modules/did/latestDidSync.entity](modules/modules_did_latestDidSync_entity.md)
 - [modules/ens/ens.module](modules/modules_ens_ens_module.md)
 - [modules/ens/ens.service](modules/modules_ens_ens_service.md)
 - [modules/interceptors/interceptors.module](modules/modules_interceptors_interceptors_module.md)

docs/api/modules/modules_did_didSyncStatus_entity.md

@@ -0,0 +1,7 @@
+# Module: modules/did/didSyncStatus.entity
+
+## Table of contents
+
+### Classes
+
+- [DidSyncStatusEntity](../classes/modules_did_didSyncStatus_entity.DidSyncStatusEntity.md)

docs/api/modules/modules_did_did_types.md

@@ -2,10 +2,18 @@
 
 ## Table of contents
 
+### Enumerations
+
+- [DidSyncStatus](../enums/modules_did_did_types.DidSyncStatus.md)
+
 ### Classes
 
 - [DID](../classes/modules_did_did_types.DID.md)
 
+### Type Aliases
+
+- [UpdateDocumentJobData](modules_did_did_types.md#updatedocumentjobdata)
+
 ### Variables
 
 - [ADD\_DID\_DOC\_JOB\_NAME](modules_did_did_types.md#add_did_doc_job_name)
@@ -17,6 +25,18 @@
 
 - [getDIDFromAddress](modules_did_did_types.md#getdidfromaddress)
 
+## Type Aliases
+
+### UpdateDocumentJobData
+
+Ƭ **UpdateDocumentJobData**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `did` | `string` |
+
 ## Variables
 
 ### ADD\_DID\_DOC\_JOB\_NAME

docs/api/modules/modules_did_latestDidSync_entity.md

@@ -0,0 +1,7 @@
+# Module: modules/did/latestDidSync.entity
+
+## Table of contents
+
+### Classes
+
+- [LatestDidSync](../classes/modules_did_latestDidSync_entity.LatestDidSync.md)

src/migrations/1730905681141-LatestDidSync.ts

@@ -0,0 +1,15 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class LatestDidSync1730905681141 implements MigrationInterface {
+  name = 'LatestDidSync1730905681141';
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `CREATE TABLE "latest_did_sync" ("block" integer NOT NULL, "createdDate" TIMESTAMP NOT NULL DEFAULT now(), CONSTRAINT "PK_9e615062cb9a1c6b45598e74eae" PRIMARY KEY ("block"))`
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`DROP TABLE "latest_did_sync"`);
+  }
+}

src/migrations/1732050720611-AddDidSyncStatus.ts

@@ -0,0 +1,30 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class AddDidSyncStatus1732050720611 implements MigrationInterface {
+  name = 'AddDidSyncStatus1732050720611';
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `CREATE TYPE "public"."did_sync_status_entity_status_enum" AS ENUM('0', '1')`
+    );
+    await queryRunner.query(
+      `CREATE TABLE "did_sync_status_entity" ("id" SERIAL NOT NULL, "status" "public"."did_sync_status_entity_status_enum" NOT NULL DEFAULT '0', "created_date" TIMESTAMP NOT NULL DEFAULT now(), "document_id" character varying NOT NULL, CONSTRAINT "REL_100b8d489b25f9c448ec03e482" UNIQUE ("document_id"), CONSTRAINT "PK_e7f58d90249f1f87ddc5132cb11" PRIMARY KEY ("id"))`
+    );
+    await queryRunner.query(
+      `ALTER TABLE "did_sync_status_entity" ADD CONSTRAINT "FK_100b8d489b25f9c448ec03e482d" FOREIGN KEY ("document_id") REFERENCES "did_document_entity"("id") ON DELETE NO ACTION ON UPDATE NO ACTION`
+    );
+    await queryRunner.query(
+      `INSERT INTO did_sync_status_entity (document_id) SELECT id FROM did_document_entity`
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE "did_sync_status_entity" DROP CONSTRAINT "FK_100b8d489b25f9c448ec03e482d"`
+    );
+    await queryRunner.query(`DROP TABLE "did_sync_status_entity"`);
+    await queryRunner.query(
+      `DROP TYPE "public"."did_sync_status_entity_status_enum"`
+    );
+  }
+}

src/modules/did/did.module.ts

@@ -5,6 +5,7 @@ import { Methods } from '@ew-did-registry/did';
 import { Provider } from '../../common/provider';
 import { DIDController } from './did.controller';
 import { DIDDocumentEntity } from './did.entity';
+import { LatestDidSync } from './latestDidSync.entity';
 import { DIDProcessor } from './did.processor';
 import { DIDResolver } from './did.resolver';
 import { DIDService } from './did.service';
@@ -13,6 +14,7 @@ import { ConfigService } from '@nestjs/config';
 import { BullModule } from '@nestjs/bull';
 import { UPDATE_DOCUMENT_QUEUE_NAME } from './did.types';
 import { PIN_CLAIM_QUEUE_NAME } from '../ipfs/ipfs.types';
+import { DidSyncStatusEntity } from './didSyncStatus.entity';
 
 const RegistrySettingsProvider = {
   provide: 'RegistrySettings',
@@ -33,7 +35,11 @@ const RegistrySettingsProvider = {
     BullModule.registerQueue({
       name: PIN_CLAIM_QUEUE_NAME,
     }),
-    TypeOrmModule.forFeature([DIDDocumentEntity]),
+    TypeOrmModule.forFeature([
+      DIDDocumentEntity,
+      LatestDidSync,
+      DidSyncStatusEntity,
+    ]),
   ],
   controllers: [DIDController],
   providers: [