@_linked/cli 1.11.1 → 1.13.0

package/lib/esm/cli-methods.js

@@ -15,6 +15,9 @@ import fs from 'fs-extra';
 import path, { dirname } from 'path';
 import { createInterface } from 'readline';
 import { debugInfo, execp, execPromise, getFileImports, getFiles, getLastCommitTime, getPackageJSON, isImportOutsideOfPackage, isImportWithMissingExtension, isInvalidLINCDImport, needsRebuilding, } from './utils.js';
+import { renameShippedDotfiles } from './utils/shippedDotfiles.js';
+import { planPackageSetup } from './utils/packageSetup.js';
+import { rewriteExtensionlessImports } from './utils/esmSpecifiers.js';
 import { spawn as spawnChild } from 'child_process';
 import { findNearestPackageJson } from 'find-nearest-package-json';
 import { statSync } from 'fs';
@@ -60,6 +63,14 @@ function promptUser(question) {
     });
 }
 export const createApp = (name_1, ...args_1) => __awaiter(void 0, [name_1, ...args_1], void 0, function* (name, basePath = process.cwd(), options = {}) {
+    // Reject unknown templates before prompting or writing anything.
+    const template = options.template;
+    if (template !== undefined &&
+        template !== 'web' &&
+        template !== 'react-native') {
+        console.warn(chalk.red(`Unknown template "${template}". Use "web" or "react-native".`));
+        return;
+    }
     // If no name provided, prompt for folder name first
     if (!name) {
         console.log(chalk.blue('\n📁 Folder name for your app:\n'));
@@ -102,6 +113,11 @@ export const createApp = (name_1, ...args_1) => __awaiter(void 0, [name_1, ...ar
     setVariable('app_prefix', appPrefix);
     setVariable('app_domain', appDomain);
     let targetFolder = path.join(basePath, hyphenName);
+    if (template === 'react-native') {
+        // Called through reactNativeInternals so tests can stub the scaffold step.
+        yield reactNativeInternals.scaffoldReactNativeApp(targetFolder, { appName, appPrefix, appDomain, hyphenName }, { skipInstall: options.skipInstall });
+        return;
+    }
     if (!fs.existsSync(targetFolder)) {
         fs.mkdirSync(targetFolder);
     }
@@ -194,6 +210,155 @@ export const createApp = (name_1, ...args_1) => __awaiter(void 0, [name_1, ...ar
     const startCommand = pm === 'yarn' ? 'yarn start' : 'npm start';
     log(`Your Linked app is ready at ${chalk.blueBright(targetFolder)}`, `\nStorage: linked.backend.storage.ts wires aliases to stores; linked.backend.datasets.json holds endpoints.`, `Defaults to Fuseki at ${chalk.cyan('http://localhost:3030')} (auto-creates the dataset on first boot).`, `Make sure Fuseki is running, e.g.:`, `  ${chalk.blueBright('docker run -d --rm -p 3030:3030 --name fuseki stain/jena-fuseki')}`, `Edit ${chalk.cyan('linked.backend.datasets.json')} to change endpoints or credentials.`, `Mirror file for the frontend: ${chalk.cyan('src/linked.frontend.storage.ts')} + ${chalk.cyan('src/linked.frontend.datasets.json')}.`, `\nTo start:`, `  ${chalk.blueBright(`cd ${hyphenName} && ${startCommand}`)}`);
 });
+/**
+ * iOS bundle identifier from the app domain and prefix:
+ * ('formaestudios.com', 'formae') -> 'com.formaestudios.formae'.
+ */
+export function reactNativeBundleId(appDomain, appPrefix) {
+    const host = appDomain
+        .trim()
+        .toLowerCase()
+        .replace(/^[a-z][a-z0-9+.-]*:\/\//, '')
+        .split(/[/?#]/)[0]
+        .replace(/:\d*$/, '');
+    const hostLabels = host.split('.').filter(Boolean);
+    // A bare host such as `localhost` gets a `com` top level: com.localhost.<prefix>.
+    if (hostLabels.length === 1)
+        hostLabels.push('com');
+    return [...hostLabels.reverse(), appPrefix.toLowerCase()]
+        .map((label) => label.replace(/_/g, '-').replace(/[^a-z0-9-]/g, ''))
+        .filter(Boolean)
+        .join('.');
+}
+/**
+ * The prefix becomes a directory, an npm package name, a bundle-ID label and a
+ * literal inside a Jest regex; this form is valid in all four unescaped.
+ */
+export const RN_PREFIX_PATTERN = /^[a-z][a-z0-9-]*$/;
+/** Throws when the prefix is invalid or the target folder is non-empty. */
+function assertReactNativeScaffoldable(targetFolder, appPrefix) {
+    if (typeof appPrefix !== 'string' || !RN_PREFIX_PATTERN.test(appPrefix)) {
+        throw new Error(`Invalid app prefix "${appPrefix !== null && appPrefix !== void 0 ? appPrefix : ''}": it must match ${RN_PREFIX_PATTERN.source} ` +
+            '(start with a lowercase letter; only lowercase letters, digits and hyphens).');
+    }
+    if (fs.existsSync(targetFolder) && fs.readdirSync(targetFolder).length > 0) {
+        throw new Error(`Target folder ${targetFolder} already exists and is not empty. ` +
+            'Choose another name or remove the folder.');
+    }
+}
+/** Placeholder name of the shapes package in defaults/app-react-native. */
+export const RN_SHAPES_TOKEN = 'app-shapes';
+/**
+ * Replace every occurrence of `token` in the text files under `folder`
+ * (node_modules and files containing a NUL byte are skipped). A literal token
+ * replacement, not the ${...} variable substitution.
+ */
+function replaceTokenInTextFiles(folder, token, value) {
+    if (token === value)
+        return;
+    for (const entry of fs.readdirSync(folder, { withFileTypes: true })) {
+        const full = path.join(folder, entry.name);
+        if (entry.isDirectory()) {
+            if (entry.name !== 'node_modules' && entry.name !== '.git') {
+                replaceTokenInTextFiles(full, token, value);
+            }
+        }
+        else if (entry.isFile()) {
+            const buffer = fs.readFileSync(full);
+            if (buffer.includes(0))
+                continue;
+            const text = buffer.toString('utf8');
+            if (text.includes(token)) {
+                fs.writeFileSync(full, text.split(token).join(value));
+            }
+        }
+    }
+}
+const readJSON = (file) => JSON.parse(fs.readFileSync(file, 'utf8'));
+const writeJSON = (file, data) => fs.writeFileSync(file, JSON.stringify(data, null, 2) + '\n');
+/**
+ * Scaffold the React Native monorepo from defaults/app-react-native.
+ * Identity is stamped into named fields only; the global ${...} substitution
+ * (replaceVariablesInFolder) is never used, so template literals in TypeScript
+ * sources stay intact.
+ */
+export function scaffoldReactNativeApp(targetFolder_1, id_1) {
+    return __awaiter(this, arguments, void 0, function* (targetFolder, id, options = {}) {
+        const { appName, appPrefix, appDomain, hyphenName } = id;
+        // Validate before writing anything.
+        assertReactNativeScaffoldable(targetFolder, appPrefix);
+        // lib/esm/ (built) is two levels below the package root; src/ (Jest) is one.
+        const templateDir = options.templateDir ||
+            [
+                path.join(getScriptDir(), '..', '..', 'defaults', 'app-react-native'),
+                path.join(getScriptDir(), '..', 'defaults', 'app-react-native'),
+            ].find((dir) => fs.existsSync(dir));
+        if (!templateDir) {
+            throw new Error('React Native template not found (defaults/app-react-native)');
+        }
+        const shapesName = `${appPrefix}-shapes`;
+        log("Creating new Linked React Native app '" + appName + "'");
+        // 1. Copy the template.
+        fs.copySync(templateDir, targetFolder);
+        // 2. Restore dotfiles npm would strip from the CLI tarball.
+        renameShippedDotfiles(targetFolder);
+        // 3. Rename the shapes package directory.
+        const oldShapesDir = path.join(targetFolder, 'packages', RN_SHAPES_TOKEN);
+        const shapesDir = path.join(targetFolder, 'packages', shapesName);
+        if (fs.existsSync(oldShapesDir) && oldShapesDir !== shapesDir) {
+            fs.renameSync(oldShapesDir, shapesDir);
+        }
+        // 4a. Rename the shapes package token everywhere: workspaces, .gitignore
+        // negation, package names, dependency keys, Jest patterns, import specifiers,
+        // test expectations and docs. Only the literal `app-shapes` token is replaced.
+        replaceTokenInTextFiles(targetFolder, RN_SHAPES_TOKEN, shapesName);
+        // 4b. Stamp the identity fields that are not the shapes token.
+        const rootPkgPath = path.join(targetFolder, 'package.json');
+        if (fs.existsSync(rootPkgPath)) {
+            const rootPkg = readJSON(rootPkgPath);
+            rootPkg.name = `${hyphenName}-monorepo`;
+            writeJSON(rootPkgPath, rootPkg);
+        }
+        const mobileDir = path.join(targetFolder, 'apps', 'mobile');
+        const appJsonPath = path.join(mobileDir, 'app.json');
+        if (fs.existsSync(appJsonPath)) {
+            const appJson = readJSON(appJsonPath);
+            appJson.expo = appJson.expo || {};
+            appJson.expo.name = appName;
+            appJson.expo.slug = hyphenName;
+            appJson.expo.ios = appJson.expo.ios || {};
+            appJson.expo.ios.bundleIdentifier = reactNativeBundleId(appDomain, appPrefix);
+            writeJSON(appJsonPath, appJson);
+        }
+        // 5. Install with npm: the template is an npm workspaces monorepo.
+        if (!options.skipInstall) {
+            const spinner = ora({
+                text: 'Installing dependencies (npm)...',
+                spinner: 'dots',
+            }).start();
+            try {
+                yield execPromise('npm install', false, false, {
+                    cwd: targetFolder,
+                    maxBuffer: 50 * 1024 * 1024,
+                });
+                spinner.succeed('Dependencies installed (npm)');
+            }
+            catch (err) {
+                spinner.fail('Could not install dependencies');
+                if (err === null || err === void 0 ? void 0 : err.stdout)
+                    process.stdout.write(err.stdout);
+                if (err === null || err === void 0 ? void 0 : err.stderr)
+                    process.stderr.write(err.stderr);
+                throw new Error(`npm install failed. The files are in ${targetFolder}; ` +
+                    `run \`npm install\` there to retry.`);
+            }
+        }
+        // 6. Next steps.
+        log(`Your Linked React Native app is ready at ${chalk.blueBright(targetFolder)}`, `\nNext steps:`, `  ${chalk.blueBright(`cd ${path.basename(targetFolder)}`)}`, `  ${chalk.blueBright('npm test -w apps/mobile')}`, `  ${chalk.blueBright('cd apps/mobile && npx expo run:ios')}`);
+    });
+}
+// Indirection so tests can replace the scaffold step when exercising createApp.
+export const reactNativeInternals = { scaffoldReactNativeApp };
 /** Set or append a `KEY=value` line in a `.env`-style text blob. */
 function setEnvVar(envText, key, value) {
     const line = `${key}=${value}`;
@@ -961,6 +1126,42 @@ export const createOntology = (prefix_1, uriBase_1, ...args_1) => __awaiter(void
         log(`Added an import of this file from ${chalk.magenta(indexPath)}`);
     }
 });
+// The shapes barrel (src/shapes/index.ts) is imported by both the frontend index and
+// the backend entry, so every shape registers on both boot paths (and materializes into
+// app-data on boot). `create-shape` adds each new shape here — NOT to the main index.
+const SHAPES_BARREL_HEADER = `// Shape registry — every shape is imported here so its @linkedShape decorator runs and\n` +
+    `// the shape registers on both boot paths (backend materialization + frontend). \`linked\n` +
+    `// create-shape\` maintains this list.\n//SHAPES\n`;
+const ensureBackendImportsShapes = function (root = process.cwd()) {
+    const backendPath = path.join(root, 'src', 'backend.ts');
+    if (!fs.existsSync(backendPath))
+        return;
+    let contents = fs.readFileSync(backendPath, 'utf-8');
+    if (contents.includes('./shapes/index'))
+        return;
+    fs.writeFileSync(backendPath, `import './shapes/index.js';\n` + contents);
+};
+// Register a shape in the shapes barrel (src/shapes/index.ts), creating it if needed, and
+// make sure both the main index and backend.ts import the barrel. Idempotent.
+export const addShapeToBarrel = function (shapeHyphenName, root = process.cwd()) {
+    const shapesDir = path.join(root, 'src', 'shapes');
+    fs.ensureDirSync(shapesDir);
+    const barrelPath = path.join(shapesDir, 'index.ts');
+    let contents = fs.existsSync(barrelPath)
+        ? fs.readFileSync(barrelPath, 'utf-8')
+        : SHAPES_BARREL_HEADER;
+    const line = `import './${shapeHyphenName}.js';`;
+    if (!contents.split(/\n/g).some((l) => l.trim() === line.trim())) {
+        contents = contents.includes('//SHAPES')
+            ? contents.replace('//SHAPES', `//SHAPES\n${line}`)
+            : contents.replace(/\n*$/, '') + `\n${line}\n`;
+        fs.writeFileSync(barrelPath, contents);
+    }
+    // Both boot paths must load the barrel (idempotent).
+    addLineToIndex(`import './shapes/index.js';`, 'shapes', root);
+    ensureBackendImportsShapes(root);
+    return barrelPath;
+};
 // Exported for Shape-Builder reuse (plan-010 T1d.4): CodeShapeSyncService adds
 // the `import './shapes/<Shape>.js';` line to a generated app package's index.
 export const addLineToIndex = function (line, insertMatchString, root = process.cwd(), insertAtStart = false) {
@@ -1145,12 +1346,11 @@ export const createShape = (name_1, ...args_1) => __awaiter(void 0, [name_1, ...
     //replace variables in some of the copied files
     yield replaceVariablesInFiles(targetFile);
     log(`Created a new shape class template in ${chalk.magenta(targetFile.replace(basePath, ''))}`);
-    //if this is NOT a lincd app (but a lincd package)
-    let indexPath;
-    if (!sourceFolder.includes('frontend')) {
-        indexPath = addLineToIndex(`import './shapes/${hyphenName}.js';`, 'shapes');
-        log(`Added an import of this file from ${chalk.magenta(indexPath)}`);
-    }
+    // Register the shape in the shapes barrel (src/shapes/index.ts) — NOT the main index —
+    // and make sure the barrel is loaded on both boot paths. This is what makes the app
+    // materialize its own shapes on boot (plan-027 / plan-028 handover).
+    const barrelPath = addShapeToBarrel(hyphenName);
+    log(`Registered the shape in ${chalk.magenta(barrelPath.replace(basePath, ''))}`);
 });
 export const createSetComponent = (name_1, ...args_1) => __awaiter(void 0, [name_1, ...args_1], void 0, function* (name, basePath = process.cwd()) {
     let targetFolder = ensureFolderExists(basePath, 'src', 'components');
@@ -1866,6 +2066,7 @@ export const createPackage = (name_1, uriBase_1, ...args_1) => __awaiter(void 0,
     let { hyphenName, camelCaseName, underscoreName } = setNameVariables(cleanPackageName);
     log("Creating new LINCD package '" + name + "'");
     fs.copySync(path.join(getScriptDir(), '..', '..', 'defaults', 'package'), targetFolder);
+    renameShippedDotfiles(targetFolder);
     //replace variables in some of the copied files
     yield Promise.all([
         'src/index.ts',
@@ -1896,12 +2097,25 @@ export const createPackage = (name_1, uriBase_1, ...args_1) => __awaiter(void 0,
         console.log('yarn probably not working');
         return '';
     }));
-    let installCommand = version.toString().match(/[0-9]+/)
-        ? 'yarn install'
-        : 'npm install';
-    yield execp(`cd ${targetFolder} && ${installCommand} && npm exec lincd build`, true).catch((err) => {
-        console.warn('Could not install dependencies');
+    const setup = planPackageSetup(version.toString(), path.join(getScriptDir(), 'launch.js'));
+    if (setup.yarnrc) {
+        fs.writeFileSync(path.join(targetFolder, '.yarnrc.yml'), setup.yarnrc);
+    }
+    const installed = yield execp(setup.installCommand, true, false, {
+        cwd: targetFolder,
+    })
+        .then(() => true)
+        .catch(() => {
+        console.warn(`Could not install dependencies (${setup.installCommand})`);
+        process.exitCode = 1;
+        return false;
     });
+    if (installed) {
+        yield execp(setup.buildCommand, true, false, { cwd: targetFolder }).catch(() => {
+            console.warn('Dependencies installed, but the initial build failed');
+            process.exitCode = 1;
+        });
+    }
     log(`Prepared a new LINCD package in ${chalk.magenta(targetFolder)}`, `Run ${chalk.blueBright('yarn build')} from this directory to build once`, `Or ${chalk.blueBright('yarn dev')} to continuously rebuild on file changes`);
 });
 var getNextVersion = function (version) {
@@ -1967,6 +2181,7 @@ export const register = function (registryURL) {
     }
 };
 export const buildPackage = (target_1, target2_1, ...args_1) => __awaiter(void 0, [target_1, target2_1, ...args_1], void 0, function* (target, target2, packagePath = process.cwd(), logResults = true) {
+    var _a;
     // Ensure packagePath is absolute and points to a directory containing package.json; if not, go up until we find one
     // First, resolve to absolute path
     let currentPath = path.isAbsolute(packagePath)
@@ -2047,23 +2262,89 @@ export const buildPackage = (target_1, target2_1, ...args_1) => __awaiter(void 0
             });
         });
     };
-    buildStep({
-        name: 'Checking imports',
-        apply: () => checkImports(packagePath + '/src'),
+    if (((_a = pkgJson.linked) === null || _a === void 0 ? void 0 : _a.extensionlessImports) === true) {
+        const skipped = "Skipping the import check: package.json sets 'linked.extensionlessImports'";
+        logResults ? spinner.info(skipped) : console.log(skipped);
+    }
+    planBuildSteps(pkgJson, packagePath).forEach(buildStep);
+    let success = yield buildProcess.catch((err) => {
+        let msg = typeof err === 'string' || err instanceof Error
+            ? err.toString()
+            : err.error && !err.error.toString().includes('Command failed:')
+                ? err.error
+                : err.stdout + '\n' + err.stderr;
+        if (logResults) {
+            spinner.stopAndPersist({
+                symbol: chalk.red('✖'),
+                // text: 'Build failed',
+            });
+        }
+        else {
+            console.error(chalk.red(packagePath.split('/').pop(), ' - Build failed:'));
+            console.error(err);
+            return msg;
+        }
+        console.log(msg);
     });
-    buildStep({
+    //will be undefined if there was an error
+    if (typeof success !== 'undefined' && success !== false) {
+        if (logResults) {
+            spinner.stopAndPersist({
+                symbol: chalk.greenBright('✔'),
+                text: success === true
+                    ? 'Build successful'
+                    : 'Build successful with warnings',
+            });
+        }
+    }
+    else {
+        if (logResults) {
+            spinner.stopAndPersist({
+                symbol: chalk.red('✖'),
+                text: 'Build failed',
+            });
+        }
+    }
+    return success;
+});
+// The ordered `linked build` steps for a linkedPackage. A package whose source
+// uses extensionless relative imports (`"linked": {"extensionlessImports": true}`)
+// skips the import check and gets `.js` added to its emitted ESM specifiers.
+export const planBuildSteps = (pkgJson, packagePath) => {
+    var _a;
+    const extensionlessImports = ((_a = pkgJson.linked) === null || _a === void 0 ? void 0 : _a.extensionlessImports) === true;
+    const steps = [];
+    if (!extensionlessImports) {
+        steps.push({
+            name: 'Checking imports',
+            apply: () => checkImports(packagePath + '/src'),
+        });
+    }
+    steps.push({
         name: 'Compiling ESM',
         apply: () => __awaiter(void 0, void 0, void 0, function* () {
             return compilePackageESM(packagePath);
         }),
     });
-    buildStep({
+    if (extensionlessImports) {
+        steps.push({
+            name: 'Rewriting ESM import specifiers',
+            apply: () => __awaiter(void 0, void 0, void 0, function* () {
+                const libEsm = path.join(packagePath, 'lib', 'esm');
+                if (fs.existsSync(libEsm)) {
+                    yield rewriteExtensionlessImports(libEsm);
+                }
+                return true;
+            }),
+        });
+    }
+    steps.push({
         name: 'Compiling CJS',
         apply: () => __awaiter(void 0, void 0, void 0, function* () {
             return compilePackageCJS(packagePath);
         }),
     });
-    buildStep({
+    steps.push({
         name: 'Copying files to lib folder',
         apply: () => __awaiter(void 0, void 0, void 0, function* () {
             const files = yield glob(packagePath + '/src/**/*.{json,d.ts,css,scss}');
@@ -2086,7 +2367,7 @@ export const buildPackage = (target_1, target2_1, ...args_1) => __awaiter(void 0
             });
         }),
     });
-    buildStep({
+    steps.push({
         name: 'Dual package support',
         apply: () => {
             // Skip if no tsconfig files (e.g. pure-CSS packages).
@@ -2101,56 +2382,18 @@ export const buildPackage = (target_1, target2_1, ...args_1) => __awaiter(void 0
             });
         },
     });
-    buildStep({
+    steps.push({
         name: 'Removing old files from lib folder',
         apply: () => __awaiter(void 0, void 0, void 0, function* () {
             return removeOldFiles(packagePath);
         }),
     });
-    buildStep({
+    steps.push({
         name: 'Checking dependencies',
         apply: () => depCheck(packagePath),
     });
-    let success = yield buildProcess.catch((err) => {
-        let msg = typeof err === 'string' || err instanceof Error
-            ? err.toString()
-            : err.error && !err.error.toString().includes('Command failed:')
-                ? err.error
-                : err.stdout + '\n' + err.stderr;
-        if (logResults) {
-            spinner.stopAndPersist({
-                symbol: chalk.red('✖'),
-                // text: 'Build failed',
-            });
-        }
-        else {
-            console.error(chalk.red(packagePath.split('/').pop(), ' - Build failed:'));
-            console.error(err);
-            return msg;
-        }
-        console.log(msg);
-    });
-    //will be undefined if there was an error
-    if (typeof success !== 'undefined' && success !== false) {
-        if (logResults) {
-            spinner.stopAndPersist({
-                symbol: chalk.greenBright('✔'),
-                text: success === true
-                    ? 'Build successful'
-                    : 'Build successful with warnings',
-            });
-        }
-    }
-    else {
-        if (logResults) {
-            spinner.stopAndPersist({
-                symbol: chalk.red('✖'),
-                text: 'Build failed',
-            });
-        }
-    }
-    return success;
-});
+    return steps;
+};
 export const compilePackage = (...args_1) => __awaiter(void 0, [...args_1], void 0, function* (packagePath = process.cwd()) {
     //echo 'compiling CJS' && tsc -p tsconfig-cjs.json && echo 'compiling ESM' && tsc -p tsconfig-esm.json
     // let cjsConfig = fs.existsSync(path.join(packagePath,'tsconfig-cjs.json'));