patch of [Breaking] Add @default decorator, uninline scalars by default · round #0 · pull #5 · danabra.mov/typelex

+17

packages/emitter/src/decorators.ts

···

       25
        
       const maxBytesKey = Symbol("maxBytes");

     

       26
        
       const minBytesKey = Symbol("minBytes");

     

       27
        
       const externalKey = Symbol("external");

     

       0
        
       
     

       28
        
       

     

       29
        
       /**

     

       30
        
        * @maxBytes decorator for maximum length of bytes type

     
···

       296
        
         return program.stateSet(readOnlyKey).has(target);

     

       297
        
       }

     

       298
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       299
        
       /**

     

       300
        
        * @external decorator for marking a namespace as external

     

       301
        
        * External namespaces are skipped during emission and don't produce JSON files

···

       25
        
       const maxBytesKey = Symbol("maxBytes");

     

       26
        
       const minBytesKey = Symbol("minBytes");

     

       27
        
       const externalKey = Symbol("external");

     

       28
       +
       const defaultKey = Symbol("default");

     

       29
        
       

     

       30
        
       /**

     

       31
        
        * @maxBytes decorator for maximum length of bytes type

     
···

       297
        
         return program.stateSet(readOnlyKey).has(target);

     

       298
        
       }

     

       299
        
       

     

       300
       +
       /**

     

       301
       +
        * @default decorator for setting default values on scalars and unions

     

       302
       +
        * The value can be a literal (string, number, boolean) or a model reference for tokens

     

       303
       +
        */

     

       304
       +
       export function $default(context: DecoratorContext, target: Type, value: any) {

     

       305
       +
         // Just store the raw value - let the emitter handle unwrapping and validation

     

       306
       +
         context.program.stateMap(defaultKey).set(target, value);

     

       307
       +
       }

     

       308
       +
       

     

       309
       +
       export function getDefault(

     

       310
       +
         program: Program,

     

       311
       +
         target: Type,

     

       312
       +
       ): any | undefined {

     

       313
       +
         return program.stateMap(defaultKey).get(target);

     

       314
       +
       }

     

       315
       +
       

     

       316
        
       /**

     

       317
        
        * @external decorator for marking a namespace as external

     

       318
        
        * External namespaces are skipped during emission and don't produce JSON files

packages/emitter/src/tsp-index.ts

···

       15
        
         $maxBytes,

     

       16
        
         $minBytes,

     

       17
        
         $external,

     

       0
        
       
     

       18
        
       } from "./decorators.js";

     

       19
        
       

     

       20
        
       /** @internal */

     
···

       36
        
           maxBytes: $maxBytes,

     

       37
        
           minBytes: $minBytes,

     

       38
        
           external: $external,

     

       0
        
       
     

       39
        
         },

     

       40
        
       };

···

       15
        
         $maxBytes,

     

       16
        
         $minBytes,

     

       17
        
         $external,

     

       18
       +
         $default,

     

       19
        
       } from "./decorators.js";

     

       20
        
       

     

       21
        
       /** @internal */

     
···

       37
        
           maxBytes: $maxBytes,

     

       38
        
           minBytes: $minBytes,

     

       39
        
           external: $external,

     

       40
       +
           default: $default,

     

       41
        
         },

     

       42
        
       };

packages/emitter/test/integration/atproto/input/app/bsky/actor/defs.tsp

···

       232
        
           prioritizeFollowedUsers?: boolean;

     

       233
        
         }

     

       234
        
       

     

       0
        
       
     

       235
        
         @maxLength(640)

     

       236
        
         @maxGraphemes(64)

     

       237
        
         scalar InterestTag extends string;

     
···

       292
        
           @required did: did;

     

       293
        
         }

     

       294
        
       

     

       0
        
       
     

       295
        
         @maxLength(100)

     

       296
        
         scalar NudgeToken extends string;

     

       297

···

       232
        
           prioritizeFollowedUsers?: boolean;

     

       233
        
         }

     

       234
        
       

     

       235
       +
         @inline

     

       236
        
         @maxLength(640)

     

       237
        
         @maxGraphemes(64)

     

       238
        
         scalar InterestTag extends string;

     
···

       293
        
           @required did: did;

     

       294
        
         }

     

       295
        
       

     

       296
       +
         @inline

     

       297
        
         @maxLength(100)

     

       298
        
         scalar NudgeToken extends string;

     

       299

+30

packages/emitter/test/spec/basic/input/com/example/scalarDefaults.tsp

