@verdocs/js-sdk 2.0.6 → 2.0.9

package/Organizations/Groups.d.ts

@@ -19,6 +19,16 @@ import { VerdocsEndpoint } from '../VerdocsEndpoint';
  * ```
  */
 export declare const getGroups: (endpoint: VerdocsEndpoint, organizationId: string) => Promise<IGroup[]>;
+/**
+ * Get a single group by name. Returns a detail record.
+ *
+ * ```typescript
+ * import {Groups} from '@verdocs/js-sdk/Organizations';
+ *
+ * const groups = await Groups.getGroups(ORGID);
+ * ```
+ */
+export declare const getGroupByName: (endpoint: VerdocsEndpoint, organizationId: string, name?: string) => Promise<IGroup>;
 /**
  * Get the details for a group.
  *

package/Organizations/Groups.js

@@ -21,6 +21,20 @@ export var getGroups = function (endpoint, organizationId) {
         .get("/organizations/".concat(organizationId, "/groups"))
         .then(function (r) { return r.data; });
 };
+/**
+ * Get a single group by name. Returns a detail record.
+ *
+ * ```typescript
+ * import {Groups} from '@verdocs/js-sdk/Organizations';
+ *
+ * const groups = await Groups.getGroups(ORGID);
+ * ```
+ */
+export var getGroupByName = function (endpoint, organizationId, name) {
+    return endpoint.api //
+        .get("/organizations/".concat(organizationId, "/groups"), { params: { name: name } })
+        .then(function (r) { return r.data; });
+};
 /**
  * Get the details for a group.
  *

package/Organizations/Types.d.ts

@@ -41,6 +41,8 @@ export interface IGroup {
     name: string;
     organization_id: string;
     /** For future expansion. In the future, Verdocs may support group hierarchies. Until then this field is always null. */
+    parent: IGroup | null;
+    /** For future expansion. In the future, Verdocs may support group hierarchies. Until then this field is always null. */
     parent_id: string | null;
     /** Some operations will additionally return a list of permissions. */
     permissions?: TPermission[];

package/VerdocsEndpoint.js

@@ -2,6 +2,9 @@ import axios from 'axios';
 import { decodeAccessTokenBody } from './Utils/Token';
 import globalThis from './Utils/globalThis';
 import * as Documents from './Documents';
+// @credit https://derickbailey.com/2016/03/09/creating-a-true-singleton-in-node-js-with-es6-symbols/
+// Also see globalThis for comments about why we're doing this in the first place.
+var ENDPOINT_KEY = Symbol.for('verdocs-default-endpoint');
 var requestLogger = function (r) {
     // tslint:disable-next-line
     console.debug("[JS-SDK] ".concat(r.method.toUpperCase(), " ").concat(r.baseURL).concat(r.url), r.data ? JSON.stringify(r.data) : '');
@@ -65,6 +68,13 @@ var VerdocsEndpoint = /** @class */ (function () {
         globalThis[ENDPOINT_KEY] = this;
     };
     VerdocsEndpoint.getDefault = function () {
+        if (!globalThis[ENDPOINT_KEY]) {
+            globalThis[ENDPOINT_KEY] = new VerdocsEndpoint();
+            window.console.debug('[JS_SDK] Created default endpoint', globalThis[ENDPOINT_KEY]);
+        }
+        else {
+            window.console.debug('[JS SDK] Re-using existing endpoint', globalThis[ENDPOINT_KEY]);
+        }
         return globalThis[ENDPOINT_KEY];
     };
     /**
@@ -289,10 +299,3 @@ var VerdocsEndpoint = /** @class */ (function () {
     return VerdocsEndpoint;
 }());
 export { VerdocsEndpoint };
-// @credit https://derickbailey.com/2016/03/09/creating-a-true-singleton-in-node-js-with-es6-symbols/
-// Also see globalThis for comments about why we're doing this in the first place.
-var ENDPOINT_KEY = Symbol.for('verdocs-default-endpoint');
-if (!globalThis[ENDPOINT_KEY]) {
-    globalThis[ENDPOINT_KEY] = new VerdocsEndpoint();
-    window.console.debug('[JS_SDK] Created default endpoint', globalThis[ENDPOINT_KEY]);
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "2.0.6",
+  "version": "2.0.9",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Verdocs JS SDK",
@@ -53,13 +53,13 @@
   "devDependencies": {
     "@jest/globals": "^28.1.2",
     "@types/jest": "^28.1.4",
-    "axios-mock-adapter": "^1.21.1",
+    "axios-mock-adapter": "^1.21.2",
     "jest": "^28.1.2",
     "prettier": "^2.7.1",
-    "ts-jest": "^28.0.5",
+    "ts-jest": "^28.0.8",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
-    "typedoc": "^0.23.9",
+    "typedoc": "^0.23.11",
     "typedoc-plugin-markdown": "^3.13.4",
     "typescript": "^4.7.4"
   }