functional-types

functional-types

Index

Modules

• "Arbitraries"
• "DateTime"
• "FileType"
• "Folder"
• "Label"
• "String"
• "TableAnnotation"
• "Vertex"
• "index"

functional-types

functional-types

Interfaces

functional-types › "Folder" › Attributes

Interface: Attributes

Hierarchy

• Attributes

Index

Properties

• folder
• id
• name
• type

Properties

folder

• folder: string

Defined in Folder.ts:29

id

• id: string

Defined in Folder.ts:28

name

• name: string

Defined in Folder.ts:30

type

• type: FT.FileType

Defined in Folder.ts:31

functional-types › "Folder" › Folder

Interface: Folder

Hierarchy

• Folder

Index

Properties

• created_at
• id
• name
• updated_at

Properties

created_at

• created_at: string

Defined in Folder.ts:23

id

• id: string

Defined in Folder.ts:21

name

• name: string

Defined in Folder.ts:22

updated_at

• updated_at: string

Defined in Folder.ts:24

functional-types › "Folder" › Metadata

Interface: Metadata

Hierarchy

• Metadata

Index

Properties

• bucket
• content_type
• created_at
• generation
• id
• kind
• media_link
• name
• self_link
• size
• updated_at

Properties

bucket

• bucket: string

Defined in Folder.ts:40

content_type

• content_type: string

Defined in Folder.ts:42

created_at

• created_at: string

Defined in Folder.ts:44

generation

• generation: string

Defined in Folder.ts:41

id

• id: string

Defined in Folder.ts:36

kind

• kind: string

Defined in Folder.ts:35

media_link

• media_link: string

Defined in Folder.ts:38

name

• name: string

Defined in Folder.ts:39

self_link

• self_link: string

Defined in Folder.ts:37

size

• size: string

Defined in Folder.ts:43

updated_at

• updated_at: string

Defined in Folder.ts:45

functional-types › "Label" › Label

Interface: Label

Hierarchy

• Label

Index

Properties

• color
• id
• name

Properties

color

• color: string

Defined in Label.ts:6

id

• id: string

Defined in Label.ts:4

name

• name: string

Defined in Label.ts:5

functional-types › "TableAnnotation" › TableAnnotation

Interface: TableAnnotation

Hierarchy

• TableAnnotation

Index

Properties

• boundingBoxesByPageId
• created_at
• file
• id
• updated_at

Properties

boundingBoxesByPageId

• boundingBoxesByPageId: BoundingBoxByPageId

Defined in TableAnnotation.ts:11

created_at

• created_at: string

Defined in TableAnnotation.ts:12

file

• file: string

Defined in TableAnnotation.ts:10

id

• id: string

Defined in TableAnnotation.ts:9

updated_at

• updated_at: string

Defined in TableAnnotation.ts:13

functional-types › "Vertex" › BoundingBox

Interface: BoundingBox

Hierarchy

• BoundingBox

  ↳ LabeledBoundingBox

Index

Properties

• boundingPoly
• columns
• rows

Properties

boundingPoly

• boundingPoly: Poly

Defined in Vertex.ts:33

columns

• columns: Line[]

Defined in Vertex.ts:35

rows

• rows: Line[]

Defined in Vertex.ts:34

functional-types › "Vertex" › LabeledBoundingBox

Interface: LabeledBoundingBox

Hierarchy

• BoundingBox

  ↳ LabeledBoundingBox

Index

Properties

• boundingPoly
• columns
• id
• label
• rows

Properties

boundingPoly

• boundingPoly: Poly

Inherited from BoundingBox.boundingPoly

Defined in Vertex.ts:33

columns

• columns: Line[]

Inherited from BoundingBox.columns

Defined in Vertex.ts:35

id

• id: string

Defined in Vertex.ts:47

label

• label: string

Defined in Vertex.ts:48

rows

• rows: Line[]

Inherited from BoundingBox.rows

Defined in Vertex.ts:34

functional-types › "Vertex" › Vertex

Interface: Vertex

Hierarchy

• Vertex

Index

Properties

• x
• y

Properties

x

• x: number

Defined in Vertex.ts:24

y

• y: number

Defined in Vertex.ts:25

Modules

functional-types › "Arbitraries"

