feat(license-service): update license service

.github/CODEOWNERS

@@ -136,6 +136,7 @@ codemagic.yaml
 /libs/api/domains/assets/                                                                                @island-is/hugsmidjan
 /libs/api/domains/hms-loans/                                                                             @island-is/hugsmidjan
 /libs/api/domains/license-service/                                                                       @island-is/hugsmidjan @island-is/aranja
+/libs/api/domains/license-service-v2/                                                                    @island-is/hugsmidjan @island-is/aranja
 /libs/api/domains/work-machines/                                                                         @island-is/hugsmidjan @island-is/origo
 /libs/api/domains/national-registry/                                                                     @island-is/hugsmidjan
 /libs/api/domains/notifications/                                                                         @island-is/hugsmidjan

apps/api/src/app/app.module.ts

@@ -50,6 +50,7 @@ import {
 } from '@island.is/api/domains/communications'
 import { IdentityModule } from '@island.is/api/domains/identity'
 import { LicenseServiceModule } from '@island.is/api/domains/license-service'
+import { LicenseServiceModuleV2 } from '@island.is/api/domains/license-service-v2'
 import { OfficialJournalOfIcelandModule } from '@island.is/api/domains/official-journal-of-iceland'
 import { OfficialJournalOfIcelandApplicationModule } from '@island.is/api/domains/official-journal-of-iceland-application'
 import { MortgageCertificateModule } from '@island.is/api/domains/mortgage-certificate'
@@ -233,6 +234,7 @@ const environment = getConfig
       baseApiUrl: environment.applicationSystem.baseApiUrl!,
     }),
     LicenseServiceModule,
+    LicenseServiceModuleV2,
     DirectorateOfLabourModule,
     FileUploadModule,
     DocumentModule,

apps/service-portal/src/components/Notifications/NotificationMenu.tsx

