lamp-core-lst 2025.11.1-3.basic

package/docs/TypeApi.md

@@ -0,0 +1,274 @@
+# LAMP.Type
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**getAttachment**](TypeApi.md#getAttachment) | **GET** /type/{type_id}/attachment/{attachment_key} | 
+[**getDynamicAttachment**](TypeApi.md#getDynamicAttachment) | **GET** /type/{type_id}/attachment/dynamic/{attachment_key} | 
+[**listAttachments**](TypeApi.md#listAttachments) | **GET** /type/{type_id}/attachment | 
+[**parent**](TypeApi.md#parent) | **GET** /type/{type_id}/parent | Find the owner(s) of the resource.
+[**setAttachment**](TypeApi.md#setAttachment) | **PUT** /type/{type_id}/attachment/{attachment_key}/{target} | 
+[**setDynamicAttachment**](TypeApi.md#setDynamicAttachment) | **PUT** /type/{type_id}/attachment/dynamic/{attachment_key}/{target} | 
+
+
+# **getAttachment**
+> object getAttachment(type_id, attachment_key)
+
+
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let type_id = 'type_id_example' // string 
+let attachment_key = 'attachment_key_example' // string 
+
+const result = LAMP.Type.getAttachment(type_id, attachment_key)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **type_id** | **string**|  | 
+ **attachment_key** | **string**|  | 
+
+### Return type
+
+**object**
+
+### HTTP request headers
+
+ - **Content-Type**: `application/json`
+ - **Accept**: `application/json`
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 200 Success |  -  |
+| **400** | 400 Bad Request |  -  |
+| **403** | 403 Authorization Failed |  -  |
+| **404** | 404 Not Found |  -  |
+| **0** | 500 Internal Error |  -  |
+
+# **getDynamicAttachment**
+> object getDynamicAttachment(type_id, attachment_key, invoke_always, include_logs, ignore_output)
+
+
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let type_id = 'type_id_example' // string 
+let attachment_key = 'attachment_key_example' // string 
+let invoke_always = false // boolean 
+let include_logs = false // boolean 
+let ignore_output = false // boolean 
+
+const result = LAMP.Type.getDynamicAttachment(type_id, attachment_key, invoke_always, include_logs, ignore_output)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **type_id** | **string**|  | 
+ **attachment_key** | **string**|  | 
+ **invoke_always** | **boolean**|  | 
+ **include_logs** | **boolean**|  | 
+ **ignore_output** | **boolean**|  | 
+
+### Return type
+
+**object**
+
+### HTTP request headers
+
+ - **Content-Type**: `application/json`
+ - **Accept**: `application/json`
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 200 Success |  -  |
+| **400** | 400 Bad Request |  -  |
+| **403** | 403 Authorization Failed |  -  |
+| **404** | 404 Not Found |  -  |
+| **0** | 500 Internal Error |  -  |
+
+# **listAttachments**
+> object listAttachments(type_id)
+
+
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let type_id = 'type_id_example' // string 
+
+const result = LAMP.Type.listAttachments(type_id)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **type_id** | **string**|  | 
+
+### Return type
+
+**object**
+
+### HTTP request headers
+
+ - **Content-Type**: `application/json`
+ - **Accept**: `application/json`
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 200 Success |  -  |
+| **400** | 400 Bad Request |  -  |
+| **403** | 403 Authorization Failed |  -  |
+| **404** | 404 Not Found |  -  |
+| **0** | 500 Internal Error |  -  |
+
+# **parent**
+> character parent(type_id)
+
+Find the owner(s) of the resource.
+
+Get the parent type identifier of the data structure referenced by the identifier.
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let type_id = 'type_id_example' // string 
+
+// Find the owner(s) of the resource.
+const result = LAMP.Type.parent(type_id)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **type_id** | **string**|  | 
+ **transform** | **string**|  | [optional] 
+
+### Return type
+
+**string**
+
+### HTTP request headers
+
+ - **Content-Type**: `application/json`
+ - **Accept**: `application/json`
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 200 Success |  -  |
+| **400** | 400 Bad Request |  -  |
+| **403** | 403 Authorization Failed |  -  |
+| **404** | 404 Not Found |  -  |
+| **0** | 500 Internal Error |  -  |
+
+# **setAttachment**
+> object setAttachment(type_id, target, attachment_key, body)
+
+
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let type_id = 'type_id_example' // string 
+let target = 'target_example' // string 
+let attachment_key = 'attachment_key_example' // string 
+let body = null // object 
+
+const result = LAMP.Type.setAttachment(type_id, target, attachment_key, body)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **type_id** | **string**|  | 
+ **target** | **string**|  | 
+ **attachment_key** | **string**|  | 
+ **body** | **object**|  | 
+
+### Return type
+
+**object**
+
+### HTTP request headers
+
+ - **Content-Type**: `application/json`
+ - **Accept**: `application/json`
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 200 Success |  -  |
+| **400** | 400 Bad Request |  -  |
+| **403** | 403 Authorization Failed |  -  |
+| **404** | 404 Not Found |  -  |
+| **0** | 500 Internal Error |  -  |
+
+# **setDynamicAttachment**
+> object setDynamicAttachment(type_id, target, attachment_key, invoke_once, dynamic.attachment)
+
+
+
+### Example
+```javascript
+import LAMP from 'lamp-core'
+
+let type_id = 'type_id_example' // string 
+let target = 'target_example' // string 
+let attachment_key = 'attachment_key_example' // string 
+let invoke_once = 'invoke_once_example' // string 
+let dynamic.attachment = DynamicAttachment.new("key_example", "from_example", "to_example", list(123), "language_example", "contents_example", list(123)) // DynamicAttachment 
+
+const result = LAMP.Type.setDynamicAttachment(type_id, target, attachment_key, invoke_once, dynamic.attachment)
+console.dir(result)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **type_id** | **string**|  | 
+ **target** | **string**|  | 
+ **attachment_key** | **string**|  | 
+ **invoke_once** | **string**|  | 
+ **dynamic.attachment** | [**DynamicAttachment**](DynamicAttachment.md)|  | 
+
+### Return type
+
+**object**
+
+### HTTP request headers
+
+ - **Content-Type**: `application/json`
+ - **Accept**: `application/json`
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | 200 Success |  -  |
+| **400** | 400 Bad Request |  -  |
+| **403** | 403 Authorization Failed |  -  |
+| **404** | 404 Not Found |  -  |
+| **0** | 500 Internal Error |  -  |
+

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "lamp-core-lst",
+  "version": "2025.11.1-3.basic",
+  "author": "BIDMC Division of Digital Psychiatry <team@digitalpsych.org>",
+  "description": "The JavaScript and TypeScript API client for the LAMP Platform.",
+  "homepage": "https://docs.lamp.digital/",
+  "license": "BSD-3-Clause",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/BIDMCDigitalPsychiatry/LAMP-js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/BIDMCDigitalPsychiatry/LAMP-js/issues"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "lamp": "cli.js"
+  },
+  "dependencies": {
+    "isomorphic-fetch": "^3.0.0",
+    "jose": "^5.8.0",
+    "jsonata": "^1.8.4",
+    "url-search-params-polyfill": "^7.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^13.11.1",
+    "source-map-support": "^0.5.16",
+    "typescript": "^3.7.0"
+  },
+  "scripts": {
+    "start": "tsc-watch --onSuccess \"node -r source-map-support/register ./dist/index.js\"",
+    "build": "tsc",
+    "prepublishOnly": "tsc",
+    "test": "echo \"No tests to run...\" && exit 0"
+  },
+  "prettier": {
+    "semi": false,
+    "printWidth": 120
+  },
+  "directories": {
+    "doc": "docs"
+  }
+}

package/src/index.ts

@@ -0,0 +1,256 @@
+import "isomorphic-fetch"
+import { Researcher, Participant, Identifier } from "./model/index"
+import {
+  APIService,
+  ActivityService,
+  ActivityEventService,
+  ActivitySpecService,
+  CredentialService,
+  ParticipantService,
+  ResearcherService,
+  SensorService,
+  SensorEventService,
+  SensorSpecService,
+  StudyService,
+  TypeService,
+  ResearcherSettingsService,
+} from "./service/index"
+import { Configuration } from "./service/Fetch"
+import { Demo } from "./service/Demo"
+
+export * from "./service/index"
+export * from "./model/index"
+
+/**
+ *
+ */
+interface IAuth {
+  id: string | null
+  password: string | null
+  serverAddress: string | undefined
+  token?: string | undefined
+}
+
+//
+const _bus: HTMLElement | undefined = (global as any).document?.createElement("_lamp_fake")
+
+/**
+ * The root type in LAMP. You must use `LAMP.connect(...)` to begin using any LAMP classes.
+ */
+export default class LAMP {
+  public static API = new APIService()
+  public static Type = new TypeService()
+  public static Credential = new CredentialService()
+  public static Researcher = new ResearcherService()
+  public static Participant = new ParticipantService()
+  public static Study = new StudyService()
+  public static Activity = new ActivityService()
+  public static ActivityEvent = new ActivityEventService()
+  public static ActivitySpec = new ActivitySpecService()
+  public static Sensor = new SensorService()
+  public static SensorEvent = new SensorEventService()
+  public static SensorSpec = new SensorSpecService()
+  public static ResearcherSettings = new ResearcherSettingsService()
+  private static get configuration(): Configuration | undefined {
+    return LAMP.API.configuration
+  }
+  private static set configuration(configuration: Configuration | undefined) {
+    LAMP.API.configuration = configuration
+    LAMP.Activity.configuration = configuration
+    LAMP.ActivityEvent.configuration = configuration
+    LAMP.ActivitySpec.configuration = configuration
+    LAMP.Credential.configuration = configuration
+    LAMP.Participant.configuration = configuration
+    LAMP.Researcher.configuration = configuration
+    LAMP.Sensor.configuration = configuration
+    LAMP.SensorEvent.configuration = configuration
+    LAMP.SensorSpec.configuration = configuration
+    LAMP.Study.configuration = configuration
+    LAMP.Type.configuration = configuration
+    LAMP.ResearcherSettings.configuration = configuration
+  }
+  private static protocol = "https://"
+
+  public static enableDevMode() {
+    // Make all future server requests over http
+    // Only use this for local development
+    LAMP.protocol = "http://"
+  }
+
+  public static addEventListener(event: string, callback: (any) => void) {
+    _bus?.addEventListener(event, callback)
+  }
+  public static removeEventListener(event: string, callback: (any) => void) {
+    _bus?.removeEventListener(event, callback)
+  }
+  public static dispatchEvent(event: string, detail: any = null) {
+    _bus?.dispatchEvent(new CustomEvent(event, { detail }))
+  }
+
+  //
+  // [Demo API]
+  //
+
+  public static initializeDemoDB(db: { [key: string]: any }) {
+    db = JSON.parse(JSON.stringify(db)) // make a deep copy first!
+    Demo.ActivitySpec = db.ActivitySpec ?? []
+    Demo.SensorSpec = db.SensorSpec ?? []
+    Demo.Researcher = db.Researcher ?? []
+    Demo.Study = db.Study ?? []
+    Demo.Participant = db.Participant ?? []
+    Demo.Activity = db.Activity ?? []
+    Demo.Sensor = db.Sensor ?? []
+    Demo.ActivityEvent = db.ActivityEvent ?? []
+    Demo.SensorEvent = db.SensorEvent ?? []
+    Demo.Credential = db.Credential ?? []
+    Demo.Tags = db.Tags ?? []
+  }
+
+  //
+  // [Credential/Identity Management]
+  //
+
+  // Shorthand for console/data analysis usage.
+  public static async connect(
+    identity: {
+      accessKey: string | null
+      secretKey: string | null
+      serverAddress: string | undefined
+    } = {
+      accessKey: null,
+      secretKey: null,
+      serverAddress: undefined,
+    }
+  ) {
+    // Propogate the authorization.
+    // await LAMP.Credential.login(identity.accessKey!, identity.secretKey!);
+    LAMP.Auth._auth = {
+      id: identity.accessKey,
+      password: identity.secretKey,
+      serverAddress: identity.serverAddress,
+    }
+
+    LAMP.configuration = !!LAMP.Auth._auth.id  ? {
+      base: !!identity.serverAddress ? `https://${identity.serverAddress}` : "https://api.lamp.digital",
+      authorization: `${LAMP.Auth._auth.id}:${LAMP.Auth._auth.password}` 
+    } : {
+      base: !!identity.serverAddress ? `https://${identity.serverAddress}` : "https://api.lamp.digital",
+    }
+  }
+
+  public static Auth = class {
+    public static _auth: IAuth = { id: null, password: null, serverAddress: null }
+    public static _me: Researcher[] | Researcher | Participant | null | undefined
+    public static _type: "admin" | "researcher" | "participant" | null = null
+
+    /**
+     * Authenticate/authorize as a user of a given `type`.
+     * If all values are null (especially `type`), the authorization is cleared.
+     */
+    public static async set_identity(
+      identity: {
+        id: string | null
+        password: string | null
+        serverAddress: string | null
+      } = {
+        id: null,
+        password: null,
+        serverAddress: null,
+      }
+    ) {
+      LAMP.configuration = {
+        base: !!identity.serverAddress ? `${LAMP.protocol}${identity.serverAddress}` : `${LAMP.protocol}api.lamp.digital`,
+      }
+
+      // Ensure there's actually a change to process.
+      // let l: IAuth = LAMP.Auth._auth || { id: null, password: null, serverAddress: null }
+      // if (l.id === identity.id && l.password === identity.password && l.serverAddress === identity.serverAddress) return
+
+      // Propogate the authorization.
+      LAMP.Auth._auth = {
+        id: identity.id,
+        password: identity.password,
+        serverAddress: identity.serverAddress,
+      }
+
+      LAMP.configuration = !!LAMP.Auth._auth.id ? {
+        ...(LAMP.configuration || { base: undefined, headers: undefined }),
+        authorization:  `${LAMP.Auth._auth.id}:${LAMP.Auth._auth.password}`,
+      } : {
+        ...(LAMP.configuration || { base: undefined, headers: undefined }),
+      }
+
+      //await LAMP.Credential.login( identity.id!, identity.password! );
+      try {
+        // If we aren't clearing the credential, get the "self" identity.
+        if (!!identity.id && !!identity.password) {
+          // Get our 'me' context so we know what object type we are.
+          let typeData
+          try {
+            typeData = await LAMP.Type.parent("me")
+          } catch (e) {}
+          LAMP.Auth._type =
+            typeData.data === "admin"
+              ? "admin"
+              : Object.entries(typeData.data).length === 0
+              ? "researcher"
+              : !!typeData.data
+              ? "participant"
+              : null
+
+          // Get our 'me' object now that we figured out our type.
+          LAMP.Auth._me = await (LAMP.Auth._type === "admin"
+            ? { id: identity.id }
+            : LAMP.Auth._type === "researcher"
+            ? LAMP.Researcher.view("me")
+            : LAMP.Participant.view("me"))
+
+          LAMP.dispatchEvent("LOGIN", {
+            authorizationToken: LAMP.configuration.authorization,
+            // authorizationToken: LAMP.configuration.token,
+            identityObject: LAMP.Auth._me,
+            serverAddress: LAMP.configuration.base,
+            accessToken: LAMP.configuration.accessToken,
+            refreshToken: LAMP.configuration.refreshToken,
+          })
+        } else {
+          LAMP.dispatchEvent("LOGOUT", {
+            deleteCache: true, // FIXME!
+          })
+        }
+      } catch (err) {
+        console.log(`#####LAMP err`, err)
+        // We failed: clear and propogate the authorization.
+        LAMP.Auth._auth = { id: null, password: null, serverAddress: null }
+        // if (!!LAMP.configuration) LAMP.configuration.token = undefined
+        // if (!!LAMP.configuration) LAMP.configuration.authorization = undefined
+
+        // Delete the "self" identity and throw the error we received.
+        LAMP.Auth._me = null
+        LAMP.Auth._type = null
+        throw new Error("invalid id or password")
+      } finally {
+        // Save the authorization in sessionStorage for later.
+        ;(global as any).sessionStorage?.setItem("LAMP._auth", JSON.stringify(LAMP.Auth._auth))
+      }
+    }
+
+    public static async refresh_identity() {
+      let _saved = JSON.parse((global as any).sessionStorage?.getItem("LAMP._auth") ?? "null") || LAMP.Auth._auth
+      await LAMP.Auth.set_identity({
+        id: _saved.id,
+        password: _saved.password,
+        serverAddress: _saved.serverAddress,
+      })
+    }
+  }
+}
+
+export const main = () => {
+  if (process === undefined) {
+    console.error("This function cannot be invoked from within the library.")
+    return
+  }
+  console.log("This command-line tool is currently disabled.")
+  process?.exit(1)
+}

package/src/model/Activity.ts

@@ -0,0 +1,93 @@
+import { Identifier, Timestamp } from "./Type"
+
+/**
+ *
+ */
+export class DurationInterval {
+  /**
+   *
+   */
+  start?: Timestamp
+
+  /**
+   *
+   */
+  interval?: Array<any>
+
+  /**
+   *
+   */
+  repeatCount?: number
+
+  /**
+   *
+   */
+  end?: Timestamp
+}
+
+/**
+ *
+ */
+export class DurationIntervalLegacy {
+  /**
+   *
+   */
+  repeatType?: string
+
+  /**
+   *
+   */
+  date?: Timestamp
+
+  /**
+   *
+   */
+  customTimes?: Array<any>
+}
+
+/**
+ * tab setting for Activity
+ */
+type Tab = "learn" | "assess" | "manage" | "prevent"
+/**
+ * An activity that may be performed by a participant in a study.
+ */
+export class Activity {
+  /**
+   *
+   */
+  id?: Identifier
+  /**
+   * The study id of the activity.
+   */
+  studyId?: Identifier
+  /**
+   *
+   */
+  spec?: Identifier
+
+  /**
+   * The name of the activity.
+   */
+  name?: string
+
+  /**
+   *
+   */
+  schedule?: DurationIntervalLegacy
+
+  /**
+   * The configuration settings for the activity.
+   */
+  settings?: any
+
+  /**
+   * The tab settings for the activity.
+   */
+  category?: Tab[] | null
+
+  /**
+   * The type of streak for the activity.
+   */
+  streakType?: string
+}