Module: "Arbitraries"

Index

Functions

• file
• filesByType
• folder
• invalidFolderObject
• metadata
• nonFolderObject

Functions

Const file

▸ file(): Arbitrary‹File›

Defined in Arbitraries.ts:55

Returns: Arbitrary‹File›

Const filesByType

▸ filesByType(): Arbitrary‹FilesByType›

Defined in Arbitraries.ts:65

Returns: Arbitrary‹FilesByType›

Const folder

▸ folder(): Arbitrary‹Folder›

Defined in Arbitraries.ts:37

Returns: Arbitrary‹Folder›

Const invalidFolderObject

▸ invalidFolderObject(): Arbitrary‹Record‹string, any››

Defined in Arbitraries.ts:5

Returns: Arbitrary‹Record‹string, any››

Const metadata

▸ metadata(): Arbitrary‹Metadata›

Defined in Arbitraries.ts:40

Returns: Arbitrary‹Metadata›

Const nonFolderObject

▸ nonFolderObject(): Arbitrary‹unknown›

Defined in Arbitraries.ts:20

Returns: Arbitrary‹unknown›

functional-types › "DateTime"

Module: "DateTime"

Index

Variables

• getCurrentUnixTimestamp

Functions

• getCurrentDate
• getUnixTimestamp

Variables

Const getCurrentUnixTimestamp

• getCurrentUnixTimestamp: function = Date.now

Defined in DateTime.ts:14

getCurrentUnixTimestamp :: () -> Int

Type declaration:

▸ (): number

Functions

Const getCurrentDate

▸ getCurrentDate(): Date

Defined in DateTime.ts:16

Returns: Date

Const getUnixTimestamp

▸ getUnixTimestamp(date: Date): number

Defined in DateTime.ts:6

getUnixTimestamp :: Date -> Int

Parameters:

Returns: number

functional-types › "FileType"

Module: "FileType"

Index

Type aliases

• ContentType
• DocumentContentType
• DocumentType
• FileType
• ImageContentType
• ImageType

Variables

• contentTypes
• documentTypes
• fileContentTypes
• fileTypes
• fromContentType
• fromDocumentContentType
• fromImageContentType
• imageContentTypes
• imageTypes
• toContentType
• toDocumentContentType
• toImageContentType

Functions

• isContentType
• isDocumentContentType
• isDocumentType
• isFileType
• isImageContentType
• isImageType

Type aliases

ContentType

Ƭ ContentType: DocumentContentType | ImageContentType

Defined in FileType.ts:26

DocumentContentType

Ƭ DocumentContentType: "application/pdf" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" | "application/json"

Defined in FileType.ts:19

DocumentType

Ƭ DocumentType: "pdf" | "excel" | "json"

Defined in FileType.ts:13

FileType

Ƭ FileType: DocumentType | ImageType

Defined in FileType.ts:17

ImageContentType

Ƭ ImageContentType: "image/png" | "image/jpeg"

Defined in FileType.ts:24

ImageType

Ƭ ImageType: "png" | "jpeg"

Defined in FileType.ts:15

Variables

Const contentTypes

• contentTypes: ContentType[] = values(FileTypeToContentType)

Defined in FileType.ts:151

contentTypes: [ContentType]

Const documentTypes

• documentTypes: DocumentType[] = keys(DocumentTypeToContentType)

Defined in FileType.ts:112

documentTypes: [DocumentType]

Const fileContentTypes

• fileContentTypes: DocumentContentType[] = values( DocumentTypeToContentType )

Defined in FileType.ts:133

contentTypes: [DocumentContentType]

Const fileTypes

• fileTypes: FileType[] = keys(FileTypeToContentType)

Defined in FileType.ts:126

fileTypes: [FileType]

Const fromContentType

• fromContentType: function = prop( __, ContentTypeToFileType )

Defined in FileType.ts:252

fromContentType :: ContentType -> FileType

Type declaration:

▸ (contentType: ContentType): FileType

Parameters:

Const fromDocumentContentType

• fromDocumentContentType: function = prop(__, ContentTypeToDocumentType)

Defined in FileType.ts:234

fromDocumentContentType :: DocumentContentType -> DocumentType

Type declaration:

▸ (contentType: DocumentContentType): DocumentType

