@orion-js/models 4.3.1 → 4.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Orionjs Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/createModel/clone.d.ts

@@ -0,0 +1,10 @@
+import { CreateModel, CloneOptions, CreateModelOptions, ModelResolversMap } from '../types';
+import { Schema } from '@orion-js/schema';
+interface CloneInfo {
+    createModel: CreateModel;
+    getSchema: () => Schema;
+    getResolvers: () => ModelResolversMap;
+    modelOptions: CreateModelOptions;
+}
+declare const clone: (cloneInfo: CloneInfo, options: CloneOptions) => import("..").Model<any>;
+export default clone;

package/dist/createModel/index.d.ts

@@ -0,0 +1,3 @@
+import { Model, CreateModelOptions } from '../types';
+import { Schema } from '@orion-js/schema';
+export default function createModel<TSchema extends Schema>(modelOptions: CreateModelOptions<TSchema>): Model<TSchema>;

package/dist/createModel/modelToSchema.d.ts

@@ -0,0 +1,12 @@
+import { Schema, SchemaNode } from '@orion-js/schema';
+import { ModelResolversMap } from '../types';
+export declare function processModelSchemaKey(schemaNode: SchemaNode): SchemaNode;
+interface ModelToSchemaOptions {
+    modelSchema: Schema;
+    modelName?: string;
+    cleanOptions?: any;
+    validateOptions?: any;
+    resolvers?: ModelResolversMap;
+}
+export declare function modelToSchema(options: ModelToSchemaOptions): Schema;
+export {};

package/dist/index.d.ts

