lamp-core-lst 2025.11.1-3.basic

package/src/model/ActivityEvent.ts

@@ -0,0 +1,63 @@
+import { Identifier, Timestamp } from './Type'
+
+/**
+ * A specific sub-detail of a `ActivityEvent` that contains specific  interaction information that comprises the parent `ActivityEvent`.
+ */
+export class TemporalEvent {
+    
+    /**
+     * The item that was interacted with for example, in a Jewels game, the  corresponding alphabet, or in a survey, the question index.
+     */
+    item?: any
+    
+    /**
+     * The value of the item that was interacted with in most games,  this field is `null`, but in a survey, this field is the question  choice index.
+     */
+    value?: any
+    
+    /**
+     * The type of interaction that for this detail for example, in  a Jewels game, `none` if the tapped jewel was  incorrect, or `correct` if it was correct, or in  a survey, this field will be `null`.
+     */
+    type?: string
+    
+    /**
+     * The time difference from the previous detail or the  start of the parent result.
+     */
+    duration?: number
+    
+    /**
+     * The level of activity for this detail for example, in  games with multiple levels, this field might be `2` or  `4`, but for surveys and other games this field will  be `null`.
+     */
+    level?: number
+}
+
+/**
+ * An event generated by the participant interacting with an `Activity`.
+ */
+export class ActivityEvent { 
+    
+    /**
+     *
+     */
+    timestamp?: Timestamp
+    
+    /**
+     * The duration this event lasted before recording ended.
+     */
+    duration?: number
+
+    /**
+     *
+     */
+    activity?: Identifier
+    
+    /**
+     * The summary information for the activity event as determined by the  activity that created this activity event.
+     */
+    static_data?: any
+    
+    /**
+     * The specific interaction details of the activity event.
+     */
+    temporalSlices?: Array<any>
+}

package/src/model/ActivitySpec.ts

@@ -0,0 +1,45 @@
+/**
+ * tab setting for Activity Spec
+ */
+ type Tab = 'learn' | 'assess' | 'manage' | 'prevent'
+
+/**
+ * The ActivitySpec determines the parameters and properties of an Activity and its corresponding generated ActivityEvents.
+ */
+export class ActivitySpec {
+    
+    /**
+     * The name of the activity spec.
+     */
+    name?: string
+    
+    /**
+     * Either a binary blob containing a document or video, or a string containing instructional aid about the Activity.
+     */
+    description?: string
+    
+    /**
+     * The WebView-compatible script that provides this Activity on mobile or desktop (IFrame) clients.
+     */
+    executable?: string | null
+    
+    /**
+     * The data definition of an ActivitySpec.
+     */
+    data?: any
+    
+    /**
+     * The temporal slice data definition of an ActivitySpec.
+     */
+    temporalSlices?: any
+    
+    /**
+     * The Activity settings definition of an ActivitySpec.
+     */
+    settings?: any
+
+    /**
+     * The tab settings definition of an ActivitySpec.
+     */
+    category?: Tab[] | null    
+}

package/src/model/Credential.ts

@@ -0,0 +1,26 @@
+
+/**
+ * Every object can have one or more credential(s) associated with it. i.e. my_researcher.credentials = ['person A', 'person B', 'api A', 'person C', 'api B']
+ */
+export class Credential {
+    
+    /**
+     * The root object this credential is attached to. The scope of this credential is limited to the object itself and any children.
+     */
+    origin?: string
+    
+    /**
+     * Username or machine-readable public key (access).
+     */
+    accessKey?: string
+    
+    /**
+     * SALTED HASH OF Password or machine-readable private key (secret).
+     */
+    secretKey?: string
+    
+    /**
+     * The user-visible description of the credential.
+     */
+    description?: string
+}

package/src/model/DynamicAttachment.ts

