@cosmology/utils - npm Package Compare versions

Comparing version 1.5.0 to 1.5.1

main/proto.js

@@ -6,3 +6,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getObjectName = exports.isRefExcluded = exports.isRefIncluded = exports.getQueryMethodNames = exports.makeHookKeyName = exports.makeUseHookTypeName = exports.makePkgMethodName = exports.makeUsePkgHookName = exports.makeUseHookNameWithCamel = exports.makeUseHookName = exports.getNested = exports.getNestedProtoGeneric = exports.getNestedProto = void 0;
+exports.getTypeNameFromFieldName = exports.getObjectName = exports.isRefExcluded = exports.isRefIncluded = exports.getQueryMethodNames = exports.makeHookKeyName = exports.makeUseHookTypeName = exports.makePkgMethodName = exports.makeUsePkgHookName = exports.makeUseHookNameWithCamel = exports.makeUseHookName = exports.getNested = exports.getNestedProtoGeneric = exports.getNestedProto = void 0;
 const _1 = require(".");
@@ -164,1 +164,12 @@ const case_1 = require("case");
 exports.getObjectName = getObjectName;
+const getTypeNameFromFieldName = (name, importSrc, ref) => {
+    let importedAs = name;
+    const names = ref.traversed?.importNames;
+    if (names
+        && names.hasOwnProperty(importSrc)
+        && names[importSrc].hasOwnProperty(name)) {
+        importedAs = names[importSrc][name];
+    }
+    return importedAs;
+};
+exports.getTypeNameFromFieldName = getTypeNameFromFieldName;

main/utils.js

@@ -29,3 +29,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.duplicateImportPathsWithExt = exports.restoreExtension = exports.getServiceImplement = exports.buildImports = exports.getTypeNameFromFieldName = exports.getPluginValue = exports.swapKeyValue = void 0;
+exports.getTypeNameByEnumObj = exports.getEnumValues = exports.duplicateImportPathsWithExt = exports.restoreExtension = exports.getServiceImplement = exports.buildImports = exports.getPluginValue = exports.swapKeyValue = void 0;
 const minimatch_1 = __importDefault(require("minimatch"));
@@ -81,13 +81,2 @@ const dotty = __importStar(require("dotty"));
 exports.getPluginValue = getPluginValue;
