@twin.org/identity-service 0.0.2-next.9 → 0.0.3-next.2

package/dist/es/identityProfileRoutes.js

@@ -0,0 +1,389 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { HttpParameterHelper } from "@twin.org/api-models";
+import { ContextIdHelper, ContextIdKeys, ContextIdStore } from "@twin.org/context";
+import { Coerce, ComponentFactory, Guards } from "@twin.org/core";
+import { HeaderTypes, HttpStatusCode, MimeTypes } from "@twin.org/web";
+/**
+ * The source used when communicating about these routes.
+ */
+const ROUTES_SOURCE = "identityProfileRoutes";
+/**
+ * The tag to associate with the routes.
+ */
+export const tagsIdentityProfile = [
+    {
+        name: "Identity Profile",
+        description: "Service to provide all features related to digital identity profiles."
+    }
+];
+/**
+ * The REST routes for identity.
+ * @param baseRouteName Prefix to prepend to the paths.
+ * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @returns The generated routes.
+ */
+export function generateRestRoutesIdentityProfile(baseRouteName, componentName) {
+    const identityProfileCreateRoute = {
+        operationId: "identityProfileCreate",
+        summary: "Create an identity profile",
+        tag: tagsIdentityProfile[0].name,
+        method: "POST",
+        path: `${baseRouteName}/`,
+        handler: async (httpRequestContext, request) => identityProfileCreate(httpRequestContext, componentName, request),
+        requestType: {
+            type: "IIdentityProfileCreateRequest",
+            examples: [
+                {
+                    id: "identityProfileCreateRequestExample",
+                    request: {
+                        body: {
+                            publicProfile: {
+                                "@context": "https://schema.org",
+                                "@type": "Person",
+                                jobTitle: "Professor",
+                                name: "Jane Doe"
+                            },
+                            privateProfile: {
+                                "@context": "https://schema.org",
+                                "@type": "Person",
+                                telephone: "(425) 123-4567",
+                                url: "http://www.janedoe.com"
+                            }
+                        }
+                    }
+                }
+            ]
+        },
+        responseType: [
+            {
+                type: "INoContentResponse"
+            },
+            {
+                type: "IConflictResponse"
+            }
+        ]
+    };
+    const identityProfileGetRoute = {
+        operationId: "identityProfileGet",
+        summary: "Get the identity profile properties",
+        tag: tagsIdentityProfile[0].name,
+        method: "GET",
+        path: `${baseRouteName}/`,
+        handler: async (httpRequestContext, request) => identityGet(httpRequestContext, componentName, request),
+        requestType: {
+            type: "IIdentityProfileGetRequest",
+            examples: [
+                {
+                    id: "identityGetProfileRequestExample",
+                    request: {
+                        query: {
+                            publicPropertyNames: "name,jobTitle"
+                        }
+                    }
+                }
+            ]
+        },
+        responseType: [
+            {
+                type: "IIdentityProfileGetResponse",
+                examples: [
+                    {
+                        id: "identityGetResponseExample",
+                        response: {
+                            body: {
+                                identity: "did:iota:tst:0xc57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
+                                publicProfile: {
+                                    "@context": "https://schema.org",
+                                    "@type": "Person",
+                                    jobTitle: "Professor",
+                                    name: "Jane Doe"
+                                }
+                            }
+                        }
+                    }
+                ]
+            },
+            {
+                type: "INotFoundResponse"
+            }
+        ]
+    };
+    const identityProfileGetPublicRoute = {
+        operationId: "identityProfileGetPublic",
+        summary: "Get the identity profile public properties",
+        tag: tagsIdentityProfile[0].name,
+        method: "GET",
+        path: `${baseRouteName}/:identity/public`,
+        handler: async (httpRequestContext, request) => identityGetPublic(httpRequestContext, componentName, request),
+        requestType: {
+            type: "IIdentityProfileGetPublicRequest",
+            examples: [
+                {
+                    id: "identityGetPublicProfileRequestExample",
+                    request: {
+                        pathParams: {
+                            identity: "did:iota:tst:0xc57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70"
+                        },
+                        query: {
+                            propertyNames: "role,email,name"
+                        }
+                    }
+                }
+            ]
+        },
+        responseType: [
+            {
+                type: "IIdentityProfileGetPublicResponse",
+                mimeType: MimeTypes.JsonLd,
+                examples: [
+                    {
+                        id: "identityGetPublicResponseExample",
+                        response: {
+                            headers: {
+                                [HeaderTypes.ContentType]: MimeTypes.JsonLd
+                            },
+                            body: {
+                                "@context": "https://schema.org",
+                                "@type": "Person",
+                                jobTitle: "Professor",
+                                name: "Jane Doe"
+                            }
+                        }
+                    }
+                ]
+            },
+            {
+                type: "INotFoundResponse"
+            }
+        ],
+        skipAuth: true
+    };
+    const identityProfileUpdateRoute = {
+        operationId: "identityProfileUpdate",
+        summary: "Update an identity profile properties",
+        tag: tagsIdentityProfile[0].name,
+        method: "PUT",
+        path: `${baseRouteName}/`,
+        handler: async (httpRequestContext, request) => identityProfileUpdate(httpRequestContext, componentName, request),
+        requestType: {
+            type: "IIdentityProfileUpdateRequest",
+            examples: [
+                {
+                    id: "identityProfileUpdateRequestExample",
+                    request: {
+                        body: {
+                            publicProfile: {
+                                "@context": "https://schema.org",
+                                "@type": "Person",
+                                jobTitle: "Professor",
+                                name: "Jane Doe"
+                            },
+                            privateProfile: {
+                                "@context": "https://schema.org",
+                                "@type": "Person",
+                                telephone: "(425) 123-4567",
+                                url: "http://www.janedoe.com"
+                            }
+                        }
+                    }
+                }
+            ]
+        },
+        responseType: [
+            {
+                type: "INoContentResponse"
+            },
+            {
+                type: "INotFoundResponse"
+            }
+        ]
+    };
+    const identityProfileRemoveRoute = {
+        operationId: "identityProfileRemove",
+        summary: "Remove an identity profile",
+        tag: tagsIdentityProfile[0].name,
+        method: "DELETE",
+        path: `${baseRouteName}/`,
+        handler: async (httpRequestContext, request) => identityProfileRemove(httpRequestContext, componentName, request),
+        responseType: [
+            {
+                type: "INoContentResponse"
+            },
+            {
+                type: "INotFoundResponse"
+            }
+        ]
+    };
+    const identityProfileListRoute = {
+        operationId: "identitiesProfileList",
+        summary: "Get the list of profile data for identities",
+        tag: tagsIdentityProfile[0].name,
+        method: "GET",
+        path: `${baseRouteName}/query/`,
+        handler: async (httpRequestContext, request) => identitiesList(httpRequestContext, componentName, request),
+        requestType: {
+            type: "IIdentityProfileListRequest",
+            examples: [
+                {
+                    id: "identityProfileListRequestExample",
+                    request: {
+                        query: {}
+                    }
+                },
+                {
+                    id: "identityProfileListRequestFilteredExample",
+                    request: {
+                        query: {
+                            publicFilters: "jobTitle:Professor"
+                        }
+                    }
+                }
+            ]
+        },
+        responseType: [
+            {
+                type: "IIdentityProfileListResponse",
+                examples: [
+                    {
+                        id: "identitiesProfileListResponseExample",
+                        response: {
+                            body: {
+                                items: [
+                                    {
+                                        identity: "did:iota:tst:0xc57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
+                                        publicProfile: {
+                                            "@context": "https://schema.org",
+                                            "@type": "Person",
+                                            jobTitle: "Professor",
+                                            name: "Jane Doe"
+                                        }
+                                    }
+                                ],
+                                cursor: "1"
+                            }
+                        }
+                    }
+                ]
+            }
+        ]
+    };
+    return [
+        identityProfileCreateRoute,
+        identityProfileGetRoute,
+        identityProfileGetPublicRoute,
+        identityProfileUpdateRoute,
+        identityProfileRemoveRoute,
+        identityProfileListRoute
+    ];
+}
+/**
+ * Create an identity profile.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export async function identityProfileCreate(httpRequestContext, componentName, request) {
+    Guards.object(ROUTES_SOURCE, "request", request);
+    Guards.object(ROUTES_SOURCE, "request.body", request.body);
+    const contextIds = await ContextIdStore.getContextIds();
+    ContextIdHelper.guard(contextIds, ContextIdKeys.User);
+    const component = ComponentFactory.get(componentName);
+    await component.create(request.body.publicProfile, request.body.privateProfile, contextIds[ContextIdKeys.User]);
+    return {
+        statusCode: HttpStatusCode.noContent
+    };
+}
+/**
+ * Get the identity profile.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export async function identityGet(httpRequestContext, componentName, request) {
+    Guards.object(ROUTES_SOURCE, "request", request);
+    const contextIds = await ContextIdStore.getContextIds();
+    ContextIdHelper.guard(contextIds, ContextIdKeys.User);
+    const component = ComponentFactory.get(componentName);
+    const result = await component.get(HttpParameterHelper.arrayFromString(request?.query?.publicPropertyNames), HttpParameterHelper.arrayFromString(request?.query?.privatePropertyNames), contextIds[ContextIdKeys.User]);
+    return {
+        body: result
+    };
+}
+/**
+ * Get the identity public profile.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export async function identityGetPublic(httpRequestContext, componentName, request) {
+    Guards.object(ROUTES_SOURCE, "request", request);
+    Guards.stringValue(ROUTES_SOURCE, "request.pathParams.identity", request.pathParams?.identity);
+    const component = ComponentFactory.get(componentName);
+    const result = await component.getPublic(request?.pathParams.identity, HttpParameterHelper.arrayFromString(request?.query?.propertyNames));
+    return {
+        headers: {
+            [HeaderTypes.ContentType]: MimeTypes.JsonLd
+        },
+        body: result
+    };
+}
+/**
+ * Update an identity profile.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export async function identityProfileUpdate(httpRequestContext, componentName, request) {
+    Guards.object(ROUTES_SOURCE, "request", request);
+    Guards.object(ROUTES_SOURCE, "request.body", request.body);
+    const contextIds = await ContextIdStore.getContextIds();
+    ContextIdHelper.guard(contextIds, ContextIdKeys.User);
+    const component = ComponentFactory.get(componentName);
+    await component.update(request.body.publicProfile, request.body.privateProfile, contextIds[ContextIdKeys.User]);
+    return {
+        statusCode: HttpStatusCode.noContent
+    };
+}
+/**
+ * Remove an identity profile.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export async function identityProfileRemove(httpRequestContext, componentName, request) {
+    const contextIds = await ContextIdStore.getContextIds();
+    ContextIdHelper.guard(contextIds, ContextIdKeys.User);
+    const component = ComponentFactory.get(componentName);
+    await component.remove(contextIds[ContextIdKeys.User]);
+    return {
+        statusCode: HttpStatusCode.noContent
+    };
+}
+/**
+ * Get the list of organizations.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export async function identitiesList(httpRequestContext, componentName, request) {
+    const component = ComponentFactory.get(componentName);
+    const publicFilterPairs = HttpParameterHelper.arrayFromString(request?.query?.publicFilters);
+    const publicFilters = publicFilterPairs?.map(pair => {
+        const parts = pair.split(":");
+        return {
+            propertyName: parts[0],
+            propertyValue: parts[1]
+        };
+    });
+    return {
+        body: await component.list(publicFilters, HttpParameterHelper.arrayFromString(request?.query?.publicPropertyNames), request?.query?.cursor, Coerce.integer(request.query?.limit))
+    };
+}
+//# sourceMappingURL=identityProfileRoutes.js.map

package/dist/es/identityProfileRoutes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"identityProfileRoutes.js","sourceRoot":"","sources":["../../src/identityProfileRoutes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EACN,mBAAmB,EAQnB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnF,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAclE,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAEvE;;GAEG;AACH,MAAM,aAAa,GAAG,uBAAuB,CAAC;AAE9C;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAW;IAC1C;QACC,IAAI,EAAE,kBAAkB;QACxB,WAAW,EAAE,uEAAuE;KACpF;CACD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,UAAU,iCAAiC,CAChD,aAAqB,EACrB,aAAqB;IAErB,MAAM,0BAA0B,GAC/B;QACC,WAAW,EAAE,uBAAuB;QACpC,OAAO,EAAE,4BAA4B;QACrC,GAAG,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC,IAAI;QAChC,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,GAAG,aAAa,GAAG;QACzB,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,qBAAqB,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QAClE,WAAW,EAAE;YACZ,IAAI,iCAAyC;YAC7C,QAAQ,EAAE;gBACT;oBACC,EAAE,EAAE,qCAAqC;oBACzC,OAAO,EAAE;wBACR,IAAI,EAAE;4BACL,aAAa,EAAE;gCACd,UAAU,EAAE,oBAAoB;gCAChC,OAAO,EAAE,QAAQ;gCACjB,QAAQ,EAAE,WAAW;gCACrB,IAAI,EAAE,UAAU;6BAChB;4BACD,cAAc,EAAE;gCACf,UAAU,EAAE,oBAAoB;gCAChC,OAAO,EAAE,QAAQ;gCACjB,SAAS,EAAE,gBAAgB;gCAC3B,GAAG,EAAE,wBAAwB;6BAC7B;yBACD;qBACD;iBACD;aACD;SACD;QACD,YAAY,EAAE;YACb;gBACC,IAAI,sBAA8B;aAClC;YACD;gBACC,IAAI,qBAA6B;aACjC;SACD;KACD,CAAC;IAEH,MAAM,uBAAuB,GAGzB;QACH,WAAW,EAAE,oBAAoB;QACjC,OAAO,EAAE,qCAAqC;QAC9C,GAAG,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC,IAAI;QAChC,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,GAAG,aAAa,GAAG;QACzB,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,WAAW,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QACxD,WAAW,EAAE;YACZ,IAAI,8BAAsC;YAC1C,QAAQ,EAAE;gBACT;oBACC,EAAE,EAAE,kCAAkC;oBACtC,OAAO,EAAE;wBACR,KAAK,EAAE;4BACN,mBAAmB,EAAE,eAAe;yBACpC;qBACD;iBACD;aACD;SACD;QACD,YAAY,EAAE;YACb;gBACC,IAAI,+BAAuC;gBAC3C,QAAQ,EAAE;oBACT;wBACC,EAAE,EAAE,4BAA4B;wBAChC,QAAQ,EAAE;4BACT,IAAI,EAAE;gCACL,QAAQ,EACP,iFAAiF;gCAClF,aAAa,EAAE;oCACd,UAAU,EAAE,oBAAoB;oCAChC,OAAO,EAAE,QAAQ;oCACjB,QAAQ,EAAE,WAAW;oCACrB,IAAI,EAAE,UAAU;iCAChB;6BACD;yBACD;qBACD;iBACD;aACD;YACD;gBACC,IAAI,qBAA6B;aACjC;SACD;KACD,CAAC;IAEF,MAAM,6BAA6B,GAG/B;QACH,WAAW,EAAE,0BAA0B;QACvC,OAAO,EAAE,4CAA4C;QACrD,GAAG,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC,IAAI;QAChC,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,GAAG,aAAa,mBAAmB;QACzC,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,iBAAiB,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QAC9D,WAAW,EAAE;YACZ,IAAI,oCAA4C;YAChD,QAAQ,EAAE;gBACT;oBACC,EAAE,EAAE,wCAAwC;oBAC5C,OAAO,EAAE;wBACR,UAAU,EAAE;4BACX,QAAQ,EACP,iFAAiF;yBAClF;wBACD,KAAK,EAAE;4BACN,aAAa,EAAE,iBAAiB;yBAChC;qBACD;iBACD;aACD;SACD;QACD,YAAY,EAAE;YACb;gBACC,IAAI,qCAA6C;gBACjD,QAAQ,EAAE,SAAS,CAAC,MAAM;gBAC1B,QAAQ,EAAE;oBACT;wBACC,EAAE,EAAE,kCAAkC;wBACtC,QAAQ,EAAE;4BACT,OAAO,EAAE;gCACR,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,SAAS,CAAC,MAAM;6BAC3C;4BACD,IAAI,EAAE;gCACL,UAAU,EAAE,oBAAoB;gCAChC,OAAO,EAAE,QAAQ;gCACjB,QAAQ,EAAE,WAAW;gCACrB,IAAI,EAAE,UAAU;6BAChB;yBACD;qBACD;iBACD;aACD;YACD;gBACC,IAAI,qBAA6B;aACjC;SACD;QACD,QAAQ,EAAE,IAAI;KACd,CAAC;IAEF,MAAM,0BAA0B,GAC/B;QACC,WAAW,EAAE,uBAAuB;QACpC,OAAO,EAAE,uCAAuC;QAChD,GAAG,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC,IAAI;QAChC,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,GAAG,aAAa,GAAG;QACzB,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,qBAAqB,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QAClE,WAAW,EAAE;YACZ,IAAI,iCAAyC;YAC7C,QAAQ,EAAE;gBACT;oBACC,EAAE,EAAE,qCAAqC;oBACzC,OAAO,EAAE;wBACR,IAAI,EAAE;4BACL,aAAa,EAAE;gCACd,UAAU,EAAE,oBAAoB;gCAChC,OAAO,EAAE,QAAQ;gCACjB,QAAQ,EAAE,WAAW;gCACrB,IAAI,EAAE,UAAU;6BAChB;4BACD,cAAc,EAAE;gCACf,UAAU,EAAE,oBAAoB;gCAChC,OAAO,EAAE,QAAQ;gCACjB,SAAS,EAAE,gBAAgB;gCAC3B,GAAG,EAAE,wBAAwB;6BAC7B;yBACD;qBACD;iBACD;aACD;SACD;QACD,YAAY,EAAE;YACb;gBACC,IAAI,sBAA8B;aAClC;YACD;gBACC,IAAI,qBAA6B;aACjC;SACD;KACD,CAAC;IAEH,MAAM,0BAA0B,GAAsD;QACrF,WAAW,EAAE,uBAAuB;QACpC,OAAO,EAAE,4BAA4B;QACrC,GAAG,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC,IAAI;QAChC,MAAM,EAAE,QAAQ;QAChB,IAAI,EAAE,GAAG,aAAa,GAAG;QACzB,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,qBAAqB,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QAClE,YAAY,EAAE;YACb;gBACC,IAAI,sBAA8B;aAClC;YACD;gBACC,IAAI,qBAA6B;aACjC;SACD;KACD,CAAC;IAEF,MAAM,wBAAwB,GAG1B;QACH,WAAW,EAAE,uBAAuB;QACpC,OAAO,EAAE,6CAA6C;QACtD,GAAG,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC,IAAI;QAChC,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,GAAG,aAAa,SAAS;QAC/B,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,EAAE,CAC9C,cAAc,CAAC,kBAAkB,EAAE,aAAa,EAAE,OAAO,CAAC;QAC3D,WAAW,EAAE;YACZ,IAAI,+BAAuC;YAC3C,QAAQ,EAAE;gBACT;oBACC,EAAE,EAAE,mCAAmC;oBACvC,OAAO,EAAE;wBACR,KAAK,EAAE,EAAE;qBACT;iBACD;gBACD;oBACC,EAAE,EAAE,2CAA2C;oBAC/C,OAAO,EAAE;wBACR,KAAK,EAAE;4BACN,aAAa,EAAE,oBAAoB;yBACnC;qBACD;iBACD;aACD;SACD;QACD,YAAY,EAAE;YACb;gBACC,IAAI,gCAAwC;gBAC5C,QAAQ,EAAE;oBACT;wBACC,EAAE,EAAE,sCAAsC;wBAC1C,QAAQ,EAAE;4BACT,IAAI,EAAE;gCACL,KAAK,EAAE;oCACN;wCACC,QAAQ,EACP,iFAAiF;wCAClF,aAAa,EAAE;4CACd,UAAU,EAAE,oBAAoB;4CAChC,OAAO,EAAE,QAAQ;4CACjB,QAAQ,EAAE,WAAW;4CACrB,IAAI,EAAE,UAAU;yCAChB;qCACD;iCACD;gCACD,MAAM,EAAE,GAAG;6BACX;yBACD;qBACD;iBACD;aACD;SACD;KACD,CAAC;IAEF,OAAO;QACN,0BAA0B;QAC1B,uBAAuB;QACvB,6BAA6B;QAC7B,0BAA0B;QAC1B,0BAA0B;QAC1B,wBAAwB;KACxB,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAC1C,kBAAuC,EACvC,aAAqB,EACrB,OAAsC;IAEtC,MAAM,CAAC,MAAM,CAAgC,aAAa,aAAmB,OAAO,CAAC,CAAC;IACtF,MAAM,CAAC,MAAM,CACZ,aAAa,kBAEb,OAAO,CAAC,IAAI,CACZ,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,aAAa,EAAE,CAAC;IACxD,eAAe,CAAC,KAAK,CAAC,UAAU,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;IAEtD,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA4B,aAAa,CAAC,CAAC;IAEjF,MAAM,SAAS,CAAC,MAAM,CACrB,OAAO,CAAC,IAAI,CAAC,aAAa,EAC1B,OAAO,CAAC,IAAI,CAAC,cAAc,EAC3B,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,CAC9B,CAAC;IAEF,OAAO;QACN,UAAU,EAAE,cAAc,CAAC,SAAS;KACpC,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAChC,kBAAuC,EACvC,aAAqB,EACrB,OAAmC;IAEnC,MAAM,CAAC,MAAM,CAA6B,aAAa,aAAmB,OAAO,CAAC,CAAC;IAEnF,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,aAAa,EAAE,CAAC;IACxD,eAAe,CAAC,KAAK,CAAC,UAAU,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;IAEtD,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA4B,aAAa,CAAC,CAAC;IAEjF,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,GAAG,CACjC,mBAAmB,CAAC,eAAe,CAAwB,OAAO,EAAE,KAAK,EAAE,mBAAmB,CAAC,EAC/F,mBAAmB,CAAC,eAAe,CAClC,OAAO,EAAE,KAAK,EAAE,oBAAoB,CACpC,EACD,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,CAC9B,CAAC;IAEF,OAAO;QACN,IAAI,EAAE,MAAM;KACZ,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACtC,kBAAuC,EACvC,aAAqB,EACrB,OAAyC;IAEzC,MAAM,CAAC,MAAM,CAAmC,aAAa,aAAmB,OAAO,CAAC,CAAC;IACzF,MAAM,CAAC,WAAW,CACjB,aAAa,iCAEb,OAAO,CAAC,UAAU,EAAE,QAAQ,CAC5B,CAAC;IAEF,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA4B,aAAa,CAAC,CAAC;IAEjF,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,SAAS,CACvC,OAAO,EAAE,UAAU,CAAC,QAAQ,EAC5B,mBAAmB,CAAC,eAAe,CAAwB,OAAO,EAAE,KAAK,EAAE,aAAa,CAAC,CACzF,CAAC;IAEF,OAAO;QACN,OAAO,EAAE;YACR,CAAC,WAAW,CAAC,WAAW,CAAC,EAAE,SAAS,CAAC,MAAM;SAC3C;QACD,IAAI,EAAE,MAAM;KACZ,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAC1C,kBAAuC,EACvC,aAAqB,EACrB,OAAsC;IAEtC,MAAM,CAAC,MAAM,CAAgC,aAAa,aAAmB,OAAO,CAAC,CAAC;IAEtF,MAAM,CAAC,MAAM,CACZ,aAAa,kBAEb,OAAO,CAAC,IAAI,CACZ,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,aAAa,EAAE,CAAC;IACxD,eAAe,CAAC,KAAK,CAAC,UAAU,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;IAEtD,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA4B,aAAa,CAAC,CAAC;IAEjF,MAAM,SAAS,CAAC,MAAM,CACrB,OAAO,CAAC,IAAI,CAAC,aAAa,EAC1B,OAAO,CAAC,IAAI,CAAC,cAAc,EAC3B,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,CAC9B,CAAC;IAEF,OAAO;QACN,UAAU,EAAE,cAAc,CAAC,SAAS;KACpC,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAC1C,kBAAuC,EACvC,aAAqB,EACrB,OAA0B;IAE1B,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,aAAa,EAAE,CAAC;IACxD,eAAe,CAAC,KAAK,CAAC,UAAU,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;IAEtD,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA4B,aAAa,CAAC,CAAC;IAEjF,MAAM,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;IAEvD,OAAO;QACN,UAAU,EAAE,cAAc,CAAC,SAAS;KACpC,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CACnC,kBAAuC,EACvC,aAAqB,EACrB,OAAoC;IAEpC,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA4B,aAAa,CAAC,CAAC;IAEjF,MAAM,iBAAiB,GAAG,mBAAmB,CAAC,eAAe,CAAC,OAAO,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;IAC7F,MAAM,aAAa,GAAG,iBAAiB,EAAE,GAAG,CAAC,IAAI,CAAC,EAAE;QACnD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC9B,OAAO;YACN,YAAY,EAAE,KAAK,CAAC,CAAC,CAAC;YACtB,aAAa,EAAE,KAAK,CAAC,CAAC,CAAC;SACvB,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO;QACN,IAAI,EAAE,MAAM,SAAS,CAAC,IAAI,CACzB,aAAa,EACb,mBAAmB,CAAC,eAAe,CAClC,OAAO,EAAE,KAAK,EAAE,mBAAmB,CACnC,EACD,OAAO,EAAE,KAAK,EAAE,MAAM,EACtB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CACpC;KACD,CAAC;AACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport {\n\tHttpParameterHelper,\n\ttype IConflictResponse,\n\ttype IHttpRequestContext,\n\ttype INoContentRequest,\n\ttype INoContentResponse,\n\ttype INotFoundResponse,\n\ttype IRestRoute,\n\ttype ITag\n} from \"@twin.org/api-models\";\nimport { ContextIdHelper, ContextIdKeys, ContextIdStore } from \"@twin.org/context\";\nimport { Coerce, ComponentFactory, Guards } from \"@twin.org/core\";\nimport type { IJsonLdDocument } from \"@twin.org/data-json-ld\";\nimport type {\n\tIIdentityProfileComponent,\n\tIIdentityProfileCreateRequest,\n\tIIdentityProfileGetPublicRequest,\n\tIIdentityProfileGetPublicResponse,\n\tIIdentityProfileGetRequest,\n\tIIdentityProfileGetResponse,\n\tIIdentityProfileListRequest,\n\tIIdentityProfileListResponse,\n\tIIdentityProfileUpdateRequest\n} from \"@twin.org/identity-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { HeaderTypes, HttpStatusCode, MimeTypes } from \"@twin.org/web\";\n\n/**\n * The source used when communicating about these routes.\n */\nconst ROUTES_SOURCE = \"identityProfileRoutes\";\n\n/**\n * The tag to associate with the routes.\n */\nexport const tagsIdentityProfile: ITag[] = [\n\t{\n\t\tname: \"Identity Profile\",\n\t\tdescription: \"Service to provide all features related to digital identity profiles.\"\n\t}\n];\n\n/**\n * The REST routes for identity.\n * @param baseRouteName Prefix to prepend to the paths.\n * @param componentName The name of the component to use in the routes stored in the ComponentFactory.\n * @returns The generated routes.\n */\nexport function generateRestRoutesIdentityProfile(\n\tbaseRouteName: string,\n\tcomponentName: string\n): IRestRoute[] {\n\tconst identityProfileCreateRoute: IRestRoute<IIdentityProfileCreateRequest, INoContentResponse> =\n\t\t{\n\t\t\toperationId: \"identityProfileCreate\",\n\t\t\tsummary: \"Create an identity profile\",\n\t\t\ttag: tagsIdentityProfile[0].name,\n\t\t\tmethod: \"POST\",\n\t\t\tpath: `${baseRouteName}/`,\n\t\t\thandler: async (httpRequestContext, request) =>\n\t\t\t\tidentityProfileCreate(httpRequestContext, componentName, request),\n\t\t\trequestType: {\n\t\t\t\ttype: nameof<IIdentityProfileCreateRequest>(),\n\t\t\t\texamples: [\n\t\t\t\t\t{\n\t\t\t\t\t\tid: \"identityProfileCreateRequestExample\",\n\t\t\t\t\t\trequest: {\n\t\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\t\tpublicProfile: {\n\t\t\t\t\t\t\t\t\t\"@context\": \"https://schema.org\",\n\t\t\t\t\t\t\t\t\t\"@type\": \"Person\",\n\t\t\t\t\t\t\t\t\tjobTitle: \"Professor\",\n\t\t\t\t\t\t\t\t\tname: \"Jane Doe\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tprivateProfile: {\n\t\t\t\t\t\t\t\t\t\"@context\": \"https://schema.org\",\n\t\t\t\t\t\t\t\t\t\"@type\": \"Person\",\n\t\t\t\t\t\t\t\t\ttelephone: \"(425) 123-4567\",\n\t\t\t\t\t\t\t\t\turl: \"http://www.janedoe.com\"\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t},\n\t\t\tresponseType: [\n\t\t\t\t{\n\t\t\t\t\ttype: nameof<INoContentResponse>()\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\ttype: nameof<IConflictResponse>()\n\t\t\t\t}\n\t\t\t]\n\t\t};\n\n\tconst identityProfileGetRoute: IRestRoute<\n\t\tIIdentityProfileGetRequest,\n\t\tIIdentityProfileGetResponse\n\t> = {\n\t\toperationId: \"identityProfileGet\",\n\t\tsummary: \"Get the identity profile properties\",\n\t\ttag: tagsIdentityProfile[0].name,\n\t\tmethod: \"GET\",\n\t\tpath: `${baseRouteName}/`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tidentityGet(httpRequestContext, componentName, request),\n\t\trequestType: {\n\t\t\ttype: nameof<IIdentityProfileGetRequest>(),\n\t\t\texamples: [\n\t\t\t\t{\n\t\t\t\t\tid: \"identityGetProfileRequestExample\",\n\t\t\t\t\trequest: {\n\t\t\t\t\t\tquery: {\n\t\t\t\t\t\t\tpublicPropertyNames: \"name,jobTitle\"\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: nameof<IIdentityProfileGetResponse>(),\n\t\t\t\texamples: [\n\t\t\t\t\t{\n\t\t\t\t\t\tid: \"identityGetResponseExample\",\n\t\t\t\t\t\tresponse: {\n\t\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\t\tidentity:\n\t\t\t\t\t\t\t\t\t\"did:iota:tst:0xc57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70\",\n\t\t\t\t\t\t\t\tpublicProfile: {\n\t\t\t\t\t\t\t\t\t\"@context\": \"https://schema.org\",\n\t\t\t\t\t\t\t\t\t\"@type\": \"Person\",\n\t\t\t\t\t\t\t\t\tjobTitle: \"Professor\",\n\t\t\t\t\t\t\t\t\tname: \"Jane Doe\"\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t},\n\t\t\t{\n\t\t\t\ttype: nameof<INotFoundResponse>()\n\t\t\t}\n\t\t]\n\t};\n\n\tconst identityProfileGetPublicRoute: IRestRoute<\n\t\tIIdentityProfileGetPublicRequest,\n\t\tIIdentityProfileGetPublicResponse\n\t> = {\n\t\toperationId: \"identityProfileGetPublic\",\n\t\tsummary: \"Get the identity profile public properties\",\n\t\ttag: tagsIdentityProfile[0].name,\n\t\tmethod: \"GET\",\n\t\tpath: `${baseRouteName}/:identity/public`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tidentityGetPublic(httpRequestContext, componentName, request),\n\t\trequestType: {\n\t\t\ttype: nameof<IIdentityProfileGetPublicRequest>(),\n\t\t\texamples: [\n\t\t\t\t{\n\t\t\t\t\tid: \"identityGetPublicProfileRequestExample\",\n\t\t\t\t\trequest: {\n\t\t\t\t\t\tpathParams: {\n\t\t\t\t\t\t\tidentity:\n\t\t\t\t\t\t\t\t\"did:iota:tst:0xc57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\tquery: {\n\t\t\t\t\t\t\tpropertyNames: \"role,email,name\"\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: nameof<IIdentityProfileGetPublicResponse>(),\n\t\t\t\tmimeType: MimeTypes.JsonLd,\n\t\t\t\texamples: [\n\t\t\t\t\t{\n\t\t\t\t\t\tid: \"identityGetPublicResponseExample\",\n\t\t\t\t\t\tresponse: {\n\t\t\t\t\t\t\theaders: {\n\t\t\t\t\t\t\t\t[HeaderTypes.ContentType]: MimeTypes.JsonLd\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\t\t\"@context\": \"https://schema.org\",\n\t\t\t\t\t\t\t\t\"@type\": \"Person\",\n\t\t\t\t\t\t\t\tjobTitle: \"Professor\",\n\t\t\t\t\t\t\t\tname: \"Jane Doe\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t},\n\t\t\t{\n\t\t\t\ttype: nameof<INotFoundResponse>()\n\t\t\t}\n\t\t],\n\t\tskipAuth: true\n\t};\n\n\tconst identityProfileUpdateRoute: IRestRoute<IIdentityProfileUpdateRequest, INoContentResponse> =\n\t\t{\n\t\t\toperationId: \"identityProfileUpdate\",\n\t\t\tsummary: \"Update an identity profile properties\",\n\t\t\ttag: tagsIdentityProfile[0].name,\n\t\t\tmethod: \"PUT\",\n\t\t\tpath: `${baseRouteName}/`,\n\t\t\thandler: async (httpRequestContext, request) =>\n\t\t\t\tidentityProfileUpdate(httpRequestContext, componentName, request),\n\t\t\trequestType: {\n\t\t\t\ttype: nameof<IIdentityProfileUpdateRequest>(),\n\t\t\t\texamples: [\n\t\t\t\t\t{\n\t\t\t\t\t\tid: \"identityProfileUpdateRequestExample\",\n\t\t\t\t\t\trequest: {\n\t\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\t\tpublicProfile: {\n\t\t\t\t\t\t\t\t\t\"@context\": \"https://schema.org\",\n\t\t\t\t\t\t\t\t\t\"@type\": \"Person\",\n\t\t\t\t\t\t\t\t\tjobTitle: \"Professor\",\n\t\t\t\t\t\t\t\t\tname: \"Jane Doe\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\tprivateProfile: {\n\t\t\t\t\t\t\t\t\t\"@context\": \"https://schema.org\",\n\t\t\t\t\t\t\t\t\t\"@type\": \"Person\",\n\t\t\t\t\t\t\t\t\ttelephone: \"(425) 123-4567\",\n\t\t\t\t\t\t\t\t\turl: \"http://www.janedoe.com\"\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t},\n\t\t\tresponseType: [\n\t\t\t\t{\n\t\t\t\t\ttype: nameof<INoContentResponse>()\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\ttype: nameof<INotFoundResponse>()\n\t\t\t\t}\n\t\t\t]\n\t\t};\n\n\tconst identityProfileRemoveRoute: IRestRoute<INoContentRequest, INoContentResponse> = {\n\t\toperationId: \"identityProfileRemove\",\n\t\tsummary: \"Remove an identity profile\",\n\t\ttag: tagsIdentityProfile[0].name,\n\t\tmethod: \"DELETE\",\n\t\tpath: `${baseRouteName}/`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tidentityProfileRemove(httpRequestContext, componentName, request),\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: nameof<INoContentResponse>()\n\t\t\t},\n\t\t\t{\n\t\t\t\ttype: nameof<INotFoundResponse>()\n\t\t\t}\n\t\t]\n\t};\n\n\tconst identityProfileListRoute: IRestRoute<\n\t\tIIdentityProfileListRequest,\n\t\tIIdentityProfileListResponse\n\t> = {\n\t\toperationId: \"identitiesProfileList\",\n\t\tsummary: \"Get the list of profile data for identities\",\n\t\ttag: tagsIdentityProfile[0].name,\n\t\tmethod: \"GET\",\n\t\tpath: `${baseRouteName}/query/`,\n\t\thandler: async (httpRequestContext, request) =>\n\t\t\tidentitiesList(httpRequestContext, componentName, request),\n\t\trequestType: {\n\t\t\ttype: nameof<IIdentityProfileListRequest>(),\n\t\t\texamples: [\n\t\t\t\t{\n\t\t\t\t\tid: \"identityProfileListRequestExample\",\n\t\t\t\t\trequest: {\n\t\t\t\t\t\tquery: {}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tid: \"identityProfileListRequestFilteredExample\",\n\t\t\t\t\trequest: {\n\t\t\t\t\t\tquery: {\n\t\t\t\t\t\t\tpublicFilters: \"jobTitle:Professor\"\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\tresponseType: [\n\t\t\t{\n\t\t\t\ttype: nameof<IIdentityProfileListResponse>(),\n\t\t\t\texamples: [\n\t\t\t\t\t{\n\t\t\t\t\t\tid: \"identitiesProfileListResponseExample\",\n\t\t\t\t\t\tresponse: {\n\t\t\t\t\t\t\tbody: {\n\t\t\t\t\t\t\t\titems: [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\tidentity:\n\t\t\t\t\t\t\t\t\t\t\t\"did:iota:tst:0xc57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70\",\n\t\t\t\t\t\t\t\t\t\tpublicProfile: {\n\t\t\t\t\t\t\t\t\t\t\t\"@context\": \"https://schema.org\",\n\t\t\t\t\t\t\t\t\t\t\t\"@type\": \"Person\",\n\t\t\t\t\t\t\t\t\t\t\tjobTitle: \"Professor\",\n\t\t\t\t\t\t\t\t\t\t\tname: \"Jane Doe\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t],\n\t\t\t\t\t\t\t\tcursor: \"1\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t}\n\t\t]\n\t};\n\n\treturn [\n\t\tidentityProfileCreateRoute,\n\t\tidentityProfileGetRoute,\n\t\tidentityProfileGetPublicRoute,\n\t\tidentityProfileUpdateRoute,\n\t\tidentityProfileRemoveRoute,\n\t\tidentityProfileListRoute\n\t];\n}\n\n/**\n * Create an identity profile.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes stored in the ComponentFactory.\n * @param request The request.\n * @returns The response object with additional http response properties.\n */\nexport async function identityProfileCreate(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: IIdentityProfileCreateRequest\n): Promise<INoContentResponse> {\n\tGuards.object<IIdentityProfileCreateRequest>(ROUTES_SOURCE, nameof(request), request);\n\tGuards.object<IIdentityProfileCreateRequest[\"body\"]>(\n\t\tROUTES_SOURCE,\n\t\tnameof(request.body),\n\t\trequest.body\n\t);\n\n\tconst contextIds = await ContextIdStore.getContextIds();\n\tContextIdHelper.guard(contextIds, ContextIdKeys.User);\n\n\tconst component = ComponentFactory.get<IIdentityProfileComponent>(componentName);\n\n\tawait component.create(\n\t\trequest.body.publicProfile,\n\t\trequest.body.privateProfile,\n\t\tcontextIds[ContextIdKeys.User]\n\t);\n\n\treturn {\n\t\tstatusCode: HttpStatusCode.noContent\n\t};\n}\n\n/**\n * Get the identity profile.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes stored in the ComponentFactory.\n * @param request The request.\n * @returns The response object with additional http response properties.\n */\nexport async function identityGet(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: IIdentityProfileGetRequest\n): Promise<IIdentityProfileGetResponse> {\n\tGuards.object<IIdentityProfileGetRequest>(ROUTES_SOURCE, nameof(request), request);\n\n\tconst contextIds = await ContextIdStore.getContextIds();\n\tContextIdHelper.guard(contextIds, ContextIdKeys.User);\n\n\tconst component = ComponentFactory.get<IIdentityProfileComponent>(componentName);\n\n\tconst result = await component.get(\n\t\tHttpParameterHelper.arrayFromString<keyof IJsonLdDocument>(request?.query?.publicPropertyNames),\n\t\tHttpParameterHelper.arrayFromString<keyof IJsonLdDocument>(\n\t\t\trequest?.query?.privatePropertyNames\n\t\t),\n\t\tcontextIds[ContextIdKeys.User]\n\t);\n\n\treturn {\n\t\tbody: result\n\t};\n}\n\n/**\n * Get the identity public profile.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes stored in the ComponentFactory.\n * @param request The request.\n * @returns The response object with additional http response properties.\n */\nexport async function identityGetPublic(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: IIdentityProfileGetPublicRequest\n): Promise<IIdentityProfileGetPublicResponse> {\n\tGuards.object<IIdentityProfileGetPublicRequest>(ROUTES_SOURCE, nameof(request), request);\n\tGuards.stringValue(\n\t\tROUTES_SOURCE,\n\t\tnameof(request.pathParams?.identity),\n\t\trequest.pathParams?.identity\n\t);\n\n\tconst component = ComponentFactory.get<IIdentityProfileComponent>(componentName);\n\n\tconst result = await component.getPublic(\n\t\trequest?.pathParams.identity,\n\t\tHttpParameterHelper.arrayFromString<keyof IJsonLdDocument>(request?.query?.propertyNames)\n\t);\n\n\treturn {\n\t\theaders: {\n\t\t\t[HeaderTypes.ContentType]: MimeTypes.JsonLd\n\t\t},\n\t\tbody: result\n\t};\n}\n\n/**\n * Update an identity profile.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes stored in the ComponentFactory.\n * @param request The request.\n * @returns The response object with additional http response properties.\n */\nexport async function identityProfileUpdate(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: IIdentityProfileUpdateRequest\n): Promise<INoContentResponse> {\n\tGuards.object<IIdentityProfileUpdateRequest>(ROUTES_SOURCE, nameof(request), request);\n\n\tGuards.object<IIdentityProfileUpdateRequest[\"body\"]>(\n\t\tROUTES_SOURCE,\n\t\tnameof(request.body),\n\t\trequest.body\n\t);\n\n\tconst contextIds = await ContextIdStore.getContextIds();\n\tContextIdHelper.guard(contextIds, ContextIdKeys.User);\n\n\tconst component = ComponentFactory.get<IIdentityProfileComponent>(componentName);\n\n\tawait component.update(\n\t\trequest.body.publicProfile,\n\t\trequest.body.privateProfile,\n\t\tcontextIds[ContextIdKeys.User]\n\t);\n\n\treturn {\n\t\tstatusCode: HttpStatusCode.noContent\n\t};\n}\n\n/**\n * Remove an identity profile.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes stored in the ComponentFactory.\n * @param request The request.\n * @returns The response object with additional http response properties.\n */\nexport async function identityProfileRemove(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: INoContentRequest\n): Promise<INoContentResponse> {\n\tconst contextIds = await ContextIdStore.getContextIds();\n\tContextIdHelper.guard(contextIds, ContextIdKeys.User);\n\n\tconst component = ComponentFactory.get<IIdentityProfileComponent>(componentName);\n\n\tawait component.remove(contextIds[ContextIdKeys.User]);\n\n\treturn {\n\t\tstatusCode: HttpStatusCode.noContent\n\t};\n}\n\n/**\n * Get the list of organizations.\n * @param httpRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes stored in the ComponentFactory.\n * @param request The request.\n * @returns The response object with additional http response properties.\n */\nexport async function identitiesList(\n\thttpRequestContext: IHttpRequestContext,\n\tcomponentName: string,\n\trequest: IIdentityProfileListRequest\n): Promise<IIdentityProfileListResponse> {\n\tconst component = ComponentFactory.get<IIdentityProfileComponent>(componentName);\n\n\tconst publicFilterPairs = HttpParameterHelper.arrayFromString(request?.query?.publicFilters);\n\tconst publicFilters = publicFilterPairs?.map(pair => {\n\t\tconst parts = pair.split(\":\");\n\t\treturn {\n\t\t\tpropertyName: parts[0],\n\t\t\tpropertyValue: parts[1]\n\t\t};\n\t});\n\n\treturn {\n\t\tbody: await component.list(\n\t\t\tpublicFilters,\n\t\t\tHttpParameterHelper.arrayFromString<keyof IJsonLdDocument>(\n\t\t\t\trequest?.query?.publicPropertyNames\n\t\t\t),\n\t\t\trequest?.query?.cursor,\n\t\t\tCoerce.integer(request.query?.limit)\n\t\t)\n\t};\n}\n"]}

