@shapeshift-labs/frontier-effects

v0.1.0

Published

22 days ago

Serializable effect descriptors and resource graphs for Frontier apps.

0High
0Medium
0Low

shapeshift-labs

frontier effects resources registry fetch storage workflow

@shapeshift-labs/frontier-effects

Serializable effect descriptors and resource graphs for Frontier apps. frontier-effects makes external side effects visible to the same registry, impact, inspection, replay, and AI harness tooling that already sees state, DOM, routes, migrations, tests, and telemetry.

It does not execute effects. It owns stable descriptors for the resources a feature touches: fetch:/api/todos, storage:indexeddb/todos, route:/settings, timer:autosave, worker:sync, clipboard:write, broadcast:presence, websocket:wss://example.test/socket, and stream-like resources.

npm: @shapeshift-labs/frontier-effects
source: siliconjungle/-shapeshift-labs-frontier-effects
license: MIT

API Shape

import {
  createClipboardEffect,
  createEffectManifest,
  createEffectRegistryGraph,
  createEffectRecord,
  createFetchEffect,
  createNavigationEffect,
  createStorageEffect,
  createTimerEffect,
  createWorkerEffect,
  queryEffectManifest,
  traceEffectImpact
} from '@shapeshift-labs/frontier-effects';

const manifest = createEffectManifest({
  effects: [
    createFetchEffect('todos.fetch', '/api/todos', {
      feature: 'todos',
      package: '@app/todos',
      reads: ['auth.session'],
      writes: ['entities.todos'],
      source: { file: 'src/todos/effects.ts', symbol: 'loadTodos' },
      policy: {
        retry: { attempts: 3, backoff: 'exponential', jitter: true },
        cancellation: { strategy: 'abort', timeoutMs: 5000 }
      }
    }),
    createStorageEffect('todos.cache', 'indexeddb', 'todos', {
      feature: 'todos',
      operation: 'write',
      writes: ['cache.todos']
    }),
    createNavigationEffect('settings.open', '/settings', {
      feature: 'settings',
      writes: ['ui.route']
    }),
    createTimerEffect('todos.autosave', { kind: 'interval', intervalMs: 1000 }, {
      feature: 'todos',
      policy: { concurrency: { mode: 'replace', key: 'todos.autosave' } }
    }),
    createWorkerEffect('todos.sync', 'sync', {
      feature: 'todos',
      dependsOn: ['todos.fetch']
    }),
    createClipboardEffect('todos.copy', 'write', {
      feature: 'todos'
    })
  ]
});

const graph = createEffectRegistryGraph(manifest);
const todos = queryEffectManifest(manifest, { features: ['todos'] });
const impact = traceEffectImpact(manifest, { resources: ['fetch:/api/todos'] });
const record = createEffectRecord('todos.fetch', {
  status: 'ok',
  reads: ['auth.session'],
  writes: ['entities.todos'],
  affected: ['fetch:/api/todos']
});

void graph;
void todos;
void impact;
void record;

Design Notes

Effects are plain JSON-like descriptors. Apps and package adapters can serialize them, redact them, emit them to inspect bundles, or compile them away without carrying an execution engine.

Resource ids are scheme-prefixed and stable across packages: fetch:, storage:, route:, scene:, timer:, worker:, clipboard:, broadcast:, websocket:, stream:, and package-specific schemes.
Builders normalize common host APIs while the generic createEffectDescriptor keeps custom resources possible.
Policies are descriptive only: retry, schedule, concurrency, cancellation, timeout, and dedupe metadata describe intent for tooling and replays without owning timers, fetch, workers, or schedulers.
Manifest queries use lazy indexes for id, kind, mode, operation, resource, feature, package, owner, tag, source file, and Frontier state path filters.
Impact tracing emits Frontier registry graphs so DOM, Playwright, route, migrations, logging, cache, and inspect surfaces can connect effect resources without runtime imports.
Effect records normalize runtime observations into registry records for telemetry and replay correlation.
Redaction, JSONL import/export, and proof helpers keep AI-readable evidence bundles safe to persist.

Related Packages

The published Frontier package family is generated from one shared package catalog so READMEs stay in sync across packages:

