@silexlabs/silex 3.0.1-alpha.0 → 3.0.1

package/CODE_OF_CONDUCT.md

@@ -1,128 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity
-and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
-  overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-contact [at] silex.me.
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series
-of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct
-enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.

package/CONTRIBUTING.md

@@ -1,131 +0,0 @@
-### Overview
-
-This page is about contributing code, but other types of contribution are welcome, [let's chat](https://github.com/silexlabs/Silex/discussions)!
-
-Useful links
-
-* [Silex meta repository](https://github.com/silexlabs/silex-meta)
-* [Open positions, join the team](https://github.com/silexlabs/Silex/issues?q=is%3Aissue+is%3Aopen+label%3A%22open+position%22)
-* [Become a core contributor with these issues to get started](https://github.com/silexlabs/Silex/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
-* [Testers, docs and other help wanted annoucements](https://github.com/silexlabs/Silex/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
-
-To contribute code (features, bug fixes, design changes etc.) to the Silex code base, you'll need to complete a few steps to get a local working copy of our repository. Below are the steps you'll need to fork, clone, branch, and create a pull request.
-
-Please be sure to conform to the coding standards used throughout our project and bear in mind that, by contributing to this project, you agree to our [Code of Conduct](https://github.com/silexlabs/Silex/wiki/Silex-Code-of-Conduct).
-
-## Code base overview
-
-The Silex API is primarily divided into two parts: the client-side and the server-side.
-
-### Client-side
-
-The client-side is primarily handled by the files in the `src/ts/client` directory. The main entry point is defined in `index.ts`, which initializes the Silex application. The `config.ts` file contains the `SilexConfig` class that holds the configuration for the client-side application, including the GrapesJS editor configuration and the client config URL. The `grapesjs` directory contains the GrapesJS editor configuration and plugins. The `utils.ts` file contains utility functions.
-
-### Server-side
-
-The server-side is primarily handled by the files in the `src/ts/server` directory. The main entry point is defined in `index.ts`, which initializes the server-side application. The `config.ts` file contains the `ServerConfig` class that holds the configuration for the server-side application. The `express.ts` file sets up the Express.js application and starts the server. The `cli.ts` file handles the command-line interface for the server, parsing command-line arguments and setting environment variables accordingly. The `events.ts` file defines events for the startup process.
-
-## Code contribution process
-
-### Steps
-
-   If you don't have a GitHub account, start [here](https://github.com/join).
-
-1. **Fork the project**
-
-	 Open the [Silex Project](https://github.com/silexlabs/Silex/) in GitHub. Click `Fork` in the upper right corner of the window. This adds a copy of the Silex repository to your GitHub account.
-
-2. **Clone the fork**
-
-   Now you'll make a local copy of the repository. From the command line:
-
-   ```bash
-   # Open command line terminal
-   # Navigate to your desired working directory
-   cd <your-desired-working-directory>
-   git clone https://github.com/<your-username>/Silex.git
-    ```
-
-3. **Set the upstream repository**
-
-   Assign Silex as the upstream repository. Setting the upstream repository tells Git where to pull from when you use the pull command (which you'll do in the next step).
-
-	 ```bash
-	 cd Silex
-	 git remote add upstream https://github.com/silexlabs/Silex.git
-	 ```
-
-4. **Pull the latest upstream changes**
-
-   ```bash
-   git pull upstream main
-   ```
-
-5. **Create a new branch** (Recommended)
-
-	 Though you can work directly in the default dev branch, it is best practice to keep that branch synced with Silex and create a new working branch for your changes. Name the new branch whatever you'd like.
-
-   ```bash
-   git checkout -b <new-branch-name>
-   ```
-
-    You'll need to set the upstream branch so git knows where to point your new branch's pull and push commands. Below you set your local dev branch as the upstream branch to your new branch.
-
-   ```bash
-   git branch --set-upstream-to=dev <new-branch-name>
-   ```
-
-   **Notes on branch management:**
-   You can easily see a list of all of the branches in the local repository. The branch with [*] is the current working branch.
-
-   ```bash
-   git branch
-   ```
-   You can switch between local branches using this command:
-
-   ```bash
-   git checkout <branch to which you wish to switch>
-   ```
-
-6. **Make your changes**
-   Once changes are complete, use one of the following commands to stage the changes to be committed.
-
-   ```bash
-   # Add all changes to commit
-   git add .
-
-   # Add changes from one file to commit
-   git add <file-name>
-   ```
-
-   **Note on change management:**
-   You can always use this command to see which changes are staged for commit and which aren't.
-
-   ```bash
-   git status
-   ```
-
-7. **Prepare to commit your changes**
-   Once your changes are ready and all files you wish to commit have been added (step #5), you'll create your commit.
-
-   ```bash
-   git commit -m "This is a short message about the change made in this commit"
-   ```
-
-   **Note on commiting:** If you have multiple commits or wish to change your commit message, you can use [interactive rebase](https://help.github.com/articles/about-git-rebase) to clean up and consolidate your commits before making your pull request.
-
-8. **Rebase the upstream branch** into your local branch(es)
-
-   ```bash
-   git pull [--rebase] upstream dev
-   ```
-
-9. **Push your local branch** up to your fork
-
-   ```bash
-   git push origin <branch-name>
-   ```
-
-10. **Create a pull request**
-
-	 [Create your request](https://help.github.com/articles/creating-a-pull-request/), making sure the title is as clear and descriptive as possible.

package/Dockerfile

@@ -1,15 +0,0 @@
-FROM node:18
-
-# see doc about env vars here: https://github.com/silexlabs/Silex/wiki/How-to-Host-An-Instance-of-Silex#environment-variables
-# these can be overriden using the `-e` option in docker run
-# FS_ROOT=/repo.git/
-ENV DIRECTUS_URL=
-
-COPY . /silex
-WORKDIR /silex
-RUN apt-get update
-RUN npm install
-# RUN npm run build
-
-EXPOSE 6805
-CMD ["npm", "start"]

package/directus.silex.js

@@ -1,7 +0,0 @@
-module.exports = function (silexConfig) {
-  // Add plugins
-  silexConfig.addPlugin(__dirname + '/src/plugins/AuthPlugin', {
-    directusUrl: process.env.DIRECTUS_SERVER_TO_SERVER_URL || process.env.DIRECTUS_URL,
-    directusToken: process.env.DIRECTUS_TOKEN, // In case no token is passed in the request body
-  })
-}

package/dist/constants.js

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CLIENT_CONFIG_FILE_NAME = void 0;
-exports.CLIENT_CONFIG_FILE_NAME = 'silex.js';

package/dist/events.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EVENT_STARTUP_END = exports.EVENT_STARTUP_START = void 0;
-exports.EVENT_STARTUP_START = 'silex:startup:start';
-exports.EVENT_STARTUP_END = 'silex:startup:end';

package/dist/page.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPageLink = exports.getPageSlug = void 0;
-function getPageSlug(pageName = 'index') {
-    return pageName
-        .toLowerCase()
-        .replace(/[^a-z0-9 -]/g, '')
-        .replace(/\s+/g, '-')
-        .replace(/-+/g, '-');
-}
-exports.getPageSlug = getPageSlug;
-function getPageLink(pageName = 'index') {
-    return `./${getPageSlug(pageName)}.html`;
-}
-exports.getPageLink = getPageLink;

package/dist/server/cli.js

@@ -1,43 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const cli_1 = require("cli");
-const options = (0, cli_1.parse)({
-    config: ['c', 'Path for the server side config file to load at startup', 'file'],
-    port: ['p', 'Port to listen to', 'int'],
-    debug: [false, 'Debug mode, with live reload, source maps etc.', 'boolean'],
-    'ssl-port': [false, 'Port to listen to for SSL/HTTPS', 'int'],
-    'force-https': [false, 'Force HTTPS', 'boolean'],
-    'ssl-private-key': [false, 'Path to private key for SSL', 'file'],
-    'ssl-certificate': [false, 'Path to SSL certificate', 'file'],
-    'force-https-trust-xfp-header': [false, 'Sets the trustXFPHeader param of the express module "cookie-session". Use only with --force-https', 'boolean'],
-    'session-secret': ['s', 'Session secret', 'string'],
-    'cors-url': ['', 'Enable CORS for URL (can be "*")', 'string'],
-    'client-config': ['', 'Path to client config file to be served on .silex-client.js', 'string'],
-    'fs-root': ['', 'Path to the root folder where to store websites. Used by the default backend (fs).', 'string'],
-}, {});
-if (options.config)
-    process.env.CONFIG = options.config;
-if (options.port)
-    process.env.PORT = options.port;
-if (options.debug)
-    process.env.SILEX_DEBUG = options.debug;
-if (options['ssl-port'])
-    process.env.SSL_PORT = options['ssl-port'];
-if (options['force-https'])
-    process.env.SILEX_FORCE_HTTPS = options['force-https'];
-if (options['ssl-private-key'])
-    process.env.SILEX_SSL_PRIVATE_KEY = options['ssl-private-key'];
-if (options['ssl-certificate'])
-    process.env.SILEX_SSL_CERTIFICATE = options['ssl-certificate'];
-if (options['force-https-trust-xfp-header'])
-    process.env.SILEX_FORCE_HTTPS_TRUST_XFP_HEADER = options['force-https-trust-xfp-header'];
-if (options['session-secret'])
-    process.env.SILEX_SESSION_SECRET = options['session-secret'];
-if (options['cors-url'])
-    process.env.SILEX_CORS_URL = options['cors-url'];
-if (options['client-config'])
-    process.env.SILEX_CLIENT_CONFIG = options['client-config'];
-if (options['fs-root'])
-    process.env.FS_ROOT = options['fs-root'];
-require("./index");

package/dist/server/config.js

@@ -1,70 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ServerConfig = void 0;
-const silex_plugins_1 = require("@silexlabs/silex-plugins");
-const path_1 = require("path");
-const constants_1 = require("../constants");
-const express_1 = require("express");
-const promises_1 = require("fs/promises");
-const events_1 = require("../events");
-class ServerConfig extends silex_plugins_1.Config {
-    url;
-    debug;
-    port;
-    apiPath;
-    constructor(url, debug, port, apiPath) {
-        super();
-        this.url = url;
-        this.debug = debug;
-        this.port = port;
-        this.apiPath = apiPath;
-    }
-}
-exports.ServerConfig = ServerConfig;
-async function default_1() {
-    const port = process.env.PORT || '6805';
-    const debug = process.env.SILEX_DEBUG === 'true';
-    const clientConfigPath = process.env.SILEX_CLIENT_CONFIG;
-    const url = process.env.SERVER_URL || `http://localhost:${port}`;
-    const config = new ServerConfig(url, debug, port, '/api');
-    if (clientConfigPath) {
-        config.on(events_1.EVENT_STARTUP_START, async ({ app }) => {
-            console.log(`> Serving client side config ${clientConfigPath} at ${constants_1.CLIENT_CONFIG_FILE_NAME}`);
-            const router = (0, express_1.Router)();
-            app.use(router);
-            let clientConfig = (await (0, promises_1.readFile)(clientConfigPath)).toString();
-            router.get(`/${constants_1.CLIENT_CONFIG_FILE_NAME}`, async (res, req, next) => {
-                if (config.debug) {
-                    console.log('[Debug mode] Reloading config file', clientConfigPath);
-                    clientConfig = (await (0, promises_1.readFile)(clientConfigPath)).toString();
-                }
-                req.header('Content-Type', 'application/javascript').send(clientConfig);
-            });
-        });
-    }
-    if (process.env.CONFIG) {
-        const userConfigPath = process.env.CONFIG;
-        console.log('> Loading user config', userConfigPath);
-        try {
-            await config.addPlugin(userConfigPath, {});
-        }
-        catch (e) {
-            throw new Error(`User config file ${userConfigPath} error: ${e.message}`);
-        }
-    }
-    const configFilePath = (0, path_1.resolve)(__dirname, '../../.silex.js');
-    console.log('> Loading config', configFilePath);
-    try {
-        await config.addPlugin(configFilePath, {});
-    }
-    catch (e) {
-        if (e.code === 'MODULE_NOT_FOUND') {
-            console.info('No config found', configFilePath);
-        }
-        else {
-            throw new Error(`Error in config file ${configFilePath}: ${e.message}`);
-        }
-    }
-    return config;
-}
-exports.default = default_1;

package/dist/server/express.js

@@ -1,18 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const express_1 = __importDefault(require("express"));
-const events_1 = require("../events");
-async function default_1(config) {
-    const app = (0, express_1.default)();
-    await config.emit(events_1.EVENT_STARTUP_START, { app });
-    return new Promise((resolve, reject) => {
-        app.listen(config.port, () => {
-            config.emit(events_1.EVENT_STARTUP_END, { app });
-            resolve(app);
-        });
-    });
-}
-exports.default = default_1;

package/dist/server/index.js

@@ -1,58 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const config_1 = __importDefault(require("./config"));
-const express_1 = __importDefault(require("./express"));
-const config = __importStar(require("./config"));
-const types = __importStar(require("../types"));
-const events = __importStar(require("../events"));
-const constants = __importStar(require("../constants"));
-const page = __importStar(require("../page"));
-exports.default = { config, types, events, constants, page };
-async function main() {
-    const config = await (0, config_1.default)();
-    const app = await (0, express_1.default)(config);
-    console.info(`
-I'm ready, listening to port ${config.port}
-  `);
-    if (config.debug) {
-        startLiverReload();
-    }
-}
-main();
-async function startLiverReload() {
-    const { createServer } = await Promise.resolve().then(() => __importStar(require('livereload')));
-    const { resolve } = await Promise.resolve().then(() => __importStar(require('path')));
-    const dist = resolve(__dirname, '../client');
-    const server = createServer({
-        delay: 0,
-    }, () => {
-        console.info(`\n> Debug mode\n> Live reload server is running.\n> Watching ${dist}`);
-    });
-    server.watch(dist);
-}

package/dist/types.js

@@ -1,34 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Unit = exports.defaultSite = exports.defaultPublicationSettings = void 0;
-exports.defaultPublicationSettings = {
-    path: 'publication',
-    url: '',
-    autoHomePage: true,
-    assets: { path: 'assets', url: '/assets' },
-    html: { path: '' },
-    css: { path: 'css', url: '/css' },
-};
-exports.defaultSite = {
-    pages: [{ name: 'Main', id: 'main', frames: [{ component: { type: 'text', stylable: [] }, components: [] }] }],
-    assets: [],
-    styles: [],
-    name: 'New website',
-    settings: {
-        description: '',
-        title: '',
-        head: '',
-        lang: '',
-        favicon: '',
-        'og:title': '',
-        'og:description': '',
-        'og:image': '',
-    },
-    fonts: [],
-    symbols: [],
-    publication: exports.defaultPublicationSettings,
-};
-var Unit;
-(function (Unit) {
-    Unit["PX"] = "px";
-})(Unit || (exports.Unit = Unit = {}));

package/jest.config.js

@@ -1,10 +0,0 @@
-module.exports = {
-  "testMatch": ['<rootDir>/**/*.test.ts'],
-  "testEnvironment": 'jsdom',
-  "extensionsToTreatAsEsm": [".ts"],
-  "transform": {
-    ".ts": ['ts-jest', {
-      "useESM": true,
-    }],
-  },
-};