@osdk/create-app 2.2.0-beta.2 → 2.2.0-beta.21

package/build/esm/index.js

@@ -2,18 +2,21 @@ import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import { createConsola, consola as consola$1 } from 'consola';
 import { colorize } from 'consola/utils';
-import fs2 from 'fs';
-import path2 from 'path';
+import fs2 from 'node:fs';
+import path2 from 'node:path';
 import { findUpSync } from 'find-up';
 import Handlebars from 'handlebars';
-import { fileURLToPath } from 'url';
+import { fileURLToPath } from 'node:url';
 
 // src/cli.ts
+var cancelSymbol = Symbol.for("cancel");
 var consola = createConsola({
-  // https://github.com/unjs/consola/issues/251
-  async prompt(...params) {
-    const response = await consola$1.prompt(...params);
-    if (typeof response === "symbol" && response.toString() === "Symbol(clack:cancel)") {
+  async prompt(message, opts) {
+    const response = await consola$1.prompt(message, {
+      ...opts,
+      cancel: opts?.cancel ?? "symbol"
+    });
+    if (response === cancelSymbol) {
       consola$1.fail("Operation cancelled");
       process.exit(0);
     }
@@ -49,26 +52,21 @@ async function promptApplicationUrl({
   applicationUrl
 }) {
   if (skipApplicationUrl) {
-    return undefined;
+    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, let me fill it here",
-          value: "yes"
-        }, {
-          label: "No, I will fill it in later following the instructions in the generated README",
-          value: "no"
-        }]
-      }
-      // Types for "select" are wrong the value is returned rather than the option object
-      // https://github.com/unjs/consola/pull/238
-    );
+    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, let me fill it here",
+        value: "yes"
+      }, {
+        label: "No, I will fill it in later following the instructions in the generated README",
+        value: "no"
+      }]
+    });
     if (skip === "no") {
-      return undefined;
+      return void 0;
     }
   }
   while (applicationUrl == null || !/^https?:\/\//.test(applicationUrl)) {
@@ -129,6 +127,22 @@ ${italic("(Example: https://example.palantirfoundry.com)")}`, {
   return foundryUrl.replace(/\/$/, "");
 }
 
+// src/prompts/promptOntologyRid.ts
+async function promptOntologyRid({
+  ontology
+}) {
+  while (ontology == null || !/^ri\.ontology\.[^.]+\.ontology\.[^.]+$/.test(ontology)) {
+    if (ontology != null) {
+      consola.fail("Please enter a valid Ontology resource identifier (rid)");
+    }
+    ontology = await consola.prompt(`Enter the Ontology resource identifier (rid) associated with your Developer Console:
+${italic("(Example: ri.ontology.main.ontology.1df1ce4c-f9d2-0f78-a316-287f6ac80bb2)")}`, {
+      type: "text"
+    });
+  }
+  return ontology;
+}
+
 // src/prompts/promptOsdkPackage.ts
 async function promptOsdkPackage({
   osdkPackage
@@ -170,24 +184,19 @@ async function promptOverwrite({
   if (!fs2.existsSync(path2.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
-  );
+  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"
+    }]
+  });
   switch (result) {
     case "overwrite":
       return true;
@@ -221,18 +230,17 @@ var scopeNameRegex = /^[a-zA-Z-_:]+$/;
 async function promptScopes({
   scopes
 }) {
-  if (scopes == null) {
-    return undefined;
-  }
   while (true) {
-    const invalidScopes = scopes.filter((scope) => !scopeNameRegex.test(scope));
-    const allValidScopes = invalidScopes.length === 0;
-    if (allValidScopes) {
-      break;
+    if (scopes != null) {
+      const invalidScopes = scopes.filter((scope) => !scopeNameRegex.test(scope));
+      const allValidScopes = invalidScopes.length === 0;
+      if (allValidScopes) {
+        break;
+      }
+      const joinedInvalidScopes = invalidScopes.join(", ");
+      consola.fail(`Scopes [ ${joinedInvalidScopes} ] are invalid. Scope names can only contain letters, hyphens, underscores, and colons`);
     }
-    const joinedInvalidScopes = invalidScopes.join(", ");
-    consola.fail(`Scopes [ ${joinedInvalidScopes} ] are invalid. Scope names can only contain letters, hyphens, underscores, and colons`);
-    const stringScopes = await consola.prompt("Scopes:", {
+    const stringScopes = await consola.prompt("Enter the scopes to request during OAuth:", {
       type: "text",
       placeholder: "api:read-data api:write-data",
       default: "api:read-data api:write-data"
@@ -264,18 +272,13 @@ async function promptSdkVersion({
   }
   if (template.files[sdkVersion] == null) {
     consola.fail(`The ${template.label} template does not support a "${sdkVersion}" SDK version.`);
-    sdkVersion = await consola.prompt(
-      `Please choose which version of the OSDK you'd like to use for the ${template.label} template:`,
-      {
-        type: "select",
-        options: Object.keys(template.files).reverse().map((sdkVersion2) => ({
-          label: sdkVersion2,
-          value: sdkVersion2
-        }))
-      }
-      // Types for "select" are wrong the value is returned rather than the option object
-      // https://github.com/unjs/consola/pull/238
-    );
+    sdkVersion = await consola.prompt(`Please choose which version of the OSDK you'd like to use for the ${template.label} template:`, {
+      type: "select",
+      options: Object.keys(template.files).reverse().map((sdkVersion2) => ({
+        label: sdkVersion2,
+        value: sdkVersion2
+      }))
+    });
   }
   return sdkVersion;
 }
