Class CredentialSchema

constructor

• new CredentialSchema(jsonSchema, parsingOpts?, addMissingParsingOpts?, overrides?, fullJsonSchema?, useConstantTimeEncoder?): CredentialSchema

• Takes a schema object as per JSON-schema syntax (IJsonSchema), validates it and converts it to an internal representation (ISchema) and stores both as the one with JSON-schema syntax is added to the credential representation.

  Parameters

  • jsonSchema: IEmbeddedJsonSchema | IJsonSchema

    Could be a JSON schema with properties or contain an $id key which is used to fetch them
  • parsingOpts: Partial<ISchemaParsingOpts> = DefaultSchemaParsingOpts

    Options to parse the schema like whether to use defaults and what defaults to use
  • addMissingParsingOpts: boolean = true

    Whether to update parsingOpts for any missing options with default options. Pass false when deserializing to get the exact object that was serialized which is necessary when verifying signatures
  • Optionaloverrides: Partial<ISchemaOverrides>

    Override any properties of the schema
  • OptionalfullJsonSchema: IEmbeddedJsonSchema

    When jsonSchema does not contain the properties, this object is expected to contain them.
  • useConstantTimeEncoder: boolean = true

    Set to false when creating legacy schemas

  Returns CredentialSchema

encoder

OptionalfullJsonSchema

ReadonlyjsonSchema

ReadonlyparsingOptions

Readonlyschema

StaticIGNORE_GENERIC_VALIDATION

StaticIMPLICIT_FIELDS

StaticJSON_SCHEMA_CUSTOM_DEFS

StaticJSON_SCHEMA_OVERRIDE_DEFS

StaticOLD_IMPLICIT_FIELDS

StaticPOSSIBLE_TYPES

StaticRESERVED_NAMES

StaticVERSION

flatten

• flatten(): FlattenedSchema

• Returns FlattenedSchema

getEmbeddedJsonSchema

• getEmbeddedJsonSchema(): IEmbeddedJsonSchema

• Gets the embedded JSON schema either from the one that was provided or the one that was fetched.

  Returns IEmbeddedJsonSchema

getJsonLdContext

• getJsonLdContext(): object

• Returns object

getJsonSchemaProperties

• getJsonSchemaProperties(): object

• Returns object

hasEmbeddedJsonSchema

• hasEmbeddedJsonSchema(): boolean

• Returns true if the JSON schema provided during the object creation was an embedded one.

  Returns boolean

hasStatus

• hasStatus(): boolean

• Returns boolean

initEncoder

• initEncoder(useConstantTimeEncoder?): void

• Initialize the encoder as per the internal representation of schema, i.e. ISchema

  Parameters

  • useConstantTimeEncoder: boolean = true

  Returns void

toJSON

• toJSON(): object

• Returns object

toJSONOlder

• toJSONOlder(): object

• Older version of toJSON, i.e. versions < 0.4.0

  Returns object

toJsonString

• toJsonString(): string

• Convert to a JSON string and the string is deterministic. This is important for signing

  Returns string

typeOfName

• typeOfName(name, flattenedSchema?): ValueTypes

• Parameters

  • name: string
  • flattenedSchema: FlattenedSchema = ...

  Returns ValueTypes

StaticconvertFromDataUri

• convertFromDataUri(embedded): IEmbeddedJsonSchema | IJsonSchema

• Parameters

  • embedded: string

  Returns IEmbeddedJsonSchema | IJsonSchema

StaticconvertToDataUri

• convertToDataUri(jsonSchema, version?): string

• Convert schema JSON to a data URI

  Parameters

  • jsonSchema: IEmbeddedJsonSchema | IJsonSchema
  • Optionalversion: string

    The schema version. This is needed as a different conversion to JSON function was used in older version and backward compatibility is needed.

  Returns string

StaticconvertToInternalSchemaObj

• convertToInternalSchemaObj(inputNode, parsingOpts, nodeKeyName?, rootObject?): object

• Convert a schema object as per JSON-schema syntax (IJsonSchema) to the internal representation (ISchema). Currently, does not check if the needed JSON-schema definitions are actually present but assumes that they will be already passed.

  Parameters

  • inputNode: any
  • parsingOpts: ISchemaParsingOpts
  • nodeKeyName: string = ''

    Name of the node, used for throwing more informative error message
  • OptionalrootObject: object

  Returns object

Staticessential

• essential(withDefinitions?): IEmbeddedJsonSchema

• Essential properties of a non-embedded schema.

  Parameters

  • withDefinitions: boolean = true

    add custom definitions as well

  Returns IEmbeddedJsonSchema

