@ogcio/building-blocks-sdk 0.2.87 → 0.2.89

package/src/client/clients/profile/schema.ts

@@ -172,6 +172,40 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/support/consents/latest": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Get the latest consent for all available subjects for a user */
+        get: operations["supportLatestConsent"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/support/consents/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description Submit consents for the logged in user */
+        post: operations["supportSubmitConsents"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/jobs/import-profiles/{profileImportId}": {
         parameters: {
             query?: never;
@@ -307,6 +341,58 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/onboarding/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description Check SAFE level and assign the onboarded-citizen role to the authenticated user */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Default Response */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            success?: boolean;
+                            safeLevel?: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error?: string;
+                            safeLevel?: number;
+                            required?: number;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/organisations/profiles/{profileId}": {
         parameters: {
             query?: never;
@@ -470,6 +556,22 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/support/profiles/search": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["searchSupportProfiles"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/user-login-wh": {
         parameters: {
             query?: never;
@@ -2252,6 +2354,218 @@ export interface operations {
             };
         };
     };
+    supportLatestConsent: {
+        parameters: {
+            query: {
+                profileId: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: {
+                            availableSubjects: string[];
+                            consents: {
+                                /** Format: uuid */
+                                id: string;
+                                profileId: string;
+                                status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
+                                subject: string;
+                                createdAt: string;
+                                /** Format: uuid */
+                                consentStatementId: string;
+                            }[];
+                        };
+                        metadata?: {
+                            /** @description Object containing the links to the related endpoints */
+                            links?: {
+                                self: {
+                                    /** @description URL pointing to the request itself */
+                                    href?: string;
+                                };
+                                next?: {
+                                    /** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
+                                    href?: string;
+                                };
+                                prev?: {
+                                    /** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
+                                    href?: string;
+                                };
+                                first: {
+                                    /** @description URL pointing to the first page of results in a paginated response */
+                                    href?: string;
+                                };
+                                last: {
+                                    /** @description URL pointing to the first page of results in a paginated response */
+                                    href?: string;
+                                };
+                                /** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
+                                pages: {
+                                    [key: string]: {
+                                        href?: string;
+                                    };
+                                };
+                            };
+                            /** @description Number representing the total number of available items */
+                            totalCount?: number;
+                        };
+                    };
+                };
+            };
+            /** @description Default Response */
+            "4XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @description Code used to categorize the error */
+                        code: string;
+                        /** @description Description of the error */
+                        detail: string;
+                        /** @description Unique request id. This one will be used to troubleshoot the problems */
+                        requestId: string;
+                        /** @description Name of the error type */
+                        name: string;
+                        /** @description List of the validation errors */
+                        validation?: {
+                            fieldName: string;
+                            message: string;
+                        }[];
+                        validationContext?: string;
+                        statusCode: number;
+                    };
+                };
+            };
+            /** @description Default Response */
+            "5XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @description Code used to categorize the error */
+                        code: string;
+                        /** @description Description of the error */
+                        detail: string;
+                        /** @description Unique request id. This one will be used to troubleshoot the problems */
+                        requestId: string;
+                        /** @description Name of the error type */
+                        name: string;
+                        /** @description List of the validation errors */
+                        validation?: {
+                            fieldName: string;
+                            message: string;
+                        }[];
+                        validationContext?: string;
+                        statusCode: number;
+                    };
+                };
+            };
+        };
+    };
+    supportSubmitConsents: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    profileId: string;
+                    consents: {
+                        subject: string;
+                        status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
+                    }[];
+                };
+            };
+        };
+        responses: {
+            /** @description Default Response */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: {
+                            /** Format: uuid */
+                            id: string;
+                            subject: string;
+                            status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
+                            /** Format: date-time */
+                            submittedAt: string;
+                            /** Format: uuid */
+                            consentStatementId: string;
+                            statementVersion: number;
+                            isLatestStatement: boolean;
+                        }[];
+                    };
+                };
+            };
+            /** @description Default Response */
+            "4XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @description Code used to categorize the error */
+                        code: string;
+                        /** @description Description of the error */
+                        detail: string;
+                        /** @description Unique request id. This one will be used to troubleshoot the problems */
+                        requestId: string;
+                        /** @description Name of the error type */
+                        name: string;
+                        /** @description List of the validation errors */
+                        validation?: {
+                            fieldName: string;
+                            message: string;
+                        }[];
+                        validationContext?: string;
+                        statusCode: number;
+                    };
+                };
+            };
+            /** @description Default Response */
+            "5XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @description Code used to categorize the error */
+                        code: string;
+                        /** @description Description of the error */
+                        detail: string;
+                        /** @description Unique request id. This one will be used to troubleshoot the problems */
+                        requestId: string;
+                        /** @description Name of the error type */
+                        name: string;
+                        /** @description List of the validation errors */
+                        validation?: {
+                            fieldName: string;
+                            message: string;
+                        }[];
+                        validationContext?: string;
+                        statusCode: number;
+                    };
+                };
+            };
+        };
+    };
     getLifecycleTasks: {
         parameters: {
             query?: never;
@@ -4485,6 +4799,177 @@ export interface operations {
             };
         };
     };