@@ -291,9 +294,10 @@ var TEMPLATES = [
     label: "React",
     envPrefix: "VITE_",
     buildDirectory: "./dist",
+    hidden: false,
     files: {
-      "1.x": getPackageFiles(import('./esm-ZXMFAUNZ.js')),
-      "2.x": getPackageFiles(import('./esm-FZSV3C5D.js'))
+      "1.x": getPackageFiles(import('./esm-KU5YPQC2.js')),
+      "2.x": getPackageFiles(import('./esm-O6YHTVZC.js'))
     }
   },
   // Expo
@@ -302,8 +306,9 @@ var TEMPLATES = [
     label: "Expo",
     envPrefix: "EXPO_PUBLIC_",
     buildDirectory: "./dist",
+    hidden: false,
     files: {
-      "2.x": getPackageFiles(import('./esm-BFQ5RNHV.js'))
+      "2.x": getPackageFiles(import('./esm-Z3DTLPV3.js'))
     }
   },
   // Vue
@@ -312,20 +317,10 @@ var TEMPLATES = [
     label: "Vue",
     envPrefix: "VITE_",
     buildDirectory: "./dist",
+    hidden: false,
     files: {
-      "1.x": getPackageFiles(import('./esm-HA4JIHHL.js')),
-      "2.x": getPackageFiles(import('./esm-EXZTN5HA.js'))
-    }
-  },
-  // Next (static export)
-  {
-    id: "template-next-static-export",
-    label: "Next (static export)",
-    envPrefix: "NEXT_PUBLIC_",
-    buildDirectory: "./out",
-    files: {
-      "1.x": getPackageFiles(import('./esm-NFVUE2AE.js')),
-      "2.x": getPackageFiles(import('./esm-4SFFV2ZK.js'))
+      "1.x": getPackageFiles(import('./esm-JF6OCVHP.js')),
+      "2.x": getPackageFiles(import('./esm-KD5U2KOZ.js'))
     }
   },
   // Tutorial: To do App
@@ -334,9 +329,10 @@ var TEMPLATES = [
     label: "Tutorial: To do App",
     envPrefix: "VITE_",
     buildDirectory: "./dist",
+    hidden: true,
     files: {
-      "1.x": getPackageFiles(import('./esm-XWXVWZDN.js')),
-      "2.x": getPackageFiles(import('./esm-WPYEYT7F.js'))
+      "1.x": getPackageFiles(import('./esm-N7ZNHY2Z.js')),
+      "2.x": getPackageFiles(import('./esm-ZJEGQFW7.js'))
     }
   },
   // Tutorial: To do AIP App
