stated-protocol-parser 1.0.3 → 1.0.5

package/src/types.ts

@@ -0,0 +1,186 @@
+export type StatementTypeValue =
+    | 'statement'
+    | 'quotation'
+    | 'organisation_verification'
+    | 'person_verification'
+    | 'poll'
+    | 'vote'
+    | 'response'
+    | 'dispute_statement_content'
+    | 'dispute_statement_authenticity'
+    | 'boycott'
+    | 'observation'
+    | 'rating'
+    | 'sign_pdf'
+    | 'bounty'
+
+export type Statement = {
+    domain: string
+    author: string
+    time: Date
+    tags?: string[]
+    content: string
+    representative?: string
+    supersededStatement?: string
+    formatVersion?: string
+}
+
+export type Quotation = {
+    originalAuthor: string
+    authorVerification: string
+    originalTime?: string
+    source?: string
+    quotation?: string
+    paraphrasedStatement?: string
+    picture?: string
+    confidence?: string
+}
+
+export type Poll = {
+    country: string | undefined
+    city: string | undefined
+    legalEntity: string | undefined
+    domainScope: string[] | undefined
+    judges?: string
+    deadline: Date | undefined
+    poll: string
+    scopeDescription?: string
+    scopeQueryLink?: string
+    options: string[]
+    allowArbitraryVote?: boolean
+    requiredProperty?: string
+    requiredPropertyValue?: string
+    requiredPropertyObserver?: string
+    requiredMinConfidence?: number
+}
+
+export type OrganisationVerification = {
+    name: string
+    englishName?: string
+    country: string
+    city: string
+    province: string
+    legalForm: string
+    department?: string
+    domain: string
+    foreignDomain: string
+    serialNumber: string
+    confidence?: number
+    reliabilityPolicy?: string
+    employeeCount?: string
+    pictureHash?: string
+    latitude?: number
+    longitude?: number
+    population?: string
+}
+
+export type withOwnDomain = {
+    ownDomain: string
+    foreignDomain?: string
+}
+
+export type withForeignDomain = {
+    foreignDomain: string
+    ownDomain?: string
+}
+
+export type PersonVerification = {
+    name: string
+    countryOfBirth: string
+    cityOfBirth: string
+    dateOfBirth: Date
+    jobTitle?: string
+    employer?: string
+    verificationMethod?: string
+    confidence?: number
+    picture?: string
+    reliabilityPolicy?: string
+} & (withOwnDomain | withForeignDomain)
+
+export type Vote = {
+    pollHash: string
+    poll: string
+    vote: string
+}
+
+export type DisputeAuthenticity = {
+    hash: string
+    confidence?: number
+    reliabilityPolicy?: string
+}
+
+export type DisputeContent = {
+    hash: string
+    confidence?: number
+    reliabilityPolicy?: string
+}
+
+export type ResponseContent = {
+    hash: string
+    response: string
+}
+
+export type PDFSigning = {
+    hash: string
+}
+
+export type RatingSubjectTypeValue =
+    | 'Organisation'
+    | 'Policy proposal'
+    | 'Treaty draft'
+    | 'Research publication'
+    | 'Regulation'
+    | 'Product'
+
+export type Rating = {
+    subjectType?: RatingSubjectTypeValue
+    subjectName: string
+    subjectReference?: string
+    documentFileHash?: string
+    rating: number
+    quality?: string
+    comment?: string
+}
+
+export type Bounty = {
+    motivation?: string
+    bounty: string
+    reward: string
+    judge: string
+    judgePay?: string
+}
+
+export type Observation = {
+    description?: string
+    approach?: string
+    confidence?: number
+    reliabilityPolicy?: string
+    subject: string
+    subjectReference?: string
+    observationReference?: string
+    property: string
+    value?: string
+}
+
+export type PollV3 = {
+    country: string | undefined
+    city: string | undefined
+    legalEntity: string | undefined
+    domainScope: string[] | undefined
+    judges?: string
+    deadline: Date
+    poll: string
+    scopeDescription?: string
+    scopeQueryLink?: string
+    scopeProperty?: string
+    propertyScopeObserver?: string
+    pollType?: string
+    options: string[]
+}
+
+export type Boycott = {
+    description?: string
+    reliabilityPolicy?: string
+    subject: string
+    subjectReference?: string
+}

