@platformatic/db 3.4.1 → 3.5.0

package/tsconfig.json

@@ -1,12 +1,22 @@
 {
   "compilerOptions": {
-    "module": "CommonJS",
-    "moduleResolution": "node",
+    "module": "commonjs",
     "esModuleInterop": true,
-    "allowSyntheticDefaultImports": true,
-    "target": "es2019",
-    "outDir": "build",
+    "lib": ["es2022"],
+    "target": "es2022",
     "sourceMap": true,
-    "strictNullChecks": true
+    "pretty": true,
+    "noEmitOnError": true,
+    "incremental": true,
+    "strict": true,
+    "outDir": "dist",
+    "skipLibCheck": true
+  },
+  "watchOptions": {
+    "watchFile": "fixedPollingInterval",
+    "watchDirectory": "fixedPollingInterval",
+    "fallbackPolling": "dynamicPriority",
+    "synchronousWatchDirectory": true,
+    "excludeDirectories": ["**/node_modules", "dist"]
   }
 }

package/db.mjs

@@ -1,86 +0,0 @@
-#! /usr/bin/env node
-
-import commist from 'commist'
-import parseArgs from 'minimist'
-import isMain from 'es-main'
-import helpMe from 'help-me'
-import { readFile } from 'fs/promises'
-import { join } from 'desm'
-import { start, buildCompileCmd } from '@platformatic/service'
-import { printAndExitLoadConfigError } from '@platformatic/config'
-import { platformaticDB } from './index.js'
-
-import { applyMigrations } from './lib/migrate.mjs'
-import { seed } from './lib/seed.mjs'
-import { generateTypes } from './lib/gen-types.mjs'
-import { printGraphQLSchema, printOpenAPISchema, generateJsonSchemaConfig } from './lib/gen-schema.mjs'
-import { generateMigration } from './lib/gen-migration.mjs'
-import { createDB } from './lib/create.mjs'
-
-const compile = buildCompileCmd(platformaticDB)
-
-const help = helpMe({
-  dir: join(import.meta.url, 'help'),
-  // the default
-  ext: '.txt',
-})
-
-function wrapCommand (fn) {
-  return async function (...args) {
-    try {
-      return await fn(...args)
-    } catch (err) {
-      printAndExitLoadConfigError(err)
-    }
-  }
-}
-
-const program = commist({ maxDistance: 2 })
-
-program.register('help', help.toStdout)
-program.register('help start', help.toStdout.bind(null, ['start']))
-program.register('help compile', help.toStdout.bind(null, ['compile']))
-program.register('help migrations apply', help.toStdout.bind(null, ['migrations apply']))
-program.register({ command: 'help seed', strict: true }, help.toStdout.bind(null, ['seed']))
-program.register('help schema', help.toStdout.bind(null, ['schema']))
-
-program.register('start', (argv) => {
-  start(platformaticDB, argv).catch(printAndExitLoadConfigError)
-})
-
-program.register('create', wrapCommand(createDB))
-program.register('compile', wrapCommand(compile))
-program.register('migrations create', wrapCommand(generateMigration))
-program.register('migrations apply', wrapCommand(applyMigrations))
-program.register('seed', wrapCommand(seed))
-program.register('types', wrapCommand(generateTypes))
-program.register('schema graphql', wrapCommand(printGraphQLSchema))
-program.register('schema openapi', wrapCommand(printOpenAPISchema))
-program.register('schema config', wrapCommand(generateJsonSchemaConfig))
-program.register('schema', help.toStdout.bind(null, ['schema']))
-
-// TODO add help command
-
-export async function runDB (argv) {
-  const args = parseArgs(argv, {
-    alias: {
-      v: 'version',
-    },
-  })
-
-  if (args.version) {
-    console.log('v' + JSON.parse(await readFile(join(import.meta.url, 'package.json'), 'utf-8')).version)
-    process.exit(0)
-  }
-
-  const output = await program.parseAsync(argv)
-
-  return {
-    output,
-    help,
-  }
-}
-
-if (isMain(import.meta)) {
-  await runDB(process.argv.splice(2))
-}

package/help/compile.txt

