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

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

@@ -0,0 +1,70 @@
+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 IIdentityProfileConnector<T extends IJsonLdDocument = IJsonLdDocument, U extends IJsonLdDocument = IJsonLdDocument> extends IComponent {
+    /**
+     * Create the profile properties for an identity.
+     * @param identity The identity of the profile to create.
+     * @param publicProfile The public profile data as JSON-LD.
+     * @param privateProfile The private profile data as JSON-LD.
+     * @returns Nothing.
+     */
+    create(identity: string, publicProfile?: T, privateProfile?: U): Promise<void>;
+    /**
+     * Get the profile properties for an identity.
+     * @param identity The identity of the item to get.
+     * @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.
+     * @returns The identity profile, will only return private data if you have correct permissions.
+     */
+    get(identity: string, publicPropertyNames?: (keyof T)[], privatePropertyNames?: (keyof U)[]): Promise<{
+        publicProfile: Partial<T>;
+        privateProfile: Partial<U>;
+    }>;
+    /**
+     * Update the profile properties of an identity.
+     * @param identity The identity to update.
+     * @param publicProfile The public profile data as JSON-LD.
+     * @param privateProfile The private profile data as JSON-LD.
+     * @returns Nothing.
+     */
+    update(identity: string, publicProfile?: T, privateProfile?: U): Promise<void>;
+    /**
+     * Delete the profile for an identity.
+     * @param identity The identity to delete.
+     * @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 privateFilters The filters to apply to the identities private profiles.
+     * @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 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;
+    }[], privateFilters?: {
+        propertyName: string;
+        propertyValue: unknown;
+    }[], publicPropertyNames?: (keyof T)[], privatePropertyNames?: (keyof U)[], cursor?: string, pageSize?: number): Promise<{
+        /**
+         * The identity profiles.
+         */
+        items: {
+            identity: string;
+            publicProfile?: Partial<T>;
+            privateProfile?: Partial<U>;
+        }[];
+        /**
+         * An optional cursor, when defined can be used to call find to get more entities.
+         */
+        cursor?: string;
+    }>;
+}

package/dist/types/models/api/IIdentityProfileCreateRequest.d.ts

@@ -0,0 +1,19 @@
+import type { IJsonLdDocument } from "@twin.org/data-json-ld";
+/**
+ * Request to create an identity profile.
+ */
+export interface IIdentityProfileCreateRequest {
+    /**
+     * The data for the request.
+     */
+    body: {
+        /**
+         * The public profile data.
+         */
+        publicProfile?: IJsonLdDocument;
+        /**
+         * The private profile data.
+         */
+        privateProfile?: IJsonLdDocument;
+    };
+}

package/dist/types/models/api/IIdentityProfileGetPublicRequest.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Get the public profile for an identity.
+ */
+export interface IIdentityProfileGetPublicRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The identity to get the profile for.
+         */
+        identity: string;
+    };
+    /**
+     * The query parameters.
+     */
+    query?: {
+        /**
+         * The properties to get for the public profile, defaults to all, should be a comma separated list.
+         */
+        propertyNames?: string;
+    };
+}

package/dist/types/models/api/IIdentityProfileGetPublicResponse.d.ts

@@ -0,0 +1,17 @@
+import type { IJsonLdDocument } from "@twin.org/data-json-ld";
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+/**
+ * Response to get an identity public profile.
+ */
+export interface IIdentityProfileGetPublicResponse {
+    /**
+     * The response headers.
+     */
+    headers: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The response payload.
+     */
+    body: Partial<IJsonLdDocument>;
+}

package/dist/types/models/api/IIdentityProfileGetRequest.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Get the profile for an identity.
+ */
+export interface IIdentityProfileGetRequest {
+    /**
+     * The query parameters.
+     */
+    query?: {
+        /**
+         * The public properties to get for the profile, defaults to all, should be a comma separated list.
+         */
+        publicPropertyNames?: string;
+        /**
+         * The private properties to get for the profile, defaults to all, should be a comma separated list.
+         */
+        privatePropertyNames?: string;
+    };
+}

package/dist/types/models/api/IIdentityProfileGetResponse.d.ts

@@ -0,0 +1,23 @@
+import type { IJsonLdDocument } from "@twin.org/data-json-ld";
+/**
+ * Response to get an identity details.
+ */
+export interface IIdentityProfileGetResponse {
+    /**
+     * The response payload.
+     */
+    body: {
+        /**
+         * The identity of the profile, this is the authenticated user identity.
+         */
+        identity: string;
+        /**
+         * The public profile data.
+         */
+        publicProfile?: Partial<IJsonLdDocument>;
+        /**
+         * The private profile data.
+         */
+        privateProfile?: Partial<IJsonLdDocument>;
+    };
+}

package/dist/types/models/api/IIdentityProfileListRequest.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Request to get a list of identities.
+ */
+export interface IIdentityProfileListRequest {
+    /**
+     * The query parameters.
+     */
+    query?: {
+        /**
+         * The public filters to apply to the list, comma separated list with color between key and value for each pair e.g. prop1:value1,prop2:value2.
+         */
+        publicFilters?: string;
+        /**
+         * The public properties to get for the profile, defaults to all, should be a comma separated list.
+         */
+        publicPropertyNames?: string;
+        /**
+         * The cursor for paged requests.
+         */
+        cursor?: string;
+        /**
+         * Number of items to return.
+         */
+        pageSize?: number;
+    };
+}

package/dist/types/models/api/IIdentityProfileListResponse.d.ts

