@atcute/lex-cli 2.2.2 → 2.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -23,12 +23,38 @@ then run the tool:
23
23
  npm exec lex-cli generate -c ./lex.config.js
24
24
  ```
25
25
 
26
- highly recommend packaging the generated schemas as a publishable library for others to use.
26
+ ## publishing your schemas
27
+
28
+ if you're packaging your generated schemas as a publishable library, add the `atcute:lexicons`
29
+ field to your package.json. this allows other projects to automatically discover and import your
30
+ schemas without manual configuration.
31
+
32
+ ```json
33
+ {
34
+ "name": "@example/my-schemas",
35
+ "atcute:lexicons": {
36
+ "mappings": {
37
+ "com.example.*": {
38
+ "type": "namespace",
39
+ "path": "./types/{{nsid_remainder}}"
40
+ }
41
+ }
42
+ }
43
+ }
44
+ ```
45
+
46
+ the `path` field supports several template expansions:
47
+
48
+ - `.` or `./` at the start is replaced with the package name (e.g., `./types/foo` becomes
49
+ `@example/my-schemas/types/foo`, or `.` becomes `@example/my-schemas`)
50
+ - `{{nsid}}` - the full NSID with dots replaced by slashes (e.g., `com/example/foo/bar`)
51
+ - `{{nsid_prefix}}` - the part before the wildcard (e.g., `com/example`)
52
+ - `{{nsid_remainder}}` - the part after the prefix (e.g., `foo/bar`)
27
53
 
28
54
  ## external references
29
55
 
30
56
  when your lexicons reference types from namespaces outside your configured files, you'll need to
31
- configure mappings to resolve these references.
57
+ configure how these references are resolved.
32
58
 
33
59
  for example, if your lexicon references a type from another namespace:
34
60
 
@@ -54,7 +80,25 @@ for example, if your lexicon references a type from another namespace:
54
80
  }
55
81
  ```
56
82
 
57
- define mappings in your configuration to specify how external namespaces should be imported:
83
+ the simplest way to resolve external references is using the `imports` array with packages that
84
+ provide the `atcute:lexicons` metadata:
85
+
86
+ ```ts
87
+ // file: lex.config.js
88
+ import { defineLexiconConfig } from '@atcute/lex-cli';
89
+
90
+ export default defineLexiconConfig({
91
+ files: ['lexicons/**/*.json'],
92
+ outdir: 'src/lexicons/',
93
+ imports: ['@atcute/atproto', '@atcute/bluesky'],
94
+ });
95
+ ```
96
+
97
+ the CLI will automatically discover the namespace mappings from each package's `atcute:lexicons`
98
+ field in their package.json.
99
+
100
+ for packages without metadata, or when you need more fine-grained control over import resolution,
101
+ use the `mappings` configuration instead:
58
102
 
59
103
  ```ts
60
104
  // file: lex.config.js
@@ -81,6 +125,3 @@ export default defineLexiconConfig({
81
125
  ],
82
126
  });
83
127
  ```
84
-
85
- with this configuration, any reference to a lexicon in the `com.atproto.*` or `app.bsky.*` namespace
86
- will be imported from `@atcute/atproto` or `@atcute/bluesky`, respectively.
package/dist/cli.js CHANGED
@@ -1,85 +1,170 @@
1
1
  import * as fs from 'node:fs/promises';
2
2
  import * as path from 'node:path';
3
3
  import * as url from 'node:url';
4
- import { Builtins, Command, Option, Program } from '@externdefs/collider';
4
+ import { object } from '@optique/core/constructs';
5
+ import { command, constant, option } from '@optique/core/primitives';
6
+ import { run } from '@optique/run';
7
+ import { path as pathParser } from '@optique/run/valueparser';
5
8
  import pc from 'picocolors';
6
9
  import { lexiconDoc } from '@atcute/lexicon-doc';
7
10
  import { generateLexiconApi } from './codegen.js';
