@pikku/cli 0.9.7 → 0.9.8

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @pikku/cli
 
+## 0.9.8
+
+### Patch Changes
+
+- ea89575: feat: adding the ability for custom schema validation / retrieving schemas to use (for example with openapi json_response)
+- Updated dependencies [ea89575]
+  - @pikku/core@0.9.8
+
 ## 0.9.7
 
 ### Patch Changes

package/cli.schema.json

@@ -269,10 +269,13 @@
         "rootDir": {
           "type": "string"
         },
-        "rpcMapDeclarationFile": {
+        "rpcInternalMapDeclarationFile": {
           "type": "string"
         },
-        "rpcWiringMetaFile": {
+        "rpcInternalWiringMetaFile": {
+          "type": "string"
+        },
+        "rpcMapDeclarationFile": {
           "type": "string"
         },
         "rpcWiringsFile": {
@@ -287,6 +290,12 @@
         "schemaDirectory": {
           "type": "string"
         },
+        "schemasFromTypes": {
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
         "servicesFile": {
           "type": "string"
         },
@@ -330,8 +339,9 @@
         "queueWorkersWiringFile",
         "queueWorkersWiringMetaFile",
         "rootDir",
+        "rpcInternalMapDeclarationFile",
+        "rpcInternalWiringMetaFile",
         "rpcMapDeclarationFile",
-        "rpcWiringMetaFile",
         "schedulersWiringFile",
         "schedulersWiringMetaFile",
         "schemaDirectory",

package/dist/src/pikku-cli-config.d.ts

@@ -49,6 +49,7 @@ export type PikkuCLIConfig = {
         additionalInfo: OpenAPISpecInfo;
     };
     middlewareServices?: string[];
+    schemasFromTypes?: string[];
     filters: InspectorFilters;
 } & PikkuCLICoreOutputFiles;
 export declare const getPikkuCLIConfig: (configFile: string | undefined, requiredFields: Array<keyof PikkuCLIConfig>, filters?: InspectorFilters, exitProcess?: boolean) => Promise<PikkuCLIConfig>;

package/dist/src/pikku-command-schemas.js

@@ -1,8 +1,8 @@
 import { generateSchemas, saveSchemas } from './schema-generator.js';
 import { logCommandInfoAndTime } from './utils.js';
-export const pikkuSchemas = async (logger, { tsconfig, schemaDirectory, supportsImportAttributes }, { functions, http }) => {
+export const pikkuSchemas = async (logger, { tsconfig, schemaDirectory, supportsImportAttributes, schemasFromTypes }, { functions, http }) => {
     return await logCommandInfoAndTime(logger, 'Creating schemas', 'Created schemas', [false], async () => {
-        const schemas = await generateSchemas(logger, tsconfig, functions.typesMap, functions.meta, http.meta);
-        await saveSchemas(logger, schemaDirectory, schemas, functions.typesMap, functions.meta, supportsImportAttributes);
+        const schemas = await generateSchemas(logger, tsconfig, functions.typesMap, functions.meta, http.meta, schemasFromTypes);
+        await saveSchemas(logger, schemaDirectory, schemas, functions.typesMap, functions.meta, supportsImportAttributes, schemasFromTypes);
     });
 };

package/dist/src/schema-generator.d.ts

@@ -2,5 +2,5 @@ import { CLILogger } from './utils.js';
 import { FunctionsMeta, JSONValue } from '@pikku/core';
 import { HTTPWiringsMeta } from '@pikku/core/http';
 import { TypesMap } from '@pikku/inspector';
-export declare function generateSchemas(logger: CLILogger, tsconfig: string, typesMap: TypesMap, functionMeta: FunctionsMeta, httpWiringsMeta: HTTPWiringsMeta): Promise<Record<string, JSONValue>>;
-export declare function saveSchemas(logger: CLILogger, schemaParentDir: string, schemas: Record<string, JSONValue>, typesMap: TypesMap, functionsMeta: FunctionsMeta, supportsImportAttributes: boolean): Promise<void>;
+export declare function generateSchemas(logger: CLILogger, tsconfig: string, typesMap: TypesMap, functionMeta: FunctionsMeta, httpWiringsMeta: HTTPWiringsMeta, additionalTypes?: string[]): Promise<Record<string, JSONValue>>;
+export declare function saveSchemas(logger: CLILogger, schemaParentDir: string, schemas: Record<string, JSONValue>, typesMap: TypesMap, functionsMeta: FunctionsMeta, supportsImportAttributes: boolean, additionalTypes?: string[]): Promise<void>;

package/dist/src/schema-generator.js

@@ -1,7 +1,7 @@
 import { createGenerator, RootlessError } from 'ts-json-schema-generator';
 import { writeFileInDir } from './utils.js';
 import { mkdir, writeFile } from 'fs/promises';
-export async function generateSchemas(logger, tsconfig, typesMap, functionMeta, httpWiringsMeta) {
+export async function generateSchemas(logger, tsconfig, typesMap, functionMeta, httpWiringsMeta, additionalTypes) {
     const schemasSet = new Set(typesMap.customTypes.keys());
     for (const { inputs, outputs } of Object.values(functionMeta)) {
         const types = [...(inputs || []), ...(outputs || [])];
@@ -25,6 +25,12 @@ export async function generateSchemas(logger, tsconfig, typesMap, functionMeta,
             }
         }
     }
+    // Add additional types from schemasFromTypes config
+    if (additionalTypes) {
+        for (const type of additionalTypes) {
+            schemasSet.add(type);
+        }
+    }
     const generator = createGenerator({
         tsconfig,
         skipTypeCheck: true,
@@ -53,7 +59,7 @@ export async function generateSchemas(logger, tsconfig, typesMap, functionMeta,
     });
     return schemas;
 }
-export async function saveSchemas(logger, schemaParentDir, schemas, typesMap, functionsMeta, supportsImportAttributes) {
+export async function saveSchemas(logger, schemaParentDir, schemas, typesMap, functionsMeta, supportsImportAttributes, additionalTypes) {
     await writeFileInDir(logger, `${schemaParentDir}/register.gen.ts`, 'export const empty = null;');
     const desiredSchemas = new Set([
         ...Object.values(functionsMeta)
@@ -65,6 +71,7 @@ export async function saveSchemas(logger, schemaParentDir, schemas, typesMap, fu
             .filter((s) => !!s &&
             !['boolean', 'string', 'number', 'null', 'undefined'].includes(s)),
         ...typesMap.customTypes.keys(),
+        ...(additionalTypes || []),
     ]);
     if (desiredSchemas.size === 0) {
         logger.info(`• Skipping schemas since none found.\x1b[0m`);
@@ -76,7 +83,9 @@ export async function saveSchemas(logger, schemaParentDir, schemas, typesMap, fu
             await writeFile(`${schemaParentDir}/schemas/${schemaName}.schema.json`, JSON.stringify(schema), 'utf-8');
         }
     }));
-    const schemaImports = Array.from(desiredSchemas)
+    // Only include schemas that were successfully generated
+    const availableSchemas = Array.from(desiredSchemas).filter((schema) => schemas[schema]);
+    const schemaImports = availableSchemas
         .map((schema) => `
 import * as ${schema} from './schemas/${schema}.schema.json' ${supportsImportAttributes ? `with { type: 'json' }` : ''}
 addSchema('${schema}', ${schema})

package/dist/src/schemas.js

@@ -1,8 +1,8 @@
 import { saveSchemas, generateSchemas } from './schema-generator.js';
 import { logCommandInfoAndTime } from './utils.js';
-export const pikkuSchemas = async (logger, { tsconfig, schemaDirectory, supportsImportAttributes }, { functions, http }) => {
+export const pikkuSchemas = async (logger, { tsconfig, schemaDirectory, supportsImportAttributes, schemasFromTypes }, { functions, http }) => {
     return await logCommandInfoAndTime(logger, 'Creating schemas', 'Created schemas', [false], async () => {
-        const schemas = await generateSchemas(logger, tsconfig, functions.typesMap, functions.meta, http.meta);
-        await saveSchemas(logger, schemaDirectory, schemas, functions.typesMap, functions.meta, supportsImportAttributes);
+        const schemas = await generateSchemas(logger, tsconfig, functions.typesMap, functions.meta, http.meta, schemasFromTypes);
+        await saveSchemas(logger, schemaDirectory, schemas, functions.typesMap, functions.meta, supportsImportAttributes, schemasFromTypes);
     });
 };

package/dist/src/wirings/http/pikku-command-openapi.js

@@ -2,12 +2,12 @@ import { logCommandInfoAndTime, writeFileInDir } from '../../utils.js';
 import { generateSchemas } from '../../schema-generator.js';
 import { generateOpenAPISpec } from './openapi-spec-generator.js';
 import { stringify } from 'yaml';
-export const pikkuOpenAPI = async (logger, { tsconfig, openAPI }, { http, functions }) => {
+export const pikkuOpenAPI = async (logger, { tsconfig, openAPI, schemasFromTypes }, { http, functions }) => {
     return await logCommandInfoAndTime(logger, 'Creating OpenAPI spec', 'Created OpenAPI spec', [openAPI?.outputFile === undefined, 'openAPI outfile is not defined'], async () => {
         if (!openAPI?.outputFile) {
             throw new Error('openAPI is required');
         }
-        const schemas = await generateSchemas(logger, tsconfig, functions.typesMap, functions.meta, http.meta);
+        const schemas = await generateSchemas(logger, tsconfig, functions.typesMap, functions.meta, http.meta, schemasFromTypes);
         const openAPISpec = await generateOpenAPISpec(functions.meta, http.meta, schemas, openAPI.additionalInfo);
         if (openAPI.outputFile.endsWith('.json')) {
             await writeFileInDir(logger, openAPI.outputFile, JSON.stringify(openAPISpec, null, 2), { ignoreModifyComment: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pikku/cli",
-  "version": "0.9.7",
+  "version": "0.9.8",
   "author": "yasser.fadl@gmail.com",
   "license": "MIT",
   "bin": {
@@ -22,7 +22,7 @@
   },
   "dependencies": {
     "@openapi-contrib/json-schema-to-openapi-schema": "^4.0.2",
-    "@pikku/core": "^0.9.6",
+    "@pikku/core": "^0.9.8",
     "@pikku/inspector": "^0.9.4",
     "@types/cookie": "^1.0.0",
     "@types/uuid": "^10.0.0",

package/run-tests.sh

@@ -46,7 +46,7 @@ if [ "$watch_mode" = true ]; then
 fi
 
 if [ "$coverage_mode" = true ]; then
-  node_cmd="$node_cmd --experimental-test-coverage --test-reporter=lcov --test-reporter-destination=lcov.info"
+  node_cmd="$node_cmd --test-coverage-include=\"src/**/*.{ts,js}\" --test-coverage-exclude=\"**/dist/**\" --experimental-test-coverage --test-reporter=lcov --test-reporter-destination=lcov.info"
 fi
 
 # Execute the node command with the expanded list of files

package/src/pikku-cli-config.ts

@@ -83,6 +83,8 @@ export type PikkuCLIConfig = {
 
   middlewareServices?: string[]
 
+  schemasFromTypes?: string[]
+
   filters: InspectorFilters
 } & PikkuCLICoreOutputFiles
 

package/src/pikku-command-schemas.ts

@@ -4,7 +4,7 @@ import { PikkuCommand } from './types.js'
 
 export const pikkuSchemas: PikkuCommand = async (
   logger,
-  { tsconfig, schemaDirectory, supportsImportAttributes },
+  { tsconfig, schemaDirectory, supportsImportAttributes, schemasFromTypes },
   { functions, http }
 ) => {
   return await logCommandInfoAndTime(
@@ -18,7 +18,8 @@ export const pikkuSchemas: PikkuCommand = async (
         tsconfig,
         functions.typesMap,
         functions.meta,
-        http.meta
+        http.meta,
+        schemasFromTypes
       )
       await saveSchemas(
         logger,
@@ -26,7 +27,8 @@ export const pikkuSchemas: PikkuCommand = async (
         schemas,
         functions.typesMap,
         functions.meta,
-        supportsImportAttributes
+        supportsImportAttributes,
+        schemasFromTypes
       )
     }
   )

package/src/schema-generator.ts

@@ -10,7 +10,8 @@ export async function generateSchemas(
   tsconfig: string,
   typesMap: TypesMap,
   functionMeta: FunctionsMeta,
-  httpWiringsMeta: HTTPWiringsMeta
+  httpWiringsMeta: HTTPWiringsMeta,
+  additionalTypes?: string[]
 ): Promise<Record<string, JSONValue>> {
   const schemasSet = new Set(typesMap.customTypes.keys())
   for (const { inputs, outputs } of Object.values(functionMeta)) {
@@ -37,6 +38,13 @@ export async function generateSchemas(
     }
   }
 
+  // Add additional types from schemasFromTypes config
+  if (additionalTypes) {
+    for (const type of additionalTypes) {
+      schemasSet.add(type)
+    }
+  }
+
   const generator = createGenerator({
     tsconfig,
     skipTypeCheck: true,
@@ -72,7 +80,8 @@ export async function saveSchemas(
   schemas: Record<string, JSONValue>,
   typesMap: TypesMap,
   functionsMeta: FunctionsMeta,
-  supportsImportAttributes: boolean
+  supportsImportAttributes: boolean,
+  additionalTypes?: string[]
 ) {
   await writeFileInDir(
     logger,
@@ -80,7 +89,7 @@ export async function saveSchemas(
     'export const empty = null;'
   )
 
-  const desiredSchemas = new Set([
+  const desiredSchemas = new Set<string>([
     ...Object.values(functionsMeta)
       .map(({ inputs, outputs }) => [
         inputs?.[0] ? typesMap.getUniqueName(inputs[0]) : undefined,
@@ -88,11 +97,12 @@ export async function saveSchemas(
       ])
       .flat()
       .filter(
-        (s) =>
+        (s): s is string =>
           !!s &&
           !['boolean', 'string', 'number', 'null', 'undefined'].includes(s)
       ),
     ...typesMap.customTypes.keys(),
+    ...(additionalTypes || []),
   ])
 
   if (desiredSchemas.size === 0) {
@@ -113,7 +123,12 @@ export async function saveSchemas(
     })
   )
 
-  const schemaImports = Array.from(desiredSchemas)
+  // Only include schemas that were successfully generated
+  const availableSchemas = Array.from(desiredSchemas).filter(
+    (schema) => schemas[schema]
+  )
+
+  const schemaImports = availableSchemas
     .map(
       (schema) => `
 import * as ${schema} from './schemas/${schema}.schema.json' ${supportsImportAttributes ? `with { type: 'json' }` : ''}

package/src/schemas.ts

@@ -4,7 +4,7 @@ import { PikkuCommand } from './types.js'
 
 export const pikkuSchemas: PikkuCommand = async (
   logger,
-  { tsconfig, schemaDirectory, supportsImportAttributes },
+  { tsconfig, schemaDirectory, supportsImportAttributes, schemasFromTypes },
   { functions, http }
 ) => {
   return await logCommandInfoAndTime(
@@ -18,7 +18,8 @@ export const pikkuSchemas: PikkuCommand = async (
         tsconfig,
         functions.typesMap,
         functions.meta,
-        http.meta
+        http.meta,
+        schemasFromTypes
       )
       await saveSchemas(
         logger,
@@ -26,7 +27,8 @@ export const pikkuSchemas: PikkuCommand = async (
         schemas,
         functions.typesMap,
         functions.meta,
-        supportsImportAttributes
+        supportsImportAttributes,
+        schemasFromTypes
       )
     }
   )

package/src/wirings/http/pikku-command-openapi.ts

@@ -6,7 +6,7 @@ import { PikkuCommand } from '../../types.js'
 
 export const pikkuOpenAPI: PikkuCommand = async (
   logger,
-  { tsconfig, openAPI },
+  { tsconfig, openAPI, schemasFromTypes },
   { http, functions }
 ) => {
   return await logCommandInfoAndTime(
@@ -23,7 +23,8 @@ export const pikkuOpenAPI: PikkuCommand = async (
         tsconfig,
         functions.typesMap,
         functions.meta,
-        http.meta
+        http.meta,
+        schemasFromTypes
       )
       const openAPISpec = await generateOpenAPISpec(
         functions.meta,