# club.hellyeah.defs

- Kind: defs
- Authority: hellyeah.club
- Lexicon: 1
- Published by [hellyeah.club](https://lexicon.garden/identity/did:plc:ce2gpmv3q5a4xlnpt63e4nsn), the NSID's authority

## Links

- [Documentation](https://lexicon.garden/lexicon/did:plc:ce2gpmv3q5a4xlnpt63e4nsn/club.hellyeah.defs)
- [Schema JSON](https://lexicon.garden/lexicon/did:plc:ce2gpmv3q5a4xlnpt63e4nsn/club.hellyeah.defs/schema.json)
- [Analytics](https://lexicon.garden/lexicon/did:plc:ce2gpmv3q5a4xlnpt63e4nsn/club.hellyeah.defs/analytics)

## #accountView (`club.hellyeah.defs#accountView`)

Type: object

An account as its owner sees it.

### Properties

- `accountId` (string, required)
- `admin` (boolean, required)
- `did` (string · did): Unset for a claim made with email only.
- `displayName` (string)
  - Constraints: maxLength: 640, maxGraphemes: 64
- `email` (string): Confirmed by a sign-in link.
- `handle` (string · handle)
- `member` (boolean, required)
- `notifiedAt` (string · datetime)
- `notify` (boolean, required): Asked for the one invites email.
- `pendingEmail` (string): Sent a link, not yet opened.
- `waiting` (boolean, required)

## #aspectRatio (`club.hellyeah.defs#aspectRatio`)

Type: object

### Properties

- `height` (integer, required)
  - Constraints: minimum: 1
- `width` (integer, required)
  - Constraints: minimum: 1

## #imageView (`club.hellyeah.defs#imageView`)

Type: object

An image from the cross-post, as Bluesky's AppView serves it.

### Properties

- `alt` (string, required)
- `aspectRatio` (ref)
  - Reference: `#aspectRatio`
- `fullsize` (string · uri, required)
- `thumb` (string · uri, required)

## #leaderboardEntry (`club.hellyeah.defs#leaderboardEntry`)

Type: object

### Properties

- `actor` (ref, required)
  - Reference: `#profileViewBasic`
- `rank` (integer, required)
  - Constraints: minimum: 1
- `run` (ref, required)
  - Reference: `#runView`

## #memberView (`club.hellyeah.defs#memberView`)

Type: object

### Properties

- `did` (string · did, required)
- `displayName` (string)
  - Constraints: maxLength: 640, maxGraphemes: 64
- `handle` (string · handle, required)
- `invitedBy` (ref)
  - Reference: `#profileViewBasic`
- `removed` (boolean, required)

## #postView (`club.hellyeah.defs#postView`)

Type: object

### Properties

- `author` (ref, required)
  - Reference: `#profileViewBasic`
- `cid` (string · cid, required)
- `counted` (boolean, required): Another member's hell yeah has made this post count.
- `createdAt` (string · datetime, required)
- `crosspost` (ref)
  - Reference: `com.atproto.repo.strongRef`
- `crosspostTo` (ref): The author's cross-post app, with its url reduced to an https origin. Unset when the author has none, or none that is valid.
  - Reference: `club.hellyeah.settings#app`
- `images` (array)
  - Constraints: maxLength: 4
  - `items` (ref)
    - Reference: `#imageView`
- `text` (string, required)
  - Constraints: maxLength: 10000, maxGraphemes: 1000
- `uri` (string · at-uri, required)
- `viewer` (ref)
  - Reference: `#viewerState`
- `visitorYeahCount` (integer, required): Hell yeahs from accounts that aren't members. They show but never count.
  - Constraints: minimum: 0
- `witnessedAt` (string · datetime, required): When the app view first saw the post. This is the time that counts.
- `yeahCount` (integer, required): Hell yeahs from members other than the author.
  - Constraints: minimum: 0

## #profileView (`club.hellyeah.defs#profileView`)

Type: object

### Properties

- `avatar` (string · uri)
- `did` (string · did, required)
- `displayName` (string)
  - Constraints: maxLength: 640, maxGraphemes: 64
- `handle` (string · handle, required)
- `invitePrice` (integer): Hell yeahs received per invite earned, at the club's size now. Members only.
  - Constraints: minimum: 1
- `inviteProgress` (integer): Hell yeahs received toward the next invite. Members only.
  - Constraints: minimum: 0
- `invites` (integer): Unused invites. Members only.
  - Constraints: minimum: 0
- `member` (boolean, required): On the allowlist, so able to post.
- `protectors` (integer): Streak protectors held. Members only.
  - Constraints: minimum: 0
- `run` (ref): The current run, if any.
  - Reference: `#runView`
- `waiting` (boolean): Claimed a profile and waiting for an invite: never on the allowlist.

## #profileViewBasic (`club.hellyeah.defs#profileViewBasic`)

Type: object

### Properties

- `avatar` (string · uri)
- `did` (string · did, required)
- `displayName` (string)
  - Constraints: maxLength: 640, maxGraphemes: 64
- `handle` (string · handle, required)

## #reportView (`club.hellyeah.defs#reportView`)

Type: object

### Properties

- `hidden` (boolean, required)
- `post` (ref, required)
  - Reference: `#postView`
- `reportCount` (integer, required): Reports counted, one per invite branch.
  - Constraints: minimum: 1

## #runEnd (`club.hellyeah.defs#runEnd`)

Type: object

### Properties

- `endedAt` (string · datetime, required): The deadline that was missed.
- `mode` (ref, required)
  - Reference: `#runMode`
- `run` (string · at-uri, required): The club.hellyeah.run record.
- `startedAt` (string · datetime, required)

## #runMode (`club.hellyeah.defs#runMode`)

Type: string

passive: misses show but the run never ends. strikes: the third miss ends the run. hardcore: the first miss ends the run.

Constraints: knownValues: passive | strikes | hardcore

## #runView (`club.hellyeah.defs#runView`)

Type: object

### Properties

- `days` (integer, required): Whole days since the run started.
  - Constraints: minimum: 0
- `deadline` (string · datetime, required): When the next counted check-in is due.
- `mode` (ref, required)
  - Reference: `#runMode`
- `startedAt` (string · datetime, required): When the app view first saw the run record.
- `strikes` (integer, required)
  - Constraints: minimum: 0
- `uri` (string · at-uri, required): The club.hellyeah.run record.

## #viewerState (`club.hellyeah.defs#viewerState`)

Type: object

### Properties

- `yeah` (string · at-uri): The viewer's hell yeah on this post, if any.

## #waitingView (`club.hellyeah.defs#waitingView`)

Type: object

### Properties

- `claimedAt` (string · datetime, required)
- `did` (string · did, required)
- `displayName` (string)
  - Constraints: maxLength: 640, maxGraphemes: 64
- `handle` (string · handle, required)

## Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "accountView": {
      "description": "An account as its owner sees it.",
      "properties": {
        "accountId": {
          "type": "string"
        },
        "admin": {
          "type": "boolean"
        },
        "did": {
          "description": "Unset for a claim made with email only.",
          "format": "did",
          "type": "string"
        },
        "displayName": {
          "maxGraphemes": 64,
          "maxLength": 640,
          "type": "string"
        },
        "email": {
          "description": "Confirmed by a sign-in link.",
          "type": "string"
        },
        "handle": {
          "format": "handle",
          "type": "string"
        },
        "member": {
          "type": "boolean"
        },
        "notifiedAt": {
          "format": "datetime",
          "type": "string"
        },
        "notify": {
          "description": "Asked for the one invites email.",
          "type": "boolean"
        },
        "pendingEmail": {
          "description": "Sent a link, not yet opened.",
          "type": "string"
        },
        "waiting": {
          "type": "boolean"
        }
      },
      "required": [
        "accountId",
        "notify",
        "member",
        "waiting",
        "admin"
      ],
      "type": "object"
    },
    "aspectRatio": {
      "properties": {
        "height": {
          "minimum": 1,
          "type": "integer"
        },
        "width": {
          "minimum": 1,
          "type": "integer"
        }
      },
      "required": [
        "width",
        "height"
      ],
      "type": "object"
    },
    "imageView": {
      "description": "An image from the cross-post, as Bluesky's AppView serves it.",
      "properties": {
        "alt": {
          "type": "string"
        },
        "aspectRatio": {
          "ref": "#aspectRatio",
          "type": "ref"
        },
        "fullsize": {
          "format": "uri",
          "type": "string"
        },
        "thumb": {
          "format": "uri",
          "type": "string"
        }
      },
      "required": [
        "thumb",
        "fullsize",
        "alt"
      ],
      "type": "object"
    },
    "leaderboardEntry": {
      "properties": {
        "actor": {
          "ref": "#profileViewBasic",
          "type": "ref"
        },
        "rank": {
          "minimum": 1,
          "type": "integer"
        },
        "run": {
          "ref": "#runView",
          "type": "ref"
        }
      },
      "required": [
        "rank",
        "actor",
        "run"
      ],
      "type": "object"
    },
    "memberView": {
      "properties": {
        "did": {
          "format": "did",
          "type": "string"
        },
        "displayName": {
          "maxGraphemes": 64,
          "maxLength": 640,
          "type": "string"
        },
        "handle": {
          "format": "handle",
          "type": "string"
        },
        "invitedBy": {
          "ref": "#profileViewBasic",
          "type": "ref"
        },
        "removed": {
          "type": "boolean"
        }
      },
      "required": [
        "did",
        "handle",
        "removed"
      ],
      "type": "object"
    },
    "postView": {
      "properties": {
        "author": {
          "ref": "#profileViewBasic",
          "type": "ref"
        },
        "cid": {
          "format": "cid",
          "type": "string"
        },
        "counted": {
          "description": "Another member's hell yeah has made this post count.",
          "type": "boolean"
        },
        "createdAt": {
          "format": "datetime",
          "type": "string"
        },
        "crosspost": {
          "ref": "com.atproto.repo.strongRef",
          "type": "ref"
        },
        "crosspostTo": {
          "description": "The author's cross-post app, with its url reduced to an https origin. Unset when the author has none, or none that is valid.",
          "ref": "club.hellyeah.settings#app",
          "type": "ref"
        },
        "images": {
          "items": {
            "ref": "#imageView",
            "type": "ref"
          },
          "maxLength": 4,
          "type": "array"
        },
        "text": {
          "maxGraphemes": 1000,
          "maxLength": 10000,
          "type": "string"
        },
        "uri": {
          "format": "at-uri",
          "type": "string"
        },
        "viewer": {
          "ref": "#viewerState",
          "type": "ref"
        },
        "visitorYeahCount": {
          "description": "Hell yeahs from accounts that aren't members. They show but never count.",
          "minimum": 0,
          "type": "integer"
        },
        "witnessedAt": {
          "description": "When the app view first saw the post. This is the time that counts.",
          "format": "datetime",
          "type": "string"
        },
        "yeahCount": {
          "description": "Hell yeahs from members other than the author.",
          "minimum": 0,
          "type": "integer"
        }
      },
      "required": [
        "uri",
        "cid",
        "author",
        "text",
        "createdAt",
        "witnessedAt",
        "counted",
        "yeahCount",
        "visitorYeahCount"
      ],
      "type": "object"
    },
    "profileView": {
      "properties": {
        "avatar": {
          "format": "uri",
          "type": "string"
        },
        "did": {
          "format": "did",
          "type": "string"
        },
        "displayName": {
          "maxGraphemes": 64,
          "maxLength": 640,
          "type": "string"
        },
        "handle": {
          "format": "handle",
          "type": "string"
        },
        "invitePrice": {
          "description": "Hell yeahs received per invite earned, at the club's size now. Members only.",
          "minimum": 1,
          "type": "integer"
        },
        "inviteProgress": {
          "description": "Hell yeahs received toward the next invite. Members only.",
          "minimum": 0,
          "type": "integer"
        },
        "invites": {
          "description": "Unused invites. Members only.",
          "minimum": 0,
          "type": "integer"
        },
        "member": {
          "description": "On the allowlist, so able to post.",
          "type": "boolean"
        },
        "protectors": {
          "description": "Streak protectors held. Members only.",
          "minimum": 0,
          "type": "integer"
        },
        "run": {
          "description": "The current run, if any.",
          "ref": "#runView",
          "type": "ref"
        },
        "waiting": {
          "description": "Claimed a profile and waiting for an invite: never on the allowlist.",
          "type": "boolean"
        }
      },
      "required": [
        "did",
        "handle",
        "member"
      ],
      "type": "object"
    },
    "profileViewBasic": {
      "properties": {
        "avatar": {
          "format": "uri",
          "type": "string"
        },
        "did": {
          "format": "did",
          "type": "string"
        },
        "displayName": {
          "maxGraphemes": 64,
          "maxLength": 640,
          "type": "string"
        },
        "handle": {
          "format": "handle",
          "type": "string"
        }
      },
      "required": [
        "did",
        "handle"
      ],
      "type": "object"
    },
    "reportView": {
      "properties": {
        "hidden": {
          "type": "boolean"
        },
        "post": {
          "ref": "#postView",
          "type": "ref"
        },
        "reportCount": {
          "description": "Reports counted, one per invite branch.",
          "minimum": 1,
          "type": "integer"
        }
      },
      "required": [
        "post",
        "reportCount",
        "hidden"
      ],
      "type": "object"
    },
    "runEnd": {
      "properties": {
        "endedAt": {
          "description": "The deadline that was missed.",
          "format": "datetime",
          "type": "string"
        },
        "mode": {
          "ref": "#runMode",
          "type": "ref"
        },
        "run": {
          "description": "The club.hellyeah.run record.",
          "format": "at-uri",
          "type": "string"
        },
        "startedAt": {
          "format": "datetime",
          "type": "string"
        }
      },
      "required": [
        "run",
        "mode",
        "startedAt",
        "endedAt"
      ],
      "type": "object"
    },
    "runMode": {
      "description": "passive: misses show but the run never ends. strikes: the third miss ends the run. hardcore: the first miss ends the run.",
      "knownValues": [
        "passive",
        "strikes",
        "hardcore"
      ],
      "type": "string"
    },
    "runView": {
      "properties": {
        "days": {
          "description": "Whole days since the run started.",
          "minimum": 0,
          "type": "integer"
        },
        "deadline": {
          "description": "When the next counted check-in is due.",
          "format": "datetime",
          "type": "string"
        },
        "mode": {
          "ref": "#runMode",
          "type": "ref"
        },
        "startedAt": {
          "description": "When the app view first saw the run record.",
          "format": "datetime",
          "type": "string"
        },
        "strikes": {
          "minimum": 0,
          "type": "integer"
        },
        "uri": {
          "description": "The club.hellyeah.run record.",
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "uri",
        "mode",
        "startedAt",
        "days",
        "strikes",
        "deadline"
      ],
      "type": "object"
    },
    "viewerState": {
      "properties": {
        "yeah": {
          "description": "The viewer's hell yeah on this post, if any.",
          "format": "at-uri",
          "type": "string"
        }
      },
      "type": "object"
    },
    "waitingView": {
      "properties": {
        "claimedAt": {
          "format": "datetime",
          "type": "string"
        },
        "did": {
          "format": "did",
          "type": "string"
        },
        "displayName": {
          "maxGraphemes": 64,
          "maxLength": 640,
          "type": "string"
        },
        "handle": {
          "format": "handle",
          "type": "string"
        }
      },
      "required": [
        "did",
        "handle",
        "claimedAt"
      ],
      "type": "object"
    }
  },
  "id": "club.hellyeah.defs",
  "lexicon": 1
}
```
