@osdk/create-app 2.6.0-rc.15 → 2.6.0-rc.16

package/build/esm/index.js

@@ -127,10 +127,32 @@ ${italic("(Example: https://example.palantirfoundry.com)")}`, {
   return foundryUrl.replace(/\/$/, "");
 }
 
-// src/prompts/promptOntologyRid.ts
-async function promptOntologyRid({
-  ontology
+// src/prompts/promptOntologyAndOsdkPackageAndOsdkRegistryUrl.ts
+async function promptOntologyAndOsdkPackageAndOsdkRegistryUrl({
+  ontology,
+  osdkPackage,
+  osdkRegistryUrl,
+  skipOsdk,
+  sdkVersion
 }) {
+  if (skipOsdk) {
+    return {};
+  }
+  if (sdkVersion !== "1.x" && osdkPackage == null && ontology == null && osdkRegistryUrl == null) {
+    const skip = await consola.prompt("Will you be using an OSDK in your application?", {
+      type: "select",
+      options: [{
+        label: "Yes, I will be using an OSDK",
+        value: "yes"
+      }, {
+        label: "No, I will only be using Platform APIs",
+        value: "no"
+      }]
+    });
+    if (skip === "no") {
+      return {};
+    }
+  }
   while (ontology == null || !/^ri\.ontology\.[^.]+\.ontology\.[^.]+$/.test(ontology)) {
     if (ontology != null) {
       consola.fail("Please enter a valid Ontology resource identifier (rid)");
@@ -140,13 +162,6 @@ ${italic("(Example: ri.ontology.main.ontology.1df1ce4c-f9d2-0f78-a316-287f6ac80b
       type: "text"
     });
   }
-  return ontology;
-}
-
-// 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");
@@ -156,13 +171,6 @@ ${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");
@@ -172,7 +180,11 @@ ${italic("(Example: https://example.palantirfoundry.com/artifacts/api/repositori
       type: "text"
     });
   }
-  return osdkRegistryUrl.replace(/\/$/, "");
+  return {
+    ontology,
+    osdkPackage,
+    osdkRegistryUrl: osdkRegistryUrl.replace(/\/$/, "")
+  };
 }
 async function promptOverwrite({
   project,
@@ -296,8 +308,8 @@ var TEMPLATES = [
     buildDirectory: "./dist",
     hidden: false,
     files: {
-      "1.x": getPackageFiles(import('./esm-ZNWIB6WR.js')),
-      "2.x": getPackageFiles(import('./esm-X2E7QWV3.js'))
+      "1.x": getPackageFiles(import('./esm-RRX43VDZ.js')),
+      "2.x": getPackageFiles(import('./esm-E6VURJO2.js'))
     }
   },
   // Expo
@@ -308,7 +320,7 @@ var TEMPLATES = [
     buildDirectory: "./dist",
     hidden: false,
     files: {
-      "2.x": getPackageFiles(import('./esm-UYHS7HJF.js'))
+      "2.x": getPackageFiles(import('./esm-RL6PMHXG.js'))
     }
   },
   // Vue
@@ -319,8 +331,8 @@ var TEMPLATES = [
     buildDirectory: "./dist",
     hidden: false,
     files: {
-      "1.x": getPackageFiles(import('./esm-BFU2C5I6.js')),
-      "2.x": getPackageFiles(import('./esm-YAHWUN5G.js'))
+      "1.x": getPackageFiles(import('./esm-BPDOE2XQ.js')),
+      "2.x": getPackageFiles(import('./esm-27S7ZNUY.js'))
     }
   },
   // Tutorial: To do App
@@ -331,8 +343,8 @@ var TEMPLATES = [
     buildDirectory: "./dist",
     hidden: true,
     files: {
-      "1.x": getPackageFiles(import('./esm-IPIUMRUZ.js')),
-      "2.x": getPackageFiles(import('./esm-OAZKICK5.js'))
+      "1.x": getPackageFiles(import('./esm-QTVEFJ72.js')),
+      "2.x": getPackageFiles(import('./esm-HPTIRCUT.js'))
     }
   },
   // Tutorial: To do AIP App
@@ -343,8 +355,8 @@ var TEMPLATES = [
     buildDirectory: "./dist",
     hidden: true,
     files: {
-      "1.x": getPackageFiles(import('./esm-CE2B34NS.js')),
-      "2.x": getPackageFiles(import('./esm-N4SPMGQ5.js'))
+      "1.x": getPackageFiles(import('./esm-BZCH5TWU.js')),
+      "2.x": getPackageFiles(import('./esm-VF46BQ3A.js'))
     }
   }
 ];
@@ -402,6 +414,14 @@ function generateEnvDevelopment({
 }) {
   const foundryApiUrl = corsProxy ? "http://localhost:8080" : foundryUrl;
   const applicationUrl = "http://localhost:8080";
+  const ontologyEnvSection = ontology != null ? `
+
+# This Ontology RID must match the Ontology RID your Developer Console is associated with.
+# You can check the Ontology on the "Ontology SDK" tab of Developer Console.
+# It typically does not need to be changed.
+
+${envPrefix}FOUNDRY_ONTOLOGY_RID=${ontology}
+` : "";
   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.
@@ -429,13 +449,7 @@ ${envPrefix}FOUNDRY_API_URL=${foundryApiUrl}
 # 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}
-`;
+${ontologyEnvSection}`;
 }
 function generateEnvProduction({
   envPrefix,
@@ -445,6 +459,14 @@ function generateEnvProduction({
   ontology
 }) {
   const applicationUrlOrDefault = applicationUrl ?? "<Fill in the domain at which you deploy your application>";
+  const ontologyEnvSection = ontology != null ? `
+
+# This Ontology RID must match the Ontology RID your Developer Console is associated with.
+# You can check the Ontology on the "Ontology SDK" tab of Developer Console.
+# It typically does not need to be changed.
+
+${envPrefix}FOUNDRY_ONTOLOGY_RID=${ontology}
+` : "";
   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.
@@ -472,13 +494,7 @@ ${envPrefix}FOUNDRY_API_URL=${foundryUrl}
 # 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}
-`;
+${ontologyEnvSection}`;
 }
 
 // src/generate/generateFoundryConfigJson.ts
@@ -502,14 +518,16 @@ function generateFoundryConfigJson({
 
 // src/generate/generateNpmRc.ts
 function generateNpmRc({
+  foundryUrl,
   osdkPackage,
   osdkRegistryUrl
 }) {
-  const withTrailingSlash = osdkRegistryUrl.endsWith("/") ? osdkRegistryUrl : osdkRegistryUrl + "/";
-  const withoutProtocol = withTrailingSlash.replace(/^https:\/\//, "");
+  const osdkRegistryUrlWithTrailingSlash = osdkRegistryUrl.endsWith("/") ? osdkRegistryUrl : osdkRegistryUrl + "/";
+  const formattedFoundryUrl = foundryUrl.replace(/^https:\/\//, "").replace(/\/$/, "");
+  const artifactsApiUrl = formattedFoundryUrl + "/artifacts/api/";
   const packageScope = osdkPackage.split("/")[0];
-  return `//${withoutProtocol}:_authToken=\${FOUNDRY_TOKEN}
-${packageScope}:registry=${withTrailingSlash}
+  return `//${artifactsApiUrl}:_authToken=\${FOUNDRY_TOKEN}
+${packageScope}:registry=${osdkRegistryUrlWithTrailingSlash}
 `;
 }
 
