@lwc/signals 0.0.0 → 6.2.0

package/README.md

@@ -0,0 +1,75 @@
+# @lwc/signals
+
+This is an experimental package containing the interface expected for signals.
+
+A key point to note is that when a signal is both bound to an LWC class member variable and used on a template,
+the LWC engine will attempt to subscribe a callback to rerender the template.
+
+## Reactivity with Signals
+
+A Signal is an object that holds a value and allows components to react to changes to that value.
+It exposes a `.value` property for accessing the current value, and `.subscribe` methods for responding to changes.
+
+```js
+import { signal } from 'some/signals';
+
+export default class ExampleComponent extends LightningElement {
+    count = signal(0);
+
+    increment() {
+        this.count.value++;
+    }
+}
+```
+
+In the template, we can bind directly to the `.value` property:
+
+```html
+<template>
+    <button onclick="{increment}">Increment</button>
+    <p>{count.value}</p>
+</template>
+```
+
+## Supported APIs
+
+This package supports the following APIs.
+
+### Signal
+
+This is the shape of the signal that the LWC engine expects.
+
+```js
+export type OnUpdate = () => void;
+export type Unsubscribe = () => void;
+
+export interface Signal<T> {
+    get value(): T;
+    subscribe(onUpdate: OnUpdate): Unsubscribe;
+}
+```
+
+### SignalBaseClass
+
+A base class is provided as a starting point for implementation.
+
+```js
+export abstract class SignalBaseClass<T> implements Signal<T> {
+    abstract get value(): T;
+
+    private subscribers: Set<OnUpdate> = new Set();
+
+    subscribe(onUpdate: OnUpdate) {
+        this.subscribers.add(onUpdate);
+        return () => {
+            this.subscribers.delete(onUpdate);
+        };
+    }
+
+    protected notify() {
+        for (const subscriber of this.subscribers) {
+            subscriber();
+        }
+    }
+}
+```

package/dist/index.cjs.js

@@ -0,0 +1,27 @@
+/**
+ * Copyright (c) 2024 Salesforce, Inc.
+ */
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+class SignalBaseClass {
+    constructor() {
+        this.subscribers = new Set();
+    }
+    subscribe(onUpdate) {
+        this.subscribers.add(onUpdate);
+        return () => {
+            this.subscribers.delete(onUpdate);
+        };
+    }
+    notify() {
+        for (const subscriber of this.subscribers) {
+            subscriber();
+        }
+    }
+}
+
+exports.SignalBaseClass = SignalBaseClass;
+/** version: 6.2.0 */
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/index.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;;MAcsB,eAAe,CAAA;AAArC,IAAA,WAAA,GAAA;AAGY,QAAA,IAAA,CAAA,WAAW,GAAkB,IAAI,GAAG,EAAE,CAAC;KAclD;AAZG,IAAA,SAAS,CAAC,QAAkB,EAAA;AACxB,QAAA,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AAC/B,QAAA,OAAO,MAAK;AACR,YAAA,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AACtC,SAAC,CAAC;KACL;IAES,MAAM,GAAA;AACZ,QAAA,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE;AACvC,YAAA,UAAU,EAAE,CAAC;SAChB;KACJ;AACJ;;;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+export type OnUpdate = () => void;
+export type Unsubscribe = () => void;
+export interface Signal<T> {
+    get value(): T;
+    subscribe(onUpdate: OnUpdate): Unsubscribe;
+}
+export declare abstract class SignalBaseClass<T> implements Signal<T> {
+    abstract get value(): T;
+    private subscribers;
+    subscribe(onUpdate: OnUpdate): () => void;
+    protected notify(): void;
+}

package/dist/index.js

@@ -0,0 +1,23 @@
+/**
+ * Copyright (c) 2024 Salesforce, Inc.
+ */
+class SignalBaseClass {
+    constructor() {
+        this.subscribers = new Set();
+    }
+    subscribe(onUpdate) {
+        this.subscribers.add(onUpdate);
+        return () => {
+            this.subscribers.delete(onUpdate);
+        };
+    }
+    notify() {
+        for (const subscriber of this.subscribers) {
+            subscriber();
+        }
+    }
+}
+
+export { SignalBaseClass };
+/** version: 6.2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":[null],"names":[],"mappings":";;;MAcsB,eAAe,CAAA;AAArC,IAAA,WAAA,GAAA;AAGY,QAAA,IAAA,CAAA,WAAW,GAAkB,IAAI,GAAG,EAAE,CAAC;KAclD;AAZG,IAAA,SAAS,CAAC,QAAkB,EAAA;AACxB,QAAA,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AAC/B,QAAA,OAAO,MAAK;AACR,YAAA,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AACtC,SAAC,CAAC;KACL;IAES,MAAM,GAAA;AACZ,QAAA,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE;AACvC,YAAA,UAAU,EAAE,CAAC;SAChB;KACJ;AACJ;;;;;;;"}

package/package.json

@@ -1,8 +1,44 @@
 {
-  "name": "@lwc/signals",
-  "version": "0.0.0",
-  "description": "Placeholder for signals package",
-  "main": "index.js",
-  "author": "",
-  "license": "ISC"
-}
+    "//": [
+        "THIS FILE IS AUTOGENERATED. If you modify it, it will be rewritten by check-and-rewrite-package-json.js",
+        "You can safely modify dependencies, devDependencies, keywords, etc., but other props will be overwritten."
+    ],
+    "name": "@lwc/signals",
+    "version": "6.2.0",
+    "description": "Provides the interface to interact with reactivity from outside the framework",
+    "keywords": [
+        "lwc"
+    ],
+    "homepage": "https://lwc.dev",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/salesforce/lwc.git",
+        "directory": "packages/@lwc/signals"
+    },
+    "bugs": {
+        "url": "https://github.com/salesforce/lwc/issues"
+    },
+    "license": "MIT",
+    "publishConfig": {
+        "access": "public"
+    },
+    "main": "dist/index.cjs.js",
+    "module": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "files": [
+        "dist"
+    ],
+    "scripts": {
+        "build": "rollup --config ../../../scripts/rollup/rollup.config.js",
+        "dev": "rollup  --config ../../../scripts/rollup/rollup.config.js --watch --no-watch.clearScreen"
+    },
+    "nx": {
+        "targets": {
+            "build": {
+                "outputs": [
+                    "{projectRoot}/dist"
+                ]
+            }
+        }
+    }
+}