Merge pull request #1155 from XYOracleNetwork/feature/image-thumbnail…

…-diviner-types

Image Thumbnail Diviner Types

packages/modules/packages/module/packages/model/src/Payload/ModuleState.ts

@@ -0,0 +1,15 @@
+import { isPayloadOfSchemaType, Payload } from '@xyo-network/payload-model'
+
+export interface StateDictionary {
+  [key: string]: string | number | undefined
+}
+export interface State<T extends StateDictionary = StateDictionary> {
+  state: T
+}
+
+export const ModuleStateSchema = 'network.xyo.module.state' as const
+export type ModuleStateSchema = typeof ModuleStateSchema
+
+export type ModuleState<T extends StateDictionary = StateDictionary> = Payload<State<T>, ModuleStateSchema>
+
+export const isModuleState = isPayloadOfSchemaType<ModuleState>(ModuleStateSchema)

packages/modules/packages/module/packages/model/src/Payload/index.ts

@@ -0,0 +1 @@
+export * from './ModuleState'

packages/modules/packages/module/packages/model/src/index.ts

@@ -9,5 +9,6 @@ export * from './ModuleDescription'
 export * from './ModuleParams'
 export * from './ModuleQueryHandlerResult'
 export * from './ModuleQueryResult'
+export * from './Payload'
 export * from './Queries'
 export * from './withModule'

packages/plugins/packages/payload/packages/image-thumbnail/src/Payload.ts → packages/plugins/packages/payload/packages/image-thumbnail/src/Payload/ImageThumbnail.ts

@@ -1,6 +1,6 @@
 import { isPayloadOfSchemaType, Payload } from '@xyo-network/payload-model'
 
