jmapcloud-ng-core-types 0.0.4

package/public/jmap/user.d.ts

@@ -0,0 +1,96 @@
+declare interface JUserEventSessionChangedParams {
+  session: JSessionData
+}
+
+declare interface JTokenInfo {
+  /**
+   * The JMap user session token (legacy) or access token (Saas JMap Cloud).
+   */
+  accessToken: string
+  /**
+   * The refresh token.
+   */
+  refreshToken: string
+  /**
+   * The access token expiration time in seconds.
+   */
+  accessTokenExpiration: number
+}
+
+declare interface JSessionData extends JTokenInfo {
+  /**
+   * The user permission to change his password
+   */
+  changePasswordAllowed: boolean
+  /**
+   * The user information.
+   *
+   * @example ```ts
+   *
+   * user: {
+   *   username: "jdo@company.com",
+   *   fullName: "John Do",
+   *   admin: true
+   * }
+   * ```
+   */
+  user: JUserIdentity
+  /**
+   * Infos about the user's organizations, only for JMap Cloud servers.
+   */
+  organizationInfos: JOrganizationInfo[]
+  /**
+   * THe JMap Cloud organization in which the user is currently logged in, only for JMap Cloud servers.
+   */
+  currentOrganization: JOrganization
+}
+
+declare interface JUserIdentity {
+  username: string
+  fullName: string
+  email: string
+}
+
+declare interface JUserInfo {
+  id: string
+  label: string
+  value: undefined | null | string | number | Date
+}
+
+declare interface JOrganizationInfo {
+  id: string
+  auth0Id: string
+  name: string
+  logoUrl: string
+  primaryColor: string
+  backgroundColor: string
+  active: boolean
+}
+
+declare interface JOrganization extends JOrganizationInfo {
+  externalApiKeys: JOrganizationExternalApiKey[]
+  enabledExtensions: JProjectServerExtension[]
+}
+
+declare interface JOrganizationExternalApiKey {
+  id: string
+  title: string
+  apiKey: string
+  type: JORGANIZATION_EXTERNAL_API_KEY_TYPES
+}
+
+declare interface JJMapServerPasswordPolicyCompliance {
+  hasMinimumLength: boolean
+}
+
+declare interface JJMapCloudPasswordPolicyCompliance extends JJMapServerPasswordPolicyCompliance {
+  hasLowercaseLetters: boolean
+  hasUppercaseLetters: boolean
+  hasNumbers: boolean
+  hasSpecialCharacters: boolean
+}
+
+// ALL_JORGANIZATION_EXTERNAL_API_KEY_TYPES in all-enum.ts
+declare const enum JORGANIZATION_EXTERNAL_API_KEY_TYPES {
+  MAPBOX_ACCESS_TOKEN = "MAPBOX_ACCESS_TOKEN"
+}

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "outDir": "./out",
+    "baseUrl": "./",
+    "strict": true,
+    "sourceMap": true,
+    "noImplicitAny": true,
+    "moduleResolution": "node",
+    "module": "esnext",
+    "target": "es5",
+    "jsx": "react",
+    "lib": [
+      "es2017",
+      "dom",
+      "es5",
+      "es2015.promise"
+    ]
+  },
+  "include": [
+    "../public/**/*",
+    "../private/**/*",
+    "./index.ts",
+    "./all-enums.ts"
+  ]
+}

package/tslint.json

@@ -0,0 +1,86 @@
+{
+  "defaultSeverity": "error",
+  "extends": [
+    "tslint:recommended"
+  ],
+  "jsRules": {},
+  "rules": {
+    "no-eval": false,
+    "semicolon": [ 
+      true, 
+      "never"
+    ],
+    "object-literal-sort-keys": false,
+    "no-shadowed-variable": [
+      true,
+      {
+      "class": true,
+      "enum": true,
+      "function": true,
+      "interface": false,
+      "namespace": true,
+      "typeAlias": false,
+      "typeParameter": false,
+      "temporalDeadZone": false
+      }
+    ],
+    "arrow-parens": [ 
+      true,
+      "ban-single-arg-parens"
+    ],
+    "no-trailing-whitespace": [ 
+      true, 
+      "ignore-comments" 
+    ],
+    "ordered-imports": [
+      false,
+      {
+        "import-sources-order": "any",
+        "named-imports-order": "any",
+        "grouped-imports": true
+      }
+    ],
+    "max-line-length": [
+      true,
+      130
+    ],
+    "curly": [ 
+      true
+    ],
+    "no-console": [ 
+      true, 
+      "log" 
+    ],
+    "max-classes-per-file": [ 
+      true, 
+      10, 
+      "exclude-class-expressions" 
+    ],
+    "trailing-comma": [ false ],
+    "variable-name": [
+      false, 
+      "ban-keywords", "check-format", "allow-leading-underscore", "allow-trailing-underscore"
+    ],
+    "interface-name": [ false ],
+    "member-ordering": [
+      true,
+      {
+        "order": [
+          "public-static-field",
+          "public-instance-field",
+          "private-static-field",
+          "private-instance-field",
+          "public-constructor",
+          "private-constructor",
+          "public-static-method",
+          "public-instance-method",
+          "protected-instance-method",
+          "private-instance-method",
+          "private-static-method"
+        ]
+      }
+    ],
+    "no-namespace": [true, "allow-declarations"]
+  },
+  "rulesDirectory": []
+}