@twin.org/identity-models 0.0.1-next.10

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 IOTA Stiftung.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,21 @@
+# TWIN Identity Service Models
+
+Models which define the structure of the service implementations.
+
+## Installation
+
+```shell
+npm install @twin.org/identity-service-models
+```
+
+## Examples
+
+Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
+
+## Reference
+
+Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)
+
+## Changelog
+
+The changes between each version can be found in [docs/changelog.md](docs/changelog.md)

package/dist/cjs/index.cjs

@@ -0,0 +1,71 @@
+'use strict';
+
+var core = require('@twin.org/core');
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Factory for creating identity connectors.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const IdentityConnectorFactory = core.Factory.createFactory("identity-connector");
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Factory for creating identity profile connectors.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const IdentityProfileConnectorFactory = core.Factory.createFactory("identity-profile-connector");
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The roles that an identity can have.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const IdentityRole = {
+    /**
+     * Node.
+     */
+    Node: "node",
+    /**
+     * Organization.
+     */
+    Organization: "organization",
+    /**
+     * User.
+     */
+    User: "user"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Helper methods for documents.
+ */
+class DocumentHelper {
+    /**
+     * Parse the document id into its parts.
+     * @param documentId The full document id.
+     * @returns The parsed document id.
+     */
+    static parse(documentId) {
+        if (!core.Is.stringValue(documentId)) {
+            return {
+                id: "",
+                hash: ""
+            };
+        }
+        const hashIndex = documentId.indexOf("#");
+        return {
+            id: hashIndex === -1 ? documentId : documentId.slice(0, hashIndex),
+            hash: hashIndex === -1 ? undefined : documentId.slice(hashIndex + 1)
+        };
+    }
+}
+
+exports.DocumentHelper = DocumentHelper;
+exports.IdentityConnectorFactory = IdentityConnectorFactory;
+exports.IdentityProfileConnectorFactory = IdentityProfileConnectorFactory;
+exports.IdentityRole = IdentityRole;

package/dist/esm/index.mjs

@@ -0,0 +1,66 @@
+import { Factory, Is } from '@twin.org/core';
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Factory for creating identity connectors.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const IdentityConnectorFactory = Factory.createFactory("identity-connector");
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Factory for creating identity profile connectors.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const IdentityProfileConnectorFactory = Factory.createFactory("identity-profile-connector");
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The roles that an identity can have.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const IdentityRole = {
+    /**
+     * Node.
+     */
+    Node: "node",
+    /**
+     * Organization.
+     */
+    Organization: "organization",
+    /**
+     * User.
+     */
+    User: "user"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Helper methods for documents.
+ */
+class DocumentHelper {
+    /**
+     * Parse the document id into its parts.
+     * @param documentId The full document id.
+     * @returns The parsed document id.
+     */
+    static parse(documentId) {
+        if (!Is.stringValue(documentId)) {
+            return {
+                id: "",
+                hash: ""
+            };
+        }
+        const hashIndex = documentId.indexOf("#");
+        return {
+            id: hashIndex === -1 ? documentId : documentId.slice(0, hashIndex),
+            hash: hashIndex === -1 ? undefined : documentId.slice(hashIndex + 1)
+        };
+    }
+}
+
+export { DocumentHelper, IdentityConnectorFactory, IdentityProfileConnectorFactory, IdentityRole };

package/dist/types/factories/identityConnectorFactory.d.ts

@@ -0,0 +1,6 @@
+import { Factory } from "@twin.org/core";
+import type { IIdentityConnector } from "../models/IIdentityConnector";
+/**
+ * Factory for creating identity connectors.
+ */
+export declare const IdentityConnectorFactory: Factory<IIdentityConnector>;

package/dist/types/factories/identityProfileConnectorFactory.d.ts

@@ -0,0 +1,6 @@
+import { Factory } from "@twin.org/core";
+import type { IIdentityProfileConnector } from "../models/IIdentityProfileConnector";
+/**
+ * Factory for creating identity profile connectors.
+ */
+export declare const IdentityProfileConnectorFactory: Factory<IIdentityProfileConnector<import("@twin.org/data-json-ld").IJsonLdDocument, import("@twin.org/data-json-ld").IJsonLdDocument>>;

package/dist/types/index.d.ts

@@ -0,0 +1,18 @@
+export * from "./factories/identityConnectorFactory";
+export * from "./factories/identityProfileConnectorFactory";
+export * from "./models/api/IIdentityProfileCreateRequest";
+export * from "./models/api/IIdentityProfileGetPublicRequest";
+export * from "./models/api/IIdentityProfileGetPublicResponse";
+export * from "./models/api/IIdentityProfileGetRequest";
+export * from "./models/api/IIdentityProfileGetResponse";
+export * from "./models/api/IIdentityProfileListRequest";
+export * from "./models/api/IIdentityProfileListResponse";
+export * from "./models/api/IIdentityProfileUpdateRequest";
+export * from "./models/api/IIdentityResolveRequest";
+export * from "./models/api/IIdentityResolveResponse";
+export * from "./models/identityRole";
+export * from "./models/IIdentityComponent";
+export * from "./models/IIdentityConnector";
+export * from "./models/IIdentityProfileComponent";
+export * from "./models/IIdentityProfileConnector";
+export * from "./utils/documentHelper";

package/dist/types/models/IIdentityComponent.d.ts

@@ -0,0 +1,13 @@
+import type { IComponent } from "@twin.org/core";
+import type { IDidDocument } from "@twin.org/standards-w3c-did";
+/**
+ * Interface describing a contract which provides identity operations.
+ */
+export interface IIdentityComponent extends IComponent {
+    /**
+     * Resolve an identity.
+     * @param documentId The id of the document to resolve.
+     * @returns The resolved document.
+     */
+    resolve(documentId: string): Promise<IDidDocument>;
+}

package/dist/types/models/IIdentityConnector.d.ts

@@ -0,0 +1,145 @@
+import type { IComponent } from "@twin.org/core";
+import type { IJsonLdContextDefinitionRoot, IJsonLdObject } from "@twin.org/data-json-ld";
+import type { DidVerificationMethodType, IDidDocument, IDidDocumentVerificationMethod, IDidService, IDidVerifiableCredential, IDidVerifiablePresentation } from "@twin.org/standards-w3c-did";
+/**
+ * Interface describing an identity connector.
+ */
+export interface IIdentityConnector extends IComponent {
+    /**
+     * Create a new document.
+     * @param controller The controller of the identity who can make changes.
+     * @returns The created document.
+     */
+    createDocument(controller: string): Promise<IDidDocument>;
+    /**
+     * Resolve a document from its id.
+     * @param documentId The id of the document to resolve.
+     * @returns The resolved document.
+     * @throws NotFoundError if the id can not be resolved.
+     */
+    resolveDocument(documentId: string): Promise<IDidDocument>;
+    /**
+     * Add a verification method to the document in JSON Web key Format.
+     * @param controller The controller of the identity who can make changes.
+     * @param documentId The id of the document to add the verification method to.
+     * @param verificationMethodType The type of the verification method to add.
+     * @param verificationMethodId The id of the verification method, if undefined uses the kid of the generated JWK.
+     * @returns The verification method.
+     * @throws NotFoundError if the id can not be resolved.
+     * @throws NotSupportedError if the platform does not support multiple keys.
+     */
+    addVerificationMethod(controller: string, documentId: string, verificationMethodType: DidVerificationMethodType, verificationMethodId?: string): Promise<IDidDocumentVerificationMethod>;
+    /**
+     * Remove a verification method from the document.
+     * @param controller The controller of the identity who can make changes.
+     * @param verificationMethodId The id of the verification method.
+     * @returns Nothing.
+     * @throws NotFoundError if the id can not be resolved.
+     * @throws NotSupportedError if the platform does not support multiple revocable keys.
+     */
+    removeVerificationMethod(controller: string, verificationMethodId: string): Promise<void>;
+    /**
+     * Add a service to the document.
+     * @param controller The controller of the identity who can make changes.
+     * @param documentId The id of the document to add the service to.
+     * @param serviceId The id of the service.
+     * @param serviceType The type of the service.
+     * @param serviceEndpoint The endpoint for the service.
+     * @returns The service.
+     * @throws NotFoundError if the id can not be resolved.
+     */
+    addService(controller: string, documentId: string, serviceId: string, serviceType: string, serviceEndpoint: string): Promise<IDidService>;
+    /**
+     * Remove a service from the document.
+     * @param controller The controller of the identity who can make changes.
+     * @param serviceId The id of the service.
+     * @returns Nothing.
+     * @throws NotFoundError if the id can not be resolved.
+     */
+    removeService(controller: string, serviceId: string): Promise<void>;
+    /**
+     * Create a verifiable credential for a verification method.
+     * @param controller The controller of the identity who can make changes.
+     * @param verificationMethodId The verification method id to use.
+     * @param id The id of the credential.
+     * @param credential The credential to store in the verifiable credential.
+     * @param revocationIndex The bitmap revocation index of the credential, if undefined will not have revocation status.
+     * @returns The created verifiable credential and its token.
+     * @throws NotFoundError if the id can not be resolved.
+     */
+    createVerifiableCredential<T extends IJsonLdObject = IJsonLdObject>(controller: string, verificationMethodId: string, id: string | undefined, credential: T, revocationIndex?: number): Promise<{
+        verifiableCredential: IDidVerifiableCredential<T>;
+        jwt: string;
+    }>;
+    /**
+     * Check a verifiable credential is valid.
+     * @param credentialJwt The credential to verify.
+     * @returns The credential stored in the jwt and the revocation status.
+     */
+    checkVerifiableCredential<T extends IJsonLdObject = IJsonLdObject>(credentialJwt: string): Promise<{
+        revoked: boolean;
+        verifiableCredential?: IDidVerifiableCredential<T>;
+    }>;
+    /**
+     * Revoke verifiable credential(s).
+     * @param controller The controller of the identity who can make changes.
+     * @param issuerDocumentId The id of the document to update the revocation list for.
+     * @param credentialIndices The revocation bitmap index or indices to revoke.
+     * @returns Nothing.
+     */
+    revokeVerifiableCredentials(controller: string, issuerDocumentId: string, credentialIndices: number[]): Promise<void>;
+    /**
+     * Unrevoke verifiable credential(s).
+     * @param controller The controller of the identity who can make changes.
+     * @param issuerDocumentId The id of the document to update the revocation list for.
+     * @param credentialIndices The revocation bitmap index or indices to un revoke.
+     * @returns Nothing.
+     */
+    unrevokeVerifiableCredentials(controller: string, issuerDocumentId: string, credentialIndices: number[]): Promise<void>;
+    /**
+     * Create a verifiable presentation from the supplied verifiable credentials.
+     * @param controller The controller of the identity who can make changes.
+     * @param presentationMethodId The method to associate with the presentation.
+     * @param presentationId The id of the presentation.
+     * @param contexts The contexts for the data stored in the verifiable credential.
+     * @param types The types for the data stored in the verifiable credential.
+     * @param verifiableCredentials The credentials to use for creating the presentation in jwt format.
+     * @param expiresInMinutes The time in minutes for the presentation to expire.
+     * @returns The created verifiable presentation and its token.
+     * @throws NotFoundError if the id can not be resolved.
+     */
+    createVerifiablePresentation<T extends IJsonLdObject = IJsonLdObject>(controller: string, presentationMethodId: string, presentationId: string | undefined, contexts: IJsonLdContextDefinitionRoot | undefined, types: string | string[] | undefined, verifiableCredentials: (string | IDidVerifiableCredential<T>)[], expiresInMinutes?: number): Promise<{
+        verifiablePresentation: IDidVerifiablePresentation<T>;
+        jwt: string;
+    }>;
+    /**
+     * Check a verifiable presentation is valid.
+     * @param presentationJwt The presentation to verify.
+     * @returns The presentation stored in the jwt and the revocation status.
+     */
+    checkVerifiablePresentation<T extends IJsonLdObject = IJsonLdObject>(presentationJwt: string): Promise<{
+        revoked: boolean;
+        verifiablePresentation?: IDidVerifiablePresentation<T>;
+        issuers?: IDidDocument[];
+    }>;
+    /**
+     * Create a proof for arbitrary data with the specified verification method.
+     * @param controller The controller of the identity who can make changes.
+     * @param verificationMethodId The verification method id to use.
+     * @param bytes The data bytes to sign.
+     * @returns The proof signature type and value.
+     */
+    createProof(controller: string, verificationMethodId: string, bytes: Uint8Array): Promise<{
+        type: string;
+        value: Uint8Array;
+    }>;
+    /**
+     * Verify proof for arbitrary data with the specified verification method.
+     * @param verificationMethodId The verification method id to use.
+     * @param bytes The data bytes to verify.
+     * @param signatureType The type of the signature for the proof.
+     * @param signatureValue The value of the signature for the proof.
+     * @returns True if the signature is valid.
+     */
+    verifyProof(verificationMethodId: string, bytes: Uint8Array, signatureType: string, signatureValue: Uint8Array): Promise<boolean>;
+}

package/dist/types/models/IIdentityProfileComponent.d.ts

@@ -0,0 +1,72 @@
+import type { IComponent } from "@twin.org/core";
+import type { IJsonLdDocument } from "@twin.org/data-json-ld";
+/**
+ * Interface describing a contract which provides profile operations.
+ */
+export interface IIdentityProfileComponent<T extends IJsonLdDocument = IJsonLdDocument, U extends IJsonLdDocument = IJsonLdDocument> extends IComponent {
+    /**
+     * 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.
+     */
+    create(publicProfile?: T, privateProfile?: U, identity?: string): Promise<void>;
+    /**
+     * 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.
+     */
+    get(publicPropertyNames?: (keyof T)[], privatePropertyNames?: (keyof U)[], identity?: string): Promise<{
+        identity: string;
+        publicProfile?: Partial<T>;
+        privateProfile?: Partial<U>;
+    }>;
+    /**
+     * Get the public profile properties for an identity.
+     * @param identity The identity to perform the profile operation on.
+     * @param propertyNames The public properties to get for the profile, defaults to all.
+     * @returns The items properties.
+     */
+    getPublic(identity: string, propertyNames?: (keyof T)[]): Promise<Partial<T>>;
+    /**
+     * 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.
+     */
+    update(publicProfile?: T, privateProfile?: U, identity?: string): Promise<void>;
+    /**
+     * Delete the profile for an identity.
+     * @param identity The identity to perform the profile operation on.
+     * @returns Nothing.
+     */
+    remove(identity?: string): Promise<void>;
+    /**
+     * Get a list of the requested identities.
+     * @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 pageSize The maximum number of items in a page.
+     * @returns The list of items and cursor for paging.
+     */
+    list(publicFilters?: {
+        propertyName: string;
+        propertyValue: unknown;
+    }[], publicPropertyNames?: (keyof T)[], cursor?: string, pageSize?: number): Promise<{
+        /**
+         * The identities.
+         */
+        items: {
+            identity: string;
+            publicProfile?: Partial<T>;
+        }[];
+        /**
+         * An optional cursor, when defined can be used to call find to get more entities.
+         */
+        cursor?: string;
+    }>;
+}