@@ -1,17 +0,0 @@
-Compile typescript plugins.
-
-``` bash
-  $ platformatic db compile
-```
-
-As a result of executing this command, the Platformatic DB will compile typescript
-plugins in the `outDir` directory. 
-
-If not specified, the configuration will be loaded from any of the following, in the current directory.
-
-* `platformatic.json`, or
-* `platformatic.yml`, or 
-* `platformatic.tml`
-
-You can find more details about the configuration format here:
-* [Platformatic DB Configuration](https://docs.platformatic.dev/docs/db/configuration)

package/help/create.txt

@@ -1,13 +0,0 @@
-Creates a new Platformatic DB application.
-
-Options are
-
-* `dir <string>` - the directory where to create the project (Default: `process.cwd() + 'platformatic-composer'`)
-* `port <string>` - the port where the application will listen (Default: `3042`)
-* `hostname <string>` - the hostname where the application will listen (Default: `0.0.0.0`)
-* `connectionString <string>` - the connection string for your database (Default: `sqlite://./db.sqlite`)
-* `migrations <boolean>` - Creates sample migrations (Default: `true`)
-* `git <boolean>` - Init the git repository (Default: `true`)
-* `typescript <boolean>` - Use Typescript (Default: `false`)
-* `install <boolean>` - Run or not `npm install` after creating the files (Default: `true`)
-* `plugin <boolean>` - Creates a sample plugin and tests (Default: `true`)

package/help/help.txt

@@ -1,11 +0,0 @@
-Available commands:
-
-* `help` - show this help message.
-* `help <command>` - shows more information about a command.
-* `start` - start the server.
-* `compile` - compile typescript plugins.
-* `seed` - run a seed file.
-* `types` - generate typescript types for entities.
-* `schema` - generate and print api schema.
-* `migrations create` - generate do and undo migration files.
-* `migrations apply` - apply migration files.

package/help/migrations apply.txt

@@ -1,45 +0,0 @@
-Apply all configured migrations to the database:
-
-``` bash
-  $ platformatic db migrations apply
-```
-
-The migrations will be applied in the order they are specified in the
-folder defined in the configuration file. If you want to apply a specific migration,
-you can use the `--to` option:
-
-``` bash
-  $ platformatic db migrations apply --to 001
-```
-
-Here is an example migration:
-
-``` sql
-  CREATE TABLE graphs (
-    id SERIAL PRIMARY KEY,
-    name TEXT
-  );
-```
-
-You can always rollback to a specific migration with:
-
-``` bash
-  $ platformatic db migrations apply --to VERSION
-```
-
-Use 000 to reset to the initial state.
-
-Options:
-
-* `-c, --config <path>` - Path to the configuration file.
-* `-t, --to <version>` - Migrate to a specific version.
-
-If not specified, the configuration will be loaded from any of the following, in the current directory.
-
-* `platformatic.json`, or
-* `platformatic.yml`, or 
-* `platformatic.tml`
-
-You can find more details about the configuration format here:
-* [Platformatic DB Configuration](https://docs.platformatic.dev/docs/db/configuration)
-

package/help/migrations create.txt

@@ -1,27 +0,0 @@
-Create next migration files.
-
-``` bash
-  $ platformatic db migrations create
-```
-
-It will generate do and undo sql files in the migrations folder. The name of the
-files will be the next migration number.
-
-``` bash
-  $ platformatic db migrations create
-```
-
-The migration files are named `001.<do|undo>.sql`, `002.<do|undo>.sql` etc...
-
-Options:
-
-* `-c, --config <path>` - Path to the configuration file.
-
-If not specified, the configuration will be loaded from any of the following, in the current directory.
-
-* `platformatic.json`, or
-* `platformatic.yml`, or 
-* `platformatic.tml`
-
-You can find more details about the configuration format here:
-* [Platformatic DB Configuration](https://docs.platformatic.dev/docs/db/configuration)

package/help/migrations.txt

@@ -1,4 +0,0 @@
-Available commands:
-
-* `migrations create` - generate do and undo migration files.
-* `migrations apply` - apply migration files.

package/help/schema.txt

@@ -1,25 +0,0 @@
-Update the config schema file:
-
-* `schema config` - update the JSON schema config available on `platformatic.json`
-
-Your configuration on `platformatic.json` has a schema defined to improve the developer experience and avoid mistakes when updating the configuration of Platformatic DB.
-When you run `platformatic db init`, a new JSON `$schema` property is added in `platformatic.json`. This can allow your IDE to add suggestions (f.e. mandatory/missing fields, types, default values) by opening the config in `platformatic.json`.
-Running `platformatic schema config` you can update your schema so that it matches well the latest changes available on your config.
-
-Generate a schema from the database and prints it to standard output:
-
-* `schema graphql` - generate the GraphQL schema
-* `schema openapi` - generate the OpenAPI schema
-
-Options:
-
-* `-c, --config FILE` - Specify a configuration file to use.
-
-If not specified, the configuration will be loaded from any of the following, in the current directory.
-
-* `platformatic.json`, or
-* `platformatic.yml`, or 
-* `platformatic.tml`
-
-You can find more details about the configuration format here:
-* [Platformatic DB Configuration](https://docs.platformatic.dev/docs/db/configuration)

package/help/seed.txt

@@ -1,36 +0,0 @@
-Load a seed into the database. This is a convenience method that loads
-a JavaScript file and configure @platformatic/sql-mapper to connect to
-the database specified in the configuration file.
-
-Here is an example of a seed file:
-
-``` javascript
-  'use strict'
-
-  module.exports = async function ({ entities, db, sql }) {
-    await entities.graph.save({ input: { name: 'Hello' } })
-    await db.query(sql`
-      INSERT INTO graphs (name) VALUES ('Hello 2');
-    `)
-  }
-```
-
-You can run this using the `seed` command:
-
-``` bash
-  $ platformatic db seed seed.js
-```
-
-Options:
-
-* `--config` - Path to the configuration file.
-
-If not specified, the configuration will be loaded from any of the following, in the current directory.
-
-* `platformatic.json`, or
-* `platformatic.yml`, or 
-* `platformatic.tml`
-
-You can find more details about the configuration format here:
-* [Platformatic DB Configuration](https://docs.platformatic.dev/docs/db/configuration)
-

package/help/start.txt

@@ -1,47 +0,0 @@
-Start the Platformatic DB server with the following command:
-
-``` bash
- $ platformatic db start
- ```
-
-You will need a  configuration file. Here is an example to get you started,
-save the following as `platformatic.json`:
-
-``` json
-  {
-    "server": {
-      "hostname": "127.0.0.1",
-      "port": 0,
-      "logger": {
-        "level": "info"
-      }
-    },
-    "db": {
-      "connectionString": "sqlite://./db"
-    },
-    "migrations": {
-      "dir": "./migrations"
-    }
-  }
-```
-
-Remember to create a migration, run the `db help migrate` command to know more.
-
-All outstanding migrations will be applied to the database unless the
-`migrations.autoApply` configuration option is set to false.
-
-By sending the SIGUSR2 signal, the server can be reloaded.
-
-Options:
-
-* `-c, --config FILE` - Specify a configuration file to use.
-
-If not specified, the configuration will be loaded from any of the following, in the current directory.
-
-* `platformatic.json`, or
-* `platformatic.yml`, or 
-* `platformatic.tml`
-
-You can find more details about the configuration format here:
-* [Platformatic DB Configuration](https://docs.platformatic.dev/docs/db/configuration)
-

package/help/types.txt

@@ -1,40 +0,0 @@
-Generate typescript types for your entities from the database.
-
-``` bash
-  $ platformatic db types
-```
-
-As a result of executing this command, the Platformatic DB will generate a `types`
-folder with a typescript file for each database entity. It will also generate a
-`global.d.ts` file that injects the types into the Application instance.
-
-In order to add type support to your plugins, you need to install some additional
-dependencies. To do this, copy and run an `npm install` command with dependencies
-that "platformatic db types" will ask you.
-
-Here is an example of a platformatic plugin.js with jsdoc support.
-You can use it to add autocomplete to your code.
-
-``` javascript
-/// <reference path="./global.d.ts" />
-'use strict'
-
-/** @param {import('fastify').FastifyInstance} app */
-module.exports = async function (app) {
-  app.get('/movie', async () => {
-    const movies = await app.platformatic.entities.movie.find({
-      where: { title: { eq: 'The Hitchhiker\'s Guide to the Galaxy' } }
-    })
-    return movies[0].id
-  })
-}
-```
-
-If not specified, the configuration will be loaded from any of the following, in the current directory.
-
-* `platformatic.json`, or
-* `platformatic.yml`, or 
-* `platformatic.tml`
-
-You can find more details about the configuration format here:
-* [Platformatic DB Configuration](https://docs.platformatic.dev/docs/db/configuration)

package/index.test-d.ts

@@ -1,43 +0,0 @@
-import { buildServer, PlatformaticApp, PlatformaticDBMixin, PlatformaticDBConfig, Entities, errors } from '.'
-import ConfigManager from '@platformatic/config'
-import type { Database } from '@platformatic/sql-mapper'
-import { SQL } from '@databases/sql'
-import { expectType } from 'tsd'
-import { OpenAPI } from 'openapi-types'
-import type { MercuriusPlugin } from 'mercurius'
-import { FastifyError } from '@fastify/error'
-
-declare module 'fastify' {
-  interface FastifyInstance {
-    platformatic: PlatformaticApp<PlatformaticDBConfig> & PlatformaticDBMixin<Entities>
-  }
-}
-
-async function main (): Promise<void> {
-  // TODO this configuration is incomplete, type it fully
-  const server = await buildServer({
-    server: {
-      port: 3042,
-      host: '127.0.0.1',
-    },
-  })
-
-  expectType<Database>(server.platformatic.db)
-  expectType<SQL>(server.platformatic.sql)
-  expectType<ConfigManager<PlatformaticDBConfig>>(server.platformatic.configManager)
-  expectType<PlatformaticDBConfig>(server.platformatic.config)
-  expectType<OpenAPI.Document>(server.swagger())
-  expectType<MercuriusPlugin>(server.graphql)
-}
-
-main().catch(console.error)
-
-// Errors
-type ErrorWithNoParams = () => FastifyError
-type ErrorWithOneParam = (param: string) => FastifyError
-
-expectType<ErrorWithNoParams>(errors.MigrateMissingMigrationsError)
-expectType<ErrorWithNoParams>(errors.UnknownDatabaseError)
-expectType<ErrorWithOneParam>(errors.MigrateMissingMigrationsDirError)
-expectType<ErrorWithNoParams>(errors.MissingSeedFileError)
-expectType<ErrorWithNoParams>(errors.MigrationsToApplyError)

package/lib/adjust-config.js

@@ -1,42 +0,0 @@
-'use strict'
-const { resolve } = require('path')
-const { readFile } = require('fs/promises')
-const { platformaticService } = require('@platformatic/service')
-
-module.exports = async function adjustConfig (configManager) {
-  await platformaticService.configManagerConfig.transformConfig.call(configManager)
-
-  const dirOfConfig = configManager.dirname
-  if (configManager.current.db && configManager.current.db.connectionString.indexOf('sqlite') === 0 && configManager.current.db.connectionString !== 'sqlite://:memory:') {
-    const originalSqlitePath = configManager.current.db.connectionString.replace('sqlite://', '')
-    const sqliteFullPath = resolve(dirOfConfig, originalSqlitePath)
-    configManager.current.db.connectionString = 'sqlite://' + sqliteFullPath
-  }
-
-  /* c8 ignore next 3 */
-  if (configManager.current.db.graphql?.schemaPath) {
-    configManager.current.db.graphql.schema = await readFile(configManager.current.db.graphql.schemaPath, 'utf8')
-  }
-
-  /* c8 ignore next 2 */
-  const arePostgresqlSchemaDefined = configManager.current.db?.connectionString.indexOf('postgres') === 0 && configManager.current.db?.schema?.length > 0
-  const migrationsTableName = arePostgresqlSchemaDefined ? 'public.versions' : 'versions'
-
-  // relative-to-absolute migrations path
-  if (configManager.current.migrations) {
-    configManager.current.migrations.table = configManager.current.migrations.table || migrationsTableName
-  }
-
-  if (configManager.current.migrations && configManager.current.db) {
-    // TODO remove the ignores
-    /* c8 ignore next 4 */
-    configManager.current.db.ignore = configManager.current.db.ignore || {}
-    configManager.current.db.ignore = Object.assign({}, {
-      [configManager.current.migrations.table || migrationsTableName]: true,
-    }, configManager.current.db.ignore)
-  }
-
-  if (configManager.current.types?.autogenerate === 'true') {
-    configManager.current.types.autogenerate = true
-  }
-}

package/lib/create.mjs

@@ -1,89 +0,0 @@
-'use strict'
-import minimist from 'minimist'
-import { Generator } from '../lib/generator/db-generator.js'
-import { join } from 'node:path'
-import { getPkgManager } from '@platformatic/utils'
-import { execa } from 'execa'
-import ora from 'ora'
-import { Table } from 'console-table-printer'
-import pino from 'pino'
-import pinoPretty from 'pino-pretty'
-
-function printAppSummary (args, logger) {
-  logger.info('Creating a Platformatic DB app with this config: ')
-  const table = [
-    { config: 'Directory', value: args.dir },
-    { config: 'Connection String', value: args.connectionString },
-    { config: 'Language', value: args.typescript ? 'Typescript' : 'Javascript' },
-    { config: 'Init Git Repository', value: args.git },
-    { config: 'Install Dependencies', value: args.install },
-    { config: 'Sample Plugin and Tests', value: args.plugin },
-    { config: 'Create Sample Migrations', value: args.migrations },
-  ]
-
-  const p = new Table({
-    columns: [
-      { name: 'config', alignment: 'right' },
-      { name: 'value', alignment: 'left' },
-    ],
-  })
-
-  p.addRows(table)
-  p.printTable()
-}
-async function createDB (_args) {
-  const stream = pinoPretty({
-    translateTime: 'SYS:HH:MM:ss',
-    ignore: 'hostname,pid',
-    minimumLevel: 'debug',
-    sync: true,
-  })
-
-  const logger = pino(stream)
-
-  const args = minimist(process.argv.slice(2), {
-    string: ['dir', 'port', 'hostname', 'connectionString'],
-    boolean: ['typescript', 'install', 'migrations', 'plugin', 'git'],
-    default: {
-      dir: join(process.cwd(), 'platformatic-db'),
-      port: 3042,
-      hostname: '0.0.0.0',
-      plugin: true,
-      typescript: false,
-      git: false,
-      install: true,
-      migrations: true,
-      connectionString: 'sqlite://./db.sqlite',
-    },
-
-  })
-
-  printAppSummary(args, logger)
-
-  const gen = new Generator({})
-  gen.setConfig({
-    port: args.port,
-    hostname: args.hostname,
-    plugin: args.plugin,
-    tests: args.plugin,
-    typescript: args.typescript,
-    initGitRepository: args.git,
-    targetDirectory: args.dir,
-  })
-
-  try {
-    await gen.run()
-    if (args.install) {
-      const pkgManager = getPkgManager()
-      const spinner = ora('Installing dependencies...').start()
-      await execa(pkgManager, ['install'], { cwd: args.dir })
-      spinner.succeed()
-    }
-
-    logger.info('Done! 🎉')
-  } catch (err) {
-    logger.error(err.message)
-  }
-}
-
-export { createDB }

package/lib/gen-migration.mjs

@@ -1,53 +0,0 @@
-import { join } from 'path'
-import { writeFile } from 'fs/promises'
-import pino from 'pino'
-import pretty from 'pino-pretty'
-import { loadConfig } from '@platformatic/config'
-import { Migrator } from './migrator.mjs'
-import { platformaticDB } from '../index.js'
-import errors from './errors.js'
-
-async function generateMigration (_args) {
-  const logger = pino(pretty({
-    translateTime: 'SYS:HH:MM:ss',
-    ignore: 'hostname,pid',
-  }))
-
-  const { configManager } = await loadConfig({}, _args, platformaticDB)
-  await configManager.parseAndValidate()
-  const config = configManager.current
-
-  let migrator = null
-  try {
-    const migrationsConfig = config.migrations
-    if (migrationsConfig === undefined) {
-      throw new errors.MigrateMissingMigrationsError()
-    }
-
-    migrator = new Migrator(migrationsConfig, config.db, logger)
-
-    const nextMigrationVersion = await migrator.getNextMigrationVersion()
-    const nextMigrationVersionStr = migrator.convertVersionToStr(nextMigrationVersion)
-
-    const nextDoMigrationName = `${nextMigrationVersionStr}.do.sql`
-    const nextUndoMigrationName = `${nextMigrationVersionStr}.undo.sql`
-
-    const doFile = join(migrator.migrationDir, nextDoMigrationName)
-    const undoFile = join(migrator.migrationDir, nextUndoMigrationName)
-
-    await Promise.all([
-      writeFile(doFile, ''),
-      writeFile(undoFile, ''),
-    ])
-
-    logger.info({ do: doFile, undo: undoFile }, 'Created migration files')
-  } catch (error) {
-    logger.error(error.message)
-  } finally {
-    if (migrator !== null) {
-      await migrator.close()
-    }
-  }
-}
-
-export { generateMigration }