Parameters:

Const fromImageContentType

• fromImageContentType: function = prop(__, ContentTypeToImageType)

Defined in FileType.ts:243

fromImageContentType :: DocumentContentType -> DocumentType

Type declaration:

▸ (contentType: ImageContentType): ImageType

Parameters:

Const imageContentTypes

• imageContentTypes: ImageContentType[] = values( ImageTypeToContentType )

Defined in FileType.ts:142

imageContentTypes: [DocumentContentType]

Const imageTypes

• imageTypes: ImageType[] = keys(ImageTypeToContentType)

Defined in FileType.ts:119

imageTypes: [DocumentType]

Const toContentType

• toContentType: function = prop( __, FileTypeToContentType )

Defined in FileType.ts:224

toContentType :: FileType -> ContentType

Type declaration:

▸ (fileType: FileType): ContentType

Parameters:

Const toDocumentContentType

• toDocumentContentType: function = prop(__, DocumentTypeToContentType)

Defined in FileType.ts:206

toDocumentContentType :: DocumentType -> DocumentContentType

Type declaration:

▸ (fileType: DocumentType): DocumentContentType

Parameters:

Const toImageContentType

• toImageContentType: function = prop(__, ImageTypeToContentType)

Defined in FileType.ts:215

toImageContentType :: DocumentType -> ImageContentType

Type declaration:

▸ (imageType: ImageType): ImageContentType

Parameters:

Functions

Const isContentType

▸ isContentType(a: unknown): a is ContentType

Defined in FileType.ts:198

isContentType :: a -> bool

Parameters:

Returns: a is ContentType

Const isDocumentContentType

▸ isDocumentContentType(a: unknown): a is DocumentContentType

Defined in FileType.ts:182

isDocumentContentType :: a -> bool

Parameters:

Returns: a is DocumentContentType

Const isDocumentType

▸ isDocumentType(a: unknown): a is DocumentType

Defined in FileType.ts:158

isDocumentType :: a -> bool

Parameters:

Returns: a is DocumentType

Const isFileType

▸ isFileType(a: unknown): a is ImageType

Defined in FileType.ts:174

isFileType :: a -> bool

Parameters:

Returns: a is ImageType

Const isImageContentType

▸ isImageContentType(a: unknown): a is ImageContentType

Defined in FileType.ts:190

isDocumentContentType :: a -> bool

Parameters:

Returns: a is ImageContentType

Const isImageType

▸ isImageType(a: unknown): a is ImageType

Defined in FileType.ts:166

isImageType :: a -> bool

Parameters:

Returns: a is ImageType

functional-types › "Folder"

Module: "Folder"

Index

Interfaces

• Attributes
• Folder
• Metadata

Type aliases

• File
• FilesByType

Variables

• getAttributesFromName

Functions

• fromMetadata
• isFile
• isFileArray
• isFilesByType
• isFolder
• isMetadata
• make

Type aliases

File

Ƭ File: Attributes & object

Defined in Folder.ts:48

FilesByType

Ƭ FilesByType: Record‹FT.DocumentType, File[]›

Defined in Folder.ts:50

Variables

Const getAttributesFromName

• getAttributesFromName: function = pipe( split('/'), E.fromPredicate( (segments: string[]) => segments.length >= 2, () => new Error('Invalid file name format.') ), E.map(([folder, ...names]: string[]) => { const name = names.join('/'); return { id: join('/')([folder, name]), folder, name, }; }) )

Defined in Folder.ts:157

getAttributesFromName :: String -> Either Attributes Error

Type declaration:

▸ (name: string): E.Either‹Error, Omit‹Attributes, "type"››

Parameters:

Functions

Const fromMetadata

▸ fromMetadata(metadata: Metadata): Left‹Error› | Right‹object›

Defined in Folder.ts:180

fromMetadata :: Metadata -> Either

Parameters:

Returns: Left‹Error› | Right‹object›

Const isFile

▸ isFile(a: unknown): a is File

Defined in Folder.ts:130

isFile :: a -> bool

Parameters:

Returns: a is File

Const isFileArray

▸ isFileArray(a: unknown): a is File[]

Defined in Folder.ts:138

isFileArray :: a -> bool

Parameters:

Returns: a is File[]

