# @datamodels/identity-profile-basic

> DataModel implementation of the **Basic Profile** schema and definition specified in [CIP-19](https://github.com/ceramicnetwork/CIP/blob/main/CIPs/CIP-19/CIP-19.md).

Latest version **0.2.0** (published 2022-04-19) · (Apache-2.0 OR MIT) license · 0 weekly downloads

## Install

```sh
npm install @datamodels/identity-profile-basic
pnpm add @datamodels/identity-profile-basic
yarn add @datamodels/identity-profile-basic
bun add @datamodels/identity-profile-basic
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2022-04-19 |
| First published | 2021-08-19 |
| Weekly downloads | 0 |
| License | (Apache-2.0 OR MIT) |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=14.14 |
| Dependencies | 1 |
| Unpacked size | 12.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 89 |
| Author | 3Box Labs |
| Maintainers | paul_lecam |
| Keywords | datamodel, self.id |

## Links

- npm: https://www.npmjs.com/package/@datamodels/identity-profile-basic
- Repository: https://github.com/ceramicstudio/datamodels
- Homepage: https://github.com/ceramicstudio/datamodels#readme
- Issues: https://github.com/ceramicstudio/datamodels/issues
- npm.io page: https://npm.io/package/@datamodels/identity-profile-basic

## Dependencies (1)

- [@glazed/types](https://npm.io/package/@glazed/types.md) ^0.2.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.2.0 (latest) — 2022-04-19
- 0.2.0-rc.0 (next) — 2022-04-01
- 0.1.2 — 2021-08-19
- 0.1.1 — 2021-08-19
- 0.1.0 — 2021-08-19

## README

# Basic Profile DataModel

DataModel implementation of the **Basic Profile** schema and definition specified in [CIP-19](https://github.com/ceramicnetwork/CIP/blob/main/CIPs/CIP-19/CIP-19.md).

## Installation

```sh
npm install -D @datamodels/identity-profile-basic
```

## Rationale

The **Basic Profile** contains a DID's basic profile information.

By standardizing profile information for DIDs, the Basic Profile simplifies how applications can view and display the profiles of their users.

**A profile is one of the most important aspects to identity**: Profiles are often most associated with identity, and the Basic Profile serves as the standard profile for a DID that can be used everywhere across the web.

**DID-agnostic support:** Since Ceramic documents can be created and controlled by any DID, the Basic Profile can be used in conjunction with any DID method.

## Schemas

### [BasicProfile](./schemas/BasicProfile.json)

The Basic Profile schema defines the format of a document that contains the properties listed below. Properties not defined in the schema _cannot_ be included in the Basic Profile, however the schema can always be updated via a new CIP.

| Property           | Description                    | Value                                                                                  | Max Size | Required | Example                      |
| ------------------ | ------------------------------ | -------------------------------------------------------------------------------------- | -------- | -------- | ---------------------------- |
| `name`             | a name                         | string                                                                                 | 150 char | optional | Mary Smith                   |
| `image`            | an image                       | Image sources                                                                          |          | optional |                              |
| `description`      | a short description            | string                                                                                 | 420 char | optional | This is my cool description. |
| `emoji`            | an emoji                       | unicode                                                                                | 2 char   | optional | 🔢                           |
| `background`       | a background image (3:1 ratio) | Image sources                                                                          |          | optional |                              |
| `birthDate`        | a date of birth                | [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)                                     | 10 char  | optional | 1990-04-24                   |
| `url`              | a url                          | string                                                                                 | 240 char | optional | http://ceramic.network       |
| `gender`           | a gender                       | string                                                                                 | 42 char  | optional | female                       |
| `homeLocation`     | a place of residence           | string                                                                                 | 140 char | optional | Berlin                       |
| `residenceCountry` | a country of residence         | [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)                 | 2 char   | optional | DE                           |
| `nationalities`    | nationalities                  | array of [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) values | 2 char   | optional | CN                           |
| `affiliations`     | affiliations                   | array of strings                                                                       | 240 char | optional | Ceramic Ecosystem Alliance   |

## [Discussion](https://github.com/ceramicstudio/datamodels/discussions/10)

## License

Dual licensed under MIT and Apache 2

---
_Source: https://npm.io/package/@datamodels/identity-profile-basic · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