-import { ImageThumbnailSchema } from './Schema'
+import { ImageThumbnailSchema } from '../Schema'
 
 export type ImageThumbnail = Payload<
   {

packages/plugins/packages/payload/packages/image-thumbnail/src/Payload/ImageThumbnailResult.ts

@@ -0,0 +1,18 @@
+import { isPayloadOfSchemaType, Payload } from '@xyo-network/payload-model'
+
+import { ImageThumbnailSchema } from '../Schema'
+
+export const ImageThumbnailResultIndexSchema = `${ImageThumbnailSchema}.index` as const
+export type ImageThumbnailResultIndexSchema = typeof ImageThumbnailResultIndexSchema
+
+export interface ImageThumbnailResultInfo {
+  sources: string[]
+  // TODO: Something richer than HTTP status code that allows for info about failure modes
+  status: number
+  timestamp: number
+  url: string
+}
+
+export type ImageThumbnailResult = Payload<ImageThumbnailResultInfo, ImageThumbnailResultIndexSchema>
+
+export const isImageThumbnailResult = isPayloadOfSchemaType<ImageThumbnailResult>(ImageThumbnailResultIndexSchema)

packages/plugins/packages/payload/packages/image-thumbnail/src/Payload/index.ts

@@ -0,0 +1,2 @@
+export * from './ImageThumbnail'
+export * from './ImageThumbnailResult'

packages/plugins/packages/payload/packages/image-thumbnail/src/Plugin.ts

@@ -1,6 +1,6 @@
 import { createPayloadPlugin } from '@xyo-network/payload-plugin'
 
-import { ImageThumbnail } from './Payload'
+import { ImageThumbnail } from './Payload/ImageThumbnail'
 import { ImageThumbnailSchema } from './Schema'
 
 export const ImageThumbnailPayloadPlugin = () =>

packages/plugins/packages/payloadset/packages/image-thumbnail/src/Diviner/Diviner.ts

@@ -9,53 +9,30 @@ import { BoundWitnessDivinerQueryPayload, BoundWitnessDivinerQuerySchema } from
 import { asDivinerInstance, DivinerConfigSchema } from '@xyo-network/diviner-model'
 import { PayloadDivinerQueryPayload, PayloadDivinerQuerySchema } from '@xyo-network/diviner-payload-model'
 import { DivinerWrapper } from '@xyo-network/diviner-wrapper'
-import { ImageThumbnailSchema, isImageThumbnail } from '@xyo-network/image-thumbnail-payload-plugin'
+import {
+  ImageThumbnailResult,
+  ImageThumbnailResultIndexSchema,
+  ImageThumbnailSchema,
+  isImageThumbnail,
+  isImageThumbnailResult,
+} from '@xyo-network/image-thumbnail-payload-plugin'
+import { isModuleState, ModuleState, ModuleStateSchema, StateDictionary } from '@xyo-network/module-model'
 import { PayloadBuilder } from '@xyo-network/payload-builder'
-import { isPayloadOfSchemaType, Payload } from '@xyo-network/payload-model'
-import { isUrlPayload } from '@xyo-network/url-payload-plugin'
+import { Payload } from '@xyo-network/payload-model'
+import { isUrlPayload, UrlPayload } from '@xyo-network/url-payload-plugin'
 import { isTimestamp, TimestampSchema } from '@xyo-network/witness-timestamp'
 
 import { ImageThumbnailDivinerConfig, ImageThumbnailDivinerConfigSchema } from './Config'
 import { ImageThumbnailDivinerParams } from './Params'
 
-/**
- * TODO: Once the shape settles, make a generic payload so that it
- * can be used for other modules
- */
-interface State<T> {
-  state: T
-}
-
-interface ImageThumbnailDivinerState {
+export type ImageThumbnailDivinerState = StateDictionary & {
   offset: number
 }
 
-const ModuleStateSchema = 'network.xyo.module.state' as const
-type ModuleStateSchema = typeof ModuleStateSchema
-
-type ModuleState = Payload<State<ImageThumbnailDivinerState>, ModuleStateSchema>
-
-const isModuleState = isPayloadOfSchemaType<ModuleState>(ModuleStateSchema)
-
 type ConfigStoreKey = 'indexStore' | 'stateStore' | 'thumbnailStore'
 
 type ConfigStore = Extract<keyof ImageThumbnailDivinerConfig, ConfigStoreKey>
 
-const ImageThumbnailResultIndexSchema = `${ImageThumbnailSchema}.index` as const
-type ImageThumbnailResultIndexSchema = typeof ImageThumbnailResultIndexSchema
-
-export interface ImageThumbnailResultInfo {
-  sources: string[]
-  // TODO: Something richer than HTTP status code that allows for info about failure modes
-  status: number
-  timestamp: number
-  url: string
-}
-
-export type ImageThumbnailResult = Payload<ImageThumbnailResultInfo, ImageThumbnailResultIndexSchema>
-
-export const isImageThumbnailResult = isPayloadOfSchemaType<ImageThumbnailResult>(ImageThumbnailResultIndexSchema)
-
 /**
  * The fields that will need to be indexed on in the underlying store
  */
@@ -156,20 +133,22 @@ export class ImageThumbnailDiviner<TParams extends ImageThumbnailDivinerParams =
     const module = assertEx(await this.resolve(stateStore), `${moduleName}: Failed to resolve stateStore`)
     await withArchivistModule(module, async (archivist) => {
       const mod = ArchivistWrapper.wrap(archivist, this.account)
-      const payload = new PayloadBuilder<ModuleState>({ schema: ModuleStateSchema }).fields({ state }).build()
+      const payload = new PayloadBuilder<ModuleState<ImageThumbnailDivinerState>>({ schema: ModuleStateSchema }).fields({ state }).build()
       await mod.insert([payload])
     })
   }
 
   protected override async divineHandler(payloads: Payload[] = []): Promise<ImageThumbnailResult[]> {
-    const urls = payloads.filter(isUrlPayload).map((urlPayload) => urlPayload.url)
+    const urls = payloads.filter(isUrlPayload)
     const diviner = await this.getPayloadDivinerForStore('indexStore')
     const results = (
       await Promise.all(
-        urls.map(async (url) => {
+        urls.map(async (payload) => {
+          const { url, status: payloadStatus } = payload as UrlPayload & { status: number }
+          const status = payloadStatus ?? 200
           const query = new PayloadBuilder<ImageThumbnailResultQuery>({ schema: PayloadDivinerQuerySchema })
             // TODO: Expose status, limit (and possibly offset) to caller.  Currently only exposing URL
-            .fields({ limit: 1, offset: 0, order: 'desc', url })
+            .fields({ limit: 1, offset: 0, order: 'desc', status, url })
             .build()
           return await diviner.divine([query])
         }),