@lexd/stdlib-atproto 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Harvey Randall
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@lexd/stdlib-atproto",
+  "version": "0.1.0",
+  "description": "Curated com.atproto.* Lexicon DSL sources for lexd",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/harveyrandall/lexd.git",
+    "directory": "packages/stdlib-atproto"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "lexd": "src",
+  "files": [
+    "src"
+  ],
+  "exports": {
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "build": "node -e \"process.exit(0)\""
+  }
+}

package/src/com.atproto.label.defs.lexd

@@ -0,0 +1,45 @@
+namespace com.atproto.label.defs {
+  @description("Metadata tag on an atproto resource (eg, repo or record).")
+  type label {
+    @description("The AT Protocol version of the label object.") ver?: integer
+    @description("DID of the actor who created this label.") @format("did") src: string
+    @description("AT URI of the record, repository (account), or other resource that this label applies to.") @format("uri") uri: string
+    @description("Optionally, CID specifying the specific version of 'uri' resource this label applies to.") @format("cid") cid?: string
+    @description("The short string name of the value or type of this label.") @maxLength(128) val: string
+    @description("If true, this is a negation label, overwriting a previous label.") neg?: boolean
+    @description("Timestamp when this label was created.") @format("datetime") cts: string
+    @description("Timestamp at which this label expires (no longer applies).") @format("datetime") exp?: string
+    @description("Signature of dag-cbor encoded label.") sig?: bytes
+  }
+
+  @description("Metadata tags on an atproto record, published by the author within the record.")
+  type selfLabels {
+    @maxLength(10) values: selfLabel[]
+  }
+
+  @description("Metadata tag on an atproto record, published by the author within the record. Note that schemas should use #selfLabels, not #selfLabel.")
+  type selfLabel {
+    @description("The short string name of the value or type of this label.") @maxLength(128) val: string
+  }
+
+  @description("Declares a label value and its expected interpretations and behaviors.")
+  type labelValueDefinition {
+    @description("The value of the label being defined. Must only include lowercase ascii and the '-' character ([a-z-]+).") @maxGraphemes(100) @maxLength(100) identifier: string
+    @description("How should a client visually convey this label? 'inform' means neutral and informational; 'alert' means negative and warning; 'none' means show nothing.") @knownValues("inform", "alert", "none") severity: string
+    @description("What should this label hide in the UI, if applied? 'content' hides all of the target; 'media' hides the images/video/audio; 'none' hides nothing.") @knownValues("content", "media", "none") blurs: string
+    @description("The default setting for this label.") @default("warn") @knownValues("ignore", "warn", "hide") defaultSetting?: string
+    @description("Does the user need to have adult content enabled in order to configure this label?") adultOnly?: boolean
+    locales: labelValueDefinitionStrings[]
+  }
+
+  @description("Strings which describe the label in the UI, localized into a specific language.")
+  type labelValueDefinitionStrings {
+    @description("The code of the language these strings are written in.") @format("language") lang: string
+    @description("A short human-readable name for the label.") @maxGraphemes(64) @maxLength(640) name: string
+    @description("A longer description of what the label means and why it might be applied.") @maxGraphemes(10000) @maxLength(100000) description: string
+  }
+
+  @scalar("string")
+  @knownValues("!hide", "!warn", "!no-unauthenticated", "porn", "sexual", "nudity", "graphic-media", "bot")
+  type labelValue {}
+}

package/src/com.atproto.repo.applyWrites.lexd