package/dist/es/identityProfileService.js

@@ -0,0 +1,165 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { BaseError, GeneralError, Guards, Is, NotFoundError } from "@twin.org/core";
+import { IdentityProfileConnectorFactory } from "@twin.org/identity-models";
+import { IdentityService } from "./identityService.js";
+/**
+ * Class which implements the identity profile contract.
+ */
+export class IdentityProfileService {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "IdentityProfileService";
+    /**
+     * The identity profile connector.
+     * @internal
+     */
+    _identityProfileConnector;
+    /**
+     * Create a new instance of IdentityProfileService.
+     * @param options The dependencies for the identity profile service.
+     */
+    constructor(options) {
+        this._identityProfileConnector = IdentityProfileConnectorFactory.get(options?.profileEntityConnectorType ?? "identity-profile");
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return IdentityService.CLASS_NAME;
+    }
+    /**
+     * Create the profile properties for an identity.
+     * @param publicProfile The public profile data as JSON-LD.
+     * @param privateProfile The private profile data as JSON-LD.
+     * @param identity The identity to perform the profile operation on.
+     * @returns Nothing.
+     */
+    async create(publicProfile, privateProfile, identity) {
+        Guards.stringValue(IdentityProfileService.CLASS_NAME, "identity", identity);
+        try {
+            await this._identityProfileConnector.create(identity, publicProfile, privateProfile);
+        }
+        catch (error) {
+            if (BaseError.someErrorClass(error, IdentityProfileService.CLASS_NAME)) {
+                throw error;
+            }
+            throw new GeneralError(IdentityProfileService.CLASS_NAME, "createFailed", { identity }, error);
+        }
+    }
+    /**
+     * Get the profile properties for an identity.
+     * @param publicPropertyNames The public properties to get for the profile, defaults to all.
+     * @param privatePropertyNames The private properties to get for the profile, defaults to all.
+     * @param identity The identity to perform the profile operation on.
+     * @returns The items identity and the properties.
+     */
+    async get(publicPropertyNames, privatePropertyNames, identity) {
+        Guards.stringValue(IdentityProfileService.CLASS_NAME, "identity", identity);
+        try {
+            const result = await this._identityProfileConnector.get(identity, publicPropertyNames, privatePropertyNames);
+            if (Is.undefined(result)) {
+                throw new NotFoundError(IdentityProfileService.CLASS_NAME, "notFound", identity);
+            }
+            return {
+                identity,
+                publicProfile: result.publicProfile,
+                privateProfile: result.privateProfile
+            };
+        }
+        catch (error) {
+            if (BaseError.someErrorClass(error, IdentityProfileService.CLASS_NAME)) {
+                throw error;
+            }
+            throw new GeneralError(IdentityProfileService.CLASS_NAME, "getFailed", undefined, error);
+        }
+    }
+    /**
+     * Get the public profile properties for an identity.
+     * @param identity The identity to perform the profile operation on.
+     * @param propertyNames The properties to get for the item, defaults to all.
+     * @returns The items properties.
+     */
+    async getPublic(identity, propertyNames) {
+        Guards.stringValue(IdentityProfileService.CLASS_NAME, "identity", identity);
+        try {
+            const result = await this._identityProfileConnector.get(identity, propertyNames);
+            if (Is.undefined(result)) {
+                throw new NotFoundError(IdentityProfileService.CLASS_NAME, "notFound", identity);
+            }
+            return result.publicProfile;
+        }
+        catch (error) {
+            if (BaseError.someErrorClass(error, IdentityProfileService.CLASS_NAME)) {
+                throw error;
+            }
+            throw new GeneralError(IdentityProfileService.CLASS_NAME, "getPublicFailed", undefined, error);
+        }
+    }
+    /**
+     * Update the profile properties of an identity.
+     * @param publicProfile The public profile data as JSON-LD.
+     * @param privateProfile The private profile data as JSON-LD.
+     * @param identity The identity to perform the profile operation on.
+     * @returns Nothing.
+     */
+    async update(publicProfile, privateProfile, identity) {
+        Guards.stringValue(IdentityProfileService.CLASS_NAME, "identity", identity);
+        try {
+            const result = await this._identityProfileConnector.get(identity);
+            if (Is.undefined(result)) {
+                throw new NotFoundError(IdentityProfileService.CLASS_NAME, "notFound", identity);
+            }
+            await this._identityProfileConnector.update(identity, publicProfile, privateProfile);
+        }
+        catch (error) {
+            if (BaseError.someErrorClass(error, IdentityProfileService.CLASS_NAME)) {
+                throw error;
+            }
+            throw new GeneralError(IdentityProfileService.CLASS_NAME, "updateFailed", { identity }, error);
+        }
+    }
+    /**
+     * Delete the profile for an identity.
+     * @param identity The identity to perform the profile operation on.
+     * @returns Nothing.
+     */
+    async remove(identity) {
+        Guards.stringValue(IdentityProfileService.CLASS_NAME, "identity", identity);
+        try {
+            const result = await this._identityProfileConnector.get(identity);
+            if (Is.undefined(result)) {
+                throw new NotFoundError(IdentityProfileService.CLASS_NAME, "notFound", identity);
+            }
+            await this._identityProfileConnector.remove(identity);
+        }
+        catch (error) {
+            if (BaseError.someErrorClass(error, IdentityProfileService.CLASS_NAME)) {
+                throw error;
+            }
+            throw new GeneralError(IdentityProfileService.CLASS_NAME, "removeFailed", { identity }, error);
+        }
+    }
+    /**
+     * Get a list of the requested types.
+     * @param publicFilters The filters to apply to the identities public profiles.
+     * @param publicPropertyNames The public properties to get for the profile, defaults to all.
+     * @param cursor The cursor for paged requests.
+     * @param limit The maximum number of items in a page.
+     * @returns The list of items and cursor for paging.
+     */
+    async list(publicFilters, publicPropertyNames, cursor, limit) {
+        try {
+            // We don't want to return private profile for this type of query
+            // as it would expose the values to the REST api
+            const result = await this._identityProfileConnector.list(publicFilters, undefined, publicPropertyNames, undefined, cursor, limit);
+            return result;
+        }
+        catch (error) {
+            throw new GeneralError(IdentityProfileService.CLASS_NAME, "listFailed", undefined, error);
+        }
+    }
+}
+//# sourceMappingURL=identityProfileService.js.map

