@dxos/effect 0.8.4-main.f9ba587 → 0.8.4-main.fcfe5033a5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/lib/browser/chunk-CGS2ULMK.mjs +11 -0
- package/dist/lib/browser/chunk-CGS2ULMK.mjs.map +7 -0
- package/dist/lib/browser/index.mjs +516 -189
- package/dist/lib/browser/index.mjs.map +4 -4
- package/dist/lib/browser/meta.json +1 -1
- package/dist/lib/browser/testing.mjs +39 -0
- package/dist/lib/browser/testing.mjs.map +7 -0
- package/dist/lib/node-esm/chunk-HSLMI22Q.mjs +11 -0
- package/dist/lib/node-esm/chunk-HSLMI22Q.mjs.map +7 -0
- package/dist/lib/node-esm/index.mjs +516 -189
- package/dist/lib/node-esm/index.mjs.map +4 -4
- package/dist/lib/node-esm/meta.json +1 -1
- package/dist/lib/node-esm/testing.mjs +39 -0
- package/dist/lib/node-esm/testing.mjs.map +7 -0
- package/dist/types/src/Performance.d.ts +25 -0
- package/dist/types/src/Performance.d.ts.map +1 -0
- package/dist/types/src/RuntimeProvider.d.ts +21 -0
- package/dist/types/src/RuntimeProvider.d.ts.map +1 -0
- package/dist/types/src/ast.d.ts +36 -22
- package/dist/types/src/ast.d.ts.map +1 -1
- package/dist/types/src/async-task-tagging.d.ts +6 -0
- package/dist/types/src/async-task-tagging.d.ts.map +1 -0
- package/dist/types/src/atom-kvs.d.ts +19 -0
- package/dist/types/src/atom-kvs.d.ts.map +1 -0
- package/dist/types/src/context.d.ts +2 -1
- package/dist/types/src/context.d.ts.map +1 -1
- package/dist/types/src/dynamic-runtime.d.ts +56 -0
- package/dist/types/src/dynamic-runtime.d.ts.map +1 -0
- package/dist/types/src/dynamic-runtime.test.d.ts +2 -0
- package/dist/types/src/dynamic-runtime.test.d.ts.map +1 -0
- package/dist/types/src/errors.d.ts +43 -1
- package/dist/types/src/errors.d.ts.map +1 -1
- package/dist/types/src/index.d.ts +8 -2
- package/dist/types/src/index.d.ts.map +1 -1
- package/dist/types/src/interrupt.test.d.ts +2 -0
- package/dist/types/src/interrupt.test.d.ts.map +1 -0
- package/dist/types/src/{jsonPath.d.ts → json-path.d.ts} +12 -4
- package/dist/types/src/json-path.d.ts.map +1 -0
- package/dist/types/src/json-path.test.d.ts +2 -0
- package/dist/types/src/json-path.test.d.ts.map +1 -0
- package/dist/types/src/layers.test.d.ts +2 -0
- package/dist/types/src/layers.test.d.ts.map +1 -0
- package/dist/types/src/otel.d.ts +17 -0
- package/dist/types/src/otel.d.ts.map +1 -0
- package/dist/types/src/otel.test.d.ts +2 -0
- package/dist/types/src/otel.test.d.ts.map +1 -0
- package/dist/types/src/resource.d.ts +8 -0
- package/dist/types/src/resource.d.ts.map +1 -0
- package/dist/types/src/resource.test.d.ts +2 -0
- package/dist/types/src/resource.test.d.ts.map +1 -0
- package/dist/types/src/testing.d.ts +68 -0
- package/dist/types/src/testing.d.ts.map +1 -0
- package/dist/types/src/url.d.ts +3 -1
- package/dist/types/src/url.d.ts.map +1 -1
- package/dist/types/tsconfig.tsbuildinfo +1 -1
- package/package.json +38 -10
- package/src/Performance.ts +45 -0
- package/src/RuntimeProvider.ts +35 -0
- package/src/ast.test.ts +39 -11
- package/src/ast.ts +135 -96
- package/src/async-task-tagging.ts +47 -0
- package/src/atom-kvs.ts +35 -0
- package/src/context.ts +2 -1
- package/src/dynamic-runtime.test.ts +465 -0
- package/src/dynamic-runtime.ts +195 -0
- package/src/errors.test.ts +1 -1
- package/src/errors.ts +152 -29
- package/src/index.ts +8 -2
- package/src/interrupt.test.ts +35 -0
- package/src/{jsonPath.test.ts → json-path.test.ts} +47 -8
- package/src/{jsonPath.ts → json-path.ts} +29 -4
- package/src/layers.test.ts +112 -0
- package/src/otel.test.ts +126 -0
- package/src/otel.ts +45 -0
- package/src/resource.test.ts +32 -0
- package/src/resource.ts +30 -0
- package/src/sanity.test.ts +30 -15
- package/src/testing.ts +112 -0
- package/src/url.test.ts +1 -1
- package/src/url.ts +5 -2
- package/dist/types/src/jsonPath.d.ts.map +0 -1
- package/dist/types/src/jsonPath.test.d.ts +0 -2
- package/dist/types/src/jsonPath.test.d.ts.map +0 -1
package/package.json
CHANGED
|
@@ -1,40 +1,68 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dxos/effect",
|
|
3
|
-
"version": "0.8.4-main.
|
|
3
|
+
"version": "0.8.4-main.fcfe5033a5",
|
|
4
4
|
"description": "Effect utils.",
|
|
5
5
|
"homepage": "https://dxos.org",
|
|
6
6
|
"bugs": "https://github.com/dxos/dxos/issues",
|
|
7
|
+
"repository": {
|
|
8
|
+
"type": "git",
|
|
9
|
+
"url": "https://github.com/dxos/dxos"
|
|
10
|
+
},
|
|
7
11
|
"license": "MIT",
|
|
8
12
|
"author": "info@dxos.org",
|
|
9
13
|
"type": "module",
|
|
10
14
|
"exports": {
|
|
11
15
|
".": {
|
|
16
|
+
"source": "./src/index.ts",
|
|
12
17
|
"types": "./dist/types/src/index.d.ts",
|
|
13
18
|
"browser": "./dist/lib/browser/index.mjs",
|
|
14
19
|
"node": "./dist/lib/node-esm/index.mjs"
|
|
20
|
+
},
|
|
21
|
+
"./testing": {
|
|
22
|
+
"source": "./src/testing.ts",
|
|
23
|
+
"types": "./dist/types/src/testing.d.ts",
|
|
24
|
+
"browser": "./dist/lib/browser/testing.mjs",
|
|
25
|
+
"node": "./dist/lib/node-esm/testing.mjs"
|
|
15
26
|
}
|
|
16
27
|
},
|
|
17
28
|
"types": "dist/types/src/index.d.ts",
|
|
18
29
|
"typesVersions": {
|
|
19
|
-
"*": {
|
|
30
|
+
"*": {
|
|
31
|
+
"testing": [
|
|
32
|
+
"./dist/types/src/testing.d.ts"
|
|
33
|
+
]
|
|
34
|
+
}
|
|
20
35
|
},
|
|
21
36
|
"files": [
|
|
22
37
|
"dist",
|
|
23
38
|
"src"
|
|
24
39
|
],
|
|
25
40
|
"dependencies": {
|
|
26
|
-
"
|
|
27
|
-
"@
|
|
28
|
-
"@
|
|
29
|
-
"
|
|
30
|
-
"@dxos/
|
|
41
|
+
"@effect-atom/atom-react": "^0.5.0",
|
|
42
|
+
"@effect/opentelemetry": "^0.61.0",
|
|
43
|
+
"@opentelemetry/api": "^1.9.0",
|
|
44
|
+
"jsonpath-plus": "^10.3.0",
|
|
45
|
+
"@dxos/context": "0.8.4-main.fcfe5033a5",
|
|
46
|
+
"@dxos/node-std": "0.8.4-main.fcfe5033a5",
|
|
47
|
+
"@dxos/invariant": "0.8.4-main.fcfe5033a5",
|
|
48
|
+
"@dxos/util": "0.8.4-main.fcfe5033a5"
|
|
31
49
|
},
|
|
32
50
|
"devDependencies": {
|
|
33
|
-
"effect": "
|
|
34
|
-
"@
|
|
51
|
+
"@effect/platform": "0.94.4",
|
|
52
|
+
"@effect/platform-browser": "0.74.0",
|
|
53
|
+
"@opentelemetry/api-logs": "^0.203.0",
|
|
54
|
+
"@opentelemetry/resources": "^2.1.0",
|
|
55
|
+
"@opentelemetry/sdk-logs": "^0.203.0",
|
|
56
|
+
"@opentelemetry/sdk-node": "^0.203.0",
|
|
57
|
+
"@opentelemetry/sdk-trace-node": "^2.1.0",
|
|
58
|
+
"@opentelemetry/semantic-conventions": "^1.37.0",
|
|
59
|
+
"effect": "3.20.0",
|
|
60
|
+
"@dxos/log": "0.8.4-main.fcfe5033a5"
|
|
35
61
|
},
|
|
36
62
|
"peerDependencies": {
|
|
37
|
-
"effect": "
|
|
63
|
+
"@effect/platform": "0.94.4",
|
|
64
|
+
"@effect/platform-browser": "0.74.0",
|
|
65
|
+
"effect": "3.20.0"
|
|
38
66
|
},
|
|
39
67
|
"publishConfig": {
|
|
40
68
|
"access": "public"
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
//
|
|
2
|
+
// Copyright 2026 DXOS.org
|
|
3
|
+
//
|
|
4
|
+
|
|
5
|
+
import * as Effect from 'effect/Effect';
|
|
6
|
+
import type * as Exit from 'effect/Exit';
|
|
7
|
+
|
|
8
|
+
export interface AddTrackEntryOptions {
|
|
9
|
+
name: string;
|
|
10
|
+
devtools?: {
|
|
11
|
+
/**
|
|
12
|
+
* @example 'track-entry'
|
|
13
|
+
*/
|
|
14
|
+
dataType: string;
|
|
15
|
+
track: string;
|
|
16
|
+
trackGroup: string;
|
|
17
|
+
/**
|
|
18
|
+
* @example 'tertiary-dark'
|
|
19
|
+
*/
|
|
20
|
+
color: string;
|
|
21
|
+
properties?: [string, any][];
|
|
22
|
+
tooltipText?: string;
|
|
23
|
+
};
|
|
24
|
+
detail?: Record<string, unknown>;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Puts the effect span on the performance timeline in DevTools.
|
|
29
|
+
*/
|
|
30
|
+
export const addTrackEntry =
|
|
31
|
+
<A, E>(options: AddTrackEntryOptions | ((exit: Exit.Exit<A, E>) => AddTrackEntryOptions)) =>
|
|
32
|
+
<R>(effect: Effect.Effect<A, E, R>): Effect.Effect<A, E, R> =>
|
|
33
|
+
Effect.gen(function* () {
|
|
34
|
+
const start = performance.now();
|
|
35
|
+
const exit = yield* Effect.exit(effect);
|
|
36
|
+
const resolvedOptions = typeof options === 'function' ? options(exit) : options;
|
|
37
|
+
performance.measure(resolvedOptions.name, {
|
|
38
|
+
start: start,
|
|
39
|
+
detail: {
|
|
40
|
+
...resolvedOptions.detail,
|
|
41
|
+
devtools: resolvedOptions.devtools,
|
|
42
|
+
},
|
|
43
|
+
});
|
|
44
|
+
return yield* exit;
|
|
45
|
+
});
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
//
|
|
2
|
+
// Copyright 2026 DXOS.org
|
|
3
|
+
//
|
|
4
|
+
|
|
5
|
+
import * as Effect from 'effect/Effect';
|
|
6
|
+
import * as Runtime from 'effect/Runtime';
|
|
7
|
+
|
|
8
|
+
import { runAndForwardErrors, unwrapExit } from './errors';
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Provides effect runtime with services to run effects.
|
|
12
|
+
*/
|
|
13
|
+
export type RuntimeProvider<R> = Effect.Effect<Runtime.Runtime<R>>;
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* @returns Runtime provider from the current context.
|
|
17
|
+
*/
|
|
18
|
+
export const currentRuntime = <R = never>() => Effect.runtime<R>().pipe(Effect.map(Effect.succeed));
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* Run effect, within runitme, clean errors and fix stack-traces.
|
|
22
|
+
*/
|
|
23
|
+
export const runPromise =
|
|
24
|
+
<R>(provider: RuntimeProvider<R>) =>
|
|
25
|
+
async <A>(effect: Effect.Effect<A, any, R>): Promise<A> => {
|
|
26
|
+
const runtime = await runAndForwardErrors(provider);
|
|
27
|
+
return unwrapExit(await effect.pipe(Runtime.runPromiseExit(runtime)));
|
|
28
|
+
};
|
|
29
|
+
|
|
30
|
+
/**
|
|
31
|
+
* Provide services from runtime provider to effect.
|
|
32
|
+
*/
|
|
33
|
+
export const provide: {
|
|
34
|
+
<R2>(runtime: RuntimeProvider<R2>): <A, E, R>(self: Effect.Effect<A, E, R>) => Effect.Effect<A, E, Exclude<R, R2>>;
|
|
35
|
+
} = (runtimeProvider) => (effect) => Effect.flatMap(runtimeProvider, (runtime) => Effect.provide(effect, runtime));
|
package/src/ast.test.ts
CHANGED
|
@@ -2,7 +2,8 @@
|
|
|
2
2
|
// Copyright 2024 DXOS.org
|
|
3
3
|
//
|
|
4
4
|
|
|
5
|
-
import
|
|
5
|
+
import * as Schema from 'effect/Schema';
|
|
6
|
+
import * as SchemaAST from 'effect/SchemaAST';
|
|
6
7
|
import { describe, test } from 'vitest';
|
|
7
8
|
|
|
8
9
|
import { invariant } from '@dxos/invariant';
|
|
@@ -12,15 +13,15 @@ import {
|
|
|
12
13
|
findNode,
|
|
13
14
|
findProperty,
|
|
14
15
|
getAnnotation,
|
|
15
|
-
getDiscriminatingProps,
|
|
16
16
|
getDiscriminatedType,
|
|
17
|
-
|
|
17
|
+
getDiscriminatingProps,
|
|
18
|
+
getProperties,
|
|
19
|
+
isArrayType,
|
|
20
|
+
isDiscriminatedUnion,
|
|
18
21
|
isOption,
|
|
19
|
-
isSimpleType,
|
|
20
22
|
visit,
|
|
21
|
-
isArrayType,
|
|
22
23
|
} from './ast';
|
|
23
|
-
import { type JsonPath, type JsonProp } from './
|
|
24
|
+
import { type JsonPath, type JsonProp } from './json-path';
|
|
24
25
|
|
|
25
26
|
const ZipCode = Schema.String.pipe(
|
|
26
27
|
Schema.pattern(/^\d{5}$/, {
|
|
@@ -64,10 +65,9 @@ describe('AST', () => {
|
|
|
64
65
|
|
|
65
66
|
const prop = findProperty(TestSchema, 'name' as JsonProp);
|
|
66
67
|
invariant(prop);
|
|
67
|
-
const node = findNode(prop,
|
|
68
|
+
const node = findNode(prop, (node) => node._tag === 'StringKeyword');
|
|
68
69
|
invariant(node);
|
|
69
|
-
|
|
70
|
-
expect(type).to.eq('string');
|
|
70
|
+
expect(node._tag).to.eq('StringKeyword');
|
|
71
71
|
});
|
|
72
72
|
|
|
73
73
|
test('findProperty', ({ expect }) => {
|
|
@@ -91,6 +91,30 @@ describe('AST', () => {
|
|
|
91
91
|
}
|
|
92
92
|
});
|
|
93
93
|
|
|
94
|
+
test('getProperties preserves annotation on property type after refinements', ({ expect }) => {
|
|
95
|
+
// When a property is e.g. Format.Text.pipe(nonEmptyString(), maxLength(), Schema.annotations({ title, description })),
|
|
96
|
+
// the form uses getProperties(schema.ast) and then Format.FormatAnnotation.getFromAst(property.type).
|
|
97
|
+
// Custom title and description from the outer Schema.annotations() must not be lost.
|
|
98
|
+
const WithRefinements = Schema.Struct({
|
|
99
|
+
message: Schema.String.annotations({ title: 'Feedback' }).pipe(
|
|
100
|
+
Schema.minLength(1),
|
|
101
|
+
Schema.maxLength(4096),
|
|
102
|
+
Schema.annotations({
|
|
103
|
+
title: 'Feedback label',
|
|
104
|
+
description: 'Feedback placeholder',
|
|
105
|
+
}),
|
|
106
|
+
),
|
|
107
|
+
});
|
|
108
|
+
const properties = getProperties(WithRefinements.ast);
|
|
109
|
+
const messageProp = properties.find((p) => p.name === 'message');
|
|
110
|
+
invariant(messageProp);
|
|
111
|
+
const title = findAnnotation(messageProp.type, SchemaAST.TitleAnnotationId);
|
|
112
|
+
const description = findAnnotation(messageProp.type, SchemaAST.DescriptionAnnotationId);
|
|
113
|
+
// Outer Schema.annotations() wins so form labels/placeholders are preserved.
|
|
114
|
+
expect(title).to.eq('Feedback label');
|
|
115
|
+
expect(description).to.eq('Feedback placeholder');
|
|
116
|
+
});
|
|
117
|
+
|
|
94
118
|
test('findAnnotation', ({ expect }) => {
|
|
95
119
|
const TestSchema = Schema.NonEmptyString.pipe(Schema.pattern(/^\d{5}$/)).annotations({
|
|
96
120
|
title: 'original title',
|
|
@@ -136,7 +160,11 @@ describe('AST', () => {
|
|
|
136
160
|
});
|
|
137
161
|
|
|
138
162
|
const props: string[] = [];
|
|
139
|
-
visit(
|
|
163
|
+
visit(
|
|
164
|
+
TestSchema.ast,
|
|
165
|
+
(_, path) => props.push(path.join('.')),
|
|
166
|
+
(node, path, depth) => depth < 3,
|
|
167
|
+
);
|
|
140
168
|
});
|
|
141
169
|
|
|
142
170
|
test('discriminated unions', ({ expect }) => {
|
|
@@ -151,7 +179,7 @@ describe('AST', () => {
|
|
|
151
179
|
expect(isOption(TestUnionSchema.ast)).to.be.false;
|
|
152
180
|
expect(getDiscriminatingProps(TestUnionSchema.ast)).to.deep.eq(['kind']);
|
|
153
181
|
|
|
154
|
-
const node = findNode(TestUnionSchema.ast,
|
|
182
|
+
const node = findNode(TestUnionSchema.ast, isDiscriminatedUnion);
|
|
155
183
|
expect(node).to.eq(TestUnionSchema.ast);
|
|
156
184
|
}
|
|
157
185
|
|
package/src/ast.ts
CHANGED
|
@@ -2,13 +2,15 @@
|
|
|
2
2
|
// Copyright 2024 DXOS.org
|
|
3
3
|
//
|
|
4
4
|
|
|
5
|
-
import
|
|
6
|
-
import
|
|
5
|
+
import * as Function from 'effect/Function';
|
|
6
|
+
import * as Option from 'effect/Option';
|
|
7
|
+
import * as Schema from 'effect/Schema';
|
|
8
|
+
import * as SchemaAST from 'effect/SchemaAST';
|
|
7
9
|
|
|
8
10
|
import { invariant } from '@dxos/invariant';
|
|
9
11
|
import { isNonNullable } from '@dxos/util';
|
|
10
12
|
|
|
11
|
-
import { type JsonPath, type JsonProp } from './
|
|
13
|
+
import { type JsonPath, type JsonProp } from './json-path';
|
|
12
14
|
|
|
13
15
|
//
|
|
14
16
|
// Refs
|
|
@@ -17,67 +19,66 @@ import { type JsonPath, type JsonProp } from './jsonPath';
|
|
|
17
19
|
// https://effect-ts.github.io/effect/schema/SchemaAST.ts.html
|
|
18
20
|
//
|
|
19
21
|
|
|
20
|
-
export type SimpleType = 'object' | 'string' | 'number' | 'boolean' | 'enum' | 'literal';
|
|
21
|
-
|
|
22
22
|
/**
|
|
23
|
-
*
|
|
23
|
+
* Unwraps and collects refinement filters.
|
|
24
24
|
*/
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
return 'string';
|
|
37
|
-
}
|
|
38
|
-
if (SchemaAST.isNumberKeyword(node)) {
|
|
39
|
-
return 'number';
|
|
40
|
-
}
|
|
41
|
-
if (SchemaAST.isBooleanKeyword(node)) {
|
|
42
|
-
return 'boolean';
|
|
25
|
+
const reduceRefinements = (
|
|
26
|
+
type: SchemaAST.AST,
|
|
27
|
+
refinements: SchemaAST.Refinement['filter'][] = [],
|
|
28
|
+
): { type: SchemaAST.AST; refinements: SchemaAST.Refinement['filter'][] } => {
|
|
29
|
+
if (SchemaAST.isRefinement(type)) {
|
|
30
|
+
const filter = type.filter;
|
|
31
|
+
const nextType = {
|
|
32
|
+
...type.from,
|
|
33
|
+
annotations: { ...type.from.annotations, ...type.annotations },
|
|
34
|
+
} as SchemaAST.AST;
|
|
35
|
+
return reduceRefinements(nextType, [...refinements, filter]);
|
|
43
36
|
}
|
|
44
37
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
}
|
|
38
|
+
return { type, refinements };
|
|
39
|
+
};
|
|
48
40
|
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
41
|
+
/**
|
|
42
|
+
* Get the base type of a property.
|
|
43
|
+
*
|
|
44
|
+
* Unwraps refinements and optional unions.
|
|
45
|
+
*/
|
|
46
|
+
export const getBaseType = (
|
|
47
|
+
prop: SchemaAST.PropertySignature | SchemaProperty,
|
|
48
|
+
): { type: SchemaAST.AST; refinements: SchemaAST.Refinement['filter'][] } => {
|
|
49
|
+
const encoded = SchemaAST.encodedBoundAST(prop.type);
|
|
50
|
+
// Extract property ast from optional union.
|
|
51
|
+
const unwrapped = prop.isOptional && encoded._tag === 'Union' ? encoded.types[0] : encoded;
|
|
52
|
+
return reduceRefinements(unwrapped);
|
|
52
53
|
};
|
|
53
54
|
|
|
54
|
-
export
|
|
55
|
+
export type SchemaProperty = Pick<SchemaAST.PropertySignature, 'name' | 'type' | 'isOptional' | 'isReadonly'> & {
|
|
56
|
+
/** Can be used to validate the property to the spec of the initial AST. */
|
|
57
|
+
refinements: SchemaAST.Refinement['filter'][];
|
|
58
|
+
};
|
|
55
59
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
}
|
|
79
|
-
};
|
|
80
|
-
}
|
|
60
|
+
/**
|
|
61
|
+
* Get the property types of an AST.
|
|
62
|
+
*/
|
|
63
|
+
export const getProperties = (ast: SchemaAST.AST): SchemaProperty[] => {
|
|
64
|
+
const properties = SchemaAST.getPropertySignatures(ast);
|
|
65
|
+
return properties.map((prop) => {
|
|
66
|
+
const { type, refinements } = getBaseType(prop);
|
|
67
|
+
// Merge PropertySignature-level annotations (e.g., title, description set via .annotations())
|
|
68
|
+
// onto the unwrapped base type so downstream consumers see them.
|
|
69
|
+
const mergedType =
|
|
70
|
+
prop.annotations && Reflect.ownKeys(prop.annotations).length > 0
|
|
71
|
+
? ({ ...type, annotations: { ...type.annotations, ...prop.annotations } } as SchemaAST.AST)
|
|
72
|
+
: type;
|
|
73
|
+
return {
|
|
74
|
+
type: mergedType,
|
|
75
|
+
refinements,
|
|
76
|
+
name: prop.name,
|
|
77
|
+
isOptional: prop.isOptional,
|
|
78
|
+
isReadonly: prop.isReadonly,
|
|
79
|
+
};
|
|
80
|
+
});
|
|
81
|
+
};
|
|
81
82
|
|
|
82
83
|
//
|
|
83
84
|
// Branded types
|
|
@@ -101,23 +102,14 @@ export type TestFn = (node: SchemaAST.AST, path: Path, depth: number) => VisitRe
|
|
|
101
102
|
|
|
102
103
|
export type VisitorFn = (node: SchemaAST.AST, path: Path, depth: number) => void;
|
|
103
104
|
|
|
104
|
-
const defaultTest: TestFn = isSimpleType;
|
|
105
|
-
|
|
106
105
|
/**
|
|
107
106
|
* Visit leaf nodes.
|
|
108
107
|
* Refs:
|
|
109
108
|
* - https://github.com/syntax-tree/unist-util-visit?tab=readme-ov-file#visitor
|
|
110
109
|
* - https://github.com/syntax-tree/unist-util-is?tab=readme-ov-file#test
|
|
111
110
|
*/
|
|
112
|
-
export const visit: {
|
|
113
|
-
(node
|
|
114
|
-
(node: SchemaAST.AST, test: TestFn, visitor: VisitorFn): void;
|
|
115
|
-
} = (node: SchemaAST.AST, testOrVisitor: TestFn | VisitorFn, visitor?: VisitorFn): void => {
|
|
116
|
-
if (!visitor) {
|
|
117
|
-
visitNode(node, defaultTest, testOrVisitor);
|
|
118
|
-
} else {
|
|
119
|
-
visitNode(node, testOrVisitor as TestFn, visitor);
|
|
120
|
-
}
|
|
111
|
+
export const visit = (node: SchemaAST.AST, testOrVisitor: TestFn | VisitorFn, visitor: VisitorFn): void => {
|
|
112
|
+
visitNode(node, testOrVisitor as TestFn, visitor);
|
|
121
113
|
};
|
|
122
114
|
|
|
123
115
|
const visitNode = (
|
|
@@ -127,15 +119,15 @@ const visitNode = (
|
|
|
127
119
|
path: Path = [],
|
|
128
120
|
depth = 0,
|
|
129
121
|
): VisitResult | undefined => {
|
|
130
|
-
const
|
|
122
|
+
const $result = test?.(node, path, depth);
|
|
131
123
|
const result: VisitResult =
|
|
132
|
-
|
|
124
|
+
$result === undefined
|
|
133
125
|
? VisitResult.CONTINUE
|
|
134
|
-
: typeof
|
|
135
|
-
?
|
|
126
|
+
: typeof $result === 'boolean'
|
|
127
|
+
? $result
|
|
136
128
|
? VisitResult.CONTINUE
|
|
137
129
|
: VisitResult.SKIP
|
|
138
|
-
:
|
|
130
|
+
: $result;
|
|
139
131
|
|
|
140
132
|
if (result === VisitResult.EXIT) {
|
|
141
133
|
return result;
|
|
@@ -204,6 +196,12 @@ export const findNode = (node: SchemaAST.AST, test: (node: SchemaAST.AST) => boo
|
|
|
204
196
|
return child;
|
|
205
197
|
}
|
|
206
198
|
}
|
|
199
|
+
for (const prop of getIndexSignatures(node)) {
|
|
200
|
+
const child = findNode(prop.type, test);
|
|
201
|
+
if (child) {
|
|
202
|
+
return child;
|
|
203
|
+
}
|
|
204
|
+
}
|
|
207
205
|
}
|
|
208
206
|
|
|
209
207
|
// Tuple.
|
|
@@ -218,12 +216,14 @@ export const findNode = (node: SchemaAST.AST, test: (node: SchemaAST.AST) => boo
|
|
|
218
216
|
|
|
219
217
|
// Branching union (e.g., optional, discriminated unions).
|
|
220
218
|
else if (SchemaAST.isUnion(node)) {
|
|
221
|
-
if (
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
219
|
+
if (isLiteralUnion(node)) {
|
|
220
|
+
return undefined;
|
|
221
|
+
}
|
|
222
|
+
|
|
223
|
+
for (const type of node.types) {
|
|
224
|
+
const child = findNode(type, test);
|
|
225
|
+
if (child) {
|
|
226
|
+
return child;
|
|
227
227
|
}
|
|
228
228
|
}
|
|
229
229
|
}
|
|
@@ -264,10 +264,10 @@ export const findProperty = (
|
|
|
264
264
|
//
|
|
265
265
|
|
|
266
266
|
const defaultAnnotations: Record<string, SchemaAST.Annotated> = {
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
267
|
+
ObjectKeyword: SchemaAST.objectKeyword,
|
|
268
|
+
StringKeyword: SchemaAST.stringKeyword,
|
|
269
|
+
NumberKeyword: SchemaAST.numberKeyword,
|
|
270
|
+
BooleanKeyword: SchemaAST.booleanKeyword,
|
|
271
271
|
};
|
|
272
272
|
|
|
273
273
|
/**
|
|
@@ -279,8 +279,8 @@ export const getAnnotation =
|
|
|
279
279
|
<T>(annotationId: symbol, noDefault = true) =>
|
|
280
280
|
(node: SchemaAST.AST): T | undefined => {
|
|
281
281
|
// Title fallback seems to be the identifier.
|
|
282
|
-
const id = pipe(SchemaAST.getIdentifierAnnotation(node), Option.getOrUndefined);
|
|
283
|
-
const value = pipe(SchemaAST.getAnnotation<T>(annotationId)(node), Option.getOrUndefined);
|
|
282
|
+
const id = Function.pipe(SchemaAST.getIdentifierAnnotation(node), Option.getOrUndefined);
|
|
283
|
+
const value = Function.pipe(SchemaAST.getAnnotation<T>(annotationId)(node), Option.getOrUndefined);
|
|
284
284
|
if (noDefault && (value === defaultAnnotations[node._tag]?.annotations[annotationId] || value === id)) {
|
|
285
285
|
return undefined;
|
|
286
286
|
}
|
|
@@ -326,10 +326,31 @@ export const isOption = (node: SchemaAST.AST): boolean => {
|
|
|
326
326
|
/**
|
|
327
327
|
* Determines if the node is a union of literal types.
|
|
328
328
|
*/
|
|
329
|
-
export const isLiteralUnion = (node: SchemaAST.AST):
|
|
329
|
+
export const isLiteralUnion = (node: SchemaAST.AST): node is SchemaAST.Union<SchemaAST.Literal> => {
|
|
330
330
|
return SchemaAST.isUnion(node) && node.types.every(SchemaAST.isLiteral);
|
|
331
331
|
};
|
|
332
332
|
|
|
333
|
+
/**
|
|
334
|
+
* Determines if the node is an array type.
|
|
335
|
+
*/
|
|
336
|
+
export const isArrayType = (node: SchemaAST.AST): node is SchemaAST.TupleType => {
|
|
337
|
+
return SchemaAST.isTupleType(node) && node.elements.length === 0 && node.rest.length === 1;
|
|
338
|
+
};
|
|
339
|
+
|
|
340
|
+
/**
|
|
341
|
+
* Get the type of the array elements.
|
|
342
|
+
*/
|
|
343
|
+
export const getArrayElementType = (node: SchemaAST.AST): SchemaAST.AST | undefined => {
|
|
344
|
+
return isArrayType(node) ? node.rest.at(0)?.type : undefined;
|
|
345
|
+
};
|
|
346
|
+
|
|
347
|
+
/**
|
|
348
|
+
* Determines if the node is a tuple type.
|
|
349
|
+
*/
|
|
350
|
+
export const isTupleType = (node: SchemaAST.AST): boolean => {
|
|
351
|
+
return SchemaAST.isTupleType(node) && node.elements.length > 0;
|
|
352
|
+
};
|
|
353
|
+
|
|
333
354
|
/**
|
|
334
355
|
* Determines if the node is a discriminated union.
|
|
335
356
|
*/
|
|
@@ -409,6 +430,20 @@ export const getDiscriminatedType = (
|
|
|
409
430
|
return schema.ast;
|
|
410
431
|
};
|
|
411
432
|
|
|
433
|
+
/**
|
|
434
|
+
* Determines if the node is a nested object type.
|
|
435
|
+
*/
|
|
436
|
+
export const isNestedType = (node: SchemaAST.AST): boolean => {
|
|
437
|
+
return (
|
|
438
|
+
SchemaAST.isDeclaration(node) ||
|
|
439
|
+
SchemaAST.isObjectKeyword(node) ||
|
|
440
|
+
SchemaAST.isTypeLiteral(node) ||
|
|
441
|
+
// TODO(wittjosiah): Tuples are actually arrays.
|
|
442
|
+
isTupleType(node) ||
|
|
443
|
+
isDiscriminatedUnion(node)
|
|
444
|
+
);
|
|
445
|
+
};
|
|
446
|
+
|
|
412
447
|
/**
|
|
413
448
|
* Maps AST nodes.
|
|
414
449
|
* The user is responsible for recursively calling {@link mapAst} on the SchemaAST.
|
|
@@ -432,6 +467,7 @@ export const mapAst = (
|
|
|
432
467
|
),
|
|
433
468
|
),
|
|
434
469
|
ast.indexSignatures,
|
|
470
|
+
ast.annotations,
|
|
435
471
|
);
|
|
436
472
|
}
|
|
437
473
|
case 'Union': {
|
|
@@ -456,15 +492,18 @@ export const mapAst = (
|
|
|
456
492
|
}
|
|
457
493
|
};
|
|
458
494
|
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
495
|
+
const getIndexSignatures = (ast: SchemaAST.AST): Array<SchemaAST.IndexSignature> => {
|
|
496
|
+
const annotation = SchemaAST.getSurrogateAnnotation(ast);
|
|
497
|
+
if (Option.isSome(annotation)) {
|
|
498
|
+
return getIndexSignatures(annotation.value);
|
|
499
|
+
}
|
|
500
|
+
switch (ast._tag) {
|
|
501
|
+
case 'TypeLiteral':
|
|
502
|
+
return ast.indexSignatures.slice();
|
|
503
|
+
case 'Suspend':
|
|
504
|
+
return getIndexSignatures(ast.f());
|
|
505
|
+
case 'Refinement':
|
|
506
|
+
return getIndexSignatures(ast.from);
|
|
507
|
+
}
|
|
508
|
+
return [];
|
|
470
509
|
};
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
//
|
|
2
|
+
// Copyright 2025 DXOS.org
|
|
3
|
+
//
|
|
4
|
+
|
|
5
|
+
import * as Context from 'effect/Context';
|
|
6
|
+
import * as Effect from 'effect/Effect';
|
|
7
|
+
import { pipe } from 'effect/Function';
|
|
8
|
+
import * as Layer from 'effect/Layer';
|
|
9
|
+
import * as Predicate from 'effect/Predicate';
|
|
10
|
+
import * as Tracer from 'effect/Tracer';
|
|
11
|
+
|
|
12
|
+
const runInTask = Symbol('runInTask');
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* Traces effect frames using console.createTask so that the proper stack-trace is visible in Chrome Devtools debugger.
|
|
16
|
+
*/
|
|
17
|
+
export const asyncTaskTaggingLayer = () => {
|
|
18
|
+
if (Predicate.hasProperty(console, 'createTask') === false) {
|
|
19
|
+
return Layer.empty;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
const makeTracer = Effect.gen(function* () {
|
|
23
|
+
const oldTracer = yield* Effect.tracer;
|
|
24
|
+
return Tracer.make({
|
|
25
|
+
span: (name, ...args) => {
|
|
26
|
+
const span = oldTracer.span(name, ...args);
|
|
27
|
+
const trace = (console as any).createTask(name);
|
|
28
|
+
(span as any)[runInTask] = (f: any) => trace.run(f);
|
|
29
|
+
return span;
|
|
30
|
+
},
|
|
31
|
+
context: (f, fiber) => {
|
|
32
|
+
const maybeParentSpan = Context.getOption(Tracer.ParentSpan)(fiber.currentContext);
|
|
33
|
+
|
|
34
|
+
if (maybeParentSpan._tag === 'None') return oldTracer.context(f, fiber);
|
|
35
|
+
const parentSpan = maybeParentSpan.value;
|
|
36
|
+
if (parentSpan._tag === 'ExternalSpan') return oldTracer.context(f, fiber);
|
|
37
|
+
const span = parentSpan;
|
|
38
|
+
if (runInTask in span && typeof span[runInTask] === 'function') {
|
|
39
|
+
return span[runInTask](() => oldTracer.context(f, fiber));
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
return oldTracer.context(f, fiber);
|
|
43
|
+
},
|
|
44
|
+
});
|
|
45
|
+
});
|
|
46
|
+
return pipe(makeTracer, Effect.map(Layer.setTracer), Layer.unwrapEffect);
|
|
47
|
+
};
|
package/src/atom-kvs.ts
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
//
|
|
2
|
+
// Copyright 2025 DXOS.org
|
|
3
|
+
//
|
|
4
|
+
|
|
5
|
+
import { Atom } from '@effect-atom/atom-react';
|
|
6
|
+
import * as BrowserKeyValueStore from '@effect/platform-browser/BrowserKeyValueStore';
|
|
7
|
+
import type * as Schema from 'effect/Schema';
|
|
8
|
+
|
|
9
|
+
// TODO(wittjosiah): This is currently provided for convenience but maybe should be removed.
|
|
10
|
+
const defaultRuntime = Atom.runtime(BrowserKeyValueStore.layerLocalStorage);
|
|
11
|
+
|
|
12
|
+
/**
|
|
13
|
+
* Creates a KVS-backed atom for structured settings using Atom.kvs.
|
|
14
|
+
* The entire object is stored as a single localStorage key with JSON serialization.
|
|
15
|
+
*
|
|
16
|
+
* @param options.key - The localStorage key to store the value under.
|
|
17
|
+
* @param options.schema - Effect Schema for the value type.
|
|
18
|
+
* @param options.defaultValue - Function returning the default value.
|
|
19
|
+
* @param options.runtime - Optional custom Atom runtime (defaults to localStorage).
|
|
20
|
+
* @returns A writable atom that persists to localStorage.
|
|
21
|
+
*/
|
|
22
|
+
export const createKvsStore = <T extends Record<string, any>>(options: {
|
|
23
|
+
key: string;
|
|
24
|
+
schema: Schema.Schema<T>;
|
|
25
|
+
defaultValue: () => T;
|
|
26
|
+
runtime?: ReturnType<typeof Atom.runtime>;
|
|
27
|
+
}): Atom.Writable<T> => {
|
|
28
|
+
const runtime = options.runtime ?? defaultRuntime;
|
|
29
|
+
return Atom.kvs({
|
|
30
|
+
runtime,
|
|
31
|
+
key: options.key,
|
|
32
|
+
schema: options.schema,
|
|
33
|
+
defaultValue: options.defaultValue,
|
|
34
|
+
}).pipe(Atom.keepAlive);
|
|
35
|
+
};
|