@memberjunction/codegen-lib 1.0.4 → 1.0.7-next.0

package/dist/sql_codegen.d.ts

@@ -1,21 +1,64 @@
-import { EntityInfo } from '@memberjunction/core';
+import { EntityInfo, EntityFieldInfo } from '@memberjunction/core';
+import { SQLUtilityBase } from './sql';
 import { DataSource } from 'typeorm';
-export declare function manageSQLScriptsAndExecution(ds: DataSource, entities: EntityInfo[], directory: string): Promise<boolean>;
-export declare function runCustomSQLScripts(ds: DataSource, when: string): Promise<boolean>;
-export declare function applyPermissions(ds: DataSource, directory: string, entities: EntityInfo[], batchSize?: number): Promise<boolean>;
-export declare function generateAndExecuteAllEntitiesSQLToSeparateFiles(ds: DataSource, entities: EntityInfo[], directory: string, onlyPermissions: boolean, batchSize?: number): Promise<boolean>;
-export declare function createCombinedEntitySQLFiles(directory: string, entities: EntityInfo[]): Promise<void>;
-export declare function generateAndExecuteSingleEntitySQLToSeparateFiles(ds: DataSource, entity: EntityInfo, directory: string, onlyPermissions: boolean): Promise<boolean>;
-export declare function generateSingleEntitySQLToSeparateFiles(ds: DataSource, entity: EntityInfo, directory: string, onlyPermissions: boolean): Promise<string>;
-export declare function getSPName(entity: EntityInfo, type: SPType): string;
-export declare function getEntityPermissionFileNames(entity: EntityInfo): string[];
-export declare function generateEntitySQL(ds: DataSource, entity: EntityInfo): Promise<string>;
-export declare function generateAllEntitiesSQLFileHeader(): string;
-export declare function generateSingleEntitySQLFileHeader(entity: EntityInfo, itemName: string): string;
 export declare const SPType: {
     readonly Create: "Create";
     readonly Update: "Update";
     readonly Delete: "Delete";
 };
 export type SPType = typeof SPType[keyof typeof SPType];
+/**
+ * This class is responsible for generating database level objects like views, stored procedures, permissions, etc. You can sub-class this class to create your own SQL generation logic or implement support for other
+ * databases. The base class implements support for SQL Server. In future versions of MJ, we will break out an abstract base class that has the skeleton of the logic and then the SQL Server version will be a sub-class
+ * of that abstract base class and other databases will be sub-classes of the abstract base class as well.
+ */
+export declare class SQLCodeGenBase {
+    protected _sqlUtilityObject: SQLUtilityBase;
+    get SQLUtilityObject(): SQLUtilityBase;
+    manageSQLScriptsAndExecution(ds: DataSource, entities: EntityInfo[], directory: string): Promise<boolean>;
+    runCustomSQLScripts(ds: DataSource, when: string): Promise<boolean>;
+    applyPermissions(ds: DataSource, directory: string, entities: EntityInfo[], batchSize?: number): Promise<boolean>;
+    /**
+     * This function will handle the process of creating all of the generated objects like base view, stored procedures, etc. for all entities in the entities array. It will generate the SQL for each entity and then execute it.
+     * @param ds The DataSource object to use to execute the SQL
+     * @param entities The array of EntityInfo objects to generate SQL for
+     * @param directory The directory to save the generated SQL files to
+     * @param onlyPermissions If true, only the permissions files will be generated and executed, not the actual SQL files. Use this if you are simply setting permission changes but no actual changes to the entities have occured.
+     */
+    generateAndExecuteEntitySQLToSeparateFiles(ds: DataSource, entities: EntityInfo[], directory: string, onlyPermissions: boolean, writeFiles?: boolean, batchSize?: number): Promise<boolean>;
+    createCombinedEntitySQLFiles(directory: string, entities: EntityInfo[]): Promise<void>;
+    generateAndExecuteSingleEntitySQLToSeparateFiles(ds: DataSource, entity: EntityInfo, directory: string, onlyPermissions: boolean, writeFiles?: boolean): Promise<boolean>;
+    generateSingleEntitySQLToSeparateFiles(ds: DataSource, entity: EntityInfo, directory: string, onlyPermissions: boolean, writeFiles?: boolean): Promise<{
+        sql: string;
+        permissionsSQL: string;
+    }>;
+    getSPName(entity: EntityInfo, type: SPType): string;
+    getEntityPermissionFileNames(entity: EntityInfo): string[];
+    generateEntitySQL(ds: DataSource, entity: EntityInfo): Promise<string>;
+    generateEntityFullTextSearchSQL(ds: DataSource, entity: EntityInfo): Promise<{
+        sql: string;
+        functionName: string;
+    }>;
+    getEntityPrimaryKeyIndexName(ds: DataSource, entity: EntityInfo): Promise<string>;
+    generateAllEntitiesSQLFileHeader(): string;
+    generateSingleEntitySQLFileHeader(entity: EntityInfo, itemName: string): string;
+    generateBaseView(ds: DataSource, entity: EntityInfo): Promise<string>;
+    protected generateViewPermissions(entity: EntityInfo): string;
+    protected generateBaseViewJoins(entityFields: EntityFieldInfo[]): string;
+    generateBaseViewRelatedFieldsString(ds: DataSource, entityFields: EntityFieldInfo[]): Promise<string>;
+    protected getIsNameFieldForSingleEntity(entityName: string): {
+        nameField: string;
+        nameFieldIsVirtual: boolean;
+    };
+    protected stripID(name: string): string;
+    protected generateSPPermissions(entity: EntityInfo, spName: string, type: SPType): string;
+    protected generateFullTextSearchFunctionPermissions(entity: EntityInfo, functionName: string): string;
+    protected generateSPCreate(entity: EntityInfo): string;
+    protected generateSPUpdate(entity: EntityInfo): string;
+    protected createEntityFieldsParamString(entityFields: EntityFieldInfo[], isUpdate: boolean): string;
+    protected createEntityFieldsInsertString(entity: EntityInfo, entityFields: EntityFieldInfo[], prefix: string): string;
+    protected createEntityFieldsUpdateString(entityFields: EntityFieldInfo[]): string;
+    protected generateSPDelete(entity: EntityInfo): string;
+    protected generateCascadeDeletes(entity: EntityInfo): string;
+}
 //# sourceMappingURL=sql_codegen.d.ts.map

