@astronautlabs/emoji 17.0.0 → 17.1.0

package/dist/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["../src/emoji-decorator.ts","../src/emoji.generated.ts","../src/index.ts","../src/types.ts","../src/scripts/generate-preview.ts","../src/scripts/generate.ts","../src/scripts/utils.ts"],"version":"5.9.3"}
+{"root":["../src/emoji-decorator.ts","../src/emoji.generated.ts","../src/index.ts","../src/types.ts","../src/scripts/generate-preview.ts","../src/scripts/generate.ts","../src/scripts/utils.ts","../src/scripts/data/data-utils.ts","../src/scripts/data/fixup-diversity-fields.ts","../src/scripts/data/fixup-emoji-strings.ts","../src/scripts/data/fixup-exclude-from-picker-props.ts","../src/scripts/data/fixup-keywords.ts","../src/scripts/data/fixup-types.ts","../src/scripts/data/fixup-unicode-strings.ts","../src/scripts/data/shortcuts.ts"],"version":"5.9.3"}

package/dist/types.d.ts

@@ -12,13 +12,14 @@ export interface EmojiCategory {
  * - variant: Characters that may be followed by U+fe0f (VS16, request color emoji presentation)
  *   but cannot be followed by U+fe0e (VS15, request monochrome non-emoji presentation)
  * - diversity: The emoji supports skintone variation. Typically this is <unicode> <zwj> <skintone-modifier>,
- *   but multi_diversity_base_same can be present to specify a different sequence (where "skintone" can be any
+ *   but multiDiversityBaseSame can be present to specify a different sequence (where "skintone" can be any
  *   skintone modifier)
  * - variant,diversity: Character has the variant and diversity properties
  * - text-default: Must be followd by VS16 (request emoji presentation) to be emojis. The bare character
  *   is text by default.
  * - multi-diversity: Emoji can be variated by two (or more) skintones. For these, consult
- *   multi_diversity_base_different to construct diverse variations.
+ *   multiDiversityBaseDifferent to construct diverse variations. Typically multiDiversityBaseSame will also
+ *   be available for setting a single skintone for both values (which is more space efficient).
  * - directional,diversity: Emoji supports a single skintone modifier and the glyph direction can be changed using
  *   <character> <zwj> <left/right arrow>. See Unicode TR-51 section 2.10 for more information.
  */
@@ -33,17 +34,26 @@ export interface Emoji {
      */
     unicode: number[];
     /**
-     * A short textual description
+     * The Unicode codepoints as a dash-separated string (X-Y-Z).
      */
-    description: string;
+    unicodeString: string;
     /**
-     * A list of descriptive keywords
+     * A short keyword that can be used as a :shortcut: for this emoji.
+     * Not all emoji have these.
      */
-    keywords: string[];
+    shortcut?: string;
+    /**
+     * A short textual description. Not all emoji have this
+     */
+    description?: string;
+    /**
+     * A list of descriptive keywords. Not all emoji have these.
+     */
+    keywords?: string[];
     /**
      * Whether its recommended to exclude this emoji from the emoji picker.
      */
-    excludeFromPicker: boolean;
+    excludeFromPicker?: boolean;
     /**
      * The type of this emoji. See EmojiType for details.
      */
@@ -58,7 +68,7 @@ export interface Emoji {
      * emoji. Replace the "skintone" components with Fitzpatrick skin tone modifiers.
      */
     multiDiversityBaseDifferent?: string;
-    multiDiversityBaseDifferentIsSorted: boolean;
+    multiDiversityBaseDifferentIsSorted?: boolean;
 }
 export type EmojiImageResolver = (iconId: string, options: any, variant?: string) => string;
 export type EmojiParserAttributesCallback = (rawText: string, iconId: string) => Record<string, string>;