# ing.dasl.masl

> Published by [robin.berjon.com](https://lexicon.garden/identity/did:plc:izttpdp3l6vss5crelt5kcux)

✓ This is the authoritative definition for this NSID.

## Description

Lexicon for DASL (https://dasl.ing/) types used on AT, notably for Web Tiles.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:izttpdp3l6vss5crelt5kcux/ing.dasl.masl)
- [Documentation](https://lexicon.garden/lexicon/did:plc:izttpdp3l6vss5crelt5kcux/ing.dasl.masl/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:izttpdp3l6vss5crelt5kcux/ing.dasl.masl/examples)

## Definitions

### `ing.dasl.masl`

**Type**: `record`

A tile, instantiating MASL metadata into a record

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cid` | `string` (cid) | Yes | The DRISL CID of the MASL for the tile |
| `tile` | `ref` → `ing.dasl.masl#masl` | Yes | The MASL content |
| `createdAt` | `string` (datetime) | Yes | Timestamp |

### `ing.dasl.masl#masl`

**Type**: `object`

MASL metadata as defined in https://dasl.ing/masl.html

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `name` | `string` | Yes | The name for the tile, can be a title or app name |
| `prev` | `cid-link` | No | In case there are multiple versions of this tile, this is the CID of the previous one |
| `icons` | `array` | No | Icons for the tile |
| `roots` | `array` | No | The CAR roots — avoid using this |
| `sizing` | `object` | No | Requesting sizing properties for the content |
| `version` | `integer` | No | The CAR version — avoid using this |
| `resources` | `unknown` | Yes | A mapping of path to object with a CID src and HTTP headers |
| `categories` | `array` | No | Tags categorising the tile |
| `short_name` | `string` | No | A name, in case the basic name cannot fit |
| `description` | `string` | No | Short overview of the content |
| `screenshots` | `array` | No | Screenshots, can be used for banner or card images |
| `theme_color` | `string` | No | Theme colour |
| `background_color` | `string` | No | A colour for the background of the tile |

## Raw Schema

```json
{
  "id": "ing.dasl.masl",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "cid",
          "tile",
          "createdAt"
        ],
        "properties": {
          "cid": {
            "type": "string",
            "format": "cid",
            "description": "The DRISL CID of the MASL for the tile"
          },
          "tile": {
            "ref": "ing.dasl.masl#masl",
            "type": "ref",
            "description": "The MASL content"
          },
          "createdAt": {
            "type": "string",
            "format": "datetime",
            "description": "Timestamp"
          }
        }
      },
      "description": "A tile, instantiating MASL metadata into a record"
    },
    "masl": {
      "type": "object",
      "required": [
        "name",
        "resources"
      ],
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 1000,
          "description": "The name for the tile, can be a title or app name",
          "maxGraphemes": 100
        },
        "prev": {
          "type": "cid-link",
          "description": "In case there are multiple versions of this tile, this is the CID of the previous one"
        },
        "icons": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "src"
            ],
            "properties": {
              "src": {
                "type": "string"
              },
              "sizes": {
                "type": "string"
              },
              "purpose": {
                "type": "string"
              }
            }
          },
          "description": "Icons for the tile"
        },
        "roots": {
          "type": "array",
          "items": {
            "type": "cid-link"
          },
          "description": "The CAR roots — avoid using this"
        },
        "sizing": {
          "type": "object",
          "required": [
            "width",
            "height"
          ],
          "properties": {
            "width": {
              "type": "integer",
              "mininum": 1
            },
            "height": {
              "type": "integer",
              "mininum": 1
            }
          },
          "description": "Requesting sizing properties for the content"
        },
        "version": {
          "type": "integer",
          "const": 1,
          "description": "The CAR version — avoid using this"
        },
        "resources": {
          "type": "unknown",
          "description": "A mapping of path to object with a CID src and HTTP headers"
        },
        "categories": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Tags categorising the tile"
        },
        "short_name": {
          "type": "string",
          "description": "A name, in case the basic name cannot fit"
        },
        "description": {
          "type": "string",
          "maxLength": 3000,
          "description": "Short overview of the content",
          "maxGraphemes": 300
        },
        "screenshots": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "src"
            ],
            "properties": {
              "src": {
                "type": "string"
              },
              "label": {
                "type": "string"
              },
              "sizes": {
                "type": "string"
              }
            }
          },
          "description": "Screenshots, can be used for banner or card images"
        },
        "theme_color": {
          "type": "string",
          "description": "Theme colour"
        },
        "background_color": {
          "type": "string",
          "description": "A colour for the background of the tile"
        }
      },
      "description": "MASL metadata as defined in https://dasl.ing/masl.html"
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "description": "Lexicon for DASL (https://dasl.ing/) types used on AT, notably for Web Tiles."
}
```
