IF Commons GitHub

models/identity/kit

Written to: 1 requirement: 1 proved, 0 partly, 0 failing, 0 with no test recorded. 0032-identity-principals FR-001

The helpers that the models of identity are written with (commons data 0032-identity-principals): short ways to say a required, an optional or a many-valued attribute, a key, a relationship, and the annotations every concept carries. They are public so that the modules of identity that are written in other folders say things the same way.

Source: commons/data/models/identity/kit.ts

1 of 17 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

citingconstno test imports it
const citing: (spec: string) => (...frs: readonly string[]) => Annotation

The requirements of a specification that a concept serves.

citesconstno test imports it
const cites: (...frs: readonly string[]) => Annotation

Marks an element as written to requirement of the identity specification, 0030-identity.

restrictedconstno test imports it
const restricted: Annotation

The classification of what only named people may read: restricted.

confidentialconstno test imports it
const confidential: Annotation

The classification of a concept or attribute whose disclosure would harm: confidential.

internalconstno test imports it
const internal: Annotation

The classification of what is for the organization only: internal.

keepconstno test imports it
const keep: (days: number) => Annotation

Says how many days a concept is kept before it is removed.

heldconstno test imports it
const held: (category: "Accent" | "AccountIdentifier" | "Acquaintance" | "Age" | "AgeExact" | "AgeRange" | "ApartmentOwn… (3994 characters)
const held: (category: "Accent" | "AccountIdentifier" | "Acquaintance" | "Age" | "AgeExact" | "AgeRange" | "ApartmentOwned" | "Association" | "Attitude" | "Authenticating" | "AuthenticationHistory" | "BankAccount" | "Behavioural" | "Biometric" | "BirthCountry" | "BirthDate" | "BirthPlace" | "BloodType" | "BrowserFingerprint" | "BrowserHistory" | "BrowsingBehaviour" | "BrowsingReferral" | "CallLog" | "CarOwned" | "Character" | "Citizenship" | "City" | "Communication" | "CommunicationsMetadata" | "Connection" | "Contact" | "Country" | "Credit" | "CreditCapacity" | "CreditCardNumber" | "CreditRecord" | "CreditScore" | "CreditStanding" | "CreditWorthiness" | "Criminal" | "CriminalCharge" | "CriminalConviction" | "CriminalOffence" | "CriminalPardon" | "CurrentEmployment" | "CurrentLocation" | "DNACode" | "Demeanour" | "Demographic" | "DeviceApplications" | "DeviceBased" | "DeviceOperatingSystem" | "DeviceSoftware" | "Dialect" | "DigitalFingerprint" | "Disability" | "DisciplinaryAction" | "Dislike" | "Divorce" | "Domicile" | "DrugTestResult" | "Education" | "EducationExperience" | "EducationQualification" | "EducationTraining" | "EmailAddress" | "EmailAddressPersonal" | "EmailAddressWork" | "EmailContent" | "Emotion" | "EmploymentHistory" | "EthnicOrigin" | "Ethnicity" | "External" | "FacialExpression" | "FacialPrint" | "Family" | "FamilyHealthHistory" | "FamilyStructure" | "Favourite" | "FavouriteColour" | "FavouriteFood" | "FavouriteMusic" | "Fetish" | "Financial" | "FinancialAccount" | "FinancialAccountNumber" | "FinancialStatus" | "Fingerprint" | "Friend" | "GPSCoordinate" | "Gender" | "GeneralReputation" | "Genetic" | "Geographic" | "GroupMembership" | "GroupProfile" | "HairColour" | "Health" | "HealthHistory" | "HealthRecord" | "Height" | "Historical" | "HomeLocation" | "HouseNumber" | "HouseOwned" | "Household" | "IPAddress" | "Identifier" | "Identifying" | "Income" | "IncomeBracket" | "IndividualHealthHistory" | "IndividualProfile" | "Insurance" | "Intention" | "Interaction" | "Interest" | "Internal" | "Job" | "KnowledgeBelief" | "Language" | "LifeHistory" | "Like" | "LinkClicked" | "LoanRecord" | "Locality" | "Location" | "MACAddress" | "MaritalStatus" | "Marriage" | "MedicalHealth" | "MentalHealth" | "Mood" | "Name" | "Nationality" | "OfficialID" | "Offspring" | "Opinion" | "Ownership" | "PINCode" | "Parent" | "Passport" | "Password" | "PastEmployment" | "PaymentCard" | "PaymentCardExpiry" | "PaymentCardNumber" | "PerformanceAtWork" | "PersonalDocuments" | "PersonalPossession" | "Personality" | "PhilosophicalBelief" | "PhysicalAddress" | "PhysicalCharacteristic" | "PhysicalHealth" | "PhysicalTrait" | "Picture" | "Piercing" | "PoliticalAffiliation" | "PoliticalOpinion" | "PostalCode" | "Preference" | "Prescription" | "PrivacyPreference" | "Proclivity" | "Professional" | "ProfessionalCertification" | "ProfessionalEvaluation" | "ProfessionalExperience" | "ProfessionalInterview" | "ProfessionalTraining" | "Profile" | "PublicLife" | "PubliclyAvailableSocialMedia" | "Purchase" | "PurchasesAndSpendingHabit" | "Race" | "Reference" | "Region" | "Relationship" | "Reliability" | "Religion" | "ReligiousBelief" | "Residency" | "Retina" | "RoomNumber" | "Salary" | "Sale" | "School" | "SecretText" | "ServiceConsumptionBehaviour" | "Sexual" | "SexualHistory" | "SexualPreference" | "Sibling" | "SkinTone" | "Social" | "SocialBehaviour" | "SocialMedia" | "SocialMediaCommunication" | "SocialNetwork" | "SocialStatus" | "Street" | "TVViewingBehaviour" | "Tattoo" | "Tax" | "TechnicalKnowledge" | "TelephoneNumber" | "Thought" | "Tracking" | "TradeUnionMembership" | "Transaction" | "Transactional" | "TravelHistory" | "UID" | "UserAgent" | "Username" | "VehicalLicenseNumber" | "VehicalLicenseRegistration" | "Vehicle" | "VehicleLicense" | "VehicleUsage" | "VoiceCommunicationRecording" | "VoiceMail" | "Vulnerability" | "Weight" | "WorkEnvironment" | "WorkExperience" | "WorkHistory" | "WorkLocation", ...purposes: readonly string[]) => Annotation

Says that an attribute holds personal data of a category, and for which purposes it is held.

uniqueconst
const unique: (...members: readonly string[]) => Annotation

Says that the members named are together unique across the records of a concept.

Imported by 15 tests of the run (15 passed, 0 failed): the library's results

lookupconstno test imports it
const lookup: (...members: readonly string[]) => Annotation

Says which members of a concept are looked up by, so that each is indexed.

Attrtypeno test imports it
type Attr = ReturnType<typeof attribute>;

An attribute of a concept, as the identity models write it.

reqconstno test imports it
const req: (type: Datatype, definition: string, ...annotations: readonly Annotation[]) => Attribute<Datatype, Multiplicity>

An attribute that every record must have.

optconstno test imports it
const opt: (type: Datatype, definition: string, ...annotations: readonly Annotation[]) => Attribute<Datatype, Multiplicity>

An attribute that a record may leave out.

manyconstno test imports it
const many: (type: Datatype, definition: string, ...annotations: readonly Annotation[]) => Attribute<Datatype, Multiplicity>

An attribute that may be given more than once.

keyconstno test imports it
const key: (what: string) => Attribute<Datatype, Multiplicity>

An attribute that identifies a concept, made by the application.

oneconstno test imports it
const one: (to: AnyConcept | (() => AnyConcept), definition: string) => Relationship<"one", AnyConcept | (() => AnyConcept)>

A relationship to one other concept that a record must have.

maybeconstno test imports it
const maybe: (to: AnyConcept | (() => AnyConcept), definition: string) => Relationship<"optional", AnyConcept | (() => AnyConcept)>

A relationship to another concept that a record may not have.

listconstno test imports it
const list: (name: string, definition: string, codes: Readonly<Record<string, string>>, open?: boolean) => CodeList<string, string>

A code list from its codes and their definitions; the label of a code is its words, capitalised.

Titles, headings, exports, tables, columns and requirements. Esc closes.