@decaf-ts/for-fabric 0.9.0 → 0.10.0

package/lib/types/client/services/FabricEnrollmentService.d.mts

@@ -0,0 +1,176 @@
+import FabricCAServices from "fabric-ca-client";
+import { IEnrollResponse } from "fabric-ca-client";
+import { User } from "fabric-common";
+import { CAConfig, Credentials } from "../../shared/types.js";
+import { Identity } from "../../shared/model/Identity.js";
+import { AuthorizationError } from "@decaf-ts/core";
+import { ConflictError } from "@decaf-ts/db-decorators";
+import { CA_ROLE } from "./constants.js";
+import { CertificateResponse, FabricIdentity, GetCertificatesRequest } from "../../shared/fabric-types.js";
+import { LoggedClass } from "@decaf-ts/logging";
+/**
+ * @description Hyperledger Fabric CA identity types.
+ * @summary Enumerates the supported identity types recognized by Fabric CA for registration and identity management.
+ * @enum {string}
+ * @readonly
+ * @memberOf module:for-fabric.client
+ */
+export declare enum HFCAIdentityType {
+    PEER = "peer",
+    ORDERER = "orderer",
+    CLIENT = "client",
+    USER = "user",
+    ADMIN = "admin"
+}
+/**
+ * @description Key/value attribute used during CA registration.
+ * @summary Represents an attribute entry that can be attached to a Fabric CA identity during registration, optionally marking it for inclusion in ecert.
+ * @interface IKeyValueAttribute
+ * @template T
+ * @param {string} name - Attribute name.
+ * @param {string} value - Attribute value.
+ * @param {boolean} [ecert] - Whether the attribute should be included in the enrollment certificate (ECert).
+ * @memberOf module:for-fabric.client
+ */
+export interface IKeyValueAttribute {
+    name: string;
+    value: string;
+    ecert?: boolean;
+}
+/**
+ * @description Standard Fabric CA identity attribute keys.
+ * @summary Enumerates well-known Fabric CA attribute keys that can be assigned to identities for delegations and permissions.
+ * @enum {string}
+ * @readonly
+ * @memberOf module:for-fabric.client
+ */
+export declare enum HFCAIdentityAttributes {
+    HFREGISTRARROLES = "hf.Registrar.Roles",
+    HFREGISTRARDELEGATEROLES = "hf.Registrar.DelegateRoles",
+    HFREGISTRARATTRIBUTES = "hf.Registrar.Attributes",
+    HFINTERMEDIATECA = "hf.IntermediateCA",
+    HFREVOKER = "hf.Revoker",
+    HFAFFILIATIONMGR = "hf.AffiliationMgr",
+    HFGENCRL = "hf.GenCRL"
+}
+/**
+ * @description Service wrapper for interacting with a Fabric CA.
+ * @summary Provides high-level operations for managing identities against a Hyperledger Fabric Certificate Authority, including registration, enrollment, revocation, and administrative queries. Encapsulates lower-level Fabric CA client calls with consistent logging and error mapping.
+ * @param {CAConfig} caConfig - Connection and TLS configuration for the target CA.
+ * @class FabricEnrollmentService
+ * @example
+ * // Register and enroll a new user
+ * const svc = new FabricEnrollmentService({
+ *   url: 'https://localhost:7054',
+ *   caName: 'Org1CA',
+ *   tls: { trustedRoots: ['/path/to/ca.pem'], verify: false },
+ *   caCert: '/path/to/admin/certDir',
+ *   caKey: '/path/to/admin/keyDir'
+ * });
+ * await svc.register({ userName: 'alice', password: 's3cr3t' }, false, 'org1.department1', CA_ROLE.USER);
+ * const id = await svc.enroll('alice', 's3cr3t');
+ * @mermaid
+ * sequenceDiagram
+ *   autonumber
+ *   participant App
+ *   participant Svc as FabricEnrollmentService
+ *   participant CA as Fabric CA
+ *   App->>Svc: register(credentials, ...)
+ *   Svc->>CA: register(request, adminUser)
+ *   CA-->>Svc: enrollmentSecret
+ *   Svc-->>App: secret
+ *   App->>Svc: enroll(enrollmentId, secret)
+ *   Svc->>CA: enroll({enrollmentID, secret})
+ *   CA-->>Svc: certificates
+ *   Svc-->>App: Identity
+ */
+export declare class FabricEnrollmentService extends LoggedClass {
+    private caConfig;
+    private ca?;
+    private certificateService?;
+    private affiliationService?;
+    private identityService?;
+    private client?;
+    private user?;
+    constructor(caConfig: CAConfig);
+    protected User(): Promise<User>;
+    protected CA(): Promise<FabricCAServices>;
+    protected Client(): Promise<{
+        newCertificateService: any;
+    }>;
+    protected Certificate(): Promise<any>;
+    protected Affiliations(): Promise<FabricCAServices.AffiliationService>;
+    protected Identities(): Promise<FabricCAServices.IdentityService>;
+    /**
+     * @description Retrieve certificates from the CA.
+     * @summary Calls the CA certificate service to list certificates, optionally mapping to PEM strings only.
+     * @param {GetCertificatesRequest} [request] - Optional filter request for certificate lookup.
+     * @param {boolean} [doMap=true] - When true, returns array of PEM strings; otherwise returns full response object.
+     * @return {Promise<string[] | CertificateResponse>} Array of PEM strings or the full certificate response.
+     */
+    getCertificates(request?: GetCertificatesRequest, doMap?: boolean): Promise<string[] | CertificateResponse>;
+    /**
+     * @description List identities registered in the CA.
+     * @summary Queries the CA identity service to fetch all identities and returns the list as FabricIdentity objects.
+     * @return {Promise<FabricIdentity[]>} The list of identities registered in the CA.
+     */
+    getIdentities(): Promise<FabricIdentity[]>;
+    protected parseError(e: Error): AuthorizationError | ConflictError;
+    /**
+     * @description Retrieve affiliations from the CA.
+     * @summary Queries the CA for the list of affiliations available under the configured CA.
+     * @return {string} The affiliations result payload.
+     */
+    getAffiliations(): Promise<any>;
+    /**
+     * @description Read identity details from the CA by enrollment ID.
+     * @summary Retrieves and validates a single identity, throwing NotFoundError when missing.
+     * @param {string} enrollmentId - Enrollment ID to lookup.
+     * @return {Promise<FabricIdentity>} The identity details stored in the CA.
+     */
+    read(enrollmentId: string): Promise<FabricIdentity>;
+    /**
+     * @description Register a new identity with the CA.
+     * @summary Submits a registration request for a new enrollment ID, returning the enrollment secret upon success.
+     * @param {Credentials} model - Credentials containing userName and password for the new identity.
+     * @param {boolean} [isSuperUser=false] - Whether to register the identity as a super user.
+     * @param {string} [affiliation=""] - Affiliation string (e.g., org1.department1).
+     * @param {CA_ROLE | string} [userRole] - Role to assign to the identity.
+     * @param {IKeyValueAttribute} [attrs] - Optional attributes to attach to the identity.
+     * @param {number} [maxEnrollments] - Maximum number of enrollments allowed for the identity.
+     * @return {Promise<string>} The enrollment secret for the registered identity.
+     */
+    register(model: Credentials, isSuperUser?: boolean, affiliation?: string, userRole?: CA_ROLE | string, attrs?: IKeyValueAttribute, maxEnrollments?: number): Promise<string>;
+    protected static identityFromEnrollment(enrollment: IEnrollResponse, mspId: string): Identity;
+    /**
+     * @description Enroll an identity with the CA using a registration secret.
+     * @summary Exchanges the enrollment ID and secret for certificates, returning a constructed Identity model.
+     * @param {string} enrollmentId - Enrollment ID to enroll.
+     * @param {string} registration - Enrollment secret returned at registration time.
+     * @return {Promise<Identity>} The enrolled identity object with credentials.
+     */
+    enroll(enrollmentId: string, registration: string): Promise<Identity>;
+    /**
+     * @description Register and enroll a new identity in one step.
+     * @summary Registers a new enrollment ID with the CA and immediately exchanges the secret to enroll, returning the created Identity.
+     * @param {Credentials} model - Credentials for the new identity containing userName and password.
+     * @param {boolean} [isSuperUser=false] - Whether to register the identity as a super user.
+     * @param {string} [affiliation=""] - Affiliation string (e.g., org1.department1).
+     * @param {CA_ROLE | string} [userRole] - Role to assign to the identity.
+     * @param {IKeyValueAttribute} [attrs] - Optional attributes to attach to the identity.
+     * @param {number} [maxEnrollments] - Maximum number of enrollments allowed for the identity.
+     * @return {Promise<Identity>} The enrolled identity.
+     */
+    registerAndEnroll(model: Credentials, isSuperUser?: boolean, affiliation?: string, userRole?: CA_ROLE | string, attrs?: IKeyValueAttribute, maxEnrollments?: number): Promise<Identity>;
+    /**
+     * Revokes the enrollment of an identity with the specified enrollment ID.
+     *
+     * @param enrollmentId - The enrollment ID of the identity to be revoked.
+     *
+     * @returns A Promise that resolves to the result of the revocation operation.
+     *
+     * @throws {NotFoundError} If the enrollment with the specified ID does not exist.
+     * @throws {InternalError} If there is an error during the revocation process.
+     */
+    revoke(enrollmentId: string): Promise<FabricCAServices.IServiceResponse>;
+}

