@machhub-dev/sdk-ts 0.0.1

package/src/types/auth.models.ts

@@ -0,0 +1,157 @@
+import { RecordID } from "./recordID.models";
+import { BaseResponse } from "./response.models";
+
+export interface LoginResponse extends BaseResponse {
+    tkn: string;
+}
+
+export interface PermissionResponse extends BaseResponse {
+    permission: boolean;
+}
+
+export interface ValidateJWTResponse extends BaseResponse {
+    valid: boolean;
+}
+
+
+export interface User {
+    id?: RecordID;
+    firstName: string;
+    lastName: string;
+    username: string;
+    email: string;
+    password: string
+    number: string;
+    createdDt?: string;
+    userImage: string | ArrayBuffer | null;
+    group_ids?: string[];
+};
+
+export interface Group {
+    id?: RecordID;
+    features?: {
+        name: string;
+        action: string;
+        domain: string;
+        scope: string;
+    }[];
+    name: string;
+    user_ids: RecordID[];
+};
+
+export interface Feature {
+    name:string
+    action:string
+    scope:Scope
+}
+
+export interface Permission {
+    displayName:string;
+    description:string;
+    name: string;
+    action: string;
+    scope: string;
+}
+
+export function machhubPermissions(): Permission[]{
+    return [
+		{
+			displayName: 'Applications',
+			description: 'View or manage applications all applications in MACHHUB',
+			name: 'applications',
+			action: 'nil',
+			scope: 'all'
+		},
+		{
+			displayName: 'Users',
+			description: 'View or manage user accounts in this domain',
+			name: 'users',
+			action: 'nil',
+			scope: 'domain'
+		},
+		{
+			displayName: 'Groups',
+			description: 'View or manage user groups in this domain',
+			name: 'groups',
+			action: 'nil',
+			scope: 'domain'
+		},
+		{
+			displayName: 'Manage Own API Keys',
+			description: 'View or manage API keys for own account',
+			name: 'api_keys',
+			action: 'nil',
+			scope: 'self'
+		},
+		{
+			displayName: 'Manage All API Keys',
+			description: 'View or manage all API keys in MACHHUB',
+			name: 'api_keys',
+			action: 'nil',
+			scope: 'all'
+		},
+		{
+			displayName: 'Upstreams',
+			description: 'View or manage all upstream configurations in MACHHUB',
+			name: 'upstreams',
+			action: 'nil',
+			scope: 'domain'
+		},
+		{
+			displayName: 'Manage Namespace',
+			description: 'View or manage namespaces in this domain',
+			name: 'namespace',
+			action: 'nil',
+			scope: 'domain'
+		},
+		{
+			displayName: 'Historian',
+			description: 'View or manage historian data in this domain',
+			name: 'historian',
+			action: 'nil',
+			scope: 'domain'
+		},
+		{
+			displayName: 'Collections',
+			description: 'View or manage collections in this domain',
+			name: 'collections',
+			action: 'nil',
+			scope: 'domain'
+		},
+		{
+			displayName: 'Logs',
+			description: 'View or manage system logs',
+			name: 'logs',
+			action: 'nil',
+			scope: 'all'
+		},
+		{
+			displayName: 'General Settings',
+			description: 'View or manage general system settings',
+			name: 'general_settings',
+			action: 'nil',
+			scope: 'all'
+		},
+		{
+			displayName: 'Gateway Settings',
+			description: 'View or manage gateway settings',
+			name: 'gateway',
+			action: 'nil',
+			scope: 'all'
+		},
+		{
+			displayName: 'License',
+			description: 'View or manage MACHHUB licensing details',
+			name: 'license',
+			action: 'nil',
+			scope: 'all'
+		}
+	]
+}
+
+export interface ActionResponse extends BaseResponse {
+    action: "read" | "read-write" | ""
+}
+
+export type Action = "read" | "read-write" 
+export type Scope = "self" |  "domain" | "all"| "nil" 

package/src/types/recordID.models.ts

@@ -0,0 +1,33 @@
+export interface RecordID {
+    Table: string;
+    ID: string;
+}
+
+export function StringToRecordID(id: string): RecordID {
+    const splitID = id.split(":");
+    if (splitID.length != 2) return emptyRecordID();
+    return {
+        Table: containsSpace(splitID[0]) ? `(${splitID[0]})` : splitID[0],
+        ID: splitID[1]
+    };
+}
+
+export function RecordIDToString(recordID: RecordID | undefined): string {
+    if (recordID != undefined) {
+        return recordID.Table + ":" + recordID.ID;
+    } else {
+        return "";
+    }
+}
+
+export function emptyRecordID(): RecordID {
+    return {
+        Table: "",
+        ID: "",
+    };
+}
+
+// Helper function to check if a string contains spaces
+function containsSpace(s: string): boolean {
+    return s.includes(" ");
+}

package/src/types/response.models.ts

@@ -0,0 +1,4 @@
+export interface BaseResponse {
+    success: boolean;
+    message: boolean;
+}

package/src/types/tag.models.ts

@@ -0,0 +1,4 @@
+export interface HistorizedData{
+    timestamp: string,
+    value: unknown,
+} 

package/src/utils/appConfig.ts

@@ -0,0 +1,30 @@
+import * as fs from 'fs';
+import * as path from 'path';
+
+interface AppConfig {
+  application_id: string;
+}
+
+export function getAppConfig(): AppConfig {
+  console.log("getAppConfig")
+  if (typeof process !== 'undefined' && process.env && process.env.APP_CONFIG_PATH) {
+    // Node.js environment
+    console.log(process.env)
+    console.log(process.env.APP_CONFIG_PATH)
+
+    const configPath = process.env.APP_CONFIG_PATH || path.resolve(__dirname, '../../../sdk.config.json');
+    const rawData = fs.readFileSync(configPath, 'utf-8');
+    return JSON.parse(rawData) as AppConfig;
+  } else {
+    try {
+      const configPath = path.resolve('../../../sdk.config.json');
+      console.log(configPath)
+      const rawData = fs.readFileSync(configPath, 'utf-8');
+      console.log("TEST")
+      console.log(rawData)
+      return JSON.parse(rawData) as AppConfig;
+    } catch (e:any){
+        throw new Error("Configuration not found. Set it via the APP_CONFIG_PATH environment variable : " + e);
+    }
+  }
+}

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "moduleResolution": "Node",
+    "declaration": true,
+    "outDir": "dist",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}