cognite-create 0.2.16 → 0.2.19

package/bin/index.js

@@ -8,6 +8,9 @@ const fs = require("node:fs/promises");
 const path = require("node:path");
 
 const REQUIRED_DEPENDENCIES = [
+  { name: "recharts", version: "^3.2.1" },
+  { name: "@cognite/sdk", version: "^10.2.0" },
+  { name: "date-fns", version: "^4.1.0" },
   { name: "tailwind-merge", version: "^3.3.1" },
   { name: "tw-animate-css", version: "^1.3.8" },
   { name: "clsx", version: "^2.1.1" },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cognite-create",
-  "version": "0.2.16",
+  "version": "0.2.19",
   "description": "Create a Next.js app preconfigured with Cognite defaults.",
   "bin": {
     "cognite-create": "./bin/index.js"
@@ -13,4 +13,4 @@
     "node": ">=18.0.0"
   },
   "license": "UNLICENSED"
-}
+}

package/templates/.cursor/rules/general.mdc

@@ -8,4 +8,30 @@ Use the ShadCN MCP server to list the Cognite registry for components you can us
 
 Always use semantic Tailwind color classes (e.g., bg-primary, text-primary, border-primary) instead of arbitrary color values (e.g., bg-blue-600, text-red-500). This ensures consistency with the design system.
 
-Run `pnpm lint` after your changes to make sure you have fixed all potential errors.
+When setting up auth rememeber to set up the oidcTokenProvider.
+
+Use this function to get the token string:
+
+export const getToken = async (clientId: string, clientSecret: string) => {
+  const header = "Basic " + btoa(`${clientId}:${clientSecret}`);
+
+  const response = await fetch("https://auth.cognite.com/oauth2/token", {
+    method: "POST",
+    headers: {
+      Authorization: header,
+      "Content-Type": "application/x-www-form-urlencoded",
+    },
+    body: new URLSearchParams({
+      grant_type: "client_credentials",
+    }),
+  });
+
+  const data = await response.json();
+
+  console.log("Token response:", data);
+  return data.access_token;
+};
+
+Always run `pnpm lint` after you make changes to make sure you have fixed all potential errors.
+
+Make sure all client and server components are handled properly and you are not passing client events from server components.

package/templates/.env.example

@@ -1,11 +1,8 @@
-# CDF Configuration Template
-APP_NAME=your_app
+# Cognite Configuration
+NEXT_PUBLIC_COGNITE_PROJECT=your-project-name
+NEXT_PUBLIC_COGNITE_BASE_URL=https://api.cognitedata.com
 
-# CDF Project Configuration
-ORG=your_org
-PROJECT=your_project
-BASE_URL=https://your_cluster.cognitedata.com
-
-# Authentication (Service Account)
-CLIENT_ID=your_client_id
-CLIENT_SECRET=your_client_secret
+# OIDC Authentication (Required for production)
+NEXT_PUBLIC_COGNITE_CLIENT_ID=your_client_id
+NEXT_PUBLIC_COGNITE_TENANT_ID=6a5949bb-8ea1-4bd1-aa0a-4d03846de30e
+COGNITE_CLIENT_SECRET=your_client_secret

package/templates/README.MD