package/lib/types/client/services/FabricIdentityService.d.cts

@@ -0,0 +1,98 @@
+import { AuthorizationError, ClientBasedService, Context, MaybeContextualArg } from "@decaf-ts/core";
+import FabricCAServices, { AffiliationService, IdentityService, IEnrollResponse, IIdentityRequest, IRevokeRequest, IServiceResponse } from "fabric-ca-client";
+import { CAConfig, Credentials } from "../../shared/types.cjs";
+import { ConflictError } from "@decaf-ts/db-decorators";
+import { CertificateResponse, FabricIdentity, GetCertificatesRequest } from "../../shared/fabric-types.cjs";
+import { User } from "fabric-common";
+import { CA_ROLE } from "./constants.cjs";
+import { IKeyValueAttribute } from "./FabricEnrollmentService.cjs";
+import { Identity } from "../../shared/index.cjs";
+export declare class FabricIdentityService extends ClientBasedService<FabricCAServices, CAConfig> {
+    protected _user: User;
+    constructor();
+    protected get rootClient(): {
+        newCertificateService: any;
+    };
+    protected get user(): User;
+    protected get certificates(): any;
+    protected get affiliations(): AffiliationService;
+    protected get identities(): IdentityService;
+    protected getUser(cfg: CAConfig, ctx: Context): Promise<User>;
+    initialize(...args: MaybeContextualArg<any>): Promise<{
+        config: CAConfig;
+        client: FabricCAServices;
+    }>;
+    getCertificates(...args: MaybeContextualArg<any>): Promise<string[]>;
+    getCertificates(request: GetCertificatesRequest, ...args: MaybeContextualArg<any>): Promise<string[]>;
+    getCertificates<MAP extends boolean>(doMap: MAP, ...args: MaybeContextualArg<any>): Promise<MAP extends false ? CertificateResponse : string[]>;
+    getCertificates<MAP extends boolean>(request: GetCertificatesRequest, doMap: MAP, ...args: MaybeContextualArg<any>): Promise<MAP extends false ? CertificateResponse : string[]>;
+    getIdentities(ctx: Context): Promise<FabricIdentity[]>;
+    /**
+     * @description Retrieve affiliations from the CA.
+     * @summary Queries the CA for the list of affiliations available under the configured CA.
+     * @return {string} The affiliations result payload.
+     */
+    getAffiliations(ctx: Context): Promise<any>;
+    protected parseError(e: Error): AuthorizationError | ConflictError;
+    /**
+     * @description Read identity details from the CA by enrollment ID.
+     * @summary Retrieves and validates a single identity, throwing NotFoundError when missing.
+     * @param {string} enrollmentId - Enrollment ID to lookup.
+     * @return {Promise<FabricIdentity>} The identity details stored in the CA.
+     */
+    read(enrollmentId: string, ...args: MaybeContextualArg<any>): Promise<FabricIdentity>;
+    /**
+     * @description Register a new identity with the CA.
+     * @summary Submits a registration request for a new enrollment ID, returning the enrollment secret upon success.
+     * @param {Credentials} model - Credentials containing userName and password for the new identity.
+     * @param {boolean} [isSuperUser=false] - Whether to register the identity as a super user.
+     * @param {string} [affiliation=""] - Affiliation string (e.g., org1.department1).
+     * @param {CA_ROLE | string} [userRole] - Role to assign to the identity.
+     * @param {IKeyValueAttribute} [attrs] - Optional attributes to attach to the identity.
+     * @param {number} [maxEnrollments] - Maximum number of enrollments allowed for the identity.
+     * @return {Promise<string>} The enrollment secret for the registered identity.
+     */
+    register(model: Credentials, isSuperUser?: boolean, affiliation?: string, userRole?: CA_ROLE | string, attrs?: IKeyValueAttribute, maxEnrollments?: number, ...args: MaybeContextualArg<any>): Promise<string>;
+    protected static identityFromEnrollment(enrollment: IEnrollResponse, mspId: string, ctx: Context): Identity;
+    /**
+     * @description Enroll an identity with the CA using a registration secret.
+     * @summary Exchanges the enrollment ID and secret for certificates, returning a constructed Identity model.
+     * @param {string} enrollmentId - Enrollment ID to enroll.
+     * @param {string} registration - Enrollment secret returned at registration time.
+     * @return {Promise<Identity>} The enrolled identity object with credentials.
+     */
+    enroll(enrollmentId: string, registration: string, ...args: MaybeContextualArg<any>): Promise<Identity>;
+    /**
+     * @description Register and enroll a new identity in one step.
+     * @summary Registers a new enrollment ID with the CA and immediately exchanges the secret to enroll, returning the created Identity.
+     * @param {Credentials} model - Credentials for the new identity containing userName and password.
+     * @param {boolean} [isSuperUser=false] - Whether to register the identity as a super user.
+     * @param {string} [affiliation=""] - Affiliation string (e.g., org1.department1).
+     * @param {CA_ROLE | string} [userRole] - Role to assign to the identity.
+     * @param {IKeyValueAttribute} [attrs] - Optional attributes to attach to the identity.
+     * @param {number} [maxEnrollments] - Maximum number of enrollments allowed for the identity.
+     * @return {Promise<Identity>} The enrolled identity.
+     */
+    registerAndEnroll(model: Credentials, isSuperUser?: boolean, affiliation?: string, userRole?: CA_ROLE | string, attrs?: IKeyValueAttribute, maxEnrollments?: number, ...args: MaybeContextualArg<any>): Promise<Identity>;
+    /**
+     * @description Re-enroll an existing identity using its current enrollment.
+     * @summary Renews the enrollment certificate by calling the CA reenroll.
+     * @param {User} currentUser - Already enrolled user, must have a signing identity.
+     * @return {Promise<Identity>} The renewed identity object with new credentials.
+     */
+    updateIdentity(enrollmentId: string, identity: {
+        certificate: string;
+        privateKey: string;
+    }, identityRequest: IIdentityRequest, ...args: MaybeContextualArg<any>): Promise<Identity>;
+    /**
+     * Revokes the enrollment of an identity with the specified enrollment ID.
+     *
+     * @param enrollmentId - The enrollment ID of the identity to be revoked.
+     *
+     * @returns A Promise that resolves to the result of the revocation operation.
+     *
+     * @throws {NotFoundError} If the enrollment with the specified ID does not exist.
+     * @throws {InternalError} If there is an error during the revocation process.
+     */
+    revoke(enrollmentId: string, revokeOptions: Omit<IRevokeRequest, "enrollmentID">, ...args: MaybeContextualArg<any>): Promise<IServiceResponse>;
+}

