@memberjunction/global 2.111.0 → 2.112.0

package/dist/generic/transactionGroup.js

@@ -0,0 +1,357 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionGroupBase = exports.TransactionVariable = exports.TransactionPreprocessingItem = exports.TransactionResult = exports.TransactionItem = void 0;
+const rxjs_1 = require("rxjs");
+const logging_1 = require("./logging");
+/**
+ * Internal class used by TransactionGroupBase and sub-classes to manage individual transactions
+ */
+class TransactionItem {
+    get Vars() {
+        return this._vars;
+    }
+    get ExtraData() {
+        return this._extraData;
+    }
+    get Instruction() {
+        return this._instruction;
+    }
+    set Instruction(value) {
+        this._instruction = value;
+    }
+    /**
+     * Callback function that gets called when the transaction is complete
+     * @returns A function that takes a result object (database row) and a success boolean
+     */
+    get CallBack() {
+        return this._callBack;
+    }
+    get BaseEntity() {
+        return this._baseEntity;
+    }
+    get OperationType() {
+        return this._operationType;
+    }
+    /**
+     * Creates a new TransactionItem
+     * @param baseEntity The base entity object this transaction is associated with
+     * @param operationType The type of operation (Create, Update, Delete)
+     * @param instruction The SQL or GraphQL instruction to execute
+     * @param vars Variables to pass to the SQL or GraphQL
+     * @param extraData Additional data needed for processing by the provider
+     * @param callBack Callback function that gets called when the transaction completes
+     */
+    constructor(baseEntity, operationType, instruction, vars, extraData, callBack) {
+        this._operationType = operationType;
+        this._baseEntity = baseEntity;
+        this._instruction = instruction;
+        this._vars = vars;
+        this._extraData = extraData;
+        this._callBack = callBack;
+    }
+}
+exports.TransactionItem = TransactionItem;
+/**
+ * Tracks the individual transactions within a transaction group and their commit results
+ */
+class TransactionResult {
+    constructor(transaction, result, success) {
+        this.Transaction = transaction;
+        this.Result = result;
+        this.Success = success;
+    }
+}
+exports.TransactionResult = TransactionResult;
+/**
+ * Used internally within the transaction group to manage the preprocessing of entities before a transaction is submitted
+ */
+class TransactionPreprocessingItem {
+    constructor(entity, completionPromise) {
+        this.complete = false;
+        this.entity = entity;
+        this.completionPromise = completionPromise;
+    }
+}
+exports.TransactionPreprocessingItem = TransactionPreprocessingItem;
+/**
+ * This class is used to encapsulate the concept of a variable to be used within a transaction group. This is designed to allow for the flow
+ * of data from one item in a transaction group to another. For example say you had a transaction group where you are creating a new record in
+ * EntityA and you wanted to get the newly created ID value from that record and then set it into a field called "EntityA_ID" in a record in EntityB.
+ * You can do this by telling the TransactionGroup about these variables with the AddVariable() method in the TransactionGroupBase/sub-classes.
+ */
+class TransactionVariable {
+    get Name() {
+        return this._name;
+    }
+    get EntityObject() {
+        return this._entityObject;
+    }
+    get FieldName() {
+        return this._fieldName;
+    }
+    get Type() {
+        return this._type;
+    }
+    /**
+     * Indicates if the variable has been processed. This is only true after the transaction group has been submitted and the results have been mapped back to the variables.
+     */
+    get IsProcessed() {
+        return this._isProcessed;
+    }
+    /**
+     * Processed Value is only available after the related transaction item has been executed and the results have been mapped back to the variables that are related to that transaction item.
+     */
+    get ProcessedValue() {
+        return this._processedValue;
+    }
+    set ProcessedValue(value) {
+        this._processedValue = value;
+        this._isProcessed = true;
+    }
+    constructor(name, entityObject, fieldName, type) {
+        this._isProcessed = false;
+        this._name = name;
+        this._entityObject = entityObject;
+        this._fieldName = fieldName;
+        this._type = type;
+    }
+}
+exports.TransactionVariable = TransactionVariable;
+/**
+ * TransactionGroup is a class that handles the bundling of multiple transactions into a single request. The provider handles
+ * the implementation details. If a transaction group is provided to the baseEntity object before either Save() or Delete() is called
+ * instead of just immediately executing its SQL or GQL, it provides the instructions to the TransactionGroup object instead.
+ *
+ * Then, whenever the TransactionGroup object instance has its Submit() method called, all of the requests will be bundled into a single
+ * request and handled. For example in the case of the GraphQLDataProvider, we queue up all of the GQL statements for all of the
+ * mutations and send them across as a single GraphQL request. The GraphQL server handles the actual DB transaction stuff.
+ *
+ * TransactionGroup will call a callback function, if provided, after the transaction has either completed succesfully or failed.
+ * If it is succesful, for Save() method calls, the latest data for that record will be provided back.
+ * For Delete() method calls, the callback will be called with no data.
+ *
+ * This class is the base class for managing a group of transactions and submitting it to the provider so it can be handled as an ATOMic transaction
+ */
+class TransactionGroupBase {
+    constructor() {
+        this._pendingTransactions = [];
+        this._variables = [];
+        this._status = 'Pending';
+        // RxJS Subject to notify about transaction status
+        this.transactionNotifier = new rxjs_1.Subject();
+        this._preprocessingItems = [];
+    }
+    get PendingTransactions() {
+        return this._pendingTransactions;
+    }
+    get Status() {
+        return this._status;
+    }
+    /**
+     * The array of variables that are to be used within the transaction group. These are used to pass data from one transaction item to another. See documentation on @class TransactionVariable
+     */
+    get Variables() {
+        return this._variables;
+    }
+    /**
+     * Adds a new variable to the transaction group.
+     */
+    AddVariable(newVariable) {
+        this._variables.push(newVariable);
+    }
+    // Expose transaction notifications as an observable
+    get TransactionNotifications$() {
+        return this.transactionNotifier.asObservable();
+    }
+    /**
+     * Notifies observers about transaction success or failure
+     * @param success Whether the transaction was successful
+     * @param results The transaction results (if applicable)
+     * @param error Any error that occurred (if applicable)
+     */
+    NotifyTransactionStatus(success, results, error) {
+        this.transactionNotifier.next({ success, results, error });
+    }
+    /**
+     * If an entity object needs to conduct any type of asynchronous preprocessing before a transaction is submitted, it must notify its transaction group
+     * that it is doing so with this method. This causes the TransactionGroup to wait for all preprocessing to be completed before submitting the transaction.
+     * This method checks to see if an the entity has already been registered for preprocessing and if so, does nothing.
+     * @param entity
+     */
+    RegisterPreprocessing(entity) {
+        const existingEntry = this._preprocessingItems.find((i) => i.entity === entity);
+        if (!existingEntry) {
+            const preprocessingPromise = new Promise((resolve) => {
+                entity.RegisterEventHandler((e) => {
+                    if (e.type === 'transaction_ready' && e.baseEntity === entity) {
+                        const found = this._preprocessingItems.find((i) => i.entity === entity);
+                        if (found) {
+                            found.complete = true;
+                            resolve();
+                        }
+                    }
+                });
+            });
+            const newItem = new TransactionPreprocessingItem(entity, preprocessingPromise);
+            this._preprocessingItems.push(newItem);
+        }
+    }
+    /**
+     * Indicates whether all of the entities that have registered with this transaction group have completed their preprocessing
+     * @returns
+     */
+    PreprocessingComplete() {
+        if (this._preprocessingItems.length === 0)
+            return true;
+        else
+            return this._preprocessingItems.every((i) => i.complete);
+    }
+    /**
+     * Waits for all preprocessing to be complete.
+     */
+    async waitForPreprocessing() {
+        try {
+            await Promise.all(this._preprocessingItems.map(item => item.completionPromise));
+            this._preprocessingItems = []; // clear out the preprocessing items
+        }
+        catch (e) {
+            (0, logging_1.LogError)(`Error during preprocessing TransactionGroupBase. Error: ${e.message}`);
+        }
+    }
+    /**
+     * This is used by the BaseEntity/Provider objects to manage transactions on your behalf.
+     * WARNING: Do NOT directly call this method. Instead set the TransactionGroup property on
+     * the @BaseEntity class to make an entity object part of a transaction group.
+     * @param transaction
+     */
+    AddTransaction(transaction) {
+        this._pendingTransactions.push(transaction);
+    }
+    /**
+     * Helper method for sub-classes to map a variable to a position in the pending transactions array
+     * @param variable
+     * @returns
+     */
+    MapVariableEntityObjectToPosition(variable) {
+        const index = this._pendingTransactions.findIndex((t) => {
+            return t.BaseEntity === variable.EntityObject;
+        });
+        return index;
+    }
+    /**
+     * Submits the transaction group to the provider for handling. The provider will handle the actual transaction and call the callback functions
+     * @returns true if the transaction was successful, false if it failed. If the method fails, check each of the individual BaseEntity objects within
+     * the TransactionGroup for their result histories using BaseEntity.ResultHistory and BaseEntity.LatestResult
+     * @param allowRetryOfFailedTransaction If true, the transaction group will be resubmitted even if it has failed. If false, the transaction group will not be resubmitted if it has failed.
+     */
+    async Submit(allowRetryOfFailedTransaction = false) {
+        if (this.Status === 'Complete') {
+            throw new Error('TransactionGroup has already been completed');
+        }
+        else if (this.Status === 'In Progress') {
+            throw new Error('TransactionGroup is already in progress');
+        }
+        else if (this.Status === 'Failed') {
+            if (!allowRetryOfFailedTransaction) {
+                throw new Error('TransactionGroup has failed and cannot be resubmitted unless allowRetryOfFailedTransaction is set to true');
+            }
+            else {
+                // the caller has specifid that we can retry the transaction even if it has failed, log this and continue
+                (0, logging_1.LogStatus)('TransactionGroupBase.Submit', 'TransactionGroup is in a failed state, resubmitting');
+            }
+        }
+        this._status = 'In Progress';
+        try {
+            // Wait for all preprocessing to be complete
+            await this.waitForPreprocessing();
+            if (this._pendingTransactions.length > 0) {
+                // subclass handles the actual submit implementation whatever that does
+                let results = await this.HandleSubmit();
+                // now we have the results back, so we can call the callback functions
+                for (let i = 0; i < results.length; i++) {
+                    await results[i].Transaction.CallBack(results[i].Result, results[i].Success);
+                }
+                // now, see if there are any false values for results[x].Success, if so, we have to return false
+                const overallSuccess = results.every(r => r.Success);
+                this.NotifyTransactionStatus(overallSuccess, results);
+                this._status = overallSuccess ? 'Complete' : 'Failed';
+                return overallSuccess;
+            }
+            else {
+                // there are no transactions to submit, so we just return true and go back to pending since there were no transactions
+                (0, logging_1.LogStatus)('No transactions to submit, switching status back to Pending');
+                this._status = 'Pending';
+                return true;
+            }
+        }
+        catch (err) {
+            console.error(err);
+            // it failed, so we have to call the callback functions with the error
+            for (let i = 0; i < this._pendingTransactions.length; i++) {
+                await this._pendingTransactions[i].CallBack(err, false);
+            }
+            this.NotifyTransactionStatus(false, undefined, err);
+            this._status = 'Failed';
+            return false;
+        }
+    }
+    /**
+     * This utility method is to be used by sub-classes to set the values of the variables on the BaseEntity objects before the transaction is executed for variables
+     * that are defined as 'Use' type. This is used to pass values from one transaction item to another.
+     * @param entityObject
+     * @returns the number of values set on the entity object
+     */
+    SetEntityValuesFromVariables(entityObject) {
+        let numSet = 0;
+        const vars = this.Variables.filter(v => v.EntityObject === entityObject);
+        // we have variables that we need to handle for this object. For any variables that have type of 'Use'
+        // we need to set those values on the object before we execute the query
+        for (const varItem of vars) {
+            if (varItem.Type === 'Use') {
+                // get the value from the variable that matches the NAME that has Type === 'Define'
+                const defineVar = this.Variables.find(v => v.Name.trim().toLowerCase() === varItem.Name.trim().toLowerCase() && v.Type === 'Define');
+                if (defineVar) {
+                    if (defineVar.IsProcessed) {
+                        // found the variable definition, now get the value from that BaseEntity from the variable's source field name
+                        const value = defineVar.ProcessedValue;
+                        // set the value on the BaseEntity for the current item
+                        entityObject.Set(varItem.FieldName, value);
+                        numSet++;
+                    }
+                    else {
+                        // the definition of the variable was never processed, so we can't set the value, must throw an exception and blow up the transaction
+                        throw new Error(`Variable ${varItem.Name} was never processed, can't continue with transaction`);
+                    }
+                }
+                else {
+                    // we can't set the value, must throw an exception and blow up the transaction
+                    throw new Error(`Unable to find variable definition for variable ${varItem.Name}, can't continue with transaction`);
+                }
+            }
+        }
+        return numSet;
+    }
+    /**
+     * This utility method is to be used by sub-classes to set the values of the variables on the BaseEntity objects after the transaction is executed for variables
+     * @returns the number of variables that had their processed values set from the provided entity object
+     */
+    SetVariableValuesFromEntity(entityObject, queryResults) {
+        let numVarsSet = 0;
+        const vars = this.Variables.filter(v => v.EntityObject === entityObject);
+        // we have variables that we need to handle for this object. For any variables that have type of 'Define'
+        // we need to set those values on the variable object after we execute the query and have the results
+        for (const varItem of vars) {
+            if (varItem.Type === 'Define') {
+                // get the value from the query results
+                const value = queryResults[varItem.FieldName];
+                // stash the value into the variable object
+                varItem.ProcessedValue = value;
+                // increment the counter
+                numVarsSet++;
+            }
+        }
+        return numVarsSet;
+    }
+}
+exports.TransactionGroupBase = TransactionGroupBase;
+//# sourceMappingURL=transactionGroup.js.map

