IMN-415 add consumerServiceV2 in tenant-readmodel-writer

packages/models/proto/v2/tenant/events.proto

@@ -0,0 +1,63 @@
+syntax = "proto3";
+
+package tenant.v2;
+
+import "v2/tenant/tenant.proto";
+
+message TenantOnboardedV2 {
+  TenantV2 tenant = 1;
+}
+
+message TenantOnboardDetailsUpdatedV2 {
+  TenantV2 tenant = 1;
+}
+
+message TenantCertifiedAttributeAssignedV2 {
+  string attributeId = 1;
+  TenantV2 tenant = 2;
+}
+
+message TenantCertifiedAttributeRevokedV2 {
+  string attributeId = 1;
+  TenantV2 tenant = 2;
+}
+
+message TenantDeclaredAttributeAssignedV2 {
+  string attributeId = 1;
+  TenantV2 tenant = 2;
+}
+
+message TenantDeclaredAttributeRevokedV2 {
+  string attributeId = 1;
+  TenantV2 tenant = 2;
+}
+
+message TenantVerifiedAttributeAssignedV2 {
+  string attributeId = 1;
+  TenantV2 tenant = 2;
+}
+
+message TenantVerifiedAttributeRevokedV2 {
+  string attributeId = 1;
+  TenantV2 tenant = 2;
+}
+
+message TenantVerifiedAttributeExpirationUpdatedV2 {
+  string attributeId = 1;
+  TenantV2 tenant = 2;
+}
+
+message TenantVerifiedAttributeExtensionUpdatedV2 {
+  string attributeId = 1;
+  TenantV2 tenant = 2;
+}
+
+message MaintenanceTenantDeletedV2 {
+  string tenantId = 1;
+  TenantV2 tenant = 2;
+}
+
+message TenantMailAddedV2 {
+  string mailId = 1;
+  TenantV2 tenant = 2;
+}

packages/models/proto/v2/tenant/tenant.proto

@@ -0,0 +1,100 @@
+syntax = "proto3";
+
+package tenant.v2;
+
+message TenantV2 {
+  string id = 1;
+  string selfcareId = 2;
+  ExternalIdV2 externalId = 3;
+  repeated TenantFeatureV2 features = 4;
+  repeated TenantAttributeV2 attributes = 5;
+  int64 createdAt = 6;
+  optional int64 updatedAt = 7;
+  repeated TenantMailV2 mails = 8;
+  string name = 9;
+  optional TenantKindV2 kind = 10;
+  int64 onboardedAt = 11;
+  optional TenantUnitTypeV2 subUnitType = 12;
+
+}
+
+enum TenantKindV2 {
+  PA = 0;
+  GSP = 1;
+  PRIVATE = 2;
+}
+
+message TenantMailV2 {
+  TenantMailKindV2 kind = 1;
+  string address = 2;
+  int64 createdAt = 3;
+  optional string description = 4;
+  string id = 5;
+}
+
+enum TenantMailKindV2 {
+  CONTACT_EMAIL = 0;
+  DIGITAL_ADDRESS = 1;
+}
+
+enum TenantUnitTypeV2 {
+  AOO = 0;
+  UO = 1;
+}
+
+message TenantFeatureV2 {
+  oneof sealed_value {
+    CertifierV2 certifier = 1;
+  }
+}
+
+message CertifierV2 {
+  string certifierId = 1;
+}
+
+message TenantVerifierV2 {
+  string id = 1;
+  int64 verificationDate = 2;
+  optional int64 expirationDate = 3;
+  optional int64 extensionDate = 4;
+}
+
+message TenantRevokerV2 {
+  string id = 1;
+  int64 verificationDate = 2;
+  optional int64 expirationDate = 3;
+  optional int64 extensionDate = 4;
+  int64 revocationDate = 5;
+}
+
+message ExternalIdV2 {
+  string origin = 1;
+  string value = 2;
+}
+
+message TenantCertifiedAttributeV2 {
+  string id = 1;
+  int64 assignmentTimestamp = 2;
+  optional int64 revocationTimestamp = 3;
+}
+
+message TenantDeclaredAttributeV2 {
+  string id = 1;
+  int64 assignmentTimestamp = 2;
+  optional int64 revocationTimestamp = 3;
+}
+
+message TenantVerifiedAttributeV2 {
+  string id = 1;
+  int64 assignmentTimestamp = 2;
+  repeated TenantVerifierV2 verifiedBy = 3;
+  repeated TenantRevokerV2 revokedBy = 4;
+}
+
+message TenantAttributeV2 {
+  oneof sealed_value {
+    TenantCertifiedAttributeV2 certifiedAttribute = 1;
+    TenantDeclaredAttributeV2 declaredAttribute = 2;
+    TenantVerifiedAttributeV2 verifiedAttribute = 3;
+  }
+}

