@tsed/schema 8.20.1 → 8.22.0

package/lib/esm/domain/JsonSchema.js

@@ -872,6 +872,65 @@ export class JsonSchema extends Map {
         super.set("properties", this.mapProperties(properties));
         return this;
     }
+    pick(...keys) {
+        const keySet = new Set(keys.map((key) => toJsonRegex(key)));
+        const schema = this.clone();
+        const properties = Object.entries(schema.get("properties")).reduce((properties, [key, value]) => {
+            if (keySet.has(key)) {
+                return {
+                    ...properties,
+                    [key]: value
+                };
+            }
+            return properties;
+        }, {});
+        schema.set("properties", properties);
+        schema.#required = new Set([...schema.#required].filter((key) => keySet.has(key)));
+        return schema;
+    }
+    omit(...keys) {
+        const keySet = new Set(keys.map((key) => toJsonRegex(key)));
+        const schema = this.clone();
+        const properties = Object.entries(schema.get("properties")).reduce((properties, [key, value]) => {
+            if (!keySet.has(key)) {
+                return {
+                    ...properties,
+                    [key]: value
+                };
+            }
+            return properties;
+        }, {});
+        schema.set("properties", properties);
+        keySet.forEach((key) => schema.#required.delete(key));
+        return schema;
+    }
+    partial() {
+        const schema = this.clone();
+        const properties = schema.get("properties");
+        if (properties) {
+            const partialProps = Object.entries(properties).reduce((acc, [key, value]) => {
+                if (value instanceof JsonSchema && value.$selfRequired) {
+                    acc[key] = value.required(false);
+                }
+                else {
+                    acc[key] = value;
+                }
+                return acc;
+            }, {});
+            schema.set("properties", partialProps);
+        }
+        schema.#required.clear();
+        return schema;
+    }
+    merge(schema) {
+        const cloned = this.clone();
+        const currentProperties = { ...(cloned.get("properties") || {}) };
+        const incoming = schema.get("properties") || {};
+        Object.assign(currentProperties, incoming);
+        schema.getRequiredFields().forEach((field) => cloned.#required.add(field));
+        cloned.properties(currentProperties);
+        return cloned;
+    }
     addProperty(key, schema) {
         const properties = this.get("properties") || {};
         properties[key] = schema;
@@ -1210,7 +1269,24 @@ export class JsonSchema extends Map {
     }
     assign(obj) {
         const entries = obj instanceof JsonSchema ? [...obj.entries()] : Object.entries(obj);
+        const clone = (value) => (value instanceof JsonSchema ? value.clone() : value);
         entries.forEach(([key, value]) => {
+            if (obj instanceof JsonSchema) {
+                // deep clone
+                if (key === "properties") {
+                    value = Object.fromEntries(Object.entries(value).map(([key, value]) => {
+                        return [key, clone(value)];
+                    }));
+                }
+                else if (key === "items") {
+                    if (!obj.isNullable) {
+                        value = clone(value);
+                    }
+                }
+                else if (key === "additionalProperties") {
+                    value = clone(value);
+                }
+            }
             this.set(key, value);
         });
         if (obj instanceof JsonSchema) {
@@ -1226,6 +1302,9 @@ export class JsonSchema extends Map {
             this.#target = obj.#target;
             this.#isCollection = obj.#isCollection;
             this.#isLocalSchema = obj.#isLocalSchema;
+            if (obj.#isLocalSchema && obj.#itemSchema) {
+                this.#itemSchema = obj.#itemSchema.clone();
+            }
             super.set("type", obj.get("type"));
         }
         return this;

package/lib/types/domain/JsonSchema.d.ts

@@ -9,7 +9,7 @@ import { AliasMap, AliasType } from "./JsonAliasMap.js";
 import { Discriminator } from "./JsonDiscriminator.js";
 import { JsonFormatTypes } from "./JsonFormatTypes.js";
 import { JsonLazyRef } from "./JsonLazyRef.js";
-import type { Infer, PropsToShape, UnionToIntersection } from "./types.js";
+import type { Infer, PropsToShape, SchemaKey, SchemaMerge, SchemaOmit, SchemaPartial, SchemaPick, UnionToIntersection } from "./types.js";
 /**
  * Extended JSON Schema object supporting TypeScript types and Ts.ED enhancements.
  *
@@ -624,6 +624,10 @@ export declare class JsonSchema<T = JSONSchema7Type> extends Map<string, any> {
      * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.18
      */
     properties<P extends Record<string, JsonSchema<any>> = Record<string, JsonSchema<any>>>(properties: P): JsonSchema<PropsToShape<P>>;
+    pick<K extends SchemaKey<T>>(...keys: K[]): JsonSchema<SchemaPick<T, K>>;
+    omit<K extends SchemaKey<T>>(...keys: K[]): JsonSchema<SchemaOmit<T, K>>;
+    partial(): JsonSchema<SchemaPartial<T>>;
+    merge<S extends JsonSchema<any>>(schema: S): JsonSchema<SchemaMerge<T, Infer<S>>>;
     addProperty(key: string, schema: AnyJsonSchema): this;
     /**
      * This attribute is an object that defines the schema for a set of property names of an object instance.

package/lib/types/domain/types.d.ts

@@ -43,6 +43,21 @@ export type Infer<S> = S extends JsonSchema<infer T> ? T : never;
 export type PropsToShape<P extends Record<string, JsonSchema<any>>> = {
     [K in keyof P]: Infer<P[K]>;
 };
+type JsonLikeObject = Record<string, any>;
+type ObjectPortion<T> = Extract<T, JsonLikeObject>;
+type NonObjectPortion<T> = Exclude<T, JsonLikeObject>;
+type ObjectPick<T, K extends PropertyKey> = Pick<ObjectPortion<T>, Extract<K, keyof ObjectPortion<T>>>;
+type ObjectOmit<T, K extends PropertyKey> = Omit<ObjectPortion<T>, Extract<K, keyof ObjectPortion<T>>>;
+type ObjectPartial<T> = {
+    [K in keyof ObjectPortion<T>]?: ObjectPortion<T>[K] | undefined;
+};
+type MergedObjectPortion<T, U> = [ObjectPortion<T>] extends [never] ? ObjectPortion<U> : [ObjectPortion<U>] extends [never] ? ObjectPortion<T> : ObjectPortion<T> & ObjectPortion<U>;
+export type SchemaPick<T, K extends PropertyKey> = [ObjectPortion<T>] extends [never] ? T : NonObjectPortion<T> extends never ? ObjectPick<T, K> : ObjectPick<T, K> | NonObjectPortion<T>;
+export type SchemaOmit<T, K extends PropertyKey> = [ObjectPortion<T>] extends [never] ? T : NonObjectPortion<T> extends never ? ObjectOmit<T, K> : ObjectOmit<T, K> | NonObjectPortion<T>;
+export type SchemaPartial<T> = [ObjectPortion<T>] extends [never] ? T : NonObjectPortion<T> extends never ? ObjectPartial<T> : ObjectPartial<T> | NonObjectPortion<T>;
+export type SchemaMerge<T, U> = [MergedObjectPortion<T, U>] extends [never] ? NonObjectPortion<T> | NonObjectPortion<U> : NonObjectPortion<T> extends never ? NonObjectPortion<U> extends never ? MergedObjectPortion<T, U> : MergedObjectPortion<T, U> | NonObjectPortion<U> : MergedObjectPortion<T, U> | NonObjectPortion<T> | NonObjectPortion<U>;
+type ObjectKeys<T> = ObjectPortion<T> extends never ? never : keyof ObjectPortion<T>;
+export type SchemaKey<T> = ObjectKeys<T> extends never ? string : Extract<ObjectKeys<T>, string>;
 /**
  * Maps common JavaScript constructors to their corresponding TypeScript types.
  *
@@ -95,3 +110,4 @@ export type CtorToType<C> = C extends StringConstructor ? string : C extends Num
  * @public
  */
 export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+export {};

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tsed/schema",
   "description": "JsonSchema module for Ts.ED Framework",
   "type": "module",
-  "version": "8.20.1",
+  "version": "8.22.0",
   "source": "./src/index.ts",
   "main": "./lib/esm/index.js",
   "module": "./lib/esm/index.js",
@@ -34,7 +34,7 @@
     "tsed"
   ],
   "dependencies": {
-    "@tsed/openspec": "8.20.1",
+    "@tsed/openspec": "8.22.0",
     "change-case": "^5.4.4",
     "json-schema": "0.4.0",
     "picomatch": "4.0.2",
@@ -43,11 +43,11 @@
   },
   "devDependencies": {
     "@apidevtools/swagger-parser": "10.1.0",
-    "@tsed/barrels": "8.20.1",
-    "@tsed/core": "8.20.1",
-    "@tsed/hooks": "8.20.1",
-    "@tsed/openspec": "8.20.1",
-    "@tsed/typescript": "8.20.1",
+    "@tsed/barrels": "8.22.0",
+    "@tsed/core": "8.22.0",
+    "@tsed/hooks": "8.22.0",
+    "@tsed/openspec": "8.22.0",
+    "@tsed/typescript": "8.22.0",
     "@types/fs-extra": "11.0.4",
     "@types/json-schema": "7.0.15",
     "@types/picomatch": "3.0.2",