create-harper 1.7.4 → 1.8.0

package/template-vue-ssr/src/entry-client.js

@@ -0,0 +1,7 @@
+import App from '@/App.vue';
+import { createSSRApp } from 'vue';
+
+import './style.css';
+
+// `createSSRApp` hydrates the server-rendered markup. (A client-only app would use `createApp`.)
+createSSRApp(App).mount('#app');

package/template-vue-ssr/src/entry-server.js

@@ -0,0 +1,14 @@
+import App from '@/App.vue';
+import { createSSRApp } from 'vue';
+import { renderToString } from 'vue/server-renderer';
+
+/**
+ * Server render entry. The Vite Harper plugin calls this for HTML navigations and injects the
+ * returned markup into the `<!--ssr-outlet-->` placeholder in index.html.
+ *
+ * @param {string} _url The request URL — use it to drive routing/data loading per request.
+ * @returns {Promise<string>}
+ */
+export function render(_url) {
+	return renderToString(createSSRApp(App));
+}

package/template-vue-ssr/src/style.css

@@ -0,0 +1,96 @@
+:root {
+  font-family: system-ui, Avenir, Helvetica, Arial, sans-serif;
+  line-height: 1.5;
+  font-weight: 400;
+
+  color-scheme: light dark;
+  color: rgba(255, 255, 255, 0.87);
+  background-color: #242424;
+
+  font-synthesis: none;
+  text-rendering: optimizeLegibility;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+}
+
+a {
+  font-weight: 500;
+  color: #646cff;
+  text-decoration: inherit;
+}
+a:hover {
+  color: #535bf2;
+}
+
+body {
+  margin: 0;
+  display: flex;
+  place-items: center;
+  min-width: 320px;
+  min-height: 100vh;
+}
+
+h1 {
+  font-size: 3.2em;
+  line-height: 1.1;
+}
+
+#app {
+  max-width: 1280px;
+  margin: 0 auto;
+  padding: 2rem;
+  text-align: center;
+}
+
+.logo {
+  height: 6em;
+  padding: 1.5em;
+  will-change: filter;
+  transition: filter 300ms;
+}
+.logo:hover {
+  filter: drop-shadow(0 0 2em #646cffaa);
+}
+.logo.vanilla:hover {
+  filter: drop-shadow(0 0 2em #3178c6aa);
+}
+
+.card {
+  padding: 2em;
+}
+
+.read-the-docs {
+  color: #888;
+}
+
+button {
+  border-radius: 8px;
+  border: 1px solid transparent;
+  padding: 0.6em 1.2em;
+  font-size: 1em;
+  font-weight: 500;
+  font-family: inherit;
+  background-color: #1a1a1a;
+  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/template-vue-ssr/test/counter.test.js

@@ -0,0 +1,15 @@
+import assert from 'node:assert/strict';
+import { test } from 'node:test';
+import { decrement, increment } from '../src/counter.js';
+
+test('increment function', () => {
+	assert.strictEqual(increment(0), 1);
+	assert.strictEqual(increment(1), 2);
+	assert.strictEqual(increment(-1), 0);
+});
+
+test('decrement function', () => {
+	assert.strictEqual(decrement(0), -1);
+	assert.strictEqual(decrement(1), 0);
+	assert.strictEqual(decrement(-1), -2);
+});

package/template-vue-ssr/vite.config.js

@@ -0,0 +1,22 @@
+import vue from '@vitejs/plugin-vue';
+import path from 'node:path';
+import { defineConfig } from 'vite';
+
+// https://vite.dev/config/
+export default defineConfig({
+	plugins: [
+		vue(),
+	],
+	resolve: {
+		alias: {
+			'@': path.resolve(import.meta.dirname, './src'),
+		},
+	},
+	build: {
+		outDir: 'dist',
+		emptyOutDir: true,
+		rolldownOptions: {
+			external: ['**/*.test.*', '**/*.spec.*'],
+		},
+	},
+});

package/template-vue-ts/README.md

@@ -89,7 +89,7 @@ These schemas are the heart of a great Harper app, specifying which tables you w
 
 ### View Your Website
 
-Pop open [http://localhost:9926](http://localhost:9926) to view [web/index.html](./web/index.html) in your browser.
+Pop open [http://localhost:9926](http://localhost:9926) to view [index.html](./index.html) in your browser.
 
 ### Use Your API
 
@@ -113,7 +113,11 @@ Take a look at the [default configuration](./config.yaml), which specifies how f
 
 When you are ready, head to [https://fabric.harper.fast/](https://fabric.harper.fast/), log in to your account, and create a cluster.
 
-Come back here and configure your [.env](./.env) file with your secure cluster credentials. Don't commit this file to source control!
+Come back and log in your local CLI to your cluster:
+
+```sh
+harper login
+```
 
 Then you can deploy your app to your cluster:
 

package/template-vue-ts/_gitignore

@@ -1,6 +1,5 @@
 .DS_Store
-web
-deploy
+dist
 
 #
 # https://raw.githubusercontent.com/github/gitignore/refs/heads/main/Node.gitignore

package/template-vue-ts/config.yaml

@@ -25,6 +25,19 @@ jsResource:
   globalTypes: 'schemas/globalTypes.d.ts'
   schemaTypes: 'schemas/types.ts'
 
-# Bootstraps Vite to build your frontend to HTML/JS/CSS
-'@harperfast/vite-plugin':
-  package: '@harperfast/vite-plugin'
+# Bootstraps Vite to build your frontend to HTML/JS/CSS.
+# In production it builds your app (and recompiles when files in `files` change); the `static`
+# component below serves the built output. Listed before `static` so its dev server wins in `harper dev`.
+'@harperfast/vite':
+  package: '@harperfast/vite'
+  files: 'src/**/*'
+  output: 'dist'
+
+# Serves the built frontend from Vite's output directory. `notFound` + `fallthrough: false` makes
+# client-side routing work (unmatched routes return index.html); the REST routes above take precedence.
+static:
+  files: 'dist/**'
+  notFound:
+    file: 'index.html'
+    statusCode: 200
+  fallthrough: false

package/template-vue-ts/package.json

@@ -13,20 +13,22 @@
 		"test": "node --test test/*.test.ts",
 		"test:watch": "node --watch --test test/*.test.ts",
 		"build": "vite build",
-		"deploy": "rm -Rf deploy && npm run build && mkdir deploy && mv web deploy/ && cp -R deploy-template/* deploy/ && cp -R schemas resources deploy/ && (cd deploy && harper deploy_component . project=web restart=true replicated=true) && rm -Rf deploy"
+		"deploy": "harper deploy_component . restart=true replicated=true"
+	},
+	"dependencies": {
+		"@harperfast/schema-codegen": "^1.0.10",
+		"@harperfast/vite": "^1.1.0",
+		"@vitejs/plugin-vue": "^6.0.5",
+		"vite": "^8.0.0",
+		"vue": "^3.5.29"
 	},
 	"devDependencies": {
 		"@eslint/js": "^10.0.1",
-		"@harperfast/schema-codegen": "^1.0.10",
-		"@harperfast/vite-plugin": "^0.2.1",
 		"@types/node": "^24.10.1",
-		"@vitejs/plugin-vue": "^6.0.5",
 		"eslint": "^10.0.2",
 		"globals": "^17.4.0",
 		"prettier": "^3.8.1",
 		"typescript": "~6.0.0",
-		"vite": "^8.0.0",
-		"vue": "^3.5.29",
 		"vue-tsc": "^3.2.5"
 	}
 }

package/template-vue-ts/vite.config.ts

@@ -13,7 +13,7 @@ export default defineConfig({
 		},
 	},
 	build: {
-		outDir: 'web',
+		outDir: 'dist',
 		emptyOutDir: true,
 		rolldownOptions: {
 			external: ['**/*.test.*', '**/*.spec.*'],

package/template-vue-ts-ssr/README.md

@@ -0,0 +1,132 @@
+# your-project-name-here
+
+Your new app is now ready for development!
+
+Here's what you should do next:
+
+## Installation
+
+To get started, make sure you have [installed Harper](https://docs.harperdb.io/docs/deployments/install-harper):
+
+```sh
+npm install -g harper
+```
+
+## Development
+
+Then you can start your app:
+
+```sh
+npm run dev
+```
+
+TypeScript is supported at runtime in Node.js through [type stripping](https://nodejs.org/api/typescript.html#type-stripping). Full TypeScript language support can be enabled through integrating third party build steps to transpile your TypeScript into JavaScript.
+
+### Define Your Schema
+
+1. Create a new yourTableName.graphql file in the [schemas](./schemas) directory.
+2. Craft your schema by hand.
+3. Save your changes.
+
+These schemas are the heart of a great Harper app, specifying which tables you want and what attributes/fields they should have. Any table you `@export` stands up [endpoints automatically](./.agents/skills/harper-best-practices/rules/automatic-apis.md).
+
+### Add Custom Endpoints
+
+1. Create a new greeting.ts file in the [resources](./resources) directory.
+
+2. Customize your resource:
+
+   ```typescript
+   import { type RecordObject, type RequestTargetOrId, Resource } from 'harper';
+
+   interface GreetingRecord {
+   	greeting: string;
+   }
+
+   export class Greeting extends Resource<GreetingRecord> {
+   	static loadAsInstance = false;
+
+   	async post(
+   		target: RequestTargetOrId,
+   		newRecord: Partial<GreetingRecord & RecordObject>,
+   	): Promise<GreetingRecord> {
+   		// By default, only super users can access these endpoints.
+   		return { greeting: 'Greetings, post!' };
+   	}
+
+   	async get(target?: RequestTargetOrId): Promise<GreetingRecord> {
+   		// But if we want anyone to be able to access it, we can turn off the permission checks!
+   		target.checkPermission = false;
+   		return { greeting: 'Greetings, get! ' + process.version };
+   	}
+
+   	async put(
+   		target: RequestTargetOrId,
+   		record: GreetingRecord & RecordObject,
+   	): Promise<GreetingRecord> {
+   		target.checkPermission = false;
+   		if (this.getCurrentUser()?.name?.includes('Coffee')) {
+   			// You can add your own authorization guards, of course.
+   			return new Response('Coffee? COFFEE?!', { status: 418 });
+   		}
+   		return { greeting: 'Sssssssssssssss!' };
+   	}
+
+   	async patch(
+   		target: RequestTargetOrId,
+   		record: Partial<GreetingRecord & RecordObject>,
+   	): Promise<GreetingRecord> {
+   		return { greeting: 'We can make this work!' };
+   	}
+
+   	async delete(target: RequestTargetOrId): Promise<boolean> {
+   		return true;
+   	}
+   }
+   ```
+
+3. Save your changes.
+
+### View Your Website
+
+Pop open [http://localhost:9926](http://localhost:9926) to view [index.html](./index.html) in your browser.
+
+### Use Your API
+
+Test your application works by querying the `/Greeting` endpoint:
+
+```sh
+curl http://localhost:9926/Greeting
+```
+
+You should see the following:
+
+```json
+{ "greeting": "Hello, world!" }
+```
+
+### Configure Your App
+
+Take a look at the [default configuration](./config.yaml), which specifies how files are handled in your application.
+
+## Deployment
+
+When you are ready, head to [https://fabric.harper.fast/](https://fabric.harper.fast/), log in to your account, and create a cluster.
+
+Come back and log in your local CLI to your cluster:
+
+```sh
+harper login
+```
+
+Then you can deploy your app to your cluster:
+
+```sh
+npm run deploy
+```
+
+## Keep Going!
+
+For more information about getting started with Harper and building applications, see our [getting started guide](https://docs.harperdb.io/docs).
+
+For more information on Harper Components, see the [Components documentation](https://docs.harperdb.io/docs/reference/components).

package/template-vue-ts-ssr/_aiignore

@@ -0,0 +1 @@
+.env

package/template-vue-ts-ssr/_env

@@ -0,0 +1 @@
+CLI_TARGET='your-fabric.harper.fast-cluster-url-here'

package/template-vue-ts-ssr/_env.example

@@ -0,0 +1 @@
+CLI_TARGET='YOUR_FABRIC.HARPER.FAST_CLUSTER_URL_HERE'

package/template-vue-ts-ssr/_github/workflow/deploy.yaml

@@ -0,0 +1,33 @@
+name: Deploy to Harper Fabric
+on:
+  workflow_dispatch:
+#  push:
+#    branches:
+#      - main
+
+concurrency:
+  group: main
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+      - name: Set up Node.js
+        uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0
+        with:
+          cache: 'npm'
+          node-version-file: '.nvmrc'
+      - name: Install dependencies
+        run: npm ci
+      - name: Run unit tests
+        run: npm test
+      - name: Run lint
+        run: npm run lint
+      - name: Build & deploy
+        run: npm run deploy

package/template-vue-ts-ssr/_gitignore

@@ -0,0 +1,148 @@
+.DS_Store
+dist
+
+#
+# https://raw.githubusercontent.com/github/gitignore/refs/heads/main/Node.gitignore
+#
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.*
+!.env.example
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+.output
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Sveltekit cache directory
+.svelte-kit/
+
+# vitepress build output
+**/.vitepress/dist
+
+# vitepress cache directory
+**/.vitepress/cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# Firebase cache directory
+.firebase/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v3
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+# Vite files
+vite.config.js.timestamp-*
+vite.config.ts.timestamp-*
+.vite/

package/template-vue-ts-ssr/_nvmrc

@@ -0,0 +1 @@
+24.13.1

package/template-vue-ts-ssr/config.yaml

@@ -0,0 +1,43 @@
+# yaml-language-server: $schema=./node_modules/harper/config-app.schema.json
+
+# This is the configuration file for the application.
+# It specifies built-in Harper components that will load the specified feature and files.
+# For more information, see https://docs.harperdb.io/docs/reference/components/built-in-extensions
+
+# Load Environment Variables from the specified file
+# loadEnv:
+#   files: '.env'
+
+# This provides the HTTP REST interface for all exported resources
+rest: true
+
+# These reads GraphQL schemas to define the schema of database/tables/attributes.
+graphqlSchema:
+  files: 'schemas/*.graphql'
+
+# Loads JavaScript modules such that their exports are exported as resources
+jsResource:
+  files: 'resources/*.ts'
+
+# Generates types for the schema so your code is schema-aware
+'@harperfast/schema-codegen':
+  package: '@harperfast/schema-codegen'
+  globalTypes: 'schemas/globalTypes.d.ts'
+  schemaTypes: 'schemas/types.ts'
+
+# Bootstraps Vite to build your frontend to HTML/JS/CSS.
+# In production it builds your app (and recompiles when files in `files` change) and renders HTML on
+# the server; the `static` component below serves the built assets. Listed before `static` so its dev
+# server wins in `harper dev`.
+'@harperfast/vite':
+  package: '@harperfast/vite'
+  files: 'src/**/*'
+  output: 'dist'
+  # Server-side render entry. Renders HTML on the server; omit to serve a client-only (SPA) app.
+  ssr: 'src/entry-server.ts'
+
+# Serves the built assets from Vite's output directory. `index: false` because this is an SSR app —
+# the Vite plugin renders index.html; static only serves assets.
+static:
+  files: 'dist/**'
+  index: false

package/template-vue-ts-ssr/eslint.config.js

@@ -0,0 +1,23 @@
+import js from '@eslint/js';
+import globals from 'globals';
+
+export default [
+	js.configs.recommended,
+	{
+		languageOptions: {
+			globals: {
+				...globals.browser,
+				...globals.node,
+			},
+			ecmaVersion: 'latest',
+			sourceType: 'module',
+		},
+		rules: {
+			'no-unused-vars': 'warn',
+			'no-console': 'off',
+		},
+	},
+	{
+		ignores: ['node_modules/'],
+	},
+];

package/template-vue-ts-ssr/graphql.config.yml

@@ -0,0 +1,3 @@
+schema: schema.graphql
+include: node_modules/harper/schema.graphql
+documents: '**/*.graphql'

package/template-vue-ts-ssr/index.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>your-project-name-here</title>
+  </head>
+  <body>
+    <div id="app"><!--ssr-outlet--></div>
+    <script type="module" src="/src/entry-client.ts"></script>
+  </body>
+</html>