packages/models/src/index.ts

@@ -28,9 +28,11 @@ export * from "./institution/institution.js";
 
 export * from "./risk-analysis/riskAnalysis.js";
 
-export * from "./tenant/protobufConverter.js";
 export * from "./tenant/tenant.js";
 export * from "./tenant/tenantEvents.js";
+export * from "./tenant/protobufConverterFromV1.js";
+export * from "./tenant/protobufConverterFromV2.js";
+export * from "./tenant/protobufConverterToV2.js";
 
 export * from "./purpose/purpose.js";
 export * from "./purpose/purposeEvents.js";
@@ -92,3 +94,5 @@ export * from "./gen/v2/purpose/events.js";
 export * from "./gen/v2/authorization/client.js";
 export * from "./gen/v2/authorization/key.js";
 export * from "./gen/v2/authorization/events.js";
+export * from "./gen/v2/tenant/tenant.js";
+export * from "./gen/v2/tenant/events.js";

packages/models/src/tenant/protobufConverterFromV2.ts

@@ -0,0 +1,175 @@
+import { createHash } from "crypto";
+import { match } from "ts-pattern";
+import { unsafeBrandId } from "../brandedIds.js";
+import { genericError } from "../errors.js";
+import {
+  TenantKindV2,
+  TenantMailKindV2,
+  TenantMailV2,
+  TenantFeatureV2,
+  TenantVerifierV2,
+  TenantRevokerV2,
+  TenantAttributeV2,
+  TenantV2,
+  TenantUnitTypeV2,
+} from "../gen/v2/tenant/tenant.js";
+import { bigIntToDate } from "../utils.js";
+import {
+  TenantKind,
+  tenantKind,
+  TenantMailKind,
+  tenantMailKind,
+  TenantMail,
+  TenantFeatureCertifier,
+  TenantVerifier,
+  TenantRevoker,
+  TenantAttribute,
+  Tenant,
+  ExternalId,
+  tenantAttributeType,
+  TenantUnitType,
+  tenantUnitType,
+} from "./tenant.js";
+
+export const fromTenantKindV2 = (input: TenantKindV2): TenantKind => {
+  switch (input) {
+    case TenantKindV2.GSP:
+      return tenantKind.GSP;
+    case TenantKindV2.PA:
+      return tenantKind.PA;
+    case TenantKindV2.PRIVATE:
+      return tenantKind.PRIVATE;
+  }
+};
+
+export const fromTenantMailKindV2 = (
+  input: TenantMailKindV2
+): TenantMailKind => {
+  switch (input) {
+    case TenantMailKindV2.CONTACT_EMAIL:
+      return tenantMailKind.ContactEmail;
+    case TenantMailKindV2.DIGITAL_ADDRESS:
+      return tenantMailKind.DigitalAddress;
+  }
+};
+
+export const fromTenantMailV2 = (input: TenantMailV2): TenantMail => ({
+  ...input,
+  id: input.id ?? createHash("sha256").update(input.address).digest("hex"),
+  createdAt: bigIntToDate(input.createdAt),
+  kind: fromTenantMailKindV2(input.kind),
+});
+
+export const fromTenantFeatureV2 = (
+  input: TenantFeatureV2
+): TenantFeatureCertifier =>
+  match<TenantFeatureV2["sealedValue"], TenantFeatureCertifier>(
+    input.sealedValue
+  )
+    .with({ oneofKind: "certifier" }, ({ certifier }) => ({
+      type: "PersistentCertifier",
+      certifierId: certifier.certifierId,
+    }))
+    .with({ oneofKind: undefined }, () => {
+      throw new Error("Unable to deserialize TenantFeature");
+    })
+    .exhaustive();
+
+export const fromTenantVerifierV2 = (
+  input: TenantVerifierV2
+): TenantVerifier => ({
+  ...input,
+  verificationDate: bigIntToDate(input.verificationDate),
+  expirationDate: bigIntToDate(input.expirationDate),
+  extensionDate: bigIntToDate(input.extensionDate),
+});
+
+export const fromTenantRevokerV2 = (input: TenantRevokerV2): TenantRevoker => ({
+  ...input,
+  expirationDate: bigIntToDate(input.expirationDate),
+  extensionDate: bigIntToDate(input.extensionDate),
+  revocationDate: bigIntToDate(input.revocationDate),
+  verificationDate: bigIntToDate(input.verificationDate),
+});
+
+export const fromTenantAttributesV2 = (
+  input: TenantAttributeV2
+): TenantAttribute => {
+  const { sealedValue } = input;
+
+  switch (sealedValue.oneofKind) {
+    case "certifiedAttribute":
+      const { certifiedAttribute } = sealedValue;
+      return {
+        id: unsafeBrandId(certifiedAttribute.id),
+        assignmentTimestamp: bigIntToDate(
+          certifiedAttribute.assignmentTimestamp
+        ),
+        type: tenantAttributeType.CERTIFIED,
+      };
+    case "verifiedAttribute":
+      const { verifiedAttribute } = sealedValue;
+      return {
+        id: unsafeBrandId(verifiedAttribute.id),
+        assignmentTimestamp: bigIntToDate(
+          verifiedAttribute.assignmentTimestamp
+        ),
+        verifiedBy: verifiedAttribute.verifiedBy.map(fromTenantVerifierV2),
+        revokedBy: verifiedAttribute.revokedBy.map(fromTenantRevokerV2),
+        type: tenantAttributeType.VERIFIED,
+      };
+    case "declaredAttribute":
+      const { declaredAttribute } = sealedValue;
+      return {
+        id: unsafeBrandId(declaredAttribute.id),
+        assignmentTimestamp: bigIntToDate(
+          declaredAttribute.assignmentTimestamp
+        ),
+        type: tenantAttributeType.DECLARED,
+      };
+    default:
+      throw genericError(`Invalid attribute kind: ${sealedValue.oneofKind}`);
+  }
+};
+
+export const fromTenantUnitTypeV2 = (
+  input: TenantUnitTypeV2
+): TenantUnitType => {
+  switch (input) {
+    case TenantUnitTypeV2.AOO:
+      return tenantUnitType.AOO;
+    case TenantUnitTypeV2.UO:
+      return tenantUnitType.UO;
+  }
+};
+
+export const fromTenantV2 = (input: TenantV2): Tenant => {
+  /**
+   * The `externalId` field is required in the TenantV2 protobuf model but
+   * for some reasons the @protobuf-ts/protoc library generates it as optional.
+   * This issue has been reported here: https://github.com/timostamm/protobuf-ts/issues/340
+   */
+  const externalId = ExternalId.safeParse(input.externalId);
+  if (!externalId.success) {
+    throw genericError(
+      `Error while deserializing TenantV2 (${input.id}): missing externalId`
+    );
+  }
+
+  return {
+    ...input,
+    id: unsafeBrandId(input.id),
+    name: input.name ?? "",
+    createdAt: bigIntToDate(input.createdAt),
+    attributes: input.attributes.map(fromTenantAttributesV2),
+    externalId: externalId.data,
+    features: input.features.map(fromTenantFeatureV2),
+    mails: input.mails.map(fromTenantMailV2),
+    kind: input.kind ? fromTenantKindV2(input.kind) : undefined,
+    updatedAt: bigIntToDate(input.updatedAt),
+    onboardedAt: bigIntToDate(input.onboardedAt),
+    subUnitType: input.subUnitType
+      ? fromTenantUnitTypeV2(input.subUnitType)
+      : undefined,
+  };
+};