@@ -0,0 +1,42 @@
+import { Identifier } from './Type'
+
+/**
+ *
+ */
+export class DynamicAttachment {
+    
+    /**
+     * The key.
+     */
+    key?: string
+    
+    /**
+     *
+     */
+    from?: Identifier
+    
+    /**
+     * Either \"me\" to apply to the attachment owner only, the ID of an object owned  by the attachment owner, or a string representing the child object type to apply to.
+     */
+    to?: string
+    
+    /**
+     * The API triggers that activate script execution. These will be event stream types or object types in the API, or, if scheduling execution periodically, a cron-job string prefixed with \"!\" (exclamation point).
+     */
+    triggers?: Array<any>
+    
+    /**
+     * The script language.
+     */
+    language?: string
+    
+    /**
+     * The script contents.
+     */
+    contents?: string
+    
+    /**
+     * The script requirements.
+     */
+    requirements?: Array<any>
+}

package/src/model/Participant.ts

@@ -0,0 +1,37 @@
+import { Identifier } from './Type'
+
+/**
+ * A participant within a study a participant cannot be enrolled in  more than one study at a time.
+ */
+export class Participant {
+    
+    /**
+     *
+     */ 
+    id?: Identifier
+    
+    /**
+     * The researcher-provided study code for the participant.
+     */
+    studyCode?: string
+    
+    /**
+     * The participant's selected language code for the LAMP app.
+     */
+    language?: string
+    
+    /**
+     * The participant's selected theme for the LAMP app.
+     */
+    theme?: string
+    
+    /**
+     * The participant's emergency contact number.
+     */
+    emergencyContact?: string
+    
+    /**
+     * The participant's selected personal helpline number.
+     */
+    helpline?: string
+}

package/src/model/Researcher.ts

@@ -0,0 +1,33 @@
+import { Identifier } from './Type'
+import { Study } from './Study'
+
+/**
+ *
+ */
+export class Researcher { 
+    
+    /**
+     *
+     */
+    id?: Identifier
+    
+    /**
+     * The name of the researcher.
+     */
+    name?: string
+    
+    /**
+     * The email address of the researcher.
+     */
+    email?: string
+    
+    /**
+     * The physical address of the researcher.
+     */
+    address?: string
+    
+    /**
+     * The set of all studies conducted by the researcher.
+     */
+    studies?: Study[]
+}

package/src/model/ResearcherSettings.ts

@@ -0,0 +1,65 @@
+import { Identifier, Timestamp } from "./Type"
+
+/**
+ *
+ */
+export class ResearcherSettings {
+  /**
+   * The banner greeting.
+   */
+  bannerSettings?: string
+
+  /**
+   * The banner heading
+   */
+  bannerHeading?: string
+
+  /**
+   * The banner sub heading
+   */
+  bannerSubHeading?: string
+
+  /**
+   * The image icon for banner
+   */
+  imageBase64?: string
+
+  /**
+   * The selected activity
+   */
+  selectedActivity?: string
+
+  /**
+   * The selected group
+   */
+  selectedGroup?: string
+  /**
+   * The button text
+   */
+  buttonText?: string
+  /**
+   * The activityId
+   */
+  activityId?: string
+  /**
+   * The favourite activities
+   */
+  favouriteActivities?: any
+  /**
+   * The featured activity
+   */
+  featuredActivity?: string
+  /**
+   * The timestamp
+   */
+  timestamp?: Timestamp
+
+  /**
+   * The deleted flag
+   */
+  deleted?: boolean
+}
+
+export type ResearcherBanner = {
+  data: ResearcherSettings
+}

package/src/model/Sensor.ts

@@ -0,0 +1,27 @@
+import { Identifier, Timestamp } from './Type'
+
+/**
+ * A sensor that may or may not be available on a physical device.
+ */
+export class Sensor { 
+    
+    /**
+     * The self-referencing identifier to this object.
+     */
+    id?: Identifier
+    
+    /**
+     * The specification, parameters, and type of the sensor.
+     */
+    spec?: Identifier
+    
+    /**
+     * The name of the sensor.
+     */
+    name?: string
+    
+    /**
+     * The configuration settings for the sensor.
+     */
+    settings?: any
+}

