diff --git a/README.md b/README.md index cf1e585..3bab292 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ Champions: [@styfle](https://github.com/styfle) +Author(s): [@styfle](https://github.com/styfle), Guy Bedford + Status: Stage 0. Please leave any feedback in the [issues](https://github.com/styfle/proposal-import-bytes/issues), thanks! diff --git a/package.json b/package.json index f04c47f..d9e4b30 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "private": true, "scripts": { "start": "npm run build-loose -- --watch", - "build": "npm run build-loose -- --strict", + "build": "npm run build-loose", "build-loose": "node -e 'fs.mkdirSync(\"build\", { recursive: true })' && ecmarkup --load-biblio @tc39/ecma262-biblio --verbose spec.emu build/index.html --lint-spec" }, "license": "MIT", diff --git a/spec.emu b/spec.emu index 9de3b5e..3acbc58 100644 --- a/spec.emu +++ b/spec.emu @@ -6,13 +6,13 @@ 
 title: Proposal Import Bytes
 stage: 0
-contributors: Steven
+contributors: Steven, Guy Bedford

Proposal Import Bytes

See the explainer for information.

-

This proposal is buit on top of the Import Attributes proposal.

+

This proposal is buit on top of the JSON Modules and Immutable Array Buffer proposals.

 @@ -56,9 +56,13 @@ contributors: Steven

then it must perform FinishLoadingImportedModule(_referrer_, _moduleRequest_, _payload_, _result_) with the same _result_ each time.

-
  • -

    If _moduleRequest_.[[Attributes]] has an entry _entry_ such that _entry_.[[Key]] is *"type"* and _entry_.[[Value]] is *"json"*, the host environment must perform FinishLoadingImportedModule(_referrer_, _moduleRequest_, _payload_, _result_), where _result_ is either the Completion Record returned by an invokation of ParseJSONModule or a throw completion.

    -
    • +

  • If _moduleRequest_.[[Attributes]] has an entry _entry_ such that _entry_.[[Key]] is *"type"* and _entry_.[[Value]] is *"json"*, the host environment must perform FinishLoadingImportedModule(_referrer_, _moduleRequest_, _payload_, _result_), where _result_ is either the Completion Record returned by an invokation of ParseJSONModule or a throw completion.

    • +

  • If _moduleRequest_.[[Attributes]] has an entry _entry_ such that _entry_.[[Key]] is *"type"*, then

    • +
      +

    1. Let _type_ be _entry_.[[Value]].

      2. +

    2. If _type_ is *"json"*, the host environment must perform FinishLoadingImportedModule(_referrer_, _moduleRequest_, _payload_, _result_), where _result_ is either the Completion Record returned by an invokation of ParseJSONModule or a throw completion.

      3. +

    3. If _type_ is *"buffer"*, the host environment must perform FinishLoadingImportedModule(_referrer_, _moduleRequest_, _payload_, _result_), where _result_ is either the Completion Record returned by an invokation of CreateBufferModule or a throw completion.

      4. +
  • The operation must treat _payload_ as an opaque value to be passed through to FinishLoadingImportedModule.
    • @@ -67,11 +71,11 @@ contributors: Steven

    The actual process performed is host-defined, but typically consists of performing whatever I/O operations are necessary to load the appropriate Module Record. Multiple different (_referrer_, _moduleRequest_.[[Specifer]], _moduleRequest_.[[Attributes]]) triples may map to the same Module Record instance. The actual mapping semantics is host-defined but typically a normalization process is applied to _specifier_ as part of the mapping process. A typical normalization process would include actions such as expansion of relative and abbreviated path specifiers.

    -

    The above text implies that hosts *must* support JSON modules imported with `type: "json"` (if it completes normally), but it doesn't prohibit hosts from supporting JSON modules imported with no type specified. Some environments (for example, web browsers) plan to require `with { type: "json" }`, and environments which want to restrict themselves to a compatible subset would do so as well.

    +

    The above text implies that hosts *must* support JSON modules and buffer modules imported with `type: "json"` and `type: "buffer"` respectively (if it completes normally), but it doesn't prohibit hosts from supporting JSON modules imported with no type specified. Some environments (for example, web browsers) plan to require `with { type: "json" }`, and environments which want to restrict themselves to a compatible subset would do so as well.

     -

    All of the import statements in the module graph that address the same JSON module may evaluate to the same mutable object.

    +

    All of the import statements in the module graph that address the same JSON or buffer module may evaluate to the same mutable object.

     @@ -80,7 +84,7 @@ contributors: Steven

    A Synthetic Module Record is used to represent information about a module that is defined by specifications. Its exports are derived from a pair of lists, of string keys and of ECMAScript values. The set of exported names is static, and determined at creation time (as an argument to CreateSyntheticModule), while the set of exported values can be changed over time using SetSyntheticModuleExport. It has no imports or dependencies.

    - A Synthetic Module Record could be used for defining a variety of module types: for example, built-in modules, or JSON modules, or CSS modules. + A Synthetic Module Record could be used for defining a variety of module types: for example, built-in modules, or JSON modules, or buffer modules, or CSS modules.

    In addition to the fields defined in Synthetic Module Records have the additional fields listed in . Each of these fields is initially set in CreateSyntheticModule.

    @@ -106,172 +110,13 @@ contributors: Steven - -

    - CreateSyntheticModule ( - _exportNames_: a List of Strings without duplicates, - _evaluationSteps_: an Abstract Closure, - _realm_: a Realm Record, - ): a Synthetic Module Record -

    -
    -
    description
    -
    It creates a Synthetic Module Record based upon the given exported names and evaluation steps.
    -
    - - - 1. Return Synthetic Module Record { [[Realm]]: _realm_, [[Environment]]: ~empty~, [[Namespace]]: ~empty~, [[HostDefined]]: ~empty~, [[ExportNames]]: _exportNames_, [[EvaluationSteps]]: _evaluationSteps_ }. - - - It seems we could set up the environment either here or in Link(). I've chosen to do so in Link() for symmetry with Cyclic Module Records (and thus Source Text Module Records), but I don't think there's any actual requirement in that regard. -     - - +

    - SetSyntheticModuleExport ( - _module_: a Synthetic Module Record, - _exportName_: a String, - _exportValue_: an ECMAScript Language value - ): ~unused~ -

    -
    -
    description
    -
    It can be used to set or change the exported value for a pre-established export of a Synthetic Module Record.
    -
    - - - 1. Let _envRec_ be _module_.[[Environment]]. - 1. Assert: _envRec_ is not ~empty~. - 1. Perform _envRec_.SetMutableBinding(_exportName_, _exportValue_, *true*). - 1. Return ~unused~. - -     - - -

    Concrete Methods

    - -

    The following are the concrete methods for Synthetic Module Record that implement the corresponding Module Record abstract methods.

    - - I find having this wrapping sub-clause cleaner and suggest we do the same for Source Text Module Records in the main spec. - - -

    - LoadRequestedModules (): a Promise -

    -
    -
    for
    -
    a Synthetic Module Record _module_
    -
    - - - 1. Return ! PromiseResolve(%Promise%, *undefined*). - - - - Synthetic Module Records have no dependencies. - -     - - -

    - GetExportedNames (): a List of Strings -

    -
    -
    for
    -
    a Synthetic Module Record _module_
    -
    - - - 1. Return _module_.[[ExportNames]]. - -     - - -

    - ResolveExport( - _exportName_: a String, - ): a ResolvedBinding Record or *null* -

    -
    -
    for
    -
    a Synthetic Module Record _module_
    -
    - - - 1. If _module_.[[ExportNames]] does not contain _exportName_, return *null*. - 1. Return ResolvedBinding Record { [[Module]]: _module_, [[BindingName]]: _exportName_ }. - -     - - -

    Link ( ): ~unused~

    -
    -
    for
    -
    a Synthetic Module Record _module_
    -
    - - - 1. Let _realm_ be _module_.[[Realm]]. - 1. Let _env_ be NewModuleEnvironment(_realm_.[[GlobalEnv]]). - 1. Set _module_.[[Environment]] to _env_. - 1. For each String _exportName_ in _module_.[[ExportNames]], do - 1. Perform ! _env_.CreateMutableBinding(_exportName_, *false*). - 1. Perform ! _env_.InitializeBinding(_exportName_, *undefined*). - 1. Return ~unused~. - -     - - -

    Evaluate ( ): a Promise

    -
    -
    for
    -
    a Synthetic Module Record _module_
    -
    - - - 1. Let _moduleContext_ be a new ECMAScript code execution context. - 1. Set the Function of _moduleContext_ to *null*. - 1. Set the Realm of _moduleContext_ to _module_.[[Realm]]. - 1. Set the ScriptOrModule of _moduleContext_ to _module_. - 1. Set the VariableEnvironment of _moduleContext_ to _module_.[[Environment]]. - 1. Set the LexicalEnvironment of _moduleContext_ to _module_.[[Environment]]. - 1. Suspend the currently running execution context. - 1. Push _moduleContext_ on to the execution context stack; _moduleContext_ is now the running execution context. - 1. Let _steps_ be _module_.[[EvaluationSteps]]. - 1. Let _result_ be Completion(_steps_(_module_)). - 1. Suspend _moduleContext_ and remove it from the execution context stack. - 1. Resume the context that is now on the top of the execution context stack as the running execution context. - 1. Let _pc_ be ! NewPromiseCapability(%Promise%). - 1. IfAbruptRejectPromise(_result_, _pc_). - 1. Perform ! _pc_.[[Resolve]](_result_). - 1. Return _pc_.[[Promise]]. - -     -     - - -

    - CreateDefaultExportSyntheticModule ( - _defaultExport_: an ECMAScript Language value, - ): a Synthetic Module Record -

    -
    -
    description
    -
    It creates a Synthetic Module Record whose default export is _defaultExport_.
    -
    - - 1. Let _realm_ be the current Realm Record. - 1. Let _setDefaultExport_ be a new Abstract Closure with parameters (_module_) that captures _defaultExport_ and performs the following steps when called: - 1. Perform SetSyntheticModuleExport(_module_, *"default"*, _defaultExport_). - 1. Return CreateSyntheticModule(« *"default"* », _setDefaultExport_, _realm_). - -     - - -

    - ParseJSONModule ( - _source_: a String - ): either a normal completion containing a Synthetic Module Record, or a throw completion + + CreateBufferModule ( + _arrayBuffer_: an immutable ArrayBuffer or a SharedArrayBuffer + ): a Synthetic Module Record +

    description
    @@ -279,13 +124,9 @@ contributors: Steven
    - 1. Let _json_ be ? Call(%JSON.parse%, *undefined*, « _source_ »). - 1. Return CreateDefaultExportSyntheticModule(_json_). + 1. Assert: IsImmutableBuffer(_arrayBuffer_) is *true*. + 1. Return CreateDefaultExportSyntheticModule(_arrayBuffer_). - - - TODO: Refactor JSONParse into an abstract algorithm. -     - \ No newline at end of file +