@astryxdesign/richtext 0.0.0-bootstrap.0 → 0.1.8-canary.d57e546

package/CHANGELOG.md

@@ -0,0 +1 @@
+# @astryxdesign/richtext

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Meta Platforms, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,64 @@
 # @astryxdesign/richtext
 
-This is a `0.0.0-bootstrap.0` placeholder published only to claim the npm name while configuring npm trusted publishing. Do not install it; it will be superseded by the first real release.
+Astryx rich text — a Lexical-based rich text editor and viewer.
+
+> **Status: empty scaffold.** This package is bootstrapped but does not export
+> anything yet. It will house the rich text editor and viewer that currently
+> live in `@astryxdesign/lab`; that code will move here without a fresh package
+> rollout.
+
+It will ship to npm **only under the `@canary` dist-tag** — there is never a
+stable (`latest`) release yet.
+
+## Trying richtext in your own project (canary)
+
+Once components land, `@astryxdesign/richtext` will be published **only** under
+the `@canary` dist-tag, so you must request that tag explicitly. There is no
+`latest` version to install.
+
+```bash
+npm install @astryxdesign/richtext@canary @astryxdesign/core@canary
+```
+
+> Canary builds track the latest commit on `main` (`0.x.y-canary.<sha>`). They
+> can break between any two versions — pin an exact version if you need
+> stability.
+
+## Why no stable release?
+
+`package.json` keeps `"private": true` plus an `"astryx": { "canaryOnly": true }`
+marker. The release workflow's stable (`latest`) job skips both private and
+`canaryOnly` packages, while the canary job strips `private` in its ephemeral CI
+checkout only (never in git) to publish the `@canary` tag. The committed
+`private: true` is npm's hard guarantee that no stable publish can ever happen —
+**do not remove it.**
+
+## Publishing publicly (when the editor/view are ready)
+
+When maintainers are ready to promote richtext to a stable public release:
+
+1. Move the editor/view source from `@astryxdesign/lab` into `src/` and export
+   it from `src/index.ts`. Add the StyleX CSS build wiring (see below).
+2. Remove `"private": true` **and** the `"astryx": { "canaryOnly": true }`
+   marker from `package.json`.
+3. Add a changeset (`pnpm changeset`) selecting `@astryxdesign/richtext` so the
+   release workflow versions and publishes it to the `latest` dist-tag.
+4. The stable (`latest`) release job (`.github/workflows/release.yml`) will then
+   include richtext on the next release.
+
+### Adding the StyleX CSS build (deferred until the first component)
+
+This scaffold intentionally omits the `build:css` step. `build-css.mjs` exits
+with an error ("No StyleX rules found") when a package has zero StyleX
+components, which would break CI for an empty package. When the first StyleX
+component lands:
+
+1. Register a `richtext` target in `scripts/build-css.mjs` (mirror the `lab` /
+   `charts` entries — same core token alias).
+2. Add `"build:css": "node ../../scripts/build-css.mjs --package richtext"` to
+   the `scripts` block and append `&& pnpm build:css` to the `build` script
+   (before `check-no-dev-jsx`).
+3. Add a `"./richtext.css"` entry to `exports` and add `richtext.css` under
+   `files` if needed.
+
+The babel config is already StyleX-ready, so this is a small, mechanical add.

package/dist/index.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @file index.ts
+ * @input (none yet — empty package)
+ * @output Public API surface for @astryxdesign/richtext
+ * @position Barrel export; entry point for consumers of @astryxdesign/richtext
+ *
+ * SYNC: When modified, update /packages/richtext/README.md
+ */
+/**
+ * @astryxdesign/richtext will house the Lexical-based rich text editor and
+ * viewer currently in @astryxdesign/lab. It is intentionally empty for now —
+ * this bootstrap only establishes the package, its build wiring, and its npm
+ * canary-only publishing setup so the editor/view can move here later without
+ * a fresh package rollout.
+ *
+ * The `export {}` keeps this a valid ES module with no exports until the first
+ * component lands.
+ */
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AAEH;;;;;;;;;GASG;AACH,OAAO,EAAE,CAAC"}

package/dist/index.js

