@decaf-ts/for-fabric 0.11.0 → 0.12.0

package/lib/types/shared/events.d.ts

@@ -1,37 +0,0 @@
-import { BulkCrudOperationKeys, OperationKeys } from "@decaf-ts/db-decorators";
-/**
- * @description Generates a Fabric event name from components
- * @summary Creates a standardized event name by joining table, event, and optional owner with underscores
- * @param {string} table - The table/collection name
- * @param {OperationKeys | BulkCrudOperationKeys | string} event - The event type
- * @param {string} [owner] - Optional owner identifier
- * @return {string} The generated event name in format "table_event" or "table_event_owner"
- * @function generateFabricEventName
- * @memberOf module:for-fabric.shared
- */
-export declare function generateFabricEventName(table: string, event: OperationKeys | BulkCrudOperationKeys | string, owner?: string): string;
-/**
- * @description Parses a Fabric event name into its components
- * @summary Splits an event name by underscores and extracts table, event, and optional owner
- * @param {string} name - The event name to parse
- * @return {{table: string, event: OperationKeys | BulkCrudOperationKeys | string, owner: string}} The parsed components as a structured object
- * @throws {InternalError} If the event name format is invalid
- * @function parseEventName
- * @mermaid
- * sequenceDiagram
- *   participant Caller
- *   participant Parser as parseEventName
- *   Caller->>Parser: parseEventName(name)
- *   Parser->>Parser: split name by "_"
- *   alt parts length invalid
- *     Parser-->>Caller: throw InternalError
- *   else
- *     Parser-->>Caller: { table, event, owner? }
- *   end
- * @memberOf module:for-fabric.shared
- */
-export declare function parseEventName(name: string): {
-    table?: string;
-    event: OperationKeys | BulkCrudOperationKeys | string;
-    owner?: string;
-};

package/lib/types/shared/fabric-types.d.ts

@@ -1,32 +0,0 @@
-export type GetCertificatesRequest = {
-    id?: string;
-    aki?: string;
-    serial?: string;
-    revoked_start?: string;
-    revoked_end?: string;
-    expired_start?: string;
-    expired_end?: string;
-    notrevoked?: boolean;
-    notexpired?: boolean;
-    ca?: string;
-};
-export type CertificateResponse = {
-    caname: string;
-    certs: {
-        PEM: string;
-    }[];
-};
-export type FabricIdentity = {
-    id: string;
-    type: string;
-    affiliation: string;
-    attrs: {
-        name: string;
-        value: string;
-    }[];
-    max_enrollments: number;
-};
-export type IdentityResponse = {
-    caname: string;
-    identities: FabricIdentity[];
-};

package/lib/types/shared/index.d.ts

@@ -1,21 +0,0 @@
-/**
- * @description Hyperledger Fabric Shared Module for Decaf-ts
- * @summary This module provides common logic to the client and contract sides of Hyperledger Fabric
- * @namespace shared
- * @memberOf module:for-fabric
- */
-import "./overrides";
-export * from "./erc20";
-export * from "./interfaces";
-export * from "./model";
-export * from "./overrides";
-export * from "./ClientSerializer";
-export * from "./constants";
-export * from "./decorators";
-export * from "./DeterministicSerializer";
-export * from "./errors";
-export * from "./events";
-export * from "./fabric-types";
-export * from "./math";
-export * from "./SimpleDeterministicSerializer";
-export * from "./types";

package/lib/types/shared/interfaces/Checkable.d.ts

@@ -1,23 +0,0 @@
-import { Context } from "fabric-contract-api";
-/**
- * @description Interface for health-check capable contracts/services
- * @summary Provides a standard healthcheck method signature to probe liveness/readiness of Fabric contracts or services using a Fabric context
- * @param {Context} ctx - Fabric transaction context used for performing the health check
- * @return {Promise<string|boolean>} A message describing health or a boolean status
- * @interface Checkable
- * @memberOf module:for-fabric.shared
- */
-export interface Checkable {
-    /**
-     * @description Perform a health check using the Fabric transaction context
-     * @summary Allows implementers to report readiness/liveness information that can be a textual message or a boolean status
-     * @param {Context} ctx - Fabric transaction context reference used during the check
-     * @return {Promise<string|boolean>} A string message describing health or a boolean indicating healthy/unhealthy
-     */
-    healthcheck(ctx: Context): Promise<string | healthcheck>;
-}
-export type healthcheck = {
-    healthcheck: boolean;
-    version: string | number;
-    package: string;
-};