@@ -0,0 +1,28 @@
+import type { IJsonLdDocument } from "@twin.org/data-json-ld";
+/**
+ * Response to get a list of identities.
+ */
+export interface IIdentityProfileListResponse {
+    /**
+     * The response payload.
+     */
+    body: {
+        /**
+         * The identities.
+         */
+        items: {
+            /**
+             * The identity.
+             */
+            identity: string;
+            /**
+             * The public profile data.
+             */
+            publicProfile?: Partial<IJsonLdDocument>;
+        }[];
+        /**
+         * An optional cursor, when defined can be used to call find to get more entities.
+         */
+        cursor?: string;
+    };
+}

package/dist/types/models/api/IIdentityProfileUpdateRequest.d.ts

@@ -0,0 +1,19 @@
+import type { IJsonLdDocument } from "@twin.org/data-json-ld";
+/**
+ * Request to update an identity profile.
+ */
+export interface IIdentityProfileUpdateRequest {
+    /**
+     * The data for the request.
+     */
+    body: {
+        /**
+         * The public profile data.
+         */
+        publicProfile?: IJsonLdDocument;
+        /**
+         * The private profile data.
+         */
+        privateProfile?: IJsonLdDocument;
+    };
+}

package/dist/types/models/api/IIdentityResolveRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Resolve an identity.
+ */
+export interface IIdentityResolveRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The identity to get the document for.
+         */
+        id: string;
+    };
+}

package/dist/types/models/api/IIdentityResolveResponse.d.ts

@@ -0,0 +1,10 @@
+import type { IDidDocument } from "@twin.org/standards-w3c-did";
+/**
+ * Response to resolving an identity.
+ */
+export interface IIdentityResolveResponse {
+    /**
+     * The response payload.
+     */
+    body: IDidDocument;
+}

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

@@ -0,0 +1,21 @@
+/**
+ * The roles that an identity can have.
+ */
+export declare const IdentityRole: {
+    /**
+     * Node.
+     */
+    readonly Node: "node";
+    /**
+     * Organization.
+     */
+    readonly Organization: "organization";
+    /**
+     * User.
+     */
+    readonly User: "user";
+};
+/**
+ * The roles that an identity can have.
+ */
+export type IdentityRole = (typeof IdentityRole)[keyof typeof IdentityRole];

package/dist/types/utils/documentHelper.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Helper methods for documents.
+ */
+export declare class DocumentHelper {
+    /**
+     * Parse the document id into its parts.
+     * @param documentId The full document id.
+     * @returns The parsed document id.
+     */
+    static parse(documentId: string): {
+        id: string;
+        hash: string | undefined;
+    };
+}

package/docs/changelog.md

@@ -0,0 +1,5 @@
+# @twin.org/identity-service-models - Changelog
+
+## v0.0.1-next.10
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/identity-service-models - Examples

package/docs/reference/classes/DocumentHelper.md

@@ -0,0 +1,41 @@
+# Class: DocumentHelper
+
+Helper methods for documents.
+
+## Constructors
+
+### new DocumentHelper()
+
+> **new DocumentHelper**(): [`DocumentHelper`](DocumentHelper.md)
+
+#### Returns
+
+[`DocumentHelper`](DocumentHelper.md)
+
+## Methods
+
+### parse()
+
+> `static` **parse**(`documentId`): `object`
+
+Parse the document id into its parts.
+
+#### Parameters
+
+• **documentId**: `string`
+
+The full document id.
+
+#### Returns
+
+`object`
+
+The parsed document id.
+
+##### id
+
+> **id**: `string`
+
+##### hash
+
+> **hash**: `undefined` \| `string`

package/docs/reference/index.md

@@ -0,0 +1,32 @@
+# @twin.org/identity-models
+
+## Classes
+
+- [DocumentHelper](classes/DocumentHelper.md)
+
+## Interfaces
+
+- [IIdentityComponent](interfaces/IIdentityComponent.md)
+- [IIdentityConnector](interfaces/IIdentityConnector.md)
+- [IIdentityProfileComponent](interfaces/IIdentityProfileComponent.md)
+- [IIdentityProfileConnector](interfaces/IIdentityProfileConnector.md)
+- [IIdentityProfileCreateRequest](interfaces/IIdentityProfileCreateRequest.md)
+- [IIdentityProfileGetPublicRequest](interfaces/IIdentityProfileGetPublicRequest.md)
+- [IIdentityProfileGetPublicResponse](interfaces/IIdentityProfileGetPublicResponse.md)
+- [IIdentityProfileGetRequest](interfaces/IIdentityProfileGetRequest.md)
+- [IIdentityProfileGetResponse](interfaces/IIdentityProfileGetResponse.md)
+- [IIdentityProfileListRequest](interfaces/IIdentityProfileListRequest.md)
+- [IIdentityProfileListResponse](interfaces/IIdentityProfileListResponse.md)
+- [IIdentityProfileUpdateRequest](interfaces/IIdentityProfileUpdateRequest.md)
+- [IIdentityResolveRequest](interfaces/IIdentityResolveRequest.md)
+- [IIdentityResolveResponse](interfaces/IIdentityResolveResponse.md)
+
+## Type Aliases
+
+- [IdentityRole](type-aliases/IdentityRole.md)
+
+## Variables
+
+- [IdentityConnectorFactory](variables/IdentityConnectorFactory.md)
+- [IdentityProfileConnectorFactory](variables/IdentityProfileConnectorFactory.md)
+- [IdentityRole](variables/IdentityRole.md)

package/docs/reference/interfaces/IIdentityComponent.md

@@ -0,0 +1,27 @@
+# Interface: IIdentityComponent
+
+Interface describing a contract which provides identity operations.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### resolve()
+
+> **resolve**(`documentId`): `Promise`\<`IDidDocument`\>
+
+Resolve an identity.
+
+#### Parameters
+
+• **documentId**: `string`
+
+The id of the document to resolve.
+
+#### Returns
+
+`Promise`\<`IDidDocument`\>
+
+The resolved document.