···

       1
       +
       import "@typelex/emitter";

     

       2
       +
       

     

       3
       +
       namespace com.example.scalarDefaults {

     

       4
       +
         /** Test default decorator on scalars */

     

       5
       +
         model Main {

     

       6
       +
           /** Uses string scalar with default */

     

       7
       +
           mode?: Mode;

     

       8
       +
       

     

       9
       +
           /** Uses integer scalar with default */

     

       10
       +
           limit?: Limit;

     

       11
       +
       

     

       12
       +
           /** Uses boolean scalar with default */

     

       13
       +
           enabled?: Enabled;

     

       14
       +
         }

     

       15
       +
       

     

       16
       +
         /** A string type with a default value */

     

       17
       +
         @default("standard")

     

       18
       +
         @maxLength(50)

     

       19
       +
         scalar Mode extends string;

     

       20
       +
       

     

       21
       +
         /** An integer type with a default value */

     

       22
       +
         @default(50)

     

       23
       +
         @minValue(1)

     

       24
       +
         @maxValue(100)

     

       25
       +
         scalar Limit extends integer;

     

       26
       +
       

     

       27
       +
         /** A boolean type with a default value */

     

       28
       +
         @default(true)

     

       29
       +
         scalar Enabled extends boolean;

     

       30
       +
       }

+22

packages/emitter/test/spec/basic/input/com/example/scalarDefs.tsp

···

       1
       +
       import "@typelex/emitter";

     

       2
       +
       

     

       3
       +
       namespace com.example.scalarDefs {

     

       4
       +
         /** Scalar defs should create standalone defs like models and unions */

     

       5
       +
         model Main {

     

       6
       +
           /** Uses a custom string scalar with constraints */

     

       7
       +
           tag?: Tag;

     

       8
       +
       

     

       9
       +
           /** Uses a custom integer scalar with constraints */

     

       10
       +
           count?: Count;

     

       11
       +
         }

     

       12
       +
       

     

       13
       +
         /** A custom string type with length constraints */

     

       14
       +
         @maxLength(100)

     

       15
       +
         @maxGraphemes(50)

     

       16
       +
         scalar Tag extends string;

     

       17
       +
       

     

       18
       +
         /** A custom integer type with value constraints */

     

       19
       +
         @minValue(1)

     

       20
       +
         @maxValue(100)

     

       21
       +
         scalar Count extends integer;

     

       22
       +
       }

+22

packages/emitter/test/spec/basic/input/com/example/scalarInline.tsp

···

       1
       +
       import "@typelex/emitter";

     

       2
       +
       

     

       3
       +
       namespace com.example.scalarInline {

     

       4
       +
         /** Test inline decorator on scalars */

     

       5
       +
         model Main {

     

       6
       +
           /** Inline scalar - should not create a def */

     

       7
       +
           tag?: Tag;

     

       8
       +
       

     

       9
       +
           /** Non-inline scalar - should create a def */

     

       10
       +
           category?: Category;

     

       11
       +
         }

     

       12
       +
       

     

       13
       +
         /** An inline scalar should be inlined at usage sites */

     

       14
       +
         @inline

     

       15
       +
         @maxLength(50)

     

       16
       +
         @maxGraphemes(25)

     

       17
       +
         scalar Tag extends string;

     

       18
       +
       

     

       19
       +
         /** A regular scalar should create a standalone def */

     

       20
       +
         @maxLength(100)

     

       21
       +
         scalar Category extends string;

     

       22
       +
       }

+53

packages/emitter/test/spec/basic/input/com/example/unionDefaults.tsp

···

       1
       +
       import "@typelex/emitter";

     

       2
       +
       

     

       3
       +
       namespace com.example.unionDefaults {

     

       4
       +
         /** Test default decorator on unions */

     

       5
       +
         model Main {

     

       6
       +
           /** Union with token refs and default */

     

       7
       +
           eventMode?: EventMode;

     

       8
       +
       

     

       9
       +
           /** Union with string literals and default */

     

       10
       +
           sortOrder?: SortOrder;

     

       11
       +
       

     

       12
       +
           /** Union with integer literals and default */

     

       13
       +
           priority?: Priority;

     

       14
       +
         }

     

       15
       +
       

     

       16
       +
         /** Union of tokens with default pointing to a token */

     

       17
       +
         @default(Inperson)

     

       18
       +
         union EventMode {

     

       19
       +
           Hybrid,

     

       20
       +
           Inperson,

     

       21
       +
           Virtual,

     

       22
       +
           string,

     

       23
       +
         }

     

       24
       +
       

     

       25
       +
         /** A hybrid event */

     

       26
       +
         @token

     

       27
       +
         model Hybrid {}

     

       28
       +
       

     

       29
       +
         /** An in-person event */

     

       30
       +
         @token

     

       31
       +
         model Inperson {}

     

       32
       +
       

     

       33
       +
         /** A virtual event */

     

       34
       +
         @token

     

       35
       +
         model Virtual {}

     

       36
       +
       

     

       37
       +
         /** Union of string literals with default */

     

       38
       +
         @default("asc")

     

       39
       +
         union SortOrder {

     

       40
       +
           "asc",

     

       41
       +
           "desc",

     

       42
       +
           string,

     

       43
       +
         }

     

       44
       +
       

     

       45
       +
         /** Union of integer literals with default (closed enum) */

     

       46
       +
         @default(1)

     

       47
       +
         @closed

     

       48
       +
         union Priority {

     

       49
       +
           1,

     

       50
       +
           2,

     

       51
       +
           3,

     

       52
       +
         }

     

       53
       +
       }

