@memberjunction/codegen-lib 2.12.1 → 2.13.0

package/dist/entity_types_codegen.js

@@ -0,0 +1,106 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntityTypeGeneratorBase = void 0;
+const core_1 = require("@memberjunction/core");
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const util_1 = require("./Misc/util");
+const global_1 = require("@memberjunction/global");
+const logging_1 = require("./Misc/logging");
+/**
+ * Base class for generating type definitions for entity sub-classes, you can sub-class this class to modify/extend your own entity sub-class generator logic
+ */
+let EntityTypeGeneratorBase = class EntityTypeGeneratorBase {
+    generateAllEntityTypeDefinitions(entities, directory) {
+        try {
+            const sortedEntities = entities.sort((a, b) => a.Name.localeCompare(b.Name));
+            const sContent = this.generateTypeDefinitionHeader() + sortedEntities.map((entity) => this.generateEntitySubClass(entity)).join('');
+            (0, logging_1.logStatus)(`Generating entity sub-class types file in ${directory}`);
+            (0, util_1.makeDir)(directory);
+            fs_1.default.writeFileSync(path_1.default.join(directory, 'entity_type_definitions.ts'), sContent);
+            return true;
+        }
+        catch (err) {
+            console.error(err);
+            return false;
+        }
+    }
+    generateTypeDefinitionHeader() {
+        return `/*************************************************
+* GENERATED CODE - DO NOT MODIFY
+* Generated by MemberJunction CodeGen at ${new Date().toLocaleString()}
+**************************************************/`;
+    }
+    /**
+     *
+     * @param entity
+     * @param includeFileHeader
+     */
+    generateEntitySubClass(entity) {
+        if (entity.PrimaryKeys.length === 0) {
+            (0, logging_1.logStatus)(`Entity ${entity.Name} has no primary keys.  Skipping.`);
+        }
+        else {
+            const fields = entity.Fields.map(e => {
+                let values = '';
+                let valueList = '';
+                if (e.ValueListType &&
+                    e.ValueListType.length > 0 &&
+                    e.ValueListType.trim().toLowerCase() !== 'none') {
+                    values = e.EntityFieldValues.map(v => `\n    *   * ${v.Value}${v.Description && v.Description.length > 0 ? ' - ' + v.Description : ''}`).join('');
+                    valueList = `\n    * * Value List Type: ${e.ValueListType}\n    * * Possible Values ` + values;
+                }
+                let typeString = (0, core_1.TypeScriptTypeFromSQLType)(e.Type) + (e.AllowsNull ? ' | null' : '');
+                if (e.ValueListTypeEnum !== core_1.EntityFieldValueListType.None && e.EntityFieldValues && e.EntityFieldValues.length > 0) {
+                    // construct a typeString that is a union of the possible values
+                    const quotes = e.NeedsQuotes ? "'" : '';
+                    typeString = e.EntityFieldValues.map(v => `${quotes}${v.Value}${quotes}`).join(' | ');
+                    if (e.ValueListTypeEnum === core_1.EntityFieldValueListType.ListOrUserEntry) {
+                        // special case becuase a user can enter whatever they want
+                        typeString += ' | ' + (0, core_1.TypeScriptTypeFromSQLType)(e.Type);
+                    }
+                    // finally, add the null type if it allows null
+                    if (e.AllowsNull) {
+                        typeString += ' | null';
+                    }
+                }
+                let sRet = `    /**
+    * * Field Name: ${e.Name}${e.DisplayName && e.DisplayName.length > 0 ? '\n    * * Display Name: ' + e.DisplayName : ''}
+    * * SQL Data Type: ${e.SQLFullType}${e.RelatedEntity ? '\n    * * Related Entity/Foreign Key: ' + e.RelatedEntity + ' (' + e.RelatedEntityBaseView + '.' + e.RelatedEntityFieldName + ')' : ''}${e.DefaultValue && e.DefaultValue.length > 0 ? '\n    * * Default Value: ' + e.DefaultValue : ''}${valueList}${e.Description && e.Description.length > 0 ? '\n    * * Description: ' + e.Description : ''}
+    */
+    ${e.CodeName}: ${typeString}`;
+                return sRet;
+            }).join('\n\n');
+            const sClassName = `${entity.ClassName}Object`;
+            let sRet = `
+            
+/**
+ * Type definition for the entity ${entity.Name}
+ * * Schema: ${entity.SchemaName}
+ * * Base Table: ${entity.BaseTable}
+ * * Base View: ${entity.BaseView}${entity.Description && entity.Description.length > 0 ? '\n * * @description ' + entity.Description : ''}
+ * * Primary Key${entity.PrimaryKeys.length > 1 ? 's' : ''}: ${entity.PrimaryKeys.map(f => f.Name).join(', ')}
+ */
+export type ${sClassName} = {
+
+${fields}
+}
+`;
+            return sRet;
+        }
+    }
+};
+exports.EntityTypeGeneratorBase = EntityTypeGeneratorBase;
+exports.EntityTypeGeneratorBase = EntityTypeGeneratorBase = __decorate([
+    (0, global_1.RegisterClass)(EntityTypeGeneratorBase)
+], EntityTypeGeneratorBase);
+//# sourceMappingURL=entity_types_codegen.js.map