package/dist/generic/transactionGroup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactionGroup.js","sourceRoot":"","sources":["../../src/generic/transactionGroup.ts"],"names":[],"mappings":";;;AAAA,+BAA+B;AAE/B,uCAAgD;AAEhD;;GAEG;AACH,MAAa,eAAe;IAaxB,IAAW,IAAI;QACX,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;IACD,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IACD,IAAW,WAAW;QAClB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;IACD,IAAW,WAAW,CAAC,KAAa;QAChC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;IAC9B,CAAC;IACD;;;OAGG;IACH,IAAW,QAAQ;QACf,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IACD,IAAW,UAAU;QACjB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IACD,IAAW,aAAa;QACpB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC/B,CAAC;IAED;;;;;;;;OAQG;IACH,YAAa,UAAsB,EAAE,aAA6C,EAAE,WAAmB,EAAE,IAAS,EAAE,SAAc,EAAE,QAAiE;QACjM,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QACpC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC9B,CAAC;CACJ;AAxDD,0CAwDC;AAED;;GAEG;AACH,MAAa,iBAAiB;IAQ1B,YAAY,WAA4B,EAAE,MAAW,EAAE,OAAgB;QACnE,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;CACJ;AAbD,8CAaC;AAGD;;GAEG;AACH,MAAa,4BAA4B;IAKrC,YAAY,MAAkB,EAAE,iBAAgC;QAHhE,aAAQ,GAAY,KAAK,CAAC;QAItB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;IAC/C,CAAC;CACJ;AATD,oEASC;AAED;;;;;GAKG;AACH,MAAa,mBAAmB;IAQ5B,IAAW,IAAI;QACX,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;IACD,IAAW,YAAY;QACnB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC9B,CAAC;IACD,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IACD,IAAW,IAAI;QACX,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,IAAW,WAAW;QAClB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,IAAW,cAAc;QACrB,OAAO,IAAI,CAAC,eAAe,CAAC;IAChC,CAAC;IACD,IAAW,cAAc,CAAC,KAAU;QAChC,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;QAC7B,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;IAC7B,CAAC;IAED,YAAY,IAAY,EAAE,YAAwB,EAAE,SAAiB,EAAE,IAAsB;QAjCrF,iBAAY,GAAY,KAAK,CAAC;QAkClC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACtB,CAAC;CACJ;AA7CD,kDA6CC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAsB,oBAAoB;IAA1C;QACY,yBAAoB,GAAsB,EAAE,CAAC;QAC7C,eAAU,GAA0B,EAAE,CAAC;QACvC,YAAO,GAAsD,SAAS,CAAC;QAwB/E,kDAAkD;QAC1C,wBAAmB,GAAG,IAAI,cAAO,EAAoE,CAAC;QAiBtG,wBAAmB,GAAmC,EAAE,CAAC;IA2MrE,CAAC;IAnPG,IAAc,mBAAmB;QAC7B,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACrC,CAAC;IAED,IAAW,MAAM;QACb,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,WAAW,CAAC,WAAgC;QAC/C,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACtC,CAAC;IAKD,oDAAoD;IACpD,IAAW,yBAAyB;QAChC,OAAO,IAAI,CAAC,mBAAmB,CAAC,YAAY,EAAE,CAAC;IACnD,CAAC;IAED;;;;;OAKG;IACK,uBAAuB,CAAC,OAAgB,EAAE,OAA6B,EAAE,KAAW;QACxF,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;IAC/D,CAAC;IAGD;;;;;OAKG;IACI,qBAAqB,CAAC,MAAkB;QAC3C,MAAM,aAAa,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC;QAChF,IAAI,CAAC,aAAa,EAAE,CAAC;YACjB,MAAM,oBAAoB,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;gBACvD,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,EAAE;oBAC9B,IAAI,CAAC,CAAC,IAAI,KAAK,mBAAmB,IAAI,CAAC,CAAC,UAAU,KAAK,MAAM,EAAE,CAAC;wBAC5D,MAAM,KAAK,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC;wBACxE,IAAI,KAAK,EAAE,CAAC;4BACR,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC;4BACtB,OAAO,EAAE,CAAC;wBACd,CAAC;oBACL,CAAC;gBACL,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;YAEH,MAAM,OAAO,GAAG,IAAI,4BAA4B,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;YAC/E,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3C,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,qBAAqB;QACxB,IAAI,IAAI,CAAC,mBAAmB,CAAC,MAAM,KAAK,CAAC;YACrC,OAAO,IAAI,CAAC;;YAEZ,OAAO,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;IACjE,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,oBAAoB;QAChC,IAAI,CAAC;YACD,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;YAChF,IAAI,CAAC,mBAAmB,GAAG,EAAE,CAAC,CAAC,oCAAoC;QACvE,CAAC;QACD,OAAO,CAAC,EAAE,CAAC;YACP,IAAA,kBAAQ,EAAC,2DAA2D,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;QACpF,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,WAA4B;QAC9C,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAChD,CAAC;IAOD;;;;OAIG;IACO,iCAAiC,CAAC,QAA6B;QACrE,MAAM,KAAK,GAAG,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;YACpD,OAAO,CAAC,CAAC,UAAU,KAAK,QAAQ,CAAC,YAAY,CAAA;QACjD,CAAC,CAAC,CAAC;QACH,OAAO,KAAK,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,gCAAyC,KAAK;QAC9D,IAAI,IAAI,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;QACnE,CAAC;aACI,IAAI,IAAI,CAAC,MAAM,KAAK,aAAa,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAC/D,CAAC;aACI,IAAI,IAAI,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;YAChC,IAAI,CAAC,6BAA6B,EAAE,CAAC;gBACjC,MAAM,IAAI,KAAK,CAAC,2GAA2G,CAAC,CAAC;YACjI,CAAC;iBACI,CAAC;gBACF,yGAAyG;gBACzG,IAAA,mBAAS,EAAC,6BAA6B,EAAE,qDAAqD,CAAC,CAAC;YACpG,CAAC;QACL,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,aAAa,CAAC;QAC7B,IAAI,CAAC;YACD,4CAA4C;YAC5C,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAElC,IAAI,IAAI,CAAC,oBAAoB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvC,uEAAuE;gBACvE,IAAI,OAAO,GAAwB,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;gBAE7D,sEAAsE;gBACtE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;oBACtC,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;gBACjF,CAAC;gBAED,gGAAgG;gBAChG,MAAM,cAAc,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;gBACrD,IAAI,CAAC,uBAAuB,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;gBAEtD,IAAI,CAAC,OAAO,GAAG,cAAc,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC;gBACtD,OAAO,cAAc,CAAC;YAC1B,CAAC;iBACI,CAAC;gBACF,sHAAsH;gBACtH,IAAA,mBAAS,EAAC,6DAA6D,CAAC,CAAC;gBACzE,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;gBACzB,OAAO,IAAI,CAAC;YAChB,CAAC;QACL,CAAC;QACD,OAAO,GAAG,EAAE,CAAC;YACT,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACnB,sEAAsE;YACtE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACxD,MAAM,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAC5D,CAAC;YAED,IAAI,CAAC,uBAAuB,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC;YACpD,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC;YACxB,OAAO,KAAK,CAAC;QACjB,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACO,4BAA4B,CAAC,YAAwB;QAC3D,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,YAAY,CAAC,CAAC;QACzE,sGAAsG;QACtG,wEAAwE;QACxE,KAAK,MAAM,OAAO,IAAI,IAAI,EAAE,CAAC;YACzB,IAAI,OAAO,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;gBACzB,mFAAmF;gBACnF,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;gBACrI,IAAI,SAAS,EAAE,CAAC;oBACZ,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;wBACxB,8GAA8G;wBAC9G,MAAM,KAAK,GAAG,SAAS,CAAC,cAAc,CAAC;wBAEvC,uDAAuD;wBACvD,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;wBAC3C,MAAM,EAAE,CAAC;oBACb,CAAC;yBACI,CAAC;wBACF,qIAAqI;wBACrI,MAAM,IAAI,KAAK,CAAC,YAAY,OAAO,CAAC,IAAI,uDAAuD,CAAC,CAAC;oBACrG,CAAC;gBACL,CAAC;qBACI,CAAC;oBACF,8EAA8E;oBAC9E,MAAM,IAAI,KAAK,CAAC,mDAAmD,OAAO,CAAC,IAAI,mCAAmC,CAAC,CAAC;gBACxH,CAAC;YACL,CAAC;QACL,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;OAGG;IACO,2BAA2B,CAAC,YAAwB,EAAE,YAAiB;QAC7E,IAAI,UAAU,GAAG,CAAC,CAAC;QACnB,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,KAAK,YAAY,CAAC,CAAC;QACzE,yGAAyG;QACzG,qGAAqG;QACrG,KAAK,MAAM,OAAO,IAAI,IAAI,EAAE,CAAC;YACzB,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC5B,uCAAuC;gBACvC,MAAM,KAAK,GAAG,YAAY,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;gBAE9C,2CAA2C;gBAC3C,OAAO,CAAC,cAAc,GAAG,KAAK,CAAC;gBAE/B,wBAAwB;gBACxB,UAAU,EAAE,CAAC;YACjB,CAAC;QACL,CAAC;QACD,OAAO,UAAU,CAAC;IACtB,CAAC;CACJ;AAxPD,oDAwPC"}

