@twin.org/identity-service 0.0.1-next.3

package/dist/types/identityProfileRoutes.d.ts

@@ -0,0 +1,61 @@
+import type { IHttpRequestContext, INoContentRequest, INoContentResponse, IRestRoute, ITag } from "@twin.org/api-models";
+import type { IIdentityProfileCreateRequest, IIdentityProfileGetPublicRequest, IIdentityProfileGetPublicResponse, IIdentityProfileGetRequest, IIdentityProfileGetResponse, IIdentityProfileListRequest, IIdentityProfileListResponse, IIdentityProfileUpdateRequest } from "@twin.org/identity-models";
+/**
+ * The tag to associate with the routes.
+ */
+export declare const tagsIdentityProfile: ITag[];
+/**
+ * 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 declare function generateRestRoutesIdentityProfile(baseRouteName: string, componentName: string): IRestRoute[];
+/**
+ * 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 declare function identityProfileCreate(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityProfileCreateRequest): Promise<INoContentResponse>;
+/**
+ * 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 declare function identityGet(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityProfileGetRequest): Promise<IIdentityProfileGetResponse>;
+/**
+ * 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 declare function identityGetPublic(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityProfileGetPublicRequest): Promise<IIdentityProfileGetPublicResponse>;
+/**
+ * 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 declare function identityProfileUpdate(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityProfileUpdateRequest): Promise<INoContentResponse>;
+/**
+ * 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 declare function identityProfileRemove(httpRequestContext: IHttpRequestContext, componentName: string, request: INoContentRequest): Promise<INoContentResponse>;
+/**
+ * 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 declare function identitiesList(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityProfileListRequest): Promise<IIdentityProfileListResponse>;

package/dist/types/identityProfileService.d.ts

@@ -0,0 +1,85 @@
+import type { IJsonLdDocument } from "@twin.org/data-json-ld";
+import { type IIdentityProfileComponent } from "@twin.org/identity-models";
+/**
+ * Class which implements the identity profile contract.
+ */
+export declare class IdentityProfileService<T extends IJsonLdDocument = IJsonLdDocument, U extends IJsonLdDocument = IJsonLdDocument> implements IIdentityProfileComponent<T, U> {
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of IdentityProfileService.
+     * @param options The dependencies for the identity profile service.
+     * @param options.profileEntityConnectorType The storage connector for the profiles, default to "identity-profile".
+     */
+    constructor(options?: {
+        profileEntityConnectorType?: string;
+    });
+    /**
+     * 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 properties to get for the item, 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 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 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>;
+            privateProfile?: Partial<U>;
+        }[];
+        /**
+         * An optional cursor, when defined can be used to call find to get more entities.
+         */
+        cursor?: string;
+    }>;
+}

package/dist/types/identityRoutes.d.ts

@@ -0,0 +1,21 @@
+import type { IHttpRequestContext, IRestRoute, ITag } from "@twin.org/api-models";
+import type { IIdentityResolveRequest, IIdentityResolveResponse } from "@twin.org/identity-models";
+/**
+ * The tag to associate with the routes.
+ */
+export declare const tagsIdentity: ITag[];
+/**
+ * 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 declare function generateRestRoutesIdentity(baseRouteName: string, componentName: string): IRestRoute[];
+/**
+ * Resolve an identity.
+ * @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 declare function identityResolve(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityResolveRequest): Promise<IIdentityResolveResponse>;

package/dist/types/identityService.d.ts

@@ -0,0 +1,30 @@
+import { type IIdentityComponent } from "@twin.org/identity-models";
+import type { IDidDocument } from "@twin.org/standards-w3c-did";
+import type { IIdentityServiceConfig } from "./models/IIdentityServiceConfig";
+/**
+ * Class which implements the identity contract.
+ */
+export declare class IdentityService implements IIdentityComponent {
+    /**
+     * The namespace supported by the identity service.
+     */
+    static readonly NAMESPACE: string;
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of IdentityService.
+     * @param options The options for the service.
+     * @param options.config The configuration for the service.
+     */
+    constructor(options?: {
+        config?: IIdentityServiceConfig;
+    });
+    /**
+     * Resolve an identity.
+     * @param documentId The id of the document to resolve.
+     * @returns The resolved document.
+     */
+    resolve(documentId: string): Promise<IDidDocument>;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./identityProfileRoutes";
+export * from "./identityProfileService";
+export * from "./identityRoutes";
+export * from "./identityService";
+export * from "./models/IIdentityServiceConfig";
+export * from "./restEntryPoints";

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

@@ -0,0 +1,9 @@
+/**
+ * Configuration for the Identity Service.
+ */
+export interface IIdentityServiceConfig {
+    /**
+     * What is the default connector to use for Identity. If not provided the first connector from the factory will be used.
+     */
+    defaultNamespace?: string;
+}

package/dist/types/restEntryPoints.d.ts

@@ -0,0 +1,2 @@
+import type { IRestRouteEntryPoint } from "@twin.org/api-models";
+export declare const restEntryPoints: IRestRouteEntryPoint[];

package/docs/changelog.md

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

package/docs/examples.md

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