blockly 12.3.0 → 12.4.0

package/.prettierignore

@@ -0,0 +1,30 @@
+# Build Artifacts
+/msg/*
+/build/*
+/dist/*
+/typings/*
+/docs/*
+
+# Tests other than mocha unit tests
+/tests/blocks/*
+/tests/themes/*
+/tests/compile/*
+/tests/jsunit/*
+/tests/generators/*
+/tests/mocha/webdriver.js
+/tests/screenshot/*
+/tests/test_runner.js
+/tests/workspace_svg/*
+
+# Demos, scripts, misc
+/node_modules/*
+/demos/*
+/appengine/*
+/externs/*
+/closure/*
+/scripts/gulpfiles/*
+CHANGELOG.md
+PULL_REQUEST_TEMPLATE.md
+
+# Don't bother formatting JavaScript files we're about to migrate:
+/generators/**/*.js

package/.prettierrc.js

@@ -0,0 +1,15 @@
+// This config attempts to match google-style code.
+
+module.exports = {
+  // Prefer single quotes, but minimize escaping.
+  singleQuote: true,
+  // Some properties must be quoted to preserve closure compiler behavior.
+  // Don't ever change whether properties are quoted.
+  quoteProps: 'preserve',
+  // Don't add spaces around braces for object literals.
+  bracketSpacing: false,
+  // Put HTML tag closing brackets on same line as last attribute.
+  bracketSameLine: true,
+  // Organise imports using a plugin.
+  'plugins': ['prettier-plugin-organize-imports'],
+};

package/api-extractor.json

