@sphereon/ssi-sdk.credential-store 0.33.1-next.3 → 0.33.1-next.68

package/dist/index.d.ts

@@ -1,12 +1,235 @@
+import * as _sphereon_ssi_types from '@sphereon/ssi-types';
+import { HasherSync, OriginalVerifiableCredential, OriginalVerifiablePresentation, ICredential, IPresentation, IVerifiableCredential, IVerifiablePresentation } from '@sphereon/ssi-types';
+import { NonPersistedDigitalCredential, DigitalCredential, UpdateCredentialStateArgs, FindDigitalCredentialArgs, CredentialRole, AbstractDigitalCredentialStore } from '@sphereon/ssi-sdk.data-store';
+export { CredentialCorrelationType, CredentialDocumentFormat, CredentialRole, CredentialStateType, DigitalCredential, DocumentType, FindDigitalCredentialArgs, UpdateCredentialStateArgs } from '@sphereon/ssi-sdk.data-store';
+import { IPluginMethodMap, IAgentContext, IAgentPlugin } from '@veramo/core';
+
+type TClaimsColumns = 'context' | 'credentialType' | 'type' | 'value' | 'isObj' | 'id' | 'issuer' | 'subject' | 'expirationDate' | 'issuanceDate';
+/**
+ * Represents the sort order of results from a {@link FindArgs} query.
+ *
+ * @beta This API may change without a BREAKING CHANGE notice.
+ */
+interface Order<TColumns> {
+    column: TColumns;
+    direction: 'ASC' | 'DESC';
+}
+/**
+ * Represents a WHERE predicate for a {@link FindArgs} query.
+ * In situations where multiple WHERE predicates are present, they are combined with AND.
+ *
+ * @beta This API may change without a BREAKING CHANGE notice.
+ */
+interface Where<TColumns> {
+    column: TColumns;
+    value?: string[];
+    not?: boolean;
+    op?: 'LessThan' | 'LessThanOrEqual' | 'MoreThan' | 'MoreThanOrEqual' | 'Equal' | 'Like' | 'Between' | 'In' | 'Any' | 'IsNull';
+}
+interface FindArgs<TColumns> {
+    /**
+     * Imposes constraints on the values of the given columns.
+     * WHERE clauses are combined using AND.
+     */
+    where?: Where<TColumns>[];
+    /**
+     * Sorts the results according to the given array of column priorities.
+     */
+    order?: Order<TColumns>[];
+    /**
+     * Ignores the first number of entries in a {@link IDataStoreORM} query result.
+     */
+    skip?: number;
+    /**
+     * Returns at most this number of results from a {@link IDataStoreORM} query.
+     */
+    take?: number;
+}
+type FindClaimsArgs = FindArgs<TClaimsColumns>;
+
+interface ICredentialStore extends IPluginMethodMap {
+    /**
+     * Add a new credential.
+     * @param args
+     */
+    crsAddCredential(args: AddCredentialArgs): Promise<DigitalCredential>;
+    /**
+     * Update credential the state of an existing credential.
+     * @param args
+     */
+    crsUpdateCredentialState(args: UpdateCredentialStateArgs): Promise<DigitalCredential>;
+    /**
+     * Get a single credentials by primary key
+     * @param args
+     */
+    crsGetCredential(args: GetCredentialArgs): Promise<DigitalCredential>;
+    /**
+     * Find one or more credentials using filters
+     * @param args
+     */
+    crsGetCredentials(args: GetCredentialsArgs): Promise<Array<DigitalCredential>>;
+    /**
+     * Find one or more credentials using filters
+     * @param args
+     */
+    crsGetUniqueCredentials(args: GetCredentialsArgs): Promise<Array<UniqueDigitalCredential>>;
+    /**
+     * Find one credential by id or hash
+     * @param args
+     */
+    crsGetUniqueCredentialByIdOrHash(args: GetCredentialsByIdOrHashArgs): Promise<OptionalUniqueDigitalCredential>;
+    /**
+     * Returns a list of UniqueDigitalCredentials that match the given filter based on the claims they contain.
+     * @param args
+     */
+    crsGetCredentialsByClaims(args: GetCredentialsByClaimsArgs): Promise<Array<UniqueDigitalCredential>>;
+    /**
+     * Returns a count of UniqueDigitalCredentials that match the given filter based on the claims they contain.
+     * @param args
+     */
+    crsGetCredentialsByClaimsCount(args: GetCredentialsByClaimsArgs): Promise<number>;
+    /**
+     * Delete a single credentials by primary key
+     * @param args
+     */
+    crsDeleteCredential(args: DeleteCredentialArgs): Promise<boolean>;
+    /**
+     * Delete multiple credentials records using filters
+     * @param args
+     */
+    crsDeleteCredentials(args: DeleteCredentialsArgs): Promise<number>;
+}
+/**
+ *
+ * @param context
+ * @internal
+ */
+declare function contextHasCredentialStore(context: IAgentContext<IPluginMethodMap>): context is IAgentContext<ICredentialStore>;
+type GetCredentialArgs = {
+    id: string;
+};
+type GetCredentialsArgs = {
+    filter: FindDigitalCredentialArgs;
+};
+type GetCredentialsByClaimsArgs = {
+    filter: FindClaimsArgs;
+    credentialRole?: CredentialRole;
+    tenantId?: string;
+};
+type GetCredentialsByIdOrHashArgs = {
+    credentialRole: CredentialRole;
+    idOrHash: string;
+};
+type DeleteCredentialArgs = {
+    id: string;
+} | {
+    hash: string;
+};
+type DeleteCredentialsArgs = GetCredentialsArgs;
+type AddDigitalCredential = Omit<NonPersistedDigitalCredential, 'id' | 'documentType' | 'documentFormat' | 'uniformDocument' | 'hash' | 'createdAt' | 'lastUpdatedAt' | 'validFrom' | 'validUntil'>;
+type AddCredentialArgs = {
+    credential: AddDigitalCredential;
+    opts?: {
+        maxTimeSkewInMS?: number;
+        hasher?: HasherSync;
+    };
+};
+interface UniqueDigitalCredential {
+    hash: string;
+    id?: string;
+    digitalCredential: DigitalCredential;
+    originalVerifiableCredential?: OriginalVerifiableCredential;
+    originalVerifiablePresentation?: OriginalVerifiablePresentation;
+    originalCredential?: ICredential;
+    originalPresentation?: IPresentation;
+    uniformVerifiableCredential?: IVerifiableCredential;
+    uniformVerifiablePresentation?: IVerifiablePresentation;
+}
+type OptionalUniqueDigitalCredential = UniqueDigitalCredential | undefined;
+type RequiredContext = IAgentContext<never>;
+
+declare const credentialStoreMethods: Array<string>;
+/**
+ * {@inheritDoc ICRManager}
+ */
+declare class CredentialStore implements IAgentPlugin {
+    readonly schema: any;
+    readonly methods: ICredentialStore;
+    private readonly store;
+    constructor(options: {
+        store: AbstractDigitalCredentialStore;
+    });
+    /** {@inheritDoc ICredentialStore.crsAddCredential} */
+    private crsAddCredential;
+    /** {@inheritDoc ICredentialStore.crsUpdateCredentialState} */
+    private crsUpdateCredentialState;
+    /** {@inheritDoc ICredentialStore.crsGetCredential} */
+    private crsGetCredential;
+    /** {@inheritDoc ICredentialStore.crsGetCredentials} */
+    private crsGetCredentials;
+    /** {@inheritDoc ICredentialStore.crsGetUniqueCredentialByIdOrHash} */
+    private crsGetUniqueCredentialByIdOrHash;
+    /** {@inheritDoc ICredentialStore.crsGetUniqueCredentials} */
+    private crsGetUniqueCredentials;
+    /** {@inheritDoc ICredentialStore.crsDeleteCredential} */
+    private crsDeleteCredential;
+    /** {@inheritDoc ICredentialStore.crsDeleteCredentials} */
+    private crsDeleteCredentials;
+    /**
+     * Returns a list of UniqueDigitalCredentials that match the given filter based on the claims they contain.
+     * @param args
+     */
+    private crsGetCredentialsByClaims;
+    private getValueFromCredential;
+    /**
+     * Returns a count of UniqueDigitalCredentials that match the given filter based on the claims they contain.
+     * @param args
+     */
+    private crsGetCredentialsByClaimsCount;
+    private secureParse;
+    private toUniqueCredentials;
+}
+
+/**
+ * Creates a filter to find a digital credential by its ID or hash.
+ *
+ * @param credentialRole - The role to filter by (e.g., ISSUER, HOLDER).
+ * @param idOrHash - The ID or hash of the credential to search for.
+ * @returns A FindDigitalCredentialArgs array for filtering by ID or hash.
+ */
+declare const credentialIdOrHashFilter: (credentialRole: CredentialRole, idOrHash: string) => FindDigitalCredentialArgs;
+/**
+ * Creates a filter for verifiable credentials with a specific role.
+ *
+ * @param credentialRole - The role to filter by (e.g., ISSUER, HOLDER).
+ * @param withFilter - Optional additional filter criteria.
+ * @returns A FindDigitalCredentialArgs array for filtering verifiable credentials by role.
+ */
+declare const verifiableCredentialForRoleFilter: (credentialRole: CredentialRole, withFilter?: FindDigitalCredentialArgs) => FindDigitalCredentialArgs;
+/**
+ * Merges two FindDigitalCredentialArgs arrays into a single array.
+ *
+ * This function combines two filter arrays, merging objects at the same index
+ * and adding unique objects from both arrays. When merging objects, properties
+ * from filter2 overwrite those from filter1 if they exist in both.
+ *
+ * @param filter1 - The first FindDigitalCredentialArgs array to merge.
+ * @param filter2 - The second FindDigitalCredentialArgs array to merge.
+ * @returns A new FindDigitalCredentialArgs array containing the merged result.
+ *
+ * @example
+ * const filter1 = [{ documentType: DocumentType.VC }, { credentialRole: CredentialRole.ISSUER }];
+ * const filter2 = [{ documentType: DocumentType.VP }, { hash: 'abc123' }];
+ * const mergedFilter = mergeFilter(filter1, filter2);
+ * // Result: [{ documentType: DocumentType.VP }, { credentialRole: CredentialRole.ISSUER, hash: 'abc123' }]
+ */
+declare const mergeFilter: (filter1: FindDigitalCredentialArgs, filter2: FindDigitalCredentialArgs) => FindDigitalCredentialArgs;
+
 /**
  * @public
  */
 declare const schema: any;