package/lib/types/shared/interfaces/index.d.ts

@@ -1 +0,0 @@
-export * from "./Checkable";

package/lib/types/shared/math.d.ts

@@ -1,34 +0,0 @@
-/**
- * @description Overflow-safe addition operation
- * @summary Adds two numbers and verifies no overflow by reverse-checking the operands
- * @param {number} a - First operand
- * @param {number} b - Second operand
- * @return {number} The sum of a and b
- * @function add
- * @throws {OverflowError} on addition overflow
- * @memberOf module:for-fabric.shared
- */
-export declare function add(a: number, b: number): number;
-/**
- * @description Overflow-safe subtraction operation
- * @summary Subtracts b from a and validates no overflow by reverse-checking the operands
- * @param {number} a - Minuend
- * @param {number} b - Subtrahend
- * @return {number} The difference a - b
- * @function sub
- * @throws {OverflowError} on subtaction overflow
- * @memberOf module:for-fabric.shared
- */
-export declare function sub(a: number, b: number): number;
-/**
- * @summary Safe Integer Parse
- *
- * @param {string} string
- *
- * @function safeParseInt
- *
- * @throws {ValidationError} if parseInt returns NaN
- *
- * @memberOf module:for-fabric.shared
- */
-export declare function safeParseInt(string: string): number;

package/lib/types/shared/model/FabricBaseModel.d.ts

@@ -1,7 +0,0 @@
-import { Model, type ModelArg } from "@decaf-ts/decorator-validation";
-export declare class FabricBaseModel extends Model {
-    createdAt: Date;
-    updatedAt: Date;
-    version: number;
-    constructor(arg?: ModelArg<FabricBaseModel>);
-}

package/lib/types/shared/model/FabricIdentifiedBaseModel.d.ts

@@ -1,7 +0,0 @@
-import { type ModelArg } from "@decaf-ts/decorator-validation";
-import { FabricBaseModel } from "./FabricBaseModel";
-export declare abstract class FabricIdentifiedBaseModel extends FabricBaseModel {
-    createdBy: string;
-    updatedBy: string;
-    protected constructor(arg?: ModelArg<FabricIdentifiedBaseModel>);
-}

package/lib/types/shared/model/Identity.d.ts

@@ -1,42 +0,0 @@
-import { BaseModel } from "@decaf-ts/core";
-import { type ModelArg } from "@decaf-ts/decorator-validation";
-import { IdentityCredentials } from "./IdentityCredentials";
-import { IdentityType } from "../constants";
-/**
- * @description Identity model representing a Fabric wallet entry
- * @summary Encapsulates an identity stored in a Fabric wallet, including its MSP identifier, credential linkage, and type information. Built on BaseModel for integration with Decaf validation and persistence.
- * @param {ModelArg<Identity>} [arg] - Optional initialization object used to populate model fields
- * @class Identity
- * @example
- * // Create a new identity referencing existing credentials
- * const id = new Identity({ id: "user1", mspId: "Org1MSP", type: IdentityType.X509 });
- * @mermaid
- * sequenceDiagram
- *   participant App
- *   participant Model as Identity
- *   App->>Model: new Identity({ id, mspId, type })
- *   Model-->>App: instance
- */
-export declare class Identity extends BaseModel {
-    /**
-     * @description Unique identifier of the identity in the wallet
-     * @summary Primary key used to reference this identity record
-     */
-    id: string;
-    /**
-     * @description Link to the identity credentials stored separately
-     * @summary One-to-one relationship to the credentials entity; cascades on update and delete
-     */
-    credentials: IdentityCredentials;
-    /**
-     * @description Membership Service Provider identifier
-     * @summary The MSP ID corresponding to the organization that issued this identity
-     */
-    mspId: string;
-    /**
-     * @description Type of identity
-     * @summary Indicates the identity encoding/format; defaults to X.509
-     */
-    type: IdentityType;
-    constructor(arg: ModelArg<Identity>);
-}

package/lib/types/shared/model/IdentityCredentials.d.ts

