Skip to main content

makeCollections()

@hyperledger/identus-sdk v8.0.0


@hyperledger/identus-sdk / overview / makeCollections

Function: makeCollections()

makeCollections(additional?: CollectionList): { credential-metadata: { schema: TypedSchema<CredentialMetadata>; }; credentials: { migrationStrategies: {[key: number]: MigrationFunction<TypedSchema<Credential>>; }; schema: TypedSchema<Credential>; }; did-link: { schema: TypedSchema<DIDLink>; }; didkey-link: { schema: TypedSchema<DIDKeyLink>; }; dids: { schema: TypedSchema<DID>; }; issuance: { schema: TypedSchema<Issuance>; }; keys: { schema: TypedSchema<Key>; }; messages: { migrationStrategies: {[key: number]: MigrationFunction<TypedSchema<Message>>; }; schema: TypedSchema<Message>; }; settings: { schema: TypedSchema<Settings>; }; }

Defined in: packages/lib/sdk/src/pluto/collections/index.ts:39

Build the complete map of Pluto collections.

Returns the nine built-in collections (credentials, dids, keys, messages, settings, issuance, and the relationship tables) merged with any user-supplied additional collections.

Parameters

ParameterTypeDescription
additionalCollectionListExtra collections to register alongside the defaults.

Returns

{ credential-metadata: { schema: TypedSchema<CredentialMetadata>; }; credentials: { migrationStrategies: {[key: number]: MigrationFunction<TypedSchema<Credential>>; }; schema: TypedSchema<Credential>; }; did-link: { schema: TypedSchema<DIDLink>; }; didkey-link: { schema: TypedSchema<DIDKeyLink>; }; dids: { schema: TypedSchema<DID>; }; issuance: { schema: TypedSchema<Issuance>; }; keys: { schema: TypedSchema<Key>; }; messages: { migrationStrategies: {[key: number]: MigrationFunction<TypedSchema<Message>>; }; schema: TypedSchema<Message>; }; settings: { schema: TypedSchema<Settings>; }; }

A record of collection name → { schema, migrationStrategies? }.

NameTypeDefault valueDefined in
credential-metadata{ schema: TypedSchema<CredentialMetadata>; }-packages/lib/sdk/src/pluto/collections/index.ts:42
credential-metadata.schemaTypedSchema<CredentialMetadata>Models.CredentialMetadataSchemapackages/lib/sdk/src/pluto/collections/index.ts:42
credentials{ migrationStrategies: {[key: number]: MigrationFunction<TypedSchema<Credential>>; }; schema: TypedSchema<Credential>; }-packages/lib/sdk/src/pluto/collections/index.ts:41
credentials.migrationStrategies{[key: number]: MigrationFunction<TypedSchema<Credential>>; }Models.CredentialMigrationpackages/lib/sdk/src/pluto/collections/index.ts:41
credentials.schemaTypedSchema<Credential>Models.CredentialSchemapackages/lib/sdk/src/pluto/collections/index.ts:41
did-link{ schema: TypedSchema<DIDLink>; }-packages/lib/sdk/src/pluto/collections/index.ts:44
did-link.schemaTypedSchema<DIDLink>Models.DIDLinkSchemapackages/lib/sdk/src/pluto/collections/index.ts:44
didkey-link{ schema: TypedSchema<DIDKeyLink>; }-packages/lib/sdk/src/pluto/collections/index.ts:43
didkey-link.schemaTypedSchema<DIDKeyLink>Models.DIDKeyLinkSchemapackages/lib/sdk/src/pluto/collections/index.ts:43
dids{ schema: TypedSchema<DID>; }-packages/lib/sdk/src/pluto/collections/index.ts:45
dids.schemaTypedSchema<DID>Models.DIDSchemapackages/lib/sdk/src/pluto/collections/index.ts:45
issuance{ schema: TypedSchema<Issuance>; }-packages/lib/sdk/src/pluto/collections/index.ts:49
issuance.schemaTypedSchema<Issuance>Models.IssuanceSchemapackages/lib/sdk/src/pluto/collections/index.ts:49
keys{ schema: TypedSchema<Key>; }-packages/lib/sdk/src/pluto/collections/index.ts:46
keys.schemaTypedSchema<Key>Models.KeySchemapackages/lib/sdk/src/pluto/collections/index.ts:46
messages{ migrationStrategies: {[key: number]: MigrationFunction<TypedSchema<Message>>; }; schema: TypedSchema<Message>; }-packages/lib/sdk/src/pluto/collections/index.ts:47
messages.migrationStrategies{[key: number]: MigrationFunction<TypedSchema<Message>>; }Models.MessageMigrationpackages/lib/sdk/src/pluto/collections/index.ts:47
messages.schemaTypedSchema<Message>Models.MessageSchemapackages/lib/sdk/src/pluto/collections/index.ts:47
settings{ schema: TypedSchema<Settings>; }-packages/lib/sdk/src/pluto/collections/index.ts:48
settings.schemaTypedSchema<Settings>Models.SettingsSchemapackages/lib/sdk/src/pluto/collections/index.ts:48