@wix/himalaya-cli 0.1525.0 → 0.1527.0

package/templates/events-meetups-owner/tier5-src/_shared/online-actions.ts

@@ -0,0 +1,76 @@
+import { connectivity, defineService as register, type ServiceDefinition } from '@himalaya/state';
+
+// Template generation enables this behavior only in the selected two starter families.
+export const offlineWritesEnabled = false;
+
+export const offlineWriteMessage = 'You’re offline. Connect to save this change, then submit it again.';
+
+/** The guard runs before the reducer: entered values survive and no optimistic
+ * changes, success state, or queued writes can occur. It never submits on reconnect. */
+export function offlineWriteState<S extends object>(state: S): S {
+  const next: Record<string, unknown> = { ...state, error: offlineWriteMessage, message: offlineWriteMessage };
+  for (const key of ['saving', 'isSaving', 'submitting', 'isSubmitting', 'adding', 'added', 'bookingInFlight']) {
+    if (key in next) next[key] = false;
+  }
+  for (const key of ['savedMessage', 'successMessage']) {
+    if (key in next) next[key] = '';
+  }
+  // A saved/favourited item is business state, not a submission-success flag.
+  return next as S;
+}
+
+interface OfflineWriteOptions<S> {
+  derive?: (state: S) => S;
+  /** Exempt only non-mutating branches of a registered action. */
+  requiresConnectivity?: (action: string, state: S, argument?: unknown) => boolean;
+  messageFields?: readonly string[] | ((action: string) => readonly string[]);
+  draftFields?: readonly string[] | Readonly<Record<string, string>>;
+  secretFields?: readonly string[];
+}
+
+export function withOnlineWrites<S extends object>(registerService: typeof register, names: readonly string[], options: OfflineWriteOptions<S> = {}): typeof register {
+  if (!offlineWritesEnabled) return registerService;
+  return ((name: string, definition: ServiceDefinition<Record<string, unknown>>) => {
+    let currentState: (() => Record<string, unknown>) | undefined;
+    const handle = registerService(name, {
+      ...definition,
+      notHydrated: [...new Set([...(definition.notHydrated ?? []), ...(options.secretFields ?? [])])],
+      actions: Object.fromEntries(Object.entries(definition.actions ?? {}).map(([action, reduce]) => [action,
+        (state: Record<string, unknown>, ...args: never[]) => {
+          if (!names.includes(action)) return reduce(state, ...args);
+          if (options.requiresConnectivity?.(action, state as S, args[0]) === false) return reduce(state, ...args);
+          const fields = typeof options.messageFields === 'function' ? options.messageFields(action) : options.messageFields ?? ['message'];
+          if (connectivity().online) {
+            let cleared = false;
+            for (const field of ['error', 'message', ...fields]) {
+              if (state[field] === offlineWriteMessage) { state[field] = ''; cleared = true; }
+            }
+            // Keep the runtime's state object: reducers may mutate it and return undefined.
+            const result = reduce(state, ...args);
+            if (!cleared) return result;
+            // Publish cleared feedback even for a void reducer. An async completion must
+            // keep any newer state published by another action while it was awaiting.
+            const finish = (next: Record<string, unknown> | undefined) => next === undefined ? currentState?.() ?? state : next;
+            return result && typeof (result as Promise<unknown>).then === 'function'
+              ? Promise.resolve(result).then(finish)
+              : finish(result as Record<string, unknown> | undefined);
+          }
+          const draft = { ...state };
+          const argument = args[0] as Record<string, unknown> | undefined;
+          const draftFields = options.draftFields ?? [];
+          const entries = Array.isArray(draftFields) ? draftFields.map(key => [key, key]) : Object.entries(draftFields);
+          for (const [key, source] of entries) {
+            if (argument && key in state && typeof argument[source] === typeof state[key]) draft[key] = argument[source];
+          }
+          for (const key of options.secretFields ?? []) draft[key] = '';
+          const feedback = Object.fromEntries(fields.map(key => [key, offlineWriteMessage]));
+          let next = { ...offlineWriteState(draft), ...feedback };
+          if (options.derive) next = options.derive(next as S) as Record<string, unknown>;
+          return { ...next, ...feedback };
+        },
+      ])),
+    });
+    if (typeof handle.getState === 'function') currentState = () => handle.getState();
+    return handle;
+  }) as typeof register;
+}