@samoa-house-lib/shl-types 1.0.0

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@samoa-house-lib/shl-types",
+  "version": "1.0.0",
+  "description": "Types and constants shared between the SHL project's repo's",
+  "main": "src/index.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "npm run test"
+  },
+  "author": "Ford Jones",
+  "license": "MIT",
+  "devDependencies": {
+    "@tsconfig/node18": "18.2.4",
+    "@tsconfig/node20": "20.1.4",
+    "@types/node": "20.12.7",
+    "@types/pg": "^8.11.6",
+    "typescript": "~5.4.5",
+    "ts-node": "^10.9.2"
+  },
+  "dependencies": {
+    "pg": "^8.11.5",
+    "zod": "3.23.8"
+  }
+}

package/src/constants.ts

@@ -0,0 +1,102 @@
+export enum SectionVariant {
+    MOANA = 'Moana',
+    MAORI = 'Toi Maori',
+    AOTEAROA = 'Aotearoa Art',
+    INTERNATIONAL = 'International Art',
+    THEORY = 'Theory',
+    HISTORY = 'Art History',
+    LITERATURE = 'Literature',
+    REFERENCE = 'Reference',
+  }
+  
+  export enum ConditionVariant {
+    EXQUISITE = 'Mint',
+    GOOD = 'Good',
+    OK = 'Okay',
+    BAD = 'Bad',
+    RUIN = 'Poor',
+    BINDING = 'Binding Undone',
+    TORN = 'Pages Torn',
+    SUN = 'Sun Damage',
+    WET = 'Moisture Damage',
+    COVER_MISS = 'Cover Missing',
+    PAGE_MISS = 'Pages Missing',
+    NOTES = 'Hand-written Notation',
+  }
+  
+  export enum TextVariant {
+    DEFAULT = 'Book',
+    HARDCOVER = 'Hardcover',
+    PAPERBACK = 'Paperback',
+    CHAPBOOK = 'Chapbook',
+    JOURNAL = 'Journal',
+    MAGAZINE = 'Magazine',
+    ZINE = 'Zine',
+    RECORD = 'Record',
+    CATALOGUE = 'Catalogue',
+    REPORT = 'Report',
+    LARGE = 'Large',
+    SMALL = 'Small',
+    ARCHIVE = 'Archive Box',
+    EPHEMERA = 'Ephemera',
+    AUC_CATA = 'Auction Catalogue',
+    EX_CATA = 'Exhibition Catalogue',
+    EX_TEXT = 'Exhibition Text',
+    EX_PROG = 'Exhibition Programme',
+    GAL_PUB = 'Gallery Publication',
+    ARTIST_BOOK = 'Artist Book',
+    ARTIST_PUB = 'Artist Publication',
+    ARTWORK = 'Artwork',
+    NEWSPAPER = 'Newspaper',
+    NEWSLETTER = 'Newsletter',
+    POSTCARD = 'Postcard',
+    CARD = 'Card',
+    POSTER = 'Poster',
+    OHP = 'Overhead Projector Laminate',
+    TAPE = 'Cassette Tape',
+    DVD = 'DVD',
+    VHS = 'VHS',
+    CD = 'CD',
+    ESSAY = 'Essay',
+    RINGBOUND = 'Ringbound',
+    ENVELOPE = 'Envelope',
+    CALENDAR = 'Calendar',
+    MEMOIR = 'Memoir',
+    SPECIAL = 'Special',
+    NOTEBOOK = 'Notebook',
+    MULTI_VOL = 'Multiple Volumes',
+    PAPER = 'Paper',
+    CRAFT = 'Hand Crafted',
+    THESIS = 'Thesis',
+    MONOGRAPH = 'Monograph',
+    BOOKLET = 'Booklet',
+    SLIP = 'Slipcase',
+    CONF_TEXT = 'Conference Text',
+  }
+  
+  export enum ColumnNames {
+    ID = 'id',
+    RUNNING_NUMBER = 'running_number',
+    DONOR_FIRST_NAME = 'donor_first_name',
+    DONOR_LAST_NAME = 'donor_last_name',
+    SHL_ID = 'shl_id',
+    TERMS = 'terms',
+    TITLE = 'title',
+    AUTHOR_FIRST_NAME = 'author_first_name',
+    AUTHOR_LAST_NAME = 'author_last_name',
+    ISBN_ISSN = 'isbn_issn',
+    RECIEPEIENT = 'recipient',
+    DATE_PROCESSED = 'date_processed',
+    SECTION = 'section',
+    BOOK_TYPE = 'book_type',
+    PUBLISHER = 'publisher',
+    DATE_PUBLISHED = 'date_published',
+    NOTES = 'notes',
+    SPECIAL_CONDITION = 'special_conditions',
+    CONDITION = 'condition',
+  }
+  
+  export enum Responses {
+    SUCCESS = 'Request Success',
+    FAILURE = 'Request Failure'
+  }

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from  './constants'
+export * from './types'

