sanity/src/core/form/patch/PatchChannel.ts

Sanity is a real-time content infrastructure with a scalable, hosted backend featuring a Graph Oriented Query Language (GROQ), asset pipelines and fast edge caches

import {type FormPatch} from './types'

/**
 *
 * @hidden
 * @beta
 */
export interface MutationPatchMsg {
  type: 'mutation'
  patches: FormPatch[]
  snapshot: unknown
}

/**
 *
 * @hidden
 * @beta
 */
export interface RebasePatchMsg {
  type: 'rebase'
  patches: FormPatch[]
  snapshot: unknown
}

/**
 *
 * @hidden
 * @beta
 */
export type PatchMsg = MutationPatchMsg | RebasePatchMsg

/**
 *
 * @hidden
 * @beta
 */
export interface PatchMsgSubscriber {
  (msg: PatchMsg): void
}

/**
 *
 * @hidden
 * @beta
 */
export interface PatchChannel {
  publish: (msg: PatchMsg) => void
  subscribe: (subscriber: PatchMsgSubscriber) => () => void
}

/**
 * @internal
 */
export function createPatchChannel(): PatchChannel {
  const _subscribers: PatchMsgSubscriber[] = []

  return {
    publish(msg: PatchMsg) {
      for (const subscriber of _subscribers) {
        subscriber(msg)
      }
    },

    subscribe(subscriber) {
      _subscribers.push(subscriber)

      return () => {
        const idx = _subscribers.indexOf(subscriber)

        if (idx > -1) {
          _subscribers.splice(idx, 1)
        }
      }
    },
  }
}