Const isFilesByType

▸ isFilesByType(a: unknown): a is FilesByType

Defined in Folder.ts:146

isFilesByType :: a -> bool

Parameters:

Returns: a is FilesByType

Const isFolder

▸ isFolder(a: unknown): a is Folder

Defined in Folder.ts:57

isFolder -> bool

Parameters:

Returns: a is Folder

Const isMetadata

▸ isMetadata(a: unknown): a is Metadata

Defined in Folder.ts:107

isMetadata :: a -> bool

Parameters:

Returns: a is Metadata

Const make

▸ make(name: string): (Anonymous function)

Defined in Folder.ts:71

make :: String -> Folder

Parameters:

Returns: (Anonymous function)

functional-types › "index"

Module: "index"

Index

References

• F
• FT
• L
• T
• V

References

F

• F:

FT

• FT:

L

• L:

T

• T:

V

• V:

functional-types › "Label"

Module: "Label"

Index

Interfaces

• Label

Type aliases

• ColorMappings

Variables

• toColorMappings

Functions

• isLabel

Type aliases

ColorMappings

Ƭ ColorMappings: Record‹string, string›

Defined in Label.ts:9

Variables

Const toColorMappings

• toColorMappings: function = reduce( (acc: ColorMappings, label: Label) => assoc(label.id, label.color)(acc), {} )

Defined in Label.ts:29

toColorMappings :: [Label] -> ColorMappings

Type declaration:

▸ (labels: Label[]): ColorMappings

Parameters:

Functions

Const isLabel

▸ isLabel(a: unknown): a is Label

Defined in Label.ts:16

isLabel :: a -> bool

Parameters:

Returns: a is Label

functional-types › "String"

Module: "String"

Index

Variables

• getRandomId

Variables

Const getRandomId

• getRandomId: IO‹string› = uuid

Defined in String.ts:9

getRandomId: IO String

functional-types › "TableAnnotation"

Module: "TableAnnotation"

Index

Interfaces

• TableAnnotation

Type aliases

• BoundingBoxByPageId
• TableAnnotationBase

Functions

• isBoundingBoxByPageId
• isTableAnnotation
• isTableAnnotationBase
• make

Type aliases

BoundingBoxByPageId

Ƭ BoundingBoxByPageId: Record‹string, LabeledBoundingBox[]›

Defined in TableAnnotation.ts:6

TableAnnotationBase

Ƭ TableAnnotationBase: Pick‹TableAnnotation, "file" | "boundingBoxesByPageId"›

Defined in TableAnnotation.ts:16

Functions

Const isBoundingBoxByPageId

▸ isBoundingBoxByPageId(a: unknown): a is BoundingBoxByPageId

Defined in TableAnnotation.ts:26

isBoundingBoxByPageId :: a -> bool

Parameters:

Returns: a is BoundingBoxByPageId

Const isTableAnnotation

▸ isTableAnnotation(a: unknown): a is TableAnnotation

Defined in TableAnnotation.ts:48

isTableAnnotation :: a -> bool

Parameters:

Returns: a is TableAnnotation

Const isTableAnnotationBase

▸ isTableAnnotationBase(a: unknown): a is TableAnnotationBase

Defined in TableAnnotation.ts:36

isTableAnnotationBase :: a -> bool

Parameters:

Returns: a is TableAnnotationBase

Const make

▸ make(__namedParameters: object): (Anonymous function)

Defined in TableAnnotation.ts:63

make :: (String, BoundingBoxByPageId) -> IO TableAnnotation

Parameters:

▪ __namedParameters: object

Returns: (Anonymous function)

functional-types › "Vertex"

Module: "Vertex"

Index

Interfaces

• BoundingBox
• LabeledBoundingBox
• Vertex

Type aliases

• Line
• Poly
• WithHeaderColumn
• WithHeaderRow

Variables

• getX
• getXs
• getY
• getYs

Functions

• append
• hasHeaderColumn
• hasHeaderRow
• isBoundingBox
• isLabeledBoundingBox
• isLine
• isPoly
• isVertex
• makeBoundingBox
• makeLabeledBoundingBox
• makeLine
• makePoly
• makeVertex

Type aliases

Line

Ƭ Line: [Vertex, Vertex]

