polen 0.11.0-next.7 → 0.11.0-next.8

package/src/api/schema/data-sources/introspection/introspection.ts

@@ -0,0 +1,213 @@
+import { Grafaid } from '#lib/grafaid/index'
+import { GraphqlChange } from '#lib/graphql-change/index'
+import type { GraphqlChangeset } from '#lib/graphql-changeset/index'
+import { GraphqlSchemaLoader } from '#lib/graphql-schema-loader/index'
+import { Fs, Json, Path } from '@wollybeard/kit'
+import type { NonEmptyChangeSets, SchemaReadResult } from '../../schema.js'
+
+/**
+ * Configuration for loading schema via GraphQL introspection.
+ *
+ * Polen supports two introspection features:
+ * 1. **File Convention**: Automatically detects `schema.introspection.json` if present
+ * 2. **Automatic Introspection**: Fetches from your endpoint and creates the file
+ *
+ * When configured, Polen will:
+ * - Execute the standard GraphQL introspection query against your endpoint
+ * - Save the result to `schema.introspection.json` in your project root
+ * - Use this cached file for subsequent builds (no network requests)
+ *
+ * The saved file contains a standard GraphQL introspection query result as defined
+ * in the GraphQL specification, making it compatible with any tool that works with
+ * introspection data (GraphQL Codegen, Apollo CLI, etc.).
+ *
+ * To refresh the schema, delete `schema.introspection.json` and rebuild.
+ *
+ * **Technical details**:
+ * - Uses Graffle's introspection extension
+ * - Performs the full introspection query (all types, fields, descriptions, etc.)
+ * - No customization of the query is currently supported
+ *
+ * @see https://spec.graphql.org/draft/#sec-Introspection - GraphQL Introspection spec
+ * @see https://github.com/graphql/graphql-js/blob/main/src/utilities/getIntrospectionQuery.ts - Reference implementation
+ *
+ * @example
+ * ```ts
+ * // Basic introspection
+ * introspection: {
+ *   url: 'https://api.example.com/graphql'
+ * }
+ *
+ * // With authentication
+ * introspection: {
+ *   url: 'https://api.example.com/graphql',
+ *   headers: {
+ *     'Authorization': `Bearer ${process.env.API_TOKEN}`
+ *   }
+ * }
+ * ```
+ */
+export interface ConfigInput {
+  /**
+   * The GraphQL endpoint URL to introspect.
+   *
+   * Must be a valid GraphQL endpoint that supports introspection queries.
+   *
+   * @example 'https://api.example.com/graphql'
+   */
+  url?: string
+  /**
+   * Optional headers to include in the introspection request.
+   *
+   * Use this for authentication, API keys, or any custom headers
+   * required by your GraphQL endpoint.
+   *
+   * @example
+   * ```ts
+   * headers: {
+   *   'Authorization': `Bearer ${process.env.API_TOKEN}`,
+   *   'X-API-Key': process.env.API_KEY
+   * }
+   * ```
+   */
+  headers?: Record<string, string>
+  projectRoot?: string
+}
+
+export interface Config {
+  url: string
+  headers?: Record<string, string>
+  projectRoot: string
+}
+
+export const normalizeConfig = (configInput: ConfigInput): Config => {
+  if (!configInput.url) {
+    throw new Error(`Introspection data source requires a URL`)
+  }
+
+  if (!configInput.projectRoot) {
+    throw new Error(`Introspection data source requires a projectRoot`)
+  }
+
+  const config: Config = {
+    url: configInput.url,
+    headers: configInput.headers,
+    projectRoot: configInput.projectRoot,
+  }
+
+  return config
+}
+
+const INTROSPECTION_FILE_NAME = `schema.introspection.json`
+
+const getIntrospectionFilePath = (projectRoot: string) => {
+  return Path.join(projectRoot, INTROSPECTION_FILE_NAME)
+}
+
+export const readOrThrow = async (
+  configInput: ConfigInput,
+): Promise<SchemaReadResult> => {
+  const config = normalizeConfig(configInput)
+  const introspectionFilePath = getIntrospectionFilePath(config.projectRoot)
+
+  // Check if introspection file exists
+  const introspectionFileContent = await Fs.read(introspectionFilePath)
+  let schema: Grafaid.Schema.Schema
+
+  if (introspectionFileContent) {
+    // Load from existing file - no reCreate capability
+    try {
+      const introspectionData = Json.codec.decode(introspectionFileContent)
+
+      // Validate introspection data structure before passing to fromIntrospectionQuery
+      if (!introspectionData || typeof introspectionData !== 'object') {
+        throw new Error('Introspection data must be a valid JSON object')
+      }
+
+      // Allow fromIntrospectionQuery to handle validation of the introspection format
+      // It will provide more specific GraphQL-related error messages
+      if (!('data' in introspectionData)) {
+        throw new Error(
+          'Introspection data missing required "data" property (expected GraphQL introspection result format)',
+        )
+      }
+
+      schema = Grafaid.Schema.fromIntrospectionQuery(introspectionData as any)
+    } catch (error) {
+      if (error instanceof SyntaxError) {
+        throw new Error(`Invalid JSON in ${introspectionFilePath}: ${error.message}`)
+      } else {
+        throw new Error(
+          `Invalid introspection data in ${introspectionFilePath}: ${
+            error instanceof Error ? error.message : String(error)
+          }. Delete this file to fetch fresh introspection data.`,
+        )
+      }
+    }
+
+    const schemaData = await createSingleSchemaChangeset(schema)
+    return {
+      data: schemaData,
+      source: { type: 'introspectionFile' },
+    }
+  } else {
+    // Fetch via introspection - can reCreate
+    const introspectionResult = await GraphqlSchemaLoader.load({
+      type: `introspect`,
+      url: config.url,
+      headers: config.headers,
+    })
+
+    schema = introspectionResult
+
+    // Get the raw introspection result for saving
+    const __schema = Grafaid.Schema.toIntrospectionQuery(schema)
+
+    // Wrap in GraphQL response format for consistency with API responses
+    const introspectionData = { data: { __schema } }
+
+    // Write to file
+    await Fs.write({
+      path: introspectionFilePath,
+      content: Json.codec.encode(introspectionData as any),
+    })
+
+    const schemaData = await createSingleSchemaChangeset(schema)
+    return {
+      data: schemaData,
+      source: {
+        type: 'introspectionAuto',
+        reCreate: async () => {
+          // Re-fetch using captured config - capture closure
+          const result = await readOrThrow(configInput)
+          return result.data
+        },
+      },
+    }
+  }
+}
+
+/**
+ * Create a single changeset from a schema object.
+ * This is the core logic for handling single (unversioned) schemas from introspection.
+ */
+export const createSingleSchemaChangeset = async (schema: Grafaid.Schema.Schema): Promise<NonEmptyChangeSets> => {
+  const date = new Date() // Generate date here for unversioned schema
+  const after = schema
+  const before = Grafaid.Schema.empty
+  const changes = await GraphqlChange.calcChangeset({
+    before,
+    after,
+  })
+
+  const changeset: GraphqlChangeset.ChangeSet = {
+    date,
+    after,
+    before,
+    changes,
+  }
+
+  const result: NonEmptyChangeSets = [changeset]
+
+  return result
+}

