@nyteshade/lattice-legacy

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <title>decorators/ModelProperties.js - Documentation</title> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script>  <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css"> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger" /> <label for="nav-trigger" class="navicon-button x"> <div class="navicon"></div> </label> <label for="nav-trigger" class="overlay"></label> <nav> <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading">C<a href="AwaitingPromiseError.html">AwaitingPromiseError</a></li><li class="nav-item">F<a href="AwaitingPromiseError.html#%25E2%258C%25BE%25E2%25A0%2580asyncFn">⌾⠀asyncFn</a></li><li class="nav-item">F<a href="AwaitingPromiseError.html#%25E2%258C%25BE%25E2%25A0%2580setPromise">⌾⠀setPromise</a></li><li class="nav-heading">C<a href="AwaitingPromiseError_exports.AwaitingPromiseError.html">AwaitingPromiseError</a></li><li class="nav-item">F<a href="AwaitingPromiseError_exports.AwaitingPromiseError.html#setPromise">setPromise</a></li><li class="nav-heading">C<a href="Deferred_exports.Deferred.html">Deferred</a></li><li class="nav-heading">C<a href="DirectTypeAdd.html">DirectTypeAdd</a></li><li class="nav-heading">C<a href="FunctionExecutionError_FunctionExecutionError.html">FunctionExecutionError</a></li><li class="nav-heading">C<a href="GQLBase.html">GQLBase</a></li><li class="nav-item">F<a href="GQLBase.html#.apiDocs">apiDocs</a></li><li class="nav-item">F<a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580getMergedRoot">⌾⠀getMergedRoot</a></li><li class="nav-item">F<a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580getProp">⌾⠀getProp</a></li><li class="nav-item">F<a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580getResolver">⌾⠀getResolver</a></li><li class="nav-item">F<a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580IDLFilePath">⌾⠀IDLFilePath</a></li><li class="nav-item">F<a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580MUTATORS">⌾⠀MUTATORS</a></li><li class="nav-item">F<a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580RESOLVERS">⌾⠀RESOLVERS</a></li><li class="nav-item">F<a href="GQLBase.html#.%25E2%258C%25BE%25E2%25A0%2580setupModel">⌾⠀setupModel</a></li><li class="nav-item">F<a href="GQLBase.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580handler">⬇︎⠀handler</a></li><li class="nav-item">F<a href="GQLBase.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580SCHEMA">⬇︎⠀SCHEMA</a></li><li class="nav-item">F<a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580applyAutoProps">⌾⠀applyAutoProps</a></li><li class="nav-item">F<a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580callProp">⌾⠀callProp</a></li><li class="nav-item">F<a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580extendModel">⌾⠀extendModel</a></li><li class="nav-item">F<a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580getModel">⌾⠀getModel</a></li><li class="nav-item">F<a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580getProp">⌾⠀getProp</a></li><li class="nav-item">F<a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580getResolver">⌾⠀getResolver</a></li><li class="nav-item">F<a href="GQLBase.html#%25E2%258C%25BE%25E2%25A0%2580setModel">⌾⠀setModel</a></li><li class="nav-item">F<a href="GQLBase.html#%25E2%25AC%2586%25EF%25B8%258E%25E2%25A0%2580requestData">⬆︎⠀requestData</a></li><li class="nav-item">F<a href="GQLBase.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580requestData">⬇︎⠀requestData</a></li><li class="nav-item">F<a href="GQLBase.html#~deleteProperty">deleteProperty</a></li><li class="nav-item">F<a href="GQLBase.html#~set">set</a></li><li class="nav-heading">C<a href="GQLBase.%25E2%258E%2586%25E2%25A0%2580constructor.html">⎆⠀constructor</a></li><li class="nav-heading">C<a href="GQLEnum.html">GQLEnum</a></li><li class="nav-item">F<a href="GQLEnum.html#..get">.get</a></li><li class="nav-item">F<a href="GQLEnum.html#..set">.set</a></li><li class="nav-item">F<a href="GQLEnum.html#.valueFor">valueFor</a></li><li class="nav-item">F<a href="GQLEnum.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580enums">⬇︎⠀enums</a></li><li class="nav-item">F<a href="GQLEnum.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580name">⬇︎⠀name</a></li><li class="nav-item">F<a href="GQLEnum.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580value">⬇︎⠀value</a></li><li class="nav-item">F<a href="GQLEnum.html#.%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580values">⬇︎⠀values</a></li><li class="nav-item">F<a href="GQLEnum.html#GenerateEnumsProxyHandler">GenerateEnumsProxyHandler</a></li><li class="nav-heading">C<a href="GQLExpressMiddleware.html">GQLExpressMiddleware</a></li><li class="nav-item">F<a href="GQLExpressMiddleware.html#.clearCache">clearCache</a></li><li class="nav-item">F<a href="GQLExpressMiddleware.html#.%25E2%258C%25BE%25E2%25A0%2580generateSchemaSDL">⌾⠀generateSchemaSDL</a></li><li class="nav-item">F<a href="GQLExpressMiddleware.html#astMiddleware">astMiddleware</a></li><li class="nav-item">F<a href="GQLExpressMiddleware.html#schemaMiddleware">schemaMiddleware</a></li><li class="nav-item">F<a href="GQLExpressMiddleware.html#%25E2%258C%25BE%25E2%25A0%2580customMiddleware">⌾⠀customMiddleware</a></li><li class="nav-item">F<a href="GQLExpressMiddleware.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580middleware">⬇︎⠀middleware</a></li><li class="nav-item">F<a href="GQLExpressMiddleware.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580middlewareWithoutGraphiQL">⬇︎⠀middlewareWithoutGraphiQL</a></li><li class="nav-item">F<a href="GQLExpressMiddleware.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580schema">⬇︎⠀schema</a></li><li class="nav-heading">C<a href="GQLExpressMiddleware.%25E2%258E%2586%25E2%25A0%2580constructor.html">⎆⠀constructor</a></li><li class="nav-heading">C<a href="GQLInterface.html">GQLInterface</a></li><li class="nav-item">F<a href="GQLInterface.html#.%25E2%258C%25BE%25E2%25A0%2580resolveType">⌾⠀resolveType</a></li><li class="nav-heading">C<a href="GQLScalar.html">GQLScalar</a></li><li class="nav-item">F<a href="GQLScalar.html#.parseLiteral">parseLiteral</a></li><li class="nav-item">F<a href="GQLScalar.html#.parseValue">parseValue</a></li><li class="nav-item">F<a href="GQLScalar.html#.serialize">serialize</a></li><li class="nav-heading">C<a href="IDLFileHandler.html">IDLFileHandler</a></li><li class="nav-item">F<a href="IDLFileHandler.html#%25E2%258C%25BE%25E2%25A0%2580getFile">⌾⠀getFile</a></li><li class="nav-item">F<a href="IDLFileHandler.html#%25E2%258C%25BE%25E2%25A0%2580getSchema">⌾⠀getSchema</a></li><li class="nav-item">F<a href="IDLFileHandler.html#%25E2%258C%25BE%25E2%25A0%2580getSyntaxTree">⌾⠀getSyntaxTree</a></li><li class="nav-heading">C<a href="IDLFileHandler.%25E2%258E%2586%25E2%25A0%2580constructor.html">⎆⠀constructor</a></li><li class="nav-heading">C<a href="ModuleParser.html">ModuleParser</a></li><li class="nav-item">F<a href="ModuleParser.html#.%25E2%258C%25BE%25E2%25A0%2580arrayToPattern">⌾⠀arrayToPattern</a></li><li class="nav-item">F<a href="ModuleParser.html#.%25E2%258C%25BE%25E2%25A0%2580checkForPackageExtensions">⌾⠀checkForPackageExtensions</a></li><li class="nav-item">F<a href="ModuleParser.html#%25E2%258C%25BE%25E2%25A0%2580findGQLBaseClasses">⌾⠀findGQLBaseClasses</a></li><li class="nav-item">F<a href="ModuleParser.html#%25E2%258C%25BE%25E2%25A0%2580importClass">⌾⠀importClass</a></li><li class="nav-item">F<a href="ModuleParser.html#%25E2%258C%25BE%25E2%25A0%2580parse">⌾⠀parse</a></li><li class="nav-item">F<a href="ModuleParser.html#%25E2%258C%25BE%25E2%25A0%2580parseSync">⌾⠀parseSync</a></li><li class="nav-item">F<a href="ModuleParser.html#~%25E2%258C%25BE%25E2%25A0%2580walk">⌾⠀walk</a></li><li class="nav-item">F<a href="ModuleParser.html#~%25E2%258C%25BE%25E2%25A0%2580walkSync">⌾⠀walkSync</a></li><li class="nav-item">F<a href="ModuleParser.html#~%25E2%258E%2586%25E2%25A0%2580constructor">⎆⠀constructor</a></li><li class="nav-heading">C<a href="ModuleParser.exports.ModuleParser.html">exports.ModuleParser</a></li><li class="nav-heading">C<a href="SchemaUtils.html">SchemaUtils</a></li><li class="nav-item">F<a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580createMergedRoot">⌾⠀createMergedRoot</a></li><li class="nav-item">F<a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580injectComments">⌾⠀injectComments</a></li><li class="nav-item">F<a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580injectEnums">⌾⠀injectEnums</a></li><li class="nav-item">F<a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580injectInterfaceResolvers">⌾⠀injectInterfaceResolvers</a></li><li class="nav-item">F<a href="SchemaUtils.html#.%25E2%258C%25BE%25E2%25A0%2580injectScalars">⌾⠀injectScalars</a></li><li class="nav-heading">C<a href="SyntaxTree.html">SyntaxTree</a></li><li class="nav-item">F<a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580EmptyDocument">⌾⠀EmptyDocument</a></li><li class="nav-item">F<a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580EmptyMutation">⌾⠀EmptyMutation</a></li><li class="nav-item">F<a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580EmptyQuery">⌾⠀EmptyQuery</a></li><li class="nav-item">F<a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580findDefinition">⌾⠀findDefinition</a></li><li class="nav-item">F<a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580findField">⌾⠀findField</a></li><li class="nav-item">F<a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580findInASTArrayByNameValue">⌾⠀findInASTArrayByNameValue</a></li><li class="nav-item">F<a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580from">⌾⠀from</a></li><li class="nav-item">F<a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580fromAST">⌾⠀fromAST</a></li><li class="nav-item">F<a href="SyntaxTree.html#.%25E2%258C%25BE%25E2%25A0%2580fromSchema">⌾⠀fromSchema</a></li><li class="nav-item">F<a href="SyntaxTree.html#.%25E2%258E%2586%25E2%25A0%2580constructor">⎆⠀constructor</a></li><li class="nav-item">F<a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580appendDefinitions">⌾⠀appendDefinitions</a></li><li class="nav-item">F<a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580consumeDefinition">⌾⠀consumeDefinition</a></li><li class="nav-item">F<a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580find">⌾⠀find</a></li><li class="nav-item">F<a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580findEnumDefinition">⌾⠀findEnumDefinition</a></li><li class="nav-item">F<a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580setAST">⌾⠀setAST</a></li><li class="nav-item">F<a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580toString">⌾⠀toString</a></li><li class="nav-item">F<a href="SyntaxTree.html#%25E2%258C%25BE%25E2%25A0%2580updateAST">⌾⠀updateAST</a></li><li class="nav-item">F<a href="SyntaxTree.html#%25E2%25AC%2586%25EF%25B8%258E%25E2%25A0%2580ast">⬆︎⠀ast</a></li><li class="nav-item">F<a href="SyntaxTree.html#%25E2%25AC%2587%25EF%25B8%258E%25E2%25A0%2580ast">⬇︎⠀ast</a></li><li class="nav-heading">C<a href="utils.Deferred.html">Deferred</a></li><li class="nav-heading">Namespaces</li><li class="nav-heading">N<a href="decorators.html">decorators</a></li><li class="nav-item">F<a href="decorators.html#.%25E2%258C%25BE%25E2%25A0%2580extractBits">⌾⠀extractBits</a></li><li class="nav-item">F<a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580AdjacentSchema">.🏷⠀AdjacentSchema</a></li><li class="nav-item">F<a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580FileSchema">.🏷⠀FileSchema</a></li><li class="nav-item">F<a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580Getters">.🏷⠀Getters</a></li><li class="nav-item">F<a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580Properties">.🏷⠀Properties</a></li><li class="nav-item">F<a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580Schema">.🏷⠀Schema</a></li><li class="nav-item">F<a href="decorators.html#..%25F0%259F%258F%25B7%25E2%25A0%2580Setters">.🏷⠀Setters</a></li><li class="nav-item">F<a href="decorators.html#~decorate">decorate</a></li><li class="nav-heading">N<a href="GQLBaseEnv.html">GQLBaseEnv</a></li><li class="nav-item">F<a href="GQLBaseEnv.html#~notDefined">notDefined</a></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item">F<a href="global.html#applyTags">applyTags</a></li><li class="nav-item">M<a href="global.html#AsyncFunctionExecutionError">AsyncFunctionExecutionError</a></li><li class="nav-item">M<a href="global.html#CHECK_API_DOCS">CHECK_API_DOCS</a></li><li class="nav-item">M<a href="global.html#CHECK_RESOLVERS">CHECK_RESOLVERS</a></li><li class="nav-item">M<a href="global.html#CHECK_SCHEMA">CHECK_SCHEMA</a></li><li class="nav-item">M<a href="global.html#CHECKLIST">CHECKLIST</a></li><li class="nav-item">M<a href="global.html#FunctionExecutionError">FunctionExecutionError</a></li><li class="nav-item">F<a href="global.html#getChecklist">getChecklist</a></li><li class="nav-item">F<a href="global.html#hasChecklist">hasChecklist</a></li><li class="nav-item">F<a href="global.html#newChecklist">newChecklist</a></li><li class="nav-item">F<a href="global.html#setChecklist">setChecklist</a></li><li class="nav-item">M<a href="global.html#types">types</a></li> </nav> <div id="main"> <h1 class="page-title">decorators/ModelProperties.js</h1> <section> <article> <pre class="prettyprint source linenums"><code>/** @namespace decorators */ import { GQLBase, MODEL_KEY, META_KEY, GETTERS, SETTERS, PROPS, AUTO_PROPS } from '../GQLBase' import { isArray, extendsFrom } from 'ne-types' import { inspect } from 'util' import { GraphQLEnumType, parse } from 'graphql' import { SyntaxTree } from '../SyntaxTree' /** * For each of the decorators, Getters, Setters, and Properties, we take a * list of property names used to create the appropriate accessor types. In * some cases, however, the instance of GQLBase's data model may have a * different name. Finally if the return type for the getter should be wrapped * in a another GQLBase class type, we will need a way to specify those things * too. * * The `extractBits()` takes a single argument value from the decorator as it * parses them and converts it into an object, properly sorted, into values that * allow the above described behavior. * * Examples: * * ``` * // Create a class with a name and age property that map directly to the * // underlying data model * @Getters('name', 'age') * class MyType extends GQLBase {...} * * // Create a class with a name property that maps to a different property * // name in the underlying data model * @Getters(['name', '_fake_name']) * class MyMockType extends GQLBase {...} * * // Create a class with an employee property that returns an Employee * @Getters(['employee', Employee]) * class MyRoleType extends GQLBase {...} * * // Finally create a class with an employe property that returns an Employee * // with data under a different name in the underlying data model. * @Getters(['employee', '_worker', Employee]) * class MyMockRoleType extends GQLBase {...} * ``` * * @memberof decorators * @method ⌾⠀extractBits * @since 2.5 * * @param {String|Array<String|Function>} property name of a property, or list * of property names and a Class. * @return {Object} an object with the following format ``` * { * fieldName: name of root instance property to create * modelName: name of its associated internal model property * typeClass: an optional class to wrap around the results in a getter * } * ``` */ function extractBits(property) { let array = isArray(property) ? property : [property, property, null] let reply; if (!property) { let error = new Error( 'Invalid property. Given\n %o', inspect(property, {depth: 2}) ); return { fieldName: 'anErrorOccurred', modelName: 'anErrorOccurred', typeClass: null, getterMaker: function() { return () => error }, setterMaker: function() { return (v) => undefined } } } // if (array.length === 3) { reply = { fieldName: array[0], modelName: array[1], typeClass: typeof array[2] === 'function' && array[2] || null } } // else if (array.length === 2) { reply = { fieldName: array[0], modelName: typeof array[1] === 'string' ? array[1] : array[0], typeClass: typeof array[1] === 'function' && array[1] || null } } // else { reply = { fieldName: array[0], modelName: array[0], typeClass: array[0] } } reply.getterMaker = function() { let { modelName, fieldName, typeClass } = reply; return function() { const thisClass = this.constructor const model = this[MODEL_KEY] || null let val if (!extendsFrom(thisClass, GQLBase)) { console.error(`${thisClass.name} is not derived from GQLBase`); return undefined } if (!thisClass.SCHEMA) { throw new Error(` All GQLBase extended classes should have a defined SCHEMA. Please manually define a static get SCHEMA() in your class or use the @Schema() decorator to do so. `) } if (typeClass) { // If the value of the model is already the type of class we expect // we do not need to do any processing and we can just grab it and // go. if (model[modelName] && extendsFrom(model[modelName], typeClass)) { val = model[modelName] } // Otherwise we need to return an instance of the determined typeClass // and pass that back instead; as requested. else { const results = SyntaxTree.findField( parse(this.constructor.SCHEMA), this.constructor.name, modelName ) const { meta } = results || { meta: null }; let args = [model[modelName], this.requestData]; if (meta && !meta.nullable && !model) { throw new Error(` Using @Getters or @Properties decorators with a null or undefined model when the schema states that this field cannot be null. Type : ${typeClass.name} Field (AST data) name : ${meta.name} type : ${meta.type} nullable: ${meta.nullable} [getter] : ${fieldName} [maps to] : ${modelName} [model ] : ${model} `) } // If the following is true, it means that despite allowing nulls // for this field in the schema, we do have a valid model and should // proceed. if (model) { if (extractBits.DIRECT_TYPES.includes(typeClass.name)) { val = typeClass(...args) } else { val = new typeClass(...args) } if (typeClass.GQL_TYPE === GraphQLEnumType) { return val.value; } } } } else { val = model[modelName]; } if (val === 'undefined' || val === undefined) { val = null; } return val; } } reply.setterMaker = function() { let { modelName } = reply; return function (value) { this[MODEL_KEY][modelName] = value; } } return reply; } /** * An array of proper class names that are used to test for cases where the * proper usage of instantiating an instance should preclude the use of `new` * * @memberof decorators * @type {Array<String>} */ extractBits.DIRECT_TYPES = [ String.name ]; /** * A small suite of functions a getter that allows easy manipulation of the * the DIRECT_TYPES workaround needed for some types of complex class * wrapping allowed by the @Getters and @Properties decorators. Namely the * ability to do something like @Getters('name', String) which would wrap the * contents of whatever is in the objects model in a String call. * * Direct types are those that need to be called without `new` in order for the * desired behavior to present itself. * * @memberof decorators * @type {Object} * @since 2.7.0 */ export const DirectTypeManager = { /** * A getter that retrieves the array of direct types * * @method DirectTypeManager#types * @member {Array<String>} types * * @return {Array<String>} an array of class name strings. */ get types(): Array<String> { return extractBits.DIRECT_TYPES }, /** * Appends the supplied class name to the list of registered direct types. If * a class or function is passed, rather than a String, * * @method DirectTypeManager#types * * @param {Function|string|RegExp} className the name of the class to append. * Typically it is best to pass the name property of the class in question * such as `RegExp.name` or `MyClass.name`. */ add(className: string | RegExp | Function): void { if (typeof className === 'function') { className = className.name } extractBits.DIRECT_TYPES.push(className); }, /** * Foricbly empties the contents of the extractBits.DIRECT_TYPES array. This * is not recommended as it can have unintended consequences. It is * recommended to use `reset` instead * * @method DirectTypeManager#clear * * @return {Array<string>} an array of class name Strings that were removed * when cleared. */ clear(): Array<string> { return extractBits.DIRECT_TYPES.splice(0, extractBits.DIRECT_TYPES.length) }, /** * The recommended way to reset the DIRECT_TYPES list. This removes all * changed values, returns the removed bits, and adds back in the defaults. * * @method DirectTypeManager#reset * * @return {Array<string>} an array of class name Strings that were removed * during the reset process. */ reset(): Array<string> { return extractBits.DIRECT_TYPES.splice( 0, extractBits.DIRECT_TYPES.length, String.name ) } } /** * This decorator allows you to add a Class method to the DirectTypeManager * as a function that should not be invoked with the `new` keyword. For all * intents and purposes the function should be declared `static`. * * @method DirectTypeAdd * @param {Function} target [description] * @constructor */ export function DirectTypeAdd(target) { DirectTypeManager.add(target); return target; } /** * When applying multiple property getters and setters, knowing some info * about what was applied elsewhere can be important. "Tags" can be applied * that store the fieldName and descriptor applied via one of these decorators. * * Multiple "tags" are supported to allow for detecting the difference between * decorators applied by the developer using lattice and something auto * generated such as auto-props. * * @param {GQLBase} Class an instance of GQLBase to apply the tags tp * @param {Array<string|Symbol>} addTags an array of Symbols or strings to be * wrapped in Symbols that will be used as tag keys * @param {string} fieldName the name of the field being decorated * @param {Object} descriptor the JavaScript descriptor object to associate * with this tagged field. */ export function applyTags( Class:GQLBase, addTags: Array<string|Symbol>, fieldName: string, descriptor: Object ) { let tags = (Array.isArray(addTags) && addTags || []) .map(tag => typeof tag === 'string' && Symbol.for(tag) || tag) .filter(tag => typeof tag === 'symbol') tags.forEach(tag => { Class[META_KEY][tag] = Class[META_KEY][tag] || {} Class[META_KEY][tag][fieldName] = descriptor }) } /** * When working with `GQLBase` instances that expose properties * that have a 1:1 mapping to their own model property of the * same name, adding the getters manually can be annoying. This * takes an indeterminate amount of strings representing the * properties for which getters should be injected. * * @function 🏷⠀Getters * @memberof! decorators * * @param {Array<String|Array<String>>} propertyNames if the model has 'name' * and 'age' as properties, then passing those two strings will result * in getters that surface those properties as GraphQL fields. * @return {Function} a class decorator method.s */ export function Getters( ...propertyNames: Array<String|Array<String|Function>> ): Function { return function(target: mixed, addTags: Array<string|Symbol> = []): mixed { for (let property of propertyNames) { let { fieldName, getterMaker } = extractBits(property); let desc = Object.getOwnPropertyDescriptor(target.prototype, fieldName) let hasImpl = desc && (desc.get || typeof desc.value === 'function') let tags = [GETTERS].concat(Array.isArray(addTags) && addTags || []) if (!hasImpl) { let descriptor = { get: getterMaker() } applyTags(target, tags, fieldName, descriptor) Object.defineProperty(target.prototype, fieldName, descriptor); } else { console.warn( `Skipping getter for ${target.name}.${fieldName}; already exists` ) } } return target; } } /** * When working with `GQLBase` instances that expose properties * that have a 1:1 mapping to their own model property of the * same name, adding the setters manually can be annoying. This * takes an indeterminate amount of strings representing the * properties for which setters should be injected. * * @function 🏷⠀Setters * @memberof! decorators * @since 2.1.0 * * @param {Array<String|Array<String>>} propertyNames if the model has * 'name' and 'age' as properties, then passing those two strings will * result in setters that surface those properties as GraphQL fields. * @return {Function} a class decorator method */ export function Setters( ...propertyNames: Array<String|Array<String|Function>> ): Function { return function(target: mixed, addTags: Array<String|Symbol> = []): mixed { for (let property of propertyNames) { let { fieldName, setterMaker } = extractBits(property); let desc = Object.getOwnPropertyDescriptor(target.prototype, fieldName) let hasImpl = desc && (desc.get || typeof desc.value === 'function') let tags = [SETTERS].concat(Array.isArray(addTags) && addTags || []) if (!hasImpl) { let descriptor = { set: setterMaker() } applyTags(target, tags, fieldName, descriptor) Object.defineProperty(target.prototype, fieldName, descriptor); } else { console.warn( `Skipping setter for ${target.name}.${fieldName}; already exists` ) } } return target; } } /** * When working with `GQLBase` instances that expose properties * that have a 1:1 mapping to their own model property of the * same name, adding the getters manually can be annoying. This * takes an indeterminate amount of strings representing the * properties for which getters should be injected. * * This method creates both getters and setters * * @function 🏷⠀Properties * @memberof! decorators * @since 2.1.0 * * @param {Array<String|Array<String>>} propertyNames if the model has 'name' * and 'age' as properties, then passing those two strings will result * in getters and setters that surface those properties as GraphQL fields. * @return {Function} a class decorator method */ export function Properties( ...propertyNames: Array<String|Array<String|Function>> ): Function { return function(target: mixed, addTags: Array<String|Symbol> = []): mixed { for (let property of propertyNames) { let {fieldName, getterMaker, setterMaker } = extractBits(property); let desc = Object.getOwnPropertyDescriptor(target.prototype, fieldName) let hasImpl = desc && (desc.get || typeof desc.value === 'function') let tags = [PROPS].concat(Array.isArray(addTags) && addTags || []) if (!hasImpl) { let descriptor = { set: setterMaker(), get: getterMaker() } applyTags(target, tags, fieldName, descriptor) Object.defineProperty(target.prototype, fieldName, descriptor); } else { console.warn( `Skipping properties for ${target.name}.${fieldName}; already exists` ) } } return target; } } export default Properties; </code></pre> </article> </section> </div> <footer> Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Feb 17 2018 00:27:31 GMT-0800 (PST) using the Minami theme. </footer> <script>prettyPrint();</script> <script src="scripts/linenumber.js"></script> </body> </html>