@osdk/create-app 0.17.0-beta.3 → 0.17.0-beta.4

package/templates/template-tutorial-todo-app/src/index.css

@@ -1,75 +0,0 @@
-:root {
-  font-family: Inter, system-ui, Avenir, Helvetica, Arial, sans-serif;
-  line-height: 1.5;
-  font-weight: 400;
-
-  font-synthesis: none;
-  text-rendering: optimizeLegibility;
-  -webkit-font-smoothing: antialiased;
-  -moz-osx-font-smoothing: grayscale;
-}
-
-#root-container {
-  display: flex;
-  flex: 1;
-  align-items: center;
-}
-
-#root {
-  max-width: 1280px;
-  margin: 2rem auto;
-  padding: 2rem;
-}
-
-a {
-  font-weight: 500;
-  color: #646cff;
-  text-decoration: inherit;
-}
-a:hover {
-  color: #535bf2;
-}
-
-body {
-  margin: 0;
-  display: flex;
-  flex-direction: column;
-  min-width: 320px;
-  min-height: 100vh;
-}
-
-h1 {
-  font-size: 3.2em;
-  line-height: 1.1;
-}
-
-button {
-  border-radius: 8px;
-  border: 1px solid transparent;
-  padding: 0.6em 1.2em;
-  font-size: 1em;
-  font-weight: 500;
-  font-family: inherit;
-  cursor: pointer;
-  transition: border-color 0.25s;
-}
-button:hover {
-  border-color: #646cff;
-}
-button:focus,
-button:focus-visible {
-  outline: 4px auto -webkit-focus-ring-color;
-}
-
-@media (prefers-color-scheme: light) {
-  :root {
-    color: #213547;
-    background-color: #ffffff;
-  }
-  a:hover {
-    color: #747bff;
-  }
-  button {
-    background-color: #f9f9f9;
-  }
-}

package/templates/template-tutorial-todo-app/src/main.tsx

@@ -1,36 +0,0 @@
-import ReactDOM from "react-dom/client";
-import { createBrowserRouter, RouterProvider } from "react-router-dom";
-import AuthCallback from "./AuthCallback";
-import AuthenticatedRoute from "./AuthenticatedRoute";
-import Home from "./Home";
-import Login from "./Login";
-import "./index.css";
-
-const router = createBrowserRouter(
-  [
-    {
-      path: "/",
-      element: <AuthenticatedRoute />,
-      children: [
-        {
-          path: "/",
-          element: <Home />,
-        },
-      ],
-    },
-    {
-      path: "/login",
-      element: <Login />,
-    },
-    {
-      // This is the route defined in your application's redirect URL
-      path: "/auth/callback",
-      element: <AuthCallback />,
-    },
-  ],
-  { basename: import.meta.env.BASE_URL },
-);
-
-ReactDOM.createRoot(document.getElementById("root")!).render(
-  <RouterProvider router={router} />,
-);

package/templates/template-tutorial-todo-app/src/mocks.ts

