@dereekb/dbx-cli 13.11.1 → 13.11.2

package/manifest-extract/index.cjs.js

@@ -0,0 +1,459 @@
+'use strict';
+
+var tsMorph = require('ts-morph');
+
+// 'query' is accepted today even though `<Group>ModelCrudFunctionsConfig` in @dereekb/firebase does not yet permit `query:` keys (deferred follow-up). Once query support lands upstream, every query entry flows through here with no change.
+var SUPPORTED_VERBS = new Set([
+    'create',
+    'read',
+    'update',
+    'delete',
+    'query'
+]);
+/**
+ * Walks a `<model>.api.ts` source and returns one {@link CrudEntry} per
+ * callable leaf (CRUD or standalone). Best-effort: malformed configs return
+ * fewer entries rather than throwing.
+ *
+ * @param source - in-memory source name + text pair to extract
+ * @returns the CRUD extraction with group name, model keys, entries, and
+ *   `*Functions` class name (when present).
+ */ // eslint-disable-next-line sonarjs/cognitive-complexity
+function extractCrudEntries(source) {
+    var project = new tsMorph.Project({
+        useInMemoryFileSystem: true,
+        skipAddingFilesFromTsConfig: true
+    });
+    var sourceFile = project.createSourceFile(source.name, source.text, {
+        overwrite: true
+    });
+    var entries = [];
+    var modelKeys = [];
+    var crudConfigType = findTypeAliasByEnding(sourceFile, 'ModelCrudFunctionsConfig');
+    var groupName = inferGroupName(sourceFile);
+    var functionsClassName = findFunctionsClassName(sourceFile);
+    var typeDocsCache = new Map();
+    var resolveTypeDocs = function resolveTypeDocs(typeName) {
+        if (!typeName) {
+            return undefined;
+        }
+        if (typeDocsCache.has(typeName)) {
+            return typeDocsCache.get(typeName);
+        }
+        var docs = readTypeDocs(sourceFile, typeName);
+        if (docs) {
+            typeDocsCache.set(typeName, docs);
+        }
+        return docs;
+    };
+    if (crudConfigType) {
+        var literal = crudConfigType.getTypeNode();
+        if (literal && tsMorph.Node.isTypeLiteral(literal)) {
+            var _iteratorNormalCompletion = true, _didIteratorError = false, _iteratorError = undefined;
+            try {
+                for(var _iterator = literal.getMembers()[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true){
+                    var member = _step.value;
+                    if (!tsMorph.Node.isPropertySignature(member)) {
+                        continue;
+                    }
+                    var modelName = member.getName();
+                    modelKeys.push(modelName);
+                    var valueNode = member.getTypeNode();
+                    if (!valueNode) {
+                        continue;
+                    }
+                    if (isNullLiteralType(valueNode)) {
+                        continue;
+                    }
+                    if (tsMorph.Node.isTypeLiteral(valueNode)) {
+                        var _iteratorNormalCompletion1 = true, _didIteratorError1 = false, _iteratorError1 = undefined;
+                        try {
+                            for(var _iterator1 = valueNode.getMembers()[Symbol.iterator](), _step1; !(_iteratorNormalCompletion1 = (_step1 = _iterator1.next()).done); _iteratorNormalCompletion1 = true){
+                                var verbMember = _step1.value;
+                                if (!tsMorph.Node.isPropertySignature(verbMember)) {
+                                    continue;
+                                }
+                                var verbName = verbMember.getName();
+                                if (!SUPPORTED_VERBS.has(verbName)) {
+                                    continue;
+                                }
+                                var verb = verbName;
+                                var verbValueNode = verbMember.getTypeNode();
+                                if (!verbValueNode) {
+                                    continue;
+                                }
+                                collectVerbEntries({
+                                    modelName: modelName,
+                                    verb: verb,
+                                    valueNode: verbValueNode,
+                                    entries: entries,
+                                    fallbackDescription: readJsDocSummary(verbMember),
+                                    resolveTypeDocs: resolveTypeDocs
+                                });
+                            }
+                        } catch (err) {
+                            _didIteratorError1 = true;
+                            _iteratorError1 = err;
+                        } finally{
+                            try {
+                                if (!_iteratorNormalCompletion1 && _iterator1.return != null) {
+                                    _iterator1.return();
+                                }
+                            } finally{
+                                if (_didIteratorError1) {
+                                    throw _iteratorError1;
+                                }
+                            }
+                        }
+                    }
+                }
+            } catch (err) {
+                _didIteratorError = true;
+                _iteratorError = err;
+            } finally{
+                try {
+                    if (!_iteratorNormalCompletion && _iterator.return != null) {
+                        _iterator.return();
+                    }
+                } finally{
+                    if (_didIteratorError) {
+                        throw _iteratorError;
+                    }
+                }
+            }
+        }
+    }
+    var functionTypeMap = findTypeAliasByEnding(sourceFile, 'FunctionTypeMap');
+    if (functionTypeMap) {
+        var literal1 = functionTypeMap.getTypeNode();
+        if (literal1 && tsMorph.Node.isTypeLiteral(literal1)) {
+            var _iteratorNormalCompletion2 = true, _didIteratorError2 = false, _iteratorError2 = undefined;
+            try {
+                for(var _iterator2 = literal1.getMembers()[Symbol.iterator](), _step2; !(_iteratorNormalCompletion2 = (_step2 = _iterator2.next()).done); _iteratorNormalCompletion2 = true){
+                    var member1 = _step2.value;
+                    if (!tsMorph.Node.isPropertySignature(member1)) {
+                        continue;
+                    }
+                    var key = member1.getName();
+                    var valueNode1 = member1.getTypeNode();
+                    var tuple = valueNode1 ? readTupleParamsResult(valueNode1) : undefined;
+                    var paramsDocs = resolveTypeDocs(tuple === null || tuple === void 0 ? void 0 : tuple.params);
+                    var resultDocs = resolveTypeDocs(tuple === null || tuple === void 0 ? void 0 : tuple.result);
+                    entries.push({
+                        model: key,
+                        verb: 'standalone',
+                        specifier: undefined,
+                        paramsTypeName: tuple === null || tuple === void 0 ? void 0 : tuple.params,
+                        resultTypeName: tuple === null || tuple === void 0 ? void 0 : tuple.result,
+                        line: member1.getStartLineNumber(),
+                        description: readJsDocSummary(member1),
+                        paramsTypeDescription: paramsDocs === null || paramsDocs === void 0 ? void 0 : paramsDocs.typeDescription,
+                        paramsFields: paramsDocs === null || paramsDocs === void 0 ? void 0 : paramsDocs.fields,
+                        resultTypeDescription: resultDocs === null || resultDocs === void 0 ? void 0 : resultDocs.typeDescription,
+                        resultFields: resultDocs === null || resultDocs === void 0 ? void 0 : resultDocs.fields
+                    });
+                }
+            } catch (err) {
+                _didIteratorError2 = true;
+                _iteratorError2 = err;
+            } finally{
+                try {
+                    if (!_iteratorNormalCompletion2 && _iterator2.return != null) {
+                        _iterator2.return();
+                    }
+                } finally{
+                    if (_didIteratorError2) {
+                        throw _iteratorError2;
+                    }
+                }
+            }
+        }
+    }
+    return {
+        groupName: groupName,
+        modelKeys: modelKeys,
+        entries: entries,
+        functionsClassName: functionsClassName
+    };
+}
+function findTypeAliasByEnding(sourceFile, ending) {
+    var _iteratorNormalCompletion = true, _didIteratorError = false, _iteratorError = undefined;
+    try {
+        for(var _iterator = sourceFile.getTypeAliases()[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true){
+            var alias = _step.value;
+            if (alias.getName().endsWith(ending) && alias.getTypeNode()) {
+                return alias;
+            }
+        }
+    } catch (err) {
+        _didIteratorError = true;
+        _iteratorError = err;
+    } finally{
+        try {
+            if (!_iteratorNormalCompletion && _iterator.return != null) {
+                _iterator.return();
+            }
+        } finally{
+            if (_didIteratorError) {
+                throw _iteratorError;
+            }
+        }
+    }
+    return undefined;
+}
+function findFunctionsClassName(sourceFile) {
+    var _iteratorNormalCompletion = true, _didIteratorError = false, _iteratorError = undefined;
+    try {
+        for(var _iterator = sourceFile.getClasses()[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true){
+            var cls = _step.value;
+            if (!cls.isAbstract()) {
+                continue;
+            }
+            var name = cls.getName();
+            if (name === null || name === void 0 ? void 0 : name.endsWith('Functions')) {
+                return name;
+            }
+        }
+    } catch (err) {
+        _didIteratorError = true;
+        _iteratorError = err;
+    } finally{
+        try {
+            if (!_iteratorNormalCompletion && _iterator.return != null) {
+                _iterator.return();
+            }
+        } finally{
+            if (_didIteratorError) {
+                throw _iteratorError;
+            }
+        }
+    }
+    return undefined;
+}
+function inferGroupName(sourceFile) {
+    var _iteratorNormalCompletion = true, _didIteratorError = false, _iteratorError = undefined;
+    try {
+        for(var _iterator = sourceFile.getTypeAliases()[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true){
+            var alias = _step.value;
+            var name = alias.getName();
+            if (name.endsWith('ModelCrudFunctionsConfig')) {
+                var stem = name.slice(0, -'ModelCrudFunctionsConfig'.length);
+                if (stem.length > 0) {
+                    return stem;
+                }
+            }
+        }
+    } catch (err) {
+        _didIteratorError = true;
+        _iteratorError = err;
+    } finally{
+        try {
+            if (!_iteratorNormalCompletion && _iterator.return != null) {
+                _iterator.return();
+            }
+        } finally{
+            if (_didIteratorError) {
+                throw _iteratorError;
+            }
+        }
+    }
+    var _iteratorNormalCompletion1 = true, _didIteratorError1 = false, _iteratorError1 = undefined;
+    try {
+        for(var _iterator1 = sourceFile.getTypeAliases()[Symbol.iterator](), _step1; !(_iteratorNormalCompletion1 = (_step1 = _iterator1.next()).done); _iteratorNormalCompletion1 = true){
+            var alias1 = _step1.value;
+            var name1 = alias1.getName();
+            if (name1.endsWith('FunctionTypeMap')) {
+                var stem1 = name1.slice(0, -'FunctionTypeMap'.length);
+                if (stem1.length > 0) {
+                    return stem1;
+                }
+            }
+        }
+    } catch (err) {
+        _didIteratorError1 = true;
+        _iteratorError1 = err;
+    } finally{
+        try {
+            if (!_iteratorNormalCompletion1 && _iterator1.return != null) {
+                _iterator1.return();
+            }
+        } finally{
+            if (_didIteratorError1) {
+                throw _iteratorError1;
+            }
+        }
+    }
+    return undefined;
+}
+function isNullLiteralType(node) {
+    if (tsMorph.Node.isLiteralTypeNode(node)) {
+        var literal = node.getLiteral();
+        if (tsMorph.Node.isNullLiteral(literal)) {
+            return true;
+        }
+    }
+    return false;
+}
+function collectVerbEntries(input) {
+    var _readTupleParamsResult;
+    var modelName = input.modelName, verb = input.verb, valueNode = input.valueNode, entries = input.entries, fallbackDescription = input.fallbackDescription, resolveTypeDocs = input.resolveTypeDocs;
+    if (tsMorph.Node.isTypeLiteral(valueNode)) {
+        var _iteratorNormalCompletion = true, _didIteratorError = false, _iteratorError = undefined;
+        try {
+            for(var _iterator = valueNode.getMembers()[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true){
+                var specMember = _step.value;
+                var _readTupleParamsResult1;
+                if (!tsMorph.Node.isPropertySignature(specMember)) {
+                    continue;
+                }
+                var specifier = specMember.getName();
+                var leafNode = specMember.getTypeNode();
+                var leaf = leafNode ? (_readTupleParamsResult1 = readTupleParamsResult(leafNode)) !== null && _readTupleParamsResult1 !== void 0 ? _readTupleParamsResult1 : readBareParams(leafNode) : undefined;
+                var paramsDocs = resolveTypeDocs(leaf === null || leaf === void 0 ? void 0 : leaf.params);
+                var resultDocs = resolveTypeDocs(leaf === null || leaf === void 0 ? void 0 : leaf.result);
+                entries.push({
+                    model: modelName,
+                    verb: verb,
+                    specifier: specifier,
+                    paramsTypeName: leaf === null || leaf === void 0 ? void 0 : leaf.params,
+                    resultTypeName: leaf === null || leaf === void 0 ? void 0 : leaf.result,
+                    line: specMember.getStartLineNumber(),
+                    description: readJsDocSummary(specMember),
+                    paramsTypeDescription: paramsDocs === null || paramsDocs === void 0 ? void 0 : paramsDocs.typeDescription,
+                    paramsFields: paramsDocs === null || paramsDocs === void 0 ? void 0 : paramsDocs.fields,
+                    resultTypeDescription: resultDocs === null || resultDocs === void 0 ? void 0 : resultDocs.typeDescription,
+                    resultFields: resultDocs === null || resultDocs === void 0 ? void 0 : resultDocs.fields
+                });
+            }
+        } catch (err) {
+            _didIteratorError = true;
+            _iteratorError = err;
+        } finally{
+            try {
+                if (!_iteratorNormalCompletion && _iterator.return != null) {
+                    _iterator.return();
+                }
+            } finally{
+                if (_didIteratorError) {
+                    throw _iteratorError;
+                }
+            }
+        }
+        return;
+    }
+    var leaf1 = (_readTupleParamsResult = readTupleParamsResult(valueNode)) !== null && _readTupleParamsResult !== void 0 ? _readTupleParamsResult : readBareParams(valueNode);
+    var paramsDocs1 = resolveTypeDocs(leaf1 === null || leaf1 === void 0 ? void 0 : leaf1.params);
+    var resultDocs1 = resolveTypeDocs(leaf1 === null || leaf1 === void 0 ? void 0 : leaf1.result);
+    entries.push({
+        model: modelName,
+        verb: verb,
+        specifier: undefined,
+        paramsTypeName: leaf1 === null || leaf1 === void 0 ? void 0 : leaf1.params,
+        resultTypeName: leaf1 === null || leaf1 === void 0 ? void 0 : leaf1.result,
+        line: valueNode.getStartLineNumber(),
+        description: fallbackDescription,
+        paramsTypeDescription: paramsDocs1 === null || paramsDocs1 === void 0 ? void 0 : paramsDocs1.typeDescription,
+        paramsFields: paramsDocs1 === null || paramsDocs1 === void 0 ? void 0 : paramsDocs1.fields,
+        resultTypeDescription: resultDocs1 === null || resultDocs1 === void 0 ? void 0 : resultDocs1.typeDescription,
+        resultFields: resultDocs1 === null || resultDocs1 === void 0 ? void 0 : resultDocs1.fields
+    });
+}
+function readTupleParamsResult(node) {
+    if (!tsMorph.Node.isTupleTypeNode(node)) {
+        return undefined;
+    }
+    var elements = node.getElements();
+    if (elements.length === 0) {
+        return undefined;
+    }
+    var params = elements[0] ? typeNodeName(elements[0]) : undefined;
+    var result = elements[1] ? typeNodeName(elements[1]) : undefined;
+    return {
+        params: params,
+        result: result
+    };
+}
+function readBareParams(node) {
+    var params = typeNodeName(node);
+    if (!params) {
+        return undefined;
+    }
+    return {
+        params: params,
+        result: undefined
+    };
+}
+function typeNodeName(node) {
+    if (tsMorph.Node.isTypeReference(node)) {
+        return node.getTypeName().getText();
+    }
+    // Fall back to the raw text for primitive / inline types like `boolean`.
+    var text = node.getText().trim();
+    return text.length > 0 ? text : undefined;
+}
+function readTypeDocs(sourceFile, typeName) {
+    var interfaceDecl = sourceFile.getInterface(typeName);
+    if (interfaceDecl) {
+        var typeDescription = readJsDocSummary(interfaceDecl);
+        var fields = [];
+        var _iteratorNormalCompletion = true, _didIteratorError = false, _iteratorError = undefined;
+        try {
+            for(var _iterator = interfaceDecl.getProperties()[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true){
+                var property = _step.value;
+                var _ref;
+                var fieldName = property.getName();
+                var description = readJsDocSummary(property);
+                var typeNode = property.getTypeNode();
+                var typeText = (_ref = typeNode === null || typeNode === void 0 ? void 0 : typeNode.getText().trim()) !== null && _ref !== void 0 ? _ref : '';
+                var field = description ? {
+                    name: fieldName,
+                    typeText: typeText,
+                    description: description
+                } : {
+                    name: fieldName,
+                    typeText: typeText
+                };
+                fields.push(field);
+            }
+        } catch (err) {
+            _didIteratorError = true;
+            _iteratorError = err;
+        } finally{
+            try {
+                if (!_iteratorNormalCompletion && _iterator.return != null) {
+                    _iterator.return();
+                }
+            } finally{
+                if (_didIteratorError) {
+                    throw _iteratorError;
+                }
+            }
+        }
+        if (!typeDescription && fields.length === 0) {
+            return undefined;
+        }
+        return {
+            typeDescription: typeDescription,
+            fields: fields.length > 0 ? fields : undefined
+        };
+    }
+    var typeAlias = sourceFile.getTypeAlias(typeName);
+    if (typeAlias) {
+        var typeDescription1 = readJsDocSummary(typeAlias);
+        return typeDescription1 ? {
+            typeDescription: typeDescription1
+        } : undefined;
+    }
+    return undefined;
+}
+function readJsDocSummary(node) {
+    var docs = node.getJsDocs();
+    if (docs.length === 0) {
+        return undefined;
+    }
+    var last = docs[docs.length - 1];
+    var description = last.getDescription().trim();
+    return description.length > 0 ? description : undefined;
+}
+
+exports.extractCrudEntries = extractCrudEntries;

package/manifest-extract/index.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './index.cjs.js';
+export { _default as default } from './index.cjs.default.js';

package/manifest-extract/index.d.ts

@@ -0,0 +1 @@
+export * from "./src/index";