@rathnasgala/cli 0.0.4 → 0.0.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rathnasgala/cli",
-  "version": "0.0.4",
+  "version": "0.0.7",
   "type": "module",
   "files": [
     "src"
@@ -14,7 +14,9 @@
   },
   "scripts": {
     "test": "node --test",
-    "lint": "node scripts/lint.js"
+    "lint": "node scripts/lint.js",
+    "preversion": "npm test && npm run lint",
+    "push": "node scripts/push.js"
   },
   "engines": {
     "node": ">=18"
@@ -24,7 +26,7 @@
     "url": "git+https://github.com/rathnasgala/cli.git"
   },
   "dependencies": {
-    "@rathnasgala/content-validation": "0.0.1",
+    "@rathnasgala/content-validation": "0.0.2",
     "libsodium-wrappers": "0.8.4",
     "tar": "7.5.22",
     "yaml": "2.9.0"

package/src/configure-site.js

@@ -1,7 +1,7 @@
 import { lstat, readFile, rename, rm, writeFile } from 'node:fs/promises';
 import path from 'node:path';
 import { normalizeSiteConfigurationOptions } from '@rathnasgala/content-validation';
-import { parse, stringify } from 'yaml';
+import { parseDocument } from 'yaml';
 
 import { scaffoldOptionNames } from './scaffold-options.js';
 
@@ -25,14 +25,18 @@ export async function configureSite(root, designOptions) {
   }
 
   let config;
+  let document;
   try {
-    config = parse(await readFile(configPath, 'utf8'));
+    document = parseDocument(await readFile(configPath, 'utf8'));
+    if (document.errors.length > 0) throw document.errors[0];
+    config = document.toJS();
   } catch (error) {
     throw new TypeError(`Invalid site.config.yml: ${error.message}`);
   }
   if (config.schemaVersion !== 1 || config.design == null || Array.isArray(config.design)) {
     throw new TypeError('Unsupported site configuration schema');
   }
+  if (Object.keys(designOptions).length === 0) return config;
 
   const siteOptions = Object.fromEntries(
     Object.entries(designOptions).filter(([name]) => !scaffoldOptionNames.includes(name))
@@ -42,25 +46,38 @@ export async function configureSite(root, designOptions) {
   for (const [name, value] of Object.entries(designOptions)) {
     if (scaffoldOptionNames.includes(name)) {
       config.design[name] = nonEmptyString(value, `Design option ${name}`);
+      document.setIn(['design', name], config.design[name]);
     }
   }
-  if (normalizedSiteOptions.siteName != null) config.site.name = normalizedSiteOptions.siteName;
-  if (normalizedSiteOptions.siteAuthor != null) config.site.author = normalizedSiteOptions.siteAuthor;
+  if (normalizedSiteOptions.siteName != null) {
+    config.site.name = normalizedSiteOptions.siteName;
+    document.setIn(['site', 'name'], config.site.name);
+  }
+  if (normalizedSiteOptions.siteAuthor != null) {
+    config.site.author = normalizedSiteOptions.siteAuthor;
+    document.setIn(['site', 'author'], config.site.author);
+  }
   if (normalizedSiteOptions.defaultLanguage != null) {
     config.site.defaultLanguage = normalizedSiteOptions.defaultLanguage;
+    document.setIn(['site', 'defaultLanguage'], config.site.defaultLanguage);
+  }
+  if (normalizedSiteOptions.timezone != null) {
+    config.site.timezone = normalizedSiteOptions.timezone;
+    document.setIn(['site', 'timezone'], config.site.timezone);
   }
-  if (normalizedSiteOptions.timezone != null) config.site.timezone = normalizedSiteOptions.timezone;
   if (normalizedSiteOptions.shareTargets != null) {
     config.sharing.targets = normalizedSiteOptions.shareTargets;
+    document.setIn(['sharing', 'targets'], config.sharing.targets);
   }
   if (normalizedSiteOptions.socialProfiles != null) {
     config.sharing.socialProfiles = normalizedSiteOptions.socialProfiles;
+    document.setIn(['sharing', 'socialProfiles'], config.sharing.socialProfiles);
   }
 
   const temporary = `${configPath}.gala-config-${process.pid}`;
   const backup = `${configPath}.gala-backup-${process.pid}`;
   try {
-    await writeFile(temporary, stringify(config), { flag: 'wx' });
+    await writeFile(temporary, String(document), { flag: 'wx' });
     await rename(configPath, backup);
     try {
       await rename(temporary, configPath);

package/src/scaffold-site.js

@@ -21,9 +21,8 @@ function segment(value, field) {
   return value;
 }
 
-function providerDefaultBase(owner, repository) {
-  const rootRepository = repository.toLowerCase() === `${owner}.github.io`.toLowerCase();
-  return `https://${owner.toLowerCase()}.github.io${rootRepository ? '/' : `/${repository}/`}`;
+function providerDefaultBase(owner) {
+  return `https://${owner.toLowerCase()}.github.io`;
 }
 
 export async function scaffoldSite({
@@ -77,7 +76,7 @@ export async function scaffoldSite({
     if (emptyExistingRepository) await setOrigin({ root, owner: repositoryOwner, repository: repositoryName });
   }
   const configured = await configure(root, siteOptions ?? {});
-  const canonicalBaseUrl = providerDefaultBase(repositoryOwner, repositoryName);
+  const canonicalBaseUrl = providerDefaultBase(repositoryOwner);
   const idempotencyKey = `scaffold-${createHash('sha256').update(`${repositoryOwner.toLowerCase()}/${repositoryName.toLowerCase()}`).digest('hex')}`;
   const registration = await register({
     apiBaseUrl: gala.apiBaseUrl, galaAccessToken: gala.accessToken, idempotencyKey,
@@ -87,6 +86,7 @@ export async function scaffoldSite({
   await finalize(root, {
     siteId: registration.siteId,
     canonicalBaseUrl: registration.canonicalBaseUrl,
+    pathPrefix: registration.pathPrefix,
     topology: 'provider-default'
   });
   await writeWorkflow({

package/src/site-config-registration.js

@@ -2,12 +2,20 @@ import { lstat, readFile, rename, rm, writeFile } from 'node:fs/promises';
 import path from 'node:path';
 import { parse, stringify } from 'yaml';
 
-export async function writeRegisteredSiteConfiguration(root, { siteId, canonicalBaseUrl, topology }) {
+export async function writeRegisteredSiteConfiguration(root, {
+  siteId, canonicalBaseUrl, pathPrefix, topology
+}) {
   if (!/^[0-7][0-9A-HJKMNP-TV-Z]{25}$/.test(siteId)) throw new TypeError('siteId is invalid');
   if (topology !== 'provider-default') throw new TypeError('Only provider-default topology is implemented');
   const canonical = new URL(canonicalBaseUrl);
-  if (canonical.protocol !== 'https:' || canonical.username || canonical.password || canonical.search || canonical.hash) {
-    throw new TypeError('canonicalBaseUrl must be credential-free HTTPS');
+  if (canonical.protocol !== 'https:' || canonical.username || canonical.password || canonical.search
+      || canonical.hash || canonical.pathname !== '/') {
+    throw new TypeError('canonicalBaseUrl must be a credential-free HTTPS origin; put the URL path in pathPrefix');
+  }
+  const normalizedPrefix = pathPrefix === '' ? '/' : pathPrefix;
+  if (typeof normalizedPrefix !== 'string'
+      || !/^\/(?:[^/?#]+(?:\/[^/?#]+)*)?$/.test(normalizedPrefix)) {
+    throw new TypeError('pathPrefix must be a normalized URL path');
   }
   const target = path.resolve(root, 'site.config.yml');
   const metadata = await lstat(target);
@@ -19,8 +27,8 @@ export async function writeRegisteredSiteConfiguration(root, { siteId, canonical
   config.site.id = siteId;
   config.hosting.provider = 'github-pages';
   config.hosting.topology = topology;
-  config.hosting.canonicalBaseUrl = canonical.href.replace(/\/$/, '');
-  config.hosting.pathPrefix = canonical.pathname === '/' ? '/' : canonical.pathname.replace(/\/$/, '');
+  config.hosting.canonicalBaseUrl = canonical.origin;
+  config.hosting.pathPrefix = normalizedPrefix;
   const temporary = `${target}.gala-register-${process.pid}`;
   const backup = `${target}.gala-backup-${process.pid}`;
   try {

package/src/site-registration-client.js

@@ -72,9 +72,13 @@ export async function registerSite({
   }
   const canonical = new URL(payload.canonicalBaseUrl);
   if (canonical.protocol !== 'https:' || canonical.username || canonical.password
-      || canonical.search || canonical.hash) {
+      || canonical.search || canonical.hash || canonical.pathname !== '/') {
     throw new TypeError('Gala site registration returned an invalid canonicalBaseUrl');
   }
+  if (typeof payload.pathPrefix !== 'string'
+      || !/^\/(?:[^/?#]+(?:\/[^/?#]+)*)?$/.test(payload.pathPrefix)) {
+    throw new TypeError('Gala site registration returned an invalid pathPrefix');
+  }
   const location = response.headers?.get?.('location');
   if (location !== `/v1/sites/${payload.siteId}`) {
     throw new TypeError('Gala site registration returned an invalid Location header');
@@ -82,6 +86,7 @@ export async function registerSite({
   return Object.freeze({
     siteId: payload.siteId,
     siteSecret: payload.siteSecret,
-    canonicalBaseUrl: canonical.href
+    canonicalBaseUrl: canonical.origin,
+    pathPrefix: payload.pathPrefix === '' ? '/' : payload.pathPrefix
   });
 }