├── .github ├── PULL_REQUEST_TEMPLATE │ └── lexicon.md └── workflows │ └── lex-cli.yml ├── LICENSE ├── README.md └── community └── lexicon ├── bookmarks ├── bookmark.json └── getActorBookmarks.json ├── calendar ├── event.json └── rsvp.json ├── interaction ├── README.md └── like.json └── location ├── address.json ├── fsq.json ├── geo.json └── hthree.json /.github/PULL_REQUEST_TEMPLATE/lexicon.md: -------------------------------------------------------------------------------- 1 | Provide an overview of the lexicon change here. 2 | 3 | # License and Assignment 4 | 5 | - [ ] I assign all rights of this contribution to Lexicon Community as an open source contribution under the MIT license. 6 | -------------------------------------------------------------------------------- /.github/workflows/lex-cli.yml: -------------------------------------------------------------------------------- 1 | name: Run lex-cli 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | pull_request: 8 | 9 | jobs: 10 | run-lex-cli: 11 | runs-on: ubuntu-latest 12 | 13 | steps: 14 | - name: Checkout repository 15 | uses: actions/checkout@v4 16 | 17 | - name: Setup Node.js 18 | uses: actions/setup-node@v4 19 | with: 20 | node-version: 22 21 | 22 | - name: Install lex-cli 23 | run: npm install -g @atproto/lex-cli 24 | 25 | - name: Generate API from lexicon schemas 26 | run: | 27 | lex gen-api --yes tmp ./community/lexicon/*/*.json > >(tee -a lex-gen-api-stdout.txt) 2> >(tee -a lex-gen-api-stderr.txt >&2) 28 | if [ -s "lex-gen-api-stderr.txt" ]; then 29 | exit 1 30 | fi -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2024 Lexicon Community 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # About 2 | 3 | This repository houses the `community.lexicon.*` NSID as part of the larger [ATProtocol](https://atproto.com/) lexicon ecosystem. 4 | 5 | # Governance 6 | 7 | See [lexicon-community/governance](https://github.com/lexicon-community/governance) 8 | -------------------------------------------------------------------------------- /community/lexicon/bookmarks/bookmark.json: -------------------------------------------------------------------------------- 1 | { 2 | "lexicon": 1, 3 | "id": "community.lexicon.bookmarks.bookmark", 4 | "defs": { 5 | "main": { 6 | "type": "record", 7 | "description": "Record bookmarking a link to come back to later.", 8 | "key": "tid", 9 | "record": { 10 | "type": "object", 11 | "required": [ 12 | "subject", 13 | "createdAt" 14 | ], 15 | "properties": { 16 | "subject": { 17 | "type": "string", 18 | "format": "uri" 19 | }, 20 | "createdAt": { 21 | "type": "string", 22 | "format": "datetime" 23 | }, 24 | "tags": { 25 | "type": "array", 26 | "description": "Tags for content the bookmark may be related to, for example 'news' or 'funny videos'", 27 | "items": { 28 | "type": "string" 29 | } 30 | } 31 | } 32 | } 33 | } 34 | } 35 | } -------------------------------------------------------------------------------- /community/lexicon/bookmarks/getActorBookmarks.json: -------------------------------------------------------------------------------- 1 | { 2 | "lexicon": 1, 3 | "id": "community.lexicon.bookmarks.getActorBookmarks", 4 | "defs": { 5 | "main": { 6 | "type": "query", 7 | "description": "Get a list of bookmarks by actor. Optionally add a list of tags to include, default will be all bookmarks. Requires auth, actor must be the requesting account.", 8 | "parameters": { 9 | "type": "params", 10 | "properties": { 11 | "tags": { 12 | "type": "array", 13 | "items": { 14 | "type": "string" 15 | } 16 | }, 17 | "limit": { 18 | "type": "integer", 19 | "minimum": 1, 20 | "maximum": 100, 21 | "default": 50 22 | }, 23 | "cursor": { 24 | "type": "string" 25 | } 26 | } 27 | }, 28 | "output": { 29 | "encoding": "application/json", 30 | "schema": { 31 | "type": "object", 32 | "required": [ 33 | "bookmarks" 34 | ], 35 | "properties": { 36 | "cursor": { 37 | "type": "string" 38 | }, 39 | "bookmarks": { 40 | "type": "array", 41 | "items": { 42 | "type": "ref", 43 | "ref": "community.lexicon.bookmarks.bookmark" 44 | } 45 | } 46 | } 47 | } 48 | } 49 | } 50 | } 51 | } -------------------------------------------------------------------------------- /community/lexicon/calendar/event.json: -------------------------------------------------------------------------------- 1 | { 2 | "lexicon": 1, 3 | "id": "community.lexicon.calendar.event", 4 | "defs": { 5 | "main": { 6 | "type": "record", 7 | "description": "A calendar event.", 8 | "key": "tid", 9 | "record": { 10 | "type": "object", 11 | "required": [ 12 | "createdAt", 13 | "name" 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": "community.lexicon.calendar.event#mode", 42 | "description": "The attendance mode of the event." 43 | }, 44 | "status": { 45 | "type": "ref", 46 | "ref": "community.lexicon.calendar.event#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 | "community.lexicon.calendar.event#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": "community.lexicon.calendar.event#uri" 69 | } 70 | } 71 | } 72 | } 73 | }, 74 | "mode": { 75 | "type": "string", 76 | "description": "The mode of the event.", 77 | "default": "community.lexicon.calendar.event#inperson", 78 | "knownValues": [ 79 | "community.lexicon.calendar.event#hybrid", 80 | "community.lexicon.calendar.event#inperson", 81 | "community.lexicon.calendar.event#virtual" 82 | ] 83 | }, 84 | "virtual": { 85 | "type": "token", 86 | "description": "A virtual event that takes place online." 87 | }, 88 | "inperson": { 89 | "type": "token", 90 | "description": "An in-person event that takes place offline." 91 | }, 92 | "hybrid": { 93 | "type": "token", 94 | "description": "A hybrid event that takes place both online and offline." 95 | }, 96 | "status": { 97 | "type": "string", 98 | "description": "The status of the event.", 99 | "default": "community.lexicon.calendar.event#scheduled", 100 | "knownValues": [ 101 | "community.lexicon.calendar.event#cancelled", 102 | "community.lexicon.calendar.event#planned", 103 | "community.lexicon.calendar.event#postponed", 104 | "community.lexicon.calendar.event#rescheduled", 105 | "community.lexicon.calendar.event#scheduled" 106 | ] 107 | }, 108 | "planned": { 109 | "type": "token", 110 | "description": "The event has been created, but not finalized." 111 | }, 112 | "scheduled": { 113 | "type": "token", 114 | "description": "The event has been created and scheduled." 115 | }, 116 | "rescheduled": { 117 | "type": "token", 118 | "description": "The event has been rescheduled." 119 | }, 120 | "cancelled": { 121 | "type": "token", 122 | "description": "The event has been cancelled." 123 | }, 124 | "postponed": { 125 | "type": "token", 126 | "description": "The event has been postponed and a new start date has not been set." 127 | }, 128 | "uri": { 129 | "type": "object", 130 | "description": "A URI associated with the event.", 131 | "required": [ 132 | "uri" 133 | ], 134 | "properties": { 135 | "uri": { 136 | "type": "string", 137 | "format": "uri" 138 | }, 139 | "name": { 140 | "type": "string", 141 | "description": "The display name of the URI." 142 | } 143 | } 144 | } 145 | } 146 | } -------------------------------------------------------------------------------- /community/lexicon/calendar/rsvp.json: -------------------------------------------------------------------------------- 1 | { 2 | "lexicon": 1, 3 | "id": "community.lexicon.calendar.rsvp", 4 | "defs": { 5 | "main": { 6 | "type": "record", 7 | "description": "An RSVP for an event.", 8 | "key": "tid", 9 | "record": { 10 | "type": "object", 11 | "required": [ 12 | "subject", 13 | "status" 14 | ], 15 | "properties": { 16 | "subject": { 17 | "type": "ref", 18 | "ref": "com.atproto.repo.strongRef" 19 | }, 20 | "status": { 21 | "type": "string", 22 | "default": "community.lexicon.calendar.rsvp#going", 23 | "knownValues": [ 24 | "community.lexicon.calendar.rsvp#interested", 25 | "community.lexicon.calendar.rsvp#going", 26 | "community.lexicon.calendar.rsvp#notgoing" 27 | ] 28 | } 29 | } 30 | } 31 | }, 32 | "interested": { 33 | "type": "token", 34 | "description": "Interested in the event" 35 | }, 36 | "going": { 37 | "type": "token", 38 | "description": "Going to the event" 39 | }, 40 | "notgoing": { 41 | "type": "token", 42 | "description": "Not going to the event" 43 | } 44 | } 45 | } -------------------------------------------------------------------------------- /community/lexicon/interaction/README.md: -------------------------------------------------------------------------------- 1 | # community.lexicon.interaction 2 | 3 | The `community.lexicon.interaction` namespaced identifiers contain high level interactions that occur between identities and other records. 4 | -------------------------------------------------------------------------------- /community/lexicon/interaction/like.json: -------------------------------------------------------------------------------- 1 | { 2 | "lexicon": 1, 3 | "id": "community.lexicon.interaction.like", 4 | "defs": { 5 | "main": { 6 | "type": "record", 7 | "description": "A 'like' interaction with another AT Protocol record.", 8 | "key": "tid", 9 | "record": { 10 | "type": "object", 11 | "required": [ 12 | "subject", 13 | "createdAt" 14 | ], 15 | "properties": { 16 | "subject": { 17 | "type": "ref", 18 | "ref": "com.atproto.repo.strongRef" 19 | }, 20 | "createdAt": { 21 | "type": "string", 22 | "format": "datetime" 23 | } 24 | } 25 | } 26 | } 27 | } 28 | } -------------------------------------------------------------------------------- /community/lexicon/location/address.json: -------------------------------------------------------------------------------- 1 | { 2 | "lexicon": 1, 3 | "id": "community.lexicon.location.address", 4 | "defs": { 5 | "main": { 6 | "type": "object", 7 | "description": "A physical location in the form of a street address.", 8 | "required": [ 9 | "country" 10 | ], 11 | "properties": { 12 | "country": { 13 | "type": "string", 14 | "description": "The ISO 3166 country code. Preferably the 2-letter code.", 15 | "minLength": 2, 16 | "maxLength": 10 17 | }, 18 | "postalCode": { 19 | "type": "string", 20 | "description": "The postal code of the location." 21 | }, 22 | "region": { 23 | "type": "string", 24 | "description": "The administrative region of the country. For example, a state in the USA." 25 | }, 26 | "locality": { 27 | "type": "string", 28 | "description": "The locality of the region. For example, a city in the USA." 29 | }, 30 | "street": { 31 | "type": "string", 32 | "description": "The street address." 33 | }, 34 | "name": { 35 | "type": "string", 36 | "description": "The name of the location." 37 | } 38 | } 39 | } 40 | } 41 | } -------------------------------------------------------------------------------- /community/lexicon/location/fsq.json: -------------------------------------------------------------------------------- 1 | { 2 | "lexicon": 1, 3 | "id": "community.lexicon.location.fsq", 4 | "defs": { 5 | "main": { 6 | "type": "object", 7 | "description": "A physical location contained in the Foursquare Open Source Places dataset.", 8 | "required": [ 9 | "fsq_place_id" 10 | ], 11 | "properties": { 12 | "fsq_place_id": { 13 | "type": "string", 14 | "description": "The unique identifier of a Foursquare POI." 15 | }, 16 | "latitude": { 17 | "type": "string" 18 | }, 19 | "longitude": { 20 | "type": "string" 21 | }, 22 | "name": { 23 | "type": "string", 24 | "description": "The name of the location." 25 | } 26 | } 27 | } 28 | } 29 | } -------------------------------------------------------------------------------- /community/lexicon/location/geo.json: -------------------------------------------------------------------------------- 1 | { 2 | "lexicon": 1, 3 | "id": "community.lexicon.location.geo", 4 | "defs": { 5 | "main": { 6 | "type": "object", 7 | "description": "A physical location in the form of a WGS84 coordinate.", 8 | "required": [ 9 | "latitude", 10 | "longitude" 11 | ], 12 | "properties": { 13 | "latitude": { 14 | "type": "string" 15 | }, 16 | "longitude": { 17 | "type": "string" 18 | }, 19 | "altitude": { 20 | "type": "string" 21 | }, 22 | "name": { 23 | "type": "string", 24 | "description": "The name of the location." 25 | } 26 | } 27 | } 28 | } 29 | } -------------------------------------------------------------------------------- /community/lexicon/location/hthree.json: -------------------------------------------------------------------------------- 1 | { 2 | "lexicon": 1, 3 | "id": "community.lexicon.location.hthree", 4 | "defs": { 5 | "main": { 6 | "type": "object", 7 | "description": "A physical location in the form of a H3 encoded location.", 8 | "required": [ 9 | "value" 10 | ], 11 | "properties": { 12 | "value": { 13 | "type": "string", 14 | "description": "The h3 encoded location." 15 | }, 16 | "name": { 17 | "type": "string", 18 | "description": "The name of the location." 19 | } 20 | } 21 | } 22 | } 23 | } --------------------------------------------------------------------------------