Use blueprint from smith

Author: razor-x

package-lock.json

@@ -32,18 +32,16 @@
     "@metalsmith/metadata": "^0.3.0",
     "@prettier/plugin-php": "^0.22.2",
     "@prettier/plugin-ruby": "^4.0.4",
-    "@seamapi/blueprint": "^0.43.1",
-    "@seamapi/smith": "^0.3.3",
-    "@seamapi/types": "1.399.1",
+    "@seamapi/types": "^1.402.0",
     "change-case": "^5.4.4",
     "command-exists": "^1.2.9",
     "execa": "^9.3.1",
     "prettier": "^3.0.0",
     "zod": "^3.23.8"
   },
   "devDependencies": {
-    "@types/command-exists": "^1.2.3",
-    "@types/debug": "^4.1.12",
-    "@types/micromatch": "^4.0.9"
+    "@seamapi/blueprint": "^0.43.2",
+    "@seamapi/smith": "^0.4.3",
+    "@types/command-exists": "^1.2.3"
   }
 }

package.json

@@ -4,7 +4,7 @@ import * as customHelpers from './handlebars-helpers.js'
 
 export const helpers = { ...handlebarsHelpers, ...customHelpers }
 
-export * from './blueprint.js'
+export * from './format-code.js'
 export * from './postprocess.js'
 export * from './reference.js'
 export * from './report.js'

src/lib/blueprint.ts

@@ -1,12 +1,12 @@
 import type {
   ActionAttempt,
+  CodeSample,
   Endpoint,
   Parameter,
   SdkName,
   SeamAuthMethod,
   SeamWorkspaceScope,
 } from '@seamapi/blueprint'
-import type { CodeSample } from 'node_modules/@seamapi/blueprint/dist/index.cjs'
 
 import {
   type ApiRouteResource,

src/lib/index.ts

@@ -1,6 +1,6 @@
 import type { Blueprint } from '@seamapi/blueprint'
 
-import type { PathMetadata } from 'lib/path-metadata.js'
+import type { PathMetadata } from '../path-metadata.js'
 
 export interface ApiNamespaceLayoutContext {
   title: string

src/lib/layout/api-endpoint.ts

@@ -4,16 +4,14 @@ import type {
   Endpoint,
   EnumProperty,
   Property,
+  ResourceSample,
   Route,
-} from '@seamapi/blueprint'
-import { pascalCase } from 'change-case'
-import type {
   SdkName,
   SyntaxName,
-} from 'node_modules/@seamapi/blueprint/dist/index.cjs'
-import type { ResourceSample } from 'node_modules/@seamapi/blueprint/lib/samples/resource-sample.js'
+} from '@seamapi/blueprint'
+import { pascalCase } from 'change-case'
 
-import type { PathMetadata } from 'lib/path-metadata.js'
+import type { PathMetadata } from '../path-metadata.js'
 
 export interface ApiRouteLayoutContext {
   title: string

src/lib/layout/api-namespace.ts

@@ -11,7 +11,10 @@ import {
 } from './layout/index.js'
 import { PathMetadataSchema } from './path-metadata.js'
 
-type Metadata = Partial<Pick<Blueprint, 'routes' | 'resources'>>
+interface Metadata {
+  blueprint: Blueprint
+  pathMetadata: unknown
+}
 
 type File = ApiEndpointLayoutContext &
   ApiRouteLayoutContext &
@@ -32,15 +35,7 @@ export const reference = (
       ? PathMetadataSchema.parse(metadata.pathMetadata)
       : {}
 
-  const blueprint: Blueprint = {
-    title: '',
-    routes: [],
-    resources: {},
-    events: [],
-    actionAttempts: [],
-    pagination: null,
-    ...metadata,
-  }
+  const { blueprint } = metadata
 
   const namespacePaths = getNamespacePaths(blueprint.routes)
   for (const path of namespacePaths) {

src/lib/layout/api-route.ts

@@ -50,18 +50,16 @@ interface ParameterReportItem {
   params: ReportItem[]
 }
 
-type Metadata = Partial<Pick<Blueprint, 'routes' | 'resources'>>
+interface Metadata {
+  blueprint: Pick<Blueprint, 'routes' | 'resources'>
+  pathMetadata: unknown
+}
 
 export const report = (
   files: Metalsmith.Files,
   metalsmith: Metalsmith,
 ): void => {
-  const metadata = {
-    title: '',
-    routes: [],
-    resources: {},
-    ...(metalsmith.metadata() as Metadata),
-  }
+  const metadata = metalsmith.metadata() as Metadata
 
   const reportData = generateReport(metadata)
 
@@ -70,9 +68,15 @@ export const report = (
     layout: 'report.hbs',
     ...reportData,
   }
+
+  files['api/_blueprint.json'] = {
+    contents: Buffer.from(JSON.stringify(metadata.blueprint, null, 2)),
+    layout: 'default.hbs',
+  }
 }
 
 function generateReport(metadata: Metadata): Report {
+  const { blueprint } = metadata
   const report: Report = {
     undocumented: createEmptyReportSection(),
     noDescription: { ...createEmptyReportSection(), resources: [] },
@@ -87,12 +91,12 @@ function generateReport(metadata: Metadata): Report {
     },
   }
 
-  const resources = metadata.resources ?? {}
+  const resources = blueprint.resources ?? {}
   for (const [resourceName, resource] of Object.entries(resources)) {
     processResource(resourceName, resource, report)
   }
 
-  const routes = metadata.routes ?? []
+  const routes = blueprint.routes ?? []
   for (const route of routes) {
     processRoute(route, report, metadata)
   }

src/lib/reference.ts

@@ -2,15 +2,15 @@ import { dirname } from 'node:path'
 import { env } from 'node:process'
 import { fileURLToPath } from 'node:url'
 
-import * as types from '@seamapi/types/connect'
 import layouts from '@metalsmith/layouts'
 import metadata from '@metalsmith/metadata'
-import { getHandlebarsPartials } from '@seamapi/smith'
+import { blueprint, getHandlebarsPartials } from '@seamapi/smith'
+import * as types from '@seamapi/types/connect'
 import { deleteAsync } from 'del'
 import Metalsmith from 'metalsmith'
 
 import {
-  blueprint,
+  formatCode,
   helpers,
   postprocess,
   reference,
@@ -34,12 +34,19 @@ Metalsmith(rootDir)
       pathMetadata: './data/paths.yaml',
     }),
   )
-  .use(blueprint({ types, skipCodeFormat: env['SKIP_CODE_FORMAT'] != null }))
+  .use(
+    blueprint({
+      types,
+      formatCode,
+      skipCodeFormat: env['SKIP_CODE_FORMAT'] != null,
+    }),
+  )
   .use(reference)
   .use(report)
   .use(
     layouts({
       default: 'default.hbs',
+      transform: 'handlebars',
       engineOptions: {
         noEscape: true,
         helpers,