@@ -1,137 +0,0 @@
-export interface MockProject {
-  $apiName: string;
-  $primaryKey: string;
-  id: string;
-  name: string;
-  tasks: MockTask[];
-}
-
-export interface MockTask {
-  $apiName: string;
-  $primaryKey: string;
-  id: string;
-  title: string;
-}
-
-const projects: MockProject[] = [
-  {
-    $apiName: "MockProject",
-    $primaryKey: "1",
-    id: "1",
-    name: "Mock project",
-    tasks: [
-      {
-        $apiName: "MockTask",
-        $primaryKey: "1",
-        id: "1",
-        title: "Try to",
-      },
-      {
-        $apiName: "MockTask",
-        $primaryKey: "2",
-        id: "2",
-        title: "Implement this",
-      },
-      {
-        $apiName: "MockTask",
-        $primaryKey: "3",
-        id: "3",
-        title: "With the Ontology SDK!",
-      },
-    ],
-  },
-  {
-    $apiName: "MockProject",
-    $primaryKey: "2",
-    id: "2",
-    name: "Yet another mock project",
-    tasks: [
-      {
-        $apiName: "MockTask",
-        $primaryKey: "4",
-        id: "4",
-        title: "More tasks here",
-      },
-    ],
-  },
-];
-
-async function delay(): Promise<void> {
-  return new Promise((resolve) =>
-    setTimeout(() => resolve(), 500 + Math.random() * 1000)
-  );
-}
-
-// Good enough random id for mocks
-function randomId(): string {
-  return `${Math.floor(Math.random() * 2 ** 31)}`;
-}
-
-async function getProjects(): Promise<MockProject[]> {
-  await delay();
-  const result = [...projects];
-  result.sort((p1, p2) => p1.name.localeCompare(p2.name));
-  return result;
-}
-
-async function createProject({
-  name,
-}: {
-  name: string;
-}): Promise<MockProject["$primaryKey"]> {
-  await delay();
-  const id = randomId();
-  projects.push({
-    $apiName: "MockProject",
-    $primaryKey: id,
-    id,
-    name,
-    tasks: [],
-  });
-  return id;
-}
-
-async function deleteProject(id: string): Promise<void> {
-  await delay();
-  const idx = projects.findIndex((p) => p.id === id);
-  if (idx !== -1) {
-    projects.splice(idx, 1);
-  }
-}
-
-async function createTask({
-  title,
-  projectId,
-}: {
-  title: string;
-  projectId: string;
-}): Promise<MockTask["$primaryKey"]> {
-  await delay();
-  const project = projects.find((p) => p.id === projectId);
-  if (project == null) {
-    throw new Error(`Project ${projectId} not found!`);
-  }
-  const id = randomId();
-  project.tasks.unshift({ $apiName: "MockTask", $primaryKey: id, id, title });
-  return id;
-}
-
-async function deleteTask(id: string): Promise<void> {
-  await delay();
-  for (const project of projects) {
-    const idx = project.tasks.findIndex((t) => t.id === id);
-    if (idx !== -1) {
-      project.tasks.splice(idx, 1);
-    }
-  }
-}
-
-const Mocks = {
-  getProjects,
-  createProject,
-  deleteProject,
-  createTask,
-  deleteTask,
-};
-
-export default Mocks;

package/templates/template-tutorial-todo-app/src/useProjectTasks.ts

@@ -1,60 +0,0 @@
-import { useCallback } from "react";
-import useSWR from "swr";
-import Mocks, { MockProject, MockTask } from "./mocks";
-
-export function useProjectTasks(project: MockProject | undefined) {
-  const { data, isLoading, isValidating, error, mutate } = useSWR<MockTask[]>(
-    project != null ? `projects/${project.id}/tasks` : null,
-    // Try to implement this with the Ontology SDK!
-    async () => {
-      if (project == null) {
-        return [];
-      }
-      return project.tasks;
-    },
-  );
-
-  const createTask: (
-    title: string,
-  ) => Promise<MockTask["$primaryKey"] | undefined> = useCallback(
-    async (title) => {
-      if (project == null) {
-        return undefined;
-      }
-      // Try to implement this with the Ontology SDK!
-      const id = await Mocks.createTask({
-        title,
-        projectId: project.$primaryKey,
-      });
-      await mutate();
-      return id;
-    },
-    [project, mutate],
-  );
-
-  const deleteTask: (task: MockTask) => Promise<void> = useCallback(
-    async (task) => {
-      if (project == null) {
-        return;
-      }
-      await sleep(1000);
-      // Try to implement this with the Ontology SDK!
-      await Mocks.deleteTask(task.$primaryKey);
-      await mutate();
-    },
-    [project, mutate],
-  );
-
-  return {
-    tasks: data,
-    isLoading,
-    isValidating,
-    isError: error,
-    createTask,
-    deleteTask,
-  };
-}
-
-function sleep(ms: number) {
-  return new Promise(resolve => setTimeout(resolve, ms));
-}

package/templates/template-tutorial-todo-app/src/useProjects.ts