package/src/utils.ts

@@ -0,0 +1,18 @@
+import { peopleCountBuckets } from './constants'
+
+export const minPeopleCountToRange = (n: number): string | undefined => {
+    if (n >= 10000000) return peopleCountBuckets["10000000"]
+    if (n >= 1000000) return peopleCountBuckets["1000000"]
+    if (n >= 100000) return peopleCountBuckets["100000"]
+    if (n >= 10000) return peopleCountBuckets["10000"]
+    if (n >= 1000) return peopleCountBuckets["1000"]
+    if (n >= 100) return peopleCountBuckets["100"]
+    if (n >= 10) return peopleCountBuckets["10"]
+    if (n >= 0) return peopleCountBuckets["0"]
+}
+
+export const monthIndex = (month: string): number => 
+    ["jan", "feb", "mar", "apr", "may", "jun", "jul", "aug", "sep", "oct", "nov", "dec"]
+        .indexOf(month.toLowerCase().substr(0, 3))
+
+export const birthDateFormat: RegExp = /(?<d>\d{1,2})\s(?<month>Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s(?<y>\d{4})/

package/src/v3.ts

@@ -0,0 +1,62 @@
+import { UTCFormat } from './constants'
+import { Poll } from './types'
+
+export const parsePollV3 = (s: string, version?: string): Poll & { pollType: string } => {
+    const pollRegex = new RegExp(''
+        + /^\n\tType: Poll\n/.source
+        + /(?:\tPoll type: (?<pollType>[^\n]+?)\n)?/.source
+        + /(?:\tWho can vote: (?<scopeDescription>[^\n]+?)\n)?/.source
+        + /(?:\tLink to query defining who can vote: (?<scopeQueryLink>[^\n]+?)\n)?/.source
+        + /(?:\tCountry scope: (?<country>[^\n]+?)\n)?/.source
+        + /(?:\tCity scope: (?<city>[^\n]+?)\n)?/.source
+        + /(?:\tLegal form scope: (?<legalEntity>[^\n]+?)\n)?/.source
+        + /(?:\tDomain scope: (?<domainScope>[^\n]+?)\n)?/.source
+        + /(?:\tThe decision is finalized when the following nodes agree: (?<judges>[^\n]+?)\n)?/.source
+        + /(?:\tVoting deadline: (?<deadline>[^\n]+?)\n)?/.source
+        + /\tPoll: (?<poll>[^\n]+?)\n/.source
+        + /(?:\tOption 1: (?<option1>[^\n]+?)\n)?/.source
+        + /(?:\tOption 2: (?<option2>[^\n]+?)\n)?/.source
+        + /(?:\tOption 3: (?<option3>[^\n]+?)\n)?/.source
+        + /(?:\tOption 4: (?<option4>[^\n]+?)\n)?/.source
+        + /(?:\tOption 5: (?<option5>[^\n]+?)\n)?/.source
+        + /$/.source)
+    const match = s.match(pollRegex)
+    if (!match) throw new Error("Invalid poll format: " + s)
+    
+    const m = {
+        pollType: match[1],
+        scopeDescription: match[2],
+        scopeQueryLink: match[3],
+        country: match[4],
+        city: match[5],
+        legalEntity: match[6],
+        domainScope: match[7],
+        judges: match[8],
+        deadline: match[9],
+        poll: match[10],
+        option1: match[11],
+        option2: match[12],
+        option3: match[13],
+        option4: match[14],
+        option5: match[15]
+    }
+    
+    const options = [m.option1, m.option2, m.option3, m.option4, m.option5].filter(o => o)
+    const domainScope = m.domainScope?.split(', ')
+    const deadlineStr = m.deadline
+    if (!deadlineStr.match(UTCFormat)) throw new Error("Invalid poll, deadline must be in UTC: " + deadlineStr)
+    
+    return {
+        pollType: m['pollType'],
+        country: m['country'],
+        scopeDescription: m['scopeDescription'],
+        scopeQueryLink: m['scopeQueryLink'],
+        city: m['city'],
+        legalEntity: m['legalEntity'],
+        domainScope: (domainScope && domainScope.length > 0) ? domainScope : undefined,
+        judges: m['judges'],
+        deadline: new Date(deadlineStr),
+        poll: m['poll'],
+        options
+    }
+}