# club.userstyles.alpha.defs

> Published by [userstyles.club](https://lexicon.garden/identity/did:plc:z6a2tfjek74wmqinw5vjzbed)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:z6a2tfjek74wmqinw5vjzbed/club.userstyles.alpha.defs)
- [Documentation](https://lexicon.garden/lexicon/did:plc:z6a2tfjek74wmqinw5vjzbed/club.userstyles.alpha.defs/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:z6a2tfjek74wmqinw5vjzbed/club.userstyles.alpha.defs/examples)

## Definitions

### `club.userstyles.alpha.defs#followView`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | Yes |  |
| `createdAt` | `string` (datetime) | Yes |  |

### `club.userstyles.alpha.defs#ratingView`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cid` | `string` (cid) | Yes |  |
| `uri` | `string` (at-uri) | Yes |  |
| `author` | `string` (did) | Yes |  |
| `rating` | `integer` | Yes |  |
| `createdAt` | `string` (datetime) | Yes |  |
| `indexedAt` | `string` (datetime) | Yes |  |
| `updatedAt` | `string` (datetime) | No |  |
| `subjectUri` | `string` (at-uri) | Yes |  |

### `club.userstyles.alpha.defs#commentView`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cid` | `string` (cid) | Yes |  |
| `uri` | `string` (at-uri) | Yes |  |
| `author` | `string` (did) | Yes |  |
| `comment` | `string` | Yes |  |
| `createdAt` | `string` (datetime) | Yes |  |
| `indexedAt` | `string` (datetime) | Yes |  |
| `parentUri` | `string` (at-uri) | No |  |
| `updatedAt` | `string` (datetime) | No |  |
| `subjectUri` | `string` (at-uri) | Yes |  |

### `club.userstyles.alpha.defs#profileView`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | Yes |  |
| `handle` | `string` (handle) | No |  |
| `createdAt` | `string` (datetime) | No |  |
| `indexedAt` | `string` (datetime) | No |  |
| `description` | `string` | No |  |

### `club.userstyles.alpha.defs#feedViewItem`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `type` | `string` | Yes |  |
| `follow` | `ref` → `club.userstyles.alpha.defs#feedFollowView` | No |  |
| `rating` | `ref` → `club.userstyles.alpha.defs#ratingView` | No |  |
| `comment` | `ref` → `club.userstyles.alpha.defs#commentView` | No |  |
| `userstyle` | `ref` → `club.userstyles.alpha.defs#userstyleView` | No |  |

### `club.userstyles.alpha.defs#userstyleView`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cid` | `string` (cid) | Yes |  |
| `uri` | `string` (at-uri) | Yes |  |
| `title` | `string` | Yes |  |
| `author` | `string` (did) | Yes |  |
| `license` | `string` | No |  |
| `createdAt` | `string` (datetime) | Yes |  |
| `indexedAt` | `string` (datetime) | Yes |  |
| `updatedAt` | `string` (datetime) | No |  |
| `description` | `string` | No |  |
| `homepageUrl` | `string` (uri) | No |  |
| `ratingCount` | `integer` | Yes |  |
| `upstreamUrl` | `string` (uri) | No |  |
| `userCssVars` | `integer` | No |  |
| `commentCount` | `integer` | Yes |  |
| `ratingAverage` | `string` | No |  |
| `sourceCodeCid` | `string` (cid) | Yes |  |
| `ignoreUpdateUrl` | `boolean` | No |  |
| `previewImageCid` | `string` (cid) | No |  |
| `mozDocumentFunctions` | `array` | No |  |

### `club.userstyles.alpha.defs#feedFollowView`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | Yes |  |
| `uri` | `string` (at-uri) | Yes |  |
| `createdAt` | `string` (datetime) | Yes |  |
| `indexedAt` | `string` (datetime) | Yes |  |
| `subjectDid` | `string` (did) | Yes |  |

### `club.userstyles.alpha.defs#notificationView`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `author` | `string` (did) | Yes |  |
| `reason` | `string` | Yes |  |
| `createdAt` | `string` (datetime) | Yes |  |
| `indexedAt` | `string` (datetime) | Yes |  |
| `recordUri` | `string` (at-uri) | Yes |  |
| `userstyle` | `ref` → `club.userstyles.alpha.defs#userstyleView` | No |  |

### `club.userstyles.alpha.defs#relationshipView`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | Yes |  |
| `following` | `string` (at-uri) | No |  |
| `followedBy` | `string` (at-uri) | No |  |

### `club.userstyles.alpha.defs#commentThreadView`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cid` | `string` (cid) | No |  |
| `uri` | `string` (at-uri) | Yes |  |
| `author` | `string` (did) | No |  |
| `rating` | `integer` | No |  |
| `comment` | `string` | No |  |
| `deleted` | `boolean` | Yes |  |
| `createdAt` | `string` (datetime) | Yes |  |
| `indexedAt` | `string` (datetime) | Yes |  |
| `parentUri` | `string` (at-uri) | No |  |
| `updatedAt` | `string` (datetime) | No |  |
| `subjectUri` | `string` (at-uri) | No |  |

### `club.userstyles.alpha.defs#mozDocumentFunction`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `name` | `string` | Yes |  |
| `value` | `string` | Yes |  |

## Raw Schema

```json
{
  "id": "club.userstyles.alpha.defs",
  "defs": {
    "followView": {
      "type": "object",
      "required": [
        "did",
        "createdAt"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did"
        },
        "createdAt": {
          "type": "string",
          "format": "datetime"
        }
      }
    },
    "ratingView": {
      "type": "object",
      "required": [
        "uri",
        "cid",
        "author",
        "subjectUri",
        "rating",
        "createdAt",
        "indexedAt"
      ],
      "properties": {
        "cid": {
          "type": "string",
          "format": "cid"
        },
        "uri": {
          "type": "string",
          "format": "at-uri"
        },
        "author": {
          "type": "string",
          "format": "did"
        },
        "rating": {
          "type": "integer",
          "maximum": 5,
          "minimum": 1
        },
        "createdAt": {
          "type": "string",
          "format": "datetime"
        },
        "indexedAt": {
          "type": "string",
          "format": "datetime"
        },
        "updatedAt": {
          "type": "string",
          "format": "datetime"
        },
        "subjectUri": {
          "type": "string",
          "format": "at-uri"
        }
      }
    },
    "commentView": {
      "type": "object",
      "required": [
        "uri",
        "cid",
        "author",
        "subjectUri",
        "comment",
        "createdAt",
        "indexedAt"
      ],
      "properties": {
        "cid": {
          "type": "string",
          "format": "cid"
        },
        "uri": {
          "type": "string",
          "format": "at-uri"
        },
        "author": {
          "type": "string",
          "format": "did"
        },
        "comment": {
          "type": "string",
          "maxLength": 2560,
          "maxGraphemes": 256
        },
        "createdAt": {
          "type": "string",
          "format": "datetime"
        },
        "indexedAt": {
          "type": "string",
          "format": "datetime"
        },
        "parentUri": {
          "type": "string",
          "format": "at-uri"
        },
        "updatedAt": {
          "type": "string",
          "format": "datetime"
        },
        "subjectUri": {
          "type": "string",
          "format": "at-uri"
        }
      }
    },
    "profileView": {
      "type": "object",
      "required": [
        "did"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did"
        },
        "handle": {
          "type": "string",
          "format": "handle"
        },
        "createdAt": {
          "type": "string",
          "format": "datetime"
        },
        "indexedAt": {
          "type": "string",
          "format": "datetime"
        },
        "description": {
          "type": "string",
          "maxLength": 2560,
          "maxGraphemes": 256
        }
      }
    },
    "feedViewItem": {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "enum": [
            "userstyle",
            "comment",
            "rating",
            "follow"
          ],
          "type": "string"
        },
        "follow": {
          "ref": "club.userstyles.alpha.defs#feedFollowView",
          "type": "ref"
        },
        "rating": {
          "ref": "club.userstyles.alpha.defs#ratingView",
          "type": "ref"
        },
        "comment": {
          "ref": "club.userstyles.alpha.defs#commentView",
          "type": "ref"
        },
        "userstyle": {
          "ref": "club.userstyles.alpha.defs#userstyleView",
          "type": "ref"
        }
      }
    },
    "userstyleView": {
      "type": "object",
      "required": [
        "uri",
        "cid",
        "author",
        "title",
        "sourceCodeCid",
        "createdAt",
        "indexedAt",
        "commentCount",
        "ratingCount"
      ],
      "properties": {
        "cid": {
          "type": "string",
          "format": "cid"
        },
        "uri": {
          "type": "string",
          "format": "at-uri"
        },
        "title": {
          "type": "string",
          "maxGraphemes": 140,
          "minGraphemes": 1
        },
        "author": {
          "type": "string",
          "format": "did"
        },
        "license": {
          "type": "string",
          "maxLength": 100
        },
        "createdAt": {
          "type": "string",
          "format": "datetime"
        },
        "indexedAt": {
          "type": "string",
          "format": "datetime"
        },
        "updatedAt": {
          "type": "string",
          "format": "datetime"
        },
        "description": {
          "type": "string",
          "maxGraphemes": 300
        },
        "homepageUrl": {
          "type": "string",
          "format": "uri"
        },
        "ratingCount": {
          "type": "integer"
        },
        "upstreamUrl": {
          "type": "string",
          "format": "uri"
        },
        "userCssVars": {
          "type": "integer"
        },
        "commentCount": {
          "type": "integer"
        },
        "ratingAverage": {
          "type": "string"
        },
        "sourceCodeCid": {
          "type": "string",
          "format": "cid"
        },
        "ignoreUpdateUrl": {
          "type": "boolean"
        },
        "previewImageCid": {
          "type": "string",
          "format": "cid"
        },
        "mozDocumentFunctions": {
          "type": "array",
          "items": {
            "ref": "club.userstyles.alpha.defs#mozDocumentFunction",
            "type": "ref"
          }
        }
      }
    },
    "feedFollowView": {
      "type": "object",
      "required": [
        "uri",
        "did",
        "subjectDid",
        "createdAt",
        "indexedAt"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did"
        },
        "uri": {
          "type": "string",
          "format": "at-uri"
        },
        "createdAt": {
          "type": "string",
          "format": "datetime"
        },
        "indexedAt": {
          "type": "string",
          "format": "datetime"
        },
        "subjectDid": {
          "type": "string",
          "format": "did"
        }
      }
    },
    "notificationView": {
      "type": "object",
      "required": [
        "reason",
        "recordUri",
        "author",
        "createdAt",
        "indexedAt"
      ],
      "properties": {
        "author": {
          "type": "string",
          "format": "did"
        },
        "reason": {
          "enum": [
            "comment",
            "reply",
            "thread",
            "rating",
            "follow"
          ],
          "type": "string"
        },
        "createdAt": {
          "type": "string",
          "format": "datetime"
        },
        "indexedAt": {
          "type": "string",
          "format": "datetime"
        },
        "recordUri": {
          "type": "string",
          "format": "at-uri"
        },
        "userstyle": {
          "ref": "club.userstyles.alpha.defs#userstyleView",
          "type": "ref"
        }
      }
    },
    "relationshipView": {
      "type": "object",
      "required": [
        "did"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did"
        },
        "following": {
          "type": "string",
          "format": "at-uri"
        },
        "followedBy": {
          "type": "string",
          "format": "at-uri"
        }
      }
    },
    "commentThreadView": {
      "type": "object",
      "required": [
        "uri",
        "deleted",
        "createdAt",
        "indexedAt"
      ],
      "properties": {
        "cid": {
          "type": "string",
          "format": "cid"
        },
        "uri": {
          "type": "string",
          "format": "at-uri"
        },
        "author": {
          "type": "string",
          "format": "did"
        },
        "rating": {
          "type": "integer",
          "maximum": 5,
          "minimum": 1
        },
        "comment": {
          "type": "string",
          "maxLength": 2560,
          "maxGraphemes": 256
        },
        "deleted": {
          "type": "boolean"
        },
        "createdAt": {
          "type": "string",
          "format": "datetime"
        },
        "indexedAt": {
          "type": "string",
          "format": "datetime"
        },
        "parentUri": {
          "type": "string",
          "format": "at-uri"
        },
        "updatedAt": {
          "type": "string",
          "format": "datetime"
        },
        "subjectUri": {
          "type": "string",
          "format": "at-uri"
        }
      }
    },
    "mozDocumentFunction": {
      "type": "object",
      "required": [
        "name",
        "value"
      ],
      "properties": {
        "name": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```