package/lib/types/client/services/FabricIdentityService.d.mts

@@ -0,0 +1,98 @@
+import { AuthorizationError, ClientBasedService, Context, MaybeContextualArg } from "@decaf-ts/core";
+import FabricCAServices, { AffiliationService, IdentityService, IEnrollResponse, IIdentityRequest, IRevokeRequest, IServiceResponse } from "fabric-ca-client";
+import { CAConfig, Credentials } from "../../shared/types.js";
+import { ConflictError } from "@decaf-ts/db-decorators";
+import { CertificateResponse, FabricIdentity, GetCertificatesRequest } from "../../shared/fabric-types.js";
+import { User } from "fabric-common";
+import { CA_ROLE } from "./constants.js";
+import { IKeyValueAttribute } from "./FabricEnrollmentService.js";
+import { Identity } from "../../shared/index.js";
+export declare class FabricIdentityService extends ClientBasedService<FabricCAServices, CAConfig> {
+    protected _user: User;
+    constructor();
+    protected get rootClient(): {
+        newCertificateService: any;
+    };
+    protected get user(): User;
+    protected get certificates(): any;
+    protected get affiliations(): AffiliationService;
+    protected get identities(): IdentityService;
+    protected getUser(cfg: CAConfig, ctx: Context): Promise<User>;
+    initialize(...args: MaybeContextualArg<any>): Promise<{
+        config: CAConfig;
+        client: FabricCAServices;
+    }>;
+    getCertificates(...args: MaybeContextualArg<any>): Promise<string[]>;
+    getCertificates(request: GetCertificatesRequest, ...args: MaybeContextualArg<any>): Promise<string[]>;
+    getCertificates<MAP extends boolean>(doMap: MAP, ...args: MaybeContextualArg<any>): Promise<MAP extends false ? CertificateResponse : string[]>;
+    getCertificates<MAP extends boolean>(request: GetCertificatesRequest, doMap: MAP, ...args: MaybeContextualArg<any>): Promise<MAP extends false ? CertificateResponse : string[]>;
+    getIdentities(ctx: Context): Promise<FabricIdentity[]>;
+    /**
+     * @description Retrieve affiliations from the CA.
+     * @summary Queries the CA for the list of affiliations available under the configured CA.
+     * @return {string} The affiliations result payload.
+     */
+    getAffiliations(ctx: Context): Promise<any>;
+    protected parseError(e: Error): AuthorizationError | ConflictError;
+    /**
+     * @description Read identity details from the CA by enrollment ID.
+     * @summary Retrieves and validates a single identity, throwing NotFoundError when missing.
+     * @param {string} enrollmentId - Enrollment ID to lookup.
+     * @return {Promise<FabricIdentity>} The identity details stored in the CA.
+     */
+    read(enrollmentId: string, ...args: MaybeContextualArg<any>): Promise<FabricIdentity>;
+    /**
+     * @description Register a new identity with the CA.
+     * @summary Submits a registration request for a new enrollment ID, returning the enrollment secret upon success.
+     * @param {Credentials} model - Credentials containing userName and password for the new identity.
+     * @param {boolean} [isSuperUser=false] - Whether to register the identity as a super user.
+     * @param {string} [affiliation=""] - Affiliation string (e.g., org1.department1).
+     * @param {CA_ROLE | string} [userRole] - Role to assign to the identity.
+     * @param {IKeyValueAttribute} [attrs] - Optional attributes to attach to the identity.
+     * @param {number} [maxEnrollments] - Maximum number of enrollments allowed for the identity.
+     * @return {Promise<string>} The enrollment secret for the registered identity.
+     */
+    register(model: Credentials, isSuperUser?: boolean, affiliation?: string, userRole?: CA_ROLE | string, attrs?: IKeyValueAttribute, maxEnrollments?: number, ...args: MaybeContextualArg<any>): Promise<string>;
+    protected static identityFromEnrollment(enrollment: IEnrollResponse, mspId: string, ctx: Context): Identity;
+    /**
+     * @description Enroll an identity with the CA using a registration secret.
+     * @summary Exchanges the enrollment ID and secret for certificates, returning a constructed Identity model.
+     * @param {string} enrollmentId - Enrollment ID to enroll.
+     * @param {string} registration - Enrollment secret returned at registration time.
+     * @return {Promise<Identity>} The enrolled identity object with credentials.
+     */
+    enroll(enrollmentId: string, registration: string, ...args: MaybeContextualArg<any>): Promise<Identity>;
+    /**
+     * @description Register and enroll a new identity in one step.
+     * @summary Registers a new enrollment ID with the CA and immediately exchanges the secret to enroll, returning the created Identity.
+     * @param {Credentials} model - Credentials for the new identity containing userName and password.
+     * @param {boolean} [isSuperUser=false] - Whether to register the identity as a super user.
+     * @param {string} [affiliation=""] - Affiliation string (e.g., org1.department1).
+     * @param {CA_ROLE | string} [userRole] - Role to assign to the identity.
+     * @param {IKeyValueAttribute} [attrs] - Optional attributes to attach to the identity.
+     * @param {number} [maxEnrollments] - Maximum number of enrollments allowed for the identity.
+     * @return {Promise<Identity>} The enrolled identity.
+     */
+    registerAndEnroll(model: Credentials, isSuperUser?: boolean, affiliation?: string, userRole?: CA_ROLE | string, attrs?: IKeyValueAttribute, maxEnrollments?: number, ...args: MaybeContextualArg<any>): Promise<Identity>;
+    /**
+     * @description Re-enroll an existing identity using its current enrollment.
+     * @summary Renews the enrollment certificate by calling the CA reenroll.
+     * @param {User} currentUser - Already enrolled user, must have a signing identity.
+     * @return {Promise<Identity>} The renewed identity object with new credentials.
+     */
+    updateIdentity(enrollmentId: string, identity: {
+        certificate: string;
+        privateKey: string;
+    }, identityRequest: IIdentityRequest, ...args: MaybeContextualArg<any>): Promise<Identity>;
+    /**
+     * Revokes the enrollment of an identity with the specified enrollment ID.
+     *
+     * @param enrollmentId - The enrollment ID of the identity to be revoked.
+     *
+     * @returns A Promise that resolves to the result of the revocation operation.
+     *
+     * @throws {NotFoundError} If the enrollment with the specified ID does not exist.
+     * @throws {InternalError} If there is an error during the revocation process.
+     */
+    revoke(enrollmentId: string, revokeOptions: Omit<IRevokeRequest, "enrollmentID">, ...args: MaybeContextualArg<any>): Promise<IServiceResponse>;
+}