-export { schema };
-export declare const logger: import("@sphereon/ssi-types").ISimpleLogger<unknown>;
-export { CredentialStore, credentialStoreMethods } from './agent/CredentialStore';
-export { CredentialRole, CredentialStateType, CredentialCorrelationType, CredentialDocumentFormat, DocumentType, DigitalCredential, FindDigitalCredentialArgs, } from '@sphereon/ssi-sdk.data-store';
-export * from './types/ICredentialStore';
-export * from './types/claims';
-export * from './utils/filters';
-//# sourceMappingURL=index.d.ts.map
+
+declare const logger: _sphereon_ssi_types.ISimpleLogger<unknown>;
+
+export { type AddCredentialArgs, type AddDigitalCredential, CredentialStore, type DeleteCredentialArgs, type DeleteCredentialsArgs, type FindArgs, type FindClaimsArgs, type GetCredentialArgs, type GetCredentialsArgs, type GetCredentialsByClaimsArgs, type GetCredentialsByIdOrHashArgs, type ICredentialStore, type OptionalUniqueDigitalCredential, type Order, type RequiredContext, type TClaimsColumns, type UniqueDigitalCredential, type Where, contextHasCredentialStore, credentialIdOrHashFilter, credentialStoreMethods, logger, mergeFilter, schema, verifiableCredentialForRoleFilter };