package/src/api/schema/read.ts

@@ -1,38 +1,104 @@
-import { Arr } from '@wollybeard/kit'
+import { Arr, Fs, Path } from '@wollybeard/kit'
 import * as DataSources from './data-sources/data-sources.js'
 import type { NonEmptyChangeSets } from './schema.js'
 
-export type DataSourceType = `file` | `directory` | `memory` | `data`
+export type DataSourceType =
+  | `file`
+  | `directory`
+  | `memory`
+  | `data`
+  | `introspection`
+  | `introspectionFile`
+  | `introspectionAuto`
+
+/**
+ * Result of schema reading with provenance tracking for file watching and debugging.
+ */
+export interface SchemaReadResult {
+  data: NonEmptyChangeSets | null
+  source: {
+    type: DataSourceType
+    /**
+     * Recreate the schema data and file after it has been deleted.
+     *
+     * This function re-fetches data from the original source and recreates
+     * the schema file on disk. Only called by file watchers after deletion.
+     *
+     * @returns Promise resolving to the recreated schema data, or null if recreation fails
+     */
+    reCreate?: () => Promise<NonEmptyChangeSets | null>
+  }
+}
 
 /**
  * Schema configuration for Polen.
+ *
+ * Polen supports multiple ways to load your GraphQL schema, from simple files
+ * to dynamic introspection. Configure which sources to use and in what order.
+ *
+ * @example
+ * ```ts
+ * // Load from a file (default)
+ * schema: {} // Looks for schema.graphql
+ *
+ * // Load via introspection
+ * schema: {
+ *   dataSources: {
+ *     introspection: {
+ *       url: 'https://api.example.com/graphql',
+ *       headers: { 'Authorization': 'Bearer token' }
+ *     }
+ *   }
+ * }
+ *
+ * // Try multiple sources in order
+ * schema: {
+ *   useDataSources: ['introspection', 'file'],
+ *   dataSources: {
+ *     introspection: { url: 'https://api.example.com/graphql' },
+ *     file: { path: './fallback-schema.graphql' }
+ *   }
+ * }
+ * ```
  */
 export interface Config {
   /**
    * Whether to enable schema loading.
    *
-   * Set to `false` to disable schema features entirely.
+   * Set to `false` to disable schema features entirely. This removes
+   * the Reference and Changelog pages from your portal.
    *
-   * @default `true`
+   * @default true
+   *
+   * @example
+   * ```ts
+   * // Disable schema features
+   * schema: { enabled: false }
+   * ```
    */
   enabled?: boolean
   /**
    * Which data sources to use for loading schemas.
    *
-   * - `file` - Load from a single SDL file
-   * - `directory` - Load multiple SDL files from a directory
+   * - `file` - Load from a single SDL file (default: `./schema.graphql`)
+   * - `directory` - Load multiple SDL files from a directory (default: `./schema/`)
    * - `memory` - Use schemas defined in configuration
    * - `data` - Use a pre-built schema object
+   * - `introspection` - Load schema via GraphQL introspection
    *
-   * If not specified, Polen will try all sources in order until one succeeds.
+   * If not specified, Polen tries all sources in this order:
+   * 1. `data` 2. `directory` 3. `file` 4. `memory` 5. `introspection`
    *
    * @example
    * ```ts
    * // Use only file source
    * useDataSources: 'file'
    *
-   * // Try multiple sources
-   * useDataSources: ['directory', 'file']
+   * // Try multiple sources in custom order
+   * useDataSources: ['introspection', 'file']
+   *
+   * // Default behavior (try all sources)
+   * // useDataSources: undefined
    * ```
    */
   useDataSources?: Arr.Maybe<DataSourceType>
@@ -56,22 +122,38 @@ export interface Config {
      * Pre-built schema object to use directly.
      */
     data?: NonEmptyChangeSets
+    /**
+     * Configuration for loading schema via GraphQL introspection.
+     *
+     * Introspection fetches your schema directly from a running GraphQL endpoint.
+     * The schema is saved to `schema.introspection.json` in your project root.
+     * Delete this file to force a fresh introspection on the next build.
+     *
+     * @example
+     * ```ts
+     * introspection: {
+     *   url: 'https://api.example.com/graphql',
+     *   headers: { 'Authorization': 'Bearer token' }
+     * }
+     * ```
+     */
+    introspection?: DataSources.Introspection.ConfigInput
   }
   projectRoot: string
 }
 
 export const readOrThrow = async (
   config: Config,
-): Promise<null | NonEmptyChangeSets> => {
+): Promise<SchemaReadResult> => {
   if (config.enabled === false) {
-    return null
+    return { data: null, source: { type: 'data' } }
   }
 
   const useDataSources = config.useDataSources ? Arr.sure(config.useDataSources) : null
   const usingDataSource = (dataSource: DataSourceType) => useDataSources === null || useDataSources.includes(dataSource)
 
   if (usingDataSource(`data`) && config.dataSources?.data) {
-    return config.dataSources.data
+    return { data: config.dataSources.data, source: { type: 'data' } }
   }
 
   if (usingDataSource(`directory`)) {
@@ -80,7 +162,7 @@ export const readOrThrow = async (
       ...config.dataSources?.directory,
     }
     const result = await DataSources.SchemaDirectory.readOrThrow(directoryConfig)
-    if (result) return result
+    if (result) return { data: result, source: { type: 'directory' } }
   }
 
   if (usingDataSource(`file`)) {
@@ -89,7 +171,7 @@ export const readOrThrow = async (
       ...config.dataSources?.file,
     }
     const result = await DataSources.SchemaFile.readOrThrow(fileConfig)
-    if (result) return result
+    if (result) return { data: result, source: { type: 'file' } }
   }
 
   if (usingDataSource(`memory`) && config.dataSources?.memory) {
@@ -98,8 +180,17 @@ export const readOrThrow = async (
       ...config.dataSources.memory,
     }
     const result = await DataSources.Memory.read(memoryConfig)
-    if (result) return result
+    if (result) return { data: result, source: { type: 'memory' } }
+  }
+
+  if (usingDataSource(`introspection`) && config.dataSources?.introspection) {
+    const introspectionConfig = {
+      projectRoot: config.projectRoot,
+      ...config.dataSources.introspection,
+    }
+    const result = await DataSources.Introspection.readOrThrow(introspectionConfig)
+    if (result.data) return result
   }
 
-  return null
+  return { data: null, source: { type: 'data' } }
 }

