@orion-js/typed-model 4.0.0-alpha.3 → 4.0.0-next.0

package/dist/index.cjs

@@ -196,7 +196,7 @@ class PropertyAlreadyExistsError extends Error {
     super(`Schema with name "${schemaName}" already contains property "${propertyName}".`);
   }
 }
-// ../helpers/dist/index.js
+// node_modules/@orion-js/helpers/dist/index.js
 var import_node_module = require("node:module");
 var import_crypto = __toESM(require("crypto"));
 var __create2 = Object.create;
@@ -1821,7 +1821,7 @@ function getSchemaForClassRecursive(target) {
 function getSchemaForClass(target) {
   return getSchemaForClassRecursive(target);
 }
-// ../models/dist/index.js
+// node_modules/@orion-js/models/dist/index.js
 var __create3 = Object.create;
 var __getProtoOf3 = Object.getPrototypeOf;
 var __defProp3 = Object.defineProperty;

package/dist/index.d.ts

@@ -1,476 +1,29 @@
 // Generated by dts-bundle-generator v9.5.1
 
-// Generated by dts-bundle-generator v9.5.1
-// Generated by dts-bundle-generator v9.5.1
-// Generated by dts-bundle-generator v9.5.1
-export interface StoredCacheData {
-	value: any;
-	expires?: Date;
-}
-export interface SetCacheOptions {
-	ttl?: number;
-}
-export interface GetCacheOptions {
-	ttl?: number;
-	fallback?(): Promise<any>;
-}
-export interface OrionCache {
-	/**
-	 * Save data in the cache
-	 */
-	set(key: string, value: any, options?: SetCacheOptions): Promise<void> | void;
-	/**
-	 * Get data from the cache
-	 */
-	get(key: string, options?: GetCacheOptions): Promise<StoredCacheData>;
-	/**
-	 * Removes data from the cache
-	 */
-	invalidate(key: string): Promise<void> | void;
-}
-export type Blackbox = {
-	[name: string]: any;
-};
-export type ModelResolverResolve = (item: any, params: any, viewer: any, info?: any) => Promise<any>;
-export type GlobalCheckPermissions = (params: any, viewer: any, info?: any) => Promise<string | void>;
-export type ModelCheckPermissions = (parent: any, params: any, viewer: any, info?: any) => Promise<string | void>;
-export type GlobalGetCacheKey = (params: any, viewer: any, info: any) => Promise<any>;
-export type ModelGetCacheKey = (parent: any, params: any, viewer: any, info: any) => Promise<any>;
-export interface ExecuteOptions {
-	params: Blackbox;
-	viewer: any;
-	parent?: any;
-	info?: any;
-	options: ResolverOptions;
-}
-export type Parameters$1<T> = T extends (...args: infer P) => any ? P : never;
-export type ReturnType$1<T> = T extends (...args: any) => infer R ? R : any;
-export type ResolverParams<Resolve, IsModel> = IsModel extends undefined ? Parameters$1<Resolve>[0] : Parameters$1<Resolve>[1];
-export interface ExecuteParams<Resolve = Function, IsModel = undefined> {
-	params?: ResolverParams<Resolve, IsModel>;
-	viewer?: any;
-	parent?: IsModel extends undefined ? undefined : Parameters$1<Resolve>[0];
-	info?: any;
-}
-export type Execute<Resolve = Function, IsModel = undefined> = (executeOptions: ExecuteParams<Resolve, IsModel>) => ReturnType$1<Resolve>;
-export interface SharedResolverOptions {
-	resolverId?: string;
-	params?: any;
-	returns?: any;
-	mutation?: boolean;
-	private?: boolean;
-	checkPermission?: GlobalCheckPermissions | ModelCheckPermissions;
-	getCacheKey?: GlobalGetCacheKey | ModelGetCacheKey;
-	cache?: number;
-	cacheProvider?: OrionCache;
-	permissionsOptions?: any;
-	middlewares?: ResolverMiddleware[];
-}
-export interface ResolverOptions<Resolve = Function> extends SharedResolverOptions {
-	resolve: Resolve;
-}
-export type OmitFirstArg<F> = F extends (x: any, ...args: infer P) => infer R ? (...args: P) => R : never;
-export interface Resolver<Resolve = Function, IsModel = undefined> extends SharedResolverOptions {
-	execute: Execute<Resolve, IsModel>;
-	resolve: Resolve;
-	modelResolve: IsModel extends undefined ? undefined : OmitFirstArg<Resolve>;
-}
-export type ModelResolver<Resolve = Function> = Resolver<Resolve, true>;
-export type ResolverMiddleware = (executeOptions: ExecuteOptions, next: () => Promise<any>) => Promise<any>;
-export interface FieldType {
-	name: string;
-	validate: ValidateFunction;
-	clean: CleanFunction;
-	meta?: any;
-	toGraphQLType?: (GraphQL: any) => any;
-	_isFieldType: boolean;
-}
-export type Constructor<T> = new (...args: any[]) => T;
-export type FieldTypesList = "string" | "date" | "integer" | "number" | "ID" | "boolean" | "email" | "blackbox" | "any";
-export type TypedModelOnSchema = Function;
-export type ConstructorsTypesList = Constructor<String> | Constructor<Number> | Constructor<Boolean> | Constructor<Date>;
-export type SchemaRecursiveNodeTypeExtras = {
-	_isFieldType?: boolean;
-	__clean?: CleanFunction;
-	__validate?: ValidateFunction;
-	__skipChildValidation?: (value: any, info: CurrentNodeInfo) => Promise<boolean>;
-};
-export interface Schema {
-	[key: string]: SchemaNode | Function;
-}
-export type SchemaRecursiveNodeType = Schema & SchemaRecursiveNodeTypeExtras;
-export type SchemaMetaFieldTypeSingle = FieldTypesList | ConstructorsTypesList | SchemaRecursiveNodeType | FieldType | TypedModelOnSchema;
-export type SchemaMetaFieldType = SchemaMetaFieldTypeSingle | SchemaMetaFieldTypeSingle[];
-export type ValidateFunction = (value: any, info?: Partial<CurrentNodeInfo>, ...args: any[]) => object | string | void | Promise<object | string | void>;
-export type CleanFunction = (value: any, info?: Partial<CurrentNodeInfo>, ...args: any[]) => any | Promise<any>;
-export interface SchemaNode {
-	/**
-	 * The type of the field. Used for type validations. Can also contain a subschema.
-	 */
-	type: SchemaMetaFieldType;
-	/**
-	 * Defaults to false
-	 */
-	optional?: boolean;
-	allowedValues?: Array<any>;
-	defaultValue?: ((info: CurrentNodeInfo, ...args: any[]) => any | Promise<any>) | any;
-	/**
-	 * Function that takes a value and returns an error message if there are any errors. Must return null or undefined otherwise.
-	 */
-	validate?: ValidateFunction;
-	/**
-	 * Function that preprocesses a value before it is set.
-	 */
-	clean?: CleanFunction;
-	autoValue?: (value: any, info: CurrentNodeInfo, ...args: any[]) => any | Promise<any>;
-	/**
-	 * The minimum value if it's a number, the minimum length if it's a string or array.
-	 */
-	min?: number;
-	/**
-	 * The maximum value if it's a number, the maximum length if it's a string or array.
-	 */
-	max?: number;
-	/**
-	 * Internal use only.
-	 */
-	isBlackboxChild?: boolean;
-	/**
-	 * @deprecated
-	 */
-	custom?: ValidateFunction;
-	/**
-	 * Used in GraphQL. If true, the field will be omitted from the schema.
-	 */
-	private?: boolean;
-	/**
-	 * Used in GraphQL. When in GraphQL, this resolver will replace the static field.
-	 */
-	graphQLResolver?: (...args: any) => any;
-	/**
-	 * Used in GraphQL. Sets the key of the field in the GraphQL schema. You must set this value when building your schema.
-	 */
-	key?: string;
-	/**
-	 * The name that would be displayed in a front-end form
-	 */
-	label?: string;
-	/**
-	 * The description that would be displayed in a front-end form
-	 */
-	description?: string;
-	/**
-	 * The placeholder that would be displayed in a front-end form
-	 */
-	placeholder?: string;
-	/**
-	 * The field type that would be used in a front-end form
-	 */
-	fieldType?: string;
-	/**
-	 * The field options that will be passed as props to the front-end field
-	 */
-	fieldOptions?: any;
-}
-export interface CurrentNodeInfoOptions {
-	autoConvert?: boolean;
-	filter?: boolean;
-	trimStrings?: boolean;
-	removeEmptyStrings?: boolean;
-	forceDoc?: any;
-	omitRequired?: boolean;
-}
-export interface CurrentNodeInfo {
-	/**
-	 * The global schema, prefaced by {type: {...}} to be compatible with subschemas
-	 * Sometimes it's given without {type: {...}}. TODO: Normalize this.
-	 */
-	schema?: SchemaNode | Schema;
-	/**
-	 * The current node subschema
-	 */
-	currentSchema?: Partial<SchemaNode>;
-	value: any;
-	doc?: any;
-	currentDoc?: any;
-	options?: CurrentNodeInfoOptions;
-	args?: any[];
-	type?: SchemaMetaFieldType;
-	keys?: string[];
-	addError?: (keys: string[], code: string | object) => void;
-}
-export interface ModelResolversMap {
-	[key: string]: ModelResolver<ModelResolverResolve>;
-}
-export interface CloneOptions {
-	name: string;
-	omitFields?: string[];
-	pickFields?: string[];
-	mapFields?: (field: any, key: string) => any;
-	extendSchema?: Schema;
-	extendResolvers?: ModelResolversMap;
-}
-export interface Model<TSchema = any> {
-	__isModel: boolean;
-	/**
-	 * The name of the model, used for example for GraphQL
-	 */
-	name: string;
-	/**
-	 * Returns the schema of the model
-	 */
-	getSchema: () => Schema & {
-		__model: Model;
-	};
-	/**
-	 * Returns the schema without adding __model to the schema
-	 */
-	getCleanSchema: () => Schema;
-	/**
-	 * Returns the model resolvers
-	 */
-	getResolvers: () => ModelResolversMap;
-	/**
-	 * Adds the model resolvers to a item
-	 */
-	initItem: (item: any) => any;
-	/**
-	 * Validates an item using @orion-js/schema
-	 */
-	validate: (item: any) => Promise<any>;
-	/**
-	 * Cleans an item using @orion-js/schema
-	 */
-	clean: (item: any) => Promise<TSchema>;
-	/**
-	 * Cleans and validates an item using @orion-js/schema
-	 */
-	cleanAndValidate: (item: any) => Promise<TSchema>;
-	/**
-	 * Creates a new model using this one as a base
-	 */
-	clone: (cloneOptions: CloneOptions) => Model;
-	/**
-	 * The type of the model. Only use this in typescript
-	 */
-	type: TSchema;
-}
-interface StoredCacheData$1 {
-	value: any;
-	expires?: Date;
-}
-interface SetCacheOptions$1 {
-	ttl?: number;
-}
-interface GetCacheOptions$1 {
-	ttl?: number;
-	fallback?(): Promise<any>;
-}
-interface OrionCache$1 {
-	/**
-	 * Save data in the cache
-	 */
-	set(key: string, value: any, options?: SetCacheOptions$1): Promise<void> | void;
-	/**
-	 * Get data from the cache
-	 */
-	get(key: string, options?: GetCacheOptions$1): Promise<StoredCacheData$1>;
-	/**
-	 * Removes data from the cache
-	 */
-	invalidate(key: string): Promise<void> | void;
-}
-type Blackbox$1 = {
-	[name: string]: any;
-};
-type ModelResolverResolve$1 = (item: any, params: any, viewer: any, info?: any) => Promise<any>;
-type GlobalCheckPermissions$1 = (params: any, viewer: any, info?: any) => Promise<string | void>;
-type ModelCheckPermissions$1 = (parent: any, params: any, viewer: any, info?: any) => Promise<string | void>;
-type GlobalGetCacheKey$1 = (params: any, viewer: any, info: any) => Promise<any>;
-type ModelGetCacheKey$1 = (parent: any, params: any, viewer: any, info: any) => Promise<any>;
-interface ExecuteOptions$1 {
-	params: Blackbox$1;
-	viewer: any;
-	parent?: any;
-	info?: any;
-	options: ResolverOptions$1;
-}
-type Parameters$1$1<T> = T extends (...args: infer P) => any ? P : never;
-type ReturnType$1$1<T> = T extends (...args: any) => infer R ? R : any;
-type ResolverParams$1<Resolve, IsModel> = IsModel extends undefined ? Parameters$1$1<Resolve>[0] : Parameters$1$1<Resolve>[1];
-interface ExecuteParams$1<Resolve = Function, IsModel = undefined> {
-	params?: ResolverParams$1<Resolve, IsModel>;
-	viewer?: any;
-	parent?: IsModel extends undefined ? undefined : Parameters$1$1<Resolve>[0];
-	info?: any;
-}
-type Execute$1<Resolve = Function, IsModel = undefined> = (executeOptions: ExecuteParams$1<Resolve, IsModel>) => ReturnType$1$1<Resolve>;
-interface SharedResolverOptions$1 {
-	resolverId?: string;
-	params?: any;
-	returns?: any;
-	mutation?: boolean;
-	private?: boolean;
-	checkPermission?: GlobalCheckPermissions$1 | ModelCheckPermissions$1;
-	getCacheKey?: GlobalGetCacheKey$1 | ModelGetCacheKey$1;
-	cache?: number;
-	cacheProvider?: OrionCache$1;
-	permissionsOptions?: any;
-	middlewares?: ResolverMiddleware$1[];
-}
-interface ResolverOptions$1<Resolve = Function> extends SharedResolverOptions$1 {
-	resolve: Resolve;
-}
-type OmitFirstArg$1<F> = F extends (x: any, ...args: infer P) => infer R ? (...args: P) => R : never;
-interface Resolver$1<Resolve = Function, IsModel = undefined> extends SharedResolverOptions$1 {
-	execute: Execute$1<Resolve, IsModel>;
-	resolve: Resolve;
-	modelResolve: IsModel extends undefined ? undefined : OmitFirstArg$1<Resolve>;
-}
-type ModelResolver$1<Resolve = Function> = Resolver$1<Resolve, true>;
-type ResolverMiddleware$1 = (executeOptions: ExecuteOptions$1, next: () => Promise<any>) => Promise<any>;
+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;
-interface FieldType$1 {
-	name: string;
-	validate: ValidateFunction$1;
-	clean: CleanFunction$1;
-	meta?: any;
-	toGraphQLType?: (GraphQL: any) => any;
-	_isFieldType: boolean;
-}
-type Constructor$1<T> = new (...args: any[]) => T;
-type FieldTypesList$1 = "string" | "date" | "integer" | "number" | "ID" | "boolean" | "email" | "blackbox" | "any";
-type TypedModelOnSchema$1 = Function;
-type ConstructorsTypesList$1 = Constructor$1<String> | Constructor$1<Number> | Constructor$1<Boolean> | Constructor$1<Date>;
-type SchemaRecursiveNodeTypeExtras$1 = {
-	_isFieldType?: boolean;
-	__clean?: CleanFunction$1;
-	__validate?: ValidateFunction$1;
-	__skipChildValidation?: (value: any, info: CurrentNodeInfo$1) => Promise<boolean>;
-};
-interface Schema$1 {
-	[key: string]: SchemaNode$1 | Function;
-}
-type SchemaRecursiveNodeType$1 = Schema$1 & SchemaRecursiveNodeTypeExtras$1;
-type SchemaMetaFieldTypeSingle$1 = FieldTypesList$1 | ConstructorsTypesList$1 | SchemaRecursiveNodeType$1 | FieldType$1 | TypedModelOnSchema$1;
-type SchemaMetaFieldType$1 = SchemaMetaFieldTypeSingle$1 | SchemaMetaFieldTypeSingle$1[];
-type ValidateFunction$1 = (value: any, info?: Partial<CurrentNodeInfo$1>, ...args: any[]) => object | string | void | Promise<object | string | void>;
-type CleanFunction$1 = (value: any, info?: Partial<CurrentNodeInfo$1>, ...args: any[]) => any | Promise<any>;
-interface SchemaNode$1 {
-	/**
-	 * The type of the field. Used for type validations. Can also contain a subschema.
-	 */
-	type: SchemaMetaFieldType$1;
-	/**
-	 * Defaults to false
-	 */
-	optional?: boolean;
-	allowedValues?: Array<any>;
-	defaultValue?: ((info: CurrentNodeInfo$1, ...args: any[]) => any | Promise<any>) | any;
-	/**
-	 * Function that takes a value and returns an error message if there are any errors. Must return null or undefined otherwise.
-	 */
-	validate?: ValidateFunction$1;
-	/**
-	 * Function that preprocesses a value before it is set.
-	 */
-	clean?: CleanFunction$1;
-	autoValue?: (value: any, info: CurrentNodeInfo$1, ...args: any[]) => any | Promise<any>;
-	/**
-	 * The minimum value if it's a number, the minimum length if it's a string or array.
-	 */
-	min?: number;
-	/**
-	 * The maximum value if it's a number, the maximum length if it's a string or array.
-	 */
-	max?: number;
-	/**
-	 * Internal use only.
-	 */
-	isBlackboxChild?: boolean;
-	/**
-	 * @deprecated
-	 */
-	custom?: ValidateFunction$1;
-	/**
-	 * Used in GraphQL. If true, the field will be omitted from the schema.
-	 */
-	private?: boolean;
-	/**
-	 * Used in GraphQL. When in GraphQL, this resolver will replace the static field.
-	 */
-	graphQLResolver?: (...args: any) => any;
-	/**
-	 * Used in GraphQL. Sets the key of the field in the GraphQL schema. You must set this value when building your schema.
-	 */
-	key?: string;
-	/**
-	 * The name that would be displayed in a front-end form
-	 */
-	label?: string;
-	/**
-	 * The description that would be displayed in a front-end form
-	 */
-	description?: string;
-	/**
-	 * The placeholder that would be displayed in a front-end form
-	 */
-	placeholder?: string;
-	/**
-	 * The field type that would be used in a front-end form
-	 */
-	fieldType?: string;
-	/**
-	 * The field options that will be passed as props to the front-end field
-	 */
-	fieldOptions?: any;
-}
-interface CurrentNodeInfoOptions$1 {
-	autoConvert?: boolean;
-	filter?: boolean;
-	trimStrings?: boolean;
-	removeEmptyStrings?: boolean;
-	forceDoc?: any;
-	omitRequired?: boolean;
-}
-interface CurrentNodeInfo$1 {
-	/**
-	 * The global schema, prefaced by {type: {...}} to be compatible with subschemas
-	 * Sometimes it's given without {type: {...}}. TODO: Normalize this.
-	 */
-	schema?: SchemaNode$1 | Schema$1;
-	/**
-	 * The current node subschema
-	 */
-	currentSchema?: Partial<SchemaNode$1>;
-	value: any;
-	doc?: any;
-	currentDoc?: any;
-	options?: CurrentNodeInfoOptions$1;
-	args?: any[];
-	type?: SchemaMetaFieldType$1;
-	keys?: string[];
-	addError?: (keys: string[], code: string | object) => void;
-}
-export interface SchemaNodeForClasses extends Omit<SchemaNode$1, "type"> {
-	type: SchemaMetaFieldType$1 | Constructor$1<any> | Model | Model[];
+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$1<ModelResolverResolve$1>): PropertyDecorator;
-interface Constructor$2<T> extends Function {
+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$2<TClass>): Schema$1;
-export declare function getModelForClass<TClass>(target: Constructor$2<TClass>): Model;
+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[];
@@ -490,6 +43,6 @@ export interface CloneSchemaClassOptions<TClass, TFields extends keyof TClass> {
  * type ClonedType = typeof ClonedModel.type
  * ```
  */
-export declare function cloneSchemaClass<TClass, TFields extends keyof TClass>(schema: Constructor$2<TClass>, options: CloneSchemaClassOptions<TClass, TFields>): Model<Pick<TClass, TFields>>;
+export declare function cloneSchemaClass<TClass, TFields extends keyof TClass>(schema: Constructor$1<TClass>, options: CloneSchemaClassOptions<TClass, TFields>): Model<Pick<TClass, TFields>>;
 
 export {};

package/dist/index.js

@@ -159,7 +159,7 @@ class PropertyAlreadyExistsError extends Error {
     super(`Schema with name "${schemaName}" already contains property "${propertyName}".`);
   }
 }
-// ../helpers/dist/index.js
+// node_modules/@orion-js/helpers/dist/index.js
 import { createRequire } from "node:module";
 import crypto2 from "crypto";
 var __create2 = Object.create;
@@ -1784,7 +1784,7 @@ function getSchemaForClassRecursive(target) {
 function getSchemaForClass(target) {
   return getSchemaForClassRecursive(target);
 }
-// ../models/dist/index.js
+// node_modules/@orion-js/models/dist/index.js
 var __create3 = Object.create;
 var __getProtoOf3 = Object.getPrototypeOf;
 var __defProp3 = Object.defineProperty;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orion-js/typed-model",
-  "version": "4.0.0-alpha.3",
+  "version": "4.0.0-next.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -22,11 +22,11 @@
     "clean": "rm -rf ./dist"
   },
   "dependencies": {
-    "@orion-js/helpers": "^4.0.0-alpha.2",
-    "@orion-js/models": "^4.0.0-alpha.2",
-    "@orion-js/resolvers": "^4.0.0-alpha.2",
-    "@orion-js/schema": "^4.0.0-alpha.2",
-    "@orion-js/services": "^4.0.0-alpha.2",
+    "@orion-js/helpers": "4.0.0-next.0",
+    "@orion-js/models": "4.0.0-next.0",
+    "@orion-js/resolvers": "4.0.0-next.0",
+    "@orion-js/schema": "4.0.0-next.0",
+    "@orion-js/services": "4.0.0-next.0",
     "lodash": "^4.17.21",
     "reflect-metadata": "0.1.13"
   },