@@ -0,0 +1,198 @@
+# CDF Application Template
+
+A React application template for building applications with Cognite Data Fusion (CDF) using AI assistance.
+
+## Prerequisites
+
+This project requires Node.js v22 or higher and npm (Node Package Manager).
+
+**Don't have Node.js installed?** See [Installing Node.js and npm](#installing-nodejs-and-npm) at the bottom of this document.
+
+## Initial Setup
+
+1. **Configure your app:** Fill in `app.json` with your application details
+2. **Install dependencies:** `npm install`
+3. **Start development server:** `npm start`
+4. **Deploy to CDF:** `npm run deploy`
+
+### Optional: Enable Fast Deployment & MCP Server
+
+Create a `.env` file with your CDF credentials:
+
+```
+CLIENT_ID=your-client-id
+CLIENT_SECRET=your-client-secret
+```
+
+This enables:
+
+- **Faster CI deployment:** `npm run deploy:ci`
+- **MCP server for Cursor:** AI can query and create data models directly in CDF
+
+## Features
+
+- **MCP Server Integration:** Query CDF data models, spaces, views, and containers directly through Cursor
+- **Cognite Design System:** Pre-configured `cdf-design-system-alpha` for consistent UI styling
+- **Requirements Template:** Structured template to guide AI in building your application
+- **Authentication Included:** Ready-to-use auth for both local development and CDF hosting
+- **Data Modeling Support:** AI can help structure and connect to CDF data models
+
+## Building Your Application
+
+### 1. Request a Requirements Doc
+
+Ask your AI assistant to create requirements based on your input:
+
+```
+"Write me a set of requirements for an application that [describe your needs]"
+```
+
+Review the generated requirements carefully. Add, remove, or modify as needed.
+
+### 2. Review Requirements List
+
+Go through the requirements document line by line. Make sure it accurately captures what you want to build.
+
+### 3. Request a Dummy Data Version
+
+Start with a working prototype using mock data:
+
+```
+"Build a dummy data version of this application based on the requirements"
+```
+
+### 4. Build and Iterate
+
+Run `npm start` and test your application. Iterate on the UI, functionality, and user experience with your AI assistant.
+
+### 5. Connect to CDF (Step by Step)
+
+Once satisfied with the prototype, connect it to real CDF data:
+
+```
+"Let's connect this to CDF data models. Start by creating the space and containers we need."
+```
+
+Take this **step by step** - this is where you're most likely to run into issues. Create spaces, then containers, then views, then connect your UI.
+
+## Tips and Tricks
+
+### Important Warnings
+
+⚠️ **If you get errors:** Copy-paste the error into Cursor. If it doesn't work after 3 attempts, ask it to simplify the approach.
+
+⚠️ **Don't try to implement notifications** - This rarely works well
+
+⚠️ **Don't extend existing data models** - It will likely not work. Create new views instead.
+
+⚠️ **Don't delete data models** - You can't easily recover them
+
+⚠️ **Limited availability:** Only enabled for select Cognite projects (e.g., lervik, atlas). Not to be used in customer projects.
+
+⚠️ **Commit after every step** - Version control saves you from having to rebuild everything
+
+### Helpful Prompts
+
+- Open browser console to see errors, paste them into Cursor
+- If AI isn't using the design system: "Please use the cdf-design-system-alpha design system"
+- To get correct types: "Fetch the [ViewName] view from CDF and use that to define the type"
+- To check data models: "List the available views in the [space_name] space"
+
+## Environment Variables
+
+Your `.env` file (optional, for MCP and fast deployment):
+
+```
+CLIENT_ID=your-client-id
+CLIENT_SECRET=your-client-secret
+```
+
+## Development Commands
+
+- `npm start` - Start development server
+- `npm run build` - Build for production
+- `npm run lint` - Run linter
+- `npm run deploy` - Deploy to CDF
+- `npm run deploy:ci` - Fast deployment (requires .env)
+
+## Security
+
+- Never commit `.env` files
+- Environment files are automatically ignored by git
+- Use service account credentials for deployment only
+
+---
+
+## Installing Node.js and npm
+
+This project requires Node.js v22 or higher and npm (Node Package Manager).
+
+### macOS
+
+**Option 1: Using Homebrew (recommended)**
+
+```bash
+# Install Homebrew if you don't have it
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+
+# Install Node.js (includes npm)
+brew install node@22
+```
+
+**Option 2: Using the official installer**
+
+1. Download the installer from [nodejs.org](https://nodejs.org/)
+2. Choose the LTS (Long Term Support) version
+3. Run the installer and follow the prompts
+
+### Windows
+
+**Option 1: Using the official installer (recommended)**
+
+1. Download the installer from [nodejs.org](https://nodejs.org/)
+2. Choose the LTS (Long Term Support) version
+3. Run the `.msi` installer and follow the prompts
+4. Restart your terminal/command prompt
+
+**Option 2: Using Chocolatey**
+
+```powershell
+# Install Chocolatey if you don't have it
+Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))
+
+# Install Node.js
+choco install nodejs-lts
+```
+
+### Linux
+
+**Ubuntu/Debian:**
+
+```bash
+# Install Node.js 22.x
+curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash -
+sudo apt-get install -y nodejs
+```
+
+**Fedora/RHEL/CentOS:**
+
+```bash
+# Install Node.js 22.x
+curl -fsSL https://rpm.nodesource.com/setup_22.x | sudo bash -
+sudo yum install -y nodejs
+```
+
+**Arch Linux:**
+
+```bash
+sudo pacman -S nodejs npm
+```
+
+### Verify Installation
+
+After installation, verify that Node.js and npm are installed correctly:
+
+```bash
+node --version  # Should show v22.x.x or higher
+npm --version   # Should show 10.x.x or higher
+```