@verdocs/js-sdk 1.0.23 → 1.0.28

package/Users/Types.d.ts

@@ -1,7 +1,16 @@
 import { IGroup, IOrganization } from '../Organizations/Types';
 import { TRequestStatus } from '../HTTP/Types';
+/**
+ * An operation within Verdocs the user may perform.
+ */
 export declare type TPermission = 'org:view' | 'member:view' | 'org:update' | 'member:add' | 'member:remove' | 'admin:add' | 'admin:remove' | 'org:delete' | 'org:transfer' | 'owner:add' | 'owner:remove' | 'template:creator:create:personal' | 'template:creator:visibility' | 'template:creator:create:org' | 'template:member:read' | 'template:member:write' | 'template:member:visibility' | 'template:creator:delete' | 'template:member:delete' | 'template:creator:create:public' | 'rform:access' | 'rcommon:access' | 'org:list' | 'org:create';
+/**
+ * Plans provide access to Verdocs product features.
+ */
 export declare type TPlan = 'env:essential' | 'org:standard';
+/**
+ * Roles provide access to groups of permissions.
+ */
 export declare type TRole = 'owner' | 'basic_user' | 'member';
 export interface IProfile {
     /** The unique ID of the profile */
@@ -37,12 +46,13 @@ export interface IActiveSession {
     email_verified: boolean;
     iat: number;
     exp: number;
-    permissions: IPermission[];
-    roles: IRole[];
+    permissions: TPermission[];
+    roles: TRole[];
     profile: IProfile;
     profile_id: string;
     organization_id: string;
     plans?: TPlan[];
+    [key: string]: any;
 }
 export interface IRole {
     /** Unique identifier for the role. */

package/Utils/DateTime.js

@@ -37,5 +37,5 @@ export var formatShortTimeAgo = function (val) {
     if (timeDiff >= MINUTE) {
         return Math.floor(timeDiff / MINUTE) + 'Y';
     }
-    return timeDiff + "S";
+    return "".concat(timeDiff, "S");
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "1.0.23",
+  "version": "1.0.28",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Verdocs JS SDK",
@@ -23,20 +23,20 @@
     "url": "https://github.com/Verdocs/js-sdk/issues"
   },
   "scripts": {
-    "build": "npm run clean && tsc && npm run lint && npm run docs",
+    "build": "npm run clean && npm run docs && tsc && npm run lint",
     "prepare": "npm run build",
     "prepublishOnly": "npm run lint",
-    "OldprepublishOnly": "npm test && npm run lint",
     "preversion": "npm run lint",
     "version": "npm run format && git add -A src",
     "postversion": "git push && git push --tags",
     "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --config jestconfig.json",
     "format": "prettier --write \"src/**/*.ts\"",
     "lint": "tslint -p tsconfig.json",
-    "docs-md": "typedoc",
-    "docs-html": "typedoc --plugin none --out docs-html",
-    "docs": "npm run docs-md && npm run docs-html && cp -aR docs-html/* ../partner-portal/site/static/js-sdk/",
-    "clean": "rm -rf Documents HTTP Organizations Search Templates Users Utils index.js index.d.ts"
+    "docs-md": "typedoc --tsconfig ./tsconfig-typedoc.json",
+    "docs-html": "typedoc --tsconfig ./tsconfig-typedoc.json --plugin none --out docs-html",
+    "Xdocs-html": "typedoc --tsconfig ./tsconfig-typedoc.json --plugin ./typedoc-theme.tsx --out docs-html",
+    "docs": "rm -rf ../partner-portal/site/static/js-sdk/* && npm run docs-md && npm run docs-html && cp -aR docs-html/* ../partner-portal/site/static/js-sdk/",
+    "clean": "rm -rf Documents HTTP Organizations Search Templates Users Utils index.js index.d.ts docs docs-html"
   },
   "publishConfig": {
     "access": "public"
@@ -45,18 +45,18 @@
     "axios": "^0.21.1"
   },
   "peerDependencies": {
-    "typescript": "4.0.x || 4.1.x || 4.2.x || 4.3.x || 4.4.x"
+    "typescript": "4.2.x || 4.3.x || 4.4.x || 4.5.x"
   },
   "devDependencies": {
     "@types/jest": "^27.0.2",
     "jest": "^27.3.1",
     "jest-mock-axios": "^4.4.1",
-    "prettier": "^2.4.1",
+    "prettier": "^2.5.1",
     "ts-jest": "^27.0.7",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
-    "typedoc": "^0.22.9",
-    "typedoc-plugin-markdown": "^3.11.6",
-    "typescript": "^4.4.4"
+    "typedoc": "^0.22.10",
+    "typedoc-plugin-markdown": "^3.11.9",
+    "typescript": "^4.5.4"
   }
 }

package/tsconfig-typedoc.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "module": "esnext",
+    "lib": ["es2017", "es7", "es6", "dom"],
+    "declaration": true,
+    "allowJs": true,
+    "outDir": "./",
+    "strict": true,
+    "esModuleInterop": true,
+    "moduleResolution": "node",
+    "jsx": "react",
+    "jsxFactory": "JSX.createElement",
+    "jsxFragmentFactory": "JSX.Fragment"
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "dist", "**/__tests__/*"],
+  "typedocOptions": {
+    "entryPoints": ["src/index.ts"],
+    "out": "docs",
+    "includeVersion": true,
+    "gitRevision": "main",
+    "hideGenerator": true
+  }
+}