@pikku/cli 0.6.6

package/CHANGELOG.md

@@ -0,0 +1,445 @@
+# @pikku/cli
+
+## 0.6.6
+
+### Patch Changes
+
+- 780d7c2: revert: using import for json
+- Updated dependencies [0a92fa7]
+  - @pikku/core@0.6.7
+
+## 0.6.5
+
+### Patch Changes
+
+- 4357bca: feat: fixing up nextjs apis
+- Updated dependencies [4357bca]
+  - @pikku/core@0.6.6
+
+## 0.6.4
+
+### Patch Changes
+
+- 2bc64fd: feat: adding methods to fetch wrapper (and small fixes)
+- a40a508: fix: Fixing some generation bugs and other minors
+- 4855e68: refactor: changing all generated files to have a .gen in the default name suffix
+- Updated dependencies [a40a508]
+  - @pikku/inspector@0.6.2
+  - @pikku/core@0.6.5
+
+## 0.6.3
+
+### Patch Changes
+
+- f26880f: feat: extracting inspector and adding unique type references
+- Updated dependencies [f26880f]
+  - @pikku/inspector@0.6.1
+  - @pikku/core@0.6.4
+
+## 0.6.2
+
+### Patch Changes
+
+- 09fc52c: feat: adding cloudflare and lambda websockets
+  breaking change: moved subscription from channel to services and renamed to event hub
+- Updated dependencies [09fc52c]
+- Updated dependencies [adecb52]
+  - @pikku/core@0.6.3
+
+## 0.6.1
+
+### Patch Changes
+
+- adeb392: feat: more channel improvements, and adding bubble option to runners to avoid all the empty try catches
+- Updated dependencies [ed45ca9]
+- Updated dependencies [adeb392]
+  - @pikku/core@0.6.2
+
+## 0.6
+
+Marking a major release to include channels and scheduled tasks
+
+## 0.5.43
+
+### Patch Changes
+
+- 662a6cf: feat: adding scheduled tasks names
+- c8578ea: fix: getting websocket auth to work on individual messages
+- d2f8edf: feat: adding channelId to channels for serverless compatability
+- Updated dependencies [662a6cf]
+- Updated dependencies [c8578ea]
+- Updated dependencies [d2f8edf]
+  - @pikku/core@0.5.29
+
+## 0.5.42
+
+### Patch Changes
+
+- 886a2fb: refactor: moving singletons (like routes and channels) to global to avoid nodemodule overrides
+- 886a2fb: fix: making core routes global to avoid state overrides
+- Updated dependencies [a768bad]
+- Updated dependencies [886a2fb]
+- Updated dependencies [886a2fb]
+  - @pikku/core@0.5.28
+
+## 0.5.41
+
+### Patch Changes
+
+- 3f2e365: fix: create custom types if one object thats not a valid alias
+
+## 0.5.40
+
+### Patch Changes
+
+- 57731ed: fix: deleting a deadline in serializer
+
+## 0.5.39
+
+### Patch Changes
+
+- 75a828d: feat: create schemas for custom types extracted from apis
+
+## 0.5.38
+
+### Patch Changes
+
+- 6dc72d5: feat: add support for import attributes to cli options
+
+## 0.5.37
+
+### Patch Changes
+
+- 5d03fac: refactor: removing some dead code
+
+## 0.5.36
+
+### Patch Changes
+
+- aa8435c: fix: fixing up channel apis and implementations
+- Updated dependencies [aa8435c]
+  - @pikku/core@0.5.27
+
+## 0.5.35
+
+### Patch Changes
+
+- 2160039: fix: fixing alias issue with generated types
+- ab42f18: chore: upgrading to next15 and dropping pages support
+- Updated dependencies [ab42f18]
+  - @pikku/core@0.5.26
+
+## 0.5.34
+
+### Patch Changes
+
+- 0f96787: refactor: dropping cjs support
+- 64e4a1e: refactor: seperating core into cleaner sub-packages
+- c23524a: refactor: bump to versions to ensure correct package usage
+- Updated dependencies [0f96787]
+- Updated dependencies [64e4a1e]
+- Updated dependencies [c23524a]
+  - @pikku/core@0.5.25
+
+## 0.5.33
+
+### Patch Changes
+
+- bba25cc: chore: updating all packages to reflect major changes
+- 9deb482: refactor: finalizing stream api
+- f37042d: fix: always print out core schema register file
+- ee0c6ea: feat: adding ws server
+- d97e952: refactor: removing requirement of config method outside of nextjs
+- Updated dependencies [bba25cc]
+- Updated dependencies [9deb482]
+- Updated dependencies [ee0c6ea]
+  - @pikku/core@0.5.24
+
+## 0.5.32
+
+### Patch Changes
+
+- e9a9968: refactor: completing rename of stream to channel
+- Updated dependencies [7fa64a0]
+- Updated dependencies [539937e]
+- Updated dependencies [e9a9968]
+  - @pikku/core@0.5.23
+
+## 0.5.31
+
+### Patch Changes
+
+- 73973ec: fix: data type for methods is optional
+- Updated dependencies [73973ec]
+  - @pikku/core@0.5.22
+
+## 0.5.30
+
+### Patch Changes
+
+- 179b9c2: fix: fixing stream types
+- Updated dependencies [179b9c2]
+  - @pikku/core@0.5.21
+
+## 0.5.29
+
+### Patch Changes
+
+- b20ef35: fix: generate stream types from message array
+
+## 0.5.28
+
+### Patch Changes
+
+- 5be6da1: feat: adding streams to uws (and associated refactors)
+- Updated dependencies [5be6da1]
+  - @pikku/core@0.5.20
+
+## 0.5.27
+
+### Patch Changes
+
+- d58c440: refactor: making http requests explicit to support other types
+- 11c50d4: feat: adding streams to cli
+- Updated dependencies [cbcc75b]
+- Updated dependencies [d58c440]
+- Updated dependencies [11c50d4]
+  - @pikku/core@0.5.19
+
+## 0.5.26
+
+### Patch Changes
+
+- b7b78bb: fix: add '& {}' to openapi interfaces as a workaround for not directly refering to a type since it confuses typescript
+
+## 0.5.25
+
+### Patch Changes
+
+- 69d388d: refactor: switching to use config async creator
+
+## 0.5.24
+
+### Patch Changes
+
+- 2307831: fix: removing unused import
+
+## 0.5.23
+
+### Patch Changes
+
+- 30b46aa: fix: looks like using patch lowercase breaks the node fetch client sometimes
+- Updated dependencies [30b46aa]
+  - @pikku/core@0.5.13
+
+## 0.5.22
+
+### Patch Changes
+
+- f8aa99f: feat: export pikkuFetch instance to avoid needing a singleton class
+- Updated dependencies [ff8a563]
+  - @pikku/core@0.5.12
+
+## 0.5.21
+
+### Patch Changes
+
+- 5295380: refactor: changing config object a getConfig function
+- f24a653: feat: coerce types in ajv for correct validation / usage later on
+- Updated dependencies [be68efb]
+- Updated dependencies [5295380]
+- Updated dependencies [f24a653]
+  - @pikku/core@0.5.11
+
+## 0.5.20
+
+### Patch Changes
+
+- effbb4c: doc: adding readme to all packages
+- Updated dependencies [effbb4c]
+  - @pikku/core@0.5.10
+
+## 0.5.19
+
+### Patch Changes
+
+- 3541ab7: refactor: rename nextDeclarationFile to nextJSFile
+- 725723d: docs: adding typedocs
+- Updated dependencies [3541ab7]
+- Updated dependencies [725723d]
+  - @pikku/core@0.5.9
+
+## 0.5.18
+
+### Patch Changes
+
+- b237ace: feat: adding core errors to openapi error specs
+- 1876d7a: feat: add error return codes to doc generation
+- fda3869: fix: dont ignore decleration files when looking for types
+- Updated dependencies [1876d7a]
+- Updated dependencies [8d85f7e]
+  - @pikku/core@0.5.8
+
+## 0.5.17
+
+### Patch Changes
+
+- 25c6637: fix: fixing a type import for meta types
+
+## 0.5.16
+
+### Patch Changes
+
+- 2654ef1: fix: testing relative files
+
+## 0.5.15
+
+### Patch Changes
+
+- 707b26a: feat: save openapi as yml if needed
+
+## 0.5.14
+
+### Patch Changes
+
+- 0883f00: fix: schema generation error
+- Updated dependencies [0883f00]
+  - @pikku/core@0.5.6
+
+## 0.5.13
+
+### Patch Changes
+
+- 93b80a3: feat: adding a beta openapi standard
+- Updated dependencies [93b80a3]
+  - @pikku/core@0.5.5
+
+## 0.5.12
+
+### Patch Changes
+
+- 473ac6a: fix: correcting name of schema root file
+  refactor: removing time change in generated files
+
+## 0.5.11
+
+### Patch Changes
+
+- b3dcfc4: feat: adding a bootstrap file to simplify usage
+
+## 0.5.10
+
+### Patch Changes
+
+- 2c0e940: fix: reinspecting after type file is created
+
+## 0.5.9
+
+### Patch Changes
+
+- 0e1f01c: fix: inccorect string replacement
+
+## 0.5.8
+
+### Patch Changes
+
+- 2841fce: fix: create empty schema directory
+
+## 0.5.7
+
+### Patch Changes
+
+- 3724449: fix: fixing a cli path issue
+
+## 0.5.6
+
+### Patch Changes
+
+- 58a510a: refactor: moving routes map into a declaration file
+
+## 0.5.5
+
+### Patch Changes
+
+- 6cac8ab: feat: adding a do not edit to cli generated files
+- Updated dependencies [6cac8ab]
+  - @pikku/core@0.5.4
+
+## 0.5.4
+
+### Patch Changes
+
+- 8065e48: refactor: large cli refactor for a better dev experience
+- Updated dependencies [8065e48]
+  - @pikku/core@0.5.3
+
+## 0.5.3
+
+### Patch Changes
+
+- 5e0f033: feat: adding a routes map output file to support frontend sdks in the future
+- Updated dependencies [5e0f033]
+  - @pikku/core@0.5.2
+
+## 0.5.2
+
+### Patch Changes
+
+- 8712f25: fix: relative paths need to start with ./ for imports to work
+
+## 0.5.1
+
+### Patch Changes
+
+- 45e07de: refactor: renaming packages and pikku structure
+- Updated dependencies [97900d2]
+- Updated dependencies [d939d46]
+- Updated dependencies [45e07de]
+  - @pikku/core@0.5.1
+
+## 0.4.7
+
+### Patch Changes
+
+- c382ed3: putting glob back to 10 again for node 18 support
+
+## 0.4.6
+
+### Patch Changes
+
+- 2a2402b: republish since something went wrong
+- Updated dependencies [2a2402b]
+  - @pikku/core@0.4.6
+
+## 0.4.5
+
+### Patch Changes
+
+- 0650348: fix: export schemas using \*
+- 1a708a7: refactor: renaming PikkuCLIConfig back to PikkuConfig
+  feat: adding .end() to pikku response for servers that need it
+- 3019265: fix: ensuring node 18 compatability
+- 642d370: fix: adding schema error logs on fail
+- Updated dependencies [0650348]
+- Updated dependencies [1a708a7]
+- Updated dependencies [642d370]
+  - @pikku/core@0.4.4
+
+## 0.4.4
+
+### Patch Changes
+
+- 94f8a74: fix: finalizing cjs and esm packages
+
+## 0.4.3
+
+### Patch Changes
+
+- 28f62ea: refactor: using cjs and esm builds!
+- 14783ee: fix: including all types as dependencies to avoid users needing to install them
+
+## 0.4.2
+
+### Patch Changes
+
+- 5a012d9: Fixing typedoc generation

