wip

Author: silesky

packages/signals/signals-runtime/README.md

@@ -5,6 +5,6 @@ Encapsults Signals runtime functionality, in order to share logic between the si
 `yarn build` generate the following artifacts:
 | Generated File(s) | Description | 
 |--------|-------------|
-| `/dist/global/index.[platform].js`, `/[platform]/get-runtime-code.generated.js` | Exposes `globalThis.Signals` and constants (e.g. `SignalType`), either through the script tag or in the mobile JS engine | 
-| `/dist/editor/[platform]-editor.d.ts` | Type definitions for monaco editor on app.segment.com 
+| `/dist/runtime/index.[platform].js`, `/[platform]/get-runtime-code.generated.js` | Exposes `globalThis.Signals` and constants (e.g. `SignalType`), either through the script tag or in the mobile JS engine | 
+| `/dist/editor/[platform]-editor.d.ts.txt` | Type definitions for monaco editor on app.segment.com 
 | `/dist/esm/index.js` | Entry point for `@segment/analytics-signals` and the segment app, that want to consume the types / runtime code. | 

packages/signals/signals-runtime/build-signals-runtime-global.js

@@ -22,8 +22,8 @@ const getEntryPoint = (platform) => {
 }
 
 const getOutFiles = (platform) => {
-  const outfileMinified = `./dist/global/index.${platform}.min.js`
-  const outfileUnminified = `./dist/global/index.${platform}.js`
+  const outfileMinified = `./dist/runtime/index.${platform}.min.js`
+  const outfileUnminified = `./dist/runtime/index.${platform}.js`
   return {
     outfileMinified,
     outfileUnminified,

packages/signals/signals-runtime/bundle-build-tests/global.test.ts renamed to packages/signals/signals-runtime/bundle-build-tests/runtime-env.test.ts

@@ -6,7 +6,7 @@ describe('Global Scope Test: Web', () => {
   let dom: JSDOM
   beforeAll(() => {
     // Load the built file
-    const filePath = path.resolve(__dirname, '../dist/global/index.web.js')
+    const filePath = path.resolve(__dirname, '../dist/runtime/index.web.js')
     const scriptContent = fs.readFileSync(filePath, 'utf-8')
 
     // Create a new JSDOM instance
@@ -39,7 +39,7 @@ describe('Global Scope Test: Mobile', () => {
   let dom: JSDOM
   beforeAll(() => {
     // Load the built file
-    const filePath = path.resolve(__dirname, '../dist/global/index.mobile.js')
+    const filePath = path.resolve(__dirname, '../dist/runtime/index.mobile.js')
     const scriptContent = fs.readFileSync(filePath, 'utf-8')
 
     // Create a new JSDOM instance

packages/signals/signals-runtime/src/mobile/mobile-signals-types.ts

@@ -1,4 +1,4 @@
-import { BaseSignal, ISignalsRuntime } from '../shared/shared-types'
+import { BaseSignal } from '../shared/shared-types'
 
 export type SignalTypes = Signal['type']
 
@@ -88,5 +88,3 @@ interface InstrumentationData {
 interface InstrumentationSignal extends RawSignal<'instrumentation'> {
   data: InstrumentationData
 }
-
-export interface MobileSignalsRuntime extends ISignalsRuntime<Signal> {}

packages/signals/signals-runtime/src/shared/shared-types.ts

@@ -7,40 +7,6 @@ export type SignalOfType<
   SignalType extends AllSignals['type']
 > = AllSignals & { type: SignalType }
 
-/**
- * Interface for the Signals class (accessible via `signals` in the processSignal scope).
- */
-export interface ISignalsRuntime<Signal extends BaseSignal> {
-  /**
-   * Finds a signal of a specific type from a given signal.
-   *
-   * SignalType - The type of the signal to find.
-   * @param fromSignal - The signal to search from.
-   * @param signalType - The type of the signal to find.
-   * @param predicate - Optional predicate function to filter the signals.
-   * @returns The found signal of the specified type, or undefined if not found.
-   */
-  find: <SignalType extends Signal['type']>(
-    fromSignal: Signal,
-    signalType: SignalType,
-    predicate?: (signal: SignalOfType<Signal, SignalType>) => boolean
-  ) => SignalOfType<Signal, SignalType> | undefined
-
-  /**
-   * Filters signals of a specific type from a given signal.
-   * SignalType - The type of the signals to filter.
-   * @param fromSignal - The signal to search from.
-   * @param signalType - The type of the signals to filter.
-   * @param predicate - Optional predicate function to filter the signals.
-   * @returns An array of signals of the specified type.
-   */
-  filter: <SignalType extends Signal['type']>(
-    fromSignal: Signal,
-    signalType: SignalType,
-    predicate?: (signal: SignalOfType<Signal, SignalType>) => boolean
-  ) => SignalOfType<Signal, SignalType>[]
-}
-
 export type JSONPrimitive = string | number | boolean | null
 export type JSONValue = JSONPrimitive | JSONObject | JSONArray
 export type JSONObject = { [member: string]: JSONValue }

packages/signals/signals-runtime/src/shared/signals-runtime.ts

@@ -1,8 +1,4 @@
-import {
-  BaseSignal,
-  SignalOfType,
-  ISignalsRuntime,
-} from '../shared/shared-types'
+import { BaseSignal, SignalOfType } from '../shared/shared-types'
 
 /**
  * Base class that provides runtime utilities for signals.