package/lib/types/client/services/RegistrationRequestBuilder.d.cts

@@ -0,0 +1,19 @@
+import { IRegisterRequest, IKeyValueAttribute } from "fabric-ca-client";
+import { CA_ROLE } from "./constants.cjs";
+import { Model } from "@decaf-ts/decorator-validation";
+export declare class RegistrationRequestBuilder extends Model {
+    affiliation: string;
+    attrs?: IKeyValueAttribute[];
+    enrollmentID: string;
+    enrollmentSecret: string;
+    maxEnrollments?: number;
+    role: string;
+    build(): IRegisterRequest;
+    setAffiliation(value: string): this;
+    addAttr(attr: IKeyValueAttribute): this;
+    setAttrs(value: IKeyValueAttribute[]): this;
+    setEnrollmentID(value: string): this;
+    setEnrollmentSecret(value: string): this;
+    setMaxEnrollments(value: number): this;
+    setRole(value: CA_ROLE | string): this;
+}

package/lib/types/client/services/RegistrationRequestBuilder.d.mts

@@ -0,0 +1,19 @@
+import { IRegisterRequest, IKeyValueAttribute } from "fabric-ca-client";
+import { CA_ROLE } from "./constants.js";
+import { Model } from "@decaf-ts/decorator-validation";
+export declare class RegistrationRequestBuilder extends Model {
+    affiliation: string;
+    attrs?: IKeyValueAttribute[];
+    enrollmentID: string;
+    enrollmentSecret: string;
+    maxEnrollments?: number;
+    role: string;
+    build(): IRegisterRequest;
+    setAffiliation(value: string): this;
+    addAttr(attr: IKeyValueAttribute): this;
+    setAttrs(value: IKeyValueAttribute[]): this;
+    setEnrollmentID(value: string): this;
+    setEnrollmentSecret(value: string): this;
+    setMaxEnrollments(value: number): this;
+    setRole(value: CA_ROLE | string): this;
+}