@@ -1,100 +1,4 @@
-import { ModelResolver, GlobalResolver } from '@orion-js/resolvers';
-import { Schema, SchemaNode, SchemaFieldType } from '@orion-js/schema';
-
-interface ModelsSchemaNode extends Omit<SchemaNode, 'type'> {
-    type: Model | [Model] | SchemaFieldType;
-}
-interface ModelSchema {
-    [key: string]: ModelsSchemaNode;
-}
-interface CreateModelOptions<TSchema extends Schema = any> {
-    /**
-     * The name of the model, used for example for GraphQL
-     */
-    name: string;
-    /**
-     * Pass a function that returns the schema. For example: () => require('./schema').
-     * This is used like this to allow circular dependencies
-     */
-    schema?: TSchema;
-    /**
-     * Pass a function that returns the resolvers. For example: () => require('./resolvers')
-     * This is used like this to allow circular dependencies
-     */
-    resolvers?: ModelResolversMap;
-    /**
-     * Optional function that will process the document before being returned.
-     * @param doc The current document
-     * @return The processed document promise
-     */
-    clean?: (doc: any) => Promise<any> | any;
-    /**
-     * Optional function that will validate the document before being returned.
-     * @param doc The current document
-     */
-    validate?: (doc: any) => Promise<void> | void;
-}
-interface ModelResolversMap {
-    [key: string]: ModelResolver;
-}
-interface GlobalResolversMap {
-    [key: string]: GlobalResolver;
-}
-interface CloneOptions {
-    name: string;
-    omitFields?: string[];
-    pickFields?: string[];
-    mapFields?: (field: any, key: string) => any;
-    extendSchema?: Schema;
-    extendResolvers?: ModelResolversMap;
-}
-interface Model<TSchema = any> {
-    __isModel: true;
-    __modelName: string;
-    /**
-     * The name of the model, used for example for GraphQL
-     */
-    name: string;
-    /**
-     * Returns the schema of the model
-     */
-    getSchema: () => Schema;
-    /**
-     * Returns the model resolvers
-     */
-    getResolvers: () => ModelResolversMap;
-    /**
-     * 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;
-}
-type CreateModel<TSchema = any> = (options: CreateModelOptions) => Model<TSchema>;
-
-declare function createModel<TSchema extends Schema>(modelOptions: CreateModelOptions<TSchema>): Model<TSchema>;
-
-interface ModelToSchemaOptions {
-    modelSchema: Schema;
-    modelName?: string;
-    cleanOptions?: any;
-    validateOptions?: any;
-    resolvers?: ModelResolversMap;
-}
-declare function modelToSchema(options: ModelToSchemaOptions): Schema;
-
-export { type CloneOptions, type CreateModel, type CreateModelOptions, type GlobalResolversMap, type Model, type ModelResolversMap, type ModelSchema, type ModelsSchemaNode, createModel, modelToSchema };
+import createModel from './createModel';
+import { modelToSchema } from './createModel/modelToSchema';
+export { createModel, modelToSchema };
+export * from './types';

package/dist/{index.d.cts → types/index.d.ts}

@@ -1,13 +1,12 @@
-import { ModelResolver, GlobalResolver } from '@orion-js/resolvers';
-import { Schema, SchemaNode, SchemaFieldType } from '@orion-js/schema';
-
-interface ModelsSchemaNode extends Omit<SchemaNode, 'type'> {
+import { GlobalResolver, ModelResolver } from '@orion-js/resolvers';
+import { Schema, SchemaFieldType, SchemaNode } from '@orion-js/schema';
+export interface ModelsSchemaNode extends Omit<SchemaNode, 'type'> {
     type: Model | [Model] | SchemaFieldType;
 }
-interface ModelSchema {
+export interface ModelSchema {
     [key: string]: ModelsSchemaNode;
 }
-interface CreateModelOptions<TSchema extends Schema = any> {
+export interface CreateModelOptions<TSchema extends Schema = any> {
     /**
      * The name of the model, used for example for GraphQL
      */
@@ -34,13 +33,13 @@ interface CreateModelOptions<TSchema extends Schema = any> {
      */
     validate?: (doc: any) => Promise<void> | void;
 }
-interface ModelResolversMap {
+export interface ModelResolversMap {
     [key: string]: ModelResolver;
 }
-interface GlobalResolversMap {
+export interface GlobalResolversMap {
     [key: string]: GlobalResolver;
 }
-interface CloneOptions {
+export interface CloneOptions {
     name: string;
     omitFields?: string[];
     pickFields?: string[];
@@ -48,7 +47,7 @@ interface CloneOptions {
     extendSchema?: Schema;
     extendResolvers?: ModelResolversMap;
 }
-interface Model<TSchema = any> {
+export interface Model<TSchema = any> {
     __isModel: true;
     __modelName: string;
     /**
@@ -84,17 +83,4 @@ interface Model<TSchema = any> {
      */
     type: TSchema;
 }
-type CreateModel<TSchema = any> = (options: CreateModelOptions) => Model<TSchema>;
-
-declare function createModel<TSchema extends Schema>(modelOptions: CreateModelOptions<TSchema>): Model<TSchema>;
-
-interface ModelToSchemaOptions {
-    modelSchema: Schema;
-    modelName?: string;
-    cleanOptions?: any;
-    validateOptions?: any;
-    resolvers?: ModelResolversMap;
-}
-declare function modelToSchema(options: ModelToSchemaOptions): Schema;
-
-export { type CloneOptions, type CreateModel, type CreateModelOptions, type GlobalResolversMap, type Model, type ModelResolversMap, type ModelSchema, type ModelsSchemaNode, createModel, modelToSchema };
+export type CreateModel<TSchema = any> = (options: CreateModelOptions) => Model<TSchema>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orion-js/models",
-  "version": "4.3.1",
+  "version": "4.4.0",
   "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
   "files": [
@@ -8,25 +8,18 @@
   ],
   "author": "nicolaslopezj",
   "license": "MIT",
-  "scripts": {
-    "test": "bun test",
-    "prepare": "bun run build",
-    "clean": "rm -rf ./dist",
-    "build": "tsup",
-    "dev": "tsup --watch"
-  },
   "dependencies": {
-    "@orion-js/helpers": "4.3.1",
-    "@orion-js/resolvers": "4.3.1",
-    "@orion-js/schema": "4.3.1"
+    "@orion-js/helpers": "4.4.0",
+    "@orion-js/resolvers": "4.4.0",
+    "@orion-js/schema": "4.4.0"
   },
   "peerDependencies": {
-    "@orion-js/logger": "4.3.1"
+    "@orion-js/logger": "4.4.0"
   },
   "devDependencies": {
     "@types/node": "^18.0.0",
     "tsup": "^8.0.1",
-    "typescript": "^5.4.5"
+    "typescript": "^7.0.2"
   },
   "publishConfig": {
     "access": "public"
@@ -38,5 +31,11 @@
     "types": "./dist/index.d.ts",
     "import": "./dist/index.js",
     "require": "./dist/index.cjs"
+  },
+  "scripts": {
+    "test": "bun test",
+    "clean": "rm -rf ./dist",
+    "build": "tsup && bun run ../../scripts/emit-declarations.ts",
+    "dev": "tsup --watch"
   }
-}
+}