TypeScript klay-kiln.IKiln類代碼示例

export function createAndMergeRouters(
  kiln: IKiln,
  routerMap: IRouterMap,
  swaggerOverrides?: Partial<SwaggerSpec>,
): IRouter {
  const models = keyBy(kiln.getModels(), kilnModel => kilnModel.name)
  const router = express.Router()
  const routes: IRouterRoute[] = []
  forEach(routerMap, (routerOrOptions, prefix) => {
    let subRouter = routerOrOptions as IRouter
    if (!Array.isArray(routerOrOptions.routes)) {
      const routerOptions = routerOrOptions as IRouterOptions
      if (routerOptions.modelName) {
        const kilnModel = models[routerOptions.modelName]
        const databaseExtension = routerOptions.databaseExtension || DEFAULT_DATABASE_EXTENSION
        const executor = kiln.build<IDatabaseExecutor>(routerOptions.modelName, databaseExtension)
        subRouter = createRouter(routerOptions, kilnModel, executor)
      } else {
        subRouter = createRouter(routerOptions)
      }
    }

    router.use(prefix, subRouter.router)
    subRouter.routes.forEach(route => {
      routes.push({...route, path: `${prefix}${route.path}`})
    })
  })

  const mergedRouter = {router, routes}
  const swagger = buildSpecification(kiln, mergedRouter, swaggerOverrides)
  router.get('/swagger.json', createSwaggerSpecHandler(swagger))
  router.get('/docs', createSwaggerUIHandler(swagger, './swagger.json'))
  return mergedRouter
}

export function addForeignKeys(
  modelInProgress: Sequelize.DefineAttributes,
  model: IModel,
  kiln: IKiln,
): void {
  const constraints = model.spec.db!.constrain
  for (const constraint of constraints) {
    if (constraint.type !== ConstraintType.Reference) {
      continue
    }

    assert.ok(constraint.properties.length === 1, 'foreign key must be single field')
    const fkName = getFlattenedPath(constraint.properties[0])
    const fkDefinition = modelInProgress[fkName] as Sequelize.DefineAttributeColumnOptions
    const sqlExecutor = kiln.build<ISQLExecutor>(constraint.meta.referencedModel!, SQL_EXECUTOR)
    fkDefinition.references = {
      key: getPrimaryKeyField(sqlExecutor.kilnModel.model),
      model: sqlExecutor.sequelizeModel,
    }
  }
}

export async function createNewMigrationFile(
  kiln: IKiln,
  connection?: sequelize.Sequelize,
): Promise<string> {
  const models = kiln
    .buildAll()
    .filter(result => result.extensionName === SQL_EXECUTOR)
    .map(result => result.value.sequelizeModel) as SequelizeModel[]

  for (const model of models) {
    if (!(model as any).rawAttributes || !Array.isArray((model as any).options.indexes)) {
      throw new Error('Sequelize has changed! Unable to create migration')
    }
  }

  const upMigrations = await computeMigrations(models, connection)
  const downMigrations = computeReverseMigrations(upMigrations)

  // TODO: topological sort of models to avoid foreign key issues
  const up = upMigrations.map(createStatementFor)
  const down = downMigrations.map(createStatementFor).reverse()

  const wrapInFn = (stmts: string[]) =>
    `async (queryInterface, Sequelize) => {\n${normalizeWhitespace(
      awaitAll(stmts, 2),
      2,
      false,
    )}\n}`

  const migration = `
    module.exports = {
      up: ${normalizeWhitespace(wrapInFn(up), 6)},
      down: ${normalizeWhitespace(wrapInFn(down), 6)},
    }
  `.trim()

  return normalizeWhitespace(migration)
}

export function buildSpecification(kiln: IKiln, router: IRouter, overrides?: Partial<Spec>): Spec {
  const schemaCache = new SwaggerSchemaCache()
  for (const kilnModel of kiln.getModels()) {
    const arrayModel = defaultModelContext.array().children(kilnModel.model)
    getSchema(kilnModel.model, schemaCache, startCase(kilnModel.name))
    getSchema(arrayModel, schemaCache, `${startCase(kilnModel.meta.plural)}List`)
  }

  return {
    swagger: '2.0',
    basePath: '/',
    produces: ['application/json'],
    host: 'localhost',
    schemes: ['http'],
    info: {
      title: 'Title',
      version: 'Version',
    },
    paths: buildPaths(router, schemaCache),
    definitions: schemaCache.getUniqueSchemas(),
    ...overrides,
  }
}

  forEach(routerMap, (routerOrOptions, prefix) => {
    let subRouter = routerOrOptions as IRouter
    if (!Array.isArray(routerOrOptions.routes)) {
      const routerOptions = routerOrOptions as IRouterOptions
      if (routerOptions.modelName) {
        const kilnModel = models[routerOptions.modelName]
        const databaseExtension = routerOptions.databaseExtension || DEFAULT_DATABASE_EXTENSION
        const executor = kiln.build<IDatabaseExecutor>(routerOptions.modelName, databaseExtension)
        subRouter = createRouter(routerOptions, kilnModel, executor)
      } else {
        subRouter = createRouter(routerOptions)
      }
    }

    router.use(prefix, subRouter.router)
    subRouter.routes.forEach(route => {
      routes.push({...route, path: `${prefix}${route.path}`})
    })
  })