houdini 0.13.6 → 0.13.7-alpha.2

package/build/runtime/cache/cache.d.ts

@@ -14,8 +14,9 @@ export declare class Cache {
         selection: SubscriptionSelection;
         variables?: {};
         parent?: string;
-        layer?: LayerID;
+        layer?: LayerID | null;
         applyUpdates?: boolean;
+        forceNotify?: boolean;
     }): LayerID;
     read(...args: Parameters<CacheInternal['getSelection']>): {
         data: GraphQLObject | null;
@@ -42,7 +43,7 @@ declare class CacheInternal {
         cache: Cache;
         lifetimes: GarbageCollector;
     });
-    writeSelection({ data, selection, variables, root, parent, applyUpdates, layer, toNotify, }: {
+    writeSelection({ data, selection, variables, root, parent, applyUpdates, layer, forceNotify, toNotify, }: {
         data: {
             [key: string]: GraphQLValue;
         };
@@ -55,6 +56,7 @@ declare class CacheInternal {
         layer: Layer;
         toNotify?: SubscriptionSpec[];
         applyUpdates?: boolean;
+        forceNotify?: boolean;
     }): SubscriptionSpec[];
     getSelection({ selection, parent, variables, }: {
         selection: SubscriptionSelection;

package/build/runtime/cache/cache.js

@@ -187,7 +187,7 @@ var CacheInternal = /** @class */ (function () {
         var e_2, _b;
         var _this = this;
         var _c;
-        var data = _a.data, selection = _a.selection, _d = _a.variables, variables = _d === void 0 ? {} : _d, _e = _a.root, root = _e === void 0 ? exports.rootID : _e, _f = _a.parent, parent = _f === void 0 ? exports.rootID : _f, _g = _a.applyUpdates, applyUpdates = _g === void 0 ? false : _g, layer = _a.layer, _h = _a.toNotify, toNotify = _h === void 0 ? [] : _h;
+        var data = _a.data, selection = _a.selection, _d = _a.variables, variables = _d === void 0 ? {} : _d, _e = _a.root, root = _e === void 0 ? exports.rootID : _e, _f = _a.parent, parent = _f === void 0 ? exports.rootID : _f, _g = _a.applyUpdates, applyUpdates = _g === void 0 ? false : _g, layer = _a.layer, forceNotify = _a.forceNotify, _h = _a.toNotify, toNotify = _h === void 0 ? [] : _h;
         // if the cache is disabled, dont do anything
         if (this._disabled) {
             return [];
@@ -210,14 +210,14 @@ var CacheInternal = /** @class */ (function () {
             // look up the previous value
             var _h = this_1.storage.get(parent, key), previousValue = _h.value, displayLayers = _h.displayLayers;
             // if the layer we are updating is the top most layer for the field
-            // then its value is "live", it is providing the current value and
+            // then its value is "live". It is providing the current value and
             // subscribers need to know if the value changed
-            var displayLayer = displayLayers.length === 0 || displayLayers.includes(layer.id);
+            var displayLayer = layer.isDisplayLayer(displayLayers);
             // if we are writing to the display layer we need to refresh the lifetime of the value
             if (displayLayer) {
                 this_1.lifetimes.resetLifetime(parent, key);
             }
-            // any non-scalar is defined as a field with no selection
+            // any scalar is defined as a field with no selection
             if (!fields) {
                 // the value to write to the layer
                 var newValue = value;
@@ -234,7 +234,7 @@ var CacheInternal = /** @class */ (function () {
                 }
                 // if the value changed on a layer that impacts the current latest value
                 var valueChanged = JSON.stringify(newValue) !== JSON.stringify(previousValue);
-                if (valueChanged && displayLayer) {
+                if ((valueChanged || forceNotify) && displayLayer) {
                     // we need to add the fields' subscribers to the set of callbacks
                     // we need to invoke
                     toNotify.push.apply(toNotify, __spread(currentSubcribers));
@@ -290,7 +290,7 @@ var CacheInternal = /** @class */ (function () {
                 // write the link to the layer
                 layer.writeLink(parent, key, linkedID);
                 // if the link target of this field changed and it was responsible for the current subscription
-                if (linkedID && displayLayer && linkChange) {
+                if (linkedID && displayLayer && (linkChange || forceNotify)) {
                     // we need to clear the subscriptions in the previous link
                     // and add them to the new link
                     if (previousValue && typeof previousValue === 'string') {
@@ -447,7 +447,7 @@ var CacheInternal = /** @class */ (function () {
                 // is still valid would not be triggered
                 var contentChanged = JSON.stringify(linkedIDs) !== JSON.stringify(oldIDs_2);
                 // we need to look at the last time we saw each subscriber to check if they need to be added to the spec
-                if (contentChanged) {
+                if (contentChanged || forceNotify) {
                     toNotify.push.apply(toNotify, __spread(currentSubcribers));
                 }
                 try {

package/build/runtime/cache/storage.d.ts

@@ -32,6 +32,7 @@ export declare class Layer {
     getOperations(id: string, field: string): Operation[] | undefined;
     writeField(id: string, field: string, value: GraphQLField): LayerID;
     writeLink(id: string, field: string, value: null | string | LinkedList): LayerID;
+    isDisplayLayer(displayLayers: number[]): boolean;
     clear(): void;
     applyDeletes(): void;
     delete(id: string): void;

package/build/runtime/cache/storage.js

@@ -351,7 +351,14 @@ var Layer = /** @class */ (function () {
         this.links[id] = __assign(__assign({}, this.links[id]), (_b = {}, _b[field] = value, _b));
         return this.id;
     };
+    Layer.prototype.isDisplayLayer = function (displayLayers) {
+        return (displayLayers.length === 0 ||
+            displayLayers.includes(this.id) ||
+            Math.max.apply(Math, __spread(displayLayers)) < this.id);
+    };
     Layer.prototype.clear = function () {
+        // before we clear the data of the layer, look for any subscribers that need to be updated
+        // now that everything has been notified we can reset the data
         this.links = {};
         this.fields = {};
         this.operations = {};

package/build/runtime/mutation.d.ts

@@ -1,2 +1,5 @@
 import { Operation, GraphQLTagResult } from './types';
-export declare function mutation<_Mutation extends Operation<any, any>>(document: GraphQLTagResult): (_input: _Mutation['input']) => Promise<_Mutation['result']>;
+export declare type MutationConfig<_Mutation extends Operation<any, any>> = {
+    optimisticResponse: _Mutation['result'];
+};
+export declare function mutation<_Mutation extends Operation<any, any>>(document: GraphQLTagResult): (_input: _Mutation['input'], config?: MutationConfig<_Mutation>) => Promise<_Mutation['result']>;

package/build/runtime/mutation.js

@@ -62,30 +62,65 @@ function mutation(document) {
     // grab the session from the adapter
     var sessionStore = adapter_mjs_1.getSession();
     // return an async function that sends the mutation go the server
-    return function (variables) { return __awaiter(_this, void 0, void 0, function () {
-        var result, error_1;
+    return function (variables, mutationConfig) { return __awaiter(_this, void 0, void 0, function () {
+        var optimisticResponse, layer, result, error_1;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
-                    _a.trys.push([0, 2, , 3]);
+                    optimisticResponse = mutationConfig === null || mutationConfig === void 0 ? void 0 : mutationConfig.optimisticResponse;
+                    layer = cache_1.default._internal_unstable.storage.createLayer(true);
+                    // if there is an optimistic response then we need to write the value immediately
+                    if (optimisticResponse) {
+                        cache_1.default.write({
+                            selection: artifact.selection,
+                            // make sure that any scalar values get processed into something we can cache
+                            data: scalars_1.marshalSelection({
+                                config: config,
+                                selection: artifact.selection,
+                                data: optimisticResponse,
+                            }),
+                            variables: variables,
+                            layer: layer.id,
+                        });
+                    }
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 3, , 4]);
                     return [4 /*yield*/, network_1.executeQuery(artifact, scalars_1.marshalInputs({
                             input: variables,
                             artifact: document.artifact,
                             config: config,
-                        }), sessionStore, false)];
-                case 1:
+                        }), sessionStore, false)
+                        // clear the layer holding any mutation results
+                    ];
+                case 2:
                     result = (_a.sent()).result;
+                    // clear the layer holding any mutation results
+                    layer.clear();
+                    // write the result of the mutation to the cache
                     cache_1.default.write({
                         selection: artifact.selection,
                         data: result.data,
                         variables: variables,
+                        // if we had an optimistic response we need to write to the appropriate layer
+                        layer: layer.id,
+                        // anything that we right here should notify the parents even if the content didn't change
+                        // this is to avoid a situation where the value before the layer clear is the same as
+                        // the response from the mutation but the optimistic result was incorrect and changed the display value
+                        forceNotify: true,
                     });
-                    // unmarshal any scalars on the body
+                    // merge the layer back into the cache
+                    cache_1.default._internal_unstable.storage.resolveLayer(layer.id);
+                    // turn any scalars in the response into their complex form
                     return [2 /*return*/, scalars_1.unmarshalSelection(config, artifact.selection, result.data)];
-                case 2:
+                case 3:
                     error_1 = _a.sent();
+                    // if the mutation failed, roll the layer back and delete it
+                    layer.clear();
+                    cache_1.default._internal_unstable.storage.resolveLayer(layer.id);
+                    // bubble the mutation error up to the caller
                     throw error_1;
-                case 3: return [2 /*return*/];
+                case 4: return [2 /*return*/];
             }
         });
     }); };

package/build/runtime/scalars.d.ts

@@ -1,5 +1,10 @@
 import type { Config } from 'houdini-common';
 import { MutationArtifact, QueryArtifact, SubscriptionArtifact, SubscriptionSelection } from './types';
+export declare function marshalSelection({ config, selection, data, }: {
+    config: Config;
+    selection: SubscriptionSelection;
+    data: unknown;
+}): {} | null | undefined;
 export declare function marshalInputs<T>({ artifact, config, input, rootType, }: {
     artifact: QueryArtifact | MutationArtifact | SubscriptionArtifact;
     config: Config;

package/build/runtime/scalars.js

@@ -16,7 +16,49 @@ var __read = (this && this.__read) || function (o, n) {
     return ar;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isScalar = exports.unmarshalSelection = exports.marshalInputs = void 0;
+exports.isScalar = exports.unmarshalSelection = exports.marshalInputs = exports.marshalSelection = void 0;
+function marshalSelection(_a) {
+    var config = _a.config, selection = _a.selection, data = _a.data;
+    if (data === null || typeof data === 'undefined') {
+        return data;
+    }
+    // if we are looking at a list
+    if (Array.isArray(data)) {
+        // unmarshal every entry in the list
+        return data.map(function (val) { return marshalSelection({ config: config, selection: selection, data: val }); });
+    }
+    // we're looking at an object, build it up from the current input
+    return Object.fromEntries(Object.entries(data).map(function (_a) {
+        var _b;
+        var _c = __read(_a, 2), fieldName = _c[0], value = _c[1];
+        // look up the type for the field
+        var _d = selection[fieldName], type = _d.type, fields = _d.fields;
+        // if we don't have type information for this field, just use it directly
+        // it's most likely a non-custom scalars or enums
+        if (!type) {
+            return [fieldName, value];
+        }
+        // if there is a sub selection, walk down the selection
+        if (fields) {
+            return [fieldName, marshalSelection({ config: config, selection: fields, data: value })];
+        }
+        // is the type something that requires marshaling
+        if ((_b = config.scalars) === null || _b === void 0 ? void 0 : _b[type]) {
+            var marshalFn = config.scalars[type].marshal;
+            if (!marshalFn) {
+                throw new Error("scalar type " + type + " is missing a `marshal` function. see https://github.com/AlecAivazis/houdini#%EF%B8%8Fcustom-scalars");
+            }
+            if (Array.isArray(value)) {
+                return [fieldName, value.map(marshalFn)];
+            }
+            return [fieldName, marshalFn(value)];
+        }
+        // if the type doesn't require marshaling and isn't a referenced type
+        // then the type is a scalar that doesn't require marshaling
+        return [fieldName, value];
+    }));
+}
+exports.marshalSelection = marshalSelection;
 function marshalInputs(_a) {
     var artifact = _a.artifact, config = _a.config, input = _a.input, _b = _a.rootType, rootType = _b === void 0 ? '@root' : _b;
     if (input === null || typeof input === 'undefined') {

package/build/runtime-cjs/cache/cache.d.ts

@@ -14,8 +14,9 @@ export declare class Cache {
         selection: SubscriptionSelection;
         variables?: {};
         parent?: string;
-        layer?: LayerID;
+        layer?: LayerID | null;
         applyUpdates?: boolean;
+        forceNotify?: boolean;
     }): LayerID;
     read(...args: Parameters<CacheInternal['getSelection']>): {
         data: GraphQLObject | null;
@@ -42,7 +43,7 @@ declare class CacheInternal {
         cache: Cache;
         lifetimes: GarbageCollector;
     });
-    writeSelection({ data, selection, variables, root, parent, applyUpdates, layer, toNotify, }: {
+    writeSelection({ data, selection, variables, root, parent, applyUpdates, layer, forceNotify, toNotify, }: {
         data: {
             [key: string]: GraphQLValue;
         };
@@ -55,6 +56,7 @@ declare class CacheInternal {
         layer: Layer;
         toNotify?: SubscriptionSpec[];
         applyUpdates?: boolean;
+        forceNotify?: boolean;
     }): SubscriptionSpec[];
     getSelection({ selection, parent, variables, }: {
         selection: SubscriptionSelection;

package/build/runtime-cjs/cache/cache.js

@@ -187,7 +187,7 @@ var CacheInternal = /** @class */ (function () {
         var e_2, _b;
         var _this = this;
         var _c;
-        var data = _a.data, selection = _a.selection, _d = _a.variables, variables = _d === void 0 ? {} : _d, _e = _a.root, root = _e === void 0 ? exports.rootID : _e, _f = _a.parent, parent = _f === void 0 ? exports.rootID : _f, _g = _a.applyUpdates, applyUpdates = _g === void 0 ? false : _g, layer = _a.layer, _h = _a.toNotify, toNotify = _h === void 0 ? [] : _h;
+        var data = _a.data, selection = _a.selection, _d = _a.variables, variables = _d === void 0 ? {} : _d, _e = _a.root, root = _e === void 0 ? exports.rootID : _e, _f = _a.parent, parent = _f === void 0 ? exports.rootID : _f, _g = _a.applyUpdates, applyUpdates = _g === void 0 ? false : _g, layer = _a.layer, forceNotify = _a.forceNotify, _h = _a.toNotify, toNotify = _h === void 0 ? [] : _h;
         // if the cache is disabled, dont do anything
         if (this._disabled) {
             return [];
@@ -210,14 +210,14 @@ var CacheInternal = /** @class */ (function () {
             // look up the previous value
             var _h = this_1.storage.get(parent, key), previousValue = _h.value, displayLayers = _h.displayLayers;
             // if the layer we are updating is the top most layer for the field
-            // then its value is "live", it is providing the current value and
+            // then its value is "live". It is providing the current value and
             // subscribers need to know if the value changed
-            var displayLayer = displayLayers.length === 0 || displayLayers.includes(layer.id);
+            var displayLayer = layer.isDisplayLayer(displayLayers);
             // if we are writing to the display layer we need to refresh the lifetime of the value
             if (displayLayer) {
                 this_1.lifetimes.resetLifetime(parent, key);
             }
-            // any non-scalar is defined as a field with no selection
+            // any scalar is defined as a field with no selection
             if (!fields) {
                 // the value to write to the layer
                 var newValue = value;
@@ -234,7 +234,7 @@ var CacheInternal = /** @class */ (function () {
                 }
                 // if the value changed on a layer that impacts the current latest value
                 var valueChanged = JSON.stringify(newValue) !== JSON.stringify(previousValue);
-                if (valueChanged && displayLayer) {
+                if ((valueChanged || forceNotify) && displayLayer) {
                     // we need to add the fields' subscribers to the set of callbacks
                     // we need to invoke
                     toNotify.push.apply(toNotify, __spread(currentSubcribers));
@@ -290,7 +290,7 @@ var CacheInternal = /** @class */ (function () {
                 // write the link to the layer
                 layer.writeLink(parent, key, linkedID);
                 // if the link target of this field changed and it was responsible for the current subscription
-                if (linkedID && displayLayer && linkChange) {
+                if (linkedID && displayLayer && (linkChange || forceNotify)) {
                     // we need to clear the subscriptions in the previous link
                     // and add them to the new link
                     if (previousValue && typeof previousValue === 'string') {
@@ -447,7 +447,7 @@ var CacheInternal = /** @class */ (function () {
                 // is still valid would not be triggered
                 var contentChanged = JSON.stringify(linkedIDs) !== JSON.stringify(oldIDs_2);
                 // we need to look at the last time we saw each subscriber to check if they need to be added to the spec
-                if (contentChanged) {
+                if (contentChanged || forceNotify) {
                     toNotify.push.apply(toNotify, __spread(currentSubcribers));
                 }
                 try {

package/build/runtime-cjs/cache/storage.d.ts

@@ -32,6 +32,7 @@ export declare class Layer {
     getOperations(id: string, field: string): Operation[] | undefined;
     writeField(id: string, field: string, value: GraphQLField): LayerID;
     writeLink(id: string, field: string, value: null | string | LinkedList): LayerID;
+    isDisplayLayer(displayLayers: number[]): boolean;
     clear(): void;
     applyDeletes(): void;
     delete(id: string): void;

package/build/runtime-cjs/cache/storage.js

@@ -351,7 +351,14 @@ var Layer = /** @class */ (function () {
         this.links[id] = __assign(__assign({}, this.links[id]), (_b = {}, _b[field] = value, _b));
         return this.id;
     };
+    Layer.prototype.isDisplayLayer = function (displayLayers) {
+        return (displayLayers.length === 0 ||
+            displayLayers.includes(this.id) ||
+            Math.max.apply(Math, __spread(displayLayers)) < this.id);
+    };
     Layer.prototype.clear = function () {
+        // before we clear the data of the layer, look for any subscribers that need to be updated
+        // now that everything has been notified we can reset the data
         this.links = {};
         this.fields = {};
         this.operations = {};

package/build/runtime-cjs/mutation.d.ts

@@ -1,2 +1,5 @@
 import { Operation, GraphQLTagResult } from './types';
-export declare function mutation<_Mutation extends Operation<any, any>>(document: GraphQLTagResult): (_input: _Mutation['input']) => Promise<_Mutation['result']>;
+export declare type MutationConfig<_Mutation extends Operation<any, any>> = {
+    optimisticResponse: _Mutation['result'];
+};
+export declare function mutation<_Mutation extends Operation<any, any>>(document: GraphQLTagResult): (_input: _Mutation['input'], config?: MutationConfig<_Mutation>) => Promise<_Mutation['result']>;

package/build/runtime-cjs/mutation.js

@@ -62,30 +62,65 @@ function mutation(document) {
     // grab the session from the adapter
     var sessionStore = adapter_mjs_1.getSession();
     // return an async function that sends the mutation go the server
-    return function (variables) { return __awaiter(_this, void 0, void 0, function () {
-        var result, error_1;
+    return function (variables, mutationConfig) { return __awaiter(_this, void 0, void 0, function () {
+        var optimisticResponse, layer, result, error_1;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
-                    _a.trys.push([0, 2, , 3]);
+                    optimisticResponse = mutationConfig === null || mutationConfig === void 0 ? void 0 : mutationConfig.optimisticResponse;
+                    layer = cache_1.default._internal_unstable.storage.createLayer(true);
+                    // if there is an optimistic response then we need to write the value immediately
+                    if (optimisticResponse) {
+                        cache_1.default.write({
+                            selection: artifact.selection,
+                            // make sure that any scalar values get processed into something we can cache
+                            data: scalars_1.marshalSelection({
+                                config: config,
+                                selection: artifact.selection,
+                                data: optimisticResponse,
+                            }),
+                            variables: variables,
+                            layer: layer.id,
+                        });
+                    }
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 3, , 4]);
                     return [4 /*yield*/, network_1.executeQuery(artifact, scalars_1.marshalInputs({
                             input: variables,
                             artifact: document.artifact,
                             config: config,
-                        }), sessionStore, false)];
-                case 1:
+                        }), sessionStore, false)
+                        // clear the layer holding any mutation results
+                    ];
+                case 2:
                     result = (_a.sent()).result;
+                    // clear the layer holding any mutation results
+                    layer.clear();
+                    // write the result of the mutation to the cache
                     cache_1.default.write({
                         selection: artifact.selection,
                         data: result.data,
                         variables: variables,
+                        // if we had an optimistic response we need to write to the appropriate layer
+                        layer: layer.id,
+                        // anything that we right here should notify the parents even if the content didn't change
+                        // this is to avoid a situation where the value before the layer clear is the same as
+                        // the response from the mutation but the optimistic result was incorrect and changed the display value
+                        forceNotify: true,
                     });
-                    // unmarshal any scalars on the body
+                    // merge the layer back into the cache
+                    cache_1.default._internal_unstable.storage.resolveLayer(layer.id);
+                    // turn any scalars in the response into their complex form
                     return [2 /*return*/, scalars_1.unmarshalSelection(config, artifact.selection, result.data)];
-                case 2:
+                case 3:
                     error_1 = _a.sent();
+                    // if the mutation failed, roll the layer back and delete it
+                    layer.clear();
+                    cache_1.default._internal_unstable.storage.resolveLayer(layer.id);
+                    // bubble the mutation error up to the caller
                     throw error_1;
-                case 3: return [2 /*return*/];
+                case 4: return [2 /*return*/];
             }
         });
     }); };

package/build/runtime-cjs/scalars.d.ts

@@ -1,5 +1,10 @@
 import type { Config } from 'houdini-common';
 import { MutationArtifact, QueryArtifact, SubscriptionArtifact, SubscriptionSelection } from './types';
+export declare function marshalSelection({ config, selection, data, }: {
+    config: Config;
+    selection: SubscriptionSelection;
+    data: unknown;
+}): {} | null | undefined;
 export declare function marshalInputs<T>({ artifact, config, input, rootType, }: {
     artifact: QueryArtifact | MutationArtifact | SubscriptionArtifact;
     config: Config;

package/build/runtime-cjs/scalars.js

@@ -16,7 +16,49 @@ var __read = (this && this.__read) || function (o, n) {
     return ar;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isScalar = exports.unmarshalSelection = exports.marshalInputs = void 0;
+exports.isScalar = exports.unmarshalSelection = exports.marshalInputs = exports.marshalSelection = void 0;
+function marshalSelection(_a) {
+    var config = _a.config, selection = _a.selection, data = _a.data;
+    if (data === null || typeof data === 'undefined') {
+        return data;
+    }
+    // if we are looking at a list
+    if (Array.isArray(data)) {
+        // unmarshal every entry in the list
+        return data.map(function (val) { return marshalSelection({ config: config, selection: selection, data: val }); });
+    }
+    // we're looking at an object, build it up from the current input
+    return Object.fromEntries(Object.entries(data).map(function (_a) {
+        var _b;
+        var _c = __read(_a, 2), fieldName = _c[0], value = _c[1];
+        // look up the type for the field
+        var _d = selection[fieldName], type = _d.type, fields = _d.fields;
+        // if we don't have type information for this field, just use it directly
+        // it's most likely a non-custom scalars or enums
+        if (!type) {
+            return [fieldName, value];
+        }
+        // if there is a sub selection, walk down the selection
+        if (fields) {
+            return [fieldName, marshalSelection({ config: config, selection: fields, data: value })];
+        }
+        // is the type something that requires marshaling
+        if ((_b = config.scalars) === null || _b === void 0 ? void 0 : _b[type]) {
+            var marshalFn = config.scalars[type].marshal;
+            if (!marshalFn) {
+                throw new Error("scalar type " + type + " is missing a `marshal` function. see https://github.com/AlecAivazis/houdini#%EF%B8%8Fcustom-scalars");
+            }
+            if (Array.isArray(value)) {
+                return [fieldName, value.map(marshalFn)];
+            }
+            return [fieldName, marshalFn(value)];
+        }
+        // if the type doesn't require marshaling and isn't a referenced type
+        // then the type is a scalar that doesn't require marshaling
+        return [fieldName, value];
+    }));
+}
+exports.marshalSelection = marshalSelection;
 function marshalInputs(_a) {
     var artifact = _a.artifact, config = _a.config, input = _a.input, _b = _a.rootType, rootType = _b === void 0 ? '@root' : _b;
     if (input === null || typeof input === 'undefined') {

package/build/runtime-esm/cache/cache.d.ts

@@ -14,8 +14,9 @@ export declare class Cache {
         selection: SubscriptionSelection;
         variables?: {};
         parent?: string;
-        layer?: LayerID;
+        layer?: LayerID | null;
         applyUpdates?: boolean;
+        forceNotify?: boolean;
     }): LayerID;
     read(...args: Parameters<CacheInternal['getSelection']>): {
         data: GraphQLObject;
@@ -42,7 +43,7 @@ declare class CacheInternal {
         cache: Cache;
         lifetimes: GarbageCollector;
     });
-    writeSelection({ data, selection, variables, root, parent, applyUpdates, layer, toNotify, }: {
+    writeSelection({ data, selection, variables, root, parent, applyUpdates, layer, forceNotify, toNotify, }: {
         data: {
             [key: string]: GraphQLValue;
         };
@@ -55,6 +56,7 @@ declare class CacheInternal {
         layer: Layer;
         toNotify?: SubscriptionSpec[];
         applyUpdates?: boolean;
+        forceNotify?: boolean;
     }): SubscriptionSpec[];
     getSelection({ selection, parent, variables, }: {
         selection: SubscriptionSelection;

package/build/runtime-esm/cache/cache.js

@@ -105,7 +105,7 @@ class CacheInternal {
             this._disabled = true;
         }
     }
-    writeSelection({ data, selection, variables = {}, root = rootID, parent = rootID, applyUpdates = false, layer, toNotify = [], }) {
+    writeSelection({ data, selection, variables = {}, root = rootID, parent = rootID, applyUpdates = false, layer, forceNotify, toNotify = [], }) {
         var _a;
         // if the cache is disabled, dont do anything
         if (this._disabled) {
@@ -129,14 +129,14 @@ class CacheInternal {
             // look up the previous value
             const { value: previousValue, displayLayers } = this.storage.get(parent, key);
             // if the layer we are updating is the top most layer for the field
-            // then its value is "live", it is providing the current value and
+            // then its value is "live". It is providing the current value and
             // subscribers need to know if the value changed
-            const displayLayer = displayLayers.length === 0 || displayLayers.includes(layer.id);
+            const displayLayer = layer.isDisplayLayer(displayLayers);
             // if we are writing to the display layer we need to refresh the lifetime of the value
             if (displayLayer) {
                 this.lifetimes.resetLifetime(parent, key);
             }
-            // any non-scalar is defined as a field with no selection
+            // any scalar is defined as a field with no selection
             if (!fields) {
                 // the value to write to the layer
                 let newValue = value;
@@ -153,7 +153,7 @@ class CacheInternal {
                 }
                 // if the value changed on a layer that impacts the current latest value
                 const valueChanged = JSON.stringify(newValue) !== JSON.stringify(previousValue);
-                if (valueChanged && displayLayer) {
+                if ((valueChanged || forceNotify) && displayLayer) {
                     // we need to add the fields' subscribers to the set of callbacks
                     // we need to invoke
                     toNotify.push(...currentSubcribers);
@@ -199,7 +199,7 @@ class CacheInternal {
                 // write the link to the layer
                 layer.writeLink(parent, key, linkedID);
                 // if the link target of this field changed and it was responsible for the current subscription
-                if (linkedID && displayLayer && linkChange) {
+                if (linkedID && displayLayer && (linkChange || forceNotify)) {
                     // we need to clear the subscriptions in the previous link
                     // and add them to the new link
                     if (previousValue && typeof previousValue === 'string') {
@@ -346,7 +346,7 @@ class CacheInternal {
                 // is still valid would not be triggered
                 const contentChanged = JSON.stringify(linkedIDs) !== JSON.stringify(oldIDs);
                 // we need to look at the last time we saw each subscriber to check if they need to be added to the spec
-                if (contentChanged) {
+                if (contentChanged || forceNotify) {
                     toNotify.push(...currentSubcribers);
                 }
                 // any ids that don't show up in the new list need to have their subscribers wiped

package/build/runtime-esm/cache/list.d.ts

@@ -0,0 +1,35 @@
+import { SubscriptionSelection, ListWhen, SubscriptionSpec } from '../types';
+import { Cache } from './cache';
+import { Record } from './record';
+export declare class ListHandler {
+    readonly record: Record;
+    readonly key: string;
+    readonly listType: string;
+    private cache;
+    readonly selection: SubscriptionSelection;
+    private _when?;
+    private filters?;
+    readonly name: string;
+    readonly parentID: SubscriptionSpec['parentID'];
+    private connection;
+    constructor({ name, cache, record, key, listType, selection, when, filters, parentID, connection, }: {
+        name: string;
+        connection: boolean;
+        cache: Cache;
+        record: Record;
+        key: string;
+        listType: string;
+        selection: SubscriptionSelection;
+        when?: ListWhen;
+        filters?: ListHandler['filters'];
+        parentID?: SubscriptionSpec['parentID'];
+    });
+    when(when?: ListWhen): ListHandler;
+    append(selection: SubscriptionSelection, data: {}, variables?: {}): void;
+    prepend(selection: SubscriptionSelection, data: {}, variables?: {}): void;
+    addToList(selection: SubscriptionSelection, data: {}, variables: {}, where: 'first' | 'last'): void;
+    removeID(id: string, variables?: {}): void;
+    remove(data: {}, variables?: {}): void;
+    private validateWhen;
+    [Symbol.iterator](): Generator<Record, void, unknown>;
+}