@@ -0,0 +1,22 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+/**
+ * @file index.ts
+ * @input (none yet — empty package)
+ * @output Public API surface for @astryxdesign/richtext
+ * @position Barrel export; entry point for consumers of @astryxdesign/richtext
+ *
+ * SYNC: When modified, update /packages/richtext/README.md
+ */
+
+/**
+ * @astryxdesign/richtext will house the Lexical-based rich text editor and
+ * viewer currently in @astryxdesign/lab. It is intentionally empty for now —
+ * this bootstrap only establishes the package, its build wiring, and its npm
+ * canary-only publishing setup so the editor/view can move here later without
+ * a fresh package rollout.
+ *
+ * The `export {}` keeps this a valid ES module with no exports until the first
+ * component lands.
+ */
+export {};

package/package.json

@@ -1,11 +1,60 @@
 {
   "name": "@astryxdesign/richtext",
-  "version": "0.0.0-bootstrap.0",
-  "description": "Placeholder published to claim the npm name during trusted publishing setup. Do not install.",
-  "homepage": "https://github.com/facebook/astryx",
+  "version": "0.1.8-canary.d57e546",
+  "description": "Astryx rich text — a Lexical-based rich text editor and viewer. Published to npm only under the @canary dist-tag for early testing; never released as a stable (latest) version.",
+  "author": "Meta Open Source",
   "license": "MIT",
+  "homepage": "https://github.com/facebook/astryx#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/facebook/astryx.git"
+    "url": "git+https://github.com/facebook/astryx.git",
+    "directory": "packages/richtext"
+  },
+  "bugs": {
+    "url": "https://github.com/facebook/astryx/issues"
+  },
+  "keywords": [
+    "astryx",
+    "richtext",
+    "rich-text",
+    "editor",
+    "lexical",
+    "design-system"
+  ],
+  "astryx": {
+    "canaryOnly": true,
+    "_comment": "Published ONLY to the @canary dist-tag (see .github/workflows/release.yml). Never released as a stable `latest` release. `private: true` is intentional and must stay — it is npm's hard guarantee against an accidental stable publish."
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "src",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "peerDependencies": {
+    "@stylexjs/stylex": ">=0.10.0",
+    "@astryxdesign/core": "0.1.8-canary.d57e546",
+    "react": ">=19.0.0",
+    "react-dom": ">=19.0.0"
+  },
+  "scripts": {
+    "build": "rm -rf dist && pnpm build:esm && tsc --project tsconfig.build.json && node ../../scripts/check-no-dev-jsx.mjs",
+    "build:esm": "babel src --out-dir dist --extensions '.ts,.tsx' --out-file-extension '.js' --ignore '**/*.test.ts,**/*.test.tsx,**/__tests__/**,**/*.perf.test.*,**/*.doc.mjs,**/*.d.ts,**/*.css,**/*.css.d.ts' --config-file ./babel.config.js",
+    "dev": "babel src --watch --out-dir dist --extensions '.ts,.tsx' --out-file-extension '.js' --ignore '**/*.test.*,**/*.doc.mjs,**/*.d.ts,**/*.css*' --config-file ./babel.config.js",
+    "test": "vitest run --root ../..",
+    "test:watch": "vitest --root ../..",
+    "lint": "eslint src",
+    "typecheck": "tsc --project tsconfig.json --noEmit"
   }
-}
+}

package/src/index.ts

@@ -0,0 +1,22 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+/**
+ * @file index.ts
+ * @input (none yet — empty package)
+ * @output Public API surface for @astryxdesign/richtext
+ * @position Barrel export; entry point for consumers of @astryxdesign/richtext
+ *
+ * SYNC: When modified, update /packages/richtext/README.md
+ */
+
+/**
+ * @astryxdesign/richtext will house the Lexical-based rich text editor and
+ * viewer currently in @astryxdesign/lab. It is intentionally empty for now —
+ * this bootstrap only establishes the package, its build wiring, and its npm
+ * canary-only publishing setup so the editor/view can move here later without
+ * a fresh package rollout.
+ *
+ * The `export {}` keeps this a valid ES module with no exports until the first
+ * component lands.
+ */
+export {};