package/lib/types/client/services/constants.d.cts

@@ -0,0 +1,15 @@
+/**
+ * @description Certificate Authority role types used during enrollment and registration.
+ * @summary Enumerates the standard Hyperledger Fabric CA roles that can be assigned to identities when registering with the CA service.
+ * @enum {string}
+ * @readonly
+ * @memberOf module:for-fabric.client
+ */
+export declare enum CA_ROLE {
+    /** Administrator role with elevated privileges for managing identities and affiliations */
+    ADMIN = "admin",
+    /** Standard user role for application clients interacting with the network */
+    USER = "user",
+    /** Client role typically used for SDK-based interactions and service accounts */
+    CLIENT = "client"
+}

package/lib/types/client/services/constants.d.mts

@@ -0,0 +1,15 @@
+/**
+ * @description Certificate Authority role types used during enrollment and registration.
+ * @summary Enumerates the standard Hyperledger Fabric CA roles that can be assigned to identities when registering with the CA service.
+ * @enum {string}
+ * @readonly
+ * @memberOf module:for-fabric.client
+ */
+export declare enum CA_ROLE {
+    /** Administrator role with elevated privileges for managing identities and affiliations */
+    ADMIN = "admin",
+    /** Standard user role for application clients interacting with the network */
+    USER = "user",
+    /** Client role typically used for SDK-based interactions and service accounts */
+    CLIENT = "client"
+}