@@ -0,0 +1,62 @@
+import { commitMeta } from "com.atproto.repo.defs"
+
+namespace com.atproto.repo {
+  @procedure
+  @description("Apply a batch transaction of repository creates, updates, and deletes. Requires auth, implemented by PDS.")
+  type applyWrites {
+    input {
+      encoding: "application/json"
+      schema {
+        @description("The handle or DID of the repo (aka, current account).") @format("at-identifier") repo: string
+        @description("Can be set to 'false' to skip Lexicon schema validation of record data across all operations, 'true' to require it, or leave unset to validate only for known Lexicons.") validate?: boolean
+        writes: closed union(#create, #update, #delete)[]
+        @description("If provided, the entire operation will fail if the current repo commit CID does not match this value. Used to prevent conflicting repo mutations.") @format("cid") swapCommit?: string
+      }
+    }
+    output {
+      encoding: "application/json"
+      schema {
+        commit?: commitMeta
+        results?: closed union(#createResult, #updateResult, #deleteResult)[]
+      }
+    }
+    errors {
+      InvalidSwap: "Indicates that the 'swapCommit' parameter did not match current commit."
+    }
+  }
+
+  @description("Operation which creates a new record.")
+  type create {
+    @format("nsid") collection: string
+    @description("NOTE: maxLength is redundant with record-key format. Keeping it temporarily to ensure backwards compatibility.") @format("record-key") @maxLength(512) rkey?: string
+    value: unknown
+  }
+
+  @description("Operation which updates an existing record.")
+  type update {
+    @format("nsid") collection: string
+    @format("record-key") rkey: string
+    value: unknown
+  }
+
+  @description("Operation which deletes an existing record.")
+  type delete {
+    @format("nsid") collection: string
+    @format("record-key") rkey: string
+  }
+
+  type createResult {
+    @format("at-uri") uri: string
+    @format("cid") cid: string
+    @knownValues("valid", "unknown") validationStatus?: string
+  }
+
+  type updateResult {
+    @format("at-uri") uri: string
+    @format("cid") cid: string
+    @knownValues("valid", "unknown") validationStatus?: string
+  }
+
+  type deleteResult {
+  }
+}

package/src/com.atproto.repo.createRecord.lexd

@@ -0,0 +1,31 @@
+import { commitMeta } from "com.atproto.repo.defs"
+
+namespace com.atproto.repo {
+  @procedure
+  @description("Create a single new repository record. Requires auth, implemented by PDS.")
+  type createRecord {
+    input {
+      encoding: "application/json"
+      schema {
+        @description("The handle or DID of the repo (aka, current account).") @format("at-identifier") repo: string
+        @description("The NSID of the record collection.") @format("nsid") collection: string
+        @description("The Record Key.") @format("record-key") @maxLength(512) rkey?: string
+        @description("Can be set to 'false' to skip Lexicon schema validation of record data, 'true' to require it, or leave unset to validate only for known Lexicons.") validate?: boolean
+        @description("The record itself. Must contain a $type field.") record: unknown
+        @description("Compare and swap with the previous commit by CID.") @format("cid") swapCommit?: string
+      }
+    }
+    output {
+      encoding: "application/json"
+      schema {
+        @format("at-uri") uri: string
+        @format("cid") cid: string
+        commit?: commitMeta
+        @knownValues("valid", "unknown") validationStatus?: string
+      }
+    }
+    errors {
+      InvalidSwap: "Indicates that 'swapCommit' didn't match current repo commit."
+    }
+  }
+}

package/src/com.atproto.repo.defs.lexd

@@ -0,0 +1,6 @@
+namespace com.atproto.repo.defs {
+  type commitMeta {
+    @format("cid") cid: string
+    @format("tid") rev: string
+  }
+}

package/src/com.atproto.repo.getRecord.lexd

@@ -0,0 +1,23 @@
+namespace com.atproto.repo {
+  @query
+  @description("Get a single record from a repository. Does not require auth.")
+  type getRecord {
+    params {
+      @description("The handle or DID of the repo.") @format("at-identifier") repo: string
+      @description("The NSID of the record collection.") @format("nsid") collection: string
+      @description("The Record Key.") @format("record-key") rkey: string
+      @description("The CID of the version of the record. If not specified, then return the most recent version.") @format("cid") cid?: string
+    }
+    output {
+      encoding: "application/json"
+      schema {
+        @format("at-uri") uri: string
+        @format("cid") cid?: string
+        value: unknown
+      }
+    }
+    errors {
+      RecordNotFound
+    }
+  }
+}

package/src/com.atproto.repo.listRecords.lexd

@@ -0,0 +1,26 @@
+namespace com.atproto.repo {
+  @query
+  @description("List a range of records in a repository, matching a specific collection. Does not require auth.")
+  type listRecords {
+    params {
+      @description("The handle or DID of the repo.") @format("at-identifier") repo: string
+      @description("The NSID of the record type.") @format("nsid") collection: string
+      @description("The number of records to return.") @minimum(1) @maximum(100) @default(50) limit?: integer
+      cursor?: string
+      @description("Flag to reverse the order of the returned records.") reverse?: boolean
+    }
+    output {
+      encoding: "application/json"
+      schema {
+        cursor?: string
+        records: record[]
+      }
+    }
+  }
+
+  type record {
+    @format("at-uri") uri: string
+    @format("cid") cid: string
+    value: unknown
+  }
+}

package/src/com.atproto.repo.strongRef.lexd

@@ -0,0 +1,7 @@
+namespace com.atproto.repo {
+  @object
+  type strongRef {
+    @format("at-uri") uri: string
+    @format("cid") cid: string
+  }
+}

package/src/com.atproto.server.describeServer.lexd

@@ -0,0 +1,26 @@
+namespace com.atproto.server {
+  @query
+  @description("Describes the server's account creation requirements and capabilities. Implemented by PDS.")
+  type describeServer {
+    output {
+      encoding: "application/json"
+      schema {
+        @description("If true, an invite code must be supplied to create an account on this instance.") inviteCodeRequired?: boolean
+        @description("If true, a phone verification token must be supplied to create an account on this instance.") phoneVerificationRequired?: boolean
+        @description("List of domain suffixes that can be used in account handles.") availableUserDomains: string[]
+        @description("URLs of service policy documents.") links?: links
+        @description("Contact information") contact?: contact
+        @format("did") did: string
+      }
+    }
+  }
+
+  type links {
+    @format("uri") privacyPolicy?: string
+    @format("uri") termsOfService?: string
+  }
+
+  type contact {
+    email?: string
+  }
+}

package/src/com.atproto.sync.subscribeRepos.lexd

@@ -0,0 +1,71 @@
+namespace com.atproto.sync {
+  @subscription
+  @description("Repository event stream, aka Firehose endpoint. Outputs repo commits with diff data, and identity update events, for all repositories on the current server. See the atproto specifications for details around stream sequencing, repo versioning, CAR diff format, and more. Public and does not require auth; implemented by PDS and Relay.")
+  type subscribeRepos {
+    params {
+      @description("The last known event seq number to backfill from.") cursor?: integer
+    }
+    message {
+      schema: union(#commit, #sync, #identity, #account, #info)
+    }
+    errors {
+      FutureCursor
+      ConsumerTooSlow: "If the consumer of the stream can not keep up with events, and a backlog gets too large, the server will drop the connection."
+    }
+  }
+
+  @description("Represents an update of repository state. Note that empty commits are allowed, which include no repo data changes, but an update to rev and signature.")
+  type commit {
+    @description("The stream sequence number of this message.") seq: integer
+    @description("DEPRECATED -- unused") rebase: boolean
+    @description("DEPRECATED -- replaced by #sync event and data limits. Indicates that this commit contained too many ops, or data size was too large. Consumers will need to make a separate request to get missing data.") tooBig: boolean
+    @description("The repo this event comes from. Note that all other message types name this field 'did'.") @format("did") repo: string
+    @description("Repo commit object CID.") commit: cid-link
+    @description("The rev of the emitted commit. Note that this information is also in the commit object included in blocks, unless this is a tooBig event.") @format("tid") rev: string
+    @description("The rev of the last emitted commit from this repo (if any).") @format("tid") @nullable since: string
+    @description("CAR file containing relevant blocks, as a diff since the previous repo state. The commit must be included as a block, and the commit block CID must be the first entry in the CAR header 'roots' list.") @maxLength(2000000) blocks: bytes
+    @maxLength(200) ops: repoOp[]
+    blobs: cid-link[]
+    @description("The root CID of the MST tree for the previous commit from this repo (indicated by the 'since' revision field in this message). Corresponds to the 'data' field in the repo commit object. NOTE: this field is effectively required for the 'inductive' version of firehose.") prevData?: cid-link
+    @description("Timestamp of when this message was originally broadcast.") @format("datetime") time: string
+  }
+
+  @description("Updates the repo to a new state, without necessarily including that state on the firehose. Used to recover from broken commit streams, data loss incidents, or in situations where upstream host does not know recent state of the repository.")
+  type sync {
+    @description("The stream sequence number of this message.") seq: integer
+    @description("The account this repo event corresponds to. Must match that in the commit object.") @format("did") did: string
+    @description("CAR file containing the commit, as a block. The CAR header must include the commit block CID as the first 'root'.") @maxLength(10000) blocks: bytes
+    @description("The rev of the commit. This value must match that in the commit object.") rev: string
+    @description("Timestamp of when this message was originally broadcast.") @format("datetime") time: string
+  }
+
+  @description("Represents a change to an account's identity. Could be an updated handle, signing key, or pds hosting endpoint. Serves as a prod to all downstream services to refresh their identity cache.")
+  type identity {
+    seq: integer
+    @format("did") did: string
+    @format("datetime") time: string
+    @description("The current handle for the account, or 'handle.invalid' if validation fails. This field is optional, might have been validated or passed-through from an upstream source. Semantics and behaviors for PDS vs Relay may evolve in the future; see atproto specs for more details.") @format("handle") handle?: string
+  }
+
+  @description("Represents a change to an account's status on a host (eg, PDS or Relay). The semantics of this event are that the status is at the host which emitted the event, not necessarily that at the currently active PDS. Eg, a Relay takedown would emit a takedown with active=false, even if the PDS is still active.")
+  type account {
+    seq: integer
+    @format("did") did: string
+    @format("datetime") time: string
+    @description("Indicates that the account has a repository which can be fetched from the host that emitted this event.") active: boolean
+    @description("If active=false, this optional field indicates a reason for why the account is not active.") @knownValues("takendown", "suspended", "deleted", "deactivated", "desynchronized", "throttled") status?: string
+  }
+
+  type info {
+    @knownValues("OutdatedCursor") name: string
+    message?: string
+  }
+
+  @description("A repo operation, ie a mutation of a single record.")
+  type repoOp {
+    @knownValues("create", "update", "delete") action: string
+    path: string
+    @description("For creates and updates, the new record CID. For deletions, null.") @nullable cid: cid-link
+    @description("For updates and deletes, the previous record CID (required for inductive firehose). For creations, field should not be defined.") prev?: cid-link
+  }
+}