Add links to profile schema (#204)

report/schemas.api.md

@@ -146,6 +146,7 @@ export type Avatar = {
     userId: string;
     name: string;
     description: string;
+    links?: Link[];
     ethAddress: EthAddress;
     version: number;
     tutorialStep: number;
@@ -937,6 +938,29 @@ export enum ItemSortBy {
 // @public
 export type JSONSchema<T> = JSONSchemaType<T>;
 
+// @alpha
+export type Link = {
+    title: string;
+    url: LinkUrl;
+};
+
+// @alpha
+export namespace Link {
+    const // (undocumented)
+    schema: JSONSchema<Link>;
+}
+
+// @alpha
+export type LinkUrl = string;
+
+// @alpha
+export namespace LinkUrl {
+    const // (undocumented)
+    schema: JSONSchema<LinkUrl>;
+    const // (undocumented)
+    validate: ValidateFunction<LinkUrl>;
+}
+
 // Warning: (ae-missing-release-tag) "ListingStatus" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 // Warning: (ae-missing-release-tag) "ListingStatus" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //

src/platform/profile/avatar.ts

@@ -109,6 +109,51 @@ export namespace AvatarInfo {
   export const validate: ValidateFunction<AvatarInfo> = generateLazyValidator(schema)
 }
 
+/**
+ * LinkUrl
+ * @alpha
+ */
+export type LinkUrl = string
+
+/**
+ * LinkUrl
+ * @alpha
+ */
+export namespace LinkUrl {
+  export const schema: JSONSchema<LinkUrl> = {
+    type: 'string',
+    pattern: '^((https?:)?\\/\\/)?([\\da-z.-]+)\\.([a-z.]{2,6})([\\/\\w.-]*)*\\/?$' // RFC-3986: Uniform Resource Identifier (URI): Generic Syntax // Parsing a URI Reference with a Regular Expression
+  }
+  const regexp = new RegExp(schema.pattern!, 'i')
+  export const validate: ValidateFunction<LinkUrl> = (url: any): url is LinkUrl => regexp.test(url)
+}
+
+/**
+ * Link
+ * @alpha
+ */
+export type Link = {
+  title: string
+  url: LinkUrl
+}
+
+/**
+ * Link
+ * @alpha
+ */
+export namespace Link {
+  export const schema: JSONSchema<Link> = {
+    type: 'object',
+    required: ['title', 'url'],
+    properties: {
+      title: {
+        type: 'string'
+      },
+      url: LinkUrl.schema
+    }
+  }
+}
+
 /**
  * Avatar represents a profile avatar. Used both for comms, internal state of the
  * explorer and the deployed profiles.
@@ -118,6 +163,7 @@ export type Avatar = {
   userId: string
   name: string
   description: string
+  links?: Link[]
   ethAddress: EthAddress
   version: number
   tutorialStep: number
@@ -152,6 +198,12 @@ export namespace Avatar {
       description: {
         type: 'string'
       },
+      links: {
+        type: 'array',
+        maxItems: 5,
+        items: Link.schema,
+        nullable: true
+      },
       ethAddress: EthAddress.schema,
       version: {
         type: 'number'

test/platform/profiles/avatar.spec.ts

@@ -29,6 +29,16 @@ export const AVATAR: Avatar = {
   name: 'Some Name',
   hasClaimedName: true,
   description: 'Some Description',
+  links: [
+    {
+      title: 'Twitter',
+      url: 'https://twitter.com/decentraland'
+    },
+    {
+      title: 'Discord',
+      url: 'https://discord.gg/decentraland'
+    }
+  ],
   ethAddress: '0x87956abC4078a0Cc3b89b419628b857B8AF826Ed',
   version: 44,
   avatar: AVATAR_INFO,