package/lib/types/client/services/index.d.cts

@@ -0,0 +1,4 @@
+export * from "./FabricEnrollmentService.cjs";
+export * from "./RegistrationRequestBuilder.cjs";
+export * from "./FabricIdentityService.cjs";
+export * from "./constants.cjs";

package/lib/types/client/services/index.d.mts

@@ -0,0 +1,4 @@
+export * from "./FabricEnrollmentService.js";
+export * from "./RegistrationRequestBuilder.js";
+export * from "./FabricIdentityService.js";
+export * from "./constants.js";

package/lib/types/client/types.d.cts

@@ -0,0 +1,20 @@
+import { FabricFlags } from "../shared/index.cjs";
+export type FabricClientFlags = FabricFlags & {
+    evaluateTimeout: number;
+    endorseTimeout: number;
+    submitTimeout: number;
+    commitTimeout: number;
+    endorsingOrgs?: string[];
+    keyCertOrDirectoryPath?: string | Buffer;
+    certCertOrDirectoryPath?: string | Buffer;
+    chaincodeName?: string;
+    contractName?: string;
+    sizeLimit?: number;
+    mspId?: string;
+    channel?: string;
+    legacy?: boolean;
+    allowGatewayOverride?: boolean;
+    allowManualEndorsingOrgs: boolean;
+    encryptTransient?: false | string | (() => string);
+    syntheticEvents?: boolean;
+};

package/lib/types/client/types.d.mts