package/README.md

@@ -0,0 +1,3 @@
+# Pikku CLI
+
+This package is part of @pikku/mono and is responsible for all the intropsection and file generations.

package/bin/pikku-all.ts

@@ -0,0 +1,110 @@
+import { Command } from 'commander'
+import {
+  getFileImportRelativePath,
+  logPikkuLogo,
+  PikkuCLIOptions,
+  writeFileInDir,
+} from '../src/utils.js'
+import { getPikkuCLIConfig } from '../src/pikku-cli-config.js'
+import { pikkuRoutes } from './pikku-routes.js'
+import { pikkuFunctionTypes } from './pikku-function-types.js'
+import { pikkuHTTPMap } from './pikku-routes-map.js'
+import { existsSync } from 'fs'
+import { pikkuFetch } from './pikku-fetch.js'
+import { pikkuChannelsMap } from './pikku-channels-map.js'
+import { pikkuChannels } from './pikku-channels.js'
+import { pikkuNext } from './pikku-nextjs.js'
+import { pikkuOpenAPI } from './pikku-openapi.js'
+import { pikkuScheduler } from './pikku-scheduler.js'
+import { pikkuSchemas } from './pikku-schemas.js'
+import { pikkuWebSocket } from './pikku-websocket.js'
+import { inspectorGlob } from '../src/inspector-glob.js'
+
+export const action = async (options: PikkuCLIOptions): Promise<void> => {
+  logPikkuLogo()
+
+  const imports: string[] = []
+  const addImport = (from: string) => {
+    imports.push(
+      `import '${getFileImportRelativePath(cliConfig.bootstrapFile, from, cliConfig.packageMappings)}'`
+    )
+  }
+
+  const cliConfig = await getPikkuCLIConfig(options.config, [], true)
+
+  let typesDeclarationFileExists = true
+  let visitState = await inspectorGlob(
+    cliConfig.rootDir,
+    cliConfig.routeDirectories
+  )
+
+  if (!existsSync(cliConfig.typesDeclarationFile)) {
+    typesDeclarationFileExists = false
+  }
+  await pikkuFunctionTypes(cliConfig, options, visitState)
+
+  // This is needed since the addRoutes function will add the routes to the visitState
+  if (!typesDeclarationFileExists) {
+    console.log(`\x1b[34m• Type file first created, inspecting again...\x1b[0m`)
+    visitState = await inspectorGlob(
+      cliConfig.rootDir,
+      cliConfig.routeDirectories
+    )
+  }
+
+  const routes = await pikkuRoutes(cliConfig, visitState)
+  if (routes) {
+    await pikkuHTTPMap(cliConfig, visitState)
+    await pikkuFetch(cliConfig)
+    addImport(cliConfig.routesFile)
+  }
+
+  const scheduled = await pikkuScheduler(cliConfig, visitState)
+  if (scheduled) {
+    addImport(cliConfig.schedulersFile)
+  }
+
+  const channels = await pikkuChannels(cliConfig, visitState)
+  if (channels) {
+    await pikkuChannelsMap(cliConfig, visitState)
+    await pikkuWebSocket(cliConfig)
+    addImport(cliConfig.channelsFile)
+  }
+
+  const schemas = await pikkuSchemas(cliConfig, visitState)
+  if (schemas) {
+    addImport(`${cliConfig.schemaDirectory}/register.gen.ts`)
+  }
+
+  await pikkuNext(cliConfig, visitState, options)
+
+  if (cliConfig.openAPI) {
+    console.log(
+      `\x1b[34m• OpenAPI requires a reinspection to pickup new generated types..\x1b[0m`
+    )
+    visitState = await inspectorGlob(
+      cliConfig.rootDir,
+      cliConfig.routeDirectories
+    )
+    await pikkuOpenAPI(cliConfig, visitState)
+  }
+
+  await writeFileInDir(cliConfig.bootstrapFile, imports.join('\n'))
+}
+
+export const all = (program: Command): void => {
+  program
+    .command('all', { isDefault: true })
+    .description('Generate all the files used by pikku')
+    .option('-ct | --pikku-config-type', 'The type of your pikku config object')
+    .option(
+      '-ss | --singleton-services-factory-type',
+      'The type of your singleton services factory'
+    )
+    .option(
+      '-se | --session-services-factory-type',
+      'The type of your session services factory'
+    )
+    .option('-c | --config <string>', 'The path to pikku cli config file')
+    .action(action)
+}

