+34

SYNTAX.md

··· 736 736 } 737 737 ``` 738 738 739 739 + ### Empty Union (No Refs) 740 740 + 741 741 + **Pattern:** Use `never | unknown` for unions with no model references 742 742 + 743 743 + In rare cases, you need an empty union that accepts any type with a `$type` discriminator but has no known refs. Use the `never | unknown` pattern: 744 744 + 745 745 + **TypeSpec:** 746 746 + ```typespec 747 747 + model SubjectView { 748 748 + @required type: string; 749 749 + @required subject: string; 750 750 + profile?: never | unknown; // Empty union 751 751 + } 752 752 + ``` 753 753 + 754 754 + **JSON:** 755 755 + ```json 756 756 + { 757 757 + "profile": { 758 758 + "type": "union", 759 759 + "refs": [] 760 760 + } 761 761 + } 762 762 + ``` 763 763 + 764 764 + **Why `never | unknown`?** 765 765 + - `never` creates a union type in TypeSpec (single `unknown` is just intrinsic, not a union) 766 766 + - `never` contributes no refs (it's an empty type) 767 767 + - `unknown` marks the union as open/extensible 768 768 + - Result: empty refs array with open union semantics 769 769 + 770 770 + **When to use:** Fields that may contain any discriminated type in the future but have no current known types. 771 771 + 739 772 ### Syntax Summary 740 773 741 774 | Pattern | Syntax | JSON `closed` field | Use Case | 742 775 |---------|--------|---------------------|----------| 743 776 | **Open union (inline)** | `(A \| B \| unknown)` | omitted (false) | Default - allows future variants | 744 777 | **Open union (named)** | `union { A, B, unknown }` | omitted (false) | Named def, reusable | 778 778 + | **Empty union** | `never \| unknown` | omitted (false) | No current refs, open to future types | 745 779 | **Closed union (named)** | `@closed union { A, B }` | `true` | Fixed set, named def | 746 780 | **Closed union (inline)** | `Closed<A \| B>` | `true` | Fixed set, inline usage | 747 781 | **Single reference** | `SomeType` | N/A (not a union) | Exactly one type, no variants |

+3 -2

package.json

··· 8 8 "test": "pnpm --filter @tlex/emitter test", 9 9 "test:watch": "pnpm --filter @tlex/emitter test:watch", 10 10 "example": "pnpm --filter @tlex/example build", 11 11 - "validate": "pnpm build && pnpm test" 11 11 + "validate": "pnpm build && pnpm run validate-lexicons && pnpm test", 12 12 + "validate-lexicons": "node scripts/validate-lexicons.js" 12 13 }, 13 14 "repository": { 14 15 "type": "git", ··· 26 27 "devDependencies": { 27 28 "typescript": "^5.0.0" 28 29 } 29 29 - } 30 30 + }

+4 -4

packages/emitter/src/emitter.ts

··· 412 412 return this.createStringEnumDef(unionType, variants.stringLiterals, prop); 413 413 } 414 414 415 415 - // Case 2: Model reference union 416 416 - if (variants.unionRefs.length > 0) { 415 415 + // Case 2: Model reference union (including empty union with unknown) 416 416 + if (variants.unionRefs.length > 0 || variants.hasUnknown) { 417 417 return this.createUnionRefDef(unionType, variants, prop); 418 418 } 419 419 420 420 - // Case 3: Empty or invalid union 421 421 - if (variants.stringLiterals.length === 0 && !variants.hasUnknown) { 420 420 + // Case 3: Empty union without unknown 421 421 + if (variants.stringLiterals.length === 0) { 422 422 this.program.reportDiagnostic({ 423 423 code: "union-empty", 424 424 severity: "error",

+2 -2

packages/emitter/test/scenarios/atproto/input/app/bsky/labeler/defs.tsp

··· 32 32 labels?: com.atproto.label.defs.Label[]; 33 33 34 34 @doc("The set of report reason 'codes' which are in-scope for this service to review and action. These usually align to policy categories. If not defined (distinct from empty array), all reason types are allowed.") 35 35 - reasonTypes?: com.atproto.moderation.defs.reasonType[]; 35 35 + reasonTypes?: com.atproto.moderation.defs.ReasonType[]; 36 36 37 37 @doc("The set of subject types (account, record, etc) this service accepts reports on.") 38 38 - subjectTypes?: com.atproto.moderation.defs.subjectType[]; 38 38 + subjectTypes?: com.atproto.moderation.defs.SubjectType[]; 39 39 40 40 @doc("Set of record types (collection NSIDs) which can be reported to this service. If not defined (distinct from empty array), default is any record type.") 41 41 subjectCollections?: nsid[];

+2 -2

packages/emitter/test/scenarios/atproto/input/app/bsky/labeler/service.tsp

··· 11 11 @required createdAt: datetime; 12 12 13 13 @doc("The set of report reason 'codes' which are in-scope for this service to review and action. These usually align to policy categories. If not defined (distinct from empty array), all reason types are allowed.") 14 14 - reasonTypes?: com.atproto.moderation.defs.reasonType[]; 14 14 + reasonTypes?: com.atproto.moderation.defs.ReasonType[]; 15 15 16 16 @doc("The set of subject types (account, record, etc) this service accepts reports on.") 17 17 - subjectTypes?: com.atproto.moderation.defs.subjectType[]; 17 17 + subjectTypes?: com.atproto.moderation.defs.SubjectType[]; 18 18 19 19 @doc("Set of record types (collection NSIDs) which can be reported to this service. If not defined (distinct from empty array), default is any record type.") 20 20 subjectCollections?: nsid[];

+2 -2

packages/emitter/test/scenarios/atproto/input/app/bsky/richtext/facet.tsp

··· 30 30 model ByteSlice { 31 31 @minValue(0) 32 32 @required 33 33 - byteStart: int32; 33 33 + byteStart: integer; 34 34 35 35 @minValue(0) 36 36 @required 37 37 - byteEnd: int32; 37 37 + byteEnd: integer; 38 38 } 39 39 }

+33

packages/emitter/test/scenarios/atproto/input/app/bsky/unspecced/searchActorsSkeleton.tsp

··· 1 1 + import "@tlex/emitter"; 2 2 + 3 3 + namespace app.bsky.unspecced.searchActorsSkeleton { 4 4 + model BadQueryString {} 5 5 + 6 6 + @doc("Backend Actors (profile) search, returns only skeleton.") 7 7 + @query 8 8 + @errors(BadQueryString) 9 9 + op main( 10 10 + @doc("Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. For typeahead search, only simple term match is supported, not full syntax.") 11 11 + q: string, 12 12 + 13 13 + @doc("DID of the account making the request (not included for public/unauthenticated queries). Used to boost followed accounts in ranking.") 14 14 + viewer?: did, 15 15 + 16 16 + @doc("If true, acts as fast/simple 'typeahead' query.") 17 17 + typeahead?: boolean, 18 18 + 19 19 + @minValue(1) 20 20 + @maxValue(100) 21 21 + limit?: integer = 25, 22 22 + 23 23 + @doc("Optional pagination mechanism; may not necessarily allow scrolling through entire result set.") 24 24 + cursor?: string 25 25 + ): { 26 26 + cursor?: string; 27 27 + 28 28 + @doc("Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits.") 29 29 + hitsTotal?: integer; 30 30 + 31 31 + @required actors: app.bsky.unspecced.defs.SkeletonSearchActor[]; 32 32 + }; 33 33 + }

+61

packages/emitter/test/scenarios/atproto/input/app/bsky/unspecced/searchPostsSkeleton.tsp

··· 1 1 + import "@tlex/emitter"; 2 2 + 3 3 + @maxLength(640) 4 4 + @maxGraphemes(64) 5 5 + scalar SkeletonSearchTagString extends string; 6 6 + 7 7 + namespace app.bsky.unspecced.searchPostsSkeleton { 8 8 + model BadQueryString {} 9 9 + 10 10 + @doc("Backend Posts search, returns only skeleton") 11 11 + @query 12 12 + @errors(BadQueryString) 13 13 + op main( 14 14 + @doc("Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended.") 15 15 + q: string, 16 16 + 17 17 + @doc("Specifies the ranking order of results.") 18 18 + sort?: "top" | "latest" | string = "latest", 19 19 + 20 20 + @doc("Filter results for posts after the indicated datetime (inclusive). Expected to use 'sortAt' timestamp, which may not match 'createdAt'. Can be a datetime, or just an ISO date (YYYY-MM-DD).") 21 21 + since?: string, 22 22 + 23 23 + @doc("Filter results for posts before the indicated datetime (not inclusive). Expected to use 'sortAt' timestamp, which may not match 'createdAt'. Can be a datetime, or just an ISO date (YYY-MM-DD).") 24 24 + until?: string, 25 25 + 26 26 + @doc("Filter to posts which mention the given account. Handles are resolved to DID before query-time. Only matches rich-text facet mentions.") 27 27 + mentions?: atIdentifier, 28 28 + 29 29 + @doc("Filter to posts by the given account. Handles are resolved to DID before query-time.") 30 30 + author?: atIdentifier, 31 31 + 32 32 + @doc("Filter to posts in the given language. Expected to be based on post language field, though server may override language detection.") 33 33 + lang?: language, 34 34 + 35 35 + @doc("Filter to posts with URLs (facet links or embeds) linking to the given domain (hostname). Server may apply hostname normalization.") 36 36 + domain?: string, 37 37 + 38 38 + @doc("Filter to posts with links (facet links or embeds) pointing to this URL. Server may apply URL normalization or fuzzy matching.") 39 39 + url?: uri, 40 40 + 41 41 + @doc("Filter to posts with the given tag (hashtag), based on rich-text facet or tag field. Do not include the hash (#) prefix. Multiple tags can be specified, with 'AND' matching.") 42 42 + tag?: SkeletonSearchTagString[], 43 43 + 44 44 + @doc("DID of the account making the request (not included for public/unauthenticated queries). Used for 'from:me' queries.") 45 45 + viewer?: did, 46 46 + 47 47 + @minValue(1) 48 48 + @maxValue(100) 49 49 + limit?: integer = 25, 50 50 + 51 51 + @doc("Optional pagination mechanism; may not necessarily allow scrolling through entire result set.") 52 52 + cursor?: string 53 53 + ): { 54 54 + cursor?: string; 55 55 + 56 56 + @doc("Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits.") 57 57 + hitsTotal?: integer; 58 58 + 59 59 + @required posts: app.bsky.unspecced.defs.SkeletonSearchPost[]; 60 60 + }; 61 61 + }

+30

packages/emitter/test/scenarios/atproto/input/app/bsky/unspecced/searchStarterPacksSkeleton.tsp

··· 1 1 + import "@tlex/emitter"; 2 2 + 3 3 + namespace app.bsky.unspecced.searchStarterPacksSkeleton { 4 4 + model BadQueryString {} 5 5 + 6 6 + @doc("Backend Starter Pack search, returns only skeleton.") 7 7 + @query 8 8 + @errors(BadQueryString) 9 9 + op main( 10 10 + @doc("Search query string; syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended.") 11 11 + q: string, 12 12 + 13 13 + @doc("DID of the account making the request (not included for public/unauthenticated queries).") 14 14 + viewer?: did, 15 15 + 16 16 + @minValue(1) 17 17 + @maxValue(100) 18 18 + limit?: integer = 25, 19 19 + 20 20 + @doc("Optional pagination mechanism; may not necessarily allow scrolling through entire result set.") 21 21 + cursor?: string 22 22 + ): { 23 23 + cursor?: string; 24 24 + 25 25 + @doc("Count of search hits. Optional, may be rounded/truncated, and may not be possible to paginate through all hits.") 26 26 + hitsTotal?: integer; 27 27 + 28 28 + @required starterPacks: app.bsky.unspecced.defs.SkeletonSearchStarterPack[]; 29 29 + }; 30 30 + }

+1 -1

packages/emitter/test/scenarios/atproto/input/app/bsky/video/defs.tsp

··· 12 12 @doc("Progress within the current processing state.") 13 13 @minValue(0) 14 14 @maxValue(100) 15 15 - progress?: int32; 15 15 + progress?: integer; 16 16 17 17 blob?: Blob; 18 18 error?: string;

+12

packages/emitter/test/scenarios/atproto/input/app/bsky/video/uploadVideo.tsp

··· 1 1 + import "@tlex/emitter"; 2 2 + 3 3 + namespace app.bsky.video.uploadVideo { 4 4 + @doc("Upload a video to be processed then stored on the PDS.") 5 5 + @procedure 6 6 + op main( 7 7 + @encoding("video/mp4") 8 8 + input: void 9 9 + ): { 10 10 + @required jobStatus: app.bsky.video.defs.JobStatus; 11 11 + }; 12 12 + }

+23

packages/emitter/test/scenarios/atproto/input/com/atproto/label/subscribeLabels.tsp

··· 1 1 + import "@tlex/emitter"; 2 2 + 3 3 + namespace com.atproto.label.subscribeLabels { 4 4 + model FutureCursor {} 5 5 + 6 6 + model Labels { 7 7 + @required seq: integer; 8 8 + @required labels: com.atproto.label.defs.Label[]; 9 9 + } 10 10 + 11 11 + model Info { 12 12 + @required name: "OutdatedCursor" | string; 13 13 + message?: string; 14 14 + } 15 15 + 16 16 + @doc("Subscribe to stream of labels (and negations). Public endpoint implemented by mod services. Uses same sequencing scheme as repo event stream.") 17 17 + @subscription 18 18 + @errors(FutureCursor) 19 19 + op main( 20 20 + @doc("The last known event seq number to backfill from.") 21 21 + cursor?: integer 22 22 + ): (Labels | Info); 23 23 + }

+11

packages/emitter/test/scenarios/atproto/input/com/atproto/lexicon/schema.tsp