@@ -0,0 +1,20 @@
+import { FabricFlags } from "../shared/index.js";
+export type FabricClientFlags = FabricFlags & {
+    evaluateTimeout: number;
+    endorseTimeout: number;
+    submitTimeout: number;
+    commitTimeout: number;
+    endorsingOrgs?: string[];
+    keyCertOrDirectoryPath?: string | Buffer;
+    certCertOrDirectoryPath?: string | Buffer;
+    chaincodeName?: string;
+    contractName?: string;
+    sizeLimit?: number;
+    mspId?: string;
+    channel?: string;
+    legacy?: boolean;
+    allowGatewayOverride?: boolean;
+    allowManualEndorsingOrgs: boolean;
+    encryptTransient?: false | string | (() => string);
+    syntheticEvents?: boolean;
+};

package/lib/types/client/utils.d.cts

@@ -0,0 +1,71 @@
+import { Identity, Signer } from "@hyperledger/fabric-gateway";
+import { CryptoSetting, ICryptoSuite, User } from "fabric-common";
+import { HSMOptions } from "../shared/types.cjs";
+/**
+ * @description Core utilities for interacting with files, crypto identities, and Fabric SDK helpers
+ * @summary Provides static helper methods to read credentials and keys from disk or raw content, construct Fabric gateway Identities and Signers, and perform common filesystem operations used by the Fabric client tooling.
+ * @class CoreUtils
+ * @example
+ * // Read an identity and signer from directories
+ * const identity = await CoreUtils.getIdentity('Org1MSP', '/msp/signcerts');
+ * const signer = await CoreUtils.getSigner('/msp/keystore');
+ * // Build a CA user
+ * const user = await CoreUtils.getCAUser('appUser', pemKey, pemCert, 'Org1MSP');
+ */
+export declare class CoreUtils {
+    private static logger;
+    private static cryptoSuite;
+    private constructor();
+    /**
+     * @description Resolve file content from a path or return provided raw content
+     * @summary If the input is a Uint8Array or PEM content, returns it as-is; otherwise uses a provided async fileReader to load the content from disk.
+     * @param {string|Uint8Array} contentOrPath - Either a raw content buffer/string or a filesystem path
+     * @param {function(string): Promise<string|Uint8Array|Buffer>} fileReader - Async function to read file content when a path is provided
+     * @return {Promise<string|Uint8Array|Buffer>} The content to be used downstream
+     */
+    private static contentOfLoadFile;
+    /**
+     * @description Read file content from a path or return provided Buffer
+     * @summary Convenience wrapper that loads a file using fs.promises when a path string is provided; otherwise returns the given Buffer directly.
+     * @param {string|Buffer} contentOrPath - Path to a file on disk or an already-loaded Buffer
+     * @return {Promise<string|Uint8Array|Buffer>} The file content as a Buffer/string depending on reader
+     */
+    static readFile(contentOrPath: string | Buffer): Promise<Buffer<ArrayBufferLike>>;
+    /**
+     * @description Create a Fabric CA User object with enrollment
+     * @summary Constructs a fabric-common User, sets a crypto suite, imports the provided private key, and sets enrollment with certificate and MSP ID.
+     * @param {string} userName - The user name for the CA user
+     * @param {string} privateKey - PEM-encoded private key
+     * @param {string} certificate - PEM-encoded X.509 certificate
+     * @param {string} mspId - Membership Service Provider identifier
+     * @return {Promise<User>} The enrolled Fabric User instance
+     */
+    static getCAUser(userName: string, privateKey: string | undefined, certificate: string, mspId: string, options?: {
+        hsm?: HSMOptions;
+    }): Promise<User>;
+    static getCryptoSuite(options?: CryptoSetting): ICryptoSuite;
+    private static getSoftwareEnrollmentKey;
+    private static getHSMEnrollmentKey;
+    static getCertificateSKI(certificate: string): Promise<Buffer>;
+    /**
+     * @description Build a Fabric Gateway Identity from an MSP ID and certificate
+     * @summary Reads a certificate from a directory path or accepts raw content and returns an Identity object suitable for the Fabric Gateway.
+     * @param {string} mspId - Membership Service Provider ID
+     * @param {string} certDirectoryPath - Path to a directory containing the certificate file, or PEM content
+     * @return {Promise<Identity>} The identity containing mspId and certificate credentials
+     */
+    static getIdentity(mspId: string, certDirectoryPath: string): Promise<Identity>;
+    static getFirstDirFileName(dirPath: string): Promise<string>;
+    static getFirstDirFileNameContent(dirPath: string): Promise<string>;
+    static getFileContent(filePath: string): Promise<string>;
+    static getSigner(keyDirectoryPath: string): Promise<Signer>;
+    private static extractPrivateKey;
+}
+/**
+ * Extracts the certificate Serial Number and the AKI (Authority Key Identifier)
+ * in the format Fabric CA expects (plain hex, no colons).
+ */
+export declare function getAkiAndSerialFromCert(cert: string): {
+    aki: string;
+    serial: string;
+};

