@vaadin/hilla-react-signals 24.6.0 → 24.6.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/FullStackSignal.d.ts +14 -3
- package/FullStackSignal.d.ts.map +1 -1
- package/FullStackSignal.js +1 -6
- package/FullStackSignal.js.map +2 -2
- package/ListSignal.d.ts +2 -0
- package/ListSignal.d.ts.map +1 -1
- package/ListSignal.js +6 -1
- package/ListSignal.js.map +2 -2
- package/ValueSignal.d.ts +3 -1
- package/ValueSignal.d.ts.map +1 -1
- package/ValueSignal.js +4 -2
- package/ValueSignal.js.map +2 -2
- package/index.d.ts +1 -0
- package/index.d.ts.map +1 -1
- package/index.js.map +1 -1
- package/package.json +16 -14
package/FullStackSignal.d.ts
CHANGED
|
@@ -2,11 +2,22 @@ import type { ConnectClient, Subscription } from '@vaadin/hilla-frontend';
|
|
|
2
2
|
import { Signal } from './core.js';
|
|
3
3
|
import { type StateEvent } from './events.js';
|
|
4
4
|
/**
|
|
5
|
-
* A return type for signal operations
|
|
5
|
+
* A return type for signal operations that exposes a `result` property of type
|
|
6
|
+
* `Promise`, that resolves when the operation is completed. It allows defining
|
|
7
|
+
* callbacks to be run after the operation is completed, or error handling when
|
|
8
|
+
* the operation fails.
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* ```ts
|
|
12
|
+
* const sharedName = NameService.sharedName({ defaultValue: '' });
|
|
13
|
+
* sharedName.replace('John').result
|
|
14
|
+
* .then(() => console.log('Name updated successfully'))
|
|
15
|
+
* .catch((error) => console.error('Failed to update the name:', error));
|
|
16
|
+
* ```
|
|
6
17
|
*/
|
|
7
|
-
export
|
|
18
|
+
export interface Operation {
|
|
8
19
|
result: Promise<void>;
|
|
9
|
-
}
|
|
20
|
+
}
|
|
10
21
|
/**
|
|
11
22
|
* An abstraction of a signal that tracks the number of subscribers, and calls
|
|
12
23
|
* the provided `onSubscribe` and `onUnsubscribe` callbacks for the first
|
package/FullStackSignal.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FullStackSignal.d.ts","sourceRoot":"","sources":["src/FullStackSignal.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAA4B,aAAa,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAEpG,OAAO,EAAoB,MAAM,EAAE,MAAM,WAAW,CAAC;AACrD,OAAO,EAAuB,KAAK,UAAU,EAAE,MAAM,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"FullStackSignal.d.ts","sourceRoot":"","sources":["src/FullStackSignal.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAA4B,aAAa,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAEpG,OAAO,EAAoB,MAAM,EAAE,MAAM,WAAW,CAAC;AACrD,OAAO,EAAuB,KAAK,UAAU,EAAE,MAAM,aAAa,CAAC;AAInE;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;CACvB;AAED;;;;;GAKG;AACH,8BAAsB,wBAAwB,CAAC,CAAC,CAAE,SAAQ,MAAM,CAAC,CAAC,CAAC;;IAQjE,SAAS,aAAa,KAAK,EAAE,CAAC,GAAG,SAAS,EAAE,gBAAgB,EAAE,MAAM,IAAI,EAAE,iBAAiB,EAAE,MAAM,IAAI;cAMpF,CAAC,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI;cAQtB,CAAC,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI;CAO1C;AAED;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,QAAQ,CAAC;IAC5C;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEjC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC,CAAC;AAEH;;GAEG;AACH,cAAM,gBAAgB;;IAEpB,QAAQ,CAAC,MAAM,EAAE,sBAAsB,CAAC;gBAG5B,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,sBAAsB;IAKtD,IAAI,YAAY;;;;;;oBAEf;IAED,OAAO;;;;;;;IAcD,MAAM,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAiB9C,UAAU;CAIX;AAED,eAAO,MAAM,OAAO,eAAmB,CAAC;AACxC,eAAO,MAAM,sBAAsB,eAAkC,CAAC;AACtE,eAAO,MAAM,gBAAgB,eAA4B,CAAC;AAC1D,eAAO,MAAM,iBAAiB,eAA6B,CAAC;AAC5D,eAAO,MAAM,gBAAgB,eAA4B,CAAC;AAE1D;;;;;;;GAOG;AACH,8BAAsB,eAAe,CAAC,CAAC,CAAE,SAAQ,wBAAwB,CAAC,CAAC,CAAC;;IAC1E;;;OAGG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,OAAO,yDAAuC;IAEvD;;OAEG;IACH,QAAQ,CAAC,KAAK,mEAAqC;gBASvC,KAAK,EAAE,CAAC,GAAG,SAAS,EAAE,MAAM,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM;IAsC7E,SAAS,CAAC,CAAC,gBAAgB,CAAC,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE;QAAE,EAAE,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAA;KAAE,GAAG,SAAS;IAkClG;;;;OAIG;IACH,SAAS,CAAC,CAAC,gBAAgB,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI;IAM5C;;;;;OAKG;cACa,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAW3D;;;;;OAKG;IACH,SAAS,CAAC,CAAC,iBAAiB,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI;IAYrE;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,CAAC,CAAC,sBAAsB,CAAC,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;CAmBrE"}
|
package/FullStackSignal.js
CHANGED
|
@@ -9,11 +9,6 @@ class DependencyTrackingSignal extends Signal {
|
|
|
9
9
|
// FullStackSignal constructor.
|
|
10
10
|
#subscribeCount = -1;
|
|
11
11
|
constructor(value, onFirstSubscribe, onLastUnsubscribe) {
|
|
12
|
-
if (!globalThis.Vaadin?.featureFlags?.fullstackSignals) {
|
|
13
|
-
throw new Error(
|
|
14
|
-
`The Hilla Fullstack Signals API is currently considered experimental and may change in the future. To use it you need to explicitly enable it in Copilot or by adding com.vaadin.experimental.fullstackSignals=true to vaadin-featureflags.properties`
|
|
15
|
-
);
|
|
16
|
-
}
|
|
17
12
|
super(value);
|
|
18
13
|
this.#onFirstSubscribe = onFirstSubscribe;
|
|
19
14
|
this.#onLastUnsubscribe = onLastUnsubscribe;
|
|
@@ -121,7 +116,7 @@ class FullStackSignal extends DependencyTrackingSignal {
|
|
|
121
116
|
}
|
|
122
117
|
// stores the promise handlers associated to operations
|
|
123
118
|
#operationPromises = /* @__PURE__ */ new Map();
|
|
124
|
-
// creates the
|
|
119
|
+
// creates the object to be returned by operations to allow defining callbacks
|
|
125
120
|
[$createOperation]({ id, promise }) {
|
|
126
121
|
const thens = this.#operationPromises;
|
|
127
122
|
const promises = [];
|
package/FullStackSignal.js.map
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["src/FullStackSignal.ts"],
|
|
4
|
-
"sourcesContent": ["import type { ActionOnLostSubscription, ConnectClient, Subscription } from '@vaadin/hilla-frontend';\nimport { nanoid } from 'nanoid';\nimport { computed, signal, Signal } from './core.js';\nimport { createSetStateEvent, type StateEvent } from './events.js';\n\
|
|
5
|
-
"mappings": "AACA,SAAS,cAAc;AACvB,SAAS,UAAU,QAAQ,cAAc;AACzC,SAAS,2BAA4C;
|
|
4
|
+
"sourcesContent": ["import type { ActionOnLostSubscription, ConnectClient, Subscription } from '@vaadin/hilla-frontend';\nimport { nanoid } from 'nanoid';\nimport { computed, signal, Signal } from './core.js';\nimport { createSetStateEvent, type StateEvent } from './events.js';\n\nconst ENDPOINT = 'SignalsHandler';\n\n/**\n * A return type for signal operations that exposes a `result` property of type\n * `Promise`, that resolves when the operation is completed. It allows defining\n * callbacks to be run after the operation is completed, or error handling when\n * the operation fails.\n *\n * @example\n * ```ts\n * const sharedName = NameService.sharedName({ defaultValue: '' });\n * sharedName.replace('John').result\n * .then(() => console.log('Name updated successfully'))\n * .catch((error) => console.error('Failed to update the name:', error));\n * ```\n */\nexport interface Operation {\n result: Promise<void>;\n}\n\n/**\n * An abstraction of a signal that tracks the number of subscribers, and calls\n * the provided `onSubscribe` and `onUnsubscribe` callbacks for the first\n * subscription and the last unsubscription, respectively.\n * @internal\n */\nexport abstract class DependencyTrackingSignal<T> extends Signal<T> {\n readonly #onFirstSubscribe: () => void;\n readonly #onLastUnsubscribe: () => void;\n\n // -1 means to ignore the first subscription that is created internally in the\n // FullStackSignal constructor.\n #subscribeCount = -1;\n\n protected constructor(value: T | undefined, onFirstSubscribe: () => void, onLastUnsubscribe: () => void) {\n super(value);\n this.#onFirstSubscribe = onFirstSubscribe;\n this.#onLastUnsubscribe = onLastUnsubscribe;\n }\n\n protected override S(node: unknown): void {\n super.S(node);\n if (this.#subscribeCount === 0) {\n this.#onFirstSubscribe();\n }\n this.#subscribeCount += 1;\n }\n\n protected override U(node: unknown): void {\n super.U(node);\n this.#subscribeCount -= 1;\n if (this.#subscribeCount === 0) {\n this.#onLastUnsubscribe();\n }\n }\n}\n\n/**\n * An object that describes a data object to connect to the signal provider\n * service.\n */\nexport type ServerConnectionConfig = Readonly<{\n /**\n * The client instance to be used for communication.\n */\n client: ConnectClient;\n\n /**\n * The name of the signal provider service endpoint.\n */\n endpoint: string;\n\n /**\n * The name of the signal provider service method.\n */\n method: string;\n\n /**\n * Optional object with method call arguments to be sent to the endpoint\n * method that provides the signal when subscribing to it.\n */\n params?: Record<string, unknown>;\n\n /**\n * The unique identifier of the parent signal in the client.\n */\n parentClientSignalId?: string;\n}>;\n\n/**\n * A server connection manager.\n */\nclass ServerConnection {\n readonly #id: string;\n readonly config: ServerConnectionConfig;\n #subscription?: Subscription<StateEvent>;\n\n constructor(id: string, config: ServerConnectionConfig) {\n this.config = config;\n this.#id = id;\n }\n\n get subscription() {\n return this.#subscription;\n }\n\n connect() {\n const { client, endpoint, method, params, parentClientSignalId } = this.config;\n\n this.#subscription ??= client.subscribe(ENDPOINT, 'subscribe', {\n providerEndpoint: endpoint,\n providerMethod: method,\n clientSignalId: this.#id,\n params,\n parentClientSignalId,\n });\n\n return this.#subscription;\n }\n\n async update(event: StateEvent): Promise<void> {\n const onTheFly = !this.#subscription;\n\n if (onTheFly) {\n this.connect();\n }\n\n await this.config.client.call(ENDPOINT, 'update', {\n clientSignalId: this.#id,\n event,\n });\n\n if (onTheFly) {\n this.disconnect();\n }\n }\n\n disconnect() {\n this.#subscription?.cancel();\n this.#subscription = undefined;\n }\n}\n\nexport const $update = Symbol('update');\nexport const $processServerResponse = Symbol('processServerResponse');\nexport const $setValueQuietly = Symbol('setValueQuietly');\nexport const $resolveOperation = Symbol('resolveOperation');\nexport const $createOperation = Symbol('createOperation');\n\n/**\n * A signal that holds a shared value. Each change to the value is propagated to\n * the server-side signal provider. At the same time, each change received from\n * the server-side signal provider is propagated to the local signal and it's\n * subscribers.\n *\n * @internal\n */\nexport abstract class FullStackSignal<T> extends DependencyTrackingSignal<T> {\n /**\n * The unique identifier of the signal necessary to communicate with the\n * server.\n */\n readonly id: string;\n\n /**\n * The server connection manager.\n */\n readonly server: ServerConnection;\n\n /**\n * Defines whether the signal is currently awaits a server-side response.\n */\n readonly pending = computed(() => this.#pending.value);\n\n /**\n * Defines whether the signal has an error.\n */\n readonly error = computed(() => this.#error.value);\n\n readonly #pending = signal(false);\n readonly #error = signal<Error | undefined>(undefined);\n\n // Paused at the very start to prevent the signal from sending the initial\n // value to the server.\n #paused = true;\n\n constructor(value: T | undefined, config: ServerConnectionConfig, id?: string) {\n super(\n value,\n () => this.#connect(),\n () => this.#disconnect(),\n );\n this.id = id ?? nanoid();\n this.server = new ServerConnection(this.id, config);\n\n this.subscribe((v) => {\n if (!this.#paused) {\n this.#pending.value = true;\n this.#error.value = undefined;\n // For internal signals, the provided non-null to the constructor should\n // be used along with the parent client side signal id when sending the\n // set event to the server. For internal signals this combination is\n // needed for addressing the correct parent/child signal instances on\n // the server. For a standalone signal, both of them should be passed in\n // as undefined:\n const signalId = config.parentClientSignalId !== undefined ? this.id : undefined;\n // eslint-disable-next-line @typescript-eslint/no-floating-promises\n this[$update](createSetStateEvent(v, signalId, config.parentClientSignalId));\n }\n });\n\n this.#paused = false;\n }\n\n // stores the promise handlers associated to operations\n readonly #operationPromises = new Map<\n string,\n {\n resolve(value: PromiseLike<void> | void): void;\n reject(reason?: any): void;\n }\n >();\n\n // creates the object to be returned by operations to allow defining callbacks\n protected [$createOperation]({ id, promise }: { id?: string; promise?: Promise<void> }): Operation {\n const thens = this.#operationPromises;\n const promises: Array<Promise<void>> = [];\n\n if (promise) {\n // Add the provided promise to the list of promises\n promises.push(promise);\n }\n\n if (id) {\n // Create a promise to be associated to the provided id\n promises.push(\n new Promise<void>((resolve, reject) => {\n thens.set(id, { resolve, reject });\n }),\n );\n }\n\n if (promises.length === 0) {\n // If no promises were added, return a resolved promise\n promises.push(Promise.resolve());\n }\n\n return {\n result: Promise.allSettled(promises).then((results) => {\n const lastResult = results[results.length - 1];\n if (lastResult.status === 'fulfilled') {\n return undefined;\n }\n throw lastResult.reason;\n }),\n };\n }\n\n /**\n * Sets the local value of the signal without sending any events to the server\n * @param value - The new value.\n * @internal\n */\n protected [$setValueQuietly](value: T): void {\n this.#paused = true;\n super.value = value;\n this.#paused = false;\n }\n\n /**\n * A method to update the server with the new value.\n *\n * @param event - The event to update the server with.\n * @returns The server response promise.\n */\n protected async [$update](event: StateEvent): Promise<void> {\n return this.server\n .update(event)\n .catch((error: unknown) => {\n this.#error.value = error instanceof Error ? error : new Error(String(error));\n })\n .finally(() => {\n this.#pending.value = false;\n });\n }\n\n /**\n * Resolves the operation promise associated with the given event id.\n *\n * @param eventId - The event id.\n * @param reason - The reason to reject the promise (if any).\n */\n protected [$resolveOperation](eventId: string, reason?: string): void {\n const operationPromise = this.#operationPromises.get(eventId);\n if (operationPromise) {\n this.#operationPromises.delete(eventId);\n if (reason) {\n operationPromise.reject(reason);\n } else {\n operationPromise.resolve();\n }\n }\n }\n\n /**\n * A method with to process the server response. The implementation is\n * specific for each signal type.\n *\n * @param event - The server response event.\n */\n protected abstract [$processServerResponse](event: StateEvent): void;\n\n #connect() {\n this.server\n .connect()\n .onSubscriptionLost(() => 'resubscribe' as ActionOnLostSubscription)\n .onNext((event: StateEvent) => {\n this.#paused = true;\n this[$processServerResponse](event);\n this.#paused = false;\n });\n }\n\n #disconnect() {\n if (this.server.subscription === undefined) {\n return;\n }\n this.server.disconnect();\n }\n}\n"],
|
|
5
|
+
"mappings": "AACA,SAAS,cAAc;AACvB,SAAS,UAAU,QAAQ,cAAc;AACzC,SAAS,2BAA4C;AAErD,MAAM,WAAW;AA0BV,MAAe,iCAAoC,OAAU;AAAA,EACzD;AAAA,EACA;AAAA;AAAA;AAAA,EAIT,kBAAkB;AAAA,EAER,YAAY,OAAsB,kBAA8B,mBAA+B;AACvG,UAAM,KAAK;AACX,SAAK,oBAAoB;AACzB,SAAK,qBAAqB;AAAA,EAC5B;AAAA,EAEmB,EAAE,MAAqB;AACxC,UAAM,EAAE,IAAI;AACZ,QAAI,KAAK,oBAAoB,GAAG;AAC9B,WAAK,kBAAkB;AAAA,IACzB;AACA,SAAK,mBAAmB;AAAA,EAC1B;AAAA,EAEmB,EAAE,MAAqB;AACxC,UAAM,EAAE,IAAI;AACZ,SAAK,mBAAmB;AACxB,QAAI,KAAK,oBAAoB,GAAG;AAC9B,WAAK,mBAAmB;AAAA,IAC1B;AAAA,EACF;AACF;AAqCA,MAAM,iBAAiB;AAAA,EACZ;AAAA,EACA;AAAA,EACT;AAAA,EAEA,YAAY,IAAY,QAAgC;AACtD,SAAK,SAAS;AACd,SAAK,MAAM;AAAA,EACb;AAAA,EAEA,IAAI,eAAe;AACjB,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,UAAU;AACR,UAAM,EAAE,QAAQ,UAAU,QAAQ,QAAQ,qBAAqB,IAAI,KAAK;AAExE,SAAK,kBAAkB,OAAO,UAAU,UAAU,aAAa;AAAA,MAC7D,kBAAkB;AAAA,MAClB,gBAAgB;AAAA,MAChB,gBAAgB,KAAK;AAAA,MACrB;AAAA,MACA;AAAA,IACF,CAAC;AAED,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,MAAM,OAAO,OAAkC;AAC7C,UAAM,WAAW,CAAC,KAAK;AAEvB,QAAI,UAAU;AACZ,WAAK,QAAQ;AAAA,IACf;AAEA,UAAM,KAAK,OAAO,OAAO,KAAK,UAAU,UAAU;AAAA,MAChD,gBAAgB,KAAK;AAAA,MACrB;AAAA,IACF,CAAC;AAED,QAAI,UAAU;AACZ,WAAK,WAAW;AAAA,IAClB;AAAA,EACF;AAAA,EAEA,aAAa;AACX,SAAK,eAAe,OAAO;AAC3B,SAAK,gBAAgB;AAAA,EACvB;AACF;AAEO,MAAM,UAAU,OAAO,QAAQ;AAC/B,MAAM,yBAAyB,OAAO,uBAAuB;AAC7D,MAAM,mBAAmB,OAAO,iBAAiB;AACjD,MAAM,oBAAoB,OAAO,kBAAkB;AACnD,MAAM,mBAAmB,OAAO,iBAAiB;AAUjD,MAAe,wBAA2B,yBAA4B;AAAA;AAAA;AAAA;AAAA;AAAA,EAKlE;AAAA;AAAA;AAAA;AAAA,EAKA;AAAA;AAAA;AAAA;AAAA,EAKA,UAAU,SAAS,MAAM,KAAK,SAAS,KAAK;AAAA;AAAA;AAAA;AAAA,EAK5C,QAAQ,SAAS,MAAM,KAAK,OAAO,KAAK;AAAA,EAExC,WAAW,OAAO,KAAK;AAAA,EACvB,SAAS,OAA0B,MAAS;AAAA;AAAA;AAAA,EAIrD,UAAU;AAAA,EAEV,YAAY,OAAsB,QAAgC,IAAa;AAC7E;AAAA,MACE;AAAA,MACA,MAAM,KAAK,SAAS;AAAA,MACpB,MAAM,KAAK,YAAY;AAAA,IACzB;AACA,SAAK,KAAK,MAAM,OAAO;AACvB,SAAK,SAAS,IAAI,iBAAiB,KAAK,IAAI,MAAM;AAElD,SAAK,UAAU,CAAC,MAAM;AACpB,UAAI,CAAC,KAAK,SAAS;AACjB,aAAK,SAAS,QAAQ;AACtB,aAAK,OAAO,QAAQ;AAOpB,cAAM,WAAW,OAAO,yBAAyB,SAAY,KAAK,KAAK;AAEvE,aAAK,OAAO,EAAE,oBAAoB,GAAG,UAAU,OAAO,oBAAoB,CAAC;AAAA,MAC7E;AAAA,IACF,CAAC;AAED,SAAK,UAAU;AAAA,EACjB;AAAA;AAAA,EAGS,qBAAqB,oBAAI,IAMhC;AAAA;AAAA,EAGF,CAAW,gBAAgB,EAAE,EAAE,IAAI,QAAQ,GAAwD;AACjG,UAAM,QAAQ,KAAK;AACnB,UAAM,WAAiC,CAAC;AAExC,QAAI,SAAS;AAEX,eAAS,KAAK,OAAO;AAAA,IACvB;AAEA,QAAI,IAAI;AAEN,eAAS;AAAA,QACP,IAAI,QAAc,CAAC,SAAS,WAAW;AACrC,gBAAM,IAAI,IAAI,EAAE,SAAS,OAAO,CAAC;AAAA,QACnC,CAAC;AAAA,MACH;AAAA,IACF;AAEA,QAAI,SAAS,WAAW,GAAG;AAEzB,eAAS,KAAK,QAAQ,QAAQ,CAAC;AAAA,IACjC;AAEA,WAAO;AAAA,MACL,QAAQ,QAAQ,WAAW,QAAQ,EAAE,KAAK,CAAC,YAAY;AACrD,cAAM,aAAa,QAAQ,QAAQ,SAAS,CAAC;AAC7C,YAAI,WAAW,WAAW,aAAa;AACrC,iBAAO;AAAA,QACT;AACA,cAAM,WAAW;AAAA,MACnB,CAAC;AAAA,IACH;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,CAAW,gBAAgB,EAAE,OAAgB;AAC3C,SAAK,UAAU;AACf,UAAM,QAAQ;AACd,SAAK,UAAU;AAAA,EACjB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAiB,OAAO,EAAE,OAAkC;AAC1D,WAAO,KAAK,OACT,OAAO,KAAK,EACZ,MAAM,CAAC,UAAmB;AACzB,WAAK,OAAO,QAAQ,iBAAiB,QAAQ,QAAQ,IAAI,MAAM,OAAO,KAAK,CAAC;AAAA,IAC9E,CAAC,EACA,QAAQ,MAAM;AACb,WAAK,SAAS,QAAQ;AAAA,IACxB,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,CAAW,iBAAiB,EAAE,SAAiB,QAAuB;AACpE,UAAM,mBAAmB,KAAK,mBAAmB,IAAI,OAAO;AAC5D,QAAI,kBAAkB;AACpB,WAAK,mBAAmB,OAAO,OAAO;AACtC,UAAI,QAAQ;AACV,yBAAiB,OAAO,MAAM;AAAA,MAChC,OAAO;AACL,yBAAiB,QAAQ;AAAA,MAC3B;AAAA,IACF;AAAA,EACF;AAAA,EAUA,WAAW;AACT,SAAK,OACF,QAAQ,EACR,mBAAmB,MAAM,aAAyC,EAClE,OAAO,CAAC,UAAsB;AAC7B,WAAK,UAAU;AACf,WAAK,sBAAsB,EAAE,KAAK;AAClC,WAAK,UAAU;AAAA,IACjB,CAAC;AAAA,EACL;AAAA,EAEA,cAAc;AACZ,QAAI,KAAK,OAAO,iBAAiB,QAAW;AAC1C;AAAA,IACF;AACA,SAAK,OAAO,WAAW;AAAA,EACzB;AACF;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
package/ListSignal.d.ts
CHANGED
|
@@ -20,11 +20,13 @@ export declare class ListSignal<T> extends CollectionSignal<ReadonlyArray<ValueS
|
|
|
20
20
|
/**
|
|
21
21
|
* Inserts a new value at the end of the list.
|
|
22
22
|
* @param value - The value to insert.
|
|
23
|
+
* @returns An operation object that allows to perform additional actions.
|
|
23
24
|
*/
|
|
24
25
|
insertLast(value: T): Operation;
|
|
25
26
|
/**
|
|
26
27
|
* Removes the given item from the list.
|
|
27
28
|
* @param item - The item to remove.
|
|
29
|
+
* @returns An operation object that allows to perform additional actions.
|
|
28
30
|
*/
|
|
29
31
|
remove(item: ValueSignal<T>): Operation;
|
|
30
32
|
}
|
package/ListSignal.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ListSignal.d.ts","sourceRoot":"","sources":["src/ListSignal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EASL,KAAK,UAAU,EAChB,MAAM,aAAa,CAAC;AACrB,OAAO,EAEL,sBAAsB,EAItB,KAAK,SAAS,EACd,KAAK,sBAAsB,EAC5B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAU/C;;;;;;;;;;GAUG;AACH,qBAAa,UAAU,CAAC,CAAC,CAAE,SAAQ,gBAAgB,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;;gBAMpE,MAAM,EAAE,sBAAsB;cAgBvB,CAAC,sBAAsB,CAAC,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;
|
|
1
|
+
{"version":3,"file":"ListSignal.d.ts","sourceRoot":"","sources":["src/ListSignal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EASL,KAAK,UAAU,EAChB,MAAM,aAAa,CAAC;AACrB,OAAO,EAEL,sBAAsB,EAItB,KAAK,SAAS,EACd,KAAK,sBAAsB,EAC5B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAU/C;;;;;;;;;;GAUG;AACH,qBAAa,UAAU,CAAC,CAAC,CAAE,SAAQ,gBAAgB,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;;gBAMpE,MAAM,EAAE,sBAAsB;cAgBvB,CAAC,sBAAsB,CAAC,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;IAyFpE;;;;OAIG;IACH,UAAU,CAAC,KAAK,EAAE,CAAC,GAAG,SAAS;IAM/B;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,SAAS;CASxC"}
|
package/ListSignal.js
CHANGED
|
@@ -34,7 +34,10 @@ class ListSignal extends CollectionSignal {
|
|
|
34
34
|
}
|
|
35
35
|
[$processServerResponse](event) {
|
|
36
36
|
if (!event.accepted) {
|
|
37
|
-
this[$resolveOperation](
|
|
37
|
+
this[$resolveOperation](
|
|
38
|
+
event.id,
|
|
39
|
+
`Server rejected the operation with id '${event.id}'. See the server log for more details.`
|
|
40
|
+
);
|
|
38
41
|
return;
|
|
39
42
|
}
|
|
40
43
|
if (isListSnapshotStateEvent(event)) {
|
|
@@ -116,6 +119,7 @@ class ListSignal extends CollectionSignal {
|
|
|
116
119
|
/**
|
|
117
120
|
* Inserts a new value at the end of the list.
|
|
118
121
|
* @param value - The value to insert.
|
|
122
|
+
* @returns An operation object that allows to perform additional actions.
|
|
119
123
|
*/
|
|
120
124
|
insertLast(value) {
|
|
121
125
|
const event = createInsertLastStateEvent(value);
|
|
@@ -125,6 +129,7 @@ class ListSignal extends CollectionSignal {
|
|
|
125
129
|
/**
|
|
126
130
|
* Removes the given item from the list.
|
|
127
131
|
* @param item - The item to remove.
|
|
132
|
+
* @returns An operation object that allows to perform additional actions.
|
|
128
133
|
*/
|
|
129
134
|
remove(item) {
|
|
130
135
|
const entryToRemove = this.#values.get(item.id);
|
package/ListSignal.js.map
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["src/ListSignal.ts"],
|
|
4
|
-
"sourcesContent": ["import { CollectionSignal } from './CollectionSignal.js';\nimport {\n createInsertLastStateEvent,\n createRemoveStateEvent,\n type InsertLastStateEvent,\n isInsertLastStateEvent,\n isListSnapshotStateEvent,\n isRemoveStateEvent,\n type ListSnapshotStateEvent,\n type RemoveStateEvent,\n type StateEvent,\n} from './events.js';\nimport {\n $createOperation,\n $processServerResponse,\n $resolveOperation,\n $setValueQuietly,\n $update,\n type Operation,\n type ServerConnectionConfig,\n} from './FullStackSignal.js';\nimport { ValueSignal } from './ValueSignal.js';\n\ntype EntryId = string;\ntype Entry<T> = {\n id: EntryId;\n value: ValueSignal<T>;\n next?: EntryId;\n prev?: EntryId;\n};\n\n/**\n * A {@link FullStackSignal} that represents a shared list of values, where each\n * value is represented by a {@link ValueSignal}.\n * The list can be modified by calling the defined methods to insert or remove\n * items, but the `value` property of a `ListSignal` instance is read-only and\n * cannot be assigned directly.\n * The value of each item in the list can be manipulated similar to a regular\n * {@link ValueSignal}.\n *\n * @typeParam T - The type of the values in the list.\n */\nexport class ListSignal<T> extends CollectionSignal<ReadonlyArray<ValueSignal<T>>> {\n #head?: EntryId;\n #tail?: EntryId;\n\n readonly #values = new Map<string, Entry<T>>();\n\n constructor(config: ServerConnectionConfig) {\n const initialValue: Array<ValueSignal<T>> = [];\n super(initialValue, config);\n }\n\n #computeItems(): ReadonlyArray<ValueSignal<T>> {\n let current = this.#head;\n const result: Array<ValueSignal<T>> = [];\n while (current !== undefined) {\n const entry = this.#values.get(current)!;\n result.push(entry.value);\n current = entry.next;\n }\n return result;\n }\n\n protected override [$processServerResponse](event: StateEvent): void {\n if (!event.accepted) {\n this[$resolveOperation](event.id
|
|
5
|
-
"mappings": "AAAA,SAAS,wBAAwB;AACjC;AAAA,EACE;AAAA,EACA;AAAA,EAEA;AAAA,EACA;AAAA,EACA;AAAA,OAIK;AACP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OAGK;AACP,SAAS,mBAAmB;AAqBrB,MAAM,mBAAsB,iBAAgD;AAAA,EACjF;AAAA,EACA;AAAA,EAES,UAAU,oBAAI,IAAsB;AAAA,EAE7C,YAAY,QAAgC;AAC1C,UAAM,eAAsC,CAAC;AAC7C,UAAM,cAAc,MAAM;AAAA,EAC5B;AAAA,EAEA,gBAA+C;AAC7C,QAAI,UAAU,KAAK;AACnB,UAAM,SAAgC,CAAC;AACvC,WAAO,YAAY,QAAW;AAC5B,YAAM,QAAQ,KAAK,QAAQ,IAAI,OAAO;AACtC,aAAO,KAAK,MAAM,KAAK;AACvB,gBAAU,MAAM;AAAA,IAClB;AACA,WAAO;AAAA,EACT;AAAA,EAEA,CAAoB,sBAAsB,EAAE,OAAyB;AACnE,QAAI,CAAC,MAAM,UAAU;AACnB,WAAK,iBAAiB,
|
|
4
|
+
"sourcesContent": ["import { CollectionSignal } from './CollectionSignal.js';\nimport {\n createInsertLastStateEvent,\n createRemoveStateEvent,\n type InsertLastStateEvent,\n isInsertLastStateEvent,\n isListSnapshotStateEvent,\n isRemoveStateEvent,\n type ListSnapshotStateEvent,\n type RemoveStateEvent,\n type StateEvent,\n} from './events.js';\nimport {\n $createOperation,\n $processServerResponse,\n $resolveOperation,\n $setValueQuietly,\n $update,\n type Operation,\n type ServerConnectionConfig,\n} from './FullStackSignal.js';\nimport { ValueSignal } from './ValueSignal.js';\n\ntype EntryId = string;\ntype Entry<T> = {\n id: EntryId;\n value: ValueSignal<T>;\n next?: EntryId;\n prev?: EntryId;\n};\n\n/**\n * A {@link FullStackSignal} that represents a shared list of values, where each\n * value is represented by a {@link ValueSignal}.\n * The list can be modified by calling the defined methods to insert or remove\n * items, but the `value` property of a `ListSignal` instance is read-only and\n * cannot be assigned directly.\n * The value of each item in the list can be manipulated similar to a regular\n * {@link ValueSignal}.\n *\n * @typeParam T - The type of the values in the list.\n */\nexport class ListSignal<T> extends CollectionSignal<ReadonlyArray<ValueSignal<T>>> {\n #head?: EntryId;\n #tail?: EntryId;\n\n readonly #values = new Map<string, Entry<T>>();\n\n constructor(config: ServerConnectionConfig) {\n const initialValue: Array<ValueSignal<T>> = [];\n super(initialValue, config);\n }\n\n #computeItems(): ReadonlyArray<ValueSignal<T>> {\n let current = this.#head;\n const result: Array<ValueSignal<T>> = [];\n while (current !== undefined) {\n const entry = this.#values.get(current)!;\n result.push(entry.value);\n current = entry.next;\n }\n return result;\n }\n\n protected override [$processServerResponse](event: StateEvent): void {\n if (!event.accepted) {\n this[$resolveOperation](\n event.id,\n `Server rejected the operation with id '${event.id}'. See the server log for more details.`,\n );\n return;\n }\n if (isListSnapshotStateEvent<T>(event)) {\n this.#handleSnapshotEvent(event);\n } else if (isInsertLastStateEvent<T>(event)) {\n this.#handleInsertLastUpdate(event);\n } else if (isRemoveStateEvent(event)) {\n this.#handleRemoveUpdate(event);\n }\n this[$resolveOperation](event.id);\n }\n\n #handleInsertLastUpdate(event: InsertLastStateEvent<T>): void {\n if (event.entryId === undefined) {\n throw new Error('Unexpected state: Entry id should be defined when insert last event is accepted');\n }\n const valueSignal = new ValueSignal<T>(\n event.value,\n { ...this.server.config, parentClientSignalId: this.id },\n event.entryId,\n );\n const newEntry: Entry<T> = { id: valueSignal.id, value: valueSignal };\n\n if (this.#head === undefined) {\n this.#head = newEntry.id;\n this.#tail = this.#head;\n } else {\n const tailEntry = this.#values.get(this.#tail!)!;\n tailEntry.next = newEntry.id;\n newEntry.prev = this.#tail;\n this.#tail = newEntry.id;\n }\n this.#values.set(valueSignal.id, newEntry);\n this[$setValueQuietly](this.#computeItems());\n }\n\n #handleRemoveUpdate(event: RemoveStateEvent): void {\n const entryToRemove = this.#values.get(event.entryId);\n if (entryToRemove === undefined) {\n return;\n }\n this.#values.delete(event.id);\n if (this.#head === entryToRemove.id) {\n if (entryToRemove.next === undefined) {\n this.#head = undefined;\n this.#tail = undefined;\n } else {\n const newHead = this.#values.get(entryToRemove.next)!;\n this.#head = newHead.id;\n newHead.prev = undefined;\n }\n } else {\n const prevEntry = this.#values.get(entryToRemove.prev!)!;\n const nextEntry = entryToRemove.next !== undefined ? this.#values.get(entryToRemove.next) : undefined;\n if (nextEntry === undefined) {\n this.#tail = prevEntry.id;\n prevEntry.next = undefined;\n } else {\n prevEntry.next = nextEntry.id;\n nextEntry.prev = prevEntry.id;\n }\n }\n this[$setValueQuietly](this.#computeItems());\n }\n\n #handleSnapshotEvent(event: ListSnapshotStateEvent<T>): void {\n event.entries.forEach((entry) => {\n this.#values.set(entry.id, {\n id: entry.id,\n prev: entry.prev,\n next: entry.next,\n value: new ValueSignal(entry.value, { ...this.server.config, parentClientSignalId: this.id }, entry.id),\n });\n if (entry.prev === undefined) {\n this.#head = entry.id;\n }\n if (entry.next === undefined) {\n this.#tail = entry.id;\n }\n });\n this[$setValueQuietly](this.#computeItems());\n }\n\n /**\n * Inserts a new value at the end of the list.\n * @param value - The value to insert.\n * @returns An operation object that allows to perform additional actions.\n */\n insertLast(value: T): Operation {\n const event = createInsertLastStateEvent(value);\n const promise = this[$update](event);\n return this[$createOperation]({ id: event.id, promise });\n }\n\n /**\n * Removes the given item from the list.\n * @param item - The item to remove.\n * @returns An operation object that allows to perform additional actions.\n */\n remove(item: ValueSignal<T>): Operation {\n const entryToRemove = this.#values.get(item.id);\n if (entryToRemove === undefined) {\n return { result: Promise.resolve() };\n }\n const removeEvent = createRemoveStateEvent(entryToRemove.value.id);\n const promise = this[$update](removeEvent);\n return this[$createOperation]({ id: removeEvent.id, promise });\n }\n}\n"],
|
|
5
|
+
"mappings": "AAAA,SAAS,wBAAwB;AACjC;AAAA,EACE;AAAA,EACA;AAAA,EAEA;AAAA,EACA;AAAA,EACA;AAAA,OAIK;AACP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OAGK;AACP,SAAS,mBAAmB;AAqBrB,MAAM,mBAAsB,iBAAgD;AAAA,EACjF;AAAA,EACA;AAAA,EAES,UAAU,oBAAI,IAAsB;AAAA,EAE7C,YAAY,QAAgC;AAC1C,UAAM,eAAsC,CAAC;AAC7C,UAAM,cAAc,MAAM;AAAA,EAC5B;AAAA,EAEA,gBAA+C;AAC7C,QAAI,UAAU,KAAK;AACnB,UAAM,SAAgC,CAAC;AACvC,WAAO,YAAY,QAAW;AAC5B,YAAM,QAAQ,KAAK,QAAQ,IAAI,OAAO;AACtC,aAAO,KAAK,MAAM,KAAK;AACvB,gBAAU,MAAM;AAAA,IAClB;AACA,WAAO;AAAA,EACT;AAAA,EAEA,CAAoB,sBAAsB,EAAE,OAAyB;AACnE,QAAI,CAAC,MAAM,UAAU;AACnB,WAAK,iBAAiB;AAAA,QACpB,MAAM;AAAA,QACN,0CAA0C,MAAM,EAAE;AAAA,MACpD;AACA;AAAA,IACF;AACA,QAAI,yBAA4B,KAAK,GAAG;AACtC,WAAK,qBAAqB,KAAK;AAAA,IACjC,WAAW,uBAA0B,KAAK,GAAG;AAC3C,WAAK,wBAAwB,KAAK;AAAA,IACpC,WAAW,mBAAmB,KAAK,GAAG;AACpC,WAAK,oBAAoB,KAAK;AAAA,IAChC;AACA,SAAK,iBAAiB,EAAE,MAAM,EAAE;AAAA,EAClC;AAAA,EAEA,wBAAwB,OAAsC;AAC5D,QAAI,MAAM,YAAY,QAAW;AAC/B,YAAM,IAAI,MAAM,iFAAiF;AAAA,IACnG;AACA,UAAM,cAAc,IAAI;AAAA,MACtB,MAAM;AAAA,MACN,EAAE,GAAG,KAAK,OAAO,QAAQ,sBAAsB,KAAK,GAAG;AAAA,MACvD,MAAM;AAAA,IACR;AACA,UAAM,WAAqB,EAAE,IAAI,YAAY,IAAI,OAAO,YAAY;AAEpE,QAAI,KAAK,UAAU,QAAW;AAC5B,WAAK,QAAQ,SAAS;AACtB,WAAK,QAAQ,KAAK;AAAA,IACpB,OAAO;AACL,YAAM,YAAY,KAAK,QAAQ,IAAI,KAAK,KAAM;AAC9C,gBAAU,OAAO,SAAS;AAC1B,eAAS,OAAO,KAAK;AACrB,WAAK,QAAQ,SAAS;AAAA,IACxB;AACA,SAAK,QAAQ,IAAI,YAAY,IAAI,QAAQ;AACzC,SAAK,gBAAgB,EAAE,KAAK,cAAc,CAAC;AAAA,EAC7C;AAAA,EAEA,oBAAoB,OAA+B;AACjD,UAAM,gBAAgB,KAAK,QAAQ,IAAI,MAAM,OAAO;AACpD,QAAI,kBAAkB,QAAW;AAC/B;AAAA,IACF;AACA,SAAK,QAAQ,OAAO,MAAM,EAAE;AAC5B,QAAI,KAAK,UAAU,cAAc,IAAI;AACnC,UAAI,cAAc,SAAS,QAAW;AACpC,aAAK,QAAQ;AACb,aAAK,QAAQ;AAAA,MACf,OAAO;AACL,cAAM,UAAU,KAAK,QAAQ,IAAI,cAAc,IAAI;AACnD,aAAK,QAAQ,QAAQ;AACrB,gBAAQ,OAAO;AAAA,MACjB;AAAA,IACF,OAAO;AACL,YAAM,YAAY,KAAK,QAAQ,IAAI,cAAc,IAAK;AACtD,YAAM,YAAY,cAAc,SAAS,SAAY,KAAK,QAAQ,IAAI,cAAc,IAAI,IAAI;AAC5F,UAAI,cAAc,QAAW;AAC3B,aAAK,QAAQ,UAAU;AACvB,kBAAU,OAAO;AAAA,MACnB,OAAO;AACL,kBAAU,OAAO,UAAU;AAC3B,kBAAU,OAAO,UAAU;AAAA,MAC7B;AAAA,IACF;AACA,SAAK,gBAAgB,EAAE,KAAK,cAAc,CAAC;AAAA,EAC7C;AAAA,EAEA,qBAAqB,OAAwC;AAC3D,UAAM,QAAQ,QAAQ,CAAC,UAAU;AAC/B,WAAK,QAAQ,IAAI,MAAM,IAAI;AAAA,QACzB,IAAI,MAAM;AAAA,QACV,MAAM,MAAM;AAAA,QACZ,MAAM,MAAM;AAAA,QACZ,OAAO,IAAI,YAAY,MAAM,OAAO,EAAE,GAAG,KAAK,OAAO,QAAQ,sBAAsB,KAAK,GAAG,GAAG,MAAM,EAAE;AAAA,MACxG,CAAC;AACD,UAAI,MAAM,SAAS,QAAW;AAC5B,aAAK,QAAQ,MAAM;AAAA,MACrB;AACA,UAAI,MAAM,SAAS,QAAW;AAC5B,aAAK,QAAQ,MAAM;AAAA,MACrB;AAAA,IACF,CAAC;AACD,SAAK,gBAAgB,EAAE,KAAK,cAAc,CAAC;AAAA,EAC7C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,WAAW,OAAqB;AAC9B,UAAM,QAAQ,2BAA2B,KAAK;AAC9C,UAAM,UAAU,KAAK,OAAO,EAAE,KAAK;AACnC,WAAO,KAAK,gBAAgB,EAAE,EAAE,IAAI,MAAM,IAAI,QAAQ,CAAC;AAAA,EACzD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,MAAiC;AACtC,UAAM,gBAAgB,KAAK,QAAQ,IAAI,KAAK,EAAE;AAC9C,QAAI,kBAAkB,QAAW;AAC/B,aAAO,EAAE,QAAQ,QAAQ,QAAQ,EAAE;AAAA,IACrC;AACA,UAAM,cAAc,uBAAuB,cAAc,MAAM,EAAE;AACjE,UAAM,UAAU,KAAK,OAAO,EAAE,WAAW;AACzC,WAAO,KAAK,gBAAgB,EAAE,EAAE,IAAI,YAAY,IAAI,QAAQ,CAAC;AAAA,EAC/D;AACF;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
package/ValueSignal.d.ts
CHANGED
|
@@ -20,6 +20,7 @@ export declare class ValueSignal<T> extends FullStackSignal<T> {
|
|
|
20
20
|
* `replace` method instead.
|
|
21
21
|
*
|
|
22
22
|
* @param value - The new value.
|
|
23
|
+
* @returns An operation object that allows to perform additional actions.
|
|
23
24
|
*/
|
|
24
25
|
set(value: T): Operation;
|
|
25
26
|
/**
|
|
@@ -42,7 +43,8 @@ export declare class ValueSignal<T> extends FullStackSignal<T> {
|
|
|
42
43
|
*
|
|
43
44
|
* @param callback - The function that is applied on the current value to
|
|
44
45
|
* produce the new value.
|
|
45
|
-
* @returns An operation object that allows to perform additional actions,
|
|
46
|
+
* @returns An operation object that allows to perform additional actions,
|
|
47
|
+
* including cancellation.
|
|
46
48
|
*/
|
|
47
49
|
update(callback: (value: T) => T): OperationSubscription;
|
|
48
50
|
protected [$processServerResponse](event: StateEvent): void;
|
package/ValueSignal.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ValueSignal.d.ts","sourceRoot":"","sources":["src/ValueSignal.ts"],"names":[],"mappings":"AACA,OAAO,EAML,KAAK,UAAU,EAChB,MAAM,aAAa,CAAC;AACrB,OAAO,EAEL,sBAAsB,EAItB,eAAe,EACf,KAAK,SAAS,EACf,MAAM,sBAAsB,CAAC;AAO9B;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,SAAS;IACtD,MAAM,IAAI,IAAI,CAAC;CAChB;AAED;;GAEG;AACH,qBAAa,WAAW,CAAC,CAAC,CAAE,SAAQ,eAAe,CAAC,CAAC,CAAC;;IAGpD
|
|
1
|
+
{"version":3,"file":"ValueSignal.d.ts","sourceRoot":"","sources":["src/ValueSignal.ts"],"names":[],"mappings":"AACA,OAAO,EAML,KAAK,UAAU,EAChB,MAAM,aAAa,CAAC;AACrB,OAAO,EAEL,sBAAsB,EAItB,eAAe,EACf,KAAK,SAAS,EACf,MAAM,sBAAsB,CAAC;AAO9B;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,SAAS;IACtD,MAAM,IAAI,IAAI,CAAC;CAChB;AAED;;GAEG;AACH,qBAAa,WAAW,CAAC,CAAC,CAAE,SAAQ,eAAe,CAAC,CAAC,CAAC;;IAGpD;;;;;;;;;;OAUG;IACH,GAAG,CAAC,KAAK,EAAE,CAAC,GAAG,SAAS;IASxB;;;;;;;OAOG;IACH,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,SAAS;IAQ5C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,qBAAqB;cAcrC,CAAC,sBAAsB,CAAC,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;CA8BrE"}
|
package/ValueSignal.js
CHANGED
|
@@ -25,6 +25,7 @@ class ValueSignal extends FullStackSignal {
|
|
|
25
25
|
* `replace` method instead.
|
|
26
26
|
*
|
|
27
27
|
* @param value - The new value.
|
|
28
|
+
* @returns An operation object that allows to perform additional actions.
|
|
28
29
|
*/
|
|
29
30
|
set(value) {
|
|
30
31
|
const { parentClientSignalId } = this.server.config;
|
|
@@ -60,7 +61,8 @@ class ValueSignal extends FullStackSignal {
|
|
|
60
61
|
*
|
|
61
62
|
* @param callback - The function that is applied on the current value to
|
|
62
63
|
* produce the new value.
|
|
63
|
-
* @returns An operation object that allows to perform additional actions,
|
|
64
|
+
* @returns An operation object that allows to perform additional actions,
|
|
65
|
+
* including cancellation.
|
|
64
66
|
*/
|
|
65
67
|
update(callback) {
|
|
66
68
|
const newValue = callback(this.value);
|
|
@@ -87,7 +89,7 @@ class ValueSignal extends FullStackSignal {
|
|
|
87
89
|
if (event.accepted || isSnapshotStateEvent(event)) {
|
|
88
90
|
this.#applyAcceptedEvent(event);
|
|
89
91
|
} else {
|
|
90
|
-
reason =
|
|
92
|
+
reason = `Server rejected the operation with id '${event.id}'. See the server log for more details.`;
|
|
91
93
|
}
|
|
92
94
|
[record?.id, event.id].filter(Boolean).forEach((id) => this[$resolveOperation](id, reason));
|
|
93
95
|
}
|
package/ValueSignal.js.map
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["src/ValueSignal.ts"],
|
|
4
|
-
"sourcesContent": ["import { nanoid } from 'nanoid';\nimport {\n createReplaceStateEvent,\n createSetStateEvent,\n isReplaceStateEvent,\n isSetStateEvent,\n isSnapshotStateEvent,\n type StateEvent,\n} from './events.js';\nimport {\n $createOperation,\n $processServerResponse,\n $resolveOperation,\n $setValueQuietly,\n $update,\n FullStackSignal,\n type Operation,\n} from './FullStackSignal.js';\n\ntype PendingRequestsRecord<T> = Readonly<{\n id: string;\n callback(value: T): T;\n}> & { canceled: boolean };\n\n/**\n * An operation subscription that can be canceled.\n */\nexport interface OperationSubscription extends Operation {\n cancel(): void;\n}\n\n/**\n * A full-stack signal that holds an arbitrary value.\n */\nexport class ValueSignal<T> extends FullStackSignal<T> {\n readonly #pendingRequests = new Map<string, PendingRequestsRecord<T>>();\n\n /**\n * Sets the value.\n * Note that the value change event that is propagated to the server as the\n * result of this operation is not taking the last seen value into account and\n * will overwrite the shared value on the server unconditionally (AKA: \"Last\n * Write Wins\"). If you need to perform a conditional update, use the\n * `replace` method instead.\n *\n * @param value - The new value.\n */\n set(value: T): Operation {\n const { parentClientSignalId } = this.server.config;\n const signalId = parentClientSignalId !== undefined ? this.id : undefined;\n const event = createSetStateEvent(value, signalId, parentClientSignalId);\n const promise = this[$update](event);\n this[$setValueQuietly](value);\n return this[$createOperation]({ id: event.id, promise });\n }\n\n /**\n * Replaces the value with a new one only if the current value is equal to the\n * expected value.\n *\n * @param expected - The expected value.\n * @param newValue - The new value.\n * @returns An operation object that allows to perform additional actions.\n */\n replace(expected: T, newValue: T): Operation {\n const { parentClientSignalId } = this.server.config;\n const signalId = parentClientSignalId !== undefined ? this.id : undefined;\n const event = createReplaceStateEvent(expected, newValue, signalId, parentClientSignalId);\n const promise = this[$update](event);\n return this[$createOperation]({ id: event.id, promise });\n }\n\n /**\n * Tries to update the value by applying the callback function to the current\n * value. In case of a concurrent change, the callback is run again with an\n * updated input value. This is repeated until the result can be applied\n * without concurrent changes, or the operation is canceled.\n *\n * Note that there is no guarantee that cancel() will be effective always,\n * since a succeeding operation might already be on its way to the server.\n *\n * @param callback - The function that is applied on the current value to\n * produce the new value.\n * @returns An operation object that allows to perform additional actions
|
|
5
|
-
"mappings": "AAAA,SAAS,cAAc;AACvB;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OAEK;AACP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OAEK;AAiBA,MAAM,oBAAuB,gBAAmB;AAAA,EAC5C,mBAAmB,oBAAI,IAAsC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,
|
|
4
|
+
"sourcesContent": ["import { nanoid } from 'nanoid';\nimport {\n createReplaceStateEvent,\n createSetStateEvent,\n isReplaceStateEvent,\n isSetStateEvent,\n isSnapshotStateEvent,\n type StateEvent,\n} from './events.js';\nimport {\n $createOperation,\n $processServerResponse,\n $resolveOperation,\n $setValueQuietly,\n $update,\n FullStackSignal,\n type Operation,\n} from './FullStackSignal.js';\n\ntype PendingRequestsRecord<T> = Readonly<{\n id: string;\n callback(value: T): T;\n}> & { canceled: boolean };\n\n/**\n * An operation subscription that can be canceled.\n */\nexport interface OperationSubscription extends Operation {\n cancel(): void;\n}\n\n/**\n * A full-stack signal that holds an arbitrary value.\n */\nexport class ValueSignal<T> extends FullStackSignal<T> {\n readonly #pendingRequests = new Map<string, PendingRequestsRecord<T>>();\n\n /**\n * Sets the value.\n * Note that the value change event that is propagated to the server as the\n * result of this operation is not taking the last seen value into account and\n * will overwrite the shared value on the server unconditionally (AKA: \"Last\n * Write Wins\"). If you need to perform a conditional update, use the\n * `replace` method instead.\n *\n * @param value - The new value.\n * @returns An operation object that allows to perform additional actions.\n */\n set(value: T): Operation {\n const { parentClientSignalId } = this.server.config;\n const signalId = parentClientSignalId !== undefined ? this.id : undefined;\n const event = createSetStateEvent(value, signalId, parentClientSignalId);\n const promise = this[$update](event);\n this[$setValueQuietly](value);\n return this[$createOperation]({ id: event.id, promise });\n }\n\n /**\n * Replaces the value with a new one only if the current value is equal to the\n * expected value.\n *\n * @param expected - The expected value.\n * @param newValue - The new value.\n * @returns An operation object that allows to perform additional actions.\n */\n replace(expected: T, newValue: T): Operation {\n const { parentClientSignalId } = this.server.config;\n const signalId = parentClientSignalId !== undefined ? this.id : undefined;\n const event = createReplaceStateEvent(expected, newValue, signalId, parentClientSignalId);\n const promise = this[$update](event);\n return this[$createOperation]({ id: event.id, promise });\n }\n\n /**\n * Tries to update the value by applying the callback function to the current\n * value. In case of a concurrent change, the callback is run again with an\n * updated input value. This is repeated until the result can be applied\n * without concurrent changes, or the operation is canceled.\n *\n * Note that there is no guarantee that cancel() will be effective always,\n * since a succeeding operation might already be on its way to the server.\n *\n * @param callback - The function that is applied on the current value to\n * produce the new value.\n * @returns An operation object that allows to perform additional actions,\n * including cancellation.\n */\n update(callback: (value: T) => T): OperationSubscription {\n const newValue = callback(this.value);\n const event = createReplaceStateEvent(this.value, newValue);\n const promise = this[$update](event);\n const pendingRequest = { id: nanoid(), callback, canceled: false };\n this.#pendingRequests.set(event.id, pendingRequest);\n return {\n ...this[$createOperation]({ id: pendingRequest.id, promise }),\n cancel: () => {\n pendingRequest.canceled = true;\n },\n };\n }\n\n protected override [$processServerResponse](event: StateEvent): void {\n const record = this.#pendingRequests.get(event.id);\n if (record) {\n this.#pendingRequests.delete(event.id);\n\n if (!(event.accepted || record.canceled)) {\n this.update(record.callback);\n }\n }\n\n let reason: string | undefined;\n if (event.accepted || isSnapshotStateEvent<T>(event)) {\n this.#applyAcceptedEvent(event);\n } else {\n reason = `Server rejected the operation with id '${event.id}'. See the server log for more details.`;\n }\n // `then` callbacks can be associated to the record or the event\n // it depends on the operation that was performed\n [record?.id, event.id].filter(Boolean).forEach((id) => this[$resolveOperation](id!, reason));\n }\n\n #applyAcceptedEvent(event: StateEvent): void {\n if (isSetStateEvent<T>(event) || isSnapshotStateEvent<T>(event)) {\n this.value = event.value;\n } else if (isReplaceStateEvent<T>(event)) {\n if (JSON.stringify(this.value) === JSON.stringify(event.expected)) {\n this.value = event.value;\n }\n }\n }\n}\n"],
|
|
5
|
+
"mappings": "AAAA,SAAS,cAAc;AACvB;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OAEK;AACP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OAEK;AAiBA,MAAM,oBAAuB,gBAAmB;AAAA,EAC5C,mBAAmB,oBAAI,IAAsC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAatE,IAAI,OAAqB;AACvB,UAAM,EAAE,qBAAqB,IAAI,KAAK,OAAO;AAC7C,UAAM,WAAW,yBAAyB,SAAY,KAAK,KAAK;AAChE,UAAM,QAAQ,oBAAoB,OAAO,UAAU,oBAAoB;AACvE,UAAM,UAAU,KAAK,OAAO,EAAE,KAAK;AACnC,SAAK,gBAAgB,EAAE,KAAK;AAC5B,WAAO,KAAK,gBAAgB,EAAE,EAAE,IAAI,MAAM,IAAI,QAAQ,CAAC;AAAA,EACzD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,QAAQ,UAAa,UAAwB;AAC3C,UAAM,EAAE,qBAAqB,IAAI,KAAK,OAAO;AAC7C,UAAM,WAAW,yBAAyB,SAAY,KAAK,KAAK;AAChE,UAAM,QAAQ,wBAAwB,UAAU,UAAU,UAAU,oBAAoB;AACxF,UAAM,UAAU,KAAK,OAAO,EAAE,KAAK;AACnC,WAAO,KAAK,gBAAgB,EAAE,EAAE,IAAI,MAAM,IAAI,QAAQ,CAAC;AAAA,EACzD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,OAAO,UAAkD;AACvD,UAAM,WAAW,SAAS,KAAK,KAAK;AACpC,UAAM,QAAQ,wBAAwB,KAAK,OAAO,QAAQ;AAC1D,UAAM,UAAU,KAAK,OAAO,EAAE,KAAK;AACnC,UAAM,iBAAiB,EAAE,IAAI,OAAO,GAAG,UAAU,UAAU,MAAM;AACjE,SAAK,iBAAiB,IAAI,MAAM,IAAI,cAAc;AAClD,WAAO;AAAA,MACL,GAAG,KAAK,gBAAgB,EAAE,EAAE,IAAI,eAAe,IAAI,QAAQ,CAAC;AAAA,MAC5D,QAAQ,MAAM;AACZ,uBAAe,WAAW;AAAA,MAC5B;AAAA,IACF;AAAA,EACF;AAAA,EAEA,CAAoB,sBAAsB,EAAE,OAAyB;AACnE,UAAM,SAAS,KAAK,iBAAiB,IAAI,MAAM,EAAE;AACjD,QAAI,QAAQ;AACV,WAAK,iBAAiB,OAAO,MAAM,EAAE;AAErC,UAAI,EAAE,MAAM,YAAY,OAAO,WAAW;AACxC,aAAK,OAAO,OAAO,QAAQ;AAAA,MAC7B;AAAA,IACF;AAEA,QAAI;AACJ,QAAI,MAAM,YAAY,qBAAwB,KAAK,GAAG;AACpD,WAAK,oBAAoB,KAAK;AAAA,IAChC,OAAO;AACL,eAAS,0CAA0C,MAAM,EAAE;AAAA,IAC7D;AAGA,KAAC,QAAQ,IAAI,MAAM,EAAE,EAAE,OAAO,OAAO,EAAE,QAAQ,CAAC,OAAO,KAAK,iBAAiB,EAAE,IAAK,MAAM,CAAC;AAAA,EAC7F;AAAA,EAEA,oBAAoB,OAAyB;AAC3C,QAAI,gBAAmB,KAAK,KAAK,qBAAwB,KAAK,GAAG;AAC/D,WAAK,QAAQ,MAAM;AAAA,IACrB,WAAW,oBAAuB,KAAK,GAAG;AACxC,UAAI,KAAK,UAAU,KAAK,KAAK,MAAM,KAAK,UAAU,MAAM,QAAQ,GAAG;AACjE,aAAK,QAAQ,MAAM;AAAA,MACrB;AAAA,IACF;AAAA,EACF;AACF;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
package/index.d.ts
CHANGED
|
@@ -5,4 +5,5 @@ export { ValueSignal } from './ValueSignal.js';
|
|
|
5
5
|
export { ListSignal } from './ListSignal.js';
|
|
6
6
|
export type { OperationSubscription } from './ValueSignal.js';
|
|
7
7
|
export { FullStackSignal } from './FullStackSignal.js';
|
|
8
|
+
export type { Operation } from './FullStackSignal.js';
|
|
8
9
|
//# sourceMappingURL=index.d.ts.map
|
package/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AACA,OAAO,gBAAgB,CAAC;AAGxB,cAAc,WAAW,CAAC;AAC1B,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,YAAY,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AACA,OAAO,gBAAgB,CAAC;AAGxB,cAAc,WAAW,CAAC;AAC1B,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,YAAY,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,YAAY,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC"}
|
package/index.js.map
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["src/index.ts"],
|
|
4
|
-
"sourcesContent": ["// eslint-disable-next-line import/no-unassigned-import\nimport './polyfills.js';\n\n// eslint-disable-next-line import/export\nexport * from './core.js';\nexport { NumberSignal } from './NumberSignal.js';\nexport { ValueSignal } from './ValueSignal.js';\nexport { ListSignal } from './ListSignal.js';\nexport type { OperationSubscription } from './ValueSignal.js';\nexport { FullStackSignal } from './FullStackSignal.js';\n"],
|
|
4
|
+
"sourcesContent": ["// eslint-disable-next-line import/no-unassigned-import\nimport './polyfills.js';\n\n// eslint-disable-next-line import/export\nexport * from './core.js';\nexport { NumberSignal } from './NumberSignal.js';\nexport { ValueSignal } from './ValueSignal.js';\nexport { ListSignal } from './ListSignal.js';\nexport type { OperationSubscription } from './ValueSignal.js';\nexport { FullStackSignal } from './FullStackSignal.js';\nexport type { Operation } from './FullStackSignal.js';\n"],
|
|
5
5
|
"mappings": "AACA,OAAO;AAGP,cAAc;AACd,SAAS,oBAAoB;AAC7B,SAAS,mBAAmB;AAC5B,SAAS,kBAAkB;AAE3B,SAAS,uBAAuB;",
|
|
6
6
|
"names": []
|
|
7
7
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vaadin/hilla-react-signals",
|
|
3
|
-
"version": "24.6.
|
|
3
|
+
"version": "24.6.2",
|
|
4
4
|
"description": "Signals for Hilla React",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"module": "index.js",
|
|
@@ -46,15 +46,15 @@
|
|
|
46
46
|
"access": "public"
|
|
47
47
|
},
|
|
48
48
|
"dependencies": {
|
|
49
|
-
"@preact/signals-react": "^2.
|
|
50
|
-
"@vaadin/hilla-frontend": "24.6.
|
|
49
|
+
"@preact/signals-react": "^2.3.0",
|
|
50
|
+
"@vaadin/hilla-frontend": "24.6.2",
|
|
51
51
|
"nanoid": "^5.0.7"
|
|
52
52
|
},
|
|
53
53
|
"peerDependencies": {
|
|
54
|
-
"react": "^18"
|
|
54
|
+
"react": "^18",
|
|
55
|
+
"react-dom": "^18"
|
|
55
56
|
},
|
|
56
57
|
"devDependencies": {
|
|
57
|
-
"@esm-bundle/chai": "^4.3.4-fix.0",
|
|
58
58
|
"@testing-library/dom": "^10.4.0",
|
|
59
59
|
"@testing-library/react": "^16.1.0",
|
|
60
60
|
"@testing-library/user-event": "^14.5.2",
|
|
@@ -62,17 +62,19 @@
|
|
|
62
62
|
"@types/chai-as-promised": "^7.1.6",
|
|
63
63
|
"@types/chai-dom": "^1.11.1",
|
|
64
64
|
"@types/mocha": "^10.0.2",
|
|
65
|
-
"@types/react": "^18.
|
|
66
|
-
"@types/
|
|
67
|
-
"@types/sinon
|
|
68
|
-
"@types/
|
|
69
|
-
"
|
|
70
|
-
"chai
|
|
71
|
-
"chai-
|
|
72
|
-
"
|
|
65
|
+
"@types/react": "^18.3.17",
|
|
66
|
+
"@types/react-dom": "^18",
|
|
67
|
+
"@types/sinon": "^10.0.20",
|
|
68
|
+
"@types/sinon-chai": "^3.2.12",
|
|
69
|
+
"@types/validator": "^13.12.2",
|
|
70
|
+
"chai": "^5.1.2",
|
|
71
|
+
"chai-as-promised": "^7.1.2",
|
|
72
|
+
"chai-dom": "^1.12.0",
|
|
73
|
+
"chai-like": "^1.1.3",
|
|
74
|
+
"karma": "^6.4.4",
|
|
73
75
|
"karma-viewport": "^1.0.9",
|
|
74
76
|
"sinon": "^16.0.0",
|
|
75
77
|
"sinon-chai": "^3.7.0",
|
|
76
|
-
"typescript": "5.
|
|
78
|
+
"typescript": "5.7.2"
|
|
77
79
|
}
|
|
78
80
|
}
|