+45

packages/emitter/test/spec/basic/output/com/example/scalarDefaults.json

···

       1
       +
       {

     

       2
       +
         "lexicon": 1,

     

       3
       +
         "id": "com.example.scalarDefaults",

     

       4
       +
         "defs": {

     

       5
       +
           "main": {

     

       6
       +
             "type": "object",

     

       7
       +
             "properties": {

     

       8
       +
               "mode": {

     

       9
       +
                 "type": "ref",

     

       10
       +
                 "ref": "#mode",

     

       11
       +
                 "description": "Uses string scalar with default"

     

       12
       +
               },

     

       13
       +
               "limit": {

     

       14
       +
                 "type": "ref",

     

       15
       +
                 "ref": "#limit",

     

       16
       +
                 "description": "Uses integer scalar with default"

     

       17
       +
               },

     

       18
       +
               "enabled": {

     

       19
       +
                 "type": "ref",

     

       20
       +
                 "ref": "#enabled",

     

       21
       +
                 "description": "Uses boolean scalar with default"

     

       22
       +
               }

     

       23
       +
             },

     

       24
       +
             "description": "Test default decorator on scalars"

     

       25
       +
           },

     

       26
       +
           "mode": {

     

       27
       +
             "type": "string",

     

       28
       +
             "maxLength": 50,

     

       29
       +
             "default": "standard",

     

       30
       +
             "description": "A string type with a default value"

     

       31
       +
           },

     

       32
       +
           "limit": {

     

       33
       +
             "type": "integer",

     

       34
       +
             "minimum": 1,

     

       35
       +
             "maximum": 100,

     

       36
       +
             "default": 50,

     

       37
       +
             "description": "An integer type with a default value"

     

       38
       +
           },

     

       39
       +
           "enabled": {

     

       40
       +
             "type": "boolean",

     

       41
       +
             "default": true,

     

       42
       +
             "description": "A boolean type with a default value"

     

       43
       +
           }

     

       44
       +
         }

     

       45
       +
       }

+34

packages/emitter/test/spec/basic/output/com/example/scalarDefs.json

···

       1
       +
       {

     

       2
       +
         "lexicon": 1,

     

       3
       +
         "id": "com.example.scalarDefs",

     

       4
       +
         "defs": {

     

       5
       +
           "main": {

     

       6
       +
             "type": "object",

     

       7
       +
             "properties": {

     

       8
       +
               "tag": {

     

       9
       +
                 "type": "ref",

     

       10
       +
                 "ref": "#tag",

     

       11
       +
                 "description": "Uses a custom string scalar with constraints"

     

       12
       +
               },

     

       13
       +
               "count": {

     

       14
       +
                 "type": "ref",

     

       15
       +
                 "ref": "#count",

     

       16
       +
                 "description": "Uses a custom integer scalar with constraints"

     

       17
       +
               }

     

       18
       +
             },

     

       19
       +
             "description": "Scalar defs should create standalone defs like models and unions"

     

       20
       +
           },

     

       21
       +
           "tag": {

     

       22
       +
             "type": "string",

     

       23
       +
             "maxLength": 100,

     

       24
       +
             "maxGraphemes": 50,

     

       25
       +
             "description": "A custom string type with length constraints"

     

       26
       +
           },

     

       27
       +
           "count": {

     

       28
       +
             "type": "integer",

     

       29
       +
             "minimum": 1,

     

       30
       +
             "maximum": 100,

     

       31
       +
             "description": "A custom integer type with value constraints"

     

       32
       +
           }

     

       33
       +
         }

     

       34
       +
       }

+28

packages/emitter/test/spec/basic/output/com/example/scalarInline.json

···

       1
       +
       {

     

       2
       +
         "lexicon": 1,

     

       3
       +
         "id": "com.example.scalarInline",

     

       4
       +
         "defs": {

     

       5
       +
           "main": {

     

       6
       +
             "type": "object",

     

       7
       +
             "properties": {

     

       8
       +
               "tag": {

     

       9
       +
                 "type": "string",

     

       10
       +
                 "maxLength": 50,

     

       11
       +
                 "maxGraphemes": 25,

     

       12
       +
                 "description": "Inline scalar - should not create a def"

     

       13
       +
               },

     

       14
       +
               "category": {

     

       15
       +
                 "type": "ref",

     

       16
       +
                 "ref": "#category",

     

       17
       +
                 "description": "Non-inline scalar - should create a def"

     

       18
       +
               }

     

       19
       +
             },

     

       20
       +
             "description": "Test inline decorator on scalars"

     

       21
       +
           },

     

       22
       +
           "category": {

     

       23
       +
             "type": "string",

     

       24
       +
             "maxLength": 100,

     

       25
       +
             "description": "A regular scalar should create a standalone def"

     

       26
       +
           }

     

       27
       +
         }

     

       28
       +
       }

+61