package/dist/entity_types_codegen.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity_types_codegen.js","sourceRoot":"","sources":["../src/entity_types_codegen.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+CAAuG;AACvG,4CAAoB;AACpB,gDAAwB;AACxB,sCAAsC;AACtC,mDAAuD;AACvD,4CAA2C;AAE3C;;GAEG;AAEI,IAAM,uBAAuB,GAA7B,MAAM,uBAAuB;IACzB,gCAAgC,CAAC,QAAsB,EAAE,SAAiB;QAC7E,IAAI,CAAC;YACD,MAAM,cAAc,GAAiB,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;YAC3F,MAAM,QAAQ,GAAW,IAAI,CAAC,4BAA4B,EAAE,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,MAAkB,EAAE,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACxJ,IAAA,mBAAS,EAAC,6CAA6C,SAAS,EAAE,CAAC,CAAC;YACpE,IAAA,cAAO,EAAC,SAAS,CAAC,CAAC;YACnB,YAAE,CAAC,aAAa,CAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,4BAA4B,CAAC,EAAE,QAAQ,CAAC,CAAC;YAE/E,OAAO,IAAI,CAAC;QAChB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACnB,OAAO,KAAK,CAAC;QACjB,CAAC;IACL,CAAC;IAEM,4BAA4B;QAC/B,OAAO;;2CAE4B,IAAI,IAAI,EAAE,CAAC,cAAc,EAAE;oDAClB,CAAA;IAChD,CAAC;IAED;;;;OAIG;IACI,sBAAsB,CAAC,MAAkB;QAC5C,IAAI,MAAM,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClC,IAAA,mBAAS,EAAC,UAAU,MAAM,CAAC,IAAI,kCAAkC,CAAC,CAAC;QACvE,CAAC;aACI,CAAC;YACF,MAAM,MAAM,GAAW,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;gBACzC,IAAI,MAAM,GAAW,EAAE,CAAC;gBACxB,IAAI,SAAS,GAAW,EAAE,CAAC;gBAC3B,IAAI,CAAC,CAAC,aAAa;oBACf,CAAC,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC;oBAC1B,CAAC,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;oBAClD,MAAM,GAAG,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,WAAW,IAAI,CAAC,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;oBAClJ,SAAS,GAAG,8BAA8B,CAAC,CAAC,aAAa,4BAA4B,GAAE,MAAM,CAAA;gBACjG,CAAC;gBACD,IAAI,UAAU,GAAW,IAAA,gCAAyB,EAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;gBAC7F,IAAI,CAAC,CAAC,iBAAiB,KAAK,+BAAwB,CAAC,IAAI,IAAI,CAAC,CAAC,iBAAiB,IAAI,CAAC,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACjH,gEAAgE;oBAChE,MAAM,MAAM,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;oBACxC,UAAU,GAAG,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC,KAAK,GAAG,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBACtF,IAAI,CAAC,CAAC,iBAAiB,KAAK,+BAAwB,CAAC,eAAe,EAAE,CAAC;wBACnE,2DAA2D;wBAC3D,UAAU,IAAI,KAAK,GAAG,IAAA,gCAAyB,EAAC,CAAC,CAAC,IAAI,CAAC,CAAC;oBAC5D,CAAC;oBACD,+CAA+C;oBAC/C,IAAI,CAAC,CAAC,UAAU,EAAE,CAAC;wBACf,UAAU,IAAI,SAAS,CAAC;oBAC5B,CAAC;gBACL,CAAC;gBACD,IAAI,IAAI,GAAW;sBACb,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,WAAW,IAAI,CAAC,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,0BAA0B,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE;yBACjG,CAAC,CAAC,WAAW,GAAG,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,wCAAwC,GAAI,CAAC,CAAC,aAAa,GAAG,IAAI,GAAG,CAAC,CAAC,qBAAqB,GAAG,GAAG,GAAG,CAAC,CAAC,sBAAsB,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,YAAY,IAAI,CAAC,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,2BAA2B,GAAG,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,SAAS,GAAG,CAAC,CAAC,WAAW,IAAI,CAAC,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,yBAAyB,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE;;MAExY,CAAC,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;gBAClB,OAAO,IAAI,CAAC;YAChB,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;YAEf,MAAM,UAAU,GAAW,GAAG,MAAM,CAAC,SAAS,QAAQ,CAAC;YACvD,IAAI,IAAI,GAAW;;;oCAGK,MAAM,CAAC,IAAI;eAChC,MAAM,CAAC,UAAU;mBACb,MAAM,CAAC,SAAS;kBACjB,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,WAAW,IAAI,MAAM,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,sBAAsB,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE;kBACxH,MAAM,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;;cAE/F,UAAU;;EAEtB,MAAM;;CAEP,CAAC;YAEU,OAAO,IAAI,CAAC;QAChB,CAAC;IACL,CAAC;CACJ,CAAA;AAnFY,0DAAuB;kCAAvB,uBAAuB;IADnC,IAAA,sBAAa,EAAC,uBAAuB,CAAC;GAC1B,uBAAuB,CAmFnC"}