package/lib/types/client/utils.d.mts

@@ -0,0 +1,71 @@
+import { Identity, Signer } from "@hyperledger/fabric-gateway";
+import { CryptoSetting, ICryptoSuite, User } from "fabric-common";
+import { HSMOptions } from "../shared/types.js";
+/**
+ * @description Core utilities for interacting with files, crypto identities, and Fabric SDK helpers
+ * @summary Provides static helper methods to read credentials and keys from disk or raw content, construct Fabric gateway Identities and Signers, and perform common filesystem operations used by the Fabric client tooling.
+ * @class CoreUtils
+ * @example
+ * // Read an identity and signer from directories
+ * const identity = await CoreUtils.getIdentity('Org1MSP', '/msp/signcerts');
+ * const signer = await CoreUtils.getSigner('/msp/keystore');
+ * // Build a CA user
+ * const user = await CoreUtils.getCAUser('appUser', pemKey, pemCert, 'Org1MSP');
+ */
+export declare class CoreUtils {
+    private static logger;
+    private static cryptoSuite;
+    private constructor();
+    /**
+     * @description Resolve file content from a path or return provided raw content
+     * @summary If the input is a Uint8Array or PEM content, returns it as-is; otherwise uses a provided async fileReader to load the content from disk.
+     * @param {string|Uint8Array} contentOrPath - Either a raw content buffer/string or a filesystem path
+     * @param {function(string): Promise<string|Uint8Array|Buffer>} fileReader - Async function to read file content when a path is provided
+     * @return {Promise<string|Uint8Array|Buffer>} The content to be used downstream
+     */
+    private static contentOfLoadFile;
+    /**
+     * @description Read file content from a path or return provided Buffer
+     * @summary Convenience wrapper that loads a file using fs.promises when a path string is provided; otherwise returns the given Buffer directly.
+     * @param {string|Buffer} contentOrPath - Path to a file on disk or an already-loaded Buffer
+     * @return {Promise<string|Uint8Array|Buffer>} The file content as a Buffer/string depending on reader
+     */
+    static readFile(contentOrPath: string | Buffer): Promise<Buffer<ArrayBufferLike>>;
+    /**
+     * @description Create a Fabric CA User object with enrollment
+     * @summary Constructs a fabric-common User, sets a crypto suite, imports the provided private key, and sets enrollment with certificate and MSP ID.
+     * @param {string} userName - The user name for the CA user
+     * @param {string} privateKey - PEM-encoded private key
+     * @param {string} certificate - PEM-encoded X.509 certificate
+     * @param {string} mspId - Membership Service Provider identifier
+     * @return {Promise<User>} The enrolled Fabric User instance
+     */
+    static getCAUser(userName: string, privateKey: string | undefined, certificate: string, mspId: string, options?: {
+        hsm?: HSMOptions;
+    }): Promise<User>;
+    static getCryptoSuite(options?: CryptoSetting): ICryptoSuite;
+    private static getSoftwareEnrollmentKey;
+    private static getHSMEnrollmentKey;
+    static getCertificateSKI(certificate: string): Promise<Buffer>;
+    /**
+     * @description Build a Fabric Gateway Identity from an MSP ID and certificate
+     * @summary Reads a certificate from a directory path or accepts raw content and returns an Identity object suitable for the Fabric Gateway.
+     * @param {string} mspId - Membership Service Provider ID
+     * @param {string} certDirectoryPath - Path to a directory containing the certificate file, or PEM content
+     * @return {Promise<Identity>} The identity containing mspId and certificate credentials
+     */
+    static getIdentity(mspId: string, certDirectoryPath: string): Promise<Identity>;
+    static getFirstDirFileName(dirPath: string): Promise<string>;
+    static getFirstDirFileNameContent(dirPath: string): Promise<string>;
+    static getFileContent(filePath: string): Promise<string>;
+    static getSigner(keyDirectoryPath: string): Promise<Signer>;
+    private static extractPrivateKey;
+}
+/**
+ * Extracts the certificate Serial Number and the AKI (Authority Key Identifier)
+ * in the format Fabric CA expects (plain hex, no colons).
+ */
+export declare function getAkiAndSerialFromCert(cert: string): {
+    aki: string;
+    serial: string;
+};