packages/emitter/test/spec/basic/output/com/example/unionDefaults.json

···

       1
       +
       {

     

       2
       +
         "lexicon": 1,

     

       3
       +
         "id": "com.example.unionDefaults",

     

       4
       +
         "defs": {

     

       5
       +
           "main": {

     

       6
       +
             "type": "object",

     

       7
       +
             "properties": {

     

       8
       +
               "eventMode": {

     

       9
       +
                 "type": "ref",

     

       10
       +
                 "ref": "#eventMode",

     

       11
       +
                 "description": "Union with token refs and default"

     

       12
       +
               },

     

       13
       +
               "sortOrder": {

     

       14
       +
                 "type": "ref",

     

       15
       +
                 "ref": "#sortOrder",

     

       16
       +
                 "description": "Union with string literals and default"

     

       17
       +
               },

     

       18
       +
               "priority": {

     

       19
       +
                 "type": "ref",

     

       20
       +
                 "ref": "#priority",

     

       21
       +
                 "description": "Union with integer literals and default"

     

       22
       +
               }

     

       23
       +
             },

     

       24
       +
             "description": "Test default decorator on unions"

     

       25
       +
           },

     

       26
       +
           "eventMode": {

     

       27
       +
             "type": "string",

     

       28
       +
             "knownValues": [

     

       29
       +
               "com.example.unionDefaults#hybrid",

     

       30
       +
               "com.example.unionDefaults#inperson",

     

       31
       +
               "com.example.unionDefaults#virtual"

     

       32
       +
             ],

     

       33
       +
             "default": "com.example.unionDefaults#inperson",

     

       34
       +
             "description": "Union of tokens with default pointing to a token"

     

       35
       +
           },

     

       36
       +
           "hybrid": {

     

       37
       +
             "type": "token",

     

       38
       +
             "description": "A hybrid event"

     

       39
       +
           },

     

       40
       +
           "inperson": {

     

       41
       +
             "type": "token",

     

       42
       +
             "description": "An in-person event"

     

       43
       +
           },

     

       44
       +
           "virtual": {

     

       45
       +
             "type": "token",

     

       46
       +
             "description": "A virtual event"

     

       47
       +
           },

     

       48
       +
           "sortOrder": {

     

       49
       +
             "type": "string",

     

       50
       +
             "knownValues": ["asc", "desc"],

     

       51
       +
             "default": "asc",

     

       52
       +
             "description": "Union of string literals with default"

     

       53
       +
           },

     

       54
       +
           "priority": {

     

       55
       +
             "type": "integer",

     

       56
       +
             "enum": [1, 2, 3],

     

       57
       +
             "default": 1,

     

       58
       +
             "description": "Union of integer literals with default (closed enum)"

     

       59
       +
           }

     

       60
       +
         }

     

       61
       +
       }

+164 -1

DOCS.md

···

       312
        
       

     

       313
        
       Note that `Caption` won't exist as a separate def—the abstraction is erased in the output.

     

       314
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       315
        
       ## Top-Level Lexicon Types

     

       316
        
       

     

       317
        
       TypeSpec uses `model` for almost everything. Decorators specify what kind of Lexicon type it becomes.

     
