@pikku/cli 0.6.11 → 0.6.13

package/src/nextjs/serialize-nextjs-wrapper.ts

@@ -4,20 +4,23 @@ export const serializeNextJsWrapper = (
   schemasPath: string,
   configImport: string,
   singleServicesFactoryImport: string,
-  sessionServicesImport: string
+  sessionServicesImport: string,
+  userSessionTypeImport: string
 ) => {
   return `'server-only'
-
+  
 /**
  * This file provides a wrapper around the PikkuNextJS class to allow for methods to be type checked against your routes.
- * This ensures type safety for route handling methods when integrating with the \`@pikku/core\` framework.
+ * It ensures type safety for route handling methods when integrating with the @pikku/core framework.
  */
-import { PikkuNextJS } from '@pikku/next'
+import { PikkuMiddleware } from '@pikku/core'
+import { PikkuNextJS, PikkuNextRequest } from '@pikku/next'
 import type { RoutesMap, RouteHandlerOf, RoutesWithMethod } from '${routesMapPath}'
 
 ${configImport}
 ${singleServicesFactoryImport}
 ${sessionServicesImport}
+${userSessionTypeImport}
 
 import '${routesPath}'
 import '${schemasPath}'
@@ -27,7 +30,7 @@ let _pikku: PikkuNextJS | undefined
 /**
  * Initializes and returns an instance of PikkuNextJS with helper methods for handling route requests.
  *
- * @returns An object containing methods for making dynamic and static action requests.
+ * @returns An object containing methods for making dynamic and static action requests, as well as session retrieval.
  */
 export const pikku = () => {
   if (!_pikku) {
@@ -38,14 +41,28 @@ export const pikku = () => {
     )
   }
 
+  /**
+   * Retrieves the user session using the current PikkuNextJS instance.
+   *
+   * @param request - The Next.js request object.
+   * @param middleware - An array of middleware functions to process the request.
+   * @returns A promise that resolves to the user session.
+   */
+  const getSession = async (
+    request: PikkuNextRequest,
+    middleware: PikkuMiddleware[]
+  ): Promise<UserSession | undefined> => {
+    return _pikku!.getSession(request, middleware) as any
+  }
+
   /**
    * Makes a dynamic action request for a specified route and method.
-   * Dynamic requests may access headers and cookies, making them unsuitable for precompile stages.
+   * Dynamic requests may access headers and cookies and are therefore unsuitable for precompile stages.
    *
    * @template Route - The route key from the RoutesMap.
    * @template Method - The method key from the specified route.
-   * @param route - The route to make the request to.
-   * @param method - The method to be used for the request.
+   * @param route - The route identifier.
+   * @param method - The HTTP method to be used for the request.
    * @param data - The input data for the request, defaults to null.
    * @returns A promise that resolves to the output of the route handler.
    */
@@ -66,8 +83,8 @@ export const pikku = () => {
    *
    * @template Route - The route key from the RoutesMap.
    * @template Method - The method key from the specified route.
-   * @param route - The route to make the request to.
-   * @param method - The method to be used for the request.
+   * @param route - The route identifier.
+   * @param method - The HTTP method to be used for the request.
    * @param data - The input data for the request, defaults to null.
    * @returns A promise that resolves to the output of the route handler.
    */
@@ -84,6 +101,11 @@ export const pikku = () => {
 
   /**
    * Makes a dynamic POST request for a specified route.
+   *
+   * @template Route - The route key with the POST method.
+   * @param route - The route identifier.
+   * @param data - The input data for the POST request, defaults to null.
+   * @returns A promise that resolves to the output of the POST handler.
    */
   const dynamicPost = <Route extends RoutesWithMethod<'POST'>>(
     route: Route,
@@ -94,6 +116,11 @@ export const pikku = () => {
 
   /**
    * Makes a dynamic GET request for a specified route.
+   *
+   * @template Route - The route key with the GET method.
+   * @param route - The route identifier.
+   * @param data - The input data for the GET request, defaults to null.
+   * @returns A promise that resolves to the output of the GET handler.
    */
   const dynamicGet = <Route extends RoutesWithMethod<'GET'>>(
     route: Route,
@@ -104,6 +131,11 @@ export const pikku = () => {
 
   /**
    * Makes a dynamic PATCH request for a specified route.
+   *
+   * @template Route - The route key with the PATCH method.
+   * @param route - The route identifier.
+   * @param data - The input data for the PATCH request, defaults to null.
+   * @returns A promise that resolves to the output of the PATCH handler.
    */
   const dynamicPatch = <Route extends RoutesWithMethod<'PATCH'>>(
     route: Route,
@@ -114,6 +146,11 @@ export const pikku = () => {
 
   /**
    * Makes a dynamic DELETE request for a specified route.
+   *
+   * @template Route - The route key with the DELETE method.
+   * @param route - The route identifier.
+   * @param data - The input data for the DELETE request, defaults to null.
+   * @returns A promise that resolves to the output of the DELETE handler.
    */
   const dynamicDel = <Route extends RoutesWithMethod<'DELETE'>>(
     route: Route,
@@ -122,10 +159,15 @@ export const pikku = () => {
     return dynamicActionRequest(route, 'DELETE', data)
   }
 
-  // Static
+  // Static Requests
 
   /**
    * Makes a static POST request for a specified route.
+   *
+   * @template Route - The route key with the POST method.
+   * @param route - The route identifier.
+   * @param data - The input data for the POST request, defaults to null.
+   * @returns A promise that resolves to the output of the POST handler.
    */
   const staticPost = <Route extends RoutesWithMethod<'POST'>>(
     route: Route,
@@ -136,6 +178,11 @@ export const pikku = () => {
 
   /**
    * Makes a static GET request for a specified route.
+   *
+   * @template Route - The route key with the GET method.
+   * @param route - The route identifier.
+   * @param data - The input data for the GET request, defaults to null.
+   * @returns A promise that resolves to the output of the GET handler.
    */
   const staticGet = <Route extends RoutesWithMethod<'GET'>>(
     route: Route,
@@ -145,6 +192,7 @@ export const pikku = () => {
   }
 
   return {
+    getSession,
     get: dynamicGet,
     post: dynamicPost,
     patch: dynamicPatch,
@@ -152,5 +200,6 @@ export const pikku = () => {
     staticGet,
     staticPost
   }
-}`
+}
+`
 }

package/src/pikku-cli-config.ts

@@ -1,6 +1,7 @@
 import { join, dirname, resolve, isAbsolute } from 'path'
 import { readdir, readFile } from 'fs/promises'
 import { OpenAPISpecInfo } from './openapi/openapi-spec-generator.js'
+import { InspectorFilters } from '@pikku/inspector'
 
 export interface PikkuCLICoreOutputFiles {
   outDir?: string
@@ -35,6 +36,8 @@ export type PikkuCLIConfig = {
     outputFile: string
     additionalInfo: OpenAPISpecInfo
   }
+
+  filters: InspectorFilters
 } & PikkuCLICoreOutputFiles
 
 const CONFIG_DIR_FILES = ['nextJSfile', 'fetchFile', 'websocketFile']
@@ -42,11 +45,13 @@ const CONFIG_DIR_FILES = ['nextJSfile', 'fetchFile', 'websocketFile']
 export const getPikkuCLIConfig = async (
   configFile: string | undefined = undefined,
   requiredFields: Array<keyof PikkuCLIConfig>,
+  tags: string[] = [],
   exitProcess: boolean = false
 ): Promise<PikkuCLIConfig> => {
   const config = await _getPikkuCLIConfig(
     configFile,
     requiredFields,
+    tags,
     exitProcess
   )
   return config
@@ -55,6 +60,7 @@ export const getPikkuCLIConfig = async (
 const _getPikkuCLIConfig = async (
   configFile: string | undefined = undefined,
   requiredFields: Array<keyof PikkuCLIConfig>,
+  tags: string[] = [],
   exitProcess: boolean = false
 ): Promise<PikkuCLIConfig> => {
   if (!configFile) {
@@ -82,6 +88,7 @@ const _getPikkuCLIConfig = async (
       const extendedConfig = await getPikkuCLIConfig(
         resolve(configDir, config.extends),
         [],
+        tags,
         exitProcess
       )
       result = {
@@ -154,6 +161,11 @@ const _getPikkuCLIConfig = async (
       }
     }
 
+    result.filters = result.filters || {}
+    if (tags.length > 0) {
+      result.filters.tags = tags
+    }
+
     if (!isAbsolute(result.tsconfig)) {
       result.tsconfig = join(result.rootDir, result.tsconfig)
     }

package/src/utils.ts

@@ -52,6 +52,7 @@ interface Meta {
 export type FilesAndMethods = {
   userSessionType: Meta
   sessionServicesType: Meta
+  singletonServicesType: Meta
   pikkuConfigFactory: Meta
   singletonServicesFactory: Meta
   sessionServicesFactory: Meta
@@ -63,6 +64,7 @@ export interface PikkuCLIOptions {
   userSessionType?: string
   singletonServicesFactoryType?: string
   sessionServicesFactoryType?: string
+  tags?: string[]
 }
 
 const getMetaTypes = (
@@ -102,7 +104,8 @@ const getMetaTypes = (
 
 export const getPikkuFilesAndMethods = async (
   {
-    sessionServicesTypeImportMap: httpSessionServicesTypeImportMap,
+    singletonServicesTypeImportMap,
+    sessionServicesTypeImportMap,
     userSessionTypeImportMap,
     sessionServicesFactories,
     singletonServicesFactories,
@@ -118,11 +121,13 @@ export const getPikkuFilesAndMethods = async (
   requires: Partial<{
     config: boolean
     sessionServiceType: boolean
+    singletonServicesType: boolean
     userSessionType: boolean
     singletonServicesFactory: boolean
     sessionServicesFactory: boolean
   }> = {
     config: false,
+    singletonServicesType: false,
     sessionServiceType: false,
     userSessionType: false,
     singletonServicesFactory: false,
@@ -138,10 +143,15 @@ export const getPikkuFilesAndMethods = async (
       userSessionTypeImportMap,
       configFileType
     ),
+    singletonServicesType: getMetaTypes(
+      'CoreSingletonServices',
+      requires.singletonServicesType ? errors : new Map(),
+      singletonServicesTypeImportMap
+    ),
     sessionServicesType: getMetaTypes(
       'CoreServices',
       requires.sessionServiceType ? errors : new Map(),
-      httpSessionServicesTypeImportMap
+      sessionServicesTypeImportMap
     ),
     pikkuConfigFactory: getMetaTypes(
       'CoreConfig',
@@ -210,7 +220,9 @@ export const logCommandInfoAndTime = async (
   callback: (...args: any[]) => Promise<unknown>
 ): Promise<boolean> => {
   if (skipCondition === true) {
-    logInfo(`• Skipping ${commandStart} since ${skipMessage}.`)
+    logInfo(
+      `• Skipping ${commandStart.charAt(0).toLocaleLowerCase()}${commandStart.slice(1)} since ${skipMessage}.`
+    )
     return false
   }