package/bin/pikku-channels-map.ts

@@ -0,0 +1,53 @@
+import { Command } from 'commander'
+import { getPikkuCLIConfig, PikkuCLIConfig } from '../src/pikku-cli-config.js'
+import { InspectorState } from '@pikku/inspector'
+import {
+  logCommandInfoAndTime,
+  logPikkuLogo,
+  PikkuCLIOptions,
+  writeFileInDir,
+} from '../src/utils.js'
+import { serializeTypedChannelsMap } from '../src/channels/serialize-typed-channel-map.js'
+import { inspectorGlob } from '../src/inspector-glob.js'
+
+export const pikkuChannelsMap = async (
+  { channelsMapDeclarationFile, packageMappings }: PikkuCLIConfig,
+  state: InspectorState
+) => {
+  return await logCommandInfoAndTime(
+    'Creating channels map',
+    'Created channels map',
+    [state.channels.files.size === 0],
+    async () => {
+      const content = serializeTypedChannelsMap(
+        channelsMapDeclarationFile,
+        packageMappings,
+        state.channels.typesMap,
+        state.channels.meta
+      )
+      await writeFileInDir(channelsMapDeclarationFile, content)
+    }
+  )
+}
+
+async function action(cliOptions: PikkuCLIOptions): Promise<void> {
+  logPikkuLogo()
+  const cliConfig = await getPikkuCLIConfig(cliOptions.config, [
+    'rootDir',
+    'routeDirectories',
+    'routesFile',
+  ])
+  const visitState = await inspectorGlob(
+    cliConfig.rootDir,
+    cliConfig.routeDirectories
+  )
+  await pikkuChannelsMap(cliConfig, visitState)
+}
+
+export const channelsMap = (program: Command): void => {
+  program
+    .command('channels-map')
+    .description('Generate a map of all channels to aid in type checking')
+    .option('-c | --config <string>', 'The path to pikku cli config file')
+    .action(action)
+}