Defined in Vertex.ts:28

Poly

Ƭ Poly: [Vertex, Vertex, Vertex, Vertex]

Defined in Vertex.ts:30

WithHeaderColumn

Ƭ WithHeaderColumn: A & object

Defined in Vertex.ts:42

WithHeaderRow

Ƭ WithHeaderRow: A & object

Defined in Vertex.ts:38

Variables

Const getX

• getX: function = pipe(head, prop<'x', number>('x'))

Defined in Vertex.ts:289

getX :: Line -> Int

Type declaration:

▸ (line: Line): number

Parameters:

Const getXs

• getXs: function = map(getX)

Defined in Vertex.ts:303

getXs :: [Line] -> [Int]

Type declaration:

▸ (lines: Line[]): number[]

Parameters:

Const getY

• getY: function = pipe(head, prop<'y', number>('y'))

Defined in Vertex.ts:282

getY :: Line -> Int

Type declaration:

▸ (line: Line): number

Parameters:

Const getYs

• getYs: function = map(getY)

Defined in Vertex.ts:296

getYs :: [Line] -> [Int]

Type declaration:

▸ (lines: Line[]): number[]

Parameters:

Functions

Const append

▸ append<**A**>(boundingBox: A): (Anonymous function)

Defined in Vertex.ts:341

append :: ([Int], [Int]) -> BoundingBox

Type parameters:

▪ A: BoundingBox

Parameters:

Returns: (Anonymous function)

Const hasHeaderColumn

▸ hasHeaderColumn<**A**>(a: A): a is WithHeaderRow

hasHeaderColumn :: a -> bool

▪ A: BoundingBox

Parameters:

Returns: a is WithHeaderRow

Const hasHeaderRow

▸ hasHeaderRow<**A**>(a: A): a is WithHeaderRow

hasHeaderRow :: a -> bool

▪ A: BoundingBox

Parameters:

Returns: a is WithHeaderRow

Const isBoundingBox

▸ isBoundingBox(a: unknown): a is BoundingBox

Defined in Vertex.ts:101

isBoundingBox :: a -> bool

Parameters:

Returns: a is BoundingBox

Const isLabeledBoundingBox

▸ isLabeledBoundingBox(a: unknown): a is LabeledBoundingBox

Defined in Vertex.ts:310

isLabeledBoundingBox :: a -> bool

Parameters:

Returns: a is LabeledBoundingBox

Const isLine

▸ isLine(a: unknown): a is Line

Defined in Vertex.ts:69

isLine :: a -> bool

Parameters:

Returns: a is Line

Const isPoly

▸ isPoly(a: unknown): a is Poly

Defined in Vertex.ts:81

isPoly :: a -> bool

Parameters:

Returns: a is Poly

Const isVertex

▸ isVertex(a: unknown): a is Vertex

Defined in Vertex.ts:61

isVertex :: a -> bool

Parameters:

Returns: a is Vertex

Const makeBoundingBox

▸ makeBoundingBox(boundingPoly: Poly, ys: number[], xs: number[]): BoundingBox

Defined in Vertex.ts:263

makeBoundingBox :: (Poly, [Int], [Int]) -> BoundingBox

Parameters:

Returns: BoundingBox

Const makeLabeledBoundingBox

▸ makeLabeledBoundingBox(id: string, label: string, boundingPoly: Poly, ys: number[], xs: number[]): LabeledBoundingBox

Defined in Vertex.ts:318

makeLabeledBoundingBox :: (String, String, Poly, [Int], [Int]) -> LabeledBoundingBox

Parameters:

Returns: LabeledBoundingBox

Const makeLine

▸ makeLine(x0: number, y0: number, x1: number, y1: number): Line

Defined in Vertex.ts:137

makeVertex :: (Int, Int, Int, Int) -> Line

Parameters:

Returns: Line

Const makePoly

▸ makePoly(...coords: [number, number, number, number]): Poly

Defined in Vertex.ts:202

makePoly :: (Int, Int, Int, Int) -> Poly

Parameters:

Returns: Poly

Const makeVertex

▸ makeVertex(x: number, y: number): Vertex

Defined in Vertex.ts:130

makeVertex :: (Int, Int) -> Vertex

Parameters:

Returns: Vertex