+    searchSupportProfiles: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /** @default [] */
+                    name?: string[];
+                    /** @default [] */
+                    email?: string[];
+                    /** @default [] */
+                    ppsn?: string[];
+                    /** @default [] */
+                    dateOfBirth?: {
+                        /**
+                         * Format: date
+                         * @description If set, the endpoint searches for users whose date of birth is from this date (inclusive)
+                         */
+                        from?: string;
+                        /**
+                         * Format: date
+                         * @description If set, the endpoint searches for users whose date of birth is to this date (inclusive)
+                         */
+                        to?: string;
+                    }[];
+                    /** @default [] */
+                    id?: string[];
+                    /** @default and */
+                    logicalOperator?: "and" | "or";
+                    /**
+                     * @description Indicates where to start fetching data or how many records to skip, defining the initial position within the list
+                     * @default 0
+                     */
+                    offset?: string;
+                    /**
+                     * @description Indicates the maximum number (100) of items that will be returned in a single request
+                     * @default 20
+                     */
+                    limit?: string;
+                };
+            };
+        };
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: {
+                            id: string;
+                            publicName: string;
+                            email: string;
+                            organisationId: string | null;
+                            ppsn: string | null;
+                            dateOfBirth: string | null;
+                            primaryUserId: string;
+                            /** Format: date-time */
+                            createdAt: string;
+                            /** Format: date-time */
+                            updatedAt: string;
+                            deletedAt: string | null;
+                            /** @description The preferred language of the user, in ISO 639-1 format */
+                            preferredLanguage: string;
+                            /** @description The status of the user, either 'active' or 'disabled' or 'deleted' */
+                            status: string;
+                            /** @description The safe level of the user */
+                            safeLevel: number;
+                            consentStatuses: {
+                                [key: string]: {
+                                    status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
+                                    /** Format: uuid */
+                                    consent_statement_id: string;
+                                };
+                            };
+                            firstName: string | null;
+                            lastName: string | null;
+                        }[];
+                        metadata?: {
+                            /** @description Object containing the links to the related endpoints */
+                            links?: {
+                                self: {
+                                    /** @description URL pointing to the request itself */
+                                    href?: string;
+                                };
+                                next?: {
+                                    /** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
+                                    href?: string;
+                                };
+                                prev?: {
+                                    /** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
+                                    href?: string;
+                                };
+                                first: {
+                                    /** @description URL pointing to the first page of results in a paginated response */
+                                    href?: string;
+                                };
+                                last: {
+                                    /** @description URL pointing to the first page of results in a paginated response */
+                                    href?: string;
+                                };
+                                /** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
+                                pages: {
+                                    [key: string]: {
+                                        href?: string;
+                                    };
+                                };
+                            };
+                            /** @description Number representing the total number of available items */
+                            totalCount?: number;
+                        };
+                    };
+                };
+            };
+            /** @description Default Response */
+            "4XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @description Code used to categorize the error */
+                        code: string;
+                        /** @description Description of the error */
+                        detail: string;
+                        /** @description Unique request id. This one will be used to troubleshoot the problems */
+                        requestId: string;
+                        /** @description Name of the error type */
+                        name: string;
+                        /** @description List of the validation errors */
+                        validation?: {
+                            fieldName: string;
+                            message: string;
+                        }[];
+                        validationContext?: string;
+                        statusCode: number;
+                    };
+                };
+            };
+            /** @description Default Response */
+            "5XX": {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @description Code used to categorize the error */
+                        code: string;
+                        /** @description Description of the error */
+                        detail: string;
+                        /** @description Unique request id. This one will be used to troubleshoot the problems */
+                        requestId: string;
+                        /** @description Name of the error type */
+                        name: string;
+                        /** @description List of the validation errors */
+                        validation?: {
+                            fieldName: string;
+                            message: string;
+                        }[];
+                        validationContext?: string;
+                        statusCode: number;
+                    };
+                };
+            };
+        };
+    };
     logtoUserCreated: {
         parameters: {
             query?: never;

package/src/client/clients/profile/support.ts

@@ -0,0 +1,51 @@
+import type createClient from "openapi-fetch";
+import type { Logger } from "../../../types/index.js";
+import { formatError, formatResponse } from "../../utils/client-utils.js";
+import type { paths } from "./schema.js";
+
+export class ProfileSupport {
+  constructor(
+    private readonly client: ReturnType<typeof createClient<paths>>,
+    private readonly serviceName: string,
+    private readonly logger: Logger | undefined,
+  ) {}
+
+  async postProfileSearch(
+    body: paths["/api/v1/support/profiles/search"]["post"]["requestBody"]["content"]["application/json"],
+  ) {
+    return this.client
+      .POST("/api/v1/support/profiles/search", {
+        body,
+      })
+      .then(
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
+      );
+  }
+
+  async getLatestConsents(
+    query: paths["/api/v1/support/consents/latest"]["get"]["parameters"]["query"],
+  ) {
+    return this.client
+      .GET("/api/v1/support/consents/latest", {
+        params: { query },
+      })
+      .then(
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
+      );
+  }
+
+  async submitConsents(
+    body: paths["/api/v1/support/consents/"]["post"]["requestBody"]["content"]["application/json"],
+  ) {
+    return this.client
+      .POST("/api/v1/support/consents/", {
+        body,
+      })
+      .then(
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
+      );
+  }
+}

package/src/clients-configurations/clients-configuration.json

@@ -22,7 +22,7 @@
         "messaging:template:*",
         "messaging:event:read"
       ],
-      "updateDefinitions": true
+      "updateDefinitions": false
     },
     {
       "name": "upload",
@@ -30,7 +30,7 @@
       "openApiDefinitionFormat": "yaml",
       "citizenPermissions": ["upload:file.self:write", "upload:file.self:read"],
       "publicServantPermissions": ["upload:file:*", "profile:user:read"],
-      "updateDefinitions": true
+      "updateDefinitions": false
     },
     {
       "name": "payments",
@@ -56,11 +56,11 @@
       "openApiDefinitionFormat": "yaml",
       "citizenPermissions": ["scheduler:jobs:write"],
       "publicServantPermissions": ["scheduler:jobs:write"],
-      "updateDefinitions": true
+      "updateDefinitions": false
     },
     {
       "name": "profile",
-      "openApiDefinitionUrl": "https://raw.githubusercontent.com/ogcio/govie-services-profile/refs/heads/dev/apps/profile-api/openapi-definition.yml",
+      "openApiDefinitionUrl": "http://localhost:8003/docs/yaml",
       "openApiDefinitionFormat": "yaml",
       "citizenPermissions": [
         "profile:user.self:read",
@@ -75,7 +75,7 @@
       "openApiDefinitionFormat": "json",
       "citizenPermissions": [],
       "publicServantPermissions": [],
-      "updateDefinitions": true
+      "updateDefinitions": false
     },
     {
       "name": "journey",
@@ -91,7 +91,7 @@
         "integrator:step:*",
         "integrator:run:read"
       ],
-      "updateDefinitions": true
+      "updateDefinitions": false
     },
     {
       "name": "auditCollector",
@@ -99,7 +99,7 @@
       "openApiDefinitionFormat": "yaml",
       "citizenPermissions": [],
       "publicServantPermissions": [],
-      "updateDefinitions": true
+      "updateDefinitions": false
     }
   ]
 }

package/src/clients-configurations/read-configuration-file.ts

@@ -45,7 +45,7 @@ export async function readConfigurationFile(
   const { default: rawConfigurationFile } = await import(
     configurationFilePath,
     {
-      assert: {
+      with: {
         type: "json",
       },
     }