package/dist/graphql_server_codegen.d.ts

@@ -0,0 +1,29 @@
+import { EntityInfo, EntityFieldInfo, EntityRelationshipInfo, Metadata } from '@memberjunction/core';
+/**
+ * This class is responsible for generating the GraphQL Server resolvers and types for the entities, you can sub-class this class to extend/modify the logic, make sure to use @memberjunction/global RegisterClass decorator
+ * so that your class is used.
+ */
+export declare class GraphQLServerGeneratorBase {
+    generateGraphQLServerCode(entities: EntityInfo[], outputDirectory: string, generatedEntitiesImportLibrary: string, excludeRelatedEntitiesExternalToSchema: boolean): boolean;
+    protected _graphQLTypeSuffix: string;
+    /**
+     * The suffix to append to the GraphQL Type name, default is an underscore, override this property in your sub-class to change the suffix
+     */
+    get GraphQLTypeSuffix(): string;
+    generateServerEntityString(entity: EntityInfo, includeFileHeader: boolean, generatedEntitiesImportLibrary: string, excludeRelatedEntitiesExternalToSchema: boolean): string;
+    generateAllEntitiesServerFileHeader(entities: EntityInfo[], importLibrary: string, isInternal: boolean): string;
+    generateEntitySpecificServerFileHeader(entity: EntityInfo, importLibrary: string, excludeRelatedEntitiesExternalToSchema: boolean): string;
+    protected generateServerEntityHeader(entity: EntityInfo, serverGraphQLTypeName: string): string;
+    protected generateServerEntityFooter(entity: EntityInfo): string;
+    protected generateServerField(fieldInfo: EntityFieldInfo): string;
+    protected getTypeGraphQLFieldString(fieldInfo: EntityFieldInfo): string;
+    protected generateServerRelationship(md: Metadata, r: EntityRelationshipInfo, isInternal: boolean): string;
+    protected generateServerGraphQLResolver(entity: EntityInfo, serverGraphQLTypeName: string, excludeRelatedEntitiesExternalToSchema: boolean, isInternal: boolean): string;
+    protected schemaName(entity: EntityInfo): string;
+    protected generateServerGraphQLInputType(entity: EntityInfo): string;
+    protected generateServerGraphQLInputTypeInner(entity: EntityInfo, isUpdate: boolean, classPrefix: string): string;
+    protected generateServerGraphQLMutations(entity: EntityInfo, serverGraphQLTypeName: string): string;
+    protected generateOneToManyFieldResolver(entity: EntityInfo, r: EntityRelationshipInfo, isInternal: boolean): string;
+    protected generateManyToManyFieldResolver(entity: EntityInfo, r: EntityRelationshipInfo): string;
+}
+//# sourceMappingURL=graphql_server_codegen.d.ts.map