@@ -1,41 +0,0 @@
-import { BaseModel } from "@decaf-ts/core";
-import { type ModelArg } from "@decaf-ts/decorator-validation";
-/**
- * @description Identity credential model storing cryptographic materials
- * @summary Holds certificate chain and private key information for a Fabric identity, managed as a separate entity linked from Identity
- * @param {ModelArg<IdentityCredentials>} [arg] - Optional initialization object used to populate model fields
- * @class IdentityCredentials
- * @example
- * // Create credentials entry
- * const creds = new IdentityCredentials({ id: "creds1", certificate: "...", rootCertificate: "...", privateKey: "..." });
- * @mermaid
- * sequenceDiagram
- *   participant App
- *   participant Model as IdentityCredentials
- *   App->>Model: new IdentityCredentials({ id, certificate, rootCertificate, privateKey })
- *   Model-->>App: instance
- * @see model
- */
-export declare class IdentityCredentials extends BaseModel {
-    /**
-     * @description Unique identifier of the credentials record
-     * @summary Primary key for referencing this credentials entry
-     */
-    id: string;
-    /**
-     * @description PEM-encoded X.509 certificate for the identity
-     * @summary Leaf certificate associated with the identity
-     */
-    certificate: string;
-    /**
-     * @description PEM-encoded root or intermediate certificate
-     * @summary Root of trust used to validate the leaf certificate
-     */
-    rootCertificate: string;
-    /**
-     * @description PEM-encoded private key material
-     * @summary Private key corresponding to the identity certificate
-     */
-    privateKey: string;
-    constructor(arg?: ModelArg<IdentityCredentials>);
-}

package/lib/types/shared/model/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./FabricBaseModel";
-export * from "./FabricIdentifiedBaseModel";
-export * from "./Identity";
-export * from "./IdentityCredentials";

package/lib/types/shared/overrides/Model.d.ts

@@ -1,22 +0,0 @@
-import { SegregatedModel } from "../types";
-import { Constructor } from "@decaf-ts/decoration";
-import "@decaf-ts/decorator-validation";
-import { CollectionResolver, MirrorMetadata } from "../decorators";
-declare module "@decaf-ts/decorator-validation" {
-    interface Model {
-        isPrivate<M extends Model>(this: M): boolean;
-        isShared<M extends Model>(this: M): boolean;
-        segregate<M extends Model>(this: M): SegregatedModel<M>;
-    }
-    namespace Model {
-        function isPrivate<M extends Model>(model: Constructor<M>): boolean;
-        function isShared<M extends Model>(model: Constructor<M>): boolean;
-        function segregate<M extends Model>(model: M): SegregatedModel<M>;
-        function ownerOf<M extends Model>(model: M): string;
-        function mirroredAt<M extends Model>(model: M | Constructor<M>): MirrorMetadata | undefined;
-        function collectionsFor<M extends Model>(model: M | Constructor<M>): {
-            privateCols: (string | CollectionResolver)[];
-            sharedCols: (string | CollectionResolver)[];
-        };
-    }
-}

package/lib/types/shared/overrides/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./Model";
-export * from "./overrides";

package/lib/types/shared/overrides/overrides.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/types/shared/types.d.ts