@@ -1,43 +0,0 @@
-import { useCallback } from "react";
-import useSWR from "swr";
-import Mocks, { MockProject } from "./mocks";
-
-function useProjects() {
-  const { data, isLoading, isValidating, error, mutate } = useSWR<
-    MockProject[]
-  >("projects", async () => {
-    // Try to implement this with the Ontology SDK!
-    return Mocks.getProjects();
-  });
-
-  const createProject: (name: string) => Promise<MockProject["$primaryKey"]> =
-    useCallback(
-      async (name) => {
-        // Try to implement this with the Ontology SDK!
-        const id = await Mocks.createProject({ name });
-        await mutate();
-        return id;
-      },
-      [mutate],
-    );
-
-  const deleteProject: (project: MockProject) => Promise<void> = useCallback(
-    async (project) => {
-      // Try to implement this with the Ontology SDK!
-      await Mocks.deleteProject(project.$primaryKey);
-      await mutate();
-    },
-    [mutate],
-  );
-
-  return {
-    projects: data,
-    isLoading,
-    isValidating,
-    isError: error,
-    createProject,
-    deleteProject,
-  };
-}
-
-export default useProjects;

package/templates/template-tutorial-todo-app/src/vite-env.d.ts

@@ -1 +0,0 @@
-/// <reference types="vite/client" />

package/templates/template-tutorial-todo-app/tsconfig.json

@@ -1,25 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2020",
-    "useDefineForClassFields": true,
-    "lib": ["ES2020", "DOM", "DOM.Iterable"],
-    "module": "ESNext",
-    "skipLibCheck": true,
-
-    /* Bundler mode */
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "noEmit": true,
-    "jsx": "react-jsx",
-
-    /* Linting */
-    "strict": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noFallthroughCasesInSwitch": true
-  },
-  "include": ["src"],
-  "references": [{ "path": "./tsconfig.node.json" }]
-}

package/templates/template-tutorial-todo-app/tsconfig.node.json

@@ -1,10 +0,0 @@
-{
-  "compilerOptions": {
-    "composite": true,
-    "skipLibCheck": true,
-    "module": "ESNext",
-    "moduleResolution": "bundler",
-    "allowSyntheticDefaultImports": true
-  },
-  "include": ["vite.config.ts"]
-}

package/templates/template-tutorial-todo-app/vite.config.ts.hbs

