@soda-gql/common


Shared utilities and types for the soda-gql ecosystem.

Installation

``bash
bun add @soda-gql/common
`

> Note: This package is primarily used internally by other soda-gql packages. Direct usage is only needed for advanced integration scenarios.

Overview

This package provides shared utilities used across the soda-gql ecosystem:

- Portable utilities for cross-environment compatibility
- Canonical ID generation and parsing
- Path building utilities
- Zod validation helpers

Exports

$3

Common types and utilities:

`typescript
import { ... } from "@soda-gql/common";
`

$3

Cross-environment utilities:

`typescript
import { ... } from "@soda-gql/common/portable";
`

$3

Canonical ID generation and parsing:

`typescript
import { createCanonicalId, parseCanonicalId } from "@soda-gql/common/canonical-id";

// Create a canonical ID
const id = createCanonicalId("/path/to/file.ts", "userQuery");
// Result: "/path/to/file.ts::userQuery"

// Parse a canonical ID
const parsed = parseCanonicalId(id);
// Result: { filePath: "/path/to/file.ts", astPath: "userQuery" }
`

$3

General utility functions:

`typescript
import { ... } from "@soda-gql/common/utils";
`

$3

Zod validation helpers:

`typescript
import { ... } from "@soda-gql/common/zod";
`

$3

Generator-based effect system for scheduling sync and async operations:

`typescript
import {
createSyncScheduler,
createAsyncScheduler,
PureEffect,
DeferEffect,
ParallelEffect,
YieldEffect,
} from "@soda-gql/common";

// Sync usage
const syncScheduler = createSyncScheduler();
const result = syncScheduler.run(function* () {
const a = yield* new PureEffect(1).run();
const b = yield* new PureEffect(2).run();
return a + b;
});

// Async usage with parallel effects
const asyncScheduler = createAsyncScheduler();
const asyncResult = await asyncScheduler.run(function* () {
const data = yield* new DeferEffect(fetchData()).run();
yield* new YieldEffect().run(); // Yield to event loop
return processData(data);
});
`

$3

Shared test utilities for soda-gql packages (internal use):

`typescript
import { createTempDir, TestSuite } from "@soda-gql/common/test";
``

Related Packages

- @soda-gql/core - Core types and utilities
- @soda-gql/builder - Static analysis engine

License

MIT