···

       905
        
       

     

       906
        
       ## Defaults and Constants

     

       907
        
       

     

       908
       -
       ### Defaults

     

       0
        
       
     

       0
        
       
     

       909
        
       

     

       910
        
       ```typescript

     

       911
        
       import "@typelex/emitter";

     
···

       920
        
       

     

       921
        
       Maps to: `{"default": 1}`, `{"default": "en"}`

     

       922
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       923
        
       ### Constants

     

       924
        
       

     

       925
        
       Use `@readOnly` with a default:

···

       312
        
       

     

       313
        
       Note that `Caption` won't exist as a separate def—the abstraction is erased in the output.

     

       314
        
       

     

       315
       +
       ### Scalars

     

       316
       +
       

     

       317
       +
       TypeSpec scalars let you create named types with constraints. **By default, scalars create standalone defs** (like models):

     

       318
       +
       

     

       319
       +
       ```typescript

     

       320
       +
       import "@typelex/emitter";

     

       321
       +
       

     

       322
       +
       namespace com.example {

     

       323
       +
         model Main {

     

       324
       +
           handle?: Handle;

     

       325
       +
           bio?: Bio;

     

       326
       +
         }

     

       327
       +
       

     

       328
       +
         @maxLength(50)

     

       329
       +
         scalar Handle extends string;

     

       330
       +
       

     

       331
       +
         @maxLength(256)

     

       332
       +
         @maxGraphemes(128)

     

       333
       +
         scalar Bio extends string;

     

       334
       +
       }

     

       335
       +
       ```

     

       336
       +
       

     

       337
       +
       This creates three defs: `main`, `handle`, and `bio`:

     

       338
       +
       

     

       339
       +
       ```json

     

       340
       +
       {

     

       341
       +
         "id": "com.example",

     

       342
       +
         "defs": {

     

       343
       +
           "main": {

     

       344
       +
             "type": "object",

     

       345
       +
             "properties": {

     

       346
       +
               "handle": { "type": "ref", "ref": "#handle" },

     

       347
       +
               "bio": { "type": "ref", "ref": "#bio" }

     

       348
       +
             }

     

       349
       +
           },

     

       350
       +
           "handle": {

     

       351
       +
             "type": "string",

     

       352
       +
             "maxLength": 50

     

       353
       +
           },

     

       354
       +
           "bio": {

     

       355
       +
             "type": "string",

     

       356
       +
             "maxLength": 256,

     

       357
       +
             "maxGraphemes": 128

     

       358
       +
           }

     

       359
       +
         }

     

       360
       +
       }

     

       361
       +
       ```

     

       362
       +
       

     

       363
       +
       Use `@inline` to expand a scalar inline instead:

     

       364
       +
       

     

       365
       +
       ```typescript

     

       366
       +
       import "@typelex/emitter";

     

       367
       +
       

     

       368
       +
       namespace com.example {

     

       369
       +
         model Main {

     

       370
       +
           handle?: Handle;

     

       371
       +
         }

     

       372
       +
       

     

       373
       +
         @inline

     

       374
       +
         @maxLength(50)

     

       375
       +
         scalar Handle extends string;

     

       376
       +
       }

     

       377
       +
       ```

     

       378
       +
       

     

       379
       +
       Now `Handle` is expanded inline (no separate def):

     

       380
       +
       

     

       381
       +
       ```json

     

       382
       +
       // ...

     

       383
       +
       "properties": {

     

       384
       +
         "handle": { "type": "string", "maxLength": 50 }

     

       385
       +
       }

     

       386
       +
       // ...

     

       387
       +
       ```

     

       388
       +
       

     

       389
        
       ## Top-Level Lexicon Types

     

       390
        
       

     

       391
        
       TypeSpec uses `model` for almost everything. Decorators specify what kind of Lexicon type it becomes.

     
···

       979
        
       

     

       980
        
       ## Defaults and Constants

     

       981
        
       

     

       982
       +
       ### Property Defaults

     

       983
       +
       

     

       984
       +
       You can set default values on properties:

     

       985
        
       

     

       986
        
       ```typescript

     

       987
        
       import "@typelex/emitter";

     
···

       996
        
       

     

       997
        
       Maps to: `{"default": 1}`, `{"default": "en"}`

     

       998
        
       

     

       999
       +
       ### Type Defaults

     

       1000
       +
       

     

       1001
       +
       You can also set defaults on scalar and union types using the `@default` decorator:

     

       1002
       +
       

     

       1003
       +
       ```typescript

     

       1004
       +
       import "@typelex/emitter";

     

       1005
       +
       

     

       1006
       +
       namespace com.example {

     

       1007
       +
         model Main {

     

       1008
       +
           mode?: Mode;

     

       1009
       +
           priority?: Priority;

     

       1010
       +
         }

     

       1011
       +
       

     

       1012
       +
         @default("standard")

     

       1013
       +
         scalar Mode extends string;

     

       1014
       +
       

     

       1015
       +
         @default(1)

     

       1016
       +
         @closed

     

       1017
       +
         @inline

     

       1018
       +
         union Priority { 1, 2, 3 }

     

       1019
       +
       }

     

       1020
       +
       ```

     

       1021
       +
       

     

       1022
       +
       This creates a default on the type definition itself:

     

       1023
       +
       

     

       1024
       +
       ```json

     

       1025
       +
       {

     

       1026
       +
         "defs": {

     

       1027
       +
           "mode": {

     

       1028
       +
             "type": "string",

     

       1029
       +
             "default": "standard"

     

       1030
       +
           }

     

       1031
       +
         }

     

       1032
       +
       }

     

       1033
       +
       ```

     

       1034
       +
       

     

       1035
       +
       For unions with token references, pass the model directly:

     

       1036
       +
       

     

       1037
       +
       ```typescript

     

       1038
       +
       import "@typelex/emitter";

     

       1039
       +
       

     

       1040
       +
       namespace com.example {

     

       1041
       +
         model Main {

     

       1042
       +
           eventType?: EventType;

     

       1043
       +
         }

     

       1044
       +
       

     

       1045
       +
         @default(InPerson)

     

       1046
       +
         union EventType { Hybrid, InPerson, Virtual, string }

     

       1047
       +
       

     

       1048
       +
         @token model Hybrid {}

     

       1049
       +
         @token model InPerson {}

     

       1050
       +
         @token model Virtual {}

     

       1051
       +
       }

     

       1052
       +
       ```

     

       1053
       +
       

     

       1054
       +
       This resolves to the fully-qualified token NSID:

     

       1055
       +
       

     

       1056
       +
       ```json

     

       1057
       +
       {

     

       1058
       +
         "eventType": {

     

       1059
       +
           "type": "string",

     

       1060
       +
           "knownValues": [

     

       1061
       +
             "com.example#hybrid",

     

       1062
       +
             "com.example#inPerson",

     

       1063
       +
             "com.example#virtual"

     

       1064
       +
           ],

     

       1065
       +
           "default": "com.example#inPerson"

     

       1066
       +
         }

     

       1067
       +
       }

     

       1068
       +
       ```

     

       1069
       +
       

     

       1070
       +
       **Important:** When a scalar or union creates a standalone def (not `@inline`), property-level defaults must match the type's `@default`. Otherwise you'll get an error:

     

       1071
       +
       

     

       1072
       +
       ```typescript

     

       1073
       +
       @default("standard")

     

       1074
       +
       scalar Mode extends string;

     

       1075
       +
       

     

       1076
       +
       model Main {

     

       1077
       +
         mode?: Mode = "custom";  // ERROR: Conflicting defaults!

     

       1078
       +
       }

     

       1079
       +
       ```

     

       1080
       +
       

     

       1081
       +
       Solutions:

     

       1082
       +
       1. Make the defaults match: `mode?: Mode = "standard"`

     

       1083
       +
       2. Mark the type `@inline`: Allows property-level defaults

     

       1084
       +
       3. Remove the property default: Uses the type's default

     

       1085
       +
       

     

       1086
        
       ### Constants

     

       1087
        
       

     

       1088
        
       Use `@readOnly` with a default:

+125

packages/emitter/test/integration/lexicon-examples/input/community/lexicon/calendar/event.tsp

···

       1
       +
       import "@typelex/emitter";

     

       2
       +
       

     

       3
       +
       namespace community.lexicon.calendar.event {

     

       4
       +
         /** A calendar event. */

     

       5
       +
         @rec("tid")

     

       6
       +
         model Main {

     

       7
       +
           /** The name of the event. */

     

       8
       +
           @required

     

       9
       +
           name: string;

     

       10
       +
       

     

       11
       +
           /** The description of the event. */

     

       12
       +
           description?: string;

     

       13
       +
       

     

       14
       +
           /** Client-declared timestamp when the event was created. */

     

       15
       +
           @required

     

       16
       +
           createdAt: datetime;

     

       17
       +
       

     

       18
       +
           /** Client-declared timestamp when the event starts. */

     

       19
       +
           startsAt?: datetime;

     

       20
       +
       

     

       21
       +
           /** Client-declared timestamp when the event ends. */

     

       22
       +
           endsAt?: datetime;

     

       23
       +
       

     

       24
       +
           /** The attendance mode of the event. */

     

       25
       +
           mode?: Mode;

     

       26
       +
       

     

       27
       +
           /** The status of the event. */

     

       28
       +
           status?: Status;

     

       29
       +
       

     

       30
       +
           /** The locations where the event takes place. */

     

       31
       +
           locations?: (

     

       32
       +
             | Uri

     

       33
       +
             | community.lexicon.location.address.Main

     

       34
       +
             | community.lexicon.location.fsq.Main

     

       35
       +
             | community.lexicon.location.geo.Main

     

       36
       +
             | community.lexicon.location.hthree.Main

     

       37
       +
           )[];

     

       38
       +
       

     

       39
       +
           /** URIs associated with the event. */

     

       40
       +
           uris?: Uri[];

     

       41
       +
         }

     

       42
       +
       

     

       43
       +
         /** The mode of the event. */

     

       44
       +
         @default(Inperson)

     

       45
       +
         union Mode {

     

       46
       +
           Hybrid,

     

       47
       +
           Inperson,

     

       48
       +
           Virtual,

     

       49
       +
           string,

     

       50
       +
         }

     

       51
       +
       

     

       52
       +
         /** A virtual event that takes place online. */

     

       53
       +
         @token

     

       54
       +
         model Virtual {}

     

       55
       +
       

     

       56
       +
         /** An in-person event that takes place offline. */

     

       57
       +
         @token

     

       58
       +
         model Inperson {}

     

       59
       +
       

     

       60
       +
         /** A hybrid event that takes place both online and offline. */

     

       61
       +
         @token

     

       62
       +
         model Hybrid {}

     

       63
       +
       

     

       64
       +
         /** The status of the event. */

     

       65
       +
         @default(Scheduled)

     

       66
       +
         union Status {

     

       67
       +
           Cancelled,

     

       68
       +
           Planned,

     

       69
       +
           Postponed,

     

       70
       +
           Rescheduled,

     

       71
       +
           Scheduled,

     

       72
       +
           string,

     

       73
       +
         }

     

       74
       +
       

     

       75
       +
         /** The event has been created, but not finalized. */

     

       76
       +
         @token

     

       77
       +
         model Planned {}

     

       78
       +
       

     

       79
       +
         /** The event has been created and scheduled. */

     

       80
       +
         @token

     

       81
       +
         model Scheduled {}

     

       82
       +
       

     

       83
       +
         /** The event has been rescheduled. */

     

       84
       +
         @token

     

       85
       +
         model Rescheduled {}

     

       86
       +
       

     

       87
       +
         /** The event has been cancelled. */

     

       88
       +
         @token

     

       89
       +
         model Cancelled {}

     

       90
       +
       

     

       91
       +
         /** The event has been postponed and a new start date has not been set. */

     

       92
       +
         @token

     

       93
       +
         model Postponed {}

     

       94
       +
       

     

       95
       +
         /** A URI associated with the event. */

     

       96
       +
         model Uri {

     

       97
       +
           @required

     

       98
       +
           uri: uri;

     

       99
       +
       

     

       100
       +
           /** The display name of the URI. */

     

       101
       +
           name?: string;

     

       102
       +
         }

     

       103
       +
       }

     

       104
       +
       

     

       105
       +
       // --- Externals ---

     

       106
       +
       

     

       107
       +
       @external

     

       108
       +
       namespace community.lexicon.location.address {

     

       109
       +
         model Main {}

     

       110
       +
       }

     

       111
       +
       

     

       112
       +
       @external

     

       113
       +
       namespace community.lexicon.location.fsq {

     

       114
       +
         model Main {}

     

       115
       +
       }

     

       116
       +
       

     

       117
       +
       @external

     

       118
       +
       namespace community.lexicon.location.geo {

     

       119
       +
         model Main {}

     

       120
       +
       }

     

       121
       +
       

     

       122
       +
       @external

     

       123
       +
       namespace community.lexicon.location.hthree {

     

       124
       +
         model Main {}

     

       125
       +
       }