@@ -1,19 +0,0 @@
-import react from "@vitejs/plugin-react";
-import { defineConfig } from "vite";
-
-// https://vitejs.dev/config/
-export default defineConfig({
-  plugins: [react()],
-  server: {
-    port: 8080,
-    {{#if corsProxy}}
-    proxy: {
-      "^(/multipass/api|/api)": {
-        target: "{{foundryUrl}}",
-        changeOrigin: true,
-        secure: true,
-      },
-    },
-    {{/if}}
-  },
-});

package/templates/template-vue/.vscode/extensions.json

@@ -1,3 +0,0 @@
-{
-  "recommendations": ["Vue.volar", "Vue.vscode-typescript-vue-plugin"]
-}

package/templates/template-vue/README.md.hbs

@@ -1,35 +0,0 @@
-# {{project}}
-
-This project was generated with [`@osdk/create-app`](https://www.npmjs.com/package/@osdk/create-app) and demonstrates using the Ontology SDK package `{{osdkPackage}}` with Vue on top of Vite. Check out the [Vite](https://vitejs.dev/guide/) docs for further configuration.
-
-## Developing
-
-Run the following command or equivalent with your preferred package manager to start a local development server on `http://localhost:8080`:
-
-```sh
-npm run dev
-```
-
-Development configuration is stored in `.env.development`.
-
-{{#if corsProxy}}
-In order to make API requests to Foundry, a CORS proxy has been set up for local development which may be removed if the stack is configured to allow `http://localhost:8080` to load resources. The configured OAuth client must also allow `http://localhost:8080/auth/callback` as a redirect URL.
-{{else}}
-In order to make API requests to Foundry, CORS must be configured for the stack to allow `http://localhost:8080` to load resources. If this has not been configured and you are unable to request this, you can alternatively generate your project again with `--corsProxy true` to use a proxy for API requests during local development. The configured OAuth client must also allow `http://localhost:8080/auth/callback` as a redirect URL.
-{{/if}}
-
-## Deploying
-
-Run the following command or equivalent with your preferred package manager to create a production build of your application:
-
-```sh
-npm run build
-```
-
-Production configuration is stored in `.env.production`.
-
-If you did not fill in the URL your production application will be hosted on you will need to fill in the `VITE_FOUNDRY_REDIRECT_URL` in `.env.production`.
-
-In order to make API requests to Foundry, CORS must be configured for the stack to allow the production origin to load resources. This will be automatically done for you if you are using Foundry website hosting. The configured OAuth client must also allow the production origin auth callback as a redirect URL.
-
-A `foundry.config.json` file is included in the root of this project to make deploying to Foundry website hosting with [`@osdk/cli`](https://www.npmjs.com/package/@osdk/cli) easier. If you are not using Foundry website hosting for your application you may delete this file.

package/templates/template-vue/_gitignore

@@ -1,24 +0,0 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-pnpm-debug.log*
-lerna-debug.log*
-
-node_modules
-dist
-dist-ssr
-*.local
-
-# Editor directories and files
-.vscode/*
-!.vscode/extensions.json
-.idea
-.DS_Store
-*.suo
-*.ntvs*
-*.njsproj
-*.sln
-*.sw?

package/templates/template-vue/index.html

@@ -1,15 +0,0 @@
-<!doctype html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <link rel="icon" type="image/svg+xml" href="/vue.svg" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Ontology SDK + Vue</title>
-  </head>
-  <body>
-    <div id="app-container">
-      <div id="app"></div>
-    </div>
-    <script type="module" src="/src/main.ts"></script>
-  </body>
-</html>

package/templates/template-vue/package.json.hbs

@@ -1,22 +0,0 @@
-{
-  "name": "{{project}}",
-  "private": true,
-  "version": "0.0.0",
-  "type": "module",
-  "scripts": {
-    "dev": "vite",
-    "build": "vue-tsc && vite build",
-    "preview": "vite preview"
-  },
-  "dependencies": {
-    "{{osdkPackage}}": "latest",
-    "vue": "^3.4.27",
-    "vue-router": "^4.2.5"
-  },
-  "devDependencies": {
-    "@vitejs/plugin-vue": "^4.5.0",
-    "typescript": "^5.2.2",
-    "vite": "^5.2.11",
-    "vue-tsc": "^1.8.22"
-  }
-}

package/templates/template-vue/public/palantir.svg

@@ -1,3 +0,0 @@
-<svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg">
-<path fill-rule="evenodd" clip-rule="evenodd" d="M4.10768 6.06401C4.10768 8.3771 5.96702 10.2526 8.26059 10.2526C10.5543 10.2526 12.4138 8.3771 12.4138 6.06401C12.4138 3.7508 10.5543 1.87553 8.26059 1.87553C5.96702 1.87553 4.10768 3.7508 4.10768 6.06401ZM8.26093 13.923L13.6299 11.5848L14.5217 13.3091L8.26093 16L2 13.3091L2.89201 11.5848L8.26093 13.923ZM8.26101 0C4.94367 0 2.25442 2.71228 2.25442 6.05803C2.25442 9.40378 4.94367 12.1159 8.26101 12.1159C11.5782 12.1159 14.2676 9.40378 14.2676 6.05803C14.2676 2.71228 11.5782 0 8.26101 0Z" fill="#111418"/>
-</svg>

package/templates/template-vue/public/vue.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="37.07" height="36" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 198"><path fill="#41B883" d="M204.8 0H256L128 220.8L0 0h97.92L128 51.2L157.44 0h47.36Z"></path><path fill="#41B883" d="m0 0l128 220.8L256 0h-51.2L128 132.48L50.56 0H0Z"></path><path fill="#35495E" d="M50.56 0L128 133.12L204.8 0h-47.36L128 51.2L97.92 0H50.56Z"></path></svg>

package/templates/template-vue/src/AuthCallback.vue

@@ -1,22 +0,0 @@
-<script setup lang="ts">
-import { onMounted, ref } from "vue";
-import client from "./client";
-import { useRouter } from "vue-router";
-
-const router = useRouter();
-
-const error = ref<string>();
-
-onMounted(() => {
-  client.auth
-    .signIn()
-    .then(() => router.replace("/"))
-    .catch((e: unknown) => {
-      error.value = (e as Error).message;
-    });
-});
-</script>
-
-<template>
-  <div>{{ error != null ? error : "Authenticating…" }}</div>
-</template>

package/templates/template-vue/src/Home.vue.hbs

@@ -1,38 +0,0 @@
-<script setup lang="ts">
-import client from "./client";
-
-const objectApiNames = Object.keys(client.ontology.objects);
-const actionApiNames = Object.keys(client.ontology.actions);
-const queryApiNames = Object.keys(client.ontology.queries);
-</script>
-
-<template>
-  <h1>{{osdkPackage}}</h1>
-  <p>
-    Welcome to your Ontology SDK! Try using any of the following methods now.
-  </p>
-  <div class="methods">
-    <div>
-      <h2>Objects (\{{ objectApiNames.length }})</h2>
-      <pre v-for="objectApiName in objectApiNames" key="objectApiName">client.ontology.objects.\{{ objectApiName }}</pre>
-    </div>
-    <div>
-      <h2>Actions (\{{ actionApiNames.length }})</h2>
-      <pre v-for="actionApiName in actionApiNames" key="actionApiName">client.ontology.actions.\{{ actionApiName }}</pre>
-    </div>
-    <div>
-      <h2>Queries (\{{ queryApiNames.length }})</h2>
-      <pre v-for="queryApiName in queryApiNames" key="queryApiName">client.ontology.queries.\{{ queryApiName }}</pre>
-    </div>
-  </div>
-</template>
-
-<style scoped>
-.methods {
-  padding: 2em;
-  gap: 2em;
-  display: flex;
-  flex-direction: row;
-  flex-wrap: wrap;
-}
-</style>

package/templates/template-vue/src/Layout.vue

@@ -1,26 +0,0 @@
-<template>
-  <div>
-    <a
-      href="https://www.palantir.com/docs/foundry/ontology-sdk/overview/"
-      target="_blank"
-    >
-      <img src="/palantir.svg" class="logo" alt="Palantir logo" />
-    </a>
-    <a href="https://vuejs.org/" target="_blank">
-      <img src="/vue.svg" class="logo" alt="Vue logo" />
-    </a>
-  </div>
-  <router-view />
-</template>
-
-<style scoped>
-.logo {
-  height: 6em;
-  padding: 1.5em;
-  will-change: filter;
-  transition: filter 300ms;
-}
-.logo:hover {
-  filter: drop-shadow(0 0 2em #646cffaa);
-}
-</style>

package/templates/template-vue/src/Login.vue

@@ -1,36 +0,0 @@
-<script setup lang="ts">
-import { onUpdated, ref } from "vue";
-import client from "./client";
-import { useRouter } from "vue-router";
-
-const router = useRouter();
-
-const isLoggingIn = ref(false);
-const error = ref<string>();
-
-const login = async () => {
-  isLoggingIn.value = true;
-  try {
-    await client.auth.signIn();
-  } catch (e: unknown) {
-    error.value = (e as Error).message;
-  } finally {
-    isLoggingIn.value = false;
-  }
-};
-
-onUpdated(() => {
-  // If the token exists but a user tries to load /login, redirect to the home page instead
-  if (client.auth.token != null) {
-    router.replace("/");
-  }
-});
-</script>
-
-<template>
-  <h1>Ontology SDK</h1>
-  <button @click="login">
-    {{ isLoggingIn ? "Logging in…" : "Log in " }}
-  </button>
-  <div v-if="error">Unable to log in: {{ error }}</div>
-</template>

package/templates/template-vue/src/client.ts.hbs

@@ -1,31 +0,0 @@
-import { FoundryClient, PublicClientAuth } from "{{osdkPackage}}";
-
-const url = import.meta.env.VITE_FOUNDRY_API_URL;
-const clientId = import.meta.env.VITE_FOUNDRY_CLIENT_ID;
-const redirectUrl = import.meta.env.VITE_FOUNDRY_REDIRECT_URL;
-checkEnv(url, "VITE_FOUNDRY_API_URL");
-checkEnv(clientId, "VITE_FOUNDRY_CLIENT_ID");
-checkEnv(redirectUrl, "VITE_FOUNDRY_REDIRECT_URL");
-
-function checkEnv(
-  value: string | undefined,
-  name: string,
-): asserts value is string {
-  if (value == null) {
-    throw new Error(`Missing environment variable: ${name}`);
-  }
-}
-
-/**
- * Initialize the client to interact with the Ontology SDK
- */
-const client = new FoundryClient({
-  url,
-  auth: new PublicClientAuth({
-    clientId,
-    url,
-    redirectUrl,
-  }),
-});
-
-export default client;