piral-cli 1.4.0-beta.6228 → 1.4.0-beta.6247

package/src/common/template.ts

@@ -1,7 +1,12 @@
 import { ForceOverwrite } from './enums';
 import { createFileIfNotExists } from './io';
 
-function fillTemplate(data: any = {}) {
+export interface PiralStubFileTemplateData {
+  outFile: string;
+  name: string;
+}
+
+function fillTemplate(data: PiralStubFileTemplateData) {
   return `if (process.env.NODE_ENV === 'test') {
   // behavior for the test environment, we'll try to make it work
 
@@ -24,8 +29,8 @@ function fillTemplate(data: any = {}) {
 export async function createPiralStubIndexIfNotExists(
   targetDir: string,
   fileName: string,
-  forceOverwrite?: ForceOverwrite,
-  data?: any,
+  forceOverwrite: ForceOverwrite,
+  data: PiralStubFileTemplateData,
 ) {
   const content = fillTemplate(data);
   await createFileIfNotExists(targetDir, fileName, content, forceOverwrite);

package/src/common/website.ts

@@ -0,0 +1,67 @@
+import { resolve as resolveUrl } from 'url';
+import { join, resolve } from 'path';
+import { createPiralStubIndexIfNotExists } from './template';
+import { packageJson } from './constants';
+import { ForceOverwrite } from './enums';
+import { createDirectory, writeBinary } from './io';
+import { writeJson } from './io';
+import { axios } from '../external';
+import { EmulatorWebsiteManifestFiles, EmulatorWebsiteManifest } from '../types';
+
+async function downloadEmulatorFiles(manifestUrl: string, target: string, files: EmulatorWebsiteManifestFiles) {
+  const requiredFiles = [files.typings, files.main, files.app];
+
+  await Promise.all(
+    requiredFiles.map(async (file) => {
+      const res = await axios.default.get(resolveUrl(manifestUrl, file), { responseType: 'arraybuffer' });
+      const data: Buffer = res.data;
+      await writeBinary(target, file, data);
+    }),
+  );
+}
+
+export async function scaffoldFromEmulatorWebsite(rootDir: string, manifestUrl: string) {
+  const response = await axios.default.get(manifestUrl);
+  const emulatorJson: EmulatorWebsiteManifest = response.data;
+
+  const targetDir = resolve(rootDir, 'node_modules', emulatorJson.name);
+  const appDirName = 'app';
+  const mainFile = 'index.js';
+  const appDir = resolve(targetDir, appDirName);
+  await createDirectory(appDir);
+
+  await writeJson(
+    targetDir,
+    packageJson,
+    {
+      name: emulatorJson.name,
+      description: emulatorJson.description,
+      version: emulatorJson.version,
+      importmap: emulatorJson.importmap,
+      pilets: emulatorJson.scaffolding.pilets,
+      piralCLI: {
+        version: emulatorJson.scaffolding.cli,
+        timestamp: emulatorJson.timestamp,
+        source: manifestUrl,
+        generated: true,
+      },
+      files: emulatorJson.files,
+      main: `./${join(appDirName, mainFile)}`,
+      typings: `./${join(appDirName, emulatorJson.files.typings)}`,
+      app: `./${join(appDirName, emulatorJson.files.app)}`,
+      peerDependencies: {},
+      optionalDependencies: emulatorJson.dependencies.optional,
+      devDependencies: emulatorJson.dependencies.included,
+    },
+    true,
+  );
+
+  // actually including this one hints that the app shell should have been included - which is forbidden
+  await createPiralStubIndexIfNotExists(appDir, mainFile, ForceOverwrite.yes, {
+    name: emulatorJson.name,
+    outFile: emulatorJson.files.main,
+  });
+
+  await downloadEmulatorFiles(manifestUrl, appDir, emulatorJson.files);
+  return emulatorJson;
+}

package/src/helpers.ts

@@ -14,7 +14,13 @@ import type {
 export const schemaKeys: Array<PiletSchemaVersion> = ['v0', 'v1', 'v2', 'v3', 'none'];
 export const publishModeKeys: Array<PiletPublishScheme> = ['none', 'basic', 'bearer', 'digest'];
 export const fromKeys: Array<PiletPublishSource> = ['local', 'remote', 'npm'];
-export const piralBuildTypeKeys: Array<PiralBuildType> = ['all', 'release', 'emulator', 'emulator-sources'];
+export const piralBuildTypeKeys: Array<PiralBuildType> = [
+  'all',
+  'release',
+  'emulator',
+  'emulator-sources',
+  'emulator-website',
+];
 export const piletBuildTypeKeys: Array<PiletBuildType> = ['default', 'standalone', 'manifest'];
 export const clientTypeKeys: Array<NpmClientType> = ['npm', 'pnpm', 'pnp', 'yarn', 'lerna', 'rush', 'bun'];
 export const sourceLanguageKeys: Array<SourceLanguage> = ['ts', 'js'];

package/src/types/common.ts

@@ -4,6 +4,30 @@ export interface Importmap {
   exclude?: Array<string>;
 }
 
+export interface EmulatorWebsiteManifestFiles {
+  typings: string;
+  main: string;
+  app: string;
+  assets: Array<string>;
+}
+
+export interface EmulatorWebsiteManifest {
+  name: string;
+  description: string;
+  version: string;
+  timestamp: string;
+  scaffolding: {
+    pilets: PiletsInfo;
+    cli: string;
+  };
+  files: EmulatorWebsiteManifestFiles;
+  importmap: Importmap;
+  dependencies: {
+    optional: Record<string, string>;
+    included: Record<string, string>;
+  };
+}
+
 export interface PackageData {
   name: string;
   version: string;

package/src/types/internal.ts

@@ -1,19 +1,20 @@
 import type { LogLevels } from './common';
 import type { ImportmapVersions, PiletSchemaVersion } from './public';
 
+export interface PiralInstanceDetails {
+  selected?: boolean;
+  port?: number;
+  path?: string;
+  url?: string;
+}
+
 /**
  * Shape of the pilet.json
  */
 export interface PiletDefinition {
   schemaVersion?: PiletSchemaVersion;
   importmapVersions?: ImportmapVersions;
-  piralInstances?: Record<
-    string,
-    {
-      selected?: boolean;
-      port?: number;
-    }
-  >;
+  piralInstances?: Record<string, PiralInstanceDetails>;
 }
 
 export interface PackageFiles {

package/src/types/public.ts

@@ -136,6 +136,7 @@ export interface BundlerPrepareArgs<T> {
 
 export interface BaseBundlerDefinition<T> {
   path: string;
+  exec?: string;
   prepare?: BundlerPrepareArgs<T>;
 }
 
@@ -231,11 +232,11 @@ export type PiletPublishScheme = 'none' | 'digest' | 'bearer' | 'basic';
 
 export type PiletPublishSource = 'local' | 'npm' | 'remote';
 
-export type PiralBuildType = 'all' | 'release' | 'emulator' | 'emulator-sources';
+export type PiralBuildType = 'all' | 'release' | 'emulator' | 'emulator-sources' | 'emulator-website';
 
 export type PiletBuildType = 'default' | 'standalone' | 'manifest';
 
-export type PackageType = 'registry' | 'file' | 'git';
+export type PackageType = 'registry' | 'file' | 'git' | 'remote';
 
 export type NpmClientType = 'npm' | 'yarn' | 'pnp' | 'pnpm' | 'lerna' | 'rush' | 'bun';