@orion-js/typed-model 3.3.13 → 3.3.20

package/lib/factories/cloneSchemaClass.d.ts

@@ -1,3 +1,4 @@
+import { Model } from '@orion-js/models';
 import { CloneOptions } from '@orion-js/models';
 import { Constructor } from '../utils/interfaces';
 export interface CloneSchemaClassOptions<TClass, TFields extends keyof TClass> {
@@ -10,9 +11,13 @@ export interface CloneSchemaClassOptions<TClass, TFields extends keyof TClass> {
  * This function returns a cloned model but the type is a subset of the original Schema.
  * It will work as a Model but the type will not be the Type of the Model.
  *
- * You can use the return variable as a Model and you `typeof returnType` will be the class
- * for type checking.
- *
- * Remember that in runtime this will be a Model and not the class.
+ * Example:
+ * ```ts
+ * const ClonedModel = cloneSchemaClass(Schema, {
+ *   name: 'ClonedSchema',
+ *   pickFields: ['name'] as const
+ * })
+ * type ClonedType = typeof ClonedModel.type
+ * ```
  */
-export declare function cloneSchemaClass<TClass, TFields extends keyof TClass>(schema: Constructor<TClass>, options: CloneSchemaClassOptions<TClass, TFields>): Pick<TClass, TFields>;
+export declare function cloneSchemaClass<TClass, TFields extends keyof TClass>(schema: Constructor<TClass>, options: CloneSchemaClassOptions<TClass, TFields>): Model<Pick<TClass, TFields>>;

package/lib/factories/cloneSchemaClass.js

@@ -6,10 +6,14 @@ const getModelForClass_1 = require("./getModelForClass");
  * This function returns a cloned model but the type is a subset of the original Schema.
  * It will work as a Model but the type will not be the Type of the Model.
  *
- * You can use the return variable as a Model and you `typeof returnType` will be the class
- * for type checking.
- *
- * Remember that in runtime this will be a Model and not the class.
+ * Example:
+ * ```ts
+ * const ClonedModel = cloneSchemaClass(Schema, {
+ *   name: 'ClonedSchema',
+ *   pickFields: ['name'] as const
+ * })
+ * type ClonedType = typeof ClonedModel.type
+ * ```
  */
 function cloneSchemaClass(schema, options) {
     const model = (0, getModelForClass_1.getModelForClass)(schema);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orion-js/typed-model",
-  "version": "3.3.13",
+  "version": "3.3.20",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [
@@ -17,11 +17,11 @@
     "test": "jest --config jest.config.js"
   },
   "dependencies": {
-    "@orion-js/helpers": "^3.3.6",
-    "@orion-js/models": "^3.3.13",
-    "@orion-js/resolvers": "^3.3.13",
-    "@orion-js/schema": "^3.3.13",
-    "@orion-js/services": "^3.3.6",
+    "@orion-js/helpers": "^3.3.20",
+    "@orion-js/models": "^3.3.20",
+    "@orion-js/resolvers": "^3.3.20",
+    "@orion-js/schema": "^3.3.20",
+    "@orion-js/services": "^3.3.20",
     "lodash": "^4.17.21",
     "reflect-metadata": "0.1.13"
   },
@@ -41,5 +41,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8b63161dd4c14fa182571eb46a7fb87a67895a07"
+  "gitHead": "fc4d8447758abffb74834f58443e7489cee3a454"
 }