package/src/model/SensorEvent.ts

@@ -0,0 +1,22 @@
+import { Timestamp } from './Type'
+
+/**
+ * An event generated by a participant interacting with the LAMP app.
+ */
+export class SensorEvent { 
+
+    /**
+     *
+     */
+    timestamp?: Timestamp
+    
+    /**
+     * The type of the sensor event.
+     */
+    sensor?: string
+    
+    /**
+     * The item information recorded within the sensor event.
+     */
+    data?: any
+}

package/src/model/SensorSpec.ts

@@ -0,0 +1,16 @@
+
+/**
+ * The SensorSpec determines the parameters of generated SensorEvents.
+ */
+export class SensorSpec {
+    
+    /**
+     * The name of the sensor.
+     */
+    name?: string
+    
+    /**
+     * The data definition of a SensorSpec.
+     */
+    settingsSchema?: any
+}

package/src/model/Study.ts

@@ -0,0 +1,29 @@
+import { Identifier } from './Type'
+import { Activity } from './Activity'
+import { Participant } from './Participant'
+
+/**
+ *
+ */
+export class Study { 
+    
+    /**
+     *
+     */
+    id?: Identifier
+
+    /**
+     * The name of the study.
+     */
+    name?: string
+
+    /**
+     * The set of all activities available in the study.
+     */
+    activities?: Activity[]
+
+    /**
+     * The set of all enrolled participants in the study.
+     */
+    participants?: Participant[]
+}

package/src/model/Type.ts

@@ -0,0 +1,68 @@
+
+/**
+ * A globally unique reference for objects.
+ */
+export type Identifier = string
+
+/**
+ * The UNIX Epoch date-time representation: number of milliseconds since 1/1/1970 12:00 AM.
+ */
+export type Timestamp = number
+
+/**
+ * Runtime type specification for each object in the LAMP platform.
+ */
+export interface Type {}
+
+/**
+ *
+ */
+export class AccessCitation { 
+    
+    /**
+     *
+     */
+    _in?: string
+    
+    /**
+     *
+     */
+    at?: string
+    
+    /**
+     *
+     */
+    on?: Timestamp
+    
+    /**
+     *
+     */
+    by?: string
+}
+
+/**
+ *
+ */
+export class Metadata { 
+    
+    /**
+     *
+     */
+    access?: AccessCitation
+}
+
+/**
+ *
+ */
+export class Document { 
+    
+    /**
+     *
+     */
+    meta?: Metadata
+    
+    /**
+     *
+     */
+    data?: Array<any>
+}

package/src/model/index.ts

@@ -0,0 +1,12 @@
+export * from './Activity'
+export * from './ActivityEvent'
+export * from './ActivitySpec'
+export * from './Credential'
+export * from './Participant'
+export * from './Researcher'
+export * from './ResearcherSettings'
+export * from './Sensor'
+export * from './SensorEvent'
+export * from './SensorSpec'
+export * from './Study'
+export * from './Type'

package/src/service/API.service.ts

@@ -0,0 +1,29 @@
+import { Fetch, Configuration } from "./Fetch"
+import { Demo } from "./Demo"
+import jsonata from "jsonata"
+
+export class APIService {
+  public configuration?: Configuration
+
+  /**
+   * Query the LAMP Database.
+   */
+  public async query(transform: string): Promise<{}> {
+    if (this.configuration.base === "https://demo.lamp.digital") {
+      // DEMO
+      return Promise.resolve({ error: "500.demo-unavailable" } as any)
+    }
+    return await Fetch.post<{}>(`/`, transform, this.configuration)
+  }
+
+  /**
+   * View the API schema document.
+   */
+  public async schema(): Promise<{}> {
+    if (this.configuration.base === "https://demo.lamp.digital") {
+      // DEMO
+      return Promise.resolve({ error: "500.demo-unavailable" } as any)
+    }
+    return await Fetch.get<{}>(`/`, this.configuration)
+  }
+}