@dxos/echo 0.8.3 → 0.8.4-main.28f8d3d
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/README.md +1 -1
- package/dist/lib/browser/{chunk-UYPR62ZB.mjs → chunk-NLPBTYZV.mjs} +56 -33
- package/dist/lib/browser/chunk-NLPBTYZV.mjs.map +7 -0
- package/dist/lib/browser/index.mjs +1 -1
- package/dist/lib/browser/meta.json +1 -1
- package/dist/lib/browser/testing/index.mjs +2 -2
- package/dist/lib/node-esm/{chunk-BYBICDIO.mjs → chunk-BQZZRMFX.mjs} +56 -33
- package/dist/lib/node-esm/chunk-BQZZRMFX.mjs.map +7 -0
- package/dist/lib/node-esm/index.mjs +1 -1
- package/dist/lib/node-esm/meta.json +1 -1
- package/dist/lib/node-esm/testing/index.mjs +2 -2
- package/dist/types/src/Obj.d.ts +32 -11
- package/dist/types/src/Obj.d.ts.map +1 -1
- package/dist/types/src/Ref.d.ts +2 -2
- package/dist/types/src/Relation.d.ts +6 -4
- package/dist/types/src/Relation.d.ts.map +1 -1
- package/dist/types/src/Type.d.ts +34 -33
- package/dist/types/src/Type.d.ts.map +1 -1
- package/dist/types/tsconfig.tsbuildinfo +1 -1
- package/package.json +19 -13
- package/src/Obj.ts +52 -16
- package/src/Relation.ts +9 -8
- package/src/Type.ts +65 -50
- package/src/query/dsl.test.ts +2 -1
- package/src/test/api.test.ts +2 -2
- package/dist/lib/browser/chunk-UYPR62ZB.mjs.map +0 -7
- package/dist/lib/node/chunk-4HQE2F3L.cjs +0 -644
- package/dist/lib/node/chunk-4HQE2F3L.cjs.map +0 -7
- package/dist/lib/node/index.cjs +0 -43
- package/dist/lib/node/index.cjs.map +0 -7
- package/dist/lib/node/meta.json +0 -1
- package/dist/lib/node/testing/index.cjs +0 -89
- package/dist/lib/node/testing/index.cjs.map +0 -7
- package/dist/lib/node-esm/chunk-BYBICDIO.mjs.map +0 -7
package/dist/types/src/Type.d.ts
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
import { type Schema } from 'effect';
|
|
2
|
-
import type
|
|
3
|
-
import type
|
|
2
|
+
import { type Simplify } from 'effect/Schema';
|
|
3
|
+
import { type EncodedReference } from '@dxos/echo-protocol';
|
|
4
4
|
import * as EchoSchema from '@dxos/echo-schema';
|
|
5
|
-
import type
|
|
5
|
+
import { type ToMutable } from '@dxos/echo-schema';
|
|
6
6
|
import type * as Keys from '@dxos/keys';
|
|
7
7
|
import type * as RelationModule from './Relation';
|
|
8
8
|
export declare const KindId: unique symbol;
|
|
9
9
|
export type KindId = typeof KindId;
|
|
10
|
-
export
|
|
10
|
+
export declare const Kind: typeof EchoSchema.EntityKind;
|
|
11
11
|
/**
|
|
12
12
|
* Assigns a kind to an Object or Relation instance.
|
|
13
13
|
*/
|
|
@@ -15,29 +15,24 @@ export interface OfKind<Kind extends EchoSchema.EntityKind> {
|
|
|
15
15
|
readonly id: Keys.ObjectId;
|
|
16
16
|
readonly [KindId]: Kind;
|
|
17
17
|
}
|
|
18
|
-
interface ObjJsonProps {
|
|
19
|
-
id: string;
|
|
20
|
-
}
|
|
21
|
-
interface RelationJsonProps {
|
|
22
|
-
id: string;
|
|
23
|
-
[EchoSchema.ATTR_RELATION_SOURCE]: string;
|
|
24
|
-
[EchoSchema.ATTR_RELATION_TARGET]: string;
|
|
25
|
-
}
|
|
26
|
-
/**
|
|
27
|
-
* Returns all properties of an object or relation except for the id and kind.
|
|
28
|
-
*/
|
|
29
|
-
export type Properties<T> = Omit<T, 'id' | KindId | RelationModule.Source | RelationModule.Target>;
|
|
30
18
|
/**
|
|
31
19
|
* Base ECHO schema type.
|
|
32
20
|
*/
|
|
33
21
|
export type Schema = EchoSchema.EchoSchema;
|
|
22
|
+
/**
|
|
23
|
+
* Returns all properties of an object or relation except for the id and kind.
|
|
24
|
+
*/
|
|
25
|
+
export type Properties<T = any> = Omit<T, 'id' | KindId | RelationModule.Source | RelationModule.Target>;
|
|
26
|
+
interface ObjJsonProps {
|
|
27
|
+
id: string;
|
|
28
|
+
}
|
|
34
29
|
/**
|
|
35
30
|
* Return type of the `Obj` schema constructor.
|
|
36
31
|
*
|
|
37
32
|
* This typedef avoids `TS4023` error (name from external module cannot be used named).
|
|
38
33
|
* See Effect's note on interface types.
|
|
39
34
|
*/
|
|
40
|
-
export interface obj<Self extends Schema.Schema.Any> extends Schema.AnnotableClass<obj<Self>, OfKind<EchoSchema.EntityKind.Object> & ToMutable<Schema.Schema.Type<Self>>, Simplify<ObjJsonProps & ToMutable<Schema.Schema.Encoded<Self>>>, Schema.Schema.Context<Self
|
|
35
|
+
export interface obj<Self extends Schema.Schema.Any> extends EchoSchema.TypeMeta, Schema.AnnotableClass<obj<Self>, OfKind<EchoSchema.EntityKind.Object> & ToMutable<Schema.Schema.Type<Self>>, Simplify<ObjJsonProps & ToMutable<Schema.Schema.Encoded<Self>>>, Schema.Schema.Context<Self>> {
|
|
41
36
|
}
|
|
42
37
|
/**
|
|
43
38
|
* Object schema.
|
|
@@ -55,13 +50,25 @@ export declare namespace Obj {
|
|
|
55
50
|
*/
|
|
56
51
|
type Any = Schema.Schema.AnyNoContext;
|
|
57
52
|
}
|
|
53
|
+
export interface Expando extends OfKind<EchoSchema.EntityKind.Object> {
|
|
54
|
+
[key: string]: any;
|
|
55
|
+
}
|
|
56
|
+
type ExpandoEncoded = Simplify<ObjJsonProps & {
|
|
57
|
+
[key: string]: any;
|
|
58
|
+
}>;
|
|
59
|
+
export declare const Expando: Schema.Schema<Expando, ExpandoEncoded, never>;
|
|
60
|
+
interface RelationJsonProps {
|
|
61
|
+
id: string;
|
|
62
|
+
[EchoSchema.ATTR_RELATION_SOURCE]: string;
|
|
63
|
+
[EchoSchema.ATTR_RELATION_TARGET]: string;
|
|
64
|
+
}
|
|
58
65
|
/**
|
|
59
66
|
* Return type of the `Relation` schema constructor.
|
|
60
67
|
*
|
|
61
68
|
* This typedef avoids `TS4023` error (name from external module cannot be used named).
|
|
62
69
|
* See Effect's note on interface types.
|
|
63
70
|
*/
|
|
64
|
-
export interface relation<Self extends Schema.Schema.Any, SourceSchema extends Schema.Schema.Any, TargetSchema extends Schema.Schema.Any> extends Schema.AnnotableClass<relation<Self, SourceSchema, TargetSchema>, OfKind<EchoSchema.EntityKind.Relation> & Relation.Endpoints<Schema.Schema.Type<SourceSchema>, Schema.Schema.Type<TargetSchema>> & ToMutable<Schema.Schema.Type<Self>>, Simplify<RelationJsonProps & ToMutable<Schema.Schema.Encoded<Self>>>, Schema.Schema.Context<Self
|
|
71
|
+
export interface relation<Self extends Schema.Schema.Any, SourceSchema extends Schema.Schema.Any, TargetSchema extends Schema.Schema.Any> extends EchoSchema.TypeMeta, Schema.AnnotableClass<relation<Self, SourceSchema, TargetSchema>, OfKind<EchoSchema.EntityKind.Relation> & Relation.Endpoints<Schema.Schema.Type<SourceSchema>, Schema.Schema.Type<TargetSchema>> & ToMutable<Schema.Schema.Type<Self>>, Simplify<RelationJsonProps & ToMutable<Schema.Schema.Encoded<Self>>>, Schema.Schema.Context<Self>> {
|
|
65
72
|
}
|
|
66
73
|
/**
|
|
67
74
|
* Relation schema.
|
|
@@ -78,14 +85,14 @@ export declare namespace Relation {
|
|
|
78
85
|
* NOTE: This is not an instance type.
|
|
79
86
|
*/
|
|
80
87
|
type Any = Schema.Schema.AnyNoContext;
|
|
81
|
-
/**
|
|
82
|
-
* Get relation target type.
|
|
83
|
-
*/
|
|
84
|
-
type Target<A> = A extends Relation.Endpoints<infer _S, infer T> ? T : never;
|
|
85
88
|
/**
|
|
86
89
|
* Get relation source type.
|
|
87
90
|
*/
|
|
88
91
|
type Source<A> = A extends Relation.Endpoints<infer S, infer _T> ? S : never;
|
|
92
|
+
/**
|
|
93
|
+
* Get relation target type.
|
|
94
|
+
*/
|
|
95
|
+
type Target<A> = A extends Relation.Endpoints<infer _S, infer T> ? T : never;
|
|
89
96
|
type Endpoints<Source, Target> = {
|
|
90
97
|
[RelationModule.Source]: Source;
|
|
91
98
|
[RelationModule.Target]: Target;
|
|
@@ -129,6 +136,10 @@ export declare const getTypename: (schema: Obj.Any | Relation.Any) => string;
|
|
|
129
136
|
* @example 0.1.0
|
|
130
137
|
*/
|
|
131
138
|
export declare const getVersion: (schema: Obj.Any | Relation.Any) => string;
|
|
139
|
+
/**
|
|
140
|
+
* @returns True if the schema is mutable.
|
|
141
|
+
*/
|
|
142
|
+
export declare const isMutable: (schema: Schema.Schema.AnyNoContext) => schema is EchoSchema.EchoSchema;
|
|
132
143
|
/**
|
|
133
144
|
* ECHO type metadata.
|
|
134
145
|
*/
|
|
@@ -137,16 +148,6 @@ export type Meta = EchoSchema.TypeAnnotation;
|
|
|
137
148
|
* Gets the meta data of the schema.
|
|
138
149
|
*/
|
|
139
150
|
export declare const getMeta: (schema: Obj.Any | Relation.Any) => Meta | undefined;
|
|
140
|
-
/**
|
|
141
|
-
* @returns True if the schema is mutable.
|
|
142
|
-
*/
|
|
143
|
-
export declare const isMutable: (schema: Schema.Schema.AnyNoContext) => schema is EchoSchema.EchoSchema;
|
|
144
151
|
export { SpaceId, ObjectId, DXN } from '@dxos/keys';
|
|
145
|
-
export
|
|
146
|
-
[key: string]: any;
|
|
147
|
-
}
|
|
148
|
-
export declare const Expando: Schema.Schema<Expando, Simplify<ObjJsonProps & {
|
|
149
|
-
[key: string]: any;
|
|
150
|
-
}>, never>;
|
|
151
|
-
export { Format, JsonSchemaType as JsonSchema, toEffectSchema, toJsonSchema, } from '@dxos/echo-schema';
|
|
152
|
+
export { Format, JsonSchemaType as JsonSchema, toEffectSchema, toJsonSchema } from '@dxos/echo-schema';
|
|
152
153
|
//# sourceMappingURL=Type.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Type.d.ts","sourceRoot":"","sources":["../../../src/Type.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,QAAQ,CAAC;AACrC,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"Type.d.ts","sourceRoot":"","sources":["../../../src/Type.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,QAAQ,CAAC;AACrC,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,eAAe,CAAC;AAE9C,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAEnD,OAAO,KAAK,KAAK,IAAI,MAAM,YAAY,CAAC;AAExC,OAAO,KAAK,KAAK,cAAc,MAAM,YAAY,CAAC;AAMlD,eAAO,MAAM,MAAM,EAAE,OAAO,MAAuC,CAAC;AACpE,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAC;AAEnC,eAAO,MAAM,IAAI,8BAAwB,CAAC;AAE1C;;GAEG;AAEH,MAAM,WAAW,MAAM,CAAC,IAAI,SAAS,UAAU,CAAC,UAAU;IACxD,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC;IAC3B,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,UAAU,CAAC,UAAU,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,GAAG,IAAI,IAAI,CAAC,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,cAAc,CAAC,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;AAMzG,UAAU,YAAY;IACpB,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;;;;GAKG;AACH,MAAM,WAAW,GAAG,CAAC,IAAI,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,CACjD,SAAQ,UAAU,CAAC,QAAQ,EACzB,MAAM,CAAC,cAAc,CACnB,GAAG,CAAC,IAAI,CAAC,EACT,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAC1E,QAAQ,CAAC,YAAY,GAAG,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAC/D,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAC5B;CAAG;AAER;;GAEG;AACH,eAAO,MAAM,GAAG,EAAE;IAChB,CAAC,IAAI,EAAE,UAAU,CAAC,QAAQ,GAAG,CAAC,IAAI,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,KAAK,GAAG,CAAC,IAAI,CAAC,CAAC;CACzD,CAAC;AAEjC;;GAEG;AACH,yBAAiB,GAAG,CAAC;IACnB;;;OAGG;IAGH,KAAY,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC;CAC9C;AAOD,MAAM,WAAW,OAAQ,SAAQ,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC;IACnE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,KAAK,cAAc,GAAG,QAAQ,CAAC,YAAY,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,CAAC,CAAC;AAEtE,eAAO,MAAM,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,cAAc,EAAE,KAAK,CAA6B,CAAC;AAMhG,UAAU,iBAAiB;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,UAAU,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC1C,CAAC,UAAU,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC3C;AAED;;;;;GAKG;AACH,MAAM,WAAW,QAAQ,CACvB,IAAI,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAC9B,YAAY,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EACtC,YAAY,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,CACtC,SAAQ,UAAU,CAAC,QAAQ,EACzB,MAAM,CAAC,cAAc,CACnB,QAAQ,CAAC,IAAI,EAAE,YAAY,EAAE,YAAY,CAAC,EAC1C,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,GACpC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,GACtF,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EACrC,QAAQ,CAAC,iBAAiB,GAAG,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EACpE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAC5B;CAAG;AAER;;GAEG;AAEH,eAAO,MAAM,QAAQ,EAAE;IACrB,CAAC,MAAM,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,EACnF,IAAI,EAAE,UAAU,CAAC,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,GACnD,CAAC,IAAI,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,KAAK,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;CAClD,CAAC;AAEnC;;GAEG;AACH,yBAAiB,QAAQ,CAAC;IACxB;;;OAGG;IAEH,KAAY,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC;IAE7C;;OAEG;IACH,KAAY,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IAEpF;;OAEG;IACH,KAAY,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IAEpF,KAAY,SAAS,CAAC,MAAM,EAAE,MAAM,IAAI;QACtC,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAChC,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;KACjC,CAAC;CACH;AAMD;;;;;GAKG;AACH,MAAM,WAAW,GAAG,CAAC,YAAY,SAAS,MAAM,CAAC,MAAM,CAAC,GAAG,CACzD,SAAQ,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;CAAG;AAE9D;;GAEG;AACH,eAAO,MAAM,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,KAAK,GAAG,CAAC,CAAC,CAAkB,CAAC;AAE5E,MAAM,WAAW,GAAG,CAAC,CAAC,CAAE,SAAQ,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,gBAAgB,CAAC;CAAG;AAG1F,yBAAiB,GAAG,CAAC;IACnB;;;OAGG;IACH,KAAY,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,gBAAgB,CAAC,CAAC;CACxE;AAED;;;;;GAKG;AACH,eAAO,MAAM,MAAM,GAAI,QAAQ,GAAG,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,KAAG,IAAI,CAAC,GAAG,GAAG,SAElE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,WAAW,GAAI,QAAQ,GAAG,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,KAAG,MAI5D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,UAAU,GAAI,QAAQ,GAAG,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,KAAG,MAI3D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,SAAS,yEAAuB,CAAC;AAE9C;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,UAAU,CAAC,cAAc,CAAC;AAE7C;;GAEG;AACH,eAAO,MAAM,OAAO,GAAI,QAAQ,GAAG,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,KAAG,IAAI,GAAG,SAE/D,CAAC;AAGF,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AAEpD,OAAO,EAAE,MAAM,EAAE,cAAc,IAAI,UAAU,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC"}
|