package/src/api/schema-source/schema-source.ts

@@ -157,13 +157,13 @@ export const createSchemaSource = (config: SchemaSourceConfig) => {
     },
 
     writeAllAssets: async (
-      schemaData: Awaited<ReturnType<typeof Schema.readOrThrow>>,
+      schemaData: Awaited<ReturnType<typeof Schema.readOrThrow>>['data'],
       metadata: Schema.SchemaMetadata,
     ) => {
       if (!schemaData) return
 
       // Write schema and changelog files
-      for (const [index, version] of schemaData.entries()) {
+      for (const [index, version] of schemaData!.entries()) {
         const versionName = index === 0 ? Schema.VERSION_LATEST : Schema.dateToVersionString(version.date)
 
         // Write schema file
@@ -173,7 +173,7 @@ export const createSchemaSource = (config: SchemaSourceConfig) => {
         )
 
         // Write changelog file (except for the oldest/last version)
-        if (Schema.shouldVersionHaveChangelog(index, schemaData.length)) {
+        if (Schema.shouldVersionHaveChangelog(index, schemaData!.length)) {
           const changelogData = {
             changes: version.changes,
             date: version.date.toISOString(),

package/src/api/vite/plugins/core.ts

@@ -35,15 +35,15 @@ export const Core = (config: Config.Config): Vite.PluginOption[] => {
 
   const readSchema = async () => {
     if (schemaCache === null) {
-      const schema = await Schema.readOrThrow({
+      const schemaResult = await Schema.readOrThrow({
         ...config.schema,
         projectRoot: config.paths.project.rootDir,
       })
       // todo: augmentations scoped to a version
-      schema?.forEach(version => {
+      schemaResult.data?.forEach(version => {
         SchemaAugmentation.apply(version.after, config.schemaAugmentations)
       })
-      schemaCache = schema
+      schemaCache = schemaResult
     }
     return schemaCache
   }
@@ -166,8 +166,8 @@ export const Core = (config: Config.Config): Vite.PluginOption[] => {
             const debug = debugPolen.sub(`module-project-schema`)
             debug(`load`, { id: viProjectSchema.id })
 
-            const schema = await readSchema()
-            return superjson.stringify(schema)
+            const schemaResult = await readSchema()
+            return superjson.stringify(schemaResult.data)
           },
         },
         {
@@ -191,18 +191,18 @@ export const Core = (config: Config.Config): Vite.PluginOption[] => {
 
             debug(`load`, { id: viProjectData.id })
 
-            const schema = await readSchema()
+            const schemaResult = await readSchema()
 
             const navbar = []
 
             // ━ Schema presence causes adding some navbar items
-            if (schema) {
+            if (schemaResult.data) {
               // IMPORTANT: Always ensure paths start with '/' for React Router compatibility.
               // Without the leading slash, React Router treats paths as relative, which causes
               // hydration mismatches between SSR (where base path is prepended) and client
               // (where basename is configured). This ensures consistent behavior.
               navbar.push({ pathExp: `/reference`, title: `Reference` })
-              if (schema.length > 1) {
+              if (schemaResult.data.length > 1) {
                 navbar.push({ pathExp: `/changelog`, title: `Changelog` })
               }
             }

package/src/api/vite/plugins/schema-assets.ts

@@ -9,6 +9,7 @@ import { debugPolen } from '#singletons/debug'
 import { Cache } from '@wollybeard/kit'
 import * as NodeFs from 'node:fs/promises'
 import * as NodePath from 'node:path'
+import type { NonEmptyChangeSets } from '../../schema/schema.js'
 import { polenVirtual } from '../vi.js'
 
 export const viProjectSchemaMetadata = polenVirtual([`project`, `schema-metadata`])
@@ -35,27 +36,28 @@ export const SchemaAssets = (config: Config.Config): Vite.Plugin => {
 
   // Helper to load and process schema data
   const loadAndProcessSchemaData = Cache.memoize(async () => {
-    const schemaData = await Schema.readOrThrow({
+    const schemaResult = await Schema.readOrThrow({
       ...config.schema,
       projectRoot: config.paths.project.rootDir,
     })
 
-    if (!schemaData) {
+    if (!schemaResult.data) {
       const metadata: Schema.SchemaMetadata = { hasSchema: false, versions: [] }
       return {
         schemaData: null,
         metadata,
+        source: schemaResult.source,
       }
     }
 
     // Apply augmentations
-    schemaData.forEach(version => {
+    schemaResult.data.forEach(version => {
       SchemaAugmentation.apply(version.after, config.schemaAugmentations)
     })
 
     // Build metadata
     const versionStrings: string[] = []
-    for (const [index, version] of schemaData.entries()) {
+    for (const [index, version] of schemaResult.data.entries()) {
       const versionName = index === 0 ? Schema.VERSION_LATEST : Schema.dateToVersionString(version.date)
       versionStrings.push(versionName)
     }
@@ -65,11 +67,12 @@ export const SchemaAssets = (config: Config.Config): Vite.Plugin => {
       versions: versionStrings,
     }
 
-    debug(`schemaDataLoaded`, { versionCount: schemaData.length })
+    debug(`schemaDataLoaded`, { versionCount: schemaResult.data.length })
 
     return {
-      schemaData,
+      schemaData: schemaResult.data,
       metadata,
+      source: schemaResult.source,
     }
   })
 
@@ -102,10 +105,10 @@ export const SchemaAssets = (config: Config.Config): Vite.Plugin => {
 
   // Helper to write assets using schema-source API
   const writeDevAssets = async (
-    schemaData: Awaited<ReturnType<typeof Schema.readOrThrow>>,
+    schemaData: NonEmptyChangeSets,
     metadata: Schema.SchemaMetadata,
   ) => {
-    if (!schemaData) return
+    // schemaData is now guaranteed to be non-null NonEmptyChangeSets
 
     const devAssetsDir = config.paths.framework.devAssets.schemas
     await NodeFs.mkdir(devAssetsDir, { recursive: true })
@@ -149,6 +152,13 @@ export const SchemaAssets = (config: Config.Config): Vite.Plugin => {
         debug(`watchingSchemaFile`, { path: config.schema.dataSources.file.path })
       }
 
+      if (config.schema?.dataSources?.introspection?.url) {
+        // Watch the introspection file if introspection is configured
+        const introspectionFilePath = NodePath.join(config.paths.project.rootDir, `schema.introspection.json`)
+        server.watcher.add(introspectionFilePath)
+        debug(`watchingIntrospectionFile`, { path: introspectionFilePath })
+      }
+
       // Handle file removal
       server.watcher.on('unlink', async (file) => {
         const isSchemaFile = config.schema && (() => {
@@ -172,6 +182,15 @@ export const SchemaAssets = (config: Config.Config): Vite.Plugin => {
             if (absoluteFile.startsWith(absoluteSchemaDir + NodePath.sep)) return true
           }
 
+          // Check if file is the introspection file
+          if (config.schema.dataSources?.introspection?.url) {
+            const absoluteIntrospectionFile = NodePath.resolve(
+              config.paths.project.rootDir,
+              `schema.introspection.json`,
+            )
+            if (absoluteFile === absoluteIntrospectionFile) return true
+          }
+
           return false
         })()
 
@@ -181,14 +200,33 @@ export const SchemaAssets = (config: Config.Config): Vite.Plugin => {
           try {
             // Clear cache and regenerate
             loadAndProcessSchemaData.clear()
-            const { schemaData, metadata } = await loadAndProcessSchemaData()
-
-            if (schemaData) {
+            const { schemaData, metadata, source } = await loadAndProcessSchemaData()
+
+            // If file was deleted but can be recreated, attempt recreation
+            if (!schemaData && source.reCreate) {
+              debug(`attemptingSchemaRecreation`, { sourceType: source.type })
+              try {
+                const recreatedData = await source.reCreate()
+                if (recreatedData) {
+                  // Clear cache again and reload after recreation
+                  loadAndProcessSchemaData.clear()
+                  const reloadResult = await loadAndProcessSchemaData()
+                  if (reloadResult.schemaData) {
+                    await writeDevAssets(reloadResult.schemaData, reloadResult.metadata)
+                    debug(`hmr:schemaRecreatedAndWritten`, { versionCount: reloadResult.schemaData.length })
+                  }
+                } else {
+                  debug(`hmr:schemaRecreationFailed`, { reason: 'reCreate returned null' })
+                }
+              } catch (recreationError) {
+                debug(`hmr:schemaRecreationFailed`, { error: recreationError })
+              }
+            } else if (schemaData) {
               // Write new assets without the removed file
               await writeDevAssets(schemaData, metadata)
               debug(`hmr:schemaAssetsUpdatedAfterRemoval`, { versionCount: schemaData.length })
             } else {
-              // No schema data - clear all assets
+              // No schema data and cannot recreate - clear all assets
               const schemaSource = createDevSchemaSource({ hasSchema: false, versions: [] })
               await schemaSource.clearAllAssets()
               debug(`hmr:allAssetsCleared`, {})
@@ -274,6 +312,15 @@ export const SchemaAssets = (config: Config.Config): Vite.Plugin => {
           if (absoluteFile.startsWith(absoluteSchemaDir + NodePath.sep)) return true
         }
 
+        // Check if file is the introspection file
+        if (config.schema.dataSources?.introspection?.url) {
+          const absoluteIntrospectionFile = NodePath.resolve(
+            config.paths.project.rootDir,
+            `schema.introspection.json`,
+          )
+          if (absoluteFile === absoluteIntrospectionFile) return true
+        }
+
         return false
       })()
       if (isSchemaFile) {

package/src/cli/commands/open.ts

@@ -132,7 +132,7 @@ const wrapCache = <fn extends Fn.AnyAnyAsync>(fn: fn): fn => {
 
 // todo: use a proper validation, e.g. zod, better yet: allow to specify the validation in molt itself
 const parseHeaders = (headersJsonEncoded: string): Record<string, string> => {
-  const headersJson = Json.codec.deserialize(headersJsonEncoded)
+  const headersJson = Json.codec.decode(headersJsonEncoded)
   if (!Rec.is(headersJson)) {
     console.log(`--introspection-headers must be a JSON object.`)
     process.exit(1)

package/src/lib/grafaid/schema/schema.ts

@@ -4,6 +4,7 @@ export {
   buildASTSchema as fromAST,
   buildClientSchema as fromIntrospectionQuery,
   GraphQLSchema as Schema,
+  introspectionFromSchema as toIntrospectionQuery,
   printSchema as print,
 } from 'graphql'
 

package/src/lib/kit-temp.ts

@@ -105,9 +105,9 @@ export const objPolicyFilter = <
   const result: any = mode === `deny` ? { ...obj } : {}
 
   if (mode === `allow`) {
-    // For allow mode, only add specified keys
+    // For allow mode, only add specified keys that are own properties
     for (const key of keys) {
-      if (key in obj) {
+      if (Object.prototype.hasOwnProperty.call(obj, key)) {
         // @ts-expect-error
         result[key] = obj[key]
       }

package/src/lib/mask/$.test.ts

@@ -113,9 +113,9 @@ describe('property-based tests', () => {
           // Result contains only keys that were in both mask and object
           expect(resultKeys.every(key => keys.includes(key))).toBe(true)
 
-          // All requested keys that exist in obj are in result
+          // All requested keys that are own properties of obj are in result
           keys.forEach(key => {
-            if (key in obj) {
+            if (Object.prototype.hasOwnProperty.call(obj, key)) {
               expect(result).toHaveProperty(key, (obj as any)[key])
             }
           })
@@ -169,7 +169,7 @@ describe('property-based tests', () => {
           const result = Mask.apply(obj as any, Mask.create(keys))
 
           keys.forEach(key => {
-            if (key in obj) {
+            if (Object.prototype.hasOwnProperty.call(obj, key)) {
               expect(result).toHaveProperty(key)
               expect((result as any)[key]).toBe((obj as any)[key])
             }