@@ -0,0 +1,390 @@
+/**
+ * Config file for API Extractor.  For more info, please visit: https://api-extractor.com
+ */
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+
+  /**
+   * Optionally specifies another JSON config file that this file extends from.  This provides a way for
+   * standard settings to be shared across multiple projects.
+   *
+   * If the path starts with "./" or "../", the path is resolved relative to the folder of the file that contains
+   * the "extends" field.  Otherwise, the first path segment is interpreted as an NPM package name, and will be
+   * resolved using NodeJS require().
+   *
+   * SUPPORTED TOKENS: none
+   * DEFAULT VALUE: ""
+   */
+  // "extends": "./shared/api-extractor-base.json"
+  // "extends": "my-package/include/api-extractor-base.json"
+
+  /**
+   * Determines the "<projectFolder>" token that can be used with other config file settings.  The project folder
+   * typically contains the tsconfig.json and package.json config files, but the path is user-defined.
+   *
+   * The path is resolved relative to the folder of the config file that contains the setting.
+   *
+   * The default value for "projectFolder" is the token "<lookup>", which means the folder is determined by traversing
+   * parent folders, starting from the folder containing api-extractor.json, and stopping at the first folder
+   * that contains a tsconfig.json file.  If a tsconfig.json file cannot be found in this way, then an error
+   * will be reported.
+   *
+   * SUPPORTED TOKENS: <lookup>
+   * DEFAULT VALUE: "<lookup>"
+   */
+  // "projectFolder": "..",
+
+  /**
+   * (REQUIRED) Specifies the .d.ts file to be used as the starting point for analysis.  API Extractor
+   * analyzes the symbols exported by this module.
+   *
+   * The file extension must be ".d.ts" and not ".ts".
+   *
+   * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+   * prepend a folder token such as "<projectFolder>".
+   *
+   * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+   */
+  "mainEntryPointFilePath": "dist/index.d.ts",
+
+  /**
+   * A list of NPM package names whose exports should be treated as part of this package.
+   *
+   * For example, suppose that Webpack is used to generate a distributed bundle for the project "library1",
+   * and another NPM package "library2" is embedded in this bundle.  Some types from library2 may become part
+   * of the exported API for library1, but by default API Extractor would generate a .d.ts rollup that explicitly
+   * imports library2.  To avoid this, we can specify:
+   *
+   *   "bundledPackages": [ "library2" ],
+   *
+   * This would direct API Extractor to embed those types directly in the .d.ts rollup, as if they had been
+   * local files for library1.
+   */
+  "bundledPackages": [],
+
+  /**
+   * Determines how the TypeScript compiler engine will be invoked by API Extractor.
+   */
+  "compiler": {
+    /**
+     * Specifies the path to the tsconfig.json file to be used by API Extractor when analyzing the project.
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * Note: This setting will be ignored if "overrideTsconfig" is used.
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<projectFolder>/tsconfig.json"
+     */
+    // "tsconfigFilePath": "<projectFolder>/tsconfig.json",
+    /**
+     * Provides a compiler configuration that will be used instead of reading the tsconfig.json file from disk.
+     * The object must conform to the TypeScript tsconfig schema:
+     *
+     * http://json.schemastore.org/tsconfig
+     *
+     * If omitted, then the tsconfig.json file will be read from the "projectFolder".
+     *
+     * DEFAULT VALUE: no overrideTsconfig section
+     */
+    // "overrideTsconfig": {
+    //   . . .
+    // }
+    /**
+     * This option causes the compiler to be invoked with the --skipLibCheck option. This option is not recommended
+     * and may cause API Extractor to produce incomplete or incorrect declarations, but it may be required when
+     * dependencies contain declarations that are incompatible with the TypeScript engine that API Extractor uses
+     * for its analysis.  Where possible, the underlying issue should be fixed rather than relying on skipLibCheck.
+     *
+     * DEFAULT VALUE: false
+     */
+    // "skipLibCheck": true,
+  },
+
+  /**
+   * Configures how the API report file (*.api.md) will be generated.
+   */
+  "apiReport": {
+    /**
+     * (REQUIRED) Whether to generate an API report.
+     */
+    "enabled": false
+
+    /**
+     * The filename for the API report files.  It will be combined with "reportFolder" or "reportTempFolder" to produce
+     * a full file path.
+     *
+     * The file extension should be ".api.md", and the string should not contain a path separator such as "\" or "/".
+     *
+     * SUPPORTED TOKENS: <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<unscopedPackageName>.api.md"
+     */
+    // "reportFileName": "<unscopedPackageName>.api.md",
+
+    /**
+     * Specifies the folder where the API report file is written.  The file name portion is determined by
+     * the "reportFileName" setting.
+     *
+     * The API report file is normally tracked by Git.  Changes to it can be used to trigger a branch policy,
+     * e.g. for an API review.
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<projectFolder>/temp/"
+     */
+    // "reportFolder": "<projectFolder>/temp/",
+
+    /**
+     * Specifies the folder where the temporary report file is written.  The file name portion is determined by
+     * the "reportFileName" setting.
+     *
+     * After the temporary file is written to disk, it is compared with the file in the "reportFolder".
+     * If they are different, a production build will fail.
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<projectFolder>/temp/"
+     */
+    // "reportTempFolder": "<projectFolder>/temp/"
+  },
+
+  /**
+   * Configures how the doc model file (*.api.json) will be generated.
+   */
+  "docModel": {
+    /**
+     * (REQUIRED) Whether to generate a doc model file.
+     */
+    "enabled": true
+
+    /**
+     * The output path for the doc model file.  The file extension should be ".api.json".
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<projectFolder>/temp/<unscopedPackageName>.api.json"
+     */
+    // "apiJsonFilePath": "<projectFolder>/temp/<unscopedPackageName>.api.json"
+  },
+
+  /**
+   * Configures how the .d.ts rollup file will be generated.
+   */
+  "dtsRollup": {
+    /**
+     * (REQUIRED) Whether to generate the .d.ts rollup file.
+     */
+    "enabled": true,
+
+    /**
+     * Specifies the output path for a .d.ts rollup file to be generated without any trimming.
+     * This file will include all declarations that are exported by the main entry point.
+     *
+     * If the path is an empty string, then this file will not be written.
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<projectFolder>/dist/<unscopedPackageName>.d.ts"
+     */
+    "untrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>_rollup.d.ts"
+
+    /**
+     * Specifies the output path for a .d.ts rollup file to be generated with trimming for an "alpha" release.
+     * This file will include only declarations that are marked as "@public", "@beta", or "@alpha".
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: ""
+     */
+    // "alphaTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-alpha.d.ts",
+
+    /**
+     * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "beta" release.
+     * This file will include only declarations that are marked as "@public" or "@beta".
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: ""
+     */
+    // "betaTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-beta.d.ts",
+
+    /**
+     * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "public" release.
+     * This file will include only declarations that are marked as "@public".
+     *
+     * If the path is an empty string, then this file will not be written.
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: ""
+     */
+    // "publicTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-public.d.ts",
+
+    /**
+     * When a declaration is trimmed, by default it will be replaced by a code comment such as
+     * "Excluded from this release type: exampleMember".  Set "omitTrimmingComments" to true to remove the
+     * declaration completely.
+     *
+     * DEFAULT VALUE: false
+     */
+    // "omitTrimmingComments": true
+  },
+
+  /**
+   * Configures how the tsdoc-metadata.json file will be generated.
+   */
+  "tsdocMetadata": {
+    /**
+     * Whether to generate the tsdoc-metadata.json file.
+     *
+     * DEFAULT VALUE: true
+     */
+    // "enabled": true,
+    /**
+     * Specifies where the TSDoc metadata file should be written.
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * The default value is "<lookup>", which causes the path to be automatically inferred from the "tsdocMetadata",
+     * "typings" or "main" fields of the project's package.json.  If none of these fields are set, the lookup
+     * falls back to "tsdoc-metadata.json" in the package folder.
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     * DEFAULT VALUE: "<lookup>"
+     */
+    // "tsdocMetadataFilePath": "<projectFolder>/dist/tsdoc-metadata.json"
+  },
+
+  /**
+   * Specifies what type of newlines API Extractor should use when writing output files.  By default, the output files
+   * will be written with Windows-style newlines.  To use POSIX-style newlines, specify "lf" instead.
+   * To use the OS's default newline kind, specify "os".
+   *
+   * DEFAULT VALUE: "crlf"
+   */
+  // "newlineKind": "crlf",
+
+  /**
+   * Configures how API Extractor reports error and warning messages produced during analysis.
+   *
+   * There are three sources of messages:  compiler messages, API Extractor messages, and TSDoc messages.
+   */
+  "messages": {
+    /**
+     * Configures handling of diagnostic messages reported by the TypeScript compiler engine while analyzing
+     * the input .d.ts files.
+     *
+     * TypeScript message identifiers start with "TS" followed by an integer.  For example: "TS2551"
+     *
+     * DEFAULT VALUE:  A single "default" entry with logLevel=warning.
+     */
+    "compilerMessageReporting": {
+      /**
+       * Configures the default routing for messages that don't match an explicit rule in this table.
+       */
+      "default": {
+        /**
+         * Specifies whether the message should be written to the the tool's output log.  Note that
+         * the "addToApiReportFile" property may supersede this option.
+         *
+         * Possible values: "error", "warning", "none"
+         *
+         * Errors cause the build to fail and return a nonzero exit code.  Warnings cause a production build fail
+         * and return a nonzero exit code.  For a non-production build (e.g. when "api-extractor run" includes
+         * the "--local" option), the warning is displayed but the build will not fail.
+         *
+         * DEFAULT VALUE: "warning"
+         */
+        "logLevel": "warning"
+
+        /**
+         * When addToApiReportFile is true:  If API Extractor is configured to write an API report file (.api.md),
+         * then the message will be written inside that file; otherwise, the message is instead logged according to
+         * the "logLevel" option.
+         *
+         * DEFAULT VALUE: false
+         */
+        // "addToApiReportFile": false
+      }
+
+      // "TS2551": {
+      //   "logLevel": "warning",
+      //   "addToApiReportFile": true
+      // },
+      //
+      // . . .
+    },
+
+    /**
+     * Configures handling of messages reported by API Extractor during its analysis.
+     *
+     * API Extractor message identifiers start with "ae-".  For example: "ae-extra-release-tag"
+     *
+     * DEFAULT VALUE: See api-extractor-defaults.json for the complete table of extractorMessageReporting mappings
+     */
+    "extractorMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+        // "addToApiReportFile": false
+      },
+
+      // We don't use `@public`, that's just the default.
+      "ae-missing-release-tag": {
+        "logLevel": "none"
+      },
+
+      // Needs investigation.
+      "ae-forgotten-export": {
+        "logLevel": "none"
+      },
+
+      // We don't prefix our internal APIs with underscores.
+      "ae-internal-missing-underscore": {
+        "logLevel": "none"
+      }
+    },
+
+    /**
+     * Configures handling of messages reported by the TSDoc parser when analyzing code comments.
+     *
+     * TSDoc message identifiers start with "tsdoc-".  For example: "tsdoc-link-tag-unescaped-text"
+     *
+     * DEFAULT VALUE:  A single "default" entry with logLevel=warning.
+     */
+    "tsdocMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+        // "addToApiReportFile": false
+      },
+
+      "tsdoc-param-tag-missing-hyphen": {
+        "logLevel": "none"
+      },
+
+      // These two are due to "type-like" tags in JsDoc like
+      // `@suppress {warningName}`. The braces are unexpected in TsDoc.
+      "tsdoc-malformed-inline-tag": {
+        "logLevel": "none"
+      },
+      "tsdoc-escape-right-brace": {
+        "logLevel": "none"
+      }
+    }
+  }
+}

