gwchq-textjam 0.1.73 → 0.1.74

package/README.md

@@ -54,20 +54,23 @@ The dev playground (`webpack.config.js`) keeps styles in JavaScript via `style-l
 **Refactor Global Styles**: When working on existing code, identify global styles and refactor them into CSS Modules when possible. This improves maintainability, reduces style conflicts, and makes components more self-contained.
 
 **CSS Modules Structure**:
+
 - Component-specific styles should live in `ComponentName/styles.module.scss` alongside the component
 - Import styles as: `import classes from './styles.module.scss'`
 - Use class names from the imported styles object: `className={classes.container}`
 - Webpack automatically generates scoped class names like `ComponentName__container--abc123`
 
 **When Global Styles Are Acceptable**:
+
 - Design system tokens and variables (e.g., color palettes, spacing scales)
 - Third-party library overrides that cannot be modularized
 - Base resets or typography that must apply globally
 
 **Example - Preferred CSS Modules Approach**:
+
 ```jsx
 // ComponentName/ComponentName.jsx
-import classes from './styles.module.scss';
+import classes from "./styles.module.scss";
 
 export function ComponentName() {
   return <div className={classes.container}>Content</div>;
@@ -91,6 +94,7 @@ Automated unit tests can be run via the `yarn test` command. These unit tests ar
 ### Prerequisites
 
 1. Ensure you're logged into npm:
+
    ```bash
    npm login
    ```
@@ -105,25 +109,30 @@ Automated unit tests can be run via the `yarn test` command. These unit tests ar
    - Patch: `0.1.2` → `0.1.3` (bug fixes)
    - Minor: `0.1.2` → `0.2.0` (new features, backwards compatible)
    - Major: `0.1.2` → `1.0.0` (breaking changes)
-   
 2. **Build the library** (automatically runs via `prepublishOnly` hook):
+
    ```bash
    yarn build:lib
    ```
+
    This creates the `dist` folder with:
+
    - `index.js` - The main ESM module
    - `style.css` - Extracted stylesheet
    - `assets/` - Static assets (icons, fonts, etc.)
 
 3. **Verify the build output**:
+
    - Check that `dist/index.js` exists and is properly built
    - Verify `dist/style.css` contains all styles
    - Ensure all required assets are in `dist/assets/`
 
 4. **Publish to npm**:
+
    ```bash
    npm publish
    ```
+
    The `prepublishOnly` script will automatically run `yarn build:lib` before publishing.
 
 5. **Verify publication**:
@@ -134,6 +143,7 @@ Automated unit tests can be run via the `yarn test` command. These unit tests ar
 ### What Gets Published
 
 The following files are included in the npm package (as defined in `package.json` → `files`):
+
 - `dist/` - Built library files
 - `README.md` - This file
 - `LICENSE` - License file
@@ -141,6 +151,7 @@ The following files are included in the npm package (as defined in `package.json
 ### Package Exports
 
 Consumers can import:
+
 - Main component: `import { TextJamEditor } from "gwchq-textjam"`
 - Stylesheet: `import "gwchq-textjam/style.css"`
 
@@ -150,7 +161,7 @@ The editor can be imported and rendered directly inside another React applicatio
 
 ```tsx
 import { TextJamEditor } from "gwchq-textjam";
-import "gwchq-textjam/style.css"
+import "gwchq-textjam/style.css";
 
 export function EditorWrapper() {
   return (
@@ -162,6 +173,7 @@ export function EditorWrapper() {
 ```
 
 The consumer's webpack config should include the following setups
+
 ```
 {
   ...,
@@ -217,9 +229,14 @@ The consumer's webpack config should include the following setups
 - `project`: an object with the project data. Contains the following props:
   - `project_type`: Possible values `web` | `python`. Default project files will be created according to this value
   - `identifier`: A string that represents the project id. If provided, cached project with same id will be loaded
-  - `packageApiUrl`: A string with url to download pyodide packages. If not provided - default value is pyodide CDN.
+  - `author`: an object with owner user data (firstName, lastName, id)
+  - `components`: an array of project components (files and folders)
+- `packageApiUrl`: A string with url to download pyodide packages. If not provided - default value is pyodide CDN.
+- `isSharedProject`: a boolean to show a shared project interface instead the regular editor if `true` (`false` by default)
+- `isCodeVisible`: a boolean to show or hide the code panel (`true` by default)
 
 // TODO: review old options below
+
 - `loadCache`: Load latest version of project code from local storage (defaults to `true`)
 - `locale`: Locale for UI elements and to determine the language of projects loaded from the API (defaults to `en`)
 - `outputOnly`: Only display the output panel (defaults to `false`)
@@ -248,4 +265,3 @@ For backwards compatibility the editor continues to dispatch the following `docu
 - `editor-themeUpdated`
 
 These events make it possible for the host page to react to code execution, project changes, authentication requests, and theme updates.
-