package/bin/pikku-channels.ts

@@ -0,0 +1,57 @@
+import { Command } from 'commander'
+import { getPikkuCLIConfig, PikkuCLIConfig } from '../src/pikku-cli-config.js'
+import { InspectorState } from '@pikku/inspector'
+import {
+  logCommandInfoAndTime,
+  logPikkuLogo,
+  PikkuCLIOptions,
+  writeFileInDir,
+} from '../src/utils.js'
+import {
+  serializeChannels,
+  serializeChannelMeta,
+} from '../src/channels/serialize-channels.js'
+import { inspectorGlob } from '../src/inspector-glob.js'
+
+export const pikkuChannels = async (
+  cliConfig: PikkuCLIConfig,
+  visitState: InspectorState
+) => {
+  return await logCommandInfoAndTime(
+    'Finding Channels',
+    'Found channels',
+    [visitState.channels.files.size === 0],
+    async () => {
+      const { channelsFile, packageMappings } = cliConfig
+      const { channels } = visitState
+      const content = [
+        serializeChannels(channelsFile, channels.files, packageMappings),
+        serializeChannelMeta(channels.meta),
+      ]
+      await writeFileInDir(channelsFile, content.join('\n\n'))
+    }
+  )
+}
+
+async function action(cliOptions: PikkuCLIOptions): Promise<void> {
+  logPikkuLogo()
+
+  const cliConfig = await getPikkuCLIConfig(cliOptions.config, [
+    'rootDir',
+    'routeDirectories',
+    'routesFile',
+  ])
+  const visitState = await inspectorGlob(
+    cliConfig.rootDir,
+    cliConfig.routeDirectories
+  )
+  await pikkuChannels(cliConfig, visitState)
+}
+
+export const channels = (program: Command): void => {
+  program
+    .command('channels')
+    .description('Find all channels to import')
+    .option('-c | --config <string>', 'The path to pikku cli config file')
+    .action(action)
+}

