# dev.tsunagite.defs

> Published by [tsunagite.dev](https://lexicon.garden/identity/did:plc:pz4sp2vf5w26wnaee253gfms)

✓ This is the authoritative definition for this NSID.

## Description

Assistant data types for Tsunagite lexicons.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:pz4sp2vf5w26wnaee253gfms/dev.tsunagite.defs)
- [Documentation](https://lexicon.garden/lexicon/did:plc:pz4sp2vf5w26wnaee253gfms/dev.tsunagite.defs/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:pz4sp2vf5w26wnaee253gfms/dev.tsunagite.defs/examples)

## Definitions

### `dev.tsunagite.defs#typedRef`

**Type**: `object`

A typed record reference that does not require a CID hash.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `ref` | `string` (at-uri) | No | The AT URI of the record this object references. |
| `type` | `string` (nsid) | No | The type of the record this object references. |

### `dev.tsunagite.defs#indexable`

**Type**: `object`

A named value with a numeric index for sorting.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `id` | `string` (record-key) | Yes | The internal ID for the value, limited to the RecordKey character set. |
| `name` | `ref` → `dev.tsunagite.translatable` | Yes | The human-readable name of the value for displaying in UIs. |
| `index` | `integer` | Yes | The numeric index used for sorting. |

### `dev.tsunagite.defs#associatedScore`

**Type**: `object`

A combined view of a score and the profile of the user who performed it.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | No |  |
| `score` | `ref` → `dev.tsunagite.score` | Yes |  |
| `handle` | `string` (handle) | No |  |
| `profile` | `ref` → `dev.tsunagite.profile` | No |  |

## Raw Schema

```json
{
  "id": "dev.tsunagite.defs",
  "defs": {
    "typedRef": {
      "type": "object",
      "properties": {
        "ref": {
          "type": "string",
          "format": "at-uri",
          "description": "The AT URI of the record this object references."
        },
        "type": {
          "type": "string",
          "format": "nsid",
          "description": "The type of the record this object references."
        }
      },
      "description": "A typed record reference that does not require a CID hash."
    },
    "indexable": {
      "type": "object",
      "required": [
        "id",
        "name",
        "index"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "record-key",
          "maxLength": 32,
          "minLength": 1,
          "description": "The internal ID for the value, limited to the RecordKey character set."
        },
        "name": {
          "ref": "dev.tsunagite.translatable",
          "type": "ref",
          "description": "The human-readable name of the value for displaying in UIs."
        },
        "index": {
          "type": "integer",
          "description": "The numeric index used for sorting."
        }
      },
      "description": "A named value with a numeric index for sorting."
    },
    "associatedScore": {
      "type": "object",
      "required": [
        "score"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did"
        },
        "score": {
          "ref": "dev.tsunagite.score",
          "type": "ref"
        },
        "handle": {
          "type": "string",
          "format": "handle"
        },
        "profile": {
          "ref": "dev.tsunagite.profile",
          "type": "ref"
        }
      },
      "description": "A combined view of a score and the profile of the user who performed it."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "description": "Assistant data types for Tsunagite lexicons."
}
```