@osdk/create-app 0.0.1 → 0.2.0

package/build/js/index.cjs

@@ -2,8 +2,8 @@
 
 var findUp = require('find-up');
 var Handlebars = require('handlebars');
-var fs = require('fs');
-var path = require('path');
+var fs2 = require('fs');
+var path2 = require('path');
 var url = require('url');
 var yargs = require('yargs');
 var helpers = require('yargs/helpers');
@@ -14,8 +14,8 @@ var _documentCurrentScript = typeof document !== 'undefined' ? document.currentS
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
 var Handlebars__default = /*#__PURE__*/_interopDefault(Handlebars);
-var fs__default = /*#__PURE__*/_interopDefault(fs);
-var path__default = /*#__PURE__*/_interopDefault(path);
+var fs2__default = /*#__PURE__*/_interopDefault(fs2);
+var path2__default = /*#__PURE__*/_interopDefault(path2);
 var yargs__default = /*#__PURE__*/_interopDefault(yargs);
 
 // src/cli.ts
@@ -30,6 +30,74 @@ var consola = consola$1.createConsola({
     return response;
   }
 });
+
+// src/generate/generateEnv.ts
+function generateEnvDevelopment({
+  envPrefix,
+  foundryUrl,
+  clientId
+}) {
+  return generateEnv({
+    envPrefix,
+    foundryUrl,
+    applicationUrl: "http://localhost:8080",
+    clientId
+  });
+}
+function generateEnvProduction({
+  envPrefix,
+  foundryUrl,
+  applicationUrl,
+  clientId
+}) {
+  return generateEnv({
+    envPrefix,
+    foundryUrl,
+    applicationUrl: applicationUrl ?? "<Fill in the domain at which you deploy your application>",
+    clientId
+  });
+}
+function generateEnv({
+  envPrefix,
+  foundryUrl,
+  applicationUrl,
+  clientId
+}) {
+  return `${envPrefix}FOUNDRY_API_URL=${foundryUrl}
+${envPrefix}FOUNDRY_REDIRECT_URL=${applicationUrl}/auth/callback
+${envPrefix}FOUNDRY_CLIENT_ID=${clientId}
+`;
+}
+
+// src/generate/generateFoundryConfigJson.ts
+function generateFoundryConfigJson({
+  foundryUrl,
+  application,
+  directory
+}) {
+  return JSON.stringify({
+    foundryUrl,
+    site: {
+      application,
+      directory,
+      autoVersion: {
+        type: "git-describe",
+        tagPrefix: ""
+      }
+    }
+  }, null, 2) + "\n";
+}
+
+// src/generate/generateNpmRc.ts
+function generateNpmRc({
+  osdkPackage,
+  osdkRegistryUrl
+}) {
+  const withoutProtocol = osdkRegistryUrl.replace(/^https:\/\//, "");
+  return `//${withoutProtocol}:_authToken=\${FOUNDRY_TOKEN}
+${osdkPackage.split("/")[0]}:registry=${osdkRegistryUrl}
+`;
+}
 function green(text) {
   return utils.colorize("green", text);
 }
@@ -37,24 +105,223 @@ function italic(text) {
   return utils.colorize("italic", text);
 }
 
+// src/prompts/promptApplicationRid.ts
+async function promptApplicationRid({
+  application
+}) {
+  while (application == null || !/^ri\.third-party-applications\.[^.]+\.application\.[^.]+$/.test(application)) {
+    if (application != null) {
+      consola.fail("Please enter a valid application resource identifier (rid)");
+    }
+    application = await consola.prompt(`Enter the application resource identifier (rid) for your application from Developer Console:
+${italic("(Example ri.third-party-applications.main.application.1c66b352-4e00-40d2-995d-061c9d533ace)")}`, {
+      type: "text"
+    });
+  }
+  return application;
+}
+
+// src/prompts/promptApplicationUrl.ts
+async function promptApplicationUrl({
+  skipApplicationUrl,
+  applicationUrl
+}) {
+  if (skipApplicationUrl) {
+    return void 0;
+  }
+  if (applicationUrl == null) {
+    const skip = await consola.prompt(
+      `Do you know the URL your production application will be hosted on? This is required to create a production build of your application with the correct OAuth redirect URL.`,
+      {
+        type: "select",
+        options: [{
+          label: "Yes, prefill it for me",
+          value: "yes"
+        }, {
+          label: "No, I will fill it in myself later",
+          value: "no"
+        }]
+      }
+      // Types for "select" are wrong the value is returned rather than the option object
+      // https://github.com/unjs/consola/pull/238
+    );
+    if (skip === "no") {
+      return void 0;
+    }
+  }
+  while (applicationUrl == null || !/^https?:\/\//.test(applicationUrl)) {
+    if (applicationUrl != null) {
+      consola.fail("Please enter a valid application URL");
+    }
+    applicationUrl = await consola.prompt(`Enter the URL your production application will be hosted on:
+${italic("(Example https://myapp.example.palantirfoundry.com/)")}`, {
+      type: "text"
+    });
+  }
+  return applicationUrl.replace(/\/$/, "");
+}
+
+// src/prompts/promptClientId.ts
+async function promptClientId({
+  clientId
+}) {
+  while (clientId == null || !/^[0-9a-f]+$/.test(clientId)) {
+    if (clientId != null) {
+      consola.fail("Please enter a valid OAuth client ID");
+    }
+    clientId = await consola.prompt(`Enter the OAuth client ID for your application from Developer Console:
+${italic("(Example 2650385ab6c5e0df3b44aff776b00a42)")}`, {
+      type: "text"
+    });
+  }
+  return clientId;
+}
+
+// src/prompts/promptFoundryUrl.ts
+async function promptFoundryUrl({
+  foundryUrl
+}) {
+  while (foundryUrl == null || !foundryUrl.startsWith("https://")) {
+    if (foundryUrl != null) {
+      consola.fail("Please enter a valid Foundry URL");
+    }
+    foundryUrl = await consola.prompt(`Enter the URL for your Foundry stack:
+${italic("(Example https://example.palantirfoundry.com/)")}`, {
+      type: "text"
+    });
+  }
+  return foundryUrl.replace(/\/$/, "");
+}
+
+// src/prompts/promptOsdkPackage.ts
+async function promptOsdkPackage({
+  osdkPackage
+}) {
+  while (osdkPackage == null || !/^@[a-z0-9-]+\/sdk$/.test(osdkPackage)) {
+    if (osdkPackage != null) {
+      consola.fail("Please enter a valid OSDK package name");
+    }
+    osdkPackage = await consola.prompt(`Enter the OSDK package name for your application from Developer Console:
+${italic("(Example @my-app/sdk)")}`, {
+      type: "text"
+    });
+  }
+  return osdkPackage;
+}
+
+// src/prompts/promptOsdkRegistryUrl.ts
+async function promptOsdkRegistryUrl({
+  osdkRegistryUrl
+}) {
+  while (osdkRegistryUrl == null || !/^https:\/\/[^/]+\/artifacts\/api\/repositories\/ri\.artifacts\.[^/]+\/contents\/release\/npm\/?$/.test(osdkRegistryUrl)) {
+    if (osdkRegistryUrl != null) {
+      consola.fail("Please enter a valid NPM registry URL to install your OSDK package");
+    }
+    osdkRegistryUrl = await consola.prompt(`Enter the NPM registry URL to install your OSDK package from Developer Console:
+${italic("(Example https://example.palantirfoundry.com/artifacts/api/repositories/ri.artifacts.main.repository.a4a7fe1c-486f-4226-b706-7b90005f527d/contents/release/npm)")}`, {
+      type: "text"
+    });
+  }
+  return osdkRegistryUrl.replace(/\/$/, "");
+}
+async function promptOverwrite({
+  project,
+  overwrite
+}) {
+  if (overwrite != null) {
+    return overwrite;
+  }
+  if (!fs2__default.default.existsSync(path2__default.default.join(process.cwd(), project))) {
+    return true;
+  }
+  const result = await consola.prompt(
+    `The directory ${green(project)} already exists do you want to overwrite or ignore it?`,
+    {
+      type: "select",
+      options: [{
+        label: "Remove existing files and continue",
+        value: "overwrite"
+      }, {
+        label: "Ignore files and continue",
+        value: "ignore"
+      }, {
+        label: "Cancel",
+        value: "cancel"
+      }]
+    }
+    // Types for "select" are wrong the value is returned rather than the option object
+    // https://github.com/unjs/consola/pull/238
+  );
+  switch (result) {
+    case "overwrite":
+      return true;
+    case "ignore":
+      return false;
+    case "cancel":
+      consola.fail("Operation cancelled");
+      process.exit(0);
+  }
+}
+
+// src/prompts/promptProject.ts
+async function promptProject({
+  project
+}) {
+  while (project == null || !/^[a-zA-Z0-9-_]+$/.test(project)) {
+    if (project != null) {
+      consola.fail("Project name can only contain alphanumeric characters, hyphens and underscores");
+    }
+    project = await consola.prompt("Project name:", {
+      type: "text",
+      placeholder: "my-osdk-app",
+      default: "my-osdk-app"
+    });
+  }
+  return project;
+}
+
 // src/templates.ts
 var TEMPLATES = [{
   id: "template-react",
   label: "React",
-  envPrefix: "VITE_"
+  envPrefix: "VITE_",
+  buildDirectory: "./dist"
 }, {
   id: "template-vue",
   label: "Vue",
-  envPrefix: "VITE_"
+  envPrefix: "VITE_",
+  buildDirectory: "./dist"
 }, {
   id: "template-next-static-export",
   label: "Next (static export)",
-  envPrefix: "NEXT_PUBLIC_"
+  envPrefix: "NEXT_PUBLIC_",
+  buildDirectory: "./out"
 }];
 
+// src/prompts/promptTemplate.ts
+async function promptTemplate(parsed) {
+  let template = TEMPLATES.find((t) => t.id === parsed.template);
+  if (template == null) {
+    const templateId = await consola.prompt(parsed.template != null ? `The provided template ${green(parsed.template)} is invalid please select a framework:` : "Select a framework:", {
+      type: "select",
+      options: TEMPLATES.map((template2) => ({
+        value: template2.id,
+        label: template2.label
+      }))
+      // Types for "select" are wrong the value is returned rather than the option object
+      // https://github.com/unjs/consola/pull/238
+    });
+    template = TEMPLATES.find((t) => t.id === templateId);
+    if (template == null) {
+      throw new Error(`Template ${templateId} should be found`);
+    }
+  }
+  return template;
+}
+
 // src/cli.ts
 async function cli(args = process.argv) {
-  const base = yargs__default.default(helpers.hideBin(args)).version("0.0.1").strict().help().command("$0 [project] [--<option>]", "Create a new OSDK application based on framework templates. Information may be provided through arguments to skip interactive prompts.", (yargs2) => yargs2.positional("project", {
+  const base = yargs__default.default(helpers.hideBin(args)).version("0.2.0").strict().help().command("$0 [project] [--<option>]", "Create a new OSDK application based on framework templates. Information may be provided through arguments to skip interactive prompts.", (yargs2) => yargs2.positional("project", {
     type: "string",
     describe: "Project name to create"
   }).option("overwrite", {
@@ -72,6 +339,9 @@ async function cli(args = process.argv) {
   }).option("skip-application-url", {
     type: "boolean",
     describe: "Skip filling in URL the production application will be hosted on"
+  }).option("application", {
+    type: "string",
+    describe: "Application resource identifier (rid)"
   }).option("client-id", {
     type: "string",
     describe: "OAuth client ID for application"
@@ -84,25 +354,29 @@ async function cli(args = process.argv) {
   }));
   const parsed = base.parseSync();
   const project = await promptProject(parsed);
-  const overwrite = await promptOverwrite(parsed, project);
+  const overwrite = await promptOverwrite({
+    ...parsed,
+    project
+  });
   const template = await promptTemplate(parsed);
   const foundryUrl = await promptFoundryUrl(parsed);
   const applicationUrl = await promptApplicationUrl(parsed);
+  const application = await promptApplicationRid(parsed);
   const clientId = await promptClientId(parsed);
   const osdkPackage = await promptOsdkPackage(parsed);
   const osdkRegistryUrl = await promptOsdkRegistryUrl(parsed);
   consola.log("");
   consola.start(`Creating project ${green(project)} using template ${green(template.id)}`);
   const cwd = process.cwd();
-  const root = path__default.default.join(cwd, project);
-  if (fs__default.default.existsSync(root)) {
+  const root = path2__default.default.join(cwd, project);
+  if (fs2__default.default.existsSync(root)) {
     if (overwrite) {
       consola.info(`Overwriting existing project directory`);
-      fs__default.default.rmSync(root, {
+      fs2__default.default.rmSync(root, {
         recursive: true,
         force: true
       });
-      fs__default.default.mkdirSync(root, {
+      fs2__default.default.mkdirSync(root, {
         recursive: true
       });
     } else {
@@ -110,26 +384,30 @@ async function cli(args = process.argv) {
     }
   } else {
     consola.info(`Creating project directory`);
-    fs__default.default.mkdirSync(root, {
+    fs2__default.default.mkdirSync(root, {
       recursive: true
     });
   }
   consola.info(`Copying files into project directory`);
   const templatesDir = findUp.findUpSync("templates", {
-    cwd: path__default.default.dirname(url.fileURLToPath((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.src || new URL('out.js', document.baseURI).href)))),
+    cwd: path2__default.default.dirname(url.fileURLToPath((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.src || new URL('out.js', document.baseURI).href)))),
     type: "directory"
   });
   if (templatesDir == null) {
     throw new Error(`Could not find templates directory`);
   }
-  const templateDir = path__default.default.resolve(templatesDir, template.id);
-  fs__default.default.cpSync(templateDir, root, {
+  const templateDir = path2__default.default.resolve(templatesDir, template.id);
+  fs2__default.default.cpSync(templateDir, root, {
     recursive: true
   });
+  const templateContext = {
+    project,
+    osdkPackage
+  };
   const templateHbs = function(dir) {
-    fs__default.default.readdirSync(dir).forEach(function(file) {
+    fs2__default.default.readdirSync(dir).forEach(function(file) {
       file = dir + "/" + file;
-      const stat = fs__default.default.statSync(file);
+      const stat = fs2__default.default.statSync(file);
       if (stat.isDirectory()) {
         templateHbs(file);
         return;
@@ -137,37 +415,43 @@ async function cli(args = process.argv) {
       if (!file.endsWith(".hbs")) {
         return;
       }
-      const hbsContext = {
-        project,
-        osdkPackage
-      };
-      const templated = Handlebars__default.default.compile(fs__default.default.readFileSync(file, "utf-8"))(hbsContext);
-      fs__default.default.writeFileSync(file.replace(/.hbs$/, ""), templated);
-      fs__default.default.rmSync(file);
+      const templated = Handlebars__default.default.compile(fs2__default.default.readFileSync(file, "utf-8"))(templateContext);
+      fs2__default.default.writeFileSync(file.replace(/.hbs$/, ""), templated);
+      fs2__default.default.rmSync(file);
     });
   };
   templateHbs(root);
-  const npmRc = `//${osdkRegistryUrl.replace(/^https:\/\//, "")}:_authToken=\${FOUNDRY_SDK_AUTH_TOKEN}
-${osdkPackage.split("/")[0]}:registry=${osdkRegistryUrl}
-`;
-  fs__default.default.writeFileSync(path__default.default.join(root, ".npmrc"), npmRc);
-  const envDevelopment = `${template.envPrefix}FOUNDRY_API_URL=${foundryUrl}
-${template.envPrefix}FOUNDRY_REDIRECT_URL=http://localhost:8080/auth/callback
-${template.envPrefix}FOUNDRY_CLIENT_ID=${clientId}
-`;
-  fs__default.default.writeFileSync(path__default.default.join(root, ".env.development"), envDevelopment);
-  const envProduction = `${template.envPrefix}FOUNDRY_API_URL=${foundryUrl}
-${template.envPrefix}FOUNDRY_REDIRECT_URL=${applicationUrl != null ? applicationUrl : "<Fill in the domain at which you deploy your application>"}/auth/callback
-${template.envPrefix}FOUNDRY_CLIENT_ID=${clientId}
-`;
-  fs__default.default.writeFileSync(path__default.default.join(root, ".env.production"), envProduction);
+  const npmRc = generateNpmRc({
+    osdkPackage,
+    osdkRegistryUrl
+  });
+  fs2__default.default.writeFileSync(path2__default.default.join(root, ".npmrc"), npmRc);
+  const envDevelopment = generateEnvDevelopment({
+    envPrefix: template.envPrefix,
+    foundryUrl,
+    clientId
+  });
+  fs2__default.default.writeFileSync(path2__default.default.join(root, ".env.development"), envDevelopment);
+  const envProduction = generateEnvProduction({
+    envPrefix: template.envPrefix,
+    foundryUrl,
+    applicationUrl,
+    clientId
+  });
+  fs2__default.default.writeFileSync(path2__default.default.join(root, ".env.production"), envProduction);
+  const foundryConfigJson = generateFoundryConfigJson({
+    foundryUrl,
+    application,
+    directory: template.buildDirectory
+  });
+  fs2__default.default.writeFileSync(path2__default.default.join(root, "foundry.config.json"), foundryConfigJson);
   consola.success("Success");
-  const cdRelative = path__default.default.relative(cwd, root);
+  const cdRelative = path2__default.default.relative(cwd, root);
   consola.box({
     message: `Done! Run the following commands to get started:
 
   \`cd ${cdRelative}\`
-  \`export FOUNDRY_SDK_AUTH_TOKEN=<token>\`
+  \`export FOUNDRY_TOKEN=<token>\`
   \`npm install\`
   \`npm run dev\``,
     style: {
@@ -177,162 +461,6 @@ ${template.envPrefix}FOUNDRY_CLIENT_ID=${clientId}
     }
   });
 }
-async function promptProject(parsed) {
-  let project = parsed.project;
-  while (project == null || !/^[a-zA-Z0-9-_]+$/.test(project)) {
-    if (project != null) {
-      consola.fail("Project name can only contain alphanumeric characters, hyphens and underscores");
-    }
-    project = await consola.prompt("Project name:", {
-      type: "text",
-      placeholder: "my-osdk-app",
-      default: "my-osdk-app"
-    });
-  }
-  return project;
-}
-async function promptOverwrite(parsed, project) {
-  if (!fs__default.default.existsSync(path__default.default.join(process.cwd(), project))) {
-    return true;
-  }
-  if (parsed.overwrite != null) {
-    return parsed.overwrite;
-  }
-  const result = await consola.prompt(
-    `The directory ${green(project)} already exists do you want to overwrite or ignore it?`,
-    {
-      type: "select",
-      options: [{
-        label: "Remove existing files and continue",
-        value: "overwrite"
-      }, {
-        label: "Ignore files and continue",
-        value: "ignore"
-      }, {
-        label: "Cancel",
-        value: "cancel"
-      }]
-    }
-    // Types for "select" are wrong the value is returned rather than the option object
-    // https://github.com/unjs/consola/pull/238
-  );
-  switch (result) {
-    case "overwrite":
-      return true;
-    case "ignore":
-      return false;
-    case "cancel":
-      consola.fail("Operation cancelled");
-      process.exit(0);
-  }
-}
-async function promptTemplate(parsed) {
-  let template = TEMPLATES.find((t) => t.id === parsed.template);
-  if (template == null) {
-    const templateId = await consola.prompt(parsed.template != null ? `The provided template ${green(parsed.template)} is invalid please select a framework:` : "Select a framework:", {
-      type: "select",
-      options: TEMPLATES.map((template2) => ({
-        value: template2.id,
-        label: template2.label
-      }))
-      // Types for "select" are wrong the value is returned rather than the option object
-      // https://github.com/unjs/consola/pull/238
-    });
-    template = TEMPLATES.find((t) => t.id === templateId);
-    if (template == null) {
-      throw new Error(`Template ${templateId} should be found`);
-    }
-  }
-  return template;
-}
-async function promptFoundryUrl(parsed) {
-  let foundryUrl = parsed.foundryUrl;
-  while (foundryUrl == null || !foundryUrl.startsWith("https://")) {
-    if (foundryUrl != null) {
-      consola.fail("Please enter a valid Foundry URL");
-    }
-    foundryUrl = await consola.prompt(`Enter the URL for your Foundry stack:
-${italic("(Example https://example.palantirfoundry.com/)")}`, {
-      type: "text"
-    });
-  }
-  return foundryUrl.replace(/\/$/, "");
-}
-async function promptApplicationUrl(parsed) {
-  if (parsed.skipApplicationUrl) {
-    return void 0;
-  }
-  let applicationUrl = parsed.applicationUrl;
-  if (applicationUrl == null) {
-    const skip = await consola.prompt(
-      `Do you know the URL your production application will be hosted on? This is required to create a production build of your application with the correct OAuth redirect URL.`,
-      {
-        type: "select",
-        options: [{
-          label: "Yes, prefill it for me",
-          value: "yes"
-        }, {
-          label: "No, I will fill it in myself later",
-          value: "no"
-        }]
-      }
-      // Types for "select" are wrong the value is returned rather than the option object
-      // https://github.com/unjs/consola/pull/238
-    );
-    if (skip === "no") {
-      return void 0;
-    }
-  }
-  while (applicationUrl == null || !/^https?:\/\//.test(applicationUrl)) {
-    if (applicationUrl != null) {
-      consola.fail("Please enter a valid application URL");
-    }
-    applicationUrl = await consola.prompt(`Enter the URL your production application will be hosted on:
-${italic("(Example https://myapp.example.palantirfoundry.com/)")}`, {
-      type: "text"
-    });
-  }
-  return applicationUrl.replace(/\/$/, "");
-}
-async function promptClientId(parsed) {
-  let clientId = parsed.clientId;
-  while (clientId == null || !/^[0-9a-f]+$/.test(clientId)) {
-    if (clientId != null) {
-      consola.fail("Please enter a valid OAuth client ID");
-    }
-    clientId = await consola.prompt(`Enter the OAuth client ID for your application from Developer Console:
-${italic("(Example 2650385ab6c5e0df3b44aff776b00a42)")}`, {
-      type: "text"
-    });
-  }
-  return clientId;
-}
-async function promptOsdkPackage(parsed) {
-  let osdkPackage = parsed.osdkPackage;
-  while (osdkPackage == null || !/^@[a-z0-9-]+\/sdk$/.test(osdkPackage)) {
-    if (osdkPackage != null) {
-      consola.fail("Please enter a valid OSDK package name");
-    }
-    osdkPackage = await consola.prompt(`Enter the OSDK package name for your application from Developer Console:
-${italic("(Example @my-app/sdk)")}`, {
-      type: "text"
-    });
-  }
-  return osdkPackage;
-}
-async function promptOsdkRegistryUrl(parsed) {
-  let osdkRegistryUrl = parsed.osdkRegistryUrl;
-  while (osdkRegistryUrl == null || !/^https:\/\/[^/]+\/artifacts\/api\/repositories\/ri\.artifacts\.[^/]+\/contents\/release\/npm\/?$/.test(osdkRegistryUrl)) {
-    if (osdkRegistryUrl != null) {
-      consola.fail("Please enter a valid NPM registry URL to install your OSDK package");
-    }
-    osdkRegistryUrl = await consola.prompt(`Enter the NPM registry URL to install your OSDK package from Developer Console:
-${italic("(Example https://example.palantirfoundry.com/artifacts/api/repositories/ri.artifacts.main.repository.a4a7fe1c-486f-4226-b706-7b90005f527d/contents/release/npm)")}`, {
-      type: "text"
-    });
-  }
-  return osdkRegistryUrl.replace(/\/$/, "");
-}
 
 exports.cli = cli;
 //# sourceMappingURL=out.js.map