ember-source 5.6.0-beta.2 → 5.7.0-alpha.2

package/dist/header/license.js

@@ -5,5 +5,5 @@
  *            Portions Copyright 2008-2011 Apple Inc. All rights reserved.
  * @license   Licensed under MIT license
  *            See https://raw.github.com/emberjs/ember.js/master/LICENSE
- * @version   5.6.0-beta.2
+ * @version   5.7.0-alpha.2
  */

package/dist/packages/@ember/-internals/glimmer/index.js

@@ -1291,7 +1291,7 @@ var __decorate = undefined && undefined.__decorate || function (decorators, targ
   @public
 */
 /**
-  See Ember.Templates.components.Textarea.
+  See [Ember.Templates.components.Textarea](/ember/release/classes/Ember.Templates.components/methods/Textarea?anchor=Textarea)
 
   @method textarea
   @for Ember.Templates.helpers
@@ -1302,7 +1302,7 @@ var __decorate = undefined && undefined.__decorate || function (decorators, targ
   An opaque interface which can be imported and used in strict-mode
   templates to call <Textarea>.
 
-  See [Ember.Templates.components.Textarea](/ember/release/classes/Ember.Templates.components/methods/Textarea?anchor=Input).
+  See [Ember.Templates.components.Textarea](/ember/release/classes/Ember.Templates.components/methods/Textarea?anchor=Textarea).
 
   @for @ember/component
   @method Textarea

package/dist/packages/@ember/component/index.js

@@ -1,3 +1,124 @@
+/**
+  @module @ember/component
+  @public
+ */
 export { setComponentTemplate, getComponentTemplate } from '@glimmer/manager';
 export { Component as default, Input, Textarea } from '@ember/-internals/glimmer';
-export { componentCapabilities as capabilities, setComponentManager } from '@ember/-internals/glimmer';
+export { componentCapabilities as capabilities, setComponentManager } from '@ember/-internals/glimmer';
+/**
+ * Assigns a TemplateFactory to a component class.
+ *
+ * @method setComponentTemplate
+ * @static
+ * @for @ember/component
+ * @public
+ *
+ * ```js
+ * import Component from '@glimmer/component';
+ * import { hbs } from 'ember-cli-htmlbars';
+ * import { setComponentTemplate } from '@ember/component';
+ *
+ * export default class Demo extends Component {
+ *   // ...
+ * }
+ *
+ * setComponentTemplate(hbs`
+ *  <div>my template</div>
+ * `, Demo);
+ * ```
+ *
+ * @param {TemplateFactory} templateFactory
+ * @param {object} componentDefinition
+ */
+/**
+ * Returns the TemplateFactory associated with a component
+ *
+ * @method getComponentTemplate
+ * @static
+ * @for @ember/component
+ * @public
+ *
+ * ```js
+ * import Component from '@glimmer/component';
+ * import { hbs } from 'ember-cli-htmlbars';
+ * import { getComponentTemplate } from '@ember/component';
+ *
+ * export default class Demo extends Component {
+ *   // ...
+ * }
+ *
+ * let theTemplateFactory = getTemplateFactory(Demo)
+ * ```
+ *
+ * @param {object} componentDefinition
+ * @returns {TemplateFactory}
+ */
+/**
+ * Tell the VM how manage a type of object / class when encountered
+ * via component-invocation.
+ *
+ * A Component Manager, must implement this interface:
+ * - static create()
+ * - createComponent()
+ * - updateComponent()
+ * - destroyComponent()
+ * - getContext()
+ *
+ * @method setComponentManager
+ * @static
+ * @for @ember/component
+ * @public
+ *
+ *
+ * After a component manager is registered via `setComponentManager`,
+ *
+ * ```js
+ * import { StateNode } from 'xstate';
+ * import ComponentManager from './-private/statechart-manager';
+ *
+ * setComponentManager((owner) => ComponentManager.create(owner), StateNode.prototype);
+ * ```
+ *
+ * Instances of the class can be used as component.
+ * No need to extend from `@glimmer/component`.
+ *
+ * ```js
+ * // app/components/my-component.js
+ * import { createMachine } from 'xstate';
+ *
+ * export default createMachine({ ... });
+ * ```
+ * ```hbs
+ * {{!-- app/templates/application.hbs}}
+ * <MyComponent />
+ * ```
+ *
+ * @param {(owner: Owner) => import('@glimmer/interfaces').ComponentManager} managerFactory
+ * @param {object} object that will be managed by the return value of `managerFactory`
+ *
+ */
+/**
+ * Tells Glimmer what capabilities a Component Manager will have
+ *
+ * ```js
+ * import { capabilities } from '@ember/component';
+ *
+ * export class MyComponentManager {
+ *   capabilities = capabilities('3.13', {
+ *     // capabilities listed here
+ *   })
+ * }
+ * ```
+ *
+ *
+ * For a full list of capabilities, their defaults, and how they are used, see [@glimmer/manager](https://github.com/glimmerjs/glimmer-vm/blob/4f1bef0d9a8a3c3ebd934c5b6e09de4c5f6e4468/packages/%40glimmer/manager/lib/public/component.ts#L26)
+ *
+ *
+ * @method capabilities
+ * @static
+ * @for @ember/component
+ * @public
+ * @param {'3.13'} managerApiVersion
+ * @param {Parameters<import('@ember/-internals/glimmer').componentCapabilities>[1]} options
+ *
+ */

package/dist/packages/ember/version.js

@@ -1 +1 @@
-export default "5.6.0-beta.2";
+export default "5.7.0-alpha.2";

package/docs/data.json

@@ -3,7 +3,7 @@
     "name": "The Ember API",
     "description": "The Ember API: a framework for building ambitious web applications",
     "url": "https://emberjs.com/",
-    "version": "5.6.0-beta.2"
+    "version": "5.7.0-alpha.2"
   },
   "files": {
     "node_modules/rsvp/lib/rsvp/promise/all.js": {
@@ -1050,6 +1050,15 @@
       "fors": {},
       "namespaces": {}
     },
+    "packages/@ember/component/index.ts": {
+      "name": "packages/@ember/component/index.ts",
+      "modules": {},
+      "classes": {},
+      "fors": {
+        "@ember/component": 1
+      },
+      "namespaces": {}
+    },
     "packages/@ember/component/template-only.ts": {
       "name": "packages/@ember/component/template-only.ts",
       "modules": {
@@ -1793,7 +1802,9 @@
       "file": "packages/@ember/-internals/glimmer/lib/helper.ts",
       "line": 53,
       "description": "[Glimmer](https://github.com/tildeio/glimmer) is a templating engine used by Ember.js that is compatible with a subset of the [Handlebars](http://handlebarsjs.com/) syntax.\n\n### Showing a property\n\nTemplates manage the flow of an application's UI, and display state (through\nthe DOM) to a user. For example, given a component with the property \"name\",\nthat component's template can use the name in several ways:\n\n```app/components/person-profile.js\nimport Component from '@ember/component';\n\nexport default Component.extend({\n  name: 'Jill'\n});\n```\n\n```app/components/person-profile.hbs\n{{this.name}}\n<div>{{this.name}}</div>\n<span data-name={{this.name}}></span>\n```\n\nAny time the \"name\" property on the component changes, the DOM will be\nupdated.\n\nProperties can be chained as well:\n\n```handlebars\n{{@aUserModel.name}}\n<div>{{@listOfUsers.firstObject.name}}</div>\n```\n\n### Using Ember helpers\n\nWhen content is passed in mustaches `{{}}`, Ember will first try to find a helper\nor component with that name. For example, the `if` helper:\n\n```app/components/person-profile.hbs\n{{if this.name \"I have a name\" \"I have no name\"}}\n<span data-has-name={{if this.name true}}></span>\n```\n\nThe returned value is placed where the `{{}}` is called. The above style is\ncalled \"inline\". A second style of helper usage is called \"block\". For example:\n\n```handlebars\n{{#if this.name}}\n  I have a name\n{{else}}\n  I have no name\n{{/if}}\n```\n\nThe block form of helpers allows you to control how the UI is created based\non the values of properties.\nA third form of helper is called \"nested\". For example here the concat\nhelper will add \" Doe\" to a displayed name if the person has no last name:\n\n```handlebars\n<span data-name={{concat this.firstName (\n  if this.lastName (concat \" \" this.lastName) \"Doe\"\n)}}></span>\n```\n\nEmber's built-in helpers are described under the [Ember.Templates.helpers](/ember/release/classes/Ember.Templates.helpers)\nnamespace. Documentation on creating custom helpers can be found under\n[helper](/ember/release/functions/@ember%2Fcomponent%2Fhelper/helper) (or\nunder [Helper](/ember/release/classes/Helper) if a helper requires access to\ndependency injection).\n\n### Invoking a Component\n\nEmber components represent state to the UI of an application. Further\nreading on components can be found under [Component](/ember/release/classes/Component).",
-      "itemtype": "main"
+      "itemtype": "main",
+      "access": "public",
+      "tagname": ""
     },
     "@ember/routing": {
       "name": "@ember/routing",
@@ -5649,7 +5660,7 @@
     {
       "file": "packages/@ember/-internals/glimmer/lib/components/textarea.ts",
       "line": 123,
-      "description": "See Ember.Templates.components.Textarea.",
+      "description": "See [Ember.Templates.components.Textarea](/ember/release/classes/Ember.Templates.components/methods/Textarea?anchor=Textarea)",
       "itemtype": "method",
       "name": "textarea",
       "see": [
@@ -5663,7 +5674,7 @@
     {
       "file": "packages/@ember/-internals/glimmer/lib/components/textarea.ts",
       "line": 132,
-      "description": "An opaque interface which can be imported and used in strict-mode\ntemplates to call <Textarea>.\n\nSee [Ember.Templates.components.Textarea](/ember/release/classes/Ember.Templates.components/methods/Textarea?anchor=Input).",
+      "description": "An opaque interface which can be imported and used in strict-mode\ntemplates to call <Textarea>.\n\nSee [Ember.Templates.components.Textarea](/ember/release/classes/Ember.Templates.components/methods/Textarea?anchor=Textarea).",
       "itemtype": "method",
       "name": "Textarea",
       "see": [
@@ -11346,6 +11357,101 @@
       "class": "FEATURES",
       "module": "@ember/canary-features"
     },
+    {
+      "file": "packages/@ember/component/index.ts",
+      "line": 14,
+      "description": "Assigns a TemplateFactory to a component class.",
+      "itemtype": "method",
+      "name": "setComponentTemplate",
+      "static": 1,
+      "access": "public",
+      "tagname": "```js\nimport Component from '---AT-PLACEHOLDER---glimmer/component';\nimport { hbs } from 'ember-cli-htmlbars';\nimport { setComponentTemplate } from '---AT-PLACEHOLDER---ember/component';\n\nexport default class Demo extends Component {\n  // ...\n}\n\nsetComponentTemplate(hbs`\n <div>my template</div>\n`, Demo);\n```",
+      "params": [
+        {
+          "name": "templateFactory",
+          "description": "",
+          "type": "TemplateFactory"
+        },
+        {
+          "name": "componentDefinition",
+          "description": "",
+          "type": "Object"
+        }
+      ],
+      "class": "@ember/component",
+      "module": "@ember/component"
+    },
+    {
+      "file": "packages/@ember/component/index.ts",
+      "line": 40,
+      "description": "Returns the TemplateFactory associated with a component",
+      "itemtype": "method",
+      "name": "getComponentTemplate",
+      "static": 1,
+      "access": "public",
+      "tagname": "```js\nimport Component from '---AT-PLACEHOLDER---glimmer/component';\nimport { hbs } from 'ember-cli-htmlbars';\nimport { getComponentTemplate } from '---AT-PLACEHOLDER---ember/component';\n\nexport default class Demo extends Component {\n  // ...\n}\n\nlet theTemplateFactory = getTemplateFactory(Demo)\n```",
+      "params": [
+        {
+          "name": "componentDefinition",
+          "description": "",
+          "type": "Object"
+        }
+      ],
+      "return": {
+        "description": "",
+        "type": "TemplateFactory"
+      },
+      "class": "@ember/component",
+      "module": "@ember/component"
+    },
+    {
+      "file": "packages/@ember/component/index.ts",
+      "line": 64,
+      "description": "Tell the VM how manage a type of object / class when encountered\nvia component-invocation.\n\nA Component Manager, must implement this interface:\n- static create()\n- createComponent()\n- updateComponent()\n- destroyComponent()\n- getContext()",
+      "itemtype": "method",
+      "name": "setComponentManager",
+      "static": 1,
+      "access": "public",
+      "tagname": "After a component manager is registered via `setComponentManager`,\n\n```js\nimport { StateNode } from 'xstate';\nimport ComponentManager from './-private/statechart-manager';\n\nsetComponentManager((owner) => ComponentManager.create(owner), StateNode.prototype);\n```\n\nInstances of the class can be used as component.\nNo need to extend from `@glimmer/component`.\n\n```js\n// app/components/my-component.js\nimport { createMachine } from 'xstate';\n\nexport default createMachine({ ... });\n```\n```hbs\n{{!-- app/templates/application.hbs}}\n<MyComponent />\n```",
+      "params": [
+        {
+          "name": "managerFactory",
+          "description": "",
+          "type": "(owner: Owner) => import('@glimmer/interfaces').ComponentManager"
+        },
+        {
+          "name": "object",
+          "description": "that will be managed by the return value of `managerFactory`",
+          "type": "Object"
+        }
+      ],
+      "class": "@ember/component",
+      "module": "@ember/component"
+    },
+    {
+      "file": "packages/@ember/component/index.ts",
+      "line": 109,
+      "description": "Tells Glimmer what capabilities a Component Manager will have\n\n```js\nimport { capabilities } from '@ember/component';\n\nexport class MyComponentManager {\n  capabilities = capabilities('3.13', {\n    // capabilities listed here\n  })\n}\n```\n\n\nFor a full list of capabilities, their defaults, and how they are used, see [@glimmer/manager](https://github.com/glimmerjs/glimmer-vm/blob/4f1bef0d9a8a3c3ebd934c5b6e09de4c5f6e4468/packages/%40glimmer/manager/lib/public/component.ts#L26)",
+      "itemtype": "method",
+      "name": "capabilities",
+      "static": 1,
+      "access": "public",
+      "tagname": "",
+      "params": [
+        {
+          "name": "managerApiVersion",
+          "description": "",
+          "type": "'3.13'"
+        },
+        {
+          "name": "options",
+          "description": "",
+          "type": "Parameters<import('@ember/-internals/glimmer').componentCapabilities>[1]"
+        }
+      ],
+      "class": "@ember/component",
+      "module": "@ember/component"
+    },
     {
       "file": "packages/@ember/component/template-only.ts",
       "line": 6,
@@ -19070,6 +19176,10 @@
       "message": "replacing incorrect tag: function with method",
       "line": " packages/@ember/-internals/utils/lib/spec.ts:1"
     },
+    {
+      "message": "replacing incorrect tag: returns with return",
+      "line": " packages/@ember/component/index.ts:40"
+    },
     {
       "message": "replacing incorrect tag: returns with return",
       "line": " packages/@ember/destroyable/index.ts:31"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ember-source",
-  "version": "5.6.0-beta.2",
+  "version": "5.7.0-alpha.2",
   "description": "A JavaScript framework for creating ambitious web applications",
   "keywords": [
     "ember-addon"
@@ -38,6 +38,7 @@
     "build": "npm-run-all build:*",
     "docs": "ember ember-cli-yuidoc",
     "start": "ember serve",
+    "link:glimmer-vm": "node bin/link-glimmer-vm-packages.mjs",
     "lint": "npm-run-all --continue-on-error --aggregate-output --parallel \"lint:!(fix)\"",
     "lint:docs": "qunit tests/docs/coverage-test.js",
     "lint:eslint": "eslint --report-unused-disable-directives --cache .",
@@ -51,7 +52,8 @@
     "test:browserstack": "node bin/run-browserstack-tests.js",
     "type-check:internals": "tsc --noEmit",
     "type-check:types": "pnpm build:types && tsc --noEmit --project type-tests",
-    "type-check": "npm-run-all type-check:*"
+    "type-check": "npm-run-all type-check:*",
+    "unlink:all": "node bin/unlink-all.mjs"
   },
   "dependencies": {
     "@babel/helper-module-imports": "^7.16.7",
@@ -105,7 +107,7 @@
   "devDependencies": {
     "@aws-sdk/client-s3": "^3.321.1",
     "@babel/core": "^7.22.9",
-    "@babel/plugin-proposal-decorators": "^7.22.7",
+    "@babel/plugin-proposal-decorators": "^7.23.6",
     "@babel/plugin-transform-typescript": "^7.22.9",
     "@babel/preset-env": "^7.16.11",
     "@babel/types": "^7.22.5",
@@ -138,14 +140,14 @@
     "ember-cli-dependency-checker": "^3.3.1",
     "ember-cli-yuidoc": "^0.9.1",
     "eslint": "^8.53.0",
-    "eslint-config-prettier": "^8.5.0",
+    "eslint-config-prettier": "^9.1.0",
     "eslint-import-resolver-node": "^0.3.7",
     "eslint-plugin-disable-features": "^0.1.3",
     "eslint-plugin-ember-internal": "^3.0.0",
-    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-import": "^2.29.0",
     "eslint-plugin-n": "^16.0.1",
     "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-qunit": "^7.3.4",
+    "eslint-plugin-qunit": "^8.0.1",
     "execa": "^5.1.1",
     "expect-type": "^0.15.0",
     "express": "^4.18.2",
@@ -156,9 +158,9 @@
     "glob": "^8.0.3",
     "html-differ": "^1.4.0",
     "lodash.uniq": "^4.5.0",
-    "mkdirp": "^2.1.3",
+    "mkdirp": "^3.0.1",
     "mocha": "^10.2.0",
-    "npm-run-all": "^4.1.5",
+    "npm-run-all2": "^6.0.6",
     "prettier": "^2.8.0",
     "puppeteer": "^20.9.0",
     "qunit": "^2.19.4",
@@ -202,9 +204,9 @@
     "node": "16.20.0",
     "pnpm": "8.10.0"
   },
-  "_originalVersion": "5.6.0-beta.2",
+  "_originalVersion": "5.7.0-alpha.2",
   "_versionPreviouslyCalculated": true,
   "publishConfig": {
-    "tag": "beta"
+    "tag": "alpha"
   }
 }

package/types/stable/@ember/-internals/metal/lib/cached.d.ts

@@ -88,5 +88,5 @@ declare module '@ember/-internals/metal/lib/cached' {
       @for @glimmer/tracking
       @public
      */
-  export const cached: PropertyDecorator;
+  export const cached: MethodDecorator;
 }

package/types/stable/@ember/component/index.d.ts

@@ -1,8 +1,129 @@
 declare module '@ember/component' {
+  /**
+      @module @ember/component
+      @public
+     */
   export { setComponentTemplate, getComponentTemplate } from '@glimmer/manager';
   export { Component as default, Input, Textarea } from '@ember/-internals/glimmer';
   export {
     componentCapabilities as capabilities,
     setComponentManager,
   } from '@ember/-internals/glimmer';
+  /**
+   * Assigns a TemplateFactory to a component class.
+   *
+   * @method setComponentTemplate
+   * @static
+   * @for @ember/component
+   * @public
+   *
+   * ```js
+   * import Component from '@glimmer/component';
+   * import { hbs } from 'ember-cli-htmlbars';
+   * import { setComponentTemplate } from '@ember/component';
+   *
+   * export default class Demo extends Component {
+   *   // ...
+   * }
+   *
+   * setComponentTemplate(hbs`
+   *  <div>my template</div>
+   * `, Demo);
+   * ```
+   *
+   * @param {TemplateFactory} templateFactory
+   * @param {object} componentDefinition
+   */
+  /**
+   * Returns the TemplateFactory associated with a component
+   *
+   * @method getComponentTemplate
+   * @static
+   * @for @ember/component
+   * @public
+   *
+   * ```js
+   * import Component from '@glimmer/component';
+   * import { hbs } from 'ember-cli-htmlbars';
+   * import { getComponentTemplate } from '@ember/component';
+   *
+   * export default class Demo extends Component {
+   *   // ...
+   * }
+   *
+   * let theTemplateFactory = getTemplateFactory(Demo)
+   * ```
+   *
+   * @param {object} componentDefinition
+   * @returns {TemplateFactory}
+   */
+  /**
+   * Tell the VM how manage a type of object / class when encountered
+   * via component-invocation.
+   *
+   * A Component Manager, must implement this interface:
+   * - static create()
+   * - createComponent()
+   * - updateComponent()
+   * - destroyComponent()
+   * - getContext()
+   *
+   * @method setComponentManager
+   * @static
+   * @for @ember/component
+   * @public
+   *
+   *
+   * After a component manager is registered via `setComponentManager`,
+   *
+   * ```js
+   * import { StateNode } from 'xstate';
+   * import ComponentManager from './-private/statechart-manager';
+   *
+   * setComponentManager((owner) => ComponentManager.create(owner), StateNode.prototype);
+   * ```
+   *
+   * Instances of the class can be used as component.
+   * No need to extend from `@glimmer/component`.
+   *
+   * ```js
+   * // app/components/my-component.js
+   * import { createMachine } from 'xstate';
+   *
+   * export default createMachine({ ... });
+   * ```
+   * ```hbs
+   * {{!-- app/templates/application.hbs}}
+   * <MyComponent />
+   * ```
+   *
+   * @param {(owner: Owner) => import('@glimmer/interfaces').ComponentManager} managerFactory
+   * @param {object} object that will be managed by the return value of `managerFactory`
+   *
+   */
+  /**
+   * Tells Glimmer what capabilities a Component Manager will have
+   *
+   * ```js
+   * import { capabilities } from '@ember/component';
+   *
+   * export class MyComponentManager {
+   *   capabilities = capabilities('3.13', {
+   *     // capabilities listed here
+   *   })
+   * }
+   * ```
+   *
+   *
+   * For a full list of capabilities, their defaults, and how they are used, see [@glimmer/manager](https://github.com/glimmerjs/glimmer-vm/blob/4f1bef0d9a8a3c3ebd934c5b6e09de4c5f6e4468/packages/%40glimmer/manager/lib/public/component.ts#L26)
+   *
+   *
+   * @method capabilities
+   * @static
+   * @for @ember/component
+   * @public
+   * @param {'3.13'} managerApiVersion
+   * @param {Parameters<import('@ember/-internals/glimmer').componentCapabilities>[1]} options
+   *
+   */
 }