@@ -152,10 +152,7 @@ const NotificationMenu = ({
       isVisible={sideMenuOpen}
       hideOnClickOutside={true}
       hideOnEsc={true}
-      modalLabel={formatMessage({
-        id: 'service.portal:notification-button-aria',
-        defaultMessage: 'Valmynd fyrir tilkynningar',
-      })}
+      modalLabel={formatMessage(m.notificationButtonAria)}
       removeOnClose={true}
       preventBodyScroll={false}
       onVisibilityChange={(visibility: boolean) => {

apps/service-portal/src/components/Sidemenu/Sidemenu.tsx

@@ -124,11 +124,7 @@ const Sidemenu = ({
       isVisible={sideMenuOpen}
       hideOnClickOutside={true}
       hideOnEsc={true}
-      modalLabel={formatMessage({
-        id: 'service.portal:menu-button-aria',
-        description: 'Lýsing á notendavalmynd fyrir skjálesara',
-        defaultMessage: 'Valmynd fyrir yfirlit',
-      })}
+      modalLabel={formatMessage(m.menuButtonAria)}
       removeOnClose={true}
       preventBodyScroll={false}
       onVisibilityChange={(visibility: boolean) => {

libs/api/domains/license-service-v2/.eslintrc.json

@@ -0,0 +1,10 @@
+{
+  "extends": ["../../../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "rules": {},
+  "overrides": [
+    { "files": ["*.ts", "*.tsx", "*.js", "*.jsx"], "rules": {} },
+    { "files": ["*.ts", "*.tsx"], "rules": {} },
+    { "files": ["*.js", "*.jsx"], "rules": {} }
+  ]
+}

libs/api/domains/license-service-v2/README.md

@@ -0,0 +1,73 @@
+# API Domains License Service
+
+A layer that provides a single point of entry for all of a users licenses.
+
+### Licenses
+
+The license service returns a generic license that consists of the following parts.
+
+- License type: A license type comes from an exhaustive list of types.
+  - e.g. DriversLicense, FirearmLicense, MachineLicense etc...
+- Provider: What issuer provides the license.
+  - e.g National police commissioner
+- Fetch: A status object containing all relevant info about the fetch itself.
+- Payload: The actual payload, i.e. the license itself. Might be empty if the user doesn't have a license!
+
+**Currently accepted licenses include**:
+
+- Driving License
+- Firearm License
+- Machine License
+- ADR License
+- Disability License
+
+### Usage
+
+The Api and Xroad services need to be running
+
+- Api
+  `Yarn start api`
+- XRoad
+  `./scripts/run-xroad-proxy.sh`
+
+### Mocking
+
+Mocks are available if switched on.
+When a new license is added, don't forget to mock it!
+
+### Adding a new license
+
+1. Generate an external client that fetches the data from a 3rd party
+2. Create a client folder in `/license-service/client/` folder
+   - Each individual client is a module, so it can be injected into the license service easily. What you need then is:
+     - A service that provides the license data.
+     - A mapper that transforms and raw specific license data into a generic form.
+     - A configuration definition for the service. - All secrets should be kept in the AWS parameter store. Do not use environment files!
+     - (optional) Type definitions if required
+     - Finally, the module definitions, that provides the everything for injection and exports the service.
+3. Add the new license to the relevant types, e.g. `GenericLicenseTypeType``
+4. Inject the new internal client into the LicenseService!
+   - For digital licenses, you also need to provide the config to the CONFIG_PROVIDER factory function if pkpass is available (so it can retrieve the `passTemplateId` from it)
+   - Don't forget to add the new license to the `AVAILABLE_LICENSES` object if it's supposed to be displayed.
+
+### Digital Licenses
+
+The license service offers a service to create a digital license for each applicable license. To do this, it creates a _Pk pass_
+
+The license service currently uses the [SmartSolution API](https://smartsolutions.gitbook.io/smart-solutions-drivers-license/) to generate a pk pass for all applicable licenses, which is the used to provide a digitized license.
+
+To be able to generate a digital license, some conditions need to be met for each license.
+
+- **Drivers License**
+
+  - User has a result when RLS API is called
+  - The result has a non-null `mynd` in the result
+  - The date of the image is 1997-08-15 or newer
+
+- **Firearm License**
+
+  - The license must not be expired
+
+- **Adr License**
+
+  - The license must not be expired

libs/api/domains/license-service-v2/jest.config.ts

@@ -0,0 +1,17 @@
+/* eslint-disable */
+export default {
+  displayName: 'api-domains-license-service-v2',
+  preset: './jest.preset.js',
+  rootDir: '../../../..',
+  roots: [__dirname],
+  globals: {},
+  transform: {
+    '^.+\\.[tj]sx?$': [
+      'ts-jest',
+      { tsconfig: `${__dirname}/tsconfig.spec.json` },
+    ],
+  },
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
+  coverageDirectory: '<rootDir>/coverage/libs/api/domains/license-service-v2',
+  testEnvironment: 'node',
+}

libs/api/domains/license-service-v2/project.json

@@ -0,0 +1,33 @@
+{
+  "name": "api-domains-license-service-v2",
+  "$schema": "../../../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "libs/api/domains/license-service-v2/src",
+  "projectType": "library",
+  "targets": {
+    "lint": {
+      "executor": "@nx/linter:eslint",
+      "options": {
+        "lintFilePatterns": [
+          "libs/api/domains/license-service-v2/**/*.{ts,tsx,js,jsx}"
+        ]
+      }
+    },
+    "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": [
+        "{workspaceRoot}/coverage/libs/api/domains/license-service-v2"
+      ],
+      "options": {
+        "jestConfig": "libs/api/domains/license-service-v2/jest.config.ts",
+        "passWithNoTests": true
+      }
+    },
+    "extract-strings": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "yarn ts-node -P libs/localization/tsconfig.lib.json libs/localization/scripts/extract 'libs/api/domains/license-service-v2/src/lib/messages.ts'"
+      }
+    }
+  },
+  "tags": ["lib:api", "scope:api"]
+}

libs/api/domains/license-service-v2/src/index.ts

@@ -0,0 +1 @@
+export * from './lib/licenseService.module'

libs/api/domains/license-service-v2/src/lib/dto/CreateBarcodeResult.dto.ts

@@ -0,0 +1,14 @@
+import { Field, Int, ObjectType } from '@nestjs/graphql'
+
+@ObjectType('LicenseServiceV2CreateBarcodeResult')
+export class CreateBarcodeResult {
+  @Field({
+    description: 'Barcode token',
+  })
+  token!: string
+
+  @Field(() => Int, {
+    description: 'Barcode expire time in seconds',
+  })
+  expiresIn!: number
+}

libs/api/domains/license-service-v2/src/lib/dto/GeneratePkPass.input.ts

@@ -0,0 +1,8 @@
+import { Field, InputType } from '@nestjs/graphql'
+import { GenericLicenseType } from '../licenceService.type'
+
+@InputType('LicenseServiceV2GeneratePkPassInput')
+export class GeneratePkPassInput {
+  @Field(() => GenericLicenseType)
+  licenseType!: GenericLicenseType
+}

libs/api/domains/license-service-v2/src/lib/dto/GenericLicense.dto.ts

@@ -0,0 +1,57 @@
+import { Field, ObjectType, registerEnumType } from '@nestjs/graphql'
+import {
+  GenericLicenseType,
+  GenericUserLicensePkPassStatus,
+  GenericUserLicenseStatus,
+} from '../licenceService.type'
+import { GenericLicenseProvider } from './GenericLicenseProvider.dto'
+
+registerEnumType(GenericLicenseType, {
+  name: 'LicenseServiceV2GenericLicenseType',
+  description: 'Exhaustive list of license types',
+})
+
+registerEnumType(GenericUserLicenseStatus, {
+  name: 'LicenseServiceV2GenericUserLicenseStatus',
+  description: 'Possible license statuses for user',
+})
+
+registerEnumType(GenericUserLicensePkPassStatus, {
+  name: 'LicenseServiceV2GenericUserLicensePkPassStatus',
+  description: 'Possible license pkpass statuses',
+})
+
+@ObjectType('LicenseServiceV2GenericLicense')
+export class GenericLicense {
+  @Field(() => GenericLicenseType, {
+    description: 'Type of license from an exhaustive list',
+  })
+  type!: GenericLicenseType
+
+  @Field(() => GenericLicenseProvider, {
+    description: 'Provider of the license',
+  })
+  provider!: GenericLicenseProvider
+
+  @Field({ description: 'Does the license support pkpass?' })
+  pkpass!: boolean
+
+  @Field({ description: 'Does the license support verification of pkpass?' })
+  pkpassVerify!: boolean
+
+  @Field({
+    nullable: true,
+    deprecationReason: 'Unclear if this is used',
+    description:
+      'How long the data about the license should be treated as fresh',
+  })
+  timeout?: number
+
+  @Field(() => GenericUserLicenseStatus, { description: 'Status of license' })
+  status!: GenericUserLicenseStatus
+
+  @Field(() => GenericUserLicensePkPassStatus, {
+    description: 'Status of pkpass availablity of license',
+  })
+  pkpassStatus!: GenericUserLicensePkPassStatus
+}

libs/api/domains/license-service-v2/src/lib/dto/GenericLicenseCollection.dto.ts

@@ -0,0 +1,12 @@
+import { Field, ObjectType } from '@nestjs/graphql'
+import { LicenseError } from './GenericLicenseError.dto'
+import { GenericUserLicense } from './GenericUserLicense.dto'
+
+@ObjectType('LicenseServiceV2GenericLicensesCollection')
+export class LicenseCollection {
+  @Field(() => [GenericUserLicense], { nullable: true })
+  licenses!: Array<GenericUserLicense>
+
+  @Field(() => [LicenseError], { nullable: true })
+  errors?: Array<LicenseError>
+}

libs/api/domains/license-service-v2/src/lib/dto/GenericLicenseDataField.dto.ts

@@ -0,0 +1,54 @@
+import { Field, ObjectType, registerEnumType } from '@nestjs/graphql'
+import { GenericLicenseDataFieldType } from '../licenceService.type'
+import { GenericUserLicenseMetaLinks } from './GenericUserLicenseMetaLinks.dto'
+import { GenericUserLicenseMetaTag } from './GenericUserLicenseMetaTag.dto'
+
+registerEnumType(GenericLicenseDataFieldType, {
+  name: 'LicenseServiceV2GenericLicenseDataFieldType',
+  description: 'Possible types of data fields',
+})
+
+@ObjectType('LicenseServiceV2GenericLicenseDataField')
+export class GenericLicenseDataField {
+  @Field(() => GenericLicenseDataFieldType, {
+    description: 'Type of data field',
+  })
+  type!: GenericLicenseDataFieldType
+
+  @Field({ nullable: true, description: 'Name of data field' })
+  name?: string
+
+  @Field({ nullable: true, description: 'Label of data field' })
+  label?: string
+
+  @Field({
+    nullable: true,
+    description: 'Display value of data field category',
+  })
+  description?: string
+
+  @Field({ nullable: true, description: 'Value of data field' })
+  value?: string
+
+  @Field(() => GenericUserLicenseMetaTag, { nullable: true })
+  tag?: GenericUserLicenseMetaTag
+
+  @Field(() => GenericUserLicenseMetaLinks, {
+    nullable: true,
+    description: 'External meta link',
+  })
+  link?: GenericUserLicenseMetaLinks
+
+  @Field({
+    nullable: true,
+    description: 'Hide from service portal',
+    defaultValue: false,
+  })
+  hideFromServicePortal?: boolean
+
+  @Field(() => [GenericLicenseDataField], {
+    nullable: true,
+    description: 'Name of data field',
+  })
+  fields?: GenericLicenseDataField[]
+}

libs/api/domains/license-service-v2/src/lib/dto/GenericLicenseError.dto.ts

@@ -0,0 +1,21 @@
+import { Field, Int, ObjectType } from '@nestjs/graphql'
+import { GenericLicenseType } from '../licenceService.type'
+import { GenericLicenseProvider } from './GenericLicenseProvider.dto'
+
+@ObjectType('LicenseServiceV2GenericUserLicenseError')
+export class LicenseError {
+  @Field(() => GenericLicenseType)
+  type!: GenericLicenseType
+
+  @Field(() => GenericLicenseProvider, { nullable: true })
+  provider?: GenericLicenseProvider
+
+  @Field(() => Int, { nullable: true })
+  errorCode?: number
+
+  @Field({ nullable: true })
+  errorMessage?: string
+
+  @Field({ nullable: true })
+  extraData?: string
+}

libs/api/domains/license-service-v2/src/lib/dto/GenericLicenseFetch.dto.ts

@@ -0,0 +1,18 @@
+import { Field, ObjectType, registerEnumType } from '@nestjs/graphql'
+import { GenericUserLicenseFetchStatus } from '../licenceService.type'
+
+registerEnumType(GenericUserLicenseFetchStatus, {
+  name: 'LicenseServiceV2GenericUserLicenseFetchStatus',
+  description: 'Possible license fetch statuses',
+})
+
+@ObjectType('LicenseServiceV2GenericLicenseFetch')
+export class GenericLicenseFetch {
+  @Field(() => GenericUserLicenseFetchStatus, {
+    description: 'Status of license fetch',
+  })
+  status!: GenericUserLicenseFetchStatus
+
+  @Field({ description: 'Datetime of last update of fetch status' })
+  updated!: string
+}