StaticflattenSchemaObj

• flattenSchemaObj(schema, versionGte040?): FlattenedSchema

• Parameters

  • schema: object
  • versionGte040: boolean = true

  Returns FlattenedSchema

StaticfromJSON

• fromJSON(j): CredentialSchema

• Parameters

  • j: object

  Returns CredentialSchema

StaticfromJSONWithPotentiallyExternalSchema

• fromJSONWithPotentiallyExternalSchema(j, schemaGetter): Promise<CredentialSchema>

• Similar to this.fromJSON but can load an externally referenced schema if the given schema is not an embedded one.

  Parameters

  • j: object
  • schemaGetter: ((url: string) => Promise<IEmbeddedJsonSchema>)
    • • (url): Promise<IEmbeddedJsonSchema>

      • Parameters

        • url: string

        Returns Promise<IEmbeddedJsonSchema>

  Returns Promise<CredentialSchema>

StaticgenerateAppropriateSchema

• generateAppropriateSchema(cred, schema): CredentialSchema

• Generate a schema based on the credential and with the help of a schema that defines some fields. For fields with a conflicting types between credential and schema, error will be thrown. For extra keys or items in schema, they will be removed in the returned schema. The missing keys or items in schema will be added in the returned schema.

  Parameters

  • cred: object
  • schema: CredentialSchema

  Returns CredentialSchema

StaticgetDecimalPlaces

• getDecimalPlaces(d): number

• Parameters

  • d: number

  Returns number

StaticgetDummyContextValue

• getDummyContextValue(term): string

• Parameters

  • term: string

  Returns string

StaticisEmbeddedJsonSchema

• isEmbeddedJsonSchema(obj): boolean

• Returns true if the given object is an embedded schema, i.e. it has the properties key set.

  Parameters

  • obj: IEmbeddedJsonSchema | IJsonSchema

  Returns boolean

StaticnewSchemaFromExternal

• newSchemaFromExternal(jsonSchema, schemaGetter, parsingOpts?, addMissingParsingOpts?, overrides?): Promise<CredentialSchema>

• Same as the constructor of this class but gets the JSON schema from a callback

  Parameters

  • jsonSchema: IJsonSchema

    The JSON schema that contains the URL to fetch the full JSON schema, i.e. properties
  • schemaGetter: ((url: string) => Promise<IEmbeddedJsonSchema>)

    The callback that takes the $id field of jsonSchema and returns the full JSON schema.

    • • (url): Promise<IEmbeddedJsonSchema>

      • Parameters

        • url: string

        Returns Promise<IEmbeddedJsonSchema>

  • parsingOpts: Partial<ISchemaParsingOpts> = DefaultSchemaParsingOpts
  • addMissingParsingOpts: boolean = true
  • Optionaloverrides: Partial<ISchemaOverrides>

  Returns Promise<CredentialSchema>

StaticparseBooleanType

• parseBooleanType(): object

• Returns object

StaticparseDateType

• parseDateType(node, parsingOpts): object

• Parameters

  • node: {
        minimum?: number;
    }

    • Optionalminimum?: number

  • parsingOpts: ISchemaParsingOpts

  Returns object

StaticparseIntegerType

• parseIntegerType(node, parsingOpts, nodeName): object

• Parameters

  • node: {
        minimum?: number;
    }

    • Optionalminimum?: number

  • parsingOpts: ISchemaParsingOpts
  • nodeName: string

  Returns object

StaticparseNumberType

• parseNumberType(node, parsingOpts, nodeName): object

• Parameters

  • node: {
        minimum?: number;
        multipleOf: number;
    }

    • Optionalminimum?: number

    • multipleOf: number

  • parsingOpts: ISchemaParsingOpts
  • nodeName: string

  Returns object

StaticstatusAsJsonSchema

• statusAsJsonSchema(): object

• Returns object

StatictypeOfName

• typeOfName(name, flattenedSchema): ValueTypes

• Parameters

  • name: string
  • flattenedSchema: FlattenedSchema

  Returns ValueTypes

StatictypeOfValue

• typeOfValue(value): ValueTypes

• Parameters

  • value: object

  Returns ValueTypes

Staticvalidate

• validate(schema): void

• Validates the internal representation of schema

  Parameters

  • schema: ISchema

  Returns void

StaticvalidateGeneric

• validateGeneric(schema, ignoreKeys?): void

• Parameters

  • schema: object
  • ignoreKeys: Set<string> = ...

  Returns void