package/src/types.ts

@@ -0,0 +1,89 @@
+import * as z from 'zod'
+import { SectionVariant, TextVariant, ConditionVariant, ColumnNames } from "./constants"
+import { QueryResult } from 'pg'
+
+const unionFromEnum = (enumerable: object): z.ZodUnion<NonEmptyStringArray> => {
+    return z.union(
+        Object.values(enumerable)
+        .map(
+            (val) => z.literal(val as z.Primitive)
+        ) as NonEmptyStringArray
+    )
+}
+
+
+export interface ServiceResponse {
+  readBatch: () => Promise<QueryResult | void>,
+  readBy: (column_name: ColumnName, column_value: string) => Promise<QueryResult | void>,
+  readLatest: () => Promise<QueryResult | void>,
+  writeItem: (data: CreateBookRequest) => Promise<QueryResult | void>,
+  updateItem: (colName: ColumnName, colValue: string, id: ShlID) => Promise<QueryResult | void>,
+  createTable : () => Promise<QueryResult | void>
+}
+
+export type Book = z.infer<typeof dbEntrySchema>
+export type BookBatch = z.infer<typeof bookBatchSchema>
+
+export type BookWithID = z.infer<typeof newDbEntrySchema>
+
+export type CreateBookRequest = z.infer<typeof addBookRequest>
+
+export type ColumnName = z.infer<typeof dbColumnNameSchema>
+
+export type ShlID = z.infer<typeof shlIdSchema>
+export type Name = z.infer<typeof nameSchema>
+export type Terms = z.infer<typeof termsSchema>
+export type Section = z.infer<typeof sectionSchema>
+export type TextType = z.infer<typeof textTypeSchema>
+export type Condition = z.infer<typeof conditionSchema>
+
+type NonEmptyStringArray = [z.ZodLiteral<string>, z.ZodLiteral<string>, ...z.ZodLiteral<string>[]]
+
+export const shlIdSchema = z.string().min(3).brand("SamoaHouseLibraryID")
+
+export const nameSchema = z.string().transform((val) => {
+    const initial = val.charAt(0).toUpperCase()
+    return initial.concat(val.slice(1, val.length))
+})
+
+export const termsSchema = z.union([z.literal("D"), z.literal("R")]).optional()
+
+export const dbColumnNameSchema = unionFromEnum(ColumnNames)
+export const sectionSchema = unionFromEnum(SectionVariant)
+export const textTypeSchema = unionFromEnum(TextVariant)
+export const conditionSchema = unionFromEnum(ConditionVariant)
+
+export const addBookRequest = z.object({
+    donor_first_name: nameSchema.optional(),
+    donor_last_name: nameSchema.optional().nullable(),
+    terms: termsSchema.optional(),
+    title: z.string().max(150),
+    author_first_name: nameSchema.optional(),
+    author_last_name: nameSchema.optional().nullable(),
+    isbn_issn: z.string().max(13).optional().nullable(),
+    recipient: z.string().max(2),
+    date_processed: z.string().max(27),
+    section: sectionSchema.optional().nullable(),
+    book_type: textTypeSchema.optional(),
+    publisher: z.string().optional().nullable(),
+    date_published: z.string().max(27).optional().nullable(),
+    notes: z.string().max(100).optional().nullable(),
+    special_conditions: z.string().optional().nullable(),
+    condition: conditionSchema.optional()
+})
+
+export const newDbEntrySchema = addBookRequest.extend({
+  shl_id: shlIdSchema 
+})
+
+  export const dbEntrySchema = newDbEntrySchema.extend({
+      id: z.number(),
+      running_number: z.number()
+  })
+
+  export const bookBatchSchema = z.array(dbEntrySchema)
+
+export const responseSchema = z.object({
+  message: z.string(),
+  data: bookBatchSchema.nullable()
+})  

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "target": "es2016",
+    "module": "commonjs",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true
+  }
+}