@@ -569,8 +587,10 @@ async function run({
     cwd: fileURLToPath(import.meta.url)
   });
   ourPackageJsonPath ? JSON.parse(fs2.readFileSync(ourPackageJsonPath, "utf-8")).version : void 0;
-  const clientVersion = "2.6.0-rc.15";
+  const clientVersion = "2.6.0-rc.16";
   const templateContext = {
+    application,
+    applicationUrl,
     project,
     foundryUrl,
     osdkPackage,
@@ -580,30 +600,50 @@ async function run({
   };
   const processFiles = function(dir) {
     fs2.readdirSync(dir).forEach(function(file) {
-      file = dir + "/" + file;
-      const stat = fs2.statSync(file);
+      let fullPath = dir + "/" + file;
+      const stat = fs2.statSync(fullPath);
       if (stat.isDirectory()) {
-        processFiles(file);
+        processFiles(fullPath);
         return;
       }
-      if (file.endsWith("/_gitignore")) {
-        fs2.renameSync(file, file.replace(/\/_gitignore$/, "/.gitignore"));
+      if (fullPath.endsWith("/_gitignore")) {
+        fs2.renameSync(fullPath, fullPath.replace(/\/_gitignore$/, "/.gitignore"));
         return;
       }
-      if (!file.endsWith(".hbs")) {
+      if (file.includes(".osdk")) {
+        if (osdkPackage == null) {
+          fs2.rmSync(fullPath);
+          return;
+        } else {
+          fs2.renameSync(fullPath, fullPath.replace(".osdk", ""));
+          fullPath = fullPath.replace(".osdk", "");
+        }
+      } else if (file.includes(".psdk")) {
+        if (osdkPackage == null) {
+          fs2.renameSync(fullPath, fullPath.replace(".psdk", ""));
+          fullPath = fullPath.replace(".psdk", "");
+        } else {
+          fs2.rmSync(fullPath);
+          return;
+        }
+      }
+      if (!fullPath.endsWith(".hbs")) {
         return;
       }
-      const templated = Handlebars.compile(fs2.readFileSync(file, "utf-8"))(templateContext);
-      fs2.writeFileSync(file.replace(/.hbs$/, ""), templated);
-      fs2.rmSync(file);
+      const templated = Handlebars.compile(fs2.readFileSync(fullPath, "utf-8"))(templateContext);
+      fs2.writeFileSync(fullPath.replace(/.hbs$/, ""), templated);
+      fs2.rmSync(fullPath);
     });
   };
   processFiles(root);
-  const npmRc = generateNpmRc({
-    osdkPackage,
-    osdkRegistryUrl
-  });
-  fs2.writeFileSync(path2.join(root, ".npmrc"), npmRc);
+  if (osdkPackage != null && osdkRegistryUrl != null) {
+    const npmRc = generateNpmRc({
+      osdkPackage,
+      osdkRegistryUrl,
+      foundryUrl
+    });
+    fs2.writeFileSync(path2.join(root, ".npmrc"), npmRc);
+  }
   const envDevelopment = generateEnvDevelopment({
     envPrefix: template.envPrefix,
     foundryUrl,
@@ -645,7 +685,7 @@ async function run({
 
 // src/cli.ts
 async function cli(args = process.argv) {
-  const base = yargs(hideBin(args)).version("2.6.0-rc.15").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.6.0-rc.16").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", {
@@ -675,13 +715,18 @@ async function cli(args = process.argv) {
     describe: "Application resource identifier (rid)"
   }).option("ontology", {
     type: "string",
-    describe: "Ontology resource identifier (rid)"
+    describe: "Ontology resource identifier (rid)",
+    conflicts: "skipOsdk"
+  }).option("osdkPackage", {
+    type: "string",
+    describe: "OSDK package name for application",
+    conflicts: "skipOsdk"
+  }).option("skipOsdk", {
+    type: "boolean",
+    describe: "Skip filling in OSDK options"
   }).option("clientId", {
     type: "string",
     describe: "OAuth client ID for application"
-  }).option("osdkPackage", {
-    type: "string",
-    describe: "OSDK package name for application"
   }).option("osdkRegistryUrl", {
     type: "string",
     describe: "URL for NPM registry to install OSDK package"
@@ -692,6 +737,11 @@ async function cli(args = process.argv) {
     type: "string",
     array: true,
     describe: "List of client-side scopes to be used when creating a client"
+  }).check((argv) => {
+    if (argv.skipOsdk && (argv.sdkVersion == null || argv.sdkVersion.startsWith("1."))) {
+      throw new Error("The --skipOsdk flag is only allowed when sdkVersion is 2.x. Please set --sdkVersion to 2.x or remove the --skipOsdk flag.");
+    }
+    return true;
   }));
   const parsed = base.parseSync();
   const project = await promptProject(parsed);
@@ -707,10 +757,15 @@ 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);
+  const {
+    osdkPackage,
+    ontology,
+    osdkRegistryUrl
+  } = await promptOntologyAndOsdkPackageAndOsdkRegistryUrl({
+    ...parsed,
+    sdkVersion
+  });
   const corsProxy = await promptCorsProxy(parsed);
   const scopes = await promptScopes(parsed);
   await run({