8
- const program = new Program({ binaryName: 'lex-cli' });
9
- program.register(Builtins.HelpCommand);
10
- program.register(class GenerateCommand extends Command {
11
- static paths = [['generate']];
12
- static usage = Command.Usage({
13
- description: `Generates TypeScript schema`,
14
- });
15
- config = Option.String(['-c', '--config'], {
16
- required: true,
17
- description: `Config file`,
18
- });
19
- async execute() {
20
- const configFilename = path.resolve(this.config);
21
- const configDirname = path.dirname(configFilename);
22
- let config;
23
- try {
24
- const configURL = url.pathToFileURL(configFilename);
25
- const configMod = (await import(configURL.href));
26
- config = configMod.default;
27
- }
28
- catch (err) {
29
- console.error(pc.bold(pc.red(`failed to import config:`)));
30
- console.error(err);
31
- return 1;
32
- }
33
- const documents = [];
34
- for await (const filename of fs.glob(config.files, { cwd: configDirname })) {
35
- let source;
11
+ import { packageJsonSchema } from './lexicon-metadata.js';
12
+ /**
13
+ * Resolves package imports to ImportMapping[]
14
+ */
15
+ const resolveImportsToMappings = async (imports, configDirname) => {
16
+ const mappings = [];
17
+ for (const packageName of imports) {
18
+ // Walk up from config directory to find package in node_modules
19
+ let packageJson;
20
+ let currentDir = configDirname;
21
+ let found = false;
22
+ while (currentDir !== path.dirname(currentDir)) {
23
+ const candidatePath = path.join(currentDir, 'node_modules', packageName, 'package.json');
36
24
  try {
37
- source = await fs.readFile(path.join(configDirname, filename), 'utf8');
25
+ const content = await fs.readFile(candidatePath, 'utf8');
26
+ packageJson = JSON.parse(content);
27
+ found = true;
28
+ break;
38
29
  }
39
30
  catch (err) {
40
- console.error(pc.bold(pc.red(`file read error with "${filename}"`)));
41
- console.error(err);
42
- return 1;
43
- }
44
- let json;
45
- try {
46
- json = JSON.parse(source);
47
- }
48
- catch (err) {
49
- console.error(pc.bold(pc.red(`json parse error in "${filename}"`)));
50
- console.error(err);
51
- return 1;
52
- }
53
- const result = lexiconDoc.try(json, { mode: 'strip' });
54
- if (!result.ok) {
55
- console.error(pc.bold(pc.red(`schema validation failed for "${filename}"`)));
56
- console.error(result.message);
57
- for (const issue of result.issues) {
58
- console.log(`- ${issue.code} at .${issue.path.join('.')}`);
31
+ // Only continue to parent if file not found
32
+ if (err.code !== 'ENOENT') {
33
+ console.error(pc.bold(pc.red(`failed to read package.json for "${packageName}":`)));
34
+ console.error(err);
35
+ process.exit(1);
59
36
  }
60
- return 1;
37
+ // Not found, try parent directory
38
+ currentDir = path.dirname(currentDir);
39
+ }
40
+ }
41
+ if (!found) {
42
+ console.error(pc.bold(pc.red(`failed to resolve package "${packageName}"`)));
43
+ console.error(`Could not find package in node_modules starting from ${configDirname}`);
44
+ process.exit(1);
45
+ }
46
+ // Validate package.json
47
+ const result = packageJsonSchema.try(packageJson, { mode: 'passthrough' });
48
+ if (!result.ok) {
49
+ console.error(pc.bold(pc.red(`invalid atcute:lexicons in "${packageName}":`)));
50
+ console.error(result.message);
51
+ for (const issue of result.issues) {
52
+ console.log(`- ${issue.code} at .${issue.path.join('.')}`);
61
53
  }
62
- documents.push(result.value);
54
+ process.exit(1);
63
55
  }
64
- const result = await generateLexiconApi({
65
- documents: documents,
66
- mappings: config.mappings ?? [],
67
- modules: {
68
- importSuffix: config.modules?.importSuffix ?? '.js',
69
- },
70
- prettier: {
71
- cwd: process.cwd(),
72
- },
73
- });
74
- const outdir = path.join(configDirname, config.outdir);
75
- for (const file of result.files) {
76
- const filename = path.join(outdir, file.filename);
77
- const dirname = path.dirname(filename);
78
- await fs.mkdir(dirname, { recursive: true });
79
- await fs.writeFile(filename, file.code);
56
+ const lexicons = result.value['atcute:lexicons'];
57
+ if (!lexicons?.mappings) {
58
+ continue;
80
59
  }
60
+ // Convert mapping to ImportMapping[]
61
+ for (const [pattern, entry] of Object.entries(lexicons.mappings)) {
62
+ const isWildcard = pattern.endsWith('.*');
63
+ mappings.push({
64
+ nsid: [pattern],
65
+ imports: (nsid) => {
66
+ // Check if pattern matches
67
+ if (isWildcard) {
68
+ if (!nsid.startsWith(pattern.slice(0, -1))) {
69
+ throw new Error(`NSID ${nsid} does not match pattern ${pattern}`);
70
+ }
71
+ }
72
+ else {
73
+ if (nsid !== pattern) {
74
+ throw new Error(`NSID ${nsid} does not match pattern ${pattern}`);
75
+ }
76
+ }
77
+ const nsidPrefix = isWildcard ? pattern.slice(0, -2) : pattern;
78
+ const nsidRemainder = isWildcard ? nsid.slice(nsidPrefix.length + 1) : '';
79
+ let expandedPath = entry.path
80
+ .replaceAll('{{nsid}}', nsid.replaceAll('.', '/'))
81
+ .replaceAll('{{nsid_remainder}}', nsidRemainder.replaceAll('.', '/'))
82
+ .replaceAll('{{nsid_prefix}}', nsidPrefix.replaceAll('.', '/'));
83
+ if (expandedPath === '.') {
84
+ expandedPath = packageName;
85
+ }
86
+ else if (expandedPath.startsWith('./')) {
87
+ expandedPath = `${packageName}/${expandedPath.slice(2)}`;
88
+ }
89
+ return {
90
+ type: entry.type,
91
+ from: expandedPath,
92
+ };
93
+ },
94
+ });
95
+ }
96
+ }
97
+ return mappings;
98
+ };
99
+ const parser = command('generate', object({
100
+ type: constant('generate'),
101
+ config: option('-c', '--config', pathParser({ metavar: 'CONFIG' })),
102
+ }));
103
+ const result = run(parser, { programName: 'lex-cli' });
104
+ if (result.type === 'generate') {
105
+ const configFilename = path.resolve(result.config);
106
+ const configDirname = path.dirname(configFilename);
107
+ let config;
108
+ try {
109
+ const configURL = url.pathToFileURL(configFilename);
110
+ const configMod = (await import(configURL.href));
111
+ config = configMod.default;
112
+ }
113
+ catch (err) {
114
+ console.error(pc.bold(pc.red(`failed to import config:`)));
115
+ console.error(err);
116
+ process.exit(1);
117
+ }
118
+ // Resolve imports to mappings
119
+ const importMappings = config.imports ? await resolveImportsToMappings(config.imports, configDirname) : [];
120
+ const allMappings = [...importMappings, ...(config.mappings ?? [])];
121
+ const documents = [];
122
+ for await (const filename of fs.glob(config.files, { cwd: configDirname })) {
123
+ let source;
124
+ try {
125
+ source = await fs.readFile(path.join(configDirname, filename), 'utf8');
126
+ }
127
+ catch (err) {
128
+ console.error(pc.bold(pc.red(`file read error with "${filename}"`)));
129
+ console.error(err);
130
+ process.exit(1);
131
+ }
132
+ let json;
133
+ try {
134
+ json = JSON.parse(source);
135
+ }
136
+ catch (err) {
137
+ console.error(pc.bold(pc.red(`json parse error in "${filename}"`)));
138
+ console.error(err);
139
+ process.exit(1);
140
+ }
141
+ const result = lexiconDoc.try(json, { mode: 'strip' });
142
+ if (!result.ok) {
143
+ console.error(pc.bold(pc.red(`schema validation failed for "${filename}"`)));
144
+ console.error(result.message);
145
+ for (const issue of result.issues) {
146
+ console.log(`- ${issue.code} at .${issue.path.join('.')}`);
147
+ }
148
+ process.exit(1);
149
+ }
150
+ documents.push(result.value);
151
+ }
152
+ const generationResult = await generateLexiconApi({
153
+ documents: documents,
154
+ mappings: allMappings,
155
+ modules: {
156
+ importSuffix: config.modules?.importSuffix ?? '.js',
157
+ },
158
+ prettier: {
159
+ cwd: process.cwd(),
160
+ },
161
+ });
162
+ const outdir = path.join(configDirname, config.outdir);
163
+ for (const file of generationResult.files) {
164
+ const filename = path.join(outdir, file.filename);
165
+ const dirname = path.dirname(filename);
166
+ await fs.mkdir(dirname, { recursive: true });
167
+ await fs.writeFile(filename, file.code);
81
168
  }
82
- });
83
- const exitCode = await program.run(process.argv.slice(2));
84
- process.exitCode = exitCode;
169
+ }
85
170
  //# sourceMappingURL=cli.js.map
package/dist/cli.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACvC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,KAAK,GAAG,MAAM,UAAU,CAAC;AAEhC,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC1E,OAAO,EAAE,MAAM,YAAY,CAAC;AAE5B,OAAO,EAAE,UAAU,EAAmB,MAAM,qBAAqB,CAAC;AAElE,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAGlD,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC;AAEvD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;AAEvC,OAAO,CAAC,QAAQ,CACf,MAAM,eAAgB,SAAQ,OAAO;IACpC,MAAM,CAAU,KAAK,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;IAEvC,MAAM,CAAU,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QACrC,WAAW,EAAE,6BAA6B;KAC1C,CAAC,CAAC;IAEH,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE;QAC1C,QAAQ,EAAE,IAAI;QACd,WAAW,EAAE,aAAa;KAC1B,CAAC,CAAC;IAEH,KAAK,CAAC,OAAO;QACZ,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACjD,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAEnD,IAAI,MAAqB,CAAC;QAC1B,IAAI,CAAC;YACJ,MAAM,SAAS,GAAG,GAAG,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;YACpD,MAAM,SAAS,GAAG,CAAC,MAAM,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAA+B,CAAC;YAC/E,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC;QAC5B,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC;YAC3D,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAEnB,OAAO,CAAC,CAAC;QACV,CAAC;QAED,MAAM,SAAS,GAAiB,EAAE,CAAC;QAEnC,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC,EAAE,CAAC;YAC5E,IAAI,MAAc,CAAC;YACnB,IAAI,CAAC;gBACJ,MAAM,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC;YACxE,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACd,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,yBAAyB,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC;gBACrE,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAEnB,OAAO,CAAC,CAAC;YACV,CAAC;YAED,IAAI,IAAa,CAAC;YAClB,IAAI,CAAC;gBACJ,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAC3B,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACd,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,wBAAwB,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC;gBACpE,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAEnB,OAAO,CAAC,CAAC;YACV,CAAC;YAED,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;YACvD,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;gBAChB,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,iCAAiC,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC;gBAC7E,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBAE9B,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;oBACnC,OAAO,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,IAAI,QAAQ,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBAC5D,CAAC;gBAED,OAAO,CAAC,CAAC;YACV,CAAC;YAED,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,kBAAkB,CAAC;YACvC,SAAS,EAAE,SAAS;YACpB,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,EAAE;YAC/B,OAAO,EAAE;gBACR,YAAY,EAAE,MAAM,CAAC,OAAO,EAAE,YAAY,IAAI,KAAK;aACnD;YACD,QAAQ,EAAE;gBACT,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE;aAClB;SACD,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QAEvD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YAClD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAEvC,MAAM,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC7C,MAAM,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACzC,CAAC;IACF,CAAC;CACD,CACD,CAAC;AAEF,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AAC1D,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC"}
1
+ {"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACvC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,KAAK,GAAG,MAAM,UAAU,CAAC;AAEhC,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AACrE,OAAO,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AACnC,OAAO,EAAE,IAAI,IAAI,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,MAAM,YAAY,CAAC;AAE5B,OAAO,EAAE,UAAU,EAAmB,MAAM,qBAAqB,CAAC;AAElE,OAAO,EAAE,kBAAkB,EAAsB,MAAM,cAAc,CAAC;AAEtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE1D;;GAEG;AACH,MAAM,wBAAwB,GAAG,KAAK,EACrC,OAAiB,EACjB,aAAqB,EACM,EAAE;IAC7B,MAAM,QAAQ,GAAoB,EAAE,CAAC;IAErC,KAAK,MAAM,WAAW,IAAI,OAAO,EAAE,CAAC;QACnC,gEAAgE;QAChE,IAAI,WAAoB,CAAC;QACzB,IAAI,UAAU,GAAG,aAAa,CAAC;QAC/B,IAAI,KAAK,GAAG,KAAK,CAAC;QAElB,OAAO,UAAU,KAAK,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YAChD,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,cAAc,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC;YACzF,IAAI,CAAC;gBACJ,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;gBACzD,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAClC,KAAK,GAAG,IAAI,CAAC;gBACb,MAAM;YACP,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBACnB,4CAA4C;gBAC5C,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAC3B,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,oCAAoC,WAAW,IAAI,CAAC,CAAC,CAAC,CAAC;oBACpF,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBACnB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBACjB,CAAC;gBAED,kCAAkC;gBAClC,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YACvC,CAAC;QACF,CAAC;QAED,IAAI,CAAC,KAAK,EAAE,CAAC;YACZ,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,8BAA8B,WAAW,GAAG,CAAC,CAAC,CAAC,CAAC;YAC7E,OAAO,CAAC,KAAK,CAAC,wDAAwD,aAAa,EAAE,CAAC,CAAC;YACvF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjB,CAAC;QAED,wBAAwB;QACxB,MAAM,MAAM,GAAG,iBAAiB,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC;QAC3E,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;YAChB,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,+BAA+B,WAAW,IAAI,CAAC,CAAC,CAAC,CAAC;YAC/E,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAE9B,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBACnC,OAAO,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,IAAI,QAAQ,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC5D,CAAC;YAED,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjB,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACjD,IAAI,CAAC,QAAQ,EAAE,QAAQ,EAAE,CAAC;YACzB,SAAS;QACV,CAAC;QAED,qCAAqC;QACrC,KAAK,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YAClE,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAE1C,QAAQ,CAAC,IAAI,CAAC;gBACb,IAAI,EAAE,CAAC,OAAO,CAAC;gBACf,OAAO,EAAE,CAAC,IAAY,EAAE,EAAE;oBACzB,2BAA2B;oBAC3B,IAAI,UAAU,EAAE,CAAC;wBAChB,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;4BAC5C,MAAM,IAAI,KAAK,CAAC,QAAQ,IAAI,2BAA2B,OAAO,EAAE,CAAC,CAAC;wBACnE,CAAC;oBACF,CAAC;yBAAM,CAAC;wBACP,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;4BACtB,MAAM,IAAI,KAAK,CAAC,QAAQ,IAAI,2BAA2B,OAAO,EAAE,CAAC,CAAC;wBACnE,CAAC;oBACF,CAAC;oBAED,MAAM,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;oBAC/D,MAAM,aAAa,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBAE1E,IAAI,YAAY,GAAG,KAAK,CAAC,IAAI;yBAC3B,UAAU,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;yBACjD,UAAU,CAAC,oBAAoB,EAAE,aAAa,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;yBACpE,UAAU,CAAC,iBAAiB,EAAE,UAAU,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;oBAEjE,IAAI,YAAY,KAAK,GAAG,EAAE,CAAC;wBAC1B,YAAY,GAAG,WAAW,CAAC;oBAC5B,CAAC;yBAAM,IAAI,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;wBAC1C,YAAY,GAAG,GAAG,WAAW,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC1D,CAAC;oBAED,OAAO;wBACN,IAAI,EAAE,KAAK,CAAC,IAAI;wBAChB,IAAI,EAAE,YAAY;qBAClB,CAAC;gBACH,CAAC;aACD,CAAC,CAAC;QACJ,CAAC;IACF,CAAC;IAED,OAAO,QAAQ,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,MAAM,GAAG,OAAO,CACrB,UAAU,EACV,MAAM,CAAC;IACN,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC;IAC1B,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,UAAU,EAAE,UAAU,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;CACnE,CAAC,CACF,CAAC;AAEF,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAC;AAEvD,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;IAChC,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACnD,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IAEnD,IAAI,MAAqB,CAAC;IAC1B,IAAI,CAAC;QACJ,MAAM,SAAS,GAAG,GAAG,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QACpD,MAAM,SAAS,GAAG,CAAC,MAAM,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAA+B,CAAC;QAC/E,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC;IAC5B,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACd,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC;QAC3D,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEnB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjB,CAAC;IAED,8BAA8B;IAC9B,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,wBAAwB,CAAC,MAAM,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC3G,MAAM,WAAW,GAAG,CAAC,GAAG,cAAc,EAAE,GAAG,CAAC,MAAM,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,CAAC;IAEpE,MAAM,SAAS,GAAiB,EAAE,CAAC;IAEnC,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC,EAAE,CAAC;QAC5E,IAAI,MAAc,CAAC;QACnB,IAAI,CAAC;YACJ,MAAM,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC;QACxE,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,yBAAyB,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC;YACrE,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAEnB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjB,CAAC;QAED,IAAI,IAAa,CAAC;QAClB,IAAI,CAAC;YACJ,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC3B,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,wBAAwB,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC;YACpE,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAEnB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjB,CAAC;QAED,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;QACvD,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;YAChB,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,iCAAiC,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC;YAC7E,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAE9B,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBACnC,OAAO,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,IAAI,QAAQ,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC5D,CAAC;YAED,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjB,CAAC;QAED,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED,MAAM,gBAAgB,GAAG,MAAM,kBAAkB,CAAC;QACjD,SAAS,EAAE,SAAS;QACpB,QAAQ,EAAE,WAAW;QACrB,OAAO,EAAE;YACR,YAAY,EAAE,MAAM,CAAC,OAAO,EAAE,YAAY,IAAI,KAAK;SACnD;QACD,QAAQ,EAAE;YACT,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE;SAClB;KACD,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAEvD,KAAK,MAAM,IAAI,IAAI,gBAAgB,CAAC,KAAK,EAAE,CAAC;QAC3C,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAClD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAEvC,MAAM,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC7C,MAAM,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;AACF,CAAC"}
package/dist/index.d.ts CHANGED
@@ -2,6 +2,7 @@ import type { ImportMapping } from './codegen.js';
2
2
  export interface LexiconConfig {
3
3
  outdir: string;
4
4
  files: string[];
5
+ imports?: string[];
5
6
  mappings?: ImportMapping[];
6
7
  modules?: {
7
8
  importSuffix?: string;
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAElD,MAAM,WAAW,aAAa;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAC;IAC3B,OAAO,CAAC,EAAE;QACT,YAAY,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACF;AAED,eAAO,MAAM,mBAAmB,GAAI,QAAQ,aAAa,KAAG,aAE3D,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAElD,MAAM,WAAW,aAAa;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAC;IAC3B,OAAO,CAAC,EAAE;QACT,YAAY,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACF;AAED,eAAO,MAAM,mBAAmB,GAAI,QAAQ,aAAa,KAAG,aAE3D,CAAC"}
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAWA,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,MAAqB,EAAiB,EAAE;IAC3E,OAAO,MAAM,CAAC;AACf,CAAC,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAYA,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,MAAqB,EAAiB,EAAE;IAC3E,OAAO,MAAM,CAAC;AACf,CAAC,CAAC"}
@@ -0,0 +1,19 @@
1
+ import * as v from '@badrap/valita';
2
+ export type LexiconMappingEntryType = 'namespace' | 'named';
3
+ export type LexiconMappingPath = '.' | `./${string}`;
4
+ export interface LexiconMappingEntry {
5
+ type: LexiconMappingEntryType;
6
+ path: LexiconMappingPath;
7
+ }
8
+ export interface AtcuteLexiconsField {
9
+ mappings?: Record<string, LexiconMappingEntry>;
10
+ }
11
+ export interface PackageJsonWithLexicons {
12
+ 'atcute:lexicons'?: AtcuteLexiconsField;
13
+ [key: string]: unknown;
14
+ }
15
+ /**
16
+ * Schema for package.json with atcute:lexicons field
17
+ */
18
+ export declare const packageJsonSchema: v.Type<PackageJsonWithLexicons>;
19
+ //# sourceMappingURL=lexicon-metadata.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"lexicon-metadata.d.ts","sourceRoot":"","sources":["../src/lexicon-metadata.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,gBAAgB,CAAC;AAIpC,MAAM,MAAM,uBAAuB,GAAG,WAAW,GAAG,OAAO,CAAC;AAC5D,MAAM,MAAM,kBAAkB,GAAG,GAAG,GAAG,KAAK,MAAM,EAAE,CAAC;AAErD,MAAM,WAAW,mBAAmB;IACnC,IAAI,EAAE,uBAAuB,CAAC;IAC9B,IAAI,EAAE,kBAAkB,CAAC;CACzB;AAED,MAAM,WAAW,mBAAmB;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;CAC/C;AAED,MAAM,WAAW,uBAAuB;IACvC,iBAAiB,CAAC,EAAE,mBAAmB,CAAC;IACxC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACvB;AAmDD;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAE5D,CAAC"}
@@ -0,0 +1,53 @@
1
+ import * as v from '@badrap/valita';
2
+ import { isNsid } from '@atcute/lexicons/syntax';
3
+ /**
4
+ * Validates if a string is a valid NSID pattern (exact or wildcard)
5
+ * - Exact: "com.atproto.repo.getRecord"
6
+ * - Wildcard: "com.atproto.*"
7
+ */
8
+ const isValidLexiconPattern = (pattern) => {
9
+ if (pattern.endsWith('.*')) {
10
+ // For wildcards, remove the .* and validate the prefix as an NSID segment
11
+ const prefix = pattern.slice(0, -2);
12
+ // Add a dummy segment to make it a valid NSID for validation
13
+ return isNsid(prefix + '.x');
14
+ }
15
+ return isNsid(pattern);
16
+ };
17
+ /**
18
+ * Schema for a single lexicon mapping entry
19
+ */
20
+ const lexiconMappingEntry = v.object({
21
+ type: v.union(v.literal('namespace'), v.literal('named')),
22
+ path: v
23
+ .string()
24
+ .assert((input) => input === '.' || input.startsWith('./'), {
25
+ message: `path must be "." or start with "./"`,
26
+ }),
27
+ });
28
+ /**
29
+ * Schema for the atcute:lexicons field in package.json
30
+ */
31
+ const mappingsSchema = v
32
+ .record(lexiconMappingEntry)
33
+ .chain((input) => {
34
+ for (const key in input) {
35
+ if (!isValidLexiconPattern(key)) {
36
+ return v.err({
37
+ message: `invalid NSID pattern (must be valid NSID or end with .*)`,
38
+ path: [key],
39
+ });
40
+ }
41
+ }
42
+ return v.ok(input);
43
+ });
44
+ const atcuteLexiconsField = v.object({
45
+ mappings: mappingsSchema.optional(),
46
+ });
47
+ /**
48
+ * Schema for package.json with atcute:lexicons field
49
+ */
50
+ export const packageJsonSchema = v.object({
51
+ 'atcute:lexicons': atcuteLexiconsField.optional(),
52
+ });
53
+ //# sourceMappingURL=lexicon-metadata.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"lexicon-metadata.js","sourceRoot":"","sources":["../src/lexicon-metadata.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,gBAAgB,CAAC;AAEpC,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAmBjD;;;;GAIG;AACH,MAAM,qBAAqB,GAAG,CAAC,OAAe,EAAW,EAAE;IAC1D,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5B,0EAA0E;QAC1E,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACpC,6DAA6D;QAC7D,OAAO,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAC9B,CAAC;IACD,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC;AACxB,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,mBAAmB,GAAgC,CAAC,CAAC,MAAM,CAAC;IACjE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACzD,IAAI,EAAE,CAAC;SACL,MAAM,EAAE;SACR,MAAM,CAAC,CAAC,KAAK,EAA+B,EAAE,CAAC,KAAK,KAAK,GAAG,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;QACxF,OAAO,EAAE,qCAAqC;KAC9C,CAAC;CACH,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,cAAc,GAAgD,CAAC;KACnE,MAAM,CAAC,mBAAmB,CAAC;KAC3B,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IAChB,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,CAAC;YACjC,OAAO,CAAC,CAAC,GAAG,CAAC;gBACZ,OAAO,EAAE,0DAA0D;gBACnE,IAAI,EAAE,CAAC,GAAG,CAAC;aACX,CAAC,CAAC;QACJ,CAAC;IACF,CAAC;IAED,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;AACpB,CAAC,CAAC,CAAC;AAEJ,MAAM,mBAAmB,GAAgC,CAAC,CAAC,MAAM,CAAC;IACjE,QAAQ,EAAE,cAAc,CAAC,QAAQ,EAAE;CACnC,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAoC,CAAC,CAAC,MAAM,CAAC;IAC1E,iBAAiB,EAAE,mBAAmB,CAAC,QAAQ,EAAE;CACjD,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "type": "module",
3
3
  "name": "@atcute/lex-cli",
4
- "version": "2.2.2",
4
+ "version": "2.3.1",
5
5
  "description": "cli tool to generate type definitions for atcute",
6
6
  "license": "0BSD",
7
7
  "repository": {
@@ -13,7 +13,8 @@
13
13
  "src/",
14
14
  "!src/**/*.bench.ts",
15
15
  "!src/**/*.test.ts",
16
- "cli.mjs"
16
+ "cli.mjs",
17
+ "schema/"
17
18
  ],
18
19
  "bin": "./cli.mjs",
19
20
  "exports": {
@@ -21,17 +22,20 @@
21
22
  },
22
23
  "dependencies": {
23
24
  "@badrap/valita": "^0.4.6",
24
- "@externdefs/collider": "^0.3.0",
25
+ "@optique/core": "^0.6.1",
26
+ "@optique/run": "^0.6.1",
25
27
  "picocolors": "^1.1.1",
26
28
  "prettier": "^3.6.2",
27
- "@atcute/lexicon-doc": "^1.1.2"
29
+ "@atcute/lexicon-doc": "^1.1.4"
28
30
  },
29
31
  "devDependencies": {
30
32
  "@types/node": "^22.18.0",
33
+ "tschema": "^3.2.0",
31
34
  "@atcute/lexicons": "^1.2.2"
32
35
  },
33
36
  "scripts": {
34
- "build": "tsc",
37
+ "build": "pnpm run generate:schema && tsc",
38
+ "generate:schema": "node scripts/generate-schema.js",
35
39
  "prepublish": "rm -rf dist; pnpm run build"
36
40
  }
37
41
  }
@@ -0,0 +1,39 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "$id": "https://unpkg.com/@atcute/lex-cli/schema/lexicon-package.schema.json",
4
+ "title": "package.json with atcute:lexicons",
5
+ "description": "JSON Schema for package.json with atcute:lexicons field for lexicon import mappings",
6
+ "additionalProperties": true,
7
+ "type": "object",
8
+ "properties": {
9
+ "atcute:lexicons": {
10
+ "type": "object",
11
+ "properties": {
12
+ "mappings": {
13
+ "type": "object",
14
+ "additionalProperties": {
15
+ "type": "object",
16
+ "properties": {
17
+ "type": {
18
+ "enum": [
19
+ "namespace",
20
+ "named"
21
+ ]
22
+ },
23
+ "path": {
24
+ "pattern": "^\\.$|^\\.\\/",
25
+ "type": "string"
26
+ }
27
+ },
28
+ "additionalProperties": false,
29
+ "required": [
30
+ "type",
31
+ "path"
32
+ ]
33
+ }
34
+ }
35
+ },
36
+ "additionalProperties": false
37
+ }
38
+ }
39
+ }
package/src/cli.ts CHANGED
@@ -2,108 +2,207 @@ import * as fs from 'node:fs/promises';
2
2
  import * as path from 'node:path';
3
3
  import * as url from 'node:url';
4
4
 
5
- import { Builtins, Command, Option, Program } from '@externdefs/collider';
5
+ import { object } from '@optique/core/constructs';
6
+ import { command, constant, option } from '@optique/core/primitives';
7
+ import { run } from '@optique/run';
8
+ import { path as pathParser } from '@optique/run/valueparser';
6
9
  import pc from 'picocolors';
7
10
 
8
11
  import { lexiconDoc, type LexiconDoc } from '@atcute/lexicon-doc';
9
12
 
10
- import { generateLexiconApi } from './codegen.js';
13
+ import { generateLexiconApi, type ImportMapping } from './codegen.js';
11
14
  import type { LexiconConfig } from './index.js';
15
+ import { packageJsonSchema } from './lexicon-metadata.js';
16
+
17
+ /**
18
+ * Resolves package imports to ImportMapping[]
19
+ */
20
+ const resolveImportsToMappings = async (
21
+ imports: string[],
22
+ configDirname: string,
23
+ ): Promise<ImportMapping[]> => {
24
+ const mappings: ImportMapping[] = [];
25
+
26
+ for (const packageName of imports) {
27
+ // Walk up from config directory to find package in node_modules
28
+ let packageJson: unknown;
29
+ let currentDir = configDirname;
30
+ let found = false;
31
+
32
+ while (currentDir !== path.dirname(currentDir)) {
33
+ const candidatePath = path.join(currentDir, 'node_modules', packageName, 'package.json');
34
+ try {
35
+ const content = await fs.readFile(candidatePath, 'utf8');
36
+ packageJson = JSON.parse(content);
37
+ found = true;
38
+ break;
39
+ } catch (err: any) {
40
+ // Only continue to parent if file not found
41
+ if (err.code !== 'ENOENT') {
42
+ console.error(pc.bold(pc.red(`failed to read package.json for "${packageName}":`)));
43
+ console.error(err);
44
+ process.exit(1);
45
+ }
12
46
 
13
- const program = new Program({ binaryName: 'lex-cli' });
47
+ // Not found, try parent directory
48
+ currentDir = path.dirname(currentDir);
49
+ }
50
+ }
14
51
 
15
- program.register(Builtins.HelpCommand);
52
+ if (!found) {
53
+ console.error(pc.bold(pc.red(`failed to resolve package "${packageName}"`)));
54
+ console.error(`Could not find package in node_modules starting from ${configDirname}`);
55
+ process.exit(1);
56
+ }
16
57
 
17
- program.register(
18
- class GenerateCommand extends Command {
19
- static override paths = [['generate']];
58
+ // Validate package.json
59
+ const result = packageJsonSchema.try(packageJson, { mode: 'passthrough' });
60
+ if (!result.ok) {
61
+ console.error(pc.bold(pc.red(`invalid atcute:lexicons in "${packageName}":`)));
62
+ console.error(result.message);
20
63
 
21
- static override usage = Command.Usage({
22
- description: `Generates TypeScript schema`,
23
- });
64
+ for (const issue of result.issues) {
65
+ console.log(`- ${issue.code} at .${issue.path.join('.')}`);
66
+ }
24
67
 
25
- config = Option.String(['-c', '--config'], {
26
- required: true,
27
- description: `Config file`,
28
- });
68
+ process.exit(1);
69
+ }
29
70
 
30
- async execute(): Promise<number | void> {
31
- const configFilename = path.resolve(this.config);
32
- const configDirname = path.dirname(configFilename);
71
+ const lexicons = result.value['atcute:lexicons'];
72
+ if (!lexicons?.mappings) {
73
+ continue;
74
+ }
33
75
 
34
- let config: LexiconConfig;
35
- try {
36
- const configURL = url.pathToFileURL(configFilename);
37
- const configMod = (await import(configURL.href)) as { default: LexiconConfig };
38
- config = configMod.default;
39
- } catch (err) {
40
- console.error(pc.bold(pc.red(`failed to import config:`)));
41
- console.error(err);
42
-
43
- return 1;
44
- }
76
+ // Convert mapping to ImportMapping[]
77
+ for (const [pattern, entry] of Object.entries(lexicons.mappings)) {
78
+ const isWildcard = pattern.endsWith('.*');
79
+
80
+ mappings.push({
81
+ nsid: [pattern],
82
+ imports: (nsid: string) => {
83
+ // Check if pattern matches
84
+ if (isWildcard) {
85
+ if (!nsid.startsWith(pattern.slice(0, -1))) {
86
+ throw new Error(`NSID ${nsid} does not match pattern ${pattern}`);
87
+ }
88
+ } else {
89
+ if (nsid !== pattern) {
90
+ throw new Error(`NSID ${nsid} does not match pattern ${pattern}`);
91
+ }
92
+ }
45
93
 
46
- const documents: LexiconDoc[] = [];
94
+ const nsidPrefix = isWildcard ? pattern.slice(0, -2) : pattern;
95
+ const nsidRemainder = isWildcard ? nsid.slice(nsidPrefix.length + 1) : '';
47
96
 
48
- for await (const filename of fs.glob(config.files, { cwd: configDirname })) {
49
- let source: string;
50
- try {
51
- source = await fs.readFile(path.join(configDirname, filename), 'utf8');
52
- } catch (err) {
53
- console.error(pc.bold(pc.red(`file read error with "${filename}"`)));
54
- console.error(err);
97
+ let expandedPath = entry.path
98
+ .replaceAll('{{nsid}}', nsid.replaceAll('.', '/'))
99
+ .replaceAll('{{nsid_remainder}}', nsidRemainder.replaceAll('.', '/'))
100
+ .replaceAll('{{nsid_prefix}}', nsidPrefix.replaceAll('.', '/'));
55
101
 
56
- return 1;
57
- }
102
+ if (expandedPath === '.') {
103
+ expandedPath = packageName;
104
+ } else if (expandedPath.startsWith('./')) {
105
+ expandedPath = `${packageName}/${expandedPath.slice(2)}`;
106
+ }
58
107
 
59
- let json: unknown;
60
- try {
61
- json = JSON.parse(source);
62
- } catch (err) {
63
- console.error(pc.bold(pc.red(`json parse error in "${filename}"`)));
64
- console.error(err);
108
+ return {
109
+ type: entry.type,
110
+ from: expandedPath,
111
+ };
112
+ },
113
+ });
114
+ }
115
+ }
65
116
 
66
- return 1;
67
- }
117
+ return mappings;
118
+ };
68
119
 
69
- const result = lexiconDoc.try(json, { mode: 'strip' });
70
- if (!result.ok) {
71
- console.error(pc.bold(pc.red(`schema validation failed for "${filename}"`)));
72
- console.error(result.message);
120
+ const parser = command(
121
+ 'generate',
122
+ object({
123
+ type: constant('generate'),
124
+ config: option('-c', '--config', pathParser({ metavar: 'CONFIG' })),
125
+ }),
126
+ );
73
127
 
74
- for (const issue of result.issues) {
75
- console.log(`- ${issue.code} at .${issue.path.join('.')}`);
76
- }
128
+ const result = run(parser, { programName: 'lex-cli' });
77
129
 
78
- return 1;
79
- }
130
+ if (result.type === 'generate') {
131
+ const configFilename = path.resolve(result.config);
132
+ const configDirname = path.dirname(configFilename);
80
133
 
81
- documents.push(result.value);
82
- }
134
+ let config: LexiconConfig;
135
+ try {
136
+ const configURL = url.pathToFileURL(configFilename);
137
+ const configMod = (await import(configURL.href)) as { default: LexiconConfig };
138
+ config = configMod.default;
139
+ } catch (err) {
140
+ console.error(pc.bold(pc.red(`failed to import config:`)));
141
+ console.error(err);
83
142
 
84
- const result = await generateLexiconApi({
85
- documents: documents,
86
- mappings: config.mappings ?? [],
87
- modules: {
88
- importSuffix: config.modules?.importSuffix ?? '.js',
89
- },
90
- prettier: {
91
- cwd: process.cwd(),
92
- },
93
- });
143
+ process.exit(1);
144
+ }
94
145
 
95
- const outdir = path.join(configDirname, config.outdir);
146
+ // Resolve imports to mappings
147
+ const importMappings = config.imports ? await resolveImportsToMappings(config.imports, configDirname) : [];
148
+ const allMappings = [...importMappings, ...(config.mappings ?? [])];
96
149
 
97
- for (const file of result.files) {
98
- const filename = path.join(outdir, file.filename);
99
- const dirname = path.dirname(filename);
150
+ const documents: LexiconDoc[] = [];
100
151
 
101
- await fs.mkdir(dirname, { recursive: true });
102
- await fs.writeFile(filename, file.code);
152
+ for await (const filename of fs.glob(config.files, { cwd: configDirname })) {
153
+ let source: string;
154
+ try {
155
+ source = await fs.readFile(path.join(configDirname, filename), 'utf8');
156
+ } catch (err) {
157
+ console.error(pc.bold(pc.red(`file read error with "${filename}"`)));
158
+ console.error(err);
159
+
160
+ process.exit(1);
161
+ }
162
+
163
+ let json: unknown;
164
+ try {
165
+ json = JSON.parse(source);
166
+ } catch (err) {
167
+ console.error(pc.bold(pc.red(`json parse error in "${filename}"`)));
168
+ console.error(err);
169
+
170
+ process.exit(1);
171
+ }
172
+
173
+ const result = lexiconDoc.try(json, { mode: 'strip' });
174
+ if (!result.ok) {
175
+ console.error(pc.bold(pc.red(`schema validation failed for "${filename}"`)));
176
+ console.error(result.message);
177
+
178
+ for (const issue of result.issues) {
179
+ console.log(`- ${issue.code} at .${issue.path.join('.')}`);
103
180
  }
181
+
182
+ process.exit(1);
104
183
  }
105
- },
106
- );
107
184
 
108
- const exitCode = await program.run(process.argv.slice(2));
109
- process.exitCode = exitCode;
185
+ documents.push(result.value);
186
+ }
187
+
188
+ const generationResult = await generateLexiconApi({
189
+ documents: documents,
190
+ mappings: allMappings,
191
+ modules: {
192
+ importSuffix: config.modules?.importSuffix ?? '.js',
193
+ },
194
+ prettier: {
195
+ cwd: process.cwd(),
196
+ },
197
+ });
198
+
199
+ const outdir = path.join(configDirname, config.outdir);
200
+
201
+ for (const file of generationResult.files) {
202
+ const filename = path.join(outdir, file.filename);
203
+ const dirname = path.dirname(filename);
204
+
205
+ await fs.mkdir(dirname, { recursive: true });
206
+ await fs.writeFile(filename, file.code);
207
+ }
208
+ }
package/src/index.ts CHANGED
@@ -3,6 +3,7 @@ import type { ImportMapping } from './codegen.js';
3
3
  export interface LexiconConfig {
4
4
  outdir: string;
5
5
  files: string[];
6
+ imports?: string[];
6
7
  mappings?: ImportMapping[];
7
8
  modules?: {
8
9
  importSuffix?: string;
@@ -0,0 +1,76 @@
1
+ import * as v from '@badrap/valita';
2
+
3
+ import { isNsid } from '@atcute/lexicons/syntax';
4
+
5
+ export type LexiconMappingEntryType = 'namespace' | 'named';
6
+ export type LexiconMappingPath = '.' | `./${string}`;
7
+
8
+ export interface LexiconMappingEntry {
9
+ type: LexiconMappingEntryType;
10
+ path: LexiconMappingPath;
11
+ }
12
+
13
+ export interface AtcuteLexiconsField {
14
+ mappings?: Record<string, LexiconMappingEntry>;
15
+ }
16
+
17
+ export interface PackageJsonWithLexicons {
18
+ 'atcute:lexicons'?: AtcuteLexiconsField;
19
+ [key: string]: unknown;
20
+ }
21
+
22
+ /**
23
+ * Validates if a string is a valid NSID pattern (exact or wildcard)
24
+ * - Exact: "com.atproto.repo.getRecord"
25
+ * - Wildcard: "com.atproto.*"
26
+ */
27
+ const isValidLexiconPattern = (pattern: string): boolean => {
28
+ if (pattern.endsWith('.*')) {
29
+ // For wildcards, remove the .* and validate the prefix as an NSID segment
30
+ const prefix = pattern.slice(0, -2);
31
+ // Add a dummy segment to make it a valid NSID for validation
32
+ return isNsid(prefix + '.x');
33
+ }
34
+ return isNsid(pattern);
35
+ };
36
+
37
+ /**
38
+ * Schema for a single lexicon mapping entry
39
+ */
40
+ const lexiconMappingEntry: v.Type<LexiconMappingEntry> = v.object({
41
+ type: v.union(v.literal('namespace'), v.literal('named')),
42
+ path: v
43
+ .string()
44
+ .assert((input): input is LexiconMappingPath => input === '.' || input.startsWith('./'), {
45
+ message: `path must be "." or start with "./"`,
46
+ }),
47
+ });
48
+
49
+ /**
50
+ * Schema for the atcute:lexicons field in package.json
51
+ */
52
+ const mappingsSchema: v.Type<Record<string, LexiconMappingEntry>> = v
53
+ .record(lexiconMappingEntry)
54
+ .chain((input) => {
55
+ for (const key in input) {
56
+ if (!isValidLexiconPattern(key)) {
57
+ return v.err({
58
+ message: `invalid NSID pattern (must be valid NSID or end with .*)`,
59
+ path: [key],
60
+ });
61
+ }
62
+ }
63
+
64
+ return v.ok(input);
65
+ });
66
+
67
+ const atcuteLexiconsField: v.Type<AtcuteLexiconsField> = v.object({
68
+ mappings: mappingsSchema.optional(),
69
+ });
70
+
71
+ /**
72
+ * Schema for package.json with atcute:lexicons field
73
+ */
74
+ export const packageJsonSchema: v.Type<PackageJsonWithLexicons> = v.object({
75
+ 'atcute:lexicons': atcuteLexiconsField.optional(),
76
+ });