package/dist/generic/util.d.ts

@@ -0,0 +1,81 @@
+/**
+ * Returns the TypeScript type that corresponds to the SQL type passed in
+ */
+export declare function TypeScriptTypeFromSQLType(sqlType: string): 'string' | 'number' | 'boolean' | 'Date';
+export declare function TypeScriptTypeFromSQLTypeWithNullableOption(sqlType: string, addNullableOption: boolean): 'string' | 'string | null' | 'number' | 'number | null' | 'boolean' | 'boolean | null' | 'Date' | 'Date | null';
+/**
+ * Formats a value based on the parameters passed in
+ * @param sqlType - Required - the base type in SQL Server, for example int, nvarchar, etc. For types that have a length like numeric(28,4) or nvarchar(50) do NOT provide the length, just numeric and nvarchar in those examples
+ * @param value - Value to format
+ * @param decimals Number of decimals to show, defaults to 2
+ * @param currency Currency to use when formatting, defaults to USD
+ * @param maxLength Maximum length of the string to return, if the formatted value is longer than this length then the string will be truncated and the trailingChars will be appended to the end of the string
+ * @param trailingChars Only used if maxLength is > 0 and the string being formatted is > maxLength, this is the string that will be appended to the end of the string to indicate that it was truncated, defaults to "..."
+ * @returns either the original string value or a formatted version. If the format cannot be applied an an exception occurs it is captured and the error is put to the log, and the original value is returned
+ */
+export declare function FormatValue(sqlType: string, value: any, decimals?: number, currency?: string, maxLength?: number, trailingChars?: string): string;
+/**
+ * Returns a string that contains the full SQL type including length, precision and scale if applicable
+ * @param baseType
+ * @param length
+ * @param precision
+ * @param scale
+ * @returns
+ */
+export declare function SQLFullType(baseType: string, length: number, precision: number, scale: number): string;
+/**
+ * This function determines the actual maximum length for a given SQL field based on the base type and the length specified in the schema.
+ * For example, for a varchar(50) field, the length is 50, for an nvarchar(50) field, the length is 50/2 = 25
+ * @param sqlBaseType
+ * @param sqlLength
+ * @returns
+ */
+export declare function SQLMaxLength(sqlBaseType: string, sqlLength: number): number;
+/**
+ * This function returns an array of common stop words that are used in text processing
+ * @returns An array of common stop words that are used in text processing
+ */
+export declare function CommonStopWords(): string[];
+/**
+ * This function takes a string and removes common stop words from it, using the CommonStopWords() function to get the list of stop words
+ * @param inputString
+ * @returns
+ */
+export declare function StripStopWords(inputString: string): string;
+/**
+ * Returns a system-wide standard CodeName which is a programmatically acceptable identifier for a class, variable, etc using a standard replacement strategy for characters that are not acceptable in that context from a regular name
+ */
+export declare function CodeNameFromString(input: string): string;
+/**
+ * Run concurrent promises with a maximum concurrency level
+ * @param concurrency - The number of concurrently running promises
+ * @param funcs - An array of functions that return promises
+ * @returns A promise that resolves to an array of the resolved values from the promises returned by funcs
+ */
+export declare function Concurrent<V>(concurrency: number, funcs: (() => Promise<V>)[]): Promise<V[]>;
+/**
+ * The DBMS may store the default value for a column with extra parens, for example ((1)) or (getdate()) or (('Pending')) or (('Active')) and in addition for unicode characters
+ * it may prefix the value with an N, for example N'Active'. This function will strip out the extra parens and the N prefix if it exists and return the actual default value
+ * @param storedDefaultValue - The default value as stored in the DBMS
+ */
+export declare function ExtractActualDefaultValue(storedDefaultValue: string): string;
+/**
+ * Strips out the N prefix and single quotes from a string if they exist so that a value like
+ * N'Active' becomes Active
+ */
+export declare function StripUnicodePrefix(value: string): string;
+/**
+ * Strips out single quotes from a string if they exist so that a value like
+ * 'Active' becomes Active
+ * @param value
+ * @returns
+ */
+export declare function StripSingleQuotes(value: string): string;
+/**
+ * Strips out any number of symmetric containing parens from a string, for example ((0)) becomes 0
+ * and ('Active') becomes 'Active'
+ * @param value
+ * @returns
+ */
+export declare function StripContainingParens(value: string): string;
+//# sourceMappingURL=util.d.ts.map

package/dist/generic/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../src/generic/util.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,CAqBnG;AAED,wBAAgB,2CAA2C,CAAC,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,OAAO,GAAG,QAAQ,GAAG,eAAe,GAAG,QAAQ,GAAG,eAAe,GAAG,SAAS,GAAG,gBAAgB,GAAG,MAAM,GAAG,aAAa,CAQxN;AAGD;;;;;;;;;GASG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,GAAG,EACV,QAAQ,GAAE,MAAU,EACpB,QAAQ,GAAE,MAAc,EACxB,SAAS,GAAE,MAAU,EACrB,aAAa,GAAE,MAAc,GAAG,MAAM,CAYjE;AA6CD;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAiBtG;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAa3E;AAyBD;;;GAGG;AACH,wBAAgB,eAAe,IAAI,MAAM,EAAE,CAE1C;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAK1D;AAGD;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAUxD;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAU5F;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAC,kBAAkB,EAAE,MAAM,GAAG,MAAM,CAuB5E;AAGD;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAgBxD;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAQvD;AAGD;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAO3D"}