@takeshape/json-schema 11.64.0 → 11.69.0

package/dist/converters/__tests__/schema-converter.test.js

@@ -262,7 +262,7 @@ describe('SchemaConverter', () => {
             expect(result.stats).toEqual({ propertiesCount: 1, stringLength: 4695, enumValuesCount: 600 });
             expect(result.warnings.length).toEqual(0);
         });
-        test('removes keys matching removePropertyKeyPatterns', () => {
+        test('removes keys not included in propertyKeys', () => {
             const exampleSchema = {
                 type: 'object',
                 properties: {
@@ -274,7 +274,7 @@ describe('SchemaConverter', () => {
             };
             const result = SchemaConverter.convert(exampleSchema, {
                 target: SchemaConversionTarget.JSONSchema,
-                removePropertyKeyPatterns: ['_*']
+                propertyFilter: (key) => key === 'id' || key === 'name'
             });
             expect(result.schema).toEqual({
                 properties: {
@@ -408,7 +408,7 @@ describe('SchemaConverter', () => {
             const result = SchemaConverter.convert(searchShapeSchemaJson, {
                 target: SchemaConversionTarget.JSONSchema,
                 inlineDefinitions: false,
-                removePropertyKeyPatterns: ['_*', 'where']
+                propertyFilter: (key) => !key.startsWith('_') && key !== 'where'
             });
             expect(result.stats).toEqual({ propertiesCount: 10, stringLength: 87, enumValuesCount: 0 });
             expect(result.warnings).toEqual([]);
@@ -882,7 +882,7 @@ describe('SchemaConverter', () => {
             };
             const result = SchemaConverter.convert(exampleSchema, {
                 target: SchemaConversionTarget.OpenAI,
-                removePropertyKeyPatterns: ['_*']
+                propertyFilter: (key) => key === 'id' || key === 'name'
             });
             expect(result.schema).toEqual({
                 additionalProperties: false,
@@ -1043,7 +1043,7 @@ describe('SchemaConverter', () => {
             const result = SchemaConverter.convert(searchShapeSchemaJson, {
                 target: SchemaConversionTarget.OpenAI,
                 inlineDefinitions: false,
-                removePropertyKeyPatterns: ['_*', 'where']
+                propertyFilter: (key) => !key.startsWith('_') && key !== 'where'
             });
             expect(result.stats).toEqual({ propertiesCount: 10, stringLength: 87, enumValuesCount: 0 });
             expect(result.warnings).toEqual([]);

package/dist/converters/schema-converter.d.ts

@@ -19,9 +19,9 @@ export type SchemaConversionOptions = {
      */
     target?: SchemaConversionTarget;
     /**
-     * Accepts minimatch patterns of keys to remove
+     * Keys to include
      */
-    removePropertyKeyPatterns?: string[];
+    propertyFilter?: (key: string) => boolean;
     /**
      * @default false
      */

package/dist/converters/schema-converter.js

@@ -1,7 +1,6 @@
 import { assert, ensureArray } from '@takeshape/util';
 import intersection from 'lodash/intersection.js';
 import uniq from 'lodash/uniq.js';
-import { Minimatch } from 'minimatch';
 import { getReferenceMap, isAllOfSchema, isAnyOfSchema, isArraySchema, isEnumSchema, isListSchema, isObjectSchema, isOneOfSchema, isPropertySchema, isRefSchema, isTupleSchema, pickJSONSchema7 } from "../utils/index.js";
 export var SchemaConversionTarget;
 (function (SchemaConversionTarget) {
@@ -30,12 +29,12 @@ export class SchemaConverter {
         return new SchemaConverter(schema, options).run();
     }
     constructor(originalSchema, options = {}) {
-        const { removePropertyKeyPatterns, target = SchemaConversionTarget.JSONSchema, inlineDefinitions = false, maxDepth = 5, allowUnknownKeys = false } = options;
+        const { propertyFilter, target = SchemaConversionTarget.JSONSchema, inlineDefinitions = false, maxDepth = 5, allowUnknownKeys = false } = options;
         this.#config = {
             target,
             maxDepth,
             allowUnknownKeys,
-            removePropertyKeyPatterns: removePropertyKeyPatterns?.map((pattern) => new Minimatch(pattern)) ?? [],
+            propertyFilter,
             inlineDefinitions
         };
         const { $defs, definitions, ...schema } = originalSchema;
@@ -280,7 +279,7 @@ export class SchemaConverter {
     }
     processObjectSchema(context, schema) {
         const { depth, path, processingMode } = context;
-        const { target, removePropertyKeyPatterns } = this.#config;
+        const { target, propertyFilter } = this.#config;
         const newSchema = this.initializeNewSchema(schema, {
             type: 'object'
         });
@@ -290,8 +289,8 @@ export class SchemaConverter {
         if (schema.properties) {
             // Process each property
             for (const [key, property] of Object.entries(schema.properties)) {
-                // Skip properties that match removePropertyKeyPatterns
-                if (removePropertyKeyPatterns.length && removePropertyKeyPatterns.some((pattern) => pattern.match(key))) {
+                // Skip properties that are not in propertyKeys
+                if (propertyFilter && !propertyFilter(key)) {
                     continue;
                 }
                 newSchemaProperties[key] = this.processSchema({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@takeshape/json-schema",
-  "version": "11.64.0",
+  "version": "11.69.0",
   "description": "JSON Schema validator",
   "homepage": "https://www.takeshape.io",
   "repository": {
@@ -38,7 +38,7 @@
     "ajv-formats": "3.0.1",
     "lodash": "^4.17.21",
     "minimatch": "^3.0.4",
-    "@takeshape/util": "11.64.0"
+    "@takeshape/util": "11.69.0"
   },
   "devDependencies": {
     "@types/json-schema": "^7.0.7",