@shapeshift-labs/frontier: Core JSON diff/apply, compact patch tuples, JSON Pointer, equality, clone, validation, Unicode helpers, and tiny dependency-free runtime budget/scheduler primitives.
@shapeshift-labs/frontier-query: Shared query-key, selector path, condition, entity identity, and table-shape primitives.
@shapeshift-labs/frontier-codec: Patch serialization, binary frames, canonical JSON, and patch-history codecs.
@shapeshift-labs/frontier-engine: Stateful planned diff engine, adaptive profiles, schema plans, and engine-level history helpers.
@shapeshift-labs/frontier-state: Patch-routed app-state subscriptions, owned commits, maintained views, and path mapping.
@shapeshift-labs/frontier-dataflow: Serializable incremental dataflow and materialized-view graphs for Frontier apps, including selectors, dependency DAGs, filters, joins, aggregations, stale paths, recompute budgets, output patches, provenance records, and proof of why derived views changed.
@shapeshift-labs/frontier-state-cache: Normalized query-result cache with entity/query watchers, persistence, change logs, optimistic layers, scheduled persistence, and mutation bridge.
@shapeshift-labs/frontier-state-cache-idb: IndexedDB persistence adapter for Frontier state-cache snapshots and durable change logs.
@shapeshift-labs/frontier-state-cache-file: Structured file persistence adapter for Frontier state-cache snapshots and change logs.
@shapeshift-labs/frontier-state-cache-sql: SQL persistence adapter for Frontier state-cache snapshots and change logs.
@shapeshift-labs/frontier-schema: JSON Schema validation, Frontier profile generation, CloudEvent envelopes, and query/table schema helpers.
@shapeshift-labs/frontier-migrations: Boundary-first data migrations, import normalization, plugin/API version mapping, versioned envelopes, graph diagnostics, patch path rewrites, dry-run reports, and current-shape rehydration.
@shapeshift-labs/frontier-event-log: Bounded event logs, replay cursors, consumer acknowledgements, keyed compaction, checkpoints, and Frontier patch event records.
@shapeshift-labs/frontier-inspect: Cross-package inspection/evidence bundles, registry graph snapshots, feature/resource impact reports, timeline/event normalization, redaction, JSONL import/export, and AI-readable app feature maps.
@shapeshift-labs/frontier-scheduler: Deterministic work scheduling, lanes, cancellation, backpressure, frame policies, replay snapshots, and work graphs.
@shapeshift-labs/frontier-logging: Opt-in structured logging, browser telemetry, scheduled sinks, file sinks, exporters, benchmark traces, and Frontier patch/update summaries.
@shapeshift-labs/frontier-mutation: Explicit mutation and selector plans compiled to Frontier patches or CRDT operations.
@shapeshift-labs/frontier-policy: Serializable policy and capability decisions for Frontier apps, effects, views, sync, routes, traces, and AI tools.
@shapeshift-labs/frontier-tools: Serializable app action/tool manifests for AI-operable Frontier apps, including availability, validation, dry-run plans, patch previews, effect/tool constraints, execution records, rollback links, and registry graph output.
@shapeshift-labs/frontier-sandbox: Runtime-agnostic sandbox contracts for Frontier patch-producing actions, including manifests, declared reads/writes/capabilities, host-validated patch/effect/event/log results, dynamic source modules, source event replay, and structural runtime adapters.
@shapeshift-labs/frontier-sandbox-quickjs: QuickJS/WebAssembly runtime adapter for Frontier sandbox actions, including invocation/runtime isolation modes, deadline and memory limits, dynamic source execution, and patch/effect result normalization.
@shapeshift-labs/frontier-workflow: Serializable durable workflow/process manifests for Frontier apps, including steps, waits, approvals, timers, retries, expected patches, compensation, records, timelines, and registry graph output.
@shapeshift-labs/frontier-worker: Serializable worker and edge task descriptors for Frontier apps, including queues, idempotency keys, retry and timeout policy, declared reads/writes/effects, snapshots, patch outputs, produced assets, execution records, logs, trace links, proof hashes, dedupe indexes, and registry graph output.
@shapeshift-labs/frontier-assets: Serializable asset and content provenance graphs for Frontier apps, including source files, generated variants, thumbnails, LOD chunks, shader/material dependencies, transforms, hashes, owners, runtime consumers, review plans, registry graph output, and impact queries.
@shapeshift-labs/frontier-triggers: Capability-gated event trigger registry, scoped event envelopes, listener/reaction rules, structured rejection, deterministic event-to-action scheduling, replay/provenance records, and registry graph output.
@shapeshift-labs/frontier-virtual: DOM-neutral virtualization, layout providers, range materialization, grids, spatial/frustum indexes, patch invalidation, camera anchors, and serializable layout state.
@shapeshift-labs/frontier-scene: Patch-native 2D/3D scene graph, transform propagation, bounds queries, virtual/culling adapters, spatial invalidation, and camera/frustum materialization.
@shapeshift-labs/frontier-pathfinding: Patch-native grid pathfinding, typed-array A*/Dijkstra search, flow fields, connected components, line-of-sight smoothing, dirty-cell invalidation, and scheduler-friendly path jobs.
@shapeshift-labs/frontier-lod: Patch-native level-of-detail and significance selection for rendering and computation workloads, compact typed hot paths, multi-observer selection, budget degradation, materialization frames, and scheduler work plans.
@shapeshift-labs/frontier-route: DOM-neutral app/game route resources, route and scene manifests, match/resolve/transition planning, dependency metadata, sessions, registry graph output, and impact queries.
@shapeshift-labs/frontier-trace: Serializable traces, spans, events, causal links, W3C trace context helpers, timeline/resource/path queries, critical-path analysis, registry graph output, JSONL/proof helpers, Chrome trace export, and redaction for app-wide feature observability.
@shapeshift-labs/frontier-manifest: Build/static feature manifests for owners, routes, actions, states, migrations, tests, source files, assets, resources, tasks, dependency metadata, registry graph output, feature maps, JSONL export, and impact queries.
@shapeshift-labs/frontier-view: Renderer-neutral view manifests, type defaults, validation frames, action bindings, visual channels, virtual/LOD hints, and data-to-representation mapping for Frontier apps.
@shapeshift-labs/frontier-dom: Patch-native DOM and host renderer bindings, manifest hydration, JSX runtime/compiler helpers, SSR, devtools, and logging bridges.
@shapeshift-labs/frontier-playwright: Playwright/headless automation probes for Frontier state, DOM, devtools, marks, and timeline queries.
@shapeshift-labs/frontier-test: Serializable test/spec evidence manifests for Frontier apps, including fixtures, commands, expected patches/effects/routes/policies, coverage declarations, run plans, run records, report adapters, replay proofs, fuzzers, benchmarks, registry graph output, and impact queries.
@shapeshift-labs/frontier-history: Serializable temporal explanation and causality records for Frontier apps, including field-change explanations, action/workflow/policy/effect/trace/test provenance, audit windows, undo planning, registry/provenance graph output, JSONL replay bundles, and proof hashes.
@shapeshift-labs/frontier-application: Serializable whole-application graph and impact queries for Frontier apps, including features, owners, packages, routes, views, actions, mutations, state paths, effects, workers, assets, tests, traces, policies, workflows, migrations, benchmarks, registry graph output, feature maps, JSONL bundles, and proof hashes.
@shapeshift-labs/frontier-linter: Serializable Frontier lint rules, diagnostics, fixes, reports, and fast rule execution for package catalogs, registry graphs, application maps, manifests, traces, policies, workflows, workers, assets, tests, benchmarks, and source snippets.
@shapeshift-labs/frontier-crdt: Native CRDT documents, update tooling, awareness, branches, conflict introspection, version frames, and undo.
@shapeshift-labs/frontier-crdt-sync: CRDT sync endpoints, repo/storage/provider contracts, scheduled sync work, document URLs, local networks, model checking, forensics, and text binding contracts.
@shapeshift-labs/frontier-crdt-websocket: WebSocket client/server transports for Frontier CRDT sync providers.
@shapeshift-labs/frontier-react: React external-store hooks and adapters for Frontier state, cache, and CRDT surfaces.
@shapeshift-labs/frontier-richtext: Rich text Delta normalization/application, marks, embeds, ranges, and cursor/selection transforms for local editor integrations.
@shapeshift-labs/frontier-realtime: Shared realtime command, tick, snapshot, prediction, reconciliation, interpolation, rollback, message, and delta primitives.
@shapeshift-labs/frontier-realtime-server: Authoritative realtime room, tick, command validation, rate-limit, session, and snapshot-history runtime.
@shapeshift-labs/frontier-realtime-websocket: WebSocket client, wire, and Node room-server transport for Frontier realtime.
@shapeshift-labs/frontier-game: Game-facing entity, component, player, room, ownership, spatial interest, rollback, physics, and replication helpers above realtime.

Package source repositories:

Install

npm install @shapeshift-labs/frontier-effects

Benchmarks

These are Frontier-only package measurements, not competitor comparisons.

Run package-local measurements:

npm run bench

The benchmark covers manifest creation, feature/resource/path queries, impact tracing, registry graph generation, JSONL roundtrip, redaction, and proof generation.

Boundary

frontier-effects depends only on @shapeshift-labs/frontier. It does not import DOM, Playwright, route, inspect, logging, migrations, cache, scheduler, React, worker, fetch, or browser APIs. Those packages should pass structural effect descriptors, manifests, records, or registry graphs into this package rather than becoming runtime dependencies.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@shapeshift-labs/frontier-effects

API Shape

Design Notes

Related Packages

Install

Benchmarks

Boundary