-const getTypeNameFromFieldName = (name, importSrc, ref) => {
-    let importedAs = name;
-    const names = ref.traversed?.importNames;
-    if (names &&
-        names.hasOwnProperty(importSrc) &&
-        names[importSrc].hasOwnProperty(name)) {
-        importedAs = names[importSrc][name];
-    }
-    return importedAs;
-};
-exports.getTypeNameFromFieldName = getTypeNameFromFieldName;
 const buildImports = (imports) => {
@@ -178,1 +167,33 @@ return imports.map((item) => {
 exports.duplicateImportPathsWithExt = duplicateImportPathsWithExt;
+const getEnumValues = (proto) => {
+    const enums = Object.keys(proto.values).map(key => {
+        const e = {
+            name: key,
+            comment: null,
+            value: null
+        };
+        e.value = proto.values[key];
+        if (proto.comments[key]) {
+            e.comment = proto.comments[key];
+        }
+        return e;
+    });
+    return enums;
+};
+exports.getEnumValues = getEnumValues;
+/**
+ * get the type name by enum object while traversing the nested enum
+ * @param field
+ * @param pkg name space
+ * @param traversal traversed name spaces and nested enum names
+ * @param isNested whether the enum is nested
+ * @returns
+ */
+const getTypeNameByEnumObj = (field, pkg, traversal, isNested) => {
+    return !isNested ? field.name : excludePackageFromTraversal(pkg, traversal);
+};
+exports.getTypeNameByEnumObj = getTypeNameByEnumObj;
+function excludePackageFromTraversal(pkg, traversal) {
+    const connectedPkg = pkg.split('.').join('_') + '_';
+    return traversal.join('_').replace(connectedPkg, '');
+}

module/proto.js

@@ -144,1 +144,11 @@ import { camel, variableSlug } from ".";
 };
+export const getTypeNameFromFieldName = (name, importSrc, ref) => {
+    let importedAs = name;
+    const names = ref.traversed?.importNames;
+    if (names
+        && names.hasOwnProperty(importSrc)
+        && names[importSrc].hasOwnProperty(name)) {
+        importedAs = names[importSrc][name];
+    }
+    return importedAs;
+};

module/utils.js

@@ -49,12 +49,2 @@ import minimatch from "minimatch";
 };
-export const getTypeNameFromFieldName = (name, importSrc, ref) => {
-    let importedAs = name;
-    const names = ref.traversed?.importNames;
-    if (names &&
-        names.hasOwnProperty(importSrc) &&
-        names[importSrc].hasOwnProperty(name)) {
-        importedAs = names[importSrc][name];
-    }
-    return importedAs;
-};
 export const buildImports = (imports) => {
@@ -141,1 +131,31 @@ return imports.map((item) => {
 };
+export const getEnumValues = (proto) => {
+    const enums = Object.keys(proto.values).map(key => {
+        const e = {
+            name: key,
+            comment: null,
+            value: null
+        };
+        e.value = proto.values[key];
+        if (proto.comments[key]) {
+            e.comment = proto.comments[key];
+        }
+        return e;
+    });
+    return enums;
+};
+/**
+ * get the type name by enum object while traversing the nested enum
+ * @param field
+ * @param pkg name space
+ * @param traversal traversed name spaces and nested enum names
+ * @param isNested whether the enum is nested
+ * @returns
+ */
+export const getTypeNameByEnumObj = (field, pkg, traversal, isNested) => {
+    return !isNested ? field.name : excludePackageFromTraversal(pkg, traversal);
+};
+function excludePackageFromTraversal(pkg, traversal) {
+    const connectedPkg = pkg.split('.').join('_') + '_';
+    return traversal.join('_').replace(connectedPkg, '');
+}

package.json

 {
   "name": "@cosmology/utils",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "Telescope utils",
@@ -77,6 +77,6 @@ "author": "Dan Lynch <[e-mail]>",
   "dependencies": {
-    "@cosmology/types": "^1.5.0",
+    "@cosmology/types": "^1.5.1",
     "dotty": "0.1.2"
   },
-  "gitHead": "8d975f29b54ef773af98ce65a851a4b35b14e07e"
+  "gitHead": "a498e19917131aa20c9beafcb746246d95e00bc0"
 }

src/proto.ts

 import { camel, variableSlug } from ".";
 import { pascal, snake } from "case";
 import minimatch from "minimatch";
-import { ProtoRef, ProtoRoot } from "@cosmology/types";
+import { ProtoField, ProtoRef, ProtoRoot } from "@cosmology/types";
 import dotty from "dotty";
@@ -193,1 +193,15 @@
 };
+
+export const getTypeNameFromFieldName = (name: string, importSrc: string, ref: ProtoRef) => {
+  let importedAs = name;
+  const names = ref.traversed?.importNames;
+  if (names
+      && names.hasOwnProperty(importSrc)
+      && names[importSrc].hasOwnProperty(name)
+  ) {
+
+      importedAs = names[importSrc][name];
+  }
+
+  return importedAs;
+}

src/utils.ts

@@ -7,2 +7,3 @@ import minimatch from "minimatch";
   ImportUsage,
+  ProtoEnum,
 } from "@cosmology/types";
@@ -69,20 +70,2 @@ import { ImportDeclaration } from "@babel/types";
 
-export const getTypeNameFromFieldName = (
-  name: string,
-  importSrc: string,
-  ref: ProtoRef
-) => {
-  let importedAs = name;
-  const names = ref.traversed?.importNames;
-  if (
-    names &&
-    names.hasOwnProperty(importSrc) &&
-    names[importSrc].hasOwnProperty(name)
-  ) {
-    importedAs = names[importSrc][name];
-  }
-
-  return importedAs;
-};
-
 export const buildImports = (imports: ImportUsage[]) => {
@@ -208,1 +191,35 @@ return imports.map((item) => {
 };
+
+export const getEnumValues = (proto: ProtoEnum) => {
+  const enums = Object.keys(proto.values).map(key => {
+      const e = {
+          name: key,
+          comment: null,
+          value: null
+      };
+      e.value = proto.values[key];
+      if (proto.comments[key]) {
+          e.comment = proto.comments[key];
+      }
+      return e;
+  });
+  return enums;
+}
+
+/**
+ * get the type name by enum object while traversing the nested enum
+ * @param field
+ * @param pkg name space
+ * @param traversal traversed name spaces and nested enum names
+ * @param isNested whether the enum is nested
+ * @returns
+ */
+export const getTypeNameByEnumObj = (field: any, pkg: string, traversal: string[], isNested: boolean) => {
+  return !isNested ? field.name : excludePackageFromTraversal(pkg, traversal);
+}
+
+function excludePackageFromTraversal(pkg: string, traversal: string[]) {
+  const connectedPkg = pkg.split('.').join('_') + '_';
+
+  return traversal.join('_').replace(connectedPkg, '');
+}

types/proto.d.ts

@@ -50,1 +50,2 @@ import { ProtoRef, ProtoRoot } from "@cosmology/types";
 export declare const getObjectName: (name: string, scope?: string[]) => string;
+export declare const getTypeNameFromFieldName: (name: string, importSrc: string, ref: ProtoRef) => string;

types/utils.d.ts

@@ -1,2 +0,2 @@
-import { TelescopeOptions, TelescopeOption, ProtoRef, ImportUsage } from "@cosmology/types";
+import { TelescopeOptions, TelescopeOption, ImportUsage, ProtoEnum } from "@cosmology/types";
 import { ImportDeclaration } from "@babel/types";
@@ -14,3 +14,2 @@ /**
 export declare const getPluginValue: (optionName: TelescopeOption | string, currentPkg: string, options: TelescopeOptions) => any;
-export declare const getTypeNameFromFieldName: (name: string, importSrc: string, ref: ProtoRef) => string;
 export declare const buildImports: (imports: ImportUsage[]) => {
@@ -50,1 +49,15 @@ type: string;
 export declare const duplicateImportPathsWithExt: (paths: ImportDeclaration[], ext?: string) => ImportDeclaration[];
+export declare const getEnumValues: (proto: ProtoEnum) => {
+    name: string;
+    comment: any;
+    value: any;
+}[];
+/**
+ * get the type name by enum object while traversing the nested enum
+ * @param field
+ * @param pkg name space
+ * @param traversal traversed name spaces and nested enum names
+ * @param isNested whether the enum is nested
+ * @returns
+ */
+export declare const getTypeNameByEnumObj: (field: any, pkg: string, traversal: string[], isNested: boolean) => any;

No alert changes

Improved metrics

Total package byte prevSize

83254

increased by4.39%

Lines of code

2241

increased by4.67%

Dependency changes

• Updated@cosmology/types@^1.5.1