+41

packages/emitter/test/integration/lexicon-examples/input/community/lexicon/calendar/rsvp.tsp

···

       1
       +
       import "@typelex/emitter";

     

       2
       +
       

     

       3
       +
       namespace community.lexicon.calendar.rsvp {

     

       4
       +
         /** An RSVP for an event. */

     

       5
       +
         @rec("tid")

     

       6
       +
         model Main {

     

       7
       +
           @required

     

       8
       +
           subject: `com`.atproto.repo.strongRef.Main;

     

       9
       +
       

     

       10
       +
           @required

     

       11
       +
           status: Status;

     

       12
       +
         }

     

       13
       +
       

     

       14
       +
         @inline

     

       15
       +
         @default(Going)

     

       16
       +
         union Status {

     

       17
       +
           Interested,

     

       18
       +
           Going,

     

       19
       +
           Notgoing,

     

       20
       +
           string,

     

       21
       +
         }

     

       22
       +
       

     

       23
       +
         /** Interested in the event */

     

       24
       +
         @token

     

       25
       +
         model Interested {}

     

       26
       +
       

     

       27
       +
         /** Going to the event */

     

       28
       +
         @token

     

       29
       +
         model Going {}

     

       30
       +
       

     

       31
       +
         /** Not going to the event */

     

       32
       +
         @token

     

       33
       +
         model Notgoing {}

     

       34
       +
       }

     

       35
       +
       

     

       36
       +
       // --- Externals ---

     

       37
       +
       

     

       38
       +
       @external

     

       39
       +
       namespace `com`.atproto.repo.strongRef {

     

       40
       +
         model Main {}

     

       41
       +
       }

+119 -1

packages/emitter/test/integration/lexicon-examples/output/community/lexicon/calendar/event.json

···

       2
        
           "lexicon": 1,

     

       3
        
           "id": "community.lexicon.calendar.event",

     

       4
        
           "defs": {

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       5
        
               "mode": {

     

       6
        
                   "type": "string",

     

       7
        
                   "description": "The mode of the event.",

     
···

       23
        
               "hybrid": {

     

       24
        
                   "type": "token",

     

       25
        
                   "description": "A hybrid event that takes place both online and offline."

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       26
        
               }

     

       27
        
           }

     

       28
       -
       }

