Add behavior and object headers to the registry (#930)

Author: D8H

extensions/views.json

@@ -1,5 +1,9 @@
 {
   "default": {
-    "firstExtensionIds": ["Health", "FireBullet", "Gamepads"]
+    "firstExtensionIds": ["Health", "FireBullet", "Gamepads"],
+    "firstBehaviorIds": [
+      { "extensionName": "Health", "behaviorName": "Health" },
+      { "extensionName": "FireBullet", "behaviorName": "FireBullet" }
+    ]
   }
 }

scripts/generate-extensions-registry.js

@@ -8,6 +8,9 @@ const {
 const args = require('minimist')(process.argv.slice(2));
 
 /** @typedef {import('./types').ExtensionShortHeader} ExtensionShortHeader */
+/** @typedef {import('./types').BehaviorShortHeader} BehaviorShortHeader */
+/** @typedef {import('./types').ObjectShortHeader} ObjectShortHeader */
+/** @typedef {import('./types').RegistryItem} RegistryItem */
 /** @typedef {import('./types').ExtensionsDatabase} ExtensionsDatabase */
 /** @typedef {import('./types').ExtensionHeader} ExtensionHeader */
 /** @typedef {import('./types').ExtensionWithFileInfo} ExtensionWithFileInfo */
@@ -99,6 +102,10 @@ const readExtensionsFromFolder = async (folderPath, tier) => {
 
     /** @type {ExtensionShortHeader[]} */
     const extensionShortHeaders = [];
+    /** @type {Array<BehaviorShortHeader>} */
+    const behaviorShortHeaders = [];
+    /** @type {Array<ObjectShortHeader>} */
+    const objectShortHeaders = [];
 
     let totalErrors = 0;
     let fixableErrors = 0;
@@ -159,11 +166,10 @@ const readExtensionsFromFolder = async (folderPath, tier) => {
         }
 
         // Generate the headers of the extension
-        /** @type {ExtensionShortHeader} */
-        const extensionShortHeader = {
+        /** @type {RegistryItem} */
+        const registryItem = {
           tier,
           authorIds: extension.authorIds,
-          shortDescription: extension.shortDescription,
           extensionNamespace: extension.extensionNamespace,
           fullName: extension.fullName,
           name,
@@ -174,6 +180,13 @@ const readExtensionsFromFolder = async (folderPath, tier) => {
           tags: extension.tags,
           category: extension.category || 'General',
           previewIconUrl: extension.previewIconUrl,
+        };
+        /** @type {ExtensionShortHeader} */
+        const extensionShortHeader = {
+          ...registryItem,
+          shortDescription: extension.shortDescription,
+          fullName: extension.fullName,
+          name,
           eventsBasedBehaviorsCount: extension.eventsBasedBehaviors.length,
           eventsFunctionsCount: extension.eventsFunctions.length,
         };
@@ -190,7 +203,40 @@ const readExtensionsFromFolder = async (folderPath, tier) => {
           iconUrl: extension.iconUrl,
         };
 
-        extension.tags.split(',').map(
+        /** @type {Array<BehaviorShortHeader>} */
+        behaviorShortHeaders.push.apply(
+          behaviorShortHeaders,
+          extension.eventsBasedBehaviors
+            .map((behavior) =>
+              behavior.private
+                ? null
+                : {
+                    ...registryItem,
+                    extensionName: name,
+                    name: behavior.name,
+                    fullName: behavior.fullName,
+                    description: behavior.description,
+                    objectType: behavior.objectType,
+                  }
+            )
+            .filter(Boolean)
+        );
+
+        /** @type {Array<ObjectShortHeader>} */
+        objectShortHeaders.push.apply(
+          objectShortHeaders,
+          extension.eventsBasedObjects
+            ? extension.eventsBasedObjects.map((object) => ({
+                ...registryItem,
+                extensionName: name,
+                name: object.name,
+                fullName: object.fullName,
+                description: object.description,
+              }))
+            : []
+        );
+
+        extension.tags.split(',').forEach(
           /** @param {string} tag */
           (tag) => {
             allTagsSet.add(tag.trim().toLowerCase());
@@ -240,6 +286,12 @@ const readExtensionsFromFolder = async (folderPath, tier) => {
       allTags: Array.from(allTagsSet),
       allCategories: Array.from(allCategoriesSet),
       extensionShortHeaders,
+      behavior: {
+        headers: behaviorShortHeaders,
+      },
+      object: {
+        headers: objectShortHeaders,
+      },
       views,
     };
 

scripts/lib.es5.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Fixes https://github.com/microsoft/TypeScript/issues/16655 for `Array.prototype.filter()`
+ * For example, using the fix the type of `bar` is `string[]` in the below snippet as it should be.
+ *
+ *  const foo: (string | null | undefined)[] = [];
+ *  const bar = foo.filter(Boolean);
+ *
+ * For related definitions, see https://github.com/microsoft/TypeScript/blob/master/src/lib/es5.d.ts
+ *
+ * Original licenses apply, see
+ *  - https://github.com/microsoft/TypeScript/blob/master/LICENSE.txt
+ *  - https://stackoverflow.com/help/licensing
+ */
+
+/** See https://stackoverflow.com/a/51390763/1470607  */
+type Falsy = false | 0 | '' | null | undefined;
+
+interface Array<T> {
+  /**
+   * Returns the elements of an array that meet the condition specified in a callback function.
+   * @param predicate A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
+   * @param thisArg An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
+   */
+  filter<S extends T>(
+    predicate: BooleanConstructor,
+    thisArg?: any
+  ): Exclude<S, Falsy>[];
+}

scripts/types.d.ts

@@ -1,41 +1,89 @@
-interface ExtensionAndShortHeaderFields {
+interface ItemExtensionHeaderFields {
   authorIds: Array<string>;
-  shortDescription: string;
   extensionNamespace: string;
-  fullName: string;
-  name: string;
   version: string;
   gdevelopVersion?: string;
   tags: Array<string>;
   category: string;
   previewIconUrl: string;
 }
 
+type ExtensionTier = 'community' | 'reviewed';
+
+/**
+ * An extension, behavior or object.
+ */
+export interface RegistryItem extends ItemExtensionHeaderFields {
+  tier: ExtensionTier;
+  url: string;
+  headerUrl: string;
+}
+
+interface ExtensionAndShortHeaderFields extends ItemExtensionHeaderFields {
+  shortDescription: string;
+  fullName: string;
+  name: string;
+}
+
 interface ExtensionAndHeaderFields {
   description: string;
   helpPath: string;
   iconUrl: string;
 }
 
-type ExtensionTier = 'community' | 'reviewed';
-
-export interface ExtensionShortHeader extends ExtensionAndShortHeaderFields {
+export interface ExtensionShortHeader
+  extends RegistryItem,
+    ExtensionAndShortHeaderFields {
   tier: ExtensionTier;
   url: string;
   headerUrl: string;
   eventsBasedBehaviorsCount: number;
   eventsFunctionsCount: number;
 }
 
+interface BehaviorAndShortHeaderFields {
+  description: string;
+  fullName: string;
+  name: string;
+  objectType: string;
+}
+
+export interface BehaviorShortHeader
+  extends RegistryItem,
+    BehaviorAndShortHeaderFields {
+  extensionName: string;
+}
+
+interface ObjectAndShortHeaderFields {
+  description: string;
+  fullName: string;
+  name: string;
+}
+
+export interface ObjectShortHeader
+  extends RegistryItem,
+    ObjectAndShortHeaderFields {
+  extensionName: string;
+}
+
 export interface ExtensionHeader
   extends ExtensionShortHeader,
     ExtensionAndHeaderFields {}
 
 export interface ExtensionsDatabase {
   version: string;
+  /** @deprecated Tags list should be built by the UI. When only reviewed
+   * extensions are shown, some tags could lead to no extension. */
   allTags: Array<string>;
+  /** @deprecated Categories list should be built by the UI. */
   allCategories: Array<string>;
   extensionShortHeaders: Array<ExtensionShortHeader>;
+  behavior: {
+    headers: Array<BehaviorShortHeader>;
+  };
+  object: {
+    headers: Array<ObjectShortHeader>;
+  };
   views: {
     default: {
       firstExtensionIds: Array<string>;
@@ -95,6 +143,7 @@ export interface EventsBasedBehaviors {
   fullName: string;
   name: string;
   objectType: string;
+  private?: boolean;
   eventsFunctions: EventsFunction[];
 }
 

tsconfig.json

@@ -29,5 +29,5 @@
     "skipLibCheck": true,
     "forceConsistentCasingInFileNames": true
   },
-  "include": ["scripts", "__tests__"]
+  "include": ["scripts", "__tests__", "lib.es5.d.ts"]
 }