package/dist/graphql_server_codegen.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"graphql_server_codegen.d.ts","sourceRoot":"","sources":["../src/graphql_server_codegen.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,sBAAsB,EAA6B,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAQhI;;;GAGG;AACH,qBACa,0BAA0B;IAC9B,yBAAyB,CAC9B,QAAQ,EAAE,UAAU,EAAE,EACtB,eAAe,EAAE,MAAM,EACvB,8BAA8B,EAAE,MAAM,EACtC,sCAAsC,EAAE,OAAO,GAC9C,OAAO;IAmBV,SAAS,CAAC,kBAAkB,SAAO;IACnC;;OAEG;IACH,IAAW,iBAAiB,IAAI,MAAM,CAErC;IAEM,0BAA0B,CAC/B,MAAM,EAAE,UAAU,EAClB,iBAAiB,EAAE,OAAO,EAC1B,8BAA8B,EAAE,MAAM,EACtC,sCAAsC,EAAE,OAAO,GAC9C,MAAM;IAqDF,mCAAmC,CAAC,QAAQ,EAAE,UAAU,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,GAAG,MAAM;IA+B/G,sCAAsC,CAC3C,MAAM,EAAE,UAAU,EAClB,aAAa,EAAE,MAAM,EACrB,sCAAsC,EAAE,OAAO,GAC9C,MAAM;IA6BT,SAAS,CAAC,0BAA0B,CAAC,MAAM,EAAE,UAAU,EAAE,qBAAqB,EAAE,MAAM,GAAG,MAAM;IAa/F,SAAS,CAAC,0BAA0B,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM;IAMhE,SAAS,CAAC,mBAAmB,CAAC,SAAS,EAAE,eAAe,GAAG,MAAM;IAejE,SAAS,CAAC,yBAAyB,CAAC,SAAS,EAAE,eAAe,GAAG,MAAM;IAiCvE,SAAS,CAAC,0BAA0B,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,sBAAsB,EAAE,UAAU,EAAE,OAAO,GAAG,MAAM;IAuB1G,SAAS,CAAC,6BAA6B,CACrC,MAAM,EAAE,UAAU,EAClB,qBAAqB,EAAE,MAAM,EAC7B,sCAAsC,EAAE,OAAO,EAC/C,UAAU,EAAE,OAAO,GAClB,MAAM;IA2HT,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM;IAMhD,SAAS,CAAC,8BAA8B,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM;IAOpE,SAAS,CAAC,mCAAmC,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM;IAuCjH,SAAS,CAAC,8BAA8B,CAAC,MAAM,EAAE,UAAU,EAAE,qBAAqB,EAAE,MAAM,GAAG,MAAM;IAqEnG,SAAS,CAAC,8BAA8B,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC,EAAE,sBAAsB,EAAE,UAAU,EAAE,OAAO,GAAG,MAAM;IA+CpH,SAAS,CAAC,+BAA+B,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC,EAAE,sBAAsB,GAAG,MAAM;CA6CjG"}