package/dist/sql_codegen.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sql_codegen.d.ts","sourceRoot":"","sources":["../src/sql_codegen.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAmD,MAAM,sBAAsB,CAAC;AAMnG,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAWrC,wBAAsB,4BAA4B,CAAC,EAAE,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAmE9H;AAED,wBAAsB,mBAAmB,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAqBxF;AAGD,wBAAsB,gBAAgB,CAAC,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,SAAS,GAAE,MAAU,GAAG,OAAO,CAAC,OAAO,CAAC,CAsCzI;AAID,wBAAsB,+CAA+C,CAAC,EAAE,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,SAAS,GAAE,MAAU,GAAG,OAAO,CAAC,OAAO,CAAC,CA4BlM;AAED,wBAAsB,4BAA4B,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,iBAW3F;AAID,wBAAsB,gDAAgD,CAAC,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CASxK;AAED,wBAAsB,sCAAsC,CAAC,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CA8G7J;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CASlE;AAED,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,EAAE,CAmBzE;AAGD,wBAAsB,iBAAiB,CAAC,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAyC3F;AAqHD,wBAAgB,gCAAgC,IAAI,MAAM,CAazD;AAED,wBAAgB,iCAAiC,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAW9F;AAiHD,eAAO,MAAM,MAAM;;;;CAIP,CAAC;AAEb,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAC,MAAM,OAAO,MAAM,CAAC,CAAC"}
+{"version":3,"file":"sql_codegen.d.ts","sourceRoot":"","sources":["../src/sql_codegen.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAkC,MAAM,sBAAsB,CAAC;AAKnG,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAUrC,eAAO,MAAM,MAAM;;;;CAIP,CAAC;AAEb,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAC,MAAM,OAAO,MAAM,CAAC,CAAC;AAGxD;;;;GAIG;AACH,qBACa,cAAc;IACvB,SAAS,CAAC,iBAAiB,EAAE,cAAc,CAAiF;IAC5H,IAAW,gBAAgB,IAAI,cAAc,CAE5C;IAEY,4BAA4B,CAAC,EAAE,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAsEzG,mBAAmB,CAAC,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAwBnE,gBAAgB,CAAC,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,SAAS,GAAE,MAAU,GAAG,OAAO,CAAC,OAAO,CAAC;IAyCjI;;;;;;OAMG;IACU,0CAA0C,CAAC,EAAE,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,UAAU,GAAE,OAAc,EAAE,SAAS,GAAE,MAAU,GAAG,OAAO,CAAC,OAAO,CAAC;IA8BpM,4BAA4B,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE;IAetE,gDAAgD,CAAC,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,UAAU,GAAE,OAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAY/K,sCAAsC,CAAC,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,UAAU,GAAE,OAAc,GAAG,OAAO,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,MAAM,CAAA;KAAC,CAAC;IAsIzM,SAAS,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;IAWnD,4BAA4B,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,EAAE;IAsBpD,iBAAiB,CAAC,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC;IA2C7E,+BAA+B,CAAC,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,CAAA;KAAC,CAAC;IA6FjH,4BAA4B,CAAC,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC;IAsBhF,gCAAgC,IAAI,MAAM;IAe1C,iCAAiC,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM;IAahF,gBAAgB,CAAC,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC;IA0B3E,SAAS,CAAC,uBAAuB,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM;IAS7D,SAAS,CAAC,qBAAqB,CAAC,YAAY,EAAE,eAAe,EAAE,GAAG,MAAM;IAYlE,mCAAmC,CAAC,EAAE,EAAE,UAAU,EAAE,YAAY,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IA4C3G,SAAS,CAAC,6BAA6B,CAAC,UAAU,EAAE,MAAM,GAAG;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,kBAAkB,EAAE,OAAO,CAAA;KAAC;IAc7G,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAQvC,SAAS,CAAC,qBAAqB,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;IAczF,SAAS,CAAC,yCAAyC,CAAC,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM;IAWrG,SAAS,CAAC,gBAAgB,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM;IA0DtD,SAAS,CAAC,gBAAgB,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM;IAwCtD,SAAS,CAAC,6BAA6B,CAAC,YAAY,EAAE,eAAe,EAAE,EAAE,QAAQ,EAAE,OAAO,GAAG,MAAM;IAsBnG,SAAS,CAAC,8BAA8B,CAAC,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,eAAe,EAAE,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM;IAgCrH,SAAS,CAAC,8BAA8B,CAAC,YAAY,EAAE,eAAe,EAAE,GAAG,MAAM;IA8BjF,SAAS,CAAC,gBAAgB,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM;IAwCtD,SAAS,CAAC,sBAAsB,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM;CA8C/D"}