@trdrs/quickcharts 4.0.0 → 5.0.0

package/dist/chunk-D3S26ARP.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/resources.ts"],"sourcesContent":["// SAVED RESOURCES — the revisioned, async persistence contract for the entities a chart names and\n// a viewer can lose: saved charts, layouts, drawing documents, and templates.\n//\n// The contract exists because a saved chart is shared, mutable, remote state. Two tabs, two\n// devices, or one slow save and one fast one all end at the same question: whose version wins?\n// A store that answers \"the last write\" silently destroys work. So every read hands back a\n// `ResourceRef` (a stable id plus an opaque revision token), every write states the revision it\n// believes it is replacing, and a write against a stale revision comes back as a typed `conflict`\n// carrying the current ref. The chart never resolves that by overwriting; it surfaces it.\n//\n// Three rules the shape enforces:\n//   - The revision is OPAQUE. It is a token the host minted and the chart only ever echoes back.\n//     No ordering, no arithmetic, no timestamp parsing; a host is free to use an ETag, a counter,\n//     or a content hash.\n//   - Every call takes an `AbortSignal`. A symbol switch, a closed dialog, or a fast retype must be\n//     able to abandon in-flight work, and a late answer to an abandoned ask must never land.\n//   - A successful write RETURNS the stored revision, so the caller's next write is conditional on\n//     what the store actually holds rather than on what it hoped it wrote.\n//\n// A chart's, a layout's and a template's body is contractually OPAQUE to the store: no parsing, no\n// per-entity logic, so the chart can evolve those formats freely. The drawings family is the one\n// deliberate exception: its body is the structured document in `drawings/document.ts`, because\n// deletion tombstones, ordered groups and per-drawing ownership have to survive a merge between two\n// surfaces, and a merge cannot be performed over a string. Each drawing's own state stays opaque\n// inside its entry.\n//\n// Flat viewer preferences that need no entity identity are NOT here; they stay on `ChartStorage`,\n// the small settings port beside this one.\nimport type { DrawingResourceContext, DrawingsBody } from './drawings/document'\nimport { drawingContextKey } from './drawings/document'\n\n/** A resource's identity plus the exact version this reader saw. A write quotes it back. */\nexport interface ResourceRef {\n  id: string\n  /** Opaque to the chart: minted by the store, compared only for equality. */\n  revision: string\n}\n\n/** What a write did. `ok` carries the ref the store now holds (and, where the store computes one,\n *  the resulting metadata); `conflict` carries the ref that beat this write, so a caller can reload\n *  and re-decide; `not-found` means the id is gone. */\nexport type WriteOutcome<T = void> =\n  | { kind: 'ok'; ref: ResourceRef; value?: T }\n  | { kind: 'conflict'; current: ResourceRef }\n  | { kind: 'not-found' }\n\n/** One family of resources. `Meta` is the listing row a picker shows without fetching content\n *  (it carries the row's ref, so a picker can delete or open a row without a second read); `Body`\n *  is the stored document. */\nexport interface ResourceStore<Meta, Body> {\n  /** Listing rows, metadata only. */\n  list(signal?: AbortSignal): Promise<Meta[]>\n  /** The stored document and the revision it was read at, or null when the id is unknown. */\n  load(id: string, signal?: AbortSignal): Promise<{ ref: ResourceRef; body: Body } | null>\n  /** Store a new document. The store mints the id; a create conflicts only where the store keys a\n   *  document by identity and one already stands there (a drawings context that holds a document, a\n   *  name already taken), and then it answers the ref that stands. */\n  create(body: Body, signal?: AbortSignal): Promise<WriteOutcome<Meta>>\n  /** Replace the document at `ref.id`, but only while it still stands at `ref.revision`. */\n  update(ref: ResourceRef, body: Body, signal?: AbortSignal): Promise<WriteOutcome<Meta>>\n  /** Delete the document at `ref.id`, but only while it still stands at `ref.revision`. */\n  remove(ref: ResourceRef, signal?: AbortSignal): Promise<WriteOutcome<void>>\n}\n\n/** A saved chart's listing row. */\nexport interface ChartMeta extends ResourceRef {\n  name: string\n  symbol: string\n  timeframe: string\n  /** Last save, ms since epoch (server-stamped by real backends). */\n  updatedAt: number\n}\n\n/** A saved chart. `content` is the chart's own serialized state, opaque to the store. */\nexport interface ChartBody {\n  name: string\n  symbol: string\n  timeframe: string\n  content: string\n}\n\n/** A saved multi-chart layout's listing row. `symbol` is the active chart's market as the chart\n *  writes it (`symbolNames(...).mark`, such as `BTCUSDC`) and `timeframe` its timeframe token, both\n *  as they stood at the last save, so a listing can say what each layout shows without opening it. A\n *  store that does not keep them, or a layout saved before they were stated, leaves them out. */\nexport interface LayoutMeta extends ResourceRef {\n  name: string\n  symbol?: string\n  timeframe?: string\n  updatedAt: number\n}\n\n/** A saved multi-chart layout. `content` is the arrangement's serialized state, opaque to the store.\n *  The widget states the listing's `symbol` and `timeframe` on every save; they are display text and\n *  play no part in restoring the layout. */\nexport interface LayoutBody {\n  name: string\n  symbol?: string\n  timeframe?: string\n  content: string\n}\n\n/** A drawings document's listing row. A context holds at most one, so `list` returns zero rows or\n *  one, and the ref is the store's handle on it. */\nexport interface DrawingsMeta extends ResourceRef {\n  updatedAt: number\n}\n\nexport type TemplateKind = 'indicator' | 'drawing' | 'palette'\n\n/** A named template's listing row. `tool` scopes DRAWING templates to their tool (a trend-line\n *  template is meaningless on a rectangle); indicator and palette templates carry no tool. */\nexport interface TemplateMeta extends ResourceRef {\n  name: string\n  tool?: string\n  updatedAt: number\n}\n\nexport interface TemplateBody {\n  name: string\n  tool?: string\n  content: string\n}\n\n/** The adapter a host implements: four resource families over one revisioned contract. Viewer\n *  settings are deliberately absent; they belong to `ChartStorage`. */\nexport interface ChartSaveLoadAdapter {\n  charts: ResourceStore<ChartMeta, ChartBody>\n  layouts: ResourceStore<LayoutMeta, LayoutBody>\n  /** The store for one drawing-resource context. Calling with an equal context returns an\n   *  equivalent store; `drawingContextKey` is the canonical way to compare two. */\n  drawings(context: DrawingResourceContext): ResourceStore<DrawingsMeta, DrawingsBody>\n  templates(kind: TemplateKind): ResourceStore<TemplateMeta, TemplateBody>\n}\n\n/** The error every store rejects with when its signal aborts. `name` is 'AbortError', which is what\n *  callers branch on, and what `DOMException` uses, so a host may reject with either. */\nexport class ResourceAbortError extends Error {\n  override readonly name = 'AbortError'\n  constructor(message = 'the resource operation was aborted') {\n    super(message)\n  }\n}\n\n/* ── The in-memory reference implementation ────────────────────────────────────────────────────\n   The shape's own proof and the fixture every consumer test mounts: revisions on every write,\n   conflicts on a stale ref, not-found on a vanished id, and an abort that lands before any state\n   changes. It persists nothing, so it is also the right adapter for SSR, an ephemeral embed, and\n   the clean-room consumer. */\n\ninterface Record_<Body> {\n  id: string\n  revision: string\n  body: Body\n  updatedAt: number\n}\n\n/** An aborted signal REJECTS the returned promise rather than throwing out of the call, so every\n *  caller handles abandonment on one path. */\nconst aborted = (signal: AbortSignal | undefined): Promise<never> | null =>\n  signal?.aborted ? Promise.reject(new ResourceAbortError()) : null\n\nconst newId = (): string =>\n  typeof crypto !== 'undefined' && crypto.randomUUID ? crypto.randomUUID() : `r${Date.now().toString(36)}${Math.random().toString(36).slice(2, 8)}`\n\n/** Options for {@link memorySaveLoadAdapter}: a clock, so a test can pin `updatedAt`. */\nexport interface MemoryResourcesOptions {\n  now?: () => number\n}\n\nfunction memoryStore<Meta, Body>(\n  metaOf: (record: Record_<Body>) => Meta,\n  now: () => number,\n): ResourceStore<Meta, Body> {\n  const rows = new Map<string, Record_<Body>>()\n  let counter = 0\n  const nextRevision = (): string => `rev-${++counter}`\n  const refOf = (record: Record_<Body>): ResourceRef => ({ id: record.id, revision: record.revision })\n\n  return {\n    list(signal) {\n      return aborted(signal) ?? Promise.resolve([...rows.values()].map(metaOf))\n    },\n    load(id, signal) {\n      const stop = aborted(signal)\n      if (stop) return stop\n      const record = rows.get(id)\n      return Promise.resolve(record ? { ref: refOf(record), body: record.body } : null)\n    },\n    create(body, signal) {\n      const stop = aborted(signal)\n      if (stop) return stop\n      const record: Record_<Body> = { id: newId(), revision: nextRevision(), body, updatedAt: now() }\n      rows.set(record.id, record)\n      const outcome: WriteOutcome<Meta> = { kind: 'ok', ref: refOf(record), value: metaOf(record) }\n      return Promise.resolve(outcome)\n    },\n    update(ref, body, signal) {\n      const stop = aborted(signal)\n      if (stop) return stop\n      const record = rows.get(ref.id)\n      if (!record) return Promise.resolve<WriteOutcome<Meta>>({ kind: 'not-found' })\n      if (record.revision !== ref.revision) return Promise.resolve<WriteOutcome<Meta>>({ kind: 'conflict', current: refOf(record) })\n      record.body = body\n      record.revision = nextRevision()\n      record.updatedAt = now()\n      const outcome: WriteOutcome<Meta> = { kind: 'ok', ref: refOf(record), value: metaOf(record) }\n      return Promise.resolve(outcome)\n    },\n    remove(ref, signal) {\n      const stop = aborted(signal)\n      if (stop) return stop\n      const record = rows.get(ref.id)\n      if (!record) return Promise.resolve<WriteOutcome<void>>({ kind: 'not-found' })\n      if (record.revision !== ref.revision) return Promise.resolve<WriteOutcome<void>>({ kind: 'conflict', current: refOf(record) })\n      rows.delete(ref.id)\n      return Promise.resolve<WriteOutcome<void>>({ kind: 'ok', ref: refOf(record) })\n    },\n  }\n}\n\n/** An in-memory {@link ChartSaveLoadAdapter}. Each drawing context and each template kind gets its\n *  own store, created on first ask and kept, so two calls for one context see the same document. */\nexport function memorySaveLoadAdapter(options?: MemoryResourcesOptions): ChartSaveLoadAdapter {\n  const now = options?.now ?? (() => Date.now())\n  const drawingStores = new Map<string, ResourceStore<DrawingsMeta, DrawingsBody>>()\n  const templateStores = new Map<TemplateKind, ResourceStore<TemplateMeta, TemplateBody>>()\n\n  return {\n    charts: memoryStore<ChartMeta, ChartBody>(\n      (r) => ({ id: r.id, revision: r.revision, name: r.body.name, symbol: r.body.symbol, timeframe: r.body.timeframe, updatedAt: r.updatedAt }),\n      now,\n    ),\n    layouts: memoryStore<LayoutMeta, LayoutBody>(\n      (r) => ({\n        id: r.id,\n        revision: r.revision,\n        name: r.body.name,\n        ...(r.body.symbol === undefined ? {} : { symbol: r.body.symbol }),\n        ...(r.body.timeframe === undefined ? {} : { timeframe: r.body.timeframe }),\n        updatedAt: r.updatedAt,\n      }),\n      now,\n    ),\n    drawings(context) {\n      const key = drawingContextKey(context)\n      let store = drawingStores.get(key)\n      if (!store) {\n        store = memoryStore<DrawingsMeta, DrawingsBody>((r) => ({ id: r.id, revision: r.revision, updatedAt: r.updatedAt }), now)\n        drawingStores.set(key, store)\n      }\n      return store\n    },\n    templates(kind) {\n      let store = templateStores.get(kind)\n      if (!store) {\n        store = memoryStore<TemplateMeta, TemplateBody>(\n          (r) => ({ id: r.id, revision: r.revision, name: r.body.name, ...(r.body.tool === undefined ? {} : { tool: r.body.tool }), updatedAt: r.updatedAt }),\n          now,\n        )\n        templateStores.set(kind, store)\n      }\n      return store\n    },\n  }\n}\n"],"mappings":";;;;;AAyIO,IAAM,qBAAN,cAAiC,MAAM;AAAA,EAC1B,OAAO;AAAA,EACzB,YAAY,UAAU,sCAAsC;AAC1D,UAAM,OAAO;AAAA,EACf;AACF;AAiBA,IAAM,UAAU,CAAC,WACf,QAAQ,UAAU,QAAQ,OAAO,IAAI,mBAAmB,CAAC,IAAI;AAE/D,IAAM,QAAQ,MACZ,OAAO,WAAW,eAAe,OAAO,aAAa,OAAO,WAAW,IAAI,IAAI,KAAK,IAAI,EAAE,SAAS,EAAE,CAAC,GAAG,KAAK,OAAO,EAAE,SAAS,EAAE,EAAE,MAAM,GAAG,CAAC,CAAC;AAOjJ,SAAS,YACP,QACA,KAC2B;AAC3B,QAAM,OAAO,oBAAI,IAA2B;AAC5C,MAAI,UAAU;AACd,QAAM,eAAe,MAAc,OAAO,EAAE,OAAO;AACnD,QAAM,QAAQ,CAAC,YAAwC,EAAE,IAAI,OAAO,IAAI,UAAU,OAAO,SAAS;AAElG,SAAO;AAAA,IACL,KAAK,QAAQ;AACX,aAAO,QAAQ,MAAM,KAAK,QAAQ,QAAQ,CAAC,GAAG,KAAK,OAAO,CAAC,EAAE,IAAI,MAAM,CAAC;AAAA,IAC1E;AAAA,IACA,KAAK,IAAI,QAAQ;AACf,YAAM,OAAO,QAAQ,MAAM;AAC3B,UAAI,KAAM,QAAO;AACjB,YAAM,SAAS,KAAK,IAAI,EAAE;AAC1B,aAAO,QAAQ,QAAQ,SAAS,EAAE,KAAK,MAAM,MAAM,GAAG,MAAM,OAAO,KAAK,IAAI,IAAI;AAAA,IAClF;AAAA,IACA,OAAO,MAAM,QAAQ;AACnB,YAAM,OAAO,QAAQ,MAAM;AAC3B,UAAI,KAAM,QAAO;AACjB,YAAM,SAAwB,EAAE,IAAI,MAAM,GAAG,UAAU,aAAa,GAAG,MAAM,WAAW,IAAI,EAAE;AAC9F,WAAK,IAAI,OAAO,IAAI,MAAM;AAC1B,YAAM,UAA8B,EAAE,MAAM,MAAM,KAAK,MAAM,MAAM,GAAG,OAAO,OAAO,MAAM,EAAE;AAC5F,aAAO,QAAQ,QAAQ,OAAO;AAAA,IAChC;AAAA,IACA,OAAO,KAAK,MAAM,QAAQ;AACxB,YAAM,OAAO,QAAQ,MAAM;AAC3B,UAAI,KAAM,QAAO;AACjB,YAAM,SAAS,KAAK,IAAI,IAAI,EAAE;AAC9B,UAAI,CAAC,OAAQ,QAAO,QAAQ,QAA4B,EAAE,MAAM,YAAY,CAAC;AAC7E,UAAI,OAAO,aAAa,IAAI,SAAU,QAAO,QAAQ,QAA4B,EAAE,MAAM,YAAY,SAAS,MAAM,MAAM,EAAE,CAAC;AAC7H,aAAO,OAAO;AACd,aAAO,WAAW,aAAa;AAC/B,aAAO,YAAY,IAAI;AACvB,YAAM,UAA8B,EAAE,MAAM,MAAM,KAAK,MAAM,MAAM,GAAG,OAAO,OAAO,MAAM,EAAE;AAC5F,aAAO,QAAQ,QAAQ,OAAO;AAAA,IAChC;AAAA,IACA,OAAO,KAAK,QAAQ;AAClB,YAAM,OAAO,QAAQ,MAAM;AAC3B,UAAI,KAAM,QAAO;AACjB,YAAM,SAAS,KAAK,IAAI,IAAI,EAAE;AAC9B,UAAI,CAAC,OAAQ,QAAO,QAAQ,QAA4B,EAAE,MAAM,YAAY,CAAC;AAC7E,UAAI,OAAO,aAAa,IAAI,SAAU,QAAO,QAAQ,QAA4B,EAAE,MAAM,YAAY,SAAS,MAAM,MAAM,EAAE,CAAC;AAC7H,WAAK,OAAO,IAAI,EAAE;AAClB,aAAO,QAAQ,QAA4B,EAAE,MAAM,MAAM,KAAK,MAAM,MAAM,EAAE,CAAC;AAAA,IAC/E;AAAA,EACF;AACF;AAIO,SAAS,sBAAsB,SAAwD;AAC5F,QAAM,MAAM,SAAS,QAAQ,MAAM,KAAK,IAAI;AAC5C,QAAM,gBAAgB,oBAAI,IAAuD;AACjF,QAAM,iBAAiB,oBAAI,IAA6D;AAExF,SAAO;AAAA,IACL,QAAQ;AAAA,MACN,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,UAAU,EAAE,UAAU,MAAM,EAAE,KAAK,MAAM,QAAQ,EAAE,KAAK,QAAQ,WAAW,EAAE,KAAK,WAAW,WAAW,EAAE,UAAU;AAAA,MACxI;AAAA,IACF;AAAA,IACA,SAAS;AAAA,MACP,CAAC,OAAO;AAAA,QACN,IAAI,EAAE;AAAA,QACN,UAAU,EAAE;AAAA,QACZ,MAAM,EAAE,KAAK;AAAA,QACb,GAAI,EAAE,KAAK,WAAW,SAAY,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,OAAO;AAAA,QAC/D,GAAI,EAAE,KAAK,cAAc,SAAY,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,UAAU;AAAA,QACxE,WAAW,EAAE;AAAA,MACf;AAAA,MACA;AAAA,IACF;AAAA,IACA,SAAS,SAAS;AAChB,YAAM,MAAM,kBAAkB,OAAO;AACrC,UAAI,QAAQ,cAAc,IAAI,GAAG;AACjC,UAAI,CAAC,OAAO;AACV,gBAAQ,YAAwC,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,UAAU,EAAE,UAAU,WAAW,EAAE,UAAU,IAAI,GAAG;AACxH,sBAAc,IAAI,KAAK,KAAK;AAAA,MAC9B;AACA,aAAO;AAAA,IACT;AAAA,IACA,UAAU,MAAM;AACd,UAAI,QAAQ,eAAe,IAAI,IAAI;AACnC,UAAI,CAAC,OAAO;AACV,gBAAQ;AAAA,UACN,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,UAAU,EAAE,UAAU,MAAM,EAAE,KAAK,MAAM,GAAI,EAAE,KAAK,SAAS,SAAY,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,KAAK,GAAI,WAAW,EAAE,UAAU;AAAA,UACjJ;AAAA,QACF;AACA,uBAAe,IAAI,MAAM,KAAK;AAAA,MAChC;AACA,aAAO;AAAA,IACT;AAAA,EACF;AACF;","names":[]}