+1
.gitignore
+1
.gitignore
-9
CHANGELOG.md
-9
CHANGELOG.md
+31
-165
DOCS.md
+31
-165
DOCS.md
···
258
258
259
259
The `@external` decorator tells the emitter to skip JSON output for that namespace. This is useful when referencing definitions from other Lexicons that you don't want to re-emit.
260
260
261
-
Starting with 0.3.0, typelex will automatically generate a `typelex/externals.tsp` file based on the JSON files in your `lexicons/` folder, and enforce that it's imported into your `typelex/main.tsp` entry point. However, this will *not* include Lexicons from your app's namespace, but only external ones.
261
+
You could collect external stubs in one file and import them:
262
+
263
+
```typescript
264
+
import "@typelex/emitter";
265
+
import "../atproto-stubs.tsp";
266
+
267
+
namespace app.bsky.actor.profile {
268
+
model Main {
269
+
labels?: (com.atproto.label.defs.SelfLabels | unknown);
270
+
}
271
+
}
272
+
```
273
+
274
+
Then in `atproto-stubs.tsp`:
275
+
276
+
```typescript
277
+
import "@typelex/emitter";
278
+
279
+
@external
280
+
namespace com.atproto.label.defs {
281
+
model SelfLabels { }
282
+
}
283
+
284
+
@external
285
+
namespace com.atproto.repo.defs {
286
+
model StrongRef { }
287
+
@token model SomeToken { } // Note: Tokens still need @token
288
+
}
289
+
// ... more stubs
290
+
```
262
291
263
292
You'll want to ensure the real JSON for external Lexicons is available before running codegen.
264
293
···
311
340
```
312
341
313
342
Note that `Caption` won't exist as a separate defโthe abstraction is erased in the output.
314
-
315
-
### Scalars
316
-
317
-
TypeSpec scalars let you create named types with constraints. **By default, scalars create standalone defs** (like models):
318
-
319
-
```typescript
320
-
import "@typelex/emitter";
321
-
322
-
namespace com.example {
323
-
model Main {
324
-
handle?: Handle;
325
-
bio?: Bio;
326
-
}
327
-
328
-
@maxLength(50)
329
-
scalar Handle extends string;
330
-
331
-
@maxLength(256)
332
-
@maxGraphemes(128)
333
-
scalar Bio extends string;
334
-
}
335
-
```
336
-
337
-
This creates three defs: `main`, `handle`, and `bio`:
338
-
339
-
```json
340
-
{
341
-
"id": "com.example",
342
-
"defs": {
343
-
"main": {
344
-
"type": "object",
345
-
"properties": {
346
-
"handle": { "type": "ref", "ref": "#handle" },
347
-
"bio": { "type": "ref", "ref": "#bio" }
348
-
}
349
-
},
350
-
"handle": {
351
-
"type": "string",
352
-
"maxLength": 50
353
-
},
354
-
"bio": {
355
-
"type": "string",
356
-
"maxLength": 256,
357
-
"maxGraphemes": 128
358
-
}
359
-
}
360
-
}
361
-
```
362
-
363
-
Use `@inline` to expand a scalar inline instead:
364
-
365
-
```typescript
366
-
import "@typelex/emitter";
367
-
368
-
namespace com.example {
369
-
model Main {
370
-
handle?: Handle;
371
-
}
372
-
373
-
@inline
374
-
@maxLength(50)
375
-
scalar Handle extends string;
376
-
}
377
-
```
378
-
379
-
Now `Handle` is expanded inline (no separate def):
380
-
381
-
```json
382
-
// ...
383
-
"properties": {
384
-
"handle": { "type": "string", "maxLength": 50 }
385
-
}
386
-
// ...
387
-
```
388
343
389
344
## Top-Level Lexicon Types
390
345
···
979
934
980
935
## Defaults and Constants
981
936
982
-
### Property Defaults
983
-
984
-
You can set default values on properties:
937
+
### Defaults
985
938
986
939
```typescript
987
940
import "@typelex/emitter";
···
995
948
```
996
949
997
950
Maps to: `{"default": 1}`, `{"default": "en"}`
998
-
999
-
### Type Defaults
1000
-
1001
-
You can also set defaults on scalar and union types using the `@default` decorator:
1002
-
1003
-
```typescript
1004
-
import "@typelex/emitter";
1005
-
1006
-
namespace com.example {
1007
-
model Main {
1008
-
mode?: Mode;
1009
-
priority?: Priority;
1010
-
}
1011
-
1012
-
@default("standard")
1013
-
scalar Mode extends string;
1014
-
1015
-
@default(1)
1016
-
@closed
1017
-
@inline
1018
-
union Priority { 1, 2, 3 }
1019
-
}
1020
-
```
1021
-
1022
-
This creates a default on the type definition itself:
1023
-
1024
-
```json
1025
-
{
1026
-
"defs": {
1027
-
"mode": {
1028
-
"type": "string",
1029
-
"default": "standard"
1030
-
}
1031
-
}
1032
-
}
1033
-
```
1034
-
1035
-
For unions with token references, pass the model directly:
1036
-
1037
-
```typescript
1038
-
import "@typelex/emitter";
1039
-
1040
-
namespace com.example {
1041
-
model Main {
1042
-
eventType?: EventType;
1043
-
}
1044
-
1045
-
@default(InPerson)
1046
-
union EventType { Hybrid, InPerson, Virtual, string }
1047
-
1048
-
@token model Hybrid {}
1049
-
@token model InPerson {}
1050
-
@token model Virtual {}
1051
-
}
1052
-
```
1053
-
1054
-
This resolves to the fully-qualified token NSID:
1055
-
1056
-
```json
1057
-
{
1058
-
"eventType": {
1059
-
"type": "string",
1060
-
"knownValues": [
1061
-
"com.example#hybrid",
1062
-
"com.example#inPerson",
1063
-
"com.example#virtual"
1064
-
],
1065
-
"default": "com.example#inPerson"
1066
-
}
1067
-
}
1068
-
```
1069
-
1070
-
**Important:** When a scalar or union creates a standalone def (not `@inline`), property-level defaults must match the type's `@default`. Otherwise you'll get an error:
1071
-
1072
-
```typescript
1073
-
@default("standard")
1074
-
scalar Mode extends string;
1075
-
1076
-
model Main {
1077
-
mode?: Mode = "custom"; // ERROR: Conflicting defaults!
1078
-
}
1079
-
```
1080
-
1081
-
Solutions:
1082
-
1. Make the defaults match: `mode?: Mode = "standard"`
1083
-
2. Mark the type `@inline`: Allows property-level defaults
1084
-
3. Remove the property default: Uses the type's default
1085
951
1086
952
### Constants
1087
953
-24
LICENSE.md
-24
LICENSE.md
···
18
18
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
19
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
20
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
-
SOFTWARE.
22
-
23
-
Contains lexicons from https://github.com/lexicon-community/lexicon under the following license:
24
-
25
-
MIT License
26
-
27
-
Copyright (c) 2024 Lexicon Community
28
-
29
-
Permission is hereby granted, free of charge, to any person obtaining a copy
30
-
of this software and associated documentation files (the "Software"), to deal
31
-
in the Software without restriction, including without limitation the rights
32
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
33
-
copies of the Software, and to permit persons to whom the Software is
34
-
furnished to do so, subject to the following conditions:
35
-
36
-
The above copyright notice and this permission notice shall be included in all
37
-
copies or substantial portions of the Software.
38
-
39
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
40
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
41
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
42
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
43
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
44
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
45
21
SOFTWARE.
+1
-1
package.json
+1
-1
package.json
···
5
5
"description": "TypeSpec-based IDL for ATProto Lexicons",
6
6
"scripts": {
7
7
"build": "pnpm -r build",
8
-
"test": "pnpm -r test",
8
+
"test": "pnpm --filter @typelex/emitter test",
9
9
"test:watch": "pnpm --filter @typelex/emitter test:watch",
10
10
"example": "pnpm --filter @typelex/example build",
11
11
"playground": "pnpm --filter @typelex/playground dev",
+4
-9
packages/cli/package.json
+4
-9
packages/cli/package.json
···
1
1
{
2
2
"name": "@typelex/cli",
3
-
"version": "0.3.1",
3
+
"version": "0.2.0",
4
+
"description": "CLI for typelex - TypeSpec-based IDL for ATProto Lexicons",
4
5
"main": "dist/index.js",
5
6
"type": "module",
6
7
"bin": {
···
14
15
"build": "tsc",
15
16
"clean": "rm -rf dist",
16
17
"watch": "tsc --watch",
17
-
"test": "npm run build && vitest run",
18
-
"test:watch": "npm run build && vitest watch",
19
18
"prepublishOnly": "npm run build"
20
19
},
21
20
"keywords": [
···
28
27
"license": "MIT",
29
28
"dependencies": {
30
29
"@typespec/compiler": "^1.4.0",
31
-
"globby": "^14.0.0",
32
-
"picocolors": "^1.1.1",
33
30
"yargs": "^18.0.0"
34
31
},
35
32
"devDependencies": {
36
33
"@types/node": "^20.0.0",
37
34
"@types/yargs": "^17.0.33",
38
-
"typescript": "^5.0.0",
39
-
"vitest": "^1.0.0",
40
-
"@typelex/emitter": "workspace:*"
35
+
"typescript": "^5.0.0"
41
36
},
42
37
"peerDependencies": {
43
-
"@typelex/emitter": "^0.3.1"
38
+
"@typelex/emitter": "^0.2.0"
44
39
}
45
40
}
+4
-53
packages/cli/src/cli.ts
+4
-53
packages/cli/src/cli.ts
···
2
2
import yargs from "yargs";
3
3
import { hideBin } from "yargs/helpers";
4
4
import { compileCommand } from "./commands/compile.js";
5
-
import { initCommand } from "./commands/init.js";
6
5
7
6
async function main() {
8
7
await yargs(hideBin(process.argv))
9
8
.scriptName("typelex")
10
-
.command(
11
-
"init",
12
-
"Initialize a new typelex project",
13
-
(yargs) => {
14
-
return yargs.option("setup", {
15
-
describe: "Internal: run setup after installation",
16
-
type: "boolean",
17
-
hidden: true,
18
-
default: false,
19
-
});
20
-
},
21
-
async (argv) => {
22
-
// Extract any unknown flags to pass through to package manager
23
-
const flags: string[] = [];
24
-
const knownFlags = new Set(["setup", "_", "$0"]);
25
-
26
-
for (const [key, value] of Object.entries(argv)) {
27
-
if (!knownFlags.has(key)) {
28
-
// Single letter = short flag, multiple letters = long flag
29
-
const prefix = key.length === 1 ? "-" : "--";
30
-
if (typeof value === "boolean" && value) {
31
-
flags.push(`${prefix}${key}`);
32
-
} else if (value !== false && value !== undefined) {
33
-
flags.push(`${prefix}${key}`, String(value));
34
-
}
35
-
}
36
-
}
37
-
38
-
await initCommand(argv.setup, flags);
39
-
}
40
-
)
9
+
.usage("$0 compile <namespace>")
41
10
.command(
42
11
"compile <namespace>",
43
12
"Compile TypeSpec files to Lexicon JSON",
44
13
(yargs) => {
45
14
return yargs
46
15
.positional("namespace", {
47
-
describe: "Primary namespace pattern (e.g., com.example.*)",
16
+
describe: "Primary namespace pattern (e.g., app.bsky.*)",
48
17
type: "string",
49
18
demandOption: true,
50
19
})
51
20
.option("out", {
52
-
describe: "Output directory for generated Lexicon files (must end with 'lexicons')",
21
+
describe: "Output directory for generated Lexicon files (relative to cwd)",
53
22
type: "string",
54
23
default: "./lexicons",
55
24
});
56
25
},
57
26
async (argv) => {
58
-
if (!argv.namespace) {
59
-
console.error("Error: namespace is required");
60
-
console.error("Usage: typelex compile <namespace>");
61
-
console.error("Example: typelex compile com.example.*");
62
-
process.exit(1);
63
-
}
64
-
65
-
if (!argv.namespace.endsWith(".*")) {
66
-
console.error("Error: namespace must end with .*");
67
-
console.error(`Got: ${argv.namespace}`);
68
-
console.error("Example: typelex compile com.example.*");
69
-
process.exit(1);
70
-
}
71
-
72
27
const options: Record<string, unknown> = {};
73
28
if (argv.watch) {
74
29
options.watch = true;
···
84
39
type: "boolean",
85
40
default: false,
86
41
})
87
-
.demandCommand(1)
42
+
.demandCommand(1, "You must specify a command")
88
43
.help()
89
44
.version()
90
45
.fail((msg, err) => {
91
46
if (err) {
92
47
console.error(err);
93
-
} else if (msg.includes("Not enough non-option arguments")) {
94
-
console.error("Error: namespace is required");
95
-
console.error("Usage: typelex compile <namespace>");
96
-
console.error("Example: typelex compile com.example.*");
97
48
} else {
98
49
console.error(msg);
99
50
}
+1
-5
packages/cli/src/commands/compile.ts
+1
-5
packages/cli/src/commands/compile.ts
···
33
33
34
34
// Compile TypeSpec using the TypeSpec CLI
35
35
const entrypoint = resolve(cwd, "typelex/main.tsp");
36
-
37
-
// Normalize path for TypeSpec (remove leading ./)
38
-
const normalizedOutDir = outDir.replace(/^\.\//, '');
39
-
40
36
const args = [
41
37
"compile",
42
38
entrypoint,
43
39
"--emit",
44
40
"@typelex/emitter",
45
41
"--option",
46
-
`@typelex/emitter.emitter-output-dir={project-root}/${normalizedOutDir}`,
42
+
`@typelex/emitter.emitter-output-dir={project-root}/${outDir}`,
47
43
];
48
44
49
45
if (options.watch) {
-335
packages/cli/src/commands/init.ts
-335
packages/cli/src/commands/init.ts
···
1
-
import { resolve, relative } from "path";
2
-
import { mkdir, writeFile, readFile, access, stat } from "fs/promises";
3
-
import { spawn } from "child_process";
4
-
import { createInterface } from "readline";
5
-
import pc from "picocolors";
6
-
import { generateExternalsFile } from "../utils/externals-generator.js";
7
-
import { escapeTypeSpecKeywords } from "../utils/escape-keywords.js";
8
-
9
-
function gradientText(text: string): string {
10
-
const colors = [
11
-
"\x1b[38;5;33m",
12
-
"\x1b[38;5;69m",
13
-
"\x1b[38;5;99m",
14
-
"\x1b[38;5;133m",
15
-
"\x1b[38;5;170m",
16
-
"\x1b[38;5;170m",
17
-
"\x1b[38;5;133m",
18
-
];
19
-
const reset = "\x1b[0m";
20
-
21
-
return (
22
-
text
23
-
.split("")
24
-
.map((char, i) => {
25
-
const colorIndex = Math.floor((i / text.length) * colors.length);
26
-
return colors[colorIndex] + char;
27
-
})
28
-
.join("") + reset
29
-
);
30
-
}
31
-
32
-
function createMainTemplate(namespace: string): string {
33
-
const escapedNamespace = escapeTypeSpecKeywords(namespace);
34
-
return `import "@typelex/emitter";
35
-
import "./externals.tsp";
36
-
37
-
namespace ${escapedNamespace}.example.profile {
38
-
/** My profile. */
39
-
@rec("literal:self")
40
-
model Main {
41
-
/** Free-form profile description.*/
42
-
@maxGraphemes(256)
43
-
description?: string;
44
-
}
45
-
}
46
-
`;
47
-
}
48
-
49
-
const EXTERNALS_TSP_TEMPLATE = `import "@typelex/emitter";
50
-
51
-
// Generated by typelex
52
-
// This file is auto-generated. Do not edit manually.
53
-
`;
54
-
55
-
async function promptNamespace(): Promise<string> {
56
-
const rl = createInterface({
57
-
input: process.stdin,
58
-
output: process.stdout,
59
-
});
60
-
61
-
return new Promise((resolve) => {
62
-
rl.question(
63
-
`Which Lexicons do you want to write in typelex (e.g. ${pc.cyan("com.example.*")})? `,
64
-
(answer) => {
65
-
rl.close();
66
-
resolve(answer.trim());
67
-
},
68
-
);
69
-
});
70
-
}
71
-
72
-
export async function initCommand(
73
-
isSetup: boolean = false,
74
-
flags: string[] = [],
75
-
): Promise<void> {
76
-
const originalCwd = process.cwd();
77
-
78
-
// Find nearest package.json upward
79
-
let projectRoot = originalCwd;
80
-
let dir = originalCwd;
81
-
while (dir !== resolve(dir, "..")) {
82
-
try {
83
-
await access(resolve(dir, "package.json"));
84
-
projectRoot = dir;
85
-
break;
86
-
} catch {
87
-
dir = resolve(dir, "..");
88
-
}
89
-
}
90
-
91
-
if (isSetup) {
92
-
return initSetup();
93
-
}
94
-
95
-
console.log(gradientText("Adding typelex...") + "\n");
96
-
97
-
// Detect package manager
98
-
let packageManager = "npm";
99
-
dir = projectRoot;
100
-
while (dir !== resolve(dir, "..") && packageManager === "npm") {
101
-
try {
102
-
await access(resolve(dir, "pnpm-lock.yaml"));
103
-
packageManager = "pnpm";
104
-
break;
105
-
} catch {
106
-
// Not found
107
-
}
108
-
try {
109
-
await access(resolve(dir, "yarn.lock"));
110
-
packageManager = "yarn";
111
-
break;
112
-
} catch {
113
-
// Not found
114
-
}
115
-
dir = resolve(dir, "..");
116
-
}
117
-
118
-
// Install dependencies
119
-
await new Promise<void>((resolvePromise, reject) => {
120
-
const args =
121
-
packageManager === "npm"
122
-
? [
123
-
"install",
124
-
"--save-dev",
125
-
"@typelex/cli@latest",
126
-
"@typelex/emitter@latest",
127
-
]
128
-
: ["add", "-D", "@typelex/cli@latest", "@typelex/emitter@latest"];
129
-
130
-
// Add any additional flags
131
-
args.push(...flags);
132
-
133
-
const install = spawn(packageManager, args, {
134
-
cwd: projectRoot,
135
-
stdio: "inherit",
136
-
});
137
-
138
-
install.on("close", (code) => {
139
-
if (code === 0) {
140
-
console.log(
141
-
`\n${pc.green("โ")} Installed ${pc.dim("@typelex/cli")} and ${pc.dim("@typelex/emitter")}\n`,
142
-
);
143
-
resolvePromise();
144
-
} else {
145
-
console.error(pc.red("โ Failed to install dependencies"));
146
-
process.exit(code ?? 1);
147
-
}
148
-
});
149
-
150
-
install.on("error", (err) => {
151
-
console.error(pc.red("โ Failed to install dependencies:"), err);
152
-
reject(err);
153
-
});
154
-
});
155
-
156
-
// Find node_modules
157
-
let nodeModulesDir = resolve(projectRoot, "node_modules");
158
-
let searchDir = projectRoot;
159
-
while (searchDir !== resolve(searchDir, "..")) {
160
-
try {
161
-
const candidatePath = resolve(searchDir, "node_modules/.bin/typelex");
162
-
await access(candidatePath);
163
-
nodeModulesDir = resolve(searchDir, "node_modules");
164
-
break;
165
-
} catch {
166
-
searchDir = resolve(searchDir, "..");
167
-
}
168
-
}
169
-
170
-
return new Promise((resolvePromise, reject) => {
171
-
const localCli = resolve(nodeModulesDir, ".bin/typelex");
172
-
const setup = spawn(localCli, ["init", "--setup"], {
173
-
cwd: projectRoot,
174
-
stdio: "inherit",
175
-
});
176
-
177
-
setup.on("close", (code) => {
178
-
if (code === 0) {
179
-
resolvePromise();
180
-
} else {
181
-
process.exit(code ?? 1);
182
-
}
183
-
});
184
-
185
-
setup.on("error", (err) => {
186
-
console.error(pc.red("โ Failed to run setup:"), err);
187
-
reject(err);
188
-
});
189
-
});
190
-
}
191
-
192
-
export async function initSetup(): Promise<void> {
193
-
const cwd = process.cwd();
194
-
const typelexDir = resolve(cwd, "typelex");
195
-
const mainTspPath = resolve(typelexDir, "main.tsp");
196
-
const externalsTspPath = resolve(typelexDir, "externals.tsp");
197
-
198
-
// Prompt for namespace
199
-
let namespace = await promptNamespace();
200
-
201
-
// Validate namespace format
202
-
while (!namespace.endsWith(".*")) {
203
-
console.error(pc.red(`Error: namespace must end with ${pc.bold(".*")}`));
204
-
console.error(pc.red(`Got: ${pc.bold(namespace)}\n`));
205
-
namespace = await promptNamespace();
206
-
}
207
-
208
-
// Remove the .* suffix for use in template
209
-
const namespacePrefix = namespace.slice(0, -2);
210
-
211
-
// Detect lexicons directory: check cwd first, then walk up parents
212
-
let lexiconsDir: string | null = null;
213
-
let hasLocalLexicons = false;
214
-
215
-
// Check current directory for lexicons/ (will use default, no --out flag needed)
216
-
try {
217
-
const localPath = resolve(cwd, "lexicons");
218
-
if ((await stat(localPath)).isDirectory()) {
219
-
hasLocalLexicons = true;
220
-
}
221
-
} catch {
222
-
// Not found in current directory, check parent directories
223
-
let dir = resolve(cwd, "..");
224
-
while (dir !== resolve(dir, "..")) {
225
-
try {
226
-
const lexPath = resolve(dir, "lexicons");
227
-
if ((await stat(lexPath)).isDirectory()) {
228
-
lexiconsDir = relative(cwd, lexPath);
229
-
break;
230
-
}
231
-
} catch {
232
-
// Not found, continue up
233
-
}
234
-
dir = resolve(dir, "..");
235
-
}
236
-
}
237
-
238
-
// Determine the actual lexicons path for display
239
-
const displayLexiconsPath = hasLocalLexicons
240
-
? "./lexicons"
241
-
: lexiconsDir || "./lexicons";
242
-
243
-
// Inform about external lexicons
244
-
console.log(
245
-
`\nLexicons for ${pc.cyan(namespace)} will now be managed by typelex.`,
246
-
);
247
-
console.log(`You can begin writing them in ${pc.cyan("typelex/main.tsp")}.`);
248
-
console.log(
249
-
`Any external lexicons should remain in ${pc.cyan(displayLexiconsPath)}.\n`,
250
-
);
251
-
252
-
// Create typelex directory
253
-
await mkdir(typelexDir, { recursive: true });
254
-
255
-
// Check if main.tsp exists and is non-empty
256
-
let shouldCreateMain = true;
257
-
try {
258
-
await access(mainTspPath);
259
-
const content = await readFile(mainTspPath, "utf-8");
260
-
if (content.trim().length > 0) {
261
-
console.log(
262
-
`${pc.green("โ")} ${pc.cyan("typelex/main.tsp")} already exists, skipping`,
263
-
);
264
-
shouldCreateMain = false;
265
-
}
266
-
} catch {
267
-
// File doesn't exist, we'll create it
268
-
}
269
-
270
-
if (shouldCreateMain) {
271
-
await writeFile(mainTspPath, createMainTemplate(namespacePrefix), "utf-8");
272
-
console.log(`${pc.green("โ")} Created ${pc.cyan("typelex/main.tsp")}`);
273
-
}
274
-
275
-
// Generate externals.tsp with any existing external lexicons
276
-
const outDir = lexiconsDir || "./lexicons";
277
-
await generateExternalsFile(namespace, cwd, outDir);
278
-
console.log(`${pc.green("โ")} Created ${pc.cyan("typelex/externals.tsp")}`);
279
-
280
-
// Add build script to package.json
281
-
const packageJsonPath = resolve(cwd, "package.json");
282
-
try {
283
-
const packageJson = JSON.parse(await readFile(packageJsonPath, "utf-8"));
284
-
if (!packageJson.scripts) {
285
-
packageJson.scripts = {};
286
-
}
287
-
if (!packageJson.scripts["build:typelex"]) {
288
-
const outFlag = lexiconsDir ? ` --out ${lexiconsDir}` : "";
289
-
packageJson.scripts["build:typelex"] =
290
-
`typelex compile ${namespace}${outFlag}`;
291
-
await writeFile(
292
-
packageJsonPath,
293
-
JSON.stringify(packageJson, null, 2) + "\n",
294
-
"utf-8",
295
-
);
296
-
console.log(
297
-
`${pc.green("โ")} Added ${pc.cyan("build:typelex")} script to ${pc.cyan("package.json")}`,
298
-
);
299
-
if (hasLocalLexicons) {
300
-
console.log(
301
-
pc.dim(
302
-
` Using existing lexicons directory: ${pc.cyan("./lexicons")}`,
303
-
),
304
-
);
305
-
} else if (lexiconsDir) {
306
-
console.log(
307
-
pc.dim(
308
-
` Using existing lexicons directory: ${pc.cyan(lexiconsDir)}`,
309
-
),
310
-
);
311
-
}
312
-
} else {
313
-
console.log(
314
-
`${pc.green("โ")} ${pc.cyan("build:typelex")} script already exists in ${pc.cyan("package.json")}`,
315
-
);
316
-
}
317
-
} catch (err) {
318
-
console.warn(
319
-
pc.yellow(`โ Could not update ${pc.cyan("package.json")}:`),
320
-
(err as Error).message,
321
-
);
322
-
}
323
-
324
-
console.log(`\n${pc.green("โ")} ${pc.bold("All set!")}`);
325
-
console.log(`\n${pc.bold("Next steps:")}`);
326
-
console.log(
327
-
` ${pc.dim("1.")} Edit ${pc.cyan("typelex/main.tsp")} to define the ${pc.cyan(namespace)} lexicons`,
328
-
);
329
-
console.log(
330
-
` ${pc.dim("2.")} Keep putting external lexicons into ${pc.cyan(displayLexiconsPath)}`,
331
-
);
332
-
console.log(
333
-
` ${pc.dim("3.")} Run ${pc.cyan("npm run build:typelex")} to compile to JSON`,
334
-
);
335
-
}
-28
packages/cli/src/utils/escape-keywords.ts
-28
packages/cli/src/utils/escape-keywords.ts
···
1
-
/**
2
-
* Complete list of TypeSpec reserved keywords (67 total)
3
-
* Source: @typespec/compiler/src/core/scanner.ts
4
-
*/
5
-
const TYPESPEC_KEYWORDS = new Set([
6
-
// Active keywords
7
-
"import", "model", "scalar", "namespace", "using", "op", "enum", "alias",
8
-
"is", "interface", "union", "projection", "else", "if", "dec", "fn",
9
-
"const", "init", "extern", "extends", "true", "false", "return", "void",
10
-
"never", "unknown", "valueof", "typeof",
11
-
// Reserved keywords
12
-
"statemachine", "macro", "package", "metadata", "env", "arg", "declare",
13
-
"array", "struct", "record", "module", "mod", "sym", "context", "prop",
14
-
"property", "scenario", "pub", "sub", "typeref", "trait", "this", "self",
15
-
"super", "keyof", "with", "implements", "impl", "satisfies", "flag", "auto",
16
-
"partial", "private", "public", "protected", "internal", "sealed", "local",
17
-
"async"
18
-
]);
19
-
20
-
/**
21
-
* Escape TypeSpec reserved keywords in a namespace identifier
22
-
* Example: "pub.leaflet.example" -> "`pub`.leaflet.example"
23
-
*/
24
-
export function escapeTypeSpecKeywords(nsid: string): string {
25
-
return nsid.split('.').map(part =>
26
-
TYPESPEC_KEYWORDS.has(part) ? `\`${part}\`` : part
27
-
).join('.');
28
-
}
+6
-7
packages/cli/src/utils/externals-generator.ts
+6
-7
packages/cli/src/utils/externals-generator.ts
···
1
1
import { resolve } from "path";
2
2
import { writeFile, mkdir } from "fs/promises";
3
3
import { findExternalLexicons, LexiconDoc, isTokenDef, isModelDef } from "./lexicon.js";
4
-
import { escapeTypeSpecKeywords } from "./escape-keywords.js";
5
4
6
5
/**
7
6
* Convert camelCase to PascalCase
···
23
22
/**
24
23
* Generate TypeSpec external definitions from lexicon documents
25
24
*/
26
-
function generateExternalsCode(lexicons: Map<string, LexiconDoc>, outDir: string, excludedPrefix: string): string {
25
+
function generateExternalsCode(lexicons: Map<string, LexiconDoc>): string {
27
26
const lines: string[] = [];
28
27
29
28
lines.push('import "@typelex/emitter";');
30
29
lines.push("");
31
-
lines.push(`// Generated by typelex from ${outDir} (excluding ${excludedPrefix}.*)`);
30
+
lines.push("// Generated by typelex");
32
31
lines.push("// This file is auto-generated. Do not edit manually.");
33
32
lines.push("");
34
33
···
39
38
40
39
for (const [nsid, lexicon] of sortedNamespaces) {
41
40
lines.push("@external");
42
-
// Escape reserved keywords in namespace
43
-
const escapedNsid = escapeTypeSpecKeywords(nsid);
41
+
// Escape reserved keywords in namespace (like 'record')
42
+
const escapedNsid = nsid.replace(/\b(record|union|enum|interface|namespace|model|op|import|using|extends|is|scalar|alias|if|else|return|void|never|unknown|any|true|false|null)\b/g, '`$1`');
44
43
lines.push(`namespace ${escapedNsid} {`);
45
44
46
45
// Sort definitions for consistent output
···
90
89
await mkdir(resolve(cwd, "typelex"), { recursive: true });
91
90
await writeFile(
92
91
outputFile,
93
-
`import "@typelex/emitter";\n\n// Generated by typelex from ${outDir} (excluding ${prefix}.*)\n// No external lexicons found\n`,
92
+
'import "@typelex/emitter";\n\n// Generated by typelex\n// No external lexicons found\n',
94
93
"utf-8"
95
94
);
96
95
return;
97
96
}
98
97
99
-
const code = generateExternalsCode(externals, outDir, prefix);
98
+
const code = generateExternalsCode(externals);
100
99
await mkdir(resolve(cwd, "typelex"), { recursive: true });
101
100
await writeFile(outputFile, code, "utf-8");
102
101
} catch (error) {
-291
packages/cli/test/helpers/test-project.ts
-291
packages/cli/test/helpers/test-project.ts
···
1
-
import { mkdtemp, rm, mkdir, writeFile, readFile, readdir, stat } from "fs/promises";
2
-
import { join, resolve, dirname } from "path";
3
-
import { tmpdir } from "os";
4
-
import { spawn } from "child_process";
5
-
import { fileURLToPath } from "url";
6
-
7
-
const __filename = fileURLToPath(import.meta.url);
8
-
const __dirname = dirname(__filename);
9
-
10
-
export interface TestProjectOptions {
11
-
packageManager?: "npm" | "pnpm";
12
-
}
13
-
14
-
export class TestProject {
15
-
public readonly path: string;
16
-
public scenarioPath?: string;
17
-
private cleanupHandlers: Array<() => Promise<void>> = [];
18
-
19
-
constructor(path: string) {
20
-
this.path = path;
21
-
}
22
-
23
-
static async create(options: TestProjectOptions = {}): Promise<TestProject> {
24
-
const tmpDir = await mkdtemp(join(tmpdir(), "typelex-test-"));
25
-
const project = new TestProject(tmpDir);
26
-
27
-
// Create lock file based on package manager (scenarios provide their own package.json and lexicons)
28
-
if (options.packageManager === "pnpm") {
29
-
await writeFile(join(tmpDir, "pnpm-lock.yaml"), "lockfileVersion: '6.0'\n");
30
-
} else if (options.packageManager === "npm") {
31
-
// npm is default, no lock file needed for detection
32
-
}
33
-
34
-
return project;
35
-
}
36
-
37
-
async cleanup(): Promise<void> {
38
-
for (const handler of this.cleanupHandlers) {
39
-
await handler();
40
-
}
41
-
await rm(this.path, { recursive: true, force: true });
42
-
}
43
-
44
-
async writeFile(relativePath: string, content: string): Promise<void> {
45
-
const fullPath = join(this.path, relativePath);
46
-
await mkdir(join(fullPath, ".."), { recursive: true });
47
-
await writeFile(fullPath, content);
48
-
}
49
-
50
-
async readFile(relativePath: string): Promise<string> {
51
-
return readFile(join(this.path, relativePath), "utf-8");
52
-
}
53
-
54
-
async fileExists(relativePath: string): Promise<boolean> {
55
-
try {
56
-
await stat(join(this.path, relativePath));
57
-
return true;
58
-
} catch {
59
-
return false;
60
-
}
61
-
}
62
-
63
-
async readJson(relativePath: string): Promise<unknown> {
64
-
const content = await this.readFile(relativePath);
65
-
return JSON.parse(content);
66
-
}
67
-
68
-
async getDirectoryContents(relativePath: string = ""): Promise<string[]> {
69
-
const fullPath = join(this.path, relativePath);
70
-
try {
71
-
return await readdir(fullPath);
72
-
} catch {
73
-
return [];
74
-
}
75
-
}
76
-
77
-
async runCommand(
78
-
command: string,
79
-
args: string[],
80
-
options: { input?: string; env?: Record<string, string>; cwd?: string } = {}
81
-
): Promise<{ stdout: string; stderr: string; exitCode: number; output: string }> {
82
-
return new Promise((promiseResolve, promiseReject) => {
83
-
// Add monorepo node_modules/.bin to PATH for tsp and other tools
84
-
const monorepoRoot = resolve(__dirname, "../../../..");
85
-
const tspBinPath = join(monorepoRoot, "node_modules/.bin");
86
-
const envPath = options.env?.PATH || process.env.PATH || "";
87
-
const newPath = `${tspBinPath}:${envPath}`;
88
-
89
-
const child = spawn(command, args, {
90
-
cwd: options.cwd || this.path,
91
-
env: { ...process.env, ...options.env, PATH: newPath },
92
-
});
93
-
94
-
let stdout = "";
95
-
let stderr = "";
96
-
97
-
child.stdout?.on("data", (data) => {
98
-
stdout += data.toString();
99
-
});
100
-
101
-
child.stderr?.on("data", (data) => {
102
-
stderr += data.toString();
103
-
});
104
-
105
-
if (options.input) {
106
-
child.stdin?.write(options.input);
107
-
child.stdin?.end();
108
-
}
109
-
110
-
child.on("close", (exitCode) => {
111
-
promiseResolve({
112
-
stdout,
113
-
stderr,
114
-
exitCode: exitCode ?? 0,
115
-
output: stdout + stderr // Combined output for easier testing
116
-
});
117
-
});
118
-
119
-
child.on("error", promiseReject);
120
-
});
121
-
}
122
-
123
-
async runTypelex(args: string[], options?: { input?: string; cwd?: string }): Promise<{
124
-
stdout: string;
125
-
stderr: string;
126
-
exitCode: number;
127
-
output: string; // Combined stdout + stderr
128
-
}> {
129
-
// Use the local CLI from the monorepo
130
-
const cliPath = resolve(__dirname, "../../dist/cli.js");
131
-
const result = await this.runCommand("node", [cliPath, ...args], options);
132
-
return {
133
-
...result,
134
-
output: result.stdout + result.stderr,
135
-
};
136
-
}
137
-
138
-
async compile(namespace: string, outDir: string = "./lexicons", options?: { cwd?: string }): Promise<void> {
139
-
const result = await this.runTypelex(["compile", namespace, "--out", outDir], options);
140
-
if (result.exitCode !== 0) {
141
-
throw new Error(`Compilation failed: ${result.output}`);
142
-
}
143
-
}
144
-
145
-
async init(namespace: string, options?: { cwd?: string }): Promise<void> {
146
-
const result = await this.runTypelex(["init", "--setup"], {
147
-
input: `${namespace}\n`,
148
-
...options,
149
-
});
150
-
if (result.exitCode !== 0) {
151
-
throw new Error(`Init failed: ${result.output}`);
152
-
}
153
-
}
154
-
155
-
async runBuildScript(options?: { cwd?: string }): Promise<{stdout: string; stderr: string}> {
156
-
const result = await this.runCommand("npm", ["run", "build:typelex"], options);
157
-
if (result.exitCode !== 0) {
158
-
throw new Error(`Build failed with exit code ${result.exitCode}:\n${result.output}`);
159
-
}
160
-
return { stdout: result.stdout, stderr: result.stderr };
161
-
}
162
-
163
-
async expectBuildToFail(options?: { cwd?: string }): Promise<{stdout: string; stderr: string; output: string}> {
164
-
const result = await this.runCommand("npm", ["run", "build:typelex"], options);
165
-
if (result.exitCode === 0) {
166
-
throw new Error(`Expected build to fail but it succeeded`);
167
-
}
168
-
return { stdout: result.stdout, stderr: result.stderr, output: result.output };
169
-
}
170
-
171
-
/**
172
-
* Compare files in the project against an expected directory
173
-
* Only checks files that exist in expectedDir
174
-
*/
175
-
async compareTo(expectedSubdir: string = "expected"): Promise<void> {
176
-
const { readdir } = await import("fs/promises");
177
-
178
-
if (!this.scenarioPath) {
179
-
throw new Error("scenarioPath not set on TestProject");
180
-
}
181
-
182
-
const expectedDir = join(this.scenarioPath, expectedSubdir);
183
-
184
-
// Helper to recursively list all files in a directory
185
-
async function listAllFiles(dir: string, prefix: string = ""): Promise<string[]> {
186
-
const files: string[] = [];
187
-
try {
188
-
const entries = await readdir(dir, { withFileTypes: true });
189
-
for (const entry of entries) {
190
-
const fullPath = join(dir, entry.name);
191
-
const relPath = prefix ? join(prefix, entry.name) : entry.name;
192
-
if (entry.isDirectory()) {
193
-
files.push(...await listAllFiles(fullPath, relPath));
194
-
} else {
195
-
files.push(relPath);
196
-
}
197
-
}
198
-
} catch {
199
-
// Directory doesn't exist
200
-
}
201
-
return files.sort();
202
-
}
203
-
204
-
async function compareRecursive(relPath: string = "") {
205
-
const expectedPath = join(expectedDir, relPath);
206
-
const actualPath = join(this.path, relPath);
207
-
208
-
const entries = await readdir(expectedPath, { withFileTypes: true });
209
-
210
-
for (const entry of entries) {
211
-
const entryRelPath = join(relPath, entry.name);
212
-
213
-
if (entry.isDirectory()) {
214
-
await compareRecursive.call(this, entryRelPath);
215
-
} else {
216
-
const expected = await readFile(join(expectedDir, entryRelPath), "utf-8");
217
-
218
-
let actual: string;
219
-
try {
220
-
actual = await readFile(join(this.path, entryRelPath), "utf-8");
221
-
} catch (err) {
222
-
if ((err as NodeJS.ErrnoException).code === "ENOENT") {
223
-
// File is missing - show what files actually exist
224
-
const actualFiles = await listAllFiles(this.path);
225
-
throw new Error(
226
-
`Expected file not found: ${entryRelPath}\n\n` +
227
-
`Actual files in project:\n${actualFiles.map(f => ` ${f}`).join("\n") || " (none)"}`
228
-
);
229
-
}
230
-
throw err;
231
-
}
232
-
233
-
if (expected !== actual) {
234
-
throw new Error(
235
-
`File mismatch: ${entryRelPath}\n\nExpected:\n${expected}\n\nActual:\n${actual}`
236
-
);
237
-
}
238
-
}
239
-
}
240
-
}
241
-
242
-
await compareRecursive.call(this);
243
-
}
244
-
245
-
/**
246
-
* Mock npm/pnpm install by creating node_modules structure
247
-
* Links to the real packages from the monorepo
248
-
*/
249
-
async mockInstall(): Promise<void> {
250
-
const nodeModulesPath = join(this.path, "node_modules");
251
-
await mkdir(nodeModulesPath, { recursive: true });
252
-
await mkdir(join(nodeModulesPath, ".bin"), { recursive: true });
253
-
await mkdir(join(nodeModulesPath, "@typelex"), { recursive: true });
254
-
await mkdir(join(nodeModulesPath, "@typespec"), { recursive: true });
255
-
256
-
// Get paths to real packages in monorepo
257
-
const monorepoRoot = resolve(__dirname, "../../../..");
258
-
const cliPackagePath = resolve(monorepoRoot, "packages/cli");
259
-
const emitterPackagePath = resolve(monorepoRoot, "packages/emitter");
260
-
const typespecCompilerPath = resolve(monorepoRoot, "node_modules/@typespec/compiler");
261
-
262
-
// Create symlinks to real packages
263
-
const { symlink } = await import("fs/promises");
264
-
265
-
try {
266
-
await symlink(cliPackagePath, join(nodeModulesPath, "@typelex/cli"), "dir");
267
-
} catch (err) {
268
-
if ((err as NodeJS.ErrnoException).code !== "EEXIST") throw err;
269
-
}
270
-
271
-
try {
272
-
await symlink(emitterPackagePath, join(nodeModulesPath, "@typelex/emitter"), "dir");
273
-
} catch (err) {
274
-
if ((err as NodeJS.ErrnoException).code !== "EEXIST") throw err;
275
-
}
276
-
277
-
try {
278
-
await symlink(typespecCompilerPath, join(nodeModulesPath, "@typespec/compiler"), "dir");
279
-
} catch (err) {
280
-
if ((err as NodeJS.ErrnoException).code !== "EEXIST") throw err;
281
-
}
282
-
283
-
// Create bin symlink for typelex CLI
284
-
const cliPath = resolve(cliPackagePath, "dist/cli.js");
285
-
try {
286
-
await symlink(cliPath, join(nodeModulesPath, ".bin/typelex"), "file");
287
-
} catch (err) {
288
-
if ((err as NodeJS.ErrnoException).code !== "EEXIST") throw err;
289
-
}
290
-
}
291
-
}
-123
packages/cli/test/scenarios/README.md
-123
packages/cli/test/scenarios/README.md
···
1
-
# Test Scenarios
2
-
3
-
This directory contains declarative test scenarios for the typelex CLI.
4
-
5
-
## Philosophy
6
-
7
-
**These tests focus on CLI workflows, NOT language features.**
8
-
9
-
The CLI's job is to:
10
-
1. Find/create lexicons directories (`./lexicons`, `../lexicons`)
11
-
2. Read existing JSON lexicons from disk
12
-
3. Generate `externals.tsp` from those JSON files
13
-
4. Run compilation while preserving external lexicons
14
-
5. Manage paths and directory structures correctly
15
-
16
-
Language features (syntax, types, decorators) are tested in the emitter package.
17
-
18
-
## Test Coverage
19
-
20
-
All non-trivial branches in the CLI code are tested. Each test was verified by:
21
-
1. Breaking the code (commenting out the condition)
22
-
2. Verifying the test fails
23
-
3. Fixing the code and verifying the test passes
24
-
25
-
### Current Scenarios (8 total)
26
-
27
-
**External Lexicon Workflows** (The Core CLI Functionality):
28
-
- `compile-with-external-atproto` - Real JSONโTSPโJSON cycle, externals preserved
29
-
- `compile-to-parent-lexicons` - Compile with `../lexicons` directory
30
-
- `compile-idempotent` - Deterministic output across runs
31
-
32
-
**Init Workflows** (Directory Detection & File Management):
33
-
- `init-finds-current-lexicons` - Detects `./lexicons`, no `--out` flag
34
-
- `init-finds-parent-lexicons` - Detects `../lexicons`, adds `--out ../lexicons`
35
-
- `init-overwrites-empty-main` - Empty `main.tsp` gets overwritten
36
-
- `init-preserves-build-script` - Existing `build:typelex` not overwritten
37
-
38
-
**Validation** (Error Handling):
39
-
- `validation-errors` - Namespace format, path validation, file structure
40
-
41
-
### Branch Coverage Matrix
42
-
43
-
| File | Line | Branch | Tested By |
44
-
|------|------|--------|-----------|
45
-
| compile.ts | 21 | Path validation | validation-errors |
46
-
| ensure-imports.ts | 20 | First line check | validation-errors |
47
-
| ensure-imports.ts | 26 | Second line check | validation-errors |
48
-
| ensure-imports.ts | 32 | File not found | validation-errors |
49
-
| externals-generator.ts | 87 | No externals case | All compile scenarios |
50
-
| init.ts | 194 | Local lexicons dir | init-finds-current-lexicons |
51
-
| init.ts | 203 | Parent lexicons dir | init-finds-parent-lexicons |
52
-
| init.ts | 231 | Empty main.tsp | init-overwrites-empty-main |
53
-
| init.ts | 252 | No scripts object | All init scenarios (crashes without) |
54
-
| init.ts | 255 | Script exists | init-preserves-build-script |
55
-
56
-
## Structure
57
-
58
-
Each scenario directory contains:
59
-
60
-
```
61
-
scenario-name/
62
-
project/ # Realistic project structure
63
-
package.json
64
-
typelex/
65
-
main.tsp # Input TypeSpec
66
-
externals.tsp # Boilerplate or generated
67
-
lexicons/ # REAL JSON FILES (not mocked!)
68
-
com/atproto/... # Checked-in external lexicons
69
-
expected/ # Expected outputs (optional)
70
-
lexicons/
71
-
com/myapp/...
72
-
test.ts # Test logic with run() function
73
-
```
74
-
75
-
## Writing Tests
76
-
77
-
The `test.ts` exports a `run()` function that performs assertions:
78
-
79
-
```typescript
80
-
import { expect } from "vitest";
81
-
82
-
export const namespace = "com.myapp.*";
83
-
84
-
export async function run(project, scenarioPath) {
85
-
// Compile
86
-
await project.compile(namespace);
87
-
88
-
// Assert on behavior
89
-
const externals = await project.readFile("typelex/externals.tsp");
90
-
expect(externals).toContain("namespace com.atproto.label.defs");
91
-
92
-
// Verify files match expected
93
-
await verifyExpectedFiles(join(scenarioPath, "expected"), project);
94
-
}
95
-
```
96
-
97
-
Available exports:
98
-
- `namespace` - Default namespace
99
-
- `packageManager` - "npm" or "pnpm"
100
-
- `lexiconsDirLocation` - "current", "parent"
101
-
- `run(project, scenarioPath)` - Test logic
102
-
103
-
Available helpers:
104
-
- `project.compile(namespace, outDir?)` - Compile (throws on error)
105
-
- `project.init(namespace)` - Run init (throws on error)
106
-
- `project.runTypelex(args, options?)` - Run any command
107
-
- `project.writeFile/readFile/readJson/fileExists`
108
-
- `verifyExpectedFiles(expectedDir, project)` - Match expected outputs
109
-
110
-
## Key Insight
111
-
112
-
Most tests should have **real lexicons/ folders with JSON files**. This tests the actual CLI behavior: reading JSON from disk, generating externals.tsp, and emitting new JSON that correctly references external lexicons.
113
-
114
-
Don't test language features here - test file I/O, directory management, and the JSONโTSPโJSON workflow.
115
-
116
-
## Adding New Tests
117
-
118
-
When adding a new scenario, verify it catches bugs:
119
-
1. Write the test
120
-
2. Break the corresponding code
121
-
3. Run tests - should FAIL
122
-
4. Fix the code
123
-
5. Run tests - should PASS
-27
packages/cli/test/scenarios/basic/expected/lexicons/com/atproto/label/defs.json
-27
packages/cli/test/scenarios/basic/expected/lexicons/com/atproto/label/defs.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.atproto.label.defs",
4
-
"defs": {
5
-
"selfLabels": {
6
-
"type": "object",
7
-
"properties": {
8
-
"values": {
9
-
"type": "array",
10
-
"items": { "type": "ref", "ref": "#selfLabel" },
11
-
"maxLength": 10
12
-
}
13
-
},
14
-
"required": ["values"]
15
-
},
16
-
"selfLabel": {
17
-
"type": "object",
18
-
"properties": {
19
-
"val": {
20
-
"type": "string",
21
-
"maxLength": 128
22
-
}
23
-
},
24
-
"required": ["val"]
25
-
}
26
-
}
27
-
}
-21
packages/cli/test/scenarios/basic/expected/lexicons/com/test/example/profile.json
-21
packages/cli/test/scenarios/basic/expected/lexicons/com/test/example/profile.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.test.example.profile",
4
-
"defs": {
5
-
"main": {
6
-
"type": "record",
7
-
"key": "literal:self",
8
-
"record": {
9
-
"type": "object",
10
-
"properties": {
11
-
"description": {
12
-
"type": "string",
13
-
"maxGraphemes": 256,
14
-
"description": "Free-form profile description."
15
-
}
16
-
}
17
-
},
18
-
"description": "My profile."
19
-
}
20
-
}
21
-
}
-8
packages/cli/test/scenarios/basic/expected/package.json
-8
packages/cli/test/scenarios/basic/expected/package.json
-10
packages/cli/test/scenarios/basic/expected/typelex/externals.tsp
-10
packages/cli/test/scenarios/basic/expected/typelex/externals.tsp
-12
packages/cli/test/scenarios/basic/expected/typelex/main.tsp
-12
packages/cli/test/scenarios/basic/expected/typelex/main.tsp
-27
packages/cli/test/scenarios/basic/project/lexicons/com/atproto/label/defs.json
-27
packages/cli/test/scenarios/basic/project/lexicons/com/atproto/label/defs.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.atproto.label.defs",
4
-
"defs": {
5
-
"selfLabels": {
6
-
"type": "object",
7
-
"properties": {
8
-
"values": {
9
-
"type": "array",
10
-
"items": { "type": "ref", "ref": "#selfLabel" },
11
-
"maxLength": 10
12
-
}
13
-
},
14
-
"required": ["values"]
15
-
},
16
-
"selfLabel": {
17
-
"type": "object",
18
-
"properties": {
19
-
"val": {
20
-
"type": "string",
21
-
"maxLength": 128
22
-
}
23
-
},
24
-
"required": ["val"]
25
-
}
26
-
}
27
-
}
-1
packages/cli/test/scenarios/basic/project/package.json
-1
packages/cli/test/scenarios/basic/project/package.json
···
1
-
{"name":"test-idempotent","version":"1.0.0","type":"module"}
-10
packages/cli/test/scenarios/basic/test.ts
-10
packages/cli/test/scenarios/basic/test.ts
-25
packages/cli/test/scenarios/init-preserves-main/expected/lexicons/com/example/custom.json
-25
packages/cli/test/scenarios/init-preserves-main/expected/lexicons/com/example/custom.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.example.custom",
4
-
"defs": {
5
-
"main": {
6
-
"type": "record",
7
-
"key": "tid",
8
-
"record": {
9
-
"type": "object",
10
-
"properties": {
11
-
"foo": {
12
-
"type": "string"
13
-
},
14
-
"bar": {
15
-
"type": "integer"
16
-
}
17
-
},
18
-
"required": [
19
-
"foo",
20
-
"bar"
21
-
]
22
-
}
23
-
}
24
-
}
25
-
}
-8
packages/cli/test/scenarios/init-preserves-main/expected/package.json
-8
packages/cli/test/scenarios/init-preserves-main/expected/package.json
-4
packages/cli/test/scenarios/init-preserves-main/expected/typelex/externals.tsp
-4
packages/cli/test/scenarios/init-preserves-main/expected/typelex/externals.tsp
-10
packages/cli/test/scenarios/init-preserves-main/expected/typelex/main.tsp
-10
packages/cli/test/scenarios/init-preserves-main/expected/typelex/main.tsp
-1
packages/cli/test/scenarios/init-preserves-main/project/package.json
-1
packages/cli/test/scenarios/init-preserves-main/project/package.json
···
1
-
{"name":"test-init-preserves-main","version":"1.0.0","type":"module"}
-10
packages/cli/test/scenarios/init-preserves-main/project/typelex/main.tsp
-10
packages/cli/test/scenarios/init-preserves-main/project/typelex/main.tsp
-9
packages/cli/test/scenarios/init-preserves-main/test.ts
-9
packages/cli/test/scenarios/init-preserves-main/test.ts
-21
packages/cli/test/scenarios/missing-dependency/expected/lexicons/com/external/media/defs.json
-21
packages/cli/test/scenarios/missing-dependency/expected/lexicons/com/external/media/defs.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.external.media.defs",
4
-
"defs": {
5
-
"video": {
6
-
"type": "object",
7
-
"properties": {
8
-
"url": {
9
-
"type": "string",
10
-
"format": "uri"
11
-
},
12
-
"mimeType": {
13
-
"type": "string"
14
-
}
15
-
},
16
-
"required": [
17
-
"url"
18
-
]
19
-
}
20
-
}
21
-
}
-25
packages/cli/test/scenarios/missing-dependency/expected/lexicons/com/myapp/post.json
-25
packages/cli/test/scenarios/missing-dependency/expected/lexicons/com/myapp/post.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.myapp.post",
4
-
"defs": {
5
-
"main": {
6
-
"type": "record",
7
-
"key": "tid",
8
-
"record": {
9
-
"type": "object",
10
-
"properties": {
11
-
"text": {
12
-
"type": "string"
13
-
},
14
-
"video": {
15
-
"type": "ref",
16
-
"ref": "com.external.media.defs#video"
17
-
}
18
-
},
19
-
"required": [
20
-
"text"
21
-
]
22
-
}
23
-
}
24
-
}
25
-
}
-8
packages/cli/test/scenarios/missing-dependency/expected/package.json
-8
packages/cli/test/scenarios/missing-dependency/expected/package.json
-9
packages/cli/test/scenarios/missing-dependency/expected/typelex/externals.tsp
-9
packages/cli/test/scenarios/missing-dependency/expected/typelex/externals.tsp
-10
packages/cli/test/scenarios/missing-dependency/expected/typelex/main.tsp
-10
packages/cli/test/scenarios/missing-dependency/expected/typelex/main.tsp
-1
packages/cli/test/scenarios/missing-dependency/project/package.json
-1
packages/cli/test/scenarios/missing-dependency/project/package.json
···
1
-
{"name":"test-missing-dependency","version":"1.0.0","type":"module"}
-51
packages/cli/test/scenarios/missing-dependency/test.ts
-51
packages/cli/test/scenarios/missing-dependency/test.ts
···
1
-
export async function run(project) {
2
-
await project.init("com.myapp.*");
3
-
4
-
// Edit main.tsp to reference a missing external lexicon
5
-
await project.writeFile("typelex/main.tsp", `import "@typelex/emitter";
6
-
import "./externals.tsp";
7
-
8
-
namespace com.myapp.post {
9
-
@rec("tid")
10
-
model Main {
11
-
@required text: string;
12
-
video?: com.external.media.defs.Video;
13
-
}
14
-
}
15
-
`);
16
-
17
-
// Build should fail because com.external.media.defs doesn't exist
18
-
const failure = await project.expectBuildToFail();
19
-
if (!failure.output.includes("com.external.media.defs")) {
20
-
throw new Error(`Expected error about missing com.external.media.defs, got: ${failure.output}`);
21
-
}
22
-
23
-
// Add the missing external lexicon
24
-
await project.writeFile("lexicons/com/external/media/defs.json", JSON.stringify({
25
-
"lexicon": 1,
26
-
"id": "com.external.media.defs",
27
-
"defs": {
28
-
"video": {
29
-
"type": "object",
30
-
"properties": {
31
-
"url": {
32
-
"type": "string",
33
-
"format": "uri"
34
-
},
35
-
"mimeType": {
36
-
"type": "string"
37
-
}
38
-
},
39
-
"required": ["url"]
40
-
}
41
-
}
42
-
}, null, 2) + "\n");
43
-
44
-
// Now build should succeed
45
-
await project.runBuildScript();
46
-
await project.compareTo("expected");
47
-
48
-
// Verify idempotency
49
-
await project.runBuildScript();
50
-
await project.compareTo("expected");
51
-
}
-21
packages/cli/test/scenarios/nested-init/expected/lexicons/com/myservice/example/profile.json
-21
packages/cli/test/scenarios/nested-init/expected/lexicons/com/myservice/example/profile.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.myservice.example.profile",
4
-
"defs": {
5
-
"main": {
6
-
"type": "record",
7
-
"key": "literal:self",
8
-
"record": {
9
-
"type": "object",
10
-
"properties": {
11
-
"description": {
12
-
"type": "string",
13
-
"maxGraphemes": 256,
14
-
"description": "Free-form profile description."
15
-
}
16
-
}
17
-
},
18
-
"description": "My profile."
19
-
}
20
-
}
21
-
}
-8
packages/cli/test/scenarios/nested-init/expected/package.json
-8
packages/cli/test/scenarios/nested-init/expected/package.json
-4
packages/cli/test/scenarios/nested-init/expected/typelex/externals.tsp
-4
packages/cli/test/scenarios/nested-init/expected/typelex/externals.tsp
-12
packages/cli/test/scenarios/nested-init/expected/typelex/main.tsp
-12
packages/cli/test/scenarios/nested-init/expected/typelex/main.tsp
-1
packages/cli/test/scenarios/nested-init/project/package.json
-1
packages/cli/test/scenarios/nested-init/project/package.json
···
1
-
{"name":"test-nested-init","version":"1.0.0","type":"module"}
-16
packages/cli/test/scenarios/nested-init/test.ts
-16
packages/cli/test/scenarios/nested-init/test.ts
···
1
-
import { join } from "path";
2
-
3
-
export async function run(project) {
4
-
const apiDir = join(project.path, "src/api");
5
-
6
-
// Init at root (where package.json is)
7
-
await project.init("com.myservice.*");
8
-
9
-
// Build from nested directory should work (this is what we're testing)
10
-
await project.runBuildScript({ cwd: apiDir });
11
-
await project.compareTo("expected");
12
-
13
-
// Verify idempotency
14
-
await project.runBuildScript({ cwd: apiDir });
15
-
await project.compareTo("expected");
16
-
}
-8
packages/cli/test/scenarios/parent-lexicons/expected1/app/package.json
-8
packages/cli/test/scenarios/parent-lexicons/expected1/app/package.json
-10
packages/cli/test/scenarios/parent-lexicons/expected1/app/typelex/externals.tsp
-10
packages/cli/test/scenarios/parent-lexicons/expected1/app/typelex/externals.tsp
-12
packages/cli/test/scenarios/parent-lexicons/expected1/app/typelex/main.tsp
-12
packages/cli/test/scenarios/parent-lexicons/expected1/app/typelex/main.tsp
-27
packages/cli/test/scenarios/parent-lexicons/expected1/lexicons/com/atproto/label/defs.json
-27
packages/cli/test/scenarios/parent-lexicons/expected1/lexicons/com/atproto/label/defs.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.atproto.label.defs",
4
-
"defs": {
5
-
"selfLabels": {
6
-
"type": "object",
7
-
"properties": {
8
-
"values": {
9
-
"type": "array",
10
-
"items": { "type": "ref", "ref": "#selfLabel" },
11
-
"maxLength": 10
12
-
}
13
-
},
14
-
"required": ["values"]
15
-
},
16
-
"selfLabel": {
17
-
"type": "object",
18
-
"properties": {
19
-
"val": {
20
-
"type": "string",
21
-
"maxLength": 128
22
-
}
23
-
},
24
-
"required": ["val"]
25
-
}
26
-
}
27
-
}
-21
packages/cli/test/scenarios/parent-lexicons/expected1/lexicons/com/myapp/example/profile.json
-21
packages/cli/test/scenarios/parent-lexicons/expected1/lexicons/com/myapp/example/profile.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.myapp.example.profile",
4
-
"defs": {
5
-
"main": {
6
-
"type": "record",
7
-
"key": "literal:self",
8
-
"record": {
9
-
"type": "object",
10
-
"properties": {
11
-
"description": {
12
-
"type": "string",
13
-
"maxGraphemes": 256,
14
-
"description": "Free-form profile description."
15
-
}
16
-
}
17
-
},
18
-
"description": "My profile."
19
-
}
20
-
}
21
-
}
-8
packages/cli/test/scenarios/parent-lexicons/expected2/app/package.json
-8
packages/cli/test/scenarios/parent-lexicons/expected2/app/package.json
-10
packages/cli/test/scenarios/parent-lexicons/expected2/app/typelex/externals.tsp
-10
packages/cli/test/scenarios/parent-lexicons/expected2/app/typelex/externals.tsp
-13
packages/cli/test/scenarios/parent-lexicons/expected2/app/typelex/main.tsp
-13
packages/cli/test/scenarios/parent-lexicons/expected2/app/typelex/main.tsp
···
1
-
import "@typelex/emitter";
2
-
import "./externals.tsp";
3
-
4
-
namespace com.myapp.example.profile {
5
-
/** My profile. */
6
-
@rec("literal:self")
7
-
model Main {
8
-
/** Free-form profile description.*/
9
-
@maxGraphemes(256)
10
-
description?: string;
11
-
labels?: com.atproto.label.defs.SelfLabels;
12
-
}
13
-
}
-27
packages/cli/test/scenarios/parent-lexicons/expected2/lexicons/com/atproto/label/defs.json
-27
packages/cli/test/scenarios/parent-lexicons/expected2/lexicons/com/atproto/label/defs.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.atproto.label.defs",
4
-
"defs": {
5
-
"selfLabels": {
6
-
"type": "object",
7
-
"properties": {
8
-
"values": {
9
-
"type": "array",
10
-
"items": { "type": "ref", "ref": "#selfLabel" },
11
-
"maxLength": 10
12
-
}
13
-
},
14
-
"required": ["values"]
15
-
},
16
-
"selfLabel": {
17
-
"type": "object",
18
-
"properties": {
19
-
"val": {
20
-
"type": "string",
21
-
"maxLength": 128
22
-
}
23
-
},
24
-
"required": ["val"]
25
-
}
26
-
}
27
-
}
-25
packages/cli/test/scenarios/parent-lexicons/expected2/lexicons/com/myapp/example/profile.json
-25
packages/cli/test/scenarios/parent-lexicons/expected2/lexicons/com/myapp/example/profile.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.myapp.example.profile",
4
-
"defs": {
5
-
"main": {
6
-
"type": "record",
7
-
"key": "literal:self",
8
-
"record": {
9
-
"type": "object",
10
-
"properties": {
11
-
"description": {
12
-
"type": "string",
13
-
"maxGraphemes": 256,
14
-
"description": "Free-form profile description."
15
-
},
16
-
"labels": {
17
-
"type": "ref",
18
-
"ref": "com.atproto.label.defs#selfLabels"
19
-
}
20
-
}
21
-
},
22
-
"description": "My profile."
23
-
}
24
-
}
25
-
}
-1
packages/cli/test/scenarios/parent-lexicons/project/app/package.json
-1
packages/cli/test/scenarios/parent-lexicons/project/app/package.json
···
1
-
{"name":"test-parent-lexicons","version":"1.0.0","type":"module"}
-27
packages/cli/test/scenarios/parent-lexicons/project/lexicons/com/atproto/label/defs.json
-27
packages/cli/test/scenarios/parent-lexicons/project/lexicons/com/atproto/label/defs.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.atproto.label.defs",
4
-
"defs": {
5
-
"selfLabels": {
6
-
"type": "object",
7
-
"properties": {
8
-
"values": {
9
-
"type": "array",
10
-
"items": { "type": "ref", "ref": "#selfLabel" },
11
-
"maxLength": 10
12
-
}
13
-
},
14
-
"required": ["values"]
15
-
},
16
-
"selfLabel": {
17
-
"type": "object",
18
-
"properties": {
19
-
"val": {
20
-
"type": "string",
21
-
"maxLength": 128
22
-
}
23
-
},
24
-
"required": ["val"]
25
-
}
26
-
}
27
-
}
-45
packages/cli/test/scenarios/parent-lexicons/test.ts
-45
packages/cli/test/scenarios/parent-lexicons/test.ts
···
1
-
import { join } from "path";
2
-
3
-
export async function run(project) {
4
-
const appDir = join(project.path, "app");
5
-
6
-
await project.init("com.myapp.*", { cwd: appDir });
7
-
8
-
// Verify init generated externals.tsp with existing external lexicons (before build)
9
-
const externals = await project.readFile("app/typelex/externals.tsp");
10
-
if (!externals.includes("com.atproto.label.defs")) {
11
-
throw new Error(
12
-
"externals.tsp should contain external lexicons after init",
13
-
);
14
-
}
15
-
16
-
// Verify init created a working project with default main.tsp
17
-
await project.runBuildScript({ cwd: appDir });
18
-
await project.compareTo("expected1");
19
-
20
-
// Edit main.tsp to add labels (simulates user editing the file)
21
-
await project.writeFile(
22
-
"app/typelex/main.tsp",
23
-
`import "@typelex/emitter";
24
-
import "./externals.tsp";
25
-
26
-
namespace com.myapp.example.profile {
27
-
/** My profile. */
28
-
@rec("literal:self")
29
-
model Main {
30
-
/** Free-form profile description.*/
31
-
@maxGraphemes(256)
32
-
description?: string;
33
-
labels?: com.atproto.label.defs.SelfLabels;
34
-
}
35
-
}
36
-
`,
37
-
);
38
-
39
-
await project.runBuildScript({ cwd: appDir });
40
-
await project.compareTo("expected2");
41
-
42
-
// Third build - verify idempotency
43
-
await project.runBuildScript({ cwd: appDir });
44
-
await project.compareTo("expected2");
45
-
}
-14
packages/cli/test/scenarios/reserved-keywords/expected/lexicons/app/bsky/feed/post/record.json
-14
packages/cli/test/scenarios/reserved-keywords/expected/lexicons/app/bsky/feed/post/record.json
-14
packages/cli/test/scenarios/reserved-keywords/expected/lexicons/com/atproto/server/defs.json
-14
packages/cli/test/scenarios/reserved-keywords/expected/lexicons/com/atproto/server/defs.json
-21
packages/cli/test/scenarios/reserved-keywords/expected/lexicons/pub/leaflet/example/profile.json
-21
packages/cli/test/scenarios/reserved-keywords/expected/lexicons/pub/leaflet/example/profile.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "pub.leaflet.example.profile",
4
-
"defs": {
5
-
"main": {
6
-
"type": "record",
7
-
"key": "literal:self",
8
-
"record": {
9
-
"type": "object",
10
-
"properties": {
11
-
"description": {
12
-
"type": "string",
13
-
"maxGraphemes": 256,
14
-
"description": "Free-form profile description."
15
-
}
16
-
}
17
-
},
18
-
"description": "My profile."
19
-
}
20
-
}
21
-
}
-7
packages/cli/test/scenarios/reserved-keywords/expected/package.json
-7
packages/cli/test/scenarios/reserved-keywords/expected/package.json
-14
packages/cli/test/scenarios/reserved-keywords/expected/typelex/externals.tsp
-14
packages/cli/test/scenarios/reserved-keywords/expected/typelex/externals.tsp
···
1
-
import "@typelex/emitter";
2
-
3
-
// Generated by typelex from ./lexicons (excluding pub.leaflet.*)
4
-
// This file is auto-generated. Do not edit manually.
5
-
6
-
@external
7
-
namespace app.bsky.feed.post.`record` {
8
-
model Main { }
9
-
}
10
-
11
-
@external
12
-
namespace com.atproto.server.defs {
13
-
model InviteCode { }
14
-
}
-12
packages/cli/test/scenarios/reserved-keywords/expected/typelex/main.tsp
-12
packages/cli/test/scenarios/reserved-keywords/expected/typelex/main.tsp
-14
packages/cli/test/scenarios/reserved-keywords/project/lexicons/app/bsky/feed/post/record.json
-14
packages/cli/test/scenarios/reserved-keywords/project/lexicons/app/bsky/feed/post/record.json
-14
packages/cli/test/scenarios/reserved-keywords/project/lexicons/com/atproto/server/defs.json
-14
packages/cli/test/scenarios/reserved-keywords/project/lexicons/com/atproto/server/defs.json
-4
packages/cli/test/scenarios/reserved-keywords/project/package.json
-4
packages/cli/test/scenarios/reserved-keywords/project/package.json
-10
packages/cli/test/scenarios/reserved-keywords/test.ts
-10
packages/cli/test/scenarios/reserved-keywords/test.ts
-1
packages/cli/test/scenarios/validation-errors/project/package.json
-1
packages/cli/test/scenarios/validation-errors/project/package.json
···
1
-
{"name":"test-validation","version":"1.0.0","type":"module"}
-35
packages/cli/test/scenarios/validation-errors/test.ts
-35
packages/cli/test/scenarios/validation-errors/test.ts
···
1
-
import { expect } from "vitest";
2
-
3
-
export async function run(project) {
4
-
// Test: Namespace must end with .*
5
-
let result = await project.runTypelex(["compile", "com.example"]);
6
-
expect(result.exitCode).not.toBe(0);
7
-
expect(result.output).toContain("namespace must end with .*");
8
-
9
-
// Test: Output path must end with 'lexicons'
10
-
await project.writeFile("typelex/main.tsp", `import "@typelex/emitter";\nimport "./externals.tsp";\n`);
11
-
await project.writeFile("typelex/externals.tsp", `import "@typelex/emitter";\n`);
12
-
13
-
result = await project.runTypelex(["compile", "com.test.*", "--out", "./output"]);
14
-
expect(result.exitCode).not.toBe(0);
15
-
expect(result.output).toContain("Output directory must end with 'lexicons'");
16
-
17
-
// Test: main.tsp must exist
18
-
await project.runCommand("rm", ["-rf", "typelex"]);
19
-
result = await project.runTypelex(["compile", "com.test.*"]);
20
-
expect(result.exitCode).not.toBe(0);
21
-
expect(result.output).toContain("main.tsp not found");
22
-
23
-
// Test: main.tsp first line must be import "@typelex/emitter"
24
-
await project.writeFile("typelex/main.tsp", `// wrong first line\nimport "./externals.tsp";\n`);
25
-
await project.writeFile("typelex/externals.tsp", `import "@typelex/emitter";\n`);
26
-
result = await project.runTypelex(["compile", "com.test.*"]);
27
-
expect(result.exitCode).not.toBe(0);
28
-
expect(result.output).toContain('main.tsp must start with: import "@typelex/emitter"');
29
-
30
-
// Test: main.tsp second line must be import "./externals.tsp"
31
-
await project.writeFile("typelex/main.tsp", `import "@typelex/emitter";\n// wrong second line\n`);
32
-
result = await project.runTypelex(["compile", "com.test.*"]);
33
-
expect(result.exitCode).not.toBe(0);
34
-
expect(result.output).toContain('Line 2 of main.tsp must be: import "./externals.tsp"');
35
-
}
-27
packages/cli/test/scenarios/with-external-lexicons/expected1/lexicons/com/atproto/label/defs.json
-27
packages/cli/test/scenarios/with-external-lexicons/expected1/lexicons/com/atproto/label/defs.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.atproto.label.defs",
4
-
"defs": {
5
-
"selfLabels": {
6
-
"type": "object",
7
-
"properties": {
8
-
"values": {
9
-
"type": "array",
10
-
"items": { "type": "ref", "ref": "#selfLabel" },
11
-
"maxLength": 10
12
-
}
13
-
},
14
-
"required": ["values"]
15
-
},
16
-
"selfLabel": {
17
-
"type": "object",
18
-
"properties": {
19
-
"val": {
20
-
"type": "string",
21
-
"maxLength": 128
22
-
}
23
-
},
24
-
"required": ["val"]
25
-
}
26
-
}
27
-
}
-21
packages/cli/test/scenarios/with-external-lexicons/expected1/lexicons/com/myapp/example/profile.json
-21
packages/cli/test/scenarios/with-external-lexicons/expected1/lexicons/com/myapp/example/profile.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.myapp.example.profile",
4
-
"defs": {
5
-
"main": {
6
-
"type": "record",
7
-
"key": "literal:self",
8
-
"record": {
9
-
"type": "object",
10
-
"properties": {
11
-
"description": {
12
-
"type": "string",
13
-
"maxGraphemes": 256,
14
-
"description": "Free-form profile description."
15
-
}
16
-
}
17
-
},
18
-
"description": "My profile."
19
-
}
20
-
}
21
-
}
-8
packages/cli/test/scenarios/with-external-lexicons/expected1/package.json
-8
packages/cli/test/scenarios/with-external-lexicons/expected1/package.json
-10
packages/cli/test/scenarios/with-external-lexicons/expected1/typelex/externals.tsp
-10
packages/cli/test/scenarios/with-external-lexicons/expected1/typelex/externals.tsp
-12
packages/cli/test/scenarios/with-external-lexicons/expected1/typelex/main.tsp
-12
packages/cli/test/scenarios/with-external-lexicons/expected1/typelex/main.tsp
-27
packages/cli/test/scenarios/with-external-lexicons/expected2/lexicons/com/atproto/label/defs.json
-27
packages/cli/test/scenarios/with-external-lexicons/expected2/lexicons/com/atproto/label/defs.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.atproto.label.defs",
4
-
"defs": {
5
-
"selfLabels": {
6
-
"type": "object",
7
-
"properties": {
8
-
"values": {
9
-
"type": "array",
10
-
"items": { "type": "ref", "ref": "#selfLabel" },
11
-
"maxLength": 10
12
-
}
13
-
},
14
-
"required": ["values"]
15
-
},
16
-
"selfLabel": {
17
-
"type": "object",
18
-
"properties": {
19
-
"val": {
20
-
"type": "string",
21
-
"maxLength": 128
22
-
}
23
-
},
24
-
"required": ["val"]
25
-
}
26
-
}
27
-
}
-30
packages/cli/test/scenarios/with-external-lexicons/expected2/lexicons/com/myapp/profile.json
-30
packages/cli/test/scenarios/with-external-lexicons/expected2/lexicons/com/myapp/profile.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.myapp.profile",
4
-
"defs": {
5
-
"main": {
6
-
"type": "object",
7
-
"properties": {
8
-
"did": {
9
-
"type": "string",
10
-
"format": "did"
11
-
},
12
-
"handle": {
13
-
"type": "string",
14
-
"format": "handle"
15
-
},
16
-
"displayName": {
17
-
"type": "string"
18
-
},
19
-
"labels": {
20
-
"type": "ref",
21
-
"ref": "com.atproto.label.defs#selfLabels"
22
-
}
23
-
},
24
-
"required": [
25
-
"did",
26
-
"handle"
27
-
]
28
-
}
29
-
}
30
-
}
-8
packages/cli/test/scenarios/with-external-lexicons/expected2/package.json
-8
packages/cli/test/scenarios/with-external-lexicons/expected2/package.json
-10
packages/cli/test/scenarios/with-external-lexicons/expected2/typelex/externals.tsp
-10
packages/cli/test/scenarios/with-external-lexicons/expected2/typelex/externals.tsp
-13
packages/cli/test/scenarios/with-external-lexicons/expected2/typelex/main.tsp
-13
packages/cli/test/scenarios/with-external-lexicons/expected2/typelex/main.tsp
···
1
-
import "@typelex/emitter";
2
-
import "./externals.tsp";
3
-
4
-
namespace com.myapp.profile {
5
-
model Main {
6
-
@required did: did;
7
-
@required handle: handle;
8
-
displayName?: string;
9
-
10
-
// Reference to external lexicon
11
-
labels?: com.atproto.label.defs.SelfLabels;
12
-
}
13
-
}
-27
packages/cli/test/scenarios/with-external-lexicons/project/lexicons/com/atproto/label/defs.json
-27
packages/cli/test/scenarios/with-external-lexicons/project/lexicons/com/atproto/label/defs.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.atproto.label.defs",
4
-
"defs": {
5
-
"selfLabels": {
6
-
"type": "object",
7
-
"properties": {
8
-
"values": {
9
-
"type": "array",
10
-
"items": { "type": "ref", "ref": "#selfLabel" },
11
-
"maxLength": 10
12
-
}
13
-
},
14
-
"required": ["values"]
15
-
},
16
-
"selfLabel": {
17
-
"type": "object",
18
-
"properties": {
19
-
"val": {
20
-
"type": "string",
21
-
"maxLength": 128
22
-
}
23
-
},
24
-
"required": ["val"]
25
-
}
26
-
}
27
-
}
-1
packages/cli/test/scenarios/with-external-lexicons/project/package.json
-1
packages/cli/test/scenarios/with-external-lexicons/project/package.json
···
1
-
{"name":"test-external-lexicons","version":"1.0.0","type":"module"}
-36
packages/cli/test/scenarios/with-external-lexicons/test.ts
-36
packages/cli/test/scenarios/with-external-lexicons/test.ts
···
1
-
export async function run(project) {
2
-
await project.init("com.myapp.*");
3
-
4
-
// Verify init generated externals.tsp with existing external lexicons (before build)
5
-
const externals = await project.readFile("typelex/externals.tsp");
6
-
if (!externals.includes("com.atproto.label.defs")) {
7
-
throw new Error("externals.tsp should contain external lexicons after init");
8
-
}
9
-
10
-
// Verify init created a working project with default main.tsp
11
-
await project.runBuildScript();
12
-
await project.compareTo("expected1");
13
-
14
-
// Edit main.tsp to add a profile schema (simulates user editing the file)
15
-
await project.writeFile("typelex/main.tsp", `import "@typelex/emitter";
16
-
import "./externals.tsp";
17
-
18
-
namespace com.myapp.profile {
19
-
model Main {
20
-
@required did: did;
21
-
@required handle: handle;
22
-
displayName?: string;
23
-
24
-
// Reference to external lexicon
25
-
labels?: com.atproto.label.defs.SelfLabels;
26
-
}
27
-
}
28
-
`);
29
-
30
-
await project.runBuildScript();
31
-
await project.compareTo("expected2");
32
-
33
-
// Third build - verify idempotency
34
-
await project.runBuildScript();
35
-
await project.compareTo("expected2");
36
-
}
-77
packages/cli/test/scenarios.test.ts
-77
packages/cli/test/scenarios.test.ts
···
1
-
import { describe, it, afterEach } from "vitest";
2
-
import { readdirSync, statSync, existsSync } from "fs";
3
-
import { readFile, readdir } from "fs/promises";
4
-
import { join, dirname, relative } from "path";
5
-
import { fileURLToPath } from "url";
6
-
import { TestProject } from "./helpers/test-project.js";
7
-
8
-
const __filename = fileURLToPath(import.meta.url);
9
-
const __dirname = dirname(__filename);
10
-
11
-
const SCENARIOS_DIR = join(__dirname, "scenarios");
12
-
13
-
async function copyDirRecursive(src: string, dest: string, project: TestProject) {
14
-
const { mkdir } = await import("fs/promises");
15
-
const entries = await readdir(src, { withFileTypes: true });
16
-
17
-
for (const entry of entries) {
18
-
const srcPath = join(src, entry.name);
19
-
const destPath = join(dest, entry.name);
20
-
21
-
if (entry.isDirectory()) {
22
-
// Create the directory in destination (even if empty)
23
-
const relativePath = relative(project.path, destPath);
24
-
await mkdir(join(project.path, relativePath), { recursive: true });
25
-
await copyDirRecursive(srcPath, destPath, project);
26
-
} else {
27
-
const content = await readFile(srcPath, "utf-8");
28
-
const relativePath = relative(project.path, destPath);
29
-
await project.writeFile(relativePath, content);
30
-
}
31
-
}
32
-
}
33
-
34
-
describe("CLI scenarios", () => {
35
-
let project: TestProject;
36
-
37
-
afterEach(async () => {
38
-
if (project) {
39
-
await project.cleanup();
40
-
}
41
-
});
42
-
43
-
// Auto-discover scenario directories
44
-
const scenarios = readdirSync(SCENARIOS_DIR)
45
-
.map((name) => join(SCENARIOS_DIR, name))
46
-
.filter((path) => statSync(path).isDirectory())
47
-
.filter((path) => existsSync(join(path, "test.ts")));
48
-
49
-
for (const scenarioPath of scenarios) {
50
-
const scenarioName = scenarioPath.split("/").pop()!;
51
-
52
-
it(scenarioName, async () => {
53
-
// Load test module to get config
54
-
const testModule = await import(join(scenarioPath, "test.ts"));
55
-
if (typeof testModule.run !== "function") {
56
-
throw new Error(`${scenarioName}/test.ts must export a run() function`);
57
-
}
58
-
59
-
// Create project
60
-
project = await TestProject.create({
61
-
packageManager: testModule.packageManager || "npm",
62
-
});
63
-
project.scenarioPath = scenarioPath;
64
-
65
-
// Copy project files
66
-
const projectDir = join(scenarioPath, "project");
67
-
if (existsSync(projectDir)) {
68
-
await copyDirRecursive(projectDir, project.path, project);
69
-
}
70
-
71
-
await project.mockInstall();
72
-
73
-
// Run the scenario
74
-
await testModule.run(project);
75
-
});
76
-
}
77
-
});
-10
packages/cli/vitest.config.ts
-10
packages/cli/vitest.config.ts
-65
packages/emitter/lib/decorators.tsp
-65
packages/emitter/lib/decorators.tsp
···
163
163
extern dec errors(target: unknown, ...errors: unknown[]);
164
164
165
165
/**
166
-
* Forces a model, scalar, or union to be inlined instead of creating a standalone def.
167
-
* By default, named types create separate definitions with references.
168
-
* Use @inline to expand the type inline at each usage site.
169
-
*
170
-
* @example Inline model
171
-
* ```typespec
172
-
* @inline
173
-
* model Caption {
174
-
* text?: string;
175
-
* }
176
-
*
177
-
* model Main {
178
-
* captions?: Caption[]; // Expands inline, no separate "caption" def
179
-
* }
180
-
* ```
181
-
*
182
-
* @example Inline scalar
183
-
* ```typespec
184
-
* @inline
185
-
* @maxLength(50)
186
-
* scalar Handle extends string;
187
-
*
188
-
* model Main {
189
-
* handle?: Handle; // Expands to { type: "string", maxLength: 50 }
190
-
* }
191
-
* ```
192
-
*
193
-
* @example Inline union
194
-
* ```typespec
195
-
* @inline
196
-
* union Status { "active", "inactive", string }
197
-
*
198
-
* model Main {
199
-
* status?: Status; // Expands inline with knownValues
200
-
* }
201
-
* ```
202
-
*/
203
-
extern dec inline(target: unknown);
204
-
205
-
/**
206
-
* Specifies a default value for a scalar or union definition.
207
-
* Only valid on standalone scalar or union defs (not @inline).
208
-
* The value must match the underlying type (string, integer, or boolean).
209
-
* For unions with token refs, you can pass a model reference directly.
210
-
*
211
-
* @param value - The default value (literal or model reference for tokens)
212
-
*
213
-
* @example Scalar with default
214
-
* ```typespec
215
-
* @default("standard")
216
-
* scalar Mode extends string;
217
-
* ```
218
-
*
219
-
* @example Union with token default
220
-
* ```typespec
221
-
* @default(Inperson)
222
-
* union EventMode { Hybrid, Inperson, Virtual, string }
223
-
*
224
-
* @token
225
-
* model Inperson {}
226
-
* ```
227
-
*/
228
-
extern dec `default`(target: unknown, value: unknown);
229
-
230
-
/**
231
166
* Marks a namespace as external, preventing it from emitting JSON output.
232
167
* This decorator can only be applied to namespaces.
233
168
* Useful for importing definitions from other lexicons without re-emitting them.
+1
-1
packages/emitter/package.json
+1
-1
packages/emitter/package.json
-17
packages/emitter/src/decorators.ts
-17
packages/emitter/src/decorators.ts
···
25
25
const maxBytesKey = Symbol("maxBytes");
26
26
const minBytesKey = Symbol("minBytes");
27
27
const externalKey = Symbol("external");
28
-
const defaultKey = Symbol("default");
29
28
30
29
/**
31
30
* @maxBytes decorator for maximum length of bytes type
···
295
294
296
295
export function isReadOnly(program: Program, target: Type): boolean {
297
296
return program.stateSet(readOnlyKey).has(target);
298
-
}
299
-
300
-
/**
301
-
* @default decorator for setting default values on scalars and unions
302
-
* The value can be a literal (string, number, boolean) or a model reference for tokens
303
-
*/
304
-
export function $default(context: DecoratorContext, target: Type, value: any) {
305
-
// Just store the raw value - let the emitter handle unwrapping and validation
306
-
context.program.stateMap(defaultKey).set(target, value);
307
-
}
308
-
309
-
export function getDefault(
310
-
program: Program,
311
-
target: Type,
312
-
): any | undefined {
313
-
return program.stateMap(defaultKey).get(target);
314
297
}
315
298
316
299
/**
+22
-274
packages/emitter/src/emitter.ts
+22
-274
packages/emitter/src/emitter.ts
···
68
68
getMaxBytes,
69
69
getMinBytes,
70
70
isExternal,
71
-
getDefault,
72
71
} from "./decorators.js";
73
72
74
73
export interface EmitterOptions {
···
98
97
private program: Program,
99
98
private options: EmitterOptions,
100
99
) {}
101
-
102
-
/**
103
-
* Process the raw default value from the decorator, unwrapping TypeSpec value objects
104
-
* and returning either a primitive (string, number, boolean) or a Type (for model references)
105
-
*/
106
-
private processDefaultValue(rawValue: any): string | number | boolean | Type | undefined {
107
-
if (rawValue === undefined) return undefined;
108
-
109
-
// TypeSpec may wrap values - check if this is a value object first
110
-
if (rawValue && typeof rawValue === 'object' && rawValue.valueKind) {
111
-
if (rawValue.valueKind === "StringValue") {
112
-
return rawValue.value;
113
-
} else if (rawValue.valueKind === "NumericValue" || rawValue.valueKind === "NumberValue") {
114
-
return rawValue.value;
115
-
} else if (rawValue.valueKind === "BooleanValue") {
116
-
return rawValue.value;
117
-
}
118
-
return undefined; // Unsupported valueKind
119
-
}
120
-
121
-
// Check if it's a Type object (Model, String, Number, Boolean literals)
122
-
if (rawValue && typeof rawValue === 'object' && rawValue.kind) {
123
-
if (rawValue.kind === "String") {
124
-
return (rawValue as StringLiteral).value;
125
-
} else if (rawValue.kind === "Number") {
126
-
return (rawValue as NumericLiteral).value;
127
-
} else if (rawValue.kind === "Boolean") {
128
-
return (rawValue as BooleanLiteral).value;
129
-
} else if (rawValue.kind === "Model") {
130
-
// Return the model itself for token references
131
-
return rawValue as Model;
132
-
}
133
-
return undefined; // Unsupported kind
134
-
}
135
-
136
-
// Direct primitive value
137
-
if (typeof rawValue === 'string' || typeof rawValue === 'number' || typeof rawValue === 'boolean') {
138
-
return rawValue;
139
-
}
140
-
141
-
return undefined;
142
-
}
143
100
144
101
async emit() {
145
102
const globalNs = this.program.getGlobalNamespaceType();
···
399
356
}
400
357
401
358
private addScalarToDefs(lexicon: LexiconDoc, scalar: Scalar) {
402
-
// Only skip if the scalar itself is in TypeSpec namespace (built-in scalars)
403
359
if (scalar.namespace?.name === "TypeSpec") return;
360
+
if (scalar.baseScalar?.namespace?.name === "TypeSpec") return;
404
361
405
362
// Skip @inline scalars - they should be inlined, not defined separately
406
363
if (isInline(this.program, scalar)) {
···
411
368
const scalarDef = this.scalarToLexiconPrimitive(scalar, undefined);
412
369
if (scalarDef) {
413
370
const description = getDoc(this.program, scalar);
414
-
415
-
// Apply @default decorator if present
416
-
const rawDefault = getDefault(this.program, scalar);
417
-
const defaultValue = this.processDefaultValue(rawDefault);
418
-
let defWithDefault: any = { ...scalarDef };
419
-
420
-
if (defaultValue !== undefined) {
421
-
// Check if it's a Type (model reference for tokens)
422
-
if (typeof defaultValue === 'object' && 'kind' in defaultValue) {
423
-
// For model references, we need to resolve to NSID
424
-
// This shouldn't happen for scalars, only unions support token refs
425
-
this.program.reportDiagnostic({
426
-
code: "invalid-default-on-scalar",
427
-
severity: "error",
428
-
message: "@default on scalars must be a literal value (string, number, or boolean), not a model reference",
429
-
target: scalar,
430
-
});
431
-
} else {
432
-
// Validate that the default value matches the type
433
-
this.assertValidValueForType(scalarDef.type, defaultValue, scalar);
434
-
defWithDefault = { ...defWithDefault, default: defaultValue };
435
-
}
436
-
}
437
-
438
-
// Apply integer constraints for standalone scalar defs
439
-
if (scalarDef.type === "integer") {
440
-
const minValue = getMinValue(this.program, scalar);
441
-
if (minValue !== undefined) {
442
-
(defWithDefault as any).minimum = minValue;
443
-
}
444
-
const maxValue = getMaxValue(this.program, scalar);
445
-
if (maxValue !== undefined) {
446
-
(defWithDefault as any).maximum = maxValue;
447
-
}
448
-
}
449
-
450
-
lexicon.defs[defName] = { ...defWithDefault, description } as LexUserType;
371
+
lexicon.defs[defName] = { ...scalarDef, description } as LexUserType;
451
372
}
452
373
}
453
374
···
470
391
if (unionDef.type === "string" && (unionDef.knownValues || unionDef.enum)) {
471
392
const defName = name.charAt(0).toLowerCase() + name.slice(1);
472
393
const description = getDoc(this.program, union);
473
-
474
-
// Apply @default decorator if present
475
-
const rawDefault = getDefault(this.program, union);
476
-
const defaultValue = this.processDefaultValue(rawDefault);
477
-
let defWithDefault: any = { ...unionDef };
478
-
479
-
if (defaultValue !== undefined) {
480
-
// Check if it's a Type (model reference for tokens)
481
-
if (typeof defaultValue === 'object' && 'kind' in defaultValue) {
482
-
// Resolve the model reference to its NSID
483
-
const tokenModel = defaultValue as Model;
484
-
const tokenRef = this.getModelReference(tokenModel, true); // fullyQualified=true
485
-
if (tokenRef) {
486
-
defWithDefault = { ...defWithDefault, default: tokenRef };
487
-
} else {
488
-
this.program.reportDiagnostic({
489
-
code: "invalid-default-token",
490
-
severity: "error",
491
-
message: "@default value must be a valid token model reference",
492
-
target: union,
493
-
});
494
-
}
495
-
} else {
496
-
// Literal value - validate it matches the union type
497
-
if (typeof defaultValue !== "string") {
498
-
this.program.reportDiagnostic({
499
-
code: "invalid-default-value-type",
500
-
severity: "error",
501
-
message: `Default value type mismatch: expected string, got ${typeof defaultValue}`,
502
-
target: union,
503
-
});
504
-
} else {
505
-
defWithDefault = { ...defWithDefault, default: defaultValue };
506
-
}
507
-
}
508
-
}
509
-
510
-
lexicon.defs[defName] = { ...defWithDefault, description };
394
+
lexicon.defs[defName] = { ...unionDef, description };
511
395
} else if (unionDef.type === "union") {
512
396
this.program.reportDiagnostic({
513
397
code: "union-refs-not-allowed-as-def",
···
517
401
`Use @inline to inline them at usage sites, use @token models for known values, or use string literals.`,
518
402
target: union,
519
403
});
520
-
} else if (unionDef.type === "integer" && (unionDef as any).enum) {
521
-
// Integer enums can also be defs
522
-
const defName = name.charAt(0).toLowerCase() + name.slice(1);
523
-
const description = getDoc(this.program, union);
524
-
525
-
// Apply @default decorator if present
526
-
const rawDefault = getDefault(this.program, union);
527
-
const defaultValue = this.processDefaultValue(rawDefault);
528
-
let defWithDefault = { ...unionDef };
529
-
530
-
if (defaultValue !== undefined) {
531
-
if (typeof defaultValue === "number") {
532
-
defWithDefault = { ...defWithDefault, default: defaultValue };
533
-
} else {
534
-
this.program.reportDiagnostic({
535
-
code: "invalid-default-value-type",
536
-
severity: "error",
537
-
message: `Default value type mismatch: expected integer, got ${typeof defaultValue}`,
538
-
target: union,
539
-
});
540
-
}
541
-
}
542
-
543
-
lexicon.defs[defName] = { ...defWithDefault, description };
544
404
}
545
405
}
546
406
···
641
501
isClosed(this.program, unionType)
642
502
) {
643
503
const propDesc = prop ? getDoc(this.program, prop) : undefined;
644
-
645
-
// Check for default value: property default takes precedence, then union's @default
646
-
let defaultValue: string | number | boolean | undefined;
647
-
if (prop?.defaultValue !== undefined) {
648
-
defaultValue = serializeValueAsJson(this.program, prop.defaultValue, prop) as any;
649
-
} else {
650
-
// If no property default, check union's @default decorator
651
-
const rawUnionDefault = getDefault(this.program, unionType);
652
-
const unionDefault = this.processDefaultValue(rawUnionDefault);
653
-
if (unionDefault !== undefined && typeof unionDefault === 'number') {
654
-
defaultValue = unionDefault;
655
-
}
656
-
}
657
-
504
+
const defaultValue = prop?.defaultValue
505
+
? serializeValueAsJson(this.program, prop.defaultValue, prop)
506
+
: undefined;
658
507
return {
659
508
type: "integer",
660
509
enum: variants.numericLiterals,
···
677
526
) {
678
527
const isClosedUnion = isClosed(this.program, unionType);
679
528
const propDesc = prop ? getDoc(this.program, prop) : undefined;
680
-
681
-
// Check for default value: property default takes precedence, then union's @default
682
-
let defaultValue: string | number | boolean | undefined;
683
-
if (prop?.defaultValue !== undefined) {
684
-
defaultValue = serializeValueAsJson(this.program, prop.defaultValue, prop) as any;
685
-
} else {
686
-
// If no property default, check union's @default decorator
687
-
const rawUnionDefault = getDefault(this.program, unionType);
688
-
const unionDefault = this.processDefaultValue(rawUnionDefault);
689
-
690
-
if (unionDefault !== undefined) {
691
-
// Check if it's a Type (model reference for tokens)
692
-
if (typeof unionDefault === 'object' && 'kind' in unionDefault && unionDefault.kind === 'Model') {
693
-
// Resolve the model reference to its NSID
694
-
const tokenModel = unionDefault as Model;
695
-
const tokenRef = this.getModelReference(tokenModel, true); // fullyQualified=true
696
-
if (tokenRef) {
697
-
defaultValue = tokenRef;
698
-
}
699
-
} else if (typeof unionDefault === 'string') {
700
-
defaultValue = unionDefault;
701
-
}
702
-
}
703
-
}
704
-
529
+
const defaultValue = prop?.defaultValue
530
+
? serializeValueAsJson(this.program, prop.defaultValue, prop)
531
+
: undefined;
705
532
const maxLength = getMaxLength(this.program, unionType);
706
533
const minLength = getMinLength(this.program, unionType);
707
534
const maxGraphemes = getMaxGraphemes(this.program, unionType);
···
1331
1158
prop?: ModelProperty,
1332
1159
propDesc?: string,
1333
1160
): LexObjectProperty | null {
1334
-
// Check if this scalar should be referenced instead of inlined
1335
-
const scalarRef = this.getScalarReference(scalar);
1336
-
if (scalarRef) {
1337
-
// Check if property has a default value that would conflict with the scalar's @default
1338
-
if (prop?.defaultValue !== undefined) {
1339
-
const scalarDefaultRaw = getDefault(this.program, scalar);
1340
-
const scalarDefault = this.processDefaultValue(scalarDefaultRaw);
1341
-
const propDefault = serializeValueAsJson(this.program, prop.defaultValue, prop);
1342
-
1343
-
// If the scalar has a different default, or if the property has a default but the scalar doesn't, error
1344
-
if (scalarDefault !== propDefault) {
1345
-
this.program.reportDiagnostic({
1346
-
code: "conflicting-defaults",
1347
-
severity: "error",
1348
-
message: scalarDefault !== undefined
1349
-
? `Property default value conflicts with scalar's @default decorator. The scalar "${scalar.name}" has @default(${JSON.stringify(scalarDefault)}) but property has default value ${JSON.stringify(propDefault)}. Either remove the property default, mark the scalar @inline, or make the defaults match.`
1350
-
: `Property has a default value but the referenced scalar "${scalar.name}" does not. Either add @default to the scalar, mark it @inline to allow property-level defaults, or remove the property default.`,
1351
-
target: prop,
1352
-
});
1353
-
}
1354
-
}
1355
-
1356
-
return { type: "ref" as const, ref: scalarRef, description: propDesc };
1357
-
}
1358
-
1359
-
// Inline the scalar
1360
1161
const primitive = this.scalarToLexiconPrimitive(scalar, prop);
1361
1162
if (!primitive) return null;
1362
1163
···
1445
1246
if (!isDefining) {
1446
1247
const unionRef = this.getUnionReference(unionType);
1447
1248
if (unionRef) {
1448
-
// Check if property has a default value that would conflict with the union's @default
1449
-
if (prop?.defaultValue !== undefined) {
1450
-
const unionDefaultRaw = getDefault(this.program, unionType);
1451
-
const unionDefault = this.processDefaultValue(unionDefaultRaw);
1452
-
const propDefault = serializeValueAsJson(this.program, prop.defaultValue, prop);
1453
-
1454
-
// For union defaults that are model references, we need to resolve them for comparison
1455
-
let resolvedUnionDefault: string | number | boolean | undefined = unionDefault as any;
1456
-
if (unionDefault && typeof unionDefault === 'object' && 'kind' in unionDefault && unionDefault.kind === 'Model') {
1457
-
const ref = this.getModelReference(unionDefault as Model, true);
1458
-
resolvedUnionDefault = ref || undefined;
1459
-
}
1460
-
1461
-
// If the union has a different default, or if the property has a default but the union doesn't, error
1462
-
if (resolvedUnionDefault !== propDefault) {
1463
-
this.program.reportDiagnostic({
1464
-
code: "conflicting-defaults",
1465
-
severity: "error",
1466
-
message: unionDefault !== undefined
1467
-
? `Property default value conflicts with union's @default decorator. The union "${unionType.name}" has @default(${JSON.stringify(resolvedUnionDefault)}) but property has default value ${JSON.stringify(propDefault)}. Either remove the property default, mark the union @inline, or make the defaults match.`
1468
-
: `Property has a default value but the referenced union "${unionType.name}" does not. Either add @default to the union, mark it @inline to allow property-level defaults, or remove the property default.`,
1469
-
target: prop,
1470
-
});
1471
-
}
1472
-
}
1473
-
1474
1249
return { type: "ref" as const, ref: unionRef, description: propDesc };
1475
1250
}
1476
1251
}
···
1496
1271
// Check if this scalar (or its base) is bytes type
1497
1272
if (this.isScalarOfType(scalar, "bytes")) {
1498
1273
const byteDef: LexBytes = { type: "bytes" };
1274
+
const target = prop || scalar;
1499
1275
1500
-
// Check scalar first for its own constraints, then property overrides
1501
-
const minLength = getMinBytes(this.program, scalar) ?? (prop ? getMinBytes(this.program, prop) : undefined);
1276
+
const minLength = getMinBytes(this.program, target);
1502
1277
if (minLength !== undefined) {
1503
1278
byteDef.minLength = minLength;
1504
1279
}
1505
1280
1506
-
const maxLength = getMaxBytes(this.program, scalar) ?? (prop ? getMaxBytes(this.program, prop) : undefined);
1281
+
const maxLength = getMaxBytes(this.program, target);
1507
1282
if (maxLength !== undefined) {
1508
1283
byteDef.maxLength = maxLength;
1509
1284
}
···
1535
1310
1536
1311
// Apply string constraints
1537
1312
if (primitive.type === "string") {
1538
-
// Check scalar first for its own constraints, then property overrides
1539
-
const maxLength = getMaxLength(this.program, scalar) ?? (prop ? getMaxLength(this.program, prop) : undefined);
1313
+
const target = prop || scalar;
1314
+
const maxLength = getMaxLength(this.program, target);
1540
1315
if (maxLength !== undefined) {
1541
1316
primitive.maxLength = maxLength;
1542
1317
}
1543
-
const minLength = getMinLength(this.program, scalar) ?? (prop ? getMinLength(this.program, prop) : undefined);
1318
+
const minLength = getMinLength(this.program, target);
1544
1319
if (minLength !== undefined) {
1545
1320
primitive.minLength = minLength;
1546
1321
}
1547
-
const maxGraphemes = getMaxGraphemes(this.program, scalar) ?? (prop ? getMaxGraphemes(this.program, prop) : undefined);
1322
+
const maxGraphemes = getMaxGraphemes(this.program, target);
1548
1323
if (maxGraphemes !== undefined) {
1549
1324
primitive.maxGraphemes = maxGraphemes;
1550
1325
}
1551
-
const minGraphemes = getMinGraphemes(this.program, scalar) ?? (prop ? getMinGraphemes(this.program, prop) : undefined);
1326
+
const minGraphemes = getMinGraphemes(this.program, target);
1552
1327
if (minGraphemes !== undefined) {
1553
1328
primitive.minGraphemes = minGraphemes;
1554
1329
}
1555
1330
}
1556
1331
1557
1332
// Apply numeric constraints
1558
-
if (primitive.type === "integer") {
1559
-
// Check scalar first for its own constraints, then property overrides
1560
-
const minValue = getMinValue(this.program, scalar) ?? (prop ? getMinValue(this.program, prop) : undefined);
1333
+
if (prop && primitive.type === "integer") {
1334
+
const minValue = getMinValue(this.program, prop);
1561
1335
if (minValue !== undefined) {
1562
1336
primitive.minimum = minValue;
1563
1337
}
1564
-
const maxValue = getMaxValue(this.program, scalar) ?? (prop ? getMaxValue(this.program, prop) : undefined);
1338
+
const maxValue = getMaxValue(this.program, prop);
1565
1339
if (maxValue !== undefined) {
1566
1340
primitive.maximum = maxValue;
1567
1341
}
···
1657
1431
private assertValidValueForType(
1658
1432
primitiveType: string,
1659
1433
value: unknown,
1660
-
target: ModelProperty | Scalar | Union,
1434
+
prop: ModelProperty,
1661
1435
): void {
1662
1436
const valid =
1663
1437
(primitiveType === "boolean" && typeof value === "boolean") ||
···
1668
1442
code: "invalid-default-value-type",
1669
1443
severity: "error",
1670
1444
message: `Default value type mismatch: expected ${primitiveType}, got ${typeof value}`,
1671
-
target: target,
1445
+
target: prop,
1672
1446
});
1673
1447
}
1674
1448
}
···
1733
1507
1734
1508
private getUnionReference(union: Union): string | null {
1735
1509
return this.getReference(union, union.name, union.namespace);
1736
-
}
1737
-
1738
-
private getScalarReference(scalar: Scalar): string | null {
1739
-
// Built-in TypeSpec scalars (string, integer, boolean themselves) should not be referenced
1740
-
if (scalar.namespace?.name === "TypeSpec") return null;
1741
-
1742
-
// @inline scalars should be inlined, not referenced
1743
-
if (isInline(this.program, scalar)) return null;
1744
-
1745
-
// Scalars without names or namespace can't be referenced
1746
-
if (!scalar.name || !scalar.namespace) return null;
1747
-
1748
-
const defName = scalar.name.charAt(0).toLowerCase() + scalar.name.slice(1);
1749
-
const namespaceName = getNamespaceFullName(scalar.namespace);
1750
-
if (!namespaceName) return null;
1751
-
1752
-
// Local reference (same namespace) - use short ref
1753
-
if (
1754
-
this.currentLexiconId === namespaceName ||
1755
-
this.currentLexiconId === `${namespaceName}.defs`
1756
-
) {
1757
-
return `#${defName}`;
1758
-
}
1759
-
1760
-
// Cross-namespace reference
1761
-
return `${namespaceName}#${defName}`;
1762
1510
}
1763
1511
1764
1512
private modelToLexiconArray(
-2
packages/emitter/src/tsp-index.ts
-2
packages/emitter/src/tsp-index.ts
-2
packages/emitter/test/integration/atproto/input/app/bsky/actor/defs.tsp
-2
packages/emitter/test/integration/atproto/input/app/bsky/actor/defs.tsp
···
232
232
prioritizeFollowedUsers?: boolean;
233
233
}
234
234
235
-
@inline
236
235
@maxLength(640)
237
236
@maxGraphemes(64)
238
237
scalar InterestTag extends string;
···
293
292
@required did: did;
294
293
}
295
294
296
-
@inline
297
295
@maxLength(100)
298
296
scalar NudgeToken extends string;
299
297
-14
packages/emitter/test/integration/lexicon-examples/input/community/lexicon/bookmarks/bookmark.tsp
-14
packages/emitter/test/integration/lexicon-examples/input/community/lexicon/bookmarks/bookmark.tsp
···
1
-
import "@typelex/emitter";
2
-
3
-
namespace community.lexicon.bookmarks.bookmark {
4
-
/** Record bookmarking a link to come back to later. */
5
-
@rec("tid")
6
-
model Main {
7
-
@required subject: uri;
8
-
9
-
@required createdAt: datetime;
10
-
11
-
/** Tags for content the bookmark may be related to, for example 'news' or 'funny videos' */
12
-
tags?: string[];
13
-
}
14
-
}
-27
packages/emitter/test/integration/lexicon-examples/input/community/lexicon/bookmarks/getActorBookmarks.tsp
-27
packages/emitter/test/integration/lexicon-examples/input/community/lexicon/bookmarks/getActorBookmarks.tsp
···
1
-
import "@typelex/emitter";
2
-
3
-
namespace community.lexicon.bookmarks.getActorBookmarks {
4
-
/** Get a list of bookmarks by actor. Optionally add a list of tags to include, default will be all bookmarks. Requires auth, actor must be the requesting account. */
5
-
@query
6
-
op main(
7
-
tags?: string[],
8
-
9
-
@minValue(1)
10
-
@maxValue(100)
11
-
limit?: int32 = 50,
12
-
13
-
cursor?: string
14
-
): {
15
-
@required
16
-
bookmarks: community.lexicon.bookmarks.bookmark.Main[];
17
-
18
-
cursor?: string;
19
-
};
20
-
}
21
-
22
-
// --- Externals ---
23
-
24
-
@external
25
-
namespace community.lexicon.bookmarks.bookmark {
26
-
model Main { }
27
-
}
-125
packages/emitter/test/integration/lexicon-examples/input/community/lexicon/calendar/event.tsp
-125
packages/emitter/test/integration/lexicon-examples/input/community/lexicon/calendar/event.tsp
···
1
-
import "@typelex/emitter";
2
-
3
-
namespace community.lexicon.calendar.event {
4
-
/** A calendar event. */
5
-
@rec("tid")
6
-
model Main {
7
-
/** The name of the event. */
8
-
@required
9
-
name: string;
10
-
11
-
/** The description of the event. */
12
-
description?: string;
13
-
14
-
/** Client-declared timestamp when the event was created. */
15
-
@required
16
-
createdAt: datetime;
17
-
18
-
/** Client-declared timestamp when the event starts. */
19
-
startsAt?: datetime;
20
-
21
-
/** Client-declared timestamp when the event ends. */
22
-
endsAt?: datetime;
23
-
24
-
/** The attendance mode of the event. */
25
-
mode?: Mode;
26
-
27
-
/** The status of the event. */
28
-
status?: Status;
29
-
30
-
/** The locations where the event takes place. */
31
-
locations?: (
32
-
| Uri
33
-
| community.lexicon.location.address.Main
34
-
| community.lexicon.location.fsq.Main
35
-
| community.lexicon.location.geo.Main
36
-
| community.lexicon.location.hthree.Main
37
-
)[];
38
-
39
-
/** URIs associated with the event. */
40
-
uris?: Uri[];
41
-
}
42
-
43
-
/** The mode of the event. */
44
-
@default(Inperson)
45
-
union Mode {
46
-
Hybrid,
47
-
Inperson,
48
-
Virtual,
49
-
string,
50
-
}
51
-
52
-
/** A virtual event that takes place online. */
53
-
@token
54
-
model Virtual {}
55
-
56
-
/** An in-person event that takes place offline. */
57
-
@token
58
-
model Inperson {}
59
-
60
-
/** A hybrid event that takes place both online and offline. */
61
-
@token
62
-
model Hybrid {}
63
-
64
-
/** The status of the event. */
65
-
@default(Scheduled)
66
-
union Status {
67
-
Cancelled,
68
-
Planned,
69
-
Postponed,
70
-
Rescheduled,
71
-
Scheduled,
72
-
string,
73
-
}
74
-
75
-
/** The event has been created, but not finalized. */
76
-
@token
77
-
model Planned {}
78
-
79
-
/** The event has been created and scheduled. */
80
-
@token
81
-
model Scheduled {}
82
-
83
-
/** The event has been rescheduled. */
84
-
@token
85
-
model Rescheduled {}
86
-
87
-
/** The event has been cancelled. */
88
-
@token
89
-
model Cancelled {}
90
-
91
-
/** The event has been postponed and a new start date has not been set. */
92
-
@token
93
-
model Postponed {}
94
-
95
-
/** A URI associated with the event. */
96
-
model Uri {
97
-
@required
98
-
uri: uri;
99
-
100
-
/** The display name of the URI. */
101
-
name?: string;
102
-
}
103
-
}
104
-
105
-
// --- Externals ---
106
-
107
-
@external
108
-
namespace community.lexicon.location.address {
109
-
model Main {}
110
-
}
111
-
112
-
@external
113
-
namespace community.lexicon.location.fsq {
114
-
model Main {}
115
-
}
116
-
117
-
@external
118
-
namespace community.lexicon.location.geo {
119
-
model Main {}
120
-
}
121
-
122
-
@external
123
-
namespace community.lexicon.location.hthree {
124
-
model Main {}
125
-
}
-41
packages/emitter/test/integration/lexicon-examples/input/community/lexicon/calendar/rsvp.tsp
-41
packages/emitter/test/integration/lexicon-examples/input/community/lexicon/calendar/rsvp.tsp
···
1
-
import "@typelex/emitter";
2
-
3
-
namespace community.lexicon.calendar.rsvp {
4
-
/** An RSVP for an event. */
5
-
@rec("tid")
6
-
model Main {
7
-
@required
8
-
subject: `com`.atproto.repo.strongRef.Main;
9
-
10
-
@required
11
-
status: Status;
12
-
}
13
-
14
-
@inline
15
-
@default(Going)
16
-
union Status {
17
-
Interested,
18
-
Going,
19
-
Notgoing,
20
-
string,
21
-
}
22
-
23
-
/** Interested in the event */
24
-
@token
25
-
model Interested {}
26
-
27
-
/** Going to the event */
28
-
@token
29
-
model Going {}
30
-
31
-
/** Not going to the event */
32
-
@token
33
-
model Notgoing {}
34
-
}
35
-
36
-
// --- Externals ---
37
-
38
-
@external
39
-
namespace `com`.atproto.repo.strongRef {
40
-
model Main {}
41
-
}
-20
packages/emitter/test/integration/lexicon-examples/input/community/lexicon/interaction/like.tsp
-20
packages/emitter/test/integration/lexicon-examples/input/community/lexicon/interaction/like.tsp
···
1
-
import "@typelex/emitter";
2
-
3
-
namespace community.lexicon.interaction.like {
4
-
/** A 'like' interaction with another AT Protocol record. */
5
-
@rec("tid")
6
-
model Main {
7
-
@required
8
-
subject: `com`.atproto.repo.strongRef.Main;
9
-
10
-
@required
11
-
createdAt: datetime;
12
-
}
13
-
}
14
-
15
-
// --- Externals ---
16
-
17
-
@external
18
-
namespace `com`.atproto.repo.strongRef {
19
-
model Main { }
20
-
}
-27
packages/emitter/test/integration/lexicon-examples/input/community/lexicon/location/address.tsp
-27
packages/emitter/test/integration/lexicon-examples/input/community/lexicon/location/address.tsp
···
1
-
import "@typelex/emitter";
2
-
3
-
namespace community.lexicon.location.address {
4
-
/** A physical location in the form of a street address. */
5
-
model Main {
6
-
/** The ISO 3166 country code. Preferably the 2-letter code. */
7
-
@required
8
-
@minLength(2)
9
-
@maxLength(10)
10
-
country: string;
11
-
12
-
/** The postal code of the location. */
13
-
postalCode?: string;
14
-
15
-
/** The administrative region of the country. For example, a state in the USA. */
16
-
region?: string;
17
-
18
-
/** The locality of the region. For example, a city in the USA. */
19
-
locality?: string;
20
-
21
-
/** The street address. */
22
-
street?: string;
23
-
24
-
/** The name of the location. */
25
-
name?: string;
26
-
}
27
-
}
-15
packages/emitter/test/integration/lexicon-examples/input/community/lexicon/location/fsq.tsp
-15
packages/emitter/test/integration/lexicon-examples/input/community/lexicon/location/fsq.tsp
···
1
-
import "@typelex/emitter";
2
-
3
-
namespace community.lexicon.location.fsq {
4
-
/** A physical location contained in the Foursquare Open Source Places dataset. */
5
-
model Main {
6
-
/** The unique identifier of a Foursquare POI. */
7
-
@required fsq_place_id: string;
8
-
9
-
latitude?: string;
10
-
longitude?: string;
11
-
12
-
/** The name of the location. */
13
-
name?: string;
14
-
}
15
-
}
-12
packages/emitter/test/integration/lexicon-examples/input/community/lexicon/location/geo.tsp
-12
packages/emitter/test/integration/lexicon-examples/input/community/lexicon/location/geo.tsp
···
1
-
import "@typelex/emitter";
2
-
3
-
namespace community.lexicon.location.geo {
4
-
/** A physical location in the form of a WGS84 coordinate. */
5
-
model Main {
6
-
@required latitude: string;
7
-
@required longitude: string;
8
-
altitude?: string;
9
-
/** The name of the location. */
10
-
name?: string;
11
-
}
12
-
}
-12
packages/emitter/test/integration/lexicon-examples/input/community/lexicon/location/hthree.tsp
-12
packages/emitter/test/integration/lexicon-examples/input/community/lexicon/location/hthree.tsp
···
1
-
import "@typelex/emitter";
2
-
3
-
namespace community.lexicon.location.hthree {
4
-
/** A physical location in the form of a H3 encoded location. */
5
-
model Main {
6
-
/** The h3 encoded location. */
7
-
@required value: string;
8
-
9
-
/** The name of the location. */
10
-
name?: string;
11
-
}
12
-
}
-14
packages/emitter/test/integration/lexicon-examples/input/community/lexicon/payments/webMonetization.tsp
-14
packages/emitter/test/integration/lexicon-examples/input/community/lexicon/payments/webMonetization.tsp
···
1
-
import "@typelex/emitter";
2
-
3
-
/** Web Monetization integration: https://webmonetization.org/ */
4
-
namespace community.lexicon.payments.webMonetization {
5
-
@rec("any")
6
-
/** Web Monetization wallet. */
7
-
model Main {
8
-
/** Wallet address. */
9
-
@required address: uri;
10
-
11
-
/** Short, human-readable description of how this wallet is related to this account. */
12
-
note?: string;
13
-
}
14
-
}
-35
packages/emitter/test/integration/lexicon-examples/output/community/lexicon/bookmarks/bookmark.json
-35
packages/emitter/test/integration/lexicon-examples/output/community/lexicon/bookmarks/bookmark.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "community.lexicon.bookmarks.bookmark",
4
-
"defs": {
5
-
"main": {
6
-
"type": "record",
7
-
"description": "Record bookmarking a link to come back to later.",
8
-
"key": "tid",
9
-
"record": {
10
-
"type": "object",
11
-
"required": [
12
-
"subject",
13
-
"createdAt"
14
-
],
15
-
"properties": {
16
-
"subject": {
17
-
"type": "string",
18
-
"format": "uri"
19
-
},
20
-
"createdAt": {
21
-
"type": "string",
22
-
"format": "datetime"
23
-
},
24
-
"tags": {
25
-
"type": "array",
26
-
"description": "Tags for content the bookmark may be related to, for example 'news' or 'funny videos'",
27
-
"items": {
28
-
"type": "string"
29
-
}
30
-
}
31
-
}
32
-
}
33
-
}
34
-
}
35
-
}
-51
packages/emitter/test/integration/lexicon-examples/output/community/lexicon/bookmarks/getActorBookmarks.json
-51
packages/emitter/test/integration/lexicon-examples/output/community/lexicon/bookmarks/getActorBookmarks.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "community.lexicon.bookmarks.getActorBookmarks",
4
-
"defs": {
5
-
"main": {
6
-
"type": "query",
7
-
"description": "Get a list of bookmarks by actor. Optionally add a list of tags to include, default will be all bookmarks. Requires auth, actor must be the requesting account.",
8
-
"parameters": {
9
-
"type": "params",
10
-
"properties": {
11
-
"tags": {
12
-
"type": "array",
13
-
"items": {
14
-
"type": "string"
15
-
}
16
-
},
17
-
"limit": {
18
-
"type": "integer",
19
-
"minimum": 1,
20
-
"maximum": 100,
21
-
"default": 50
22
-
},
23
-
"cursor": {
24
-
"type": "string"
25
-
}
26
-
}
27
-
},
28
-
"output": {
29
-
"encoding": "application/json",
30
-
"schema": {
31
-
"type": "object",
32
-
"required": [
33
-
"bookmarks"
34
-
],
35
-
"properties": {
36
-
"cursor": {
37
-
"type": "string"
38
-
},
39
-
"bookmarks": {
40
-
"type": "array",
41
-
"items": {
42
-
"type": "ref",
43
-
"ref": "community.lexicon.bookmarks.bookmark"
44
-
}
45
-
}
46
-
}
47
-
}
48
-
}
49
-
}
50
-
}
51
-
}
-146
packages/emitter/test/integration/lexicon-examples/output/community/lexicon/calendar/event.json
-146
packages/emitter/test/integration/lexicon-examples/output/community/lexicon/calendar/event.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "community.lexicon.calendar.event",
4
-
"defs": {
5
-
"main": {
6
-
"type": "record",
7
-
"description": "A calendar event.",
8
-
"key": "tid",
9
-
"record": {
10
-
"type": "object",
11
-
"required": [
12
-
"name",
13
-
"createdAt"
14
-
],
15
-
"properties": {
16
-
"name": {
17
-
"type": "string",
18
-
"description": "The name of the event."
19
-
},
20
-
"description": {
21
-
"type": "string",
22
-
"description": "The description of the event."
23
-
},
24
-
"createdAt": {
25
-
"type": "string",
26
-
"format": "datetime",
27
-
"description": "Client-declared timestamp when the event was created."
28
-
},
29
-
"startsAt": {
30
-
"type": "string",
31
-
"format": "datetime",
32
-
"description": "Client-declared timestamp when the event starts."
33
-
},
34
-
"endsAt": {
35
-
"type": "string",
36
-
"format": "datetime",
37
-
"description": "Client-declared timestamp when the event ends."
38
-
},
39
-
"mode": {
40
-
"type": "ref",
41
-
"ref": "#mode",
42
-
"description": "The attendance mode of the event."
43
-
},
44
-
"status": {
45
-
"type": "ref",
46
-
"ref": "#status",
47
-
"description": "The status of the event."
48
-
},
49
-
"locations": {
50
-
"type": "array",
51
-
"description": "The locations where the event takes place.",
52
-
"items": {
53
-
"type": "union",
54
-
"refs": [
55
-
"#uri",
56
-
"community.lexicon.location.address",
57
-
"community.lexicon.location.fsq",
58
-
"community.lexicon.location.geo",
59
-
"community.lexicon.location.hthree"
60
-
]
61
-
}
62
-
},
63
-
"uris": {
64
-
"type": "array",
65
-
"description": "URIs associated with the event.",
66
-
"items": {
67
-
"type": "ref",
68
-
"ref": "#uri"
69
-
}
70
-
}
71
-
}
72
-
}
73
-
},
74
-
"mode": {
75
-
"type": "string",
76
-
"description": "The mode of the event.",
77
-
"default": "community.lexicon.calendar.event#inperson",
78
-
"knownValues": [
79
-
"community.lexicon.calendar.event#hybrid",
80
-
"community.lexicon.calendar.event#inperson",
81
-
"community.lexicon.calendar.event#virtual"
82
-
]
83
-
},
84
-
"virtual": {
85
-
"type": "token",
86
-
"description": "A virtual event that takes place online."
87
-
},
88
-
"inperson": {
89
-
"type": "token",
90
-
"description": "An in-person event that takes place offline."
91
-
},
92
-
"hybrid": {
93
-
"type": "token",
94
-
"description": "A hybrid event that takes place both online and offline."
95
-
},
96
-
"status": {
97
-
"type": "string",
98
-
"description": "The status of the event.",
99
-
"default": "community.lexicon.calendar.event#scheduled",
100
-
"knownValues": [
101
-
"community.lexicon.calendar.event#cancelled",
102
-
"community.lexicon.calendar.event#planned",
103
-
"community.lexicon.calendar.event#postponed",
104
-
"community.lexicon.calendar.event#rescheduled",
105
-
"community.lexicon.calendar.event#scheduled"
106
-
]
107
-
},
108
-
"planned": {
109
-
"type": "token",
110
-
"description": "The event has been created, but not finalized."
111
-
},
112
-
"scheduled": {
113
-
"type": "token",
114
-
"description": "The event has been created and scheduled."
115
-
},
116
-
"rescheduled": {
117
-
"type": "token",
118
-
"description": "The event has been rescheduled."
119
-
},
120
-
"cancelled": {
121
-
"type": "token",
122
-
"description": "The event has been cancelled."
123
-
},
124
-
"postponed": {
125
-
"type": "token",
126
-
"description": "The event has been postponed and a new start date has not been set."
127
-
},
128
-
"uri": {
129
-
"type": "object",
130
-
"description": "A URI associated with the event.",
131
-
"required": [
132
-
"uri"
133
-
],
134
-
"properties": {
135
-
"uri": {
136
-
"type": "string",
137
-
"format": "uri"
138
-
},
139
-
"name": {
140
-
"type": "string",
141
-
"description": "The display name of the URI."
142
-
}
143
-
}
144
-
}
145
-
}
146
-
}
-45
packages/emitter/test/integration/lexicon-examples/output/community/lexicon/calendar/rsvp.json
-45
packages/emitter/test/integration/lexicon-examples/output/community/lexicon/calendar/rsvp.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "community.lexicon.calendar.rsvp",
4
-
"defs": {
5
-
"main": {
6
-
"type": "record",
7
-
"description": "An RSVP for an event.",
8
-
"key": "tid",
9
-
"record": {
10
-
"type": "object",
11
-
"required": [
12
-
"subject",
13
-
"status"
14
-
],
15
-
"properties": {
16
-
"subject": {
17
-
"type": "ref",
18
-
"ref": "com.atproto.repo.strongRef"
19
-
},
20
-
"status": {
21
-
"type": "string",
22
-
"default": "community.lexicon.calendar.rsvp#going",
23
-
"knownValues": [
24
-
"community.lexicon.calendar.rsvp#interested",
25
-
"community.lexicon.calendar.rsvp#going",
26
-
"community.lexicon.calendar.rsvp#notgoing"
27
-
]
28
-
}
29
-
}
30
-
}
31
-
},
32
-
"interested": {
33
-
"type": "token",
34
-
"description": "Interested in the event"
35
-
},
36
-
"going": {
37
-
"type": "token",
38
-
"description": "Going to the event"
39
-
},
40
-
"notgoing": {
41
-
"type": "token",
42
-
"description": "Not going to the event"
43
-
}
44
-
}
45
-
}
-28
packages/emitter/test/integration/lexicon-examples/output/community/lexicon/interaction/like.json
-28
packages/emitter/test/integration/lexicon-examples/output/community/lexicon/interaction/like.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "community.lexicon.interaction.like",
4
-
"defs": {
5
-
"main": {
6
-
"type": "record",
7
-
"description": "A 'like' interaction with another AT Protocol record.",
8
-
"key": "tid",
9
-
"record": {
10
-
"type": "object",
11
-
"required": [
12
-
"subject",
13
-
"createdAt"
14
-
],
15
-
"properties": {
16
-
"subject": {
17
-
"type": "ref",
18
-
"ref": "com.atproto.repo.strongRef"
19
-
},
20
-
"createdAt": {
21
-
"type": "string",
22
-
"format": "datetime"
23
-
}
24
-
}
25
-
}
26
-
}
27
-
}
28
-
}
-41
packages/emitter/test/integration/lexicon-examples/output/community/lexicon/location/address.json
-41
packages/emitter/test/integration/lexicon-examples/output/community/lexicon/location/address.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "community.lexicon.location.address",
4
-
"defs": {
5
-
"main": {
6
-
"type": "object",
7
-
"description": "A physical location in the form of a street address.",
8
-
"required": [
9
-
"country"
10
-
],
11
-
"properties": {
12
-
"country": {
13
-
"type": "string",
14
-
"description": "The ISO 3166 country code. Preferably the 2-letter code.",
15
-
"minLength": 2,
16
-
"maxLength": 10
17
-
},
18
-
"postalCode": {
19
-
"type": "string",
20
-
"description": "The postal code of the location."
21
-
},
22
-
"region": {
23
-
"type": "string",
24
-
"description": "The administrative region of the country. For example, a state in the USA."
25
-
},
26
-
"locality": {
27
-
"type": "string",
28
-
"description": "The locality of the region. For example, a city in the USA."
29
-
},
30
-
"street": {
31
-
"type": "string",
32
-
"description": "The street address."
33
-
},
34
-
"name": {
35
-
"type": "string",
36
-
"description": "The name of the location."
37
-
}
38
-
}
39
-
}
40
-
}
41
-
}
-29
packages/emitter/test/integration/lexicon-examples/output/community/lexicon/location/fsq.json
-29
packages/emitter/test/integration/lexicon-examples/output/community/lexicon/location/fsq.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "community.lexicon.location.fsq",
4
-
"defs": {
5
-
"main": {
6
-
"type": "object",
7
-
"description": "A physical location contained in the Foursquare Open Source Places dataset.",
8
-
"required": [
9
-
"fsq_place_id"
10
-
],
11
-
"properties": {
12
-
"fsq_place_id": {
13
-
"type": "string",
14
-
"description": "The unique identifier of a Foursquare POI."
15
-
},
16
-
"latitude": {
17
-
"type": "string"
18
-
},
19
-
"longitude": {
20
-
"type": "string"
21
-
},
22
-
"name": {
23
-
"type": "string",
24
-
"description": "The name of the location."
25
-
}
26
-
}
27
-
}
28
-
}
29
-
}
-29
packages/emitter/test/integration/lexicon-examples/output/community/lexicon/location/geo.json
-29
packages/emitter/test/integration/lexicon-examples/output/community/lexicon/location/geo.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "community.lexicon.location.geo",
4
-
"defs": {
5
-
"main": {
6
-
"type": "object",
7
-
"description": "A physical location in the form of a WGS84 coordinate.",
8
-
"required": [
9
-
"latitude",
10
-
"longitude"
11
-
],
12
-
"properties": {
13
-
"latitude": {
14
-
"type": "string"
15
-
},
16
-
"longitude": {
17
-
"type": "string"
18
-
},
19
-
"altitude": {
20
-
"type": "string"
21
-
},
22
-
"name": {
23
-
"type": "string",
24
-
"description": "The name of the location."
25
-
}
26
-
}
27
-
}
28
-
}
29
-
}
-23
packages/emitter/test/integration/lexicon-examples/output/community/lexicon/location/hthree.json
-23
packages/emitter/test/integration/lexicon-examples/output/community/lexicon/location/hthree.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "community.lexicon.location.hthree",
4
-
"defs": {
5
-
"main": {
6
-
"type": "object",
7
-
"description": "A physical location in the form of a H3 encoded location.",
8
-
"required": [
9
-
"value"
10
-
],
11
-
"properties": {
12
-
"value": {
13
-
"type": "string",
14
-
"description": "The h3 encoded location."
15
-
},
16
-
"name": {
17
-
"type": "string",
18
-
"description": "The name of the location."
19
-
}
20
-
}
21
-
}
22
-
}
23
-
}
-27
packages/emitter/test/integration/lexicon-examples/output/community/lexicon/payments/webMonetization.json
-27
packages/emitter/test/integration/lexicon-examples/output/community/lexicon/payments/webMonetization.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "community.lexicon.payments.webMonetization",
4
-
"description": "Web Monetization integration: https://webmonetization.org/",
5
-
"defs": {
6
-
"main": {
7
-
"type": "record",
8
-
"description": "Web Monetization wallet.",
9
-
"key": "any",
10
-
"record": {
11
-
"type": "object",
12
-
"required": ["address"],
13
-
"properties": {
14
-
"address": {
15
-
"type": "string",
16
-
"format": "uri",
17
-
"description": "Wallet address."
18
-
},
19
-
"note": {
20
-
"type": "string",
21
-
"description": "Short, human-readable description of how this wallet is related to this account."
22
-
}
23
-
}
24
-
}
25
-
}
26
-
}
27
-
}
-30
packages/emitter/test/spec/basic/input/com/example/scalarDefaults.tsp
-30
packages/emitter/test/spec/basic/input/com/example/scalarDefaults.tsp
···
1
-
import "@typelex/emitter";
2
-
3
-
namespace com.example.scalarDefaults {
4
-
/** Test default decorator on scalars */
5
-
model Main {
6
-
/** Uses string scalar with default */
7
-
mode?: Mode;
8
-
9
-
/** Uses integer scalar with default */
10
-
limit?: Limit;
11
-
12
-
/** Uses boolean scalar with default */
13
-
enabled?: Enabled;
14
-
}
15
-
16
-
/** A string type with a default value */
17
-
@default("standard")
18
-
@maxLength(50)
19
-
scalar Mode extends string;
20
-
21
-
/** An integer type with a default value */
22
-
@default(50)
23
-
@minValue(1)
24
-
@maxValue(100)
25
-
scalar Limit extends integer;
26
-
27
-
/** A boolean type with a default value */
28
-
@default(true)
29
-
scalar Enabled extends boolean;
30
-
}
-22
packages/emitter/test/spec/basic/input/com/example/scalarDefs.tsp
-22
packages/emitter/test/spec/basic/input/com/example/scalarDefs.tsp
···
1
-
import "@typelex/emitter";
2
-
3
-
namespace com.example.scalarDefs {
4
-
/** Scalar defs should create standalone defs like models and unions */
5
-
model Main {
6
-
/** Uses a custom string scalar with constraints */
7
-
tag?: Tag;
8
-
9
-
/** Uses a custom integer scalar with constraints */
10
-
count?: Count;
11
-
}
12
-
13
-
/** A custom string type with length constraints */
14
-
@maxLength(100)
15
-
@maxGraphemes(50)
16
-
scalar Tag extends string;
17
-
18
-
/** A custom integer type with value constraints */
19
-
@minValue(1)
20
-
@maxValue(100)
21
-
scalar Count extends integer;
22
-
}
-22
packages/emitter/test/spec/basic/input/com/example/scalarInline.tsp
-22
packages/emitter/test/spec/basic/input/com/example/scalarInline.tsp
···
1
-
import "@typelex/emitter";
2
-
3
-
namespace com.example.scalarInline {
4
-
/** Test inline decorator on scalars */
5
-
model Main {
6
-
/** Inline scalar - should not create a def */
7
-
tag?: Tag;
8
-
9
-
/** Non-inline scalar - should create a def */
10
-
category?: Category;
11
-
}
12
-
13
-
/** An inline scalar should be inlined at usage sites */
14
-
@inline
15
-
@maxLength(50)
16
-
@maxGraphemes(25)
17
-
scalar Tag extends string;
18
-
19
-
/** A regular scalar should create a standalone def */
20
-
@maxLength(100)
21
-
scalar Category extends string;
22
-
}
-53
packages/emitter/test/spec/basic/input/com/example/unionDefaults.tsp
-53
packages/emitter/test/spec/basic/input/com/example/unionDefaults.tsp
···
1
-
import "@typelex/emitter";
2
-
3
-
namespace com.example.unionDefaults {
4
-
/** Test default decorator on unions */
5
-
model Main {
6
-
/** Union with token refs and default */
7
-
eventMode?: EventMode;
8
-
9
-
/** Union with string literals and default */
10
-
sortOrder?: SortOrder;
11
-
12
-
/** Union with integer literals and default */
13
-
priority?: Priority;
14
-
}
15
-
16
-
/** Union of tokens with default pointing to a token */
17
-
@default(Inperson)
18
-
union EventMode {
19
-
Hybrid,
20
-
Inperson,
21
-
Virtual,
22
-
string,
23
-
}
24
-
25
-
/** A hybrid event */
26
-
@token
27
-
model Hybrid {}
28
-
29
-
/** An in-person event */
30
-
@token
31
-
model Inperson {}
32
-
33
-
/** A virtual event */
34
-
@token
35
-
model Virtual {}
36
-
37
-
/** Union of string literals with default */
38
-
@default("asc")
39
-
union SortOrder {
40
-
"asc",
41
-
"desc",
42
-
string,
43
-
}
44
-
45
-
/** Union of integer literals with default (closed enum) */
46
-
@default(1)
47
-
@closed
48
-
union Priority {
49
-
1,
50
-
2,
51
-
3,
52
-
}
53
-
}
-45
packages/emitter/test/spec/basic/output/com/example/scalarDefaults.json
-45
packages/emitter/test/spec/basic/output/com/example/scalarDefaults.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.example.scalarDefaults",
4
-
"defs": {
5
-
"main": {
6
-
"type": "object",
7
-
"properties": {
8
-
"mode": {
9
-
"type": "ref",
10
-
"ref": "#mode",
11
-
"description": "Uses string scalar with default"
12
-
},
13
-
"limit": {
14
-
"type": "ref",
15
-
"ref": "#limit",
16
-
"description": "Uses integer scalar with default"
17
-
},
18
-
"enabled": {
19
-
"type": "ref",
20
-
"ref": "#enabled",
21
-
"description": "Uses boolean scalar with default"
22
-
}
23
-
},
24
-
"description": "Test default decorator on scalars"
25
-
},
26
-
"mode": {
27
-
"type": "string",
28
-
"maxLength": 50,
29
-
"default": "standard",
30
-
"description": "A string type with a default value"
31
-
},
32
-
"limit": {
33
-
"type": "integer",
34
-
"minimum": 1,
35
-
"maximum": 100,
36
-
"default": 50,
37
-
"description": "An integer type with a default value"
38
-
},
39
-
"enabled": {
40
-
"type": "boolean",
41
-
"default": true,
42
-
"description": "A boolean type with a default value"
43
-
}
44
-
}
45
-
}
-34
packages/emitter/test/spec/basic/output/com/example/scalarDefs.json
-34
packages/emitter/test/spec/basic/output/com/example/scalarDefs.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.example.scalarDefs",
4
-
"defs": {
5
-
"main": {
6
-
"type": "object",
7
-
"properties": {
8
-
"tag": {
9
-
"type": "ref",
10
-
"ref": "#tag",
11
-
"description": "Uses a custom string scalar with constraints"
12
-
},
13
-
"count": {
14
-
"type": "ref",
15
-
"ref": "#count",
16
-
"description": "Uses a custom integer scalar with constraints"
17
-
}
18
-
},
19
-
"description": "Scalar defs should create standalone defs like models and unions"
20
-
},
21
-
"tag": {
22
-
"type": "string",
23
-
"maxLength": 100,
24
-
"maxGraphemes": 50,
25
-
"description": "A custom string type with length constraints"
26
-
},
27
-
"count": {
28
-
"type": "integer",
29
-
"minimum": 1,
30
-
"maximum": 100,
31
-
"description": "A custom integer type with value constraints"
32
-
}
33
-
}
34
-
}
-28
packages/emitter/test/spec/basic/output/com/example/scalarInline.json
-28
packages/emitter/test/spec/basic/output/com/example/scalarInline.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.example.scalarInline",
4
-
"defs": {
5
-
"main": {
6
-
"type": "object",
7
-
"properties": {
8
-
"tag": {
9
-
"type": "string",
10
-
"maxLength": 50,
11
-
"maxGraphemes": 25,
12
-
"description": "Inline scalar - should not create a def"
13
-
},
14
-
"category": {
15
-
"type": "ref",
16
-
"ref": "#category",
17
-
"description": "Non-inline scalar - should create a def"
18
-
}
19
-
},
20
-
"description": "Test inline decorator on scalars"
21
-
},
22
-
"category": {
23
-
"type": "string",
24
-
"maxLength": 100,
25
-
"description": "A regular scalar should create a standalone def"
26
-
}
27
-
}
28
-
}
-61
packages/emitter/test/spec/basic/output/com/example/unionDefaults.json
-61
packages/emitter/test/spec/basic/output/com/example/unionDefaults.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.example.unionDefaults",
4
-
"defs": {
5
-
"main": {
6
-
"type": "object",
7
-
"properties": {
8
-
"eventMode": {
9
-
"type": "ref",
10
-
"ref": "#eventMode",
11
-
"description": "Union with token refs and default"
12
-
},
13
-
"sortOrder": {
14
-
"type": "ref",
15
-
"ref": "#sortOrder",
16
-
"description": "Union with string literals and default"
17
-
},
18
-
"priority": {
19
-
"type": "ref",
20
-
"ref": "#priority",
21
-
"description": "Union with integer literals and default"
22
-
}
23
-
},
24
-
"description": "Test default decorator on unions"
25
-
},
26
-
"eventMode": {
27
-
"type": "string",
28
-
"knownValues": [
29
-
"com.example.unionDefaults#hybrid",
30
-
"com.example.unionDefaults#inperson",
31
-
"com.example.unionDefaults#virtual"
32
-
],
33
-
"default": "com.example.unionDefaults#inperson",
34
-
"description": "Union of tokens with default pointing to a token"
35
-
},
36
-
"hybrid": {
37
-
"type": "token",
38
-
"description": "A hybrid event"
39
-
},
40
-
"inperson": {
41
-
"type": "token",
42
-
"description": "An in-person event"
43
-
},
44
-
"virtual": {
45
-
"type": "token",
46
-
"description": "A virtual event"
47
-
},
48
-
"sortOrder": {
49
-
"type": "string",
50
-
"knownValues": ["asc", "desc"],
51
-
"default": "asc",
52
-
"description": "Union of string literals with default"
53
-
},
54
-
"priority": {
55
-
"type": "integer",
56
-
"enum": [1, 2, 3],
57
-
"default": 1,
58
-
"description": "Union of integer literals with default (closed enum)"
59
-
}
60
-
}
61
-
}
+7
packages/example/.gitignore
+7
packages/example/.gitignore
-31
packages/example/lexicons/app/bsky/actor/defs.json
-31
packages/example/lexicons/app/bsky/actor/defs.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "app.bsky.actor.defs",
4
-
"defs": {
5
-
"profileView": {
6
-
"type": "object",
7
-
"required": ["did", "handle"],
8
-
"properties": {
9
-
"did": { "type": "string", "format": "did" },
10
-
"handle": { "type": "string", "format": "handle" },
11
-
"displayName": {
12
-
"type": "string",
13
-
"maxGraphemes": 64,
14
-
"maxLength": 640
15
-
},
16
-
"description": {
17
-
"type": "string",
18
-
"maxGraphemes": 256,
19
-
"maxLength": 2560
20
-
},
21
-
"avatar": { "type": "string", "format": "uri" },
22
-
"indexedAt": { "type": "string", "format": "datetime" },
23
-
"createdAt": { "type": "string", "format": "datetime" },
24
-
"labels": {
25
-
"type": "array",
26
-
"items": { "type": "ref", "ref": "com.atproto.label.defs#label" }
27
-
}
28
-
}
29
-
}
30
-
}
31
-
}
-53
packages/example/lexicons/app/bsky/actor/profile.json
-53
packages/example/lexicons/app/bsky/actor/profile.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "app.bsky.actor.profile",
4
-
"defs": {
5
-
"main": {
6
-
"type": "record",
7
-
"description": "A declaration of a Bluesky account profile.",
8
-
"key": "literal:self",
9
-
"record": {
10
-
"type": "object",
11
-
"properties": {
12
-
"displayName": {
13
-
"type": "string",
14
-
"maxGraphemes": 64,
15
-
"maxLength": 640
16
-
},
17
-
"description": {
18
-
"type": "string",
19
-
"description": "Free-form profile description text.",
20
-
"maxGraphemes": 256,
21
-
"maxLength": 2560
22
-
},
23
-
"avatar": {
24
-
"type": "blob",
25
-
"description": "Small image to be displayed next to posts from account. AKA, 'profile picture'",
26
-
"accept": ["image/png", "image/jpeg"],
27
-
"maxSize": 1000000
28
-
},
29
-
"banner": {
30
-
"type": "blob",
31
-
"description": "Larger horizontal image to display behind profile view.",
32
-
"accept": ["image/png", "image/jpeg"],
33
-
"maxSize": 1000000
34
-
},
35
-
"labels": {
36
-
"type": "union",
37
-
"description": "Self-label values, specific to the Bluesky application, on the overall account.",
38
-
"refs": ["com.atproto.label.defs#selfLabels"]
39
-
},
40
-
"joinedViaStarterPack": {
41
-
"type": "ref",
42
-
"ref": "com.atproto.repo.strongRef"
43
-
},
44
-
"pinnedPost": {
45
-
"type": "ref",
46
-
"ref": "com.atproto.repo.strongRef"
47
-
},
48
-
"createdAt": { "type": "string", "format": "datetime" }
49
-
}
50
-
}
51
-
}
52
-
}
53
-
}
-156
packages/example/lexicons/com/atproto/label/defs.json
-156
packages/example/lexicons/com/atproto/label/defs.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.atproto.label.defs",
4
-
"defs": {
5
-
"label": {
6
-
"type": "object",
7
-
"description": "Metadata tag on an atproto resource (eg, repo or record).",
8
-
"required": ["src", "uri", "val", "cts"],
9
-
"properties": {
10
-
"ver": {
11
-
"type": "integer",
12
-
"description": "The AT Protocol version of the label object."
13
-
},
14
-
"src": {
15
-
"type": "string",
16
-
"format": "did",
17
-
"description": "DID of the actor who created this label."
18
-
},
19
-
"uri": {
20
-
"type": "string",
21
-
"format": "uri",
22
-
"description": "AT URI of the record, repository (account), or other resource that this label applies to."
23
-
},
24
-
"cid": {
25
-
"type": "string",
26
-
"format": "cid",
27
-
"description": "Optionally, CID specifying the specific version of 'uri' resource this label applies to."
28
-
},
29
-
"val": {
30
-
"type": "string",
31
-
"maxLength": 128,
32
-
"description": "The short string name of the value or type of this label."
33
-
},
34
-
"neg": {
35
-
"type": "boolean",
36
-
"description": "If true, this is a negation label, overwriting a previous label."
37
-
},
38
-
"cts": {
39
-
"type": "string",
40
-
"format": "datetime",
41
-
"description": "Timestamp when this label was created."
42
-
},
43
-
"exp": {
44
-
"type": "string",
45
-
"format": "datetime",
46
-
"description": "Timestamp at which this label expires (no longer applies)."
47
-
},
48
-
"sig": {
49
-
"type": "bytes",
50
-
"description": "Signature of dag-cbor encoded label."
51
-
}
52
-
}
53
-
},
54
-
"selfLabels": {
55
-
"type": "object",
56
-
"description": "Metadata tags on an atproto record, published by the author within the record.",
57
-
"required": ["values"],
58
-
"properties": {
59
-
"values": {
60
-
"type": "array",
61
-
"items": { "type": "ref", "ref": "#selfLabel" },
62
-
"maxLength": 10
63
-
}
64
-
}
65
-
},
66
-
"selfLabel": {
67
-
"type": "object",
68
-
"description": "Metadata tag on an atproto record, published by the author within the record. Note that schemas should use #selfLabels, not #selfLabel.",
69
-
"required": ["val"],
70
-
"properties": {
71
-
"val": {
72
-
"type": "string",
73
-
"maxLength": 128,
74
-
"description": "The short string name of the value or type of this label."
75
-
}
76
-
}
77
-
},
78
-
"labelValueDefinition": {
79
-
"type": "object",
80
-
"description": "Declares a label value and its expected interpretations and behaviors.",
81
-
"required": ["identifier", "severity", "blurs", "locales"],
82
-
"properties": {
83
-
"identifier": {
84
-
"type": "string",
85
-
"description": "The value of the label being defined. Must only include lowercase ascii and the '-' character ([a-z-]+).",
86
-
"maxLength": 100,
87
-
"maxGraphemes": 100
88
-
},
89
-
"severity": {
90
-
"type": "string",
91
-
"description": "How should a client visually convey this label? 'inform' means neutral and informational; 'alert' means negative and warning; 'none' means show nothing.",
92
-
"knownValues": ["inform", "alert", "none"]
93
-
},
94
-
"blurs": {
95
-
"type": "string",
96
-
"description": "What should this label hide in the UI, if applied? 'content' hides all of the target; 'media' hides the images/video/audio; 'none' hides nothing.",
97
-
"knownValues": ["content", "media", "none"]
98
-
},
99
-
"defaultSetting": {
100
-
"type": "string",
101
-
"description": "The default setting for this label.",
102
-
"knownValues": ["ignore", "warn", "hide"],
103
-
"default": "warn"
104
-
},
105
-
"adultOnly": {
106
-
"type": "boolean",
107
-
"description": "Does the user need to have adult content enabled in order to configure this label?"
108
-
},
109
-
"locales": {
110
-
"type": "array",
111
-
"items": { "type": "ref", "ref": "#labelValueDefinitionStrings" }
112
-
}
113
-
}
114
-
},
115
-
"labelValueDefinitionStrings": {
116
-
"type": "object",
117
-
"description": "Strings which describe the label in the UI, localized into a specific language.",
118
-
"required": ["lang", "name", "description"],
119
-
"properties": {
120
-
"lang": {
121
-
"type": "string",
122
-
"description": "The code of the language these strings are written in.",
123
-
"format": "language"
124
-
},
125
-
"name": {
126
-
"type": "string",
127
-
"description": "A short human-readable name for the label.",
128
-
"maxGraphemes": 64,
129
-
"maxLength": 640
130
-
},
131
-
"description": {
132
-
"type": "string",
133
-
"description": "A longer description of what the label means and why it might be applied.",
134
-
"maxGraphemes": 10000,
135
-
"maxLength": 100000
136
-
}
137
-
}
138
-
},
139
-
"labelValue": {
140
-
"type": "string",
141
-
"knownValues": [
142
-
"!hide",
143
-
"!no-promote",
144
-
"!warn",
145
-
"!no-unauthenticated",
146
-
"dmca-violation",
147
-
"doxxing",
148
-
"porn",
149
-
"sexual",
150
-
"nudity",
151
-
"nsfl",
152
-
"gore"
153
-
]
154
-
}
155
-
}
156
-
}
-131
packages/example/lexicons/com/atproto/repo/applyWrites.json
-131
packages/example/lexicons/com/atproto/repo/applyWrites.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.atproto.repo.applyWrites",
4
-
"defs": {
5
-
"main": {
6
-
"type": "procedure",
7
-
"description": "Apply a batch transaction of repository creates, updates, and deletes. Requires auth, implemented by PDS.",
8
-
"input": {
9
-
"encoding": "application/json",
10
-
"schema": {
11
-
"type": "object",
12
-
"required": ["repo", "writes"],
13
-
"properties": {
14
-
"repo": {
15
-
"type": "string",
16
-
"format": "at-identifier",
17
-
"description": "The handle or DID of the repo (aka, current account)."
18
-
},
19
-
"validate": {
20
-
"type": "boolean",
21
-
"description": "Can be set to 'false' to skip Lexicon schema validation of record data across all operations, 'true' to require it, or leave unset to validate only for known Lexicons."
22
-
},
23
-
"writes": {
24
-
"type": "array",
25
-
"items": {
26
-
"type": "union",
27
-
"refs": ["#create", "#update", "#delete"],
28
-
"closed": true
29
-
}
30
-
},
31
-
"swapCommit": {
32
-
"type": "string",
33
-
"description": "If provided, the entire operation will fail if the current repo commit CID does not match this value. Used to prevent conflicting repo mutations.",
34
-
"format": "cid"
35
-
}
36
-
}
37
-
}
38
-
},
39
-
"output": {
40
-
"encoding": "application/json",
41
-
"schema": {
42
-
"type": "object",
43
-
"required": [],
44
-
"properties": {
45
-
"commit": {
46
-
"type": "ref",
47
-
"ref": "com.atproto.repo.defs#commitMeta"
48
-
},
49
-
"results": {
50
-
"type": "array",
51
-
"items": {
52
-
"type": "union",
53
-
"refs": ["#createResult", "#updateResult", "#deleteResult"],
54
-
"closed": true
55
-
}
56
-
}
57
-
}
58
-
}
59
-
},
60
-
"errors": [
61
-
{
62
-
"name": "InvalidSwap",
63
-
"description": "Indicates that the 'swapCommit' parameter did not match current commit."
64
-
}
65
-
]
66
-
},
67
-
"create": {
68
-
"type": "object",
69
-
"description": "Operation which creates a new record.",
70
-
"required": ["collection", "value"],
71
-
"properties": {
72
-
"collection": { "type": "string", "format": "nsid" },
73
-
"rkey": {
74
-
"type": "string",
75
-
"maxLength": 512,
76
-
"format": "record-key",
77
-
"description": "NOTE: maxLength is redundant with record-key format. Keeping it temporarily to ensure backwards compatibility."
78
-
},
79
-
"value": { "type": "unknown" }
80
-
}
81
-
},
82
-
"update": {
83
-
"type": "object",
84
-
"description": "Operation which updates an existing record.",
85
-
"required": ["collection", "rkey", "value"],
86
-
"properties": {
87
-
"collection": { "type": "string", "format": "nsid" },
88
-
"rkey": { "type": "string", "format": "record-key" },
89
-
"value": { "type": "unknown" }
90
-
}
91
-
},
92
-
"delete": {
93
-
"type": "object",
94
-
"description": "Operation which deletes an existing record.",
95
-
"required": ["collection", "rkey"],
96
-
"properties": {
97
-
"collection": { "type": "string", "format": "nsid" },
98
-
"rkey": { "type": "string", "format": "record-key" }
99
-
}
100
-
},
101
-
"createResult": {
102
-
"type": "object",
103
-
"required": ["uri", "cid"],
104
-
"properties": {
105
-
"uri": { "type": "string", "format": "at-uri" },
106
-
"cid": { "type": "string", "format": "cid" },
107
-
"validationStatus": {
108
-
"type": "string",
109
-
"knownValues": ["valid", "unknown"]
110
-
}
111
-
}
112
-
},
113
-
"updateResult": {
114
-
"type": "object",
115
-
"required": ["uri", "cid"],
116
-
"properties": {
117
-
"uri": { "type": "string", "format": "at-uri" },
118
-
"cid": { "type": "string", "format": "cid" },
119
-
"validationStatus": {
120
-
"type": "string",
121
-
"knownValues": ["valid", "unknown"]
122
-
}
123
-
}
124
-
},
125
-
"deleteResult": {
126
-
"type": "object",
127
-
"required": [],
128
-
"properties": {}
129
-
}
130
-
}
131
-
}
-73
packages/example/lexicons/com/atproto/repo/createRecord.json
-73
packages/example/lexicons/com/atproto/repo/createRecord.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.atproto.repo.createRecord",
4
-
"defs": {
5
-
"main": {
6
-
"type": "procedure",
7
-
"description": "Create a single new repository record. Requires auth, implemented by PDS.",
8
-
"input": {
9
-
"encoding": "application/json",
10
-
"schema": {
11
-
"type": "object",
12
-
"required": ["repo", "collection", "record"],
13
-
"properties": {
14
-
"repo": {
15
-
"type": "string",
16
-
"format": "at-identifier",
17
-
"description": "The handle or DID of the repo (aka, current account)."
18
-
},
19
-
"collection": {
20
-
"type": "string",
21
-
"format": "nsid",
22
-
"description": "The NSID of the record collection."
23
-
},
24
-
"rkey": {
25
-
"type": "string",
26
-
"format": "record-key",
27
-
"description": "The Record Key.",
28
-
"maxLength": 512
29
-
},
30
-
"validate": {
31
-
"type": "boolean",
32
-
"description": "Can be set to 'false' to skip Lexicon schema validation of record data, 'true' to require it, or leave unset to validate only for known Lexicons."
33
-
},
34
-
"record": {
35
-
"type": "unknown",
36
-
"description": "The record itself. Must contain a $type field."
37
-
},
38
-
"swapCommit": {
39
-
"type": "string",
40
-
"format": "cid",
41
-
"description": "Compare and swap with the previous commit by CID."
42
-
}
43
-
}
44
-
}
45
-
},
46
-
"output": {
47
-
"encoding": "application/json",
48
-
"schema": {
49
-
"type": "object",
50
-
"required": ["uri", "cid"],
51
-
"properties": {
52
-
"uri": { "type": "string", "format": "at-uri" },
53
-
"cid": { "type": "string", "format": "cid" },
54
-
"commit": {
55
-
"type": "ref",
56
-
"ref": "com.atproto.repo.defs#commitMeta"
57
-
},
58
-
"validationStatus": {
59
-
"type": "string",
60
-
"knownValues": ["valid", "unknown"]
61
-
}
62
-
}
63
-
}
64
-
},
65
-
"errors": [
66
-
{
67
-
"name": "InvalidSwap",
68
-
"description": "Indicates that 'swapCommit' didn't match current repo commit."
69
-
}
70
-
]
71
-
}
72
-
}
73
-
}
-14
packages/example/lexicons/com/atproto/repo/defs.json
-14
packages/example/lexicons/com/atproto/repo/defs.json
-57
packages/example/lexicons/com/atproto/repo/deleteRecord.json
-57
packages/example/lexicons/com/atproto/repo/deleteRecord.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.atproto.repo.deleteRecord",
4
-
"defs": {
5
-
"main": {
6
-
"type": "procedure",
7
-
"description": "Delete a repository record, or ensure it doesn't exist. Requires auth, implemented by PDS.",
8
-
"input": {
9
-
"encoding": "application/json",
10
-
"schema": {
11
-
"type": "object",
12
-
"required": ["repo", "collection", "rkey"],
13
-
"properties": {
14
-
"repo": {
15
-
"type": "string",
16
-
"format": "at-identifier",
17
-
"description": "The handle or DID of the repo (aka, current account)."
18
-
},
19
-
"collection": {
20
-
"type": "string",
21
-
"format": "nsid",
22
-
"description": "The NSID of the record collection."
23
-
},
24
-
"rkey": {
25
-
"type": "string",
26
-
"format": "record-key",
27
-
"description": "The Record Key."
28
-
},
29
-
"swapRecord": {
30
-
"type": "string",
31
-
"format": "cid",
32
-
"description": "Compare and swap with the previous record by CID."
33
-
},
34
-
"swapCommit": {
35
-
"type": "string",
36
-
"format": "cid",
37
-
"description": "Compare and swap with the previous commit by CID."
38
-
}
39
-
}
40
-
}
41
-
},
42
-
"output": {
43
-
"encoding": "application/json",
44
-
"schema": {
45
-
"type": "object",
46
-
"properties": {
47
-
"commit": {
48
-
"type": "ref",
49
-
"ref": "com.atproto.repo.defs#commitMeta"
50
-
}
51
-
}
52
-
}
53
-
},
54
-
"errors": [{ "name": "InvalidSwap" }]
55
-
}
56
-
}
57
-
}
-51
packages/example/lexicons/com/atproto/repo/describeRepo.json
-51
packages/example/lexicons/com/atproto/repo/describeRepo.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.atproto.repo.describeRepo",
4
-
"defs": {
5
-
"main": {
6
-
"type": "query",
7
-
"description": "Get information about an account and repository, including the list of collections. Does not require auth.",
8
-
"parameters": {
9
-
"type": "params",
10
-
"required": ["repo"],
11
-
"properties": {
12
-
"repo": {
13
-
"type": "string",
14
-
"format": "at-identifier",
15
-
"description": "The handle or DID of the repo."
16
-
}
17
-
}
18
-
},
19
-
"output": {
20
-
"encoding": "application/json",
21
-
"schema": {
22
-
"type": "object",
23
-
"required": [
24
-
"handle",
25
-
"did",
26
-
"didDoc",
27
-
"collections",
28
-
"handleIsCorrect"
29
-
],
30
-
"properties": {
31
-
"handle": { "type": "string", "format": "handle" },
32
-
"did": { "type": "string", "format": "did" },
33
-
"didDoc": {
34
-
"type": "unknown",
35
-
"description": "The complete DID document for this account."
36
-
},
37
-
"collections": {
38
-
"type": "array",
39
-
"description": "List of all the collections (NSIDs) for which this repo contains at least one record.",
40
-
"items": { "type": "string", "format": "nsid" }
41
-
},
42
-
"handleIsCorrect": {
43
-
"type": "boolean",
44
-
"description": "Indicates if handle is currently valid (resolves bi-directionally)"
45
-
}
46
-
}
47
-
}
48
-
}
49
-
}
50
-
}
51
-
}
-49
packages/example/lexicons/com/atproto/repo/getRecord.json
-49
packages/example/lexicons/com/atproto/repo/getRecord.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.atproto.repo.getRecord",
4
-
"defs": {
5
-
"main": {
6
-
"type": "query",
7
-
"description": "Get a single record from a repository. Does not require auth.",
8
-
"parameters": {
9
-
"type": "params",
10
-
"required": ["repo", "collection", "rkey"],
11
-
"properties": {
12
-
"repo": {
13
-
"type": "string",
14
-
"format": "at-identifier",
15
-
"description": "The handle or DID of the repo."
16
-
},
17
-
"collection": {
18
-
"type": "string",
19
-
"format": "nsid",
20
-
"description": "The NSID of the record collection."
21
-
},
22
-
"rkey": {
23
-
"type": "string",
24
-
"description": "The Record Key.",
25
-
"format": "record-key"
26
-
},
27
-
"cid": {
28
-
"type": "string",
29
-
"format": "cid",
30
-
"description": "The CID of the version of the record. If not specified, then return the most recent version."
31
-
}
32
-
}
33
-
},
34
-
"output": {
35
-
"encoding": "application/json",
36
-
"schema": {
37
-
"type": "object",
38
-
"required": ["uri", "value"],
39
-
"properties": {
40
-
"uri": { "type": "string", "format": "at-uri" },
41
-
"cid": { "type": "string", "format": "cid" },
42
-
"value": { "type": "unknown" }
43
-
}
44
-
}
45
-
},
46
-
"errors": [{ "name": "RecordNotFound" }]
47
-
}
48
-
}
49
-
}
-13
packages/example/lexicons/com/atproto/repo/importRepo.json
-13
packages/example/lexicons/com/atproto/repo/importRepo.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.atproto.repo.importRepo",
4
-
"defs": {
5
-
"main": {
6
-
"type": "procedure",
7
-
"description": "Import a repo in the form of a CAR file. Requires Content-Length HTTP header to be set.",
8
-
"input": {
9
-
"encoding": "application/vnd.ipld.car"
10
-
}
11
-
}
12
-
}
13
-
}
-44
packages/example/lexicons/com/atproto/repo/listMissingBlobs.json
-44
packages/example/lexicons/com/atproto/repo/listMissingBlobs.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.atproto.repo.listMissingBlobs",
4
-
"defs": {
5
-
"main": {
6
-
"type": "query",
7
-
"description": "Returns a list of missing blobs for the requesting account. Intended to be used in the account migration flow.",
8
-
"parameters": {
9
-
"type": "params",
10
-
"properties": {
11
-
"limit": {
12
-
"type": "integer",
13
-
"minimum": 1,
14
-
"maximum": 1000,
15
-
"default": 500
16
-
},
17
-
"cursor": { "type": "string" }
18
-
}
19
-
},
20
-
"output": {
21
-
"encoding": "application/json",
22
-
"schema": {
23
-
"type": "object",
24
-
"required": ["blobs"],
25
-
"properties": {
26
-
"cursor": { "type": "string" },
27
-
"blobs": {
28
-
"type": "array",
29
-
"items": { "type": "ref", "ref": "#recordBlob" }
30
-
}
31
-
}
32
-
}
33
-
}
34
-
},
35
-
"recordBlob": {
36
-
"type": "object",
37
-
"required": ["cid", "recordUri"],
38
-
"properties": {
39
-
"cid": { "type": "string", "format": "cid" },
40
-
"recordUri": { "type": "string", "format": "at-uri" }
41
-
}
42
-
}
43
-
}
44
-
}
-69
packages/example/lexicons/com/atproto/repo/listRecords.json
-69
packages/example/lexicons/com/atproto/repo/listRecords.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.atproto.repo.listRecords",
4
-
"defs": {
5
-
"main": {
6
-
"type": "query",
7
-
"description": "List a range of records in a repository, matching a specific collection. Does not require auth.",
8
-
"parameters": {
9
-
"type": "params",
10
-
"required": ["repo", "collection"],
11
-
"properties": {
12
-
"repo": {
13
-
"type": "string",
14
-
"format": "at-identifier",
15
-
"description": "The handle or DID of the repo."
16
-
},
17
-
"collection": {
18
-
"type": "string",
19
-
"format": "nsid",
20
-
"description": "The NSID of the record type."
21
-
},
22
-
"limit": {
23
-
"type": "integer",
24
-
"minimum": 1,
25
-
"maximum": 100,
26
-
"default": 50,
27
-
"description": "The number of records to return."
28
-
},
29
-
"cursor": { "type": "string" },
30
-
"rkeyStart": {
31
-
"type": "string",
32
-
"description": "DEPRECATED: The lowest sort-ordered rkey to start from (exclusive)"
33
-
},
34
-
"rkeyEnd": {
35
-
"type": "string",
36
-
"description": "DEPRECATED: The highest sort-ordered rkey to stop at (exclusive)"
37
-
},
38
-
"reverse": {
39
-
"type": "boolean",
40
-
"description": "Flag to reverse the order of the returned records."
41
-
}
42
-
}
43
-
},
44
-
"output": {
45
-
"encoding": "application/json",
46
-
"schema": {
47
-
"type": "object",
48
-
"required": ["records"],
49
-
"properties": {
50
-
"cursor": { "type": "string" },
51
-
"records": {
52
-
"type": "array",
53
-
"items": { "type": "ref", "ref": "#record" }
54
-
}
55
-
}
56
-
}
57
-
}
58
-
},
59
-
"record": {
60
-
"type": "object",
61
-
"required": ["uri", "cid", "value"],
62
-
"properties": {
63
-
"uri": { "type": "string", "format": "at-uri" },
64
-
"cid": { "type": "string", "format": "cid" },
65
-
"value": { "type": "unknown" }
66
-
}
67
-
}
68
-
}
69
-
}
-74
packages/example/lexicons/com/atproto/repo/putRecord.json
-74
packages/example/lexicons/com/atproto/repo/putRecord.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.atproto.repo.putRecord",
4
-
"defs": {
5
-
"main": {
6
-
"type": "procedure",
7
-
"description": "Write a repository record, creating or updating it as needed. Requires auth, implemented by PDS.",
8
-
"input": {
9
-
"encoding": "application/json",
10
-
"schema": {
11
-
"type": "object",
12
-
"required": ["repo", "collection", "rkey", "record"],
13
-
"nullable": ["swapRecord"],
14
-
"properties": {
15
-
"repo": {
16
-
"type": "string",
17
-
"format": "at-identifier",
18
-
"description": "The handle or DID of the repo (aka, current account)."
19
-
},
20
-
"collection": {
21
-
"type": "string",
22
-
"format": "nsid",
23
-
"description": "The NSID of the record collection."
24
-
},
25
-
"rkey": {
26
-
"type": "string",
27
-
"format": "record-key",
28
-
"description": "The Record Key.",
29
-
"maxLength": 512
30
-
},
31
-
"validate": {
32
-
"type": "boolean",
33
-
"description": "Can be set to 'false' to skip Lexicon schema validation of record data, 'true' to require it, or leave unset to validate only for known Lexicons."
34
-
},
35
-
"record": {
36
-
"type": "unknown",
37
-
"description": "The record to write."
38
-
},
39
-
"swapRecord": {
40
-
"type": "string",
41
-
"format": "cid",
42
-
"description": "Compare and swap with the previous record by CID. WARNING: nullable and optional field; may cause problems with golang implementation"
43
-
},
44
-
"swapCommit": {
45
-
"type": "string",
46
-
"format": "cid",
47
-
"description": "Compare and swap with the previous commit by CID."
48
-
}
49
-
}
50
-
}
51
-
},
52
-
"output": {
53
-
"encoding": "application/json",
54
-
"schema": {
55
-
"type": "object",
56
-
"required": ["uri", "cid"],
57
-
"properties": {
58
-
"uri": { "type": "string", "format": "at-uri" },
59
-
"cid": { "type": "string", "format": "cid" },
60
-
"commit": {
61
-
"type": "ref",
62
-
"ref": "com.atproto.repo.defs#commitMeta"
63
-
},
64
-
"validationStatus": {
65
-
"type": "string",
66
-
"knownValues": ["valid", "unknown"]
67
-
}
68
-
}
69
-
}
70
-
},
71
-
"errors": [{ "name": "InvalidSwap" }]
72
-
}
73
-
}
74
-
}
-15
packages/example/lexicons/com/atproto/repo/strongRef.json
-15
packages/example/lexicons/com/atproto/repo/strongRef.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.atproto.repo.strongRef",
4
-
"description": "A URI with a content-hash fingerprint.",
5
-
"defs": {
6
-
"main": {
7
-
"type": "object",
8
-
"required": ["uri", "cid"],
9
-
"properties": {
10
-
"uri": { "type": "string", "format": "at-uri" },
11
-
"cid": { "type": "string", "format": "cid" }
12
-
}
13
-
}
14
-
}
15
-
}
-23
packages/example/lexicons/com/atproto/repo/uploadBlob.json
-23
packages/example/lexicons/com/atproto/repo/uploadBlob.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "com.atproto.repo.uploadBlob",
4
-
"defs": {
5
-
"main": {
6
-
"type": "procedure",
7
-
"description": "Upload a new blob, to be referenced from a repository record. The blob will be deleted if it is not referenced within a time window (eg, minutes). Blob restrictions (mimetype, size, etc) are enforced when the reference is created. Requires auth, implemented by PDS.",
8
-
"input": {
9
-
"encoding": "*/*"
10
-
},
11
-
"output": {
12
-
"encoding": "application/json",
13
-
"schema": {
14
-
"type": "object",
15
-
"required": ["blob"],
16
-
"properties": {
17
-
"blob": { "type": "blob" }
18
-
}
19
-
}
20
-
}
21
-
}
22
-
}
23
-
}
-52
packages/example/lexicons/xyz/statusphere/defs.json
-52
packages/example/lexicons/xyz/statusphere/defs.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "xyz.statusphere.defs",
4
-
"defs": {
5
-
"statusView": {
6
-
"type": "object",
7
-
"properties": {
8
-
"uri": {
9
-
"type": "string",
10
-
"format": "at-uri"
11
-
},
12
-
"status": {
13
-
"type": "string",
14
-
"maxLength": 32,
15
-
"minLength": 1,
16
-
"maxGraphemes": 1
17
-
},
18
-
"createdAt": {
19
-
"type": "string",
20
-
"format": "datetime"
21
-
},
22
-
"profile": {
23
-
"type": "ref",
24
-
"ref": "#profileView"
25
-
}
26
-
},
27
-
"required": [
28
-
"uri",
29
-
"status",
30
-
"createdAt",
31
-
"profile"
32
-
]
33
-
},
34
-
"profileView": {
35
-
"type": "object",
36
-
"properties": {
37
-
"did": {
38
-
"type": "string",
39
-
"format": "did"
40
-
},
41
-
"handle": {
42
-
"type": "string",
43
-
"format": "handle"
44
-
}
45
-
},
46
-
"required": [
47
-
"did",
48
-
"handle"
49
-
]
50
-
}
51
-
}
52
-
}
-39
packages/example/lexicons/xyz/statusphere/getStatuses.json
-39
packages/example/lexicons/xyz/statusphere/getStatuses.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "xyz.statusphere.getStatuses",
4
-
"defs": {
5
-
"main": {
6
-
"type": "query",
7
-
"description": "Get a list of the most recent statuses on the network.",
8
-
"parameters": {
9
-
"type": "params",
10
-
"properties": {
11
-
"limit": {
12
-
"type": "integer",
13
-
"minimum": 1,
14
-
"maximum": 100,
15
-
"default": 50
16
-
}
17
-
}
18
-
},
19
-
"output": {
20
-
"encoding": "application/json",
21
-
"schema": {
22
-
"type": "object",
23
-
"properties": {
24
-
"statuses": {
25
-
"type": "array",
26
-
"items": {
27
-
"type": "ref",
28
-
"ref": "xyz.statusphere.defs#statusView"
29
-
}
30
-
}
31
-
},
32
-
"required": [
33
-
"statuses"
34
-
]
35
-
}
36
-
}
37
-
}
38
-
}
39
-
}
-29
packages/example/lexicons/xyz/statusphere/getUser.json
-29
packages/example/lexicons/xyz/statusphere/getUser.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "xyz.statusphere.getUser",
4
-
"defs": {
5
-
"main": {
6
-
"type": "query",
7
-
"description": "Get the current user's profile and status.",
8
-
"output": {
9
-
"encoding": "application/json",
10
-
"schema": {
11
-
"type": "object",
12
-
"properties": {
13
-
"profile": {
14
-
"type": "ref",
15
-
"ref": "app.bsky.actor.defs#profileView"
16
-
},
17
-
"status": {
18
-
"type": "ref",
19
-
"ref": "xyz.statusphere.defs#statusView"
20
-
}
21
-
},
22
-
"required": [
23
-
"profile"
24
-
]
25
-
}
26
-
}
27
-
}
28
-
}
29
-
}
-42
packages/example/lexicons/xyz/statusphere/sendStatus.json
-42
packages/example/lexicons/xyz/statusphere/sendStatus.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "xyz.statusphere.sendStatus",
4
-
"defs": {
5
-
"main": {
6
-
"type": "procedure",
7
-
"description": "Send a status into the ATmosphere.",
8
-
"input": {
9
-
"encoding": "application/json",
10
-
"schema": {
11
-
"type": "object",
12
-
"properties": {
13
-
"status": {
14
-
"type": "string",
15
-
"maxLength": 32,
16
-
"minLength": 1,
17
-
"maxGraphemes": 1
18
-
}
19
-
},
20
-
"required": [
21
-
"status"
22
-
]
23
-
}
24
-
},
25
-
"output": {
26
-
"encoding": "application/json",
27
-
"schema": {
28
-
"type": "object",
29
-
"properties": {
30
-
"status": {
31
-
"type": "ref",
32
-
"ref": "xyz.statusphere.defs#statusView"
33
-
}
34
-
},
35
-
"required": [
36
-
"status"
37
-
]
38
-
}
39
-
}
40
-
}
41
-
}
42
-
}
-29
packages/example/lexicons/xyz/statusphere/status.json
-29
packages/example/lexicons/xyz/statusphere/status.json
···
1
-
{
2
-
"lexicon": 1,
3
-
"id": "xyz.statusphere.status",
4
-
"defs": {
5
-
"main": {
6
-
"type": "record",
7
-
"key": "tid",
8
-
"record": {
9
-
"type": "object",
10
-
"properties": {
11
-
"status": {
12
-
"type": "string",
13
-
"maxLength": 32,
14
-
"minLength": 1,
15
-
"maxGraphemes": 1
16
-
},
17
-
"createdAt": {
18
-
"type": "string",
19
-
"format": "datetime"
20
-
}
21
-
},
22
-
"required": [
23
-
"status",
24
-
"createdAt"
25
-
]
26
-
}
27
-
}
28
-
}
29
-
}
+2
-2
packages/example/package.json
+2
-2
packages/example/package.json
···
4
4
"private": true,
5
5
"type": "module",
6
6
"scripts": {
7
-
"build": "pnpm run build:typelex && pnpm run build:codegen",
8
-
"build:typelex": "typelex compile xyz.statusphere.*",
7
+
"build": "pnpm run build:lexicons && pnpm run build:codegen",
8
+
"build:lexicons": "typelex compile xyz.statusphere.*",
9
9
"build:codegen": "lex gen-server --yes ./src lexicons/xyz/statusphere/*.json"
10
10
},
11
11
"dependencies": {
+154
-1
packages/example/typelex/externals.tsp
+154
-1
packages/example/typelex/externals.tsp
···
1
1
import "@typelex/emitter";
2
2
3
-
// Generated by typelex from ./lexicons (excluding xyz.statusphere.*)
3
+
// Generated by typelex
4
4
// This file is auto-generated. Do not edit manually.
5
5
6
6
@external
7
7
namespace app.bsky.actor.defs {
8
+
model AdultContentPref { }
9
+
model BskyAppProgressGuide { }
10
+
model BskyAppStatePref { }
11
+
model ContentLabelPref { }
12
+
model FeedViewPref { }
13
+
model HiddenPostsPref { }
14
+
model InterestsPref { }
15
+
model KnownFollowers { }
16
+
model LabelerPrefItem { }
17
+
model LabelersPref { }
18
+
model MutedWord { }
19
+
model MutedWordsPref { }
20
+
model MutedWordTarget { }
21
+
model Nux { }
22
+
model PersonalDetailsPref { }
23
+
model PostInteractionSettingsPref { }
24
+
model ProfileAssociated { }
25
+
model ProfileAssociatedChat { }
8
26
model ProfileView { }
27
+
model ProfileViewBasic { }
28
+
model ProfileViewDetailed { }
29
+
model SavedFeed { }
30
+
model SavedFeedsPref { }
31
+
model SavedFeedsPrefV2 { }
32
+
model ThreadViewPref { }
33
+
model ViewerState { }
9
34
}
10
35
11
36
@external
12
37
namespace app.bsky.actor.profile {
13
38
model Main { }
39
+
}
40
+
41
+
@external
42
+
namespace app.bsky.embed.defs {
43
+
model AspectRatio { }
44
+
}
45
+
46
+
@external
47
+
namespace app.bsky.embed.external {
48
+
model External { }
49
+
model Main { }
50
+
model View { }
51
+
model ViewExternal { }
52
+
}
53
+
54
+
@external
55
+
namespace app.bsky.embed.images {
56
+
model Image { }
57
+
model Main { }
58
+
model View { }
59
+
model ViewImage { }
60
+
}
61
+
62
+
@external
63
+
namespace app.bsky.embed.`record` {
64
+
model Main { }
65
+
model View { }
66
+
model ViewBlocked { }
67
+
model ViewDetached { }
68
+
model ViewNotFound { }
69
+
model ViewRecord { }
70
+
}
71
+
72
+
@external
73
+
namespace app.bsky.embed.recordWithMedia {
74
+
model Main { }
75
+
model View { }
76
+
}
77
+
78
+
@external
79
+
namespace app.bsky.embed.video {
80
+
model Caption { }
81
+
model Main { }
82
+
model View { }
83
+
}
84
+
85
+
@external
86
+
namespace app.bsky.feed.defs {
87
+
model BlockedAuthor { }
88
+
model BlockedPost { }
89
+
@token model ClickthroughAuthor { }
90
+
@token model ClickthroughEmbed { }
91
+
@token model ClickthroughItem { }
92
+
@token model ClickthroughReposter { }
93
+
@token model ContentModeUnspecified { }
94
+
@token model ContentModeVideo { }
95
+
model FeedViewPost { }
96
+
model GeneratorView { }
97
+
model GeneratorViewerState { }
98
+
model Interaction { }
99
+
@token model InteractionLike { }
100
+
@token model InteractionQuote { }
101
+
@token model InteractionReply { }
102
+
@token model InteractionRepost { }
103
+
@token model InteractionSeen { }
104
+
@token model InteractionShare { }
105
+
model NotFoundPost { }
106
+
model PostView { }
107
+
model ReasonPin { }
108
+
model ReasonRepost { }
109
+
model ReplyRef { }
110
+
@token model RequestLess { }
111
+
@token model RequestMore { }
112
+
model SkeletonFeedPost { }
113
+
model SkeletonReasonPin { }
114
+
model SkeletonReasonRepost { }
115
+
model ThreadContext { }
116
+
model ThreadgateView { }
117
+
model ThreadViewPost { }
118
+
model ViewerState { }
119
+
}
120
+
121
+
@external
122
+
namespace app.bsky.feed.postgate {
123
+
model DisableRule { }
124
+
model Main { }
125
+
}
126
+
127
+
@external
128
+
namespace app.bsky.feed.threadgate {
129
+
model FollowerRule { }
130
+
model FollowingRule { }
131
+
model ListRule { }
132
+
model Main { }
133
+
model MentionRule { }
134
+
}
135
+
136
+
@external
137
+
namespace app.bsky.graph.defs {
138
+
@token model Curatelist { }
139
+
model ListItemView { }
140
+
model ListPurpose { }
141
+
model ListView { }
142
+
model ListViewBasic { }
143
+
model ListViewerState { }
144
+
@token model Modlist { }
145
+
model NotFoundActor { }
146
+
@token model Referencelist { }
147
+
model Relationship { }
148
+
model StarterPackView { }
149
+
model StarterPackViewBasic { }
150
+
}
151
+
152
+
@external
153
+
namespace app.bsky.labeler.defs {
154
+
model LabelerPolicies { }
155
+
model LabelerView { }
156
+
model LabelerViewDetailed { }
157
+
model LabelerViewerState { }
158
+
}
159
+
160
+
@external
161
+
namespace app.bsky.richtext.facet {
162
+
model ByteSlice { }
163
+
model Link { }
164
+
model Main { }
165
+
model Mention { }
166
+
model Tag { }
14
167
}
15
168
16
169
@external
-1
packages/website/package.json
-1
packages/website/package.json
-14
packages/website/src/components/CodeBlock.astro
-14
packages/website/src/components/CodeBlock.astro
···
1
-
---
2
-
import { highlightCode } from '../utils/shiki';
3
-
4
-
interface Props {
5
-
lang: 'typespec' | 'json' | 'bash';
6
-
code?: string;
7
-
}
8
-
9
-
const { lang, code } = Astro.props;
10
-
const codeContent = code || await Astro.slots.render('default');
11
-
const highlighted = await highlightCode(codeContent.trim(), lang);
12
-
---
13
-
14
-
<pre set:html={highlighted} />
-62
packages/website/src/components/ComparisonBlock.astro
-62
packages/website/src/components/ComparisonBlock.astro
···
1
-
---
2
-
import { highlightCode } from '../utils/shiki';
3
-
import { compileToJson } from '../utils/compile';
4
-
import { createPlaygroundUrl } from '../utils/playground-url';
5
-
import stringify from 'json-stringify-pretty-compact';
6
-
import { mkdtempSync, writeFileSync, rmSync } from 'fs';
7
-
import { join } from 'path';
8
-
import { tmpdir } from 'os';
9
-
10
-
interface Props {
11
-
code: string;
12
-
hero?: boolean;
13
-
}
14
-
15
-
const { code, hero = false } = Astro.props;
16
-
17
-
// Create temporary file for compilation
18
-
const tmpDir = mkdtempSync(join(tmpdir(), 'typelex-'));
19
-
const tmpFile = join(tmpDir, 'example.tsp');
20
-
writeFileSync(tmpFile, code);
21
-
22
-
let lexiconJson: string;
23
-
let lexicon: string;
24
-
25
-
try {
26
-
lexiconJson = await compileToJson(tmpFile);
27
-
lexicon = stringify(JSON.parse(lexiconJson), { maxLength: hero ? 50 : 80 });
28
-
} finally {
29
-
rmSync(tmpDir, { recursive: true, force: true });
30
-
}
31
-
32
-
const typelexHtml = await highlightCode(code, 'typespec');
33
-
const lexiconHtml = await highlightCode(lexicon, 'json');
34
-
const playgroundUrl = createPlaygroundUrl(code);
35
-
36
-
const panelClass = hero ? 'hero-panel' : 'code-panel';
37
-
const headerClass = hero ? 'hero-header' : 'code-header';
38
-
const blockClass = hero ? 'hero-code' : 'code-block';
39
-
---
40
-
41
-
<figure class:list={[hero ? 'hero-comparison' : 'comparison']}>
42
-
<div class="comparison-content">
43
-
<div class={panelClass}>
44
-
<p class={headerClass}>
45
-
Typelex
46
-
<a href={playgroundUrl} target="_blank" rel="noopener noreferrer" class="code-playground-link" aria-label="Open in playground">
47
-
<svg width="14" height="14" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg" aria-hidden="true">
48
-
<path d="M6.5 3.5C6.5 3.22386 6.72386 3 7 3H13C13.2761 3 13.5 3.22386 13.5 3.5V9.5C13.5 9.77614 13.2761 10 13 10C12.7239 10 12.5 9.77614 12.5 9.5V4.70711L6.85355 10.3536C6.65829 10.5488 6.34171 10.5488 6.14645 10.3536C5.95118 10.1583 5.95118 9.84171 6.14645 9.64645L11.7929 4H7C6.72386 4 6.5 3.77614 6.5 3.5Z" fill="currentColor"/>
49
-
<path d="M3 5.5C3 4.67157 3.67157 4 4.5 4H5C5.27614 4 5.5 4.22386 5.5 4.5C5.5 4.77614 5.27614 5 5 5H4.5C4.22386 5 4 5.22386 4 5.5V11.5C4 11.7761 4.22386 12 4.5 12H10.5C10.7761 12 11 11.7761 11 11.5V11C11 10.7239 11.2239 10.5 11.5 10.5C11.7761 10.5 12 10.7239 12 11V11.5C12 12.3284 11.3284 13 10.5 13H4.5C3.67157 13 3 12.3284 3 11.5V5.5Z" fill="currentColor"/>
50
-
</svg>
51
-
</a>
52
-
</p>
53
-
<div class={blockClass} set:html={typelexHtml} />
54
-
</div>
55
-
<div class={panelClass}>
56
-
<p class={headerClass}>
57
-
Lexicon
58
-
</p>
59
-
<div class={blockClass} set:html={lexiconHtml} />
60
-
</div>
61
-
</div>
62
-
</figure>
-193
packages/website/src/layouts/BaseLayout.astro
-193
packages/website/src/layouts/BaseLayout.astro
···
1
-
---
2
-
interface Props {
3
-
title: string;
4
-
description?: string;
5
-
transparentNav?: boolean;
6
-
}
7
-
8
-
const {
9
-
title,
10
-
description = "An experimental TypeSpec syntax for AT Protocol Lexicons. Write Lexicons in a more readable syntax using TypeSpec.",
11
-
transparentNav = false
12
-
} = Astro.props;
13
-
---
14
-
15
-
<!DOCTYPE html>
16
-
<html lang="en">
17
-
<head>
18
-
<meta charset="utf-8" />
19
-
<link rel="icon" type="image/svg+xml" href="/favicon.svg" />
20
-
<meta name="viewport" content="width=device-width, initial-scale=1" />
21
-
<meta name="generator" content={Astro.generator} />
22
-
<title>{title}</title>
23
-
<meta name="description" content={description} />
24
-
25
-
<!-- Open Graph / Facebook -->
26
-
<meta property="og:type" content="website" />
27
-
<meta property="og:url" content="https://typelex.org/" />
28
-
<meta property="og:title" content={title} />
29
-
<meta property="og:description" content={description} />
30
-
<meta property="og:image" content="https://typelex.org/og.png" />
31
-
32
-
<!-- Twitter -->
33
-
<meta property="twitter:card" content="summary_large_image" />
34
-
<meta property="twitter:url" content="https://typelex.org/" />
35
-
<meta property="twitter:title" content={title} />
36
-
<meta property="twitter:description" content={description} />
37
-
<meta property="twitter:image" content="https://typelex.org/og.png" />
38
-
</head>
39
-
<body>
40
-
<nav class:list={["top-nav", { transparent: transparentNav }]}>
41
-
<div class="nav-container">
42
-
<a href="/" class="logo">typelex</a>
43
-
<div class="nav-links">
44
-
<a href="#install">Install</a>
45
-
<a href="https://tangled.org/@danabra.mov/typelex/blob/main/DOCS.md" target="_blank" rel="noopener noreferrer">Docs</a>
46
-
<a href="https://playground.typelex.org" target="_blank" rel="noopener noreferrer">Playground</a>
47
-
</div>
48
-
</div>
49
-
</nav>
50
-
51
-
<slot />
52
-
53
-
<script>
54
-
// Smooth scroll to top when clicking logo
55
-
document.addEventListener('DOMContentLoaded', () => {
56
-
const logo = document.querySelector('.logo');
57
-
if (logo) {
58
-
logo.addEventListener('click', (e) => {
59
-
// Allow Ctrl/Cmd+click to open in new tab
60
-
if (e.ctrlKey || e.metaKey || e.shiftKey) {
61
-
return;
62
-
}
63
-
e.preventDefault();
64
-
window.scrollTo({ top: 0, behavior: 'smooth' });
65
-
});
66
-
}
67
-
});
68
-
</script>
69
-
70
-
{transparentNav && (
71
-
<script>
72
-
const nav = document.querySelector('.top-nav');
73
-
const heroTitle = document.querySelector('header h1');
74
-
75
-
if (heroTitle && nav) {
76
-
const handleScroll = () => {
77
-
const titleRect = heroTitle.getBoundingClientRect();
78
-
79
-
if (titleRect.bottom < 16) {
80
-
nav.classList.remove('transparent');
81
-
} else {
82
-
nav.classList.add('transparent');
83
-
}
84
-
};
85
-
86
-
window.addEventListener('scroll', handleScroll, { passive: true });
87
-
handleScroll();
88
-
}
89
-
</script>
90
-
)}
91
-
</body>
92
-
</html>
93
-
94
-
<style is:global>
95
-
* {
96
-
margin: 0;
97
-
padding: 0;
98
-
box-sizing: border-box;
99
-
}
100
-
101
-
html {
102
-
scroll-behavior: smooth;
103
-
}
104
-
105
-
body {
106
-
font-family: system-ui, -apple-system, sans-serif;
107
-
line-height: 1.6;
108
-
color: #1e293b;
109
-
background: #f8fafc;
110
-
font-size: 16px;
111
-
}
112
-
113
-
@media (min-width: 768px) {
114
-
body {
115
-
font-size: 17px;
116
-
}
117
-
}
118
-
119
-
.top-nav {
120
-
position: sticky;
121
-
top: 0;
122
-
z-index: 100;
123
-
background: rgba(255, 255, 255, 0.8);
124
-
backdrop-filter: blur(10px);
125
-
border-bottom: 1px solid #e2e8f0;
126
-
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.05);
127
-
transition: all 0.3s ease;
128
-
}
129
-
130
-
.top-nav.transparent {
131
-
background: rgba(255, 255, 255, 0);
132
-
backdrop-filter: none;
133
-
border-bottom-color: transparent;
134
-
box-shadow: none;
135
-
}
136
-
137
-
.top-nav.transparent .logo {
138
-
opacity: 0;
139
-
transform: translateY(-100%);
140
-
}
141
-
142
-
.top-nav.transparent .nav-links a {
143
-
opacity: 0.7;
144
-
}
145
-
146
-
.nav-container {
147
-
max-width: 1104px;
148
-
margin: 0 auto;
149
-
padding: 1rem 2rem;
150
-
display: flex;
151
-
justify-content: space-between;
152
-
align-items: center;
153
-
}
154
-
155
-
@media (min-width: 768px) {
156
-
.nav-container {
157
-
padding: 1rem 2rem;
158
-
}
159
-
}
160
-
161
-
.logo {
162
-
font-size: 1.25rem;
163
-
font-weight: 800;
164
-
background: linear-gradient(90deg, #4a9eff 0%, #7a8ef7 40%, #ff85c1 70%, #9b7ef7 100%);
165
-
-webkit-background-clip: text;
166
-
-webkit-text-fill-color: transparent;
167
-
background-clip: text;
168
-
text-decoration: none;
169
-
transition: all 0.3s ease;
170
-
padding-left: 80px;
171
-
padding-right: 80px;
172
-
margin-left: -80px;
173
-
margin-right: -80px;
174
-
}
175
-
176
-
.nav-links {
177
-
display: flex;
178
-
gap: 1.5rem;
179
-
align-items: center;
180
-
}
181
-
182
-
.nav-links a {
183
-
color: #64748b;
184
-
text-decoration: none;
185
-
font-weight: 500;
186
-
transition: all 0.3s ease;
187
-
font-size: 0.9375rem;
188
-
}
189
-
190
-
.nav-links a:hover {
191
-
color: #7a8ef7;
192
-
}
193
-
</style>
-445
packages/website/src/layouts/DocsLayout.astro
-445
packages/website/src/layouts/DocsLayout.astro
···
1
-
---
2
-
import BaseLayout from './BaseLayout.astro';
3
-
4
-
interface Props {
5
-
title: string;
6
-
}
7
-
8
-
const { title } = Astro.props;
9
-
---
10
-
11
-
<BaseLayout title={`${title} โ typelex`}>
12
-
<div class="docs-container">
13
-
<aside class="sidebar">
14
-
<div class="sidebar-content">
15
-
<h3>Documentation</h3>
16
-
<nav class="sidebar-nav">
17
-
<a href="/docs" class:list={[{ active: Astro.url.pathname === '/docs' || Astro.url.pathname === '/docs/' }]}>Introduction</a>
18
-
</nav>
19
-
</div>
20
-
</aside>
21
-
22
-
<main class="docs-main">
23
-
<article class="docs-content">
24
-
<h1>{title}</h1>
25
-
<slot />
26
-
</article>
27
-
</main>
28
-
</div>
29
-
30
-
<script>
31
-
document.addEventListener('DOMContentLoaded', () => {
32
-
const scrollables = document.querySelectorAll('.code-panel:last-child .code-block');
33
-
34
-
// Update gradient mask based on scroll position
35
-
scrollables.forEach(block => {
36
-
const updateMask = () => {
37
-
const isAtBottom = block.scrollHeight - block.scrollTop <= block.clientHeight + 5;
38
-
if (isAtBottom) {
39
-
block.style.maskImage = 'none';
40
-
block.style.webkitMaskImage = 'none';
41
-
} else {
42
-
block.style.maskImage = 'linear-gradient(to bottom, black calc(100% - 150px), transparent 100%)';
43
-
block.style.webkitMaskImage = 'linear-gradient(to bottom, black calc(100% - 150px), transparent 100%)';
44
-
}
45
-
};
46
-
47
-
block.addEventListener('scroll', updateMask);
48
-
updateMask(); // Initial check
49
-
});
50
-
51
-
// Freeze inner scrollable blocks while scrolling the page
52
-
let scrollTimeout;
53
-
const freezeInnerScroll = () => {
54
-
document.body.classList.add('outer-scrolling');
55
-
56
-
clearTimeout(scrollTimeout);
57
-
scrollTimeout = setTimeout(() => {
58
-
document.body.classList.remove('outer-scrolling');
59
-
}, 150);
60
-
};
61
-
62
-
// Listen for both scroll and wheel events to catch scrolling early
63
-
window.addEventListener('scroll', freezeInnerScroll, { passive: true });
64
-
window.addEventListener('wheel', (e) => {
65
-
// Only freeze if the wheel event is not inside a scrollable block
66
-
const target = e.target;
67
-
const isInsideScrollable = target.closest('.code-panel:last-child .code-block');
68
-
if (!isInsideScrollable) {
69
-
freezeInnerScroll();
70
-
}
71
-
}, { passive: true });
72
-
});
73
-
</script>
74
-
</BaseLayout>
75
-
76
-
<style is:global>
77
-
.docs-container {
78
-
max-width: 1400px;
79
-
margin: 0 auto;
80
-
display: grid;
81
-
grid-template-columns: 250px 1fr;
82
-
gap: 3rem;
83
-
padding: 2rem 1.5rem;
84
-
}
85
-
86
-
@media (max-width: 968px) {
87
-
.docs-container {
88
-
grid-template-columns: 1fr;
89
-
gap: 2rem;
90
-
}
91
-
92
-
.sidebar {
93
-
position: static;
94
-
border-right: none;
95
-
border-bottom: 1px solid #e2e8f0;
96
-
padding-bottom: 2rem;
97
-
}
98
-
}
99
-
100
-
.sidebar {
101
-
position: sticky;
102
-
top: 5rem;
103
-
height: fit-content;
104
-
}
105
-
106
-
.sidebar-content h3 {
107
-
font-size: 0.875rem;
108
-
text-transform: uppercase;
109
-
letter-spacing: 0.05em;
110
-
color: #94a3b8;
111
-
margin-bottom: 1rem;
112
-
font-weight: 600;
113
-
}
114
-
115
-
.sidebar-nav {
116
-
display: flex;
117
-
flex-direction: column;
118
-
gap: 0.25rem;
119
-
}
120
-
121
-
.sidebar-nav a {
122
-
color: #64748b;
123
-
text-decoration: none;
124
-
padding: 0.5rem 0.75rem;
125
-
border-radius: 6px;
126
-
transition: all 0.2s ease;
127
-
font-weight: 500;
128
-
}
129
-
130
-
.sidebar-nav a:hover {
131
-
background: #f1f5f9;
132
-
color: #1e293b;
133
-
}
134
-
135
-
.sidebar-nav a.active {
136
-
background: linear-gradient(135deg, #7a8ef7 0%, #9483f7 70%, #b87ed8 100%);
137
-
color: white;
138
-
font-weight: 600;
139
-
}
140
-
141
-
.docs-main {
142
-
min-width: 0;
143
-
max-width: 800px;
144
-
}
145
-
146
-
.docs-content {
147
-
padding-bottom: 4rem;
148
-
}
149
-
150
-
.docs-content h1 {
151
-
font-size: 2.5rem;
152
-
font-weight: 800;
153
-
margin: 0 0 2rem 0;
154
-
background: linear-gradient(90deg, #4a9eff 0%, #7a8ef7 40%, #ff85c1 70%, #9b7ef7 100%);
155
-
-webkit-background-clip: text;
156
-
-webkit-text-fill-color: transparent;
157
-
background-clip: text;
158
-
}
159
-
160
-
.docs-content h2 {
161
-
font-size: 1.875rem;
162
-
font-weight: 700;
163
-
margin-top: 3rem;
164
-
margin-bottom: 1.5rem;
165
-
color: #1e293b;
166
-
}
167
-
168
-
.docs-content h3 {
169
-
font-size: 1.5rem;
170
-
font-weight: 600;
171
-
margin-top: 2rem;
172
-
margin-bottom: 1rem;
173
-
color: #334155;
174
-
}
175
-
176
-
.docs-content h4 {
177
-
font-size: 1.25rem;
178
-
font-weight: 600;
179
-
margin-top: 1.5rem;
180
-
margin-bottom: 0.75rem;
181
-
color: #475569;
182
-
}
183
-
184
-
.docs-content p {
185
-
margin-bottom: 1.25rem;
186
-
line-height: 1.8;
187
-
color: #475569;
188
-
}
189
-
190
-
.docs-content a {
191
-
color: #6366f1;
192
-
text-decoration: none;
193
-
border-bottom: 1px solid #c7d2fe;
194
-
transition: all 0.2s ease;
195
-
}
196
-
197
-
.docs-content a:hover {
198
-
color: #4f46e5;
199
-
border-bottom-color: #6366f1;
200
-
}
201
-
202
-
.docs-content ul, .docs-content ol {
203
-
margin-bottom: 1.5rem;
204
-
padding-left: 2rem;
205
-
}
206
-
207
-
.docs-content li {
208
-
margin-bottom: 0.5rem;
209
-
line-height: 1.8;
210
-
color: #475569;
211
-
}
212
-
213
-
.docs-content code {
214
-
font-family: 'Monaco', 'Menlo', monospace;
215
-
font-size: 0.875em;
216
-
background: #f1f5f9;
217
-
padding: 0.2em 0.4em;
218
-
border-radius: 4px;
219
-
color: #e879b9;
220
-
}
221
-
222
-
.docs-content pre {
223
-
background: #1e1b29;
224
-
border-radius: 8px;
225
-
padding: 1rem;
226
-
overflow-x: auto;
227
-
margin-bottom: 1.5rem;
228
-
}
229
-
230
-
@media (min-width: 768px) {
231
-
.docs-content pre {
232
-
padding: 1.25rem;
233
-
}
234
-
}
235
-
236
-
.docs-content pre code {
237
-
background: transparent;
238
-
padding: 0;
239
-
color: inherit;
240
-
font-size: 0.75rem;
241
-
line-height: 1.6;
242
-
}
243
-
244
-
@media (min-width: 768px) {
245
-
.docs-content pre code {
246
-
font-size: 0.875rem;
247
-
line-height: 1.7;
248
-
}
249
-
}
250
-
251
-
.docs-content table {
252
-
width: 100%;
253
-
border-collapse: collapse;
254
-
margin-bottom: 1.5rem;
255
-
font-size: 0.9375rem;
256
-
}
257
-
258
-
.docs-content th,
259
-
.docs-content td {
260
-
text-align: left;
261
-
padding: 0.75rem 1rem;
262
-
border: 1px solid #e2e8f0;
263
-
}
264
-
265
-
.docs-content th {
266
-
background: #f8fafc;
267
-
font-weight: 600;
268
-
color: #1e293b;
269
-
}
270
-
271
-
.docs-content td {
272
-
color: #475569;
273
-
}
274
-
275
-
.docs-content blockquote {
276
-
border-left: 4px solid #7a8ef7;
277
-
padding-left: 1.5rem;
278
-
margin: 1.5rem 0;
279
-
color: #64748b;
280
-
font-style: italic;
281
-
}
282
-
283
-
.comparison {
284
-
background: #1e1b29;
285
-
border-radius: 12px;
286
-
box-shadow: 0 4px 6px rgba(0, 0, 0, 0.1);
287
-
overflow: hidden;
288
-
margin: 2rem 0;
289
-
}
290
-
291
-
.comparison-content {
292
-
position: relative;
293
-
padding: 0.75rem;
294
-
display: grid;
295
-
grid-template-columns: 1fr;
296
-
gap: 1.5rem;
297
-
}
298
-
299
-
@media (min-width: 768px) {
300
-
.comparison-content {
301
-
padding: 1rem;
302
-
grid-template-columns: 1fr 1fr;
303
-
gap: 2rem;
304
-
}
305
-
}
306
-
307
-
.code-panel {
308
-
position: relative;
309
-
min-width: 0;
310
-
overflow: hidden;
311
-
text-align: left;
312
-
}
313
-
314
-
.code-header {
315
-
padding: 0.5rem 1rem;
316
-
background: #252231;
317
-
border-radius: 8px 8px 0 0;
318
-
font-size: 0.75rem;
319
-
font-weight: 600;
320
-
text-transform: uppercase;
321
-
letter-spacing: 0.05em;
322
-
margin: 0;
323
-
color: #94a3b8;
324
-
display: flex;
325
-
align-items: center;
326
-
justify-content: space-between;
327
-
}
328
-
329
-
@media (min-width: 768px) {
330
-
.code-header {
331
-
font-size: 0.8125rem;
332
-
padding: 0.625rem 1rem;
333
-
}
334
-
}
335
-
336
-
.code-block {
337
-
position: relative;
338
-
text-align: left;
339
-
}
340
-
341
-
.code-panel:last-child .code-block {
342
-
overflow-y: auto;
343
-
max-height: 400px;
344
-
-webkit-mask-image: linear-gradient(to bottom, black calc(100% - 100px), transparent 100%);
345
-
mask-image: linear-gradient(to bottom, black calc(100% - 100px), transparent 100%);
346
-
}
347
-
348
-
/* Freeze inner scrollables when scrolling the page */
349
-
body.outer-scrolling .code-panel:last-child .code-block {
350
-
pointer-events: none;
351
-
overflow-y: hidden;
352
-
}
353
-
354
-
@media (min-width: 768px) {
355
-
.code-panel:first-child {
356
-
position: relative;
357
-
z-index: 1;
358
-
}
359
-
360
-
.code-panel:last-child {
361
-
position: absolute;
362
-
top: 1rem;
363
-
bottom: 1rem;
364
-
right: 1rem;
365
-
left: calc(50% + 1rem);
366
-
}
367
-
368
-
.code-panel:last-child .code-block {
369
-
max-height: none;
370
-
height: 100%;
371
-
padding-bottom: 1.5rem;
372
-
-webkit-mask-image: linear-gradient(to bottom, black calc(100% - 150px), transparent 100%);
373
-
mask-image: linear-gradient(to bottom, black calc(100% - 150px), transparent 100%);
374
-
}
375
-
376
-
body.outer-scrolling .code-panel:last-child .code-block {
377
-
pointer-events: none;
378
-
overflow-y: hidden;
379
-
}
380
-
}
381
-
382
-
.code-block pre {
383
-
margin: 0;
384
-
padding: 1rem;
385
-
background: transparent !important;
386
-
overflow-x: auto;
387
-
overflow-y: visible;
388
-
-webkit-overflow-scrolling: touch;
389
-
max-width: 100%;
390
-
}
391
-
392
-
@media (min-width: 768px) {
393
-
.code-block pre {
394
-
padding: 1.5rem;
395
-
}
396
-
}
397
-
398
-
.code-block code {
399
-
font-family: 'Monaco', 'Menlo', monospace;
400
-
font-size: 0.75rem !important;
401
-
line-height: 1.6;
402
-
white-space: pre;
403
-
text-align: left;
404
-
}
405
-
406
-
@media (min-width: 768px) {
407
-
.code-block code {
408
-
font-size: 0.875rem !important;
409
-
}
410
-
}
411
-
412
-
.code-block pre code,
413
-
.code-block pre code * {
414
-
font-size: inherit !important;
415
-
}
416
-
417
-
.code-playground-link {
418
-
display: inline-flex;
419
-
align-items: center;
420
-
justify-content: center;
421
-
color: #94a3b8;
422
-
transition: all 0.2s ease;
423
-
text-decoration: none;
424
-
opacity: 0.4;
425
-
padding: 0.125rem;
426
-
border-bottom: none !important;
427
-
}
428
-
429
-
.code-playground-link:hover {
430
-
color: #c7d2fe;
431
-
opacity: 1;
432
-
}
433
-
434
-
.code-playground-link svg {
435
-
width: 1rem;
436
-
height: 1rem;
437
-
}
438
-
439
-
@media (min-width: 768px) {
440
-
.code-playground-link svg {
441
-
width: 1.125rem;
442
-
height: 1.125rem;
443
-
}
444
-
}
445
-
</style>
+234
-45
packages/website/src/pages/index.astro
+234
-45
packages/website/src/pages/index.astro
···
1
1
---
2
-
import BaseLayout from '../layouts/BaseLayout.astro';
3
-
import ComparisonBlock from '../components/ComparisonBlock.astro';
4
2
import { highlightCode } from '../utils/shiki';
3
+
import { compileToJson } from '../utils/compile';
5
4
import { createPlaygroundUrl } from '../utils/playground-url';
5
+
import stringify from 'json-stringify-pretty-compact';
6
+
import { mkdtempSync, writeFileSync, rmSync } from 'fs';
7
+
import { join } from 'path';
8
+
import { tmpdir } from 'os';
6
9
7
10
// Define examples inline
8
11
const examples = [
9
12
{
10
13
title: "Records and properties",
11
-
code: `import "@typelex/emitter";
14
+
typelex: `import "@typelex/emitter";
12
15
13
16
namespace fm.teal.alpha.feed.play {
14
17
@rec("tid")
15
18
model Main {
16
19
@maxItems(10)
17
20
artistNames?: string[];
18
-
21
+
19
22
@required
20
23
@minLength(1)
21
24
@maxLength(256)
···
28
31
},
29
32
{
30
33
title: "Refs and unions",
31
-
code: `import "@typelex/emitter";
34
+
typelex: `import "@typelex/emitter";
32
35
33
36
namespace app.bsky.feed.post {
34
37
@rec("tid")
···
63
66
},
64
67
{
65
68
title: "Queries and params",
66
-
code: `import "@typelex/emitter";
69
+
typelex: `import "@typelex/emitter";
67
70
68
71
namespace com.atproto.repo.listRecords {
69
72
@query
···
96
99
},
97
100
];
98
101
99
-
const heroCode = `import "@typelex/emitter";
102
+
// Compile examples
103
+
const highlighted = await Promise.all(
104
+
examples.map(async (ex) => {
105
+
// Create temporary file for compilation
106
+
const tmpDir = mkdtempSync(join(tmpdir(), 'typelex-'));
107
+
const tmpFile = join(tmpDir, 'example.tsp');
108
+
writeFileSync(tmpFile, ex.typelex);
109
+
110
+
try {
111
+
const lexiconJson = await compileToJson(tmpFile);
112
+
const lexicon = stringify(JSON.parse(lexiconJson), { maxLength: 80 });
113
+
114
+
return {
115
+
...ex,
116
+
typelexHtml: await highlightCode(ex.typelex, 'typespec'),
117
+
lexiconHtml: await highlightCode(lexicon, 'json'),
118
+
playgroundUrl: createPlaygroundUrl(ex.typelex),
119
+
};
120
+
} finally {
121
+
rmSync(tmpDir, { recursive: true, force: true });
122
+
}
123
+
})
124
+
);
125
+
---
126
+
127
+
<!DOCTYPE html>
128
+
<html lang="en">
129
+
<head>
130
+
<meta charset="utf-8" />
131
+
<link rel="icon" type="image/svg+xml" href="/favicon.svg" />
132
+
<meta name="viewport" content="width=device-width, initial-scale=1" />
133
+
<meta name="generator" content={Astro.generator} />
134
+
<title>typelex โ An experimental TypeSpec syntax for Lexicon</title>
135
+
<meta name="description" content="An experimental TypeSpec syntax for AT Protocol Lexicons. Write Lexicons in a more readable syntax using TypeSpec." />
136
+
137
+
<!-- Open Graph / Facebook -->
138
+
<meta property="og:type" content="website" />
139
+
<meta property="og:url" content="https://typelex.org/" />
140
+
<meta property="og:title" content="typelex โ An experimental TypeSpec syntax for Lexicon" />
141
+
<meta property="og:description" content="An experimental TypeSpec syntax for AT Protocol Lexicons. Write Lexicons in a more readable syntax using TypeSpec." />
142
+
<meta property="og:image" content="https://typelex.org/og.png" />
143
+
144
+
<!-- Twitter -->
145
+
<meta property="twitter:card" content="summary_large_image" />
146
+
<meta property="twitter:url" content="https://typelex.org/" />
147
+
<meta property="twitter:title" content="typelex โ An experimental TypeSpec syntax for Lexicon" />
148
+
<meta property="twitter:description" content="An experimental TypeSpec syntax for AT Protocol Lexicons. Write Lexicons in a more readable syntax using TypeSpec." />
149
+
<meta property="twitter:image" content="https://typelex.org/og.png" />
150
+
</head>
151
+
<body>
152
+
<main class="container">
153
+
<header>
154
+
<h1>typelex</h1>
155
+
<p class="tagline">An experimental <a href="https://typespec.io" target="_blank" rel="noopener noreferrer">TypeSpec</a> syntax for <a href="https://atproto.com/specs/lexicon" target="_blank" rel="noopener noreferrer">Lexicon</a></p>
156
+
157
+
<figure class="hero-comparison">
158
+
<div class="comparison-content">
159
+
<div class="hero-panel">
160
+
<p class="hero-header">
161
+
Typelex
162
+
<a href={createPlaygroundUrl(`import "@typelex/emitter";
100
163
101
164
namespace app.bsky.actor.profile {
102
165
@rec("self")
···
109
172
@maxGraphemes(256)
110
173
description?: string;
111
174
}
112
-
}`;
175
+
}`)} target="_blank" rel="noopener noreferrer" class="code-playground-link" aria-label="Open in playground">
176
+
<svg width="14" height="14" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg" aria-hidden="true">
177
+
<path d="M6.5 3.5C6.5 3.22386 6.72386 3 7 3H13C13.2761 3 13.5 3.22386 13.5 3.5V9.5C13.5 9.77614 13.2761 10 13 10C12.7239 10 12.5 9.77614 12.5 9.5V4.70711L6.85355 10.3536C6.65829 10.5488 6.34171 10.5488 6.14645 10.3536C5.95118 10.1583 5.95118 9.84171 6.14645 9.64645L11.7929 4H7C6.72386 4 6.5 3.77614 6.5 3.5Z" fill="currentColor"/>
178
+
<path d="M3 5.5C3 4.67157 3.67157 4 4.5 4H5C5.27614 4 5.5 4.22386 5.5 4.5C5.5 4.77614 5.27614 5 5 5H4.5C4.22386 5 4 5.22386 4 5.5V11.5C4 11.7761 4.22386 12 4.5 12H10.5C10.7761 12 11 11.7761 11 11.5V11C11 10.7239 11.2239 10.5 11.5 10.5C11.7761 10.5 12 10.7239 12 11V11.5C12 12.3284 11.3284 13 10.5 13H4.5C3.67157 13 3 12.3284 3 11.5V5.5Z" fill="currentColor"/>
179
+
</svg>
180
+
</a>
181
+
</p>
182
+
<div class="hero-code" set:html={await highlightCode(`import "@typelex/emitter";
113
183
114
-
const installCode = `import "@typelex/emitter";
115
-
import "./externals.tsp";
184
+
namespace app.bsky.actor.profile {
185
+
@rec("self")
186
+
model Main {
187
+
@maxLength(64)
188
+
@maxGraphemes(64)
189
+
displayName?: string;
116
190
117
-
namespace com.myapp.example.profile {
118
-
/** My profile. */
119
-
@rec("literal:self")
120
-
model Main {
121
-
/** Free-form profile description.*/
191
+
@maxLength(256)
122
192
@maxGraphemes(256)
123
193
description?: string;
124
194
}
125
-
}`;
126
-
---
127
-
128
-
<BaseLayout title="typelex โ An experimental TypeSpec syntax for Lexicon" transparentNav={true}>
129
-
<main class="container">
130
-
<header>
131
-
<h1>typelex</h1>
132
-
<p class="tagline">An experimental <a href="https://typespec.io" target="_blank" rel="noopener noreferrer">TypeSpec</a> syntax for <a href="https://atproto.com/specs/lexicon" target="_blank" rel="noopener noreferrer">Lexicon</a></p>
133
-
134
-
<ComparisonBlock code={heroCode} hero={true} />
195
+
}`, 'typespec')} />
196
+
</div>
197
+
<div class="hero-panel">
198
+
<p class="hero-header">
199
+
Lexicon
200
+
</p>
201
+
<div class="hero-code" set:html={await highlightCode(stringify({
202
+
"lexicon": 1,
203
+
"id": "app.bsky.actor.profile",
204
+
"defs": {
205
+
"main": {
206
+
"type": "record",
207
+
"key": "self",
208
+
"record": {
209
+
"type": "object",
210
+
"properties": {
211
+
"displayName": {
212
+
"type": "string",
213
+
"maxLength": 64,
214
+
"maxGraphemes": 64
215
+
},
216
+
"description": {
217
+
"type": "string",
218
+
"maxLength": 256,
219
+
"maxGraphemes": 256
220
+
}
221
+
}
222
+
}
223
+
}
224
+
}
225
+
}, { maxLength: 50 }), 'json')} />
226
+
</div>
227
+
</div>
228
+
</figure>
135
229
136
230
<p class="hero-description">
137
231
Typelex lets you write AT <a target="_blank" href="https://atproto.com/specs/lexicon">Lexicons</a> in a more readable syntax. <br />
···
140
234
141
235
<nav class="hero-actions">
142
236
<a href="#install" class="install-cta">Try It</a>
143
-
<a target="_blank" href="https://tangled.org/@danabra.mov/typelex/blob/main/DOCS.md" class="star-btn">
237
+
<a href="https://tangled.org/@danabra.mov/typelex/blob/main/DOCS.md" target="_blank" rel="noopener noreferrer" class="star-btn">
144
238
Read Docs
145
239
</a>
146
240
</nav>
···
148
242
149
243
<hr class="separator" />
150
244
151
-
{examples.map(({ title, code }) => (
245
+
{highlighted.map(({ title, typelexHtml, lexiconHtml, playgroundUrl }) => (
152
246
<section>
153
247
<h2>{title}</h2>
154
-
<ComparisonBlock code={code} />
248
+
<figure class="comparison">
249
+
<div class="comparison-content">
250
+
<div class="code-panel">
251
+
<p class="code-header">
252
+
Typelex
253
+
<a href={playgroundUrl} target="_blank" rel="noopener noreferrer" class="code-playground-link" aria-label="Open in playground">
254
+
<svg width="14" height="14" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg" aria-hidden="true">
255
+
<path d="M6.5 3.5C6.5 3.22386 6.72386 3 7 3H13C13.2761 3 13.5 3.22386 13.5 3.5V9.5C13.5 9.77614 13.2761 10 13 10C12.7239 10 12.5 9.77614 12.5 9.5V4.70711L6.85355 10.3536C6.65829 10.5488 6.34171 10.5488 6.14645 10.3536C5.95118 10.1583 5.95118 9.84171 6.14645 9.64645L11.7929 4H7C6.72386 4 6.5 3.77614 6.5 3.5Z" fill="currentColor"/>
256
+
<path d="M3 5.5C3 4.67157 3.67157 4 4.5 4H5C5.27614 4 5.5 4.22386 5.5 4.5C5.5 4.77614 5.27614 5 5 5H4.5C4.22386 5 4 5.22386 4 5.5V11.5C4 11.7761 4.22386 12 4.5 12H10.5C10.7761 12 11 11.7761 11 11.5V11C11 10.7239 11.2239 10.5 11.5 10.5C11.7761 10.5 12 10.7239 12 11V11.5C12 12.3284 11.3284 13 10.5 13H4.5C3.67157 13 3 12.3284 3 11.5V5.5Z" fill="currentColor"/>
257
+
</svg>
258
+
</a>
259
+
</p>
260
+
<div class="code-block" set:html={typelexHtml} />
261
+
</div>
262
+
<div class="code-panel">
263
+
<p class="code-header">
264
+
Lexicon
265
+
</p>
266
+
<div class="code-block" set:html={lexiconHtml} />
267
+
</div>
268
+
</div>
269
+
</figure>
155
270
</section>
156
271
))}
157
272
···
167
282
<div class="step-number">0</div>
168
283
<div class="step-content">
169
284
<h3>Try the playground</h3>
285
+
<p class="step-description">Experiment with typelex in your browser before installing.</p>
170
286
<a href="https://playground.typelex.org" target="_blank" rel="noopener noreferrer" class="playground-button">
171
287
Open Playground
172
288
</a>
173
-
<p class="step-description">Experiment with typelex in your browser before installing.</p>
174
289
</div>
175
290
</div>
176
291
177
292
<div class="install-step">
178
293
<div class="step-number">1</div>
179
294
<div class="step-content">
180
-
<h3>Add typelex to your app</h3>
181
-
<figure class="install-box" set:html={await highlightCode('npx @typelex/cli init', 'bash')} />
182
-
<p class="step-description">This will add a few things to your <code>package.json</code> and create a <code>typelex/</code> folder.</p>
295
+
<h3>Install packages</h3>
296
+
<figure class="install-box" set:html={await highlightCode('npm install -D @typespec/compiler @typelex/emitter', 'bash')} />
183
297
</div>
184
298
</div>
185
299
186
300
<div class="install-step">
187
301
<div class="step-number">2</div>
188
302
<div class="step-content">
189
-
<h3>Write your lexicons in <code>typelex/main.tsp</code></h3>
190
-
<figure class="install-box" set:html={await highlightCode(installCode, 'typespec')} />
191
-
<p class="step-description">Your app's lexicons go here. They may reference any external ones from <code>lexicons/</code>.</p>
303
+
<h3>Create <code>typelex/main.tsp</code></h3>
304
+
<figure class="install-box install-box-with-link">
305
+
<a href={createPlaygroundUrl(`import "@typelex/emitter";
306
+
307
+
namespace com.example.actor.profile {
308
+
/** My profile. */
309
+
@rec("literal:self")
310
+
model Main {
311
+
/** Free-form profile description.*/
312
+
@maxGraphemes(256)
313
+
description?: string;
314
+
}
315
+
}`)} target="_blank" rel="noopener noreferrer" class="install-playground-link" aria-label="Open in playground">
316
+
<svg width="14" height="14" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg" aria-hidden="true">
317
+
<path d="M6.5 3.5C6.5 3.22386 6.72386 3 7 3H13C13.2761 3 13.5 3.22386 13.5 3.5V9.5C13.5 9.77614 13.2761 10 13 10C12.7239 10 12.5 9.77614 12.5 9.5V4.70711L6.85355 10.3536C6.65829 10.5488 6.34171 10.5488 6.14645 10.3536C5.95118 10.1583 5.95118 9.84171 6.14645 9.64645L11.7929 4H7C6.72386 4 6.5 3.77614 6.5 3.5Z" fill="currentColor"/>
318
+
<path d="M3 5.5C3 4.67157 3.67157 4 4.5 4H5C5.27614 4 5.5 4.22386 5.5 4.5C5.5 4.77614 5.27614 5 5 5H4.5C4.22386 5 4 5.22386 4 5.5V11.5C4 11.7761 4.22386 12 4.5 12H10.5C10.7761 12 11 11.7761 11 11.5V11C11 10.7239 11.2239 10.5 11.5 10.5C11.7761 10.5 12 10.7239 12 11V11.5C12 12.3284 11.3284 13 10.5 13H4.5C3.67157 13 3 12.3284 3 11.5V5.5Z" fill="currentColor"/>
319
+
</svg>
320
+
</a>
321
+
<div set:html={await highlightCode(`import "@typelex/emitter";
322
+
323
+
namespace com.example.actor.profile {
324
+
/** My profile. */
325
+
@rec("literal:self")
326
+
model Main {
327
+
/** Free-form profile description.*/
328
+
@maxGraphemes(256)
329
+
description?: string;
330
+
}
331
+
}`, 'typespec')} />
332
+
</figure>
192
333
</div>
334
+
<p class="step-description">Or grab any example Lexicon <a target=_blank href="https://playground.typelex.org/">from the Playground</a>.</p>
193
335
</div>
194
336
195
337
<div class="install-step">
196
338
<div class="step-number">3</div>
197
339
<div class="step-content">
198
-
<h3>Compile your lexicons</h3>
199
-
<figure class="install-box" set:html={await highlightCode(`npm run build:typelex`, 'bash')} />
200
-
<p class="step-description">Your appโs compiled lexicons will appear in <code>lexicons/</code> alongside any external ones.</p>
340
+
<h3>Create <code><a href="https://typespec.io/docs/handbook/configuration/configuration/" target="_blank" rel="noopener noreferrer">tspconfig.yaml</a></code></h3>
341
+
<figure class="install-box" set:html={await highlightCode(`emit:
342
+
- "@typelex/emitter"
343
+
options:
344
+
"@typelex/emitter":
345
+
output-dir: "./lexicons"`, 'yaml')} />
201
346
</div>
202
347
</div>
203
348
204
349
<div class="install-step">
205
350
<div class="step-number">4</div>
206
351
<div class="step-content">
352
+
<h3>Add a build script to <code>package.json</code></h3>
353
+
<figure class="install-box" set:html={await highlightCode(`{
354
+
"scripts": {
355
+
// ...
356
+
"build:lexicons": "tsp compile typelex/main.tsp"
357
+
}
358
+
}`, 'json')} />
359
+
</div>
360
+
</div>
361
+
362
+
<div class="install-step">
363
+
<div class="step-number">5</div>
364
+
<div class="step-content">
365
+
<h3>Generate Lexicon files</h3>
366
+
<figure class="install-box" set:html={await highlightCode(`npm run build:lexicons`, 'bash')} />
367
+
<p class="step-description">Lexicon files will be generated in the <code>output-dir</code> from your <code>tspconfig.yaml</code> config.</p>
368
+
</div>
369
+
</div>
370
+
371
+
<div class="install-step">
372
+
<div class="step-number">6</div>
373
+
<div class="step-content">
207
374
<h3>Set up VS Code</h3>
208
375
<p class="step-description">Install the <a href="https://typespec.io/docs/introduction/editor/vscode/" target="_blank" rel="noopener noreferrer">TypeSpec for VS Code extension</a> for syntax highlighting and IntelliSense.</p>
209
376
</div>
210
377
</div>
211
378
212
379
<div class="install-step">
213
-
<div class="step-number">5</div>
380
+
<div class="step-number">7</div>
214
381
<div class="step-content">
215
-
<h3>Learn more</h3>
382
+
<h3>Read the docs</h3>
216
383
<p class="step-description">Check out the <a href="https://tangled.org/@danabra.mov/typelex/blob/main/DOCS.md" target="_blank" rel="noopener noreferrer">documentation</a> to learn more.</p>
217
384
</div>
218
385
</div>
···
225
392
<p>This is my personal hobby project and is not affiliated with AT or endorsed by anyone.</p>
226
393
<p>Who knows if this is a good idea?</p>
227
394
</footer>
228
-
</main>
395
+
</main>
229
396
230
-
<script>
397
+
<script>
231
398
document.addEventListener('DOMContentLoaded', () => {
232
399
const scrollables = document.querySelectorAll('.code-panel:last-child .code-block, .hero-panel:last-child .hero-code');
233
400
···
270
437
}
271
438
}, { passive: true });
272
439
});
273
-
</script>
274
-
</BaseLayout>
440
+
</script>
441
+
</body>
442
+
</html>
275
443
276
444
<style is:global>
445
+
* {
446
+
margin: 0;
447
+
padding: 0;
448
+
box-sizing: border-box;
449
+
}
450
+
451
+
html {
452
+
scroll-behavior: smooth;
453
+
}
454
+
277
455
body {
456
+
font-family: system-ui, -apple-system, sans-serif;
457
+
line-height: 1.6;
458
+
color: #1e293b;
459
+
background: #f8fafc;
460
+
font-size: 16px;
278
461
position: relative;
279
462
overflow-x: hidden;
280
463
}
···
290
473
border-radius: 50%;
291
474
pointer-events: none;
292
475
z-index: 0;
476
+
}
477
+
478
+
@media (min-width: 768px) {
479
+
body {
480
+
font-size: 17px;
481
+
}
293
482
}
294
483
295
484
.container {
···
592
781
.install-section {
593
782
margin: 0;
594
783
padding: 0;
595
-
scroll-margin-top: 5rem;
596
784
}
597
785
598
786
.install-section h2 {
···
1030
1218
1031
1219
.playground-button {
1032
1220
display: inline-block;
1221
+
margin-top: 1.25rem;
1033
1222
padding: 0.875rem 2rem;
1034
1223
background: linear-gradient(135deg, #7a8ef7 0%, #9483f7 70%, #b87ed8 100%);
1035
1224
color: white;
+12
-12
pnpm-lock.yaml
+12
-12
pnpm-lock.yaml
···
14
14
15
15
packages/cli:
16
16
dependencies:
17
+
'@typelex/emitter':
18
+
specifier: ^0.2.0
19
+
version: 0.2.0(@typespec/compiler@1.4.0(@types/node@20.19.19))
17
20
'@typespec/compiler':
18
21
specifier: ^1.4.0
19
22
version: 1.4.0(@types/node@20.19.19)
20
-
globby:
21
-
specifier: ^14.0.0
22
-
version: 14.1.0
23
-
picocolors:
24
-
specifier: ^1.1.1
25
-
version: 1.1.1
26
23
yargs:
27
24
specifier: ^18.0.0
28
25
version: 18.0.0
29
26
devDependencies:
30
-
'@typelex/emitter':
31
-
specifier: workspace:*
32
-
version: link:../emitter
33
27
'@types/node':
34
28
specifier: ^20.0.0
35
29
version: 20.19.19
···
39
33
typescript:
40
34
specifier: ^5.0.0
41
35
version: 5.9.3
42
-
vitest:
43
-
specifier: ^1.0.0
44
-
version: 1.6.1(@types/node@20.19.19)
45
36
46
37
packages/emitter:
47
38
dependencies:
···
1675
1666
1676
1667
'@ts-morph/common@0.25.0':
1677
1668
resolution: {integrity: sha512-kMnZz+vGGHi4GoHnLmMhGNjm44kGtKUXGnOvrKmMwAuvNjM/PgKVGfUnL7IDvK7Jb2QQ82jq3Zmp04Gy+r3Dkg==}
1669
+
1670
+
'@typelex/emitter@0.2.0':
1671
+
resolution: {integrity: sha512-4Iw6VAnd9nCFGOkJcu9utWdmu9ZyPeAb1QX/B7KerGBmfc2FuIDqgZZ/mZ6c56atcZd62pb2oYF/3RgSFhEsoQ==}
1672
+
peerDependencies:
1673
+
'@typespec/compiler': ^1.4.0
1678
1674
1679
1675
'@types/babel__core@7.20.5':
1680
1676
resolution: {integrity: sha512-qoQprZvz5wQFJwMDqeseRXWv3rqMvhgpbXFfVyWhbx9X47POIA6i/+dXefEmZKoAgOaTdaIgNSMqMIU61yRyzA==}
···
7447
7443
minimatch: 9.0.5
7448
7444
path-browserify: 1.0.1
7449
7445
tinyglobby: 0.2.15
7446
+
7447
+
'@typelex/emitter@0.2.0(@typespec/compiler@1.4.0(@types/node@20.19.19))':
7448
+
dependencies:
7449
+
'@typespec/compiler': 1.4.0(@types/node@20.19.19)
7450
7450
7451
7451
'@types/babel__core@7.20.5':
7452
7452
dependencies:
-229
scripts/publish-all.sh
-229
scripts/publish-all.sh
···
1
-
#!/bin/bash
2
-
set -e
3
-
4
-
# Usage: ./scripts/publish-all.sh <version> [--dry]
5
-
# Example: ./scripts/publish-all.sh 0.4.0
6
-
# Example: ./scripts/publish-all.sh 0.4.0 --dry
7
-
8
-
if [ -z "$1" ]; then
9
-
echo "Error: Version argument required"
10
-
echo "Usage: ./scripts/publish-all.sh <version> [--dry]"
11
-
echo "Example: ./scripts/publish-all.sh 0.4.0"
12
-
echo "Example: ./scripts/publish-all.sh 0.4.0 --dry"
13
-
exit 1
14
-
fi
15
-
16
-
VERSION="$1"
17
-
DRY_RUN=false
18
-
19
-
if [ "$2" = "--dry" ]; then
20
-
DRY_RUN=true
21
-
fi
22
-
23
-
# Validate version format (basic semver check)
24
-
if ! [[ "$VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+(-[a-zA-Z0-9.]+)?$ ]]; then
25
-
echo "Error: Invalid version format. Use semver format (e.g., 0.4.0 or 0.4.0-beta.1)"
26
-
exit 1
27
-
fi
28
-
29
-
echo "๐ฆ Publishing all packages at version $VERSION"
30
-
echo ""
31
-
32
-
# Get the root directory
33
-
ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
34
-
cd "$ROOT_DIR"
35
-
36
-
# Find all package.json files in packages/*
37
-
ALL_PACKAGES=($(find packages -maxdepth 2 -name "package.json" -not -path "*/node_modules/*" | sort))
38
-
39
-
# Filter out private packages and topologically sort by dependencies
40
-
PACKAGES=($(node -e "
41
-
const fs = require('fs');
42
-
const allPackages = process.argv.slice(1);
43
-
44
-
// Filter out private packages
45
-
const packages = allPackages.filter(path => {
46
-
const pkg = JSON.parse(fs.readFileSync(path, 'utf-8'));
47
-
return !pkg.private;
48
-
});
49
-
50
-
// Build dependency graph
51
-
const graph = new Map();
52
-
const pkgNames = new Map();
53
-
54
-
packages.forEach(path => {
55
-
const pkg = JSON.parse(fs.readFileSync(path, 'utf-8'));
56
-
pkgNames.set(pkg.name, path);
57
-
58
-
const deps = new Set();
59
-
[pkg.dependencies, pkg.devDependencies, pkg.peerDependencies].forEach(depObj => {
60
-
if (depObj) {
61
-
Object.keys(depObj).forEach(dep => {
62
-
if (dep.startsWith('@typelex/')) {
63
-
deps.add(dep);
64
-
}
65
-
});
66
-
}
67
-
});
68
-
69
-
graph.set(pkg.name, deps);
70
-
});
71
-
72
-
// Topological sort - packages with more dependents first
73
-
const sorted = [];
74
-
const processed = new Set();
75
-
76
-
function visit(pkgName) {
77
-
if (processed.has(pkgName)) return;
78
-
processed.add(pkgName);
79
-
80
-
// Visit all dependencies first
81
-
const deps = graph.get(pkgName) || new Set();
82
-
deps.forEach(dep => {
83
-
if (graph.has(dep)) {
84
-
visit(dep);
85
-
}
86
-
});
87
-
88
-
sorted.push(pkgName);
89
-
}
90
-
91
-
// Visit all packages
92
-
graph.forEach((_, pkgName) => visit(pkgName));
93
-
94
-
// Output sorted package paths
95
-
sorted.forEach(name => {
96
-
if (pkgNames.has(name)) {
97
-
console.log(pkgNames.get(name));
98
-
}
99
-
});
100
-
" "${ALL_PACKAGES[@]}"))
101
-
102
-
if [ ${#PACKAGES[@]} -eq 0 ]; then
103
-
echo "Error: No publishable packages found in packages/"
104
-
exit 1
105
-
fi
106
-
107
-
echo "Found ${#PACKAGES[@]} publishable packages (topologically sorted):"
108
-
for pkg in "${PACKAGES[@]}"; do
109
-
PKG_NAME=$(node -p "require('./$pkg').name")
110
-
echo " - $PKG_NAME"
111
-
done
112
-
echo ""
113
-
114
-
# Update all package.json files with the new version
115
-
echo "๐ Updating versions in all packages..."
116
-
for pkg in "${PACKAGES[@]}"; do
117
-
PKG_DIR=$(dirname "$pkg")
118
-
PKG_NAME=$(node -p "require('./$pkg').name")
119
-
120
-
echo " Updating $PKG_NAME..."
121
-
122
-
# Update version
123
-
node -e "
124
-
const fs = require('fs');
125
-
const path = '$pkg';
126
-
const pkg = require('./' + path);
127
-
pkg.version = '$VERSION';
128
-
129
-
// Helper to preserve semver prefix (^, ~, etc.) and workspace: protocol
130
-
function updateVersion(currentVersion, newVersion) {
131
-
// Preserve workspace: protocol for monorepo
132
-
if (currentVersion.startsWith('workspace:')) {
133
-
return currentVersion;
134
-
}
135
-
// Preserve semver prefix
136
-
const match = currentVersion.match(/^([~^>=<]*)(.*)$/);
137
-
if (match) {
138
-
return match[1] + newVersion;
139
-
}
140
-
return newVersion;
141
-
}
142
-
143
-
// Helper to update dependencies
144
-
function updateDeps(deps) {
145
-
if (!deps) return;
146
-
for (const dep in deps) {
147
-
if (dep.startsWith('@typelex/')) {
148
-
deps[dep] = updateVersion(deps[dep], '$VERSION');
149
-
}
150
-
}
151
-
}
152
-
153
-
updateDeps(pkg.dependencies);
154
-
updateDeps(pkg.devDependencies);
155
-
updateDeps(pkg.peerDependencies);
156
-
157
-
fs.writeFileSync(path, JSON.stringify(pkg, null, 2) + '\n');
158
-
"
159
-
done
160
-
161
-
echo ""
162
-
echo "โ
All versions updated to $VERSION"
163
-
echo ""
164
-
165
-
if [ "$DRY_RUN" = true ]; then
166
-
echo "โ
Dry run complete! Version updates have been applied."
167
-
echo ""
168
-
echo "๐ Updated packages:"
169
-
for pkg in "${PACKAGES[@]}"; do
170
-
PKG_NAME=$(node -p "require('./$pkg').name")
171
-
echo " - $PKG_NAME@$VERSION"
172
-
done
173
-
echo ""
174
-
echo "๐ก Review the changes, then run without --dry to publish."
175
-
exit 0
176
-
fi
177
-
178
-
# Ask for confirmation
179
-
read -p "๐ Ready to publish all packages to npm. Continue? (y/N) " -n 1 -r
180
-
echo
181
-
if [[ ! $REPLY =~ ^[Yy]$ ]]; then
182
-
echo "โ Publish cancelled"
183
-
exit 1
184
-
fi
185
-
186
-
echo ""
187
-
echo "๐ค Publishing packages..."
188
-
echo ""
189
-
190
-
# Publish each package
191
-
PUBLISHED=()
192
-
FAILED=()
193
-
194
-
for pkg in "${PACKAGES[@]}"; do
195
-
PKG_DIR=$(dirname "$pkg")
196
-
PKG_NAME=$(node -p "require('./$pkg').name")
197
-
198
-
echo "Publishing $PKG_NAME..."
199
-
200
-
if (cd "$PKG_DIR" && npm publish --access public); then
201
-
echo " โ
$PKG_NAME published successfully"
202
-
PUBLISHED+=("$PKG_NAME")
203
-
else
204
-
echo " โ $PKG_NAME failed to publish"
205
-
FAILED+=("$PKG_NAME")
206
-
fi
207
-
208
-
echo ""
209
-
done
210
-
211
-
# Summary
212
-
echo "๐ Summary:"
213
-
echo ""
214
-
echo "Published (${#PUBLISHED[@]}):"
215
-
for pkg in "${PUBLISHED[@]}"; do
216
-
echo " โ
$pkg"
217
-
done
218
-
219
-
if [ ${#FAILED[@]} -gt 0 ]; then
220
-
echo ""
221
-
echo "Failed (${#FAILED[@]}):"
222
-
for pkg in "${FAILED[@]}"; do
223
-
echo " โ $pkg"
224
-
done
225
-
exit 1
226
-
fi
227
-
228
-
echo ""
229
-
echo "๐ All packages published successfully!"