feat: add standard site lexicons to project (#297)

Co-authored-by: Daniel Roe <daniel@roe.dev>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

Author: 3 people

.gitignore

@@ -36,3 +36,6 @@ test-results/
 
 # Lighthouse
 .lighthouseci
+
+# generated files
+shared/types/lexicons

knip.json

@@ -2,7 +2,8 @@
   "$schema": "https://unpkg.com/knip@5/schema.json",
   "includeEntryExports": true,
   "ignoreExportsUsedInFile": true,
-  "ignoreBinaries": ["simple-git-hooks", "lint-staged"],
+  "ignoreBinaries": ["simple-git-hooks", "lint-staged", "lex"],
+  "ignore": ["shared/types/lexicons/**"],
   "workspaces": {
     ".": {
       "entry": [

lexicons.json

@@ -0,0 +1,14 @@
+{
+  "version": 1,
+  "lexicons": ["site.standard.document"],
+  "resolutions": {
+    "com.atproto.repo.strongRef": {
+      "uri": "at://did:plc:6msi3pj7krzih5qxqtryxlzw/com.atproto.lexicon.schema/com.atproto.repo.strongRef",
+      "cid": "bafyreifrkdbnkvfjujntdaeigolnrjj3srrs53tfixjhmacclps72qlov4"
+    },
+    "site.standard.document": {
+      "uri": "at://did:plc:re3ebnp5v7ffagz6rb6xfei4/com.atproto.lexicon.schema/site.standard.document",
+      "cid": "bafyreigdukg62hmel4jbdvghdsoaphslhrdktmahzdyokomuka6yejetwa"
+    }
+  }
+}

lexicons/com/atproto/repo/strongRef.json

@@ -0,0 +1,22 @@
+{
+  "id": "com.atproto.repo.strongRef",
+  "defs": {
+    "main": {
+      "type": "object",
+      "required": ["uri", "cid"],
+      "properties": {
+        "cid": {
+          "type": "string",
+          "format": "cid"
+        },
+        "uri": {
+          "type": "string",
+          "format": "at-uri"
+        }
+      }
+    }
+  },
+  "$type": "com.atproto.lexicon.schema",
+  "lexicon": 1,
+  "description": "A URI with a content-hash fingerprint."
+}

lexicons/site/standard/document.json

@@ -0,0 +1,79 @@
+{
+  "id": "site.standard.document",
+  "defs": {
+    "main": {
+      "key": "tid",
+      "type": "record",
+      "record": {
+        "type": "object",
+        "required": ["site", "title", "publishedAt"],
+        "properties": {
+          "path": {
+            "type": "string",
+            "description": "Combine with site or publication url to construct a canonical URL to the document. Prepend with a leading slash."
+          },
+          "site": {
+            "type": "string",
+            "format": "uri",
+            "description": "Points to a publication record (at://) or a publication url (https://) for loose documents. Avoid trailing slashes."
+          },
+          "tags": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "maxLength": 1280,
+            "description": "Array of strings used to tag or categorize the document. Avoid prepending tags with hashtags.",
+            "maxGraphemes": 128
+          },
+          "title": {
+            "type": "string",
+            "maxLength": 5000,
+            "description": "Title of the document.",
+            "maxGraphemes": 500
+          },
+          "content": {
+            "refs": [],
+            "type": "union",
+            "closed": false,
+            "description": "Open union used to define the record's content. Each entry must specify a $type and may be extended with other lexicons to support additional content formats."
+          },
+          "updatedAt": {
+            "type": "string",
+            "format": "datetime",
+            "description": "Timestamp of the documents last edit."
+          },
+          "coverImage": {
+            "type": "blob",
+            "accept": ["image/*"],
+            "maxSize": 1000000,
+            "description": "Image to used for thumbnail or cover image. Less than 1MB is size."
+          },
+          "bskyPostRef": {
+            "ref": "com.atproto.repo.strongRef",
+            "type": "ref",
+            "description": "Strong reference to a Bluesky post. Useful to keep track of comments off-platform."
+          },
+          "description": {
+            "type": "string",
+            "maxLength": 30000,
+            "description": "A brief description or excerpt from the document.",
+            "maxGraphemes": 3000
+          },
+          "publishedAt": {
+            "type": "string",
+            "format": "datetime",
+            "description": "Timestamp of the documents publish time."
+          },
+          "textContent": {
+            "type": "string",
+            "description": "Plaintext representation of the documents contents. Should not contain markdown or other formatting."
+          }
+        }
+      },
+      "description": "A document record representing a published article, blog post, or other content. Documents can belong to a publication or exist independently."
+    }
+  },
+  "$type": "com.atproto.lexicon.schema",
+  "lexicon": 1
+}

package.json

@@ -21,7 +21,8 @@
     "generate": "nuxt generate",
     "npmx-connector": "pnpm --filter npmx-connector dev",
     "preview": "nuxt preview",
-    "postinstall": "nuxt prepare && simple-git-hooks",
+    "postinstall": "nuxt prepare && simple-git-hooks && pnpm generate:lexicons",
+    "generate:lexicons": "lex build --lexicons lexicons --out shared/types/lexicons --clear",
     "test": "vite test",
     "test:browser": "playwright test",
     "test:browser:ui": "playwright test --ui",
@@ -31,6 +32,7 @@
     "test:unit": "vite test --project unit"
   },
   "dependencies": {
+    "@atproto/lex": "^0.0.13",
     "@deno/doc": "jsr:^0.189.1",
     "@iconify-json/simple-icons": "^1.2.67",
     "@iconify-json/vscode-icons": "^1.2.40",