package/dist/es/identityProfileService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"identityProfileService.js","sourceRoot":"","sources":["../../src/identityProfileService.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAEpF,OAAO,EACN,+BAA+B,EAG/B,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAGvD;;GAEG;AACH,MAAM,OAAO,sBAAsB;IAKlC;;OAEG;IACI,MAAM,CAAU,UAAU,4BAA4C;IAE7E;;;OAGG;IACc,yBAAyB,CAAkC;IAE5E;;;OAGG;IACH,YAAY,OAAmD;QAC9D,IAAI,CAAC,yBAAyB,GAAG,+BAA+B,CAAC,GAAG,CAElE,OAAO,EAAE,0BAA0B,IAAI,kBAAkB,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,eAAe,CAAC,UAAU,CAAC;IACnC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CAAC,aAAiB,EAAE,cAAkB,EAAE,QAAiB;QAC3E,MAAM,CAAC,WAAW,CAAC,sBAAsB,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAElF,IAAI,CAAC;YACJ,MAAM,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,QAAQ,EAAE,aAAa,EAAE,cAAc,CAAC,CAAC;QACtF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,sBAAsB,CAAC,UAAU,CAAC,EAAE,CAAC;gBACxE,MAAM,KAAK,CAAC;YACb,CAAC;YACD,MAAM,IAAI,YAAY,CACrB,sBAAsB,CAAC,UAAU,EACjC,cAAc,EACd,EAAE,QAAQ,EAAE,EACZ,KAAK,CACL,CAAC;QACH,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,GAAG,CACf,mBAAiC,EACjC,oBAAkC,EAClC,QAAiB;QAMjB,MAAM,CAAC,WAAW,CAAC,sBAAsB,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAElF,IAAI,CAAC;YACJ,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,GAAG,CACtD,QAAQ,EACR,mBAAmB,EACnB,oBAAoB,CACpB,CAAC;YACF,IAAI,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC1B,MAAM,IAAI,aAAa,CAAC,sBAAsB,CAAC,UAAU,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;YAClF,CAAC;YACD,OAAO;gBACN,QAAQ;gBACR,aAAa,EAAE,MAAM,CAAC,aAAa;gBACnC,cAAc,EAAE,MAAM,CAAC,cAAc;aACrC,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,sBAAsB,CAAC,UAAU,CAAC,EAAE,CAAC;gBACxE,MAAM,KAAK,CAAC;YACb,CAAC;YACD,MAAM,IAAI,YAAY,CAAC,sBAAsB,CAAC,UAAU,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;QAC1F,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,SAAS,CAAC,QAAgB,EAAE,aAA2B;QACnE,MAAM,CAAC,WAAW,CAAC,sBAAsB,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAElF,IAAI,CAAC;YACJ,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;YACjF,IAAI,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC1B,MAAM,IAAI,aAAa,CAAC,sBAAsB,CAAC,UAAU,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;YAClF,CAAC;YACD,OAAO,MAAM,CAAC,aAAa,CAAC;QAC7B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,sBAAsB,CAAC,UAAU,CAAC,EAAE,CAAC;gBACxE,MAAM,KAAK,CAAC;YACb,CAAC;YACD,MAAM,IAAI,YAAY,CACrB,sBAAsB,CAAC,UAAU,EACjC,iBAAiB,EACjB,SAAS,EACT,KAAK,CACL,CAAC;QACH,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CAAC,aAAiB,EAAE,cAAkB,EAAE,QAAiB;QAC3E,MAAM,CAAC,WAAW,CAAC,sBAAsB,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAElF,IAAI,CAAC;YACJ,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAClE,IAAI,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC1B,MAAM,IAAI,aAAa,CAAC,sBAAsB,CAAC,UAAU,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;YAClF,CAAC;YACD,MAAM,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,QAAQ,EAAE,aAAa,EAAE,cAAc,CAAC,CAAC;QACtF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,sBAAsB,CAAC,UAAU,CAAC,EAAE,CAAC;gBACxE,MAAM,KAAK,CAAC;YACb,CAAC;YACD,MAAM,IAAI,YAAY,CACrB,sBAAsB,CAAC,UAAU,EACjC,cAAc,EACd,EAAE,QAAQ,EAAE,EACZ,KAAK,CACL,CAAC;QACH,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,MAAM,CAAC,QAAiB;QACpC,MAAM,CAAC,WAAW,CAAC,sBAAsB,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAElF,IAAI,CAAC;YACJ,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAClE,IAAI,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC1B,MAAM,IAAI,aAAa,CAAC,sBAAsB,CAAC,UAAU,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;YAClF,CAAC;YACD,MAAM,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACvD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,IAAI,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,sBAAsB,CAAC,UAAU,CAAC,EAAE,CAAC;gBACxE,MAAM,KAAK,CAAC;YACb,CAAC;YACD,MAAM,IAAI,YAAY,CACrB,sBAAsB,CAAC,UAAU,EACjC,cAAc,EACd,EAAE,QAAQ,EAAE,EACZ,KAAK,CACL,CAAC;QACH,CAAC;IACF,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,IAAI,CAChB,aAGG,EACH,mBAAiC,EACjC,MAAe,EACf,KAAc;QAWd,IAAI,CAAC;YACJ,iEAAiE;YACjE,gDAAgD;YAChD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,IAAI,CACvD,aAAa,EACb,SAAS,EACT,mBAAmB,EACnB,SAAS,EACT,MAAM,EACN,KAAK,CACL,CAAC;YACF,OAAO,MAAM,CAAC;QACf,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,YAAY,CAAC,sBAAsB,CAAC,UAAU,EAAE,YAAY,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;QAC3F,CAAC;IACF,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { BaseError, GeneralError, Guards, Is, NotFoundError } from \"@twin.org/core\";\nimport type { IJsonLdDocument } from \"@twin.org/data-json-ld\";\nimport {\n\tIdentityProfileConnectorFactory,\n\ttype IIdentityProfileComponent,\n\ttype IIdentityProfileConnector\n} from \"@twin.org/identity-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { IdentityService } from \"./identityService.js\";\nimport type { IIdentityProfileServiceConstructorOptions } from \"./models/IIdentityProfileServiceConstructorOptions.js\";\n\n/**\n * Class which implements the identity profile contract.\n */\nexport class IdentityProfileService<\n\tT extends IJsonLdDocument = IJsonLdDocument,\n\tU extends IJsonLdDocument = IJsonLdDocument\n> implements IIdentityProfileComponent<T, U>\n{\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<IdentityProfileService>();\n\n\t/**\n\t * The identity profile connector.\n\t * @internal\n\t */\n\tprivate readonly _identityProfileConnector: IIdentityProfileConnector<T, U>;\n\n\t/**\n\t * Create a new instance of IdentityProfileService.\n\t * @param options The dependencies for the identity profile service.\n\t */\n\tconstructor(options?: IIdentityProfileServiceConstructorOptions) {\n\t\tthis._identityProfileConnector = IdentityProfileConnectorFactory.get<\n\t\t\tIIdentityProfileConnector<T, U>\n\t\t>(options?.profileEntityConnectorType ?? \"identity-profile\");\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn IdentityService.CLASS_NAME;\n\t}\n\n\t/**\n\t * Create the profile properties for an identity.\n\t * @param publicProfile The public profile data as JSON-LD.\n\t * @param privateProfile The private profile data as JSON-LD.\n\t * @param identity The identity to perform the profile operation on.\n\t * @returns Nothing.\n\t */\n\tpublic async create(publicProfile?: T, privateProfile?: U, identity?: string): Promise<void> {\n\t\tGuards.stringValue(IdentityProfileService.CLASS_NAME, nameof(identity), identity);\n\n\t\ttry {\n\t\t\tawait this._identityProfileConnector.create(identity, publicProfile, privateProfile);\n\t\t} catch (error) {\n\t\t\tif (BaseError.someErrorClass(error, IdentityProfileService.CLASS_NAME)) {\n\t\t\t\tthrow error;\n\t\t\t}\n\t\t\tthrow new GeneralError(\n\t\t\t\tIdentityProfileService.CLASS_NAME,\n\t\t\t\t\"createFailed\",\n\t\t\t\t{ identity },\n\t\t\t\terror\n\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Get the profile properties for an identity.\n\t * @param publicPropertyNames The public properties to get for the profile, defaults to all.\n\t * @param privatePropertyNames The private properties to get for the profile, defaults to all.\n\t * @param identity The identity to perform the profile operation on.\n\t * @returns The items identity and the properties.\n\t */\n\tpublic async get(\n\t\tpublicPropertyNames?: (keyof T)[],\n\t\tprivatePropertyNames?: (keyof U)[],\n\t\tidentity?: string\n\t): Promise<{\n\t\tidentity: string;\n\t\tpublicProfile?: Partial<T>;\n\t\tprivateProfile?: Partial<U>;\n\t}> {\n\t\tGuards.stringValue(IdentityProfileService.CLASS_NAME, nameof(identity), identity);\n\n\t\ttry {\n\t\t\tconst result = await this._identityProfileConnector.get(\n\t\t\t\tidentity,\n\t\t\t\tpublicPropertyNames,\n\t\t\t\tprivatePropertyNames\n\t\t\t);\n\t\t\tif (Is.undefined(result)) {\n\t\t\t\tthrow new NotFoundError(IdentityProfileService.CLASS_NAME, \"notFound\", identity);\n\t\t\t}\n\t\t\treturn {\n\t\t\t\tidentity,\n\t\t\t\tpublicProfile: result.publicProfile,\n\t\t\t\tprivateProfile: result.privateProfile\n\t\t\t};\n\t\t} catch (error) {\n\t\t\tif (BaseError.someErrorClass(error, IdentityProfileService.CLASS_NAME)) {\n\t\t\t\tthrow error;\n\t\t\t}\n\t\t\tthrow new GeneralError(IdentityProfileService.CLASS_NAME, \"getFailed\", undefined, error);\n\t\t}\n\t}\n\n\t/**\n\t * Get the public profile properties for an identity.\n\t * @param identity The identity to perform the profile operation on.\n\t * @param propertyNames The properties to get for the item, defaults to all.\n\t * @returns The items properties.\n\t */\n\tpublic async getPublic(identity: string, propertyNames?: (keyof T)[]): Promise<Partial<T>> {\n\t\tGuards.stringValue(IdentityProfileService.CLASS_NAME, nameof(identity), identity);\n\n\t\ttry {\n\t\t\tconst result = await this._identityProfileConnector.get(identity, propertyNames);\n\t\t\tif (Is.undefined(result)) {\n\t\t\t\tthrow new NotFoundError(IdentityProfileService.CLASS_NAME, \"notFound\", identity);\n\t\t\t}\n\t\t\treturn result.publicProfile;\n\t\t} catch (error) {\n\t\t\tif (BaseError.someErrorClass(error, IdentityProfileService.CLASS_NAME)) {\n\t\t\t\tthrow error;\n\t\t\t}\n\t\t\tthrow new GeneralError(\n\t\t\t\tIdentityProfileService.CLASS_NAME,\n\t\t\t\t\"getPublicFailed\",\n\t\t\t\tundefined,\n\t\t\t\terror\n\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Update the profile properties of an identity.\n\t * @param publicProfile The public profile data as JSON-LD.\n\t * @param privateProfile The private profile data as JSON-LD.\n\t * @param identity The identity to perform the profile operation on.\n\t * @returns Nothing.\n\t */\n\tpublic async update(publicProfile?: T, privateProfile?: U, identity?: string): Promise<void> {\n\t\tGuards.stringValue(IdentityProfileService.CLASS_NAME, nameof(identity), identity);\n\n\t\ttry {\n\t\t\tconst result = await this._identityProfileConnector.get(identity);\n\t\t\tif (Is.undefined(result)) {\n\t\t\t\tthrow new NotFoundError(IdentityProfileService.CLASS_NAME, \"notFound\", identity);\n\t\t\t}\n\t\t\tawait this._identityProfileConnector.update(identity, publicProfile, privateProfile);\n\t\t} catch (error) {\n\t\t\tif (BaseError.someErrorClass(error, IdentityProfileService.CLASS_NAME)) {\n\t\t\t\tthrow error;\n\t\t\t}\n\t\t\tthrow new GeneralError(\n\t\t\t\tIdentityProfileService.CLASS_NAME,\n\t\t\t\t\"updateFailed\",\n\t\t\t\t{ identity },\n\t\t\t\terror\n\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Delete the profile for an identity.\n\t * @param identity The identity to perform the profile operation on.\n\t * @returns Nothing.\n\t */\n\tpublic async remove(identity?: string): Promise<void> {\n\t\tGuards.stringValue(IdentityProfileService.CLASS_NAME, nameof(identity), identity);\n\n\t\ttry {\n\t\t\tconst result = await this._identityProfileConnector.get(identity);\n\t\t\tif (Is.undefined(result)) {\n\t\t\t\tthrow new NotFoundError(IdentityProfileService.CLASS_NAME, \"notFound\", identity);\n\t\t\t}\n\t\t\tawait this._identityProfileConnector.remove(identity);\n\t\t} catch (error) {\n\t\t\tif (BaseError.someErrorClass(error, IdentityProfileService.CLASS_NAME)) {\n\t\t\t\tthrow error;\n\t\t\t}\n\t\t\tthrow new GeneralError(\n\t\t\t\tIdentityProfileService.CLASS_NAME,\n\t\t\t\t\"removeFailed\",\n\t\t\t\t{ identity },\n\t\t\t\terror\n\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Get a list of the requested types.\n\t * @param publicFilters The filters to apply to the identities public profiles.\n\t * @param publicPropertyNames The public properties to get for the profile, defaults to all.\n\t * @param cursor The cursor for paged requests.\n\t * @param limit The maximum number of items in a page.\n\t * @returns The list of items and cursor for paging.\n\t */\n\tpublic async list(\n\t\tpublicFilters?: {\n\t\t\tpropertyName: string;\n\t\t\tpropertyValue: unknown;\n\t\t}[],\n\t\tpublicPropertyNames?: (keyof T)[],\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\t/**\n\t\t * The identities.\n\t\t */\n\t\titems: { identity: string; publicProfile?: Partial<T>; privateProfile?: Partial<U> }[];\n\t\t/**\n\t\t * An optional cursor, when defined can be used to call find to get more entities.\n\t\t */\n\t\tcursor?: string;\n\t}> {\n\t\ttry {\n\t\t\t// We don't want to return private profile for this type of query\n\t\t\t// as it would expose the values to the REST api\n\t\t\tconst result = await this._identityProfileConnector.list(\n\t\t\t\tpublicFilters,\n\t\t\t\tundefined,\n\t\t\t\tpublicPropertyNames,\n\t\t\t\tundefined,\n\t\t\t\tcursor,\n\t\t\t\tlimit\n\t\t\t);\n\t\t\treturn result;\n\t\t} catch (error) {\n\t\t\tthrow new GeneralError(IdentityProfileService.CLASS_NAME, \"listFailed\", undefined, error);\n\t\t}\n\t}\n}\n"]}