@clevyr/global-watcher v1.0.3

Global Watcher - NPM Package

Package to share common code.

Dictionaries

Collections : Lookup names of Firestore collections.

Errors : Lookup for Messages and Codes.

Roles : Lookup for shared roles used in the system.

Schemas : Lookup for shared schema names.

Storage Buckets : Lookup for storage buckets paths.

Enums : Dork Scan Status; Invitation Status; Report Type

Functions

Object Helper Functions

• copy : Immutable Copy
• replace : Replace/overwrite properties on an object
  • returns Immutable Copy
• merge : Merge the props of the original and the new object
  • returns : immutable copy
• hasTag: lookup a tag in the objects tag array
• hasTags : search for many tags in the objects tag array
• removeTags : remove a tag from the objects tag array
  • returns : immutable copy
• getDictionaryEntry : returns the contents of the dictionary key provided from the objects dictionary object.
• hasDictionaryEntry : checks if the provided key exits in the objects dictionary.

Schema Validation Helper Functions

• validate : validates a json object against a schema

  Ajv

Interfaces

• Address
• DorkScanResponse
• GenericResponseObject
• InvitationPublic
• InvitationSecure
• Registration
• ScanSecure
• TenantPublic
• TenantSecure
• TenantUser
• UserPublic
• UserSecure
• UserTenantPivotAdmin

Schemas

• DorkScanResponseSchema
• InvitationPublicSchema
• InvitationSecureSchema
• RegistrationSchema
• ScanSecureSchema
• TenantPublicSchema
• TenantSecureSchema
• TenantUserSchema
• UserPublicSchema
• UserSecureSchema