package/appengine/.gcloudignore

@@ -0,0 +1,20 @@
+# Do not upload these files.
+.*
+*.soy
+*.komodoproject
+deploy
+/static/appengine/
+/static/demos/plane/soy/*.jar
+/static/demos/plane/xlf/
+/static/externs/
+/static/msg/json/
+/static/scripts/
+/static/typings/
+
+/static/eslintrc.json
+/static/gulpfile.js
+/static/jsconfig.json
+/static/LICENSE
+/static/package-lock.json
+/static/package.json
+/static/README.md

package/appengine/README.txt

@@ -0,0 +1,42 @@
+
+  Running an App Engine server
+
+This directory contains the files needed to setup the optional Blockly server.
+Although Blockly itself is 100% client-side, the server enables cloud storage
+and sharing.  Store your programs in Datastore and get a unique URL that allows
+you to load the program on any computer.
+
+To run your own App Engine instance you'll need to create this directory
+structure:
+
+blockly/
+ |- app.yaml
+ |- deploy
+ |- index.yaml
+ |- main.py
+ |- README.txt
+ |- requirements.txt
+ |- storage.js
+ |- storage.py
+ `- static/
+     |- blocks/
+     |- core/
+     |- demos/
+     |- generators/
+     |- media/
+     |- msg/
+     |- tests/
+     |- blockly_compressed.js
+     |- blockly_uncompressed.js
+     |- blocks_compressed.js
+     |- dart_compressed.js
+     |- javascript_compressed.js
+     |- lua_compressed.js
+     |- php_compressed.js
+     `- python_compressed.js
+
+Go to https://appengine.google.com/ and create your App Engine application.
+Modify the 'PROJECT' name in the 'deploy' file to your App Engine application name.
+
+Finally, upload this directory structure to your App Engine account,
+then go to http://YOURAPPNAME.appspot.com/

package/appengine/add_timestamps.py

@@ -0,0 +1,69 @@
+"""Blockly Demo: Add timestamps
+
+Copyright 2020 Google LLC
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+"""A script to get all Xml entries in the datastore for Blockly demos
+and reinsert any that do not have a last_accessed time.
+
+This script should only need to be run once, but may take a long time
+to complete.
+
+NDB does not provide a way to query for all entities that are missing a
+given property, so we have to get all of them and discard any that
+already have a last_accessed time.
+
+Auth: `gcloud auth login`
+
+Set the correct project: `gcloud config set project blockly-demo`
+
+See the current project: `gcloud config get-value project`
+
+Start a venv: `python3 -m venv venv && source venv/bin/activate`
+Inside your vm run `pip install google-cloud-ndb`
+Run the script: `python3 add_timestamps.py`
+"""
+
+__author__ = "fenichel@google.com (Rachel Fenichel)"
+
+
+from google.cloud import ndb
+from storage import Xml
+import datetime
+
+PAGE_SIZE = 1000
+
+def handle_results(results):
+  for x in results:
+    if (x.last_accessed is None):
+      x.put()
+
+def run_query():
+  client = ndb.Client()
+  with client.context():
+    query = Xml.query()
+    print(f'Total entries: {query.count()}')
+    cursor = None
+    more = True
+    page_count = 0
+    result_count = 0
+    while more:
+      results, cursor, more = query.fetch_page(PAGE_SIZE, start_cursor=cursor)
+      handle_results(results)
+      page_count += 1
+      result_count += len(results)
+      print(f'{datetime.datetime.now().strftime("%I:%M:%S %p")} : page {page_count} : {result_count}')
+
+run_query()

package/appengine/app.yaml

@@ -0,0 +1,106 @@
+runtime: python312
+
+handlers:
+# Redirect obsolete URLs.
+# Blockly files moved from /blockly to /static on 5 Dec 2012.
+- url: /blockly/.*
+  static_files: redirect.html
+  upload: redirect.html
+# Code, Maze and Turtle moved from demos on 29 Dec 2012.
+- url: /static/demos/(maze|turtle)/.*
+  static_files: redirect.html
+  upload: redirect.html
+# Apps was disbanded on 20 Nov 2014.
+- url: /static/apps/.*
+  static_files: redirect.html
+  upload: redirect.html
+# Certain demos were moved on 25 Nov 2022.
+- url: /static/demos/fixed/.*
+  static_files: redirect.html
+  upload: redirect.html
+- url: /static/demos/resizable/.*
+  static_files: redirect.html
+  upload: redirect.html
+- url: /static/demos/toolbox/.*
+  static_files: redirect.html
+  upload: redirect.html
+- url: /static/demos/maxBlocks/.*
+  static_files: redirect.html
+  upload: redirect.html
+- url: /static/demos/generator/.*
+  static_files: redirect.html
+  upload: redirect.html
+- url: /static/demos/headless/.*
+  static_files: redirect.html
+  upload: redirect.html
+- url: /static/demos/interpreter/step-execution.*
+  static_files: redirect.html
+  upload: redirect.html
+- url: /static/demos/interpreter/async-execution.*
+  static_files: redirect.html
+  upload: redirect.html
+- url: /static/demos/graph/.*
+  static_files: redirect.html
+  upload: redirect.html
+- url: /static/demos/rtl/.*
+  static_files: redirect.html
+  upload: redirect.html
+- url: /static/demos/custom-dialogs/.*
+  static_files: redirect.html
+  upload: redirect.html
+- url: /static/demos/custom-fields/turtle/.*
+  static_files: redirect.html
+  upload: redirect.html
+- url: /static/demos/custom-fields/pitch/.*
+  static_files: redirect.html
+  upload: redirect.html
+- url: /static/demos/mirror/.*
+  static_files: redirect.html
+  upload: redirect.html
+- url: /static/demos/plane/.*
+  static_files: redirect.html
+  upload: redirect.html
+- url: /static/demos/keyboard_nav/.*
+  static_files: redirect.html
+  upload: redirect.html
+- url: /static/demos/custom-fields/.*
+  static_files: redirect.html
+  upload: redirect.html
+
+# Blockly files.
+- url: /static
+  static_dir: static
+  http_headers:
+    Access-Control-Allow-Origin: "*"
+  secure: always
+
+# Storage API.
+- url: /storage\.js
+  static_files: storage.js
+  upload: storage\.js
+  secure: always
+
+# Favicon.
+- url: /favicon\.ico
+  static_files: favicon.ico
+  upload: favicon\.ico
+  secure: always
+  expiration: "30d"
+
+# Apple icon.
+- url: /apple-touch-icon\.png
+  static_files: apple-touch-icon.png
+  upload: apple-touch-icon\.png
+  secure: always
+  expiration: "30d"
+
+# robot.txt
+- url: /robots\.txt
+  static_files: robots.txt
+  upload: robots\.txt
+  secure: always
+
+# Dynamic content.
+- url: /.*
+  script: auto
+  secure: always

package/appengine/blockly_compressed.js

@@ -0,0 +1,11 @@
+// Added November 2022 after discovering that a number of orgs were hot-linking
+// their Blockly applications to https://blockly-demo.appspot.com/
+// Delete this file in early 2024.
+var msg = 'Compiled Blockly files should be loaded from https://unpkg.com/blockly/\n' +
+    'For help, contact https://groups.google.com/g/blockly';
+console.log(msg);
+try {
+  alert(msg);
+} catch {
+  // Can't alert?  Probably node.js.
+}