@@ -1,125 +0,0 @@
-import { TLSOptions } from "fabric-ca-client";
-import { ClientIdentity } from "fabric-shim-api";
-import { Model } from "@decaf-ts/decorator-validation";
-import { AdapterFlags } from "@decaf-ts/core";
-import { Logger } from "@decaf-ts/logging";
-export type HSMOptions = {
-    library: string;
-    slot?: number;
-    tokenLabel?: string;
-    pin: string;
-    keyLabel?: string;
-    keyIdHex?: string;
-};
-export type MspDetails = {
-    endpoint: string;
-    tlsCert?: string | Buffer;
-    alias?: string;
-};
-/**
- * @description Configuration for connecting to a Hyperledger Fabric peer
- * @summary Contains all the necessary parameters to establish a connection to a Fabric peer and interact with chaincode
- * @typedef {Object} PeerConfig
- * @property {string} cryptoPath - Path to the crypto materials
- * @property {string} keyCertOrDirectoryPath - Key file contents or Path to the directory containing private keys
- * @property {string} certCertOrDirectoryPath - Cert file contents or Path to the directory containing certificates
- * @property {string} tlsCert - Path to the TLS certificate
- * @property {string} peerEndpoint - Endpoint URL for the peer
- * @property {string} peerHostAlias - Host alias for the peer
- * @property {string} caEndpoint - Endpoint URL for the certificate authority
- * @property {string} caTlsCertificate - TLS certificate for the certificate authority
- * @property {string} caCert - Certificate for the certificate authority
- * @property {string} caKey - Key for the certificate authority
- * @property {string} chaincodeName - Name of the chaincode to interact with
- * @property {string} [contractName] - Optional name of the specific contract within the chaincode
- * @property {string} [ca] - Optional certificate authority name
- * @property {string} mspId - Membership Service Provider ID
- * @property {string} channel - Channel name
- * @memberOf module:for-fabric.shared
- */
-export type PeerConfig = {
-    cryptoPath: string;
-    keyCertOrDirectoryPath: string | Buffer;
-    certCertOrDirectoryPath: string | Buffer;
-    tlsCert: string | Buffer;
-    allowGatewayOverride?: boolean;
-    mspMap?: Record<string, MspDetails[]>;
-    legacyMspCount?: number;
-    peerEndpoint: string;
-    peerHostAlias: string;
-    caEndpoint?: string;
-    caTlsCertificate?: string;
-    caCert?: string;
-    caKey?: string;
-    chaincodeName: string;
-    contractName?: string;
-    sizeLimit?: number;
-    ca?: string;
-    mspId: string;
-    channel: string;
-    evaluateTimeout: number;
-    endorseTimeout: number;
-    submitTimeout: number;
-    commitTimeout: number;
-    hsm?: HSMOptions;
-    /**
-     * When true, only chaincode events whose owner segment in the event name matches
-     * this adapter's mspId are forwarded to observers. Events with a different owner,
-     * or whose event name carries no owner segment, pass through unfiltered.
-     * Defaults to false (all events are forwarded regardless of owner).
-     */
-    mspEventOnly?: boolean;
-    /**
-     * When true (default), the FabricClientDispatch uses a Proxy-based mechanism
-     * to emit events for ALL CRUD operations without a live gateway connection.
-     * When false, the dispatch opens a real chaincode-event subscription via the
-     * gateway and limits the local proxy fallback to fully-segregated models only.
-     */
-    syntheticEvents?: boolean;
-};
-/**
- * @description Configuration for connecting to a Hyperledger Fabric peer
- * @summary Contains all the necessary parameters to establish a connection to a Fabric peer and interact with chaincode
- * @typedef {Object} CAConfig
- * @property {string} url - Path to the crypto materials
- * @property {TLSOptions} tls - Path to the directory containing private keys
- * @property {string} caName - Path to the directory containing certificates
- * @property {string} tlsCertPath - Path to the TLS certificate
- * @property {string} caCert - Endpoint URL for the peer
- * @property {string} [caKey] - Host alias for the peer or directory containing the admin private key
- * @memberOf module:for-fabric.shared
- */
-export type CAConfig = {
-    url: string;
-    tls?: TLSOptions;
-    caName: string;
-    caCert: string;
-    caKey?: string;
-    hsm?: HSMOptions;
-};
-/**
- * @description User credentials for CA enrollment or access
- * @summary Optional username/password pair used when enrolling with a Fabric CA or authenticating in client utilities
- * @interface Credentials
- * @property {string} [userName] - Optional username
- * @property {string} [password] - Optional password
- * @memberOf module:for-fabric.shared
- */
-export interface Credentials {
-    userName?: string;
-    password?: string;
-}
-export type SegregatedModel<M extends Model> = {
-    model: M;
-    public?: Record<keyof M, any>;
-    transient?: Record<keyof M, any>;
-    privates?: Record<string, Record<keyof M, any>>;
-    shared?: Record<string, Record<keyof M, any>>;
-};
-export type FabricFlags<LOG extends Logger = Logger> = AdapterFlags<LOG> & {
-    segregated?: string;
-    mirror?: boolean;
-    mirrorCollection?: string;
-    identity?: string | ClientIdentity;
-    ownerOverride?: string;
-};

package/lib/types/version.d.ts

@@ -1,2 +0,0 @@
-export declare const VERSION = "0.10.0";
-export declare const PACKAGE_NAME = "@decaf-ts/for-fabric";