··· 1 1 + import "@tlex/emitter"; 2 2 + 3 3 + namespace com.atproto.lexicon.schema { 4 4 + @doc("Representation of Lexicon schemas themselves, when published as atproto records. Note that the schema language is not defined in Lexicon; this meta schema currently only includes a single version field ('lexicon'). See the atproto specifications for description of the other expected top-level fields ('id', 'defs', etc).") 5 5 + @record("nsid") 6 6 + model Main { 7 7 + @doc("Indicates the 'version' of the Lexicon language. Must be '1' for the current atproto/Lexicon schema system.") 8 8 + @required 9 9 + lexicon: integer; 10 10 + } 11 11 + }

+2 -2

packages/emitter/test/scenarios/atproto/input/com/atproto/moderation/createReport.tsp

··· 6 6 op main(input: { 7 7 @doc("Indicates the broad category of violation the report is for.") 8 8 @required 9 9 - reasonType: com.atproto.moderation.defs.reasonType; 9 9 + reasonType: com.atproto.moderation.defs.ReasonType; 10 10 11 11 @maxGraphemes(2000) 12 12 @maxLength(20000) ··· 23 23 modTool?: ModTool; 24 24 }): { 25 25 @required id: integer; 26 26 - @required reasonType: com.atproto.moderation.defs.reasonType; 26 26 + @required reasonType: com.atproto.moderation.defs.ReasonType; 27 27 28 28 @maxGraphemes(2000) 29 29 @maxLength(20000)

+5 -6

packages/emitter/test/scenarios/atproto/input/com/atproto/moderation/defs.tsp

··· 1 1 import "@tlex/emitter"; 2 2 3 3 namespace com.atproto.moderation.defs { 4 4 - union reasonType { 4 4 + union ReasonType { 5 5 string, 6 6 7 7 ReasonSpam: "com.atproto.moderation.defs#reasonSpam", ··· 95 95 model ReasonAppeal {} 96 96 97 97 @doc("Tag describing a type of subject that might be reported.") 98 98 - union subjectType { 98 98 + union SubjectType { 99 99 + "account", 100 100 + "record", 101 101 + "chat", 99 102 string, 100 100 - 101 101 - Account: "account", 102 102 - Record: "record", 103 103 - Chat: "chat", 104 103 } 105 104 }

+11

packages/emitter/test/scenarios/atproto/input/com/atproto/temp/addReservedHandle.tsp

··· 1 1 + import "@tlex/emitter"; 2 2 + 3 3 + namespace com.atproto.temp.addReservedHandle { 4 4 + @doc("Add a handle to the set of reserved handles.") 5 5 + @procedure 6 6 + op main( 7 7 + input: { 8 8 + @required handle: string; 9 9 + } 10 10 + ): {}; 11 11 + }

+44

packages/emitter/test/scenarios/atproto/input/com/atproto/temp/checkHandleAvailability.tsp

··· 1 1 + import "@tlex/emitter"; 2 2 + 3 3 + namespace com.atproto.temp.checkHandleAvailability { 4 4 + @doc("An invalid email was provided.") 5 5 + model InvalidEmail {} 6 6 + 7 7 + @doc("Indicates the provided handle is available.") 8 8 + model ResultAvailable {} 9 9 + 10 10 + @doc("Indicates the provided handle is unavailable and gives suggestions of available handles.") 11 11 + model ResultUnavailable { 12 12 + @doc("List of suggested handles based on the provided inputs.") 13 13 + @required 14 14 + suggestions: Suggestion[]; 15 15 + } 16 16 + 17 17 + model Suggestion { 18 18 + @required handle: handle; 19 19 + 20 20 + @doc("Method used to build this suggestion. Should be considered opaque to clients. Can be used for metrics.") 21 21 + @required 22 22 + method: string; 23 23 + } 24 24 + 25 25 + @doc("Checks whether the provided handle is available. If the handle is not available, available suggestions will be returned. Optional inputs will be used to generate suggestions.") 26 26 + @query 27 27 + @errors(InvalidEmail) 28 28 + op main( 29 29 + @doc("Tentative handle. Will be checked for availability or used to build handle suggestions.") 30 30 + handle: handle, 31 31 + 32 32 + @doc("User-provided email. Might be used to build handle suggestions.") 33 33 + email?: string, 34 34 + 35 35 + @doc("User-provided birth date. Might be used to build handle suggestions.") 36 36 + birthDate?: datetime 37 37 + ): { 38 38 + @doc("Echo of the input handle.") 39 39 + @required 40 40 + handle: handle; 41 41 + 42 42 + @required result: ResultAvailable | ResultUnavailable; 43 43 + }; 44 44 + }

+11

packages/emitter/test/scenarios/atproto/input/com/atproto/temp/checkSignupQueue.tsp

··· 1 1 + import "@tlex/emitter"; 2 2 + 3 3 + namespace com.atproto.temp.checkSignupQueue { 4 4 + @doc("Check accounts location in signup queue.") 5 5 + @query 6 6 + op main(): { 7 7 + @required activated: boolean; 8 8 + placeInQueue?: integer; 9 9 + estimatedTimeMs?: integer; 10 10 + }; 11 11 + }

+18

packages/emitter/test/scenarios/atproto/input/com/atproto/temp/dereferenceScope.tsp

··· 1 1 + import "@tlex/emitter"; 2 2 + 3 3 + namespace com.atproto.temp.dereferenceScope { 4 4 + @doc("An invalid scope reference was provided.") 5 5 + model InvalidScopeReference {} 6 6 + 7 7 + @doc("Allows finding the oauth permission scope from a reference") 8 8 + @query 9 9 + @errors(InvalidScopeReference) 10 10 + op main( 11 11 + @doc("The scope reference (starts with 'ref:')") 12 12 + scope: string 13 13 + ): { 14 14 + @doc("The full oauth permission scope") 15 15 + @required 16 16 + scope: string; 17 17 + }; 18 18 + }

+15

packages/emitter/test/scenarios/atproto/input/com/atproto/temp/fetchLabels.tsp

··· 1 1 + import "@tlex/emitter"; 2 2 + 3 3 + namespace com.atproto.temp.fetchLabels { 4 4 + @doc("DEPRECATED: use queryLabels or subscribeLabels instead -- Fetch all labels from a labeler created after a certain date.") 5 5 + @query 6 6 + op main( 7 7 + since?: integer, 8 8 + 9 9 + @minValue(1) 10 10 + @maxValue(250) 11 11 + limit?: integer = 50 12 12 + ): { 13 13 + @required labels: com.atproto.label.defs.Label[]; 14 14 + }; 15 15 + }

+11

packages/emitter/test/scenarios/atproto/input/com/atproto/temp/requestPhoneVerification.tsp

··· 1 1 + import "@tlex/emitter"; 2 2 + 3 3 + namespace com.atproto.temp.requestPhoneVerification { 4 4 + @doc("Request a verification code to be sent to the supplied phone number") 5 5 + @procedure 6 6 + op main( 7 7 + input: { 8 8 + @required phoneNumber: string; 9 9 + } 10 10 + ): void; 11 11 + }

+11

packages/emitter/test/scenarios/atproto/input/com/atproto/temp/revokeAccountCredentials.tsp

··· 1 1 + import "@tlex/emitter"; 2 2 + 3 3 + namespace com.atproto.temp.revokeAccountCredentials { 4 4 + @doc("Revoke sessions, password, and app passwords associated with account. May be resolved by a password reset.") 5 5 + @procedure 6 6 + op main( 7 7 + input: { 8 8 + @required account: atIdentifier; 9 9 + } 10 10 + ): void; 11 11 + }

+30

packages/emitter/test/scenarios/atproto/input/tools/ozone/communication/createTemplate.tsp

··· 1 1 + import "@tlex/emitter"; 2 2 + 3 3 + namespace tools.ozone.communication.createTemplate { 4 4 + model DuplicateTemplateName {} 5 5 + 6 6 + @doc("Administrative action to create a new, re-usable communication (email for now) template.") 7 7 + @procedure 8 8 + @errors(DuplicateTemplateName) 9 9 + op main( 10 10 + input: { 11 11 + @doc("Subject of the message, used in emails.") 12 12 + @required 13 13 + subject: string; 14 14 + 15 15 + @doc("Content of the template, markdown supported, can contain variable placeholders.") 16 16 + @required 17 17 + contentMarkdown: string; 18 18 + 19 19 + @doc("Name of the template.") 20 20 + @required 21 21 + name: string; 22 22 + 23 23 + @doc("Message language.") 24 24 + lang?: language; 25 25 + 26 26 + @doc("DID of the user who is creating the template.") 27 27 + createdBy?: did; 28 28 + } 29 29 + ): tools.ozone.communication.defs.TemplateView; 30 30 + }

+30

packages/emitter/test/scenarios/atproto/input/tools/ozone/communication/defs.tsp

··· 1 1 + import "@tlex/emitter"; 2 2 + 3 3 + namespace tools.ozone.communication.defs { 4 4 + model TemplateView { 5 5 + @required id: string; 6 6 + 7 7 + @doc("Name of the template.") 8 8 + @required 9 9 + name: string; 10 10 + 11 11 + @doc("Content of the template, can contain markdown and variable placeholders.") 12 12 + subject?: string; 13 13 + 14 14 + @doc("Subject of the message, used in emails.") 15 15 + @required 16 16 + contentMarkdown: string; 17 17 + 18 18 + @required disabled: boolean; 19 19 + 20 20 + @doc("Message language.") 21 21 + lang?: language; 22 22 + 23 23 + @doc("DID of the user who last updated the template.") 24 24 + @required 25 25 + lastUpdatedBy: did; 26 26 + 27 27 + @required createdAt: datetime; 28 28 + @required updatedAt: datetime; 29 29 + } 30 30 + }

+11

packages/emitter/test/scenarios/atproto/input/tools/ozone/communication/deleteTemplate.tsp

··· 1 1 + import "@tlex/emitter"; 2 2 + 3 3 + namespace tools.ozone.communication.deleteTemplate { 4 4 + @doc("Delete a communication template.") 5 5 + @procedure 6 6 + op main( 7 7 + input: { 8 8 + @required id: string; 9 9 + } 10 10 + ): void; 11 11 + }

+9

packages/emitter/test/scenarios/atproto/input/tools/ozone/communication/listTemplates.tsp

··· 1 1 + import "@tlex/emitter"; 2 2 + 3 3 + namespace tools.ozone.communication.listTemplates { 4 4 + @doc("Get list of all communication templates.") 5 5 + @query 6 6 + op main(): { 7 7 + @required communicationTemplates: tools.ozone.communication.defs.TemplateView[]; 8 8 + }; 9 9 + }

+33

packages/emitter/test/scenarios/atproto/input/tools/ozone/communication/updateTemplate.tsp

··· 1 1 + import "@tlex/emitter"; 2 2 + 3 3 + namespace tools.ozone.communication.updateTemplate { 4 4 + model DuplicateTemplateName {} 5 5 + 6 6 + @doc("Administrative action to update an existing communication template. Allows passing partial fields to patch specific fields only.") 7 7 + @procedure 8 8 + @errors(DuplicateTemplateName) 9 9 + op main( 10 10 + input: { 11 11 + @doc("ID of the template to be updated.") 12 12 + @required 13 13 + id: string; 14 14 + 15 15 + @doc("Name of the template.") 16 16 + name?: string; 17 17 + 18 18 + @doc("Message language.") 19 19 + lang?: language; 20 20 + 21 21 + @doc("Content of the template, markdown supported, can contain variable placeholders.") 22 22 + contentMarkdown?: string; 23 23 + 24 24 + @doc("Subject of the message, used in emails.") 25 25 + subject?: string; 26 26 + 27 27 + @doc("DID of the user who is updating the template.") 28 28 + updatedBy?: did; 29 29 + 30 30 + disabled?: boolean; 31 31 + } 32 32 + ): tools.ozone.communication.defs.TemplateView; 33 33 + }

+540

packages/emitter/test/scenarios/atproto/input/tools/ozone/moderation/defs.tsp

··· 1 1 + import "@tlex/emitter"; 2 2 + 3 3 + namespace tools.ozone.moderation.defs { 4 4 + model ModEventView { 5 5 + @required id: integer; 6 6 + @required event: ModEventTakedown | ModEventReverseTakedown | ModEventComment | ModEventReport | ModEventLabel | ModEventAcknowledge | ModEventEscalate | ModEventMute | ModEventUnmute | ModEventMuteReporter | ModEventUnmuteReporter | ModEventEmail | ModEventResolveAppeal | ModEventDivert | ModEventTag | AccountEvent | IdentityEvent | RecordEvent | ModEventPriorityScore | AgeAssuranceEvent | AgeAssuranceOverrideEvent | RevokeAccountCredentialsEvent; 7 7 + @required subject: com.atproto.admin.defs.RepoRef | com.atproto.repo.strongRef.Main | chat.bsky.convo.defs.MessageRef; 8 8 + @required subjectBlobCids: string[]; 9 9 + @required createdBy: did; 10 10 + @required createdAt: datetime; 11 11 + creatorHandle?: string; 12 12 + subjectHandle?: string; 13 13 + modTool?: ModTool; 14 14 + } 15 15 + 16 16 + model ModEventViewDetail { 17 17 + @required id: integer; 18 18 + @required event: ModEventTakedown | ModEventReverseTakedown | ModEventComment | ModEventReport | ModEventLabel | ModEventAcknowledge | ModEventEscalate | ModEventMute | ModEventUnmute | ModEventMuteReporter | ModEventUnmuteReporter | ModEventEmail | ModEventResolveAppeal | ModEventDivert | ModEventTag | AccountEvent | IdentityEvent | RecordEvent | ModEventPriorityScore | AgeAssuranceEvent | AgeAssuranceOverrideEvent | RevokeAccountCredentialsEvent; 19 19 + @required subject: RepoView | RepoViewNotFound | RecordView | RecordViewNotFound; 20 20 + @required subjectBlobs: BlobView[]; 21 21 + @required createdBy: did; 22 22 + @required createdAt: datetime; 23 23 + modTool?: ModTool; 24 24 + } 25 25 + 26 26 + model SubjectStatusView { 27 27 + @required id: integer; 28 28 + @required subject: com.atproto.admin.defs.RepoRef | com.atproto.repo.strongRef.Main | chat.bsky.convo.defs.MessageRef; 29 29 + hosting?: AccountHosting | RecordHosting; 30 30 + subjectBlobCids?: cid[]; 31 31 + subjectRepoHandle?: string; 32 32 + 33 33 + @doc("Timestamp referencing the first moderation status impacting event was emitted on the subject") 34 34 + @required 35 35 + createdAt: datetime; 36 36 + 37 37 + @doc("Timestamp referencing when the last update was made to the moderation status of the subject") 38 38 + @required 39 39 + updatedAt: datetime; 40 40 + 41 41 + @required reviewState: SubjectReviewState; 42 42 + 43 43 + @doc("Sticky comment on the subject.") 44 44 + comment?: string; 45 45 + 46 46 + @doc("Numeric value representing the level of priority. Higher score means higher priority.") 47 47 + @minValue(0) 48 48 + @maxValue(100) 49 49 + priorityScore?: integer; 50 50 + 51 51 + muteUntil?: datetime; 52 52 + muteReportingUntil?: datetime; 53 53 + lastReviewedBy?: did; 54 54 + lastReviewedAt?: datetime; 55 55 + lastReportedAt?: datetime; 56 56 + 57 57 + @doc("Timestamp referencing when the author of the subject appealed a moderation action") 58 58 + lastAppealedAt?: datetime; 59 59 + 60 60 + takendown?: boolean; 61 61 + 62 62 + @doc("True indicates that the a previously taken moderator action was appealed against, by the author of the content. False indicates last appeal was resolved by moderators.") 63 63 + appealed?: boolean; 64 64 + 65 65 + suspendUntil?: datetime; 66 66 + tags?: string[]; 67 67 + 68 68 + @doc("Statistics related to the account subject") 69 69 + accountStats?: AccountStats; 70 70 + 71 71 + @doc("Statistics related to the record subjects authored by the subject's account") 72 72 + recordsStats?: RecordsStats; 73 73 + 74 74 + @doc("Current age assurance state of the subject.") 75 75 + ageAssuranceState?: "pending" | "assured" | "unknown" | "reset" | "blocked" | string; 76 76 + 77 77 + @doc("Whether or not the last successful update to age assurance was made by the user or admin.") 78 78 + ageAssuranceUpdatedBy?: "admin" | "user" | string; 79 79 + } 80 80 + 81 81 + @doc("Detailed view of a subject. For record subjects, the author's repo and profile will be returned.") 82 82 + model SubjectView { 83 83 + @required type: com.atproto.moderation.defs.SubjectType; 84 84 + @required subject: string; 85 85 + status?: SubjectStatusView; 86 86 + repo?: RepoViewDetail; 87 87 + profile?: (never | unknown); 88 88 + record?: RecordViewDetail; 89 89 + } 90 90 + 91 91 + @doc("Statistics about a particular account subject") 92 92 + model AccountStats { 93 93 + @doc("Total number of reports on the account") 94 94 + reportCount?: integer; 95 95 + 96 96 + @doc("Total number of appeals against a moderation action on the account") 97 97 + appealCount?: integer; 98 98 + 99 99 + @doc("Number of times the account was suspended") 100 100 + suspendCount?: integer; 101 101 + 102 102 + @doc("Number of times the account was escalated") 103 103 + escalateCount?: integer; 104 104 + 105 105 + @doc("Number of times the account was taken down") 106 106 + takedownCount?: integer; 107 107 + } 108 108 + 109 109 + @doc("Statistics about a set of record subject items") 110 110 + model RecordsStats { 111 111 + @doc("Cumulative sum of the number of reports on the items in the set") 112 112 + totalReports?: integer; 113 113 + 114 114 + @doc("Number of items that were reported at least once") 115 115 + reportedCount?: integer; 116 116 + 117 117 + @doc("Number of items that were escalated at least once") 118 118 + escalatedCount?: integer; 119 119 + 120 120 + @doc("Number of items that were appealed at least once") 121 121 + appealedCount?: integer; 122 122 + 123 123 + @doc("Total number of item in the set") 124 124 + subjectCount?: integer; 125 125 + 126 126 + @doc("Number of item currently in \"reviewOpen\" or \"reviewEscalated\" state") 127 127 + pendingCount?: integer; 128 128 + 129 129 + @doc("Number of item currently in \"reviewNone\" or \"reviewClosed\" state") 130 130 + processedCount?: integer; 131 131 + 132 132 + @doc("Number of item currently taken down") 133 133 + takendownCount?: integer; 134 134 + } 135 135 + 136 136 + union SubjectReviewState { 137 137 + string, 138 138 + 139 139 + ReviewOpen: "#reviewOpen", 140 140 + ReviewEscalated: "#reviewEscalated", 141 141 + ReviewClosed: "#reviewClosed", 142 142 + ReviewNone: "#reviewNone", 143 143 + } 144 144 + 145 145 + @doc("Moderator review status of a subject: Open. Indicates that the subject needs to be reviewed by a moderator") 146 146 + @token 147 147 + model ReviewOpen {} 148 148 + 149 149 + @doc("Moderator review status of a subject: Escalated. Indicates that the subject was escalated for review by a moderator") 150 150 + @token 151 151 + model ReviewEscalated {} 152 152 + 153 153 + @doc("Moderator review status of a subject: Closed. Indicates that the subject was already reviewed and resolved by a moderator") 154 154 + @token 155 155 + model ReviewClosed {} 156 156 + 157 157 + @doc("Moderator review status of a subject: Unnecessary. Indicates that the subject does not need a review at the moment but there is probably some moderation related metadata available for it") 158 158 + @token 159 159 + model ReviewNone {} 160 160 + 161 161 + @doc("Take down a subject permanently or temporarily") 162 162 + model ModEventTakedown { 163 163 + comment?: string; 164 164 + 165 165 + @doc("Indicates how long the takedown should be in effect before automatically expiring.") 166 166 + durationInHours?: integer; 167 167 + 168 168 + @doc("If true, all other reports on content authored by this account will be resolved (acknowledged).") 169 169 + acknowledgeAccountSubjects?: boolean; 170 170 + 171 171 + @maxItems(5) 172 172 + @doc("Names/Keywords of the policies that drove the decision.") 173 173 + policies?: string[]; 174 174 + } 175 175 + 176 176 + @doc("Revert take down action on a subject") 177 177 + model ModEventReverseTakedown { 178 178 + @doc("Describe reasoning behind the reversal.") 179 179 + comment?: string; 180 180 + } 181 181 + 182 182 + @doc("Resolve appeal on a subject") 183 183 + model ModEventResolveAppeal { 184 184 + @doc("Describe resolution.") 185 185 + comment?: string; 186 186 + } 187 187 + 188 188 + @doc("Add a comment to a subject. An empty comment will clear any previously set sticky comment.") 189 189 + model ModEventComment { 190 190 + comment?: string; 191 191 + 192 192 + @doc("Make the comment persistent on the subject") 193 193 + sticky?: boolean; 194 194 + } 195 195 + 196 196 + @doc("Report a subject") 197 197 + model ModEventReport { 198 198 + comment?: string; 199 199 + 200 200 + @doc("Set to true if the reporter was muted from reporting at the time of the event. These reports won't impact the reviewState of the subject.") 201 201 + isReporterMuted?: boolean; 202 202 + 203 203 + @required reportType: com.atproto.moderation.defs.ReasonType; 204 204 + } 205 205 + 206 206 + @doc("Apply/Negate labels on a subject") 207 207 + model ModEventLabel { 208 208 + comment?: string; 209 209 + @required createLabelVals: string[]; 210 210 + @required negateLabelVals: string[]; 211 211 + 212 212 + @doc("Indicates how long the label will remain on the subject. Only applies on labels that are being added.") 213 213 + durationInHours?: integer; 214 214 + } 215 215 + 216 216 + @doc("Set priority score of the subject. Higher score means higher priority.") 217 217 + model ModEventPriorityScore { 218 218 + comment?: string; 219 219 + 220 220 + @minValue(0) 221 221 + @maxValue(100) 222 222 + @required 223 223 + score: integer; 224 224 + } 225 225 + 226 226 + @doc("Age assurance info coming directly from users. Only works on DID subjects.") 227 227 + model AgeAssuranceEvent { 228 228 + @doc("The date and time of this write operation.") 229 229 + @required 230 230 + createdAt: datetime; 231 231 + 232 232 + @doc("The status of the age assurance process.") 233 233 + @required 234 234 + status: "unknown" | "pending" | "assured" | string; 235 235 + 236 236 + @doc("The unique identifier for this instance of the age assurance flow, in UUID format.") 237 237 + @required 238 238 + attemptId: string; 239 239 + 240 240 + @doc("The IP address used when initiating the AA flow.") 241 241 + initIp?: string; 242 242 + 243 243 + @doc("The user agent used when initiating the AA flow.") 244 244 + initUa?: string; 245 245 + 246 246 + @doc("The IP address used when completing the AA flow.") 247 247 + completeIp?: string; 248 248 + 249 249 + @doc("The user agent used when completing the AA flow.") 250 250 + completeUa?: string; 251 251 + } 252 252 + 253 253 + @doc("Age assurance status override by moderators. Only works on DID subjects.") 254 254 + model AgeAssuranceOverrideEvent { 255 255 + @doc("Comment describing the reason for the override.") 256 256 + @required 257 257 + comment: string; 258 258 + 259 259 + @doc("The status to be set for the user decided by a moderator, overriding whatever value the user had previously. Use reset to default to original state.") 260 260 + @required 261 261 + status: "assured" | "reset" | "blocked" | string; 262 262 + } 263 263 + 264 264 + @doc("Account credentials revocation by moderators. Only works on DID subjects.") 265 265 + model RevokeAccountCredentialsEvent { 266 266 + @doc("Comment describing the reason for the revocation.") 267 267 + @required 268 268 + comment: string; 269 269 + } 270 270 + 271 271 + model ModEventAcknowledge { 272 272 + comment?: string; 273 273 + 274 274 + @doc("If true, all other reports on content authored by this account will be resolved (acknowledged).") 275 275 + acknowledgeAccountSubjects?: boolean; 276 276 + } 277 277 + 278 278 + model ModEventEscalate { 279 279 + comment?: string; 280 280 + } 281 281 + 282 282 + @doc("Mute incoming reports on a subject") 283 283 + model ModEventMute { 284 284 + comment?: string; 285 285 + 286 286 + @doc("Indicates how long the subject should remain muted.") 287 287 + @required 288 288 + durationInHours: integer; 289 289 + } 290 290 + 291 291 + @doc("Unmute action on a subject") 292 292 + model ModEventUnmute { 293 293 + @doc("Describe reasoning behind the reversal.") 294 294 + comment?: string; 295 295 + } 296 296 + 297 297 + @doc("Mute incoming reports from an account") 298 298 + model ModEventMuteReporter { 299 299 + comment?: string; 300 300 + 301 301 + @doc("Indicates how long the account should remain muted. Falsy value here means a permanent mute.") 302 302 + durationInHours?: integer; 303 303 + } 304 304 + 305 305 + @doc("Unmute incoming reports from an account") 306 306 + model ModEventUnmuteReporter { 307 307 + @doc("Describe reasoning behind the reversal.") 308 308 + comment?: string; 309 309 + } 310 310 + 311 311 + @doc("Keep a log of outgoing email to a user") 312 312 + model ModEventEmail { 313 313 + @doc("The subject line of the email sent to the user.") 314 314 + @required 315 315 + subjectLine: string; 316 316 + 317 317 + @doc("The content of the email sent to the user.") 318 318 + content?: string; 319 319 + 320 320 + @doc("Additional comment about the outgoing comm.") 321 321 + comment?: string; 322 322 + } 323 323 + 324 324 + @doc("Divert a record's blobs to a 3rd party service for further scanning/tagging") 325 325 + model ModEventDivert { 326 326 + comment?: string; 327 327 + } 328 328 + 329 329 + @doc("Add/Remove a tag on a subject") 330 330 + model ModEventTag { 331 331 + @doc("Tags to be added to the subject. If already exists, won't be duplicated.") 332 332 + @required 333 333 + add: string[]; 334 334 + 335 335 + @doc("Tags to be removed to the subject. Ignores a tag If it doesn't exist, won't be duplicated.") 336 336 + @required 337 337 + remove: string[]; 338 338 + 339 339 + @doc("Additional comment about added/removed tags.") 340 340 + comment?: string; 341 341 + } 342 342 + 343 343 + @doc("Logs account status related events on a repo subject. Normally captured by automod from the firehose and emitted to ozone for historical tracking.") 344 344 + model AccountEvent { 345 345 + comment?: string; 346 346 + @required timestamp: datetime; 347 347 + 348 348 + @doc("Indicates that the account has a repository which can be fetched from the host that emitted this event.") 349 349 + @required 350 350 + active: boolean; 351 351 + 352 352 + status?: "unknown" | "deactivated" | "deleted" | "takendown" | "suspended" | "tombstoned" | string; 353 353 + } 354 354 + 355 355 + @doc("Logs identity related events on a repo subject. Normally captured by automod from the firehose and emitted to ozone for historical tracking.") 356 356 + model IdentityEvent { 357 357 + comment?: string; 358 358 + handle?: handle; 359 359 + pdsHost?: uri; 360 360 + tombstone?: boolean; 361 361 + @required timestamp: datetime; 362 362 + } 363 363 + 364 364 + @doc("Logs lifecycle event on a record subject. Normally captured by automod from the firehose and emitted to ozone for historical tracking.") 365 365 + model RecordEvent { 366 366 + comment?: string; 367 367 + @required timestamp: datetime; 368 368 + 369 369 + @required 370 370 + `op`: "create" | "update" | "delete" | string; 371 371 + 372 372 + cid?: cid; 373 373 + } 374 374 + 375 375 + model RepoView { 376 376 + @required did: did; 377 377 + @required handle: handle; 378 378 + email?: string; 379 379 + @required relatedRecords: unknown[]; 380 380 + @required indexedAt: datetime; 381 381 + @required moderation: Moderation; 382 382 + invitedBy?: com.atproto.server.defs.InviteCode; 383 383 + invitesDisabled?: boolean; 384 384 + inviteNote?: string; 385 385 + deactivatedAt?: datetime; 386 386 + threatSignatures?: com.atproto.admin.defs.ThreatSignature[]; 387 387 + } 388 388 + 389 389 + model RepoViewDetail { 390 390 + @required did: did; 391 391 + @required handle: handle; 392 392 + email?: string; 393 393 + @required relatedRecords: unknown[]; 394 394 + @required indexedAt: datetime; 395 395 + @required moderation: ModerationDetail; 396 396 + labels?: com.atproto.label.defs.Label[]; 397 397 + invitedBy?: com.atproto.server.defs.InviteCode; 398 398 + invites?: com.atproto.server.defs.InviteCode[]; 399 399 + invitesDisabled?: boolean; 400 400 + inviteNote?: string; 401 401 + emailConfirmedAt?: datetime; 402 402 + deactivatedAt?: datetime; 403 403 + threatSignatures?: com.atproto.admin.defs.ThreatSignature[]; 404 404 + } 405 405 + 406 406 + model RepoViewNotFound { 407 407 + @required did: did; 408 408 + } 409 409 + 410 410 + model RecordView { 411 411 + @required uri: atUri; 412 412 + @required cid: cid; 413 413 + @required value: unknown; 414 414 + @required blobCids: cid[]; 415 415 + @required indexedAt: datetime; 416 416 + @required moderation: Moderation; 417 417 + @required repo: RepoView; 418 418 + } 419 419 + 420 420 + model RecordViewDetail { 421 421 + @required uri: atUri; 422 422 + @required cid: cid; 423 423 + @required value: unknown; 424 424 + @required blobs: BlobView[]; 425 425 + labels?: com.atproto.label.defs.Label[]; 426 426 + @required indexedAt: datetime; 427 427 + @required moderation: ModerationDetail; 428 428 + @required repo: RepoView; 429 429 + } 430 430 + 431 431 + model RecordViewNotFound { 432 432 + @required uri: atUri; 433 433 + } 434 434 + 435 435 + model Moderation { 436 436 + subjectStatus?: SubjectStatusView; 437 437 + } 438 438 + 439 439 + model ModerationDetail { 440 440 + subjectStatus?: SubjectStatusView; 441 441 + } 442 442 + 443 443 + model BlobView { 444 444 + @required cid: cid; 445 445 + @required mimeType: string; 446 446 + @required size: integer; 447 447 + @required createdAt: datetime; 448 448 + details?: ImageDetails | VideoDetails; 449 449 + moderation?: Moderation; 450 450 + } 451 451 + 452 452 + model ImageDetails { 453 453 + @required width: integer; 454 454 + @required height: integer; 455 455 + } 456 456 + 457 457 + model VideoDetails { 458 458 + @required width: integer; 459 459 + @required height: integer; 460 460 + @required length: integer; 461 461 + } 462 462 + 463 463 + model AccountHosting { 464 464 + @required 465 465 + status: "takendown" | "suspended" | "deleted" | "deactivated" | "unknown" | string; 466 466 + 467 467 + updatedAt?: datetime; 468 468 + createdAt?: datetime; 469 469 + deletedAt?: datetime; 470 470 + deactivatedAt?: datetime; 471 471 + reactivatedAt?: datetime; 472 472 + } 473 473 + 474 474 + model RecordHosting { 475 475 + @required 476 476 + status: "deleted" | "unknown" | string; 477 477 + 478 478 + updatedAt?: datetime; 479 479 + createdAt?: datetime; 480 480 + deletedAt?: datetime; 481 481 + } 482 482 + 483 483 + model ReporterStats { 484 484 + @required did: did; 485 485 + 486 486 + @doc("The total number of reports made by the user on accounts.") 487 487 + @required 488 488 + accountReportCount: integer; 489 489 + 490 490 + @doc("The total number of reports made by the user on records.") 491 491 + @required 492 492 + recordReportCount: integer; 493 493 + 494 494 + @doc("The total number of accounts reported by the user.") 495 495 + @required 496 496 + reportedAccountCount: integer; 497 497 + 498 498 + @doc("The total number of records reported by the user.") 499 499 + @required 500 500 + reportedRecordCount: integer; 501 501 + 502 502 + @doc("The total number of accounts taken down as a result of the user's reports.") 503 503 + @required 504 504 + takendownAccountCount: integer; 505 505 + 506 506 + @doc("The total number of records taken down as a result of the user's reports.") 507 507 + @required 508 508 + takendownRecordCount: integer; 509 509 + 510 510 + @doc("The total number of accounts labeled as a result of the user's reports.") 511 511 + @required 512 512 + labeledAccountCount: integer; 513 513 + 514 514 + @doc("The total number of records labeled as a result of the user's reports.") 515 515 + @required 516 516 + labeledRecordCount: integer; 517 517 + } 518 518 + 519 519 + @doc("Moderation tool information for tracing the source of the action") 520 520 + model ModTool { 521 521 + @doc("Name/identifier of the source (e.g., 'automod', 'ozone/workspace')") 522 522 + @required 523 523 + name: string; 524 524 + 525 525 + @doc("Additional arbitrary metadata about the source") 526 526 + meta?: unknown; 527 527 + } 528 528 + 529 529 + @doc("Moderation event timeline event for a PLC create operation") 530 530 + @token 531 531 + model TimelineEventPlcCreate {} 532 532 + 533 533 + @doc("Moderation event timeline event for generic PLC operation") 534 534 + @token 535 535 + model TimelineEventPlcOperation {} 536 536 + 537 537 + @doc("Moderation event timeline event for a PLC tombstone operation") 538 538 + @token 539 539 + model TimelineEventPlcTombstone {} 540 540 + }

+240

packages/emitter/test/scenarios/atproto/input/tools/ozone/report/defs.tsp

··· 1 1 + import "@tlex/emitter"; 2 2 + 3 3 + namespace tools.ozone.report.defs { 4 4 + union ReasonType { 5 5 + string, 6 6 + 7 7 + ReasonAppeal: "tools.ozone.report.defs#reasonAppeal", 8 8 + 9 9 + ReasonViolenceAnimalWelfare: "tools.ozone.report.defs#reasonViolenceAnimalWelfare", 10 10 + ReasonViolenceThreats: "tools.ozone.report.defs#reasonViolenceThreats", 11 11 + ReasonViolenceGraphicContent: "tools.ozone.report.defs#reasonViolenceGraphicContent", 12 12 + ReasonViolenceSelfHarm: "tools.ozone.report.defs#reasonViolenceSelfHarm", 13 13 + ReasonViolenceGlorification: "tools.ozone.report.defs#reasonViolenceGlorification", 14 14 + ReasonViolenceExtremistContent: "tools.ozone.report.defs#reasonViolenceExtremistContent", 15 15 + ReasonViolenceTrafficking: "tools.ozone.report.defs#reasonViolenceTrafficking", 16 16 + ReasonViolenceOther: "tools.ozone.report.defs#reasonViolenceOther", 17 17 + 18 18 + ReasonSexualAbuseContent: "tools.ozone.report.defs#reasonSexualAbuseContent", 19 19 + ReasonSexualNCII: "tools.ozone.report.defs#reasonSexualNCII", 20 20 + ReasonSexualSextortion: "tools.ozone.report.defs#reasonSexualSextortion", 21 21 + ReasonSexualDeepfake: "tools.ozone.report.defs#reasonSexualDeepfake", 22 22 + ReasonSexualAnimal: "tools.ozone.report.defs#reasonSexualAnimal", 23 23 + ReasonSexualUnlabeled: "tools.ozone.report.defs#reasonSexualUnlabeled", 24 24 + ReasonSexualOther: "tools.ozone.report.defs#reasonSexualOther", 25 25 + 26 26 + ReasonChildSafetyCSAM: "tools.ozone.report.defs#reasonChildSafetyCSAM", 27 27 + ReasonChildSafetyGroom: "tools.ozone.report.defs#reasonChildSafetyGroom", 28 28 + ReasonChildSafetyMinorPrivacy: "tools.ozone.report.defs#reasonChildSafetyMinorPrivacy", 29 29 + ReasonChildSafetyEndangerment: "tools.ozone.report.defs#reasonChildSafetyEndangerment", 30 30 + ReasonChildSafetyHarassment: "tools.ozone.report.defs#reasonChildSafetyHarassment", 31 31 + ReasonChildSafetyPromotion: "tools.ozone.report.defs#reasonChildSafetyPromotion", 32 32 + ReasonChildSafetyOther: "tools.ozone.report.defs#reasonChildSafetyOther", 33 33 + 34 34 + ReasonHarassmentTroll: "tools.ozone.report.defs#reasonHarassmentTroll", 35 35 + ReasonHarassmentTargeted: "tools.ozone.report.defs#reasonHarassmentTargeted", 36 36 + ReasonHarassmentHateSpeech: "tools.ozone.report.defs#reasonHarassmentHateSpeech", 37 37 + ReasonHarassmentDoxxing: "tools.ozone.report.defs#reasonHarassmentDoxxing", 38 38 + ReasonHarassmentOther: "tools.ozone.report.defs#reasonHarassmentOther", 39 39 + 40 40 + ReasonMisleadingBot: "tools.ozone.report.defs#reasonMisleadingBot", 41 41 + ReasonMisleadingImpersonation: "tools.ozone.report.defs#reasonMisleadingImpersonation", 42 42 + ReasonMisleadingSpam: "tools.ozone.report.defs#reasonMisleadingSpam", 43 43 + ReasonMisleadingScam: "tools.ozone.report.defs#reasonMisleadingScam", 44 44 + ReasonMisleadingSyntheticContent: "tools.ozone.report.defs#reasonMisleadingSyntheticContent", 45 45 + ReasonMisleadingMisinformation: "tools.ozone.report.defs#reasonMisleadingMisinformation", 46 46 + ReasonMisleadingOther: "tools.ozone.report.defs#reasonMisleadingOther", 47 47 + 48 48 + ReasonRuleSiteSecurity: "tools.ozone.report.defs#reasonRuleSiteSecurity", 49 49 + ReasonRuleStolenContent: "tools.ozone.report.defs#reasonRuleStolenContent", 50 50 + ReasonRuleProhibitedSales: "tools.ozone.report.defs#reasonRuleProhibitedSales", 51 51 + ReasonRuleBanEvasion: "tools.ozone.report.defs#reasonRuleBanEvasion", 52 52 + ReasonRuleOther: "tools.ozone.report.defs#reasonRuleOther", 53 53 + 54 54 + ReasonCivicElectoralProcess: "tools.ozone.report.defs#reasonCivicElectoralProcess", 55 55 + ReasonCivicDisclosure: "tools.ozone.report.defs#reasonCivicDisclosure", 56 56 + ReasonCivicInterference: "tools.ozone.report.defs#reasonCivicInterference", 57 57 + ReasonCivicMisinformation: "tools.ozone.report.defs#reasonCivicMisinformation", 58 58 + ReasonCivicImpersonation: "tools.ozone.report.defs#reasonCivicImpersonation", 59 59 + } 60 60 + 61 61 + @doc("Appeal a previously taken moderation action") 62 62 + @token 63 63 + model ReasonAppeal {} 64 64 + 65 65 + @doc("Animal welfare violations") 66 66 + @token 67 67 + model ReasonViolenceAnimalWelfare {} 68 68 + 69 69 + @doc("Threats or incitement") 70 70 + @token 71 71 + model ReasonViolenceThreats {} 72 72 + 73 73 + @doc("Graphic violent content") 74 74 + @token 75 75 + model ReasonViolenceGraphicContent {} 76 76 + 77 77 + @doc("Self harm") 78 78 + @token 79 79 + model ReasonViolenceSelfHarm {} 80 80 + 81 81 + @doc("Glorification of violence") 82 82 + @token 83 83 + model ReasonViolenceGlorification {} 84 84 + 85 85 + @doc("Extremist content. These reports will be sent only be sent to the application's Moderation Authority.") 86 86 + @token 87 87 + model ReasonViolenceExtremistContent {} 88 88 + 89 89 + @doc("Human trafficking") 90 90 + @token 91 91 + model ReasonViolenceTrafficking {} 92 92 + 93 93 + @doc("Other violent content") 94 94 + @token 95 95 + model ReasonViolenceOther {} 96 96 + 97 97 + @doc("Adult sexual abuse content") 98 98 + @token 99 99 + model ReasonSexualAbuseContent {} 100 100 + 101 101 + @doc("Non-consensual intimate imagery") 102 102 + @token 103 103 + model ReasonSexualNCII {} 104 104 + 105 105 + @doc("Sextortion") 106 106 + @token 107 107 + model ReasonSexualSextortion {} 108 108 + 109 109 + @doc("Deepfake adult content") 110 110 + @token 111 111 + model ReasonSexualDeepfake {} 112 112 + 113 113 + @doc("Animal sexual abuse") 114 114 + @token 115 115 + model ReasonSexualAnimal {} 116 116 + 117 117 + @doc("Unlabelled adult content") 118 118 + @token 119 119 + model ReasonSexualUnlabeled {} 120 120 + 121 121 + @doc("Other sexual violence content") 122 122 + @token 123 123 + model ReasonSexualOther {} 124 124 + 125 125 + @doc("Child sexual abuse material (CSAM). These reports will be sent only be sent to the application's Moderation Authority.") 126 126 + @token 127 127 + model ReasonChildSafetyCSAM {} 128 128 + 129 129 + @doc("Grooming or predatory behavior. These reports will be sent only be sent to the application's Moderation Authority.") 130 130 + @token 131 131 + model ReasonChildSafetyGroom {} 132 132 + 133 133 + @doc("Privacy violation involving a minor") 134 134 + @token 135 135 + model ReasonChildSafetyMinorPrivacy {} 136 136 + 137 137 + @doc("Child endangerment. These reports will be sent only be sent to the application's Moderation Authority.") 138 138 + @token 139 139 + model ReasonChildSafetyEndangerment {} 140 140 + 141 141 + @doc("Harassment or bullying of minors") 142 142 + @token 143 143 + model ReasonChildSafetyHarassment {} 144 144 + 145 145 + @doc("Promotion of child exploitation. These reports will be sent only be sent to the application's Moderation Authority.") 146 146 + @token 147 147 + model ReasonChildSafetyPromotion {} 148 148 + 149 149 + @doc("Other child safety. These reports will be sent only be sent to the application's Moderation Authority.") 150 150 + @token 151 151 + model ReasonChildSafetyOther {} 152 152 + 153 153 + @doc("Trolling") 154 154 + @token 155 155 + model ReasonHarassmentTroll {} 156 156 + 157 157 + @doc("Targeted harassment") 158 158 + @token 159 159 + model ReasonHarassmentTargeted {} 160 160 + 161 161 + @doc("Hate speech") 162 162 + @token 163 163 + model ReasonHarassmentHateSpeech {} 164 164 + 165 165 + @doc("Doxxing") 166 166 + @token 167 167 + model ReasonHarassmentDoxxing {} 168 168 + 169 169 + @doc("Other harassing or hateful content") 170 170 + @token 171 171 + model ReasonHarassmentOther {} 172 172 + 173 173 + @doc("Fake account or bot") 174 174 + @token 175 175 + model ReasonMisleadingBot {} 176 176 + 177 177 + @doc("Impersonation") 178 178 + @token 179 179 + model ReasonMisleadingImpersonation {} 180 180 + 181 181 + @doc("Spam") 182 182 + @token 183 183 + model ReasonMisleadingSpam {} 184 184 + 185 185 + @doc("Scam") 186 186 + @token 187 187 + model ReasonMisleadingScam {} 188 188 + 189 189 + @doc("Unlabelled gen-AI or synthetic content") 190 190 + @token 191 191 + model ReasonMisleadingSyntheticContent {} 192 192 + 193 193 + @doc("Harmful false claims") 194 194 + @token 195 195 + model ReasonMisleadingMisinformation {} 196 196 + 197 197 + @doc("Other misleading content") 198 198 + @token 199 199 + model ReasonMisleadingOther {} 200 200 + 201 201 + @doc("Hacking or system attacks") 202 202 + @token 203 203 + model ReasonRuleSiteSecurity {} 204 204 + 205 205 + @doc("Stolen content") 206 206 + @token 207 207 + model ReasonRuleStolenContent {} 208 208 + 209 209 + @doc("Promoting or selling prohibited items or services") 210 210 + @token 211 211 + model ReasonRuleProhibitedSales {} 212 212 + 213 213 + @doc("Banned user returning") 214 214 + @token 215 215 + model ReasonRuleBanEvasion {} 216 216 + 217 217 + @doc("Other") 218 218 + @token 219 219 + model ReasonRuleOther {} 220 220 + 221 221 + @doc("Electoral process violations") 222 222 + @token 223 223 + model ReasonCivicElectoralProcess {} 224 224 + 225 225 + @doc("Disclosure & transparency violations") 226 226 + @token 227 227 + model ReasonCivicDisclosure {} 228 228 + 229 229 + @doc("Voter intimidation or interference") 230 230 + @token 231 231 + model ReasonCivicInterference {} 232 232 + 233 233 + @doc("Election misinformation") 234 234 + @token 235 235 + model ReasonCivicMisinformation {} 236 236 + 237 237 + @doc("Impersonation of electoral officials/entities") 238 238 + @token 239 239 + model ReasonCivicImpersonation {} 240 240 + }

+83

packages/emitter/test/scenarios/atproto/input/tools/ozone/safelink/defs.tsp

··· 1 1 + import "@tlex/emitter"; 2 2 + 3 3 + namespace tools.ozone.safelink.defs { 4 4 + @doc("An event for URL safety decisions") 5 5 + model Event { 6 6 + @doc("Auto-incrementing row ID") 7 7 + @required 8 8 + id: integer; 9 9 + 10 10 + @required eventType: EventType; 11 11 + 12 12 + @doc("The URL that this rule applies to") 13 13 + @required 14 14 + url: string; 15 15 + 16 16 + @required pattern: PatternType; 17 17 + @required action: ActionType; 18 18 + @required reason: ReasonType; 19 19 + 20 20 + @doc("DID of the user who created this rule") 21 21 + @required 22 22 + createdBy: did; 23 23 + 24 24 + @required createdAt: datetime; 25 25 + 26 26 + @doc("Optional comment about the decision") 27 27 + comment?: string; 28 28 + } 29 29 + 30 30 + union EventType { 31 31 + "addRule", 32 32 + "updateRule", 33 33 + "removeRule", 34 34 + string, 35 35 + } 36 36 + 37 37 + union PatternType { 38 38 + "domain", 39 39 + "url", 40 40 + string, 41 41 + } 42 42 + 43 43 + union ActionType { 44 44 + "block", 45 45 + "warn", 46 46 + "whitelist", 47 47 + string, 48 48 + } 49 49 + 50 50 + union ReasonType { 51 51 + "csam", 52 52 + "spam", 53 53 + "phishing", 54 54 + "none", 55 55 + string, 56 56 + } 57 57 + 58 58 + @doc("Input for creating a URL safety rule") 59 59 + model UrlRule { 60 60 + @doc("The URL or domain to apply the rule to") 61 61 + @required 62 62 + url: string; 63 63 + 64 64 + @required pattern: PatternType; 65 65 + @required action: ActionType; 66 66 + @required reason: ReasonType; 67 67 + 68 68 + @doc("Optional comment about the decision") 69 69 + comment?: string; 70 70 + 71 71 + @doc("DID of the user added the rule.") 72 72 + @required 73 73 + createdBy: did; 74 74 + 75 75 + @doc("Timestamp when the rule was created") 76 76 + @required 77 77 + createdAt: datetime; 78 78 + 79 79 + @doc("Timestamp when the rule was last updated") 80 80 + @required 81 81 + updatedAt: datetime; 82 82 + } 83 83 + }

+24

packages/emitter/test/scenarios/atproto/input/tools/ozone/server/getConfig.tsp

··· 1 1 + import "@tlex/emitter"; 2 2 + 3 3 + namespace tools.ozone.server.getConfig { 4 4 + model ServiceConfig { 5 5 + url?: uri; 6 6 + } 7 7 + 8 8 + model ViewerConfig { 9 9 + role?: "tools.ozone.team.defs#roleAdmin" | "tools.ozone.team.defs#roleModerator" | "tools.ozone.team.defs#roleTriage" | "tools.ozone.team.defs#roleVerifier" | string; 10 10 + } 11 11 + 12 12 + @doc("Get details about ozone's server configuration.") 13 13 + @query 14 14 + op main(): { 15 15 + appview?: ServiceConfig; 16 16 + pds?: ServiceConfig; 17 17 + blobDivert?: ServiceConfig; 18 18 + chat?: ServiceConfig; 19 19 + viewer?: ViewerConfig; 20 20 + 21 21 + @doc("The did of the verifier used for verification.") 22 22 + verifierDid?: did; 23 23 + }; 24 24 + }

+29

packages/emitter/test/scenarios/atproto/input/tools/ozone/set/defs.tsp

··· 1 1 + import "@tlex/emitter"; 2 2 + 3 3 + namespace tools.ozone.set.defs { 4 4 + model Set { 5 5 + @minLength(3) 6 6 + @maxLength(128) 7 7 + @required 8 8 + name: string; 9 9 + 10 10 + @maxGraphemes(1024) 11 11 + @maxLength(10240) 12 12 + description?: string; 13 13 + } 14 14 + 15 15 + model SetView { 16 16 + @minLength(3) 17 17 + @maxLength(128) 18 18 + @required 19 19 + name: string; 20 20 + 21 21 + @maxGraphemes(1024) 22 22 + @maxLength(10240) 23 23 + description?: string; 24 24 + 25 25 + @required setSize: integer; 26 26 + @required createdAt: datetime; 27 27 + @required updatedAt: datetime; 28 28 + } 29 29 + }

+24

packages/emitter/test/scenarios/atproto/input/tools/ozone/setting/defs.tsp

··· 1 1 + import "@tlex/emitter"; 2 2 + 3 3 + namespace tools.ozone.setting.defs { 4 4 + model Option { 5 5 + @required key: nsid; 6 6 + @required value: unknown; 7 7 + @required did: did; 8 8 + 9 9 + @maxGraphemes(1024) 10 10 + @maxLength(10240) 11 11 + description?: string; 12 12 + 13 13 + createdAt?: datetime; 14 14 + updatedAt?: datetime; 15 15 + 16 16 + managerRole?: "tools.ozone.team.defs#roleModerator" | "tools.ozone.team.defs#roleTriage" | "tools.ozone.team.defs#roleAdmin" | "tools.ozone.team.defs#roleVerifier" | string; 17 17 + 18 18 + @required 19 19 + scope: "instance" | "personal" | string; 20 20 + 21 21 + @required createdBy: did; 22 22 + @required lastUpdatedBy: did; 23 23 + } 24 24 + }

+31

packages/emitter/test/scenarios/atproto/input/tools/ozone/team/defs.tsp

··· 1 1 + import "@tlex/emitter"; 2 2 + 3 3 + namespace tools.ozone.team.defs { 4 4 + model Member { 5 5 + @required did: did; 6 6 + disabled?: boolean; 7 7 + profile?: app.bsky.actor.defs.ProfileViewDetailed; 8 8 + createdAt?: datetime; 9 9 + updatedAt?: datetime; 10 10 + lastUpdatedBy?: string; 11 11 + 12 12 + @required 13 13 + role: "#roleAdmin" | "#roleModerator" | "#roleTriage" | "#roleVerifier" | string; 14 14 + } 15 15 + 16 16 + @doc("Admin role. Highest level of access, can perform all actions.") 17 17 + @token 18 18 + model RoleAdmin {} 19 19 + 20 20 + @doc("Moderator role. Can perform most actions.") 21 21 + @token 22 22 + model RoleModerator {} 23 23 + 24 24 + @doc("Triage role. Mostly intended for monitoring and escalating issues.") 25 25 + @token 26 26 + model RoleTriage {} 27 27 + 28 28 + @doc("Verifier role. Only allowed to issue verifications.") 29 29 + @token 30 30 + model RoleVerifier {} 31 31 + }

+44

packages/emitter/test/scenarios/atproto/input/tools/ozone/verification/defs.tsp

··· 1 1 + import "@tlex/emitter"; 2 2 + 3 3 + namespace tools.ozone.verification.defs { 4 4 + @doc("Verification data for the associated subject.") 5 5 + model VerificationView { 6 6 + @doc("The user who issued this verification.") 7 7 + @required 8 8 + issuer: did; 9 9 + 10 10 + @doc("The AT-URI of the verification record.") 11 11 + @required 12 12 + uri: atUri; 13 13 + 14 14 + @doc("The subject of the verification.") 15 15 + @required 16 16 + subject: did; 17 17 + 18 18 + @doc("Handle of the subject the verification applies to at the moment of verifying, which might not be the same at the time of viewing. The verification is only valid if the current handle matches the one at the time of verifying.") 19 19 + @required 20 20 + handle: handle; 21 21 + 22 22 + @doc("Display name of the subject the verification applies to at the moment of verifying, which might not be the same at the time of viewing. The verification is only valid if the current displayName matches the one at the time of verifying.") 23 23 + @required 24 24 + displayName: string; 25 25 + 26 26 + @doc("Timestamp when the verification was created.") 27 27 + @required 28 28 + createdAt: datetime; 29 29 + 30 30 + @doc("Describes the reason for revocation, also indicating that the verification is no longer valid.") 31 31 + revokeReason?: string; 32 32 + 33 33 + @doc("Timestamp when the verification was revoked.") 34 34 + revokedAt?: datetime; 35 35 + 36 36 + @doc("The user who revoked this verification.") 37 37 + revokedBy?: did; 38 38 + 39 39 + subjectProfile?: (never | unknown); 40 40 + issuerProfile?: (never | unknown); 41 41 + subjectRepo?: tools.ozone.moderation.defs.RepoViewDetail | tools.ozone.moderation.defs.RepoViewNotFound; 42 42 + issuerRepo?: tools.ozone.moderation.defs.RepoViewDetail | tools.ozone.moderation.defs.RepoViewNotFound; 43 43 + } 44 44 + }

+36

packages/emitter/test/spec/README.md

··· 1 1 + # Lexicon Spec Test Fixtures 2 2 + 3 3 + This directory contains test fixtures organized by ATProto Lexicon specification features, not by real-world examples. 4 4 + 5 5 + ## Organization 6 6 + 7 7 + Each subdirectory focuses on a specific feature from the [Lexicon spec](https://atproto.com/specs/lexicon): 8 8 + 9 9 + - **union/** - Union type features (open, closed, variants) 10 10 + - **string-constraints/** - String knownValues, enum, formats 11 11 + - **validation/** - Constraints (min/max length/value, graphemes) 12 12 + - **primary-types/** - Record, query, procedure, subscription 13 13 + - **field-types/** - Primitive types and their features 14 14 + - **refs/** - Reference patterns (local, cross-namespace) 15 15 + - **nullable/** - Nullable field handling 16 16 + - **unknown/** - Unknown type usage 17 17 + - **tokens/** - Token definitions and usage 18 18 + - **binary/** - Blob and bytes types 19 19 + - **evolution/** - Schema evolution patterns 20 20 + 21 21 + ## Purpose 22 22 + 23 23 + Unlike `test/scenarios/atproto/` which tests real ATProto lexicons, these fixtures: 24 24 + 25 25 + 1. Test each spec feature in isolation 26 26 + 2. Demonstrate minimal, focused examples 27 27 + 3. Serve as documentation for TypeSpec → Lexicon mappings 28 28 + 4. Catch edge cases and corner cases in the spec 29 29 + 30 30 + ## Example Structure 31 31 + 32 32 + Each feature directory contains: 33 33 + - `input/*.tsp` - TypeSpec definitions for that feature 34 34 + - `output/*.json` - Expected Lexicon JSON output 35 35 + 36 36 + Tests should be atomic and focus on one feature at a time.

+39

packages/emitter/test/spec/output/binary-types/blob.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.blobs", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "object", 7 7 + "description": "Blob type examples", 8 8 + "properties": { 9 9 + "simpleBlob": { 10 10 + "type": "blob", 11 11 + "description": "Basic blob with no constraints" 12 12 + }, 13 13 + "imageBlob": { 14 14 + "type": "blob", 15 15 + "accept": ["image/*"], 16 16 + "maxSize": 5000000, 17 17 + "description": "Image blob up to 5MB" 18 18 + }, 19 19 + "specificImages": { 20 20 + "type": "blob", 21 21 + "accept": ["image/png", "image/jpeg", "image/gif"], 22 22 + "maxSize": 2000000, 23 23 + "description": "Specific image types up to 2MB" 24 24 + }, 25 25 + "videoBlob": { 26 26 + "type": "blob", 27 27 + "accept": ["video/mp4", "video/webm"], 28 28 + "maxSize": 100000000, 29 29 + "description": "Video blob up to 100MB" 30 30 + }, 31 31 + "anyBlob": { 32 32 + "type": "blob", 33 33 + "accept": ["*/*"], 34 34 + "description": "Accept any MIME type" 35 35 + } 36 36 + } 37 37 + } 38 38 + } 39 39 + }

+20

packages/emitter/test/spec/output/binary-types/cid-link.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.cidLinks", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "object", 7 7 + "description": "CID link examples", 8 8 + "properties": { 9 9 + "contentCid": { 10 10 + "type": "cid-link", 11 11 + "description": "A CID link to content" 12 12 + }, 13 13 + "previousVersion": { 14 14 + "type": "cid-link", 15 15 + "description": "Link to previous version" 16 16 + } 17 17 + } 18 18 + } 19 19 + } 20 20 + }

+70

packages/emitter/test/spec/output/container-types/array.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.arrays", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "object", 7 7 + "description": "Array container types", 8 8 + "properties": { 9 9 + "stringArray": { 10 10 + "type": "array", 11 11 + "items": { 12 12 + "type": "string" 13 13 + }, 14 14 + "description": "Array of strings" 15 15 + }, 16 16 + "arrayWithLength": { 17 17 + "type": "array", 18 18 + "items": { 19 19 + "type": "integer" 20 20 + }, 21 21 + "minLength": 1, 22 22 + "maxLength": 10, 23 23 + "description": "Array with size constraints" 24 24 + }, 25 25 + "arrayOfRefs": { 26 26 + "type": "array", 27 27 + "items": { 28 28 + "type": "ref", 29 29 + "ref": "#item" 30 30 + }, 31 31 + "description": "Array of object references" 32 32 + }, 33 33 + "arrayOfUnion": { 34 34 + "type": "array", 35 35 + "items": { 36 36 + "type": "union", 37 37 + "refs": ["#typeA", "#typeB"] 38 38 + }, 39 39 + "description": "Array of union types" 40 40 + } 41 41 + } 42 42 + }, 43 43 + "item": { 44 44 + "type": "object", 45 45 + "properties": { 46 46 + "value": { 47 47 + "type": "string" 48 48 + } 49 49 + } 50 50 + }, 51 51 + "typeA": { 52 52 + "type": "object", 53 53 + "required": ["a"], 54 54 + "properties": { 55 55 + "a": { 56 56 + "type": "string" 57 57 + } 58 58 + } 59 59 + }, 60 60 + "typeB": { 61 61 + "type": "object", 62 62 + "required": ["b"], 63 63 + "properties": { 64 64 + "b": { 65 65 + "type": "integer" 66 66 + } 67 67 + } 68 68 + } 69 69 + } 70 70 + }

+42

packages/emitter/test/spec/output/container-types/object.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.objects", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "object", 7 7 + "description": "Object with various property configurations", 8 8 + "required": ["requiredField"], 9 9 + "nullable": ["nullableField"], 10 10 + "properties": { 11 11 + "requiredField": { 12 12 + "type": "string", 13 13 + "description": "This field is required" 14 14 + }, 15 15 + "optionalField": { 16 16 + "type": "string", 17 17 + "description": "This field is optional" 18 18 + }, 19 19 + "nullableField": { 20 20 + "type": "string", 21 21 + "description": "This field can be null" 22 22 + }, 23 23 + "nestedObject": { 24 24 + "type": "ref", 25 25 + "ref": "#nested" 26 26 + } 27 27 + } 28 28 + }, 29 29 + "nested": { 30 30 + "type": "object", 31 31 + "required": ["id"], 32 32 + "properties": { 33 33 + "id": { 34 34 + "type": "string" 35 35 + }, 36 36 + "label": { 37 37 + "type": "string" 38 38 + } 39 39 + } 40 40 + } 41 41 + } 42 42 + }

+56

packages/emitter/test/spec/output/container-types/params.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.queryParams", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "query", 7 7 + "description": "Query with various parameter types", 8 8 + "parameters": { 9 9 + "type": "params", 10 10 + "required": ["requiredParam"], 11 11 + "properties": { 12 12 + "requiredParam": { 13 13 + "type": "string", 14 14 + "description": "A required query parameter" 15 15 + }, 16 16 + "boolParam": { 17 17 + "type": "boolean", 18 18 + "description": "Optional boolean parameter" 19 19 + }, 20 20 + "intParam": { 21 21 + "type": "integer", 22 22 + "description": "Optional integer parameter" 23 23 + }, 24 24 + "stringParam": { 25 25 + "type": "string", 26 26 + "maxLength": 100, 27 27 + "description": "Optional string parameter" 28 28 + }, 29 29 + "arrayParam": { 30 30 + "type": "array", 31 31 + "items": { 32 32 + "type": "string" 33 33 + }, 34 34 + "description": "Array of strings" 35 35 + }, 36 36 + "unknownParam": { 37 37 + "type": "unknown", 38 38 + "description": "Unknown type parameter" 39 39 + } 40 40 + } 41 41 + }, 42 42 + "output": { 43 43 + "encoding": "application/json", 44 44 + "schema": { 45 45 + "type": "object", 46 46 + "required": ["result"], 47 47 + "properties": { 48 48 + "result": { 49 49 + "type": "string" 50 50 + } 51 51 + } 52 52 + } 53 53 + } 54 54 + } 55 55 + } 56 56 + }

+32

packages/emitter/test/spec/output/field-types/boolean-constraints.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.booleanConstraints", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "object", 7 7 + "description": "Boolean field constraints", 8 8 + "properties": { 9 9 + "defaultTrue": { 10 10 + "type": "boolean", 11 11 + "default": true, 12 12 + "description": "Boolean with default true" 13 13 + }, 14 14 + "defaultFalse": { 15 15 + "type": "boolean", 16 16 + "default": false, 17 17 + "description": "Boolean with default false" 18 18 + }, 19 19 + "constTrue": { 20 20 + "type": "boolean", 21 21 + "const": true, 22 22 + "description": "Constant true value" 23 23 + }, 24 24 + "constFalse": { 25 25 + "type": "boolean", 26 26 + "const": false, 27 27 + "description": "Constant false value" 28 28 + } 29 29 + } 30 30 + } 31 31 + } 32 32 + }

+32

packages/emitter/test/spec/output/field-types/bytes-constraints.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.bytesConstraints", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "object", 7 7 + "description": "Bytes field constraints", 8 8 + "properties": { 9 9 + "simpleBytes": { 10 10 + "type": "bytes", 11 11 + "description": "Basic bytes field" 12 12 + }, 13 13 + "withLength": { 14 14 + "type": "bytes", 15 15 + "minLength": 1, 16 16 + "maxLength": 1024, 17 17 + "description": "Bytes with size constraints" 18 18 + }, 19 19 + "withMinOnly": { 20 20 + "type": "bytes", 21 21 + "minLength": 32, 22 22 + "description": "Bytes with minimum size only" 23 23 + }, 24 24 + "withMaxOnly": { 25 25 + "type": "bytes", 26 26 + "maxLength": 5000000, 27 27 + "description": "Bytes with maximum size only (5MB)" 28 28 + } 29 29 + } 30 30 + } 31 31 + } 32 32 + }

+33

packages/emitter/test/spec/output/field-types/integer-constraints.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.integerConstraints", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "object", 7 7 + "description": "Integer field constraints", 8 8 + "properties": { 9 9 + "withMinMax": { 10 10 + "type": "integer", 11 11 + "minimum": 1, 12 12 + "maximum": 100, 13 13 + "description": "Integer between 1 and 100" 14 14 + }, 15 15 + "withEnum": { 16 16 + "type": "integer", 17 17 + "enum": [1, 2, 3, 5, 8, 13], 18 18 + "description": "Fibonacci numbers only" 19 19 + }, 20 20 + "withDefault": { 21 21 + "type": "integer", 22 22 + "default": 42, 23 23 + "description": "Integer with default value" 24 24 + }, 25 25 + "withConst": { 26 26 + "type": "integer", 27 27 + "const": 99, 28 28 + "description": "Constant integer value" 29 29 + } 30 30 + } 31 31 + } 32 32 + } 33 33 + }

+32

packages/emitter/test/spec/output/field-types/primitives.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.primitives", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "object", 7 7 + "description": "All primitive field types", 8 8 + "properties": { 9 9 + "boolField": { 10 10 + "type": "boolean", 11 11 + "description": "A boolean field" 12 12 + }, 13 13 + "intField": { 14 14 + "type": "integer", 15 15 + "description": "An integer field" 16 16 + }, 17 17 + "stringField": { 18 18 + "type": "string", 19 19 + "description": "A string field" 20 20 + }, 21 21 + "bytesField": { 22 22 + "type": "bytes", 23 23 + "description": "A bytes field" 24 24 + }, 25 25 + "cidField": { 26 26 + "type": "cid-link", 27 27 + "description": "A CID link field" 28 28 + } 29 29 + } 30 30 + } 31 31 + } 32 32 + }

+52

packages/emitter/test/spec/output/field-types/string-constraints.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.stringConstraints", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "object", 7 7 + "description": "String field constraints", 8 8 + "properties": { 9 9 + "withLength": { 10 10 + "type": "string", 11 11 + "minLength": 1, 12 12 + "maxLength": 100, 13 13 + "description": "String with byte length constraints" 14 14 + }, 15 15 + "withGraphemes": { 16 16 + "type": "string", 17 17 + "minGraphemes": 1, 18 18 + "maxGraphemes": 50, 19 19 + "description": "String with grapheme cluster length constraints" 20 20 + }, 21 21 + "withBothLengths": { 22 22 + "type": "string", 23 23 + "minLength": 1, 24 24 + "maxLength": 300, 25 25 + "minGraphemes": 1, 26 26 + "maxGraphemes": 100, 27 27 + "description": "String with both byte and grapheme constraints" 28 28 + }, 29 29 + "withEnum": { 30 30 + "type": "string", 31 31 + "enum": ["draft", "published", "archived"], 32 32 + "description": "Closed enum of allowed values" 33 33 + }, 34 34 + "withKnownValues": { 35 35 + "type": "string", 36 36 + "knownValues": ["en", "es", "fr", "de", "ja"], 37 37 + "description": "Open set of suggested values" 38 38 + }, 39 39 + "withDefault": { 40 40 + "type": "string", 41 41 + "default": "hello", 42 42 + "description": "String with default value" 43 43 + }, 44 44 + "withConst": { 45 45 + "type": "string", 46 46 + "const": "fixed-value", 47 47 + "description": "Constant string value" 48 48 + } 49 49 + } 50 50 + } 51 51 + } 52 52 + }

+36

packages/emitter/test/spec/output/meta-types/ref.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.refs", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "object", 7 7 + "description": "Reference examples", 8 8 + "properties": { 9 9 + "localRef": { 10 10 + "type": "ref", 11 11 + "ref": "#localDef", 12 12 + "description": "Reference to local definition" 13 13 + }, 14 14 + "externalRef": { 15 15 + "type": "ref", 16 16 + "ref": "com.example.other#someDef", 17 17 + "description": "Reference to external definition" 18 18 + }, 19 19 + "mainRef": { 20 20 + "type": "ref", 21 21 + "ref": "com.example.record", 22 22 + "description": "Reference to main definition (no fragment)" 23 23 + } 24 24 + } 25 25 + }, 26 26 + "localDef": { 27 27 + "type": "object", 28 28 + "required": ["value"], 29 29 + "properties": { 30 30 + "value": { 31 31 + "type": "string" 32 32 + } 33 33 + } 34 34 + } 35 35 + } 36 36 + }

+29

packages/emitter/test/spec/output/meta-types/token.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.tokens", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "object", 7 7 + "description": "Token usage example", 8 8 + "required": ["status"], 9 9 + "properties": { 10 10 + "status": { 11 11 + "type": "ref", 12 12 + "ref": "#active" 13 13 + } 14 14 + } 15 15 + }, 16 16 + "active": { 17 17 + "type": "token", 18 18 + "description": "Indicates an active state" 19 19 + }, 20 20 + "inactive": { 21 21 + "type": "token", 22 22 + "description": "Indicates an inactive state" 23 23 + }, 24 24 + "pending": { 25 25 + "type": "token", 26 26 + "description": "Indicates a pending state" 27 27 + } 28 28 + } 29 29 + }

+61

packages/emitter/test/spec/output/meta-types/union-closed.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.unionClosed", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "object", 7 7 + "description": "Closed union example", 8 8 + "required": ["action"], 9 9 + "properties": { 10 10 + "action": { 11 11 + "type": "union", 12 12 + "refs": ["#create", "#update", "#delete"], 13 13 + "closed": true, 14 14 + "description": "Closed union - no more variants allowed" 15 15 + } 16 16 + } 17 17 + }, 18 18 + "create": { 19 19 + "type": "object", 20 20 + "required": ["type", "data"], 21 21 + "properties": { 22 22 + "type": { 23 23 + "type": "string", 24 24 + "const": "create" 25 25 + }, 26 26 + "data": { 27 27 + "type": "string" 28 28 + } 29 29 + } 30 30 + }, 31 31 + "update": { 32 32 + "type": "object", 33 33 + "required": ["type", "id", "data"], 34 34 + "properties": { 35 35 + "type": { 36 36 + "type": "string", 37 37 + "const": "update" 38 38 + }, 39 39 + "id": { 40 40 + "type": "string" 41 41 + }, 42 42 + "data": { 43 43 + "type": "string" 44 44 + } 45 45 + } 46 46 + }, 47 47 + "delete": { 48 48 + "type": "object", 49 49 + "required": ["type", "id"], 50 50 + "properties": { 51 51 + "type": { 52 52 + "type": "string", 53 53 + "const": "delete" 54 54 + }, 55 55 + "id": { 56 56 + "type": "string" 57 57 + } 58 58 + } 59 59 + } 60 60 + } 61 61 + }

+17

packages/emitter/test/spec/output/meta-types/union-empty.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.unionEmpty", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "object", 7 7 + "description": "Empty open union (similar to unknown but requires $type)", 8 8 + "properties": { 9 9 + "data": { 10 10 + "type": "union", 11 11 + "refs": [], 12 12 + "description": "Empty open union - any object with $type allowed" 13 13 + } 14 14 + } 15 15 + } 16 16 + } 17 17 + }

+57

packages/emitter/test/spec/output/meta-types/union-open.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.unionOpen", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "object", 7 7 + "description": "Open union example (default)", 8 8 + "required": ["item"], 9 9 + "properties": { 10 10 + "item": { 11 11 + "type": "union", 12 12 + "refs": ["#typeA", "#typeB", "#typeC"], 13 13 + "description": "Open union - more variants can be added in future" 14 14 + } 15 15 + } 16 16 + }, 17 17 + "typeA": { 18 18 + "type": "object", 19 19 + "required": ["kind", "valueA"], 20 20 + "properties": { 21 21 + "kind": { 22 22 + "type": "string", 23 23 + "const": "a" 24 24 + }, 25 25 + "valueA": { 26 26 + "type": "string" 27 27 + } 28 28 + } 29 29 + }, 30 30 + "typeB": { 31 31 + "type": "object", 32 32 + "required": ["kind", "valueB"], 33 33 + "properties": { 34 34 + "kind": { 35 35 + "type": "string", 36 36 + "const": "b" 37 37 + }, 38 38 + "valueB": { 39 39 + "type": "integer" 40 40 + } 41 41 + } 42 42 + }, 43 43 + "typeC": { 44 44 + "type": "object", 45 45 + "required": ["kind", "valueC"], 46 46 + "properties": { 47 47 + "kind": { 48 48 + "type": "string", 49 49 + "const": "c" 50 50 + }, 51 51 + "valueC": { 52 52 + "type": "boolean" 53 53 + } 54 54 + } 55 55 + } 56 56 + } 57 57 + }

+20

packages/emitter/test/spec/output/meta-types/unknown.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.unknown", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "object", 7 7 + "description": "Unknown type usage", 8 8 + "properties": { 9 9 + "metadata": { 10 10 + "type": "unknown", 11 11 + "description": "Any object data without validation" 12 12 + }, 13 13 + "optionalMetadata": { 14 14 + "type": "unknown", 15 15 + "description": "Optional unknown field" 16 16 + } 17 17 + } 18 18 + } 19 19 + } 20 20 + }

+46

packages/emitter/test/spec/output/primary-types/procedure-simple.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.createRecord", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "procedure", 7 7 + "description": "Create a new record", 8 8 + "input": { 9 9 + "encoding": "application/json", 10 10 + "schema": { 11 11 + "type": "object", 12 12 + "required": ["text"], 13 13 + "properties": { 14 14 + "text": { 15 15 + "type": "string", 16 16 + "description": "The text content" 17 17 + } 18 18 + } 19 19 + } 20 20 + }, 21 21 + "output": { 22 22 + "encoding": "application/json", 23 23 + "schema": { 24 24 + "type": "object", 25 25 + "required": ["uri", "cid"], 26 26 + "properties": { 27 27 + "uri": { 28 28 + "type": "string", 29 29 + "format": "at-uri" 30 30 + }, 31 31 + "cid": { 32 32 + "type": "string", 33 33 + "format": "cid" 34 34 + } 35 35 + } 36 36 + } 37 37 + }, 38 38 + "errors": [ 39 39 + { 40 40 + "name": "InvalidText", 41 41 + "description": "The provided text is invalid" 42 42 + } 43 43 + ] 44 44 + } 45 45 + } 46 46 + }

+33

packages/emitter/test/spec/output/primary-types/query-simple.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.getRecord", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "query", 7 7 + "description": "Retrieve a record by ID", 8 8 + "parameters": { 9 9 + "type": "params", 10 10 + "required": ["id"], 11 11 + "properties": { 12 12 + "id": { 13 13 + "type": "string", 14 14 + "description": "The record identifier" 15 15 + } 16 16 + } 17 17 + }, 18 18 + "output": { 19 19 + "encoding": "application/json", 20 20 + "schema": { 21 21 + "type": "object", 22 22 + "required": ["record"], 23 23 + "properties": { 24 24 + "record": { 25 25 + "type": "ref", 26 26 + "ref": "com.example.record" 27 27 + } 28 28 + } 29 29 + } 30 30 + } 31 31 + } 32 32 + } 33 33 + }

+26

packages/emitter/test/spec/output/primary-types/record-simple.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.record", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "record", 7 7 + "description": "A simple record with basic properties", 8 8 + "key": "tid", 9 9 + "record": { 10 10 + "type": "object", 11 11 + "required": ["text", "createdAt"], 12 12 + "properties": { 13 13 + "text": { 14 14 + "type": "string", 15 15 + "description": "The text content" 16 16 + }, 17 17 + "createdAt": { 18 18 + "type": "string", 19 19 + "format": "datetime", 20 20 + "description": "When the record was created" 21 21 + } 22 22 + } 23 23 + } 24 24 + } 25 25 + } 26 26 + }

+49

packages/emitter/test/spec/output/primary-types/subscription-simple.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.subscribeRecords", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "subscription", 7 7 + "description": "Subscribe to record updates", 8 8 + "parameters": { 9 9 + "type": "params", 10 10 + "properties": { 11 11 + "cursor": { 12 12 + "type": "integer", 13 13 + "description": "Optional cursor for resuming" 14 14 + } 15 15 + } 16 16 + }, 17 17 + "message": { 18 18 + "schema": { 19 19 + "type": "union", 20 20 + "refs": ["#record", "#delete"] 21 21 + } 22 22 + } 23 23 + }, 24 24 + "record": { 25 25 + "type": "object", 26 26 + "required": ["uri", "record"], 27 27 + "properties": { 28 28 + "uri": { 29 29 + "type": "string", 30 30 + "format": "at-uri" 31 31 + }, 32 32 + "record": { 33 33 + "type": "ref", 34 34 + "ref": "com.example.record" 35 35 + } 36 36 + } 37 37 + }, 38 38 + "delete": { 39 39 + "type": "object", 40 40 + "required": ["uri"], 41 41 + "properties": { 42 42 + "uri": { 43 43 + "type": "string", 44 44 + "format": "at-uri" 45 45 + } 46 46 + } 47 47 + } 48 48 + } 49 49 + }

+41

packages/emitter/test/spec/output/special-features/defs-lexicon.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.defs", 4 4 + "description": "Common definitions used by other lexicons", 5 5 + "defs": { 6 6 + "statusEnum": { 7 7 + "type": "string", 8 8 + "enum": ["active", "inactive", "pending", "deleted"] 9 9 + }, 10 10 + "timestamp": { 11 11 + "type": "object", 12 12 + "required": ["createdAt"], 13 13 + "nullable": ["updatedAt"], 14 14 + "properties": { 15 15 + "createdAt": { 16 16 + "type": "string", 17 17 + "format": "datetime" 18 18 + }, 19 19 + "updatedAt": { 20 20 + "type": "string", 21 21 + "format": "datetime" 22 22 + } 23 23 + } 24 24 + }, 25 25 + "metadata": { 26 26 + "type": "object", 27 27 + "properties": { 28 28 + "version": { 29 29 + "type": "integer", 30 30 + "default": 1 31 31 + }, 32 32 + "tags": { 33 33 + "type": "array", 34 34 + "items": { 35 35 + "type": "string" 36 36 + } 37 37 + } 38 38 + } 39 39 + } 40 40 + } 41 41 + }

+49

packages/emitter/test/spec/output/special-features/errors.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.withErrors", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "procedure", 7 7 + "description": "Procedure with error definitions", 8 8 + "input": { 9 9 + "encoding": "application/json", 10 10 + "schema": { 11 11 + "type": "object", 12 12 + "required": ["value"], 13 13 + "properties": { 14 14 + "value": { 15 15 + "type": "integer", 16 16 + "minimum": 1, 17 17 + "maximum": 100 18 18 + } 19 19 + } 20 20 + } 21 21 + }, 22 22 + "output": { 23 23 + "encoding": "application/json", 24 24 + "schema": { 25 25 + "type": "object", 26 26 + "required": ["result"], 27 27 + "properties": { 28 28 + "result": { 29 29 + "type": "string" 30 30 + } 31 31 + } 32 32 + } 33 33 + }, 34 34 + "errors": [ 35 35 + { 36 36 + "name": "InvalidValue", 37 37 + "description": "The provided value is invalid" 38 38 + }, 39 39 + { 40 40 + "name": "RateLimitExceeded", 41 41 + "description": "Too many requests" 42 42 + }, 43 43 + { 44 44 + "name": "Unauthorized" 45 45 + } 46 46 + ] 47 47 + } 48 48 + } 49 49 + }

+46

packages/emitter/test/spec/output/special-features/input-output-ref.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.refInOutput", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "procedure", 7 7 + "description": "Procedure with ref in output schema", 8 8 + "input": { 9 9 + "encoding": "application/json", 10 10 + "schema": { 11 11 + "type": "ref", 12 12 + "ref": "#inputData" 13 13 + } 14 14 + }, 15 15 + "output": { 16 16 + "encoding": "application/json", 17 17 + "schema": { 18 18 + "type": "ref", 19 19 + "ref": "#outputData" 20 20 + } 21 21 + } 22 22 + }, 23 23 + "inputData": { 24 24 + "type": "object", 25 25 + "required": ["value"], 26 26 + "properties": { 27 27 + "value": { 28 28 + "type": "string" 29 29 + } 30 30 + } 31 31 + }, 32 32 + "outputData": { 33 33 + "type": "object", 34 34 + "required": ["result", "timestamp"], 35 35 + "properties": { 36 36 + "result": { 37 37 + "type": "string" 38 38 + }, 39 39 + "timestamp": { 40 40 + "type": "string", 41 41 + "format": "datetime" 42 42 + } 43 43 + } 44 44 + } 45 45 + } 46 46 + }

+30

packages/emitter/test/spec/output/special-features/nullable-fields.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.nullableFields", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "object", 7 7 + "description": "Demonstrates nullable field semantics", 8 8 + "required": ["requiredField"], 9 9 + "nullable": ["nullableRequired", "nullableOptional"], 10 10 + "properties": { 11 11 + "requiredField": { 12 12 + "type": "string", 13 13 + "description": "Required, cannot be null or omitted" 14 14 + }, 15 15 + "nullableRequired": { 16 16 + "type": "string", 17 17 + "description": "Must be present, but can be null" 18 18 + }, 19 19 + "nullableOptional": { 20 20 + "type": "string", 21 21 + "description": "Can be omitted, present with value, or present as null" 22 22 + }, 23 23 + "optionalField": { 24 24 + "type": "string", 25 25 + "description": "Can be omitted or present with value, but not null" 26 26 + } 27 27 + } 28 28 + } 29 29 + } 30 30 + }

+22

packages/emitter/test/spec/output/special-features/output-without-schema.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.outputWithoutSchema", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "query", 7 7 + "description": "Query with JSON output but no schema defined", 8 8 + "parameters": { 9 9 + "type": "params", 10 10 + "properties": { 11 11 + "id": { 12 12 + "type": "string" 13 13 + } 14 14 + } 15 15 + }, 16 16 + "output": { 17 17 + "encoding": "application/json", 18 18 + "description": "Returns JSON data without a defined schema" 19 19 + } 20 20 + } 21 21 + } 22 22 + }

+25

packages/emitter/test/spec/output/special-features/record-key-any.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.flexibleRecord", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "record", 7 7 + "description": "Record with any key type", 8 8 + "key": "any", 9 9 + "record": { 10 10 + "type": "object", 11 11 + "properties": { 12 12 + "data": { 13 13 + "type": "string" 14 14 + }, 15 15 + "tags": { 16 16 + "type": "array", 17 17 + "items": { 18 18 + "type": "string" 19 19 + } 20 20 + } 21 21 + } 22 22 + } 23 23 + } 24 24 + } 25 25 + }

+25

packages/emitter/test/spec/output/special-features/record-key-literal.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.profile", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "record", 7 7 + "description": "Record with literal 'self' key", 8 8 + "key": "literal:self", 9 9 + "record": { 10 10 + "type": "object", 11 11 + "required": ["displayName"], 12 12 + "properties": { 13 13 + "displayName": { 14 14 + "type": "string", 15 15 + "maxGraphemes": 64 16 16 + }, 17 17 + "description": { 18 18 + "type": "string", 19 19 + "maxGraphemes": 256 20 20 + } 21 21 + } 22 22 + } 23 23 + } 24 24 + } 25 25 + }

+24

packages/emitter/test/spec/output/special-features/record-key-tid.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.tidRecord", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "record", 7 7 + "description": "Record with TID key type", 8 8 + "key": "tid", 9 9 + "record": { 10 10 + "type": "object", 11 11 + "required": ["content", "createdAt"], 12 12 + "properties": { 13 13 + "content": { 14 14 + "type": "string" 15 15 + }, 16 16 + "createdAt": { 17 17 + "type": "string", 18 18 + "format": "datetime" 19 19 + } 20 20 + } 21 21 + } 22 22 + } 23 23 + } 24 24 + }

+123

packages/emitter/test/spec/output/special-features/subscription-union-message.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.eventStream", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "subscription", 7 7 + "description": "Subscription with union message schema", 8 8 + "parameters": { 9 9 + "type": "params", 10 10 + "properties": { 11 11 + "cursor": { 12 12 + "type": "integer" 13 13 + } 14 14 + } 15 15 + }, 16 16 + "message": { 17 17 + "description": "Stream of events", 18 18 + "schema": { 19 19 + "type": "union", 20 20 + "refs": ["#commit", "#identity", "#account", "#handle", "#tombstone"] 21 21 + } 22 22 + }, 23 23 + "errors": [ 24 24 + { 25 25 + "name": "FutureCursor", 26 26 + "description": "Cursor is in the future" 27 27 + } 28 28 + ] 29 29 + }, 30 30 + "commit": { 31 31 + "type": "object", 32 32 + "required": ["seq", "time", "repo"], 33 33 + "properties": { 34 34 + "seq": { 35 35 + "type": "integer" 36 36 + }, 37 37 + "time": { 38 38 + "type": "string", 39 39 + "format": "datetime" 40 40 + }, 41 41 + "repo": { 42 42 + "type": "string", 43 43 + "format": "did" 44 44 + } 45 45 + } 46 46 + }, 47 47 + "identity": { 48 48 + "type": "object", 49 49 + "required": ["seq", "time", "did"], 50 50 + "properties": { 51 51 + "seq": { 52 52 + "type": "integer" 53 53 + }, 54 54 + "time": { 55 55 + "type": "string", 56 56 + "format": "datetime" 57 57 + }, 58 58 + "did": { 59 59 + "type": "string", 60 60 + "format": "did" 61 61 + } 62 62 + } 63 63 + }, 64 64 + "account": { 65 65 + "type": "object", 66 66 + "required": ["seq", "time", "did", "active"], 67 67 + "properties": { 68 68 + "seq": { 69 69 + "type": "integer" 70 70 + }, 71 71 + "time": { 72 72 + "type": "string", 73 73 + "format": "datetime" 74 74 + }, 75 75 + "did": { 76 76 + "type": "string", 77 77 + "format": "did" 78 78 + }, 79 79 + "active": { 80 80 + "type": "boolean" 81 81 + } 82 82 + } 83 83 + }, 84 84 + "handle": { 85 85 + "type": "object", 86 86 + "required": ["seq", "time", "did", "handle"], 87 87 + "properties": { 88 88 + "seq": { 89 89 + "type": "integer" 90 90 + }, 91 91 + "time": { 92 92 + "type": "string", 93 93 + "format": "datetime" 94 94 + }, 95 95 + "did": { 96 96 + "type": "string", 97 97 + "format": "did" 98 98 + }, 99 99 + "handle": { 100 100 + "type": "string", 101 101 + "format": "handle" 102 102 + } 103 103 + } 104 104 + }, 105 105 + "tombstone": { 106 106 + "type": "object", 107 107 + "required": ["seq", "time", "did"], 108 108 + "properties": { 109 109 + "seq": { 110 110 + "type": "integer" 111 111 + }, 112 112 + "time": { 113 113 + "type": "string", 114 114 + "format": "datetime" 115 115 + }, 116 116 + "did": { 117 117 + "type": "string", 118 118 + "format": "did" 119 119 + } 120 120 + } 121 121 + } 122 122 + } 123 123 + }

+67

packages/emitter/test/spec/output/string-formats/all-formats.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.stringFormats", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "object", 7 7 + "description": "All string format types", 8 8 + "properties": { 9 9 + "atIdentifier": { 10 10 + "type": "string", 11 11 + "format": "at-identifier", 12 12 + "description": "Handle or DID" 13 13 + }, 14 14 + "atUri": { 15 15 + "type": "string", 16 16 + "format": "at-uri", 17 17 + "description": "AT-URI format" 18 18 + }, 19 19 + "cid": { 20 20 + "type": "string", 21 21 + "format": "cid", 22 22 + "description": "CID in string format" 23 23 + }, 24 24 + "datetime": { 25 25 + "type": "string", 26 26 + "format": "datetime", 27 27 + "description": "ISO 8601 datetime with timezone" 28 28 + }, 29 29 + "did": { 30 30 + "type": "string", 31 31 + "format": "did", 32 32 + "description": "DID identifier" 33 33 + }, 34 34 + "handle": { 35 35 + "type": "string", 36 36 + "format": "handle", 37 37 + "description": "Handle identifier" 38 38 + }, 39 39 + "nsid": { 40 40 + "type": "string", 41 41 + "format": "nsid", 42 42 + "description": "Namespaced identifier" 43 43 + }, 44 44 + "tid": { 45 45 + "type": "string", 46 46 + "format": "tid", 47 47 + "description": "Timestamp identifier" 48 48 + }, 49 49 + "recordKey": { 50 50 + "type": "string", 51 51 + "format": "record-key", 52 52 + "description": "Record key (any syntax)" 53 53 + }, 54 54 + "uri": { 55 55 + "type": "string", 56 56 + "format": "uri", 57 57 + "description": "Generic URI (RFC 3986)" 58 58 + }, 59 59 + "language": { 60 60 + "type": "string", 61 61 + "format": "language", 62 62 + "description": "IETF BCP 47 language tag" 63 63 + } 64 64 + } 65 65 + } 66 66 + } 67 67 + }

+28

packages/emitter/test/spec/output/string-formats/datetime-examples.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.datetimeExamples", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "object", 7 7 + "description": "Datetime format usage examples", 8 8 + "required": ["createdAt"], 9 9 + "properties": { 10 10 + "createdAt": { 11 11 + "type": "string", 12 12 + "format": "datetime", 13 13 + "description": "Required datetime field" 14 14 + }, 15 15 + "updatedAt": { 16 16 + "type": "string", 17 17 + "format": "datetime", 18 18 + "description": "Optional datetime field" 19 19 + }, 20 20 + "publishedAt": { 21 21 + "type": "string", 22 22 + "format": "datetime", 23 23 + "description": "Optional publish time" 24 24 + } 25 25 + } 26 26 + } 27 27 + } 28 28 + }

+37

packages/emitter/test/spec/output/string-formats/identifier-examples.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.identifierExamples", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "object", 7 7 + "description": "Identifier format examples", 8 8 + "properties": { 9 9 + "did": { 10 10 + "type": "string", 11 11 + "format": "did", 12 12 + "description": "DID identifier (did:plc:, did:web:, etc)" 13 13 + }, 14 14 + "handle": { 15 15 + "type": "string", 16 16 + "format": "handle", 17 17 + "description": "Handle identifier (username.bsky.social)" 18 18 + }, 19 19 + "atIdentifier": { 20 20 + "type": "string", 21 21 + "format": "at-identifier", 22 22 + "description": "Either a DID or handle" 23 23 + }, 24 24 + "cidString": { 25 25 + "type": "string", 26 26 + "format": "cid", 27 27 + "description": "CID as string" 28 28 + }, 29 29 + "languageCode": { 30 30 + "type": "string", 31 31 + "format": "language", 32 32 + "description": "BCP 47 language tag" 33 33 + } 34 34 + } 35 35 + } 36 36 + } 37 37 + }

+37

packages/emitter/test/spec/output/string-formats/uri-examples.json

··· 1 1 + { 2 2 + "lexicon": 1, 3 3 + "id": "com.example.uriExamples", 4 4 + "defs": { 5 5 + "main": { 6 6 + "type": "object", 7 7 + "description": "Various URI format examples", 8 8 + "properties": { 9 9 + "atUri": { 10 10 + "type": "string", 11 11 + "format": "at-uri", 12 12 + "description": "AT protocol URI" 13 13 + }, 14 14 + "genericUri": { 15 15 + "type": "string", 16 16 + "format": "uri", 17 17 + "description": "Generic URI (https, did, ipfs, etc)" 18 18 + }, 19 19 + "recordKey": { 20 20 + "type": "string", 21 21 + "format": "record-key", 22 22 + "description": "Record key identifier" 23 23 + }, 24 24 + "nsid": { 25 25 + "type": "string", 26 26 + "format": "nsid", 27 27 + "description": "Namespaced identifier" 28 28 + }, 29 29 + "tid": { 30 30 + "type": "string", 31 31 + "format": "tid", 32 32 + "description": "Timestamp identifier" 33 33 + } 34 34 + } 35 35 + } 36 36 + } 37 37 + }

+92

scripts/validate-lexicons.js

··· 1 1 + #!/usr/bin/env node 2 2 + 3 3 + const fs = require('fs'); 4 4 + const path = require('path'); 5 5 + 6 6 + // Import validation from atproto lexicon package 7 7 + const atprotoPath = path.join(__dirname, '../../atproto/packages/lexicon'); 8 8 + const { Lexicons } = require(path.join(atprotoPath, 'dist/index.js')); 9 9 + 10 10 + function findJsonFiles(dir, fileList = []) { 11 11 + const files = fs.readdirSync(dir); 12 12 + 13 13 + files.forEach(file => { 14 14 + // Skip node_modules, tsp-output, and common non-lexicon directories 15 15 + if (file === 'node_modules' || file === 'tsp-output' || file === 'dist' || file === '.git') { 16 16 + return; 17 17 + } 18 18 + 19 19 + const filePath = path.join(dir, file); 20 20 + const stat = fs.statSync(filePath); 21 21 + 22 22 + if (stat.isDirectory()) { 23 23 + findJsonFiles(filePath, fileList); 24 24 + } else if (file.endsWith('.json') && !file.includes('package') && !file.includes('tsconfig')) { 25 25 + fileList.push(filePath); 26 26 + } 27 27 + }); 28 28 + 29 29 + return fileList; 30 30 + } 31 31 + 32 32 + function validateLexicons() { 33 33 + const packagesDir = path.join(__dirname, '..', 'packages'); 34 34 + const files = findJsonFiles(packagesDir); 35 35 + 36 36 + if (files.length === 0) { 37 37 + console.log('No lexicon files found'); 38 38 + return 0; 39 39 + } 40 40 + 41 41 + let errorCount = 0; 42 42 + let validCount = 0; 43 43 + let skippedCount = 0; 44 44 + const seenIds = new Set(); 45 45 + 46 46 + for (const filePath of files) { 47 47 + const relPath = path.relative(path.join(__dirname, '..'), filePath); 48 48 + 49 49 + try { 50 50 + const content = fs.readFileSync(filePath, 'utf-8'); 51 51 + const json = JSON.parse(content); 52 52 + 53 53 + // Skip non-lexicon JSON files (e.g., package.json, tsconfig.json) 54 54 + if (!json.lexicon || typeof json.lexicon !== 'number') { 55 55 + continue; 56 56 + } 57 57 + 58 58 + // Skip duplicates (same ID already seen) 59 59 + if (json.id && seenIds.has(json.id)) { 60 60 + skippedCount++; 61 61 + continue; 62 62 + } 63 63 + 64 64 + // Validate individually with a fresh Lexicons instance 65 65 + // This avoids duplicate ID errors when validating independent lexicons 66 66 + const lexicons = new Lexicons(); 67 67 + lexicons.add(json); 68 68 + 69 69 + if (json.id) { 70 70 + seenIds.add(json.id); 71 71 + } 72 72 + 73 73 + validCount++; 74 74 + console.log(`✓ ${relPath}`); 75 75 + } catch (error) { 76 76 + errorCount++; 77 77 + console.error(`✗ ${relPath}: ${error.message}`); 78 78 + } 79 79 + } 80 80 + 81 81 + console.log(`\nValidated ${validCount} lexicons: ${validCount} valid, ${errorCount} errors${skippedCount > 0 ? `, ${skippedCount} duplicates skipped` : ''}`); 82 82 + 83 83 + return errorCount > 0 ? 1 : 0; 84 84 + } 85 85 + 86 86 + try { 87 87 + const exitCode = validateLexicons(); 88 88 + process.exit(exitCode); 89 89 + } catch (err) { 90 90 + console.error('Fatal error:', err); 91 91 + process.exit(1); 92 92 + }