@@ -345,30 +341,26 @@ var TEMPLATES = [
     label: "Tutorial: To do AIP App",
     envPrefix: "VITE_",
     buildDirectory: "./dist",
+    hidden: true,
     files: {
-      "1.x": getPackageFiles(import('./esm-YVNV3MQG.js')),
-      "2.x": getPackageFiles(import('./esm-ZDKAQEHX.js'))
+      "1.x": getPackageFiles(import('./esm-SCLZKD46.js')),
+      "2.x": getPackageFiles(import('./esm-S4C4CWK7.js'))
     }
   }
 ];
 
 // src/prompts/promptTemplate.ts
 async function promptTemplate(parsed) {
-  let useBeta = parsed.beta ?? false;
+  const useBeta = parsed.beta ?? false;
   let template = TEMPLATES.find((t) => t.id === parsed.template || t.id === `template-${parsed.template}`);
   if (template == null) {
-    const availableTemplates = TEMPLATES.filter((template2) => !template2.hidden && (useBeta ? template2.isBeta === true : !template2.isBeta));
-    if (availableTemplates.length === 0) {
-      throw new Error("No available templates found for the selected options.");
-    }
+    const availableTemplates = getAvailableTemplatesOrThrow(useBeta);
     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: availableTemplates.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) {
@@ -377,6 +369,13 @@ async function promptTemplate(parsed) {
   }
   return template;
 }
+function getAvailableTemplatesOrThrow(useBeta) {
+  const availableTemplates = TEMPLATES.filter((template) => !template.hidden && (useBeta ? template.isBeta === true : !template.isBeta));
+  if (availableTemplates.length === 0) {
+    throw new Error("No available templates found for the selected options.");
+  }
+  return availableTemplates;
+}
 
 // ../generator-utils/build/esm/changeVersionPrefix.js
 function changeVersionPrefix(version, prefix) {
@@ -398,37 +397,87 @@ function generateEnvDevelopment({
   envPrefix,
   foundryUrl,
   clientId,
-  corsProxy
+  corsProxy,
+  ontology
 }) {
-  return generateEnv({
-    envPrefix,
-    foundryUrl: corsProxy ? "http://localhost:8080" : foundryUrl,
-    applicationUrl: "http://localhost:8080",
-    clientId
-  });
+  const foundryApiUrl = corsProxy ? "http://localhost:8080" : foundryUrl;
+  const applicationUrl = "http://localhost:8080";
+  return `# This env file is intended for developing on your local computer.
+# To set up development in Foundry's Code Workspaces, see .env.code-workspaces.
+# To deploy your application to production, see .env.production.
+# Note that .env.code-workspaces is only present for projects that were set up
+# using the "Bootstrap in Foundry" option in Developer Console.
+
+
+# This URL is the URL your users will be redirected back to after signing in.
+# This URL must exactly match one of the URLs listed in the "OAuth & scopes"
+# page of Developer Console.
+#
+# If your application in development is not hosted on port 8080, you will need
+# to change this URL here and in Developer Console.
+
+${envPrefix}FOUNDRY_REDIRECT_URL=${applicationUrl}/auth/callback
+
+
+# This URL is the Foundry host that your OSDK will use. It typically does not
+# need to be changed.
+
+${envPrefix}FOUNDRY_API_URL=${foundryApiUrl}
+
+
+# This client ID must match the client ID given on the "OAuth & scopes" page of
+# Developer Console. It typically does not need to be changed.
+
+${envPrefix}FOUNDRY_CLIENT_ID=${clientId}
+
+# This Ontology RID must match the Ontology RID your Developer Console is associated with.
+# You can check the Ontology on the "Data Resources" page of Developer Console. 
+# It typically does not need to be changed.
+
+${envPrefix}FOUNDRY_ONTOLOGY_RID=${ontology}
+`;
 }
 function generateEnvProduction({
   envPrefix,
   foundryUrl,
   applicationUrl,
-  clientId
-}) {
-  return generateEnv({
-    envPrefix,
-    foundryUrl,
-    applicationUrl,
-    clientId
-  });
-}
-function generateEnv({
-  envPrefix,
-  foundryUrl,
-  applicationUrl,
-  clientId
+  clientId,
+  ontology
 }) {
-  return `${envPrefix}FOUNDRY_API_URL=${foundryUrl}
-${applicationUrl == null ? "# " : ""}${envPrefix}FOUNDRY_REDIRECT_URL=${applicationUrl ?? "<Fill in the domain at which you deploy your application>"}/auth/callback
+  const applicationUrlOrDefault = applicationUrl ?? "<Fill in the domain at which you deploy your application>";
+  return `# This env file is intended for deploying your application to production.
+# To set up development on your local computer, see .env.development.
+# To set up development in Foundry's Code Workspaces, see .env.code-workspaces.
+# Note that .env.code-workspaces is only present for projects that were set up
+# using the "Bootstrap in Foundry" option in Developer Console.
+
+
+# This URL is the URL your users will be redirected back to after signing in.
+# This URL must exactly match one of the URLs listed in the "OAuth & scopes"
+# page of Developer Console.
+#
+# If you change where your application is hosted, you will need to change this
+# URL here and in Developer Console.
+
+${applicationUrl == null ? "# " : ""}${envPrefix}FOUNDRY_REDIRECT_URL=${applicationUrlOrDefault}/auth/callback
+
+
+# This URL is the Foundry host that your OSDK will use. It typically does not
+# need to be changed.
+
+${envPrefix}FOUNDRY_API_URL=${foundryUrl}
+
+
+# This client ID must match the client ID given on the "OAuth & scopes" page of
+# Developer Console. It typically does not need to be changed.
+
 ${envPrefix}FOUNDRY_CLIENT_ID=${clientId}
+
+# This Ontology RID must match the Ontology RID your Developer Console is associated with.
+# You can check the Ontology on the "Data Resources" page of Developer Console. 
+# It typically does not need to be changed.
+
+${envPrefix}FOUNDRY_ONTOLOGY_RID=${ontology}
 `;
 }
 
@@ -473,6 +522,7 @@ async function run({
   foundryUrl,
   applicationUrl,
   application,
+  ontology,
   clientId,
   osdkPackage,
   osdkRegistryUrl,
@@ -518,8 +568,8 @@ async function run({
   const ourPackageJsonPath = findUpSync("package.json", {
     cwd: fileURLToPath(import.meta.url)
   });
-  ourPackageJsonPath ? JSON.parse(fs2.readFileSync(ourPackageJsonPath, "utf-8")).version : undefined;
-  const clientVersion = "2.2.0-beta.2";
+  ourPackageJsonPath ? JSON.parse(fs2.readFileSync(ourPackageJsonPath, "utf-8")).version : void 0;
+  const clientVersion = "2.2.0-beta.21";
   const templateContext = {
     project,
     foundryUrl,
@@ -558,14 +608,16 @@ async function run({
     envPrefix: template.envPrefix,
     foundryUrl,
     clientId,
-    corsProxy
+    corsProxy,
+    ontology
   });
   fs2.writeFileSync(path2.join(root, ".env.development"), envDevelopment);
   const envProduction = generateEnvProduction({
     envPrefix: template.envPrefix,
     foundryUrl,
     applicationUrl,
-    clientId
+    clientId,
+    ontology
   });
   fs2.writeFileSync(path2.join(root, ".env.production"), envProduction);
   const foundryConfigJson = generateFoundryConfigJson({
@@ -593,7 +645,7 @@ async function run({
 
 // src/cli.ts
 async function cli(args = process.argv) {
-  const base = yargs(hideBin(args)).version("2.2.0-beta.2").wrap(Math.min(150, yargs().terminalWidth())).strict().help().command("$0 [project] [--<option>]", "Create a new OSDK application based on framework templates. Information may be provided through options to skip interactive prompts.", (yargs2) => yargs2.positional("project", {
+  const base = yargs(hideBin(args)).version("2.2.0-beta.21").wrap(Math.min(150, yargs().terminalWidth())).strict().help().command("$0 [project] [--<option>]", "Create a new OSDK application based on framework templates. Information may be provided through options to skip interactive prompts.", (yargs2) => yargs2.positional("project", {
     type: "string",
     describe: "Project name to create"
   }).option("overwrite", {
@@ -621,6 +673,9 @@ async function cli(args = process.argv) {
   }).option("application", {
     type: "string",
     describe: "Application resource identifier (rid)"
+  }).option("ontology", {
+    type: "string",
+    describe: "Ontology resource identifier (rid)"
   }).option("clientId", {
     type: "string",
     describe: "OAuth client ID for application"
@@ -652,6 +707,7 @@ async function cli(args = process.argv) {
   const foundryUrl = await promptFoundryUrl(parsed);
   const applicationUrl = await promptApplicationUrl(parsed);
   const application = await promptApplicationRid(parsed);
+  const ontology = await promptOntologyRid(parsed);
   const clientId = await promptClientId(parsed);
   const osdkPackage = await promptOsdkPackage(parsed);
   const osdkRegistryUrl = await promptOsdkRegistryUrl(parsed);
@@ -669,7 +725,8 @@ async function cli(args = process.argv) {
     osdkPackage,
     osdkRegistryUrl,
     corsProxy,
-    scopes
+    scopes,
+    ontology
   });
 }