@trackunit/react-core-contexts-api 0.0.34

package/README.md

@@ -0,0 +1,5 @@
+This is the documentation for library
+
+# core-contexts-api
+
+The purpose of this library is to contain the api for the core contexts.

package/currentUserContext.d.ts

@@ -0,0 +1,29 @@
+export interface ICurrentUserContext {
+    /**
+     * userName used when logging in. Undefined if not authenticated
+     */
+    userName: string | undefined;
+    /**
+     * Legacy user id. Undefined if not authenticated
+     */
+    userId: number | undefined;
+    /**
+     * Legacy customer id. Undefined if not authenticated
+     */
+    customerId: number | undefined;
+    /**
+     * Account ID. undefined if not authenticated
+     */
+    accountId: string | undefined;
+    /**
+     * If currently assuming a different user, this contains the information of that user. Null if not assuming
+     */
+    assumedUser: {
+        userId: number;
+        customerId: number;
+        accountId: string;
+    } | null;
+    email: string | undefined;
+    name: string | undefined;
+    jobTitle: string | undefined;
+}

package/environmentContext.d.ts

@@ -0,0 +1,30 @@
+export interface ITracingHeaders {
+    "X-TrackunitAppVersion": string;
+    "session-id": string;
+}
+export interface IEnvironmentContext {
+    auth: {
+        url: string;
+        clientId: string;
+        issuer: string;
+    };
+    tracingHeaders: ITracingHeaders;
+    managerClassicUrl: string;
+    googleMapsApiKey: string;
+    amplitudeApiKey: string;
+    launchDarklyApiKey: string;
+    twilioUrl: string;
+    graphqlLegacyUrl: string;
+    graphqlManagerUrl: string;
+    graphqlReportUrl: string;
+    graphqlSimulatorUrl: string;
+    buildVersion: string;
+    commitNumber: number;
+    buildDate: string;
+    publicUrl: string;
+    irisAppSdkServerUrl: string;
+    isDev: boolean;
+    environment: string;
+    sentryDsn: string;
+    sessionId: string;
+}

package/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./currentUserContext";
+export * from "./environmentContext";
+export * from "./tokenContext";
+export * from "./userSubscriptionContext";

package/index.js

@@ -0,0 +1,10 @@
+var UserSubscriptionPackageType;
+
+(function (UserSubscriptionPackageType) {
+  UserSubscriptionPackageType["Collect"] = "COLLECT";
+  UserSubscriptionPackageType["Insight"] = "INSIGHT";
+  UserSubscriptionPackageType["None"] = "NONE";
+  UserSubscriptionPackageType["View"] = "VIEW";
+})(UserSubscriptionPackageType || (UserSubscriptionPackageType = {}));
+
+export { UserSubscriptionPackageType };

package/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@trackunit/react-core-contexts-api",
+  "version": "0.0.34",
+  "repository": "https://github.com/Trackunit/manager",
+  "license": "MIT",
+  "module": "./index.js",
+  "main": "./index.js",
+  "type": "module",
+  "types": "./index.d.ts"
+}

package/test/config/jest.setup.d.ts

@@ -0,0 +1 @@
+export {};

package/tokenContext.d.ts

@@ -0,0 +1,6 @@
+export interface ITokenContext {
+    /**
+     * The current valid token or null if no token is available.
+     */
+    token?: string;
+}

package/userSubscriptionContext.d.ts

@@ -0,0 +1,23 @@
+export interface IUserSubscriptionContext {
+    /**
+     * The users subscription package
+     */
+    packageType: UserSubscriptionPackageType;
+    /**
+     * Extra features enabled for the current user. Will be null if still loading
+     */
+    features: IFeature[] | null;
+    hasCollectPackage: boolean;
+    hasViewPackage: boolean;
+    hasInsightPackage: boolean;
+}
+export declare enum UserSubscriptionPackageType {
+    Collect = "COLLECT",
+    Insight = "INSIGHT",
+    None = "NONE",
+    View = "VIEW"
+}
+export interface IFeature {
+    id: string;
+    name: string;
+}