@orion-js/typed-model 3.11.15 → 3.12.0

package/dist/index.d.ts

@@ -0,0 +1,48 @@
+// Generated by dts-bundle-generator v9.5.1
+
+import { CloneOptions, Model } from '@orion-js/models';
+import { ModelResolver, ModelResolverResolve } from '@orion-js/resolvers';
+import { Constructor, Schema, SchemaMetaFieldType, SchemaNode } from '@orion-js/schema';
+
+export type TypedModelOptions = Record<string, never>;
+/**
+ * @deprecated Please use @TypedSchema instead
+ */
+export declare function TypedModel(options?: TypedModelOptions): ClassDecorator;
+export declare function TypedSchema(options?: TypedModelOptions): ClassDecorator;
+export interface SchemaNodeForClasses extends Omit<SchemaNode, "type"> {
+	type: SchemaMetaFieldType | Constructor<any> | Model | Model[];
+}
+export type PropOptions = Partial<SchemaNodeForClasses>;
+export declare function Prop(options?: PropOptions): PropertyDecorator;
+/**
+ * @deprecated Please use a @TypedSchema and a @Model a @ModelResolver instead
+ */
+export declare function ResolverProp(options: ModelResolver<ModelResolverResolve>): PropertyDecorator;
+interface Constructor$1<T> extends Function {
+	new (...args: unknown[]): T;
+}
+export declare function getSchemaForClass<TClass>(target: Constructor$1<TClass>): Schema;
+export declare function getModelForClass<TClass>(target: Constructor$1<TClass>): Model;
+export interface CloneSchemaClassOptions<TClass, TFields extends keyof TClass> {
+	name: string;
+	pickFields: readonly TFields[];
+	mapFields?: CloneOptions["mapFields"];
+	extendSchema?: CloneOptions["extendSchema"];
+}
+/**
+ * This function returns a cloned model but the type is a subset of the original Schema.
+ * To use the type of the cloned schema use `typeof ClonedModel.type`
+ *
+ * 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$1<TClass>, options: CloneSchemaClassOptions<TClass, TFields>): Model<Pick<TClass, TFields>>;
+
+export {};