@orion-js/models 3.11.15 → 3.12.0

package/lib/createModel/validation.test.js

@@ -1,72 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const index_1 = __importDefault(require("./index"));
-const resolvers_1 = require("@orion-js/resolvers");
-it('should validate a schema', async () => {
-    const model = (0, index_1.default)({
-        name: 'AModel',
-        schema: {
-            name: {
-                type: String
-            }
-        }
-    });
-    await model.validate({ name: 'String' });
-});
-it('should allow deep model validation', async () => {
-    const model2 = (0, index_1.default)({
-        name: 'AModel',
-        schema: {
-            firstName: {
-                type: String
-            },
-            lastName: {
-                type: String
-            }
-        }
-    });
-    const model1 = (0, index_1.default)({
-        name: 'AModel2',
-        schema: {
-            data: {
-                type: model2
-            }
-        }
-    });
-    await model1.validate({ data: { firstName: 'Nicolás', lastName: 'López' } });
-    expect.assertions(1);
-    try {
-        await model1.validate({});
-    }
-    catch (error) {
-        expect(error.code).toBe('validationError');
-    }
-});
-it('[regression test]: should allow correct doc cleaning for resolver params', async () => {
-    const Point = (0, index_1.default)({
-        name: 'Point',
-        schema: {
-            latitude: {
-                type: Number
-            },
-            longitude: {
-                type: Number
-            }
-        }
-    });
-    const resolver1 = (0, resolvers_1.resolver)({
-        params: {
-            point: {
-                type: Point
-            }
-        },
-        async resolve({ point }) {
-            return point;
-        }
-    });
-    const doc = await resolver1.resolve({ point: { latitude: '11', longitude: '12' } });
-    expect(doc).toEqual({ latitude: 11, longitude: 12 });
-});

package/lib/index.d.ts

@@ -1,4 +0,0 @@
-import createModel from './createModel';
-import { modelToSchema, modelToSchemaWithModel } from './createModel/modelToSchema';
-export { createModel, modelToSchema, modelToSchemaWithModel };
-export * from './types';

package/lib/index.js

@@ -1,22 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.modelToSchemaWithModel = exports.modelToSchema = exports.createModel = void 0;
-const createModel_1 = __importDefault(require("./createModel"));
-exports.createModel = createModel_1.default;
-const modelToSchema_1 = require("./createModel/modelToSchema");
-Object.defineProperty(exports, "modelToSchema", { enumerable: true, get: function () { return modelToSchema_1.modelToSchema; } });
-Object.defineProperty(exports, "modelToSchemaWithModel", { enumerable: true, get: function () { return modelToSchema_1.modelToSchemaWithModel; } });
-__exportStar(require("./types"), exports);

package/lib/types/index.d.ts

@@ -1,99 +0,0 @@
-import { GlobalResolverResolve, ModelResolver, ModelResolverResolve, Resolver } from '@orion-js/resolvers';
-import { Schema, SchemaMetaFieldType, SchemaNode } from '@orion-js/schema';
-export interface ModelsSchemaNode extends Omit<SchemaNode, 'type'> {
-    type: Model | [Model] | SchemaMetaFieldType;
-}
-export interface ModelSchema {
-    [key: string]: ModelsSchemaNode;
-}
-export interface CreateModelOptions {
-    /**
-     * 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?: ModelSchema | (() => {
-        default: ModelSchema;
-    });
-    /**
-     * Pass a function that returns the resolvers. For example: () => require('./resolvers')
-     * This is used like this to allow circular dependencies
-     */
-    resolvers?: ModelResolversMap | (() => {
-        default: 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;
-}
-export interface ModelResolversMap {
-    [key: string]: ModelResolver<ModelResolverResolve>;
-}
-export interface GlobalResolversMap {
-    [key: string]: Resolver<GlobalResolverResolve>;
-}
-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;
-}
-export declare type CreateModel<TSchema = any> = (options: CreateModelOptions) => Model<TSchema>;

package/lib/types/index.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/index.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/types/index.test.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const __1 = require("..");
-it('should create correctly a model with its schema', async () => {
-    const model1 = (0, __1.createModel)({
-        name: 'Name',
-        schema: {
-            services: {
-                type: 'blackbox'
-            }
-        }
-    });
-    const model2 = (0, __1.createModel)({
-        name: 'Name',
-        schema: {
-            services: {
-                type: model1,
-                private: true
-            }
-        }
-    });
-    const model3 = (0, __1.createModel)({
-        name: 'Name',
-        schema: {
-            services: {
-                type: [model2],
-                optional: true
-            }
-        }
-    });
-    const model4 = (0, __1.createModel)({
-        name: 'Name',
-        schema: {}
-    });
-});