···

       2
        
           "lexicon": 1,

     

       3
        
           "id": "community.lexicon.calendar.event",

     

       4
        
           "defs": {

     

       5
       +
               "main": {

     

       6
       +
                   "type": "record",

     

       7
       +
                   "description": "A calendar event.",

     

       8
       +
                   "key": "tid",

     

       9
       +
                   "record": {

     

       10
       +
                       "type": "object",

     

       11
       +
                       "required": [

     

       12
       +
                           "name",

     

       13
       +
                           "createdAt"

     

       14
       +
                       ],

     

       15
       +
                       "properties": {

     

       16
       +
                           "name": {

     

       17
       +
                               "type": "string",

     

       18
       +
                               "description": "The name of the event."

     

       19
       +
                           },

     

       20
       +
                           "description": {

     

       21
       +
                               "type": "string",

     

       22
       +
                               "description": "The description of the event."

     

       23
       +
                           },

     

       24
       +
                           "createdAt": {

     

       25
       +
                               "type": "string",

     

       26
       +
                               "format": "datetime",

     

       27
       +
                               "description": "Client-declared timestamp when the event was created."

     

       28
       +
                           },

     

       29
       +
                           "startsAt": {

     

       30
       +
                               "type": "string",

     

       31
       +
                               "format": "datetime",

     

       32
       +
                               "description": "Client-declared timestamp when the event starts."

     

       33
       +
                           },

     

       34
       +
                           "endsAt": {

     

       35
       +
                               "type": "string",

     

       36
       +
                               "format": "datetime",

     

       37
       +
                               "description": "Client-declared timestamp when the event ends."

     

       38
       +
                           },

     

       39
       +
                           "mode": {

     

       40
       +
                               "type": "ref",

     

       41
       +
                               "ref": "#mode",

     

       42
       +
                               "description": "The attendance mode of the event."

     

       43
       +
                           },

     

       44
       +
                           "status": {

     

       45
       +
                               "type": "ref",

     

       46
       +
                               "ref": "#status",

     

       47
       +
                               "description": "The status of the event."

     

       48
       +
                           },

     

       49
       +
                           "locations": {

     

       50
       +
                               "type": "array",

     

       51
       +
                               "description": "The locations where the event takes place.",

     

       52
       +
                               "items": {

     

       53
       +
                                   "type": "union",

     

       54
       +
                                   "refs": [

     

       55
       +
                                       "#uri",

     

       56
       +
                                       "community.lexicon.location.address",

     

       57
       +
                                       "community.lexicon.location.fsq",

     

       58
       +
                                       "community.lexicon.location.geo",

     

       59
       +
                                       "community.lexicon.location.hthree"

     

       60
       +
                                   ]

     

       61
       +
                               }

     

       62
       +
                           },

     

       63
       +
                           "uris": {

     

       64
       +
                               "type": "array",

     

       65
       +
                               "description": "URIs associated with the event.",

     

       66
       +
                               "items": {

     

       67
       +
                                   "type": "ref",

     

       68
       +
                                   "ref": "#uri"

     

       69
       +
                               }

     

       70
       +
                           }

     

       71
       +
                       }

     

       72
       +
                   }

     

       73
       +
               },

     

       74
        
               "mode": {

     

       75
        
                   "type": "string",

     

       76
        
                   "description": "The mode of the event.",

     
···

       92
        
               "hybrid": {

     

       93
        
                   "type": "token",

     

       94
        
                   "description": "A hybrid event that takes place both online and offline."

     

       95
       +
               },

     

       96
       +
               "status": {

     

       97
       +
                   "type": "string",

     

       98
       +
                   "description": "The status of the event.",

     

       99
       +
                   "default": "community.lexicon.calendar.event#scheduled",

     

       100
       +
                   "knownValues": [

     

       101
       +
                       "community.lexicon.calendar.event#cancelled",

     

       102
       +
                       "community.lexicon.calendar.event#planned",

     

       103
       +
                       "community.lexicon.calendar.event#postponed",

     

       104
       +
                       "community.lexicon.calendar.event#rescheduled",

     

       105
       +
                       "community.lexicon.calendar.event#scheduled"

     

       106
       +
                   ]

     

       107
       +
               },

     

       108
       +
               "planned": {

     

       109
       +
                   "type": "token",

     

       110
       +
                   "description": "The event has been created, but not finalized."

     

       111
       +
               },

     

       112
       +
               "scheduled": {

     

       113
       +
                   "type": "token",

     

       114
       +
                   "description": "The event has been created and scheduled."

     

       115
       +
               },

     

       116
       +
               "rescheduled": {

     

       117
       +
                   "type": "token",

     

       118
       +
                   "description": "The event has been rescheduled."

     

       119
       +
               },

     

       120
       +
               "cancelled": {

     

       121
       +
                   "type": "token",

     

       122
       +
                   "description": "The event has been cancelled."

     

       123
       +
               },

     

       124
       +
               "postponed": {

     

       125
       +
                   "type": "token",

     

       126
       +
                   "description": "The event has been postponed and a new start date has not been set."

     

       127
       +
               },

     

       128
       +
               "uri": {

     

       129
       +
                   "type": "object",

     

       130
       +
                   "description": "A URI associated with the event.",

     

       131
       +
                   "required": [

     

       132
       +
                       "uri"

     

       133
       +
                   ],

     

       134
       +
                   "properties": {

     

       135
       +
                       "uri": {

     

       136
       +
                           "type": "string",

     

       137
       +
                           "format": "uri"

     

       138
       +
                       },

     

       139
       +
                       "name": {

     

       140
       +
                           "type": "string",

     

       141
       +
                           "description": "The display name of the URI."

     

       142
       +
                       }

     

       143
       +
                   }

     

       144
        
               }

     

       145
        
           }

     

       146
       +
       }

+1 -1

packages/emitter/test/integration/lexicon-examples/output/community/lexicon/calendar/rsvp.json

···

       42
        
                   "description": "Not going to the event"

     

       43
        
               }

     

       44
        
           }

     

       45
       -
       }

···

       42
        
                   "description": "Not going to the event"

     

       43
        
               }

     

       44
        
           }

     

       45
       +
       }