package/bin/pikku-fetch.ts

@@ -0,0 +1,54 @@
+import { Command } from 'commander'
+import {
+  getFileImportRelativePath,
+  logCommandInfoAndTime,
+  logPikkuLogo,
+  PikkuCLIOptions,
+  writeFileInDir,
+} from '../src/utils.js'
+import { getPikkuCLIConfig, PikkuCLIConfig } from '../src/pikku-cli-config.js'
+import { serializeFetchWrapper } from '../src/http/serialize-fetch-wrapper.js'
+
+export const pikkuFetch = async ({
+  fetchFile,
+  routesMapDeclarationFile,
+  packageMappings,
+}: PikkuCLIConfig) => {
+  await logCommandInfoAndTime(
+    'Generating fetch wrapper',
+    'Generated fetch wrapper',
+    [fetchFile === undefined, 'fetchFile is required in pikku config'],
+    async () => {
+      if (!fetchFile) {
+        throw new Error('fetchFile is required in pikku config')
+      }
+
+      const routesMapDeclarationPath = getFileImportRelativePath(
+        fetchFile,
+        routesMapDeclarationFile,
+        packageMappings
+      )
+
+      const content = [serializeFetchWrapper(routesMapDeclarationPath)]
+      await writeFileInDir(fetchFile, content.join('\n'))
+    }
+  )
+}
+
+export const action = async (options: PikkuCLIOptions): Promise<void> => {
+  logPikkuLogo()
+  const cliConfig = await getPikkuCLIConfig(
+    options.config,
+    ['rootDir', 'schemaDirectory', 'configDir', 'fetchFile'],
+    true
+  )
+  await pikkuFetch(cliConfig)
+}
+
+export const fetch = (program: Command): void => {
+  program
+    .command('fetch')
+    .description('generate fetch wrapper')
+    .option('-c | --config <string>', 'The path to pikku cli config file')
+    .action(action)
+}